OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/power/Kconfig

155 lines
4.7 KiB
Plaintext
Raw Normal View History

Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
# Copyright (c) 2014-2015 Wind River Systems, Inc.
# Copyright (c) 2016 Intel Corporation
license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-06 21:08:09 +08:00
# SPDX-License-Identifier: Apache-2.0
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
menu "Power Management"
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config SYS_POWER_MANAGEMENT
bool "System Power management"
select PM
help
This option is deprecated. Please use CONFIG_PM instead.
menuconfig PM
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
bool "System Power management"
select TICKLESS_IDLE
help
This option enables the board to implement extra power management
policies whenever the kernel becomes idle. The kernel informs the
power management subsystem of the number of ticks until the next kernel
timer is due to expire.
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
if PM
config PM_SLEEP_STATES
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
bool "Low Power states"
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
depends on HAS_POWER_STATE_SLEEP_1 || \
HAS_POWER_STATE_SLEEP_2 || \
HAS_POWER_STATE_SLEEP_3
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
help
This option enables the kernel to interface with a power manager
application. This permits the system to enter a custom CPU low power
state when the kernel becomes idle. The low power state could be any of
the CPU low power states supported by the processor. Generally the one
saving most power.
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config PM_DEEP_SLEEP_STATES
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
bool "Deep Sleep states"
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
depends on HAS_POWER_STATE_DEEP_SLEEP_1 || \
HAS_POWER_STATE_DEEP_SLEEP_2 || \
HAS_POWER_STATE_DEEP_SLEEP_3
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
help
This option enables the kernel to interface with a power manager
application. This permits the system to enter a Deep sleep state
supported by the SOC where the system clock is turned off while RAM is
retained. This state would be entered when the kernel becomes idle for
extended periods and would have a high wake latency. Resume would be
from the reset vector same as cold boot. The interface allows
restoration of states that were saved at the time of suspend.
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config PM_STATE_LOCK
power: Rework OS <-> Application interface This commit simplifies OS <-> Application interface controlling power management. In the previous approach application-based PM required overriding sys_suspend() and sys_resume() functions. As these functions actually implemented power state change, in such case application basically had to provide own implementation of all PM-related stuff, which was not portable and hard to maintain. This commit changes this scheme: The sys_suspend() and sys_resume() are now system functions while the application could either use built-in power management policies or provide its own. All details of power mode switching are now handled by the OS. Also, this commit cleans up the Kconfig options related to system-level power management grouping them under common CONFIG_SYS_PM_ prefix. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-04 22:05:23 +08:00
bool "Enable Power State locking capability"
power: Add API's to enable/disable System PM states Add API's to enable/disable System PM states so that an an application can enable/disable system from entering certain Low Power states. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2018-11-05 18:06:04 +08:00
help
power: Rework OS <-> Application interface This commit simplifies OS <-> Application interface controlling power management. In the previous approach application-based PM required overriding sys_suspend() and sys_resume() functions. As these functions actually implemented power state change, in such case application basically had to provide own implementation of all PM-related stuff, which was not portable and hard to maintain. This commit changes this scheme: The sys_suspend() and sys_resume() are now system functions while the application could either use built-in power management policies or provide its own. All details of power mode switching are now handled by the OS. Also, this commit cleans up the Kconfig options related to system-level power management grouping them under common CONFIG_SYS_PM_ prefix. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-04 22:05:23 +08:00
Enable Power Management system state locking capability
power: Add API's to enable/disable System PM states Add API's to enable/disable System PM states so that an an application can enable/disable system from entering certain Low Power states. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2018-11-05 18:06:04 +08:00
if any application wants to temporarily disable certain
power: pm_ctrl: Allow fine-grained power state locking This commit enables fine-grained power state locking. Now, each power state could be independently enabled or disabled. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-01-11 17:53:57 +08:00
Power States while doing any critical work or needs quick
response from hardware resources.
power: Add API's to enable/disable System PM states Add API's to enable/disable System PM states so that an an application can enable/disable system from entering certain Low Power states. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2018-11-05 18:06:04 +08:00
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config PM_DIRECT_FORCE_MODE
power: add system power management direct force mode. Add system power management direct force trigger mode. In this mode application thread can directly put system in sleep or deep sleep mode instead of waiting for idle thread to do it, so that it can reduce latency to enter low power mode. Signed-off-by: Wentong Wu <wentong.wu@intel.com>
2020-01-22 16:36:21 +08:00
bool "Enable system power management direct force trigger mode"
help
Enable system power management direct force trigger mode. In
this mode application thread can directly put system in sleep
or deep sleep mode instead of waiting for idle thread to do
it, so that it can reduce latency to enter low power mode.
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config PM_DEBUG
power: Rework OS <-> Application interface This commit simplifies OS <-> Application interface controlling power management. In the previous approach application-based PM required overriding sys_suspend() and sys_resume() functions. As these functions actually implemented power state change, in such case application basically had to provide own implementation of all PM-related stuff, which was not portable and hard to maintain. This commit changes this scheme: The sys_suspend() and sys_resume() are now system functions while the application could either use built-in power management policies or provide its own. All details of power mode switching are now handled by the OS. Also, this commit cleans up the Kconfig options related to system-level power management grouping them under common CONFIG_SYS_PM_ prefix. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-04 22:05:23 +08:00
bool "Enable System Power Management debug hooks"
power: Add OS Power Management debug hooks Add the necessary PM hooks like Low Power state entry count and residencies for logging and debugging purposes. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2018-10-24 16:24:20 +08:00
help
power: Rework OS <-> Application interface This commit simplifies OS <-> Application interface controlling power management. In the previous approach application-based PM required overriding sys_suspend() and sys_resume() functions. As these functions actually implemented power state change, in such case application basically had to provide own implementation of all PM-related stuff, which was not portable and hard to maintain. This commit changes this scheme: The sys_suspend() and sys_resume() are now system functions while the application could either use built-in power management policies or provide its own. All details of power mode switching are now handled by the OS. Also, this commit cleans up the Kconfig options related to system-level power management grouping them under common CONFIG_SYS_PM_ prefix. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-04 22:05:23 +08:00
Enable System Power Management debugging hooks.
power: Add OS Power Management debug hooks Add the necessary PM hooks like Low Power state entry count and residencies for logging and debugging purposes. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2018-10-24 16:24:20 +08:00
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config PM_DEVICE_IDLE
power: Add device idle power management support Add framework for device Idle Power Management(IPM) for suspending devices based on device idle. This will help in saving power even while system(CPU) is active. The framework uses device_set_power_state() API set the device power state accordingly based on the usage count. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2019-02-28 15:37:58 +08:00
bool "Enable device Idle Power Management"
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
depends on PM_DEVICE
power: Add device idle power management support Add framework for device Idle Power Management(IPM) for suspending devices based on device idle. This will help in saving power even while system(CPU) is active. The framework uses device_set_power_state() API set the device power state accordingly based on the usage count. Signed-off-by: Ramakrishna Pallala <ramakrishna.pallala@intel.com>
2019-02-28 15:37:58 +08:00
select POLL
help
Enable device Idle Power Management to save power.
With device Idle PM enabled, devices can be suspended or
resumed based on the device usage even while the CPU or
system is running.
power: Rework OS <-> Application interface This commit simplifies OS <-> Application interface controlling power management. In the previous approach application-based PM required overriding sys_suspend() and sys_resume() functions. As these functions actually implemented power state change, in such case application basically had to provide own implementation of all PM-related stuff, which was not portable and hard to maintain. This commit changes this scheme: The sys_suspend() and sys_resume() are now system functions while the application could either use built-in power management policies or provide its own. All details of power mode switching are now handled by the OS. Also, this commit cleans up the Kconfig options related to system-level power management grouping them under common CONFIG_SYS_PM_ prefix. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-04 22:05:23 +08:00
source "subsys/power/policy/Kconfig"
logging: Refactor LOG_MODULE_REGISTER and LOG_MODULE_DECLARE macros Changed LOG_MODULE_REGISTER and LOG_MODULE_DECLARE macros to take log level as optional parameter. LOG_MODULE_DECLARE can now also be used in static inline functions in headers. Added LOG_LEVEL_SET macro which is used when instance logging API is used to indicate maximal log level compiled into the file. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2018-09-25 20:58:27 +08:00
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
module = PM
power: Rework OS <-> Application interface This commit simplifies OS <-> Application interface controlling power management. In the previous approach application-based PM required overriding sys_suspend() and sys_resume() functions. As these functions actually implemented power state change, in such case application basically had to provide own implementation of all PM-related stuff, which was not portable and hard to maintain. This commit changes this scheme: The sys_suspend() and sys_resume() are now system functions while the application could either use built-in power management policies or provide its own. All details of power mode switching are now handled by the OS. Also, this commit cleans up the Kconfig options related to system-level power management grouping them under common CONFIG_SYS_PM_ prefix. Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-04 22:05:23 +08:00
module-str = System Power Management
source "subsys/logging/Kconfig.template.log_config"
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
endif # PM
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config PM_DEVICE
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
bool "Device power management"
help
This option enables the device power management interface. The
interface consists of hook functions implemented by device drivers
that get called by the power manager application when the system
is going to suspend state or resuming from suspend state. This allows
device drivers to do any necessary power management operations
like turning off device clocks and peripherals. The device drivers
may also save and restore states in these hook functions.
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
config DEVICE_POWER_MANAGEMENT
bool "Device Power Management"
select PM_DEVICE
help
This option is deprecated, please use CONFIG_PM_DEVICE instead.
power: allow external definition of core devices When try to enable CONFIG_DEVICE_POWER_MANAGEMENT for a board, the #error directive in subsys/power/device.c requires that "MAX_PM_DEVICE" and "core_devices[]" must be defined exactly in that file, or a compile error will come up. For flexibility, this patch move "PM_MAX_DEVICE" to Kconfig and define a weak version of "z_mp_core_devices[]", so any board or SOC can define these varibles in their own module. Signed-off-by: Meng xianglin <xianglinx.meng@intel.com>
2020-09-06 21:45:40 +08:00
config PM_MAX_DEVICES
int "Max number of devices support power management"
power: standarize PM Kconfigs and cleanup - Remove SYS_ prefix - shorten POWER_MANAGEMENT to just PM - DEVICE_POWER_MANAGEMENT -> PM_DEVICE and use PM_ as the prefix for all PM related Kconfigs Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 06:31:40 +08:00
depends on PM_DEVICE
power: allow external definition of core devices When try to enable CONFIG_DEVICE_POWER_MANAGEMENT for a board, the #error directive in subsys/power/device.c requires that "MAX_PM_DEVICE" and "core_devices[]" must be defined exactly in that file, or a compile error will come up. For flexibility, this patch move "PM_MAX_DEVICE" to Kconfig and define a weak version of "z_mp_core_devices[]", so any board or SOC can define these varibles in their own module. Signed-off-by: Meng xianglin <xianglinx.meng@intel.com>
2020-09-06 21:45:40 +08:00
default 15
Kconfig: move power management Kconfig into subsys/power Consolidate all PM related Kconfigs in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-08-23 00:58:49 +08:00
endmenu
power: move kconfigs from arch/ to power/ Move all Kconfigs where they belong and in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:04 +08:00
#
# Hidden PM feature configs which are to be selected by
# individual SoC.
#
config HAS_POWER_STATE_SLEEP_1
bool
help
This option signifies that the target supports the POWER_STATE_SLEEP_1
configuration option.
config HAS_POWER_STATE_SLEEP_2
bool
help
This option signifies that the target supports the POWER_STATE_SLEEP_2
configuration option.
config HAS_POWER_STATE_SLEEP_3
bool
help
This option signifies that the target supports the POWER_STATE_SLEEP_3
configuration option.
config HAS_POWER_STATE_DEEP_SLEEP_1
bool
help
power: remove SYS_ and sys_ prefixes Remove SYS_ and sys_ from all PM related functions and defines. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:30 +08:00
This option signifies that the target supports the POWER_STATE_DEEP_SLEEP_1
power: move kconfigs from arch/ to power/ Move all Kconfigs where they belong and in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:04 +08:00
configuration option.
config HAS_POWER_STATE_DEEP_SLEEP_2
bool
help
power: remove SYS_ and sys_ prefixes Remove SYS_ and sys_ from all PM related functions and defines. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:30 +08:00
This option signifies that the target supports the POWER_STATE_DEEP_SLEEP_2
power: move kconfigs from arch/ to power/ Move all Kconfigs where they belong and in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:04 +08:00
configuration option.
config HAS_POWER_STATE_DEEP_SLEEP_3
bool
help
power: remove SYS_ and sys_ prefixes Remove SYS_ and sys_ from all PM related functions and defines. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:30 +08:00
This option signifies that the target supports the POWER_STATE_DEEP_SLEEP_3
power: move kconfigs from arch/ to power/ Move all Kconfigs where they belong and in one place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-09-02 09:46:04 +08:00
configuration option.