uart_init() function

UART instance. uart0 or uart1

Baudrate of UART in Hz

Get the real hardware UART instance from a UART instance This extra level of abstraction was added to facilitate adding PIO UARTs in the future. It currently does nothing, and costs nothing.

Enable/Disable UART interrupt outputs Enable/Disable the UART's interrupt outputs. An interrupt handler should be installed prior to calling this function.

Determine whether data is waiting in the RX FIFO

Write single character to UART for transmission. This function will block until the entire character has been sent to the UART transmit buffer

Write single character to UART for transmission, with optional CR/LF conversions This function will block until the character has been sent to the UART transmit buffer

Perform custom initialization initialize stdin/stdout over UART and add it to the current set of stdin/stdout drivers

Convert UART instance to hardware instance number

Write to the UART for transmission. This function will block until all the data has been sent to the UART transmit buffer hardware. Note: Serial data transmission will continue until the Tx FIFO and the transmit shift register (not programmer-accessible) are empty. To ensure the UART FIFO has been emptied, you can use uart_tx_wait_blocking()

Write string to UART for transmission, doing any CR/LF conversions This function will block until the entire string has been sent to the UART transmit buffer

Perform custom deinitialization deinitialize stdin/stdout over UART and remove it from the current set of stdin/stdout drivers

Read a single character from the UART This function will block until a character has been read

DeInitialise a UART Disable the UART if it is no longer used. Must be reinitialised before being used again.

Set UART baud rate Set baud rate as close as possible to requested, and return actual rate selected. The UART is paused for around two character periods whilst the settings are changed. Data received during this time may be dropped by the UART. Any characters still in the transmit buffer will be sent using the new updated baud rate. uart_tx_wait_blocking() can be called before this function to ensure all characters at the old baud rate have been sent before the rate is changed. This function should not be called from an interrupt context, and the UART interrupt should be disabled before calling this function.

Set CR/LF conversion on UART

Determine if space is available in the TX FIFO

Return the reset_num_t to use for pacing transfers to/from a particular UART instance

Set UART data format Configure the data format (bits etc) for the UART. The UART is paused for around two character periods whilst the settings are changed. Data received during this time may be dropped by the UART. Any characters still in the transmit buffer will be sent using the new updated data format. uart_tx_wait_blocking() can be called before this function to ensure all characters needing the old format have been sent before the format is changed. This function should not be called from an interrupt context, and the UART interrupt should be disabled before calling this function.

Enable/Disable the FIFOs on specified UART The UART is paused for around two character periods whilst the settings are changed. Data received during this time may be dropped by the UART. Any characters still in the transmit FIFO will be lost if the FIFO is disabled. uart_tx_wait_blocking() can be called before this function to avoid this. This function should not be called from an interrupt context, and the UART interrupt should be disabled when calling this function.

\tag::uart_reset[]

Set UART flow control CTS/RTS

Wait for the UART TX fifo to be drained

Read from the UART This function blocks until len characters have been read from the UART

Return the dreq_num_t to use for pacing transfers to/from a particular UART instance

Assert a break condition on the UART transmission.

Wait for up to a certain number of microseconds for the RX FIFO to be non empty

Test if specific UART is enabled