IoMmu.h File Reference

Data Structures
struct	_EDKII_IOMMU_PROTOCOL

Macros
#define	EDKII_IOMMU_PROTOCOL_GUID
#define	EDKII_IOMMU_PROTOCOL_REVISION   0x00010000
#define	EDKII_IOMMU_ACCESS_READ   0x1
#define	EDKII_IOMMU_ACCESS_WRITE   0x2
#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)

Typedefs
typedef struct _EDKII_IOMMU_PROTOCOL	EDKII_IOMMU_PROTOCOL
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)

Enumerations
enum	EDKII_IOMMU_OPERATION {   EdkiiIoMmuOperationBusMasterRead, EdkiiIoMmuOperationBusMasterWrite, EdkiiIoMmuOperationBusMasterCommonBuffer, EdkiiIoMmuOperationBusMasterRead64,   EdkiiIoMmuOperationBusMasterWrite64, EdkiiIoMmuOperationBusMasterCommonBuffer64, EdkiiIoMmuOperationMaximum }

Variables
EFI_GUID	gEdkiiIoMmuProtocolGuid

Detailed Description

EFI IOMMU Protocol.

Copyright (c) 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EDKII_IOMMU_ACCESS_READ   0x1

#define EDKII_IOMMU_ACCESS_WRITE   0x2

#define EDKII_IOMMU_ATTRIBUTE_DUAL_ADDRESS_CYCLE   0x8000

#define EDKII_IOMMU_ATTRIBUTE_INVALID_FOR_ALLOCATE_BUFFER   (~EDKII_IOMMU_ATTRIBUTE_VALID_FOR_ALLOCATE_BUFFER)

#define EDKII_IOMMU_ATTRIBUTE_MEMORY_CACHED   0x0800

#define EDKII_IOMMU_ATTRIBUTE_MEMORY_WRITE_COMBINE   0x0080

#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_PROTOCOL_GUID

Value:

{ \
      0x4e939de9, 0xd948, 0x4b0f, { 0x88, 0xed, 0xe6, 0xe1, 0xce, 0x51, 0x7c, 0x1e } \
    }

#define EDKII_IOMMU_PROTOCOL_REVISION   0x00010000

Typedef Documentation

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)

Allocates pages that are suitable for an OperationBusMasterCommonBuffer or OperationBusMasterCommonBuffer64 mapping.

Parameters

This	The protocol instance pointer.
Type	This parameter is not used and must be ignored.
MemoryType	The type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
Pages	The number of pages to allocate.
HostAddress	A pointer to store the base system memory address of the allocated range.
Attributes	The requested bit mask of attributes for the allocated range.

Return values

EFI_SUCCESS	The requested memory pages were allocated.
EFI_UNSUPPORTED	Attributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE, MEMORY_CACHED and DUAL_ADDRESS_CYCLE.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_OUT_OF_RESOURCES	The memory pages could not be allocated.

typedef EFI_STATUS(EFIAPI * EDKII_IOMMU_FREE_BUFFER)(IN EDKII_IOMMU_PROTOCOL *This, IN UINTN Pages, IN VOID *HostAddress)

Frees memory that was allocated with AllocateBuffer().

Parameters

This	The protocol instance pointer.
Pages	The number of pages to free.
HostAddress	The base system memory address of the allocated range.

Return values

EFI_SUCCESS	The requested memory pages were freed.
EFI_INVALID_PARAMETER	The memory range specified by HostAddress and Pages was not allocated with AllocateBuffer().

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)

Provides the controller-specific addresses required to access system memory from a DMA bus master.

Parameters

This	The protocol instance pointer.
Operation	Indicates if the bus master is going to read or write to system memory.
HostAddress	The system memory address to map to the PCI controller.
NumberOfBytes	On input the number of bytes to map. On output the number of bytes that were mapped.
DeviceAddress	The resulting map address for the bus master PCI controller to use to access the hosts HostAddress.
Mapping	A resulting value to pass to Unmap().

Return values

EFI_SUCCESS	The range was mapped for the returned NumberOfBytes.
EFI_UNSUPPORTED	The HostAddress cannot be mapped as a common buffer.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.
EFI_DEVICE_ERROR	The system hardware could not map the requested address.

