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