Introduction

This module contains APIs to program and use the UART.

Sub Modules
	APIs for UART DMA mode

Files
file	uart/v0/uart.h
	This file contains the prototype of UART driver APIs.

Data Structures
struct	UART_Transaction
	Data structure used with UART_read() and UART_write() More...

struct	UART_Params
	UART Parameters. More...

struct	UART_Attrs
	UART instance attributes - used during init time. More...

struct	UART_Object
	UART driver object. More...

struct	UART_Config
	UART global configuration array. More...

Functions
void	UART_init (void)
	This function initializes the UART module. More...

void	UART_deinit (void)
	This function de-initializes the UART module. More...

UART_Handle	UART_open (uint32_t index, const UART_Params *prms)
	This function opens a given UART peripheral. More...

void	UART_close (UART_Handle handle)
	Function to close a UART peripheral specified by the UART handle. More...

int32_t	UART_write (UART_Handle handle, UART_Transaction *trans)
	Function to perform UART write operation. More...

int32_t	UART_read (UART_Handle handle, UART_Transaction *trans)
	Function to perform UART read operation. More...

int32_t	UART_writeCancel (UART_Handle handle, UART_Transaction *trans)
	Function to perform UART canceling of current write transaction. More...

int32_t	UART_readCancel (UART_Handle handle, UART_Transaction *trans)
	Function to perform UART canceling of current read transaction. More...

UART_Handle	UART_getHandle (uint32_t index)
	Function to return a open'ed UART handle given a UART instance index. More...

void	UART_flushTxFifo (UART_Handle handle)
	Function to flush a TX FIFO of peripheral specified by the UART handle. More...

static void	UART_Params_init (UART_Params *prms)
	Function to initialize the UART_Params struct to its defaults. More...

static void	UART_Transaction_init (UART_Transaction *trans)
	Function to initialize the UART_Transaction struct to its defaults. More...

uint32_t	UART_getBaseAddr (UART_Handle handle)
	Function to get base address of UART instance of a particular handle. More...

void	UART_enableLoopbackMode (uint32_t baseAddr)
	Function to enable loopback mode. This function is for internal use. Not recommended for customers to use. More...

void	UART_disableLoopbackMode (uint32_t baseAddr)
	Function to disable loopback mode. This function is for internal use. Not recommended for customers to use. More...

static void	UART_putChar (uint32_t baseAddr, uint8_t byteTx)
	This API writes a byte to the Transmitter FIFO without checking for the emptiness of the Transmitter FIFO or the Transmitter Shift Register(TSR). More...

static uint32_t	UART_getChar (uint32_t baseAddr, uint8_t *pChar)
	This API reads a byte from the Receiver Buffer Register (RBR). It checks once if any character is ready to be read. More...

static void	UART_intrEnable (uint32_t baseAddr, uint32_t intrFlag)
	This API enables the specified interrupts in the UART mode of operation. More...

static void	UART_intrDisable (uint32_t baseAddr, uint32_t intrFlag)
	This API disables the specified interrupts in the UART mode of operation. More...

static void	UART_intr2Enable (uint32_t baseAddr, uint32_t intrFlag)
	This API enables the specified interrupts in the UART mode of operation for IER2. More...

static void	UART_intr2Disable (uint32_t baseAddr, uint32_t intrFlag)
	This API disables the specified interrupts in the UART mode of operation for IER2. More...

static uint32_t	UART_getIntrIdentityStatus (uint32_t baseAddr)
	This API determines the UART Interrupt Status. More...

static uint32_t	UART_getIntr2Status (uint32_t baseAddr)
	This API determines the UART Interrupt Status 2. More...

static uint32_t	UART_checkCharsAvailInFifo (uint32_t baseAddr)
	This API checks if the RX FIFO (or RHR in non-FIFO mode) has atleast one byte of data to be read. More...

static uint32_t	UART_readLineStatus (uint32_t baseAddr)
	This API reads the line status register value. More...

static uint8_t	UART_getCharFifo (uint32_t baseAddr, uint8_t *readBuf)
	This API reads the data present at the top of the RX FIFO, that is, the data in the Receive Holding Register(RHR). However before reading the data from RHR, it checks for RX error. More...

Typedefs
typedef void *	UART_Handle
	A handle that is returned from a UART_open() call. More...

typedef void(*	UART_CallbackFxn) (UART_Handle handle, UART_Transaction *transaction)
	The definition of a callback function used by the UART driver when used in UART_TRANSFER_MODE_CALLBACK. More...

Macros
#define	UART_FIFO_SIZE (64U)
	Uart FIFO Size. More...

#define	UART_TRANSMITEMPTY_TRIALCOUNT (3000U)
	Timeout in ms used for TX FIFO empty at the time of delete. Three seconds is more than sufficient to transfer 64 bytes (FIFO size) at the lowest baud rate of 2400. More...

#define	UART_ERROR_COUNT (0x00FFFFFFU)
	Count Value to check error in the recieved byte More...

Transfer Status Code
Status codes that are set by the UART driver
#define	UART_TRANSFER_STATUS_SUCCESS (0U)
	Transaction success. More...

#define	UART_TRANSFER_STATUS_TIMEOUT (1U)
	Time out error. More...

#define	UART_TRANSFER_STATUS_ERROR_BI (2U)
	Break condition error. More...

