IoMmu.h File Reference

Data Structures
struct	_EDKII_IOMMU_PPI

Macros
#define	EDKII_IOMMU_PPI_GUID
#define	EDKII_IOMMU_PPI_REVISION   0x00010000

Typedefs
typedef struct _EDKII_IOMMU_PPI	EDKII_IOMMU_PPI
typedef EFI_STATUS(EFIAPI *	EDKII_PEI_IOMMU_SET_ATTRIBUTE )(IN EDKII_IOMMU_PPI *This, IN VOID *Mapping, IN UINT64 IoMmuAccess)
typedef EFI_STATUS(EFIAPI *	EDKII_PEI_IOMMU_MAP )(IN EDKII_IOMMU_PPI *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_PEI_IOMMU_UNMAP )(IN EDKII_IOMMU_PPI *This, IN VOID *Mapping)
typedef EFI_STATUS(EFIAPI *	EDKII_PEI_IOMMU_ALLOCATE_BUFFER )(IN EDKII_IOMMU_PPI *This, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, IN OUT VOID **HostAddress, IN UINT64 Attributes)
typedef EFI_STATUS(EFIAPI *	EDKII_PEI_IOMMU_FREE_BUFFER )(IN EDKII_IOMMU_PPI *This, IN UINTN Pages, IN VOID *HostAddress)

Variables
EFI_GUID	gEdkiiIoMmuPpiGuid

Detailed Description

PEI IOMMU PPI.

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

Macro Definition Documentation

#define EDKII_IOMMU_PPI_GUID

Value:

{ \
      0x70b0af26, 0xf847, 0x4bb6, { 0xaa, 0xb9, 0xcd, 0xe8, 0x4f, 0xc6, 0x14, 0x31 } \
    }

#define EDKII_IOMMU_PPI_REVISION   0x00010000

Typedef Documentation

typedef struct _EDKII_IOMMU_PPI EDKII_IOMMU_PPI

typedef EFI_STATUS(EFIAPI * EDKII_PEI_IOMMU_ALLOCATE_BUFFER)(IN EDKII_IOMMU_PPI *This, 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 PPI instance pointer.
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.
EFI_NOT_AVAILABLE_YET	DMA protection has been enabled, but DMA buffer are not available to be allocated yet.

typedef EFI_STATUS(EFIAPI * EDKII_PEI_IOMMU_FREE_BUFFER)(IN EDKII_IOMMU_PPI *This, IN UINTN Pages, IN VOID *HostAddress)

Frees memory that was allocated with AllocateBuffer().

Parameters

This	The PPI 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().
EFI_NOT_AVAILABLE_YET	DMA protection has been enabled, but DMA buffer are not available to be allocated yet.

typedef EFI_STATUS(EFIAPI * EDKII_PEI_IOMMU_MAP)(IN EDKII_IOMMU_PPI *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 PPI 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.
EFI_NOT_AVAILABLE_YET	DMA protection has been enabled, but DMA buffer are not available to be allocated yet.

typedef EFI_STATUS(EFIAPI * EDKII_PEI_IOMMU_SET_ATTRIBUTE)(IN EDKII_IOMMU_PPI *This, IN VOID *Mapping, IN UINT64 IoMmuAccess)

Set IOMMU attribute for a system memory.

If the IOMMU PPI 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).

Parameters

[in]	This	The PPI instance pointer.
[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	Mapping is not a value that was returned by Map().
EFI_INVALID_PARAMETER	IoMmuAccess specified an illegal combination of access.
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.
EFI_NOT_AVAILABLE_YET	DMA protection has been enabled, but DMA buffer are not available to be allocated yet.

typedef EFI_STATUS(EFIAPI * EDKII_PEI_IOMMU_UNMAP)(IN EDKII_IOMMU_PPI *This, IN VOID *Mapping)

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

Parameters

This	The PPI 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.
EFI_NOT_AVAILABLE_YET	DMA protection has been enabled, but DMA buffer are not available to be allocated yet.

Variable Documentation

EFI_GUID gEdkiiIoMmuPpiGuid

IOMMU PPI GUID variable.