Universal asynchronous receiver/transmitter (UART0/UART1) HW driver header file. More...

#include <neorv32.h>
#include <stdint.h>
#include <stdarg.h>

Data Structures
struct	neorv32_uart_t

Macros
UART aliases for easy access
#define	neorv32_uart0_available() neorv32_uart_available(NEORV32_UART0)

#define	neorv32_uart0_get_rx_fifo_depth() neorv32_uart_get_rx_fifo_depth(NEORV32_UART0)

#define	neorv32_uart0_get_tx_fifo_depth() neorv32_uart_get_tx_fifo_depth(NEORV32_UART0)

#define	neorv32_uart0_setup(baudrate, irq_mask) neorv32_uart_setup(NEORV32_UART0, baudrate, irq_mask)

#define	neorv32_uart0_disable() neorv32_uart_disable(NEORV32_UART0)

#define	neorv32_uart0_enable() neorv32_uart_enable(NEORV32_UART0)

#define	neorv32_uart0_rtscts_disable() neorv32_uart_rtscts_disable(NEORV32_UART0)

#define	neorv32_uart0_rtscts_enable() neorv32_uart_rtscts_enable(NEORV32_UART0)

#define	neorv32_uart0_putc(c) neorv32_uart_putc(NEORV32_UART0, c)

#define	neorv32_uart0_tx_busy() neorv32_uart_tx_busy(NEORV32_UART0)

#define	neorv32_uart0_tx_free() neorv32_uart_tx_free(NEORV32_UART0)

#define	neorv32_uart0_tx_put(c) neorv32_uart_tx_put(NEORV32_UART0, c)

#define	neorv32_uart0_getc() neorv32_uart_getc(NEORV32_UART0)

#define	neorv32_uart0_char_received() neorv32_uart_char_received(NEORV32_UART0)

#define	neorv32_uart0_char_received_get() neorv32_uart_char_received_get(NEORV32_UART0)

#define	neorv32_uart0_puts(s) neorv32_uart_puts(NEORV32_UART0, s)

#define	neorv32_uart0_println(s) neorv32_uart_println(NEORV32_UART0, s)

#define	neorv32_uart0_printf(...) neorv32_uart_printf(NEORV32_UART0, __VA_ARGS__)

#define	neorv32_uart0_scan(buffer, max_size, echo) neorv32_uart_scan(NEORV32_UART0, buffer, max_size, echo)

#define	neorv32_uart1_available() neorv32_uart_available(NEORV32_UART1)

#define	neorv32_uart1_get_rx_fifo_depth() neorv32_uart_get_rx_fifo_depth(NEORV32_UART1)

#define	neorv32_uart1_get_tx_fifo_depth() neorv32_uart_get_tx_fifo_depth(NEORV32_UART1)

#define	neorv32_uart1_setup(baudrate, irq_mask) neorv32_uart_setup(NEORV32_UART1, baudrate, irq_mask)

#define	neorv32_uart1_disable() neorv32_uart_disable(NEORV32_UART1)

#define	neorv32_uart1_enable() neorv32_uart_enable(NEORV32_UART1)

#define	neorv32_uart1_rtscts_disable() neorv32_uart_rtscts_disable(NEORV32_UART1)

#define	neorv32_uart1_rtscts_enable() neorv32_uart_rtscts_enable(NEORV32_UART1)

#define	neorv32_uart1_putc(c) neorv32_uart_putc(NEORV32_UART1, c)

#define	neorv32_uart1_tx_busy() neorv32_uart_tx_busy(NEORV32_UART1)

#define	neorv32_uart1_tx_free() neorv32_uart_tx_free(NEORV32_UART1)

#define	neorv32_uart1_tx_put(c) neorv32_uart_tx_put(NEORV32_UART1, c)

#define	neorv32_uart1_getc() neorv32_uart_getc(NEORV32_UART1)

#define	neorv32_uart1_char_received() neorv32_uart_char_received(NEORV32_UART1)

#define	neorv32_uart1_char_received_get() neorv32_uart_char_received_get(NEORV32_UART1)

#define	neorv32_uart1_puts(s) neorv32_uart_puts(NEORV32_UART1, s)

#define	neorv32_uart1_println(s) neorv32_uart_println(NEORV32_UART1, s)

#define	neorv32_uart1_printf(...) neorv32_uart_printf(NEORV32_UART1, __VA_ARGS__)

#define	neorv32_uart1_scan(buffer, max_size, echo) neorv32_uart_scan(NEORV32_UART1, buffer, max_size, echo)

Functions
Prototypes
int	neorv32_uart_available (neorv32_uart_t *UARTx)