#define	UART_TRANSFER_STATUS_ERROR_FE (3U)
	Framing error. More...

#define	UART_TRANSFER_STATUS_ERROR_PE (4U)
	Parity error. More...

#define	UART_TRANSFER_STATUS_ERROR_OE (5U)
	Overrun error. More...

#define	UART_TRANSFER_STATUS_CANCELLED (6U)
	Cancelled. More...

#define	UART_TRANSFER_STATUS_STARTED (7U)
	Transaction started. More...

#define	UART_TRANSFER_STATUS_READ_TIMEOUT (8U)
	Read timeout error. More...

#define	UART_TRANSFER_STATUS_ERROR_INUSE (9U)
	UART is currently in use. More...

#define	UART_TRANSFER_STATUS_ERROR_OTH (10U)
	Other errors. More...

Transfer Mode
This determines whether the driver operates synchronously or asynchronously In UART_TRANSFER_MODE_BLOCKING mode UART_read() and UART_write() blocks code execution until the transaction has completed In UART_TRANSFER_MODE_CALLBACK UART_read() and UART_write() does not block code execution and instead calls a UART_CallbackFxn callback function when the transaction has completed
#define	UART_TRANSFER_MODE_BLOCKING (0U)
	UART read/write APIs blocks execution. This mode can only be used when called within a Task context. More...

#define	UART_TRANSFER_MODE_CALLBACK (1U)
	UART read/write APIs does not block code execution and will call a UART_CallbackFxn. This mode can be used in a Task, Swi, or Hwi context. More...

UART Read length
This enumeration defines the return modes for UART_read(). UART_READ_RETURN_MODE_FULL unblocks or performs a callback when the read buffer has been filled with the number of bytes passed to UART_read(). UART_READ_RETURN_MODE_PARTIAL unblocks or performs a callback whenever a read timeout error occurs on the UART peripheral. The read timeout occurs if the read FIFO is non-empty and no new data has been received for a specific device/baudrate dependent number of clock cycles. This mode can be used when the exact number of bytes to be read is not known.
#define	UART_READ_RETURN_MODE_FULL (0U)
	Unblock/callback when buffer is full. More...

#define	UART_READ_RETURN_MODE_PARTIAL (1U)
	Unblock/callback when no new data comes in. More...

UART data length
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#define	UART_LEN_5 (0U)

#define	UART_LEN_6 (1U)

#define	UART_LEN_7 (2U)

#define	UART_LEN_8 (3U)

UART stop bits
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#define	UART_STOPBITS_1 (0U)

#define	UART_STOPBITS_2 (1U)

UART Parity
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#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)

UART Flow Control Type
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#define	UART_FCTYPE_NONE (0x00U)

#define	UART_FCTYPE_HW (0x02U)

UART Flow Control Params for RX
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#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)

UART Flow Control Params for TX
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#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)

UART RX trigger level
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#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)

UART TX trigger level
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#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)

UART Operational Mode
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#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)

Values indicating the filled status of TX FIFO
Note: The values should not be changed since it represents the actual register configuration values used to configure the UART
#define	UART_TX_FIFO_NOT_FULL

#define	UART_TX_FIFO_FULL

Values related to status of Interrupt souces.

#define	UART_INTID_MODEM_STAT
	Values pertaining to status of UART Interrupt sources. More...

#define	UART_INTID_TX_THRES_REACH

#define	UART_INTID_RX_THRES_REACH

#define	UART_INTID_RX_LINE_STAT_ERROR

#define	UART_INTID_CHAR_TIMEOUT

#define	UART_INTID_XOFF_SPEC_CHAR_DETECT

#define	UART_INTID_MODEM_SIG_STATE_CHANGE

#define	UART_INTR_PENDING (0U)
	Values indicating the UART Interrupt pending status. More...

#define	UART_N0_INTR_PENDING (1U)

Values related to enabling/disabling of Interrupts.
#define	UART_INTR_CTS (UART_IER_CTS_IT_MASK)
	Values for enabling/disabling the interrupts of UART. More...

#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)

Values related to Line Status information.
#define	UART_FIFO_PE_FE_BI_DETECTED (UART_LSR_RX_FIFO_STS_MASK)
	Values pertaining to UART Line Status information. More...

#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)

Values related to Register Mode Configuration.
#define	UART_REG_CONFIG_MODE_A ((uint32_t) 0x0080)
	Values to be used while switching between register configuration modes. More...

#define	UART_REG_CONFIG_MODE_B ((uint32_t) 0x00BF)

#define	UART_REG_OPERATIONAL_MODE ((uint32_t) 0x007F)

UART Configration Mode
This determines whether the driver configuration mode like Polled, Interrupt, Dma used for the transfer function
#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)

Macro Definition Documentation

◆ UART_FIFO_SIZE

#define UART_FIFO_SIZE (64U)

Uart FIFO Size.

◆ UART_TRANSMITEMPTY_TRIALCOUNT

#define UART_TRANSMITEMPTY_TRIALCOUNT (3000U)

Timeout in ms used for TX FIFO empty at the time of delete. Three seconds is more than sufficient to transfer 64 bytes (FIFO size) at the lowest baud rate of 2400.

◆ UART_ERROR_COUNT

#define UART_ERROR_COUNT (0x00FFFFFFU)

