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