Collaboration diagram for [uart.h] Universal Asynchronous Receiver/Transmitter:

Macros
#define	UART_INT_EOT (UART_IMSC_EOT_M)
	End Of Transmission Interrupt Mask. More...

#define	UART_INT_OE (UART_IMSC_OE_M)
	Overrun Error Interrupt Mask. More...

#define	UART_INT_BE (UART_IMSC_BE_M)
	Break Error Interrupt Mask. More...

#define	UART_INT_PE (UART_IMSC_PE_M)
	Parity Error Interrupt Mask. More...

#define	UART_INT_FE (UART_IMSC_FE_M)
	Framing Error Interrupt Mask. More...

#define	UART_INT_RT (UART_IMSC_RT_M)
	Receive Timeout Interrupt Mask. More...

#define	UART_INT_RX (UART_IMSC_RX_M)
	Receive Interrupt Mask. More...

#define	UART_INT_TX (UART_IMSC_TX_M)
	Transmit Interrupt Mask. More...

#define	UART_INT_CTS (UART_IMSC_CTSM_M)
	CTS Modem Interrupt Mask. More...

#define	UART_INT_TXDMADONE (UART_IMSC_TXDMADONE_M)
	Tx DMA done interrupt mask. More...

#define	UART_INT_RXDMADONE (UART_IMSC_RXDMADONE_M)
	Rx DMA done interrupt mask. More...

#define	UART_INT_LINBRK (UART_IMSC_LINBRK_M)
	LIN Break Field Detected Interrupt Mask. More...

#define	UART_INT_LINBRKTOE (UART_IMSC_LINBRKTOE_M)
	LIN Break Field Timeout Error Interrupt Mask. More...

#define	UART_INT_LINSYNCTOE (UART_IMSC_LINSYNCTOE_M)
	LIN Sync Timeout Error Interrupt Mask. More...

#define	UART_CONFIG_WLEN_MASK UART_LCRH_WLEN_M
	Mask for extracting word length. More...

#define	UART_CONFIG_WLEN_8 UART_LCRH_WLEN_BITL8
	8 bit data More...

#define	UART_CONFIG_WLEN_7 UART_LCRH_WLEN_BITL7
	7 bit data More...

#define	UART_CONFIG_WLEN_6 UART_LCRH_WLEN_BITL6
	6 bit data More...

#define	UART_CONFIG_WLEN_5 UART_LCRH_WLEN_BITL5
	5 bit data More...

#define	UART_CONFIG_STOP_MASK UART_LCRH_STP2_M
	Mask for extracting stop bits. More...

#define	UART_CONFIG_STOP_ONE 0x00000000
	One stop bit. More...

#define	UART_CONFIG_STOP_TWO UART_LCRH_STP2
	Two stop bits. More...

#define	UART_CONFIG_PAR_MASK 0x00000086
	Mask for extracting parity. More...

#define	UART_CONFIG_PAR_NONE 0x00000000
	No parity. More...

#define	UART_CONFIG_PAR_EVEN 0x00000006
	Even parity. More...

#define	UART_CONFIG_PAR_ODD 0x00000002
	Odd parity. More...

#define	UART_CONFIG_PAR_ONE 0x00000082
	Parity bit is one. More...

#define	UART_CONFIG_PAR_ZERO 0x00000086
	Parity bit is zero. More...

#define	UART_FIFO_TX2_8 UART_IFLS_TXSEL_QUARTER
	Transmit interrupt at 1/4 Full. More...

#define	UART_FIFO_TX4_8 UART_IFLS_TXSEL_HALF
	Transmit interrupt at 1/2 Full. More...

#define	UART_FIFO_TX6_8 UART_IFLS_TXSEL_THREEQU
	Transmit interrupt at 3/4 Full. More...

#define	UART_FIFO_RX2_8 UART_IFLS_RXSEL_QUARTER
	Receive interrupt at 1/4 Full. More...

#define	UART_FIFO_RX4_8 UART_IFLS_RXSEL_HALF
	Receive interrupt at 1/2 Full. More...

#define	UART_FIFO_RX6_8 UART_IFLS_RXSEL_THREEQU
	Receive interrupt at 3/4 Full. More...

#define	UART_DMA_ERR_RXSTOP 0x00000004
	Stop DMA receive if UART error. More...

#define	UART_DMA_TX 0x00000002
	Enable DMA for transmit. More...

#define	UART_DMA_RX 0x00000001
	Enable DMA for receive. More...

#define	UART_LIN_DELIM_LEN1BIT UART_LCRH_DELIM_LEN_1
	1 bit delimiter length More...

