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>
25 #include <Library/ArmLib.h>
27 #include <Protocol/Cpu.h>
30 EFI_PHYSICAL_ADDRESS HostAddress
;
31 EFI_PHYSICAL_ADDRESS DeviceAddress
;
33 DMA_MAP_OPERATION Operation
;
39 EFI_CPU_ARCH_PROTOCOL
*gCpu
;
40 UINTN gCacheAlignment
= 0;
43 Provides the DMA controller-specific addresses needed to access system memory.
45 Operation is relative to the DMA bus master.
47 @param Operation Indicates if the bus master is going to read or write to system memory.
48 @param HostAddress The system memory address to map to the DMA controller.
49 @param NumberOfBytes On input the number of bytes to map. On output the number of bytes
51 @param DeviceAddress The resulting map address for the bus master controller to use to
52 access the hosts HostAddress.
53 @param Mapping A resulting value to pass to Unmap().
55 @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
56 @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
57 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
58 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
59 @retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
65 IN DMA_MAP_OPERATION Operation
,
67 IN OUT UINTN
*NumberOfBytes
,
68 OUT PHYSICAL_ADDRESS
*DeviceAddress
,
73 MAP_INFO_INSTANCE
*Map
;
75 EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor
;
77 if (HostAddress
== NULL
|| NumberOfBytes
== NULL
|| DeviceAddress
== NULL
|| Mapping
== NULL
) {
78 return EFI_INVALID_PARAMETER
;
81 if (Operation
>= MapOperationMaximum
) {
82 return EFI_INVALID_PARAMETER
;
85 *DeviceAddress
= ConvertToPhysicalAddress (HostAddress
);
87 // Remember range so we can flush on the other side
88 Map
= AllocatePool (sizeof (MAP_INFO_INSTANCE
));
90 return EFI_OUT_OF_RESOURCES
;
95 if ((((UINTN
)HostAddress
& (gCacheAlignment
- 1)) != 0) ||
96 ((*NumberOfBytes
% gCacheAlignment
) != 0)) {
98 // Get the cacheability of the region
99 Status
= gDS
->GetMemorySpaceDescriptor (*DeviceAddress
, &GcdDescriptor
);
100 if (EFI_ERROR(Status
)) {
104 // If the mapped buffer is not an uncached buffer
105 if (GcdDescriptor
.Attributes
!= EFI_MEMORY_UC
) {
107 // If the buffer does not fill entire cache lines we must double buffer into
108 // uncached memory. Device (PCI) address becomes uncached page.
110 Map
->DoubleBuffer
= TRUE
;
111 Status
= DmaAllocateBuffer (EfiBootServicesData
, EFI_SIZE_TO_PAGES (*NumberOfBytes
), &Buffer
);
112 if (EFI_ERROR (Status
)) {
116 if ((Operation
== MapOperationBusMasterRead
) || (Operation
== MapOperationBusMasterCommonBuffer
)) {
117 CopyMem (Buffer
, HostAddress
, *NumberOfBytes
);
120 *DeviceAddress
= (PHYSICAL_ADDRESS
)(UINTN
)Buffer
;
122 Map
->DoubleBuffer
= FALSE
;
125 Map
->DoubleBuffer
= FALSE
;
127 // Flush the Data Cache (should not have any effect if the memory region is uncached)
128 gCpu
->FlushDataCache (gCpu
, *DeviceAddress
, *NumberOfBytes
, EfiCpuFlushTypeWriteBackInvalidate
);
130 if ((Operation
== MapOperationBusMasterRead
) || (Operation
== MapOperationBusMasterCommonBuffer
)) {
131 // In case the buffer is used for instance to send command to a PCI controller, we must ensure the memory is uncached
132 Status
= gDS
->SetMemorySpaceAttributes (ALIGN_VALUE(*DeviceAddress
- BASE_4KB
- 1,BASE_4KB
), ALIGN_VALUE(*NumberOfBytes
,BASE_4KB
), EFI_MEMORY_UC
);
133 ASSERT_EFI_ERROR (Status
);
137 Map
->HostAddress
= (UINTN
)HostAddress
;
138 Map
->DeviceAddress
= *DeviceAddress
;
139 Map
->NumberOfBytes
= *NumberOfBytes
;
140 Map
->Operation
= Operation
;
147 Completes the DmaMapBusMasterRead(), DmaMapBusMasterWrite(), or DmaMapBusMasterCommonBuffer()
148 operation and releases any corresponding resources.
150 @param Mapping The mapping value returned from DmaMap*().
152 @retval EFI_SUCCESS The range was unmapped.
153 @retval EFI_DEVICE_ERROR The data was not committed to the target system memory.
162 MAP_INFO_INSTANCE
*Map
;
164 if (Mapping
== NULL
) {
166 return EFI_INVALID_PARAMETER
;
169 Map
= (MAP_INFO_INSTANCE
*)Mapping
;
171 if (Map
->DoubleBuffer
) {
172 if ((Map
->Operation
== MapOperationBusMasterWrite
) || (Map
->Operation
== MapOperationBusMasterCommonBuffer
)) {
173 CopyMem ((VOID
*)(UINTN
)Map
->HostAddress
, (VOID
*)(UINTN
)Map
->DeviceAddress
, Map
->NumberOfBytes
);
176 DmaFreeBuffer (EFI_SIZE_TO_PAGES (Map
->NumberOfBytes
), (VOID
*)(UINTN
)Map
->DeviceAddress
);
179 if (Map
->Operation
== MapOperationBusMasterWrite
) {
181 // Make sure we read buffer from uncached memory and not the cache
183 gCpu
->FlushDataCache (gCpu
, Map
->HostAddress
, Map
->NumberOfBytes
, EfiCpuFlushTypeInvalidate
);
193 Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer.
196 @param MemoryType The type of memory to allocate, EfiBootServicesData or
197 EfiRuntimeServicesData.
198 @param Pages The number of pages to allocate.
199 @param HostAddress A pointer to store the base system memory address of the
202 @retval EFI_SUCCESS The requested memory pages were allocated.
203 @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are
204 MEMORY_WRITE_COMBINE and MEMORY_CACHED.
205 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
206 @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
212 IN EFI_MEMORY_TYPE MemoryType
,
214 OUT VOID
**HostAddress
217 if (HostAddress
== NULL
) {
218 return EFI_INVALID_PARAMETER
;
222 // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
224 // We used uncached memory to keep coherency
226 if (MemoryType
== EfiBootServicesData
) {
227 *HostAddress
= UncachedAllocatePages (Pages
);
228 } else if (MemoryType
== EfiRuntimeServicesData
) {
229 *HostAddress
= UncachedAllocateRuntimePages (Pages
);
231 return EFI_INVALID_PARAMETER
;
239 Frees memory that was allocated with DmaAllocateBuffer().
241 @param Pages The number of pages to free.
242 @param HostAddress The base system memory address of the allocated range.
244 @retval EFI_SUCCESS The requested memory pages were freed.
245 @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
246 was not allocated with DmaAllocateBuffer().
256 if (HostAddress
== NULL
) {
257 return EFI_INVALID_PARAMETER
;
260 UncachedFreePages (HostAddress
, Pages
);
267 ArmDmaLibConstructor (
268 IN EFI_HANDLE ImageHandle
,
269 IN EFI_SYSTEM_TABLE
*SystemTable
274 // Get the Cpu protocol for later use
275 Status
= gBS
->LocateProtocol (&gEfiCpuArchProtocolGuid
, NULL
, (VOID
**)&gCpu
);
276 ASSERT_EFI_ERROR(Status
);
278 gCacheAlignment
= ArmDataCacheLineLength ();