Hardware Abstraction Layer (HAL)
mtb_hal_syspm_callback_params_t Struct Reference

Description

Power management callback data object.

This is used to register a new callback handler for power management transitions. The specific power states to register for can be specified as well as any modes

Data Fields

mtb_hal_syspm_callback_t callback
 Callback to run on power state change.
 
mtb_hal_syspm_callback_state_t state
 Power states that should trigger calling the callback.
 
mtb_hal_syspm_callback_mode_t ignore_modes
 Modes to ignore invoking the callback for. More...
 
void * arg
 Argument value to provide to the callback.
 

Field Documentation

◆ callback

mtb_hal_syspm_callback_t mtb_hal_syspm_callback_params_t::callback

Callback to run on power state change.

◆ state

mtb_hal_syspm_callback_state_t mtb_hal_syspm_callback_params_t::state

Power states that should trigger calling the callback.

◆ ignore_modes

mtb_hal_syspm_callback_mode_t mtb_hal_syspm_callback_params_t::ignore_modes

Modes to ignore invoking the callback for.

Multiple mtb_hal_syspm_callback_mode_t values can be ored together.

◆ arg

void* mtb_hal_syspm_callback_params_t::arg

Argument value to provide to the callback.