_EFI_SPI_BUS Struct Reference

Data Fields
CONST CHAR16 *	FriendlyName
CONST EFI_SPI_PERIPHERAL *	Peripherallist
CONST EFI_DEVICE_PATH_PROTOCOL *	ControllerPath
EFI_SPI_CLOCK	Clock
VOID *	ClockParameter

Detailed Description

The EFI_SPI_BUS data structure provides the connection details between the physical SPI bus and the EFI_SPI_HC_PROTOCOL instance which controls that SPI bus. This data structure also describes the details of how the clock is generated for that SPI bus. Finally this data structure provides the list of physical SPI devices which are attached to the SPI bus.

Field Documentation

EFI_SPI_CLOCK _EFI_SPI_BUS::Clock

Address of the routine which controls the clock used by the SPI bus for this SPI peripheral. The SPI host co ntroller's clock routine is called when this value is set to NULL.

VOID* _EFI_SPI_BUS::ClockParameter

Address of a data structure containing the additional values which describe the necessary control for the clock. When Clock is NULL, the declaration for this data structure is provided by the vendor of the host's SPI controller driver. When Clock is not NULL, the declaration for this data structure is provided by the board layer.

CONST EFI_DEVICE_PATH_PROTOCOL* _EFI_SPI_BUS::ControllerPath

Address of an EFI_DEVICE_PATH_PROTOCOL data structure which uniquely describes the SPI controller.

CONST CHAR16* _EFI_SPI_BUS::FriendlyName

A Unicode string describing the SPI bus

CONST EFI_SPI_PERIPHERAL* _EFI_SPI_BUS::Peripherallist

Address of the first EFI_SPI_PERIPHERAL data structure connected to this bus. Specify NULL if there are no SPI peripherals connected to this bus.