MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
_EFI_SPI_BUS_TRANSACTION Struct Reference

Data Fields

CONST EFI_SPI_PERIPHERALSpiPeripheral
 
EFI_SPI_TRANSACTION_TYPE TransactionType
 
BOOLEAN DebugTransaction
 
UINT32 BusWidth
 
UINT32 FrameSize
 
UINT32 WriteBytes
 
UINT8WriteBuffer
 
UINT32 ReadBytes
 
UINT8ReadBuffer
 

Detailed Description

The EFI_SPI_BUS_ TRANSACTION data structure contains the description of the SPI transaction to perform on the host controller.

Field Documentation

UINT32 _EFI_SPI_BUS_TRANSACTION::BusWidth

SPI bus width in bits: 1, 2, 4

BOOLEAN _EFI_SPI_BUS_TRANSACTION::DebugTransaction

TRUE if the transaction is being debugged. Debugging may be turned on for a single SPI transaction. Only this transaction will display debugging messages. All other transactions with this value set to FALSE will not display any debugging messages.

UINT32 _EFI_SPI_BUS_TRANSACTION::FrameSize

Frame size in bits, range: 1 - 32

UINT8* _EFI_SPI_BUS_TRANSACTION::ReadBuffer

Buffer to receive the data from the SPI peripheral

  • Frame sizes 1 - 8 bits: UINT8 (one byte) per frame
  • Frame sizes 7 - 16 bits : UINT16 (two bytes) per frame
  • Frame sizes 17 - 32 bits : UINT32 (four bytes) per frame
UINT32 _EFI_SPI_BUS_TRANSACTION::ReadBytes

Length of the read buffer in bytes

CONST EFI_SPI_PERIPHERAL* _EFI_SPI_BUS_TRANSACTION::SpiPeripheral

Pointer to the SPI peripheral being manipulated.

EFI_SPI_TRANSACTION_TYPE _EFI_SPI_BUS_TRANSACTION::TransactionType

Type of transaction specified by one of the EFI_SPI_TRANSACTION_TYPE values.

UINT8* _EFI_SPI_BUS_TRANSACTION::WriteBuffer

Buffer containing data to send to the SPI peripheral Frame sizes 1 - 8 bits: UINT8 (one byte) per frame Frame sizes 7 - 16 bits : UINT16 (two bytes) per frame

UINT32 _EFI_SPI_BUS_TRANSACTION::WriteBytes

Length of the write buffer in bytes