Modules
	UART_Registers

Data Structures
struct	mxc_uart_req_t

Typedefs
typedef void(*	mxc_uart_complete_cb_t) (mxc_uart_req_t *req, int result)

typedef void(*	mxc_uart_dma_complete_cb_t) (mxc_uart_req_t *req, int num, int result)

Enumerations
enum	mxc_uart_stop_t

enum	mxc_uart_parity_t

enum	mxc_uart_flow_t

enum	mxc_uart_clock_t

Functions
int	MXC_UART_Init (mxc_uart_regs_t *uart, unsigned int baud, mxc_uart_clock_t clock)

int	MXC_UART_Shutdown (mxc_uart_regs_t *uart)

int	MXC_UART_ReadyForSleep (mxc_uart_regs_t *uart)

int	MXC_UART_SetFrequency (mxc_uart_regs_t *uart, unsigned int baud, mxc_uart_clock_t clock)

int	MXC_UART_GetFrequency (mxc_uart_regs_t *uart)

int	MXC_UART_SetDataSize (mxc_uart_regs_t *uart, int dataSize)

int	MXC_UART_SetStopBits (mxc_uart_regs_t *uart, mxc_uart_stop_t stopBits)

int	MXC_UART_SetParity (mxc_uart_regs_t *uart, mxc_uart_parity_t parity)

int	MXC_UART_SetFlowCtrl (mxc_uart_regs_t *uart, mxc_uart_flow_t flowCtrl, int rtsThreshold)

int	MXC_UART_SetClockSource (mxc_uart_regs_t *uart, mxc_uart_clock_t clock)

mxc_uart_clock_t	MXC_UART_GetClockSource (mxc_uart_regs_t *uart)

int	MXC_UART_GetActive (mxc_uart_regs_t *uart)

int	MXC_UART_AbortTransmission (mxc_uart_regs_t *uart)

int	MXC_UART_ReadCharacterRaw (mxc_uart_regs_t *uart)

int	MXC_UART_WriteCharacterRaw (mxc_uart_regs_t *uart, uint8_t character)

int	MXC_UART_ReadCharacter (mxc_uart_regs_t *uart)

int	MXC_UART_WriteCharacter (mxc_uart_regs_t *uart, uint8_t character)

int	MXC_UART_Read (mxc_uart_regs_t uart, uint8_t buffer, int *len)

int	MXC_UART_Write (mxc_uart_regs_t uart, const uint8_t byte, int *len)

unsigned int	MXC_UART_ReadRXFIFO (mxc_uart_regs_t uart, unsigned char bytes, unsigned int len)

int	MXC_UART_ReadRXFIFODMA (mxc_uart_regs_t uart, unsigned char bytes, unsigned int len, mxc_uart_dma_complete_cb_t callback)

unsigned int	MXC_UART_GetRXFIFOAvailable (mxc_uart_regs_t *uart)

unsigned int	MXC_UART_WriteTXFIFO (mxc_uart_regs_t uart, const unsigned char bytes, unsigned int len)

int	MXC_UART_WriteTXFIFODMA (mxc_uart_regs_t uart, const unsigned char bytes, unsigned int len, mxc_uart_dma_complete_cb_t callback)

unsigned int	MXC_UART_GetTXFIFOAvailable (mxc_uart_regs_t *uart)

int	MXC_UART_ClearRXFIFO (mxc_uart_regs_t *uart)

int	MXC_UART_ClearTXFIFO (mxc_uart_regs_t *uart)

int	MXC_UART_SetRXThreshold (mxc_uart_regs_t *uart, unsigned int numBytes)

unsigned int	MXC_UART_GetRXThreshold (mxc_uart_regs_t *uart)

int	MXC_UART_SetTXThreshold (mxc_uart_regs_t *uart, unsigned int numBytes)

unsigned int	MXC_UART_GetTXThreshold (mxc_uart_regs_t *uart)

unsigned int	MXC_UART_GetFlags (mxc_uart_regs_t *uart)

int	MXC_UART_ClearFlags (mxc_uart_regs_t *uart, unsigned int flags)