#define	UART_LIN_DELIM_LEN2BIT UART_LCRH_DELIM_LEN_2
	2 bit delimiter length More...

#define	UART_LIN_DELIM_LEN3BIT UART_LCRH_DELIM_LEN_3
	3 bit delimiter length More...

#define	UART_LIN_DELIM_LEN4BIT UART_LCRH_DELIM_LEN_4
	4 bit delimiter length More...

#define	UART_RXERROR_OVERRUN 0x00000008

#define	UART_RXERROR_BREAK 0x00000004

#define	UART_RXERROR_PARITY 0x00000002

#define	UART_RXERROR_FRAMING 0x00000001

Functions
__STATIC_INLINE void	UARTSetFifoLevel (uint32_t base, uint32_t txLevel, uint32_t rxLevel)
	Sets the FIFO level at which interrupts are generated. More...

void	UARTConfigSetExpClk (uint32_t base, uint32_t UARTClkFreq, uint32_t baudFreq, uint32_t config)
	Sets the configuration of a UART. More...

void	UARTDisable (uint32_t base)
	Disables transmitting and receiving. More...

__STATIC_INLINE void	UARTEnableFifo (uint32_t base)
	Enables the transmit and receive FIFOs. More...

__STATIC_INLINE void	UARTDisableFIFO (uint32_t base)
	Disables the transmit and receive FIFOs. More...

__STATIC_INLINE bool	UARTCharAvailable (uint32_t base)
	Determines if there are any characters in the receive FIFO. More...

__STATIC_INLINE uint8_t	UARTGetCharNonBlocking (uint32_t base)
	Receives a character from the specified port. More...

uint8_t	UARTGetChar (uint32_t base)
	Waits for a character from the specified port. More...

__STATIC_INLINE bool	UARTSpaceAvailable (uint32_t base)
	Determines if there is any space in the transmit FIFO. More...

__STATIC_INLINE void	UARTPutCharNonBlocking (uint32_t base, uint8_t data)
	Sends a character to the specified port. More...

void	UARTPutChar (uint32_t base, uint8_t data)
	Waits to send a character to the specified port. More...

__STATIC_INLINE bool	UARTBusy (uint32_t base)
	Determines whether the UART transmitter is busy or not. More...

__STATIC_INLINE void	UARTEnableInt (uint32_t base, uint32_t intFlags)
	Enables individual UART interrupt sources. More...

__STATIC_INLINE void	UARTDisableInt (uint32_t base, uint32_t intFlags)
	Disables individual UART interrupt sources. More...

__STATIC_INLINE uint32_t	UARTIntStatus (uint32_t base, bool masked)
	Gets the current interrupt status. More...

__STATIC_INLINE void	UARTClearInt (uint32_t base, uint32_t intFlags)
	Clears UART interrupt sources. More...

__STATIC_INLINE void	UARTEnableDMA (uint32_t base, uint32_t dmaFlags)
	Enable UART DMA operation. More...

__STATIC_INLINE void	UARTDisableDMA (uint32_t base, uint32_t dmaFlags)
	Disable UART DMA operation. More...

__STATIC_INLINE uint32_t	UARTGetRxError (uint32_t base)
	Gets current receiver errors. More...

__STATIC_INLINE void	UARTClearRxError (uint32_t base)
	Clears all reported receiver errors. More...

__STATIC_INLINE void	UARTEnableCTS (uint32_t base)
	Enable CTS flow control. More...

__STATIC_INLINE void	UARTEnableRTS (uint32_t base)
	Enable RTS flow control. More...

__STATIC_INLINE void	UARTDisableCTS (uint32_t base)
	Disable CTS flow control. More...

__STATIC_INLINE void	UARTDisableRTS (uint32_t base)
	Disable RTS flow control. More...

__STATIC_INLINE void	UARTEnableLIN (uint32_t base)
	Enables LIN mode for UART. More...

__STATIC_INLINE void	UARTDisableLIN (uint32_t base)
	Disables LIN mode for UART. More...

__STATIC_INLINE void	UARTEnableLINDormant (uint32_t base)
	Enables dormant mode for UART in LIN mode. More...

__STATIC_INLINE void	UARTDisableLINDormant (uint32_t base)
	Disables dormant mode for UART in LIN mode. More...

void	UARTSetLINDelimiterLength (uint32_t base, uint32_t length)
	Sets the delimiter length for UART in LIN mode. More...

__STATIC_INLINE void	UARTEnableLINBreakSync (uint32_t base)
	Enables sending Break/Sync field for UART in LIN mode. More...

__STATIC_INLINE void	UARTDisableLINBreakSync (uint32_t base)
	Disables sending Break/Sync field for UART in LIN mode. More...

Detailed Description