int	neorv32_uart_get_rx_fifo_depth (neorv32_uart_t *UARTx)

int	neorv32_uart_get_tx_fifo_depth (neorv32_uart_t *UARTx)

void	neorv32_uart_setup (neorv32_uart_t *UARTx, uint32_t baudrate, uint32_t irq_mask)

void	neorv32_uart_enable (neorv32_uart_t *UARTx)

void	neorv32_uart_disable (neorv32_uart_t *UARTx)

void	neorv32_uart_rtscts_enable (neorv32_uart_t *UARTx)

void	neorv32_uart_rtscts_disable (neorv32_uart_t *UARTx)

void	neorv32_uart_putc (neorv32_uart_t *UARTx, char c)

int	neorv32_uart_tx_busy (neorv32_uart_t *UARTx)

int	neorv32_uart_tx_free (neorv32_uart_t *UARTx)

void	neorv32_uart_tx_put (neorv32_uart_t *UARTx, char c)

char	neorv32_uart_getc (neorv32_uart_t *UARTx)

int	neorv32_uart_char_received (neorv32_uart_t *UARTx)

char	neorv32_uart_char_received_get (neorv32_uart_t *UARTx)

void	neorv32_uart_puts (neorv32_uart_t UARTx, const char s)

void	neorv32_uart_println (neorv32_uart_t UARTx, const char s)

void	neorv32_uart_vprintf (neorv32_uart_t UARTx, const char format, va_list args)

void	neorv32_uart_printf (neorv32_uart_t UARTx, const char format,...)

int	neorv32_uart_scan (neorv32_uart_t UARTx, char buffer, int max_size, int echo)

IO Device: Primary/Secondary Universal Asynchronous Receiver and Transmitter (UART0 / UART1)
#define	NEORV32_UART0 ((neorv32_uart_t*) (NEORV32_UART0_BASE))

#define	NEORV32_UART1 ((neorv32_uart_t*) (NEORV32_UART1_BASE))

enum	NEORV32_UART_CTRL_enum { UART_CTRL_EN = 0 , UART_CTRL_SIM_MODE = 1 , UART_CTRL_HWFC_EN = 2 , UART_CTRL_PRSC_LSB = 3 , UART_CTRL_PRSC_MSB = 5 , UART_CTRL_BAUD_LSB = 6 , UART_CTRL_BAUD_MSB = 15 , UART_CTRL_RX_NEMPTY = 16 , UART_CTRL_RX_FULL = 17 , UART_CTRL_TX_EMPTY = 18 , UART_CTRL_TX_NFULL = 19 , UART_CTRL_IRQ_RX_NEMPTY = 20 , UART_CTRL_IRQ_RX_FULL = 21 , UART_CTRL_IRQ_TX_EMPTY = 22 , UART_CTRL_IRQ_TX_NFULL = 23 , UART_CTRL_RX_OVER = 30 , UART_CTRL_TX_BUSY = 31 }

enum	NEORV32_UART_DATA_enum { UART_DATA_RTX_LSB = 0 , UART_DATA_RTX_MSB = 7 , UART_DATA_RX_FIFO_SIZE_LSB = 8 , UART_DATA_RX_FIFO_SIZE_MSB = 11 , UART_DATA_TX_FIFO_SIZE_LSB = 12 , UART_DATA_TX_FIFO_SIZE_MSB = 15 }

Detailed Description

Universal asynchronous receiver/transmitter (UART0/UART1) HW driver header file.

Macro Definition Documentation

◆ NEORV32_UART0

#define NEORV32_UART0 ((neorv32_uart_t*) (NEORV32_UART0_BASE))

UART0 module hardware handle (neorv32_uart_t)

◆ NEORV32_UART1

#define NEORV32_UART1 ((neorv32_uart_t*) (NEORV32_UART1_BASE))

UART1 module hardware handle (neorv32_uart_t)

Enumeration Type Documentation

◆ NEORV32_UART_CTRL_enum

enum NEORV32_UART_CTRL_enum

UART control register bits