int	MXC_UART_EnableInt (mxc_uart_regs_t *uart, unsigned int mask)

int	MXC_UART_DisableInt (mxc_uart_regs_t *uart, unsigned int mask)

unsigned int	MXC_UART_GetStatus (mxc_uart_regs_t *uart)

int	MXC_UART_Transaction (mxc_uart_req_t *req)

int	MXC_UART_TransactionAsync (mxc_uart_req_t *req)

int	MXC_UART_TransactionDMA (mxc_uart_req_t *req)

void	MXC_UART_DMACallback (int ch, int error)

int	MXC_UART_AsyncCallback (mxc_uart_regs_t *uart, int retVal)

int	MXC_UART_AsyncStop (mxc_uart_regs_t *uart)

int	MXC_UART_AbortAsync (mxc_uart_regs_t *uart)

int	MXC_UART_AsyncHandler (mxc_uart_regs_t *uart)

uint32_t	MXC_UART_GetAsyncTXCount (mxc_uart_req_t *req)

uint32_t	MXC_UART_GetAsyncRXCount (mxc_uart_req_t *req)

int	MXC_UART_SetAutoDMAHandlers (mxc_uart_regs_t *uart, bool enable)

int	MXC_UART_SetTXDMAChannel (mxc_uart_regs_t *uart, unsigned int channel)

int	MXC_UART_GetTXDMAChannel (mxc_uart_regs_t *uart)

int	MXC_UART_SetRXDMAChannel (mxc_uart_regs_t *uart, unsigned int channel)

int	MXC_UART_GetRXDMAChannel (mxc_uart_regs_t *uart)

Detailed Description

Data Structure Documentation

◆ _mxc_uart_req_t

struct _mxc_uart_req_t

The information required to perform a complete UART transaction.

Note: This structure is used by blocking, async, and DMA based transactions.; "callback" only needs to be initialized for interrupt driven (Async) and DMA transactions.

Data Fields
mxc_uart_regs_t *	uart

const uint8_t *	txData

uint8_t *	rxData

uint32_t	txLen

uint32_t	rxLen

volatile uint32_t	txCnt

volatile uint32_t	rxCnt

mxc_uart_complete_cb_t	callback

Field Documentation

◆ rxData

uint8_t* rxData

Buffer to store received data For character sizes < 8 bits, pad the MSB of each byte with zeros. For character sizes > 8 bits, use two bytes per character and pad the MSB of the upper byte with zeros

◆ txData

const uint8_t* txData

Buffer containing transmit data. For character sizes < 8 bits, pad the MSB of each byte with zeros. For character sizes > 8 bits, use two bytes per character and pad the MSB of the upper byte with zeros

Typedef Documentation

◆ mxc_uart_complete_cb_t

typedef void(* mxc_uart_complete_cb_t) (mxc_uart_req_t *req, int result)

The callback routine used to indicate the transaction has terminated.

Parameters

req	The details of the transaction.
result	See Error Codes for the list of error codes.

◆ mxc_uart_dma_complete_cb_t

typedef void(* mxc_uart_dma_complete_cb_t) (mxc_uart_req_t *req, int num, int result)

The callback routine used to indicate the transaction has terminated.

Parameters

req	The details of the transaction.
num	The number of characters actually copied
result	See Error Codes for the list of error codes.

Enumeration Type Documentation

◆ mxc_uart_flow_t

enum mxc_uart_flow_t

The list of UART flow control options supported.

Enumerator
MXC_UART_FLOW_DIS	UART Flow Control Disabled.
MXC_UART_FLOW_EN	UART Flow Control Enabled.

◆ mxc_uart_parity_t

enum mxc_uart_parity_t

The list of UART Parity options supported.

Enumerator
MXC_UART_PARITY_DISABLE	UART Parity Disabled.
MXC_UART_PARITY_EVEN_0	UART Parity Even, 0 based.
MXC_UART_PARITY_EVEN_1	UART Parity Even, 1 based.
MXC_UART_PARITY_ODD_0	UART Parity Odd, 0 based.
MXC_UART_PARITY_ODD_1	UART Parity Odd, 1 based.

