SPIMSP432DMA.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_SPIMSP432DMA__include
#define ti_drivers_spi_SPIMSP432DMA__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#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/UDMAMSP432.h>

/* Add SPIMSP432DMA_STATUS_* macros here */

/* Add SPIMSP432DMA_CMD_* macros here */

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

typedef struct SPIMSP432DMA_HWAttrs {
    uint32_t baseAddr;           
    uint16_t bitOrder;           
    uint8_t  clockSource;        
    uint8_t  defaultTxBufValue;  
    uint8_t  dmaIntNum;          
    uint32_t intPriority;        
    uint32_t rxDMAChannelIndex;  
    uint32_t txDMAChannelIndex;  
} SPIMSP432DMA_HWAttrs;

typedef struct SPIMSP432DMA_Object {
    SemaphoreP_Handle transferComplete;    /* Notify finished SPI transfer */
    HwiP_Handle       hwiHandle;

    SPI_CallbackFxn   transferCallbackFxn; /* Callback fxn in CALLBACK mode */
    SPI_Transaction  *transaction;         /* Ptr to the current transaction*/

    SPI_TransferMode  transferMode;        /* SPI transfer mode */
    SPI_Mode          spiMode;             /* Master or Slave mode */
    uint8_t           scratchBuffer;       /* Scratch buffer */

    bool              isOpen;

    uint32_t          bitRate;             /* SPI bit rate in Hz */
    uint16_t          clockPhase;
    uint16_t          clockPolarity;

    Power_NotifyObj   perfChangeNotify;
    uint32_t          perfConstraintMask;
    UDMAMSP432_Handle dmaHandle;
} SPIMSP432DMA_Object, *SPIMSP432DMA_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_spi_SPIMSP432DMA__include */