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 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 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
86 * user to request that behavior by using the 'acpi_old_suspend_ordering'
87 * kernel command line option that causes the following variable to be set.
89 static bool old_suspend_ordering;
91 void __init acpi_old_suspend_ordering(void)
93 old_suspend_ordering = true;
97 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
99 static int acpi_pm_freeze(void)
101 acpi_disable_all_gpes();
102 acpi_os_wait_events_complete(NULL);
103 acpi_ec_block_transactions();
108 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
110 static int acpi_pm_pre_suspend(void)
118 * __acpi_pm_prepare - Prepare the platform to enter the target state.
120 * If necessary, set the firmware waking vector and do arch-specific
121 * nastiness to get the wakeup code to the waking vector.
123 static int __acpi_pm_prepare(void)
125 int error = acpi_sleep_prepare(acpi_target_sleep_state);
127 acpi_target_sleep_state = ACPI_STATE_S0;
133 * acpi_pm_prepare - Prepare the platform to enter the target sleep
134 * state and disable the GPEs.
136 static int acpi_pm_prepare(void)
138 int error = __acpi_pm_prepare();
140 acpi_pm_pre_suspend();
146 * acpi_pm_finish - Instruct the platform to leave a sleep state.
148 * This is called after we wake back up (or if entering the sleep state
151 static void acpi_pm_finish(void)
153 u32 acpi_state = acpi_target_sleep_state;
155 acpi_ec_unblock_transactions();
157 if (acpi_state == ACPI_STATE_S0)
160 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
162 acpi_disable_wakeup_devices(acpi_state);
163 acpi_leave_sleep_state(acpi_state);
165 /* reset firmware waking vector */
166 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
168 acpi_target_sleep_state = ACPI_STATE_S0;
172 * acpi_pm_end - Finish up suspend sequence.
174 static void acpi_pm_end(void)
178 * This is necessary in case acpi_pm_finish() is not called during a
179 * failing transition to a sleep state.
181 acpi_target_sleep_state = ACPI_STATE_S0;
182 acpi_sleep_tts_switch(acpi_target_sleep_state);
184 #else /* !CONFIG_ACPI_SLEEP */
185 #define acpi_target_sleep_state ACPI_STATE_S0
186 #endif /* CONFIG_ACPI_SLEEP */
188 #ifdef CONFIG_SUSPEND
189 extern void do_suspend_lowlevel(void);
191 static u32 acpi_suspend_states[] = {
192 [PM_SUSPEND_ON] = ACPI_STATE_S0,
193 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
194 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
195 [PM_SUSPEND_MAX] = ACPI_STATE_S5
199 * acpi_suspend_begin - Set the target system sleep state to the state
200 * associated with given @pm_state, if supported.
202 static int acpi_suspend_begin(suspend_state_t pm_state)
204 u32 acpi_state = acpi_suspend_states[pm_state];
207 error = suspend_nvs_alloc();
212 if (sleep_states[acpi_state]) {
213 acpi_target_sleep_state = acpi_state;
214 acpi_sleep_tts_switch(acpi_target_sleep_state);
216 printk(KERN_ERR "ACPI does not support this state: %d\n",
224 * acpi_suspend_enter - Actually enter a sleep state.
227 * Flush caches and go to sleep. For STR we have to call arch-specific
228 * assembly, which in turn call acpi_enter_sleep_state().
229 * It's unfortunate, but it works. Please fix if you're feeling frisky.
231 static int acpi_suspend_enter(suspend_state_t pm_state)
233 acpi_status status = AE_OK;
234 unsigned long flags = 0;
235 u32 acpi_state = acpi_target_sleep_state;
237 ACPI_FLUSH_CPU_CACHE();
239 /* Do arch specific saving of state. */
240 if (acpi_state == ACPI_STATE_S3) {
241 int error = acpi_save_state_mem();
247 local_irq_save(flags);
248 switch (acpi_state) {
251 status = acpi_enter_sleep_state(acpi_state);
255 do_suspend_lowlevel();
259 /* This violates the spec but is required for bug compatibility. */
260 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
262 /* Reprogram control registers and execute _BFS */
263 acpi_leave_sleep_state_prep(acpi_state);
265 /* ACPI 3.0 specs (P62) says that it's the responsibility
266 * of the OSPM to clear the status bit [ implying that the
267 * POWER_BUTTON event should not reach userspace ]
269 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
270 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
273 * Disable and clear GPE status before interrupt is enabled. Some GPEs
274 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
275 * acpi_leave_sleep_state will reenable specific GPEs later
277 acpi_disable_all_gpes();
278 /* Allow EC transactions to happen. */
279 acpi_ec_unblock_transactions_early();
281 local_irq_restore(flags);
282 printk(KERN_DEBUG "Back to C!\n");
284 /* restore processor state */
285 if (acpi_state == ACPI_STATE_S3)
286 acpi_restore_state_mem();
288 suspend_nvs_restore();
290 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
293 static void acpi_suspend_finish(void)
298 static int acpi_suspend_state_valid(suspend_state_t pm_state)
304 case PM_SUSPEND_STANDBY:
306 acpi_state = acpi_suspend_states[pm_state];
308 return sleep_states[acpi_state];
314 static struct platform_suspend_ops acpi_suspend_ops = {
315 .valid = acpi_suspend_state_valid,
316 .begin = acpi_suspend_begin,
317 .prepare_late = acpi_pm_prepare,
318 .enter = acpi_suspend_enter,
319 .wake = acpi_suspend_finish,
324 * acpi_suspend_begin_old - Set the target system sleep state to the
325 * state associated with given @pm_state, if supported, and
326 * execute the _PTS control method. This function is used if the
327 * pre-ACPI 2.0 suspend ordering has been requested.
329 static int acpi_suspend_begin_old(suspend_state_t pm_state)
331 int error = acpi_suspend_begin(pm_state);
333 error = __acpi_pm_prepare();
339 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
342 static struct platform_suspend_ops acpi_suspend_ops_old = {
343 .valid = acpi_suspend_state_valid,
344 .begin = acpi_suspend_begin_old,
345 .prepare_late = acpi_pm_pre_suspend,
346 .enter = acpi_suspend_enter,
347 .wake = acpi_suspend_finish,
349 .recover = acpi_pm_finish,
352 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
354 old_suspend_ordering = true;
358 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
360 .callback = init_old_suspend_ordering,
361 .ident = "Abit KN9 (nForce4 variant)",
363 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
364 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
368 .callback = init_old_suspend_ordering,
369 .ident = "HP xw4600 Workstation",
371 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
372 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
376 .callback = init_old_suspend_ordering,
377 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
379 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
380 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
384 .callback = init_old_suspend_ordering,
385 .ident = "Panasonic CF51-2L",
387 DMI_MATCH(DMI_BOARD_VENDOR,
388 "Matsushita Electric Industrial Co.,Ltd."),
389 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
394 #endif /* CONFIG_SUSPEND */
396 #ifdef CONFIG_HIBERNATION
398 * The ACPI specification wants us to save NVS memory regions during hibernation
399 * and to restore them during the subsequent resume. However, it is not certain
400 * if this mechanism is going to work on all machines, so we allow the user to
401 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
404 static bool s4_no_nvs;
406 void __init acpi_s4_no_nvs(void)
411 static unsigned long s4_hardware_signature;
412 static struct acpi_table_facs *facs;
413 static bool nosigcheck;
415 void __init acpi_no_s4_hw_signature(void)
420 static int acpi_hibernation_begin(void)
424 error = s4_no_nvs ? 0 : suspend_nvs_alloc();
426 acpi_target_sleep_state = ACPI_STATE_S4;
427 acpi_sleep_tts_switch(acpi_target_sleep_state);
433 static int acpi_hibernation_enter(void)
435 acpi_status status = AE_OK;
436 unsigned long flags = 0;
438 ACPI_FLUSH_CPU_CACHE();
440 local_irq_save(flags);
441 /* This shouldn't return. If it returns, we have a problem */
442 status = acpi_enter_sleep_state(ACPI_STATE_S4);
443 /* Reprogram control registers and execute _BFS */
444 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
445 local_irq_restore(flags);
447 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
450 static void acpi_hibernation_leave(void)
453 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
457 /* Reprogram control registers and execute _BFS */
458 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
459 /* Check the hardware signature */
460 if (facs && s4_hardware_signature != facs->hardware_signature) {
461 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
463 panic("ACPI S4 hardware signature mismatch");
465 /* Restore the NVS memory area */
466 suspend_nvs_restore();
467 /* Allow EC transactions to happen. */
468 acpi_ec_unblock_transactions_early();
471 static void acpi_pm_thaw(void)
473 acpi_ec_unblock_transactions();
474 acpi_enable_all_runtime_gpes();
477 static struct platform_hibernation_ops acpi_hibernation_ops = {
478 .begin = acpi_hibernation_begin,
480 .pre_snapshot = acpi_pm_prepare,
481 .finish = acpi_pm_finish,
482 .prepare = acpi_pm_prepare,
483 .enter = acpi_hibernation_enter,
484 .leave = acpi_hibernation_leave,
485 .pre_restore = acpi_pm_freeze,
486 .restore_cleanup = acpi_pm_thaw,
490 * acpi_hibernation_begin_old - Set the target system sleep state to
491 * ACPI_STATE_S4 and execute the _PTS control method. This
492 * function is used if the pre-ACPI 2.0 suspend ordering has been
495 static int acpi_hibernation_begin_old(void)
499 * The _TTS object should always be evaluated before the _PTS object.
500 * When the old_suspended_ordering is true, the _PTS object is
501 * evaluated in the acpi_sleep_prepare.
503 acpi_sleep_tts_switch(ACPI_STATE_S4);
505 error = acpi_sleep_prepare(ACPI_STATE_S4);
509 error = suspend_nvs_alloc();
511 acpi_target_sleep_state = ACPI_STATE_S4;
517 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
520 static struct platform_hibernation_ops acpi_hibernation_ops_old = {
521 .begin = acpi_hibernation_begin_old,
523 .pre_snapshot = acpi_pm_pre_suspend,
524 .prepare = acpi_pm_freeze,
525 .finish = acpi_pm_finish,
526 .enter = acpi_hibernation_enter,
527 .leave = acpi_hibernation_leave,
528 .pre_restore = acpi_pm_freeze,
529 .restore_cleanup = acpi_pm_thaw,
530 .recover = acpi_pm_finish,
532 #endif /* CONFIG_HIBERNATION */
534 int acpi_suspend(u32 acpi_state)
536 suspend_state_t states[] = {
537 [1] = PM_SUSPEND_STANDBY,
538 [3] = PM_SUSPEND_MEM,
542 if (acpi_state < 6 && states[acpi_state])
543 return pm_suspend(states[acpi_state]);
549 #ifdef CONFIG_PM_SLEEP
551 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
552 * in the system sleep state given by %acpi_target_sleep_state
553 * @dev: device to examine; its driver model wakeup flags control
554 * whether it should be able to wake up the system
555 * @d_min_p: used to store the upper limit of allowed states range
556 * Return value: preferred power state of the device on success, -ENODEV on
557 * failure (ie. if there's no 'struct acpi_device' for @dev)
559 * Find the lowest power (highest number) ACPI device power state that
560 * device @dev can be in while the system is in the sleep state represented
561 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
562 * able to wake up the system from this sleep state. If @d_min_p is set,
563 * the highest power (lowest number) device power state of @dev allowed
564 * in this system sleep state is stored at the location pointed to by it.
566 * The caller must ensure that @dev is valid before using this function.
567 * The caller is also responsible for figuring out if the device is
568 * supposed to be able to wake up the system and passing this information
572 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
574 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
575 struct acpi_device *adev;
576 char acpi_method[] = "_SxD";
577 unsigned long long d_min, d_max;
579 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
580 printk(KERN_DEBUG "ACPI handle has no context!\n");
584 acpi_method[2] = '0' + acpi_target_sleep_state;
586 * If the sleep state is S0, we will return D3, but if the device has
587 * _S0W, we will use the value from _S0W
589 d_min = ACPI_STATE_D0;
590 d_max = ACPI_STATE_D3;
593 * If present, _SxD methods return the minimum D-state (highest power
594 * state) we can use for the corresponding S-states. Otherwise, the
595 * minimum D-state is D0 (ACPI 3.x).
597 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
598 * provided -- that's our fault recovery, we ignore retval.
600 if (acpi_target_sleep_state > ACPI_STATE_S0)
601 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
604 * If _PRW says we can wake up the system from the target sleep state,
605 * the D-state returned by _SxD is sufficient for that (we assume a
606 * wakeup-aware driver if wake is set). Still, if _SxW exists
607 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
608 * can wake the system. _S0W may be valid, too.
610 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
611 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
612 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
615 acpi_method[3] = 'W';
616 status = acpi_evaluate_integer(handle, acpi_method, NULL,
618 if (ACPI_FAILURE(status)) {
620 } else if (d_max < d_min) {
621 /* Warn the user of the broken DSDT */
622 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
635 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
636 * capability of given device
637 * @dev: device to handle
638 * @enable: 'true' - enable, 'false' - disable the wake-up capability
640 int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
643 struct acpi_device *adev;
646 if (!device_can_wakeup(dev))
649 handle = DEVICE_ACPI_HANDLE(dev);
650 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
651 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
656 error = acpi_enable_wakeup_device_power(adev,
657 acpi_target_sleep_state);
659 acpi_enable_gpe(adev->wakeup.gpe_device,
660 adev->wakeup.gpe_number,
663 acpi_disable_gpe(adev->wakeup.gpe_device, adev->wakeup.gpe_number,
665 error = acpi_disable_wakeup_device_power(adev);
668 dev_info(dev, "wake-up capability %s by ACPI\n",
669 enable ? "enabled" : "disabled");
675 static void acpi_power_off_prepare(void)
677 /* Prepare to power off the system */
678 acpi_sleep_prepare(ACPI_STATE_S5);
679 acpi_disable_all_gpes();
682 static void acpi_power_off(void)
684 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
685 printk(KERN_DEBUG "%s called\n", __func__);
687 acpi_enter_sleep_state(ACPI_STATE_S5);
691 * ACPI 2.0 created the optional _GTS and _BFS,
692 * but industry adoption has been neither rapid nor broad.
694 * Linux gets into trouble when it executes poorly validated
695 * paths through the BIOS, so disable _GTS and _BFS by default,
696 * but do speak up and offer the option to enable them.
698 void __init acpi_gts_bfs_check(void)
702 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
704 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
705 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
706 "please notify linux-acpi@vger.kernel.org\n");
708 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
710 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
711 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
712 "please notify linux-acpi@vger.kernel.org\n");
716 int __init acpi_sleep_init(void)
720 #ifdef CONFIG_SUSPEND
723 dmi_check_system(acpisleep_dmi_table);
729 sleep_states[ACPI_STATE_S0] = 1;
730 printk(KERN_INFO PREFIX "(supports S0");
732 #ifdef CONFIG_SUSPEND
733 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
734 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
735 if (ACPI_SUCCESS(status)) {
741 suspend_set_ops(old_suspend_ordering ?
742 &acpi_suspend_ops_old : &acpi_suspend_ops);
745 #ifdef CONFIG_HIBERNATION
746 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
747 if (ACPI_SUCCESS(status)) {
748 hibernation_set_ops(old_suspend_ordering ?
749 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
750 sleep_states[ACPI_STATE_S4] = 1;
753 acpi_get_table(ACPI_SIG_FACS, 1,
754 (struct acpi_table_header **)&facs);
756 s4_hardware_signature =
757 facs->hardware_signature;
761 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
762 if (ACPI_SUCCESS(status)) {
763 sleep_states[ACPI_STATE_S5] = 1;
765 pm_power_off_prepare = acpi_power_off_prepare;
766 pm_power_off = acpi_power_off;
770 * Register the tts_notifier to reboot notifier list so that the _TTS
771 * object can also be evaluated when the system enters S5.
773 register_reboot_notifier(&tts_notifier);
774 acpi_gts_bfs_check();