From 81bc205daf18ca46bec3621fc05fc049db152826 Mon Sep 17 00:00:00 2001 From: andrewfish Date: Sat, 29 May 2010 00:21:30 +0000 Subject: [PATCH] Clean up OMAP DMA lib and split into generic DMA lib based on PCI_IO DMA abstractions and make OMAP DMA lib about channel programming only. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10555 6f19259b-4bc3-4df7-8a09-765794883524 --- ArmEbPkg/ArmEbPkg.dsc | 2 +- ArmPkg/ArmPkg.dsc | 1 + BeagleBoardPkg/BeagleBoardPkg.dsc | 1 + Omap35xxPkg/Include/Library/OmapDmaLib.h | 118 +-------- Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.c | 248 +----------------- Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.inf | 2 +- Omap35xxPkg/MMCHSDxe/MMCHS.h | 1 + Omap35xxPkg/MMCHSDxe/MMCHS.inf | 1 + Omap35xxPkg/Omap35xxPkg.dsc | 3 +- Omap35xxPkg/PciEmulation/PciEmulation.h | 1 + Omap35xxPkg/PciEmulation/PciEmulation.inf | 1 + 11 files changed, 14 insertions(+), 365 deletions(-) diff --git a/ArmEbPkg/ArmEbPkg.dsc b/ArmEbPkg/ArmEbPkg.dsc index b035273fc7..8a022351a9 100644 --- a/ArmEbPkg/ArmEbPkg.dsc +++ b/ArmEbPkg/ArmEbPkg.dsc @@ -119,7 +119,7 @@ TimerLib|ArmEbPkg/Library/TimerLib/TimerLib.inf SerialPortLib|ArmEbPkg/Library/SerialPortLib/SerialPortLib.inf GdbSerialLib|ArmEbPkg/Library/GdbSerialLib/GdbSerialLib.inf - + DmaLib|ArmPkg/Library/ArmDmaLib/ArmDmaLib.inf [LibraryClasses.common.SEC] diff --git a/ArmPkg/ArmPkg.dsc b/ArmPkg/ArmPkg.dsc index 819ee5c68c..4185a11259 100644 --- a/ArmPkg/ArmPkg.dsc +++ b/ArmPkg/ArmPkg.dsc @@ -66,6 +66,7 @@ ArmLib|ArmPkg/Library/ArmLib/ArmV7/ArmV7Lib.inf CpuLib|MdePkg/Library/BaseCpuLib/BaseCpuLib.inf ArmDisassemblerLib|ArmPkg/Library/ArmDisassemblerLib/ArmDisassemblerLib.inf + DmaLib|ArmPkg/Library/ArmDmaLib/ArmDmaLib.inf [LibraryClasses.ARM] NULL|ArmPkg/Library/CompilerIntrinsicsLib/CompilerIntrinsicsLib.inf diff --git a/BeagleBoardPkg/BeagleBoardPkg.dsc b/BeagleBoardPkg/BeagleBoardPkg.dsc index 65f0106f82..bc886201be 100644 --- a/BeagleBoardPkg/BeagleBoardPkg.dsc +++ b/BeagleBoardPkg/BeagleBoardPkg.dsc @@ -113,6 +113,7 @@ GdbSerialLib|Omap35xxPkg/Library/GdbSerialLib/GdbSerialLib.inf ArmDisassemblerLib|ArmPkg/Library/ArmDisassemblerLib/ArmDisassemblerLib.inf DebugAgentLib|MdeModulePkg/Library/DebugAgentLibNull/DebugAgentLibNull.inf + DmaLib|ArmPkg/Library/ArmDmaLib/ArmDmaLib.inf [LibraryClasses.common.SEC] ArmLib|ArmPkg/Library/ArmLib/ArmV7/ArmV7LibPrePi.inf diff --git a/Omap35xxPkg/Include/Library/OmapDmaLib.h b/Omap35xxPkg/Include/Library/OmapDmaLib.h index d4daf6d364..0dc4468c91 100755 --- a/Omap35xxPkg/Include/Library/OmapDmaLib.h +++ b/Omap35xxPkg/Include/Library/OmapDmaLib.h @@ -1,10 +1,7 @@ /** @file - Abstractions for simple OMAP DMA. The DMA functions are modeled on - the PCI IO protocol and follow the same rules as outlined in the UEFI specification. - OMAP_DMA4 structure elements are described in the OMAP35xx TRM. Currently - there is no PCI'less DMA protocol, if one existed it could be used to - replace this library. + Abstractions for simple OMAP DMA. + OMAP_DMA4 structure elements are described in the OMAP35xx TRM. Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.
@@ -21,23 +18,6 @@ #ifndef __OMAP_DMA_LIB_H__ #define __OMAP_DMA_LIB_H__ -typedef enum { - /// - /// A read operation from system memory by a bus master. - /// - MapOperationBusMasterRead, - /// - /// A write operation from system memory by a bus master. - /// - MapOperationBusMasterWrite, - /// - /// Provides both read and write access to system memory by both the processor and a - /// bus master. The buffer is coherent from both the processor's and the bus master's point of view. - /// - MapOperationBusMasterCommonBuffer, - MapOperationMaximum -} DMA_MAP_OPERATION; - // Example from DMA chapter of the OMAP35xx spec typedef struct { @@ -105,100 +85,6 @@ DisableDmaChannel ( ); -/** - Provides the DMA controller-specific addresses needed to access system memory. - - Operation is relative to the DMA bus master. - - @param Operation Indicates if the bus master is going to read or write to system memory. - @param HostAddress The system memory address to map to the DMA controller. - @param NumberOfBytes On input the number of bytes to map. On output the number of bytes - that were mapped. - @param DeviceAddress The resulting map address for the bus master controller to use to - access the hosts HostAddress. - @param Mapping A resulting value to pass to Unmap(). - - @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. - @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. - -**/ -EFI_STATUS -EFIAPI -DmaMap ( - IN DMA_MAP_OPERATION Operation, - IN VOID *HostAddress, - IN OUT UINTN *NumberOfBytes, - OUT PHYSICAL_ADDRESS *DeviceAddress, - OUT VOID **Mapping - ); - - - - -/** - Completes the DmaMapBusMasterRead(), DmaMapBusMasterWrite(), or DmaMapBusMasterCommonBuffer() - operation and releases any corresponding resources. - - @param Mapping The mapping value returned from DmaMap*(). - - @retval EFI_SUCCESS The range was unmapped. - @retval EFI_DEVICE_ERROR The data was not committed to the target system memory. - -**/ -EFI_STATUS -EFIAPI -DmaUnmap ( - IN VOID *Mapping - ); - - -/** - Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer. - mapping. - - @param MemoryType The type of memory to allocate, EfiBootServicesData or - EfiRuntimeServicesData. - @param Pages The number of pages to allocate. - @param HostAddress A pointer to store the base system memory address of the - allocated range. - - @retval EFI_SUCCESS The requested memory pages were allocated. - @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are - MEMORY_WRITE_COMBINE and MEMORY_CACHED. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. - -**/ -EFI_STATUS -EFIAPI -DmaAllocateBuffer ( - IN EFI_MEMORY_TYPE MemoryType, - IN UINTN Pages, - OUT VOID **HostAddress - ); - - -/** - Frees memory that was allocated with DmaAllocateBuffer(). - - @param Pages The number of pages to free. - @param HostAddress The base system memory address of the allocated range. - - @retval EFI_SUCCESS The requested memory pages were freed. - @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages - was not allocated with DmaAllocateBuffer(). - -**/ -EFI_STATUS -EFIAPI -DmaFreeBuffer ( - IN UINTN Pages, - IN VOID *HostAddress - ); - #endif diff --git a/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.c b/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.c index 27617fa09e..d1183129a6 100755 --- a/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.c +++ b/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.c @@ -1,6 +1,6 @@ /** @file - OMAP35xx DMA abstractions modeled on PCI IO protocol. EnableDma()/DisableDma() - are from OMAP35xx TRM. + Abstractions for simple OMAP DMA channel. + Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.
@@ -17,28 +17,10 @@ #include #include #include -#include -#include -#include #include #include -#include #include -#include - -typedef struct { - EFI_PHYSICAL_ADDRESS HostAddress; - EFI_PHYSICAL_ADDRESS DeviceAddress; - UINTN NumberOfBytes; - DMA_MAP_OPERATION Operation; - BOOLEAN DoubleBuffer; -} MAP_INFO_INSTANCE; - - - -EFI_CPU_ARCH_PROTOCOL *gCpu; -UINTN gCacheAlignment = 0; /** Configure OMAP DMA Channel @@ -192,229 +174,3 @@ DisableDmaChannel ( -/** - Provides the DMA controller-specific addresses needed to access system memory. - - Operation is relative to the DMA bus master. - - @param Operation Indicates if the bus master is going to read or write to system memory. - @param HostAddress The system memory address to map to the DMA controller. - @param NumberOfBytes On input the number of bytes to map. On output the number of bytes - that were mapped. - @param DeviceAddress The resulting map address for the bus master controller to use to - access the hosts HostAddress. - @param Mapping A resulting value to pass to Unmap(). - - @retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes. - @retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - @retval EFI_DEVICE_ERROR The system hardware could not map the requested address. - -**/ -EFI_STATUS -EFIAPI -DmaMap ( - IN DMA_MAP_OPERATION Operation, - IN VOID *HostAddress, - IN OUT UINTN *NumberOfBytes, - OUT PHYSICAL_ADDRESS *DeviceAddress, - OUT VOID **Mapping - ) -{ - EFI_STATUS Status; - MAP_INFO_INSTANCE *Map; - VOID *Buffer; - - if ( HostAddress == NULL || NumberOfBytes == NULL || - DeviceAddress == NULL || Mapping == NULL ) { - return EFI_INVALID_PARAMETER; - } - - - if (Operation >= MapOperationMaximum) { - return EFI_INVALID_PARAMETER; - } - - *DeviceAddress = ConvertToPhysicalAddress (HostAddress); - - // Remember range so we can flush on the other side - Map = AllocatePool (sizeof (MAP_INFO_INSTANCE)); - if (Map == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - *Mapping = Map; - - if (((UINTN)HostAddress & (gCacheAlignment - 1)) != 0) { - Map->DoubleBuffer = TRUE; - Status = DmaAllocateBuffer (EfiBootServicesData, EFI_SIZE_TO_PAGES (*NumberOfBytes), &Buffer); - if (EFI_ERROR (Status)) { - return Status; - } - - *DeviceAddress = (PHYSICAL_ADDRESS)(UINTN)Buffer; - - } else { - Map->DoubleBuffer = FALSE; - } - - *NumberOfBytes &= *NumberOfBytes & ~(gCacheAlignment - 1); // Only do it on full cache lines - - Map->HostAddress = (UINTN)HostAddress; - Map->DeviceAddress = *DeviceAddress; - Map->NumberOfBytes = *NumberOfBytes; - Map->Operation = Operation; - - if (Map->DoubleBuffer) { - if (Map->Operation == MapOperationBusMasterWrite) { - CopyMem ((VOID *)(UINTN)Map->DeviceAddress, (VOID *)(UINTN)Map->HostAddress, Map->NumberOfBytes); - } - } else { - // EfiCpuFlushTypeWriteBack, EfiCpuFlushTypeInvalidate - if (Map->Operation == MapOperationBusMasterWrite || Map->Operation == MapOperationBusMasterRead) { - gCpu->FlushDataCache (gCpu, (EFI_PHYSICAL_ADDRESS)(UINTN)HostAddress, Map->NumberOfBytes, EfiCpuFlushTypeWriteBackInvalidate); - } - } - - return EFI_SUCCESS; -} - - -/** - Completes the DmaMapBusMasterRead(), DmaMapBusMasterWrite(), or DmaMapBusMasterCommonBuffer() - operation and releases any corresponding resources. - - @param Mapping The mapping value returned from DmaMap*(). - - @retval EFI_SUCCESS The range was unmapped. - @retval EFI_DEVICE_ERROR The data was not committed to the target system memory. - -**/ -EFI_STATUS -EFIAPI -DmaUnmap ( - IN VOID *Mapping - ) -{ - MAP_INFO_INSTANCE *Map; - - if (Mapping == NULL) { - ASSERT (FALSE); - return EFI_INVALID_PARAMETER; - } - - Map = (MAP_INFO_INSTANCE *)Mapping; - - if (Map->DoubleBuffer) { - if (Map->Operation == MapOperationBusMasterRead) { - CopyMem ((VOID *)(UINTN)Map->HostAddress, (VOID *)(UINTN)Map->DeviceAddress, Map->NumberOfBytes); - } - - DmaFreeBuffer (EFI_SIZE_TO_PAGES (Map->NumberOfBytes), (VOID *)(UINTN)Map->DeviceAddress); - - } else { - if (Map->Operation == MapOperationBusMasterWrite) { - // - // Make sure we read buffer from uncached memory and not the cache - // - gCpu->FlushDataCache (gCpu, Map->HostAddress, Map->NumberOfBytes, EfiCpuFlushTypeInvalidate); - } - } - - FreePool (Map); - - return EFI_SUCCESS; -} - -/** - Allocates pages that are suitable for an DmaMap() of type MapOperationBusMasterCommonBuffer. - mapping. - - @param MemoryType The type of memory to allocate, EfiBootServicesData or - EfiRuntimeServicesData. - @param Pages The number of pages to allocate. - @param HostAddress A pointer to store the base system memory address of the - allocated range. - - @retval EFI_SUCCESS The requested memory pages were allocated. - @retval EFI_UNSUPPORTED Attributes is unsupported. The only legal attribute bits are - MEMORY_WRITE_COMBINE and MEMORY_CACHED. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated. - -**/ -EFI_STATUS -EFIAPI -DmaAllocateBuffer ( - IN EFI_MEMORY_TYPE MemoryType, - IN UINTN Pages, - OUT VOID **HostAddress - ) -{ - if (HostAddress == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // The only valid memory types are EfiBootServicesData and EfiRuntimeServicesData - // - // We used uncached memory to keep coherency - // - if (MemoryType == EfiBootServicesData) { - *HostAddress = UncachedAllocatePages (Pages); - } else if (MemoryType != EfiRuntimeServicesData) { - *HostAddress = UncachedAllocateRuntimePages (Pages); - } else { - return EFI_INVALID_PARAMETER; - } - - return EFI_SUCCESS; -} - - -/** - Frees memory that was allocated with DmaAllocateBuffer(). - - @param Pages The number of pages to free. - @param HostAddress The base system memory address of the allocated range. - - @retval EFI_SUCCESS The requested memory pages were freed. - @retval EFI_INVALID_PARAMETER The memory range specified by HostAddress and Pages - was not allocated with DmaAllocateBuffer(). - -**/ -EFI_STATUS -EFIAPI -DmaFreeBuffer ( - IN UINTN Pages, - IN VOID *HostAddress - ) -{ - if (HostAddress == NULL) { - return EFI_INVALID_PARAMETER; - } - - UncachedFreePages (HostAddress, Pages); - return EFI_SUCCESS; -} - - -EFI_STATUS -EFIAPI -OmapDmaLibConstructor ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - EFI_STATUS Status; - - // Get the Cpu protocol for later use - Status = gBS->LocateProtocol (&gEfiCpuArchProtocolGuid, NULL, (VOID **)&gCpu); - ASSERT_EFI_ERROR(Status); - - gCacheAlignment = ArmDataCacheLineLength (); - - return Status; -} - diff --git a/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.inf b/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.inf index 04be6e0897..4356853bbc 100755 --- a/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.inf +++ b/Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.inf @@ -18,7 +18,7 @@ MODULE_TYPE = UEFI_DRIVER VERSION_STRING = 1.0 LIBRARY_CLASS = OmapDmaLib - CONSTRUCTOR = OmapDmaLibConstructor + [Sources.common] OmapDmaLib.c diff --git a/Omap35xxPkg/MMCHSDxe/MMCHS.h b/Omap35xxPkg/MMCHSDxe/MMCHS.h index e7d8b7e474..2cda5679be 100644 --- a/Omap35xxPkg/MMCHSDxe/MMCHS.h +++ b/Omap35xxPkg/MMCHSDxe/MMCHS.h @@ -26,6 +26,7 @@ #include #include #include +#include #include #include diff --git a/Omap35xxPkg/MMCHSDxe/MMCHS.inf b/Omap35xxPkg/MMCHSDxe/MMCHS.inf index 3313ddd44f..0931112e95 100644 --- a/Omap35xxPkg/MMCHSDxe/MMCHS.inf +++ b/Omap35xxPkg/MMCHSDxe/MMCHS.inf @@ -36,6 +36,7 @@ MemoryAllocationLib IoLib OmapDmaLib + DmaLib [Guids] diff --git a/Omap35xxPkg/Omap35xxPkg.dsc b/Omap35xxPkg/Omap35xxPkg.dsc index 5e4fa30145..fda0b7b0a7 100644 --- a/Omap35xxPkg/Omap35xxPkg.dsc +++ b/Omap35xxPkg/Omap35xxPkg.dsc @@ -60,6 +60,7 @@ DxeServicesTableLib|MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.inf UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf UefiApplicationEntryPoint|MdePkg/Library/UefiApplicationEntryPoint/UefiApplicationEntryPoint.inf + DmaLib|ArmPkg/Library/ArmDmaLib/ArmDmaLib.inf # # Assume everything is fixed at build @@ -172,7 +173,7 @@ [Components.common] Omap35xxPkg/Library/Omap35xxTimerLib/Omap35xxTimerLib.inf Omap35xxPkg/Library/OmapLib/OmapLib.inf - Omap35xxPkg/Library/OmapLib/OmapDmaLib.inf + Omap35xxPkg/Library/OmapDmaLib/OmapDmaLib.inf Omap35xxPkg/Flash/Flash.inf Omap35xxPkg/MMCHSDxe/MMCHS.inf diff --git a/Omap35xxPkg/PciEmulation/PciEmulation.h b/Omap35xxPkg/PciEmulation/PciEmulation.h index 066a553950..7db4f330ca 100644 --- a/Omap35xxPkg/PciEmulation/PciEmulation.h +++ b/Omap35xxPkg/PciEmulation/PciEmulation.h @@ -29,6 +29,7 @@ #include #include #include +#include #include #include diff --git a/Omap35xxPkg/PciEmulation/PciEmulation.inf b/Omap35xxPkg/PciEmulation/PciEmulation.inf index e9da1fb4f7..8567b69388 100644 --- a/Omap35xxPkg/PciEmulation/PciEmulation.inf +++ b/Omap35xxPkg/PciEmulation/PciEmulation.inf @@ -42,6 +42,7 @@ UefiRuntimeServicesTableLib IoLib OmapDmaLib + DmaLib [Protocols] gEfiPciRootBridgeIoProtocolGuid