SPITivaDMA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 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_SPITivaDMA__include
#define ti_drivers_spi_SPITivaDMA__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <ti/drivers/SPI.h>

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

/* Add SPITivaDMA_STATUS_* macros here */

/* Add SPITivaDMA_CMD_* macros here */

#if defined(TIVAWARE)
/* c99 types required by TivaWare */
#include <stdint.h>
typedef uint32_t            SPIBaseAddrType;
typedef uint32_t            SPIDataType;
#else /* MWARE */
typedef unsigned long       SPIBaseAddrType;
typedef unsigned long       SPIDataType;
#endif

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

typedef enum SPITivaDMA_FrameSize {
    SPITivaDMA_8bit  = 0,
    SPITivaDMA_16bit = 1
} SPITivaDMA_FrameSize;

typedef struct SPITivaDMA_HWAttrs {
    SPIBaseAddrType   baseAddr;
    unsigned int      intNum;

    uint32_t          intPriority;

    uint32_t         *scratchBufPtr;
    uint32_t          defaultTxBufValue;
    uint32_t          rxChannelIndex;
    uint32_t          txChannelIndex;

    void  (*channelMappingFxn)(SPIDataType);
    uint32_t          rxChannelMappingFxnArg;
    uint32_t          txChannelMappingFxnArg;
} SPITivaDMA_HWAttrs;

typedef struct SPITivaDMA_Object {
    Semaphore_Struct      transferComplete;    /* Notify finished SPITivaDMA transfer */
    ti_sysbios_family_arm_m3_Hwi_Struct hwi;   /* Hwi object handle */

    SPI_TransferMode      transferMode;        /* SPITivaDMA transfer mode */
    SPI_CallbackFxn       transferCallbackFxn; /* Callback fxn in CALLBACK mode */
    uint32_t              transferTimeout;     /* Transfer timeout in system ticks */

    SPI_Transaction      *transaction;         /* void * to the current transaction*/

    SPITivaDMA_FrameSize  frameSize;           /* Data frame size variable */

    bool                  isOpen;              /* flag to indicate module is open */
} SPITivaDMA_Object, *SPITivaDMA_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_SPITivaDMA__include */