Macro Definition Documentation

§ UART_INT_EOT

#define UART_INT_EOT (UART_IMSC_EOT_M)

End Of Transmission Interrupt Mask.

§ UART_INT_OE

#define UART_INT_OE (UART_IMSC_OE_M)

Overrun Error Interrupt Mask.

§ UART_INT_BE

#define UART_INT_BE (UART_IMSC_BE_M)

Break Error Interrupt Mask.

§ UART_INT_PE

#define UART_INT_PE (UART_IMSC_PE_M)

Parity Error Interrupt Mask.

§ UART_INT_FE

#define UART_INT_FE (UART_IMSC_FE_M)

Framing Error Interrupt Mask.

§ UART_INT_RT

#define UART_INT_RT (UART_IMSC_RT_M)

Receive Timeout Interrupt Mask.

§ UART_INT_RX

#define UART_INT_RX (UART_IMSC_RX_M)

Receive Interrupt Mask.

§ UART_INT_TX

#define UART_INT_TX (UART_IMSC_TX_M)

Transmit Interrupt Mask.

§ UART_INT_CTS

#define UART_INT_CTS (UART_IMSC_CTSM_M)

CTS Modem Interrupt Mask.

§ UART_INT_TXDMADONE

#define UART_INT_TXDMADONE (UART_IMSC_TXDMADONE_M)

Tx DMA done interrupt mask.

§ UART_INT_RXDMADONE

#define UART_INT_RXDMADONE (UART_IMSC_RXDMADONE_M)

Rx DMA done interrupt mask.

§ UART_INT_LINBRK

#define UART_INT_LINBRK (UART_IMSC_LINBRK_M)

LIN Break Field Detected Interrupt Mask.

§ UART_INT_LINBRKTOE

#define UART_INT_LINBRKTOE (UART_IMSC_LINBRKTOE_M)

LIN Break Field Timeout Error Interrupt Mask.

§ UART_INT_LINSYNCTOE

#define UART_INT_LINSYNCTOE (UART_IMSC_LINSYNCTOE_M)

LIN Sync Timeout Error Interrupt Mask.

§ UART_CONFIG_WLEN_MASK

#define UART_CONFIG_WLEN_MASK UART_LCRH_WLEN_M

Mask for extracting word length.

§ UART_CONFIG_WLEN_8

#define UART_CONFIG_WLEN_8 UART_LCRH_WLEN_BITL8

8 bit data

§ UART_CONFIG_WLEN_7

#define UART_CONFIG_WLEN_7 UART_LCRH_WLEN_BITL7

7 bit data

§ UART_CONFIG_WLEN_6

#define UART_CONFIG_WLEN_6 UART_LCRH_WLEN_BITL6

6 bit data

§ UART_CONFIG_WLEN_5

#define UART_CONFIG_WLEN_5 UART_LCRH_WLEN_BITL5

5 bit data

§ UART_CONFIG_STOP_MASK

#define UART_CONFIG_STOP_MASK UART_LCRH_STP2_M

Mask for extracting stop bits.

§ UART_CONFIG_STOP_ONE

#define UART_CONFIG_STOP_ONE 0x00000000

One stop bit.

§ UART_CONFIG_STOP_TWO

#define UART_CONFIG_STOP_TWO UART_LCRH_STP2

Two stop bits.

§ UART_CONFIG_PAR_MASK

#define UART_CONFIG_PAR_MASK 0x00000086

Mask for extracting parity.

§ UART_CONFIG_PAR_NONE

#define UART_CONFIG_PAR_NONE 0x00000000

No parity.

§ UART_CONFIG_PAR_EVEN

#define UART_CONFIG_PAR_EVEN 0x00000006

Even parity.

§ UART_CONFIG_PAR_ODD

#define UART_CONFIG_PAR_ODD 0x00000002

Odd parity.

§ UART_CONFIG_PAR_ONE

#define UART_CONFIG_PAR_ONE 0x00000082

Parity bit is one.

§ UART_CONFIG_PAR_ZERO

#define UART_CONFIG_PAR_ZERO 0x00000086

Parity bit is zero.

§ UART_FIFO_TX2_8

#define UART_FIFO_TX2_8 UART_IFLS_TXSEL_QUARTER

Transmit interrupt at 1/4 Full.

Referenced by UARTSetFifoLevel().

§ UART_FIFO_TX4_8

#define UART_FIFO_TX4_8 UART_IFLS_TXSEL_HALF

Transmit interrupt at 1/2 Full.

Referenced by UARTSetFifoLevel().

§ UART_FIFO_TX6_8

#define UART_FIFO_TX6_8 UART_IFLS_TXSEL_THREEQU