typedef struct _EDKII_IOMMU_PROTOCOL EDKII_IOMMU_PROTOCOL

typedef EFI_STATUS(EFIAPI * EDKII_IOMMU_SET_ATTRIBUTE)(IN EDKII_IOMMU_PROTOCOL *This, IN EFI_HANDLE DeviceHandle, IN VOID *Mapping, IN UINT64 IoMmuAccess)

Set IOMMU attribute for a system memory.

If the IOMMU protocol exists, the system memory cannot be used for DMA by default.

When a device requests a DMA access for a system memory, the device driver need use SetAttribute() to update the IOMMU attribute to request DMA access (read and/or write).

The DeviceHandle is used to identify which device submits the request. The IOMMU implementation need translate the device path to an IOMMU device ID, and set IOMMU hardware register accordingly. 1) DeviceHandle can be a standard PCI device. The memory for BusMasterRead need set EDKII_IOMMU_ACCESS_READ. The memory for BusMasterWrite need set EDKII_IOMMU_ACCESS_WRITE. The memory for BusMasterCommonBuffer need set EDKII_IOMMU_ACCESS_READ|EDKII_IOMMU_ACCESS_WRITE. After the memory is used, the memory need set 0 to keep it being protected. 2) DeviceHandle can be an ACPI device (ISA, I2C, SPI, etc). The memory for DMA access need set EDKII_IOMMU_ACCESS_READ and/or EDKII_IOMMU_ACCESS_WRITE.

Parameters

[in]	This	The protocol instance pointer.
[in]	DeviceHandle	The device who initiates the DMA access request.
[in]	Mapping	The mapping value returned from Map().
[in]	IoMmuAccess	The IOMMU access.

Return values

EFI_SUCCESS	The IoMmuAccess is set for the memory range specified by DeviceAddress and Length.
EFI_INVALID_PARAMETER	DeviceHandle is an invalid handle.
EFI_INVALID_PARAMETER	Mapping is not a value that was returned by Map().
EFI_INVALID_PARAMETER	IoMmuAccess specified an illegal combination of access.
EFI_UNSUPPORTED	DeviceHandle is unknown by the IOMMU.
EFI_UNSUPPORTED	The bit mask of IoMmuAccess is not supported by the IOMMU.
EFI_UNSUPPORTED	The IOMMU does not support the memory range specified by Mapping.
EFI_OUT_OF_RESOURCES	There are not enough resources available to modify the IOMMU access.
EFI_DEVICE_ERROR	The IOMMU device reported an error while attempting the operation.

typedef EFI_STATUS(EFIAPI * EDKII_IOMMU_UNMAP)(IN EDKII_IOMMU_PROTOCOL *This, IN VOID *Mapping)

Completes the Map() operation and releases any corresponding resources.

Parameters

This	The protocol instance pointer.
Mapping	The mapping value returned from Map().

Return values

EFI_SUCCESS	The range was unmapped.
EFI_INVALID_PARAMETER	Mapping is not a value that was returned by Map().
EFI_DEVICE_ERROR	The data was not committed to the target system memory.

Enumeration Type Documentation

enum EDKII_IOMMU_OPERATION

Enumerator
EdkiiIoMmuOperationBusMasterRead	A read operation from system memory by a bus master that is not capable of producing PCI dual address cycles.
EdkiiIoMmuOperationBusMasterWrite	A write operation from system memory by a bus master that is not capable of producing PCI dual address cycles.
EdkiiIoMmuOperationBusMasterCommonBuffer	Provides both read and write access to system memory by both the processor and a bus master that is not capable of producing PCI dual address cycles.
EdkiiIoMmuOperationBusMasterRead64	A read operation from system memory by a bus master that is capable of producing PCI dual address cycles.
EdkiiIoMmuOperationBusMasterWrite64	A write operation to system memory by a bus master that is capable of producing PCI dual address cycles.
EdkiiIoMmuOperationBusMasterCommonBuffer64	Provides both read and write access to system memory by both the processor and a bus master that is capable of producing PCI dual address cycles.
EdkiiIoMmuOperationMaximum

Variable Documentation

EFI_GUID gEdkiiIoMmuProtocolGuid

IOMMU Protocol GUID variable.