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