◆ mxc_uart_stop_t

enum mxc_uart_stop_t

The list of UART stop bit lengths supported.

Enumerator
MXC_UART_STOP_1	UART Stop 1 clock cycle.
MXC_UART_STOP_2	UART Stop 2 clock cycle (1.5 clocks for 5 bit characters)

Function Documentation

◆ MXC_UART_AbortAsync()

int MXC_UART_AbortAsync ( mxc_uart_regs_t * uart )

Abort any asynchronous requests in progress.

Note: Abort any asynchronous requests in progress. Any callbacks associated with the active transaction will be executed to indicate when the transaction has been terminated.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_AbortTransmission()

int MXC_UART_AbortTransmission ( mxc_uart_regs_t * uart )

Aborts an ongoing UART Transmission.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_AsyncCallback()

int MXC_UART_AsyncCallback	(	mxc_uart_regs_t *	uart,
		int	retVal
	)

Async callback.

Parameters

uart	The uart
retVal	The ret value

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_AsyncHandler()

int MXC_UART_AsyncHandler ( mxc_uart_regs_t * uart )

The processing function for asynchronous transactions.

Note: When using the asynchronous functions, the application must call this function periodically. This can be done from within the UART interrupt handler or periodically by the application if UART interrupts are disabled.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_AsyncStop()

int MXC_UART_AsyncStop ( mxc_uart_regs_t * uart )

stop any async callbacks

Parameters

uart The uart

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_ClearFlags()

int MXC_UART_ClearFlags	(	mxc_uart_regs_t *	uart,
		unsigned int	flags
	)

Clears the interrupt flags that are currently set.

Note: These functions should not be used while using non-blocking Transaction Level functions (Async or DMA)

Parameters

uart	Pointer to UART registers (selects the UART block used.)
flags	mask of flags to clear

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_ClearRXFIFO()

int MXC_UART_ClearRXFIFO ( mxc_uart_regs_t * uart )

Removes and discards all bytes currently in the receive FIFO.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_ClearTXFIFO()

int MXC_UART_ClearTXFIFO ( mxc_uart_regs_t * uart )

Removes and discards all bytes currently in the transmit FIFO.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_DisableInt()

int MXC_UART_DisableInt	(	mxc_uart_regs_t *	uart,
		unsigned int	mask
	)

Disables specific interrupts.

Note: These functions should not be used while using non-blocking Transaction Level functions (Async or DMA)

Parameters

uart	Pointer to UART registers (selects the UART block used.)
mask	The interrupts to be disabled

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_DMACallback()

void MXC_UART_DMACallback	(	int	ch,
		int	error
	)

The processing function for DMA transactions.

When using the DMA functions, the application must call this function periodically. This can be done from within the DMA Interrupt Handler.

Parameters

ch	DMA channel
error	Error status

◆ MXC_UART_EnableInt()

int MXC_UART_EnableInt	(	mxc_uart_regs_t *	uart,
		unsigned int	mask
	)

Enables specific interrupts.

Note: These functions should not be used while using non-blocking Transaction Level functions (Async or DMA)

Parameters

uart	Pointer to UART registers (selects the UART block used.)
mask	The interrupts to be enabled

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_GetActive()

int MXC_UART_GetActive ( mxc_uart_regs_t * uart )

Checks the UART Peripheral for an ongoing transmission.

Note: This function is applicable in Master mode only

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: Active/Inactive, see Error Codes for a list of return codes.

◆ MXC_UART_GetAsyncRXCount()

uint32_t MXC_UART_GetAsyncRXCount ( mxc_uart_req_t * req )

Provide RXCount for asynchronous transactions..

Parameters

req	Pointer to UART request structure.

Returns: Returns receive bytes (in FIFO).

◆ MXC_UART_GetAsyncTXCount()

uint32_t MXC_UART_GetAsyncTXCount ( mxc_uart_req_t * req )

Provide TXCount for asynchronous transactions..

Parameters

req	Pointer to UART request structure.

Returns: Returns transmit bytes (in FIFO).

◆ MXC_UART_GetClockSource()

