Skip to content

Commit 2ad6478

Browse files
Ramakrishna Pallalanashif
Ramakrishna Pallala
authored and
nashif
committed
subsys: power: Add OS managed Power Management framework
Add support for OS managed Power Management framework for Zephyr under 'subsys/power'. This framework takes care of implementing the _sys_soc_suspend/_sys_soc_resume API's, a PM policy based on SoC Low Power residencies and also provides necessary API's to do devices suspend and resume. Also add necessary changes to support the existing Application managed Power Management framework. Signed-off-by: Ramakrishna Pallala <[email protected]>
1 parent 1301cc6 commit 2ad6478

File tree

9 files changed

+496
-0
lines changed

9 files changed

+496
-0
lines changed

‎kernel/Kconfig.power_mgmt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,29 @@ menuconfig SYS_POWER_MANAGEMENT
1414
timer is due to expire.
1515

1616
if SYS_POWER_MANAGEMENT
17+
choice POWER_MANAGEMENT_CONTROL
18+
prompt "Power Management Control"
19+
default PM_CONTROL_APP
20+
help
21+
Select the Application managed or OS managed power saving
22+
mechanism.
23+
24+
config PM_CONTROL_APP
25+
bool
26+
prompt "Handled at Application level"
27+
help
28+
This option enbles the Application to handle all the Power
29+
Management flows for the platform.
30+
31+
config PM_CONTROL_OS
32+
bool
33+
prompt "Handle at OS level"
34+
help
35+
This option allows the OS to handle all the Power
36+
Management flows for the platform.
37+
38+
endchoice # POWER_MANAGEMENT_CONTROL
39+
1740
config SYS_POWER_LOW_POWER_STATE
1841
bool "Low power state"
1942
depends on SYS_POWER_LOW_POWER_STATE_SUPPORTED

‎subsys/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ add_subdirectory_ifdef(CONFIG_USB usb)
1414
add_subdirectory(random)
1515
add_subdirectory(storage)
1616
add_subdirectory_ifdef(CONFIG_SETTINGS settings)
17+
add_subdirectory_ifdef(CONFIG_PM_CONTROL_OS power)

‎subsys/Kconfig‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@ source "subsys/storage/Kconfig"
3434
source "subsys/settings/Kconfig"
3535

3636
source "subsys/app_memory/Kconfig"
37+
38+
source "subsys/power/Kconfig"

‎subsys/power/CMakeLists.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
zephyr_sources(
2+
power.c
3+
policy.c
4+
device.c
5+
)

‎subsys/power/Kconfig‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
2+
if PM_CONTROL_OS
3+
menu "OS Power Management"
4+
5+
if SYS_POWER_LOW_POWER_STATE
6+
config PM_CONTROL_OS_LPS
7+
bool "Platform supports LPS"
8+
help
9+
Select this option if SoC support LPS state.
10+
11+
if PM_CONTROL_OS_LPS
12+
config PM_LPS_MIN_RES
13+
int "LPS minimum residency"
14+
default 5
15+
help
16+
Minimum residency in ticks to enter LPS state.
17+
endif
18+
19+
config PM_CONTROL_OS_LPS_1
20+
bool "Platform supports LPS_1"
21+
help
22+
Select this option if SoC support LPS_1 state.
23+
24+
if PM_CONTROL_OS_LPS_1
25+
config PM_LPS_1_MIN_RES
26+
int "LPS_1 minimum residency"
27+
default 10
28+
help
29+
Minimum residency in ticks to enter LPS_1 state.
30+
endif
31+
32+
config PM_CONTROL_OS_LPS_2
33+
bool "Platform supports LPS_2"
34+
help
35+
Select this option if SoC support LPS_2 state.
36+
37+
if PM_CONTROL_OS_LPS_2
38+
config PM_LPS_2_MIN_RES
39+
int "LPS_2 minimum residency"
40+
default 30
41+
help
42+
Minimum residency in ticks to enter LPS_2 state.
43+
endif
44+
endif # SYS_POWER_LOW_POWER_STATE
45+
46+
if SYS_POWER_DEEP_SLEEP
47+
config PM_CONTROL_OS_DEEP_SLEEP
48+
bool "Platform supports DEEP_SLEEP"
49+
help
50+
Select this option if SoC support DEEP_SLEEP state.
51+
52+
if PM_CONTROL_OS_DEEP_SLEEP
53+
config PM_DEEP_SLEEP_MIN_RES
54+
int "DEEP_SLEEP minimum residency"
55+
default 60
56+
help
57+
Minimum residency in ticks to enter DEEP_SLEEP state.
58+
endif
59+
60+
config PM_CONTROL_OS_DEEP_SLEEP_1
61+
bool "Platform supports DEEP_SLEEP_1"
62+
help
63+
Select this option if SoC support DEEP_SLEEP_1 state.
64+
65+
if PM_CONTROL_OS_DEEP_SLEEP_1
66+
config PM_DEEP_SLEEP_1_MIN_RES
67+
int "DEEP_SLEEP_1 minimum residency"
68+
default 90
69+
help
70+
Minimum residency in ticks to enter DEEP_SLEEP_1 state.
71+
endif
72+
73+
config PM_CONTROL_OS_DEEP_SLEEP_2
74+
bool "Platform supports DEEP_SLEEP_2"
75+
help
76+
Select this option if SoC support DEEP_SLEEP_2 state.
77+
78+
if PM_CONTROL_OS_DEEP_SLEEP_2
79+
config PM_DEEP_SLEEP_2_MIN_RES
80+
int "DEEP_SLEEP_2 minimum residency"
81+
default 120
82+
help
83+
Minimum residency in ticks to enter DEEP_SLEEP_2 state.
84+
endif
85+
endif # PM_CONTROL_OS_DEEP_SLEEP
86+
87+
endmenu
88+
endif # PM_CONTROL_OS

