SPICC26X2DMA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2018, 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_SPICC26X2DMA__include
#define ti_drivers_spi_SPICC26X2DMA__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>

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/dpl/SwiP.h>

/* Add SPICC26X2DMA_STATUS_* macros here */

#define SPICC26X2DMA_CMD_RETURN_PARTIAL_ENABLE  (SPI_CMD_RESERVED + 0)

#define SPICC26X2DMA_CMD_RETURN_PARTIAL_DISABLE (SPI_CMD_RESERVED + 1)

#define SPICC26X2DMA_CMD_SET_CSN_PIN            (SPI_CMD_RESERVED + 2)

/* BACKWARDS COMPATIBILITY */
#define SPICC26X2DMA_RETURN_PARTIAL_ENABLE      SPICC26X2DMA_CMD_RETURN_PARTIAL_ENABLE
#define SPICC26X2DMA_RETURN_PARTIAL_DISABLE     SPICC26X2DMA_CMD_RETURN_PARTIAL_DISABLE
#define SPICC26X2DMA_SET_CSN_PIN                SPICC26X2DMA_CMD_SET_CSN_PIN
/* END BACKWARDS COMPATIBILITY */

extern const SPI_FxnTable SPICC26X2DMA_fxnTable;

typedef enum SPICC26X2DMA_FrameSize {
    SPICC26X2DMA_8bit  = 0,
    SPICC26X2DMA_16bit = 1
} SPICC26X2DMA_FrameSize;

typedef enum SPICC26X2DMA_ReturnPartial {
    SPICC26X2DMA_retPartDisabled  = 0,
    SPICC26X2DMA_retPartEnabledIntNotSet = 1,
    SPICC26X2DMA_retPartEnabledIntSet = 2
} SPICC26X2DMA_ReturnPartial;

typedef struct SPICC26X2DMA_HWAttrs {
    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;

    uint32_t minDmaTransferSize;
} SPICC26X2DMA_HWAttrs;

typedef struct SPICC26X2DMA_Object {
    HwiP_Struct                hwi;
    PIN_Handle                 pinHandle;
    PIN_State                  pinState;
    Power_NotifyObj            spiPostObj;
    SwiP_Struct                swi;
    SemaphoreP_Struct          transferComplete;

    SPI_CallbackFxn            transferCallbackFxn;
    SPI_Transaction            *headPtr;
    SPI_Transaction            *tailPtr;
    SPI_Transaction            *completedTransfers;
    UDMACC26XX_Handle          udmaHandle;

    size_t                     framesQueued;
    size_t                     framesTransferred;
    size_t                     priTransferSize;
    size_t                     altTransferSize;

    uint32_t                   activeChannel;
    uint32_t                   bitRate;
    uint32_t                   dataSize;
    uint32_t                   transferTimeout;

    uint16_t                   rxScratchBuf;
    uint16_t                   txScratchBuf;

    SPI_TransferMode           transferMode;
    SPI_Mode                   mode;
    uint8_t                    format;
    PIN_Id                     csnPin;
    SPICC26X2DMA_ReturnPartial returnPartial;
    bool                       isOpen;
} SPICC26X2DMA_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_spi_SPICC26X2DMA__include */