UART Interface

Interface for UART communications. More...

Data Structures
struct	uart_info_t
struct	uart_callback_args_t
struct	uart_cfg_t
struct	uart_api_t
struct	uart_instance_t

Typedefs
typedef void	uart_ctrl_t

Enumerations
enum	uart_event_t {   UART_EVENT_RX_COMPLETE = (1UL << 0), UART_EVENT_TX_COMPLETE = (1UL << 1), UART_EVENT_ERR_PARITY = (1UL << 2), UART_EVENT_ERR_FRAMING = (1UL << 3),   UART_EVENT_BREAK_DETECT = (1UL << 4), UART_EVENT_ERR_OVERFLOW = (1UL << 5), UART_EVENT_ERR_RXBUF_OVERFLOW = (1UL << 6), UART_EVENT_RX_CHAR = (1UL << 7),   UART_EVENT_TX_DATA_EMPTY = (1UL << 8) }
enum	uart_data_bits_t { UART_DATA_BITS_8, UART_DATA_BITS_7, UART_DATA_BITS_9 }
enum	uart_parity_t { UART_PARITY_OFF = 0U, UART_PARITY_EVEN = 2U, UART_PARITY_ODD = 3U }
enum	uart_stop_bits_t { UART_STOP_BITS_1 = 0U, UART_STOP_BITS_2 = 1U }
enum	uart_dir_t { UART_DIR_RX_TX = 0U, UART_DIR_RX = 1U, UART_DIR_TX = 2U }
enum	uart_mode_t { UART_MODE_RS232 = 0U, UART_MODE_RS485 = 1U }
enum	uart_rs485_type_t { UART_RS485_HD = 0U, UART_RS485_FD = 1U }

Detailed Description

Interface for UART communications.

Summary

The UART interface provides common APIs for UART HAL drivers. The UART interface supports the following features:

• Full-duplex UART communication
• Generic UART parameter setting
• Interrupt driven transmit/receive processing
• Callback function with returned event code
• Runtime baud-rate change
• Hardware resource locking during a transaction
• CTS/RTS hardware flow control support (with an associated IOPORT pin)
• Circular buffer support
• Runtime Transmit/Receive circular buffer flushing

Implemented by:

• UART on SCI

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

UART Interface description: UART Driver

Typedef Documentation

uart_ctrl_t

typedef void uart_ctrl_t

UART control block. Allocate an instance specific control block to pass into the UART API calls.

Implemented as

• sci_uart_instance_ctrl_t

Enumeration Type Documentation

uart_data_bits_t

enum uart_data_bits_t

UART Data bit length definition

Enumerator
UART_DATA_BITS_8	Data bits 8-bit.
UART_DATA_BITS_7	Data bits 7-bit.
UART_DATA_BITS_9	Data bits 9-bit.

uart_dir_t

enum uart_dir_t

UART transaction definition

Enumerator
UART_DIR_RX_TX	Both RX and TX.
UART_DIR_RX	Only RX.
UART_DIR_TX	Only TX.

uart_event_t

enum uart_event_t

UART Event codes

Enumerator
UART_EVENT_RX_COMPLETE	Receive complete event.
UART_EVENT_TX_COMPLETE	Transmit complete event.
UART_EVENT_ERR_PARITY	Parity error event.
UART_EVENT_ERR_FRAMING	Mode fault error event.
UART_EVENT_BREAK_DETECT	Break detect error event.
UART_EVENT_ERR_OVERFLOW	FIFO Overflow error event.
UART_EVENT_ERR_RXBUF_OVERFLOW	DEPRECATED: Receive buffer overflow error event.
UART_EVENT_RX_CHAR	Character received.
UART_EVENT_TX_DATA_EMPTY	Last byte is transmitting, ready for more data.

uart_mode_t

enum uart_mode_t

UART communication mode definition

Enumerator
UART_MODE_RS232	Enables RS232 communication mode.
UART_MODE_RS485	Enables RS485 communication mode.

uart_parity_t

enum uart_parity_t

UART Parity definition

Enumerator
UART_PARITY_OFF	No parity.
UART_PARITY_EVEN	Even parity.
UART_PARITY_ODD	Odd parity.

uart_rs485_type_t

enum uart_rs485_type_t

UART RS485 communication channel type definition

Enumerator
UART_RS485_HD	Uses RS485 half duplex communication channel.
UART_RS485_FD	Uses RS485 full duplex communication channel.

uart_stop_bits_t

enum uart_stop_bits_t

UART Stop bits definition

Enumerator
UART_STOP_BITS_1	Stop bit 1-bit.
UART_STOP_BITS_2	Stop bits 2-bit.