uart_lld.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021-2023 Texas Instruments Incorporated
 *
 * 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 UART_LLD_H_
#define UART_LLD_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_uart.h>
#include <drivers/hw_include/hw_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
typedef void *UART_DmaHandle;
 
typedef void *UART_DmaChConfig;
 
#define UART_FIFO_SIZE                  (64U)
 
#define UART_TRANSMITEMPTY_TRIALCOUNT   (3000U)
 
#define UART_ERROR_COUNT            (0x00FFFFFFU)
 
#define UART_STATUS_SUCCESS                 ((int32_t)0)
 
#define UART_STATUS_FAILURE                 ((int32_t)-1)
 
#define UART_TRANSFER_STATUS_SUCCESS         ((int32_t)0)
 
#define UART_TRANSFER_STATUS_FAILURE         ((int32_t)-1)
 
#define UART_WAIT_FOREVER                   ((int32_t)-1)
 
#define UART_INVALID_PARAM                  ((int32_t)-3)
 
#define UART_TRANSFER_BUSY                  ((int32_t)-4)
 
#define UART_TRANSFER_TIMEOUT               ((int32_t)-2)
 
#define UART_TRANSFER_INVALID_STATE        ((int32_t)-5)
 
#define UART_TRANSFER_STATUS_TIMEOUT         (1U)
 
#define UART_TRANSFER_STATUS_ERROR_BI        (2U)
 
#define UART_TRANSFER_STATUS_ERROR_FE        (3U)
 
#define UART_TRANSFER_STATUS_ERROR_PE        (4U)
 
#define UART_TRANSFER_STATUS_ERROR_OE        (5U)
 
#define UART_TRANSFER_STATUS_CANCELLED       (6U)
 
#define UART_TRANSFER_STATUS_STARTED         (7U)
 
#define UART_TRANSFER_STATUS_READ_TIMEOUT    (8U)
 
#define UART_TRANSFER_STATUS_ERROR_INUSE     (9U)
 
#define UART_TRANSFER_STATUS_ERROR_OTH       (10U)
 
#define UART_READ_RETURN_MODE_FULL        (0U)
 
#define UART_READ_RETURN_MODE_PARTIAL     (1U)
 
#define UART_LEN_5                      (0U)
#define UART_LEN_6                      (1U)
#define UART_LEN_7                      (2U)
#define UART_LEN_8                      (3U)
 
#define UART_STATE_RESET (0U)
#define UART_STATE_READY (1U)
#define UART_STATE_BUSY  (2U)
#define UART_STATE_ERROR (3U)
 
#define UART_NOT_IN_USE(x) (void) 0
 
#define UART_STOPBITS_1                 (0U)
#define UART_STOPBITS_2                 (1U)
#define UART_STOPBITS_1P5               (UART_STOPBITS_1)
 
#define UART_PARITY_NONE                (0x00U)
#define UART_PARITY_ODD                 (0x01U)
#define UART_PARITY_EVEN                (0x03U)
#define UART_PARITY_FORCED0             (0x07U)
#define UART_PARITY_FORCED1             (0x05U)
 
#define UART_FCTYPE_NONE                (0x00U)
#define UART_FCTYPE_HW                  (0x02U)
 
#define UART_FCPARAM_RXNONE             (0x00U)
#define UART_FCPARAM_RXXONXOFF_2        (0x01U)
#define UART_FCPARAM_RXXONXOFF_1        (0x02U)
#define UART_FCPARAM_RXXONXOFF_12       (0x03U)
#define UART_FCPARAM_AUTO_RTS           (0x40U)
 
#define UART_FCPARAM_TXNONE             (0x00U)
#define UART_FCPARAM_TXXONXOFF_2        (0x04U)
#define UART_FCPARAM_TXXONXOFF_1        (0x08U)
#define UART_FCPARAM_TXXONXOFF_12       (0x0CU)
#define UART_FCPARAM_AUTO_CTS           (0x80U)
 
#define UART_RXTRIGLVL_1                (1U)
#define UART_RXTRIGLVL_8                (8U)
#define UART_RXTRIGLVL_16               (16U)
#define UART_RXTRIGLVL_56               (56U)
#define UART_RXTRIGLVL_60               (60U)
 
#define UART_TXTRIGLVL_1                (1U)
#define UART_TXTRIGLVL_8                (8U)
#define UART_TXTRIGLVL_16               (16U)
#define UART_TXTRIGLVL_32               (32U)
#define UART_TXTRIGLVL_56               (56U)
 
#define UART_OPER_MODE_16X              (0U)
#define UART_OPER_MODE_SIR              (1U)
#define UART_OPER_MODE_16X_AUTO_BAUD    (2U)
#define UART_OPER_MODE_13X              (3U)
#define UART_OPER_MODE_MIR              (4U)
#define UART_OPER_MODE_FIR              (5U)
#define UART_OPER_MODE_CIR              (6U)
#define UART_OPER_MODE_DISABLED         (7U)
 
#define UART_TX_FIFO_NOT_FULL               ( \
        UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_0)