Count Value to check error in the recieved byte

◆ UART_TRANSFER_STATUS_SUCCESS

#define UART_TRANSFER_STATUS_SUCCESS (0U)

Transaction success.

◆ UART_TRANSFER_STATUS_TIMEOUT

#define UART_TRANSFER_STATUS_TIMEOUT (1U)

Time out error.

◆ UART_TRANSFER_STATUS_ERROR_BI

#define UART_TRANSFER_STATUS_ERROR_BI (2U)

Break condition error.

◆ UART_TRANSFER_STATUS_ERROR_FE

#define UART_TRANSFER_STATUS_ERROR_FE (3U)

Framing error.

◆ UART_TRANSFER_STATUS_ERROR_PE

#define UART_TRANSFER_STATUS_ERROR_PE (4U)

Parity error.

◆ UART_TRANSFER_STATUS_ERROR_OE

#define UART_TRANSFER_STATUS_ERROR_OE (5U)

Overrun error.

◆ UART_TRANSFER_STATUS_CANCELLED

#define UART_TRANSFER_STATUS_CANCELLED (6U)

Cancelled.

◆ UART_TRANSFER_STATUS_STARTED

#define UART_TRANSFER_STATUS_STARTED (7U)

Transaction started.

◆ UART_TRANSFER_STATUS_READ_TIMEOUT

#define UART_TRANSFER_STATUS_READ_TIMEOUT (8U)

Read timeout error.

◆ UART_TRANSFER_STATUS_ERROR_INUSE

#define UART_TRANSFER_STATUS_ERROR_INUSE (9U)

UART is currently in use.

◆ UART_TRANSFER_STATUS_ERROR_OTH

#define UART_TRANSFER_STATUS_ERROR_OTH (10U)

Other errors.

◆ UART_TRANSFER_MODE_BLOCKING

#define UART_TRANSFER_MODE_BLOCKING (0U)

UART read/write APIs blocks execution. This mode can only be used when called within a Task context.

◆ UART_TRANSFER_MODE_CALLBACK

#define UART_TRANSFER_MODE_CALLBACK (1U)

UART read/write APIs does not block code execution and will call a UART_CallbackFxn. This mode can be used in a Task, Swi, or Hwi context.

◆ UART_READ_RETURN_MODE_FULL

#define UART_READ_RETURN_MODE_FULL (0U)

Unblock/callback when buffer is full.

◆ UART_READ_RETURN_MODE_PARTIAL

#define UART_READ_RETURN_MODE_PARTIAL (1U)

Unblock/callback when no new data comes in.

◆ UART_LEN_5

#define UART_LEN_5 (0U)

◆ UART_LEN_6

#define UART_LEN_6 (1U)

◆ UART_LEN_7

#define UART_LEN_7 (2U)

◆ UART_LEN_8

#define UART_LEN_8 (3U)

◆ UART_STOPBITS_1

#define UART_STOPBITS_1 (0U)

◆ UART_STOPBITS_2

#define UART_STOPBITS_2 (1U)

◆ UART_PARITY_NONE

#define UART_PARITY_NONE (0x00U)

◆ UART_PARITY_ODD

#define UART_PARITY_ODD (0x01U)

◆ UART_PARITY_EVEN

#define UART_PARITY_EVEN (0x03U)

◆ UART_PARITY_FORCED0

#define UART_PARITY_FORCED0 (0x07U)

◆ UART_PARITY_FORCED1

#define UART_PARITY_FORCED1 (0x05U)

◆ UART_FCTYPE_NONE

#define UART_FCTYPE_NONE (0x00U)

◆ UART_FCTYPE_HW

#define UART_FCTYPE_HW (0x02U)

◆ UART_FCPARAM_RXNONE

#define UART_FCPARAM_RXNONE (0x00U)

◆ UART_FCPARAM_RXXONXOFF_2

#define UART_FCPARAM_RXXONXOFF_2 (0x01U)

◆ UART_FCPARAM_RXXONXOFF_1

#define UART_FCPARAM_RXXONXOFF_1 (0x02U)

◆ UART_FCPARAM_RXXONXOFF_12

#define UART_FCPARAM_RXXONXOFF_12 (0x03U)

◆ UART_FCPARAM_AUTO_RTS

#define UART_FCPARAM_AUTO_RTS (0x40U)

◆ UART_FCPARAM_TXNONE

#define UART_FCPARAM_TXNONE (0x00U)

◆ UART_FCPARAM_TXXONXOFF_2

#define UART_FCPARAM_TXXONXOFF_2 (0x04U)

◆ UART_FCPARAM_TXXONXOFF_1

#define UART_FCPARAM_TXXONXOFF_1 (0x08U)

◆ UART_FCPARAM_TXXONXOFF_12

#define UART_FCPARAM_TXXONXOFF_12 (0x0CU)

◆ UART_FCPARAM_AUTO_CTS

#define UART_FCPARAM_AUTO_CTS (0x80U)

◆ UART_RXTRIGLVL_1

#define UART_RXTRIGLVL_1 (1U)

◆ UART_RXTRIGLVL_8

#define UART_RXTRIGLVL_8 (8U)

◆ UART_RXTRIGLVL_16

#define UART_RXTRIGLVL_16 (16U)

◆ UART_RXTRIGLVL_56

