UARTCC32XX.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_uart_UARTCC32XX__include
#define ti_drivers_uart_UARTCC32XX__include

#ifdef __cplusplus
extern "C" {
#endif

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


#define UARTCC32XX_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, UARTCC32XX_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 UARTCC32XX_PIN_01_UART1_TX  0x700 
#define UARTCC32XX_PIN_02_UART1_RX  0x701 
#define UARTCC32XX_PIN_03_UART0_TX  0x702 
#define UARTCC32XX_PIN_04_UART0_RX  0x703 
#define UARTCC32XX_PIN_07_UART1_TX  0x506 
#define UARTCC32XX_PIN_08_UART1_RX  0x507 
#define UARTCC32XX_PIN_16_UART1_TX  0x20F 
#define UARTCC32XX_PIN_17_UART1_RX  0x210 
#define UARTCC32XX_PIN_45_UART0_RX  0x92C 
#define UARTCC32XX_PIN_45_UART1_RX  0x22C 
#define UARTCC32XX_PIN_53_UART0_TX  0x934 
#define UARTCC32XX_PIN_55_UART0_TX  0x336 
#define UARTCC32XX_PIN_55_UART1_TX  0x636 
#define UARTCC32XX_PIN_57_UART0_RX  0x338 
#define UARTCC32XX_PIN_57_UART1_RX  0x638 
#define UARTCC32XX_PIN_58_UART1_TX  0x639 
#define UARTCC32XX_PIN_59_UART1_RX  0x63A 
#define UARTCC32XX_PIN_62_UART0_TX  0xB3D 
/*
 *  Flow control pins.
 */
#define UARTCC32XX_PIN_50_UART0_CTS  0xC31 
#define UARTCC32XX_PIN_50_UART0_RTS  0x331 
#define UARTCC32XX_PIN_50_UART1_RTS  0xA31 
#define UARTCC32XX_PIN_52_UART0_RTS  0x633 
#define UARTCC32XX_PIN_61_UART0_RTS  0x53C 
#define UARTCC32XX_PIN_61_UART0_CTS  0x63C 
#define UARTCC32XX_PIN_61_UART1_CTS  0x33C 
#define UARTCC32XX_PIN_62_UART0_RTS  0xA3D 
#define UARTCC32XX_PIN_62_UART1_RTS  0x33D 
#define UARTCC32XX_FLOWCTRL_NONE 0

#define UARTCC32XX_FLOWCTRL_HARDWARE 1

/* Add UARTCC32XX_STATUS_* macros here */

#define UARTCC32XX_CMD_IS_BUSY                  (UART_CMD_RESERVED + 0)


#define UARTCC32XX_CMD_IS_RX_DATA_AVAILABLE     (UART_CMD_RESERVED + 1)


#define UARTCC32XX_CMD_IS_TX_SPACE_AVAILABLE    (UART_CMD_RESERVED + 2)


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

typedef struct UARTCC32XX_FxnSet {
    bool (*readIsrFxn)  (UART_Handle handle);
    int  (*readTaskFxn) (UART_Handle handle);
} UARTCC32XX_FxnSet;

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

typedef struct UARTCC32XX_HWAttrsV1 {
    unsigned int    baseAddr;
    unsigned int    intNum;
    unsigned int    intPriority;
    uint32_t        flowControl;
    unsigned char  *ringBufPtr;
    size_t          ringBufSize;
    uint16_t        rxPin;
    uint16_t        txPin;
    uint16_t        ctsPin;
    uint16_t        rtsPin;
    UARTCC32XX_ErrorCallback errorFxn;
} UARTCC32XX_HWAttrsV1;

typedef struct UARTCC32XX_Object {
    /* UART state variable */
    struct {
        bool             opened:1;         /* Has the obj been opened */
        UART_Mode        readMode:1;       /* Mode for all read calls */
        UART_Mode        writeMode:1;      /* Mode for all write calls */
        UART_DataMode    readDataMode:1;   /* Type of data being read */
        UART_DataMode    writeDataMode:1;  /* Type of data being written */
        UART_ReturnMode  readReturnMode:1; /* Receive return mode */
        UART_Echo        readEcho:1;       /* Echo received data back */
        /*
         * Flag to determine if a timeout has occurred when the user called
         * UART_read(). This flag is set by the timeoutClk clock object.
         */
        bool             bufTimeout:1;
        /*
         * Flag to determine when an ISR needs to perform a callback; in both
         * UART_MODE_BLOCKING or UART_MODE_CALLBACK
         */
        bool             callCallback:1;
        /*
         * Flag to determine if the ISR is in control draining the ring buffer
         * when in UART_MODE_CALLBACK
         */
        bool             drainByISR:1;
        /* Flag to keep the state of the read Power constraints */
        bool             rxEnabled:1;
        /* Flag to keep the state of the write Power constraints */
        bool             txEnabled:1;

        /* Flags to prevent recursion in read callback mode */
        bool             inReadCallback:1;
        volatile bool    readCallbackPending:1;
    } state;

    HwiP_Handle          hwiHandle;        /* Hwi handle for interrupts */
    ClockP_Handle        timeoutClk;       /* Clock object to for timeouts */
    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 read variables */
    RingBuf_Object       ringBuffer;       /* local circular buffer object */
    /* A complement pair of read functions for both the ISR and UART_read() */
    UARTCC32XX_FxnSet    readFxns;
    unsigned char       *readBuf;          /* Buffer data pointer */
    size_t               readSize;         /* Desired number of bytes to read */
    size_t               readCount;        /* Number of bytes left to read */
    SemaphoreP_Handle    readSem;          /* UART read semaphore */
    unsigned int         readTimeout;      /* Timeout for read semaphore */
    UART_Callback        readCallback;     /* Pointer to read callback */

    /* UART write variables */
    const unsigned char *writeBuf;         /* Buffer data pointer */
    size_t               writeSize;        /* Desired number of bytes to write*/
    size_t               writeCount;       /* Number of bytes left to write */
    SemaphoreP_Handle    writeSem;         /* UART write semaphore*/
    unsigned int         writeTimeout;     /* Timeout for write semaphore */
    UART_Callback        writeCallback;    /* Pointer to write callback */

    /* For Power management */
    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 */
} UARTCC32XX_Object, *UARTCC32XX_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart_UARTCC32XX__include */