tr_hal_uart_settings_t Struct Reference

#include <T32CM11_uart.h>

Collaboration diagram for tr_hal_uart_settings_t:

Data Fields
tr_hal_gpio_pin_t	tx_pin
tr_hal_gpio_pin_t	rx_pin
bool	hardware_flow_control_enabled
tr_hal_gpio_pin_t	rts_pin
tr_hal_gpio_pin_t	cts_pin
tr_hal_baud_rate_t	baud_rate
tr_hal_data_bits_t	data_bits
tr_hal_stop_bits_t	stop_bits
tr_hal_parity_t	parity
bool	rx_dma_enabled
bool	tx_dma_enabled
uint8_t *	rx_dma_buffer
uint16_t	rx_dma_buff_length
uint8_t *	raw_tx_buffer
uint16_t	raw_tx_buff_length
tr_hal_uart_receive_callback_t	rx_handler_function
tr_hal_uart_event_callback_t	event_handler_fx
tr_hal_fifo_trigger_t	rx_bytes_before_trigger
bool	enable_chip_interrupts
tr_hal_int_pri_t	interrupt_priority
bool	wake_on_interrupt
tr_hal_clock_t	clock_to_use
bool	run_when_sleeping
tr_hal_baud_rate_t	sleep_baud_rate
tr_hal_clock_t	sleep_clock_to_use

Detailed Description

---

uart settings strut - this is passed to tr_hal_uart_init

this contains protocol settings: baud rate data bits stop bits parity flow control this contains DMA settings for the UART: DMA enabled for receive DMA enabled for transmit initial DMA receive buffer (if DMA is enabled for receive) initial DMA receive buffer length (if DMA is enabled for receive) this contains settings for the user handler function for the UART: do we have a user handler (callback) for when bytes are received if we have a user handler, give a pointer to the function

---

---

uart settings strut - this is passed to tr_hal_uart_init

this contains protocol settings:

• baud rate
  
• data bits
  
• stop bits
  
• parity
  
• flow control
  

this contains DMA settings for the UART:

• DMA enabled for receive
  
• DMA enabled for transmit
  
• initial DMA receive buffer (if DMA is enabled for receive)
  
• initial DMA receive buffer length (if DMA is enabled for receive)
  

this contains settings for the user handler function for the UART:

• do we have a user handler (callback) for when bytes are received
  
• if we have a user handler, give a pointer to the function
  

  ---

Field Documentation

baud_rate

tr_hal_baud_rate_t tr_hal_uart_settings_t::baud_rate

clock_to_use

tr_hal_clock_t tr_hal_uart_settings_t::clock_to_use

cts_pin

tr_hal_gpio_pin_t tr_hal_uart_settings_t::cts_pin

data_bits

tr_hal_data_bits_t tr_hal_uart_settings_t::data_bits

enable_chip_interrupts

bool tr_hal_uart_settings_t::enable_chip_interrupts

event_handler_fx

tr_hal_uart_event_callback_t tr_hal_uart_settings_t::event_handler_fx

hardware_flow_control_enabled

bool tr_hal_uart_settings_t::hardware_flow_control_enabled

interrupt_priority

tr_hal_int_pri_t tr_hal_uart_settings_t::interrupt_priority

parity

tr_hal_parity_t tr_hal_uart_settings_t::parity

raw_tx_buff_length

uint16_t tr_hal_uart_settings_t::raw_tx_buff_length

raw_tx_buffer

uint8_t * tr_hal_uart_settings_t::raw_tx_buffer

rts_pin

tr_hal_gpio_pin_t tr_hal_uart_settings_t::rts_pin

run_when_sleeping

bool tr_hal_uart_settings_t::run_when_sleeping

rx_bytes_before_trigger

tr_hal_fifo_trigger_t tr_hal_uart_settings_t::rx_bytes_before_trigger

rx_dma_buff_length

uint16_t tr_hal_uart_settings_t::rx_dma_buff_length

rx_dma_buffer

uint8_t * tr_hal_uart_settings_t::rx_dma_buffer

rx_dma_enabled

bool tr_hal_uart_settings_t::rx_dma_enabled

rx_handler_function

tr_hal_uart_receive_callback_t tr_hal_uart_settings_t::rx_handler_function

rx_pin

tr_hal_gpio_pin_t tr_hal_uart_settings_t::rx_pin

sleep_baud_rate

tr_hal_baud_rate_t tr_hal_uart_settings_t::sleep_baud_rate

sleep_clock_to_use

tr_hal_clock_t tr_hal_uart_settings_t::sleep_clock_to_use

stop_bits

tr_hal_stop_bits_t tr_hal_uart_settings_t::stop_bits

tx_dma_enabled

bool tr_hal_uart_settings_t::tx_dma_enabled

tx_pin

tr_hal_gpio_pin_t tr_hal_uart_settings_t::tx_pin

wake_on_interrupt

bool tr_hal_uart_settings_t::wake_on_interrupt

---

The documentation for this struct was generated from the following files:

• /sdk/framework/hal/T32CM11/T32CM11_uart.h
• /sdk/framework/hal/T32CZ20/T32CZ20_uart.h