STRUCT SPI_BOARD_INFO(9)

πŸ“¦ version 7.3.1, in nixpkgs unstable

🌸 NAME 🌸

okay so bestie, welcome to struct spi_board_info(9) from the Kernel API Manual β€” this is literally the board-specific template for a SPI device, and it's giving β€œpartial device glow-up” energy. 🫢✨


πŸ’… SYNOPSIS πŸ’…

       struct spi_board_info {
           char modalias[SPI_NAME_SIZE];
           const void      *platform_data;
           const struct software_node *swnode;
           void *controller_data;
           int irq;
           u32 max_speed_hz;
           u16 bus_num;
           u16 chip_select;
           u32 mode;
        };

🧚 Members 🧚

each member is lowkey a little starter pack for the matching spi_device field, so let’s go through them one by one, no cap:

  • modalias β€” initializes spi_device.modalias; identifies the driver. iykyk πŸ’…
  • platform_data β€” initializes spi_device.platform_data; the particular data stored there is driver-specific. πŸ“
  • swnode β€” software node for the device. ✨
  • controller_data β€” initializes spi_device.controller_data; some controllers need hints about hardware setup, e.g. for DMA. 🧚
  • irq β€” initializes spi_device.irq; depends on how the board is wired. πŸ”₯
  • max_speed_hz β€” initializes spi_device.max_speed_hz; based on limits from the chip datasheet and board-specific signal quality issues. ⚑
  • bus_num β€” identifies which spi_controller parents the spi_device; unused by spi_new_device, and otherwise depends on board wiring. πŸ¦‹
  • chip_select β€” initializes spi_device.chip_select; depends on how the board is wired. πŸŽ€
  • mode β€” initializes spi_device.mode; based on the chip datasheet, board wiring (some devices support both 3WIRE and standard modes), and possibly presence of an inverter in the chipselect path. 🌈

🌈 Description 🌈

When adding new SPI devices to the device tree, these structures serve as a partial device template. They hold information which can't always be determined by drivers. Information that probe can establish (such as the default transfer wordsize) is not included here. 😌

bestie, this is a partial template β€” probe can fill in stuff like the default transfer wordsize, and that’s not listed here. periodt. πŸ’–

These structures are used in two places. Their primary role is to be stored in tables of board-specific device descriptors, which are declared early in board initialization and then used (much later) to populate a controller's device tree after the that controller's driver initializes. A secondary (and atypical) role is as a parameter to spi_new_device call, which happens after those controller drivers are active in some dynamic board configuration models. πŸ‘‘


πŸ¦‹ SEE ALSO πŸ¦‹

start with the Kernel file ./include/linux/spi/spi.h, then the whole bestie lineup:


and that’s the page, bestie πŸ’– source: ./include/linux/spi Β· date: October 2026 Β· page: struct spi_board_info(9) β€” bye byeee πŸŽ€βœ¨

πŸ“¦ where this page comes from