SPIUSCIBDMA.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_SPIUSCIBDMA__include
#define ti_drivers_spi_SPIUSCIBDMA__include

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/sysbios/knl/Semaphore.h>

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

typedef struct SPIUSCIBDMA_HWAttrs {
    uint32_t   baseAddr;
    uint8_t   clockSource;
    uint8_t   bitOrder;
    uint8_t *scratchBufPtr;
    uint8_t  defaultTxBufValue;

    uint32_t  dmaBaseAddr;
    uint8_t   rxDMAChannelIndex;
    uint8_t   rxDMASourceTrigger;
    uint8_t   txDMAChannelIndex;
    uint8_t   txDMASourceTrigger;
} SPIUSCIBDMA_HWAttrs;

typedef struct SPIUSCIBDMA_Object {
    bool                isOpen;             /* Variable to determine if the SPI is open */

    Semaphore_Struct    transferComplete;   /* Notify finished SPI transfer */

    SPI_TransferMode    transferMode;       /* SPI transfer mode */
    SPI_CallbackFxn     transferCallbackFxn;/* Callback fxn in CALLBACK mode */

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

} SPIUSCIBDMA_Object, *SPIUSCIBDMA_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_spi_SPIUSCIBDMA__include */