SPICC26XXDMA.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_SPICC26XXDMA__include
#define ti_drivers_spi_SPICC26XXDMA__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <ti/drivers/SPI.h>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/dma/UDMACC26XX.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/power/PowerCC26XX.h>

#define ti_sysbios_family_arm_m3_Hwi__nolocalnames
#include <ti/sysbios/knl/Semaphore.h>
#include <ti/sysbios/knl/Swi.h>
#include <ti/sysbios/family/arm/m3/Hwi.h>

/* Add SPICC26XXDMA_STATUS_* macros here */

#define SPICC26XXDMA_CMD_RETURN_PARTIAL_ENABLE  SPI_CMD_RESERVED + 0

#define SPICC26XXDMA_CMD_RETURN_PARTIAL_DISABLE SPI_CMD_RESERVED + 1

#define SPICC26XXDMA_CMD_SET_CSN_PIN            SPI_CMD_RESERVED + 2

#define SPICC26XXDMA_CMD_SET_CSN_WAKEUP         SPI_CMD_RESERVED + 3

/* BACKWARDS COMPATIBILITY */
#define SPICC26XXDMA_RETURN_PARTIAL_ENABLE      SPICC26XXDMA_CMD_RETURN_PARTIAL_ENABLE
#define SPICC26XXDMA_RETURN_PARTIAL_DISABLE     SPICC26XXDMA_CMD_RETURN_PARTIAL_DISABLE
#define SPICC26XXDMA_SET_CSN_PIN                SPICC26XXDMA_CMD_SET_CSN_PIN
#define SPICC26XXDMA_SET_CSN_WAKEUP             SPICC26XXDMA_CMD_SET_CSN_WAKEUP
/* END BACKWARDS COMPATIBILITY */

extern const SPI_FxnTable SPICC26XXDMA_fxnTable;

typedef enum SPICC26XXDMA_FrameSize {
    SPICC26XXDMA_8bit  = 0,
    SPICC26XXDMA_16bit = 1
} SPICC26XXDMA_FrameSize;

typedef void        (*SPICC26XXDMA_CallbackFxn) (SPI_Handle handle);

typedef struct SPICC26XXDMA_HWAttrsV1 {
    uint32_t         baseAddr;
    uint8_t          intNum;
    uint8_t          intPriority;
    uint32_t         swiPriority;
    PowerCC26XX_Resource   powerMngrId;
    uint16_t         defaultTxBufValue;
    uint32_t         rxChannelBitMask;
    uint32_t         txChannelBitMask;
    PIN_Id           mosiPin;
    PIN_Id           misoPin;
    PIN_Id           clkPin;
    PIN_Id           csnPin;
} SPICC26XXDMA_HWAttrsV1;

typedef struct SPICC26XXDMA_Object {
    /* SPI control variables */
    SPI_TransferMode       transferMode;        
    unsigned int           transferTimeout;     
    SPI_CallbackFxn        transferCallbackFxn; 
    SPI_Mode               mode;                
    unsigned int           bitRate;
    unsigned int           dataSize;            
    SPI_FrameFormat        frameFormat;         
    /* SPI SYS/BIOS objects */
    ti_sysbios_family_arm_m3_Hwi_Struct hwi;    
    Swi_Struct             swi;                 
    Semaphore_Struct       transferComplete;    
    /* SPI current transaction */
    SPI_Transaction        *currentTransaction; 
    SPICC26XXDMA_FrameSize frameSize;           
    /* Support for dynamic CSN pin allocation */
    PIN_Id                 csnPin;              
    /* PIN driver state object and handle */
    PIN_State              pinState;
    PIN_Handle             pinHandle;

    /* UDMA driver handle */
    UDMACC26XX_Handle      udmaHandle;

    /* Optional slave mode features */
    bool                   returnPartial;      
#ifdef SPICC26XXDMA_WAKEUP_ENABLED
    SPICC26XXDMA_CallbackFxn wakeupCallbackFxn;
#endif
    /* Scratch buffer of size uint32_t */
    uint16_t               scratchBuf;

    /* SPI pre- and post notification functions */
    void                   *spiPreFxn;         
    void                   *spiPostFxn;        
    Power_NotifyObj        spiPreObj;          
    Power_NotifyObj        spiPostObj;         
    volatile bool          spiPowerConstraint; 
    bool                   isOpen;             
} SPICC26XXDMA_Object, *SPICC26XXDMA_Handle;


/* Do not interfere with the app if they include the family Hwi module */
#undef ti_sysbios_family_arm_m3_Hwi__nolocalnames

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_spi_SPICC26XXDMA__include */