Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * sleep.c - ACPI sleep support.
4 *
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
9 */
10
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>
21#include <asm/io.h>
22#include <trace/events/power.h>
23
24#include "internal.h"
25#include "sleep.h"
26
27/*
28 * Some HW-full platforms do not have _S5, so they may need
29 * to leverage efi power off for a shutdown.
30 */
31bool acpi_no_s5;
32static u8 sleep_states[ACPI_S_STATE_COUNT];
33
34static void acpi_sleep_tts_switch(u32 acpi_state)
35{
36 acpi_status status;
37
38 status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state);
39 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
40 /*
41 * OS can't evaluate the _TTS object correctly. Some warning
42 * message will be printed. But it won't break anything.
43 */
44 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
45 }
46}
47
48static int tts_notify_reboot(struct notifier_block *this,
49 unsigned long code, void *x)
50{
51 acpi_sleep_tts_switch(ACPI_STATE_S5);
52 return NOTIFY_DONE;
53}
54
55static struct notifier_block tts_notifier = {
56 .notifier_call = tts_notify_reboot,
57 .next = NULL,
58 .priority = 0,
59};
60
61static int acpi_sleep_prepare(u32 acpi_state)
62{
63#ifdef CONFIG_ACPI_SLEEP
64 unsigned long acpi_wakeup_address;
65
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)
70 return -EFAULT;
71 acpi_set_waking_vector(acpi_wakeup_address);
72
73 }
74 ACPI_FLUSH_CPU_CACHE();
75#endif
76 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
77 acpi_state);
78 acpi_enable_wakeup_devices(acpi_state);
79 acpi_enter_sleep_state_prep(acpi_state);
80 return 0;
81}
82
83bool acpi_sleep_state_supported(u8 sleep_state)
84{
85 acpi_status status;
86 u8 type_a, type_b;
87
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));
92}
93
94#ifdef CONFIG_ACPI_SLEEP
95static bool sleep_no_lps0 __read_mostly;
96module_param(sleep_no_lps0, bool, 0644);
97MODULE_PARM_DESC(sleep_no_lps0, "Do not use the special LPS0 device interface");
98
99static u32 acpi_target_sleep_state = ACPI_STATE_S0;
100
101u32 acpi_target_system_state(void)
102{
103 return acpi_target_sleep_state;
104}
105EXPORT_SYMBOL_GPL(acpi_target_system_state);
106
107static bool pwr_btn_event_pending;
108
109/*
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.
115 */
116static bool nvs_nosave;
117
118void __init acpi_nvs_nosave(void)
119{
120 nvs_nosave = true;
121}
122
123/*
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.
130 */
131static bool nvs_nosave_s3;
132
133void __init acpi_nvs_nosave_s3(void)
134{
135 nvs_nosave_s3 = true;
136}
137
138static int __init init_nvs_save_s3(const struct dmi_system_id *d)
139{
140 nvs_nosave_s3 = false;
141 return 0;
142}
143
144/*
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.
148 */
149static bool old_suspend_ordering;
150
151void __init acpi_old_suspend_ordering(void)
152{
153 old_suspend_ordering = true;
154}
155
156static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
157{
158 acpi_old_suspend_ordering();
159 return 0;
160}
161
162static int __init init_nvs_nosave(const struct dmi_system_id *d)
163{
164 acpi_nvs_nosave();
165 return 0;
166}
167
168static bool acpi_sleep_default_s3;
169
170static int __init init_default_s3(const struct dmi_system_id *d)
171{
172 acpi_sleep_default_s3 = true;
173 return 0;
174}
175
176static const struct dmi_system_id acpisleep_dmi_table[] __initconst = {
177 {
178 .callback = init_old_suspend_ordering,
179 .ident = "Abit KN9 (nForce4 variant)",
180 .matches = {
181 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
182 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
183 },
184 },
185 {
186 .callback = init_old_suspend_ordering,
187 .ident = "HP xw4600 Workstation",
188 .matches = {
189 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
190 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
191 },
192 },
193 {
194 .callback = init_old_suspend_ordering,
195 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
196 .matches = {
197 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
198 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
199 },
200 },
201 {
202 .callback = init_old_suspend_ordering,
203 .ident = "Panasonic CF51-2L",
204 .matches = {
205 DMI_MATCH(DMI_BOARD_VENDOR,
206 "Matsushita Electric Industrial Co.,Ltd."),
207 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
208 },
209 },
210 {
211 .callback = init_nvs_nosave,
212 .ident = "Sony Vaio VGN-FW41E_H",
213 .matches = {
214 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
215 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
216 },
217 },
218 {
219 .callback = init_nvs_nosave,
220 .ident = "Sony Vaio VGN-FW21E",
221 .matches = {
222 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
223 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
224 },
225 },
226 {
227 .callback = init_nvs_nosave,
228 .ident = "Sony Vaio VGN-FW21M",
229 .matches = {
230 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
231 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
232 },
233 },
234 {
235 .callback = init_nvs_nosave,
236 .ident = "Sony Vaio VPCEB17FX",
237 .matches = {
238 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
239 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
240 },
241 },
242 {
243 .callback = init_nvs_nosave,
244 .ident = "Sony Vaio VGN-SR11M",
245 .matches = {
246 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
247 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
248 },
249 },
250 {
251 .callback = init_nvs_nosave,
252 .ident = "Everex StepNote Series",
253 .matches = {
254 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
255 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
256 },
257 },
258 {
259 .callback = init_nvs_nosave,
260 .ident = "Sony Vaio VPCEB1Z1E",
261 .matches = {
262 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
263 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
264 },
265 },
266 {
267 .callback = init_nvs_nosave,
268 .ident = "Sony Vaio VGN-NW130D",
269 .matches = {
270 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
271 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
272 },
273 },
274 {
275 .callback = init_nvs_nosave,
276 .ident = "Sony Vaio VPCCW29FX",
277 .matches = {
278 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
279 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
280 },
281 },
282 {
283 .callback = init_nvs_nosave,
284 .ident = "Averatec AV1020-ED2",
285 .matches = {
286 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
287 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
288 },
289 },
290 {
291 .callback = init_old_suspend_ordering,
292 .ident = "Asus A8N-SLI DELUXE",
293 .matches = {
294 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
295 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
296 },
297 },
298 {
299 .callback = init_old_suspend_ordering,
300 .ident = "Asus A8N-SLI Premium",
301 .matches = {
302 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
303 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
304 },
305 },
306 {
307 .callback = init_nvs_nosave,
308 .ident = "Sony Vaio VGN-SR26GN_P",
309 .matches = {
310 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
311 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
312 },
313 },
314 {
315 .callback = init_nvs_nosave,
316 .ident = "Sony Vaio VPCEB1S1E",
317 .matches = {
318 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
319 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
320 },
321 },
322 {
323 .callback = init_nvs_nosave,
324 .ident = "Sony Vaio VGN-FW520F",
325 .matches = {
326 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
327 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
328 },
329 },
330 {
331 .callback = init_nvs_nosave,
332 .ident = "Asus K54C",
333 .matches = {
334 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
335 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
336 },
337 },
338 {
339 .callback = init_nvs_nosave,
340 .ident = "Asus K54HR",
341 .matches = {
342 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
343 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
344 },
345 },
346 {
347 .callback = init_nvs_save_s3,
348 .ident = "Asus 1025C",
349 .matches = {
350 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
351 DMI_MATCH(DMI_PRODUCT_NAME, "1025C"),
352 },
353 },
354 /*
355 * https://bugzilla.kernel.org/show_bug.cgi?id=189431
356 * Lenovo G50-45 is a platform later than 2012, but needs nvs memory
357 * saving during S3.
358 */
359 {
360 .callback = init_nvs_save_s3,
361 .ident = "Lenovo G50-45",
362 .matches = {
363 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
364 DMI_MATCH(DMI_PRODUCT_NAME, "80E3"),
365 },
366 },
367 /*
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).
371 */
372 {
373 .callback = init_default_s3,
374 .ident = "ThinkPad X1 Tablet(2016)",
375 .matches = {
376 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
377 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"),
378 },
379 },
380 {},
381};
382
383static bool ignore_blacklist;
384
385void __init acpi_sleep_no_blacklist(void)
386{
387 ignore_blacklist = true;
388}
389
390static void __init acpi_sleep_dmi_check(void)
391{
392 if (ignore_blacklist)
393 return;
394
395 if (dmi_get_bios_year() >= 2012)
396 acpi_nvs_nosave_s3();
397
398 dmi_check_system(acpisleep_dmi_table);
399}
400
401/**
402 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
403 */
404static int acpi_pm_freeze(void)
405{
406 acpi_disable_all_gpes();
407 acpi_os_wait_events_complete();
408 acpi_ec_block_transactions();
409 return 0;
410}
411
412/**
413 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
414 */
415static int acpi_pm_pre_suspend(void)
416{
417 acpi_pm_freeze();
418 return suspend_nvs_save();
419}
420
421/**
422 * __acpi_pm_prepare - Prepare the platform to enter the target state.
423 *
424 * If necessary, set the firmware waking vector and do arch-specific
425 * nastiness to get the wakeup code to the waking vector.
426 */
427static int __acpi_pm_prepare(void)
428{
429 int error = acpi_sleep_prepare(acpi_target_sleep_state);
430 if (error)
431 acpi_target_sleep_state = ACPI_STATE_S0;
432
433 return error;
434}
435
436/**
437 * acpi_pm_prepare - Prepare the platform to enter the target sleep
438 * state and disable the GPEs.
439 */
440static int acpi_pm_prepare(void)
441{
442 int error = __acpi_pm_prepare();
443 if (!error)
444 error = acpi_pm_pre_suspend();
445
446 return error;
447}
448
449/**
450 * acpi_pm_finish - Instruct the platform to leave a sleep state.
451 *
452 * This is called after we wake back up (or if entering the sleep state
453 * failed).
454 */
455static void acpi_pm_finish(void)
456{
457 struct acpi_device *pwr_btn_adev;
458 u32 acpi_state = acpi_target_sleep_state;
459
460 acpi_ec_unblock_transactions();
461 suspend_nvs_free();
462
463 if (acpi_state == ACPI_STATE_S0)
464 return;
465
466 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
467 acpi_state);
468 acpi_disable_wakeup_devices(acpi_state);
469 acpi_leave_sleep_state(acpi_state);
470
471 /* reset firmware waking vector */
472 acpi_set_waking_vector(0);
473
474 acpi_target_sleep_state = ACPI_STATE_S0;
475
476 acpi_resume_power_resources();
477
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).
481 *
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)
485 return;
486
487 pwr_btn_event_pending = false;
488 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
489 NULL, -1);
490 if (pwr_btn_adev) {
491 pm_wakeup_event(&pwr_btn_adev->dev, 0);
492 acpi_dev_put(pwr_btn_adev);
493 }
494}
495
496/**
497 * acpi_pm_start - Start system PM transition.
498 */
499static void acpi_pm_start(u32 acpi_state)
500{
501 acpi_target_sleep_state = acpi_state;
502 acpi_sleep_tts_switch(acpi_target_sleep_state);
503 acpi_scan_lock_acquire();
504}
505
506/**
507 * acpi_pm_end - Finish up system PM transition.
508 */
509static void acpi_pm_end(void)
510{
511 acpi_turn_off_unused_power_resources();
512 acpi_scan_lock_release();
513 /*
514 * This is necessary in case acpi_pm_finish() is not called during a
515 * failing transition to a sleep state.
516 */
517 acpi_target_sleep_state = ACPI_STATE_S0;
518 acpi_sleep_tts_switch(acpi_target_sleep_state);
519}
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)
524static inline void acpi_sleep_dmi_check(void) {}
525#endif /* CONFIG_ACPI_SLEEP */
526
527#ifdef CONFIG_SUSPEND
528static 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
533};
534
535/**
536 * acpi_suspend_begin - Set the target system sleep state to the state
537 * associated with given @pm_state, if supported.
538 */
539static int acpi_suspend_begin(suspend_state_t pm_state)
540{
541 u32 acpi_state = acpi_suspend_states[pm_state];
542 int error;
543
544 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
545 if (error)
546 return error;
547
548 if (!sleep_states[acpi_state]) {
549 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
550 return -ENOSYS;
551 }
552 if (acpi_state > ACPI_STATE_S1)
553 pm_set_suspend_via_firmware();
554
555 acpi_pm_start(acpi_state);
556 return 0;
557}
558
559/**
560 * acpi_suspend_enter - Actually enter a sleep state.
561 * @pm_state: ignored
562 *
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.
566 */
567static int acpi_suspend_enter(suspend_state_t pm_state)
568{
569 acpi_status status = AE_OK;
570 u32 acpi_state = acpi_target_sleep_state;
571 int error;
572
573 ACPI_FLUSH_CPU_CACHE();
574
575 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
576 switch (acpi_state) {
577 case ACPI_STATE_S1:
578 barrier();
579 status = acpi_enter_sleep_state(acpi_state);
580 break;
581
582 case ACPI_STATE_S3:
583 if (!acpi_suspend_lowlevel)
584 return -ENOSYS;
585 error = acpi_suspend_lowlevel();
586 if (error)
587 return error;
588 pr_info(PREFIX "Low-level resume complete\n");
589 pm_set_resume_via_firmware();
590 break;
591 }
592 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
593
594 /* This violates the spec but is required for bug compatibility. */
595 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
596
597 /* Reprogram control registers */
598 acpi_leave_sleep_state_prep(acpi_state);
599
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 ]
603 *
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.
608 */
609 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
610 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
611
612 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
613
614 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
615 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
616 /* Flag for later */
617 pwr_btn_event_pending = true;
618 }
619 }
620
621 /*
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
625 */
626 acpi_disable_all_gpes();
627 /* Allow EC transactions to happen. */
628 acpi_ec_unblock_transactions();
629
630 suspend_nvs_restore();
631
632 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
633}
634
635static int acpi_suspend_state_valid(suspend_state_t pm_state)
636{
637 u32 acpi_state;
638
639 switch (pm_state) {
640 case PM_SUSPEND_ON:
641 case PM_SUSPEND_STANDBY:
642 case PM_SUSPEND_MEM:
643 acpi_state = acpi_suspend_states[pm_state];
644
645 return sleep_states[acpi_state];
646 default:
647 return 0;
648 }
649}
650
651static 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,
657 .end = acpi_pm_end,
658};
659
660/**
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.
665 */
666static int acpi_suspend_begin_old(suspend_state_t pm_state)
667{
668 int error = acpi_suspend_begin(pm_state);
669 if (!error)
670 error = __acpi_pm_prepare();
671
672 return error;
673}
674
675/*
676 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
677 * been requested.
678 */
679static 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,
685 .end = acpi_pm_end,
686 .recover = acpi_pm_finish,
687};
688
689static bool s2idle_wakeup;
690
691/*
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
698 * mode accordingly.
699 */
700static const struct acpi_device_id lps0_device_ids[] = {
701 {"PNP0D80", },
702 {"", },
703};
704
705#define ACPI_LPS0_DSM_UUID "c4eb40a0-6cd2-11e2-bcfd-0800200c9a66"
706
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
712
713static acpi_handle lps0_device_handle;
714static guid_t lps0_dsm_guid;
715static char lps0_dsm_func_mask;
716
717/* Device constraint entry structure */
718struct lpi_device_info {
719 char *name;
720 int enabled;
721 union acpi_object *package;
722};
723
724/* Constraint package structure */
725struct lpi_device_constraint {
726 int uid;
727 int min_dstate;
728 int function_states;
729};
730
731struct lpi_constraints {
732 acpi_handle handle;
733 int min_dstate;
734};
735
736static struct lpi_constraints *lpi_constraints_table;
737static int lpi_constraints_table_size;
738
739static void lpi_device_get_constraints(void)
740{
741 union acpi_object *out_obj;
742 int i;
743
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);
747
748 acpi_handle_debug(lps0_device_handle, "_DSM function 1 eval %s\n",
749 out_obj ? "successful" : "failed");
750
751 if (!out_obj)
752 return;
753
754 lpi_constraints_table = kcalloc(out_obj->package.count,
755 sizeof(*lpi_constraints_table),
756 GFP_KERNEL);
757 if (!lpi_constraints_table)
758 goto free_acpi_buffer;
759
760 acpi_handle_debug(lps0_device_handle, "LPI: constraints list begin:\n");
761
762 for (i = 0; i < out_obj->package.count; i++) {
763 struct lpi_constraints *constraint;
764 acpi_status status;
765 union acpi_object *package = &out_obj->package.elements[i];
766 struct lpi_device_info info = { };
767 int package_count = 0, j;
768
769 if (!package)
770 continue;
771
772 for (j = 0; j < package->package.count; ++j) {
773 union acpi_object *element =
774 &(package->package.elements[j]);
775
776 switch (element->type) {
777 case ACPI_TYPE_INTEGER:
778 info.enabled = element->integer.value;
779 break;
780 case ACPI_TYPE_STRING:
781 info.name = element->string.pointer;
782 break;
783 case ACPI_TYPE_PACKAGE:
784 package_count = element->package.count;
785 info.package = element->package.elements;
786 break;
787 }
788 }
789
790 if (!info.enabled || !info.package || !info.name)
791 continue;
792
793 constraint = &lpi_constraints_table[lpi_constraints_table_size];
794
795 status = acpi_get_handle(NULL, info.name, &constraint->handle);
796 if (ACPI_FAILURE(status))
797 continue;
798
799 acpi_handle_debug(lps0_device_handle,
800 "index:%d Name:%s\n", i, info.name);
801
802 constraint->min_dstate = -1;
803
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;
809
810 switch (info_obj->type) {
811 case ACPI_TYPE_INTEGER:
812 /* version */
813 break;
814 case ACPI_TYPE_PACKAGE:
815 if (info_obj->package.count < 2)
816 break;
817
818 cnstr_pkg = info_obj->package.elements;
819 obj = &cnstr_pkg[0];
820 dev_info.uid = obj->integer.value;
821 obj = &cnstr_pkg[1];
822 dev_info.min_dstate = obj->integer.value;
823
824 acpi_handle_debug(lps0_device_handle,
825 "uid:%d min_dstate:%s\n",
826 dev_info.uid,
827 acpi_power_state_string(dev_info.min_dstate));
828
829 constraint->min_dstate = dev_info.min_dstate;
830 break;
831 }
832 }
833
834 if (constraint->min_dstate < 0) {
835 acpi_handle_debug(lps0_device_handle,
836 "Incomplete constraint defined\n");
837 continue;
838 }
839
840 lpi_constraints_table_size++;
841 }
842
843 acpi_handle_debug(lps0_device_handle, "LPI: constraints list end\n");
844
845free_acpi_buffer:
846 ACPI_FREE(out_obj);
847}
848
849static void lpi_check_constraints(void)
850{
851 int i;
852
853 for (i = 0; i < lpi_constraints_table_size; ++i) {
854 acpi_handle handle = lpi_constraints_table[i].handle;
855 struct acpi_device *adev;
856
857 if (!handle || acpi_bus_get_device(handle, &adev))
858 continue;
859
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));
864
865 if (!adev->flags.power_manageable) {
866 acpi_handle_info(handle, "LPI: Device not power manageable\n");
867 lpi_constraints_table[i].handle = NULL;
868 continue;
869 }
870
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));
876 }
877}
878
879static void acpi_sleep_run_lps0_dsm(unsigned int func)
880{
881 union acpi_object *out_obj;
882
883 if (!(lps0_dsm_func_mask & (1 << func)))
884 return;
885
886 out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL);
887 ACPI_FREE(out_obj);
888
889 acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n",
890 func, out_obj ? "successful" : "failed");
891}
892
893static int lps0_device_attach(struct acpi_device *adev,
894 const struct acpi_device_id *not_used)
895{
896 union acpi_object *out_obj;
897
898 if (lps0_device_handle)
899 return 0;
900
901 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0))
902 return 0;
903
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");
910 return 0;
911 }
912
913 lps0_dsm_func_mask = *(char *)out_obj->buffer.pointer;
914
915 ACPI_FREE(out_obj);
916
917 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n",
918 lps0_dsm_func_mask);
919
920 lps0_device_handle = adev->handle;
921
922 lpi_device_get_constraints();
923
924 /*
925 * Use suspend-to-idle by default if the default suspend mode was not
926 * set from the command line.
927 */
928 if (mem_sleep_default > PM_SUSPEND_MEM && !acpi_sleep_default_s3)
929 mem_sleep_current = PM_SUSPEND_TO_IDLE;
930
931 /*
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.
935 */
936 acpi_ec_mark_gpe_for_wake();
937
938 return 0;
939}
940
941static struct acpi_scan_handler lps0_handler = {
942 .ids = lps0_device_ids,
943 .attach = lps0_device_attach,
944};
945
946static int acpi_s2idle_begin(void)
947{
948 acpi_scan_lock_acquire();
949 return 0;
950}
951
952static int acpi_s2idle_prepare(void)
953{
954 if (acpi_sci_irq_valid()) {
955 enable_irq_wake(acpi_sci_irq);
956 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
957 }
958
959 acpi_enable_wakeup_devices(ACPI_STATE_S0);
960
961 /* Change the configuration of GPEs to avoid spurious wakeup. */
962 acpi_enable_all_wakeup_gpes();
963 acpi_os_wait_events_complete();
964
965 s2idle_wakeup = true;
966 return 0;
967}
968
969static int acpi_s2idle_prepare_late(void)
970{
971 if (!lps0_device_handle || sleep_no_lps0)
972 return 0;
973
974 if (pm_debug_messages_on)
975 lpi_check_constraints();
976
977 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF);
978 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY);
979
980 return 0;
981}
982
983static bool acpi_s2idle_wake(void)
984{
985 if (!acpi_sci_irq_valid())
986 return pm_wakeup_pending();
987
988 while (pm_wakeup_pending()) {
989 /*
990 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the
991 * SCI has not triggered while suspended, so bail out (the
992 * wakeup is pending anyway and the SCI is not the source of
993 * it).
994 */
995 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) {
996 pm_pr_dbg("Wakeup unrelated to ACPI SCI\n");
997 return true;
998 }
999
1000 /*
1001 * If the status bit of any enabled fixed event is set, the
1002 * wakeup is regarded as valid.
1003 */
1004 if (acpi_any_fixed_event_status_set()) {
1005 pm_pr_dbg("ACPI fixed event wakeup\n");
1006 return true;
1007 }
1008
1009 /* Check wakeups from drivers sharing the SCI. */
1010 if (acpi_check_wakeup_handlers()) {
1011 pm_pr_dbg("ACPI custom handler wakeup\n");
1012 return true;
1013 }
1014
1015 /* Check non-EC GPE wakeups and dispatch the EC GPE. */
1016 if (acpi_ec_dispatch_gpe()) {
1017 pm_pr_dbg("ACPI non-EC GPE wakeup\n");
1018 return true;
1019 }
1020
1021 /*
1022 * Cancel the SCI wakeup and process all pending events in case
1023 * there are any wakeup ones in there.
1024 *
1025 * Note that if any non-EC GPEs are active at this point, the
1026 * SCI will retrigger after the rearming below, so no events
1027 * should be missed by canceling the wakeup here.
1028 */
1029 pm_system_cancel_wakeup();
1030 acpi_os_wait_events_complete();
1031
1032 /*
1033 * The SCI is in the "suspended" state now and it cannot produce
1034 * new wakeup events till the rearming below, so if any of them
1035 * are pending here, they must be resulting from the processing
1036 * of EC events above or coming from somewhere else.
1037 */
1038 if (pm_wakeup_pending()) {
1039 pm_pr_dbg("Wakeup after ACPI Notify sync\n");
1040 return true;
1041 }
1042
1043 rearm_wake_irq(acpi_sci_irq);
1044 }
1045
1046 return false;
1047}
1048
1049static void acpi_s2idle_restore_early(void)
1050{
1051 if (!lps0_device_handle || sleep_no_lps0)
1052 return;
1053
1054 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT);
1055 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON);
1056}
1057
1058static void acpi_s2idle_restore(void)
1059{
1060 /*
1061 * Drain pending events before restoring the working-state configuration
1062 * of GPEs.
1063 */
1064 acpi_os_wait_events_complete(); /* synchronize GPE processing */
1065 acpi_ec_flush_work(); /* flush the EC driver's workqueues */
1066 acpi_os_wait_events_complete(); /* synchronize Notify handling */
1067
1068 s2idle_wakeup = false;
1069
1070 acpi_enable_all_runtime_gpes();
1071
1072 acpi_disable_wakeup_devices(ACPI_STATE_S0);
1073
1074 if (acpi_sci_irq_valid()) {
1075 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
1076 disable_irq_wake(acpi_sci_irq);
1077 }
1078}
1079
1080static void acpi_s2idle_end(void)
1081{
1082 acpi_scan_lock_release();
1083}
1084
1085static const struct platform_s2idle_ops acpi_s2idle_ops = {
1086 .begin = acpi_s2idle_begin,
1087 .prepare = acpi_s2idle_prepare,
1088 .prepare_late = acpi_s2idle_prepare_late,
1089 .wake = acpi_s2idle_wake,
1090 .restore_early = acpi_s2idle_restore_early,
1091 .restore = acpi_s2idle_restore,
1092 .end = acpi_s2idle_end,
1093};
1094
1095static void acpi_sleep_suspend_setup(void)
1096{
1097 int i;
1098
1099 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
1100 if (acpi_sleep_state_supported(i))
1101 sleep_states[i] = 1;
1102
1103 suspend_set_ops(old_suspend_ordering ?
1104 &acpi_suspend_ops_old : &acpi_suspend_ops);
1105
1106 acpi_scan_add_handler(&lps0_handler);
1107 s2idle_set_ops(&acpi_s2idle_ops);
1108}
1109
1110#else /* !CONFIG_SUSPEND */
1111#define s2idle_wakeup (false)
1112#define lps0_device_handle (NULL)
1113static inline void acpi_sleep_suspend_setup(void) {}
1114#endif /* !CONFIG_SUSPEND */
1115
1116bool acpi_s2idle_wakeup(void)
1117{
1118 return s2idle_wakeup;
1119}
1120
1121#ifdef CONFIG_PM_SLEEP
1122static u32 saved_bm_rld;
1123
1124static int acpi_save_bm_rld(void)
1125{
1126 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
1127 return 0;
1128}
1129
1130static void acpi_restore_bm_rld(void)
1131{
1132 u32 resumed_bm_rld = 0;
1133
1134 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
1135 if (resumed_bm_rld == saved_bm_rld)
1136 return;
1137
1138 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
1139}
1140
1141static struct syscore_ops acpi_sleep_syscore_ops = {
1142 .suspend = acpi_save_bm_rld,
1143 .resume = acpi_restore_bm_rld,
1144};
1145
1146static void acpi_sleep_syscore_init(void)
1147{
1148 register_syscore_ops(&acpi_sleep_syscore_ops);
1149}
1150#else
1151static inline void acpi_sleep_syscore_init(void) {}
1152#endif /* CONFIG_PM_SLEEP */
1153
1154#ifdef CONFIG_HIBERNATION
1155static unsigned long s4_hardware_signature;
1156static struct acpi_table_facs *facs;
1157static bool nosigcheck;
1158
1159void __init acpi_no_s4_hw_signature(void)
1160{
1161 nosigcheck = true;
1162}
1163
1164static int acpi_hibernation_begin(pm_message_t stage)
1165{
1166 if (!nvs_nosave) {
1167 int error = suspend_nvs_alloc();
1168 if (error)
1169 return error;
1170 }
1171
1172 if (stage.event == PM_EVENT_HIBERNATE)
1173 pm_set_suspend_via_firmware();
1174
1175 acpi_pm_start(ACPI_STATE_S4);
1176 return 0;
1177}
1178
1179static int acpi_hibernation_enter(void)
1180{
1181 acpi_status status = AE_OK;
1182
1183 ACPI_FLUSH_CPU_CACHE();
1184
1185 /* This shouldn't return. If it returns, we have a problem */
1186 status = acpi_enter_sleep_state(ACPI_STATE_S4);
1187 /* Reprogram control registers */
1188 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1189
1190 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
1191}
1192
1193static void acpi_hibernation_leave(void)
1194{
1195 pm_set_resume_via_firmware();
1196 /*
1197 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
1198 * enable it here.
1199 */
1200 acpi_enable();
1201 /* Reprogram control registers */
1202 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1203 /* Check the hardware signature */
1204 if (facs && s4_hardware_signature != facs->hardware_signature)
1205 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
1206 /* Restore the NVS memory area */
1207 suspend_nvs_restore();
1208 /* Allow EC transactions to happen. */
1209 acpi_ec_unblock_transactions();
1210}
1211
1212static void acpi_pm_thaw(void)
1213{
1214 acpi_ec_unblock_transactions();
1215 acpi_enable_all_runtime_gpes();
1216}
1217
1218static const struct platform_hibernation_ops acpi_hibernation_ops = {
1219 .begin = acpi_hibernation_begin,
1220 .end = acpi_pm_end,
1221 .pre_snapshot = acpi_pm_prepare,
1222 .finish = acpi_pm_finish,
1223 .prepare = acpi_pm_prepare,
1224 .enter = acpi_hibernation_enter,
1225 .leave = acpi_hibernation_leave,
1226 .pre_restore = acpi_pm_freeze,
1227 .restore_cleanup = acpi_pm_thaw,
1228};
1229
1230/**
1231 * acpi_hibernation_begin_old - Set the target system sleep state to
1232 * ACPI_STATE_S4 and execute the _PTS control method. This
1233 * function is used if the pre-ACPI 2.0 suspend ordering has been
1234 * requested.
1235 */
1236static int acpi_hibernation_begin_old(pm_message_t stage)
1237{
1238 int error;
1239 /*
1240 * The _TTS object should always be evaluated before the _PTS object.
1241 * When the old_suspended_ordering is true, the _PTS object is
1242 * evaluated in the acpi_sleep_prepare.
1243 */
1244 acpi_sleep_tts_switch(ACPI_STATE_S4);
1245
1246 error = acpi_sleep_prepare(ACPI_STATE_S4);
1247 if (error)
1248 return error;
1249
1250 if (!nvs_nosave) {
1251 error = suspend_nvs_alloc();
1252 if (error)
1253 return error;
1254 }
1255
1256 if (stage.event == PM_EVENT_HIBERNATE)
1257 pm_set_suspend_via_firmware();
1258
1259 acpi_target_sleep_state = ACPI_STATE_S4;
1260 acpi_scan_lock_acquire();
1261 return 0;
1262}
1263
1264/*
1265 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1266 * been requested.
1267 */
1268static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1269 .begin = acpi_hibernation_begin_old,
1270 .end = acpi_pm_end,
1271 .pre_snapshot = acpi_pm_pre_suspend,
1272 .prepare = acpi_pm_freeze,
1273 .finish = acpi_pm_finish,
1274 .enter = acpi_hibernation_enter,
1275 .leave = acpi_hibernation_leave,
1276 .pre_restore = acpi_pm_freeze,
1277 .restore_cleanup = acpi_pm_thaw,
1278 .recover = acpi_pm_finish,
1279};
1280
1281static void acpi_sleep_hibernate_setup(void)
1282{
1283 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1284 return;
1285
1286 hibernation_set_ops(old_suspend_ordering ?
1287 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1288 sleep_states[ACPI_STATE_S4] = 1;
1289 if (nosigcheck)
1290 return;
1291
1292 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1293 if (facs) {
1294 s4_hardware_signature = facs->hardware_signature;
1295 acpi_put_table((struct acpi_table_header *)facs);
1296 }
1297}
1298#else /* !CONFIG_HIBERNATION */
1299static inline void acpi_sleep_hibernate_setup(void) {}
1300#endif /* !CONFIG_HIBERNATION */
1301
1302static void acpi_power_off_prepare(void)
1303{
1304 /* Prepare to power off the system */
1305 acpi_sleep_prepare(ACPI_STATE_S5);
1306 acpi_disable_all_gpes();
1307 acpi_os_wait_events_complete();
1308}
1309
1310static void acpi_power_off(void)
1311{
1312 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1313 printk(KERN_DEBUG "%s called\n", __func__);
1314 local_irq_disable();
1315 acpi_enter_sleep_state(ACPI_STATE_S5);
1316}
1317
1318int __init acpi_sleep_init(void)
1319{
1320 char supported[ACPI_S_STATE_COUNT * 3 + 1];
1321 char *pos = supported;
1322 int i;
1323
1324 acpi_sleep_dmi_check();
1325
1326 sleep_states[ACPI_STATE_S0] = 1;
1327
1328 acpi_sleep_syscore_init();
1329 acpi_sleep_suspend_setup();
1330 acpi_sleep_hibernate_setup();
1331
1332 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1333 sleep_states[ACPI_STATE_S5] = 1;
1334 pm_power_off_prepare = acpi_power_off_prepare;
1335 pm_power_off = acpi_power_off;
1336 } else {
1337 acpi_no_s5 = true;
1338 }
1339
1340 supported[0] = 0;
1341 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1342 if (sleep_states[i])
1343 pos += sprintf(pos, " S%d", i);
1344 }
1345 pr_info(PREFIX "(supports%s)\n", supported);
1346
1347 /*
1348 * Register the tts_notifier to reboot notifier list so that the _TTS
1349 * object can also be evaluated when the system enters S5.
1350 */
1351 register_reboot_notifier(&tts_notifier);
1352 return 0;
1353}
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * sleep.c - ACPI sleep support.
4 *
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
9 */
10
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>
21#include <asm/io.h>
22#include <trace/events/power.h>
23
24#include "internal.h"
25#include "sleep.h"
26
27/*
28 * Some HW-full platforms do not have _S5, so they may need
29 * to leverage efi power off for a shutdown.
30 */
31bool acpi_no_s5;
32static u8 sleep_states[ACPI_S_STATE_COUNT];
33
34static void acpi_sleep_tts_switch(u32 acpi_state)
35{
36 acpi_status status;
37
38 status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state);
39 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
40 /*
41 * OS can't evaluate the _TTS object correctly. Some warning
42 * message will be printed. But it won't break anything.
43 */
44 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
45 }
46}
47
48static int tts_notify_reboot(struct notifier_block *this,
49 unsigned long code, void *x)
50{
51 acpi_sleep_tts_switch(ACPI_STATE_S5);
52 return NOTIFY_DONE;
53}
54
55static struct notifier_block tts_notifier = {
56 .notifier_call = tts_notify_reboot,
57 .next = NULL,
58 .priority = 0,
59};
60
61static int acpi_sleep_prepare(u32 acpi_state)
62{
63#ifdef CONFIG_ACPI_SLEEP
64 /* do we have a wakeup address for S2 and S3? */
65 if (acpi_state == ACPI_STATE_S3) {
66 if (!acpi_wakeup_address)
67 return -EFAULT;
68 acpi_set_waking_vector(acpi_wakeup_address);
69
70 }
71 ACPI_FLUSH_CPU_CACHE();
72#endif
73 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
74 acpi_state);
75 acpi_enable_wakeup_devices(acpi_state);
76 acpi_enter_sleep_state_prep(acpi_state);
77 return 0;
78}
79
80bool acpi_sleep_state_supported(u8 sleep_state)
81{
82 acpi_status status;
83 u8 type_a, type_b;
84
85 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
86 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
87 || (acpi_gbl_FADT.sleep_control.address
88 && acpi_gbl_FADT.sleep_status.address));
89}
90
91#ifdef CONFIG_ACPI_SLEEP
92static bool sleep_no_lps0 __read_mostly;
93module_param(sleep_no_lps0, bool, 0644);
94MODULE_PARM_DESC(sleep_no_lps0, "Do not use the special LPS0 device interface");
95
96static u32 acpi_target_sleep_state = ACPI_STATE_S0;
97
98u32 acpi_target_system_state(void)
99{
100 return acpi_target_sleep_state;
101}
102EXPORT_SYMBOL_GPL(acpi_target_system_state);
103
104static bool pwr_btn_event_pending;
105
106/*
107 * The ACPI specification wants us to save NVS memory regions during hibernation
108 * and to restore them during the subsequent resume. Windows does that also for
109 * suspend to RAM. However, it is known that this mechanism does not work on
110 * all machines, so we allow the user to disable it with the help of the
111 * 'acpi_sleep=nonvs' kernel command line option.
112 */
113static bool nvs_nosave;
114
115void __init acpi_nvs_nosave(void)
116{
117 nvs_nosave = true;
118}
119
120/*
121 * The ACPI specification wants us to save NVS memory regions during hibernation
122 * but says nothing about saving NVS during S3. Not all versions of Windows
123 * save NVS on S3 suspend either, and it is clear that not all systems need
124 * NVS to be saved at S3 time. To improve suspend/resume time, allow the
125 * user to disable saving NVS on S3 if their system does not require it, but
126 * continue to save/restore NVS for S4 as specified.
127 */
128static bool nvs_nosave_s3;
129
130void __init acpi_nvs_nosave_s3(void)
131{
132 nvs_nosave_s3 = true;
133}
134
135static int __init init_nvs_save_s3(const struct dmi_system_id *d)
136{
137 nvs_nosave_s3 = false;
138 return 0;
139}
140
141/*
142 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
143 * user to request that behavior by using the 'acpi_old_suspend_ordering'
144 * kernel command line option that causes the following variable to be set.
145 */
146static bool old_suspend_ordering;
147
148void __init acpi_old_suspend_ordering(void)
149{
150 old_suspend_ordering = true;
151}
152
153static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
154{
155 acpi_old_suspend_ordering();
156 return 0;
157}
158
159static int __init init_nvs_nosave(const struct dmi_system_id *d)
160{
161 acpi_nvs_nosave();
162 return 0;
163}
164
165static bool acpi_sleep_default_s3;
166
167static int __init init_default_s3(const struct dmi_system_id *d)
168{
169 acpi_sleep_default_s3 = true;
170 return 0;
171}
172
173static const struct dmi_system_id acpisleep_dmi_table[] __initconst = {
174 {
175 .callback = init_old_suspend_ordering,
176 .ident = "Abit KN9 (nForce4 variant)",
177 .matches = {
178 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
179 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
180 },
181 },
182 {
183 .callback = init_old_suspend_ordering,
184 .ident = "HP xw4600 Workstation",
185 .matches = {
186 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
187 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
188 },
189 },
190 {
191 .callback = init_old_suspend_ordering,
192 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
193 .matches = {
194 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
195 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
196 },
197 },
198 {
199 .callback = init_old_suspend_ordering,
200 .ident = "Panasonic CF51-2L",
201 .matches = {
202 DMI_MATCH(DMI_BOARD_VENDOR,
203 "Matsushita Electric Industrial Co.,Ltd."),
204 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
205 },
206 },
207 {
208 .callback = init_nvs_nosave,
209 .ident = "Sony Vaio VGN-FW41E_H",
210 .matches = {
211 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
212 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
213 },
214 },
215 {
216 .callback = init_nvs_nosave,
217 .ident = "Sony Vaio VGN-FW21E",
218 .matches = {
219 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
220 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
221 },
222 },
223 {
224 .callback = init_nvs_nosave,
225 .ident = "Sony Vaio VGN-FW21M",
226 .matches = {
227 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
228 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
229 },
230 },
231 {
232 .callback = init_nvs_nosave,
233 .ident = "Sony Vaio VPCEB17FX",
234 .matches = {
235 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
236 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
237 },
238 },
239 {
240 .callback = init_nvs_nosave,
241 .ident = "Sony Vaio VGN-SR11M",
242 .matches = {
243 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
244 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
245 },
246 },
247 {
248 .callback = init_nvs_nosave,
249 .ident = "Everex StepNote Series",
250 .matches = {
251 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
252 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
253 },
254 },
255 {
256 .callback = init_nvs_nosave,
257 .ident = "Sony Vaio VPCEB1Z1E",
258 .matches = {
259 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
260 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
261 },
262 },
263 {
264 .callback = init_nvs_nosave,
265 .ident = "Sony Vaio VGN-NW130D",
266 .matches = {
267 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
268 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
269 },
270 },
271 {
272 .callback = init_nvs_nosave,
273 .ident = "Sony Vaio VPCCW29FX",
274 .matches = {
275 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
276 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
277 },
278 },
279 {
280 .callback = init_nvs_nosave,
281 .ident = "Averatec AV1020-ED2",
282 .matches = {
283 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
284 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
285 },
286 },
287 {
288 .callback = init_old_suspend_ordering,
289 .ident = "Asus A8N-SLI DELUXE",
290 .matches = {
291 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
292 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
293 },
294 },
295 {
296 .callback = init_old_suspend_ordering,
297 .ident = "Asus A8N-SLI Premium",
298 .matches = {
299 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
300 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
301 },
302 },
303 {
304 .callback = init_nvs_nosave,
305 .ident = "Sony Vaio VGN-SR26GN_P",
306 .matches = {
307 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
308 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
309 },
310 },
311 {
312 .callback = init_nvs_nosave,
313 .ident = "Sony Vaio VPCEB1S1E",
314 .matches = {
315 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
316 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
317 },
318 },
319 {
320 .callback = init_nvs_nosave,
321 .ident = "Sony Vaio VGN-FW520F",
322 .matches = {
323 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
324 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
325 },
326 },
327 {
328 .callback = init_nvs_nosave,
329 .ident = "Asus K54C",
330 .matches = {
331 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
332 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
333 },
334 },
335 {
336 .callback = init_nvs_nosave,
337 .ident = "Asus K54HR",
338 .matches = {
339 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
340 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
341 },
342 },
343 {
344 .callback = init_nvs_save_s3,
345 .ident = "Asus 1025C",
346 .matches = {
347 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
348 DMI_MATCH(DMI_PRODUCT_NAME, "1025C"),
349 },
350 },
351 /*
352 * https://bugzilla.kernel.org/show_bug.cgi?id=189431
353 * Lenovo G50-45 is a platform later than 2012, but needs nvs memory
354 * saving during S3.
355 */
356 {
357 .callback = init_nvs_save_s3,
358 .ident = "Lenovo G50-45",
359 .matches = {
360 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
361 DMI_MATCH(DMI_PRODUCT_NAME, "80E3"),
362 },
363 },
364 /*
365 * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using
366 * the Low Power S0 Idle firmware interface (see
367 * https://bugzilla.kernel.org/show_bug.cgi?id=199057).
368 */
369 {
370 .callback = init_default_s3,
371 .ident = "ThinkPad X1 Tablet(2016)",
372 .matches = {
373 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
374 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"),
375 },
376 },
377 {},
378};
379
380static bool ignore_blacklist;
381
382void __init acpi_sleep_no_blacklist(void)
383{
384 ignore_blacklist = true;
385}
386
387static void __init acpi_sleep_dmi_check(void)
388{
389 if (ignore_blacklist)
390 return;
391
392 if (dmi_get_bios_year() >= 2012)
393 acpi_nvs_nosave_s3();
394
395 dmi_check_system(acpisleep_dmi_table);
396}
397
398/**
399 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
400 */
401static int acpi_pm_freeze(void)
402{
403 acpi_disable_all_gpes();
404 acpi_os_wait_events_complete();
405 acpi_ec_block_transactions();
406 return 0;
407}
408
409/**
410 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
411 */
412static int acpi_pm_pre_suspend(void)
413{
414 acpi_pm_freeze();
415 return suspend_nvs_save();
416}
417
418/**
419 * __acpi_pm_prepare - Prepare the platform to enter the target state.
420 *
421 * If necessary, set the firmware waking vector and do arch-specific
422 * nastiness to get the wakeup code to the waking vector.
423 */
424static int __acpi_pm_prepare(void)
425{
426 int error = acpi_sleep_prepare(acpi_target_sleep_state);
427 if (error)
428 acpi_target_sleep_state = ACPI_STATE_S0;
429
430 return error;
431}
432
433/**
434 * acpi_pm_prepare - Prepare the platform to enter the target sleep
435 * state and disable the GPEs.
436 */
437static int acpi_pm_prepare(void)
438{
439 int error = __acpi_pm_prepare();
440 if (!error)
441 error = acpi_pm_pre_suspend();
442
443 return error;
444}
445
446/**
447 * acpi_pm_finish - Instruct the platform to leave a sleep state.
448 *
449 * This is called after we wake back up (or if entering the sleep state
450 * failed).
451 */
452static void acpi_pm_finish(void)
453{
454 struct acpi_device *pwr_btn_adev;
455 u32 acpi_state = acpi_target_sleep_state;
456
457 acpi_ec_unblock_transactions();
458 suspend_nvs_free();
459
460 if (acpi_state == ACPI_STATE_S0)
461 return;
462
463 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
464 acpi_state);
465 acpi_disable_wakeup_devices(acpi_state);
466 acpi_leave_sleep_state(acpi_state);
467
468 /* reset firmware waking vector */
469 acpi_set_waking_vector(0);
470
471 acpi_target_sleep_state = ACPI_STATE_S0;
472
473 acpi_resume_power_resources();
474
475 /* If we were woken with the fixed power button, provide a small
476 * hint to userspace in the form of a wakeup event on the fixed power
477 * button device (if it can be found).
478 *
479 * We delay the event generation til now, as the PM layer requires
480 * timekeeping to be running before we generate events. */
481 if (!pwr_btn_event_pending)
482 return;
483
484 pwr_btn_event_pending = false;
485 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
486 NULL, -1);
487 if (pwr_btn_adev) {
488 pm_wakeup_event(&pwr_btn_adev->dev, 0);
489 acpi_dev_put(pwr_btn_adev);
490 }
491}
492
493/**
494 * acpi_pm_start - Start system PM transition.
495 */
496static void acpi_pm_start(u32 acpi_state)
497{
498 acpi_target_sleep_state = acpi_state;
499 acpi_sleep_tts_switch(acpi_target_sleep_state);
500 acpi_scan_lock_acquire();
501}
502
503/**
504 * acpi_pm_end - Finish up system PM transition.
505 */
506static void acpi_pm_end(void)
507{
508 acpi_turn_off_unused_power_resources();
509 acpi_scan_lock_release();
510 /*
511 * This is necessary in case acpi_pm_finish() is not called during a
512 * failing transition to a sleep state.
513 */
514 acpi_target_sleep_state = ACPI_STATE_S0;
515 acpi_sleep_tts_switch(acpi_target_sleep_state);
516}
517#else /* !CONFIG_ACPI_SLEEP */
518#define sleep_no_lps0 (1)
519#define acpi_target_sleep_state ACPI_STATE_S0
520#define acpi_sleep_default_s3 (1)
521static inline void acpi_sleep_dmi_check(void) {}
522#endif /* CONFIG_ACPI_SLEEP */
523
524#ifdef CONFIG_SUSPEND
525static u32 acpi_suspend_states[] = {
526 [PM_SUSPEND_ON] = ACPI_STATE_S0,
527 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
528 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
529 [PM_SUSPEND_MAX] = ACPI_STATE_S5
530};
531
532/**
533 * acpi_suspend_begin - Set the target system sleep state to the state
534 * associated with given @pm_state, if supported.
535 */
536static int acpi_suspend_begin(suspend_state_t pm_state)
537{
538 u32 acpi_state = acpi_suspend_states[pm_state];
539 int error;
540
541 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
542 if (error)
543 return error;
544
545 if (!sleep_states[acpi_state]) {
546 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
547 return -ENOSYS;
548 }
549 if (acpi_state > ACPI_STATE_S1)
550 pm_set_suspend_via_firmware();
551
552 acpi_pm_start(acpi_state);
553 return 0;
554}
555
556/**
557 * acpi_suspend_enter - Actually enter a sleep state.
558 * @pm_state: ignored
559 *
560 * Flush caches and go to sleep. For STR we have to call arch-specific
561 * assembly, which in turn call acpi_enter_sleep_state().
562 * It's unfortunate, but it works. Please fix if you're feeling frisky.
563 */
564static int acpi_suspend_enter(suspend_state_t pm_state)
565{
566 acpi_status status = AE_OK;
567 u32 acpi_state = acpi_target_sleep_state;
568 int error;
569
570 ACPI_FLUSH_CPU_CACHE();
571
572 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
573 switch (acpi_state) {
574 case ACPI_STATE_S1:
575 barrier();
576 status = acpi_enter_sleep_state(acpi_state);
577 break;
578
579 case ACPI_STATE_S3:
580 if (!acpi_suspend_lowlevel)
581 return -ENOSYS;
582 error = acpi_suspend_lowlevel();
583 if (error)
584 return error;
585 pr_info(PREFIX "Low-level resume complete\n");
586 pm_set_resume_via_firmware();
587 break;
588 }
589 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
590
591 /* This violates the spec but is required for bug compatibility. */
592 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
593
594 /* Reprogram control registers */
595 acpi_leave_sleep_state_prep(acpi_state);
596
597 /* ACPI 3.0 specs (P62) says that it's the responsibility
598 * of the OSPM to clear the status bit [ implying that the
599 * POWER_BUTTON event should not reach userspace ]
600 *
601 * However, we do generate a small hint for userspace in the form of
602 * a wakeup event. We flag this condition for now and generate the
603 * event later, as we're currently too early in resume to be able to
604 * generate wakeup events.
605 */
606 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
607 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
608
609 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
610
611 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
612 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
613 /* Flag for later */
614 pwr_btn_event_pending = true;
615 }
616 }
617
618 /*
619 * Disable and clear GPE status before interrupt is enabled. Some GPEs
620 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
621 * acpi_leave_sleep_state will reenable specific GPEs later
622 */
623 acpi_disable_all_gpes();
624 /* Allow EC transactions to happen. */
625 acpi_ec_unblock_transactions();
626
627 suspend_nvs_restore();
628
629 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
630}
631
632static int acpi_suspend_state_valid(suspend_state_t pm_state)
633{
634 u32 acpi_state;
635
636 switch (pm_state) {
637 case PM_SUSPEND_ON:
638 case PM_SUSPEND_STANDBY:
639 case PM_SUSPEND_MEM:
640 acpi_state = acpi_suspend_states[pm_state];
641
642 return sleep_states[acpi_state];
643 default:
644 return 0;
645 }
646}
647
648static const struct platform_suspend_ops acpi_suspend_ops = {
649 .valid = acpi_suspend_state_valid,
650 .begin = acpi_suspend_begin,
651 .prepare_late = acpi_pm_prepare,
652 .enter = acpi_suspend_enter,
653 .wake = acpi_pm_finish,
654 .end = acpi_pm_end,
655};
656
657/**
658 * acpi_suspend_begin_old - Set the target system sleep state to the
659 * state associated with given @pm_state, if supported, and
660 * execute the _PTS control method. This function is used if the
661 * pre-ACPI 2.0 suspend ordering has been requested.
662 */
663static int acpi_suspend_begin_old(suspend_state_t pm_state)
664{
665 int error = acpi_suspend_begin(pm_state);
666 if (!error)
667 error = __acpi_pm_prepare();
668
669 return error;
670}
671
672/*
673 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
674 * been requested.
675 */
676static const struct platform_suspend_ops acpi_suspend_ops_old = {
677 .valid = acpi_suspend_state_valid,
678 .begin = acpi_suspend_begin_old,
679 .prepare_late = acpi_pm_pre_suspend,
680 .enter = acpi_suspend_enter,
681 .wake = acpi_pm_finish,
682 .end = acpi_pm_end,
683 .recover = acpi_pm_finish,
684};
685
686static bool s2idle_wakeup;
687
688/*
689 * On platforms supporting the Low Power S0 Idle interface there is an ACPI
690 * device object with the PNP0D80 compatible device ID (System Power Management
691 * Controller) and a specific _DSM method under it. That method, if present,
692 * can be used to indicate to the platform that the OS is transitioning into a
693 * low-power state in which certain types of activity are not desirable or that
694 * it is leaving such a state, which allows the platform to adjust its operation
695 * mode accordingly.
696 */
697static const struct acpi_device_id lps0_device_ids[] = {
698 {"PNP0D80", },
699 {"", },
700};
701
702#define ACPI_LPS0_DSM_UUID "c4eb40a0-6cd2-11e2-bcfd-0800200c9a66"
703
704#define ACPI_LPS0_GET_DEVICE_CONSTRAINTS 1
705#define ACPI_LPS0_SCREEN_OFF 3
706#define ACPI_LPS0_SCREEN_ON 4
707#define ACPI_LPS0_ENTRY 5
708#define ACPI_LPS0_EXIT 6
709
710static acpi_handle lps0_device_handle;
711static guid_t lps0_dsm_guid;
712static char lps0_dsm_func_mask;
713
714/* Device constraint entry structure */
715struct lpi_device_info {
716 char *name;
717 int enabled;
718 union acpi_object *package;
719};
720
721/* Constraint package structure */
722struct lpi_device_constraint {
723 int uid;
724 int min_dstate;
725 int function_states;
726};
727
728struct lpi_constraints {
729 acpi_handle handle;
730 int min_dstate;
731};
732
733static struct lpi_constraints *lpi_constraints_table;
734static int lpi_constraints_table_size;
735
736static void lpi_device_get_constraints(void)
737{
738 union acpi_object *out_obj;
739 int i;
740
741 out_obj = acpi_evaluate_dsm_typed(lps0_device_handle, &lps0_dsm_guid,
742 1, ACPI_LPS0_GET_DEVICE_CONSTRAINTS,
743 NULL, ACPI_TYPE_PACKAGE);
744
745 acpi_handle_debug(lps0_device_handle, "_DSM function 1 eval %s\n",
746 out_obj ? "successful" : "failed");
747
748 if (!out_obj)
749 return;
750
751 lpi_constraints_table = kcalloc(out_obj->package.count,
752 sizeof(*lpi_constraints_table),
753 GFP_KERNEL);
754 if (!lpi_constraints_table)
755 goto free_acpi_buffer;
756
757 acpi_handle_debug(lps0_device_handle, "LPI: constraints list begin:\n");
758
759 for (i = 0; i < out_obj->package.count; i++) {
760 struct lpi_constraints *constraint;
761 acpi_status status;
762 union acpi_object *package = &out_obj->package.elements[i];
763 struct lpi_device_info info = { };
764 int package_count = 0, j;
765
766 if (!package)
767 continue;
768
769 for (j = 0; j < package->package.count; ++j) {
770 union acpi_object *element =
771 &(package->package.elements[j]);
772
773 switch (element->type) {
774 case ACPI_TYPE_INTEGER:
775 info.enabled = element->integer.value;
776 break;
777 case ACPI_TYPE_STRING:
778 info.name = element->string.pointer;
779 break;
780 case ACPI_TYPE_PACKAGE:
781 package_count = element->package.count;
782 info.package = element->package.elements;
783 break;
784 }
785 }
786
787 if (!info.enabled || !info.package || !info.name)
788 continue;
789
790 constraint = &lpi_constraints_table[lpi_constraints_table_size];
791
792 status = acpi_get_handle(NULL, info.name, &constraint->handle);
793 if (ACPI_FAILURE(status))
794 continue;
795
796 acpi_handle_debug(lps0_device_handle,
797 "index:%d Name:%s\n", i, info.name);
798
799 constraint->min_dstate = -1;
800
801 for (j = 0; j < package_count; ++j) {
802 union acpi_object *info_obj = &info.package[j];
803 union acpi_object *cnstr_pkg;
804 union acpi_object *obj;
805 struct lpi_device_constraint dev_info;
806
807 switch (info_obj->type) {
808 case ACPI_TYPE_INTEGER:
809 /* version */
810 break;
811 case ACPI_TYPE_PACKAGE:
812 if (info_obj->package.count < 2)
813 break;
814
815 cnstr_pkg = info_obj->package.elements;
816 obj = &cnstr_pkg[0];
817 dev_info.uid = obj->integer.value;
818 obj = &cnstr_pkg[1];
819 dev_info.min_dstate = obj->integer.value;
820
821 acpi_handle_debug(lps0_device_handle,
822 "uid:%d min_dstate:%s\n",
823 dev_info.uid,
824 acpi_power_state_string(dev_info.min_dstate));
825
826 constraint->min_dstate = dev_info.min_dstate;
827 break;
828 }
829 }
830
831 if (constraint->min_dstate < 0) {
832 acpi_handle_debug(lps0_device_handle,
833 "Incomplete constraint defined\n");
834 continue;
835 }
836
837 lpi_constraints_table_size++;
838 }
839
840 acpi_handle_debug(lps0_device_handle, "LPI: constraints list end\n");
841
842free_acpi_buffer:
843 ACPI_FREE(out_obj);
844}
845
846static void lpi_check_constraints(void)
847{
848 int i;
849
850 for (i = 0; i < lpi_constraints_table_size; ++i) {
851 acpi_handle handle = lpi_constraints_table[i].handle;
852 struct acpi_device *adev;
853
854 if (!handle || acpi_bus_get_device(handle, &adev))
855 continue;
856
857 acpi_handle_debug(handle,
858 "LPI: required min power state:%s current power state:%s\n",
859 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
860 acpi_power_state_string(adev->power.state));
861
862 if (!adev->flags.power_manageable) {
863 acpi_handle_info(handle, "LPI: Device not power manageable\n");
864 lpi_constraints_table[i].handle = NULL;
865 continue;
866 }
867
868 if (adev->power.state < lpi_constraints_table[i].min_dstate)
869 acpi_handle_info(handle,
870 "LPI: Constraint not met; min power state:%s current power state:%s\n",
871 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
872 acpi_power_state_string(adev->power.state));
873 }
874}
875
876static void acpi_sleep_run_lps0_dsm(unsigned int func)
877{
878 union acpi_object *out_obj;
879
880 if (!(lps0_dsm_func_mask & (1 << func)))
881 return;
882
883 out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL);
884 ACPI_FREE(out_obj);
885
886 acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n",
887 func, out_obj ? "successful" : "failed");
888}
889
890static int lps0_device_attach(struct acpi_device *adev,
891 const struct acpi_device_id *not_used)
892{
893 union acpi_object *out_obj;
894
895 if (lps0_device_handle)
896 return 0;
897
898 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0))
899 return 0;
900
901 guid_parse(ACPI_LPS0_DSM_UUID, &lps0_dsm_guid);
902 /* Check if the _DSM is present and as expected. */
903 out_obj = acpi_evaluate_dsm(adev->handle, &lps0_dsm_guid, 1, 0, NULL);
904 if (!out_obj || out_obj->type != ACPI_TYPE_BUFFER) {
905 acpi_handle_debug(adev->handle,
906 "_DSM function 0 evaluation failed\n");
907 return 0;
908 }
909
910 lps0_dsm_func_mask = *(char *)out_obj->buffer.pointer;
911
912 ACPI_FREE(out_obj);
913
914 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n",
915 lps0_dsm_func_mask);
916
917 lps0_device_handle = adev->handle;
918
919 lpi_device_get_constraints();
920
921 /*
922 * Use suspend-to-idle by default if the default suspend mode was not
923 * set from the command line.
924 */
925 if (mem_sleep_default > PM_SUSPEND_MEM && !acpi_sleep_default_s3)
926 mem_sleep_current = PM_SUSPEND_TO_IDLE;
927
928 /*
929 * Some LPS0 systems, like ASUS Zenbook UX430UNR/i7-8550U, require the
930 * EC GPE to be enabled while suspended for certain wakeup devices to
931 * work, so mark it as wakeup-capable.
932 */
933 acpi_ec_mark_gpe_for_wake();
934
935 return 0;
936}
937
938static struct acpi_scan_handler lps0_handler = {
939 .ids = lps0_device_ids,
940 .attach = lps0_device_attach,
941};
942
943static int acpi_s2idle_begin(void)
944{
945 acpi_scan_lock_acquire();
946 return 0;
947}
948
949static int acpi_s2idle_prepare(void)
950{
951 if (acpi_sci_irq_valid()) {
952 enable_irq_wake(acpi_sci_irq);
953 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
954 }
955
956 acpi_enable_wakeup_devices(ACPI_STATE_S0);
957
958 /* Change the configuration of GPEs to avoid spurious wakeup. */
959 acpi_enable_all_wakeup_gpes();
960 acpi_os_wait_events_complete();
961
962 s2idle_wakeup = true;
963 return 0;
964}
965
966static int acpi_s2idle_prepare_late(void)
967{
968 if (!lps0_device_handle || sleep_no_lps0)
969 return 0;
970
971 if (pm_debug_messages_on)
972 lpi_check_constraints();
973
974 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF);
975 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY);
976
977 return 0;
978}
979
980static void acpi_s2idle_wake(void)
981{
982 /*
983 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the SCI has
984 * not triggered while suspended, so bail out.
985 */
986 if (!acpi_sci_irq_valid() ||
987 irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq)))
988 return;
989
990 /*
991 * If there are EC events to process, the wakeup may be a spurious one
992 * coming from the EC.
993 */
994 if (acpi_ec_dispatch_gpe()) {
995 /*
996 * Cancel the wakeup and process all pending events in case
997 * there are any wakeup ones in there.
998 *
999 * Note that if any non-EC GPEs are active at this point, the
1000 * SCI will retrigger after the rearming below, so no events
1001 * should be missed by canceling the wakeup here.
1002 */
1003 pm_system_cancel_wakeup();
1004 /*
1005 * The EC driver uses the system workqueue and an additional
1006 * special one, so those need to be flushed too.
1007 */
1008 acpi_os_wait_events_complete(); /* synchronize EC GPE processing */
1009 acpi_ec_flush_work();
1010 acpi_os_wait_events_complete(); /* synchronize Notify handling */
1011
1012 rearm_wake_irq(acpi_sci_irq);
1013 }
1014}
1015
1016static void acpi_s2idle_restore_early(void)
1017{
1018 if (!lps0_device_handle || sleep_no_lps0)
1019 return;
1020
1021 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT);
1022 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON);
1023}
1024
1025static void acpi_s2idle_restore(void)
1026{
1027 s2idle_wakeup = false;
1028
1029 acpi_enable_all_runtime_gpes();
1030
1031 acpi_disable_wakeup_devices(ACPI_STATE_S0);
1032
1033 if (acpi_sci_irq_valid()) {
1034 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
1035 disable_irq_wake(acpi_sci_irq);
1036 }
1037}
1038
1039static void acpi_s2idle_end(void)
1040{
1041 acpi_scan_lock_release();
1042}
1043
1044static const struct platform_s2idle_ops acpi_s2idle_ops = {
1045 .begin = acpi_s2idle_begin,
1046 .prepare = acpi_s2idle_prepare,
1047 .prepare_late = acpi_s2idle_prepare_late,
1048 .wake = acpi_s2idle_wake,
1049 .restore_early = acpi_s2idle_restore_early,
1050 .restore = acpi_s2idle_restore,
1051 .end = acpi_s2idle_end,
1052};
1053
1054static void acpi_sleep_suspend_setup(void)
1055{
1056 int i;
1057
1058 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
1059 if (acpi_sleep_state_supported(i))
1060 sleep_states[i] = 1;
1061
1062 suspend_set_ops(old_suspend_ordering ?
1063 &acpi_suspend_ops_old : &acpi_suspend_ops);
1064
1065 acpi_scan_add_handler(&lps0_handler);
1066 s2idle_set_ops(&acpi_s2idle_ops);
1067}
1068
1069#else /* !CONFIG_SUSPEND */
1070#define s2idle_wakeup (false)
1071#define lps0_device_handle (NULL)
1072static inline void acpi_sleep_suspend_setup(void) {}
1073#endif /* !CONFIG_SUSPEND */
1074
1075bool acpi_s2idle_wakeup(void)
1076{
1077 return s2idle_wakeup;
1078}
1079
1080#ifdef CONFIG_PM_SLEEP
1081static u32 saved_bm_rld;
1082
1083static int acpi_save_bm_rld(void)
1084{
1085 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
1086 return 0;
1087}
1088
1089static void acpi_restore_bm_rld(void)
1090{
1091 u32 resumed_bm_rld = 0;
1092
1093 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
1094 if (resumed_bm_rld == saved_bm_rld)
1095 return;
1096
1097 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
1098}
1099
1100static struct syscore_ops acpi_sleep_syscore_ops = {
1101 .suspend = acpi_save_bm_rld,
1102 .resume = acpi_restore_bm_rld,
1103};
1104
1105static void acpi_sleep_syscore_init(void)
1106{
1107 register_syscore_ops(&acpi_sleep_syscore_ops);
1108}
1109#else
1110static inline void acpi_sleep_syscore_init(void) {}
1111#endif /* CONFIG_PM_SLEEP */
1112
1113#ifdef CONFIG_HIBERNATION
1114static unsigned long s4_hardware_signature;
1115static struct acpi_table_facs *facs;
1116static bool nosigcheck;
1117
1118void __init acpi_no_s4_hw_signature(void)
1119{
1120 nosigcheck = true;
1121}
1122
1123static int acpi_hibernation_begin(pm_message_t stage)
1124{
1125 if (!nvs_nosave) {
1126 int error = suspend_nvs_alloc();
1127 if (error)
1128 return error;
1129 }
1130
1131 if (stage.event == PM_EVENT_HIBERNATE)
1132 pm_set_suspend_via_firmware();
1133
1134 acpi_pm_start(ACPI_STATE_S4);
1135 return 0;
1136}
1137
1138static int acpi_hibernation_enter(void)
1139{
1140 acpi_status status = AE_OK;
1141
1142 ACPI_FLUSH_CPU_CACHE();
1143
1144 /* This shouldn't return. If it returns, we have a problem */
1145 status = acpi_enter_sleep_state(ACPI_STATE_S4);
1146 /* Reprogram control registers */
1147 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1148
1149 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
1150}
1151
1152static void acpi_hibernation_leave(void)
1153{
1154 pm_set_resume_via_firmware();
1155 /*
1156 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
1157 * enable it here.
1158 */
1159 acpi_enable();
1160 /* Reprogram control registers */
1161 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1162 /* Check the hardware signature */
1163 if (facs && s4_hardware_signature != facs->hardware_signature)
1164 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
1165 /* Restore the NVS memory area */
1166 suspend_nvs_restore();
1167 /* Allow EC transactions to happen. */
1168 acpi_ec_unblock_transactions();
1169}
1170
1171static void acpi_pm_thaw(void)
1172{
1173 acpi_ec_unblock_transactions();
1174 acpi_enable_all_runtime_gpes();
1175}
1176
1177static const struct platform_hibernation_ops acpi_hibernation_ops = {
1178 .begin = acpi_hibernation_begin,
1179 .end = acpi_pm_end,
1180 .pre_snapshot = acpi_pm_prepare,
1181 .finish = acpi_pm_finish,
1182 .prepare = acpi_pm_prepare,
1183 .enter = acpi_hibernation_enter,
1184 .leave = acpi_hibernation_leave,
1185 .pre_restore = acpi_pm_freeze,
1186 .restore_cleanup = acpi_pm_thaw,
1187};
1188
1189/**
1190 * acpi_hibernation_begin_old - Set the target system sleep state to
1191 * ACPI_STATE_S4 and execute the _PTS control method. This
1192 * function is used if the pre-ACPI 2.0 suspend ordering has been
1193 * requested.
1194 */
1195static int acpi_hibernation_begin_old(pm_message_t stage)
1196{
1197 int error;
1198 /*
1199 * The _TTS object should always be evaluated before the _PTS object.
1200 * When the old_suspended_ordering is true, the _PTS object is
1201 * evaluated in the acpi_sleep_prepare.
1202 */
1203 acpi_sleep_tts_switch(ACPI_STATE_S4);
1204
1205 error = acpi_sleep_prepare(ACPI_STATE_S4);
1206 if (error)
1207 return error;
1208
1209 if (!nvs_nosave) {
1210 error = suspend_nvs_alloc();
1211 if (error)
1212 return error;
1213 }
1214
1215 if (stage.event == PM_EVENT_HIBERNATE)
1216 pm_set_suspend_via_firmware();
1217
1218 acpi_target_sleep_state = ACPI_STATE_S4;
1219 acpi_scan_lock_acquire();
1220 return 0;
1221}
1222
1223/*
1224 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1225 * been requested.
1226 */
1227static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1228 .begin = acpi_hibernation_begin_old,
1229 .end = acpi_pm_end,
1230 .pre_snapshot = acpi_pm_pre_suspend,
1231 .prepare = acpi_pm_freeze,
1232 .finish = acpi_pm_finish,
1233 .enter = acpi_hibernation_enter,
1234 .leave = acpi_hibernation_leave,
1235 .pre_restore = acpi_pm_freeze,
1236 .restore_cleanup = acpi_pm_thaw,
1237 .recover = acpi_pm_finish,
1238};
1239
1240static void acpi_sleep_hibernate_setup(void)
1241{
1242 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1243 return;
1244
1245 hibernation_set_ops(old_suspend_ordering ?
1246 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1247 sleep_states[ACPI_STATE_S4] = 1;
1248 if (nosigcheck)
1249 return;
1250
1251 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1252 if (facs)
1253 s4_hardware_signature = facs->hardware_signature;
1254}
1255#else /* !CONFIG_HIBERNATION */
1256static inline void acpi_sleep_hibernate_setup(void) {}
1257#endif /* !CONFIG_HIBERNATION */
1258
1259static void acpi_power_off_prepare(void)
1260{
1261 /* Prepare to power off the system */
1262 acpi_sleep_prepare(ACPI_STATE_S5);
1263 acpi_disable_all_gpes();
1264 acpi_os_wait_events_complete();
1265}
1266
1267static void acpi_power_off(void)
1268{
1269 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1270 printk(KERN_DEBUG "%s called\n", __func__);
1271 local_irq_disable();
1272 acpi_enter_sleep_state(ACPI_STATE_S5);
1273}
1274
1275int __init acpi_sleep_init(void)
1276{
1277 char supported[ACPI_S_STATE_COUNT * 3 + 1];
1278 char *pos = supported;
1279 int i;
1280
1281 acpi_sleep_dmi_check();
1282
1283 sleep_states[ACPI_STATE_S0] = 1;
1284
1285 acpi_sleep_syscore_init();
1286 acpi_sleep_suspend_setup();
1287 acpi_sleep_hibernate_setup();
1288
1289 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1290 sleep_states[ACPI_STATE_S5] = 1;
1291 pm_power_off_prepare = acpi_power_off_prepare;
1292 pm_power_off = acpi_power_off;
1293 } else {
1294 acpi_no_s5 = true;
1295 }
1296
1297 supported[0] = 0;
1298 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1299 if (sleep_states[i])
1300 pos += sprintf(pos, " S%d", i);
1301 }
1302 pr_info(PREFIX "(supports%s)\n", supported);
1303
1304 /*
1305 * Register the tts_notifier to reboot notifier list so that the _TTS
1306 * object can also be evaluated when the system enters S5.
1307 */
1308 register_reboot_notifier(&tts_notifier);
1309 return 0;
1310}