Transmit interrupt at 3/4 Full.

Referenced by UARTSetFifoLevel().

§ UART_FIFO_RX2_8

#define UART_FIFO_RX2_8 UART_IFLS_RXSEL_QUARTER

Receive interrupt at 1/4 Full.

Referenced by UARTSetFifoLevel().

§ UART_FIFO_RX4_8

#define UART_FIFO_RX4_8 UART_IFLS_RXSEL_HALF

Receive interrupt at 1/2 Full.

Referenced by UARTSetFifoLevel().

§ UART_FIFO_RX6_8

#define UART_FIFO_RX6_8 UART_IFLS_RXSEL_THREEQU

Receive interrupt at 3/4 Full.

Referenced by UARTSetFifoLevel().

§ UART_DMA_ERR_RXSTOP

#define UART_DMA_ERR_RXSTOP 0x00000004

Stop DMA receive if UART error.

§ UART_DMA_TX

#define UART_DMA_TX 0x00000002

Enable DMA for transmit.

§ UART_DMA_RX

#define UART_DMA_RX 0x00000001

Enable DMA for receive.

§ UART_LIN_DELIM_LEN1BIT

#define UART_LIN_DELIM_LEN1BIT UART_LCRH_DELIM_LEN_1

1 bit delimiter length

Referenced by UARTSetLINDelimiterLength().

§ UART_LIN_DELIM_LEN2BIT

#define UART_LIN_DELIM_LEN2BIT UART_LCRH_DELIM_LEN_2

2 bit delimiter length

Referenced by UARTSetLINDelimiterLength().

§ UART_LIN_DELIM_LEN3BIT

#define UART_LIN_DELIM_LEN3BIT UART_LCRH_DELIM_LEN_3

3 bit delimiter length

Referenced by UARTSetLINDelimiterLength().

§ UART_LIN_DELIM_LEN4BIT

#define UART_LIN_DELIM_LEN4BIT UART_LCRH_DELIM_LEN_4

4 bit delimiter length

Referenced by UARTSetLINDelimiterLength().

§ UART_RXERROR_OVERRUN

#define UART_RXERROR_OVERRUN 0x00000008

§ UART_RXERROR_BREAK

#define UART_RXERROR_BREAK 0x00000004

§ UART_RXERROR_PARITY

#define UART_RXERROR_PARITY 0x00000002

§ UART_RXERROR_FRAMING

#define UART_RXERROR_FRAMING 0x00000001

Function Documentation

§ UARTSetFifoLevel()

__STATIC_INLINE void UARTSetFifoLevel	(	uint32_t	base,
		uint32_t	txLevel,
		uint32_t	rxLevel
	)

Sets the FIFO level at which interrupts are generated.

This function sets the FIFO level at which transmit and receive interrupts are generated.

Parameters

base	is the base address of the UART port.
txLevel	is the transmit FIFO interrupt level, specified as one of: UART_FIFO_TX2_8 UART_FIFO_TX4_8 UART_FIFO_TX6_8
rxLevel	is the receive FIFO interrupt level, specified as one of: UART_FIFO_RX2_8 UART_FIFO_RX4_8 UART_FIFO_RX6_8

Returns: None

References ASSERT, UART_FIFO_RX2_8, UART_FIFO_RX4_8, UART_FIFO_RX6_8, UART_FIFO_TX2_8, UART_FIFO_TX4_8, UART_FIFO_TX6_8, UARTConfigSetExpClk(), and UARTDisable().

§ UARTConfigSetExpClk()

void UARTConfigSetExpClk	(	uint32_t	base,
		uint32_t	UARTClkFreq,
		uint32_t	baudFreq,
		uint32_t	config
	)

Sets the configuration of a UART.

This function configures the UART for operation in the specified data format.

Parameters

base	is the base address of the UART port.
UARTClkFreq	is the rate of the clock supplied to the UART module.
baudFreq	is the desired baud rate. Minimum baud rate: baudFreq >= ceil(UARTClkFreq / 1,048,559.875) Maximum baud rate: baudFreq <= floor(UARTClkFreq / 15.875)
config	is the data format for the port. The parameter is the bitwise OR of three values: Number of data bits UART_CONFIG_WLEN_8 : 8 data bits per byte. UART_CONFIG_WLEN_7 : 7 data bits per byte. UART_CONFIG_WLEN_6 : 6 data bits per byte. UART_CONFIG_WLEN_5 : 5 data bits per byte. Number of stop bits UART_CONFIG_STOP_ONE : One stop bit. UART_CONFIG_STOP_TWO : Two stop bits. Parity UART_CONFIG_PAR_NONE UART_CONFIG_PAR_EVEN UART_CONFIG_PAR_ODD UART_CONFIG_PAR_ONE UART_CONFIG_PAR_ZERO

