1 // SPDX-License-Identifier: GPL-2.0-only
3 * sleep.c - ACPI sleep support.
5 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
6 * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
7 * Copyright (c) 2000-2003 Patrick Mochel
8 * Copyright (c) 2003 Open Source Development Lab
11 #include <linux/delay.h>
12 #include <linux/irq.h>
13 #include <linux/dmi.h>
14 #include <linux/device.h>
15 #include <linux/interrupt.h>
16 #include <linux/suspend.h>
17 #include <linux/reboot.h>
18 #include <linux/acpi.h>
19 #include <linux/module.h>
20 #include <linux/syscore_ops.h>
22 #include <trace/events/power.h>
28 * Some HW-full platforms do not have _S5, so they may need
29 * to leverage efi power off for a shutdown.
32 static u8 sleep_states[ACPI_S_STATE_COUNT];
34 static void acpi_sleep_tts_switch(u32 acpi_state)
38 status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state);
39 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
41 * OS can't evaluate the _TTS object correctly. Some warning
42 * message will be printed. But it won't break anything.
44 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
48 static int tts_notify_reboot(struct notifier_block *this,
49 unsigned long code, void *x)
51 acpi_sleep_tts_switch(ACPI_STATE_S5);
55 static struct notifier_block tts_notifier = {
56 .notifier_call = tts_notify_reboot,
61 static int acpi_sleep_prepare(u32 acpi_state)
63 #ifdef CONFIG_ACPI_SLEEP
64 unsigned long acpi_wakeup_address;
66 /* do we have a wakeup address for S2 and S3? */
67 if (acpi_state == ACPI_STATE_S3) {
68 acpi_wakeup_address = acpi_get_wakeup_address();
69 if (!acpi_wakeup_address)
71 acpi_set_waking_vector(acpi_wakeup_address);
74 ACPI_FLUSH_CPU_CACHE();
76 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
78 acpi_enable_wakeup_devices(acpi_state);
79 acpi_enter_sleep_state_prep(acpi_state);
83 bool acpi_sleep_state_supported(u8 sleep_state)
88 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
89 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
90 || (acpi_gbl_FADT.sleep_control.address
91 && acpi_gbl_FADT.sleep_status.address));
94 #ifdef CONFIG_ACPI_SLEEP
95 static bool sleep_no_lps0 __read_mostly;
96 module_param(sleep_no_lps0, bool, 0644);
97 MODULE_PARM_DESC(sleep_no_lps0, "Do not use the special LPS0 device interface");
99 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
101 u32 acpi_target_system_state(void)
103 return acpi_target_sleep_state;
105 EXPORT_SYMBOL_GPL(acpi_target_system_state);
107 static bool pwr_btn_event_pending;
110 * The ACPI specification wants us to save NVS memory regions during hibernation
111 * and to restore them during the subsequent resume. Windows does that also for
112 * suspend to RAM. However, it is known that this mechanism does not work on
113 * all machines, so we allow the user to disable it with the help of the
114 * 'acpi_sleep=nonvs' kernel command line option.
116 static bool nvs_nosave;
118 void __init acpi_nvs_nosave(void)
124 * The ACPI specification wants us to save NVS memory regions during hibernation
125 * but says nothing about saving NVS during S3. Not all versions of Windows
126 * save NVS on S3 suspend either, and it is clear that not all systems need
127 * NVS to be saved at S3 time. To improve suspend/resume time, allow the
128 * user to disable saving NVS on S3 if their system does not require it, but
129 * continue to save/restore NVS for S4 as specified.
131 static bool nvs_nosave_s3;
133 void __init acpi_nvs_nosave_s3(void)
135 nvs_nosave_s3 = true;
138 static int __init init_nvs_save_s3(const struct dmi_system_id *d)
140 nvs_nosave_s3 = false;
145 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
146 * user to request that behavior by using the 'acpi_old_suspend_ordering'
147 * kernel command line option that causes the following variable to be set.
149 static bool old_suspend_ordering;
151 void __init acpi_old_suspend_ordering(void)
153 old_suspend_ordering = true;
156 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
158 acpi_old_suspend_ordering();
162 static int __init init_nvs_nosave(const struct dmi_system_id *d)
168 static bool acpi_sleep_default_s3;
170 static int __init init_default_s3(const struct dmi_system_id *d)
172 acpi_sleep_default_s3 = true;
176 static const struct dmi_system_id acpisleep_dmi_table[] __initconst = {
178 .callback = init_old_suspend_ordering,
179 .ident = "Abit KN9 (nForce4 variant)",
181 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
182 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
186 .callback = init_old_suspend_ordering,
187 .ident = "HP xw4600 Workstation",
189 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
190 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
194 .callback = init_old_suspend_ordering,
195 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
197 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
198 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
202 .callback = init_old_suspend_ordering,
203 .ident = "Panasonic CF51-2L",
205 DMI_MATCH(DMI_BOARD_VENDOR,
206 "Matsushita Electric Industrial Co.,Ltd."),
207 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
211 .callback = init_nvs_nosave,
212 .ident = "Sony Vaio VGN-FW41E_H",
214 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
215 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
219 .callback = init_nvs_nosave,
220 .ident = "Sony Vaio VGN-FW21E",
222 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
223 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
227 .callback = init_nvs_nosave,
228 .ident = "Sony Vaio VGN-FW21M",
230 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
231 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
235 .callback = init_nvs_nosave,
236 .ident = "Sony Vaio VPCEB17FX",
238 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
239 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
243 .callback = init_nvs_nosave,
244 .ident = "Sony Vaio VGN-SR11M",
246 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
247 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
251 .callback = init_nvs_nosave,
252 .ident = "Everex StepNote Series",
254 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
255 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
259 .callback = init_nvs_nosave,
260 .ident = "Sony Vaio VPCEB1Z1E",
262 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
263 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
267 .callback = init_nvs_nosave,
268 .ident = "Sony Vaio VGN-NW130D",
270 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
271 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
275 .callback = init_nvs_nosave,
276 .ident = "Sony Vaio VPCCW29FX",
278 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
279 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
283 .callback = init_nvs_nosave,
284 .ident = "Averatec AV1020-ED2",
286 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
287 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
291 .callback = init_old_suspend_ordering,
292 .ident = "Asus A8N-SLI DELUXE",
294 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
295 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
299 .callback = init_old_suspend_ordering,
300 .ident = "Asus A8N-SLI Premium",
302 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
303 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
307 .callback = init_nvs_nosave,
308 .ident = "Sony Vaio VGN-SR26GN_P",
310 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
311 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
315 .callback = init_nvs_nosave,
316 .ident = "Sony Vaio VPCEB1S1E",
318 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
319 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
323 .callback = init_nvs_nosave,
324 .ident = "Sony Vaio VGN-FW520F",
326 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
327 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
331 .callback = init_nvs_nosave,
332 .ident = "Asus K54C",
334 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
335 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
339 .callback = init_nvs_nosave,
340 .ident = "Asus K54HR",
342 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
343 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
347 .callback = init_nvs_save_s3,
348 .ident = "Asus 1025C",
350 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
351 DMI_MATCH(DMI_PRODUCT_NAME, "1025C"),
355 * https://bugzilla.kernel.org/show_bug.cgi?id=189431
356 * Lenovo G50-45 is a platform later than 2012, but needs nvs memory
360 .callback = init_nvs_save_s3,
361 .ident = "Lenovo G50-45",
363 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
364 DMI_MATCH(DMI_PRODUCT_NAME, "80E3"),
368 .callback = init_nvs_save_s3,
369 .ident = "Lenovo G40-45",
371 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
372 DMI_MATCH(DMI_PRODUCT_NAME, "80E1"),
376 * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using
377 * the Low Power S0 Idle firmware interface (see
378 * https://bugzilla.kernel.org/show_bug.cgi?id=199057).
381 .callback = init_default_s3,
382 .ident = "ThinkPad X1 Tablet(2016)",
384 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
385 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"),
391 static bool ignore_blacklist;
393 void __init acpi_sleep_no_blacklist(void)
395 ignore_blacklist = true;
398 static void __init acpi_sleep_dmi_check(void)
400 if (ignore_blacklist)
403 if (dmi_get_bios_year() >= 2012)
404 acpi_nvs_nosave_s3();
406 dmi_check_system(acpisleep_dmi_table);
410 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
412 static int acpi_pm_freeze(void)
414 acpi_disable_all_gpes();
415 acpi_os_wait_events_complete();
416 acpi_ec_block_transactions();
421 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
423 static int acpi_pm_pre_suspend(void)
426 return suspend_nvs_save();
430 * __acpi_pm_prepare - Prepare the platform to enter the target state.
432 * If necessary, set the firmware waking vector and do arch-specific
433 * nastiness to get the wakeup code to the waking vector.
435 static int __acpi_pm_prepare(void)
437 int error = acpi_sleep_prepare(acpi_target_sleep_state);
439 acpi_target_sleep_state = ACPI_STATE_S0;
445 * acpi_pm_prepare - Prepare the platform to enter the target sleep
446 * state and disable the GPEs.
448 static int acpi_pm_prepare(void)
450 int error = __acpi_pm_prepare();
452 error = acpi_pm_pre_suspend();
458 * acpi_pm_finish - Instruct the platform to leave a sleep state.
460 * This is called after we wake back up (or if entering the sleep state
463 static void acpi_pm_finish(void)
465 struct acpi_device *pwr_btn_adev;
466 u32 acpi_state = acpi_target_sleep_state;
468 acpi_ec_unblock_transactions();
471 if (acpi_state == ACPI_STATE_S0)
474 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
476 acpi_disable_wakeup_devices(acpi_state);
477 acpi_leave_sleep_state(acpi_state);
479 /* reset firmware waking vector */
480 acpi_set_waking_vector(0);
482 acpi_target_sleep_state = ACPI_STATE_S0;
484 acpi_resume_power_resources();
486 /* If we were woken with the fixed power button, provide a small
487 * hint to userspace in the form of a wakeup event on the fixed power
488 * button device (if it can be found).
490 * We delay the event generation til now, as the PM layer requires
491 * timekeeping to be running before we generate events. */
492 if (!pwr_btn_event_pending)
495 pwr_btn_event_pending = false;
496 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
499 pm_wakeup_event(&pwr_btn_adev->dev, 0);
500 acpi_dev_put(pwr_btn_adev);
505 * acpi_pm_start - Start system PM transition.
507 static void acpi_pm_start(u32 acpi_state)
509 acpi_target_sleep_state = acpi_state;
510 acpi_sleep_tts_switch(acpi_target_sleep_state);
511 acpi_scan_lock_acquire();
515 * acpi_pm_end - Finish up system PM transition.
517 static void acpi_pm_end(void)
519 acpi_turn_off_unused_power_resources();
520 acpi_scan_lock_release();
522 * This is necessary in case acpi_pm_finish() is not called during a
523 * failing transition to a sleep state.
525 acpi_target_sleep_state = ACPI_STATE_S0;
526 acpi_sleep_tts_switch(acpi_target_sleep_state);
528 #else /* !CONFIG_ACPI_SLEEP */
529 #define sleep_no_lps0 (1)
530 #define acpi_target_sleep_state ACPI_STATE_S0
531 #define acpi_sleep_default_s3 (1)
532 static inline void acpi_sleep_dmi_check(void) {}
533 #endif /* CONFIG_ACPI_SLEEP */
535 #ifdef CONFIG_SUSPEND
536 static u32 acpi_suspend_states[] = {
537 [PM_SUSPEND_ON] = ACPI_STATE_S0,
538 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
539 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
540 [PM_SUSPEND_MAX] = ACPI_STATE_S5
544 * acpi_suspend_begin - Set the target system sleep state to the state
545 * associated with given @pm_state, if supported.
547 static int acpi_suspend_begin(suspend_state_t pm_state)
549 u32 acpi_state = acpi_suspend_states[pm_state];
552 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
556 if (!sleep_states[acpi_state]) {
557 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
560 if (acpi_state > ACPI_STATE_S1)
561 pm_set_suspend_via_firmware();
563 acpi_pm_start(acpi_state);
568 * acpi_suspend_enter - Actually enter a sleep state.
571 * Flush caches and go to sleep. For STR we have to call arch-specific
572 * assembly, which in turn call acpi_enter_sleep_state().
573 * It's unfortunate, but it works. Please fix if you're feeling frisky.
575 static int acpi_suspend_enter(suspend_state_t pm_state)
577 acpi_status status = AE_OK;
578 u32 acpi_state = acpi_target_sleep_state;
581 ACPI_FLUSH_CPU_CACHE();
583 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
584 switch (acpi_state) {
587 status = acpi_enter_sleep_state(acpi_state);
591 if (!acpi_suspend_lowlevel)
593 error = acpi_suspend_lowlevel();
596 pr_info(PREFIX "Low-level resume complete\n");
597 pm_set_resume_via_firmware();
600 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
602 /* This violates the spec but is required for bug compatibility. */
603 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
605 /* Reprogram control registers */
606 acpi_leave_sleep_state_prep(acpi_state);
608 /* ACPI 3.0 specs (P62) says that it's the responsibility
609 * of the OSPM to clear the status bit [ implying that the
610 * POWER_BUTTON event should not reach userspace ]
612 * However, we do generate a small hint for userspace in the form of
613 * a wakeup event. We flag this condition for now and generate the
614 * event later, as we're currently too early in resume to be able to
615 * generate wakeup events.
617 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
618 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
620 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
622 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
623 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
625 pwr_btn_event_pending = true;
630 * Disable and clear GPE status before interrupt is enabled. Some GPEs
631 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
632 * acpi_leave_sleep_state will reenable specific GPEs later
634 acpi_disable_all_gpes();
635 /* Allow EC transactions to happen. */
636 acpi_ec_unblock_transactions();
638 suspend_nvs_restore();
640 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
643 static int acpi_suspend_state_valid(suspend_state_t pm_state)
649 case PM_SUSPEND_STANDBY:
651 acpi_state = acpi_suspend_states[pm_state];
653 return sleep_states[acpi_state];
659 static const struct platform_suspend_ops acpi_suspend_ops = {
660 .valid = acpi_suspend_state_valid,
661 .begin = acpi_suspend_begin,
662 .prepare_late = acpi_pm_prepare,
663 .enter = acpi_suspend_enter,
664 .wake = acpi_pm_finish,
669 * acpi_suspend_begin_old - Set the target system sleep state to the
670 * state associated with given @pm_state, if supported, and
671 * execute the _PTS control method. This function is used if the
672 * pre-ACPI 2.0 suspend ordering has been requested.
674 static int acpi_suspend_begin_old(suspend_state_t pm_state)
676 int error = acpi_suspend_begin(pm_state);
678 error = __acpi_pm_prepare();
684 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
687 static const struct platform_suspend_ops acpi_suspend_ops_old = {
688 .valid = acpi_suspend_state_valid,
689 .begin = acpi_suspend_begin_old,
690 .prepare_late = acpi_pm_pre_suspend,
691 .enter = acpi_suspend_enter,
692 .wake = acpi_pm_finish,
694 .recover = acpi_pm_finish,
697 static bool s2idle_wakeup;
700 * On platforms supporting the Low Power S0 Idle interface there is an ACPI
701 * device object with the PNP0D80 compatible device ID (System Power Management
702 * Controller) and a specific _DSM method under it. That method, if present,
703 * can be used to indicate to the platform that the OS is transitioning into a
704 * low-power state in which certain types of activity are not desirable or that
705 * it is leaving such a state, which allows the platform to adjust its operation
708 static const struct acpi_device_id lps0_device_ids[] = {
713 #define ACPI_LPS0_DSM_UUID "c4eb40a0-6cd2-11e2-bcfd-0800200c9a66"
715 #define ACPI_LPS0_GET_DEVICE_CONSTRAINTS 1
716 #define ACPI_LPS0_SCREEN_OFF 3
717 #define ACPI_LPS0_SCREEN_ON 4
718 #define ACPI_LPS0_ENTRY 5
719 #define ACPI_LPS0_EXIT 6
721 static acpi_handle lps0_device_handle;
722 static guid_t lps0_dsm_guid;
723 static char lps0_dsm_func_mask;
725 /* Device constraint entry structure */
726 struct lpi_device_info {
729 union acpi_object *package;
732 /* Constraint package structure */
733 struct lpi_device_constraint {
739 struct lpi_constraints {
744 static struct lpi_constraints *lpi_constraints_table;
745 static int lpi_constraints_table_size;
747 static void lpi_device_get_constraints(void)
749 union acpi_object *out_obj;
752 out_obj = acpi_evaluate_dsm_typed(lps0_device_handle, &lps0_dsm_guid,
753 1, ACPI_LPS0_GET_DEVICE_CONSTRAINTS,
754 NULL, ACPI_TYPE_PACKAGE);
756 acpi_handle_debug(lps0_device_handle, "_DSM function 1 eval %s\n",
757 out_obj ? "successful" : "failed");
762 lpi_constraints_table = kcalloc(out_obj->package.count,
763 sizeof(*lpi_constraints_table),
765 if (!lpi_constraints_table)
766 goto free_acpi_buffer;
768 acpi_handle_debug(lps0_device_handle, "LPI: constraints list begin:\n");
770 for (i = 0; i < out_obj->package.count; i++) {
771 struct lpi_constraints *constraint;
773 union acpi_object *package = &out_obj->package.elements[i];
774 struct lpi_device_info info = { };
775 int package_count = 0, j;
780 for (j = 0; j < package->package.count; ++j) {
781 union acpi_object *element =
782 &(package->package.elements[j]);
784 switch (element->type) {
785 case ACPI_TYPE_INTEGER:
786 info.enabled = element->integer.value;
788 case ACPI_TYPE_STRING:
789 info.name = element->string.pointer;
791 case ACPI_TYPE_PACKAGE:
792 package_count = element->package.count;
793 info.package = element->package.elements;
798 if (!info.enabled || !info.package || !info.name)
801 constraint = &lpi_constraints_table[lpi_constraints_table_size];
803 status = acpi_get_handle(NULL, info.name, &constraint->handle);
804 if (ACPI_FAILURE(status))
807 acpi_handle_debug(lps0_device_handle,
808 "index:%d Name:%s\n", i, info.name);
810 constraint->min_dstate = -1;
812 for (j = 0; j < package_count; ++j) {
813 union acpi_object *info_obj = &info.package[j];
814 union acpi_object *cnstr_pkg;
815 union acpi_object *obj;
816 struct lpi_device_constraint dev_info;
818 switch (info_obj->type) {
819 case ACPI_TYPE_INTEGER:
822 case ACPI_TYPE_PACKAGE:
823 if (info_obj->package.count < 2)
826 cnstr_pkg = info_obj->package.elements;
828 dev_info.uid = obj->integer.value;
830 dev_info.min_dstate = obj->integer.value;
832 acpi_handle_debug(lps0_device_handle,
833 "uid:%d min_dstate:%s\n",
835 acpi_power_state_string(dev_info.min_dstate));
837 constraint->min_dstate = dev_info.min_dstate;
842 if (constraint->min_dstate < 0) {
843 acpi_handle_debug(lps0_device_handle,
844 "Incomplete constraint defined\n");
848 lpi_constraints_table_size++;
851 acpi_handle_debug(lps0_device_handle, "LPI: constraints list end\n");
857 static void lpi_check_constraints(void)
861 for (i = 0; i < lpi_constraints_table_size; ++i) {
862 acpi_handle handle = lpi_constraints_table[i].handle;
863 struct acpi_device *adev;
865 if (!handle || acpi_bus_get_device(handle, &adev))
868 acpi_handle_debug(handle,
869 "LPI: required min power state:%s current power state:%s\n",
870 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
871 acpi_power_state_string(adev->power.state));
873 if (!adev->flags.power_manageable) {
874 acpi_handle_info(handle, "LPI: Device not power manageable\n");
875 lpi_constraints_table[i].handle = NULL;
879 if (adev->power.state < lpi_constraints_table[i].min_dstate)
880 acpi_handle_info(handle,
881 "LPI: Constraint not met; min power state:%s current power state:%s\n",
882 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
883 acpi_power_state_string(adev->power.state));
887 static void acpi_sleep_run_lps0_dsm(unsigned int func)
889 union acpi_object *out_obj;
891 if (!(lps0_dsm_func_mask & (1 << func)))
894 out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL);
897 acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n",
898 func, out_obj ? "successful" : "failed");
901 static int lps0_device_attach(struct acpi_device *adev,
902 const struct acpi_device_id *not_used)
904 union acpi_object *out_obj;
906 if (lps0_device_handle)
909 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0))
912 guid_parse(ACPI_LPS0_DSM_UUID, &lps0_dsm_guid);
913 /* Check if the _DSM is present and as expected. */
914 out_obj = acpi_evaluate_dsm(adev->handle, &lps0_dsm_guid, 1, 0, NULL);
915 if (!out_obj || out_obj->type != ACPI_TYPE_BUFFER) {
916 acpi_handle_debug(adev->handle,
917 "_DSM function 0 evaluation failed\n");
921 lps0_dsm_func_mask = *(char *)out_obj->buffer.pointer;
925 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n",
928 lps0_device_handle = adev->handle;
930 lpi_device_get_constraints();
933 * Use suspend-to-idle by default if the default suspend mode was not
934 * set from the command line.
936 if (mem_sleep_default > PM_SUSPEND_MEM && !acpi_sleep_default_s3)
937 mem_sleep_current = PM_SUSPEND_TO_IDLE;
940 * Some LPS0 systems, like ASUS Zenbook UX430UNR/i7-8550U, require the
941 * EC GPE to be enabled while suspended for certain wakeup devices to
942 * work, so mark it as wakeup-capable.
944 acpi_ec_mark_gpe_for_wake();
949 static struct acpi_scan_handler lps0_handler = {
950 .ids = lps0_device_ids,
951 .attach = lps0_device_attach,
954 static int acpi_s2idle_begin(void)
956 acpi_scan_lock_acquire();
960 static int acpi_s2idle_prepare(void)
962 if (acpi_sci_irq_valid()) {
963 enable_irq_wake(acpi_sci_irq);
964 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
967 acpi_enable_wakeup_devices(ACPI_STATE_S0);
969 /* Change the configuration of GPEs to avoid spurious wakeup. */
970 acpi_enable_all_wakeup_gpes();
971 acpi_os_wait_events_complete();
973 s2idle_wakeup = true;
977 static int acpi_s2idle_prepare_late(void)
979 if (!lps0_device_handle || sleep_no_lps0)
982 if (pm_debug_messages_on)
983 lpi_check_constraints();
985 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF);
986 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY);
991 static bool acpi_s2idle_wake(void)
993 if (!acpi_sci_irq_valid())
994 return pm_wakeup_pending();
996 while (pm_wakeup_pending()) {
998 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the
999 * SCI has not triggered while suspended, so bail out (the
1000 * wakeup is pending anyway and the SCI is not the source of
1003 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) {
1004 pm_pr_dbg("Wakeup unrelated to ACPI SCI\n");
1009 * If the status bit of any enabled fixed event is set, the
1010 * wakeup is regarded as valid.
1012 if (acpi_any_fixed_event_status_set()) {
1013 pm_pr_dbg("ACPI fixed event wakeup\n");
1017 /* Check wakeups from drivers sharing the SCI. */
1018 if (acpi_check_wakeup_handlers()) {
1019 pm_pr_dbg("ACPI custom handler wakeup\n");
1023 /* Check non-EC GPE wakeups and dispatch the EC GPE. */
1024 if (acpi_ec_dispatch_gpe()) {
1025 pm_pr_dbg("ACPI non-EC GPE wakeup\n");
1030 * Cancel the SCI wakeup and process all pending events in case
1031 * there are any wakeup ones in there.
1033 * Note that if any non-EC GPEs are active at this point, the
1034 * SCI will retrigger after the rearming below, so no events
1035 * should be missed by canceling the wakeup here.
1037 pm_system_cancel_wakeup();
1038 acpi_os_wait_events_complete();
1041 * The SCI is in the "suspended" state now and it cannot produce
1042 * new wakeup events till the rearming below, so if any of them
1043 * are pending here, they must be resulting from the processing
1044 * of EC events above or coming from somewhere else.
1046 if (pm_wakeup_pending()) {
1047 pm_pr_dbg("Wakeup after ACPI Notify sync\n");
1051 pm_wakeup_clear(acpi_sci_irq);
1052 rearm_wake_irq(acpi_sci_irq);
1058 static void acpi_s2idle_restore_early(void)
1060 if (!lps0_device_handle || sleep_no_lps0)
1063 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT);
1064 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON);
1067 static void acpi_s2idle_restore(void)
1070 * Drain pending events before restoring the working-state configuration
1073 acpi_os_wait_events_complete(); /* synchronize GPE processing */
1074 acpi_ec_flush_work(); /* flush the EC driver's workqueues */
1075 acpi_os_wait_events_complete(); /* synchronize Notify handling */
1077 s2idle_wakeup = false;
1079 acpi_enable_all_runtime_gpes();
1081 acpi_disable_wakeup_devices(ACPI_STATE_S0);
1083 if (acpi_sci_irq_valid()) {
1084 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
1085 disable_irq_wake(acpi_sci_irq);
1089 static void acpi_s2idle_end(void)
1091 acpi_scan_lock_release();
1094 static const struct platform_s2idle_ops acpi_s2idle_ops = {
1095 .begin = acpi_s2idle_begin,
1096 .prepare = acpi_s2idle_prepare,
1097 .prepare_late = acpi_s2idle_prepare_late,
1098 .wake = acpi_s2idle_wake,
1099 .restore_early = acpi_s2idle_restore_early,
1100 .restore = acpi_s2idle_restore,
1101 .end = acpi_s2idle_end,
1104 static void acpi_sleep_suspend_setup(void)
1108 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
1109 if (acpi_sleep_state_supported(i))
1110 sleep_states[i] = 1;
1112 suspend_set_ops(old_suspend_ordering ?
1113 &acpi_suspend_ops_old : &acpi_suspend_ops);
1115 acpi_scan_add_handler(&lps0_handler);
1116 s2idle_set_ops(&acpi_s2idle_ops);
1119 #else /* !CONFIG_SUSPEND */
1120 #define s2idle_wakeup (false)
1121 #define lps0_device_handle (NULL)
1122 static inline void acpi_sleep_suspend_setup(void) {}
1123 #endif /* !CONFIG_SUSPEND */
1125 bool acpi_s2idle_wakeup(void)
1127 return s2idle_wakeup;
1130 #ifdef CONFIG_PM_SLEEP
1131 static u32 saved_bm_rld;
1133 static int acpi_save_bm_rld(void)
1135 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
1139 static void acpi_restore_bm_rld(void)
1141 u32 resumed_bm_rld = 0;
1143 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
1144 if (resumed_bm_rld == saved_bm_rld)
1147 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
1150 static struct syscore_ops acpi_sleep_syscore_ops = {
1151 .suspend = acpi_save_bm_rld,
1152 .resume = acpi_restore_bm_rld,
1155 static void acpi_sleep_syscore_init(void)
1157 register_syscore_ops(&acpi_sleep_syscore_ops);
1160 static inline void acpi_sleep_syscore_init(void) {}
1161 #endif /* CONFIG_PM_SLEEP */
1163 #ifdef CONFIG_HIBERNATION
1164 static unsigned long s4_hardware_signature;
1165 static struct acpi_table_facs *facs;
1166 static bool nosigcheck;
1168 void __init acpi_no_s4_hw_signature(void)
1173 static int acpi_hibernation_begin(pm_message_t stage)
1176 int error = suspend_nvs_alloc();
1181 if (stage.event == PM_EVENT_HIBERNATE)
1182 pm_set_suspend_via_firmware();
1184 acpi_pm_start(ACPI_STATE_S4);
1188 static int acpi_hibernation_enter(void)
1190 acpi_status status = AE_OK;
1192 ACPI_FLUSH_CPU_CACHE();
1194 /* This shouldn't return. If it returns, we have a problem */
1195 status = acpi_enter_sleep_state(ACPI_STATE_S4);
1196 /* Reprogram control registers */
1197 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1199 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
1202 static void acpi_hibernation_leave(void)
1204 pm_set_resume_via_firmware();
1206 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
1210 /* Reprogram control registers */
1211 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1212 /* Check the hardware signature */
1213 if (facs && s4_hardware_signature != facs->hardware_signature)
1214 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
1215 /* Restore the NVS memory area */
1216 suspend_nvs_restore();
1217 /* Allow EC transactions to happen. */
1218 acpi_ec_unblock_transactions();
1221 static void acpi_pm_thaw(void)
1223 acpi_ec_unblock_transactions();
1224 acpi_enable_all_runtime_gpes();
1227 static const struct platform_hibernation_ops acpi_hibernation_ops = {
1228 .begin = acpi_hibernation_begin,
1230 .pre_snapshot = acpi_pm_prepare,
1231 .finish = acpi_pm_finish,
1232 .prepare = acpi_pm_prepare,
1233 .enter = acpi_hibernation_enter,
1234 .leave = acpi_hibernation_leave,
1235 .pre_restore = acpi_pm_freeze,
1236 .restore_cleanup = acpi_pm_thaw,
1240 * acpi_hibernation_begin_old - Set the target system sleep state to
1241 * ACPI_STATE_S4 and execute the _PTS control method. This
1242 * function is used if the pre-ACPI 2.0 suspend ordering has been
1245 static int acpi_hibernation_begin_old(pm_message_t stage)
1249 * The _TTS object should always be evaluated before the _PTS object.
1250 * When the old_suspended_ordering is true, the _PTS object is
1251 * evaluated in the acpi_sleep_prepare.
1253 acpi_sleep_tts_switch(ACPI_STATE_S4);
1255 error = acpi_sleep_prepare(ACPI_STATE_S4);
1260 error = suspend_nvs_alloc();
1265 if (stage.event == PM_EVENT_HIBERNATE)
1266 pm_set_suspend_via_firmware();
1268 acpi_target_sleep_state = ACPI_STATE_S4;
1269 acpi_scan_lock_acquire();
1274 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1277 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1278 .begin = acpi_hibernation_begin_old,
1280 .pre_snapshot = acpi_pm_pre_suspend,
1281 .prepare = acpi_pm_freeze,
1282 .finish = acpi_pm_finish,
1283 .enter = acpi_hibernation_enter,
1284 .leave = acpi_hibernation_leave,
1285 .pre_restore = acpi_pm_freeze,
1286 .restore_cleanup = acpi_pm_thaw,
1287 .recover = acpi_pm_finish,
1290 static void acpi_sleep_hibernate_setup(void)
1292 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1295 hibernation_set_ops(old_suspend_ordering ?
1296 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1297 sleep_states[ACPI_STATE_S4] = 1;
1301 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1303 s4_hardware_signature = facs->hardware_signature;
1305 #else /* !CONFIG_HIBERNATION */
1306 static inline void acpi_sleep_hibernate_setup(void) {}
1307 #endif /* !CONFIG_HIBERNATION */
1309 static void acpi_power_off_prepare(void)
1311 /* Prepare to power off the system */
1312 acpi_sleep_prepare(ACPI_STATE_S5);
1313 acpi_disable_all_gpes();
1314 acpi_os_wait_events_complete();
1317 static void acpi_power_off(void)
1319 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1320 printk(KERN_DEBUG "%s called\n", __func__);
1321 local_irq_disable();
1322 acpi_enter_sleep_state(ACPI_STATE_S5);
1325 int __init acpi_sleep_init(void)
1327 char supported[ACPI_S_STATE_COUNT * 3 + 1];
1328 char *pos = supported;
1331 acpi_sleep_dmi_check();
1333 sleep_states[ACPI_STATE_S0] = 1;
1335 acpi_sleep_syscore_init();
1336 acpi_sleep_suspend_setup();
1337 acpi_sleep_hibernate_setup();
1339 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1340 sleep_states[ACPI_STATE_S5] = 1;
1341 pm_power_off_prepare = acpi_power_off_prepare;
1342 pm_power_off = acpi_power_off;
1348 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1349 if (sleep_states[i])
1350 pos += sprintf(pos, " S%d", i);
1352 pr_info(PREFIX "(supports%s)\n", supported);
1355 * Register the tts_notifier to reboot notifier list so that the _TTS
1356 * object can also be evaluated when the system enters S5.
1358 register_reboot_notifier(&tts_notifier);