Information about a power management state. More...

#include <state.h>

Data Fields
enum pm_state	state

uint8_t	substate_id
	Some platforms have multiple states that map to one Zephyr power state.

uint32_t	min_residency_us
	Minimum residency duration in microseconds.

uint32_t	exit_latency_us
	Worst case latency in microseconds required to exit the idle state.

Detailed Description

Information about a power management state.

Field Documentation

◆ exit_latency_us

uint32_t pm_state_info::exit_latency_us

Worst case latency in microseconds required to exit the idle state.

Note: 0 means that this property is not available for this state.

◆ min_residency_us

uint32_t pm_state_info::min_residency_us

Minimum residency duration in microseconds.

It is the minimum time for a given idle state to be worthwhile energywise.

Note: 0 means that this property is not available for this state.

◆ state

enum pm_state pm_state_info::state

◆ substate_id

uint8_t pm_state_info::substate_id

Some platforms have multiple states that map to one Zephyr power state.

This property allows the platform distinguish them. e.g:

power-states {
   state0: state0 {
           compatible = "zephyr,power-state";
           power-state-name = "suspend-to-idle";
           substate-id = <1>;
           min-residency-us = <10000>;
           exit-latency-us = <100>;
   };
   state1: state1 {
           compatible = "zephyr,power-state";
           power-state-name = "suspend-to-idle";
           substate-id = <2>;
           min-residency-us = <20000>;
           exit-latency-us = <200>;
   };
};

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