hf_i2c_bus_config_t Struct Reference

Platform-agnostic I2C bus configuration for STM32. Users pass their CubeMX-generated I2C_HandleTypeDef* here. More...

#include <StmTypes.h>

Public Member Functions
	hf_i2c_bus_config_t () noexcept
	hf_i2c_bus_config_t (I2C_HandleTypeDef *handle, hf_u32_t timeout_ms=1000, bool dma=false) noexcept

Public Attributes
I2C_HandleTypeDef *	hal_handle
	Pointer to CubeMX-generated I2C handle.
hf_u32_t	default_timeout_ms
	Default timeout for all operations (ms)
bool	use_dma
	Use DMA transfers when available.

Detailed Description

Platform-agnostic I2C bus configuration for STM32. Users pass their CubeMX-generated I2C_HandleTypeDef* here.

Constructor & Destructor Documentation

hf_i2c_bus_config_t() [1/2]

hf_i2c_bus_config_t::hf_i2c_bus_config_t ( )

inlinenoexcept

hf_i2c_bus_config_t() [2/2]

hf_i2c_bus_config_t::hf_i2c_bus_config_t ( I2C_HandleTypeDef *  handle, hf_u32_t  timeout_ms = 1000, bool  dma = false  )

inlineexplicitnoexcept

Member Data Documentation

default_timeout_ms

hf_u32_t hf_i2c_bus_config_t::default_timeout_ms

Default timeout for all operations (ms)

hal_handle

I2C_HandleTypeDef* hf_i2c_bus_config_t::hal_handle

Pointer to CubeMX-generated I2C handle.

use_dma

bool hf_i2c_bus_config_t::use_dma

Use DMA transfers when available.

---

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

• inc/mcu/stm32/StmTypes.h