UARTCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, 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_UARTCC26XX__include
#define ti_drivers_uart_UARTCC26XX__include

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/drivers/UART.h>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/utils/RingBuf.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/uart.h)

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

/* Add UARTCC26XX_STATUS_* macros here */

#define UARTCC26XX_CMD_RETURN_PARTIAL_ENABLE    (UART_CMD_RESERVED + 0)

#define UARTCC26XX_CMD_RETURN_PARTIAL_DISABLE   (UART_CMD_RESERVED + 1)

#define UARTCC26XX_CMD_RX_FIFO_FLUSH            (UART_CMD_RESERVED + 2)

#define UARTCC26XX_FIFO_SIZE 32

typedef enum UARTCC26XX_FifoThreshold {
    UARTCC26XX_FIFO_THRESHOLD_DEFAULT = 0, 
    UARTCC26XX_FIFO_THRESHOLD_1_8,         
    UARTCC26XX_FIFO_THRESHOLD_2_8,         
    UARTCC26XX_FIFO_THRESHOLD_4_8,         
    UARTCC26XX_FIFO_THRESHOLD_6_8,         
    UARTCC26XX_FIFO_THRESHOLD_7_8          
} UARTCC26XX_FifoThreshold;

/* BACKWARDS COMPATIBILITY */
#define UARTCC26XX_RETURN_PARTIAL_ENABLE    UARTCC26XX_CMD_RETURN_PARTIAL_ENABLE
#define UARTCC26XX_RETURN_PARTIAL_DISABLE   UARTCC26XX_CMD_RETURN_PARTIAL_DISABLE
/* END BACKWARDS COMPATIBILITY */

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

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

typedef struct UARTCC26XX_HWAttrsV2 {
    uint32_t     baseAddr;    
    uint32_t     powerMngrId; 
    int          intNum;      
    uint8_t      intPriority;
    uint32_t                 swiPriority;
    uint8_t                  txPin;        
    uint8_t                  rxPin;        
    uint8_t                  ctsPin;       
    uint8_t                  rtsPin;       
    unsigned char           *ringBufPtr;   
    size_t                   ringBufSize;  
    UARTCC26XX_FifoThreshold txIntFifoThr; 
    UARTCC26XX_FifoThreshold rxIntFifoThr; 
    UARTCC26XX_ErrorCallback errorFxn;
} UARTCC26XX_HWAttrsV2;

typedef enum UART_Status {
    UART_TIMED_OUT     = 0x10,                 
    UART_PARITY_ERROR  = UART_RXERROR_PARITY,  
    UART_BRAKE_ERROR   = UART_RXERROR_BREAK,   
    UART_OVERRUN_ERROR = UART_RXERROR_OVERRUN, 
    UART_FRAMING_ERROR = UART_RXERROR_FRAMING, 
    UART_OK            = 0x0                   
} UART_Status;

typedef struct UARTCC26XX_Object {
    /* UART control variables */
    bool                opened;         
    UART_Mode           readMode;       
    UART_Mode           writeMode;      
    unsigned int        readTimeout;    
    unsigned int        writeTimeout;   
    UART_Callback       readCallback;   
    UART_Callback       writeCallback;  
    UART_ReturnMode     readReturnMode; 
    UART_DataMode       readDataMode;   
    UART_DataMode       writeDataMode;  
    uint32_t            baudRate;
    UART_LEN            dataLength;     
    UART_STOP           stopBits;       
    UART_PAR            parityType;     
    UART_Status         status;         
    /* UART write variables */
    const void         *writeBuf;       
    size_t              writeCount;     
    size_t              writeSize;      
    bool                writeCR;        
    /* UART receive variables */
    bool                  readRetPartial;     
    void                  *readBuf;           
    size_t                readCount;          
    size_t                readSize;           
    RingBuf_Object        ringBuffer;         
    /* PIN driver state object and handle */
    PIN_State              pinState;
    PIN_Handle             hPin;

    void             *uartPostFxn;
    Power_NotifyObj  uartPostObj;

    /* UART SYS/BIOS objects */
    HwiP_Struct hwi; 
    SwiP_Struct           swi;                
    SemaphoreP_Struct     writeSem;           
    SemaphoreP_Struct     readSem;            
    ClockP_Struct         txFifoEmptyClk;     
    bool uartRxPowerConstraint;
    bool uartTxPowerConstraint;
} UARTCC26XX_Object, *UARTCC26XX_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart_UARTCC26XX__include */