UARTCC26X0.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-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_UARTCC26X0__include
#define ti_drivers_uart_UARTCC26X0__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/dpl/SwiP.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/UART.h>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/utils/RingBuf.h>

#ifdef __cplusplus
extern "C" {
#endif

#define UARTCC26X0_FLOWCTRL_NONE 0

#define UARTCC26X0_FLOWCTRL_HARDWARE 1

/* Add UARTCC26X0_STATUS_* macros here */

#define UARTCC26X0_CMD_RETURN_PARTIAL_ENABLE (UART_CMD_RESERVED + 0)

#define UARTCC26X0_CMD_RETURN_PARTIAL_DISABLE (UART_CMD_RESERVED + 1)

#define UARTCC26X0_CMD_RX_FIFO_FLUSH (UART_CMD_RESERVED + 2)

#define UARTCC26X0_FIFO_SIZE 32

typedef enum
{
    UARTCC26X0_FIFO_THRESHOLD_DEFAULT = 0, 
    UARTCC26X0_FIFO_THRESHOLD_1_8,         
    UARTCC26X0_FIFO_THRESHOLD_2_8,         
    UARTCC26X0_FIFO_THRESHOLD_4_8,         
    UARTCC26X0_FIFO_THRESHOLD_6_8,         
    UARTCC26X0_FIFO_THRESHOLD_7_8          
} UARTCC26X0_FifoThreshold;

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

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

typedef struct
{
    uint32_t baseAddr;
    int intNum;
    uint8_t intPriority;
    uint32_t swiPriority;
    uint32_t flowControl;
    unsigned char *ringBufPtr;
    size_t ringBufSize;
    uint8_t rxPin;
    uint8_t txPin;
    uint8_t ctsPin;
    uint8_t rtsPin;
    UARTCC26X0_FifoThreshold txIntFifoThr;
    UARTCC26X0_FifoThreshold rxIntFifoThr;
    UARTCC26X0_ErrorCallback errorFxn;
} UARTCC26X0_HWAttrs;

typedef struct
{
    /* 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;
        /* Keep track of RX enabled state set by app with UART_control() */
        bool ctrlRxEnabled: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;
    } state;

    HwiP_Struct hwi;              /* Hwi object for interrupts */
    SwiP_Struct swi;              /* Swi for read/write callbacks */
    ClockP_Struct timeoutClk;     /* Clock object to for timeouts */
    ClockP_Struct txFifoEmptyClk; /* UART TX FIFO empty clock */
    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 */
    uint32_t status;              /* RX status */

    /* UART read variables */
    RingBuf_Object ringBuffer;  /* local circular buffer object */
    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_Struct readSem;  /* UART read semaphore */
    unsigned int readTimeout;   /* Timeout for read semaphore */
    UART_Callback readCallback; /* Pointer to read callback */
    bool readRetPartial;        /* Return partial RX data if timeout occurs */

    /* 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_Struct writeSem;        /* UART write semaphore*/
    unsigned int writeTimeout;         /* Timeout for write semaphore */
    UART_Callback writeCallback;       /* Pointer to write callback */
    unsigned int writeEmptyClkTimeout; /* TX FIFO timeout tick count */

    /* PIN driver state object and handle */
    PIN_State pinState;
    PIN_Handle hPin;

    /* For Power management */
    Power_NotifyObj postNotify;
} UARTCC26X0_Object, *UARTCC26X0_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart_UARTCC26X0__include */