/** @file\r
DMA abstraction library APIs. Based on UEFI PCI IO protocol DMA abstractions.\r
- At some point these functions will probably end up in a non PCI protocol \r
+ At some point these functions will probably end up in a non PCI protocol\r
for embedded systems.\r
\r
DMA Bus Master Read Operation:\r
- Call DmaMap() for MapOperationBusMasterRead. \r
- Program the DMA Bus Master with the DeviceAddress returned by DmaMap(). \r
- Start the DMA Bus Master. \r
- Wait for DMA Bus Master to complete the read operation. \r
+ Call DmaMap() for MapOperationBusMasterRead.\r
+ Program the DMA Bus Master with the DeviceAddress returned by DmaMap().\r
+ Start the DMA Bus Master.\r
+ Wait for DMA Bus Master to complete the read operation.\r
Call DmaUnmap().\r
\r
DMA Bus Master Write Operation:\r
Call DmaUnmap().\r
\r
DMA Bus Master Common Buffer Operation:\r
- Call DmaAllocateBuffer() to allocate a common buffer. \r
- Call DmaMap() for MapOperationBusMasterCommonBuffer. \r
- Program the DMA Bus Master with the DeviceAddress returned by DmaMap(). \r
- The common buffer can now be accessed equally by the processor and the DMA bus master. \r
- Call DmaUnmap(). \r
+ Call DmaAllocateBuffer() to allocate a common buffer.\r
+ Call DmaMap() for MapOperationBusMasterCommonBuffer.\r
+ Program the DMA Bus Master with the DeviceAddress returned by DmaMap().\r
+ The common buffer can now be accessed equally by the processor and the DMA bus master.\r
+ Call DmaUnmap().\r
Call DmaFreeBuffer().\r
\r
Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
\r
\r
\r
-/** \r
+/**\r
Provides the DMA controller-specific addresses needed to access system memory.\r
- \r
+\r
Operation is relative to the DMA bus master.\r
- \r
+\r
@param Operation Indicates if the bus master is going to read or write to system memory.\r
@param HostAddress The system memory address to map to the DMA controller.\r
@param NumberOfBytes On input the number of bytes to map. On output the number of bytes\r
- that were mapped. \r
+ that were mapped.\r
@param DeviceAddress The resulting map address for the bus master controller to use to\r
- access the hosts HostAddress. \r
+ access the hosts HostAddress.\r
@param Mapping A resulting value to pass to DmaUnmap().\r
- \r
+\r
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.\r
- @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. \r
+ @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
\r
\r
-/** \r
+/**\r
Completes the DmaMapBusMasterRead, DmaMapBusMasterWrite, or DmaMapBusMasterCommonBuffer\r
operation and releases any corresponding resources.\r
- \r
+\r
@param Mapping The mapping value returned from DmaMap().\r
- \r
+\r
@retval EFI_SUCCESS The range was unmapped.\r
@retval EFI_DEVICE_ERROR The data was not committed to the target system memory.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
\r
-/** \r
+/**\r
Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer.\r
- mapping. \r
- \r
+ mapping.\r
+\r
@param MemoryType The type of memory to allocate, EfiBootServicesData or\r
- EfiRuntimeServicesData. \r
- @param Pages The number of pages to allocate. \r
+ EfiRuntimeServicesData.\r
+ @param Pages The number of pages to allocate.\r
@param HostAddress A pointer to store the base system memory address of the\r
- allocated range. \r
+ allocated range.\r
\r
@retval EFI_SUCCESS The requested memory pages were allocated.\r
@retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are\r
- MEMORY_WRITE_COMBINE and MEMORY_CACHED. \r
+ MEMORY_WRITE_COMBINE and MEMORY_CACHED.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
- @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. \r
- \r
+ @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.\r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
\r
-/** \r
+/**\r
Frees memory that was allocated with DmaAllocateBuffer().\r
- \r
- @param Pages The number of pages to free. \r
- @param HostAddress The base system memory address of the allocated range. \r
- \r
+\r
+ @param Pages The number of pages to free.\r
+ @param HostAddress The base system memory address of the allocated range.\r
+\r
@retval EFI_SUCCESS The requested memory pages were freed.\r
@retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages\r
was not allocated with DmaAllocateBuffer().\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
\r
-#endif \r
+#endif\r
\r
projects / mirror_edk2.git / blobdiff