ArmPkg/Library/ArmDmaLib/ArmDmaLib.c

   1 /** @file
   2   Generic ARM implementation of DmaLib.h
   3
   4   Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
   5
   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
  10
  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.
  13
  14 **/
  15
  16 #include <PiDxe.h>
  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>
  26
  27 #include <Protocol/Cpu.h>
  28
  29 typedef struct {
  30   EFI_PHYSICAL_ADDRESS      HostAddress;
  31   EFI_PHYSICAL_ADDRESS      DeviceAddress;
  32   UINTN                     NumberOfBytes;
  33   DMA_MAP_OPERATION         Operation;
  34   BOOLEAN                   DoubleBuffer;
  35 } MAP_INFO_INSTANCE;
  36
  37
  38
  39 EFI_CPU_ARCH_PROTOCOL      *gCpu;
  40 UINTN                      gCacheAlignment = 0;
  41
  42 /**
  43   Provides the DMA controller-specific addresses needed to access system memory.
  44
  45   Operation is relative to the DMA bus master.
  46
  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
  50                                 that were mapped.
  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().
  54
  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.
  60
  61 **/
  62 EFI_STATUS
  63 EFIAPI
  64 DmaMap (
  65   IN     DMA_MAP_OPERATION              Operation,
  66   IN     VOID                           *HostAddress,
  67   IN OUT UINTN                          *NumberOfBytes,
  68   OUT    PHYSICAL_ADDRESS               *DeviceAddress,
  69   OUT    VOID                           **Mapping
  70   )
  71 {
  72   EFI_STATUS                      Status;
  73   MAP_INFO_INSTANCE               *Map;
  74   VOID                            *Buffer;
  75   EFI_GCD_MEMORY_SPACE_DESCRIPTOR GcdDescriptor;
  76
  77   if (HostAddress == NULL || NumberOfBytes == NULL || DeviceAddress == NULL || Mapping == NULL ) {
  78     return EFI_INVALID_PARAMETER;
  79   }
  80
  81   if (Operation >= MapOperationMaximum) {
  82     return EFI_INVALID_PARAMETER;
  83   }
  84
  85   *DeviceAddress = ConvertToPhysicalAddress (HostAddress);
  86
  87   // Remember range so we can flush on the other side
  88   Map = AllocatePool (sizeof (MAP_INFO_INSTANCE));
  89   if (Map == NULL) {
  90     return  EFI_OUT_OF_RESOURCES;
  91   }
  92
  93   *Mapping = Map;
  94
  95   if ((((UINTN)HostAddress & (gCacheAlignment - 1)) != 0) ||
  96       ((*NumberOfBytes & (gCacheAlignment - 1)) != 0)) {
  97
  98     // Get the cacheability of the region
  99     Status = gDS->GetMemorySpaceDescriptor (*DeviceAddress, &GcdDescriptor);
 100     if (EFI_ERROR(Status)) {
 101       return Status;
 102     }
 103
 104     // If the mapped buffer is not an uncached buffer
 105     if ((GcdDescriptor.Attributes & (EFI_MEMORY_WB | EFI_MEMORY_WT)) != 0) {
 106       //
 107       // Operations of type MapOperationBusMasterCommonBuffer are only allowed
 108       // on uncached buffers.
 109       //
 110       if (Operation == MapOperationBusMasterCommonBuffer) {
 111         DEBUG ((EFI_D_ERROR,
 112           "%a: Operation type 'MapOperationBusMasterCommonBuffer' is only supported\n"
 113           "on memory regions that were allocated using DmaAllocateBuffer ()\n",
 114           __FUNCTION__));
 115         return EFI_UNSUPPORTED;
 116       }
 117
 118       //
 119       // If the buffer does not fill entire cache lines we must double buffer into
 120       // uncached memory. Device (PCI) address becomes uncached page.
 121       //
 122       Map->DoubleBuffer  = TRUE;
 123       Status = DmaAllocateBuffer (EfiBootServicesData, EFI_SIZE_TO_PAGES (*NumberOfBytes), &Buffer);
 124       if (EFI_ERROR (Status)) {
 125         return Status;
 126       }
 127
 128       if (Operation == MapOperationBusMasterRead) {
 129         CopyMem (Buffer, HostAddress, *NumberOfBytes);
 130       }
 131
 132       *DeviceAddress = (PHYSICAL_ADDRESS)(UINTN)Buffer;
 133     } else {
 134       Map->DoubleBuffer  = FALSE;
 135     }
 136   } else {
 137     Map->DoubleBuffer  = FALSE;
 138
 139     // Flush the Data Cache (should not have any effect if the memory region is uncached)
 140     gCpu->FlushDataCache (gCpu, *DeviceAddress, *NumberOfBytes, EfiCpuFlushTypeWriteBackInvalidate);
 141
 142     if ((Operation == MapOperationBusMasterRead) || (Operation == MapOperationBusMasterCommonBuffer)) {
 143       // In case the buffer is used for instance to send command to a PCI controller, we must ensure the memory is uncached
 144       Status = gDS->SetMemorySpaceAttributes (*DeviceAddress & ~(BASE_4KB - 1), ALIGN_VALUE (*NumberOfBytes, BASE_4KB), EFI_MEMORY_WC);
 145       ASSERT_EFI_ERROR (Status);
 146     }
 147   }
 148
 149   Map->HostAddress   = (UINTN)HostAddress;
 150   Map->DeviceAddress = *DeviceAddress;
 151   Map->NumberOfBytes = *NumberOfBytes;
 152   Map->Operation     = Operation;
 153
 154   return EFI_SUCCESS;
 155 }
 156
 157
 158 /**
 159   Completes the DmaMapBusMasterRead(), DmaMapBusMasterWrite(), or DmaMapBusMasterCommonBuffer()
 160   operation and releases any corresponding resources.
 161
 162   @param  Mapping               The mapping value returned from DmaMap*().
 163
 164   @retval EFI_SUCCESS           The range was unmapped.
 165   @retval EFI_DEVICE_ERROR      The data was not committed to the target system memory.
 166   @retval EFI_INVALID_PARAMETER An inconsistency was detected between the mapping type
 167                                 and the DoubleBuffer field
 168
 169 **/
 170 EFI_STATUS
 171 EFIAPI
 172 DmaUnmap (
 173   IN  VOID                         *Mapping
 174   )
 175 {
 176   MAP_INFO_INSTANCE *Map;
 177   EFI_STATUS        Status;
 178
 179   if (Mapping == NULL) {
 180     ASSERT (FALSE);
 181     return EFI_INVALID_PARAMETER;
 182   }
 183
 184   Map = (MAP_INFO_INSTANCE *)Mapping;
 185
 186   Status = EFI_SUCCESS;
 187   if (Map->DoubleBuffer) {
 188     ASSERT (Map->Operation != MapOperationBusMasterCommonBuffer);
 189
 190     if (Map->Operation == MapOperationBusMasterCommonBuffer) {
 191       Status = EFI_INVALID_PARAMETER;
 192     } else if (Map->Operation == MapOperationBusMasterWrite) {
 193       CopyMem ((VOID *)(UINTN)Map->HostAddress, (VOID *)(UINTN)Map->DeviceAddress, Map->NumberOfBytes);
 194     }
 195
 196     DmaFreeBuffer (EFI_SIZE_TO_PAGES (Map->NumberOfBytes), (VOID *)(UINTN)Map->DeviceAddress);
 197
 198   } else {
 199     if (Map->Operation == MapOperationBusMasterWrite) {
 200       //
 201       // Make sure we read buffer from uncached memory and not the cache
 202       //
 203       gCpu->FlushDataCache (gCpu, Map->HostAddress, Map->NumberOfBytes, EfiCpuFlushTypeInvalidate);
 204     }
 205   }
 206
 207   FreePool (Map);
 208
 209   return Status;
 210 }
 211
 212 /**
 213   Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer.
 214   mapping.
 215
 216   @param  MemoryType            The type of memory to allocate, EfiBootServicesData or
 217                                 EfiRuntimeServicesData.
 218   @param  Pages                 The number of pages to allocate.
 219   @param  HostAddress           A pointer to store the base system memory address of the
 220                                 allocated range.
 221
 222                                 @retval EFI_SUCCESS           The requested memory pages were allocated.
 223   @retval EFI_UNSUPPORTED       Attributes is unsupported. The only legal attribute bits are
 224                                 MEMORY_WRITE_COMBINE and MEMORY_CACHED.
 225   @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
 226   @retval EFI_OUT_OF_RESOURCES  The memory pages could not be allocated.
 227
 228 **/
 229 EFI_STATUS
 230 EFIAPI
 231 DmaAllocateBuffer (
 232   IN  EFI_MEMORY_TYPE              MemoryType,
 233   IN  UINTN                        Pages,
 234   OUT VOID                         **HostAddress
 235   )
 236 {
 237   VOID    *Allocation;
 238
 239   if (HostAddress == NULL) {
 240     return EFI_INVALID_PARAMETER;
 241   }
 242
 243   //
 244   // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData
 245   //
 246   // We used uncached memory to keep coherency
 247   //
 248   if (MemoryType == EfiBootServicesData) {
 249     Allocation = UncachedAllocatePages (Pages);
 250   } else if (MemoryType == EfiRuntimeServicesData) {
 251     Allocation = UncachedAllocateRuntimePages (Pages);
 252   } else {
 253     return EFI_INVALID_PARAMETER;
 254   }
 255
 256   if (Allocation == NULL) {
 257     return EFI_OUT_OF_RESOURCES;
 258   }
 259
 260   *HostAddress = Allocation;
 261
 262   return EFI_SUCCESS;
 263 }
 264
 265
 266 /**
 267   Frees memory that was allocated with DmaAllocateBuffer().
 268
 269   @param  Pages                 The number of pages to free.
 270   @param  HostAddress           The base system memory address of the allocated range.
 271
 272   @retval EFI_SUCCESS           The requested memory pages were freed.
 273   @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages
 274                                 was not allocated with DmaAllocateBuffer().
 275
 276 **/
 277 EFI_STATUS
 278 EFIAPI
 279 DmaFreeBuffer (
 280   IN  UINTN                        Pages,
 281   IN  VOID                         *HostAddress
 282   )
 283 {
 284   if (HostAddress == NULL) {
 285      return EFI_INVALID_PARAMETER;
 286   }
 287
 288   UncachedFreePages (HostAddress, Pages);
 289   return EFI_SUCCESS;
 290 }
 291
 292
 293 EFI_STATUS
 294 EFIAPI
 295 ArmDmaLibConstructor (
 296   IN EFI_HANDLE       ImageHandle,
 297   IN EFI_SYSTEM_TABLE *SystemTable
 298   )
 299 {
 300   EFI_STATUS              Status;
 301
 302   // Get the Cpu protocol for later use
 303   Status = gBS->LocateProtocol (&gEfiCpuArchProtocolGuid, NULL, (VOID **)&gCpu);
 304   ASSERT_EFI_ERROR(Status);
 305
 306   gCacheAlignment = ArmCacheWritebackGranule ();
 307
 308   return Status;
 309 }
 310