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
;
30 EFI_PHYSICAL_ADDRESS DeviceAddress
;
32 DMA_MAP_OPERATION Operation
;
38 STATIC EFI_CPU_ARCH_PROTOCOL
*mCpu
;
41 Provides the DMA controller-specific addresses needed to access system memory.
43 Operation is relative to the DMA bus master.
45 @param Operation Indicates if the bus master is going to read or write to system memory.
46 @param HostAddress The system memory address to map to the DMA controller.
47 @param NumberOfBytes On input the number of bytes to map. On output the number of bytes
49 @param DeviceAddress The resulting map address for the bus master controller to use to
50 access the hosts HostAddress.
51 @param Mapping A resulting value to pass to Unmap().
53 @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
54 @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
55 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
56 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
57 @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
63 IN DMA_MAP_OPERATION Operation
,
65 IN OUT UINTN
*NumberOfBytes
,
66 OUT PHYSICAL_ADDRESS
*DeviceAddress
,
71 MAP_INFO_INSTANCE
*Map
;
73 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor
;
75 if (HostAddress
== NULL
|| NumberOfBytes
== NULL
|| DeviceAddress
== NULL
|| Mapping
== NULL
) {
76 return EFI_INVALID_PARAMETER
;
79 if (Operation
>= MapOperationMaximum
) {
80 return EFI_INVALID_PARAMETER
;
83 *DeviceAddress
= ConvertToPhysicalAddress (HostAddress
);
85 // Remember range so we can flush on the other side
86 Map
= AllocatePool (sizeof (MAP_INFO_INSTANCE
));
88 return EFI_OUT_OF_RESOURCES
;
91 if ((((UINTN
)HostAddress
& (mCpu
->DmaBufferAlignment
- 1)) != 0) ||
92 ((*NumberOfBytes
& (mCpu
->DmaBufferAlignment
- 1)) != 0)) {
94 // Get the cacheability of the region
95 Status
= gDS
->GetMemorySpaceDescriptor (*DeviceAddress
, &GcdDescriptor
);
96 if (EFI_ERROR(Status
)) {
100 // If the mapped buffer is not an uncached buffer
101 if ((GcdDescriptor
.Attributes
& (EFI_MEMORY_WB
| EFI_MEMORY_WT
)) != 0) {
103 // Operations of type MapOperationBusMasterCommonBuffer are only allowed
104 // on uncached buffers.
106 if (Operation
== MapOperationBusMasterCommonBuffer
) {
108 "%a: Operation type 'MapOperationBusMasterCommonBuffer' is only supported\n"
109 "on memory regions that were allocated using DmaAllocateBuffer ()\n",
111 Status
= EFI_UNSUPPORTED
;
116 // If the buffer does not fill entire cache lines we must double buffer into
117 // uncached memory. Device (PCI) address becomes uncached page.
119 Map
->DoubleBuffer
= TRUE
;
120 Status
= DmaAllocateBuffer (EfiBootServicesData
, EFI_SIZE_TO_PAGES (*NumberOfBytes
), &Buffer
);
121 if (EFI_ERROR (Status
)) {
125 if (Operation
== MapOperationBusMasterRead
) {
126 CopyMem (Buffer
, HostAddress
, *NumberOfBytes
);
129 *DeviceAddress
= (PHYSICAL_ADDRESS
)(UINTN
)Buffer
;
131 Map
->DoubleBuffer
= FALSE
;
134 Map
->DoubleBuffer
= FALSE
;
139 // The operation type check above only executes if the buffer happens to be
140 // misaligned with respect to CWG, but even if it is aligned, we should not
141 // allow arbitrary buffers to be used for creating consistent mappings.
142 // So duplicate the check here when running in DEBUG mode, just to assert
143 // that we are not trying to create a consistent mapping for cached memory.
145 Status
= gDS
->GetMemorySpaceDescriptor (*DeviceAddress
, &GcdDescriptor
);
146 ASSERT_EFI_ERROR(Status
);
148 ASSERT (Operation
!= MapOperationBusMasterCommonBuffer
||
149 (GcdDescriptor
.Attributes
& (EFI_MEMORY_WB
| EFI_MEMORY_WT
)) == 0);
153 // Flush the Data Cache (should not have any effect if the memory region is uncached)
154 mCpu
->FlushDataCache (mCpu
, *DeviceAddress
, *NumberOfBytes
,
155 EfiCpuFlushTypeWriteBackInvalidate
);
158 Map
->HostAddress
= (UINTN
)HostAddress
;
159 Map
->DeviceAddress
= *DeviceAddress
;
160 Map
->NumberOfBytes
= *NumberOfBytes
;
161 Map
->Operation
= Operation
;
175 Completes the DmaMapBusMasterRead(), DmaMapBusMasterWrite(), or DmaMapBusMasterCommonBuffer()
176 operation and releases any corresponding resources.
178 @param Mapping The mapping value returned from DmaMap*().
180 @retval EFI_SUCCESS The range was unmapped.
181 @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
182 @retval EFI_INVALID_PARAMETER An inconsistency was detected between the mapping type
183 and the DoubleBuffer field
192 MAP_INFO_INSTANCE
*Map
;
195 if (Mapping
== NULL
) {
197 return EFI_INVALID_PARAMETER
;
200 Map
= (MAP_INFO_INSTANCE
*)Mapping
;
202 Status
= EFI_SUCCESS
;
203 if (Map
->DoubleBuffer
) {
204 ASSERT (Map
->Operation
!= MapOperationBusMasterCommonBuffer
);
206 if (Map
->Operation
== MapOperationBusMasterCommonBuffer
) {
207 Status
= EFI_INVALID_PARAMETER
;
208 } else if (Map
->Operation
== MapOperationBusMasterWrite
) {
209 CopyMem ((VOID
*)(UINTN
)Map
->HostAddress
, (VOID
*)(UINTN
)Map
->DeviceAddress
, Map
->NumberOfBytes
);
212 DmaFreeBuffer (EFI_SIZE_TO_PAGES (Map
->NumberOfBytes
), (VOID
*)(UINTN
)Map
->DeviceAddress
);
215 if (Map
->Operation
== MapOperationBusMasterWrite
) {
217 // Make sure we read buffer from uncached memory and not the cache
219 mCpu
->FlushDataCache (mCpu
, Map
->HostAddress
, Map
->NumberOfBytes
,
220 EfiCpuFlushTypeInvalidate
);
230 Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer.
233 @param MemoryType The type of memory to allocate, EfiBootServicesData or
234 EfiRuntimeServicesData.
235 @param Pages The number of pages to allocate.
236 @param HostAddress A pointer to store the base system memory address of the
239 @retval EFI_SUCCESS The requested memory pages were allocated.
240 @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are
241 MEMORY_WRITE_COMBINE and MEMORY_CACHED.
242 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
243 @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
249 IN EFI_MEMORY_TYPE MemoryType
,
251 OUT VOID
**HostAddress
256 if (HostAddress
== NULL
) {
257 return EFI_INVALID_PARAMETER
;
261 // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
263 // We used uncached memory to keep coherency
265 if (MemoryType
== EfiBootServicesData
) {
266 Allocation
= UncachedAllocatePages (Pages
);
267 } else if (MemoryType
== EfiRuntimeServicesData
) {
268 Allocation
= UncachedAllocateRuntimePages (Pages
);
270 return EFI_INVALID_PARAMETER
;
273 if (Allocation
== NULL
) {
274 return EFI_OUT_OF_RESOURCES
;
277 *HostAddress
= Allocation
;
284 Frees memory that was allocated with DmaAllocateBuffer().
286 @param Pages The number of pages to free.
287 @param HostAddress The base system memory address of the allocated range.
289 @retval EFI_SUCCESS The requested memory pages were freed.
290 @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
291 was not allocated with DmaAllocateBuffer().
301 if (HostAddress
== NULL
) {
302 return EFI_INVALID_PARAMETER
;
305 UncachedFreePages (HostAddress
, Pages
);
312 ArmDmaLibConstructor (
313 IN EFI_HANDLE ImageHandle
,
314 IN EFI_SYSTEM_TABLE
*SystemTable
319 // Get the Cpu protocol for later use
320 Status
= gBS
->LocateProtocol (&gEfiCpuArchProtocolGuid
, NULL
, (VOID
**)&mCpu
);
321 ASSERT_EFI_ERROR(Status
);