IoMmu.h

Go to the documentation of this file.

 
#ifndef __IOMMU_H__
#define __IOMMU_H__
 
//
// IOMMU Protocol GUID value
//
#define EDKII_IOMMU_PROTOCOL_GUID \
    { \
      0x4e939de9, 0xd948, 0x4b0f, { 0x88, 0xed, 0xe6, 0xe1, 0xce, 0x51, 0x7c, 0x1e } \
    }
 
//
// Forward reference for pure ANSI compatability
//
typedef struct _EDKII_IOMMU_PROTOCOL EDKII_IOMMU_PROTOCOL;
 
//
// Revision The revision to which the IOMMU interface adheres.
//          All future revisions must be backwards compatible.
//          If a future version is not back wards compatible it is not the same GUID.
//
#define EDKII_IOMMU_PROTOCOL_REVISION  0x00010000
 
//
// IOMMU Access for SetAttribute
//
// These types can be "ORed" together as needed.
// Any undefined bits are reserved and must be zero.
//
#define EDKII_IOMMU_ACCESS_READ   0x1
#define EDKII_IOMMU_ACCESS_WRITE  0x2
 
//
// IOMMU Operation for Map
//
typedef enum {
  EdkiiIoMmuOperationBusMasterRead,
  EdkiiIoMmuOperationBusMasterWrite,
  EdkiiIoMmuOperationBusMasterCommonBuffer,
  EdkiiIoMmuOperationBusMasterRead64,
  EdkiiIoMmuOperationBusMasterWrite64,
  EdkiiIoMmuOperationBusMasterCommonBuffer64,
  EdkiiIoMmuOperationMaximum
} EDKII_IOMMU_OPERATION;
 
//
// IOMMU attribute for AllocateBuffer
// Any undefined bits are reserved and must be zero.
//
#define EDKII_IOMMU_ATTRIBUTE_MEMORY_WRITE_COMBINE  0x0080
#define EDKII_IOMMU_ATTRIBUTE_MEMORY_CACHED         0x0800
#define EDKII_IOMMU_ATTRIBUTE_DUAL_ADDRESS_CYCLE    0x8000
 
#define EDKII_IOMMU_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER  (EDKII_IOMMU_ATTRIBUTE_MEMORY_WRITE_COMBINE | EDKII_IOMMU_ATTRIBUTE_MEMORY_CACHED | EDKII_IOMMU_ATTRIBUTE_DUAL_ADDRESS_CYCLE)
 
#define EDKII_IOMMU_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER  (~EDKII_IOMMU_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER)
 
typedef
EFI_STATUS
(EFIAPI *EDKII_IOMMU_SET_ATTRIBUTE)(
  IN EDKII_IOMMU_PROTOCOL  *This,
  IN EFI_HANDLE            DeviceHandle,
  IN VOID                  *Mapping,
  IN UINT64                IoMmuAccess
  );
 
typedef
EFI_STATUS
(EFIAPI *EDKII_IOMMU_MAP)(
  IN     EDKII_IOMMU_PROTOCOL                       *This,
  IN     EDKII_IOMMU_OPERATION                      Operation,
  IN     VOID                                       *HostAddress,
  IN OUT UINTN                                      *NumberOfBytes,
  OUT    EFI_PHYSICAL_ADDRESS                       *DeviceAddress,
  OUT    VOID                                       **Mapping
  );
 
typedef
EFI_STATUS
(EFIAPI *EDKII_IOMMU_UNMAP)(
  IN  EDKII_IOMMU_PROTOCOL                     *This,
  IN  VOID                                     *Mapping
  );
 
typedef
EFI_STATUS
(EFIAPI *EDKII_IOMMU_ALLOCATE_BUFFER)(
  IN     EDKII_IOMMU_PROTOCOL                     *This,
  IN     EFI_ALLOCATE_TYPE                        Type,
  IN     EFI_MEMORY_TYPE                          MemoryType,
  IN     UINTN                                    Pages,
  IN OUT VOID                                     **HostAddress,
  IN     UINT64                                   Attributes
  );
 
typedef
EFI_STATUS
(EFIAPI *EDKII_IOMMU_FREE_BUFFER)(
  IN  EDKII_IOMMU_PROTOCOL                     *This,
  IN  UINTN                                    Pages,
  IN  VOID                                     *HostAddress
  );
 
struct _EDKII_IOMMU_PROTOCOL {
  UINT64                         Revision;
  EDKII_IOMMU_SET_ATTRIBUTE      SetAttribute;
  EDKII_IOMMU_MAP                Map;
  EDKII_IOMMU_UNMAP              Unmap;
  EDKII_IOMMU_ALLOCATE_BUFFER    AllocateBuffer;
  EDKII_IOMMU_FREE_BUFFER        FreeBuffer;
};
 
extern EFI_GUID  gEdkiiIoMmuProtocolGuid;
 
#endif