#define UART_RXTRIGLVL_56 (56U)

◆ UART_RXTRIGLVL_60

#define UART_RXTRIGLVL_60 (60U)

◆ UART_TXTRIGLVL_1

#define UART_TXTRIGLVL_1 (1U)

◆ UART_TXTRIGLVL_8

#define UART_TXTRIGLVL_8 (8U)

◆ UART_TXTRIGLVL_16

#define UART_TXTRIGLVL_16 (16U)

◆ UART_TXTRIGLVL_32

#define UART_TXTRIGLVL_32 (32U)

◆ UART_TXTRIGLVL_56

#define UART_TXTRIGLVL_56 (56U)

◆ UART_OPER_MODE_16X

#define UART_OPER_MODE_16X (0U)

◆ UART_OPER_MODE_SIR

#define UART_OPER_MODE_SIR (1U)

◆ UART_OPER_MODE_16X_AUTO_BAUD

#define UART_OPER_MODE_16X_AUTO_BAUD (2U)

◆ UART_OPER_MODE_13X

#define UART_OPER_MODE_13X (3U)

◆ UART_OPER_MODE_MIR

#define UART_OPER_MODE_MIR (4U)

◆ UART_OPER_MODE_FIR

#define UART_OPER_MODE_FIR (5U)

◆ UART_OPER_MODE_CIR

#define UART_OPER_MODE_CIR (6U)

◆ UART_OPER_MODE_DISABLED

#define UART_OPER_MODE_DISABLED (7U)

◆ UART_TX_FIFO_NOT_FULL

#define UART_TX_FIFO_NOT_FULL

Value:

( \

UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_0)

◆ UART_TX_FIFO_FULL

#define UART_TX_FIFO_FULL

Value:

( \

UART_SSR_TX_FIFO_FULL_TX_FIFO_FULL_VALUE_1)

◆ UART_INTID_MODEM_STAT

#define UART_INTID_MODEM_STAT

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_0 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)

Values pertaining to status of UART Interrupt sources.

◆ UART_INTID_TX_THRES_REACH

#define UART_INTID_TX_THRES_REACH

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_1 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)

◆ UART_INTID_RX_THRES_REACH

#define UART_INTID_RX_THRES_REACH

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_2 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)

◆ UART_INTID_RX_LINE_STAT_ERROR

#define UART_INTID_RX_LINE_STAT_ERROR

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_3 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)

◆ UART_INTID_CHAR_TIMEOUT

#define UART_INTID_CHAR_TIMEOUT

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_6 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)

◆ UART_INTID_XOFF_SPEC_CHAR_DETECT

#define UART_INTID_XOFF_SPEC_CHAR_DETECT

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_8 \
                                             <<                               \
                                             UART_IIR_IT_TYPE_SHIFT)

◆ UART_INTID_MODEM_SIG_STATE_CHANGE

#define UART_INTID_MODEM_SIG_STATE_CHANGE

Value:

                                             (UART_IIR_IT_TYPE_IT_TYPE_VALUE_10 \
                                             <<                                \
                                             UART_IIR_IT_TYPE_SHIFT)

◆ UART_INTR_PENDING

#define UART_INTR_PENDING (0U)

Values indicating the UART Interrupt pending status.

◆ UART_N0_INTR_PENDING

#define UART_N0_INTR_PENDING (1U)

◆ UART_INTR_CTS

#define UART_INTR_CTS (UART_IER_CTS_IT_MASK)

Values for enabling/disabling the interrupts of UART.

◆ UART_INTR_RTS

#define UART_INTR_RTS (UART_IER_RTS_IT_MASK)

◆ UART_INTR_XOFF

#define UART_INTR_XOFF (UART_IER_XOFF_IT_MASK)

◆ UART_INTR_SLEEPMODE

#define UART_INTR_SLEEPMODE (UART_IER_SLEEP_MODE_MASK)

◆ UART_INTR_MODEM_STAT

#define UART_INTR_MODEM_STAT (UART_IER_MODEM_STS_IT_MASK)

◆ UART_INTR_LINE_STAT

#define UART_INTR_LINE_STAT (UART_IER_LINE_STS_IT_MASK)

◆ UART_INTR_THR

#define UART_INTR_THR (UART_IER_THR_IT_MASK)

◆ UART_INTR_RHR_CTI

#define UART_INTR_RHR_CTI (UART_IER_RHR_IT_MASK)

◆ UART_INTR2_RX_EMPTY

#define UART_INTR2_RX_EMPTY (UART_IER2_EN_RXFIFO_EMPTY_MASK)

◆ UART_INTR2_TX_EMPTY

#define UART_INTR2_TX_EMPTY (UART_IER2_EN_TXFIFO_EMPTY_MASK)

◆ UART_FIFO_PE_FE_BI_DETECTED

#define UART_FIFO_PE_FE_BI_DETECTED (UART_LSR_RX_FIFO_STS_MASK)

Values pertaining to UART Line Status information.

◆ UART_BREAK_DETECTED_ERROR

#define UART_BREAK_DETECTED_ERROR (UART_LSR_RX_BI_MASK)

◆ UART_FRAMING_ERROR

#define UART_FRAMING_ERROR (UART_LSR_RX_FE_MASK)

◆ UART_PARITY_ERROR