mxc_uart_clock_t MXC_UART_GetClockSource ( mxc_uart_regs_t * uart )

Gets the clock source used for the UART instance.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The selected clock source for the UART instance

◆ MXC_UART_GetFlags()

unsigned int MXC_UART_GetFlags ( mxc_uart_regs_t * uart )

Gets the interrupt flags that are currently set.

Note: These functions should not be used while using non-blocking Transaction Level functions (Async or DMA)

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The interrupt flags

◆ MXC_UART_GetFrequency()

int MXC_UART_GetFrequency ( mxc_uart_regs_t * uart )

Get the frequency of the UART interface.

Note: This function is applicable in Master mode only

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The UART baud rate

◆ MXC_UART_GetRXDMAChannel()

int MXC_UART_GetRXDMAChannel ( mxc_uart_regs_t * uart )

Get the RX (Receive) DMA channel for a UART module.

This function retrieves the currently configured DMA channel for receiving data when is MXC_UART_SetAutoDMAHandlers disabled.

Parameters

uart	Pointer to the UART module's registers.

Returns: The currently configured RX DMA channel.

◆ MXC_UART_GetRXFIFOAvailable()

unsigned int MXC_UART_GetRXFIFOAvailable ( mxc_uart_regs_t * uart )

Get the number of bytes currently available in the receive FIFO.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The number of bytes available.

◆ MXC_UART_GetRXThreshold()

unsigned int MXC_UART_GetRXThreshold ( mxc_uart_regs_t * uart )

Get the current receive threshold level.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The receive threshold value (in bytes).

◆ MXC_UART_GetStatus()

unsigned int MXC_UART_GetStatus ( mxc_uart_regs_t * uart )

Gets the status flags that are currently set.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The status flags

◆ MXC_UART_GetTXDMAChannel()

int MXC_UART_GetTXDMAChannel ( mxc_uart_regs_t * uart )

Get the TX (Transmit) DMA channel for a UART module.

This function retrieves the currently assigned DMA channel for transmitting data when is MXC_UART_SetAutoDMAHandlers disabled.

Parameters

uart	Pointer to the UART module's registers.

Returns: The currently assigned TX DMA channel.

◆ MXC_UART_GetTXFIFOAvailable()

unsigned int MXC_UART_GetTXFIFOAvailable ( mxc_uart_regs_t * uart )

Get the amount of free space available in the transmit FIFO.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The number of bytes available.

◆ MXC_UART_GetTXThreshold()

unsigned int MXC_UART_GetTXThreshold ( mxc_uart_regs_t * uart )

Get the current transmit threshold level.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The transmit threshold value (in bytes).

◆ MXC_UART_Init()

int MXC_UART_Init	(	mxc_uart_regs_t *	uart,
		unsigned int	baud,
		mxc_uart_clock_t	clock
	)

Initialize and enable UART peripheral.

This function initializes everything necessary to call a UART transaction function. Some parameters are set to defaults as follows: UART Data Size - 8 bits UART Stop Bits - 1 bit UART Parity - None UART Flow Control - None

These parameters can be modified after initialization using low level functions

Note: On default this function enables UART peripheral clock. if you wish to manage clock and gpio related things in upper level instead of here. Define MSDK_NO_GPIO_CLK_INIT flag in project.mk file. By this flag this function will remove clock and gpio related codes from file.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
baud	The requested clock frequency. The actual clock frequency will be returned by the function if successful.
clock	Clock source

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_Read()

int MXC_UART_Read	(	mxc_uart_regs_t *	uart,
		uint8_t *	buffer,
		int *	len
	)

Reads the next available character.

Note: This function blocks until len characters are received See MXC_UART_TransactionAsync() for a non-blocking version

Parameters

uart	Pointer to UART registers (selects the UART block used.)
buffer	Buffer to store data in
len	Number of characters

Returns: The character read, otherwise see Error Codes for a list of return codes.

◆ MXC_UART_ReadCharacter()

int MXC_UART_ReadCharacter ( mxc_uart_regs_t * uart )

Reads the next available character.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The character read, otherwise see Error Codes for a list of return codes.