#define UART_TX_FIFO_FULL                   ( \
        UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_1)
 
#define UART_INTID_MODEM_STAT               (UART_IIR_IT_TYPE_IT_TYPE_VALUE_0 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)
#define UART_INTID_TX_THRES_REACH           (UART_IIR_IT_TYPE_IT_TYPE_VALUE_1 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)
#define UART_INTID_RX_THRES_REACH           (UART_IIR_IT_TYPE_IT_TYPE_VALUE_2 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)
#define UART_INTID_RX_LINE_STAT_ERROR       (UART_IIR_IT_TYPE_IT_TYPE_VALUE_3 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)
#define UART_INTID_CHAR_TIMEOUT             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_6 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)
#define UART_INTID_XOFF_SPEC_CHAR_DETECT    (UART_IIR_IT_TYPE_IT_TYPE_VALUE_8 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)
#define UART_INTID_MODEM_SIG_STATE_CHANGE   (UART_IIR_IT_TYPE_IT_TYPE_VALUE_10 \
                                             <<                                \
                                             UART_IIR_IT_TYPE_SHIFT)
 
#define UART_INTR_PENDING                   (0U)
#define UART_N0_INTR_PENDING                (1U)
 
#define UART_INTR_CTS                       (UART_IER_CTS_IT_MASK)
#define UART_INTR_RTS                       (UART_IER_RTS_IT_MASK)
#define UART_INTR_XOFF                      (UART_IER_XOFF_IT_MASK)
#define UART_INTR_SLEEPMODE                 (UART_IER_SLEEP_MODE_MASK)
#define UART_INTR_MODEM_STAT                (UART_IER_MODEM_STS_IT_MASK)
#define UART_INTR_LINE_STAT                 (UART_IER_LINE_STS_IT_MASK)
#define UART_INTR_THR                       (UART_IER_THR_IT_MASK)
#define UART_INTR_RHR_CTI                   (UART_IER_RHR_IT_MASK)
 
#define UART_INTR2_RX_EMPTY                 (UART_IER2_EN_RXFIFO_EMPTY_MASK)
#define UART_INTR2_TX_EMPTY                 (UART_IER2_EN_TXFIFO_EMPTY_MASK)
 
#define UART_FIFO_PE_FE_BI_DETECTED         (UART_LSR_RX_FIFO_STS_MASK)
#define UART_BREAK_DETECTED_ERROR           (UART_LSR_RX_BI_MASK)
#define UART_FRAMING_ERROR                  (UART_LSR_RX_FE_MASK)
#define UART_PARITY_ERROR                   (UART_LSR_RX_PE_MASK)
#define UART_OVERRUN_ERROR                  (UART_LSR_RX_OE_MASK)
 
#define UART_REG_CONFIG_MODE_A          ((uint32_t) 0x0080)
#define UART_REG_CONFIG_MODE_B          ((uint32_t) 0x00BF)
#define UART_REG_OPERATIONAL_MODE       ((uint32_t) 0x007F)
 
#define UART_CONFIG_MODE_POLLED       (0x00U)
#define UART_CONFIG_MODE_INTERRUPT    (0x01U)
#define UART_CONFIG_MODE_USER_INTR    (0x02U)
#define UART_CONFIG_MODE_DMA          (0x03U)
 
#define UART_STATE_RX_DISABLED        (0x0U)
#define UART_STATE_RX_ENABLED         (0x1U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
typedef struct UART_ExtendedParams_s
{
     void                   *args;
} UART_ExtendedParams;
 
typedef struct
{
    void                   *buf;
    uint32_t                count;
    uint32_t                timeout;
    uint32_t                status;
    void                   *args;
} UART_Transaction;
 
typedef uint32_t (*UART_clockGet) (void);
typedef uint32_t (*UART_clockUsecToTick) (uint64_t usecs);
 
typedef void (*UART_readCompCallbackFxn) (void *hUart);
 
typedef void (*UART_writeCompCallbackFxn) (void *hUart);
 
typedef void (*UART_errorCallbackFxn) (void *hUart);
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
typedef struct
{
    /*
     * SOC configuration
     */
    uint32_t                inputClkFreq;
    uint32_t                baudRate;
    uint32_t                dataLength;
    uint32_t                stopBits;
    uint32_t                parityType;
    uint32_t                readReturnMode;
    uint32_t                hwFlowControl;
    uint32_t                hwFlowControlThr;
    /*
     * Driver configuration
     */
    uint32_t                transferMode;
    uint32_t                intrNum;
    uint8_t                 intrPriority;
    /*
     * UART configuration
     */
    uint32_t                operMode;
    uint32_t                readMode;
    uint32_t                writeMode;
    uint32_t                rxTrigLvl;
    uint32_t                txTrigLvl;
    uint32_t                rxEvtNum;
    uint32_t                txEvtNum;
    UART_DmaHandle         uartDmaHandle;
    UART_DmaChConfig       dmaChCfg;
    uint32_t               timeGuardVal;
    /* timeguard feature by UART*/
    UART_clockGet          clockP_get;
    /* ClockP_get  API */
    UART_clockUsecToTick           clockP_usecToTick;
    /* clock usec to tick */
    UART_readCompCallbackFxn        readCompleteCallbackFxn;
    UART_writeCompCallbackFxn       writeCompleteCallbackFxn;
    UART_errorCallbackFxn           errorCallbackFxn;
} UARTLLD_InitObject, *UARTLLD_InitHandle;
 