Enumerator
UART_CTRL_EN	UART control register(0) (r/w): UART global enable
UART_CTRL_SIM_MODE	UART control register(1) (r/w): Simulation output override enable
UART_CTRL_HWFC_EN	UART control register(2) (r/w): Enable RTS/CTS hardware flow-control
UART_CTRL_PRSC_LSB	UART control register(3) (r/w): clock prescaler select, bit 0 (LSB)
UART_CTRL_PRSC_MSB	UART control register(5) (r/w): clock prescaler select, bit 2 (MSB)
UART_CTRL_BAUD_LSB	UART control register(6) (r/w): BAUD rate divisor, bit 0 (LSB)
UART_CTRL_BAUD_MSB	UART control register(15) (r/w): BAUD rate divisor, bit 9 (MSB)
UART_CTRL_RX_NEMPTY	UART control register(16) (r/-): RX FIFO not empty
UART_CTRL_RX_FULL	UART control register(17) (r/-): RX FIFO full
UART_CTRL_TX_EMPTY	UART control register(18) (r/-): TX FIFO empty
UART_CTRL_TX_NFULL	UART control register(19) (r/-): TX FIFO not full
UART_CTRL_IRQ_RX_NEMPTY	UART control register(20) (r/w): Fire IRQ if RX FIFO not empty
UART_CTRL_IRQ_RX_FULL	UART control register(21) (r/w): Fire IRQ if RX FIFO full
UART_CTRL_IRQ_TX_EMPTY	UART control register(22) (r/w): Fire IRQ if TX FIFO empty
UART_CTRL_IRQ_TX_NFULL	UART control register(23) (r/w): Fire IRQ if TX FIFO not full
UART_CTRL_RX_OVER	UART control register(30) (r/-): RX FIFO overflow
UART_CTRL_TX_BUSY	UART control register(31) (r/-): Transmitter busy or TX FIFO not empty

◆ NEORV32_UART_DATA_enum

enum NEORV32_UART_DATA_enum

UART data register bits

Enumerator
UART_DATA_RTX_LSB	UART data register(0) (r/w): UART receive/transmit data, LSB
UART_DATA_RTX_MSB	UART data register(7) (r/w): UART receive/transmit data, MSB
UART_DATA_RX_FIFO_SIZE_LSB	UART data register(8) (r/-): log2(RX FIFO size), LSB
UART_DATA_RX_FIFO_SIZE_MSB	UART data register(11) (r/-): log2(RX FIFO size), MSB
UART_DATA_TX_FIFO_SIZE_LSB	UART data register(12) (r/-): log2(RX FIFO size), LSB
UART_DATA_TX_FIFO_SIZE_MSB	UART data register(15) (r/-): log2(RX FIFO size), MSB

Function Documentation

◆ neorv32_uart_available()

int neorv32_uart_available ( neorv32_uart_t * UARTx )

Issue a warning when semihosting redirection is enabled. Check if UART unit was synthesized.

Parameters

[in,out] Hardware handle to UART register struct, neorv32_uart_t.

Returns: 0 if UART0/1 was not synthesized, non-zero if UART0/1 is available.

◆ neorv32_uart_char_received()

int neorv32_uart_char_received ( neorv32_uart_t * UARTx )

Check if UART has received a char.

Note: This function is non-blocking.; Use neorv32_uart_char_received_get(void) to get the char.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: non-zero when a char has been received, 0 otherwise.

◆ neorv32_uart_char_received_get()

char neorv32_uart_char_received_get ( neorv32_uart_t * UARTx )

Get a received char from UART.

Note: This function is non-blocking.; Should only be used in combination with neorv32_uart_char_received(void).

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: Received char.

◆ neorv32_uart_disable()

void neorv32_uart_disable ( neorv32_uart_t * UARTx )

Disable UART.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

◆ neorv32_uart_enable()

void neorv32_uart_enable ( neorv32_uart_t * UARTx )

Enable UART.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

◆ neorv32_uart_get_rx_fifo_depth()

int neorv32_uart_get_rx_fifo_depth ( neorv32_uart_t * UARTx )

Get UART RX FIFO depth.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: FIFO depth (number of entries)

◆ neorv32_uart_get_tx_fifo_depth()

int neorv32_uart_get_tx_fifo_depth ( neorv32_uart_t * UARTx )

Get UART TX FIFO depth.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: FIFO depth (number of entries)

◆ neorv32_uart_getc()

char neorv32_uart_getc ( neorv32_uart_t * UARTx )

Get char from UART.

Note: This function is blocking.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: Received char.

◆ neorv32_uart_printf()

void neorv32_uart_printf	(	neorv32_uart_t *	UARTx,
		const char *	format,
			...
	)

Custom version of 'printf' printing to UART.

Warning: : This functions only provides a minimal subset of the 'printf' formatting features!

Note: This function is blocking.

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	format	Pointer to format string. See neorv32_uart_vprintf.

◆ neorv32_uart_println()

void neorv32_uart_println	(	neorv32_uart_t *	UARTx,
		const char *	s
	)

Print string (zero-terminated) via UART and append a trailing line break.

