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>
19 #include <linux/acpi.h>
20 #include <linux/module.h>
24 #include <acpi/acpi_bus.h>
25 #include <acpi/acpi_drivers.h>
30 static u8 sleep_states[ACPI_S_STATE_COUNT];
32 static void acpi_sleep_tts_switch(u32 acpi_state)
34 union acpi_object in_arg = { ACPI_TYPE_INTEGER };
35 struct acpi_object_list arg_list = { 1, &in_arg };
36 acpi_status status = AE_OK;
38 in_arg.integer.value = acpi_state;
39 status = acpi_evaluate_object(NULL, "\\_TTS", &arg_list, NULL);
40 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
42 * OS can't evaluate the _TTS object correctly. Some warning
43 * message will be printed. But it won't break anything.
45 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
49 static int tts_notify_reboot(struct notifier_block *this,
50 unsigned long code, void *x)
52 acpi_sleep_tts_switch(ACPI_STATE_S5);
56 static struct notifier_block tts_notifier = {
57 .notifier_call = tts_notify_reboot,
62 static int acpi_sleep_prepare(u32 acpi_state)
64 #ifdef CONFIG_ACPI_SLEEP
65 /* do we have a wakeup address for S2 and S3? */
66 if (acpi_state == ACPI_STATE_S3) {
67 if (!acpi_wakeup_address)
69 acpi_set_firmware_waking_vector(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;
84 u32 acpi_target_system_state(void)
86 return acpi_target_sleep_state;
89 static bool pwr_btn_event_pending;
92 * The ACPI specification wants us to save NVS memory regions during hibernation
93 * and to restore them during the subsequent resume. Windows does that also for
94 * suspend to RAM. However, it is known that this mechanism does not work on
95 * all machines, so we allow the user to disable it with the help of the
96 * 'acpi_sleep=nonvs' kernel command line option.
98 static bool nvs_nosave;
100 void __init acpi_nvs_nosave(void)
106 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
107 * user to request that behavior by using the 'acpi_old_suspend_ordering'
108 * kernel command line option that causes the following variable to be set.
110 static bool old_suspend_ordering;
112 void __init acpi_old_suspend_ordering(void)
114 old_suspend_ordering = true;
118 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
120 static int acpi_pm_freeze(void)
122 acpi_disable_all_gpes();
123 acpi_os_wait_events_complete();
124 acpi_ec_block_transactions();
129 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
131 static int acpi_pm_pre_suspend(void)
134 return suspend_nvs_save();
138 * __acpi_pm_prepare - Prepare the platform to enter the target state.
140 * If necessary, set the firmware waking vector and do arch-specific
141 * nastiness to get the wakeup code to the waking vector.
143 static int __acpi_pm_prepare(void)
145 int error = acpi_sleep_prepare(acpi_target_sleep_state);
147 acpi_target_sleep_state = ACPI_STATE_S0;
153 * acpi_pm_prepare - Prepare the platform to enter the target sleep
154 * state and disable the GPEs.
156 static int acpi_pm_prepare(void)
158 int error = __acpi_pm_prepare();
160 error = acpi_pm_pre_suspend();
165 static int find_powerf_dev(struct device *dev, void *data)
167 struct acpi_device *device = to_acpi_device(dev);
168 const char *hid = acpi_device_hid(device);
170 return !strcmp(hid, ACPI_BUTTON_HID_POWERF);
174 * acpi_pm_finish - Instruct the platform to leave a sleep state.
176 * This is called after we wake back up (or if entering the sleep state
179 static void acpi_pm_finish(void)
181 struct device *pwr_btn_dev;
182 u32 acpi_state = acpi_target_sleep_state;
184 acpi_ec_unblock_transactions();
187 if (acpi_state == ACPI_STATE_S0)
190 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
192 acpi_disable_wakeup_devices(acpi_state);
193 acpi_leave_sleep_state(acpi_state);
195 /* reset firmware waking vector */
196 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
198 acpi_target_sleep_state = ACPI_STATE_S0;
200 /* If we were woken with the fixed power button, provide a small
201 * hint to userspace in the form of a wakeup event on the fixed power
202 * button device (if it can be found).
204 * We delay the event generation til now, as the PM layer requires
205 * timekeeping to be running before we generate events. */
206 if (!pwr_btn_event_pending)
209 pwr_btn_event_pending = false;
210 pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL,
213 pm_wakeup_event(pwr_btn_dev, 0);
214 put_device(pwr_btn_dev);
219 * acpi_pm_end - Finish up suspend sequence.
221 static void acpi_pm_end(void)
224 * This is necessary in case acpi_pm_finish() is not called during a
225 * failing transition to a sleep state.
227 acpi_target_sleep_state = ACPI_STATE_S0;
228 acpi_sleep_tts_switch(acpi_target_sleep_state);
230 #else /* !CONFIG_ACPI_SLEEP */
231 #define acpi_target_sleep_state ACPI_STATE_S0
232 #endif /* CONFIG_ACPI_SLEEP */
234 #ifdef CONFIG_SUSPEND
235 static u32 acpi_suspend_states[] = {
236 [PM_SUSPEND_ON] = ACPI_STATE_S0,
237 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
238 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
239 [PM_SUSPEND_MAX] = ACPI_STATE_S5
243 * acpi_suspend_begin - Set the target system sleep state to the state
244 * associated with given @pm_state, if supported.
246 static int acpi_suspend_begin(suspend_state_t pm_state)
248 u32 acpi_state = acpi_suspend_states[pm_state];
251 error = nvs_nosave ? 0 : suspend_nvs_alloc();
255 if (sleep_states[acpi_state]) {
256 acpi_target_sleep_state = acpi_state;
257 acpi_sleep_tts_switch(acpi_target_sleep_state);
259 printk(KERN_ERR "ACPI does not support this state: %d\n",
267 * acpi_suspend_enter - Actually enter a sleep state.
270 * Flush caches and go to sleep. For STR we have to call arch-specific
271 * assembly, which in turn call acpi_enter_sleep_state().
272 * It's unfortunate, but it works. Please fix if you're feeling frisky.
274 static int acpi_suspend_enter(suspend_state_t pm_state)
276 acpi_status status = AE_OK;
277 u32 acpi_state = acpi_target_sleep_state;
280 ACPI_FLUSH_CPU_CACHE();
282 switch (acpi_state) {
285 status = acpi_enter_sleep_state(acpi_state);
289 error = acpi_suspend_lowlevel();
292 pr_info(PREFIX "Low-level resume complete\n");
296 /* This violates the spec but is required for bug compatibility. */
297 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
299 /* Reprogram control registers */
300 acpi_leave_sleep_state_prep(acpi_state);
302 /* ACPI 3.0 specs (P62) says that it's the responsibility
303 * of the OSPM to clear the status bit [ implying that the
304 * POWER_BUTTON event should not reach userspace ]
306 * However, we do generate a small hint for userspace in the form of
307 * a wakeup event. We flag this condition for now and generate the
308 * event later, as we're currently too early in resume to be able to
309 * generate wakeup events.
311 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
312 acpi_event_status pwr_btn_status;
314 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
316 if (pwr_btn_status & ACPI_EVENT_FLAG_SET) {
317 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
319 pwr_btn_event_pending = true;
324 * Disable and clear GPE status before interrupt is enabled. Some GPEs
325 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
326 * acpi_leave_sleep_state will reenable specific GPEs later
328 acpi_disable_all_gpes();
329 /* Allow EC transactions to happen. */
330 acpi_ec_unblock_transactions_early();
332 suspend_nvs_restore();
334 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
337 static int acpi_suspend_state_valid(suspend_state_t pm_state)
343 case PM_SUSPEND_STANDBY:
345 acpi_state = acpi_suspend_states[pm_state];
347 return sleep_states[acpi_state];
353 static const struct platform_suspend_ops acpi_suspend_ops = {
354 .valid = acpi_suspend_state_valid,
355 .begin = acpi_suspend_begin,
356 .prepare_late = acpi_pm_prepare,
357 .enter = acpi_suspend_enter,
358 .wake = acpi_pm_finish,
363 * acpi_suspend_begin_old - Set the target system sleep state to the
364 * state associated with given @pm_state, if supported, and
365 * execute the _PTS control method. This function is used if the
366 * pre-ACPI 2.0 suspend ordering has been requested.
368 static int acpi_suspend_begin_old(suspend_state_t pm_state)
370 int error = acpi_suspend_begin(pm_state);
372 error = __acpi_pm_prepare();
378 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
381 static const struct platform_suspend_ops acpi_suspend_ops_old = {
382 .valid = acpi_suspend_state_valid,
383 .begin = acpi_suspend_begin_old,
384 .prepare_late = acpi_pm_pre_suspend,
385 .enter = acpi_suspend_enter,
386 .wake = acpi_pm_finish,
388 .recover = acpi_pm_finish,
391 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
393 old_suspend_ordering = true;
397 static int __init init_nvs_nosave(const struct dmi_system_id *d)
403 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
405 .callback = init_old_suspend_ordering,
406 .ident = "Abit KN9 (nForce4 variant)",
408 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
409 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
413 .callback = init_old_suspend_ordering,
414 .ident = "HP xw4600 Workstation",
416 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
417 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
421 .callback = init_old_suspend_ordering,
422 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
424 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
425 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
429 .callback = init_old_suspend_ordering,
430 .ident = "Panasonic CF51-2L",
432 DMI_MATCH(DMI_BOARD_VENDOR,
433 "Matsushita Electric Industrial Co.,Ltd."),
434 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
438 .callback = init_nvs_nosave,
439 .ident = "Sony Vaio VGN-FW21E",
441 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
442 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
446 .callback = init_nvs_nosave,
447 .ident = "Sony Vaio VPCEB17FX",
449 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
450 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
454 .callback = init_nvs_nosave,
455 .ident = "Sony Vaio VGN-SR11M",
457 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
458 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
462 .callback = init_nvs_nosave,
463 .ident = "Everex StepNote Series",
465 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
466 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
470 .callback = init_nvs_nosave,
471 .ident = "Sony Vaio VPCEB1Z1E",
473 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
474 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
478 .callback = init_nvs_nosave,
479 .ident = "Sony Vaio VGN-NW130D",
481 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
482 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
486 .callback = init_nvs_nosave,
487 .ident = "Sony Vaio VPCCW29FX",
489 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
490 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
494 .callback = init_nvs_nosave,
495 .ident = "Averatec AV1020-ED2",
497 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
498 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
502 .callback = init_old_suspend_ordering,
503 .ident = "Asus A8N-SLI DELUXE",
505 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
506 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
510 .callback = init_old_suspend_ordering,
511 .ident = "Asus A8N-SLI Premium",
513 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
514 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
518 .callback = init_nvs_nosave,
519 .ident = "Sony Vaio VGN-SR26GN_P",
521 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
522 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
526 .callback = init_nvs_nosave,
527 .ident = "Sony Vaio VGN-FW520F",
529 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
530 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
534 .callback = init_nvs_nosave,
535 .ident = "Asus K54C",
537 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
538 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
542 .callback = init_nvs_nosave,
543 .ident = "Asus K54HR",
545 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
546 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
551 #endif /* CONFIG_SUSPEND */
553 #ifdef CONFIG_HIBERNATION
554 static unsigned long s4_hardware_signature;
555 static struct acpi_table_facs *facs;
556 static bool nosigcheck;
558 void __init acpi_no_s4_hw_signature(void)
563 static int acpi_hibernation_begin(void)
567 error = nvs_nosave ? 0 : suspend_nvs_alloc();
569 acpi_target_sleep_state = ACPI_STATE_S4;
570 acpi_sleep_tts_switch(acpi_target_sleep_state);
576 static int acpi_hibernation_enter(void)
578 acpi_status status = AE_OK;
580 ACPI_FLUSH_CPU_CACHE();
582 /* This shouldn't return. If it returns, we have a problem */
583 status = acpi_enter_sleep_state(ACPI_STATE_S4);
584 /* Reprogram control registers */
585 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
587 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
590 static void acpi_hibernation_leave(void)
593 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
597 /* Reprogram control registers */
598 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
599 /* Check the hardware signature */
600 if (facs && s4_hardware_signature != facs->hardware_signature) {
601 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
603 panic("ACPI S4 hardware signature mismatch");
605 /* Restore the NVS memory area */
606 suspend_nvs_restore();
607 /* Allow EC transactions to happen. */
608 acpi_ec_unblock_transactions_early();
611 static void acpi_pm_thaw(void)
613 acpi_ec_unblock_transactions();
614 acpi_enable_all_runtime_gpes();
617 static const struct platform_hibernation_ops acpi_hibernation_ops = {
618 .begin = acpi_hibernation_begin,
620 .pre_snapshot = acpi_pm_prepare,
621 .finish = acpi_pm_finish,
622 .prepare = acpi_pm_prepare,
623 .enter = acpi_hibernation_enter,
624 .leave = acpi_hibernation_leave,
625 .pre_restore = acpi_pm_freeze,
626 .restore_cleanup = acpi_pm_thaw,
630 * acpi_hibernation_begin_old - Set the target system sleep state to
631 * ACPI_STATE_S4 and execute the _PTS control method. This
632 * function is used if the pre-ACPI 2.0 suspend ordering has been
635 static int acpi_hibernation_begin_old(void)
639 * The _TTS object should always be evaluated before the _PTS object.
640 * When the old_suspended_ordering is true, the _PTS object is
641 * evaluated in the acpi_sleep_prepare.
643 acpi_sleep_tts_switch(ACPI_STATE_S4);
645 error = acpi_sleep_prepare(ACPI_STATE_S4);
649 error = suspend_nvs_alloc();
651 acpi_target_sleep_state = ACPI_STATE_S4;
657 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
660 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
661 .begin = acpi_hibernation_begin_old,
663 .pre_snapshot = acpi_pm_pre_suspend,
664 .prepare = acpi_pm_freeze,
665 .finish = acpi_pm_finish,
666 .enter = acpi_hibernation_enter,
667 .leave = acpi_hibernation_leave,
668 .pre_restore = acpi_pm_freeze,
669 .restore_cleanup = acpi_pm_thaw,
670 .recover = acpi_pm_finish,
672 #endif /* CONFIG_HIBERNATION */
674 int acpi_suspend(u32 acpi_state)
676 suspend_state_t states[] = {
677 [1] = PM_SUSPEND_STANDBY,
678 [3] = PM_SUSPEND_MEM,
682 if (acpi_state < 6 && states[acpi_state])
683 return pm_suspend(states[acpi_state]);
689 static void acpi_power_off_prepare(void)
691 /* Prepare to power off the system */
692 acpi_sleep_prepare(ACPI_STATE_S5);
693 acpi_disable_all_gpes();
696 static void acpi_power_off(void)
698 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
699 printk(KERN_DEBUG "%s called\n", __func__);
701 acpi_enter_sleep_state(ACPI_STATE_S5);
704 int __init acpi_sleep_init(void)
708 #ifdef CONFIG_SUSPEND
711 dmi_check_system(acpisleep_dmi_table);
717 sleep_states[ACPI_STATE_S0] = 1;
718 printk(KERN_INFO PREFIX "(supports S0");
720 #ifdef CONFIG_SUSPEND
721 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
722 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
723 if (ACPI_SUCCESS(status)) {
725 printk(KERN_CONT " S%d", i);
729 suspend_set_ops(old_suspend_ordering ?
730 &acpi_suspend_ops_old : &acpi_suspend_ops);
733 #ifdef CONFIG_HIBERNATION
734 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
735 if (ACPI_SUCCESS(status)) {
736 hibernation_set_ops(old_suspend_ordering ?
737 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
738 sleep_states[ACPI_STATE_S4] = 1;
739 printk(KERN_CONT " S4");
741 acpi_get_table(ACPI_SIG_FACS, 1,
742 (struct acpi_table_header **)&facs);
744 s4_hardware_signature =
745 facs->hardware_signature;
749 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
750 if (ACPI_SUCCESS(status)) {
751 sleep_states[ACPI_STATE_S5] = 1;
752 printk(KERN_CONT " S5");
753 pm_power_off_prepare = acpi_power_off_prepare;
754 pm_power_off = acpi_power_off;
756 printk(KERN_CONT ")\n");
758 * Register the tts_notifier to reboot notifier list so that the _TTS
759 * object can also be evaluated when the system enters S5.
761 register_reboot_notifier(&tts_notifier);