2 * sleep.c - ACPI sleep support.
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
9 * This file is released under the GPLv2.
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>
22 #include <acpi/acpi_bus.h>
23 #include <acpi/acpi_drivers.h>
28 static u8 sleep_states[ACPI_S_STATE_COUNT];
30 static void acpi_sleep_tts_switch(u32 acpi_state)
32 union acpi_object in_arg = { ACPI_TYPE_INTEGER };
33 struct acpi_object_list arg_list = { 1, &in_arg };
34 acpi_status status = AE_OK;
36 in_arg.integer.value = acpi_state;
37 status = acpi_evaluate_object(NULL, "\\_TTS", &arg_list, NULL);
38 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
40 * OS can't evaluate the _TTS object correctly. Some warning
41 * message will be printed. But it won't break anything.
43 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
47 static int tts_notify_reboot(struct notifier_block *this,
48 unsigned long code, void *x)
50 acpi_sleep_tts_switch(ACPI_STATE_S5);
54 static struct notifier_block tts_notifier = {
55 .notifier_call = tts_notify_reboot,
60 static int acpi_sleep_prepare(u32 acpi_state)
62 #ifdef CONFIG_ACPI_SLEEP
63 /* do we have a wakeup address for S2 and S3? */
64 if (acpi_state == ACPI_STATE_S3) {
65 if (!acpi_wakeup_address) {
68 acpi_set_firmware_waking_vector(
69 (acpi_physical_address)acpi_wakeup_address);
72 ACPI_FLUSH_CPU_CACHE();
74 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
76 acpi_enable_wakeup_devices(acpi_state);
77 acpi_enter_sleep_state_prep(acpi_state);
81 #ifdef CONFIG_ACPI_SLEEP
82 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
85 * The ACPI specification wants us to save NVS memory regions during hibernation
86 * and to restore them during the subsequent resume. Windows does that also for
87 * suspend to RAM. However, it is known that this mechanism does not work on
88 * all machines, so we allow the user to disable it with the help of the
89 * 'acpi_sleep=nonvs' kernel command line option.
91 static bool nvs_nosave;
93 void __init acpi_nvs_nosave(void)
99 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
100 * user to request that behavior by using the 'acpi_old_suspend_ordering'
101 * kernel command line option that causes the following variable to be set.
103 static bool old_suspend_ordering;
105 void __init acpi_old_suspend_ordering(void)
107 old_suspend_ordering = true;
111 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
113 static int acpi_pm_freeze(void)
115 acpi_disable_all_gpes();
116 acpi_os_wait_events_complete(NULL);
117 acpi_ec_block_transactions();
122 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
124 static int acpi_pm_pre_suspend(void)
127 return suspend_nvs_save();
131 * __acpi_pm_prepare - Prepare the platform to enter the target state.
133 * If necessary, set the firmware waking vector and do arch-specific
134 * nastiness to get the wakeup code to the waking vector.
136 static int __acpi_pm_prepare(void)
138 int error = acpi_sleep_prepare(acpi_target_sleep_state);
140 acpi_target_sleep_state = ACPI_STATE_S0;
146 * acpi_pm_prepare - Prepare the platform to enter the target sleep
147 * state and disable the GPEs.
149 static int acpi_pm_prepare(void)
151 int error = __acpi_pm_prepare();
153 error = acpi_pm_pre_suspend();
159 * acpi_pm_finish - Instruct the platform to leave a sleep state.
161 * This is called after we wake back up (or if entering the sleep state
164 static void acpi_pm_finish(void)
166 u32 acpi_state = acpi_target_sleep_state;
168 acpi_ec_unblock_transactions();
171 if (acpi_state == ACPI_STATE_S0)
174 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
176 acpi_disable_wakeup_devices(acpi_state);
177 acpi_leave_sleep_state(acpi_state);
179 /* reset firmware waking vector */
180 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
182 acpi_target_sleep_state = ACPI_STATE_S0;
186 * acpi_pm_end - Finish up suspend sequence.
188 static void acpi_pm_end(void)
191 * This is necessary in case acpi_pm_finish() is not called during a
192 * failing transition to a sleep state.
194 acpi_target_sleep_state = ACPI_STATE_S0;
195 acpi_sleep_tts_switch(acpi_target_sleep_state);
197 #else /* !CONFIG_ACPI_SLEEP */
198 #define acpi_target_sleep_state ACPI_STATE_S0
199 #endif /* CONFIG_ACPI_SLEEP */
201 #ifdef CONFIG_SUSPEND
202 static u32 acpi_suspend_states[] = {
203 [PM_SUSPEND_ON] = ACPI_STATE_S0,
204 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
205 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
206 [PM_SUSPEND_MAX] = ACPI_STATE_S5
210 * acpi_suspend_begin - Set the target system sleep state to the state
211 * associated with given @pm_state, if supported.
213 static int acpi_suspend_begin(suspend_state_t pm_state)
215 u32 acpi_state = acpi_suspend_states[pm_state];
218 error = nvs_nosave ? 0 : suspend_nvs_alloc();
222 if (sleep_states[acpi_state]) {
223 acpi_target_sleep_state = acpi_state;
224 acpi_sleep_tts_switch(acpi_target_sleep_state);
226 printk(KERN_ERR "ACPI does not support this state: %d\n",
234 * acpi_suspend_enter - Actually enter a sleep state.
237 * Flush caches and go to sleep. For STR we have to call arch-specific
238 * assembly, which in turn call acpi_enter_sleep_state().
239 * It's unfortunate, but it works. Please fix if you're feeling frisky.
241 static int acpi_suspend_enter(suspend_state_t pm_state)
243 acpi_status status = AE_OK;
244 u32 acpi_state = acpi_target_sleep_state;
247 ACPI_FLUSH_CPU_CACHE();
249 switch (acpi_state) {
252 status = acpi_enter_sleep_state(acpi_state);
256 error = acpi_suspend_lowlevel();
259 pr_info(PREFIX "Low-level resume complete\n");
263 /* This violates the spec but is required for bug compatibility. */
264 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
266 /* Reprogram control registers and execute _BFS */
267 acpi_leave_sleep_state_prep(acpi_state);
269 /* ACPI 3.0 specs (P62) says that it's the responsibility
270 * of the OSPM to clear the status bit [ implying that the
271 * POWER_BUTTON event should not reach userspace ]
273 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
274 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
277 * Disable and clear GPE status before interrupt is enabled. Some GPEs
278 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
279 * acpi_leave_sleep_state will reenable specific GPEs later
281 acpi_disable_all_gpes();
282 /* Allow EC transactions to happen. */
283 acpi_ec_unblock_transactions_early();
285 suspend_nvs_restore();
287 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
290 static int acpi_suspend_state_valid(suspend_state_t pm_state)
296 case PM_SUSPEND_STANDBY:
298 acpi_state = acpi_suspend_states[pm_state];
300 return sleep_states[acpi_state];
306 static const struct platform_suspend_ops acpi_suspend_ops = {
307 .valid = acpi_suspend_state_valid,
308 .begin = acpi_suspend_begin,
309 .prepare_late = acpi_pm_prepare,
310 .enter = acpi_suspend_enter,
311 .wake = acpi_pm_finish,
316 * acpi_suspend_begin_old - Set the target system sleep state to the
317 * state associated with given @pm_state, if supported, and
318 * execute the _PTS control method. This function is used if the
319 * pre-ACPI 2.0 suspend ordering has been requested.
321 static int acpi_suspend_begin_old(suspend_state_t pm_state)
323 int error = acpi_suspend_begin(pm_state);
325 error = __acpi_pm_prepare();
331 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
334 static const struct platform_suspend_ops acpi_suspend_ops_old = {
335 .valid = acpi_suspend_state_valid,
336 .begin = acpi_suspend_begin_old,
337 .prepare_late = acpi_pm_pre_suspend,
338 .enter = acpi_suspend_enter,
339 .wake = acpi_pm_finish,
341 .recover = acpi_pm_finish,
344 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
346 old_suspend_ordering = true;
350 static int __init init_nvs_nosave(const struct dmi_system_id *d)
356 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
358 .callback = init_old_suspend_ordering,
359 .ident = "Abit KN9 (nForce4 variant)",
361 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
362 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
366 .callback = init_old_suspend_ordering,
367 .ident = "HP xw4600 Workstation",
369 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
370 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
374 .callback = init_old_suspend_ordering,
375 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
377 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
378 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
382 .callback = init_old_suspend_ordering,
383 .ident = "Panasonic CF51-2L",
385 DMI_MATCH(DMI_BOARD_VENDOR,
386 "Matsushita Electric Industrial Co.,Ltd."),
387 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
391 .callback = init_nvs_nosave,
392 .ident = "Sony Vaio VGN-SR11M",
394 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
395 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
399 .callback = init_nvs_nosave,
400 .ident = "Everex StepNote Series",
402 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
403 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
407 .callback = init_nvs_nosave,
408 .ident = "Sony Vaio VPCEB1Z1E",
410 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
411 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
415 .callback = init_nvs_nosave,
416 .ident = "Sony Vaio VGN-NW130D",
418 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
419 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
423 .callback = init_nvs_nosave,
424 .ident = "Averatec AV1020-ED2",
426 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
427 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
432 #endif /* CONFIG_SUSPEND */
434 #ifdef CONFIG_HIBERNATION
435 static unsigned long s4_hardware_signature;
436 static struct acpi_table_facs *facs;
437 static bool nosigcheck;
439 void __init acpi_no_s4_hw_signature(void)
444 static int acpi_hibernation_begin(void)
448 error = nvs_nosave ? 0 : suspend_nvs_alloc();
450 acpi_target_sleep_state = ACPI_STATE_S4;
451 acpi_sleep_tts_switch(acpi_target_sleep_state);
457 static int acpi_hibernation_enter(void)
459 acpi_status status = AE_OK;
461 ACPI_FLUSH_CPU_CACHE();
463 /* This shouldn't return. If it returns, we have a problem */
464 status = acpi_enter_sleep_state(ACPI_STATE_S4);
465 /* Reprogram control registers and execute _BFS */
466 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
468 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
471 static void acpi_hibernation_leave(void)
474 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
478 /* Reprogram control registers and execute _BFS */
479 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
480 /* Check the hardware signature */
481 if (facs && s4_hardware_signature != facs->hardware_signature) {
482 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
484 panic("ACPI S4 hardware signature mismatch");
486 /* Restore the NVS memory area */
487 suspend_nvs_restore();
488 /* Allow EC transactions to happen. */
489 acpi_ec_unblock_transactions_early();
492 static void acpi_pm_thaw(void)
494 acpi_ec_unblock_transactions();
495 acpi_enable_all_runtime_gpes();
498 static const struct platform_hibernation_ops acpi_hibernation_ops = {
499 .begin = acpi_hibernation_begin,
501 .pre_snapshot = acpi_pm_prepare,
502 .finish = acpi_pm_finish,
503 .prepare = acpi_pm_prepare,
504 .enter = acpi_hibernation_enter,
505 .leave = acpi_hibernation_leave,
506 .pre_restore = acpi_pm_freeze,
507 .restore_cleanup = acpi_pm_thaw,
511 * acpi_hibernation_begin_old - Set the target system sleep state to
512 * ACPI_STATE_S4 and execute the _PTS control method. This
513 * function is used if the pre-ACPI 2.0 suspend ordering has been
516 static int acpi_hibernation_begin_old(void)
520 * The _TTS object should always be evaluated before the _PTS object.
521 * When the old_suspended_ordering is true, the _PTS object is
522 * evaluated in the acpi_sleep_prepare.
524 acpi_sleep_tts_switch(ACPI_STATE_S4);
526 error = acpi_sleep_prepare(ACPI_STATE_S4);
530 error = suspend_nvs_alloc();
532 acpi_target_sleep_state = ACPI_STATE_S4;
538 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
541 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
542 .begin = acpi_hibernation_begin_old,
544 .pre_snapshot = acpi_pm_pre_suspend,
545 .prepare = acpi_pm_freeze,
546 .finish = acpi_pm_finish,
547 .enter = acpi_hibernation_enter,
548 .leave = acpi_hibernation_leave,
549 .pre_restore = acpi_pm_freeze,
550 .restore_cleanup = acpi_pm_thaw,
551 .recover = acpi_pm_finish,
553 #endif /* CONFIG_HIBERNATION */
555 int acpi_suspend(u32 acpi_state)
557 suspend_state_t states[] = {
558 [1] = PM_SUSPEND_STANDBY,
559 [3] = PM_SUSPEND_MEM,
563 if (acpi_state < 6 && states[acpi_state])
564 return pm_suspend(states[acpi_state]);
572 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
573 * in the system sleep state given by %acpi_target_sleep_state
574 * @dev: device to examine; its driver model wakeup flags control
575 * whether it should be able to wake up the system
576 * @d_min_p: used to store the upper limit of allowed states range
577 * Return value: preferred power state of the device on success, -ENODEV on
578 * failure (ie. if there's no 'struct acpi_device' for @dev)
580 * Find the lowest power (highest number) ACPI device power state that
581 * device @dev can be in while the system is in the sleep state represented
582 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
583 * able to wake up the system from this sleep state. If @d_min_p is set,
584 * the highest power (lowest number) device power state of @dev allowed
585 * in this system sleep state is stored at the location pointed to by it.
587 * The caller must ensure that @dev is valid before using this function.
588 * The caller is also responsible for figuring out if the device is
589 * supposed to be able to wake up the system and passing this information
593 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
595 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
596 struct acpi_device *adev;
597 char acpi_method[] = "_SxD";
598 unsigned long long d_min, d_max;
600 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
601 printk(KERN_DEBUG "ACPI handle has no context!\n");
605 acpi_method[2] = '0' + acpi_target_sleep_state;
607 * If the sleep state is S0, we will return D3, but if the device has
608 * _S0W, we will use the value from _S0W
610 d_min = ACPI_STATE_D0;
611 d_max = ACPI_STATE_D3;
614 * If present, _SxD methods return the minimum D-state (highest power
615 * state) we can use for the corresponding S-states. Otherwise, the
616 * minimum D-state is D0 (ACPI 3.x).
618 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
619 * provided -- that's our fault recovery, we ignore retval.
621 if (acpi_target_sleep_state > ACPI_STATE_S0)
622 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
625 * If _PRW says we can wake up the system from the target sleep state,
626 * the D-state returned by _SxD is sufficient for that (we assume a
627 * wakeup-aware driver if wake is set). Still, if _SxW exists
628 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
629 * can wake the system. _S0W may be valid, too.
631 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
632 (device_may_wakeup(dev) &&
633 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
636 acpi_method[3] = 'W';
637 status = acpi_evaluate_integer(handle, acpi_method, NULL,
639 if (ACPI_FAILURE(status)) {
640 if (acpi_target_sleep_state != ACPI_STATE_S0 ||
641 status != AE_NOT_FOUND)
643 } else if (d_max < d_min) {
644 /* Warn the user of the broken DSDT */
645 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
656 #endif /* CONFIG_PM_OPS */
658 #ifdef CONFIG_PM_SLEEP
660 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
661 * capability of given device
662 * @dev: device to handle
663 * @enable: 'true' - enable, 'false' - disable the wake-up capability
665 int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
668 struct acpi_device *adev;
671 if (!device_can_wakeup(dev))
674 handle = DEVICE_ACPI_HANDLE(dev);
675 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
676 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
681 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
682 acpi_disable_wakeup_device_power(adev);
684 dev_info(dev, "wake-up capability %s by ACPI\n",
685 enable ? "enabled" : "disabled");
689 #endif /* CONFIG_PM_SLEEP */
691 static void acpi_power_off_prepare(void)
693 /* Prepare to power off the system */
694 acpi_sleep_prepare(ACPI_STATE_S5);
695 acpi_disable_all_gpes();
698 static void acpi_power_off(void)
700 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
701 printk(KERN_DEBUG "%s called\n", __func__);
703 acpi_enter_sleep_state(ACPI_STATE_S5);
707 * ACPI 2.0 created the optional _GTS and _BFS,
708 * but industry adoption has been neither rapid nor broad.
710 * Linux gets into trouble when it executes poorly validated
711 * paths through the BIOS, so disable _GTS and _BFS by default,
712 * but do speak up and offer the option to enable them.
714 static void __init acpi_gts_bfs_check(void)
718 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
720 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
721 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
722 "please notify linux-acpi@vger.kernel.org\n");
724 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
726 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
727 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
728 "please notify linux-acpi@vger.kernel.org\n");
732 int __init acpi_sleep_init(void)
736 #ifdef CONFIG_SUSPEND
739 dmi_check_system(acpisleep_dmi_table);
745 sleep_states[ACPI_STATE_S0] = 1;
746 printk(KERN_INFO PREFIX "(supports S0");
748 #ifdef CONFIG_SUSPEND
749 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
750 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
751 if (ACPI_SUCCESS(status)) {
757 suspend_set_ops(old_suspend_ordering ?
758 &acpi_suspend_ops_old : &acpi_suspend_ops);
761 #ifdef CONFIG_HIBERNATION
762 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
763 if (ACPI_SUCCESS(status)) {
764 hibernation_set_ops(old_suspend_ordering ?
765 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
766 sleep_states[ACPI_STATE_S4] = 1;
769 acpi_get_table(ACPI_SIG_FACS, 1,
770 (struct acpi_table_header **)&facs);
772 s4_hardware_signature =
773 facs->hardware_signature;
777 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
778 if (ACPI_SUCCESS(status)) {
779 sleep_states[ACPI_STATE_S5] = 1;
781 pm_power_off_prepare = acpi_power_off_prepare;
782 pm_power_off = acpi_power_off;
786 * Register the tts_notifier to reboot notifier list so that the _TTS
787 * object can also be evaluated when the system enters S5.
789 register_reboot_notifier(&tts_notifier);
790 acpi_gts_bfs_check();