#define UART_PARITY_ERROR (UART_LSR_RX_PE_MASK)

◆ UART_OVERRUN_ERROR

#define UART_OVERRUN_ERROR (UART_LSR_RX_OE_MASK)

◆ UART_REG_CONFIG_MODE_A

#define UART_REG_CONFIG_MODE_A ((uint32_t) 0x0080)

Values to be used while switching between register configuration modes.

◆ UART_REG_CONFIG_MODE_B

#define UART_REG_CONFIG_MODE_B ((uint32_t) 0x00BF)

◆ UART_REG_OPERATIONAL_MODE

#define UART_REG_OPERATIONAL_MODE ((uint32_t) 0x007F)

◆ UART_CONFIG_MODE_POLLED

#define UART_CONFIG_MODE_POLLED (0x00U)

◆ UART_CONFIG_MODE_INTERRUPT

#define UART_CONFIG_MODE_INTERRUPT (0x01U)

◆ UART_CONFIG_MODE_USER_INTR

#define UART_CONFIG_MODE_USER_INTR (0x02U)

◆ UART_CONFIG_MODE_DMA

#define UART_CONFIG_MODE_DMA (0x03U)

Typedef Documentation

◆ UART_Handle

typedef void* UART_Handle

A handle that is returned from a UART_open() call.

◆ UART_CallbackFxn

typedef void(* UART_CallbackFxn) (UART_Handle handle, UART_Transaction *transaction)

The definition of a callback function used by the UART driver when used in UART_TRANSFER_MODE_CALLBACK.

Parameters

handle	UART_Handle
transaction*	Pointer to a UART_Transaction

Function Documentation

◆ UART_init()

void UART_init ( void )

This function initializes the UART module.

◆ UART_deinit()

void UART_deinit ( void )

This function de-initializes the UART module.

◆ UART_open()

UART_Handle UART_open	(	uint32_t	index,
		const UART_Params *	prms
	)

This function opens a given UART peripheral.

Precondition: UART controller has been initialized using UART_init()

Parameters

index	Index of config to use in the UART_Config array
prms	Pointer to open parameters. If NULL is passed, then default values will be used

Returns: A UART_Handle on success or a NULL on an error or if it has been opened already

See also: UART_init(); UART_close(); UART_Params_init

◆ UART_close()

void UART_close ( UART_Handle handle )

Function to close a UART peripheral specified by the UART handle.

Precondition: UART_open() has to be called first

Parameters

handle UART_Handle returned from UART_open()

See also: UART_open()

◆ UART_write()

int32_t UART_write	(	UART_Handle	handle,
		UART_Transaction *	trans
	)

Function to perform UART write operation.

In UART_TRANSFER_MODE_BLOCKING, UART_write() will block task execution until the transaction has completed or a timeout has occurred.

In UART_TRANSFER_MODE_CALLBACK, UART_write() does not block task execution, but calls a UART_CallbackFxn once the transfer has finished. This makes UART_write() safe to be used within a Task, software or hardware interrupt context.

In interrupt mode, UART_write() does not wait until tx fifo is empty. Application needs to call UART_flushTxFifo() to ensure write is completed. i.e. data is out from the FIFO and shift registers.

From calling UART_write() until transfer completion, the UART_Transaction structure must stay persistent and must not be altered by application code. It is also forbidden to modify the content of the UART_Transaction.buf during a transaction, even though the physical transfer might not have started yet. Doing this can result in data corruption.

Parameters

handle UART_Handle returned from UART_open()

trans Pointer to a UART_Transaction. All of the fields within transaction except UART_Transaction.count and UART_Transaction.status are WO (write-only) unless otherwise noted in the driver implementations. If a transaction timeout has occurred, UART_Transaction.count will contain the number of bytes that were transferred. Neither is it allowed to modify the transaction object nor the content of UART_Transaction.buf until the transfer has completed

Returns: SystemP_SUCCESS if started successfully; else error on failure

See also: UART_open

◆ UART_read()

int32_t UART_read	(	UART_Handle	handle,
		UART_Transaction *	trans
	)

Function to perform UART read operation.

In UART_TRANSFER_MODE_BLOCKING, UART_read() will block task execution until the transaction has completed or a timeout has occurred.

In UART_TRANSFER_MODE_CALLBACK, UART_read() does not block task execution, but calls a UART_CallbackFxn once the transfer has finished. This makes UART_read() safe to be used within a Task, software or hardware interrupt context.

From calling UART_read() until transfer completion, the UART_Transaction structure must stay persistent and must not be altered by application code. It is also forbidden to modify the content of the UART_Transaction.buf during a transaction, even though the physical transfer might not have started yet. Doing this can result in data corruption.

Parameters

handle UART_Handle returned from UART_open()

trans Pointer to a UART_Transaction. All of the fields within transaction except UART_Transaction.count and UART_Transaction.status are WO (write-only) unless otherwise noted in the driver implementations. If a transaction timeout has occurred, UART_Transaction.count will contain the number of bytes that were transferred. Neither is it allowed to modify the transaction object nor the content of UART_Transaction.buf until the transfer has completed

Returns: SystemP_SUCCESS if started successfully; else error on failure

See also: UART_open

◆ UART_writeCancel()

int32_t UART_writeCancel	(	UART_Handle	handle,
		UART_Transaction *	trans
	)