Returns: None

References ASSERT, and UARTDisable().

Referenced by UARTSetFifoLevel().

§ UARTDisable()

void UARTDisable ( uint32_t base )

Disables transmitting and receiving.

This function waits until all data in the TX FIFO has been transmitted, and then clears the UARTEN, TXE, and RXE bits, and disables the FIFO.

Parameters

base	is the base address of the UART port.

Returns: None

Referenced by UARTConfigSetExpClk(), and UARTSetFifoLevel().

§ UARTEnableFifo()

__STATIC_INLINE void UARTEnableFifo ( uint32_t base )

Enables the transmit and receive FIFOs.

This functions enables the transmit and receive FIFOs in the UART.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTDisableFIFO()

__STATIC_INLINE void UARTDisableFIFO ( uint32_t base )

Disables the transmit and receive FIFOs.

This functions disables the transmit and receive FIFOs in the UART.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTCharAvailable()

__STATIC_INLINE bool UARTCharAvailable ( uint32_t base )

Determines if there are any characters in the receive FIFO.

This function returns a flag indicating whether or not there is data available in the receive FIFO.

Parameters

base	is the base address of the UART port.

Returns

Returns status of the receive FIFO.

true : There is data in the receive FIFO.
false : There is no data in the receive FIFO.

§ UARTGetCharNonBlocking()

__STATIC_INLINE uint8_t UARTGetCharNonBlocking ( uint32_t base )

Receives a character from the specified port.

This function gets a character from the receive FIFO for the specified port.

Note: The UARTCharAvailable() function should be called before attempting to call this function.

Parameters

[in] base is the base address of the UART port.

Returns: Returns the character read from the specified port

See also: UARTCharAvailable()

References UARTGetChar().

§ UARTGetChar()

uint8_t UARTGetChar ( uint32_t base )

Waits for a character from the specified port.

This function gets a character from the receive FIFO for the specified port. If there are no characters available, this function waits until a character is received before returning.

Parameters

base	is the base address of the UART port.

Returns: Returns the character read from the specified port

Referenced by UARTGetCharNonBlocking().

§ UARTSpaceAvailable()

__STATIC_INLINE bool UARTSpaceAvailable ( uint32_t base )

Determines if there is any space in the transmit FIFO.

This function returns a flag indicating whether or not there is space available in the transmit FIFO.

Parameters

base	is the base address of the UART port.

Returns

Returns status of the transmit FIFO.

true : There is space available in the transmit FIFO.
false : There is no space available in the transmit FIFO.

§ UARTPutCharNonBlocking()

__STATIC_INLINE void UARTPutCharNonBlocking	(	uint32_t	base,
		uint8_t	data
	)

Sends a character to the specified port.

This function writes the character data to the transmit FIFO for the specified port.

Note: The UARTSpaceAvailable() function should be called before attempting to call this function.

Parameters

base	is the base address of the UART port.
data	is the character to be transmitted.

Returns: None

See also: UARTSpaceAvailable()

References UARTPutChar().

§ UARTPutChar()

void UARTPutChar	(	uint32_t	base,
		uint8_t	data
	)

Waits to send a character to the specified port.

This function sends the character data to the transmit FIFO for the specified port. If there is no space available in the transmit FIFO, this function waits until there is space available before returning.

Parameters

base	is the base address of the UART port.
data	is the character to be transmitted.

Returns: None

Referenced by UARTPutCharNonBlocking().

§ UARTBusy()

__STATIC_INLINE bool UARTBusy ( uint32_t base )

Determines whether the UART transmitter is busy or not.

Allows the caller to determine whether all transmitted bytes have cleared the transmitter hardware. If false is returned, the transmit FIFO is empty and all bits of the last transmitted character, including all stop bits, have left the hardware shift register.

Parameters

base	is the base address of the UART port.

Returns

Returns status of UART transmitter.

true : UART is transmitting.
false : All transmissions are complete.

§ UARTEnableInt()

__STATIC_INLINE void UARTEnableInt	(	uint32_t	base,
		uint32_t	intFlags
	)

Enables individual UART interrupt sources.

This function enables the indicated UART interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

Parameters

base is the base address of the UART port.

intFlags

is the bit mask of the interrupt sources to be enabled. The parameter is the bitwise OR of any of the following:

