-/** @file
- DMA abstraction library APIs. Based on UEFI PCI IO protocol DMA abstractions.
- At some point these functions will probably end up in a non PCI protocol
- for embedded systems.
-
+/** @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
+ for embedded systems.\r
+\r
DMA Bus Master Read Operation:\r
- Call DmaMap() for MapOperationBusMasterRead.
- Program the DMA Bus Master with the DeviceAddress returned by DmaMap().
- Start the DMA Bus Master.
- Wait for DMA Bus Master to complete the read operation.
- Call DmaUnmap().
-
- DMA Bus Master Write Operation:
+ 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 DmaMap() for MapOperationBusMasterWrite.\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 write operation.\r
- Call DmaUnmap().
-
- DMA Bus Master Common Buffer Operation:
- Call DmaAllocateBuffer() to allocate a common buffer.
- Call DmaMap() for MapOperationBusMasterCommonBuffer.
- Program the DMA Bus Master with the DeviceAddress returned by DmaMap().
- The common buffer can now be accessed equally by the processor and the DMA bus master.
- Call DmaUnmap().
- Call DmaFreeBuffer().
-
- Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
-
- This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#ifndef __DMA_LIB_H__
-#define __DMA_LIB_H__
-
+ 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 DmaFreeBuffer().\r
+\r
+ Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
+\r
+ This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __DMA_LIB_H__\r
+#define __DMA_LIB_H__\r
+\r
typedef enum {\r
///\r
/// A read operation from system memory by a bus master.\r
MapOperationBusMasterCommonBuffer,\r
MapOperationMaximum\r
} DMA_MAP_OPERATION;\r
-
-
-
-
+\r
+\r
+\r
+\r
/** \r
Provides the DMA controller-specific addresses needed to access system memory.\r
\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
-**/
-EFI_STATUS
-EFIAPI
-DmaMap (
- IN DMA_MAP_OPERATION Operation,
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DmaMap (\r
+ IN DMA_MAP_OPERATION Operation,\r
IN VOID *HostAddress,\r
IN OUT UINTN *NumberOfBytes,\r
OUT PHYSICAL_ADDRESS *DeviceAddress,\r
OUT VOID **Mapping\r
- );
-
-
-
-
+ );\r
+\r
+\r
+\r
+\r
/** \r
Completes the DmaMapBusMasterRead, DmaMapBusMasterWrite, or DmaMapBusMasterCommonBuffer\r
operation and releases any corresponding resources.\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
-**/
-EFI_STATUS
-EFIAPI
-DmaUnmap (
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DmaUnmap (\r
IN VOID *Mapping\r
- );
-
-
+ );\r
+\r
+\r
/** \r
Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer.\r
mapping. \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
-**/
-EFI_STATUS
-EFIAPI
-DmaAllocateBuffer (
- IN EFI_MEMORY_TYPE MemoryType,
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DmaAllocateBuffer (\r
+ IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN Pages,\r
OUT VOID **HostAddress\r
);\r
-
-
+\r
+\r
/** \r
Frees memory that was allocated with DmaAllocateBuffer().\r
\r
was not allocated with DmaAllocateBuffer().\r
\r
**/\r
-EFI_STATUS
-EFIAPI
-DmaFreeBuffer (
+EFI_STATUS\r
+EFIAPI\r
+DmaFreeBuffer (\r
IN UINTN Pages,\r
IN VOID *HostAddress\r
);\r
-
-
-#endif
-
+\r
+\r
+#endif \r
+\r
projects / mirror_edk2.git / blobdiff