SpiIo.h

Go to the documentation of this file.

 
#ifndef __SPI_IO_PROTOCOL_H__
#define __SPI_IO_PROTOCOL_H__
 
#include <Protocol/LegacySpiController.h>
#include <Protocol/SpiConfiguration.h>
 
typedef struct _EFI_SPI_IO_PROTOCOL EFI_SPI_IO_PROTOCOL;
 
typedef enum {
  SPI_TRANSACTION_FULL_DUPLEX,
 
  SPI_TRANSACTION_WRITE_ONLY,
 
  SPI_TRANSACTION_READ_ONLY,
 
  SPI_TRANSACTION_WRITE_THEN_READ
} EFI_SPI_TRANSACTION_TYPE;
 
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_IO_PROTOCOL_TRANSACTION)(
  IN  CONST EFI_SPI_IO_PROTOCOL  *This,
  IN  EFI_SPI_TRANSACTION_TYPE   TransactionType,
  IN  BOOLEAN                    DebugTransaction,
  IN  UINT32                     ClockHz OPTIONAL,
  IN  UINT32                     BusWidth,
  IN  UINT32                     FrameSize,
  IN  UINT32                     WriteBytes,
  IN  UINT8                      *WriteBuffer,
  IN  UINT32                     ReadBytes,
  OUT UINT8                      *ReadBuffer
  );
 
typedef EFI_STATUS
(EFIAPI *EFI_SPI_IO_PROTOCOL_UPDATE_SPI_PERIPHERAL)(
  IN CONST EFI_SPI_IO_PROTOCOL  *This,
  IN CONST EFI_SPI_PERIPHERAL   *SpiPeripheral
  );
 
typedef struct _EFI_SPI_BUS_TRANSACTION {
  CONST EFI_SPI_PERIPHERAL    *SpiPeripheral;
 
  EFI_SPI_TRANSACTION_TYPE    TransactionType;
 
  BOOLEAN                     DebugTransaction;
 
  UINT32                      BusWidth;
 
  UINT32                      FrameSize;
 
  UINT32                      WriteBytes;
 
  UINT8                       *WriteBuffer;
 
  UINT32                      ReadBytes;
 
  UINT8                       *ReadBuffer;
} EFI_SPI_BUS_TRANSACTION;
 
#define SPI_IO_SUPPORTS_2_BIT_DATA_BUS_WIDTH   BIT0
#define SPI_IO_SUPPORTS_4_BIT_DATA_BUS_WIDTH   BIT1
#define SPI_IO_SUPPORTS_8_BIT_DATA_BUS_WIDTH   BIT2
#define SPI_IO_TRANSFER_SIZE_INCLUDES_OPCODE   BIT3
#define SPI_IO_TRANSFER_SIZE_INCLUDES_ADDRESS  BIT4
 
struct _EFI_SPI_IO_PROTOCOL {
  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;
};
 
#endif // __SPI_IO_PROTOCOL_H__