TianoCore EDK2 master
Loading...
Searching...
No Matches
Data Fields
_EFI_SPI_BUS_TRANSACTION Struct Reference

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

Data Fields

CONST EFI_SPI_PERIPHERAL * SpiPeripheral
 
EFI_SPI_TRANSACTION_TYPE TransactionType
 
BOOLEAN DebugTransaction
 
UINT32 BusWidth
 
UINT32 FrameSize
 
UINT32 WriteBytes
 
UINT8 * WriteBuffer
 
UINT32 ReadBytes
 
UINT8 * ReadBuffer
 

Detailed Description

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

Definition at line 171 of file SpiIo.h.

Field Documentation

◆ BusWidth

UINT32 _EFI_SPI_BUS_TRANSACTION::BusWidth

SPI bus width in bits: 1, 2, 4

Definition at line 194 of file SpiIo.h.

◆ DebugTransaction

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.

Definition at line 189 of file SpiIo.h.

◆ FrameSize

UINT32 _EFI_SPI_BUS_TRANSACTION::FrameSize

Frame size in bits, range: 1 - 32

Definition at line 199 of file SpiIo.h.

◆ ReadBuffer

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

Definition at line 224 of file SpiIo.h.

◆ ReadBytes

UINT32 _EFI_SPI_BUS_TRANSACTION::ReadBytes

Length of the read buffer in bytes

Definition at line 216 of file SpiIo.h.

◆ SpiPeripheral

CONST EFI_SPI_PERIPHERAL* _EFI_SPI_BUS_TRANSACTION::SpiPeripheral

Pointer to the SPI peripheral being manipulated.

Definition at line 175 of file SpiIo.h.

◆ TransactionType

EFI_SPI_TRANSACTION_TYPE _EFI_SPI_BUS_TRANSACTION::TransactionType

Type of transaction specified by one of the EFI_SPI_TRANSACTION_TYPE values.

Definition at line 181 of file SpiIo.h.

◆ WriteBuffer

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

Definition at line 211 of file SpiIo.h.

◆ WriteBytes

UINT32 _EFI_SPI_BUS_TRANSACTION::WriteBytes

Length of the write buffer in bytes

Definition at line 204 of file SpiIo.h.

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