2 Generic ARM implementation of DmaLib.h
4 Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <Library/DebugLib.h>
18 #include <Library/DmaLib.h>
19 #include <Library/DxeServicesTableLib.h>
20 #include <Library/MemoryAllocationLib.h>
21 #include <Library/UefiBootServicesTableLib.h>
22 #include <Library/UncachedMemoryAllocationLib.h>
23 #include <Library/IoLib.h>
24 #include <Library/BaseMemoryLib.h>
26 #include <Protocol/Cpu.h>
29 EFI_PHYSICAL_ADDRESS HostAddress
;
32 DMA_MAP_OPERATION Operation
;
38 STATIC EFI_CPU_ARCH_PROTOCOL
*mCpu
;
43 IN PHYSICAL_ADDRESS HostAddress
46 return HostAddress
+ PcdGet64 (PcdArmDmaDeviceOffset
);
50 Provides the DMA controller-specific addresses needed to access system memory.
52 Operation is relative to the DMA bus master.
54 @param Operation Indicates if the bus master is going to read or write to system memory.
55 @param HostAddress The system memory address to map to the DMA controller.
56 @param NumberOfBytes On input the number of bytes to map. On output the number of bytes
58 @param DeviceAddress The resulting map address for the bus master controller to use to
59 access the hosts HostAddress.
60 @param Mapping A resulting value to pass to Unmap().
62 @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
63 @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
64 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
65 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
66 @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
72 IN DMA_MAP_OPERATION Operation
,
74 IN OUT UINTN
*NumberOfBytes
,
75 OUT PHYSICAL_ADDRESS
*DeviceAddress
,
80 MAP_INFO_INSTANCE
*Map
;
82 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor
;
84 if (HostAddress
== NULL
|| NumberOfBytes
== NULL
|| DeviceAddress
== NULL
|| Mapping
== NULL
) {
85 return EFI_INVALID_PARAMETER
;
88 if (Operation
>= MapOperationMaximum
) {
89 return EFI_INVALID_PARAMETER
;
93 // The debug implementation of UncachedMemoryAllocationLib in ArmPkg returns
94 // a virtual uncached alias, and unmaps the cached ID mapping of the buffer,
95 // in order to catch inadvertent references to the cached mapping.
96 // Since HostToDeviceAddress () expects ID mapped input addresses, convert
97 // the host address to an ID mapped address first.
99 *DeviceAddress
= HostToDeviceAddress (ConvertToPhysicalAddress (HostAddress
));
101 // Remember range so we can flush on the other side
102 Map
= AllocatePool (sizeof (MAP_INFO_INSTANCE
));
104 return EFI_OUT_OF_RESOURCES
;
107 if ((((UINTN
)HostAddress
& (mCpu
->DmaBufferAlignment
- 1)) != 0) ||
108 ((*NumberOfBytes
& (mCpu
->DmaBufferAlignment
- 1)) != 0)) {
110 // Get the cacheability of the region
111 Status
= gDS
->GetMemorySpaceDescriptor ((UINTN
)HostAddress
, &GcdDescriptor
);
112 if (EFI_ERROR(Status
)) {
116 // If the mapped buffer is not an uncached buffer
117 if ((GcdDescriptor
.Attributes
& (EFI_MEMORY_WB
| EFI_MEMORY_WT
)) != 0) {
119 // Operations of type MapOperationBusMasterCommonBuffer are only allowed
120 // on uncached buffers.
122 if (Operation
== MapOperationBusMasterCommonBuffer
) {
124 "%a: Operation type 'MapOperationBusMasterCommonBuffer' is only supported\n"
125 "on memory regions that were allocated using DmaAllocateBuffer ()\n",
127 Status
= EFI_UNSUPPORTED
;
132 // If the buffer does not fill entire cache lines we must double buffer into
133 // uncached memory. Device (PCI) address becomes uncached page.
135 Map
->DoubleBuffer
= TRUE
;
136 Status
= DmaAllocateBuffer (EfiBootServicesData
, EFI_SIZE_TO_PAGES (*NumberOfBytes
), &Buffer
);
137 if (EFI_ERROR (Status
)) {
141 if (Operation
== MapOperationBusMasterRead
) {
142 CopyMem (Buffer
, HostAddress
, *NumberOfBytes
);
145 *DeviceAddress
= HostToDeviceAddress (ConvertToPhysicalAddress (Buffer
));
146 Map
->BufferAddress
= Buffer
;
148 Map
->DoubleBuffer
= FALSE
;
151 Map
->DoubleBuffer
= FALSE
;
156 // The operation type check above only executes if the buffer happens to be
157 // misaligned with respect to CWG, but even if it is aligned, we should not
158 // allow arbitrary buffers to be used for creating consistent mappings.
159 // So duplicate the check here when running in DEBUG mode, just to assert
160 // that we are not trying to create a consistent mapping for cached memory.
162 Status
= gDS
->GetMemorySpaceDescriptor ((UINTN
)HostAddress
, &GcdDescriptor
);
163 ASSERT_EFI_ERROR(Status
);
165 ASSERT (Operation
!= MapOperationBusMasterCommonBuffer
||
166 (GcdDescriptor
.Attributes
& (EFI_MEMORY_WB
| EFI_MEMORY_WT
)) == 0);
170 // Flush the Data Cache (should not have any effect if the memory region is uncached)
171 mCpu
->FlushDataCache (mCpu
, (UINTN
)HostAddress
, *NumberOfBytes
,
172 EfiCpuFlushTypeWriteBackInvalidate
);
175 Map
->HostAddress
= (UINTN
)HostAddress
;
176 Map
->NumberOfBytes
= *NumberOfBytes
;
177 Map
->Operation
= Operation
;
191 Completes the DmaMapBusMasterRead(), DmaMapBusMasterWrite(), or DmaMapBusMasterCommonBuffer()
192 operation and releases any corresponding resources.
194 @param Mapping The mapping value returned from DmaMap*().
196 @retval EFI_SUCCESS The range was unmapped.
197 @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
198 @retval EFI_INVALID_PARAMETER An inconsistency was detected between the mapping type
199 and the DoubleBuffer field
208 MAP_INFO_INSTANCE
*Map
;
211 if (Mapping
== NULL
) {
213 return EFI_INVALID_PARAMETER
;
216 Map
= (MAP_INFO_INSTANCE
*)Mapping
;
218 Status
= EFI_SUCCESS
;
219 if (Map
->DoubleBuffer
) {
220 ASSERT (Map
->Operation
!= MapOperationBusMasterCommonBuffer
);
222 if (Map
->Operation
== MapOperationBusMasterCommonBuffer
) {
223 Status
= EFI_INVALID_PARAMETER
;
224 } else if (Map
->Operation
== MapOperationBusMasterWrite
) {
225 CopyMem ((VOID
*)(UINTN
)Map
->HostAddress
, Map
->BufferAddress
,
229 DmaFreeBuffer (EFI_SIZE_TO_PAGES (Map
->NumberOfBytes
), Map
->BufferAddress
);
232 if (Map
->Operation
== MapOperationBusMasterWrite
) {
234 // Make sure we read buffer from uncached memory and not the cache
236 mCpu
->FlushDataCache (mCpu
, Map
->HostAddress
, Map
->NumberOfBytes
,
237 EfiCpuFlushTypeInvalidate
);
247 Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer.
250 @param MemoryType The type of memory to allocate, EfiBootServicesData or
251 EfiRuntimeServicesData.
252 @param Pages The number of pages to allocate.
253 @param HostAddress A pointer to store the base system memory address of the
256 @retval EFI_SUCCESS The requested memory pages were allocated.
257 @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are
258 MEMORY_WRITE_COMBINE and MEMORY_CACHED.
259 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
260 @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
266 IN EFI_MEMORY_TYPE MemoryType
,
268 OUT VOID
**HostAddress
273 if (HostAddress
== NULL
) {
274 return EFI_INVALID_PARAMETER
;
278 // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
280 // We used uncached memory to keep coherency
282 if (MemoryType
== EfiBootServicesData
) {
283 Allocation
= UncachedAllocatePages (Pages
);
284 } else if (MemoryType
== EfiRuntimeServicesData
) {
285 Allocation
= UncachedAllocateRuntimePages (Pages
);
287 return EFI_INVALID_PARAMETER
;
290 if (Allocation
== NULL
) {
291 return EFI_OUT_OF_RESOURCES
;
294 *HostAddress
= Allocation
;
301 Frees memory that was allocated with DmaAllocateBuffer().
303 @param Pages The number of pages to free.
304 @param HostAddress The base system memory address of the allocated range.
306 @retval EFI_SUCCESS The requested memory pages were freed.
307 @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
308 was not allocated with DmaAllocateBuffer().
318 if (HostAddress
== NULL
) {
319 return EFI_INVALID_PARAMETER
;
322 UncachedFreePages (HostAddress
, Pages
);
329 ArmDmaLibConstructor (
330 IN EFI_HANDLE ImageHandle
,
331 IN EFI_SYSTEM_TABLE
*SystemTable
336 // Get the Cpu protocol for later use
337 Status
= gBS
->LocateProtocol (&gEfiCpuArchProtocolGuid
, NULL
, (VOID
**)&mCpu
);
338 ASSERT_EFI_ERROR(Status
);