SpiHc.h

Go to the documentation of this file.

 
#ifndef __SPI_HC_PROTOCOL_H__
#define __SPI_HC_PROTOCOL_H__
 
#include <Protocol/SpiConfiguration.h>
#include <Protocol/SpiIo.h>
 
#define EFI_SPI_HOST_GUID  \
  { 0xc74e5db2, 0xfa96, 0x4ae2,   \
    { 0xb3, 0x99, 0x15, 0x97, 0x7f, 0xe3, 0x0, 0x2d }}
 
#define EFI_SPI_HC_PROTOCOL_GUID  EFI_SPI_HOST_GUID
 
typedef struct _EFI_SPI_HC_PROTOCOL EFI_SPI_HC_PROTOCOL;
 
typedef EFI_STATUS
(EFIAPI *EFI_SPI_HC_PROTOCOL_CHIP_SELECT)(
  IN CONST EFI_SPI_HC_PROTOCOL  *This,
  IN CONST EFI_SPI_PERIPHERAL   *SpiPeripheral,
  IN BOOLEAN                    PinValue
  );
 
typedef EFI_STATUS
(EFIAPI *EFI_SPI_HC_PROTOCOL_CLOCK)(
  IN CONST EFI_SPI_HC_PROTOCOL  *This,
  IN CONST EFI_SPI_PERIPHERAL   *SpiPeripheral,
  IN UINT32                      *ClockHz
  );
 
typedef EFI_STATUS
(EFIAPI *EFI_SPI_HC_PROTOCOL_TRANSACTION)(
  IN CONST EFI_SPI_HC_PROTOCOL  *This,
  IN EFI_SPI_BUS_TRANSACTION    *BusTransaction
  );
 
#define HC_SUPPORTS_WRITE_ONLY_OPERATIONS       BIT0
#define HC_SUPPORTS_READ_ONLY_OPERATIONS        BIT1
#define HC_SUPPORTS_WRITE_THEN_READ_OPERATIONS  BIT2
#define HC_TX_FRAME_IN_MOST_SIGNIFICANT_BITS    BIT3
#define HC_RX_FRAME_IN_MOST_SIGNIFICANT_BITS    BIT4
#define HC_SUPPORTS_2_BIT_DATA_BUS_WIDTH        BIT5
#define HC_SUPPORTS_4_BIT_DATA_BUS_WIDTH        BIT6
#define HC_SUPPORTS_8_BIT_DATA_BUS_WIDTH        BIT7
#define HC_TRANSFER_SIZE_INCLUDES_OPCODE        BIT8
#define HC_TRANSFER_SIZE_INCLUDES_ADDRESS       BIT9
struct _EFI_SPI_HC_PROTOCOL {
  UINT32                             Attributes;
 
  UINT32                             FrameSizeSupportMask;
 
  UINT32                             MaximumTransferBytes;
 
  EFI_SPI_HC_PROTOCOL_CHIP_SELECT    ChipSelect;
 
  EFI_SPI_HC_PROTOCOL_CLOCK          Clock;
 
  EFI_SPI_HC_PROTOCOL_TRANSACTION    Transaction;
};
 
extern EFI_GUID  gEfiSpiHcProtocolGuid;
 
#endif // __SPI_HC_PROTOCOL_H__