power_manager_notify_struct_t Struct Reference

Power mode user configuration structure. More...

#include <platform/drivers/inc/power_manager.h>

Data Fields

power_manager_user_config_ttargetPowerConfigPtr
 
uint8_t targetPowerConfigIndex
 
power_manager_policy_t policy
 
power_manager_notify_t notifyType
 

Detailed Description

Power mode user configuration structure.

This structure defines power mode with additional power options. This structure is implementation-defiend. Please refer to actual definition based on the underlying HAL (SMC, MC_ME etc). Applications may define multiple power modes and switch between them. A list of all defined power modes is passed to the Power manager during initialization as an array of references to structures of this type (see POWER_SYS_Init()). Power modes can be switched by calling POWER_SYS_SetMode(), which takes as argument the index of the reqested power mode in the list passed during manager initialization. The power mode currently in use can be retrieved by calling POWER_SYS_GetLastMode(), which provides the index of the current power mode, or by calling POWER_SYS_GetLastModeConfig(), which provides a pointer to the configuration structure of the current power mode. The members of the power mode configuration structure depend on power options available for a specific chip, and includes at least the power mode. The available power modes are chip-specific. See power_manager_modes_t defined in the underlying HAL for a list of all supported modes.

Power notification structure passed to registered callback function

Implements power_manager_notify_struct_t_Class

Definition at line 143 of file power_manager.h.

Field Documentation

Power mode notification type.

Definition at line 148 of file power_manager.h.

Power mode transition policy.

Definition at line 147 of file power_manager.h.

uint8_t targetPowerConfigIndex

Target power configuration index.

Definition at line 146 of file power_manager.h.

power_manager_user_config_t* targetPowerConfigPtr

Pointer to target power configuration

Definition at line 145 of file power_manager.h.


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