xdmac.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  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 DMAC_H
#define DMAC_H

/*------------------------------------------------------------------------------
 *         Headers
 *----------------------------------------------------------------------------*/

#include "chip.h"

#ifndef __rtems__
#include <../../../../utils/utility.h>
#endif /* __rtems__ */
#include <stdint.h>
#include <rtems/score/assert.h>

/*------------------------------------------------------------------------------
 *         Definitions
 *----------------------------------------------------------------------------*/

#define XDMAC_CONTROLLER_NUM            1

#define XDMAC_CHANNEL_NUM               24

#define XDMAC_MAX_BT_SIZE               0xFFFF

/*----------------------------------------------------------------------------
 *         Macro
 *----------------------------------------------------------------------------*/
#define XDMA_GET_DATASIZE(size) ((size==0)? XDMAC_CC_DWIDTH_BYTE : \
                                 ((size==1)? XDMAC_CC_DWIDTH_HALFWORD : \
                                  (XDMAC_CC_DWIDTH_WORD)))
#define XDMA_GET_CC_SAM(s)      ((s==0)? XDMAC_CC_SAM_FIXED_AM : \
                                 ((s==1)? XDMAC_CC_SAM_INCREMENTED_AM : \
                                  ((s==2)? XDMAC_CC_SAM_UBS_AM : \
                                   XDMAC_CC_SAM_UBS_DS_AM)))
#define XDMA_GET_CC_DAM(d)      ((d==0)? XDMAC_CC_DAM_FIXED_AM : \
                                 ((d==1)? XDMAC_CC_DAM_INCREMENTED_AM : \
                                  ((d==2)? XDMAC_CC_DAM_UBS_AM : \
                                   XDMAC_CC_DAM_UBS_DS_AM)))
#define XDMA_GET_CC_MEMSET(m)   ((m==0)? XDMAC_CC_MEMSET_NORMAL_MODE : \
                                 XDMAC_CC_MEMSET_HW_MODE)

/*------------------------------------------------------------------------------
 *         Global functions
 *----------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C" {
#endif

static inline uint32_t XDMAC_GetType(Xdmac *pXdmac)
{
    _Assert(pXdmac);
    return pXdmac->XDMAC_GTYPE;
}

static inline uint32_t XDMAC_GetConfig(Xdmac *pXdmac)
{
    _Assert(pXdmac);
    return pXdmac->XDMAC_GCFG;
}

static inline uint32_t XDMAC_GetArbiter(Xdmac *pXdmac)
{
    _Assert(pXdmac);
    return pXdmac->XDMAC_GWAC;
}

static inline void XDMAC_EnableGIt (Xdmac *pXdmac, uint8_t dwInteruptMask)
{
    _Assert(pXdmac);
    pXdmac->XDMAC_GIE = (XDMAC_GIE_IE0 << dwInteruptMask);
}

static inline void XDMAC_DisableGIt (Xdmac *pXdmac, uint8_t dwInteruptMask)
{
    _Assert(pXdmac);
    pXdmac->XDMAC_GID = (XDMAC_GID_ID0 << dwInteruptMask);
}

static inline uint32_t XDMAC_GetGItMask(Xdmac *pXdmac)
{
    _Assert(pXdmac);
    return (pXdmac->XDMAC_GIM);
}

static inline uint32_t XDMAC_GetGIsr(Xdmac *pXdmac)
{
    _Assert(pXdmac);
    return (pXdmac->XDMAC_GIS);
}

static inline uint32_t XDMAC_GetMaskedGIsr(Xdmac *pXdmac)
{
    uint32_t _dwStatus;
    _Assert(pXdmac);
    _dwStatus = pXdmac->XDMAC_GIS;
    _dwStatus &= pXdmac->XDMAC_GIM;
    return _dwStatus;
}

static inline void XDMAC_EnableChannel(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GE = (XDMAC_GE_EN0 << channel);
}

static inline void XDMAC_EnableChannels(Xdmac *pXdmac, uint32_t bmChannels)
{
    _Assert(pXdmac);
    pXdmac->XDMAC_GE = bmChannels;
}

static inline void XDMAC_DisableChannel(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GD = (XDMAC_GD_DI0 << channel);
}

static inline void XDMAC_DisableChannels(Xdmac *pXdmac, uint32_t bmChannels)
{
    _Assert(pXdmac);
    pXdmac->XDMAC_GD = bmChannels;
}


static inline uint32_t XDMAC_GetGlobalChStatus(Xdmac *pXdmac)
{
    _Assert(pXdmac);
    return pXdmac->XDMAC_GS;
}

static inline void XDMAC_SuspendReadChannel(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GRS |= XDMAC_GRS_RS0 << channel;
}

static inline void XDMAC_SuspendWriteChannel(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GWS |= XDMAC_GWS_WS0 << channel;
}

static inline void XDMAC_SuspendReadWriteChannel(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GRWS = (XDMAC_GRWS_RWS0 << channel);
}

static inline void XDMAC_ResumeReadWriteChannel(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GRWR = (XDMAC_GRWR_RWR0 << channel);
}

static inline void XDMAC_SoftwareTransferReq(Xdmac *pXdmac, uint8_t channel)
{

    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GSWR = (XDMAC_GSWR_SWREQ0 << channel);
}

static inline uint32_t XDMAC_GetSoftwareTransferStatus(Xdmac *pXdmac)
{

    _Assert(pXdmac);
    return pXdmac->XDMAC_GSWS;
}

static inline uint32_t XDMAC_GetChannelIsr (Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    return pXdmac->XDMAC_CHID[channel].XDMAC_CIS;
}

static inline void XDMAC_SoftwareFlushReq(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GSWF = (XDMAC_GSWF_SWF0 << channel);

    while (!(XDMAC_GetChannelIsr(pXdmac, channel) & XDMAC_CIS_FIS));
}

static inline void XDMAC_EnableChannelIt (Xdmac *pXdmac, uint8_t channel,
                            uint8_t dwInteruptMask)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CIE = dwInteruptMask;
}

static inline void XDMAC_DisableChannelIt (Xdmac *pXdmac, uint8_t channel,
                             uint8_t dwInteruptMask)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CID = dwInteruptMask;
}

static inline uint32_t XDMAC_GetChannelItMask (Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    return pXdmac->XDMAC_CHID[channel].XDMAC_CIM;
}

static inline uint32_t XDMAC_GetMaskChannelIsr (Xdmac *pXdmac, uint8_t channel)
{
    uint32_t status;
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    status = pXdmac->XDMAC_CHID[channel].XDMAC_CIS;
    status &= pXdmac->XDMAC_CHID[channel].XDMAC_CIM;

    return status;
}

static inline void XDMAC_SetSourceAddr(Xdmac *pXdmac, uint8_t channel, uint32_t addr)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CSA = addr;
}

static inline void XDMAC_SetDestinationAddr(Xdmac *pXdmac, uint8_t channel, uint32_t addr)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CDA = addr;
}

static inline void XDMAC_SetDescriptorAddr(Xdmac *pXdmac, uint8_t channel,
                             uint32_t addr, uint8_t ndaif)
{
    _Assert(pXdmac);
    _Assert(ndaif < 2);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CNDA =  (addr & 0xFFFFFFFC) | ndaif;
}

static inline void XDMAC_SetDescriptorControl(Xdmac *pXdmac, uint8_t channel, uint8_t config)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CNDC = config;
}

static inline void XDMAC_SetMicroblockControl(Xdmac *pXdmac, uint8_t channel, uint32_t ublen)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CUBC = XDMAC_CUBC_UBLEN(ublen);
}

static inline void XDMAC_SetBlockControl(Xdmac *pXdmac, uint8_t channel, uint16_t blen)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CBC = XDMAC_CBC_BLEN(blen);
}

static inline void XDMAC_SetChannelConfig(Xdmac *pXdmac, uint8_t channel, uint32_t config)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CC = config;
}

static inline uint32_t XDMAC_GetChannelConfig(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    return pXdmac->XDMAC_CHID[channel].XDMAC_CC;
}

static inline void XDMAC_SetDataStride_MemPattern(Xdmac *pXdmac, uint8_t channel,
                                    uint32_t dds_msp)
{

    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CDS_MSP = dds_msp;
}

static inline void XDMAC_SetSourceMicroBlockStride(Xdmac *pXdmac, uint8_t channel,
                                     uint32_t subs)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CSUS = XDMAC_CSUS_SUBS(subs);
}

static inline void XDMAC_SetDestinationMicroBlockStride(Xdmac *pXdmac, uint8_t channel,
        uint32_t dubs)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_CHID[channel].XDMAC_CDUS = XDMAC_CDUS_DUBS(dubs);
}

static inline uint32_t XDMAC_GetChDestinationAddr(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    return pXdmac->XDMAC_CHID[channel].XDMAC_CDA;
}

static inline void XDMAC_StartTransfer(Xdmac *pXdmac, uint8_t channel)
{
    _Assert(pXdmac);
    _Assert(channel < XDMAC_CHANNEL_NUM);
    pXdmac->XDMAC_GE = (XDMAC_GE_EN0 << channel);
    pXdmac->XDMAC_GIE = (XDMAC_GIE_IE0 << channel);
}

#ifdef __cplusplus
}
#endif

#endif //#ifndef DMAC_H