Loading...
1/*
2 * sleep.c - ACPI sleep support.
3 *
4 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
5 * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
6 * Copyright (c) 2000-2003 Patrick Mochel
7 * Copyright (c) 2003 Open Source Development Lab
8 *
9 * This file is released under the GPLv2.
10 *
11 */
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
29static u8 sleep_states[ACPI_S_STATE_COUNT];
30
31static void acpi_sleep_tts_switch(u32 acpi_state)
32{
33 acpi_status status;
34
35 status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state);
36 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
37 /*
38 * OS can't evaluate the _TTS object correctly. Some warning
39 * message will be printed. But it won't break anything.
40 */
41 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
42 }
43}
44
45static int tts_notify_reboot(struct notifier_block *this,
46 unsigned long code, void *x)
47{
48 acpi_sleep_tts_switch(ACPI_STATE_S5);
49 return NOTIFY_DONE;
50}
51
52static struct notifier_block tts_notifier = {
53 .notifier_call = tts_notify_reboot,
54 .next = NULL,
55 .priority = 0,
56};
57
58static int acpi_sleep_prepare(u32 acpi_state)
59{
60#ifdef CONFIG_ACPI_SLEEP
61 /* do we have a wakeup address for S2 and S3? */
62 if (acpi_state == ACPI_STATE_S3) {
63 if (!acpi_wakeup_address)
64 return -EFAULT;
65 acpi_set_waking_vector(acpi_wakeup_address);
66
67 }
68 ACPI_FLUSH_CPU_CACHE();
69#endif
70 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
71 acpi_state);
72 acpi_enable_wakeup_devices(acpi_state);
73 acpi_enter_sleep_state_prep(acpi_state);
74 return 0;
75}
76
77static bool acpi_sleep_state_supported(u8 sleep_state)
78{
79 acpi_status status;
80 u8 type_a, type_b;
81
82 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
83 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
84 || (acpi_gbl_FADT.sleep_control.address
85 && acpi_gbl_FADT.sleep_status.address));
86}
87
88#ifdef CONFIG_ACPI_SLEEP
89static u32 acpi_target_sleep_state = ACPI_STATE_S0;
90
91u32 acpi_target_system_state(void)
92{
93 return acpi_target_sleep_state;
94}
95EXPORT_SYMBOL_GPL(acpi_target_system_state);
96
97static bool pwr_btn_event_pending;
98
99/*
100 * The ACPI specification wants us to save NVS memory regions during hibernation
101 * and to restore them during the subsequent resume. Windows does that also for
102 * suspend to RAM. However, it is known that this mechanism does not work on
103 * all machines, so we allow the user to disable it with the help of the
104 * 'acpi_sleep=nonvs' kernel command line option.
105 */
106static bool nvs_nosave;
107
108void __init acpi_nvs_nosave(void)
109{
110 nvs_nosave = true;
111}
112
113/*
114 * The ACPI specification wants us to save NVS memory regions during hibernation
115 * but says nothing about saving NVS during S3. Not all versions of Windows
116 * save NVS on S3 suspend either, and it is clear that not all systems need
117 * NVS to be saved at S3 time. To improve suspend/resume time, allow the
118 * user to disable saving NVS on S3 if their system does not require it, but
119 * continue to save/restore NVS for S4 as specified.
120 */
121static bool nvs_nosave_s3;
122
123void __init acpi_nvs_nosave_s3(void)
124{
125 nvs_nosave_s3 = true;
126}
127
128/*
129 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
130 * user to request that behavior by using the 'acpi_old_suspend_ordering'
131 * kernel command line option that causes the following variable to be set.
132 */
133static bool old_suspend_ordering;
134
135void __init acpi_old_suspend_ordering(void)
136{
137 old_suspend_ordering = true;
138}
139
140static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
141{
142 acpi_old_suspend_ordering();
143 return 0;
144}
145
146static int __init init_nvs_nosave(const struct dmi_system_id *d)
147{
148 acpi_nvs_nosave();
149 return 0;
150}
151
152static struct dmi_system_id acpisleep_dmi_table[] __initdata = {
153 {
154 .callback = init_old_suspend_ordering,
155 .ident = "Abit KN9 (nForce4 variant)",
156 .matches = {
157 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
158 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
159 },
160 },
161 {
162 .callback = init_old_suspend_ordering,
163 .ident = "HP xw4600 Workstation",
164 .matches = {
165 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
166 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
167 },
168 },
169 {
170 .callback = init_old_suspend_ordering,
171 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
172 .matches = {
173 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
174 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
175 },
176 },
177 {
178 .callback = init_old_suspend_ordering,
179 .ident = "Panasonic CF51-2L",
180 .matches = {
181 DMI_MATCH(DMI_BOARD_VENDOR,
182 "Matsushita Electric Industrial Co.,Ltd."),
183 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
184 },
185 },
186 {
187 .callback = init_nvs_nosave,
188 .ident = "Sony Vaio VGN-FW41E_H",
189 .matches = {
190 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
191 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
192 },
193 },
194 {
195 .callback = init_nvs_nosave,
196 .ident = "Sony Vaio VGN-FW21E",
197 .matches = {
198 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
199 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
200 },
201 },
202 {
203 .callback = init_nvs_nosave,
204 .ident = "Sony Vaio VGN-FW21M",
205 .matches = {
206 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
207 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
208 },
209 },
210 {
211 .callback = init_nvs_nosave,
212 .ident = "Sony Vaio VPCEB17FX",
213 .matches = {
214 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
215 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
216 },
217 },
218 {
219 .callback = init_nvs_nosave,
220 .ident = "Sony Vaio VGN-SR11M",
221 .matches = {
222 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
223 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
224 },
225 },
226 {
227 .callback = init_nvs_nosave,
228 .ident = "Everex StepNote Series",
229 .matches = {
230 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
231 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
232 },
233 },
234 {
235 .callback = init_nvs_nosave,
236 .ident = "Sony Vaio VPCEB1Z1E",
237 .matches = {
238 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
239 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
240 },
241 },
242 {
243 .callback = init_nvs_nosave,
244 .ident = "Sony Vaio VGN-NW130D",
245 .matches = {
246 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
247 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
248 },
249 },
250 {
251 .callback = init_nvs_nosave,
252 .ident = "Sony Vaio VPCCW29FX",
253 .matches = {
254 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
255 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
256 },
257 },
258 {
259 .callback = init_nvs_nosave,
260 .ident = "Averatec AV1020-ED2",
261 .matches = {
262 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
263 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
264 },
265 },
266 {
267 .callback = init_old_suspend_ordering,
268 .ident = "Asus A8N-SLI DELUXE",
269 .matches = {
270 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
271 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
272 },
273 },
274 {
275 .callback = init_old_suspend_ordering,
276 .ident = "Asus A8N-SLI Premium",
277 .matches = {
278 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
279 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
280 },
281 },
282 {
283 .callback = init_nvs_nosave,
284 .ident = "Sony Vaio VGN-SR26GN_P",
285 .matches = {
286 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
287 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
288 },
289 },
290 {
291 .callback = init_nvs_nosave,
292 .ident = "Sony Vaio VPCEB1S1E",
293 .matches = {
294 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
295 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
296 },
297 },
298 {
299 .callback = init_nvs_nosave,
300 .ident = "Sony Vaio VGN-FW520F",
301 .matches = {
302 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
303 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
304 },
305 },
306 {
307 .callback = init_nvs_nosave,
308 .ident = "Asus K54C",
309 .matches = {
310 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
311 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
312 },
313 },
314 {
315 .callback = init_nvs_nosave,
316 .ident = "Asus K54HR",
317 .matches = {
318 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
319 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
320 },
321 },
322 {},
323};
324
325static void __init acpi_sleep_dmi_check(void)
326{
327 int year;
328
329 if (dmi_get_date(DMI_BIOS_DATE, &year, NULL, NULL) && year >= 2012)
330 acpi_nvs_nosave_s3();
331
332 dmi_check_system(acpisleep_dmi_table);
333}
334
335/**
336 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
337 */
338static int acpi_pm_freeze(void)
339{
340 acpi_disable_all_gpes();
341 acpi_os_wait_events_complete();
342 acpi_ec_block_transactions();
343 return 0;
344}
345
346/**
347 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
348 */
349static int acpi_pm_pre_suspend(void)
350{
351 acpi_pm_freeze();
352 return suspend_nvs_save();
353}
354
355/**
356 * __acpi_pm_prepare - Prepare the platform to enter the target state.
357 *
358 * If necessary, set the firmware waking vector and do arch-specific
359 * nastiness to get the wakeup code to the waking vector.
360 */
361static int __acpi_pm_prepare(void)
362{
363 int error = acpi_sleep_prepare(acpi_target_sleep_state);
364 if (error)
365 acpi_target_sleep_state = ACPI_STATE_S0;
366
367 return error;
368}
369
370/**
371 * acpi_pm_prepare - Prepare the platform to enter the target sleep
372 * state and disable the GPEs.
373 */
374static int acpi_pm_prepare(void)
375{
376 int error = __acpi_pm_prepare();
377 if (!error)
378 error = acpi_pm_pre_suspend();
379
380 return error;
381}
382
383static int find_powerf_dev(struct device *dev, void *data)
384{
385 struct acpi_device *device = to_acpi_device(dev);
386 const char *hid = acpi_device_hid(device);
387
388 return !strcmp(hid, ACPI_BUTTON_HID_POWERF);
389}
390
391/**
392 * acpi_pm_finish - Instruct the platform to leave a sleep state.
393 *
394 * This is called after we wake back up (or if entering the sleep state
395 * failed).
396 */
397static void acpi_pm_finish(void)
398{
399 struct device *pwr_btn_dev;
400 u32 acpi_state = acpi_target_sleep_state;
401
402 acpi_ec_unblock_transactions();
403 suspend_nvs_free();
404
405 if (acpi_state == ACPI_STATE_S0)
406 return;
407
408 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
409 acpi_state);
410 acpi_disable_wakeup_devices(acpi_state);
411 acpi_leave_sleep_state(acpi_state);
412
413 /* reset firmware waking vector */
414 acpi_set_waking_vector(0);
415
416 acpi_target_sleep_state = ACPI_STATE_S0;
417
418 acpi_resume_power_resources();
419
420 /* If we were woken with the fixed power button, provide a small
421 * hint to userspace in the form of a wakeup event on the fixed power
422 * button device (if it can be found).
423 *
424 * We delay the event generation til now, as the PM layer requires
425 * timekeeping to be running before we generate events. */
426 if (!pwr_btn_event_pending)
427 return;
428
429 pwr_btn_event_pending = false;
430 pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL,
431 find_powerf_dev);
432 if (pwr_btn_dev) {
433 pm_wakeup_event(pwr_btn_dev, 0);
434 put_device(pwr_btn_dev);
435 }
436}
437
438/**
439 * acpi_pm_start - Start system PM transition.
440 */
441static void acpi_pm_start(u32 acpi_state)
442{
443 acpi_target_sleep_state = acpi_state;
444 acpi_sleep_tts_switch(acpi_target_sleep_state);
445 acpi_scan_lock_acquire();
446}
447
448/**
449 * acpi_pm_end - Finish up system PM transition.
450 */
451static void acpi_pm_end(void)
452{
453 acpi_scan_lock_release();
454 /*
455 * This is necessary in case acpi_pm_finish() is not called during a
456 * failing transition to a sleep state.
457 */
458 acpi_target_sleep_state = ACPI_STATE_S0;
459 acpi_sleep_tts_switch(acpi_target_sleep_state);
460}
461#else /* !CONFIG_ACPI_SLEEP */
462#define acpi_target_sleep_state ACPI_STATE_S0
463static inline void acpi_sleep_dmi_check(void) {}
464#endif /* CONFIG_ACPI_SLEEP */
465
466#ifdef CONFIG_SUSPEND
467static u32 acpi_suspend_states[] = {
468 [PM_SUSPEND_ON] = ACPI_STATE_S0,
469 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
470 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
471 [PM_SUSPEND_MAX] = ACPI_STATE_S5
472};
473
474/**
475 * acpi_suspend_begin - Set the target system sleep state to the state
476 * associated with given @pm_state, if supported.
477 */
478static int acpi_suspend_begin(suspend_state_t pm_state)
479{
480 u32 acpi_state = acpi_suspend_states[pm_state];
481 int error;
482
483 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
484 if (error)
485 return error;
486
487 if (!sleep_states[acpi_state]) {
488 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
489 return -ENOSYS;
490 }
491 if (acpi_state > ACPI_STATE_S1)
492 pm_set_suspend_via_firmware();
493
494 acpi_pm_start(acpi_state);
495 return 0;
496}
497
498/**
499 * acpi_suspend_enter - Actually enter a sleep state.
500 * @pm_state: ignored
501 *
502 * Flush caches and go to sleep. For STR we have to call arch-specific
503 * assembly, which in turn call acpi_enter_sleep_state().
504 * It's unfortunate, but it works. Please fix if you're feeling frisky.
505 */
506static int acpi_suspend_enter(suspend_state_t pm_state)
507{
508 acpi_status status = AE_OK;
509 u32 acpi_state = acpi_target_sleep_state;
510 int error;
511
512 ACPI_FLUSH_CPU_CACHE();
513
514 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
515 switch (acpi_state) {
516 case ACPI_STATE_S1:
517 barrier();
518 status = acpi_enter_sleep_state(acpi_state);
519 break;
520
521 case ACPI_STATE_S3:
522 if (!acpi_suspend_lowlevel)
523 return -ENOSYS;
524 error = acpi_suspend_lowlevel();
525 if (error)
526 return error;
527 pr_info(PREFIX "Low-level resume complete\n");
528 pm_set_resume_via_firmware();
529 break;
530 }
531 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
532
533 /* This violates the spec but is required for bug compatibility. */
534 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
535
536 /* Reprogram control registers */
537 acpi_leave_sleep_state_prep(acpi_state);
538
539 /* ACPI 3.0 specs (P62) says that it's the responsibility
540 * of the OSPM to clear the status bit [ implying that the
541 * POWER_BUTTON event should not reach userspace ]
542 *
543 * However, we do generate a small hint for userspace in the form of
544 * a wakeup event. We flag this condition for now and generate the
545 * event later, as we're currently too early in resume to be able to
546 * generate wakeup events.
547 */
548 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
549 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
550
551 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
552
553 if (pwr_btn_status & ACPI_EVENT_FLAG_SET) {
554 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
555 /* Flag for later */
556 pwr_btn_event_pending = true;
557 }
558 }
559
560 /*
561 * Disable and clear GPE status before interrupt is enabled. Some GPEs
562 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
563 * acpi_leave_sleep_state will reenable specific GPEs later
564 */
565 acpi_disable_all_gpes();
566 /* Allow EC transactions to happen. */
567 acpi_ec_unblock_transactions_early();
568
569 suspend_nvs_restore();
570
571 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
572}
573
574static int acpi_suspend_state_valid(suspend_state_t pm_state)
575{
576 u32 acpi_state;
577
578 switch (pm_state) {
579 case PM_SUSPEND_ON:
580 case PM_SUSPEND_STANDBY:
581 case PM_SUSPEND_MEM:
582 acpi_state = acpi_suspend_states[pm_state];
583
584 return sleep_states[acpi_state];
585 default:
586 return 0;
587 }
588}
589
590static const struct platform_suspend_ops acpi_suspend_ops = {
591 .valid = acpi_suspend_state_valid,
592 .begin = acpi_suspend_begin,
593 .prepare_late = acpi_pm_prepare,
594 .enter = acpi_suspend_enter,
595 .wake = acpi_pm_finish,
596 .end = acpi_pm_end,
597};
598
599/**
600 * acpi_suspend_begin_old - Set the target system sleep state to the
601 * state associated with given @pm_state, if supported, and
602 * execute the _PTS control method. This function is used if the
603 * pre-ACPI 2.0 suspend ordering has been requested.
604 */
605static int acpi_suspend_begin_old(suspend_state_t pm_state)
606{
607 int error = acpi_suspend_begin(pm_state);
608 if (!error)
609 error = __acpi_pm_prepare();
610
611 return error;
612}
613
614/*
615 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
616 * been requested.
617 */
618static const struct platform_suspend_ops acpi_suspend_ops_old = {
619 .valid = acpi_suspend_state_valid,
620 .begin = acpi_suspend_begin_old,
621 .prepare_late = acpi_pm_pre_suspend,
622 .enter = acpi_suspend_enter,
623 .wake = acpi_pm_finish,
624 .end = acpi_pm_end,
625 .recover = acpi_pm_finish,
626};
627
628static int acpi_freeze_begin(void)
629{
630 acpi_scan_lock_acquire();
631 return 0;
632}
633
634static int acpi_freeze_prepare(void)
635{
636 acpi_enable_wakeup_devices(ACPI_STATE_S0);
637 acpi_enable_all_wakeup_gpes();
638 acpi_os_wait_events_complete();
639 if (acpi_sci_irq_valid())
640 enable_irq_wake(acpi_sci_irq);
641 return 0;
642}
643
644static void acpi_freeze_restore(void)
645{
646 acpi_disable_wakeup_devices(ACPI_STATE_S0);
647 if (acpi_sci_irq_valid())
648 disable_irq_wake(acpi_sci_irq);
649 acpi_enable_all_runtime_gpes();
650}
651
652static void acpi_freeze_end(void)
653{
654 acpi_scan_lock_release();
655}
656
657static const struct platform_freeze_ops acpi_freeze_ops = {
658 .begin = acpi_freeze_begin,
659 .prepare = acpi_freeze_prepare,
660 .restore = acpi_freeze_restore,
661 .end = acpi_freeze_end,
662};
663
664static void acpi_sleep_suspend_setup(void)
665{
666 int i;
667
668 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
669 if (acpi_sleep_state_supported(i))
670 sleep_states[i] = 1;
671
672 suspend_set_ops(old_suspend_ordering ?
673 &acpi_suspend_ops_old : &acpi_suspend_ops);
674 freeze_set_ops(&acpi_freeze_ops);
675}
676
677#else /* !CONFIG_SUSPEND */
678static inline void acpi_sleep_suspend_setup(void) {}
679#endif /* !CONFIG_SUSPEND */
680
681#ifdef CONFIG_PM_SLEEP
682static u32 saved_bm_rld;
683
684static int acpi_save_bm_rld(void)
685{
686 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
687 return 0;
688}
689
690static void acpi_restore_bm_rld(void)
691{
692 u32 resumed_bm_rld = 0;
693
694 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
695 if (resumed_bm_rld == saved_bm_rld)
696 return;
697
698 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
699}
700
701static struct syscore_ops acpi_sleep_syscore_ops = {
702 .suspend = acpi_save_bm_rld,
703 .resume = acpi_restore_bm_rld,
704};
705
706void acpi_sleep_syscore_init(void)
707{
708 register_syscore_ops(&acpi_sleep_syscore_ops);
709}
710#else
711static inline void acpi_sleep_syscore_init(void) {}
712#endif /* CONFIG_PM_SLEEP */
713
714#ifdef CONFIG_HIBERNATION
715static unsigned long s4_hardware_signature;
716static struct acpi_table_facs *facs;
717static bool nosigcheck;
718
719void __init acpi_no_s4_hw_signature(void)
720{
721 nosigcheck = true;
722}
723
724static int acpi_hibernation_begin(void)
725{
726 int error;
727
728 error = nvs_nosave ? 0 : suspend_nvs_alloc();
729 if (!error)
730 acpi_pm_start(ACPI_STATE_S4);
731
732 return error;
733}
734
735static int acpi_hibernation_enter(void)
736{
737 acpi_status status = AE_OK;
738
739 ACPI_FLUSH_CPU_CACHE();
740
741 /* This shouldn't return. If it returns, we have a problem */
742 status = acpi_enter_sleep_state(ACPI_STATE_S4);
743 /* Reprogram control registers */
744 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
745
746 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
747}
748
749static void acpi_hibernation_leave(void)
750{
751 pm_set_resume_via_firmware();
752 /*
753 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
754 * enable it here.
755 */
756 acpi_enable();
757 /* Reprogram control registers */
758 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
759 /* Check the hardware signature */
760 if (facs && s4_hardware_signature != facs->hardware_signature)
761 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
762 /* Restore the NVS memory area */
763 suspend_nvs_restore();
764 /* Allow EC transactions to happen. */
765 acpi_ec_unblock_transactions_early();
766}
767
768static void acpi_pm_thaw(void)
769{
770 acpi_ec_unblock_transactions();
771 acpi_enable_all_runtime_gpes();
772}
773
774static const struct platform_hibernation_ops acpi_hibernation_ops = {
775 .begin = acpi_hibernation_begin,
776 .end = acpi_pm_end,
777 .pre_snapshot = acpi_pm_prepare,
778 .finish = acpi_pm_finish,
779 .prepare = acpi_pm_prepare,
780 .enter = acpi_hibernation_enter,
781 .leave = acpi_hibernation_leave,
782 .pre_restore = acpi_pm_freeze,
783 .restore_cleanup = acpi_pm_thaw,
784};
785
786/**
787 * acpi_hibernation_begin_old - Set the target system sleep state to
788 * ACPI_STATE_S4 and execute the _PTS control method. This
789 * function is used if the pre-ACPI 2.0 suspend ordering has been
790 * requested.
791 */
792static int acpi_hibernation_begin_old(void)
793{
794 int error;
795 /*
796 * The _TTS object should always be evaluated before the _PTS object.
797 * When the old_suspended_ordering is true, the _PTS object is
798 * evaluated in the acpi_sleep_prepare.
799 */
800 acpi_sleep_tts_switch(ACPI_STATE_S4);
801
802 error = acpi_sleep_prepare(ACPI_STATE_S4);
803
804 if (!error) {
805 if (!nvs_nosave)
806 error = suspend_nvs_alloc();
807 if (!error) {
808 acpi_target_sleep_state = ACPI_STATE_S4;
809 acpi_scan_lock_acquire();
810 }
811 }
812 return error;
813}
814
815/*
816 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
817 * been requested.
818 */
819static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
820 .begin = acpi_hibernation_begin_old,
821 .end = acpi_pm_end,
822 .pre_snapshot = acpi_pm_pre_suspend,
823 .prepare = acpi_pm_freeze,
824 .finish = acpi_pm_finish,
825 .enter = acpi_hibernation_enter,
826 .leave = acpi_hibernation_leave,
827 .pre_restore = acpi_pm_freeze,
828 .restore_cleanup = acpi_pm_thaw,
829 .recover = acpi_pm_finish,
830};
831
832static void acpi_sleep_hibernate_setup(void)
833{
834 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
835 return;
836
837 hibernation_set_ops(old_suspend_ordering ?
838 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
839 sleep_states[ACPI_STATE_S4] = 1;
840 if (nosigcheck)
841 return;
842
843 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
844 if (facs)
845 s4_hardware_signature = facs->hardware_signature;
846}
847#else /* !CONFIG_HIBERNATION */
848static inline void acpi_sleep_hibernate_setup(void) {}
849#endif /* !CONFIG_HIBERNATION */
850
851static void acpi_power_off_prepare(void)
852{
853 /* Prepare to power off the system */
854 acpi_sleep_prepare(ACPI_STATE_S5);
855 acpi_disable_all_gpes();
856 acpi_os_wait_events_complete();
857}
858
859static void acpi_power_off(void)
860{
861 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
862 printk(KERN_DEBUG "%s called\n", __func__);
863 local_irq_disable();
864 acpi_enter_sleep_state(ACPI_STATE_S5);
865}
866
867int __init acpi_sleep_init(void)
868{
869 char supported[ACPI_S_STATE_COUNT * 3 + 1];
870 char *pos = supported;
871 int i;
872
873 acpi_sleep_dmi_check();
874
875 sleep_states[ACPI_STATE_S0] = 1;
876
877 acpi_sleep_syscore_init();
878 acpi_sleep_suspend_setup();
879 acpi_sleep_hibernate_setup();
880
881 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
882 sleep_states[ACPI_STATE_S5] = 1;
883 pm_power_off_prepare = acpi_power_off_prepare;
884 pm_power_off = acpi_power_off;
885 }
886
887 supported[0] = 0;
888 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
889 if (sleep_states[i])
890 pos += sprintf(pos, " S%d", i);
891 }
892 pr_info(PREFIX "(supports%s)\n", supported);
893
894 /*
895 * Register the tts_notifier to reboot notifier list so that the _TTS
896 * object can also be evaluated when the system enters S5.
897 */
898 register_reboot_notifier(&tts_notifier);
899 return 0;
900}
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 */
33bool acpi_no_s5;
34static u8 sleep_states[ACPI_S_STATE_COUNT];
35
36static 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
50static 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
57static struct notifier_block tts_notifier = {
58 .notifier_call = tts_notify_reboot,
59 .next = NULL,
60 .priority = 0,
61};
62
63static int acpi_sleep_prepare(u32 acpi_state)
64{
65#ifdef CONFIG_ACPI_SLEEP
66 unsigned long acpi_wakeup_address;
67
68 /* do we have a wakeup address for S2 and S3? */
69 if (acpi_state == ACPI_STATE_S3) {
70 acpi_wakeup_address = acpi_get_wakeup_address();
71 if (!acpi_wakeup_address)
72 return -EFAULT;
73 acpi_set_waking_vector(acpi_wakeup_address);
74
75 }
76 ACPI_FLUSH_CPU_CACHE();
77#endif
78 pr_info("Preparing to enter system sleep state S%d\n", acpi_state);
79 acpi_enable_wakeup_devices(acpi_state);
80 acpi_enter_sleep_state_prep(acpi_state);
81 return 0;
82}
83
84bool acpi_sleep_state_supported(u8 sleep_state)
85{
86 acpi_status status;
87 u8 type_a, type_b;
88
89 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
90 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
91 || (acpi_gbl_FADT.sleep_control.address
92 && acpi_gbl_FADT.sleep_status.address));
93}
94
95#ifdef CONFIG_ACPI_SLEEP
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
165bool 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_pm_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 pr_info("Waking up from system sleep state S%d\n", acpi_state);
464 acpi_disable_wakeup_devices(acpi_state);
465 acpi_leave_sleep_state(acpi_state);
466
467 /* reset firmware waking vector */
468 acpi_set_waking_vector(0);
469
470 acpi_target_sleep_state = ACPI_STATE_S0;
471
472 acpi_resume_power_resources();
473
474 /* If we were woken with the fixed power button, provide a small
475 * hint to userspace in the form of a wakeup event on the fixed power
476 * button device (if it can be found).
477 *
478 * We delay the event generation til now, as the PM layer requires
479 * timekeeping to be running before we generate events. */
480 if (!pwr_btn_event_pending)
481 return;
482
483 pwr_btn_event_pending = false;
484 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
485 NULL, -1);
486 if (pwr_btn_adev) {
487 pm_wakeup_event(&pwr_btn_adev->dev, 0);
488 acpi_dev_put(pwr_btn_adev);
489 }
490}
491
492/**
493 * acpi_pm_start - Start system PM transition.
494 */
495static void acpi_pm_start(u32 acpi_state)
496{
497 acpi_target_sleep_state = acpi_state;
498 acpi_sleep_tts_switch(acpi_target_sleep_state);
499 acpi_scan_lock_acquire();
500}
501
502/**
503 * acpi_pm_end - Finish up system PM transition.
504 */
505static void acpi_pm_end(void)
506{
507 acpi_turn_off_unused_power_resources();
508 acpi_scan_lock_release();
509 /*
510 * This is necessary in case acpi_pm_finish() is not called during a
511 * failing transition to a sleep state.
512 */
513 acpi_target_sleep_state = ACPI_STATE_S0;
514 acpi_sleep_tts_switch(acpi_target_sleep_state);
515}
516#else /* !CONFIG_ACPI_SLEEP */
517#define sleep_no_lps0 (1)
518#define acpi_target_sleep_state ACPI_STATE_S0
519#define acpi_sleep_default_s3 (1)
520static inline void acpi_sleep_dmi_check(void) {}
521#endif /* CONFIG_ACPI_SLEEP */
522
523#ifdef CONFIG_SUSPEND
524static u32 acpi_suspend_states[] = {
525 [PM_SUSPEND_ON] = ACPI_STATE_S0,
526 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
527 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
528 [PM_SUSPEND_MAX] = ACPI_STATE_S5
529};
530
531/**
532 * acpi_suspend_begin - Set the target system sleep state to the state
533 * associated with given @pm_state, if supported.
534 */
535static int acpi_suspend_begin(suspend_state_t pm_state)
536{
537 u32 acpi_state = acpi_suspend_states[pm_state];
538 int error;
539
540 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
541 if (error)
542 return error;
543
544 if (!sleep_states[acpi_state]) {
545 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
546 return -ENOSYS;
547 }
548 if (acpi_state > ACPI_STATE_S1)
549 pm_set_suspend_via_firmware();
550
551 acpi_pm_start(acpi_state);
552 return 0;
553}
554
555/**
556 * acpi_suspend_enter - Actually enter a sleep state.
557 * @pm_state: ignored
558 *
559 * Flush caches and go to sleep. For STR we have to call arch-specific
560 * assembly, which in turn call acpi_enter_sleep_state().
561 * It's unfortunate, but it works. Please fix if you're feeling frisky.
562 */
563static int acpi_suspend_enter(suspend_state_t pm_state)
564{
565 acpi_status status = AE_OK;
566 u32 acpi_state = acpi_target_sleep_state;
567 int error;
568
569 ACPI_FLUSH_CPU_CACHE();
570
571 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
572 switch (acpi_state) {
573 case ACPI_STATE_S1:
574 barrier();
575 status = acpi_enter_sleep_state(acpi_state);
576 break;
577
578 case ACPI_STATE_S3:
579 if (!acpi_suspend_lowlevel)
580 return -ENOSYS;
581 error = acpi_suspend_lowlevel();
582 if (error)
583 return error;
584 pr_info("Low-level resume complete\n");
585 pm_set_resume_via_firmware();
586 break;
587 }
588 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
589
590 /* This violates the spec but is required for bug compatibility. */
591 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
592
593 /* Reprogram control registers */
594 acpi_leave_sleep_state_prep(acpi_state);
595
596 /* ACPI 3.0 specs (P62) says that it's the responsibility
597 * of the OSPM to clear the status bit [ implying that the
598 * POWER_BUTTON event should not reach userspace ]
599 *
600 * However, we do generate a small hint for userspace in the form of
601 * a wakeup event. We flag this condition for now and generate the
602 * event later, as we're currently too early in resume to be able to
603 * generate wakeup events.
604 */
605 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
606 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
607
608 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
609
610 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
611 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
612 /* Flag for later */
613 pwr_btn_event_pending = true;
614 }
615 }
616
617 /*
618 * Disable and clear GPE status before interrupt is enabled. Some GPEs
619 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
620 * acpi_leave_sleep_state will reenable specific GPEs later
621 */
622 acpi_disable_all_gpes();
623 /* Allow EC transactions to happen. */
624 acpi_ec_unblock_transactions();
625
626 suspend_nvs_restore();
627
628 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
629}
630
631static int acpi_suspend_state_valid(suspend_state_t pm_state)
632{
633 u32 acpi_state;
634
635 switch (pm_state) {
636 case PM_SUSPEND_ON:
637 case PM_SUSPEND_STANDBY:
638 case PM_SUSPEND_MEM:
639 acpi_state = acpi_suspend_states[pm_state];
640
641 return sleep_states[acpi_state];
642 default:
643 return 0;
644 }
645}
646
647static const struct platform_suspend_ops acpi_suspend_ops = {
648 .valid = acpi_suspend_state_valid,
649 .begin = acpi_suspend_begin,
650 .prepare_late = acpi_pm_prepare,
651 .enter = acpi_suspend_enter,
652 .wake = acpi_pm_finish,
653 .end = acpi_pm_end,
654};
655
656/**
657 * acpi_suspend_begin_old - Set the target system sleep state to the
658 * state associated with given @pm_state, if supported, and
659 * execute the _PTS control method. This function is used if the
660 * pre-ACPI 2.0 suspend ordering has been requested.
661 */
662static int acpi_suspend_begin_old(suspend_state_t pm_state)
663{
664 int error = acpi_suspend_begin(pm_state);
665 if (!error)
666 error = __acpi_pm_prepare();
667
668 return error;
669}
670
671/*
672 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
673 * been requested.
674 */
675static const struct platform_suspend_ops acpi_suspend_ops_old = {
676 .valid = acpi_suspend_state_valid,
677 .begin = acpi_suspend_begin_old,
678 .prepare_late = acpi_pm_pre_suspend,
679 .enter = acpi_suspend_enter,
680 .wake = acpi_pm_finish,
681 .end = acpi_pm_end,
682 .recover = acpi_pm_finish,
683};
684
685static bool s2idle_wakeup;
686
687int acpi_s2idle_begin(void)
688{
689 acpi_scan_lock_acquire();
690 return 0;
691}
692
693int acpi_s2idle_prepare(void)
694{
695 if (acpi_sci_irq_valid()) {
696 enable_irq_wake(acpi_sci_irq);
697 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
698 }
699
700 acpi_enable_wakeup_devices(ACPI_STATE_S0);
701
702 /* Change the configuration of GPEs to avoid spurious wakeup. */
703 acpi_enable_all_wakeup_gpes();
704 acpi_os_wait_events_complete();
705
706 s2idle_wakeup = true;
707 return 0;
708}
709
710bool acpi_s2idle_wake(void)
711{
712 if (!acpi_sci_irq_valid())
713 return pm_wakeup_pending();
714
715 while (pm_wakeup_pending()) {
716 /*
717 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the
718 * SCI has not triggered while suspended, so bail out (the
719 * wakeup is pending anyway and the SCI is not the source of
720 * it).
721 */
722 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) {
723 pm_pr_dbg("Wakeup unrelated to ACPI SCI\n");
724 return true;
725 }
726
727 /*
728 * If the status bit of any enabled fixed event is set, the
729 * wakeup is regarded as valid.
730 */
731 if (acpi_any_fixed_event_status_set()) {
732 pm_pr_dbg("ACPI fixed event wakeup\n");
733 return true;
734 }
735
736 /* Check wakeups from drivers sharing the SCI. */
737 if (acpi_check_wakeup_handlers()) {
738 pm_pr_dbg("ACPI custom handler wakeup\n");
739 return true;
740 }
741
742 /* Check non-EC GPE wakeups and dispatch the EC GPE. */
743 if (acpi_ec_dispatch_gpe()) {
744 pm_pr_dbg("ACPI non-EC GPE wakeup\n");
745 return true;
746 }
747
748 /*
749 * Cancel the SCI wakeup and process all pending events in case
750 * there are any wakeup ones in there.
751 *
752 * Note that if any non-EC GPEs are active at this point, the
753 * SCI will retrigger after the rearming below, so no events
754 * should be missed by canceling the wakeup here.
755 */
756 pm_system_cancel_wakeup();
757 acpi_os_wait_events_complete();
758
759 /*
760 * The SCI is in the "suspended" state now and it cannot produce
761 * new wakeup events till the rearming below, so if any of them
762 * are pending here, they must be resulting from the processing
763 * of EC events above or coming from somewhere else.
764 */
765 if (pm_wakeup_pending()) {
766 pm_pr_dbg("Wakeup after ACPI Notify sync\n");
767 return true;
768 }
769
770 rearm_wake_irq(acpi_sci_irq);
771 }
772
773 return false;
774}
775
776void acpi_s2idle_restore(void)
777{
778 /*
779 * Drain pending events before restoring the working-state configuration
780 * of GPEs.
781 */
782 acpi_os_wait_events_complete(); /* synchronize GPE processing */
783 acpi_ec_flush_work(); /* flush the EC driver's workqueues */
784 acpi_os_wait_events_complete(); /* synchronize Notify handling */
785
786 s2idle_wakeup = false;
787
788 acpi_enable_all_runtime_gpes();
789
790 acpi_disable_wakeup_devices(ACPI_STATE_S0);
791
792 if (acpi_sci_irq_valid()) {
793 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
794 disable_irq_wake(acpi_sci_irq);
795 }
796}
797
798void acpi_s2idle_end(void)
799{
800 acpi_scan_lock_release();
801}
802
803static const struct platform_s2idle_ops acpi_s2idle_ops = {
804 .begin = acpi_s2idle_begin,
805 .prepare = acpi_s2idle_prepare,
806 .wake = acpi_s2idle_wake,
807 .restore = acpi_s2idle_restore,
808 .end = acpi_s2idle_end,
809};
810
811void __weak acpi_s2idle_setup(void)
812{
813 s2idle_set_ops(&acpi_s2idle_ops);
814}
815
816static void acpi_sleep_suspend_setup(void)
817{
818 int i;
819
820 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
821 if (acpi_sleep_state_supported(i))
822 sleep_states[i] = 1;
823
824 suspend_set_ops(old_suspend_ordering ?
825 &acpi_suspend_ops_old : &acpi_suspend_ops);
826
827 acpi_s2idle_setup();
828}
829
830#else /* !CONFIG_SUSPEND */
831#define s2idle_wakeup (false)
832static inline void acpi_sleep_suspend_setup(void) {}
833#endif /* !CONFIG_SUSPEND */
834
835bool acpi_s2idle_wakeup(void)
836{
837 return s2idle_wakeup;
838}
839
840#ifdef CONFIG_PM_SLEEP
841static u32 saved_bm_rld;
842
843static int acpi_save_bm_rld(void)
844{
845 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
846 return 0;
847}
848
849static void acpi_restore_bm_rld(void)
850{
851 u32 resumed_bm_rld = 0;
852
853 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
854 if (resumed_bm_rld == saved_bm_rld)
855 return;
856
857 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
858}
859
860static struct syscore_ops acpi_sleep_syscore_ops = {
861 .suspend = acpi_save_bm_rld,
862 .resume = acpi_restore_bm_rld,
863};
864
865static void acpi_sleep_syscore_init(void)
866{
867 register_syscore_ops(&acpi_sleep_syscore_ops);
868}
869#else
870static inline void acpi_sleep_syscore_init(void) {}
871#endif /* CONFIG_PM_SLEEP */
872
873#ifdef CONFIG_HIBERNATION
874static unsigned long s4_hardware_signature;
875static struct acpi_table_facs *facs;
876static bool nosigcheck;
877
878void __init acpi_no_s4_hw_signature(void)
879{
880 nosigcheck = true;
881}
882
883static int acpi_hibernation_begin(pm_message_t stage)
884{
885 if (!nvs_nosave) {
886 int error = suspend_nvs_alloc();
887 if (error)
888 return error;
889 }
890
891 if (stage.event == PM_EVENT_HIBERNATE)
892 pm_set_suspend_via_firmware();
893
894 acpi_pm_start(ACPI_STATE_S4);
895 return 0;
896}
897
898static int acpi_hibernation_enter(void)
899{
900 acpi_status status = AE_OK;
901
902 ACPI_FLUSH_CPU_CACHE();
903
904 /* This shouldn't return. If it returns, we have a problem */
905 status = acpi_enter_sleep_state(ACPI_STATE_S4);
906 /* Reprogram control registers */
907 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
908
909 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
910}
911
912static void acpi_hibernation_leave(void)
913{
914 pm_set_resume_via_firmware();
915 /*
916 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
917 * enable it here.
918 */
919 acpi_enable();
920 /* Reprogram control registers */
921 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
922 /* Check the hardware signature */
923 if (facs && s4_hardware_signature != facs->hardware_signature)
924 pr_crit("Hardware changed while hibernated, success doubtful!\n");
925 /* Restore the NVS memory area */
926 suspend_nvs_restore();
927 /* Allow EC transactions to happen. */
928 acpi_ec_unblock_transactions();
929}
930
931static void acpi_pm_thaw(void)
932{
933 acpi_ec_unblock_transactions();
934 acpi_enable_all_runtime_gpes();
935}
936
937static const struct platform_hibernation_ops acpi_hibernation_ops = {
938 .begin = acpi_hibernation_begin,
939 .end = acpi_pm_end,
940 .pre_snapshot = acpi_pm_prepare,
941 .finish = acpi_pm_finish,
942 .prepare = acpi_pm_prepare,
943 .enter = acpi_hibernation_enter,
944 .leave = acpi_hibernation_leave,
945 .pre_restore = acpi_pm_freeze,
946 .restore_cleanup = acpi_pm_thaw,
947};
948
949/**
950 * acpi_hibernation_begin_old - Set the target system sleep state to
951 * ACPI_STATE_S4 and execute the _PTS control method. This
952 * function is used if the pre-ACPI 2.0 suspend ordering has been
953 * requested.
954 */
955static int acpi_hibernation_begin_old(pm_message_t stage)
956{
957 int error;
958 /*
959 * The _TTS object should always be evaluated before the _PTS object.
960 * When the old_suspended_ordering is true, the _PTS object is
961 * evaluated in the acpi_sleep_prepare.
962 */
963 acpi_sleep_tts_switch(ACPI_STATE_S4);
964
965 error = acpi_sleep_prepare(ACPI_STATE_S4);
966 if (error)
967 return error;
968
969 if (!nvs_nosave) {
970 error = suspend_nvs_alloc();
971 if (error)
972 return error;
973 }
974
975 if (stage.event == PM_EVENT_HIBERNATE)
976 pm_set_suspend_via_firmware();
977
978 acpi_target_sleep_state = ACPI_STATE_S4;
979 acpi_scan_lock_acquire();
980 return 0;
981}
982
983/*
984 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
985 * been requested.
986 */
987static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
988 .begin = acpi_hibernation_begin_old,
989 .end = acpi_pm_end,
990 .pre_snapshot = acpi_pm_pre_suspend,
991 .prepare = acpi_pm_freeze,
992 .finish = acpi_pm_finish,
993 .enter = acpi_hibernation_enter,
994 .leave = acpi_hibernation_leave,
995 .pre_restore = acpi_pm_freeze,
996 .restore_cleanup = acpi_pm_thaw,
997 .recover = acpi_pm_finish,
998};
999
1000static void acpi_sleep_hibernate_setup(void)
1001{
1002 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1003 return;
1004
1005 hibernation_set_ops(old_suspend_ordering ?
1006 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1007 sleep_states[ACPI_STATE_S4] = 1;
1008 if (nosigcheck)
1009 return;
1010
1011 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1012 if (facs)
1013 s4_hardware_signature = facs->hardware_signature;
1014}
1015#else /* !CONFIG_HIBERNATION */
1016static inline void acpi_sleep_hibernate_setup(void) {}
1017#endif /* !CONFIG_HIBERNATION */
1018
1019static void acpi_power_off_prepare(void)
1020{
1021 /* Prepare to power off the system */
1022 acpi_sleep_prepare(ACPI_STATE_S5);
1023 acpi_disable_all_gpes();
1024 acpi_os_wait_events_complete();
1025}
1026
1027static void acpi_power_off(void)
1028{
1029 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1030 pr_debug("%s called\n", __func__);
1031 local_irq_disable();
1032 acpi_enter_sleep_state(ACPI_STATE_S5);
1033}
1034
1035int __init acpi_sleep_init(void)
1036{
1037 char supported[ACPI_S_STATE_COUNT * 3 + 1];
1038 char *pos = supported;
1039 int i;
1040
1041 acpi_sleep_dmi_check();
1042
1043 sleep_states[ACPI_STATE_S0] = 1;
1044
1045 acpi_sleep_syscore_init();
1046 acpi_sleep_suspend_setup();
1047 acpi_sleep_hibernate_setup();
1048
1049 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1050 sleep_states[ACPI_STATE_S5] = 1;
1051 pm_power_off_prepare = acpi_power_off_prepare;
1052 pm_power_off = acpi_power_off;
1053 } else {
1054 acpi_no_s5 = true;
1055 }
1056
1057 supported[0] = 0;
1058 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1059 if (sleep_states[i])
1060 pos += sprintf(pos, " S%d", i);
1061 }
1062 pr_info("(supports%s)\n", supported);
1063
1064 /*
1065 * Register the tts_notifier to reboot notifier list so that the _TTS
1066 * object can also be evaluated when the system enters S5.
1067 */
1068 register_reboot_notifier(&tts_notifier);
1069 return 0;
1070}