UART2CC26X2.h

Go to the documentation of this file.

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

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

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

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(inc/hw_types.h)
#include DeviceFamily_constructPath(driverlib/udma.h)

#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/UART2.h>
#include <ti/drivers/pin/PINCC26XX.h>
#include <ti/drivers/dma/UDMACC26XX.h>

#ifdef __cplusplus
extern "C" {
#endif

#define UART2CC26X2_FLOWCTRL_NONE 0

#define UART2CC26X2_FLOWCTRL_HARDWARE 1

#define UART2CC26X2_FIFO_SIZE 32

typedef enum UART2CC26X2_FifoThreshold {
    UART2CC26X2_FIFO_THRESHOLD_1_8 = 0,     
    UART2CC26X2_FIFO_THRESHOLD_2_8 = 1,     
    UART2CC26X2_FIFO_THRESHOLD_4_8 = 2,     
    UART2CC26X2_FIFO_THRESHOLD_6_8 = 3,     
    UART2CC26X2_FIFO_THRESHOLD_7_8 = 4      
} UART2CC26X2_FifoThreshold;

/* UART2CC26X2 functions */
extern void UART2CC26X2_close(UART2_Handle handle);
extern void UART2CC26X2_disableRx(UART2_Handle handle);
extern UART2_Handle UART2CC26X2_open(uint_least8_t, UART2_Params *params);
extern int_fast16_t UART2CC26X2_read(UART2_Handle handle, void *buffer, size_t size,
        size_t *bytesRead);
extern void UART2CC26X2_readCancel(UART2_Handle handle);
extern int_fast16_t UART2CC26X2_write(UART2_Handle handle, const void *buffer,
                            size_t size, size_t *bytesWritten);
extern void UART2CC26X2_writeCancel(UART2_Handle handle);
extern void UART2CC26X2_flushRx(UART2_Handle handle);
extern void UART2CC26X2_getParams(UART2_Handle handle, UART2_Params *params);
extern void UART2CC26X2_setParams(UART2_Handle handle, UART2_Params *params);

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

typedef struct UART2CC26X2_HWAttrs {
    uint32_t        baseAddr;
    int             intNum;
    uint8_t         intPriority;
    uint32_t        flowControl;
    uint8_t         rxPin;
    uint8_t         txPin;
    uint8_t         ctsPin;
    uint8_t         rtsPin;
    uint32_t        rxChannelMask;
    uint32_t        txChannelMask;
    UART2CC26X2_FifoThreshold txIntFifoThr;
    UART2CC26X2_FifoThreshold rxIntFifoThr;
} UART2CC26X2_HWAttrs;

typedef struct UART2CC26X2_Object {
    /* 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) */
        /* Flag to indicate ongoing transmit */
        bool             txEnabled:1;
    } state;

    HwiP_Struct          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 */
    UDMACC26XX_Handle    udmaHandle;       /* For setting power dependency */
    volatile tDMAControlTable    *rxDmaEntry;
    volatile tDMAControlTable    *txDmaEntry;

    /* 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_Struct    readSem;          /* UART read semaphore */
    unsigned int         readTimeout;      /* Timeout for 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_Struct    writeSem;         /* UART write semaphore*/
    unsigned int         writeTimeout;     /* Timeout for write semaphore */
    UART2_Callback       writeCallback;    /* Pointer to write callback */

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

    /* For Power management */
    Power_NotifyObj      postNotify;
    unsigned int         powerMgrId;       /* Determined from base address */
} UART2CC26X2_Object, *UART2CC26X2_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_uart2_UART2CC26X2__include */