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