typedef struct
{
    uint32_t                baseAddr;
    UARTLLD_InitHandle        hUartInit;
    /*
     * UART write variables
     */
    const void             *writeBuf;
    uint32_t                writeCount;
    uint32_t                writeSizeRemaining;
    /*
     * UART receive variables
     */
    void                   *readBuf;
    uint32_t                readCount;
    uint32_t                readSizeRemaining;
    uint32_t                rxTimeoutCnt;
    uint32_t                readErrorCnt;
    /*
     * UART ransaction status variables
     */
    UART_Transaction        readTrans;
    UART_Transaction        writeTrans;
    uint32_t                currIntMask;
 
    /*
     * State variables
     */
    uint32_t                state;
    void                *readTransferMutex;
    void                *writeTransferMutex;
    void*                   args;
    uint64_t                lineStatusTimeout;
} UARTLLD_Object, *UARTLLD_Handle;
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
uint32_t UART_operatingModeSelect(uint32_t baseAddr, uint32_t modeFlag);
uint32_t UART_spaceAvail(uint32_t baseAddr);
uint32_t UART_IsTxRxFifoEmpty(uint32_t baseAddr);
int32_t UART_writeCancelNoCB(UARTLLD_Handle hUart);
int32_t UART_readCancelNoCB(UARTLLD_Handle hUart);
 
/* ========================================================================== */
/*                       Advanced Function Declarations                       */
/* ========================================================================== */
 
uint32_t UART_getBaseAddr_lld(UARTLLD_Handle handle);
 
void UART_enableLoopbackMode(uint32_t baseAddr);
 
void UART_disableLoopbackMode(uint32_t baseAddr);
 
int32_t UART_lld_init(UARTLLD_Handle hUart);
 
int32_t UART_lld_initDma(UARTLLD_Handle hUart);
 
int32_t UART_lld_deInit(UARTLLD_Handle hUart);
 
int32_t UART_lld_deInitDma(UARTLLD_Handle hUart);
 
int32_t UART_lld_write(UARTLLD_Handle hUart, void * txBuf, uint32_t size, uint32_t timeout,
                       const UART_ExtendedParams *extendedParams);
 
int32_t UART_lld_writeIntr(UARTLLD_Handle hUart, void * txBuf, uint32_t size,
                           const UART_ExtendedParams *extendedParams);
 
int32_t UART_lld_writeDma(UARTLLD_Handle hUart, void * txBuf, uint32_t size,
                          const UART_ExtendedParams *extendedParams);
 
int32_t UART_lld_read(UARTLLD_Handle hUart, void * rxBuf, uint32_t size, uint32_t timeout,
                      const UART_ExtendedParams *extendedParams);
 
int32_t UART_lld_readIntr(UARTLLD_Handle hUart, void * rxBuf, uint32_t size,
                         const UART_ExtendedParams *extendedParams);
 
int32_t UART_lld_readDma(UARTLLD_Handle hUart, void * rxBuf, uint32_t size,
                        const UART_ExtendedParams *extendedParams);
 
int32_t UART_lld_writeCancel(UARTLLD_Handle hUart, UART_Transaction *trans);
 
int32_t UART_lld_readCancel(UARTLLD_Handle hUart, UART_Transaction *trans);
 
int32_t UART_lld_flushTxFifo(UARTLLD_Handle hUart);
 
int32_t UART_procLineStatusErr(UARTLLD_Handle hUart);
 
int32_t UART_lld_setRxState(UARTLLD_Handle hUart, uint32_t state);
 
void UART_lld_controllerIsr(void* args);
 
void UART_intrDisable(uint32_t baseAddr, uint32_t intrFlag);
 
void UART_intr2Disable(uint32_t baseAddr, uint32_t intrFlag);
 
uint32_t UART_checkCharsAvailInFifo(uint32_t baseAddr);
 
uint32_t UART_readLineStatus(uint32_t baseAddr);
 
uint8_t UART_getCharFifo(uint32_t baseAddr, uint8_t *readBuf);
 
void UART_putChar(uint32_t baseAddr, uint8_t byteTx);
 
void UART_intrEnable(uint32_t baseAddr, uint32_t intrFlag);
 
uint32_t UART_getChar(uint32_t baseAddr, uint8_t *pChar);
 
uint32_t UART_getIntr2Status(uint32_t baseAddr);
 
uint32_t UART_getIntrIdentityStatus(uint32_t baseAddr);
 
void UART_intr2Enable(uint32_t baseAddr, uint32_t intrFlag);
 
void UART_lld_Transaction_init(UART_Transaction *trans);
 
void UART_lld_Transaction_deInit(UART_Transaction *trans);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef UART_V0_LLD_H_ */