uart_sci.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 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_SCI_H_
#define UART_SCI_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <kernel/dpl/HwiP.h>
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_uart.h>
#include <drivers/hw_include/hw_types.h>
#include <drivers/edma.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
typedef void *UART_Handle;
 
#define UART_TRANSFER_STATUS_SUCCESS         (0U)
 
#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_TRANSFER_MODE_BLOCKING     (0U)
 
#define UART_TRANSFER_MODE_CALLBACK     (1U)
 
#define UART_LEN_1                      (0U)
#define UART_LEN_2                      (1U)
#define UART_LEN_3                      (2U)
#define UART_LEN_4                      (3U)
#define UART_LEN_5                      (4U)
#define UART_LEN_6                      (5U)
#define UART_LEN_7                      (6U)
#define UART_LEN_8                      (7U)
 
#define UART_STOPBITS_1                 (0U)
#define UART_STOPBITS_2                 (1U)
 
#define UART_PARITY_NONE                (0x00U)
#define UART_PARITY_ODD                 (0x01U)
#define UART_PARITY_EVEN                (0x03U)
 
#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)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct
{
    void                   *buf;
    uint32_t                count;
    uint32_t                timeout;
    uint32_t                status;
    void                   *args;
} UART_Transaction;
 
typedef void (*UART_CallbackFxn) (UART_Handle handle,
                                  UART_Transaction *transaction);
 
typedef struct
{
    uint32_t                baudRate;
    uint32_t                dataLength;
    uint32_t                stopBits;
    uint32_t                parityType;
    uint32_t                readMode;
    uint32_t                writeMode;
    UART_CallbackFxn        readCallbackFxn;
    UART_CallbackFxn        writeCallbackFxn;
    /*
     * Driver configuration
     */
    uint32_t                transferMode;
    uint32_t                intrNum;
    uint8_t                 intrPriority;
    uint32_t                edmaInst;
    uint32_t                rxEvtNum;
    uint32_t                txEvtNum;
} UART_Params;
 
typedef struct
{
    /*
     * SOC configuration
     */
    uint32_t                baseAddr;
    uint32_t                inputClkFreq;
} UART_Attrs;
 
typedef struct
{
    uint32_t edmaTcc;
    uint32_t edmaChId;
    uint32_t edmaParam;
    uint32_t edmaRegionId;
    uint32_t edmaBaseAddr;
    uint32_t isIntEnabled;
    Edma_IntrObject edmaIntrObj;
} UART_EdmaParams;
 
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct
{
    /*
     * User parameters
     */
    UART_Handle             handle;
    UART_Params             prms;
    /*
     * 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;
    /*
     * State variables
     */
    uint32_t                isOpen;
    void                   *lock;
    SemaphoreP_Object       lockObj;
    void                   *readTransferSem;
    SemaphoreP_Object       readTransferSemObj;
    void                   *writeTransferSem;
    SemaphoreP_Object       writeTransferSemObj;
    void                   *hwiHandle;
    HwiP_Object             hwiObj;
    UART_EdmaParams         rxEdmaParams;
    UART_EdmaParams         txEdmaParams;
    EDMA_Handle             uartEdmaHandle;
 
    CSL_sciRegs            *pSCIRegs;
    uint8_t                 shiftJustification;
} UART_Object;
 
typedef struct
{
    UART_Attrs       *attrs;
    UART_Object      *object;
} UART_Config;
 
extern UART_Config gUartConfig[];
extern uint32_t    gUartConfigNum;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void UART_init(void);
 
void UART_deinit(void);
 
UART_Handle UART_open(uint32_t index, const UART_Params *prms);
 
void UART_close(UART_Handle handle);
 
int32_t UART_write(UART_Handle handle, UART_Transaction *trans);
 
int32_t UART_read(UART_Handle handle, UART_Transaction *trans);
 
int32_t UART_writeCancel(UART_Handle handle, UART_Transaction *trans);
 
int32_t UART_readCancel(UART_Handle handle, UART_Transaction *trans);
 
UART_Handle UART_getHandle(uint32_t index);
 
void UART_flushTxFifo(UART_Handle handle);
 
static inline void UART_Params_init(UART_Params *prms);
 
static inline void UART_Transaction_init(UART_Transaction *trans);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline void UART_Params_init(UART_Params *prms)
{
    if(prms != NULL)
    {
        prms->baudRate           = 115200U;
        prms->dataLength         = UART_LEN_8;
        prms->stopBits           = UART_STOPBITS_1;
        prms->parityType         = UART_PARITY_NONE;
        prms->readMode           = UART_TRANSFER_MODE_BLOCKING;
        prms->writeMode          = UART_TRANSFER_MODE_BLOCKING;
        prms->readCallbackFxn    = NULL;
        prms->writeCallbackFxn   = NULL;
        prms->transferMode       = UART_CONFIG_MODE_INTERRUPT;
        prms->intrNum            = 210U;
        prms->intrPriority       = 4U;
    }
}
 
static inline void UART_Transaction_init(UART_Transaction *trans)
{
    if(trans != NULL)
    {
        trans->buf              = NULL;
        trans->count            = 0U;
        trans->timeout          = SystemP_WAIT_FOREVER;
        trans->status           = UART_TRANSFER_STATUS_SUCCESS;
        trans->args             = NULL;
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef UART_SCI_H_ */