1 // SPDX-License-Identifier: GPL-2.0-only
3 * sleep.c - ACPI sleep support.
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 * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using
369 * the Low Power S0 Idle firmware interface (see
370 * https://bugzilla.kernel.org/show_bug.cgi?id=199057).
373 .callback = init_default_s3,
374 .ident = "ThinkPad X1 Tablet(2016)",
376 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
377 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"),
383 static bool ignore_blacklist;
385 void __init acpi_sleep_no_blacklist(void)
387 ignore_blacklist = true;
390 static void __init acpi_sleep_dmi_check(void)
392 if (ignore_blacklist)
395 if (dmi_get_bios_year() >= 2012)
396 acpi_nvs_nosave_s3();
398 dmi_check_system(acpisleep_dmi_table);
402 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
404 static int acpi_pm_freeze(void)
406 acpi_disable_all_gpes();
407 acpi_os_wait_events_complete();
408 acpi_ec_block_transactions();
413 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
415 static int acpi_pm_pre_suspend(void)
418 return suspend_nvs_save();
422 * __acpi_pm_prepare - Prepare the platform to enter the target state.
424 * If necessary, set the firmware waking vector and do arch-specific
425 * nastiness to get the wakeup code to the waking vector.
427 static int __acpi_pm_prepare(void)
429 int error = acpi_sleep_prepare(acpi_target_sleep_state);
431 acpi_target_sleep_state = ACPI_STATE_S0;
437 * acpi_pm_prepare - Prepare the platform to enter the target sleep
438 * state and disable the GPEs.
440 static int acpi_pm_prepare(void)
442 int error = __acpi_pm_prepare();
444 error = acpi_pm_pre_suspend();
450 * acpi_pm_finish - Instruct the platform to leave a sleep state.
452 * This is called after we wake back up (or if entering the sleep state
455 static void acpi_pm_finish(void)
457 struct acpi_device *pwr_btn_adev;
458 u32 acpi_state = acpi_target_sleep_state;
460 acpi_ec_unblock_transactions();
463 if (acpi_state == ACPI_STATE_S0)
466 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
468 acpi_disable_wakeup_devices(acpi_state);
469 acpi_leave_sleep_state(acpi_state);
471 /* reset firmware waking vector */
472 acpi_set_waking_vector(0);
474 acpi_target_sleep_state = ACPI_STATE_S0;
476 acpi_resume_power_resources();
478 /* If we were woken with the fixed power button, provide a small
479 * hint to userspace in the form of a wakeup event on the fixed power
480 * button device (if it can be found).
482 * We delay the event generation til now, as the PM layer requires
483 * timekeeping to be running before we generate events. */
484 if (!pwr_btn_event_pending)
487 pwr_btn_event_pending = false;
488 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
491 pm_wakeup_event(&pwr_btn_adev->dev, 0);
492 acpi_dev_put(pwr_btn_adev);
497 * acpi_pm_start - Start system PM transition.
499 static void acpi_pm_start(u32 acpi_state)
501 acpi_target_sleep_state = acpi_state;
502 acpi_sleep_tts_switch(acpi_target_sleep_state);
503 acpi_scan_lock_acquire();
507 * acpi_pm_end - Finish up system PM transition.
509 static void acpi_pm_end(void)
511 acpi_turn_off_unused_power_resources();
512 acpi_scan_lock_release();
514 * This is necessary in case acpi_pm_finish() is not called during a
515 * failing transition to a sleep state.
517 acpi_target_sleep_state = ACPI_STATE_S0;
518 acpi_sleep_tts_switch(acpi_target_sleep_state);
520 #else /* !CONFIG_ACPI_SLEEP */
521 #define sleep_no_lps0 (1)
522 #define acpi_target_sleep_state ACPI_STATE_S0
523 #define acpi_sleep_default_s3 (1)
524 static inline void acpi_sleep_dmi_check(void) {}
525 #endif /* CONFIG_ACPI_SLEEP */
527 #ifdef CONFIG_SUSPEND
528 static u32 acpi_suspend_states[] = {
529 [PM_SUSPEND_ON] = ACPI_STATE_S0,
530 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
531 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
532 [PM_SUSPEND_MAX] = ACPI_STATE_S5
536 * acpi_suspend_begin - Set the target system sleep state to the state
537 * associated with given @pm_state, if supported.
539 static int acpi_suspend_begin(suspend_state_t pm_state)
541 u32 acpi_state = acpi_suspend_states[pm_state];
544 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
548 if (!sleep_states[acpi_state]) {
549 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
552 if (acpi_state > ACPI_STATE_S1)
553 pm_set_suspend_via_firmware();
555 acpi_pm_start(acpi_state);
560 * acpi_suspend_enter - Actually enter a sleep state.
563 * Flush caches and go to sleep. For STR we have to call arch-specific
564 * assembly, which in turn call acpi_enter_sleep_state().
565 * It's unfortunate, but it works. Please fix if you're feeling frisky.
567 static int acpi_suspend_enter(suspend_state_t pm_state)
569 acpi_status status = AE_OK;
570 u32 acpi_state = acpi_target_sleep_state;
573 ACPI_FLUSH_CPU_CACHE();
575 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
576 switch (acpi_state) {
579 status = acpi_enter_sleep_state(acpi_state);
583 if (!acpi_suspend_lowlevel)
585 error = acpi_suspend_lowlevel();
588 pr_info(PREFIX "Low-level resume complete\n");
589 pm_set_resume_via_firmware();
592 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
594 /* This violates the spec but is required for bug compatibility. */
595 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
597 /* Reprogram control registers */
598 acpi_leave_sleep_state_prep(acpi_state);
600 /* ACPI 3.0 specs (P62) says that it's the responsibility
601 * of the OSPM to clear the status bit [ implying that the
602 * POWER_BUTTON event should not reach userspace ]
604 * However, we do generate a small hint for userspace in the form of
605 * a wakeup event. We flag this condition for now and generate the
606 * event later, as we're currently too early in resume to be able to
607 * generate wakeup events.
609 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
610 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
612 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
614 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
615 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
617 pwr_btn_event_pending = true;
622 * Disable and clear GPE status before interrupt is enabled. Some GPEs
623 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
624 * acpi_leave_sleep_state will reenable specific GPEs later
626 acpi_disable_all_gpes();
627 /* Allow EC transactions to happen. */
628 acpi_ec_unblock_transactions();
630 suspend_nvs_restore();
632 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
635 static int acpi_suspend_state_valid(suspend_state_t pm_state)
641 case PM_SUSPEND_STANDBY:
643 acpi_state = acpi_suspend_states[pm_state];
645 return sleep_states[acpi_state];
651 static const struct platform_suspend_ops acpi_suspend_ops = {
652 .valid = acpi_suspend_state_valid,
653 .begin = acpi_suspend_begin,
654 .prepare_late = acpi_pm_prepare,
655 .enter = acpi_suspend_enter,
656 .wake = acpi_pm_finish,
661 * acpi_suspend_begin_old - Set the target system sleep state to the
662 * state associated with given @pm_state, if supported, and
663 * execute the _PTS control method. This function is used if the
664 * pre-ACPI 2.0 suspend ordering has been requested.
666 static int acpi_suspend_begin_old(suspend_state_t pm_state)
668 int error = acpi_suspend_begin(pm_state);
670 error = __acpi_pm_prepare();
676 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
679 static const struct platform_suspend_ops acpi_suspend_ops_old = {
680 .valid = acpi_suspend_state_valid,
681 .begin = acpi_suspend_begin_old,
682 .prepare_late = acpi_pm_pre_suspend,
683 .enter = acpi_suspend_enter,
684 .wake = acpi_pm_finish,
686 .recover = acpi_pm_finish,
689 static bool s2idle_wakeup;
692 * On platforms supporting the Low Power S0 Idle interface there is an ACPI
693 * device object with the PNP0D80 compatible device ID (System Power Management
694 * Controller) and a specific _DSM method under it. That method, if present,
695 * can be used to indicate to the platform that the OS is transitioning into a
696 * low-power state in which certain types of activity are not desirable or that
697 * it is leaving such a state, which allows the platform to adjust its operation
700 static const struct acpi_device_id lps0_device_ids[] = {
705 #define ACPI_LPS0_DSM_UUID "c4eb40a0-6cd2-11e2-bcfd-0800200c9a66"
707 #define ACPI_LPS0_GET_DEVICE_CONSTRAINTS 1
708 #define ACPI_LPS0_SCREEN_OFF 3
709 #define ACPI_LPS0_SCREEN_ON 4
710 #define ACPI_LPS0_ENTRY 5
711 #define ACPI_LPS0_EXIT 6
713 static acpi_handle lps0_device_handle;
714 static guid_t lps0_dsm_guid;
715 static char lps0_dsm_func_mask;
717 /* Device constraint entry structure */
718 struct lpi_device_info {
721 union acpi_object *package;
724 /* Constraint package structure */
725 struct lpi_device_constraint {
731 struct lpi_constraints {
736 static struct lpi_constraints *lpi_constraints_table;
737 static int lpi_constraints_table_size;
739 static void lpi_device_get_constraints(void)
741 union acpi_object *out_obj;
744 out_obj = acpi_evaluate_dsm_typed(lps0_device_handle, &lps0_dsm_guid,
745 1, ACPI_LPS0_GET_DEVICE_CONSTRAINTS,
746 NULL, ACPI_TYPE_PACKAGE);
748 acpi_handle_debug(lps0_device_handle, "_DSM function 1 eval %s\n",
749 out_obj ? "successful" : "failed");
754 lpi_constraints_table = kcalloc(out_obj->package.count,
755 sizeof(*lpi_constraints_table),
757 if (!lpi_constraints_table)
758 goto free_acpi_buffer;
760 acpi_handle_debug(lps0_device_handle, "LPI: constraints list begin:\n");
762 for (i = 0; i < out_obj->package.count; i++) {
763 struct lpi_constraints *constraint;
765 union acpi_object *package = &out_obj->package.elements[i];
766 struct lpi_device_info info = { };
767 int package_count = 0, j;
772 for (j = 0; j < package->package.count; ++j) {
773 union acpi_object *element =
774 &(package->package.elements[j]);
776 switch (element->type) {
777 case ACPI_TYPE_INTEGER:
778 info.enabled = element->integer.value;
780 case ACPI_TYPE_STRING:
781 info.name = element->string.pointer;
783 case ACPI_TYPE_PACKAGE:
784 package_count = element->package.count;
785 info.package = element->package.elements;
790 if (!info.enabled || !info.package || !info.name)
793 constraint = &lpi_constraints_table[lpi_constraints_table_size];
795 status = acpi_get_handle(NULL, info.name, &constraint->handle);
796 if (ACPI_FAILURE(status))
799 acpi_handle_debug(lps0_device_handle,
800 "index:%d Name:%s\n", i, info.name);
802 constraint->min_dstate = -1;
804 for (j = 0; j < package_count; ++j) {
805 union acpi_object *info_obj = &info.package[j];
806 union acpi_object *cnstr_pkg;
807 union acpi_object *obj;
808 struct lpi_device_constraint dev_info;
810 switch (info_obj->type) {
811 case ACPI_TYPE_INTEGER:
814 case ACPI_TYPE_PACKAGE:
815 if (info_obj->package.count < 2)
818 cnstr_pkg = info_obj->package.elements;
820 dev_info.uid = obj->integer.value;
822 dev_info.min_dstate = obj->integer.value;
824 acpi_handle_debug(lps0_device_handle,
825 "uid:%d min_dstate:%s\n",
827 acpi_power_state_string(dev_info.min_dstate));
829 constraint->min_dstate = dev_info.min_dstate;
834 if (constraint->min_dstate < 0) {
835 acpi_handle_debug(lps0_device_handle,
836 "Incomplete constraint defined\n");
840 lpi_constraints_table_size++;
843 acpi_handle_debug(lps0_device_handle, "LPI: constraints list end\n");
849 static void lpi_check_constraints(void)
853 for (i = 0; i < lpi_constraints_table_size; ++i) {
854 acpi_handle handle = lpi_constraints_table[i].handle;
855 struct acpi_device *adev;
857 if (!handle || acpi_bus_get_device(handle, &adev))
860 acpi_handle_debug(handle,
861 "LPI: required min power state:%s current power state:%s\n",
862 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
863 acpi_power_state_string(adev->power.state));
865 if (!adev->flags.power_manageable) {
866 acpi_handle_info(handle, "LPI: Device not power manageable\n");
867 lpi_constraints_table[i].handle = NULL;
871 if (adev->power.state < lpi_constraints_table[i].min_dstate)
872 acpi_handle_info(handle,
873 "LPI: Constraint not met; min power state:%s current power state:%s\n",
874 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
875 acpi_power_state_string(adev->power.state));
879 static void acpi_sleep_run_lps0_dsm(unsigned int func)
881 union acpi_object *out_obj;
883 if (!(lps0_dsm_func_mask & (1 << func)))
886 out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL);
889 acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n",
890 func, out_obj ? "successful" : "failed");
893 static int lps0_device_attach(struct acpi_device *adev,
894 const struct acpi_device_id *not_used)
896 union acpi_object *out_obj;
898 if (lps0_device_handle)
901 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0))
904 guid_parse(ACPI_LPS0_DSM_UUID, &lps0_dsm_guid);
905 /* Check if the _DSM is present and as expected. */
906 out_obj = acpi_evaluate_dsm(adev->handle, &lps0_dsm_guid, 1, 0, NULL);
907 if (!out_obj || out_obj->type != ACPI_TYPE_BUFFER) {
908 acpi_handle_debug(adev->handle,
909 "_DSM function 0 evaluation failed\n");
913 lps0_dsm_func_mask = *(char *)out_obj->buffer.pointer;
917 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n",
920 lps0_device_handle = adev->handle;
922 lpi_device_get_constraints();
925 * Use suspend-to-idle by default if the default suspend mode was not
926 * set from the command line.
928 if (mem_sleep_default > PM_SUSPEND_MEM && !acpi_sleep_default_s3)
929 mem_sleep_current = PM_SUSPEND_TO_IDLE;
932 * Some LPS0 systems, like ASUS Zenbook UX430UNR/i7-8550U, require the
933 * EC GPE to be enabled while suspended for certain wakeup devices to
934 * work, so mark it as wakeup-capable.
936 acpi_ec_mark_gpe_for_wake();
941 static struct acpi_scan_handler lps0_handler = {
942 .ids = lps0_device_ids,
943 .attach = lps0_device_attach,
946 static int acpi_s2idle_begin(void)
948 acpi_scan_lock_acquire();
952 static int acpi_s2idle_prepare(void)
954 if (acpi_sci_irq_valid()) {
955 enable_irq_wake(acpi_sci_irq);
956 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
959 acpi_enable_wakeup_devices(ACPI_STATE_S0);
961 /* Change the configuration of GPEs to avoid spurious wakeup. */
962 acpi_enable_all_wakeup_gpes();
963 acpi_os_wait_events_complete();
965 s2idle_wakeup = true;
969 static int acpi_s2idle_prepare_late(void)
971 if (!lps0_device_handle || sleep_no_lps0)
974 if (pm_debug_messages_on)
975 lpi_check_constraints();
977 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF);
978 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY);
983 static void acpi_s2idle_sync(void)
985 /* The EC driver uses special workqueues that need to be flushed. */
986 acpi_ec_flush_work();
987 acpi_os_wait_events_complete(); /* synchronize Notify handling */
990 static bool acpi_s2idle_wake(void)
992 if (!acpi_sci_irq_valid())
993 return pm_wakeup_pending();
995 while (pm_wakeup_pending()) {
997 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the
998 * SCI has not triggered while suspended, so bail out (the
999 * wakeup is pending anyway and the SCI is not the source of
1002 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq)))
1006 * If the status bit of any enabled fixed event is set, the
1007 * wakeup is regarded as valid.
1009 if (acpi_any_fixed_event_status_set())
1012 /* Check wakeups from drivers sharing the SCI. */
1013 if (acpi_check_wakeup_handlers())
1017 * If the status bit is set for any enabled GPE other than the
1018 * EC one, the wakeup is regarded as a genuine one.
1020 if (acpi_ec_other_gpes_active())
1024 * If the EC GPE status bit has not been set, the wakeup is
1025 * regarded as a spurious one.
1027 if (!acpi_ec_dispatch_gpe())
1031 * Cancel the wakeup and process all pending events in case
1032 * there are any wakeup ones in there.
1034 * Note that if any non-EC GPEs are active at this point, the
1035 * SCI will retrigger after the rearming below, so no events
1036 * should be missed by canceling the wakeup here.
1038 pm_system_cancel_wakeup();
1043 * The SCI is in the "suspended" state now and it cannot produce
1044 * new wakeup events till the rearming below, so if any of them
1045 * are pending here, they must be resulting from the processing
1046 * of EC events above or coming from somewhere else.
1048 if (pm_wakeup_pending())
1051 rearm_wake_irq(acpi_sci_irq);
1057 static void acpi_s2idle_restore_early(void)
1059 if (!lps0_device_handle || sleep_no_lps0)
1062 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT);
1063 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON);
1066 static void acpi_s2idle_restore(void)
1069 * Drain pending events before restoring the working-state configuration
1072 acpi_os_wait_events_complete(); /* synchronize GPE processing */
1075 s2idle_wakeup = false;
1077 acpi_enable_all_runtime_gpes();
1079 acpi_disable_wakeup_devices(ACPI_STATE_S0);
1081 if (acpi_sci_irq_valid()) {
1082 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
1083 disable_irq_wake(acpi_sci_irq);
1087 static void acpi_s2idle_end(void)
1089 acpi_scan_lock_release();
1092 static const struct platform_s2idle_ops acpi_s2idle_ops = {
1093 .begin = acpi_s2idle_begin,
1094 .prepare = acpi_s2idle_prepare,
1095 .prepare_late = acpi_s2idle_prepare_late,
1096 .wake = acpi_s2idle_wake,
1097 .restore_early = acpi_s2idle_restore_early,
1098 .restore = acpi_s2idle_restore,
1099 .end = acpi_s2idle_end,
1102 static void acpi_sleep_suspend_setup(void)
1106 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
1107 if (acpi_sleep_state_supported(i))
1108 sleep_states[i] = 1;
1110 suspend_set_ops(old_suspend_ordering ?
1111 &acpi_suspend_ops_old : &acpi_suspend_ops);
1113 acpi_scan_add_handler(&lps0_handler);
1114 s2idle_set_ops(&acpi_s2idle_ops);
1117 #else /* !CONFIG_SUSPEND */
1118 #define s2idle_wakeup (false)
1119 #define lps0_device_handle (NULL)
1120 static inline void acpi_sleep_suspend_setup(void) {}
1121 #endif /* !CONFIG_SUSPEND */
1123 bool acpi_s2idle_wakeup(void)
1125 return s2idle_wakeup;
1128 #ifdef CONFIG_PM_SLEEP
1129 static u32 saved_bm_rld;
1131 static int acpi_save_bm_rld(void)
1133 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
1137 static void acpi_restore_bm_rld(void)
1139 u32 resumed_bm_rld = 0;
1141 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
1142 if (resumed_bm_rld == saved_bm_rld)
1145 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
1148 static struct syscore_ops acpi_sleep_syscore_ops = {
1149 .suspend = acpi_save_bm_rld,
1150 .resume = acpi_restore_bm_rld,
1153 static void acpi_sleep_syscore_init(void)
1155 register_syscore_ops(&acpi_sleep_syscore_ops);
1158 static inline void acpi_sleep_syscore_init(void) {}
1159 #endif /* CONFIG_PM_SLEEP */
1161 #ifdef CONFIG_HIBERNATION
1162 static unsigned long s4_hardware_signature;
1163 static struct acpi_table_facs *facs;
1164 static bool nosigcheck;
1166 void __init acpi_no_s4_hw_signature(void)
1171 static int acpi_hibernation_begin(pm_message_t stage)
1174 int error = suspend_nvs_alloc();
1179 if (stage.event == PM_EVENT_HIBERNATE)
1180 pm_set_suspend_via_firmware();
1182 acpi_pm_start(ACPI_STATE_S4);
1186 static int acpi_hibernation_enter(void)
1188 acpi_status status = AE_OK;
1190 ACPI_FLUSH_CPU_CACHE();
1192 /* This shouldn't return. If it returns, we have a problem */
1193 status = acpi_enter_sleep_state(ACPI_STATE_S4);
1194 /* Reprogram control registers */
1195 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1197 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
1200 static void acpi_hibernation_leave(void)
1202 pm_set_resume_via_firmware();
1204 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
1208 /* Reprogram control registers */
1209 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1210 /* Check the hardware signature */
1211 if (facs && s4_hardware_signature != facs->hardware_signature)
1212 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
1213 /* Restore the NVS memory area */
1214 suspend_nvs_restore();
1215 /* Allow EC transactions to happen. */
1216 acpi_ec_unblock_transactions();
1219 static void acpi_pm_thaw(void)
1221 acpi_ec_unblock_transactions();
1222 acpi_enable_all_runtime_gpes();
1225 static const struct platform_hibernation_ops acpi_hibernation_ops = {
1226 .begin = acpi_hibernation_begin,
1228 .pre_snapshot = acpi_pm_prepare,
1229 .finish = acpi_pm_finish,
1230 .prepare = acpi_pm_prepare,
1231 .enter = acpi_hibernation_enter,
1232 .leave = acpi_hibernation_leave,
1233 .pre_restore = acpi_pm_freeze,
1234 .restore_cleanup = acpi_pm_thaw,
1238 * acpi_hibernation_begin_old - Set the target system sleep state to
1239 * ACPI_STATE_S4 and execute the _PTS control method. This
1240 * function is used if the pre-ACPI 2.0 suspend ordering has been
1243 static int acpi_hibernation_begin_old(pm_message_t stage)
1247 * The _TTS object should always be evaluated before the _PTS object.
1248 * When the old_suspended_ordering is true, the _PTS object is
1249 * evaluated in the acpi_sleep_prepare.
1251 acpi_sleep_tts_switch(ACPI_STATE_S4);
1253 error = acpi_sleep_prepare(ACPI_STATE_S4);
1258 error = suspend_nvs_alloc();
1263 if (stage.event == PM_EVENT_HIBERNATE)
1264 pm_set_suspend_via_firmware();
1266 acpi_target_sleep_state = ACPI_STATE_S4;
1267 acpi_scan_lock_acquire();
1272 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1275 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1276 .begin = acpi_hibernation_begin_old,
1278 .pre_snapshot = acpi_pm_pre_suspend,
1279 .prepare = acpi_pm_freeze,
1280 .finish = acpi_pm_finish,
1281 .enter = acpi_hibernation_enter,
1282 .leave = acpi_hibernation_leave,
1283 .pre_restore = acpi_pm_freeze,
1284 .restore_cleanup = acpi_pm_thaw,
1285 .recover = acpi_pm_finish,
1288 static void acpi_sleep_hibernate_setup(void)
1290 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1293 hibernation_set_ops(old_suspend_ordering ?
1294 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1295 sleep_states[ACPI_STATE_S4] = 1;
1299 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1301 s4_hardware_signature = facs->hardware_signature;
1303 #else /* !CONFIG_HIBERNATION */
1304 static inline void acpi_sleep_hibernate_setup(void) {}
1305 #endif /* !CONFIG_HIBERNATION */
1307 static void acpi_power_off_prepare(void)
1309 /* Prepare to power off the system */
1310 acpi_sleep_prepare(ACPI_STATE_S5);
1311 acpi_disable_all_gpes();
1312 acpi_os_wait_events_complete();
1315 static void acpi_power_off(void)
1317 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1318 printk(KERN_DEBUG "%s called\n", __func__);
1319 local_irq_disable();
1320 acpi_enter_sleep_state(ACPI_STATE_S5);
1323 int __init acpi_sleep_init(void)
1325 char supported[ACPI_S_STATE_COUNT * 3 + 1];
1326 char *pos = supported;
1329 acpi_sleep_dmi_check();
1331 sleep_states[ACPI_STATE_S0] = 1;
1333 acpi_sleep_syscore_init();
1334 acpi_sleep_suspend_setup();
1335 acpi_sleep_hibernate_setup();
1337 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1338 sleep_states[ACPI_STATE_S5] = 1;
1339 pm_power_off_prepare = acpi_power_off_prepare;
1340 pm_power_off = acpi_power_off;
1346 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1347 if (sleep_states[i])
1348 pos += sprintf(pos, " S%d", i);
1350 pr_info(PREFIX "(supports%s)\n", supported);
1353 * Register the tts_notifier to reboot notifier list so that the _TTS
1354 * object can also be evaluated when the system enters S5.
1356 register_reboot_notifier(&tts_notifier);