xdmad.h

/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
/* ---------------------------------------------------------------------------- */

#ifndef _XDMAD_H
#define _XDMAD_H


/*----------------------------------------------------------------------------
 *        Includes
 *----------------------------------------------------------------------------*/

#include "chip.h"
#include <assert.h>


/*----------------------------------------------------------------------------
 *        Consts
 *----------------------------------------------------------------------------*/
#define XDMAD_TRANSFER_MEMORY  0xFF   
#define XDMAD_ALLOC_FAILED     0xFFFF 
#define XDMAD_TRANSFER_TX      0
#define XDMAD_TRANSFER_RX      1

/* XDMA_MBR_UBC */
#define XDMA_UBC_NDE (0x1u << 24)
#define   XDMA_UBC_NDE_FETCH_DIS (0x0u << 24)
#define   XDMA_UBC_NDE_FETCH_EN  (0x1u << 24)
#define XDMA_UBC_NSEN (0x1u << 25)
#define   XDMA_UBC_NSEN_UNCHANGED (0x0u << 25)
#define   XDMA_UBC_NSEN_UPDATED (0x1u << 25)
#define XDMA_UBC_NDEN (0x1u << 26)
#define   XDMA_UBC_NDEN_UNCHANGED (0x0u << 26)
#define   XDMA_UBC_NDEN_UPDATED (0x1u << 26)
#define XDMA_UBC_NVIEW_Pos 27
#define    XDMA_UBC_NVIEW_Msk (0x3u << XDMA_UBC_NVIEW_Pos)
#define    XDMA_UBC_NVIEW_NDV0 (0x0u << XDMA_UBC_NVIEW_Pos)
#define    XDMA_UBC_NVIEW_NDV1 (0x1u << XDMA_UBC_NVIEW_Pos)
#define    XDMA_UBC_NVIEW_NDV2 (0x2u << XDMA_UBC_NVIEW_Pos)
#define    XDMA_UBC_NVIEW_NDV3 (0x3u << XDMA_UBC_NVIEW_Pos)

/*----------------------------------------------------------------------------
 *        MACRO
 *----------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------
 *        Types
 *----------------------------------------------------------------------------*/
typedef enum _XdmadStatus {
    XDMAD_OK = 0,        
    XDMAD_PARTIAL_DONE,
    XDMAD_DONE,
    XDMAD_BUSY,          
    XDMAD_ERROR,         
    XDMAD_CANCELED       
} eXdmadStatus, eXdmadRC;

typedef enum _XdmadState {
    XDMAD_STATE_FREE = 0,      
    XDMAD_STATE_ALLOCATED,     
    XDMAD_STATE_START,         
    XDMAD_STATE_IN_XFR,        
    XDMAD_STATE_DONE,          
    XDMAD_STATE_HALTED,        
} eXdmadState;

typedef enum _XdmadProgState {
    XDMAD_SINGLE = 0,
    XDMAD_MULTI,
    XDMAD_LLI,
} eXdmadProgState;

typedef void (*XdmadTransferCallback)(uint32_t Channel, void *pArg, uint32_t status);

typedef struct _XdmadChannel {
    XdmadTransferCallback fCallback; 
    void *pArg;                     
    uint8_t bIrqOwner;              
    uint8_t bSrcPeriphID;           
    uint8_t bDstPeriphID;           
    uint8_t bSrcTxIfID;             
    uint8_t bSrcRxIfID;             
    uint8_t bDstTxIfID;             
    uint8_t bDstRxIfID;             
    volatile uint8_t state;         
} sXdmadChannel;

typedef struct _Xdmad {
    Xdmac *pXdmacs;
    sXdmadChannel XdmaChannels[XDMACCHID_NUMBER];
    uint8_t  numControllers;
    uint8_t  numChannels;
    uint8_t  xdmaMutex;
} sXdmad;

typedef struct _XdmadCfg {
    uint32_t mbr_ubc;
    uint32_t mbr_sa;
    uint32_t mbr_da;
    uint32_t mbr_cfg;
    uint32_t mbr_bc;
    uint32_t mbr_ds;
    uint32_t mbr_sus;
    uint32_t mbr_dus;
} sXdmadCfg;

typedef struct _LinkedListDescriporView0 {
    uint32_t mbr_nda;
    uint32_t mbr_ubc;
    uint32_t mbr_ta;
} LinkedListDescriporView0;

typedef struct _LinkedListDescriporView1 {
    uint32_t mbr_nda;
    uint32_t mbr_ubc;
    uint32_t mbr_sa;
    uint32_t mbr_da;
} LinkedListDescriporView1;

typedef struct _LinkedListDescriporView2 {
    uint32_t mbr_nda;
    uint32_t mbr_ubc;
    uint32_t mbr_sa;
    uint32_t mbr_da;
    uint32_t mbr_cfg;
} LinkedListDescriporView2;

typedef struct _LinkedListDescriporView3 {
    uint32_t mbr_nda;
    uint32_t mbr_ubc;
    uint32_t mbr_sa;
    uint32_t mbr_da;
    uint32_t mbr_cfg;
    uint32_t mbr_bc;
    uint32_t mbr_ds;
    uint32_t mbr_sus;
    uint32_t mbr_dus;
} LinkedListDescriporView3;

extern sXdmad XDMAD_Instance;

/*----------------------------------------------------------------------------
 *        Exported functions
 *----------------------------------------------------------------------------*/
extern uint32_t XDMAD_AllocateChannel(sXdmad *pXdmad,
                                       uint8_t bSrcID, uint8_t bDstID);
extern eXdmadRC XDMAD_FreeChannel(sXdmad *pXdmad, uint32_t dwChannel);

extern eXdmadRC XDMAD_ConfigureTransfer(sXdmad *pXdmad,
        uint32_t dwChannel,
        sXdmadCfg *pXdmaParam,
        uint32_t dwXdmaDescCfg,
        uint32_t dwXdmaDescAddr,
        uint32_t dwXdmaIntEn);

extern eXdmadRC XDMAD_PrepareChannel(sXdmad *pXdmad, uint32_t dwChannel);

extern eXdmadRC XDMAD_IsTransferDone(sXdmad *pXdmad, uint32_t dwChannel);

extern eXdmadRC XDMAD_StartTransfer(sXdmad *pXdmad, uint32_t dwChannel);

extern void XDMAD_DoNothingCallback(uint32_t Channel, void *pArg, uint32_t status);

extern eXdmadRC XDMAD_SetCallback(sXdmad *pXdmad,
                                   uint32_t dwChannel,
                                   XdmadTransferCallback fCallback,
                                   void *pArg);

extern eXdmadRC XDMAD_StopTransfer(sXdmad *pXdmad, uint32_t dwChannel);
#endif //#ifndef _XDMAD_H