UART_INT_EOT : End Of Transmission interrupt.
UART_INT_OE : Overrun Error interrupt.
UART_INT_BE : Break Error interrupt.
UART_INT_PE : Parity Error interrupt.
UART_INT_FE : Framing Error interrupt.
UART_INT_RT : Receive Timeout interrupt.
UART_INT_TX : Transmit interrupt.
UART_INT_RX : Receive interrupt.
UART_INT_CTS : CTS interrupt.
UART_INT_TXDMADONE : TX DMA Done interrupt.
UART_INT_RXDMADONE : RX DMA Done interrupt.
UART_INT_LINBRK : LIN Break Field Detected interrupt.
UART_INT_LINBRKTOE : LIN Break Field Timeout Error interrupt.
UART_INT_LINSYNCTOE : LIN Sync Timeout Error interrupt.

Returns: None

§ UARTDisableInt()

__STATIC_INLINE void UARTDisableInt	(	uint32_t	base,
		uint32_t	intFlags
	)

Disables individual UART interrupt sources.

This function disables the indicated UART interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

Parameters

base is the base address of the UART port.

intFlags

is the bit mask of the interrupt sources to be disabled.

UART_INT_EOT : End Of Transmission interrupt.
UART_INT_OE : Overrun Error interrupt.
UART_INT_BE : Break Error interrupt.
UART_INT_PE : Parity Error interrupt.
UART_INT_FE : Framing Error interrupt.
UART_INT_RT : Receive Timeout interrupt.
UART_INT_TX : Transmit interrupt.
UART_INT_RX : Receive interrupt.
UART_INT_CTS : CTS interrupt.
UART_INT_TXDMADONE : TX DMA Done interrupt.
UART_INT_RXDMADONE : RX DMA Done interrupt.
UART_INT_LINBRK : LIN Break Field Detected interrupt.
UART_INT_LINBRKTOE : LIN Break Field Timeout Error interrupt.
UART_INT_LINSYNCTOE : LIN Sync Timeout Error interrupt.

Returns: None

§ UARTIntStatus()

__STATIC_INLINE uint32_t UARTIntStatus	(	uint32_t	base,
		bool	masked
	)

Gets the current interrupt status.

This function returns the interrupt status for the specified UART. Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned.

Parameters

base	is the base address of the UART port.
masked	selects either raw or masked interrupt. `true` : Masked interrupt status is required. `false` : Raw interrupt status is required.

Returns

Returns the current interrupt status, enumerated as a bit field of:

UART_INT_EOT : End Of Transmission interrupt.
UART_INT_OE : Overrun Error interrupt.
UART_INT_BE : Break Error interrupt.
UART_INT_PE : Parity Error interrupt.
UART_INT_FE : Framing Error interrupt.
UART_INT_RT : Receive Timeout interrupt.
UART_INT_TX : Transmit interrupt.
UART_INT_RX : Receive interrupt.
UART_INT_CTS : CTS interrupt.
UART_INT_TXDMADONE : TX DMA Done interrupt.
UART_INT_RXDMADONE : RX DMA Done interrupt.
UART_INT_LINBRK : LIN Break Field Detected interrupt.
UART_INT_LINBRKTOE : LIN Break Field Timeout Error interrupt.
UART_INT_LINSYNCTOE : LIN Sync Timeout Error interrupt.

§ UARTClearInt()

__STATIC_INLINE void UARTClearInt	(	uint32_t	base,
		uint32_t	intFlags
	)

Clears UART interrupt sources.

The specified UART interrupt sources are cleared, so that they no longer assert. This function must be called in the interrupt handler to keep the interrupt from being recognized again immediately upon exit.

Note

Due to write buffers and synchronizers in the system it may take several clock cycles from a register write clearing an event in a module and until the event is actually cleared in the NVIC of the system CPU. It is recommended to clear the event source early in the interrupt service routine (ISR) to allow the event clear to propagate to the NVIC before returning from the ISR. At the same time, an early event clear allows new events of the same type to be pended instead of ignored if the event is cleared later in the ISR. It is the responsibility of the programmer to make sure that enough time has passed before returning from the ISR to avoid false re-triggering of the cleared event. A simple, although not necessarily optimal, way of clearing an event before returning from the ISR is:

Write to clear event (interrupt source). (buffered write)
Dummy read from the event source module. (making sure the write has propagated)
Wait two system CPU clock cycles (user code or two NOPs). (allowing cleared event to propagate through any synchronizers)

Parameters

base is the base address of the UART port.

intFlags

is a bit mask of the interrupt sources to be cleared.

