155716d26SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 2a9d70523SRafael J. Wysocki /* 3a9d70523SRafael J. Wysocki * kernel/power/suspend_test.c - Suspend to RAM and standby test facility. 4a9d70523SRafael J. Wysocki * 5a9d70523SRafael J. Wysocki * Copyright (c) 2009 Pavel Machek <pavel@ucw.cz> 6a9d70523SRafael J. Wysocki */ 7a9d70523SRafael J. Wysocki 8a9d70523SRafael J. Wysocki #include <linux/init.h> 9a9d70523SRafael J. Wysocki #include <linux/rtc.h> 10a9d70523SRafael J. Wysocki 11a9d70523SRafael J. Wysocki #include "power.h" 12a9d70523SRafael J. Wysocki 13a9d70523SRafael J. Wysocki /* 14a9d70523SRafael J. Wysocki * We test the system suspend code by setting an RTC wakealarm a short 15a9d70523SRafael J. Wysocki * time in the future, then suspending. Suspending the devices won't 16a9d70523SRafael J. Wysocki * normally take long ... some systems only need a few milliseconds. 17a9d70523SRafael J. Wysocki * 18a9d70523SRafael J. Wysocki * The time it takes is system-specific though, so when we test this 19a9d70523SRafael J. Wysocki * during system bootup we allow a LOT of time. 20a9d70523SRafael J. Wysocki */ 2104bf7539SRafael J. Wysocki #define TEST_SUSPEND_SECONDS 10 22a9d70523SRafael J. Wysocki 23a9d70523SRafael J. Wysocki static unsigned long suspend_test_start_time; 242ce98689SSrinivas Pandruvada static u32 test_repeat_count_max = 1; 252ce98689SSrinivas Pandruvada static u32 test_repeat_count_current; 26a9d70523SRafael J. Wysocki 27a9d70523SRafael J. Wysocki void suspend_test_start(void) 28a9d70523SRafael J. Wysocki { 29a9d70523SRafael J. Wysocki /* FIXME Use better timebase than "jiffies", ideally a clocksource. 30a9d70523SRafael J. Wysocki * What we want is a hardware counter that will work correctly even 31a9d70523SRafael J. Wysocki * during the irqs-are-off stages of the suspend/resume cycle... 32a9d70523SRafael J. Wysocki */ 33a9d70523SRafael J. Wysocki suspend_test_start_time = jiffies; 34a9d70523SRafael J. Wysocki } 35a9d70523SRafael J. Wysocki 36a9d70523SRafael J. Wysocki void suspend_test_finish(const char *label) 37a9d70523SRafael J. Wysocki { 38a9d70523SRafael J. Wysocki long nj = jiffies - suspend_test_start_time; 39a9d70523SRafael J. Wysocki unsigned msec; 40a9d70523SRafael J. Wysocki 41a9d70523SRafael J. Wysocki msec = jiffies_to_msecs(abs(nj)); 42a9d70523SRafael J. Wysocki pr_info("PM: %s took %d.%03d seconds\n", label, 43a9d70523SRafael J. Wysocki msec / 1000, msec % 1000); 44a9d70523SRafael J. Wysocki 45a9d70523SRafael J. Wysocki /* Warning on suspend means the RTC alarm period needs to be 46a9d70523SRafael J. Wysocki * larger -- the system was sooo slooowwww to suspend that the 47a9d70523SRafael J. Wysocki * alarm (should have) fired before the system went to sleep! 48a9d70523SRafael J. Wysocki * 49a9d70523SRafael J. Wysocki * Warning on either suspend or resume also means the system 50a9d70523SRafael J. Wysocki * has some performance issues. The stack dump of a WARN_ON 51a9d70523SRafael J. Wysocki * is more likely to get the right attention than a printk... 52a9d70523SRafael J. Wysocki */ 5304bf7539SRafael J. Wysocki WARN(msec > (TEST_SUSPEND_SECONDS * 1000), 5404bf7539SRafael J. Wysocki "Component: %s, time: %u\n", label, msec); 55a9d70523SRafael J. Wysocki } 56a9d70523SRafael J. Wysocki 57a9d70523SRafael J. Wysocki /* 58a9d70523SRafael J. Wysocki * To test system suspend, we need a hands-off mechanism to resume the 59a9d70523SRafael J. Wysocki * system. RTCs wake alarms are a common self-contained mechanism. 60a9d70523SRafael J. Wysocki */ 61a9d70523SRafael J. Wysocki 62a9d70523SRafael J. Wysocki static void __init test_wakealarm(struct rtc_device *rtc, suspend_state_t state) 63a9d70523SRafael J. Wysocki { 64a9d70523SRafael J. Wysocki static char err_readtime[] __initdata = 65a9d70523SRafael J. Wysocki KERN_ERR "PM: can't read %s time, err %d\n"; 66a9d70523SRafael J. Wysocki static char err_wakealarm [] __initdata = 67a9d70523SRafael J. Wysocki KERN_ERR "PM: can't set %s wakealarm, err %d\n"; 68a9d70523SRafael J. Wysocki static char err_suspend[] __initdata = 69a9d70523SRafael J. Wysocki KERN_ERR "PM: suspend test failed, error %d\n"; 70a9d70523SRafael J. Wysocki static char info_test[] __initdata = 71a9d70523SRafael J. Wysocki KERN_INFO "PM: test RTC wakeup from '%s' suspend\n"; 72a9d70523SRafael J. Wysocki 732a2ef473SAlexandre Belloni time64_t now; 74a9d70523SRafael J. Wysocki struct rtc_wkalrm alm; 75a9d70523SRafael J. Wysocki int status; 76a9d70523SRafael J. Wysocki 77a9d70523SRafael J. Wysocki /* this may fail if the RTC hasn't been initialized */ 782ce98689SSrinivas Pandruvada repeat: 79a9d70523SRafael J. Wysocki status = rtc_read_time(rtc, &alm.time); 80a9d70523SRafael J. Wysocki if (status < 0) { 81a9d70523SRafael J. Wysocki printk(err_readtime, dev_name(&rtc->dev), status); 82a9d70523SRafael J. Wysocki return; 83a9d70523SRafael J. Wysocki } 842a2ef473SAlexandre Belloni now = rtc_tm_to_time64(&alm.time); 85a9d70523SRafael J. Wysocki 86a9d70523SRafael J. Wysocki memset(&alm, 0, sizeof alm); 872a2ef473SAlexandre Belloni rtc_time64_to_tm(now + TEST_SUSPEND_SECONDS, &alm.time); 88a9d70523SRafael J. Wysocki alm.enabled = true; 89a9d70523SRafael J. Wysocki 90a9d70523SRafael J. Wysocki status = rtc_set_alarm(rtc, &alm); 91a9d70523SRafael J. Wysocki if (status < 0) { 92a9d70523SRafael J. Wysocki printk(err_wakealarm, dev_name(&rtc->dev), status); 93a9d70523SRafael J. Wysocki return; 94a9d70523SRafael J. Wysocki } 95a9d70523SRafael J. Wysocki 96a9d70523SRafael J. Wysocki if (state == PM_SUSPEND_MEM) { 97d431cbc5SRafael J. Wysocki printk(info_test, pm_states[state]); 98a9d70523SRafael J. Wysocki status = pm_suspend(state); 99a9d70523SRafael J. Wysocki if (status == -ENODEV) 100a9d70523SRafael J. Wysocki state = PM_SUSPEND_STANDBY; 101a9d70523SRafael J. Wysocki } 102a9d70523SRafael J. Wysocki if (state == PM_SUSPEND_STANDBY) { 103d431cbc5SRafael J. Wysocki printk(info_test, pm_states[state]); 104a9d70523SRafael J. Wysocki status = pm_suspend(state); 105bc7115b1SSrinivas Pandruvada if (status < 0) 106690cbb90SRafael J. Wysocki state = PM_SUSPEND_TO_IDLE; 107a9d70523SRafael J. Wysocki } 108690cbb90SRafael J. Wysocki if (state == PM_SUSPEND_TO_IDLE) { 109bc7115b1SSrinivas Pandruvada printk(info_test, pm_states[state]); 110bc7115b1SSrinivas Pandruvada status = pm_suspend(state); 111bc7115b1SSrinivas Pandruvada } 112bc7115b1SSrinivas Pandruvada 113a9d70523SRafael J. Wysocki if (status < 0) 114a9d70523SRafael J. Wysocki printk(err_suspend, status); 115a9d70523SRafael J. Wysocki 1162ce98689SSrinivas Pandruvada test_repeat_count_current++; 1172ce98689SSrinivas Pandruvada if (test_repeat_count_current < test_repeat_count_max) 1182ce98689SSrinivas Pandruvada goto repeat; 1192ce98689SSrinivas Pandruvada 120a9d70523SRafael J. Wysocki /* Some platforms can't detect that the alarm triggered the 121a9d70523SRafael J. Wysocki * wakeup, or (accordingly) disable it after it afterwards. 122a9d70523SRafael J. Wysocki * It's supposed to give oneshot behavior; cope. 123a9d70523SRafael J. Wysocki */ 124a9d70523SRafael J. Wysocki alm.enabled = false; 125a9d70523SRafael J. Wysocki rtc_set_alarm(rtc, &alm); 126a9d70523SRafael J. Wysocki } 127a9d70523SRafael J. Wysocki 1289f3b795aSMichał Mirosław static int __init has_wakealarm(struct device *dev, const void *data) 129a9d70523SRafael J. Wysocki { 130a9d70523SRafael J. Wysocki struct rtc_device *candidate = to_rtc_device(dev); 131a9d70523SRafael J. Wysocki 1324fac49fdSAlexandre Belloni if (!test_bit(RTC_FEATURE_ALARM, candidate->features)) 133a9d70523SRafael J. Wysocki return 0; 134a9d70523SRafael J. Wysocki if (!device_may_wakeup(candidate->dev.parent)) 135a9d70523SRafael J. Wysocki return 0; 136a9d70523SRafael J. Wysocki 137a9d70523SRafael J. Wysocki return 1; 138a9d70523SRafael J. Wysocki } 139a9d70523SRafael J. Wysocki 140a9d70523SRafael J. Wysocki /* 141a9d70523SRafael J. Wysocki * Kernel options like "test_suspend=mem" force suspend/resume sanity tests 142a9d70523SRafael J. Wysocki * at startup time. They're normally disabled, for faster boot and because 143a9d70523SRafael J. Wysocki * we can't know which states really work on this particular system. 144a9d70523SRafael J. Wysocki */ 14562109b43SRafael J. Wysocki static const char *test_state_label __initdata; 146a9d70523SRafael J. Wysocki 147a9d70523SRafael J. Wysocki static char warn_bad_state[] __initdata = 148a9d70523SRafael J. Wysocki KERN_WARNING "PM: can't test '%s' suspend state\n"; 149a9d70523SRafael J. Wysocki 150a9d70523SRafael J. Wysocki static int __init setup_test_suspend(char *value) 151a9d70523SRafael J. Wysocki { 15262109b43SRafael J. Wysocki int i; 1532ce98689SSrinivas Pandruvada char *repeat; 1542ce98689SSrinivas Pandruvada char *suspend_type; 155a9d70523SRafael J. Wysocki 1562ce98689SSrinivas Pandruvada /* example : "=mem[,N]" ==> "mem[,N]" */ 157a9d70523SRafael J. Wysocki value++; 1582ce98689SSrinivas Pandruvada suspend_type = strsep(&value, ","); 1592ce98689SSrinivas Pandruvada if (!suspend_type) 1607a64ca17SRandy Dunlap return 1; 1612ce98689SSrinivas Pandruvada 1622ce98689SSrinivas Pandruvada repeat = strsep(&value, ","); 1632ce98689SSrinivas Pandruvada if (repeat) { 1642ce98689SSrinivas Pandruvada if (kstrtou32(repeat, 0, &test_repeat_count_max)) 1657a64ca17SRandy Dunlap return 1; 1662ce98689SSrinivas Pandruvada } 1672ce98689SSrinivas Pandruvada 1688cff6679SGeert Uytterhoeven for (i = PM_SUSPEND_MIN; i < PM_SUSPEND_MAX; i++) 1692ce98689SSrinivas Pandruvada if (!strcmp(pm_labels[i], suspend_type)) { 17062109b43SRafael J. Wysocki test_state_label = pm_labels[i]; 1717a64ca17SRandy Dunlap return 1; 172a9d70523SRafael J. Wysocki } 17327ddcc65SRafael J. Wysocki 1742ce98689SSrinivas Pandruvada printk(warn_bad_state, suspend_type); 1757a64ca17SRandy Dunlap return 1; 176a9d70523SRafael J. Wysocki } 177a9d70523SRafael J. Wysocki __setup("test_suspend", setup_test_suspend); 178a9d70523SRafael J. Wysocki 179a9d70523SRafael J. Wysocki static int __init test_suspend(void) 180a9d70523SRafael J. Wysocki { 181a9d70523SRafael J. Wysocki static char warn_no_rtc[] __initdata = 182a9d70523SRafael J. Wysocki KERN_WARNING "PM: no wakealarm-capable RTC driver is ready\n"; 183a9d70523SRafael J. Wysocki 184a9d70523SRafael J. Wysocki struct rtc_device *rtc = NULL; 1859f3b795aSMichał Mirosław struct device *dev; 18662109b43SRafael J. Wysocki suspend_state_t test_state; 187a9d70523SRafael J. Wysocki 188a9d70523SRafael J. Wysocki /* PM is initialized by now; is that state testable? */ 18962109b43SRafael J. Wysocki if (!test_state_label) 19062109b43SRafael J. Wysocki return 0; 19162109b43SRafael J. Wysocki 19262109b43SRafael J. Wysocki for (test_state = PM_SUSPEND_MIN; test_state < PM_SUSPEND_MAX; test_state++) { 19362109b43SRafael J. Wysocki const char *state_label = pm_states[test_state]; 19462109b43SRafael J. Wysocki 19562109b43SRafael J. Wysocki if (state_label && !strcmp(test_state_label, state_label)) 19662109b43SRafael J. Wysocki break; 19762109b43SRafael J. Wysocki } 19862109b43SRafael J. Wysocki if (test_state == PM_SUSPEND_MAX) { 19962109b43SRafael J. Wysocki printk(warn_bad_state, test_state_label); 20062109b43SRafael J. Wysocki return 0; 201a9d70523SRafael J. Wysocki } 202a9d70523SRafael J. Wysocki 203a9d70523SRafael J. Wysocki /* RTCs have initialized by now too ... can we use one? */ 204*6b6ca096SRicardo B. Marliere dev = class_find_device(&rtc_class, NULL, NULL, has_wakealarm); 205ceb75787SJohan Hovold if (dev) { 2069f3b795aSMichał Mirosław rtc = rtc_class_open(dev_name(dev)); 207ceb75787SJohan Hovold put_device(dev); 208ceb75787SJohan Hovold } 209a9d70523SRafael J. Wysocki if (!rtc) { 210a9d70523SRafael J. Wysocki printk(warn_no_rtc); 21162109b43SRafael J. Wysocki return 0; 212a9d70523SRafael J. Wysocki } 213a9d70523SRafael J. Wysocki 214a9d70523SRafael J. Wysocki /* go for it */ 215a9d70523SRafael J. Wysocki test_wakealarm(rtc, test_state); 216a9d70523SRafael J. Wysocki rtc_class_close(rtc); 217a9d70523SRafael J. Wysocki return 0; 218a9d70523SRafael J. Wysocki } 219a9d70523SRafael J. Wysocki late_initcall(test_suspend); 220