◆ MXC_UART_ReadCharacterRaw()

int MXC_UART_ReadCharacterRaw ( mxc_uart_regs_t * uart )

Reads the next available character. If no character is available, this function will return an error.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: The character read, otherwise see Error Codes for a list of return codes.

◆ MXC_UART_ReadRXFIFO()

unsigned int MXC_UART_ReadRXFIFO	(	mxc_uart_regs_t *	uart,
		unsigned char *	bytes,
		unsigned int	len
	)

Unloads bytes from the receive FIFO.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
bytes	The buffer to read the data into.
len	The number of bytes to read.

Returns: The number of bytes actually read.

◆ MXC_UART_ReadRXFIFODMA()

int MXC_UART_ReadRXFIFODMA	(	mxc_uart_regs_t *	uart,
		unsigned char *	bytes,
		unsigned int	len,
		mxc_uart_dma_complete_cb_t	callback
	)

Unloads bytes from the receive FIFO user DMA for longer reads.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
bytes	The buffer to read the data into.
len	The number of bytes to read.
callback	The function to call when the read is complete

Returns: See Error Codes for a list of return values

◆ MXC_UART_ReadyForSleep()

int MXC_UART_ReadyForSleep ( mxc_uart_regs_t * uart )

Checks if the given UART bus can be placed in sleep more.

Note: This functions checks to see if there are any on-going UART transactions in progress. If there are transactions in progress, the application should wait until the UART bus is free before entering a low-power state.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: E_NO_ERROR if ready, and non-zero if busy or error. See Error Codes for the list of error return codes.

◆ MXC_UART_SetAutoDMAHandlers()

int MXC_UART_SetAutoDMAHandlers	(	mxc_uart_regs_t *	uart,
		bool	enable
	)

Enable or disable automatic DMA interrupt handlers for the UART module.

The MXC_UART_TransactionDMA functions require special interrupt handlers to work.

When "Auto" DMA handlers are enabled, the UART drivers will acquire DMA channels and assign the appropriate handlers automatically. The acquired channels are released after each transaction.

If "Auto" DMA handlers are disabled, the user must acquire DMA channels manually and assign them to the drivers with the MXC_UART_SetTXDMAChannel and MXC_UART_SetRXDMAChannel functions.

Parameters

uart	Pointer to the UART module's registers.
enable	true to enable Auto DMA handlers, false to disable.

Returns: 0 on success, or a non-zero error code on failure.

◆ MXC_UART_SetClockSource()

int MXC_UART_SetClockSource	(	mxc_uart_regs_t *	uart,
		mxc_uart_clock_t	clock
	)

Sets the clock source for the baud rate generator.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
clock	Clock source

Returns: Actual baud rate if successful, otherwise see Error Codes for a list of return codes.

◆ MXC_UART_SetDataSize()

int MXC_UART_SetDataSize	(	mxc_uart_regs_t *	uart,
		int	dataSize
	)

Sets the number of bits per character.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
dataSize	The number of bits per character (5-8 bits/character are valid)

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_SetFlowCtrl()

int MXC_UART_SetFlowCtrl	(	mxc_uart_regs_t *	uart,
		mxc_uart_flow_t	flowCtrl,
		int	rtsThreshold
	)

Sets the flow control used.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
flowCtrl	see UART Flow Control Types for details
rtsThreshold	Number of bytes remaining in the RX FIFO when RTS is asserted

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_SetFrequency()

int MXC_UART_SetFrequency	(	mxc_uart_regs_t *	uart,
		unsigned int	baud,
		mxc_uart_clock_t	clock
	)

Set the frequency of the UART interface.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
baud	The desired baud rate
clock	Clock source

Returns: Negative if error, otherwise actual speed set. See Error Codes for the list of error return codes.

◆ MXC_UART_SetParity()

int MXC_UART_SetParity	(	mxc_uart_regs_t *	uart,
		mxc_uart_parity_t	parity
	)

Sets the type of parity generation used.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
parity	see UART Parity Types for details

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_SetRXDMAChannel()

int MXC_UART_SetRXDMAChannel	(	mxc_uart_regs_t *	uart,
		unsigned int	channel
	)

