Power Profiles Framework Interface. More...

Data Structures
struct	sf_power_profiles_v2_callback_args_t

struct	sf_power_profiles_v2_ctrl_t

struct	sf_power_profiles_v2_cfg_t

struct	sf_power_profiles_v2_run_cfg_t

struct	sf_power_profiles_v2_low_power_cfg_t

struct	sf_power_profiles_v2_api_t

struct	sf_power_profiles_v2_instance_t

Macros
#define	SF_POWER_PROFILES_V2_API_VERSION_MAJOR (3U)

Enumerations
enum	sf_power_profiles_v2_event_t { SF_POWER_PROFILES_V2_EVENT_PRE_LOW_POWER, SF_POWER_PROFILES_V2_EVENT_POST_LOW_POWER }

Detailed Description

Power Profiles Framework Interface.

Summary

This framework allows an application to apply power profiles at runtime. There are 2 types of profiles: Run and Low Power. Applying a Run profile will change things like the system clock and IOPORT settings. The MCU will continue to run during this process and will not be put into a low power mode. Applying a Low Power profile will put the MCU into a low power mode. Which low power mode is used is specified by the LPMv2 instance used. IOPORT settings can also be specified which will be applied before entering the low power mode and after waking up.

The Deep Software Standby low power mode, available on some MCUs, will reset the MCU when the woken up. In this case the callback will not be called and the IOPORT configuration will not be applied after waking up.

This framework can be used with, or without, an RTOS.

Macro Definition Documentation

◆ SF_POWER_PROFILES_V2_API_VERSION_MAJOR

#define SF_POWER_PROFILES_V2_API_VERSION_MAJOR (3U)

Version of the API defined in this file

Enumeration Type Documentation

◆ sf_power_profiles_v2_event_t

enum sf_power_profiles_v2_event_t

Options for the callback events.

Enumerator
SF_POWER_PROFILES_V2_EVENT_PRE_LOW_POWER	Callback just before entering low power mode.
SF_POWER_PROFILES_V2_EVENT_POST_LOW_POWER	Callback just after exiting the low power mode.

Data Structures