DeviceIo.h

Go to the documentation of this file.

 
#ifndef __DEVICE_IO_H__
#define __DEVICE_IO_H__
 
#define EFI_DEVICE_IO_PROTOCOL_GUID \
  { \
    0xaf6ac311, 0x84c3, 0x11d2, {0x8e, 0x3c, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }
 
typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;
 
#define DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_PROTOCOL_GUID
 
typedef EFI_DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_INTERFACE;
 
typedef enum {
  IO_UINT8  = 0,
  IO_UINT16 = 1,
  IO_UINT32 = 2,
  IO_UINT64 = 3,
  //
  // Below enumerations are added in "Extensible Firmware Interface Specification,
  // Version 1.10, Specification Update, Version 001".
  //
  MMIO_COPY_UINT8  = 4,
  MMIO_COPY_UINT16 = 5,
  MMIO_COPY_UINT32 = 6,
  MMIO_COPY_UINT64 = 7
} EFI_IO_WIDTH;
 
typedef
EFI_STATUS
(EFIAPI *EFI_DEVICE_IO)(
  IN EFI_DEVICE_IO_PROTOCOL         *This,
  IN EFI_IO_WIDTH                   Width,
  IN UINT64                         Address,
  IN UINTN                          Count,
  IN OUT VOID                       *Buffer
  );
 
typedef struct {
  EFI_DEVICE_IO Read;
  EFI_DEVICE_IO Write;
} EFI_IO_ACCESS;
 
typedef
EFI_STATUS
(EFIAPI *EFI_PCI_DEVICE_PATH)(
  IN EFI_DEVICE_IO_PROTOCOL           *This,
  IN UINT64                           PciAddress,
  IN OUT EFI_DEVICE_PATH_PROTOCOL     **PciDevicePath
  );
 
typedef enum {
  EfiBusMasterRead,
 
  EfiBusMasterWrite,
 
  EfiBusMasterCommonBuffer
} EFI_IO_OPERATION_TYPE;
 
typedef
EFI_STATUS
(EFIAPI *EFI_IO_MAP)(
  IN EFI_DEVICE_IO_PROTOCOL           *This,
  IN EFI_IO_OPERATION_TYPE            Operation,
  IN EFI_PHYSICAL_ADDRESS             *HostAddress,
  IN OUT UINTN                        *NumberOfBytes,
  OUT EFI_PHYSICAL_ADDRESS            *DeviceAddress,
  OUT VOID                            **Mapping
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_IO_UNMAP)(
  IN EFI_DEVICE_IO_PROTOCOL           *This,
  IN VOID                             *Mapping
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_IO_ALLOCATE_BUFFER)(
  IN EFI_DEVICE_IO_PROTOCOL           *This,
  IN EFI_ALLOCATE_TYPE                Type,
  IN EFI_MEMORY_TYPE                  MemoryType,
  IN UINTN                            Pages,
  IN OUT EFI_PHYSICAL_ADDRESS         *HostAddress
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_IO_FLUSH)(
  IN EFI_DEVICE_IO_PROTOCOL  *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_IO_FREE_BUFFER)(
  IN EFI_DEVICE_IO_PROTOCOL           *This,
  IN UINTN                            Pages,
  IN EFI_PHYSICAL_ADDRESS             HostAddress
  );
 
struct _EFI_DEVICE_IO_PROTOCOL {
  EFI_IO_ACCESS           Mem;
  EFI_IO_ACCESS           Io;
  EFI_IO_ACCESS           Pci;
  EFI_IO_MAP              Map;
  EFI_PCI_DEVICE_PATH     PciDevicePath;
  EFI_IO_UNMAP            Unmap;
  EFI_IO_ALLOCATE_BUFFER  AllocateBuffer;
  EFI_IO_FLUSH            Flush;
  EFI_IO_FREE_BUFFER      FreeBuffer;
};
 
extern EFI_GUID gEfiDeviceIoProtocolGuid;
 
#endif