| /* |
| * Copyright (c) 2020 Intel Corporation |
| * |
| * SPDX-License-Identifier: Apache-2.0 |
| */ |
| |
| #include <errno.h> |
| #include <zephyr.h> |
| #include <device.h> |
| #include <soc.h> |
| #include <pm/pm.h> |
| #include <logging/log.h> |
| #define LOG_LEVEL LOG_LEVEL_DBG |
| LOG_MODULE_REGISTER(pwrmgmt_test); |
| |
| #define SLP_STATES_SUPPORTED 2ul |
| |
| /* Thread properties */ |
| #define TASK_STACK_SIZE 1024ul |
| #define PRIORITY K_PRIO_COOP(5) |
| /* Sleep time should be lower than SUSPEND_TO_IDLE residency time */ |
| #define THREAD_A_SLEEP_TIME 100ul |
| #define THREAD_B_SLEEP_TIME 1000ul |
| |
| /* Maximum latency should be less than 300 ms */ |
| #define MAX_EXPECTED_MS_LATENCY 500ul |
| |
| /* Sleep some extra time than minimum residency */ |
| #define DP_EXTRA_SLP_TIME 1100ul |
| #define LT_EXTRA_SLP_TIME 500ul |
| |
| #define SEC_TO_MSEC 1000ul |
| |
| K_THREAD_STACK_DEFINE(stack_a, TASK_STACK_SIZE); |
| K_THREAD_STACK_DEFINE(stack_b, TASK_STACK_SIZE); |
| |
| static struct k_thread thread_a_id; |
| static struct k_thread thread_b_id; |
| |
| struct pm_counter { |
| uint8_t entry_cnt; |
| uint8_t exit_cnt; |
| }; |
| |
| /* Track time elapsed */ |
| static int64_t trigger_time; |
| static bool checks_enabled; |
| /* Track entry/exit to sleep */ |
| struct pm_counter pm_counters[SLP_STATES_SUPPORTED]; |
| |
| static const struct pm_state_info residency_info[] = |
| PM_STATE_INFO_LIST_FROM_DT_CPU(DT_NODELABEL(cpu0)); |
| static size_t residency_info_len = DT_NUM_CPU_POWER_STATES(DT_NODELABEL(cpu0)); |
| |
| |
| /* Instrumentation to measure latency and track entry exit via gpios |
| * |
| * In EVB set following jumpers: |
| * JP99 7-8 closed |
| * JP99 10-11 closed |
| * JP75 29-30 closed |
| * JP75 32-33 closed |
| * |
| * In EVB probe following pins: |
| * JP25.3 (GPIO012_LT) light sleep |
| * JP25.5 (GPIO013_DP) deep sleep |
| * JP25.7 (GPIO014_TRIG) trigger in app |
| * JP75.29 (GPIO60_CLK_OUT) |
| */ |
| |
| static void pm_latency_check(void) |
| { |
| int64_t latency; |
| int secs; |
| int msecs; |
| |
| latency = k_uptime_delta(&trigger_time); |
| secs = (int)(latency / SEC_TO_MSEC); |
| msecs = (int)(latency % SEC_TO_MSEC); |
| LOG_INF("PM sleep entry latency %d.%03d seconds", secs, msecs); |
| |
| if (secs > 0) { |
| LOG_WRN("Sleep entry latency is too high"); |
| return; |
| } |
| |
| if (msecs > MAX_EXPECTED_MS_LATENCY) { |
| LOG_WRN("Sleep entry latency is higher than expected"); |
| } |
| } |
| |
| /* Hooks to count entry/exit */ |
| static void notify_pm_state_entry(enum pm_state state) |
| { |
| if (!checks_enabled) { |
| return; |
| } |
| |
| switch (state) { |
| case PM_STATE_SUSPEND_TO_IDLE: |
| GPIO_CTRL_REGS->CTRL_0012 = 0x240ul; |
| pm_counters[0].entry_cnt++; |
| break; |
| case PM_STATE_SUSPEND_TO_RAM: |
| GPIO_CTRL_REGS->CTRL_0013 = 0x240ul; |
| pm_counters[1].entry_cnt++; |
| pm_latency_check(); |
| break; |
| default: |
| break; |
| } |
| } |
| |
| static void notify_pm_state_exit(enum pm_state state) |
| { |
| if (!checks_enabled) { |
| return; |
| } |
| |
| switch (state) { |
| case PM_STATE_SUSPEND_TO_IDLE: |
| GPIO_CTRL_REGS->CTRL_0012 = 0x10240ul; |
| pm_counters[0].exit_cnt++; |
| break; |
| case PM_STATE_SUSPEND_TO_RAM: |
| GPIO_CTRL_REGS->CTRL_0013 = 0x10240ul; |
| pm_counters[1].exit_cnt++; |
| break; |
| default: |
| break; |
| } |
| } |
| |
| static void pm_check_counters(uint8_t cycles) |
| { |
| for (int i = 0; i < SLP_STATES_SUPPORTED; i++) { |
| LOG_INF("PM state[%d] entry counter %d", i, |
| pm_counters[i].entry_cnt); |
| LOG_INF("PM state[%d] exit counter %d", i, |
| pm_counters[i].exit_cnt); |
| |
| if (pm_counters[i].entry_cnt != pm_counters[i].exit_cnt) { |
| LOG_WRN("PM counters entry/exit mismatch"); |
| } |
| |
| if (pm_counters[i].entry_cnt != cycles) { |
| LOG_WRN("PM counter mismatch expected: %d", cycles); |
| } |
| |
| pm_counters[i].entry_cnt = 0; |
| pm_counters[i].exit_cnt = 0; |
| } |
| } |
| |
| static void pm_reset_counters(void) |
| { |
| for (int i = 0; i < SLP_STATES_SUPPORTED; i++) { |
| pm_counters[i].entry_cnt = 0; |
| pm_counters[i].exit_cnt = 0; |
| } |
| |
| checks_enabled = false; |
| GPIO_CTRL_REGS->CTRL_0014 = 0x10240UL; |
| } |
| |
| static void pm_trigger_marker(void) |
| { |
| trigger_time = k_uptime_get(); |
| |
| /* Directly access a pin to mark sleep trigger */ |
| GPIO_CTRL_REGS->CTRL_0014 = 0x00240UL; |
| printk("PM >\n"); |
| } |
| |
| static void pm_exit_marker(void) |
| { |
| int64_t residency_delta; |
| int secs; |
| int msecs; |
| |
| /* Directly access a pin */ |
| GPIO_CTRL_REGS->CTRL_0014 = 0x10240UL; |
| printk("PM <\n"); |
| |
| if (trigger_time > 0) { |
| residency_delta = k_uptime_delta(&trigger_time); |
| secs = (int)(residency_delta / SEC_TO_MSEC); |
| msecs = (int)(residency_delta % SEC_TO_MSEC); |
| LOG_INF("PM sleep residency %d.%03d seconds", secs, msecs); |
| } |
| } |
| |
| static int task_a_init(void) |
| { |
| LOG_INF("Thread task A init"); |
| |
| return 0; |
| } |
| |
| static int task_b_init(void) |
| { |
| printk("Thread task B init"); |
| |
| return 0; |
| } |
| |
| void task_a_thread(void *p1, void *p2, void *p3) |
| { |
| while (true) { |
| k_msleep(THREAD_A_SLEEP_TIME); |
| printk("A"); |
| } |
| } |
| |
| static void task_b_thread(void *p1, void *p2, void *p3) |
| { |
| while (true) { |
| k_msleep(THREAD_B_SLEEP_TIME); |
| printk("B"); |
| } |
| } |
| |
| static void create_tasks(void) |
| { |
| task_a_init(); |
| task_b_init(); |
| |
| k_thread_create(&thread_a_id, stack_a, TASK_STACK_SIZE, task_a_thread, |
| NULL, NULL, NULL, PRIORITY, K_INHERIT_PERMS, K_FOREVER); |
| k_thread_create(&thread_b_id, stack_b, TASK_STACK_SIZE, task_b_thread, |
| NULL, NULL, NULL, PRIORITY, K_INHERIT_PERMS, K_FOREVER); |
| |
| k_thread_start(&thread_a_id); |
| k_thread_start(&thread_b_id); |
| |
| } |
| |
| static void destroy_tasks(void) |
| { |
| k_thread_abort(&thread_a_id); |
| k_thread_abort(&thread_b_id); |
| |
| k_thread_join(&thread_a_id, K_FOREVER); |
| k_thread_join(&thread_b_id, K_FOREVER); |
| } |
| |
| static void suspend_all_tasks(void) |
| { |
| k_thread_suspend(&thread_a_id); |
| k_thread_suspend(&thread_b_id); |
| } |
| |
| static void resume_all_tasks(void) |
| { |
| k_thread_resume(&thread_a_id); |
| k_thread_resume(&thread_b_id); |
| } |
| |
| static struct pm_notifier notifier = { |
| .state_entry = notify_pm_state_entry, |
| .state_exit = notify_pm_state_exit, |
| }; |
| |
| int test_pwr_mgmt_multithread(bool use_logging, uint8_t cycles) |
| { |
| uint8_t iterations = cycles; |
| /* Ensure we can enter deep sleep when stopping threads |
| * No UART output should occur when threads are suspended |
| * Test to verify Zephyr RTOS issue #20033 |
| * https://github.com/zephyrproject-rtos/zephyr/issues/20033 |
| */ |
| |
| pm_notifier_register(¬ifier); |
| create_tasks(); |
| |
| LOG_WRN("PM multi-thread test started for cycles: %d, logging: %d", |
| cycles, use_logging); |
| |
| checks_enabled = true; |
| while (iterations-- > 0) { |
| |
| /* Light sleep cycle */ |
| LOG_INF("Suspend..."); |
| suspend_all_tasks(); |
| LOG_INF("About to enter light sleep"); |
| k_msleep((residency_info[0].min_residency_us / 1000U) + |
| LT_EXTRA_SLP_TIME); |
| k_busy_wait(100); |
| |
| if (use_logging) { |
| LOG_INF("Wake from Light Sleep"); |
| } else { |
| printk("Wake from Light Sleep\n"); |
| } |
| |
| LOG_INF("Resume"); |
| resume_all_tasks(); |
| |
| /* Deep sleep cycle */ |
| LOG_INF("Suspend..."); |
| suspend_all_tasks(); |
| LOG_INF("About to enter deep sleep"); |
| |
| /* GPIO toggle to measure latency for deep sleep */ |
| pm_trigger_marker(); |
| k_msleep( |
| (residency_info[residency_info_len - 1].min_residency_us / |
| 1000U) + DP_EXTRA_SLP_TIME); |
| k_busy_wait(100); |
| |
| if (use_logging) { |
| LOG_INF("Wake from Deep Sleep"); |
| } else { |
| printk("Wake from Deep Sleep\n"); |
| } |
| |
| pm_exit_marker(); |
| LOG_INF("Resume"); |
| resume_all_tasks(); |
| } |
| |
| destroy_tasks(); |
| |
| LOG_INF("PM multi-thread completed"); |
| pm_check_counters(cycles); |
| pm_reset_counters(); |
| pm_notifier_unregister(¬ifier); |
| |
| return 0; |
| } |
| |
| int test_pwr_mgmt_singlethread(bool use_logging, uint8_t cycles) |
| { |
| uint8_t iterations = cycles; |
| |
| LOG_WRN("PM single-thread test started for cycles: %d, logging: %d", |
| cycles, use_logging); |
| |
| pm_notifier_register(¬ifier); |
| checks_enabled = true; |
| while (iterations-- > 0) { |
| |
| /* Trigger Light Sleep 1 state. 48MHz PLL stays on */ |
| LOG_INF("About to enter light sleep"); |
| k_msleep((residency_info[0].min_residency_us / 1000U) + |
| LT_EXTRA_SLP_TIME); |
| k_busy_wait(100); |
| |
| if (use_logging) { |
| LOG_INF("Wake from Light Sleep"); |
| } else { |
| printk("Wake from Light Sleep\n"); |
| } |
| |
| /* Trigger Deep Sleep 1 state. 48MHz PLL off */ |
| LOG_INF("About to enter deep Sleep"); |
| |
| /* GPIO toggle to measure latency */ |
| pm_trigger_marker(); |
| k_msleep( |
| (residency_info[residency_info_len - 1].min_residency_us / |
| 1000U) + DP_EXTRA_SLP_TIME); |
| k_busy_wait(100); |
| |
| if (use_logging) { |
| LOG_INF("Wake from Deep Sleep"); |
| } else { |
| printk("Wake from Deep Sleep\n"); |
| } |
| |
| pm_exit_marker(); |
| } |
| |
| LOG_INF("PM single-thread completed"); |
| pm_check_counters(cycles); |
| pm_reset_counters(); |
| pm_notifier_unregister(¬ifier); |
| |
| return 0; |
| } |