Set the RX (Receive) DMA channel for a UART module.

This function assigns the DMA channel for receiving data when is MXC_UART_SetAutoDMAHandlers disabled.

Parameters

uart	Pointer to the UART module's registers.
channel	The DMA channel number to be used for MXC_UART_TransactionDMA.

◆ MXC_UART_SetRXThreshold()

int MXC_UART_SetRXThreshold	(	mxc_uart_regs_t *	uart,
		unsigned int	numBytes
	)

Set the receive threshold level.

Note: RX FIFO Receive threshold. Smaller values will cause interrupts to occur more often, but reduce the possibility of losing data because of a FIFO overflow. Larger values will reduce the time required by the ISR, but increase the possibility of data loss. Passing an invalid value will cause the driver to use the value already set in the appropriate register.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
numBytes	The threshold level to set. This value must be between 0 and 8 inclusive.

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_SetStopBits()

int MXC_UART_SetStopBits	(	mxc_uart_regs_t *	uart,
		mxc_uart_stop_t	stopBits
	)

Sets the number of stop bits sent at the end of a character.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
stopBits	The number of stop bits used

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_SetTXDMAChannel()

int MXC_UART_SetTXDMAChannel	(	mxc_uart_regs_t *	uart,
		unsigned int	channel
	)

Set the TX (Transmit) DMA channel for a UART module.

This function assigns the DMA channel for transmitting data when is MXC_UART_SetAutoDMAHandlers disabled.

Parameters

uart	Pointer to the UART module's registers.
channel	The DMA channel number to be used for MXC_UART_TransactionDMA.

◆ MXC_UART_SetTXThreshold()

int MXC_UART_SetTXThreshold	(	mxc_uart_regs_t *	uart,
		unsigned int	numBytes
	)

Set the transmit threshold level.

Note: TX FIFO threshold. Smaller values will cause interrupts to occur more often, but reduce the possibility of terminating a transaction early in master mode, or transmitting invalid data in slave mode. Larger values will reduce the time required by the ISR, but increase the possibility errors occurring. Passing an invalid value will cause the driver to use the value already set in the appropriate register.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
numBytes	The threshold level to set. This value must be between 0 and 8 inclusive.

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_Shutdown()

int MXC_UART_Shutdown ( mxc_uart_regs_t * uart )

Disable and shutdown UART peripheral.

Parameters

uart	Pointer to UART registers (selects the UART block used.)

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_Transaction()

int MXC_UART_Transaction ( mxc_uart_req_t * req )

Performs a blocking UART transaction.

Note: Performs a blocking UART transaction as follows. If tx_len is non-zero, transmit TX data Once tx_len has been sent, if rx_len is non-zero, receive data

Parameters

req	Pointer to details of the transaction

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_TransactionAsync()

int MXC_UART_TransactionAsync ( mxc_uart_req_t * req )

Setup an interrupt-driven UART transaction.

Note: The TX FIFO will be filled with txData if necessary Relevant interrupts will be enabled

Parameters

req	Pointer to details of the transaction

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_TransactionDMA()

int MXC_UART_TransactionDMA ( mxc_uart_req_t * req )

Setup a DMA driven UART transaction.

Note: The TX FIFO will be filled with txData if necessary Relevant interrupts will be enabled The DMA channel indicated by the request will be set up to load/unload the FIFOs with as few interrupt-based events as possible. The channel will be reset and returned to the system at the end of the transaction.

Parameters

req	Pointer to details of the transaction

Returns: See Error Codes for the list of error return codes.

◆ MXC_UART_Write()

int MXC_UART_Write	(	mxc_uart_regs_t *	uart,
		const uint8_t *	byte,
		int *	len
	)

Writes a byte on the UART.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
byte	The buffer of characters to write
len	The number of characters to write

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_WriteCharacter()

int MXC_UART_WriteCharacter	(	mxc_uart_regs_t *	uart,
		uint8_t	character
	)

Writes a character on the UART.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
character	The character to write

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_WriteCharacterRaw()