Function to perform UART canceling of current write transaction.

In UART_TRANSFER_MODE_CALLBACK, UART_writeCancel() does not block task execution, but calls a UART_CallbackFxn once the cancel has finished. This makes UART_writeCancel() safe to be used within a Task, software or hardware interrupt context.

From calling UART_writeCancel() until cancel completion, the UART_Transaction structure must stay persistent and must not be altered by application code. It is also forbidden to modify the content of the UART_Transaction.buf during a transaction, even though the physical transfer might not have started yet. Doing this can result in data corruption.

Parameters

handle UART_Handle returned from UART_open()

trans Pointer to a UART_Transaction. All of the fields within transaction except UART_Transaction.count and UART_Transaction.status are WO (write-only) unless otherwise noted in the driver implementations. If a transaction timeout has occurred, UART_Transaction.count will contain the number of bytes that were transferred. Neither is it allowed to modify the transaction object nor the content of UART_Transaction.buf until the transfer has completed

Returns: SystemP_SUCCESS if started successfully; else error on failure

See also: UART_open

◆ UART_readCancel()

int32_t UART_readCancel	(	UART_Handle	handle,
		UART_Transaction *	trans
	)

Function to perform UART canceling of current read transaction.

In UART_TRANSFER_MODE_CALLBACK, UART_readCancel() does not block task execution, but calls a UART_CallbackFxn once the cancel has finished. This makes UART_writeCancel() safe to be used within a Task, software or hardware interrupt context.

From calling UART_readCancel() until cancel completion, the UART_Transaction structure must stay persistent and must not be altered by application code. It is also forbidden to modify the content of the UART_Transaction.buf during a transaction, even though the physical transfer might not have started yet. Doing this can result in data corruption.

Parameters

handle UART_Handle returned from UART_open()

trans Pointer to a UART_Transaction. All of the fields within transaction except UART_Transaction.count and UART_Transaction.status are WO (write-only) unless otherwise noted in the driver implementations. If a transaction timeout has occurred, UART_Transaction.count will contain the number of bytes that were transferred. Neither is it allowed to modify the transaction object nor the content of UART_Transaction.buf until the transfer has completed

Returns: SystemP_SUCCESS if started successfully; else error on failure

See also: UART_open

◆ UART_getHandle()

UART_Handle UART_getHandle ( uint32_t index )

Function to return a open'ed UART handle given a UART instance index.

Parameters

index Index of config to use in the UART_Config array

Returns: A UART_Handle on success or a NULL on an error or if the instance index has NOT been opened yet

◆ UART_flushTxFifo()

void UART_flushTxFifo ( UART_Handle handle )

Function to flush a TX FIFO of peripheral specified by the UART handle.

Precondition: UART_open() has to be called first

Parameters

handle UART_Handle returned from UART_open()

See also: UART_open()

◆ UART_Params_init()

static void UART_Params_init ( UART_Params * prms )

inlinestatic

Function to initialize the UART_Params struct to its defaults.

Parameters

prms	Pointer to UART_Params structure for initialization

◆ UART_Transaction_init()

static void UART_Transaction_init ( UART_Transaction * trans )

inlinestatic

Function to initialize the UART_Transaction struct to its defaults.

Parameters

trans Pointer to UART_Transaction structure for initialization

◆ UART_getBaseAddr()

uint32_t UART_getBaseAddr ( UART_Handle handle )

Function to get base address of UART instance of a particular handle.

Parameters

handle UART_Handle returned from UART_open()

See also: UART_open

◆ UART_enableLoopbackMode()

void UART_enableLoopbackMode ( uint32_t baseAddr )

Function to enable loopback mode. This function is for internal use. Not recommended for customers to use.

Parameters

baseAddr Memory address of the UART instance being used.

See also: UART_open

◆ UART_disableLoopbackMode()

void UART_disableLoopbackMode ( uint32_t baseAddr )

Function to disable loopback mode. This function is for internal use. Not recommended for customers to use.

Parameters

baseAddr Memory address of the UART instance being used.

See also: UART_open

◆ UART_putChar()

static void UART_putChar	(	uint32_t	baseAddr,
		uint8_t	byteTx
	)

inlinestatic

This API writes a byte to the Transmitter FIFO without checking for the emptiness of the Transmitter FIFO or the Transmitter Shift Register(TSR).

Parameters

baseAddr	Memory address of the UART instance being used.
byteTx	The byte to be transmitted by the UART.

Note: Unlike the APIs UARTCharPut() or UARTCharPutNonBlocking(), this API does not check for the emptiness of the TX FIFO or TSR. This API is ideal for use in FIFO mode of operation where the 64-byte TX FIFO has to be written with successive bytes. If transmit interrupt is enabled, it provides a mechanism to control the writes to the TX FIFO.

See also: UART_open

◆ UART_getChar()

static uint32_t UART_getChar	(	uint32_t	baseAddr,
		uint8_t *	pChar
	)

inlinestatic

This API reads a byte from the Receiver Buffer Register (RBR). It checks once if any character is ready to be read.

Parameters

baseAddr	Memory address of the UART instance being used.
pChar	Pointer to the byte variable which saves the byte read from RBR if there is any char ready to be read

Returns: If the RX FIFO(or RHR) was found to have atleast one byte of data, then this API returns TRUE. Else it returns FALSE.

