UART2CC32XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_uart2_UART2CC32XX__include
#define ti_drivers_uart2_UART2CC32XX__include

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

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

#ifdef __cplusplus
extern "C" {
#endif

#define UART2CC32XX_PIN_UNASSIGNED   0xFFF

#define UART2CC32XX_DMACH_UNASSIGNED 0xFF

/*
 *  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, UART2CC32XX_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 UART2CC32XX_PIN_01_UART1_TX  0x700 
#define UART2CC32XX_PIN_02_UART1_RX  0x701 
#define UART2CC32XX_PIN_03_UART0_TX  0x702 
#define UART2CC32XX_PIN_04_UART0_RX  0x703 
#define UART2CC32XX_PIN_07_UART1_TX  0x506 
#define UART2CC32XX_PIN_08_UART1_RX  0x507 
#define UART2CC32XX_PIN_16_UART1_TX  0x20F 
#define UART2CC32XX_PIN_17_UART1_RX  0x210 
#define UART2CC32XX_PIN_45_UART0_RX  0x92C 
#define UART2CC32XX_PIN_45_UART1_RX  0x22C 
#define UART2CC32XX_PIN_53_UART0_TX  0x934 
#define UART2CC32XX_PIN_55_UART0_TX  0x336 
#define UART2CC32XX_PIN_55_UART1_TX  0x636 
#define UART2CC32XX_PIN_57_UART0_RX  0x338 
#define UART2CC32XX_PIN_57_UART1_RX  0x638 
#define UART2CC32XX_PIN_58_UART1_TX  0x639 
#define UART2CC32XX_PIN_59_UART1_RX  0x63A 
#define UART2CC32XX_PIN_62_UART0_TX  0xB3D 
/*
 *  Flow control pins.
 */
#define UART2CC32XX_PIN_50_UART0_CTS  0xC31 
#define UART2CC32XX_PIN_50_UART0_RTS  0x331 
#define UART2CC32XX_PIN_50_UART1_RTS  0xA31 
#define UART2CC32XX_PIN_52_UART0_RTS  0x633 
#define UART2CC32XX_PIN_61_UART0_RTS  0x53C 
#define UART2CC32XX_PIN_61_UART0_CTS  0x63C 
#define UART2CC32XX_PIN_61_UART1_CTS  0x33C 
#define UART2CC32XX_PIN_62_UART0_RTS  0xA3D 
#define UART2CC32XX_PIN_62_UART1_RTS  0x33D 
#define UART2CC32XX_FLOWCTRL_NONE 0

#define UART2CC32XX_FLOWCTRL_HARDWARE 1

typedef enum {
    UART2CC32XX_FIFO_THRESHOLD_1_8 = 0,     
    UART2CC32XX_FIFO_THRESHOLD_2_8 = 1,     
    UART2CC32XX_FIFO_THRESHOLD_4_8 = 2,     
    UART2CC32XX_FIFO_THRESHOLD_6_8 = 3,     
    UART2CC32XX_FIFO_THRESHOLD_7_8 = 4      
} UART2CC32XX_FifoThreshold;

/* UART2CC32XX functions */
extern void UART2CC32XX_close(UART2_Handle handle);
extern UART2_Handle UART2CC32XX_open(uint_least8_t, UART2_Params *params);
extern int_fast16_t UART2CC32XX_read(UART2_Handle handle, void *buffer,
        size_t size, size_t *bytesRead, uint32_t timeout);
extern void UART2CC32XX_readCancel(UART2_Handle handle);
extern int_fast16_t UART2CC32XX_write(UART2_Handle handle,
        const void *buffer, size_t size, size_t *bytesWritten,
        uint32_t timeout);
extern void UART2CC32XX_writeCancel(UART2_Handle handle);
extern void UART2CC32XX_flushRx(UART2_Handle handle);

/* UART2 function table pointer */
extern const UART2_FxnTable UART2CC32XX_fxnTable;

typedef struct {
    uint32_t        baseAddr;
    int             intNum;
    uint8_t         intPriority;
    uint32_t        flowControl;
    uint32_t         rxPin;
    uint32_t         txPin;
    uint32_t         ctsPin;
    uint32_t         rtsPin;
    UART2CC32XX_FifoThreshold txIntFifoThr;
    UART2CC32XX_FifoThreshold rxIntFifoThr;
    uint32_t  rxDmaChannel;
    uint32_t  txDmaChannel;
} UART2CC32XX_HWAttrs;

typedef struct {
    /* UART2 state variable */
    struct {
        bool             opened:1;         /* Has the obj been opened */
        UART2_Mode       readMode;         /* Mode for read calls */
        UART2_Mode       writeMode;        /* Mode for write calls */
        UART2_ReadReturnMode readReturnMode:1; /* RX return mode (partial/full) */
        bool             txEnabled:1;      /* Flag to show ongoing transmit */
    } state;

    HwiP_Handle          hwi;              /* Hwi object for interrupts */
    uint32_t             baudRate;         /* Baud rate for UART */
    UART2_DataLen        dataLength;       /* Data length for UART */
    UART2_StopBits       stopBits;         /* Stop bits for UART */
    UART2_Parity         parityType;       /* Parity bit type for UART */
    int32_t              rxStatus;         /* RX status */
    int32_t              txStatus;         /* TX status */
    void                *userArg;          /* User supplied arg for callbacks */
    UDMACC32XX_Handle    udmaHandle;       /* For setting power dependency */

    /* UART read variables */
    unsigned char       *readBuf;          /* Buffer data pointer */
    size_t               readSize;         /* Number of bytes to read */
    uint32_t             nReadTransfers;   /* Number of DMA transfers needed */
    size_t               readCount;        /* Number of bytes left to read */
    size_t               rxSize;           /* # of bytes to read in DMA xfer */
    size_t               bytesRead;        /* Number of bytes read */
    SemaphoreP_Handle    readSem;          /* UART read semaphore */
    UART2_Callback       readCallback;     /* Pointer to read callback */

    /* UART write variables */
    const unsigned char *writeBuf;         /* Buffer data pointer */
    size_t               writeSize;        /* Number of bytes to write*/
    uint32_t             nWriteTransfers;  /* Number of DMA transfers needed */
    size_t               writeCount;       /* Number of bytes left to write */
    size_t               txSize;           /* # of bytes to write with DMA */
    size_t               bytesWritten;     /* Number of bytes written */
    SemaphoreP_Handle    writeSem;         /* UART write semaphore*/
    UART2_Callback       writeCallback;    /* Pointer to write callback */

    /* For Power management */
    Power_NotifyObj       postNotify;
    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 */
} UART2CC32XX_Object, *UART2CC32XX_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart2_UART2CC32XX__include */