SAMV71 Xplained Ultra Software Package 1.4

xdmad.h

00001 /* ----------------------------------------------------------------------------
00002  *         SAM Software Package License 
00003  * ----------------------------------------------------------------------------
00004  * Copyright (c) 2013, Atmel Corporation
00005  *
00006  * All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *
00011  * - Redistributions of source code must retain the above copyright notice,
00012  * this list of conditions and the disclaimer below.
00013  *
00014  * Atmel's name may not be used to endorse or promote products derived from
00015  * this software without specific prior written permission.
00016  *
00017  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
00020  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00022  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00023  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00024  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  * ----------------------------------------------------------------------------
00028  */
00029 
00030 #ifndef _XDMAD_H
00031 #define _XDMAD_H
00032 
00033  
00034 /*----------------------------------------------------------------------------
00035  *        Includes
00036  *----------------------------------------------------------------------------*/
00037 
00038 #include "chip.h"
00039 #include <assert.h>
00040 
00041 
00042 /** \addtogroup dmad_defines DMA Driver Defines
00043         @{*/
00044 /*----------------------------------------------------------------------------
00045  *        Consts
00046  *----------------------------------------------------------------------------*/
00047 #define XDMAD_TRANSFER_MEMORY  0xFF   /**< DMA transfer from or to memory */
00048 #define XDMAD_ALLOC_FAILED     0xFFFF /**< Channel allocate failed */
00049 
00050 #define XDMAD_TRANSFER_TX      0
00051 #define XDMAD_TRANSFER_RX      1
00052 
00053 /* XDMA_MBR_UBC */
00054 #define XDMA_UBC_NDE (0x1u << 24)
00055 #define   XDMA_UBC_NDE_FETCH_DIS (0x0u << 24)
00056 #define   XDMA_UBC_NDE_FETCH_EN  (0x1u << 24)
00057 #define XDMA_UBC_NSEN (0x1u << 25)
00058 #define   XDMA_UBC_NSEN_UNCHANGED (0x0u << 25)
00059 #define   XDMA_UBC_NSEN_UPDATED (0x1u << 25)
00060 #define XDMA_UBC_NDEN (0x1u << 26)
00061 #define   XDMA_UBC_NDEN_UNCHANGED (0x0u << 26)
00062 #define   XDMA_UBC_NDEN_UPDATED (0x1u << 26)
00063 #define XDMA_UBC_NVIEW_Pos 27
00064 #define    XDMA_UBC_NVIEW_Msk (0x3u << XDMA_UBC_NVIEW_Pos)
00065 #define    XDMA_UBC_NVIEW_NDV0 (0x0u << XDMA_UBC_NVIEW_Pos)
00066 #define    XDMA_UBC_NVIEW_NDV1 (0x1u << XDMA_UBC_NVIEW_Pos)
00067 #define    XDMA_UBC_NVIEW_NDV2 (0x2u << XDMA_UBC_NVIEW_Pos)
00068 #define    XDMA_UBC_NVIEW_NDV3 (0x3u << XDMA_UBC_NVIEW_Pos)
00069 
00070 /*----------------------------------------------------------------------------
00071  *        MACRO
00072  *----------------------------------------------------------------------------*/
00073 
00074 /**     @}*/
00075 
00076 /*----------------------------------------------------------------------------
00077  *        Types
00078  *----------------------------------------------------------------------------*/
00079 /** \addtogroup dmad_structs DMA Driver Structs
00080         @{*/
00081 
00082 /** DMA status or return code */
00083 typedef enum _XdmadStatus {
00084     XDMAD_OK = 0,        /**< Operation is successful */
00085     XDMAD_PARTIAL_DONE,
00086     XDMAD_DONE,
00087     XDMAD_BUSY,          /**< Channel occupied or transfer not finished */
00088     XDMAD_ERROR,         /**< Operation failed */
00089     XDMAD_CANCELED       /**< Operation cancelled */
00090 } eXdmadStatus, eXdmadRC;
00091 
00092 /** DMA state for channel */
00093 typedef enum _XdmadState {
00094     XDMAD_STATE_FREE = 0,      /**< Free channel */
00095     XDMAD_STATE_ALLOCATED,     /**< Allocated to some peripheral */
00096     XDMAD_STATE_START,         /**< DMA started */ 
00097     XDMAD_STATE_IN_XFR,        /**< DMA in transferring */
00098     XDMAD_STATE_DONE,          /**< DMA transfer done */
00099     XDMAD_STATE_HALTED,        /**< DMA transfer stopped */
00100 } eXdmadState;
00101 
00102 /** DMA Programming state for channel */
00103 typedef enum _XdmadProgState {
00104     XDMAD_SINGLE= 0,
00105     XDMAD_MULTI,
00106     XDMAD_LLI,
00107 } eXdmadProgState;
00108 
00109 /** DMA transfer callback */
00110 typedef void (*XdmadTransferCallback)(uint32_t Channel, void* pArg);
00111 
00112 /** DMA driver channel */
00113 typedef struct _XdmadChannel {
00114     XdmadTransferCallback fCallback; /**< Callback */
00115     void* pArg;                     /**< Callback argument */
00116     uint8_t bIrqOwner;              /**< Uses DMA handler or external one */
00117     uint8_t bSrcPeriphID;           /**< HW ID for source */
00118     uint8_t bDstPeriphID;           /**< HW ID for destination */
00119     uint8_t bSrcTxIfID;             /**< DMA Tx Interface ID for source */
00120     uint8_t bSrcRxIfID;             /**< DMA Rx Interface ID for source */
00121     uint8_t bDstTxIfID;             /**< DMA Tx Interface ID for destination */
00122     uint8_t bDstRxIfID;             /**< DMA Rx Interface ID for destination */
00123     volatile uint8_t state;         /**< DMA channel state */
00124 } sXdmadChannel;
00125 
00126 /** DMA driver instance */
00127 typedef struct _Xdmad {
00128     Xdmac *pXdmacs;
00129     sXdmadChannel XdmaChannels[XDMACCHID_NUMBER];
00130     uint8_t  numControllers;
00131     uint8_t  numChannels;
00132     uint8_t  pollingMode;
00133     uint8_t  pollingTimeout;
00134     uint8_t  xdmaMutex;
00135 } sXdmad;
00136 
00137 typedef struct _XdmadCfg {
00138     /** Microblock Control Member. */
00139     uint32_t mbr_ubc;
00140     /** Source Address Member. */
00141     uint32_t mbr_sa;
00142     /** Destination Address Member. */
00143     uint32_t mbr_da;
00144     /** Configuration Register. */
00145     uint32_t mbr_cfg;
00146     /** Block Control Member. */
00147     uint32_t mbr_bc;
00148     /** Data Stride Member. */
00149     uint32_t mbr_ds;
00150     /** Source Microblock Stride Member. */
00151     uint32_t mbr_sus;
00152     /** Destination Microblock Stride Member. */
00153     uint32_t mbr_dus;
00154 } sXdmadCfg;
00155 
00156 /** \brief Structure for storing parameters for DMA view0 that can be
00157  * performed by the DMA Master transfer.*/
00158 typedef struct _LinkedListDescriporView0 
00159 {
00160     /** Next Descriptor Address number. */
00161     uint32_t mbr_nda;
00162     /** Microblock Control Member. */
00163     uint32_t mbr_ubc;
00164     /** Transfer Address Member. */
00165     uint32_t mbr_ta;
00166 }LinkedListDescriporView0;
00167 
00168 /** \brief Structure for storing parameters for DMA view1 that can be
00169  * performed by the DMA Master transfer.*/
00170 typedef struct _LinkedListDescriporView1
00171 {
00172     /** Next Descriptor Address number. */
00173     uint32_t mbr_nda;
00174     /** Microblock Control Member. */
00175     uint32_t mbr_ubc;
00176     /** Source Address Member. */
00177     uint32_t mbr_sa;
00178     /** Destination Address Member. */
00179     uint32_t mbr_da;
00180 }LinkedListDescriporView1;
00181 
00182 /** \brief Structure for storing parameters for DMA view2 that can be
00183  * performed by the DMA Master transfer.*/
00184 typedef struct _LinkedListDescriporView2
00185 {
00186     /** Next Descriptor Address number. */
00187     uint32_t mbr_nda;
00188     /** Microblock Control Member. */
00189     uint32_t mbr_ubc;
00190     /** Source Address Member. */
00191     uint32_t mbr_sa;
00192     /** Destination Address Member. */
00193     uint32_t mbr_da;
00194     /** Configuration Register. */
00195     uint32_t mbr_cfg;
00196 }LinkedListDescriporView2;
00197 
00198 /** \brief Structure for storing parameters for DMA view3 that can be
00199  * performed by the DMA Master transfer.*/
00200 typedef struct _LinkedListDescriporView3
00201 {
00202     /** Next Descriptor Address number. */
00203     uint32_t mbr_nda;
00204     /** Microblock Control Member. */
00205     uint32_t mbr_ubc;
00206     /** Source Address Member. */
00207     uint32_t mbr_sa;
00208     /** Destination Address Member. */
00209     uint32_t mbr_da;
00210     /** Configuration Register. */
00211     uint32_t mbr_cfg;
00212     /** Block Control Member. */
00213     uint32_t mbr_bc;
00214     /** Data Stride Member. */
00215     uint32_t mbr_ds;
00216     /** Source Microblock Stride Member. */
00217     uint32_t mbr_sus;
00218     /** Destination Microblock Stride Member. */
00219     uint32_t mbr_dus;
00220 }LinkedListDescriporView3;
00221 
00222 /**     @}*/
00223 
00224 /*----------------------------------------------------------------------------
00225  *        Exported functions
00226  *----------------------------------------------------------------------------*/
00227 /** \addtogroup dmad_functions DMA Driver Functions
00228         @{*/
00229 extern void XDMAD_Initialize( sXdmad *pXdmad,
00230                              uint8_t bPollingMode );
00231 
00232 extern void XDMAD_Handler( sXdmad *pDmad);
00233 
00234 extern uint32_t XDMAD_AllocateChannel( sXdmad *pXdmad,
00235                                       uint8_t bSrcID, uint8_t bDstID);
00236 extern eXdmadRC XDMAD_FreeChannel( sXdmad *pXdmad, uint32_t dwChannel );
00237 
00238 extern eXdmadRC XDMAD_ConfigureTransfer( sXdmad *pXdmad,
00239                                          uint32_t dwChannel,
00240                                          sXdmadCfg *pXdmaParam,
00241                                          uint32_t dwXdmaDescCfg,
00242                                          uint32_t dwXdmaDescAddr,
00243                                          uint32_t dwXdmaIntEn);
00244 
00245 extern eXdmadRC XDMAD_PrepareChannel( sXdmad *pXdmad, uint32_t dwChannel);
00246 
00247 extern eXdmadRC XDMAD_IsTransferDone( sXdmad *pXdmad, uint32_t dwChannel );
00248 
00249 extern eXdmadRC XDMAD_StartTransfer( sXdmad *pXdmad, uint32_t dwChannel );
00250 
00251 extern eXdmadRC XDMAD_SetCallback( sXdmad *pXdmad, 
00252                                    uint32_t dwChannel,
00253                                    XdmadTransferCallback fCallback, 
00254                                    void* pArg );
00255 
00256 extern eXdmadRC XDMAD_StopTransfer( sXdmad *pXdmad, uint32_t dwChannel );
00257 /**     @}*/
00258 /**@}*/
00259 #endif //#ifndef _XDMAD_H
00260 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines