spi_dma.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 _SPI_DMA_
#define _SPI_DMA_
 
/*----------------------------------------------------------------------------
 *        Headers
 *----------------------------------------------------------------------------*/
 
#include "chip.h"
 
/*----------------------------------------------------------------------------
 *        Definitions
 *----------------------------------------------------------------------------*/
 
#define SPID_ERROR          1
 
#define SPID_ERROR_LOCK     2
 
/*----------------------------------------------------------------------------
 *        Macros
 *----------------------------------------------------------------------------*/
 
#define SPID_CSR_SCBR(mck, spck)    SPI_CSR_SCBR((mck) / (spck))
 
#define SPID_CSR_DLYBS(mck, delay)  SPI_CSR_DLYBS((((delay) * \
        ((mck) / 1000000)) / 1000) + 1)
 
#define SPID_CSR_DLYBCT(mck, delay) SPI_CSR_DLYBCT((((delay) / 32 * \
        ((mck) / 1000000)) / 1000) + 1)
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*----------------------------------------------------------------------------
 *        Types
 *----------------------------------------------------------------------------*/
 
typedef void (*SpidCallback)(uint8_t, void *);
 
typedef struct _SpidCmd {
    uint8_t *pTxBuff;
    uint8_t TxSize;
    uint8_t *pRxBuff;
    uint16_t RxSize;
    uint8_t spiCs;
    SpidCallback callback;
    void *pArgument;
} SpidCmd;
 
typedef struct _Spid {
    Spi *pSpiHw;
    SpidCmd *pCurrentCommand;
    sXdmad *pXdmad;
    uint8_t spiId;
    volatile int8_t semaphore;
} Spid;
 
/*----------------------------------------------------------------------------
 *        Exported functions
 *----------------------------------------------------------------------------*/
 
extern uint32_t SPID_Configure(Spid *pSpid,
                                Spi *pSpiHw,
                                uint8_t spiId,
                                uint32_t SpiMode,
                                sXdmad *pXdmad);
 
extern void SPID_ConfigureCS(Spid *pSpid, uint32_t dwCS, uint32_t dwCsr);
 
extern uint32_t SPID_SendCommand(Spid *pSpid, SpidCmd *pCommand);
 
extern void SPID_Handler(Spid *pSpid);
 
extern void SPID_DmaHandler(Spid *pSpid);
 
extern uint32_t SPID_IsBusy(const Spid *pSpid);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef _SPI_DMA_ */