See also: UART_open

◆ UART_intrEnable()

static void UART_intrEnable	(	uint32_t	baseAddr,
		uint32_t	intrFlag
	)

inlinestatic

This API enables the specified interrupts in the UART mode of operation.

Parameters

baseAddr	Memory address of the UART instance being used.
intrFlag	Bit mask value of the bits corresponding to Interrupt Enable Register(IER). This specifies the UART interrupts to be enabled.

'intrFlag' can take one or a combination of the following macros:

UART_INTR_CTS - to enable Clear-To-Send interrupt,
UART_INTR_RTS - to enable Request-To-Send interrupt,
UART_INTR_XOFF - to enable XOFF interrupt,
UART_INTR_SLEEPMODE - to enable Sleep Mode,
UART_INTR_MODEM_STAT - to enable Modem Status interrupt,
UART_INTR_LINE_STAT - to enable Line Status interrupt,
UART_INTR_THR - to enable Transmitter Holding Register Empty interrupt,
UART_INTR_RHR_CTI - to enable Receiver Data available interrupt and Character timeout indication interrupt.

Note: This API modifies the contents of UART Interrupt Enable Register (IER). Modifying the bits IER[7:4] requires that EFR[4] be set. This API does the needful before it accesses IER. Moreover, this API should be called when UART is operating in UART 16x Mode, UART 13x Mode or UART 16x Auto-baud mode.

See also: UART_open

◆ UART_intrDisable()

static void UART_intrDisable	(	uint32_t	baseAddr,
		uint32_t	intrFlag
	)

inlinestatic

This API disables the specified interrupts in the UART mode of operation.

Parameters

baseAddr	Memory address of the UART instance being used.
intrFlag	Bit mask value of the bits corresponding to Interrupt Enable Register(IER). This specifies the UART interrupts to be disabled.

'intrFlag' can take one or a combination of the following macros:

UART_INTR_CTS - to disable Clear-To-Send interrupt,
UART_INTR_RTS - to disable Request-To-Send interrupt,
UART_INTR_XOFF - to disable XOFF interrupt,
UART_INTR_SLEEPMODE - to disable Sleep Mode,
UART_INTR_MODEM_STAT - to disable Modem Status interrupt,
UART_INTR_LINE_STAT - to disable Line Status interrupt,
UART_INTR_THR - to disable Transmitter Holding Register Empty interrupt,
UART_INTR_RHR_CTI - to disable Receiver Data available interrupt and Character timeout indication interrupt.

Note: The note section of UART_intrEnable() also applies to this API.

See also: UART_open

◆ UART_intr2Enable()

static void UART_intr2Enable	(	uint32_t	baseAddr,
		uint32_t	intrFlag
	)

inlinestatic

This API enables the specified interrupts in the UART mode of operation for IER2.

Parameters

baseAddr	Memory address of the UART instance being used.
intrFlag	Bit mask value of the bits corresponding to Interrupt Enable Register(IER2). This specifies the UART interrupts to be enabled.

'intrFlag' can take one or a combination of the following macros:

UART_INTR2_RX_EMPTY - to enable receive FIFO empty interrupt
UART_INTR2_TX_EMPTY - to enable TX FIFO empty interrupt

Note: This API modifies the contents of UART Interrupt Enable Register 2 (IER2).

See also: UART_open

◆ UART_intr2Disable()

static void UART_intr2Disable	(	uint32_t	baseAddr,
		uint32_t	intrFlag
	)

inlinestatic

This API disables the specified interrupts in the UART mode of operation for IER2.

Parameters

baseAddr	Memory address of the UART instance being used.
intrFlag	Bit mask value of the bits corresponding to Interrupt Enable Register(IER2). This specifies the UART interrupts to be disabled.

'intrFlag' can take one or a combination of the following macros:

UART_INTR2_RX_EMPTY - to enable receive FIFO empty interrupt
UART_INTR2_TX_EMPTY - to enable TX FIFO empty interrupt

Note: The note section of UART_intr2Enable() also applies to this API.

See also: UART_open

◆ UART_getIntrIdentityStatus()

static uint32_t UART_getIntrIdentityStatus ( uint32_t baseAddr )

inlinestatic

This API determines the UART Interrupt Status.

Parameters

baseAddr Memory address of the UART instance being used.

Returns

This returns one or a combination of the following macros:

UART_INTID_MODEM_STAT - indicating the occurence of a Modem Status interrupt
UART_INTID_TX_THRES_REACH - indicating that the TX FIFO Threshold number of bytes can be written to the TX FIFO.
UART_INTID_RX_THRES_REACH - indicating that the RX FIFO has reached its programmed Trigger Level
UART_INTID_RX_LINE_STAT_ERROR - indicating the occurence of a receiver Line Status error
UART_INTID_CHAR_TIMEOUT - indicating the occurence of a Receiver Timeout
UART_INTID_XOFF_SPEC_CHAR_DETECT - indicating the detection of XOFF or a Special character
UART_INTID_MODEM_SIG_STATE_CHANGE - indicating that atleast one of the Modem signals among CTSn, RTSn and DSRn have changed states from active(low) to inactive(high)

See also: UART_open

◆ UART_getIntr2Status()

static uint32_t UART_getIntr2Status ( uint32_t baseAddr )

