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 #define pr_fmt(fmt) "ACPI: PM: " fmt
12
13 #include <linux/delay.h>
14 #include <linux/irq.h>
15 #include <linux/dmi.h>
16 #include <linux/device.h>
17 #include <linux/interrupt.h>
18 #include <linux/suspend.h>
19 #include <linux/reboot.h>
20 #include <linux/acpi.h>
21 #include <linux/module.h>
22 #include <linux/syscore_ops.h>
23 #include <asm/io.h>
24 #include <trace/events/power.h>
25
26 #include "internal.h"
27 #include "sleep.h"
28
29 /*
30 * Some HW-full platforms do not have _S5, so they may need
31 * to leverage efi power off for a shutdown.
32 */
33 bool acpi_no_s5;
34 static u8 sleep_states[ACPI_S_STATE_COUNT];
35
acpi_sleep_tts_switch(u32 acpi_state)36 static void acpi_sleep_tts_switch(u32 acpi_state)
37 {
38 acpi_status status;
39
40 status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state);
41 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
42 /*
43 * OS can't evaluate the _TTS object correctly. Some warning
44 * message will be printed. But it won't break anything.
45 */
46 pr_notice("Failure in evaluating _TTS object\n");
47 }
48 }
49
tts_notify_reboot(struct notifier_block * this,unsigned long code,void * x)50 static int tts_notify_reboot(struct notifier_block *this,
51 unsigned long code, void *x)
52 {
53 acpi_sleep_tts_switch(ACPI_STATE_S5);
54 return NOTIFY_DONE;
55 }
56
57 static struct notifier_block tts_notifier = {
58 .notifier_call = tts_notify_reboot,
59 .next = NULL,
60 .priority = 0,
61 };
62
63 #ifndef acpi_skip_set_wakeup_address
64 #define acpi_skip_set_wakeup_address() false
65 #endif
66
acpi_sleep_prepare(u32 acpi_state)67 static int acpi_sleep_prepare(u32 acpi_state)
68 {
69 #ifdef CONFIG_ACPI_SLEEP
70 unsigned long acpi_wakeup_address;
71
72 /* do we have a wakeup address for S2 and S3? */
73 if (acpi_state == ACPI_STATE_S3 && !acpi_skip_set_wakeup_address()) {
74 acpi_wakeup_address = acpi_get_wakeup_address();
75 if (!acpi_wakeup_address)
76 return -EFAULT;
77 acpi_set_waking_vector(acpi_wakeup_address);
78
79 }
80 #endif
81 pr_info("Preparing to enter system sleep state S%d\n", acpi_state);
82 acpi_enable_wakeup_devices(acpi_state);
83 acpi_enter_sleep_state_prep(acpi_state);
84 return 0;
85 }
86
acpi_sleep_state_supported(u8 sleep_state)87 bool acpi_sleep_state_supported(u8 sleep_state)
88 {
89 acpi_status status;
90 u8 type_a, type_b;
91
92 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
93 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
94 || (acpi_gbl_FADT.sleep_control.address
95 && acpi_gbl_FADT.sleep_status.address));
96 }
97
98 #ifdef CONFIG_ACPI_SLEEP
99 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
100
acpi_target_system_state(void)101 u32 acpi_target_system_state(void)
102 {
103 return acpi_target_sleep_state;
104 }
105 EXPORT_SYMBOL_GPL(acpi_target_system_state);
106
107 static 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 */
116 static bool nvs_nosave;
117
acpi_nvs_nosave(void)118 void __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 */
131 static bool nvs_nosave_s3;
132
acpi_nvs_nosave_s3(void)133 void __init acpi_nvs_nosave_s3(void)
134 {
135 nvs_nosave_s3 = true;
136 }
137
init_nvs_save_s3(const struct dmi_system_id * d)138 static 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 */
149 static bool old_suspend_ordering;
150
acpi_old_suspend_ordering(void)151 void __init acpi_old_suspend_ordering(void)
152 {
153 old_suspend_ordering = true;
154 }
155
init_old_suspend_ordering(const struct dmi_system_id * d)156 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
157 {
158 acpi_old_suspend_ordering();
159 return 0;
160 }
161
init_nvs_nosave(const struct dmi_system_id * d)162 static int __init init_nvs_nosave(const struct dmi_system_id *d)
163 {
164 acpi_nvs_nosave();
165 return 0;
166 }
167
168 bool acpi_sleep_default_s3;
169
init_default_s3(const struct dmi_system_id * d)170 static int __init init_default_s3(const struct dmi_system_id *d)
171 {
172 acpi_sleep_default_s3 = true;
173 return 0;
174 }
175
176 static 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 .callback = init_nvs_save_s3,
369 .ident = "Lenovo G40-45",
370 .matches = {
371 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
372 DMI_MATCH(DMI_PRODUCT_NAME, "80E1"),
373 },
374 },
375 /*
376 * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using
377 * the Low Power S0 Idle firmware interface (see
378 * https://bugzilla.kernel.org/show_bug.cgi?id=199057).
379 */
380 {
381 .callback = init_default_s3,
382 .ident = "ThinkPad X1 Tablet(2016)",
383 .matches = {
384 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
385 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"),
386 },
387 },
388 /*
389 * ASUS B1400CEAE hangs on resume from suspend (see
390 * https://bugzilla.kernel.org/show_bug.cgi?id=215742).
391 */
392 {
393 .callback = init_default_s3,
394 .ident = "ASUS B1400CEAE",
395 .matches = {
396 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
397 DMI_MATCH(DMI_PRODUCT_NAME, "ASUS EXPERTBOOK B1400CEAE"),
398 },
399 },
400 {},
401 };
402
403 static bool ignore_blacklist;
404
acpi_sleep_no_blacklist(void)405 void __init acpi_sleep_no_blacklist(void)
406 {
407 ignore_blacklist = true;
408 }
409
acpi_sleep_dmi_check(void)410 static void __init acpi_sleep_dmi_check(void)
411 {
412 if (ignore_blacklist)
413 return;
414
415 if (dmi_get_bios_year() >= 2012)
416 acpi_nvs_nosave_s3();
417
418 dmi_check_system(acpisleep_dmi_table);
419 }
420
421 /**
422 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
423 */
acpi_pm_freeze(void)424 static int acpi_pm_freeze(void)
425 {
426 acpi_disable_all_gpes();
427 acpi_os_wait_events_complete();
428 acpi_ec_block_transactions();
429 return 0;
430 }
431
432 /**
433 * acpi_pm_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
434 */
acpi_pm_pre_suspend(void)435 static int acpi_pm_pre_suspend(void)
436 {
437 acpi_pm_freeze();
438 return suspend_nvs_save();
439 }
440
441 /**
442 * __acpi_pm_prepare - Prepare the platform to enter the target state.
443 *
444 * If necessary, set the firmware waking vector and do arch-specific
445 * nastiness to get the wakeup code to the waking vector.
446 */
__acpi_pm_prepare(void)447 static int __acpi_pm_prepare(void)
448 {
449 int error = acpi_sleep_prepare(acpi_target_sleep_state);
450 if (error)
451 acpi_target_sleep_state = ACPI_STATE_S0;
452
453 return error;
454 }
455
456 /**
457 * acpi_pm_prepare - Prepare the platform to enter the target sleep
458 * state and disable the GPEs.
459 */
acpi_pm_prepare(void)460 static int acpi_pm_prepare(void)
461 {
462 int error = __acpi_pm_prepare();
463 if (!error)
464 error = acpi_pm_pre_suspend();
465
466 return error;
467 }
468
469 /**
470 * acpi_pm_finish - Instruct the platform to leave a sleep state.
471 *
472 * This is called after we wake back up (or if entering the sleep state
473 * failed).
474 */
acpi_pm_finish(void)475 static void acpi_pm_finish(void)
476 {
477 struct acpi_device *pwr_btn_adev;
478 u32 acpi_state = acpi_target_sleep_state;
479
480 acpi_ec_unblock_transactions();
481 suspend_nvs_free();
482
483 if (acpi_state == ACPI_STATE_S0)
484 return;
485
486 pr_info("Waking up from system sleep state S%d\n", acpi_state);
487 acpi_disable_wakeup_devices(acpi_state);
488 acpi_leave_sleep_state(acpi_state);
489
490 /* reset firmware waking vector */
491 acpi_set_waking_vector(0);
492
493 acpi_target_sleep_state = ACPI_STATE_S0;
494
495 acpi_resume_power_resources();
496
497 /* If we were woken with the fixed power button, provide a small
498 * hint to userspace in the form of a wakeup event on the fixed power
499 * button device (if it can be found).
500 *
501 * We delay the event generation til now, as the PM layer requires
502 * timekeeping to be running before we generate events. */
503 if (!pwr_btn_event_pending)
504 return;
505
506 pwr_btn_event_pending = false;
507 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
508 NULL, -1);
509 if (pwr_btn_adev) {
510 pm_wakeup_event(&pwr_btn_adev->dev, 0);
511 acpi_dev_put(pwr_btn_adev);
512 }
513 }
514
515 /**
516 * acpi_pm_start - Start system PM transition.
517 */
acpi_pm_start(u32 acpi_state)518 static void acpi_pm_start(u32 acpi_state)
519 {
520 acpi_target_sleep_state = acpi_state;
521 acpi_sleep_tts_switch(acpi_target_sleep_state);
522 acpi_scan_lock_acquire();
523 }
524
525 /**
526 * acpi_pm_end - Finish up system PM transition.
527 */
acpi_pm_end(void)528 static void acpi_pm_end(void)
529 {
530 acpi_turn_off_unused_power_resources();
531 acpi_scan_lock_release();
532 /*
533 * This is necessary in case acpi_pm_finish() is not called during a
534 * failing transition to a sleep state.
535 */
536 acpi_target_sleep_state = ACPI_STATE_S0;
537 acpi_sleep_tts_switch(acpi_target_sleep_state);
538 }
539 #else /* !CONFIG_ACPI_SLEEP */
540 #define sleep_no_lps0 (1)
541 #define acpi_target_sleep_state ACPI_STATE_S0
542 #define acpi_sleep_default_s3 (1)
acpi_sleep_dmi_check(void)543 static inline void acpi_sleep_dmi_check(void) {}
544 #endif /* CONFIG_ACPI_SLEEP */
545
546 #ifdef CONFIG_SUSPEND
547 static u32 acpi_suspend_states[] = {
548 [PM_SUSPEND_ON] = ACPI_STATE_S0,
549 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
550 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
551 [PM_SUSPEND_MAX] = ACPI_STATE_S5
552 };
553
554 /**
555 * acpi_suspend_begin - Set the target system sleep state to the state
556 * associated with given @pm_state, if supported.
557 */
acpi_suspend_begin(suspend_state_t pm_state)558 static int acpi_suspend_begin(suspend_state_t pm_state)
559 {
560 u32 acpi_state = acpi_suspend_states[pm_state];
561 int error;
562
563 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
564 if (error)
565 return error;
566
567 if (!sleep_states[acpi_state]) {
568 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
569 return -ENOSYS;
570 }
571 if (acpi_state > ACPI_STATE_S1)
572 pm_set_suspend_via_firmware();
573
574 acpi_pm_start(acpi_state);
575 return 0;
576 }
577
578 /**
579 * acpi_suspend_enter - Actually enter a sleep state.
580 * @pm_state: ignored
581 *
582 * Flush caches and go to sleep. For STR we have to call arch-specific
583 * assembly, which in turn call acpi_enter_sleep_state().
584 * It's unfortunate, but it works. Please fix if you're feeling frisky.
585 */
acpi_suspend_enter(suspend_state_t pm_state)586 static int acpi_suspend_enter(suspend_state_t pm_state)
587 {
588 acpi_status status = AE_OK;
589 u32 acpi_state = acpi_target_sleep_state;
590 int error;
591
592 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
593 switch (acpi_state) {
594 case ACPI_STATE_S1:
595 barrier();
596 status = acpi_enter_sleep_state(acpi_state);
597 break;
598
599 case ACPI_STATE_S3:
600 if (!acpi_suspend_lowlevel)
601 return -ENOSYS;
602 error = acpi_suspend_lowlevel();
603 if (error)
604 return error;
605 pr_info("Low-level resume complete\n");
606 pm_set_resume_via_firmware();
607 break;
608 }
609 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
610
611 /* This violates the spec but is required for bug compatibility. */
612 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
613
614 /* Reprogram control registers */
615 acpi_leave_sleep_state_prep(acpi_state);
616
617 /* ACPI 3.0 specs (P62) says that it's the responsibility
618 * of the OSPM to clear the status bit [ implying that the
619 * POWER_BUTTON event should not reach userspace ]
620 *
621 * However, we do generate a small hint for userspace in the form of
622 * a wakeup event. We flag this condition for now and generate the
623 * event later, as we're currently too early in resume to be able to
624 * generate wakeup events.
625 */
626 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
627 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
628
629 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
630
631 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
632 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
633 /* Flag for later */
634 pwr_btn_event_pending = true;
635 }
636 }
637
638 /*
639 * Disable and clear GPE status before interrupt is enabled. Some GPEs
640 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
641 * acpi_leave_sleep_state will reenable specific GPEs later
642 */
643 acpi_disable_all_gpes();
644 /* Allow EC transactions to happen. */
645 acpi_ec_unblock_transactions();
646
647 suspend_nvs_restore();
648
649 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
650 }
651
acpi_suspend_state_valid(suspend_state_t pm_state)652 static int acpi_suspend_state_valid(suspend_state_t pm_state)
653 {
654 u32 acpi_state;
655
656 switch (pm_state) {
657 case PM_SUSPEND_ON:
658 case PM_SUSPEND_STANDBY:
659 case PM_SUSPEND_MEM:
660 acpi_state = acpi_suspend_states[pm_state];
661
662 return sleep_states[acpi_state];
663 default:
664 return 0;
665 }
666 }
667
668 static const struct platform_suspend_ops acpi_suspend_ops = {
669 .valid = acpi_suspend_state_valid,
670 .begin = acpi_suspend_begin,
671 .prepare_late = acpi_pm_prepare,
672 .enter = acpi_suspend_enter,
673 .wake = acpi_pm_finish,
674 .end = acpi_pm_end,
675 };
676
677 /**
678 * acpi_suspend_begin_old - Set the target system sleep state to the
679 * state associated with given @pm_state, if supported, and
680 * execute the _PTS control method. This function is used if the
681 * pre-ACPI 2.0 suspend ordering has been requested.
682 */
acpi_suspend_begin_old(suspend_state_t pm_state)683 static int acpi_suspend_begin_old(suspend_state_t pm_state)
684 {
685 int error = acpi_suspend_begin(pm_state);
686 if (!error)
687 error = __acpi_pm_prepare();
688
689 return error;
690 }
691
692 /*
693 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
694 * been requested.
695 */
696 static const struct platform_suspend_ops acpi_suspend_ops_old = {
697 .valid = acpi_suspend_state_valid,
698 .begin = acpi_suspend_begin_old,
699 .prepare_late = acpi_pm_pre_suspend,
700 .enter = acpi_suspend_enter,
701 .wake = acpi_pm_finish,
702 .end = acpi_pm_end,
703 .recover = acpi_pm_finish,
704 };
705
706 static bool s2idle_wakeup;
707
acpi_s2idle_begin(void)708 int acpi_s2idle_begin(void)
709 {
710 acpi_scan_lock_acquire();
711 return 0;
712 }
713
acpi_s2idle_prepare(void)714 int acpi_s2idle_prepare(void)
715 {
716 if (acpi_sci_irq_valid()) {
717 enable_irq_wake(acpi_sci_irq);
718 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
719 }
720
721 acpi_enable_wakeup_devices(ACPI_STATE_S0);
722
723 /* Change the configuration of GPEs to avoid spurious wakeup. */
724 acpi_enable_all_wakeup_gpes();
725 acpi_os_wait_events_complete();
726
727 s2idle_wakeup = true;
728 return 0;
729 }
730
acpi_s2idle_wake(void)731 bool acpi_s2idle_wake(void)
732 {
733 if (!acpi_sci_irq_valid())
734 return pm_wakeup_pending();
735
736 while (pm_wakeup_pending()) {
737 /*
738 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the
739 * SCI has not triggered while suspended, so bail out (the
740 * wakeup is pending anyway and the SCI is not the source of
741 * it).
742 */
743 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) {
744 pm_pr_dbg("Wakeup unrelated to ACPI SCI\n");
745 return true;
746 }
747
748 /*
749 * If the status bit of any enabled fixed event is set, the
750 * wakeup is regarded as valid.
751 */
752 if (acpi_any_fixed_event_status_set()) {
753 pm_pr_dbg("ACPI fixed event wakeup\n");
754 return true;
755 }
756
757 /* Check wakeups from drivers sharing the SCI. */
758 if (acpi_check_wakeup_handlers()) {
759 pm_pr_dbg("ACPI custom handler wakeup\n");
760 return true;
761 }
762
763 /*
764 * Check non-EC GPE wakeups and if there are none, cancel the
765 * SCI-related wakeup and dispatch the EC GPE.
766 */
767 if (acpi_ec_dispatch_gpe()) {
768 pm_pr_dbg("ACPI non-EC GPE wakeup\n");
769 return true;
770 }
771
772 acpi_os_wait_events_complete();
773
774 /*
775 * The SCI is in the "suspended" state now and it cannot produce
776 * new wakeup events till the rearming below, so if any of them
777 * are pending here, they must be resulting from the processing
778 * of EC events above or coming from somewhere else.
779 */
780 if (pm_wakeup_pending()) {
781 pm_pr_dbg("Wakeup after ACPI Notify sync\n");
782 return true;
783 }
784
785 pm_pr_dbg("Rearming ACPI SCI for wakeup\n");
786
787 pm_wakeup_clear(acpi_sci_irq);
788 rearm_wake_irq(acpi_sci_irq);
789 }
790
791 return false;
792 }
793
acpi_s2idle_restore(void)794 void acpi_s2idle_restore(void)
795 {
796 /*
797 * Drain pending events before restoring the working-state configuration
798 * of GPEs.
799 */
800 acpi_os_wait_events_complete(); /* synchronize GPE processing */
801 acpi_ec_flush_work(); /* flush the EC driver's workqueues */
802 acpi_os_wait_events_complete(); /* synchronize Notify handling */
803
804 s2idle_wakeup = false;
805
806 acpi_enable_all_runtime_gpes();
807
808 acpi_disable_wakeup_devices(ACPI_STATE_S0);
809
810 if (acpi_sci_irq_valid()) {
811 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
812 disable_irq_wake(acpi_sci_irq);
813 }
814 }
815
acpi_s2idle_end(void)816 void acpi_s2idle_end(void)
817 {
818 acpi_scan_lock_release();
819 }
820
821 static const struct platform_s2idle_ops acpi_s2idle_ops = {
822 .begin = acpi_s2idle_begin,
823 .prepare = acpi_s2idle_prepare,
824 .wake = acpi_s2idle_wake,
825 .restore = acpi_s2idle_restore,
826 .end = acpi_s2idle_end,
827 };
828
acpi_s2idle_setup(void)829 void __weak acpi_s2idle_setup(void)
830 {
831 if (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)
832 pr_info("Efficient low-power S0 idle declared\n");
833
834 s2idle_set_ops(&acpi_s2idle_ops);
835 }
836
acpi_sleep_suspend_setup(void)837 static void acpi_sleep_suspend_setup(void)
838 {
839 bool suspend_ops_needed = false;
840 int i;
841
842 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
843 if (acpi_sleep_state_supported(i)) {
844 sleep_states[i] = 1;
845 suspend_ops_needed = true;
846 }
847
848 if (suspend_ops_needed)
849 suspend_set_ops(old_suspend_ordering ?
850 &acpi_suspend_ops_old : &acpi_suspend_ops);
851
852 acpi_s2idle_setup();
853 }
854
855 #else /* !CONFIG_SUSPEND */
856 #define s2idle_wakeup (false)
acpi_sleep_suspend_setup(void)857 static inline void acpi_sleep_suspend_setup(void) {}
858 #endif /* !CONFIG_SUSPEND */
859
acpi_s2idle_wakeup(void)860 bool acpi_s2idle_wakeup(void)
861 {
862 return s2idle_wakeup;
863 }
864
865 #ifdef CONFIG_PM_SLEEP
866 static u32 saved_bm_rld;
867
acpi_save_bm_rld(void)868 static int acpi_save_bm_rld(void)
869 {
870 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
871 return 0;
872 }
873
acpi_restore_bm_rld(void)874 static void acpi_restore_bm_rld(void)
875 {
876 u32 resumed_bm_rld = 0;
877
878 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
879 if (resumed_bm_rld == saved_bm_rld)
880 return;
881
882 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
883 }
884
885 static struct syscore_ops acpi_sleep_syscore_ops = {
886 .suspend = acpi_save_bm_rld,
887 .resume = acpi_restore_bm_rld,
888 };
889
acpi_sleep_syscore_init(void)890 static void acpi_sleep_syscore_init(void)
891 {
892 register_syscore_ops(&acpi_sleep_syscore_ops);
893 }
894 #else
acpi_sleep_syscore_init(void)895 static inline void acpi_sleep_syscore_init(void) {}
896 #endif /* CONFIG_PM_SLEEP */
897
898 #ifdef CONFIG_HIBERNATION
899 static unsigned long s4_hardware_signature;
900 static struct acpi_table_facs *facs;
901 int acpi_check_s4_hw_signature = -1; /* Default behaviour is just to warn */
902
acpi_hibernation_begin(pm_message_t stage)903 static int acpi_hibernation_begin(pm_message_t stage)
904 {
905 if (!nvs_nosave) {
906 int error = suspend_nvs_alloc();
907 if (error)
908 return error;
909 }
910
911 if (stage.event == PM_EVENT_HIBERNATE)
912 pm_set_suspend_via_firmware();
913
914 acpi_pm_start(ACPI_STATE_S4);
915 return 0;
916 }
917
acpi_hibernation_enter(void)918 static int acpi_hibernation_enter(void)
919 {
920 acpi_status status = AE_OK;
921
922 /* This shouldn't return. If it returns, we have a problem */
923 status = acpi_enter_sleep_state(ACPI_STATE_S4);
924 /* Reprogram control registers */
925 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
926
927 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
928 }
929
acpi_hibernation_leave(void)930 static void acpi_hibernation_leave(void)
931 {
932 pm_set_resume_via_firmware();
933 /*
934 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
935 * enable it here.
936 */
937 acpi_enable();
938 /* Reprogram control registers */
939 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
940 /* Check the hardware signature */
941 if (facs && s4_hardware_signature != facs->hardware_signature)
942 pr_crit("Hardware changed while hibernated, success doubtful!\n");
943 /* Restore the NVS memory area */
944 suspend_nvs_restore();
945 /* Allow EC transactions to happen. */
946 acpi_ec_unblock_transactions();
947 }
948
acpi_pm_thaw(void)949 static void acpi_pm_thaw(void)
950 {
951 acpi_ec_unblock_transactions();
952 acpi_enable_all_runtime_gpes();
953 }
954
955 static const struct platform_hibernation_ops acpi_hibernation_ops = {
956 .begin = acpi_hibernation_begin,
957 .end = acpi_pm_end,
958 .pre_snapshot = acpi_pm_prepare,
959 .finish = acpi_pm_finish,
960 .prepare = acpi_pm_prepare,
961 .enter = acpi_hibernation_enter,
962 .leave = acpi_hibernation_leave,
963 .pre_restore = acpi_pm_freeze,
964 .restore_cleanup = acpi_pm_thaw,
965 };
966
967 /**
968 * acpi_hibernation_begin_old - Set the target system sleep state to
969 * ACPI_STATE_S4 and execute the _PTS control method. This
970 * function is used if the pre-ACPI 2.0 suspend ordering has been
971 * requested.
972 */
acpi_hibernation_begin_old(pm_message_t stage)973 static int acpi_hibernation_begin_old(pm_message_t stage)
974 {
975 int error;
976 /*
977 * The _TTS object should always be evaluated before the _PTS object.
978 * When the old_suspended_ordering is true, the _PTS object is
979 * evaluated in the acpi_sleep_prepare.
980 */
981 acpi_sleep_tts_switch(ACPI_STATE_S4);
982
983 error = acpi_sleep_prepare(ACPI_STATE_S4);
984 if (error)
985 return error;
986
987 if (!nvs_nosave) {
988 error = suspend_nvs_alloc();
989 if (error)
990 return error;
991 }
992
993 if (stage.event == PM_EVENT_HIBERNATE)
994 pm_set_suspend_via_firmware();
995
996 acpi_target_sleep_state = ACPI_STATE_S4;
997 acpi_scan_lock_acquire();
998 return 0;
999 }
1000
1001 /*
1002 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1003 * been requested.
1004 */
1005 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1006 .begin = acpi_hibernation_begin_old,
1007 .end = acpi_pm_end,
1008 .pre_snapshot = acpi_pm_pre_suspend,
1009 .prepare = acpi_pm_freeze,
1010 .finish = acpi_pm_finish,
1011 .enter = acpi_hibernation_enter,
1012 .leave = acpi_hibernation_leave,
1013 .pre_restore = acpi_pm_freeze,
1014 .restore_cleanup = acpi_pm_thaw,
1015 .recover = acpi_pm_finish,
1016 };
1017
acpi_sleep_hibernate_setup(void)1018 static void acpi_sleep_hibernate_setup(void)
1019 {
1020 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1021 return;
1022
1023 hibernation_set_ops(old_suspend_ordering ?
1024 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1025 sleep_states[ACPI_STATE_S4] = 1;
1026 if (!acpi_check_s4_hw_signature)
1027 return;
1028
1029 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1030 if (facs) {
1031 /*
1032 * s4_hardware_signature is the local variable which is just
1033 * used to warn about mismatch after we're attempting to
1034 * resume (in violation of the ACPI specification.)
1035 */
1036 s4_hardware_signature = facs->hardware_signature;
1037
1038 if (acpi_check_s4_hw_signature > 0) {
1039 /*
1040 * If we're actually obeying the ACPI specification
1041 * then the signature is written out as part of the
1042 * swsusp header, in order to allow the boot kernel
1043 * to gracefully decline to resume.
1044 */
1045 swsusp_hardware_signature = facs->hardware_signature;
1046 }
1047 }
1048 }
1049 #else /* !CONFIG_HIBERNATION */
acpi_sleep_hibernate_setup(void)1050 static inline void acpi_sleep_hibernate_setup(void) {}
1051 #endif /* !CONFIG_HIBERNATION */
1052
acpi_power_off_prepare(struct sys_off_data * data)1053 static int acpi_power_off_prepare(struct sys_off_data *data)
1054 {
1055 /* Prepare to power off the system */
1056 acpi_sleep_prepare(ACPI_STATE_S5);
1057 acpi_disable_all_gpes();
1058 acpi_os_wait_events_complete();
1059 return NOTIFY_DONE;
1060 }
1061
acpi_power_off(struct sys_off_data * data)1062 static int acpi_power_off(struct sys_off_data *data)
1063 {
1064 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1065 pr_debug("%s called\n", __func__);
1066 local_irq_disable();
1067 acpi_enter_sleep_state(ACPI_STATE_S5);
1068 return NOTIFY_DONE;
1069 }
1070
acpi_sleep_init(void)1071 int __init acpi_sleep_init(void)
1072 {
1073 char supported[ACPI_S_STATE_COUNT * 3 + 1];
1074 char *pos = supported;
1075 int i;
1076
1077 acpi_sleep_dmi_check();
1078
1079 sleep_states[ACPI_STATE_S0] = 1;
1080
1081 acpi_sleep_syscore_init();
1082 acpi_sleep_suspend_setup();
1083 acpi_sleep_hibernate_setup();
1084
1085 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1086 sleep_states[ACPI_STATE_S5] = 1;
1087
1088 register_sys_off_handler(SYS_OFF_MODE_POWER_OFF_PREPARE,
1089 SYS_OFF_PRIO_FIRMWARE,
1090 acpi_power_off_prepare, NULL);
1091
1092 register_sys_off_handler(SYS_OFF_MODE_POWER_OFF,
1093 SYS_OFF_PRIO_FIRMWARE,
1094 acpi_power_off, NULL);
1095
1096 /*
1097 * Windows uses S5 for reboot, so some BIOSes depend on it to
1098 * perform proper reboot.
1099 */
1100 register_sys_off_handler(SYS_OFF_MODE_RESTART_PREPARE,
1101 SYS_OFF_PRIO_FIRMWARE,
1102 acpi_power_off_prepare, NULL);
1103 } else {
1104 acpi_no_s5 = true;
1105 }
1106
1107 supported[0] = 0;
1108 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1109 if (sleep_states[i])
1110 pos += sprintf(pos, " S%d", i);
1111 }
1112 pr_info("(supports%s)\n", supported);
1113
1114 /*
1115 * Register the tts_notifier to reboot notifier list so that the _TTS
1116 * object can also be evaluated when the system enters S5.
1117 */
1118 register_reboot_notifier(&tts_notifier);
1119 return 0;
1120 }
1121