SPICC3200DMA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS 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 ti_drivers_spi_SPICC3200DMA__include
#define ti_drivers_spi_SPICC3200DMA__include

#ifdef __cplusplus
extern "C" {
#endif

#include <ti/drivers/ports/HwiP.h>
#include <ti/drivers/ports/SemaphoreP.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/SPI.h>
#include <ti/drivers/dma/UDMACC3200.h>

/* Add SPICC3200DMA_STATUS_* macros here */

/* Add SPICC3200DMA_CMD_* macros here */

typedef unsigned long SPIBaseAddrType;
typedef unsigned long SPIDataType;

/* SPI function table pointer */
extern const SPI_FxnTable SPICC3200DMA_fxnTable;

typedef enum SPICC3200DMA_FrameSize {
    SPICC3200DMA_8bit  = 0,
    SPICC3200DMA_16bit = 1,
    SPICC3200DMA_32bit = 2
} SPICC3200DMA_FrameSize;

typedef struct SPICC3200DMA_HWAttrs {
    SPIBaseAddrType   baseAddr;

    uint32_t   intNum;

    uint32_t   intPriority;

    uint32_t   spiPRCM;

    uint32_t   csControl;

    uint32_t   csPolarity;

    uint32_t   pinMode;

    uint32_t   turboMode;

    uint32_t  *scratchBufPtr;

    unsigned long   defaultTxBufValue;

    uint32_t   rxChannelIndex;

    uint32_t   txChannelIndex;

    uint32_t   minDmaTransferSize;
} SPICC3200DMA_HWAttrs;

typedef struct SPICC3200DMA_Object {
    HwiP_Handle            hwiHandle;
    SemaphoreP_Handle      transferComplete;

    Power_NotifyObj        notifyObj;
    unsigned int           powerMgrId;

    uint32_t               bitRate;        
    uint32_t               dataSize;       
    SPI_CallbackFxn        transferCallbackFxn;
    SPI_Transaction       *transaction;

    void                 (*spiPollingFxn) (uint32_t baseAddr, void *rx,
                                   void *tx, uint8_t rxInc, uint8_t txInc,
                               size_t count);

    uint8_t                rxFifoTrigger;
    uint8_t                txFifoTrigger;
    SPI_Mode               spiMode;
    SPI_TransferMode       transferMode;
    SPI_FrameFormat        frameFormat;    
    SPICC3200DMA_FrameSize frameSize;

    bool                   isOpen;

    /* UDMA */
    UDMACC3200_Handle      dmaHandle;
} SPICC3200DMA_Object, *SPICC3200DMA_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_spi_SPICC3200DMA__include */