UARTCC32XXDMA.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2020, 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_uart_UARTCC32XXDMA__include
#define ti_drivers_uart_UARTCC32XXDMA__include

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/dpl/ClockP.h>
#include <ti/drivers/dpl/HwiP.h>

#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/power/PowerCC32XX.h>
#include <ti/drivers/UART.h>
#include <ti/drivers/dma/UDMACC32XX.h>

#ifdef __cplusplus
extern "C" {
#endif

#define UARTCC32XXDMA_PIN_UNASSIGNED   0xFFF
/*
 *  The bits in the pin mode macros are as follows:
 *  The lower 8 bits of the macro refer to the pin, offset by 1, to match
 *  driverlib pin defines.  For example, UARTCC32XXDMA_PIN_01_UART1_TX & 0xff = 0,
 *  which equals PIN_01 in driverlib pin.h.  By matching the PIN_xx defines in
 *  driverlib pin.h, we can pass the pin directly to the driverlib functions.
 *  The upper 8 bits of the macro correspond to the pin mux confg mode
 *  value for the pin to operate in the UART mode.  For example, pin 1 is
 *  configured with mode 7 to operate as UART1 TX.
 */
#define UARTCC32XXDMA_PIN_01_UART1_TX  0x700 
#define UARTCC32XXDMA_PIN_02_UART1_RX  0x701 
#define UARTCC32XXDMA_PIN_03_UART0_TX  0x702 
#define UARTCC32XXDMA_PIN_04_UART0_RX  0x703 
#define UARTCC32XXDMA_PIN_07_UART1_TX  0x506 
#define UARTCC32XXDMA_PIN_08_UART1_RX  0x507 
#define UARTCC32XXDMA_PIN_16_UART1_TX  0x20F 
#define UARTCC32XXDMA_PIN_17_UART1_RX  0x210 
#define UARTCC32XXDMA_PIN_45_UART0_RX  0x92C 
#define UARTCC32XXDMA_PIN_45_UART1_RX  0x22C 
#define UARTCC32XXDMA_PIN_53_UART0_TX  0x934 
#define UARTCC32XXDMA_PIN_55_UART0_TX  0x336 
#define UARTCC32XXDMA_PIN_55_UART1_TX  0x636 
#define UARTCC32XXDMA_PIN_57_UART0_RX  0x338 
#define UARTCC32XXDMA_PIN_57_UART1_RX  0x638 
#define UARTCC32XXDMA_PIN_58_UART1_TX  0x639 
#define UARTCC32XXDMA_PIN_59_UART1_RX  0x63A 
#define UARTCC32XXDMA_PIN_62_UART0_TX  0xB3D 
/*
 *  Flow control pins.
 */
#define UARTCC32XXDMA_PIN_50_UART0_CTS  0xC31 
#define UARTCC32XXDMA_PIN_50_UART0_RTS  0x331 
#define UARTCC32XXDMA_PIN_50_UART1_RTS  0xA31 
#define UARTCC32XXDMA_PIN_52_UART0_RTS  0x633 
#define UARTCC32XXDMA_PIN_61_UART0_RTS  0x53C 
#define UARTCC32XXDMA_PIN_61_UART0_CTS  0x63C 
#define UARTCC32XXDMA_PIN_61_UART1_CTS  0x33C 
#define UARTCC32XXDMA_PIN_62_UART0_RTS  0xA3D 
#define UARTCC32XXDMA_PIN_62_UART1_RTS  0x33D 
#define UARTCC32XXDMA_FLOWCTRL_NONE 0

#define UARTCC32XXDMA_FLOWCTRL_HARDWARE 1

/* Add UARTCC32XXDMA_STATUS_* macros here */

#define UARTCC32XXDMA_CMD_IS_BUSY                       (UART_CMD_RESERVED + 0)


#define UARTCC32XXDMA_CMD_IS_RX_DATA_AVAILABLE          (UART_CMD_RESERVED + 1)


#define UARTCC32XXDMA_CMD_IS_TX_SPACE_AVAILABLE         (UART_CMD_RESERVED + 2)


/* UART function table pointer */
extern const UART_FxnTable UARTCC32XXDMA_fxnTable;

typedef void (*UARTCC32XXDMA_ErrorCallback) (UART_Handle handle, uint32_t error);

typedef struct {
    unsigned int baseAddr;
    unsigned int intNum;
    unsigned int intPriority;
    uint32_t        flowControl;
    unsigned long rxChannelIndex;
    unsigned long txChannelIndex;
    uint16_t        rxPin;
    uint16_t        txPin;
    uint16_t        ctsPin;
    uint16_t        rtsPin;
    UARTCC32XXDMA_ErrorCallback errorFxn;
} UARTCC32XXDMA_HWAttrsV1;

typedef struct {
    /* UART control variables */
    bool                 opened;           /* Has the obj been opened */
    UART_Mode            readMode;         /* Mode for all read calls */
    UART_Mode            writeMode;        /* Mode for all write calls */
    unsigned int         readTimeout;      /* Timeout for read semaphore */
    unsigned int         writeTimeout;     /* Timeout for write semaphore */
    UART_Callback        readCallback;     /* Pointer to read callback */
    UART_Callback        writeCallback;    /* Pointer to write callback */
    UART_ReturnMode      readReturnMode;   /* Receive return mode */
    UART_DataMode        readDataMode;     /* Type of data being read */
    UART_DataMode        writeDataMode;    /* Type of data being written */
    uint32_t             baudRate;         /* Baud rate for UART */
    UART_LEN             dataLength;       /* Data length for UART */
    UART_STOP            stopBits;         /* Stop bits for UART */
    UART_PAR             parityType;       /* Parity bit type for UART */
    UART_Echo            readEcho;         /* Echo received data back */

    /* UART write variables */
    const void          *writeBuf;         /* Buffer data pointer */
    size_t               writeCount;       /* Number of Chars sent */
    size_t               writeSize;        /* Chars remaining in buffer */

    /* UART receive variables */
    void                *readBuf;          /* Buffer data pointer */
    size_t               readCount;        /* Number of Chars read */
    size_t               readSize;         /* Chars remaining in buffer */

    /* Semaphores for blocking mode */
    SemaphoreP_Handle    writeSem;         /* UART write semaphore */
    SemaphoreP_Handle    readSem;          /* UART read semaphore */

    HwiP_Handle    hwiHandle;

    /* For Power management */
    ClockP_Handle         txFifoEmptyClk;  /* UART TX FIFO empty clock */
    Power_NotifyObj       postNotify;      /* LPDS wake-up notify object */
    unsigned int          powerMgrId;      /* Determined from base address */
    PowerCC32XX_ParkState prevParkTX;      /* Previous park state TX pin */
    uint16_t              txPin;           /* TX pin ID */
    PowerCC32XX_ParkState prevParkRTS;     /* Previous park state of RTS pin */
    uint16_t              rtsPin;           /* RTS pin ID */

    /* UDMA */
    UDMACC32XX_Handle    dmaHandle;
} UARTCC32XXDMA_Object, *UARTCC32XXDMA_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart_UARTCC32XXDMA__include */