inlinestatic

This API determines the UART Interrupt Status 2.

Parameters

baseAddr Memory address of the UART instance being used.

Returns

This returns one or a combination of the following macros:

UART_INTR2_RX_EMPTY - to enable receive FIFO empty interrupt
UART_INTR2_TX_EMPTY - to enable TX FIFO empty interrupt

See also: UART_open

◆ UART_checkCharsAvailInFifo()

static uint32_t UART_checkCharsAvailInFifo ( uint32_t baseAddr )

inlinestatic

This API checks if the RX FIFO (or RHR in non-FIFO mode) has atleast one byte of data to be read.

Parameters

baseAddr Memory address of the UART instance being used.

Returns: TRUE - if there is atleast one data byte present in the RX FIFO (or RHR in non-FIFO mode)
FALSE - if there are no data bytes present in the RX FIFO(or RHR in non-FIFO mode)

See also: UART_open

◆ UART_readLineStatus()

static uint32_t UART_readLineStatus ( uint32_t baseAddr )

inlinestatic

This API reads the line status register value.

Parameters

baseAddr Memory address of the UART instance being used.

Returns: This returns the line status register value.

See also: UART_open

◆ UART_getCharFifo()

static uint8_t UART_getCharFifo	(	uint32_t	baseAddr,
		uint8_t *	readBuf
	)

inlinestatic

This API reads the data present at the top of the RX FIFO, that is, the data in the Receive Holding Register(RHR). However before reading the data from RHR, it checks for RX error.

Parameters

baseAddr	Memory address of the UART instance being used.
readBuf	Pointer to the byte buffer to be read from RHR register.

Returns: The data read from the RHR.

See also: UART_open

Variable Documentation

◆ gUartConfig

UART_Config gUartConfig[]

extern

Externally defined driver configuration array.

◆ gUartConfigNum

uint32_t gUartConfigNum

extern

Externally defined driver configuration array size.

Introduction

Sub Modules

Files

Data Structures

Functions

Typedefs

Macros

Transfer Status Code

Transfer Mode

UART Read length

UART data length

UART stop bits

UART Parity

UART Flow Control Type

UART Flow Control Params for RX

UART Flow Control Params for TX

UART RX trigger level

UART TX trigger level

UART Operational Mode

Values indicating the filled status of TX FIFO

Values related to status of Interrupt souces.

Values related to enabling/disabling of Interrupts.

Values related to Line Status information.

Values related to Register Mode Configuration.

UART Configration Mode

Macro Definition Documentation

◆ UART_FIFO_SIZE

◆ UART_TRANSMITEMPTY_TRIALCOUNT

◆ UART_ERROR_COUNT

◆ UART_TRANSFER_STATUS_SUCCESS

◆ UART_TRANSFER_STATUS_TIMEOUT

◆ UART_TRANSFER_STATUS_ERROR_BI

◆ UART_TRANSFER_STATUS_ERROR_FE

◆ UART_TRANSFER_STATUS_ERROR_PE

◆ UART_TRANSFER_STATUS_ERROR_OE

◆ UART_TRANSFER_STATUS_CANCELLED

◆ UART_TRANSFER_STATUS_STARTED

◆ UART_TRANSFER_STATUS_READ_TIMEOUT

◆ UART_TRANSFER_STATUS_ERROR_INUSE

◆ UART_TRANSFER_STATUS_ERROR_OTH

◆ UART_TRANSFER_MODE_BLOCKING

◆ UART_TRANSFER_MODE_CALLBACK

◆ UART_READ_RETURN_MODE_FULL

◆ UART_READ_RETURN_MODE_PARTIAL

◆ UART_LEN_5

◆ UART_LEN_6

◆ UART_LEN_7

◆ UART_LEN_8

◆ UART_STOPBITS_1

◆ UART_STOPBITS_2

◆ UART_PARITY_NONE

◆ UART_PARITY_ODD

◆ UART_PARITY_EVEN

◆ UART_PARITY_FORCED0

◆ UART_PARITY_FORCED1

◆ UART_FCTYPE_NONE

◆ UART_FCTYPE_HW

◆ UART_FCPARAM_RXNONE

◆ UART_FCPARAM_RXXONXOFF_2

◆ UART_FCPARAM_RXXONXOFF_1

◆ UART_FCPARAM_RXXONXOFF_12

◆ UART_FCPARAM_AUTO_RTS

◆ UART_FCPARAM_TXNONE

◆ UART_FCPARAM_TXXONXOFF_2

◆ UART_FCPARAM_TXXONXOFF_1

◆ UART_FCPARAM_TXXONXOFF_12

◆ UART_FCPARAM_AUTO_CTS

◆ UART_RXTRIGLVL_1

◆ UART_RXTRIGLVL_8

◆ UART_RXTRIGLVL_16

◆ UART_RXTRIGLVL_56

◆ UART_RXTRIGLVL_60

◆ UART_TXTRIGLVL_1

◆ UART_TXTRIGLVL_8

◆ UART_TXTRIGLVL_16

◆ UART_TXTRIGLVL_32

◆ UART_TXTRIGLVL_56

◆ UART_OPER_MODE_16X

◆ UART_OPER_MODE_SIR

◆ UART_OPER_MODE_16X_AUTO_BAUD