Omap35xxPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Omap35xxPkg / Include / Library / OmapDmaLib.h

/** @file\r
\r
  Abstractions for simple OMAP DMA.\r
  OMAP_DMA4 structure elements are described in the OMAP35xx TRM.\r
\r
  Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __OMAP_DMA_LIB_H__\r
#define __OMAP_DMA_LIB_H__\r
\r
\r
// Example from DMA chapter of the OMAP35xx spec\r
typedef struct {\r
  UINT8     DataType;                      // DMA4_CSDPi[1:0]\r
  UINT8     ReadPortAccessType;            // DMA4_CSDPi[8:7]\r
  UINT8     WritePortAccessType;           // DMA4_CSDPi[15:14]\r
  UINT8     SourceEndiansim;               // DMA4_CSDPi[21]\r
  UINT8     DestinationEndianism;          // DMA4_CSDPi[19]\r
  UINT8     WriteMode;                     // DMA4_CSDPi[17:16]\r
  UINT8     SourcePacked;                  // DMA4_CSDPi[6]\r
  UINT8     DestinationPacked;             // DMA4_CSDPi[13]\r
  UINT32    NumberOfElementPerFrame;       // DMA4_CENi\r
  UINT32    NumberOfFramePerTransferBlock; // DMA4_CFNi\r
  UINT32    SourceStartAddress;            // DMA4_CSSAi\r
  UINT32    DestinationStartAddress;       // DMA4_CDSAi\r
  UINT32    SourceElementIndex;            // DMA4_CSEi\r
  UINT32    SourceFrameIndex;              // DMA4_CSFi\r
  UINT32    DestinationElementIndex;       // DMA4_CDEi\r
  UINT32    DestinationFrameIndex;         // DMA4_CDFi\r
  UINT8     ReadPortAccessMode;            // DMA4_CCRi[13:12]\r
  UINT8     WritePortAccessMode;           // DMA4_CCRi[15:14]\r
  UINT8     ReadPriority;                  // DMA4_CCRi[6]\r
  UINT8     WritePriority;                 // DMA4_CCRi[23]\r
  UINT8     ReadRequestNumber;             // DMA4_CCRi[4:0]\r
  UINT8     WriteRequestNumber;            // DMA4_CCRi[20:19]\r
} OMAP_DMA4;\r
\r
\r
/**\r
  Configure OMAP DMA Channel\r
\r
  @param  Channel               DMA Channel to configure\r
  @param  Dma4                  Pointer to structure used to initialize DMA registers for the Channel\r
\r
  @retval EFI_SUCCESS           The range was mapped for the returned NumberOfBytes.\r
  @retval EFI_INVALID_PARAMETER Channel is not valid\r
  @retval EFI_DEVICE_ERROR      The system hardware could not map the requested information.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EnableDmaChannel (\r
  IN  UINTN       Channel,\r
  IN  OMAP_DMA4   *Dma4\r
  );\r
\r
/**\r
  Turn of DMA channel configured by EnableDma().\r
\r
  @param  Channel               DMA Channel to configure\r
  @param  SuccesMask            Bits in DMA4_CSR register indicate EFI_SUCCESS\r
  @param  ErrorMask             Bits in DMA4_CSR register indicate EFI_DEVICE_ERROR\r
\r
  @retval EFI_SUCCESS           DMA hardware disabled\r
  @retval EFI_INVALID_PARAMETER Channel is not valid\r
  @retval EFI_DEVICE_ERROR      The system hardware could not map the requested information.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DisableDmaChannel (\r
  IN  UINTN       Channel,\r
  IN  UINT32      SuccessMask,\r
  IN  UINT32      ErrorMask\r
  );\r
\r
\r
\r
#endif\r
\r