SpiConfiguration.h

Go to the documentation of this file.

 
#ifndef __SPI_CONFIGURATION_PROTOCOL_H__
#define __SPI_CONFIGURATION_PROTOCOL_H__
 
#define EFI_SPI_CONFIGURATION_GUID  \
  { 0x85a6d3e6, 0xb65b, 0x4afc,     \
    { 0xb3, 0x8f, 0xc6, 0xd5, 0x4a, 0xf6, 0xdd, 0xc8 }}
 
#define Hz(Frequency)   (Frequency)
#define KHz(Frequency)  (1000 * Hz (Frequency))
#define MHz(Frequency)  (1000 * KHz (Frequency))
 
typedef struct _EFI_SPI_PERIPHERAL EFI_SPI_PERIPHERAL;
 
typedef
EFI_STATUS
(EFIAPI *EFI_SPI_CHIP_SELECT)(
  IN CONST EFI_SPI_PERIPHERAL  *SpiPeripheral,
  IN BOOLEAN                   PinValue
  );
 
typedef EFI_STATUS
(EFIAPI *EFI_SPI_CLOCK)(
  IN CONST EFI_SPI_PERIPHERAL  *SpiPeripheral,
  IN UINT32                    *ClockHz
  );
 
typedef struct _EFI_SPI_PART {
  CONST CHAR16    *Vendor;
 
  CONST CHAR16    *PartNumber;
 
  UINT32          MinClockHz;
 
  UINT32          MaxClockHz;
 
  BOOLEAN         ChipSelectPolarity;
} EFI_SPI_PART;
 
typedef struct _EFI_SPI_BUS {
  CONST CHAR16                      *FriendlyName;
 
  CONST EFI_SPI_PERIPHERAL          *Peripherallist;
 
  CONST EFI_DEVICE_PATH_PROTOCOL    *ControllerPath;
 
  EFI_SPI_CLOCK                     Clock;
 
  VOID    *ClockParameter;
} EFI_SPI_BUS;
 
#define SPI_PART_SUPPORTS_2_BIT_DATA_BUS_WIDTH  BIT0
#define SPI_PART_SUPPORTS_4_BIT_DATA_BUS_WIDTH  BIT1
#define SPI_PART_SUPPORTS_8_BIT_DATA_BUS_WIDTH  BIT2
 
struct _EFI_SPI_PERIPHERAL {
  CONST EFI_SPI_PERIPHERAL    *NextSpiPeripheral;
 
  CONST CHAR16                *FriendlyName;
 
  CONST GUID            *SpiPeripheralDriverGuid;
 
  CONST EFI_SPI_PART    *SpiPart;
 
  UINT32                MaxClockHz;
 
  BOOLEAN               ClockPolarity;
 
  BOOLEAN               ClockPhase;
 
  UINT32                 Attributes;
 
  CONST VOID             *ConfigurationData;
 
  CONST EFI_SPI_BUS      *SpiBus;
 
  EFI_SPI_CHIP_SELECT    ChipSelect;
 
  VOID    *ChipSelectParameter;
};
 
typedef struct _EFI_SPI_CONFIGURATION_PROTOCOL {
  UINT32                             BusCount;
 
  CONST EFI_SPI_BUS *CONST *CONST    Buslist;
} EFI_SPI_CONFIGURATION_PROTOCOL;
 
extern EFI_GUID  gEfiSpiConfigurationProtocolGuid;
 
#endif // __SPI_CONFIGURATION_PROTOCOL_H__