HF Interface Wrapper 0.1.0-dev
Embedded C++ hardware abstraction layer
Loading...
Searching...
No Matches
EspPwm::ValidationResult Struct Reference

Comprehensive validation result with detailed information. More...

Public Member Functions

 ValidationResult () noexcept
 

Public Attributes

bool is_valid
 Overall validation result.
 
hf_pwm_err_t error_code
 Specific error code if invalid.
 
const char * reason
 Human-readable reason for failure.
 
hf_u8_t max_achievable_resolution
 Maximum resolution for this frequency.
 
hf_u32_t max_achievable_frequency
 Maximum frequency for this resolution.
 
uint64_t required_clock_hz
 Required timer clock frequency.
 
uint64_t available_clock_hz
 Available source clock frequency.
 

Detailed Description

Comprehensive validation result with detailed information.

Constructor & Destructor Documentation

◆ ValidationResult()

EspPwm::ValidationResult::ValidationResult ( )
inlinenoexcept

Member Data Documentation

◆ available_clock_hz

uint64_t EspPwm::ValidationResult::available_clock_hz

Available source clock frequency.

◆ error_code

hf_pwm_err_t EspPwm::ValidationResult::error_code

Specific error code if invalid.

◆ is_valid

bool EspPwm::ValidationResult::is_valid

Overall validation result.

◆ max_achievable_frequency

hf_u32_t EspPwm::ValidationResult::max_achievable_frequency

Maximum frequency for this resolution.

◆ max_achievable_resolution

hf_u8_t EspPwm::ValidationResult::max_achievable_resolution

Maximum resolution for this frequency.

◆ reason

const char* EspPwm::ValidationResult::reason

Human-readable reason for failure.

◆ required_clock_hz

uint64_t EspPwm::ValidationResult::required_clock_hz

Required timer clock frequency.


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