UART_INT_EOT : End Of Transmission interrupt.
UART_INT_OE : Overrun Error interrupt.
UART_INT_BE : Break Error interrupt.
UART_INT_PE : Parity Error interrupt.
UART_INT_FE : Framing Error interrupt.
UART_INT_RT : Receive Timeout interrupt.
UART_INT_TX : Transmit interrupt.
UART_INT_RX : Receive interrupt.
UART_INT_CTS : CTS interrupt.
UART_INT_TXDMADONE : TX DMA Done interrupt.
UART_INT_RXDMADONE : RX DMA Done interrupt.
UART_INT_LINBRK : LIN Break Field Detected interrupt.
UART_INT_LINBRKTOE : LIN Break Field Timeout Error interrupt.
UART_INT_LINSYNCTOE : LIN Sync Timeout Error interrupt.

Returns: None

§ UARTEnableDMA()

__STATIC_INLINE void UARTEnableDMA	(	uint32_t	base,
		uint32_t	dmaFlags
	)

Enable UART DMA operation.

The specified UART DMA features are enabled. The UART can be configured to use DMA for transmit or receive, and to disable receive if an error occurs.

Note: The uDMA controller must also be set up before DMA can be used with the UART.

Parameters

base	is the base address of the UART port.
dmaFlags	is a bit mask of the DMA features to enable. The parameter is the bitwise OR of any of the following values: UART_DMA_RX : Enable DMA for receive. UART_DMA_TX : Enable DMA for transmit. UART_DMA_ERR_RXSTOP : Disable DMA receive on UART error.

Returns: None

§ UARTDisableDMA()

__STATIC_INLINE void UARTDisableDMA	(	uint32_t	base,
		uint32_t	dmaFlags
	)

Disable UART DMA operation.

This function is used to disable UART DMA features that were enabled by UARTEnableDMA(). The specified UART DMA features are disabled.

Parameters

base	is the base address of the UART port.
dmaFlags	is a bit mask of the DMA features to disable. The parameter is the bitwise OR of any of the following values: UART_DMA_RX : Enable DMA for receive. UART_DMA_TX : Enable DMA for transmit. UART_DMA_ERR_RXSTOP : Disable DMA receive on UART error.

Returns: None

§ UARTGetRxError()

__STATIC_INLINE uint32_t UARTGetRxError ( uint32_t base )

Gets current receiver errors.

This function returns the current state of each of the 4 receiver error sources. The returned errors are equivalent to the four error bits returned via the previous call to UARTGetChar() or UARTGetCharNonBlocking() with the exception that the overrun error is set immediately the overrun occurs rather than when a character is next read.

Parameters

base	is the base address of the UART port.

Returns

Returns a bitwise OR combination of the receiver error flags:

§ UARTClearRxError()

__STATIC_INLINE void UARTClearRxError ( uint32_t base )

Clears all reported receiver errors.

This function is used to clear all receiver error conditions reported via UARTGetRxError(). If using the overrun, framing error, parity error or break interrupts, this function must be called after clearing the interrupt to ensure that later errors of the same type trigger another interrupt.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTEnableCTS()

__STATIC_INLINE void UARTEnableCTS ( uint32_t base )

Enable CTS flow control.

Hardware flow control is disabled by default.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTEnableRTS()

__STATIC_INLINE void UARTEnableRTS ( uint32_t base )

Enable RTS flow control.

Hardware flow control is disabled by default.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTDisableCTS()

__STATIC_INLINE void UARTDisableCTS ( uint32_t base )

Disable CTS flow control.

Hardware flow control is disabled by default.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTDisableRTS()

__STATIC_INLINE void UARTDisableRTS ( uint32_t base )

Disable RTS flow control.

Hardware flow control is disabled by default.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTEnableLIN()

__STATIC_INLINE void UARTEnableLIN ( uint32_t base )

Enables LIN mode for UART.

This function enables LIN mode communication for the specified UART.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTDisableLIN()

__STATIC_INLINE void UARTDisableLIN ( uint32_t base )

Disables LIN mode for UART.

This function disables LIN mode communication for the specified UART.

Parameters

base	is the base address of the UART port.

Returns: None

§ UARTEnableLINDormant()

__STATIC_INLINE void UARTEnableLINDormant ( uint32_t base )

Enables dormant mode for UART in LIN mode.

When dormant mode is enabled, break and synch data will not be loaded to RX FIFO. RX FIFO will be updated with actual data (PID) only after successful reception of break/synch fields.

Parameters

base	is the base address of the UART port.

See also: UARTEnableLIN()

Returns: None

§ UARTDisableLINDormant()

__STATIC_INLINE void UARTDisableLINDormant ( uint32_t base )

Disables dormant mode for UART in LIN mode.

When dormant mode is enabled, break and synch data will not be loaded to RX FIFO. RX FIFO will be updated with actual data (PID) only after successful reception of break/synch fields.

Parameters

base	is the base address of the UART port.

See also: UARTEnableLIN()

Returns: None

