MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 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
ThisThe PPI instance pointer.
MemoryTypeThe type of memory to allocate, EfiBootServicesData or EfiRuntimeServicesData.
PagesThe number of pages to allocate.
HostAddressA pointer to store the base system memory address of the allocated range.
AttributesThe requested bit mask of attributes for the allocated range.
Return values
EFI_SUCCESSThe requested memory pages were allocated.
EFI_UNSUPPORTEDAttributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE, MEMORY_CACHED and DUAL_ADDRESS_CYCLE.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_OUT_OF_RESOURCESThe memory pages could not be allocated.
EFI_NOT_AVAILABLE_YETDMA 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
ThisThe PPI instance pointer.
PagesThe number of pages to free.
HostAddressThe base system memory address of the allocated range.
Return values
EFI_SUCCESSThe requested memory pages were freed.
EFI_INVALID_PARAMETERThe memory range specified by HostAddress and Pages was not allocated with AllocateBuffer().
EFI_NOT_AVAILABLE_YETDMA 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
ThisThe PPI instance pointer.
OperationIndicates if the bus master is going to read or write to system memory.
HostAddressThe system memory address to map to the PCI controller.
NumberOfBytesOn input the number of bytes to map. On output the number of bytes that were mapped.
DeviceAddressThe resulting map address for the bus master PCI controller to use to access the hosts HostAddress.
MappingA resulting value to pass to Unmap().
Return values
EFI_SUCCESSThe range was mapped for the returned NumberOfBytes.
EFI_UNSUPPORTEDThe HostAddress cannot be mapped as a common buffer.
EFI_INVALID_PARAMETEROne or more parameters are invalid.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
EFI_DEVICE_ERRORThe system hardware could not map the requested address.
EFI_NOT_AVAILABLE_YETDMA 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]ThisThe PPI instance pointer.
[in]MappingThe mapping value returned from Map().
[in]IoMmuAccessThe IOMMU access.
Return values
EFI_SUCCESSThe IoMmuAccess is set for the memory range specified by DeviceAddress and Length.
EFI_INVALID_PARAMETERMapping is not a value that was returned by Map().
EFI_INVALID_PARAMETERIoMmuAccess specified an illegal combination of access.
EFI_UNSUPPORTEDThe bit mask of IoMmuAccess is not supported by the IOMMU.
EFI_UNSUPPORTEDThe IOMMU does not support the memory range specified by Mapping.
EFI_OUT_OF_RESOURCESThere are not enough resources available to modify the IOMMU access.
EFI_DEVICE_ERRORThe IOMMU device reported an error while attempting the operation.
EFI_NOT_AVAILABLE_YETDMA 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
ThisThe PPI instance pointer.
MappingThe mapping value returned from Map().
Return values
EFI_SUCCESSThe range was unmapped.
EFI_INVALID_PARAMETERMapping is not a value that was returned by Map().
EFI_DEVICE_ERRORThe data was not committed to the target system memory.
EFI_NOT_AVAILABLE_YETDMA protection has been enabled, but DMA buffer are not available to be allocated yet.

Variable Documentation

EFI_GUID gEdkiiIoMmuPpiGuid

IOMMU PPI GUID variable.