#include <MdePkg/Include/Protocol/SpiIo.h>

Data Fields
CONST EFI_SPI_PERIPHERAL *	SpiPeripheral

CONST EFI_SPI_PERIPHERAL *	OriginalSpiPeripheral

UINT32	FrameSizeSupportMask

UINT32	MaximumTransferBytes

UINT32	Attributes

CONST EFI_LEGACY_SPI_CONTROLLER_PROTOCOL *	LegacySpiProtocol

EFI_SPI_IO_PROTOCOL_TRANSACTION	Transaction

EFI_SPI_IO_PROTOCOL_UPDATE_SPI_PERIPHERAL	UpdateSpiPeripheral

Detailed Description

Support managed SPI data transactions between the SPI controller and a SPI chip.

Definition at line 240 of file SpiIo.h.

Field Documentation

◆ Attributes

UINT32 _EFI_SPI_IO_PROTOCOL::Attributes

Transaction attributes: One or more from:

SPI_10_SUPPORTS_2_B1T_DATA_BUS_W1DTH
- The SPI host and peripheral supports a 2-bit data bus
SPI_IO_SUPPORTS_4_BIT_DATA_BUS_W1DTH
- The SPI host and peripheral supports a 4-bit data bus
SPI_IO_TRANSFER_SIZE_INCLUDES_OPCODE
- Transfer size includes the opcode byte
SPI_IO_TRANSFER_SIZE_INCLUDES_ADDRESS
- Transfer size includes the 3 address bytes

Definition at line 278 of file SpiIo.h.

◆ FrameSizeSupportMask

UINT32 _EFI_SPI_IO_PROTOCOL::FrameSizeSupportMask

Mask of frame sizes which the SPI 10 layer supports. Frame size of N-bits is supported when bit N-1 is set. The host controller must support a frame size of 8-bits. Frame sizes of 16, 24 and 32-bits are converted to 8-bit frame sizes by the SPI bus layer if the frame size is not supported by the SPI host controller.

Definition at line 260 of file SpiIo.h.

◆ LegacySpiProtocol

CONST EFI_LEGACY_SPI_CONTROLLER_PROTOCOL* _EFI_SPI_IO_PROTOCOL::LegacySpiProtocol

Pointer to legacy SPI controller protocol

Definition at line 283 of file SpiIo.h.

◆ MaximumTransferBytes

UINT32 _EFI_SPI_IO_PROTOCOL::MaximumTransferBytes

Maximum transfer size in bytes: 1 - Oxffffffff

Definition at line 265 of file SpiIo.h.

◆ OriginalSpiPeripheral

CONST EFI_SPI_PERIPHERAL* _EFI_SPI_IO_PROTOCOL::OriginalSpiPeripheral

Address of the original EFI_SPI_PERIPHERAL data structure associated with this protocol instance.

Definition at line 251 of file SpiIo.h.

◆ SpiPeripheral

CONST EFI_SPI_PERIPHERAL* _EFI_SPI_IO_PROTOCOL::SpiPeripheral

Address of an EFI_SPI_PERIPHERAL data structure associated with this protocol instance.

Definition at line 245 of file SpiIo.h.

◆ Transaction

EFI_SPI_IO_PROTOCOL_TRANSACTION _EFI_SPI_IO_PROTOCOL::Transaction

Initiate a SPI transaction between the host and a SPI peripheral.

Definition at line 288 of file SpiIo.h.

◆ UpdateSpiPeripheral

EFI_SPI_IO_PROTOCOL_UPDATE_SPI_PERIPHERAL _EFI_SPI_IO_PROTOCOL::UpdateSpiPeripheral

Update the SPI peripheral associated with this SPI 10 instance.

Definition at line 293 of file SpiIo.h.

The documentation for this struct was generated from the following file:

MdePkg/Include/Protocol/SpiIo.h

Data Fields