References UARTSetLINDelimiterLength().

§ UARTSetLINDelimiterLength()

void UARTSetLINDelimiterLength	(	uint32_t	base,
		uint32_t	length
	)

Sets the delimiter length for UART in LIN mode.

This function sets the delimiter length for the specified UART in LIN mode.

Parameters

base	is the base address of the UART port.
length	is the delimiter length to set, must be one of: UART_LIN_DELIM_LEN1BIT : 1 bit delimiter length UART_LIN_DELIM_LEN2BIT : 2 bit delimiter length UART_LIN_DELIM_LEN3BIT : 3 bit delimiter length UART_LIN_DELIM_LEN4BIT : 4 bit delimiter length

See also: UARTEnableLIN()

Returns: None

References ASSERT, UART_LIN_DELIM_LEN1BIT, UART_LIN_DELIM_LEN2BIT, UART_LIN_DELIM_LEN3BIT, and UART_LIN_DELIM_LEN4BIT.

Referenced by UARTDisableLINDormant().

§ UARTEnableLINBreakSync()

__STATIC_INLINE void UARTEnableLINBreakSync ( uint32_t base )

Enables sending Break/Sync field for UART in LIN mode.

This function enables sending Break/Sync field for the specified UART in LIN mode.

Parameters

base	is the base address of the UART port.

See also: UARTEnableLIN()

Returns: None

§ UARTDisableLINBreakSync()

__STATIC_INLINE void UARTDisableLINBreakSync ( uint32_t base )

Disables sending Break/Sync field for UART in LIN mode.

This function disables sending Break/Sync field for the specified UART in LIN mode.

Parameters

base	is the base address of the UART port.

See also: UARTEnableLIN()

Returns: None

Macros

Functions

Detailed Description

Macro Definition Documentation

§ UART_INT_EOT

§ UART_INT_OE

§ UART_INT_BE

§ UART_INT_PE

§ UART_INT_FE

§ UART_INT_RT

§ UART_INT_RX

§ UART_INT_TX

§ UART_INT_CTS

§ UART_INT_TXDMADONE

§ UART_INT_RXDMADONE

§ UART_INT_LINBRK

§ UART_INT_LINBRKTOE

§ UART_INT_LINSYNCTOE

§ UART_CONFIG_WLEN_MASK

§ UART_CONFIG_WLEN_8

§ UART_CONFIG_WLEN_7

§ UART_CONFIG_WLEN_6

§ UART_CONFIG_WLEN_5

§ UART_CONFIG_STOP_MASK

§ UART_CONFIG_STOP_ONE

§ UART_CONFIG_STOP_TWO

§ UART_CONFIG_PAR_MASK

§ UART_CONFIG_PAR_NONE

§ UART_CONFIG_PAR_EVEN

§ UART_CONFIG_PAR_ODD

§ UART_CONFIG_PAR_ONE

§ UART_CONFIG_PAR_ZERO

§ UART_FIFO_TX2_8

§ UART_FIFO_TX4_8

§ UART_FIFO_TX6_8

§ UART_FIFO_RX2_8

§ UART_FIFO_RX4_8

§ UART_FIFO_RX6_8

§ UART_DMA_ERR_RXSTOP

§ UART_DMA_TX

§ UART_DMA_RX

§ UART_LIN_DELIM_LEN1BIT

§ UART_LIN_DELIM_LEN2BIT

§ UART_LIN_DELIM_LEN3BIT

§ UART_LIN_DELIM_LEN4BIT

§ UART_RXERROR_OVERRUN

§ UART_RXERROR_BREAK

§ UART_RXERROR_PARITY

§ UART_RXERROR_FRAMING

Function Documentation

§ UARTSetFifoLevel()

§ UARTConfigSetExpClk()

§ UARTDisable()

§ UARTEnableFifo()

§ UARTDisableFIFO()

§ UARTCharAvailable()

§ UARTGetCharNonBlocking()

§ UARTGetChar()

§ UARTSpaceAvailable()

§ UARTPutCharNonBlocking()

§ UARTPutChar()

§ UARTBusy()

§ UARTEnableInt()

§ UARTDisableInt()

§ UARTIntStatus()

§ UARTClearInt()

§ UARTEnableDMA()

§ UARTDisableDMA()

§ UARTGetRxError()

§ UARTClearRxError()

§ UARTEnableCTS()

§ UARTEnableRTS()

§ UARTDisableCTS()

§ UARTDisableRTS()

§ UARTEnableLIN()

§ UARTDisableLIN()

§ UARTEnableLINDormant()

§ UARTDisableLINDormant()

§ UARTSetLINDelimiterLength()

§ UARTEnableLINBreakSync()