‎subsys/power/device.c‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
/*
2+
* Copyright (c) 2018 Intel Corporation.
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
#include <zephyr.h>
8+
#include <kernel.h>
9+
#include <string.h>
10+
#include <soc.h>
11+
#include <device.h>
12+
#include "pm_policy.h"
13+
14+
#define LOG_MODULE_NAME power
15+
#define LOG_LEVEL CONFIG_PM_LOG_LEVEL /* From power module Kconfig */
16+
#include <logging/log.h>
17+
LOG_MODULE_DECLARE();
18+
19+
/*
20+
* FIXME: Remove the conditional inclusion of
21+
* core_devices array once we enble the capability
22+
* to build the device list based on devices power
23+
* and clock domain dependencies.
24+
*/
25+
#ifdef CONFIG_SOC_SERIES_NRF52X
26+
#define MAX_PM_DEVICES 15
27+
#define NUM_CORE_DEVICES 4
28+
#define MAX_DEV_NAME_LEN 16
29+
static const char core_devices[NUM_CORE_DEVICES][MAX_DEV_NAME_LEN] = {
30+
"clk_k32src",
31+
"clk_m16src",
32+
"sys_clock",
33+
"UART_0",
34+
};
35+
#else
36+
#error "Add SoC's core devices list for PM"
37+
#endif
38+
39+
/*
40+
* Ordered list to store devices on which
41+
* device power policies would be executed.
42+
*/
43+
static int device_ordered_list[MAX_PM_DEVICES];
44+
static int device_retval[MAX_PM_DEVICES];
45+
static struct device *pm_device_list;
46+
static int device_count;
47+
48+
int sys_pm_suspend_devices(void)
49+
{
50+
for (int i = device_count - 1; i >= 0; i--) {
51+
int idx = device_ordered_list[i];
52+
53+
/* TODO: Improve the logic by checking device status
54+
* and set the device states accordingly.
55+
*/
56+
device_retval[i] = device_set_power_state(&pm_device_list[idx],
57+
DEVICE_PM_SUSPEND_STATE);
58+
if (device_retval[i]) {
59+
LOG_ERR("%s suspend operation failed\n",
60+
pm_device_list[idx].config->name);
61+
return device_retval[i];
62+
}
63+
}
64+
65+
return 0;
66+
}
67+
68+
void sys_pm_resume_devices(void)
69+
{
70+
int i;
71+
72+
for (i = 0; i < device_count; i++) {
73+
if (!device_retval[i]) {
74+
int idx = device_ordered_list[i];
75+
76+
device_set_power_state(&pm_device_list[idx],
77+
DEVICE_PM_ACTIVE_STATE);
78+
}
79+
}
80+
}
81+
82+
void sys_pm_create_device_list(void)
83+
{
84+
int count;
85+
int i, j;
86+
bool is_core_dev;
87+
88+
/*
89+
* Create an ordered list of devices that will be suspended.
90+
* Ordering should be done based on dependencies. Devices
91+
* in the beginning of the list will be resumed first.
92+
*/
93+
device_list_get(&pm_device_list, &count);
94+
95+
/* Reserve for 32KHz, 16MHz, system clock, etc... */
96+
device_count = NUM_CORE_DEVICES;
97+
98+
for (i = 0; (i < count) && (device_count < MAX_PM_DEVICES); i++) {
99+
100+
/* Check if the device is core device */
101+
for (j = 0, is_core_dev = false; j < NUM_CORE_DEVICES; j++) {
102+
if (!strcmp(pm_device_list[i].config->name,
103+
&core_devices[j][0])) {
104+
is_core_dev = true;
105+
break;
106+
}
107+
}
108+
109+
if (is_core_dev) {
110+
device_ordered_list[j] = i;
111+
} else {
112+
device_ordered_list[device_count++] = i;
113+
}
114+
}
115+
}

‎subsys/power/pm_policy.h‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* Copyright (c) 2018 Intel Corporation.
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
#ifndef _PM_POLICY_H_
8+
#define _PM_POLICY_H_
9+
10+
#include <power.h>
11+
#include <soc_power.h>
12+
13+
#ifdef __cplusplus
14+
extern "C" {
15+
#endif
16+
17+
/**
18+
* @brief Function to create device PM list
19+
*/
20+
extern void sys_pm_create_device_list(void);
21+
22+
/**
23+
* @brief Function to suspend the devices in PM device list
24+
*/
25+
extern int sys_pm_suspend_devices(void);
26+
27+
/**
28+
* @brief Function to resume the devices in PM device list
29+
*/
30+
extern void sys_pm_resume_devices(void);
31+
32+
/**
33+
* @brief Function to get the next PM state based on the ticks
34+
*/
35+
extern int sys_pm_policy_next_state(s32_t ticks, enum power_states *state);
36+
37+
/**
38+
* @brief Application defined function for Lower Power entry
39+
*
40+
* Application defined function for doing any target specific operations
41+
* for low power entry.
42+
*/
43+
extern void sys_pm_notify_lps_entry(enum power_states state);
44+
45+
/**
46+
* @brief Application defined function for Lower Power exit
47+
*
48+
* Application defined function for doing any target specific operations
49+
* for low power exit.
50+
*/
51+
extern void sys_pm_notify_lps_exit(enum power_states state);
52+
53+
#ifdef __cplusplus
54+
}
55+
#endif
56+
57+
#endif /* _PM_POLICY_H_ */

0 commit comments

Comments
 (0)