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