System Power Management States .
More...
|
#define | PM_STATE_INFO_DT_INIT(node_id) |
| Initializer for struct pm_state_info given a DT node identifier with zephyr,power-state compatible.
|
|
#define | PM_STATE_DT_INIT(node_id) |
| Initializer for enum pm_state given a DT node identifier with zephyr,power-state compatible.
|
|
#define | DT_NUM_CPU_POWER_STATES(node_id) |
| Obtain number of CPU power states supported and enabled by the given CPU node identifier.
|
|
#define | PM_STATE_INFO_LIST_FROM_DT_CPU(node_id) |
| Initialize an array of struct pm_state_info with information from all the states present and enabled in the given CPU node identifier.
|
|
#define | PM_STATE_LIST_FROM_DT_CPU(node_id) |
| Initialize an array of struct pm_state with information from all the states present and enabled in the given CPU node identifier.
|
|
System Power Management States .
◆ DT_NUM_CPU_POWER_STATES
#define DT_NUM_CPU_POWER_STATES |
( |
| node_id | ) |
|
#include <zephyr/pm/state.h>
Value:
(0))
#define DT_NODE_HAS_PROP(node_id, prop)
Does a devicetree node have a property?
Definition devicetree.h:3548
#define DT_FOREACH_PROP_ELEM_SEP(node_id, prop, fn, sep)
Invokes fn for each element in the value of property prop with separator.
Definition devicetree.h:3131
#define COND_CODE_1(_flag, _if_1_code, _else_code)
Insert code depending on whether _flag expands to 1 or not.
Definition util_macro.h:195
Obtain number of CPU power states supported and enabled by the given CPU node identifier.
- Parameters
-
node_id | A CPU node identifier. |
- Returns
- Number of supported and enabled CPU power states.
◆ PM_STATE_DT_INIT
#define PM_STATE_DT_INIT |
( |
| node_id | ) |
|
#include <zephyr/pm/state.h>
Value:
#define DT_ENUM_IDX(node_id, prop)
Get a property value's index into its enumeration values.
Definition devicetree.h:869
Initializer for enum pm_state given a DT node identifier with zephyr,power-state compatible.
- Parameters
-
node_id | A node identifier with compatible zephyr,power-state |
◆ PM_STATE_INFO_DT_INIT
#define PM_STATE_INFO_DT_INIT |
( |
| node_id | ) |
|
#include <zephyr/pm/state.h>
Value: { \
.substate_id =
DT_PROP_OR(node_id, substate_id, 0), \
.min_residency_us =
DT_PROP_OR(node_id, min_residency_us, 0), \
.exit_latency_us =
DT_PROP_OR(node_id, exit_latency_us, 0), \
.pm_device_disabled =
DT_PROP(node_id, zephyr_pm_device_disabled), \
}
#define DT_PROP_OR(node_id, prop, default_value)
Like DT_PROP(), but with a fallback to default_value.
Definition devicetree.h:825
#define DT_PROP(node_id, prop)
Get a devicetree property value.
Definition devicetree.h:663
#define PM_STATE_DT_INIT(node_id)
Initializer for enum pm_state given a DT node identifier with zephyr,power-state compatible.
Definition state.h:249
Initializer for struct pm_state_info given a DT node identifier with zephyr,power-state compatible.
- Parameters
-
node_id | A node identifier with compatible zephyr,power-state |
◆ PM_STATE_INFO_LIST_FROM_DT_CPU
#define PM_STATE_INFO_LIST_FROM_DT_CPU |
( |
| node_id | ) |
|
#include <zephyr/pm/state.h>
Value: { \
Z_PM_STATE_INFO_FROM_DT_CPU, (), node_id) \
}
#define DT_PROP_LEN_OR(node_id, prop, default_value)
Like DT_PROP_LEN(), but with a fallback to default_value.
Definition devicetree.h:713
Initialize an array of struct pm_state_info with information from all the states present and enabled in the given CPU node identifier.
Example devicetree fragment:
cpus {
...
cpu0: cpu@0 {
device_type = "cpu";
...
cpu-power-states = <&state0 &state1>;
};
power-states {
state0: state0 {
compatible = "zephyr,power-state";
power-state-name = "suspend-to-idle";
min-residency-us = <10000>;
exit-latency-us = <100>;
};
state1: state1 {
compatible = "zephyr,power-state";
power-state-name = "suspend-to-ram";
min-residency-us = <50000>;
exit-latency-us = <500>;
zephyr,pm-device-disabled;
};
};
};
Example usage:
#define DT_NODELABEL(label)
Get a node identifier for a node label.
Definition devicetree.h:200
#define PM_STATE_INFO_LIST_FROM_DT_CPU(node_id)
Initialize an array of struct pm_state_info with information from all the states present and enabled ...
Definition state.h:308
Information about a power management state.
Definition state.h:114
- Parameters
-
node_id | A CPU node identifier. |
◆ PM_STATE_LIST_FROM_DT_CPU
#define PM_STATE_LIST_FROM_DT_CPU |
( |
| node_id | ) |
|
#include <zephyr/pm/state.h>
Value: { \
Z_PM_STATE_FROM_DT_CPU, (), node_id) \
}
Initialize an array of struct pm_state with information from all the states present and enabled in the given CPU node identifier.
Example devicetree fragment:
cpus {
...
cpu0: cpu@0 {
device_type = "cpu";
...
cpu-power-states = <&state0 &state1>;
};
power-states {
state0: state0 {
compatible = "zephyr,power-state";
power-state-name = "suspend-to-idle";
min-residency-us = <10000>;
exit-latency-us = <100>;
};
state1: state1 {
compatible = "zephyr,power-state";
power-state-name = "suspend-to-ram";
min-residency-us = <50000>;
exit-latency-us = <500>;
};
};
};
Example usage:
pm_state
Power management state.
Definition state.h:27
#define PM_STATE_LIST_FROM_DT_CPU(node_id)
Initialize an array of struct pm_state with information from all the states present and enabled in th...
Definition state.h:355
- Parameters
-
node_id | A CPU node identifier. |
◆ pm_state
#include <zephyr/pm/state.h>
Power management state.
Enumerator |
---|
PM_STATE_ACTIVE | Runtime active state.
The system is fully powered and active.
- Note
- This state is correlated with ACPI G0/S0 state
|
PM_STATE_RUNTIME_IDLE | Runtime idle state.
Runtime idle is a system sleep state in which all of the cores enter deepest possible idle state and wait for interrupts, no requirements for the devices, leaving them at the states where they are.
- Note
- This state is correlated with ACPI S0ix state
|
PM_STATE_SUSPEND_TO_IDLE | Suspend to idle state.
The system goes through a normal platform suspend where it puts all of the cores in deepest possible idle state and may puts peripherals into low-power states. No operating state is lost (ie. the cpu core does not lose execution context), so the system can go back to where it left off easily enough.
- Note
- This state is correlated with ACPI S1 state
|
PM_STATE_STANDBY | Standby state.
In addition to putting peripherals into low-power states all non-boot CPUs are powered off. It should allow more energy to be saved relative to suspend to idle, but the resume latency will generally be greater than for that state. But it should be the same state with suspend to idle state on uniprocessor system.
- Note
- This state is correlated with ACPI S2 state
|
PM_STATE_SUSPEND_TO_RAM | Suspend to ram state.
This state offers significant energy savings by powering off as much of the system as possible, where memory should be placed into the self-refresh mode to retain its contents. The state of devices and CPUs is saved and held in memory, and it may require some boot- strapping code in ROM to resume the system from it.
- Note
- This state is correlated with ACPI S3 state
|
PM_STATE_SUSPEND_TO_DISK | Suspend to disk state.
This state offers significant energy savings by powering off as much of the system as possible, including the memory. The contents of memory are written to disk or other non-volatile storage, and on resume it's read back into memory with the help of boot-strapping code, restores the system to the same point of execution where it went to suspend to disk.
- Note
- This state is correlated with ACPI S4 state
|
PM_STATE_SOFT_OFF | Soft off state.
This state consumes a minimal amount of power and requires a large latency in order to return to runtime active state. The contents of system(CPU and memory) will not be preserved, so the system will be restarted as if from initial power-up and kernel boot.
- Note
- This state is correlated with ACPI G2/S5 state
|
PM_STATE_COUNT | Number of power management states (internal use)
|
◆ pm_state_cpu_get_all()
#include <zephyr/pm/state.h>
Obtain information about all supported states by a CPU.
- Parameters
-
cpu | CPU index. |
states | Where to store the list of supported states. |
- Returns
- Number of supported states.