Struct SYN_UART¶

UART driver handle. More...

#include <syn_uart.h>

Public Attributes¶

Type	Name
bool	initialized
SYN_UARTInstance	instance
uint8_t	rx_buf
SYN_RingBuf	rx_rb
uint8_t	tx_buf
SYN_RingBuf	tx_rb
bool	use_dma

Detailed Description¶

The user allocates this struct (stack or static) and passes it to syn_uart_init() or syn_uart_init_config(). The backing buffers are embedded so no dynamic allocation is needed.

Public Attributes Documentation¶

variable initialized¶

bool SYN_UART::initialized;

Initialization flag status

variable instance¶

SYN_UARTInstance SYN_UART::instance;

Hardware UART peripheral index

variable rx_buf¶

uint8_t SYN_UART::rx_buf[SYN_UART_RX_BUF_SIZE];

Physical storage memory for RX ring buffer

variable rx_rb¶

SYN_RingBuf SYN_UART::rx_rb;

Receive ring buffer control block

variable tx_buf¶

uint8_t SYN_UART::tx_buf[SYN_UART_TX_BUF_SIZE];

Physical storage memory for TX ring buffer

variable tx_rb¶

SYN_RingBuf SYN_UART::tx_rb;

Transmit ring buffer control block

variable use_dma¶

bool SYN_UART::use_dma;

Per-instance DMA enablement flag

The documentation for this class was generated from the following file src/syntropic/drivers/syn_uart.h