HF Interface Wrapper 0.1.0-dev
Embedded C++ hardware abstraction layer
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
hf_stm32_uart_config_t Struct Reference

Platform-agnostic UART configuration for STM32. More...

#include <StmTypes.h>

Public Member Functions

 hf_stm32_uart_config_t () noexcept
 
 hf_stm32_uart_config_t (UART_HandleTypeDef *handle, hf_u32_t timeout_ms=1000) noexcept
 

Public Attributes

UART_HandleTypeDef * hal_handle
 Pointer to CubeMX-generated UART handle.
 
hf_u32_t default_timeout_ms
 Default timeout (ms)
 
bool use_dma_tx
 Use DMA for TX.
 
bool use_dma_rx
 Use DMA for RX.
 
hf_u16_t rx_buffer_size
 Receive ring buffer size.
 
hf_u16_t tx_buffer_size
 Transmit buffer size.
 

Detailed Description

Platform-agnostic UART configuration for STM32.

Constructor & Destructor Documentation

◆ hf_stm32_uart_config_t() [1/2]

hf_stm32_uart_config_t::hf_stm32_uart_config_t ( )
inlinenoexcept

◆ hf_stm32_uart_config_t() [2/2]

hf_stm32_uart_config_t::hf_stm32_uart_config_t ( UART_HandleTypeDef * handle,
hf_u32_t timeout_ms = 1000 )
inlineexplicitnoexcept

Member Data Documentation

◆ default_timeout_ms

hf_u32_t hf_stm32_uart_config_t::default_timeout_ms

Default timeout (ms)

◆ hal_handle

UART_HandleTypeDef* hf_stm32_uart_config_t::hal_handle

Pointer to CubeMX-generated UART handle.

◆ rx_buffer_size

hf_u16_t hf_stm32_uart_config_t::rx_buffer_size

Receive ring buffer size.

◆ tx_buffer_size

hf_u16_t hf_stm32_uart_config_t::tx_buffer_size

Transmit buffer size.

◆ use_dma_rx

bool hf_stm32_uart_config_t::use_dma_rx

Use DMA for RX.

◆ use_dma_tx

bool hf_stm32_uart_config_t::use_dma_tx

Use DMA for TX.

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