int MXC_UART_WriteCharacterRaw	(	mxc_uart_regs_t *	uart,
		uint8_t	character
	)

Writes a character on the UART. If the character cannot be written because the transmit FIFO is currently full, this function returns an error.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
character	The character to write

Returns: Success/Fail, see Error Codes for a list of return codes.

◆ MXC_UART_WriteTXFIFO()

unsigned int MXC_UART_WriteTXFIFO	(	mxc_uart_regs_t *	uart,
		const unsigned char *	bytes,
		unsigned int	len
	)

Loads bytes into the transmit FIFO.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
bytes	The buffer containing the bytes to write
len	The number of bytes to write.

Returns: The number of bytes actually written.

◆ MXC_UART_WriteTXFIFODMA()

int MXC_UART_WriteTXFIFODMA	(	mxc_uart_regs_t *	uart,
		const unsigned char *	bytes,
		unsigned int	len,
		mxc_uart_dma_complete_cb_t	callback
	)

Loads bytes into the transmit FIFO using DMA for longer writes.

Parameters

uart	Pointer to UART registers (selects the UART block used.)
bytes	The buffer containing the bytes to write
len	The number of bytes to write.
callback	The function to call when the write is complete

Returns: See Error Codes for a list of return values

Modules

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ _mxc_uart_req_t

Data Fields

Field Documentation

◆ rxData

◆ txData

Typedef Documentation

◆ mxc_uart_complete_cb_t

◆ mxc_uart_dma_complete_cb_t

Enumeration Type Documentation

◆ mxc_uart_flow_t

◆ mxc_uart_parity_t

◆ mxc_uart_stop_t

Function Documentation

◆ MXC_UART_AbortAsync()

◆ MXC_UART_AbortTransmission()

◆ MXC_UART_AsyncCallback()

◆ MXC_UART_AsyncHandler()

◆ MXC_UART_AsyncStop()

◆ MXC_UART_ClearFlags()

◆ MXC_UART_ClearRXFIFO()

◆ MXC_UART_ClearTXFIFO()

◆ MXC_UART_DisableInt()

◆ MXC_UART_DMACallback()

◆ MXC_UART_EnableInt()

◆ MXC_UART_GetActive()

◆ MXC_UART_GetAsyncRXCount()

◆ MXC_UART_GetAsyncTXCount()

◆ MXC_UART_GetClockSource()

◆ MXC_UART_GetFlags()

◆ MXC_UART_GetFrequency()

◆ MXC_UART_GetRXDMAChannel()

◆ MXC_UART_GetRXFIFOAvailable()

◆ MXC_UART_GetRXThreshold()

◆ MXC_UART_GetStatus()

◆ MXC_UART_GetTXDMAChannel()

◆ MXC_UART_GetTXFIFOAvailable()

◆ MXC_UART_GetTXThreshold()

◆ MXC_UART_Init()

◆ MXC_UART_Read()

◆ MXC_UART_ReadCharacter()

◆ MXC_UART_ReadCharacterRaw()

◆ MXC_UART_ReadRXFIFO()

◆ MXC_UART_ReadRXFIFODMA()

◆ MXC_UART_ReadyForSleep()

◆ MXC_UART_SetAutoDMAHandlers()

◆ MXC_UART_SetClockSource()

◆ MXC_UART_SetDataSize()

◆ MXC_UART_SetFlowCtrl()

◆ MXC_UART_SetFrequency()

◆ MXC_UART_SetParity()

◆ MXC_UART_SetRXDMAChannel()

◆ MXC_UART_SetRXThreshold()

◆ MXC_UART_SetStopBits()

◆ MXC_UART_SetTXDMAChannel()

◆ MXC_UART_SetTXThreshold()

◆ MXC_UART_Shutdown()

◆ MXC_UART_Transaction()

◆ MXC_UART_TransactionAsync()

◆ MXC_UART_TransactionDMA()

◆ MXC_UART_Write()

◆ MXC_UART_WriteCharacter()

◆ MXC_UART_WriteCharacterRaw()

◆ MXC_UART_WriteTXFIFO()

◆ MXC_UART_WriteTXFIFODMA()