Note: This function is blocking.

Warning: "/n" line breaks are automatically converted to "/r/n".

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	s	Pointer to string.

◆ neorv32_uart_putc()

void neorv32_uart_putc	(	neorv32_uart_t *	UARTx,
		char	c
	)

Send single char via UART.

Note: This function is blocking.

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	c	Char to be send.

◆ neorv32_uart_puts()

void neorv32_uart_puts	(	neorv32_uart_t *	UARTx,
		const char *	s
	)

Print string (zero-terminated) via UART.

Note: This function is blocking.; No trailing line break is added; use neorv32_uart_println if you need one (e.g. when composing a single line from several calls).

Warning: "\\n" line breaks are automatically converted to "\\r\\n".

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	s	Pointer to string.

◆ neorv32_uart_rtscts_disable()

void neorv32_uart_rtscts_disable ( neorv32_uart_t * UARTx )

Disable RTS/CTS hardware flow-control.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

◆ neorv32_uart_rtscts_enable()

void neorv32_uart_rtscts_enable ( neorv32_uart_t * UARTx )

Enable RTS/CTS hardware flow-control.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

◆ neorv32_uart_scan()

int neorv32_uart_scan	(	neorv32_uart_t *	UARTx,
		char *	buffer,
		int	max_size,
		int	echo
	)

Simplified custom version of 'scanf' reading from UART.

Note: This function is blocking.

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in,out]	buffer	Pointer to array of chars to store string.
[in]	max_size	Maximum number of chars to sample (including zero-termination).
[in]	echo	Echo UART input when 1.

Returns: Number of chars read.

◆ neorv32_uart_setup()

void neorv32_uart_setup	(	neorv32_uart_t *	UARTx,
		uint32_t	baudrate,
		uint32_t	irq_mask
	)

Reset, configure and enable UART.

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	baudrate	Targeted BAUD rate (e.g. 19200).
[in]	irq_mask	Interrupt configuration bit mask (CTRL's irq_* bits).

◆ neorv32_uart_tx_busy()

int neorv32_uart_tx_busy ( neorv32_uart_t * UARTx )

Check if UART TX is busy (transmitter busy or data left in TX buffer).

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: 0 if idle, non-zero if busy

◆ neorv32_uart_tx_free()

int neorv32_uart_tx_free ( neorv32_uart_t * UARTx )

Check if there is free space in the TX output FIFO.

Parameters

[in,out] UARTx Hardware handle to UART register struct, neorv32_uart_t.

Returns: Zero if TX FIFO is full, non-zero if at least one free entry is left.

◆ neorv32_uart_tx_put()

void neorv32_uart_tx_put	(	neorv32_uart_t *	UARTx,
		char	c
	)

Put char to TX output FIFO.

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	c	Character to be send.

◆ neorv32_uart_vprintf()

void neorv32_uart_vprintf	(	neorv32_uart_t *	UARTx,
		const char *	format,
		va_list	args
	)

Custom version of 'vprintf' printing to UART.

Warning: : This functions only provides a minimal subset of the 'vprintf' formating features!; "/n" line breaks are automatically converted to "/r/n".

Note: This function is blocking.

Parameters

[in,out]	UARTx	Hardware handle to UART register struct, neorv32_uart_t.
[in]	format	Pointer to format string.
[in]	args	A value identifying a variable arguments list.

Data Structures

Macros

Functions

IO Device: Primary/Secondary Universal Asynchronous Receiver and Transmitter (UART0 / UART1)

Detailed Description

Macro Definition Documentation

◆ NEORV32_UART0

◆ NEORV32_UART1

Enumeration Type Documentation

◆ NEORV32_UART_CTRL_enum

◆ NEORV32_UART_DATA_enum

Function Documentation

◆ neorv32_uart_available()

◆ neorv32_uart_char_received()

◆ neorv32_uart_char_received_get()

◆ neorv32_uart_disable()

◆ neorv32_uart_enable()

◆ neorv32_uart_get_rx_fifo_depth()

◆ neorv32_uart_get_tx_fifo_depth()

◆ neorv32_uart_getc()

◆ neorv32_uart_printf()

◆ neorv32_uart_println()

◆ neorv32_uart_putc()

◆ neorv32_uart_puts()

◆ neorv32_uart_rtscts_disable()

◆ neorv32_uart_rtscts_enable()

◆ neorv32_uart_scan()

◆ neorv32_uart_setup()

◆ neorv32_uart_tx_busy()

◆ neorv32_uart_tx_free()

◆ neorv32_uart_tx_put()

◆ neorv32_uart_vprintf()