git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained/libchip_samv7/include/xdmad.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2013, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 #ifndef _XDMAD_H\r
  31 #define _XDMAD_H\r
  32 \r
  33  \r
  34 /*----------------------------------------------------------------------------\r
  35  *        Includes\r
  36  *----------------------------------------------------------------------------*/\r
  37 \r
  38 #include "board.h"\r
  39 #include <assert.h>\r
  40 \r
  41 \r
  42 /** \addtogroup dmad_defines DMA Driver Defines\r
  43         @{*/\r
  44 /*----------------------------------------------------------------------------\r
  45  *        Consts\r
  46  *----------------------------------------------------------------------------*/\r
  47 #define XDMAD_TRANSFER_MEMORY  0xFF   /**< DMA transfer from or to memory */\r
  48 #define XDMAD_ALLOC_FAILED     0xFFFF /**< Channel allocate failed */\r
  49 \r
  50 #define XDMAD_TRANSFER_TX      0\r
  51 #define XDMAD_TRANSFER_RX      1\r
  52 \r
  53 /* XDMA_MBR_UBC */\r
  54 #define XDMA_UBC_NDE (0x1u << 24)\r
  55 #define   XDMA_UBC_NDE_FETCH_DIS (0x0u << 24)\r
  56 #define   XDMA_UBC_NDE_FETCH_EN  (0x1u << 24)\r
  57 #define XDMA_UBC_NSEN (0x1u << 25)\r
  58 #define   XDMA_UBC_NSEN_UNCHANGED (0x0u << 25)\r
  59 #define   XDMA_UBC_NSEN_UPDATED (0x1u << 25)\r
  60 #define XDMA_UBC_NDEN (0x1u << 26)\r
  61 #define   XDMA_UBC_NDEN_UNCHANGED (0x0u << 26)\r
  62 #define   XDMA_UBC_NDEN_UPDATED (0x1u << 26)\r
  63 #define XDMA_UBC_NVIEW_Pos 27\r
  64 #define    XDMA_UBC_NVIEW_Msk (0x3u << XDMA_UBC_NVIEW_Pos)\r
  65 #define    XDMA_UBC_NVIEW_NDV0 (0x0u << XDMA_UBC_NVIEW_Pos)\r
  66 #define    XDMA_UBC_NVIEW_NDV1 (0x1u << XDMA_UBC_NVIEW_Pos)\r
  67 #define    XDMA_UBC_NVIEW_NDV2 (0x2u << XDMA_UBC_NVIEW_Pos)\r
  68 #define    XDMA_UBC_NVIEW_NDV3 (0x3u << XDMA_UBC_NVIEW_Pos)\r
  69 \r
  70 /*----------------------------------------------------------------------------\r
  71  *        MACRO\r
  72  *----------------------------------------------------------------------------*/\r
  73 \r
  74 /**     @}*/\r
  75 \r
  76 /*----------------------------------------------------------------------------\r
  77  *        Types\r
  78  *----------------------------------------------------------------------------*/\r
  79 /** \addtogroup dmad_structs DMA Driver Structs\r
  80         @{*/\r
  81 \r
  82 /** DMA status or return code */\r
  83 typedef enum _XdmadStatus {\r
  84     XDMAD_OK = 0,        /**< Operation is sucessful */\r
  85     XDMAD_PARTIAL_DONE,\r
  86     XDMAD_DONE,\r
  87     XDMAD_BUSY,          /**< Channel occupied or transfer not finished */\r
  88     XDMAD_ERROR,         /**< Operation failed */\r
  89     XDMAD_CANCELED       /**< Operation canceled */\r
  90 } eXdmadStatus, eXdmadRC;\r
  91 \r
  92 /** DMA state for channel */\r
  93 typedef enum _XdmadState {\r
  94     XDMAD_STATE_FREE = 0,      /**< Free channel */\r
  95     XDMAD_STATE_ALLOCATED,     /**< Allocated to some peripheral */\r
  96     XDMAD_STATE_START,         /**< DMA started */ \r
  97     XDMAD_STATE_IN_XFR,        /**< DMA in trasfering */\r
  98     XDMAD_STATE_DONE,          /**< DMA transfer done */\r
  99 } eXdmadState;\r
 100 \r
 101 /** DMA transfer callback */\r
 102 typedef void (*XdmadTransferCallback)(uint32_t status, void* pArg);\r
 103 \r
 104 /** DMA driver channel */\r
 105 typedef struct _XdmadChannel {\r
 106     XdmadTransferCallback fCallback; /**< Callback */\r
 107     void* pArg;                     /**< Callback argument */\r
 108     uint8_t bIrqOwner;              /**< Uses DMA handler or external one */\r
 109     uint8_t bSrcPeriphID;           /**< HW ID for source */\r
 110     uint8_t bDstPeriphID;           /**< HW ID for destination */\r
 111     uint8_t bSrcTxIfID;             /**< DMA Tx Interface ID for source */\r
 112     uint8_t bSrcRxIfID;             /**< DMA Rx Interface ID for source */\r
 113     uint8_t bDstTxIfID;             /**< DMA Tx Interface ID for destination */\r
 114     uint8_t bDstRxIfID;             /**< DMA Rx Interface ID for destination */\r
 115     volatile uint8_t state;         /**< DMA channel state */\r
 116 } sXdmadChannel;\r
 117 \r
 118 /** DMA driver instance */\r
 119 typedef struct _Xdmad {\r
 120     Xdmac *pXdmacs;\r
 121     sXdmadChannel XdmaChannels[XDMACCHID_NUMBER];\r
 122     uint8_t  numControllers;\r
 123     uint8_t  numChannels;\r
 124     uint8_t  pollingMode;\r
 125     uint8_t  pollingTimeout;\r
 126 } sXdmad;\r
 127 \r
 128 typedef struct _XdmadCfg {\r
 129     /** Microblock Control Member. */\r
 130     uint32_t mbr_ubc;\r
 131     /** Source Address Member. */\r
 132     uint32_t mbr_sa;\r
 133     /** Destination Address Member. */\r
 134     uint32_t mbr_da;\r
 135     /** Configuration Register. */\r
 136     uint32_t mbr_cfg;\r
 137     /** Block Control Member. */\r
 138     uint32_t mbr_bc;\r
 139     /** Data Stride Member. */\r
 140     uint32_t mbr_ds;\r
 141     /** Source Microblock Stride Member. */\r
 142     uint32_t mbr_sus;\r
 143     /** Destination Microblock Stride Member. */\r
 144     uint32_t mbr_dus;\r
 145 } sXdmadCfg;\r
 146 \r
 147 /** \brief Structure for storing parameters for DMA view0 that can be\r
 148  * performed by the DMA Master transfer.*/\r
 149 typedef struct _LinkedListDescriporView0 \r
 150 {\r
 151     /** Next Descriptor Address number. */\r
 152     uint32_t mbr_nda;\r
 153     /** Microblock Control Member. */\r
 154     uint32_t mbr_ubc;\r
 155     /** Transfer Address Member. */\r
 156     uint32_t mbr_ta;\r
 157 }LinkedListDescriporView0;\r
 158 \r
 159 /** \brief Structure for storing parameters for DMA view1 that can be\r
 160  * performed by the DMA Master transfer.*/\r
 161 typedef struct _LinkedListDescriporView1\r
 162 {\r
 163     /** Next Descriptor Address number. */\r
 164     uint32_t mbr_nda;\r
 165     /** Microblock Control Member. */\r
 166     uint32_t mbr_ubc;\r
 167     /** Source Address Member. */\r
 168     uint32_t mbr_sa;\r
 169     /** Destination Address Member. */\r
 170     uint32_t mbr_da;\r
 171 }LinkedListDescriporView1;\r
 172 \r
 173 /** \brief Structure for storing parameters for DMA view2 that can be\r
 174  * performed by the DMA Master transfer.*/\r
 175 typedef struct _LinkedListDescriporView2\r
 176 {\r
 177     /** Next Descriptor Address number. */\r
 178     uint32_t mbr_nda;\r
 179     /** Microblock Control Member. */\r
 180     uint32_t mbr_ubc;\r
 181     /** Source Address Member. */\r
 182     uint32_t mbr_sa;\r
 183     /** Destination Address Member. */\r
 184     uint32_t mbr_da;\r
 185     /** Configuration Register. */\r
 186     uint32_t mbr_cfg;\r
 187 }LinkedListDescriporView2;\r
 188 \r
 189 /** \brief Structure for storing parameters for DMA view3 that can be\r
 190  * performed by the DMA Master transfer.*/\r
 191 typedef struct _LinkedListDescriporView3\r
 192 {\r
 193     /** Next Descriptor Address number. */\r
 194     uint32_t mbr_nda;\r
 195     /** Microblock Control Member. */\r
 196     uint32_t mbr_ubc;\r
 197     /** Source Address Member. */\r
 198     uint32_t mbr_sa;\r
 199     /** Destination Address Member. */\r
 200     uint32_t mbr_da;\r
 201     /** Configuration Register. */\r
 202     uint32_t mbr_cfg;\r
 203     /** Block Control Member. */\r
 204     uint32_t mbr_bc;\r
 205     /** Data Stride Member. */\r
 206     uint32_t mbr_ds;\r
 207     /** Source Microblock Stride Member. */\r
 208     uint32_t mbr_sus;\r
 209     /** Destination Microblock Stride Member. */\r
 210     uint32_t mbr_dus;\r
 211 }LinkedListDescriporView3;\r
 212 \r
 213 /**     @}*/\r
 214 \r
 215 /*----------------------------------------------------------------------------\r
 216  *        Exported functions\r
 217  *----------------------------------------------------------------------------*/\r
 218 /** \addtogroup dmad_functions DMA Driver Functionos\r
 219         @{*/\r
 220 extern void XDMAD_Initialize( sXdmad *pXdmad,\r
 221                              uint8_t bPollingMode );\r
 222 \r
 223 extern void XDMAD_Handler( sXdmad *pDmad);\r
 224 \r
 225 extern uint32_t XDMAD_AllocateChannel( sXdmad *pXdmad,\r
 226                                       uint8_t bSrcID, uint8_t bDstID);\r
 227 extern eXdmadRC XDMAD_FreeChannel( sXdmad *pXdmad, uint32_t dwChannel );\r
 228 \r
 229 extern eXdmadRC XDMAD_ConfigureTransfer( sXdmad *pXdmad,\r
 230                                          uint32_t dwChannel,\r
 231                                          sXdmadCfg *pXdmaParam,\r
 232                                          uint32_t dwXdmaDescCfg,\r
 233                                          uint32_t dwXdmaDescAddr);\r
 234 \r
 235 extern eXdmadRC XDMAD_PrepareChannel( sXdmad *pXdmad, uint32_t dwChannel);\r
 236 \r
 237 extern eXdmadRC XDMAD_IsTransferDone( sXdmad *pXdmad, uint32_t dwChannel );\r
 238 \r
 239 extern eXdmadRC XDMAD_StartTransfer( sXdmad *pXdmad, uint32_t dwChannel );\r
 240 \r
 241 extern eXdmadRC XDMAD_SetCallback( sXdmad *pXdmad, \r
 242                                    uint32_t dwChannel,\r
 243                                    XdmadTransferCallback fCallback, \r
 244                                    void* pArg );\r
 245 \r
 246 extern eXdmadRC XDMAD_StopTransfer( sXdmad *pXdmad, uint32_t dwChannel );\r
 247 /**     @}*/\r
 248 /**@}*/\r
 249 #endif //#ifndef _XDMAD_H\r
 250 \r