DmaMem.c File Reference

#include "NvmExpressPei.h"

Go to the source code of this file.

Functions
EDKII_IOMMU_PPI *	GetIoMmu (VOID)
EFI_STATUS	IoMmuMap (IN EDKII_IOMMU_OPERATION Operation, IN VOID *HostAddress, IN OUT UINTN *NumberOfBytes, OUT EFI_PHYSICAL_ADDRESS *DeviceAddress, OUT VOID **Mapping)
EFI_STATUS	IoMmuUnmap (IN VOID *Mapping)
EFI_STATUS	IoMmuAllocateBuffer (IN UINTN Pages, OUT VOID **HostAddress, OUT EFI_PHYSICAL_ADDRESS *DeviceAddress, OUT VOID **Mapping)
EFI_STATUS	IoMmuFreeBuffer (IN UINTN Pages, IN VOID *HostAddress, IN VOID *Mapping)

Detailed Description

The DMA memory help function.

Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DmaMem.c.

Function Documentation

GetIoMmu()

EDKII_IOMMU_PPI * GetIoMmu

(

VOID

)

Get IOMMU PPI.

Returns

Pointer to IOMMU PPI.

Definition at line 19 of file DmaMem.c.

IoMmuAllocateBuffer()

EFI_STATUS IoMmuAllocateBuffer	(	IN UINTN	Pages,
		OUT VOID **	HostAddress,
		OUT EFI_PHYSICAL_ADDRESS *	DeviceAddress,
		OUT VOID **	Mapping
	)

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

Parameters

Pages	The number of pages to allocate.
HostAddress	A pointer to store the base system memory address of the allocated range.
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 requested memory pages were allocated.
EFI_UNSUPPORTED	Attributes is unsupported. The only legal attribute bits are MEMORY_WRITE_COMBINE and MEMORY_CACHED.
EFI_INVALID_PARAMETER	One or more parameters are invalid.
EFI_OUT_OF_RESOURCES	The memory pages could not be allocated.

Definition at line 170 of file DmaMem.c.

IoMmuFreeBuffer()

EFI_STATUS IoMmuFreeBuffer	(	IN UINTN	Pages,
		IN VOID *	HostAddress,
		IN VOID *	Mapping
	)

Frees memory that was allocated with AllocateBuffer().

Parameters

Pages	The number of pages to free.
HostAddress	The base system memory address of the allocated range.
Mapping	The mapping value returned from Map().

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().

Definition at line 251 of file DmaMem.c.

IoMmuMap()

EFI_STATUS IoMmuMap	(	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

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.

Definition at line 60 of file DmaMem.c.

IoMmuUnmap()

EFI_STATUS IoMmuUnmap

(

IN VOID *

Mapping

)

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

Parameters

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.

Definition at line 132 of file DmaMem.c.