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 * The ACPI specification wants us to save NVS memory regions during hibernation
107 * but says nothing about saving NVS during S3. Not all versions of Windows
108 * save NVS on S3 suspend either, and it is clear that not all systems need
109 * NVS to be saved at S3 time. To improve suspend/resume time, allow the
110 * user to disable saving NVS on S3 if their system does not require it, but
111 * continue to save/restore NVS for S4 as specified.
113 static bool nvs_nosave_s3;
115 void __init acpi_nvs_nosave_s3(void)
117 nvs_nosave_s3 = true;
121 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
122 * user to request that behavior by using the 'acpi_old_suspend_ordering'
123 * kernel command line option that causes the following variable to be set.
125 static bool old_suspend_ordering;
127 void __init acpi_old_suspend_ordering(void)
129 old_suspend_ordering = true;
132 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
134 acpi_old_suspend_ordering();
138 static int __init init_nvs_nosave(const struct dmi_system_id *d)
144 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
146 .callback = init_old_suspend_ordering,
147 .ident = "Abit KN9 (nForce4 variant)",
149 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
150 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
154 .callback = init_old_suspend_ordering,
155 .ident = "HP xw4600 Workstation",
157 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
158 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
162 .callback = init_old_suspend_ordering,
163 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
165 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
166 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
170 .callback = init_old_suspend_ordering,
171 .ident = "Panasonic CF51-2L",
173 DMI_MATCH(DMI_BOARD_VENDOR,
174 "Matsushita Electric Industrial Co.,Ltd."),
175 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
179 .callback = init_nvs_nosave,
180 .ident = "Sony Vaio VGN-FW21E",
182 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
183 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
187 .callback = init_nvs_nosave,
188 .ident = "Sony Vaio VPCEB17FX",
190 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
191 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
195 .callback = init_nvs_nosave,
196 .ident = "Sony Vaio VGN-SR11M",
198 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
199 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
203 .callback = init_nvs_nosave,
204 .ident = "Everex StepNote Series",
206 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
207 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
211 .callback = init_nvs_nosave,
212 .ident = "Sony Vaio VPCEB1Z1E",
214 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
215 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
219 .callback = init_nvs_nosave,
220 .ident = "Sony Vaio VGN-NW130D",
222 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
223 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
227 .callback = init_nvs_nosave,
228 .ident = "Sony Vaio VPCCW29FX",
230 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
231 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
235 .callback = init_nvs_nosave,
236 .ident = "Averatec AV1020-ED2",
238 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
239 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
243 .callback = init_old_suspend_ordering,
244 .ident = "Asus A8N-SLI DELUXE",
246 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
247 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
251 .callback = init_old_suspend_ordering,
252 .ident = "Asus A8N-SLI Premium",
254 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
255 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
259 .callback = init_nvs_nosave,
260 .ident = "Sony Vaio VGN-SR26GN_P",
262 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
263 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
267 .callback = init_nvs_nosave,
268 .ident = "Sony Vaio VPCEB1S1E",
270 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
271 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
275 .callback = init_nvs_nosave,
276 .ident = "Sony Vaio VGN-FW520F",
278 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
279 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
283 .callback = init_nvs_nosave,
284 .ident = "Asus K54C",
286 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
287 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
291 .callback = init_nvs_nosave,
292 .ident = "Asus K54HR",
294 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
295 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
301 static void acpi_sleep_dmi_check(void)
303 dmi_check_system(acpisleep_dmi_table);
307 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
309 static int acpi_pm_freeze(void)
311 acpi_disable_all_gpes();
312 acpi_os_wait_events_complete();
313 acpi_ec_block_transactions();
318 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
320 static int acpi_pm_pre_suspend(void)
323 return suspend_nvs_save();
327 * __acpi_pm_prepare - Prepare the platform to enter the target state.
329 * If necessary, set the firmware waking vector and do arch-specific
330 * nastiness to get the wakeup code to the waking vector.
332 static int __acpi_pm_prepare(void)
334 int error = acpi_sleep_prepare(acpi_target_sleep_state);
336 acpi_target_sleep_state = ACPI_STATE_S0;
342 * acpi_pm_prepare - Prepare the platform to enter the target sleep
343 * state and disable the GPEs.
345 static int acpi_pm_prepare(void)
347 int error = __acpi_pm_prepare();
349 error = acpi_pm_pre_suspend();
354 static int find_powerf_dev(struct device *dev, void *data)
356 struct acpi_device *device = to_acpi_device(dev);
357 const char *hid = acpi_device_hid(device);
359 return !strcmp(hid, ACPI_BUTTON_HID_POWERF);
363 * acpi_pm_finish - Instruct the platform to leave a sleep state.
365 * This is called after we wake back up (or if entering the sleep state
368 static void acpi_pm_finish(void)
370 struct device *pwr_btn_dev;
371 u32 acpi_state = acpi_target_sleep_state;
373 acpi_ec_unblock_transactions();
376 if (acpi_state == ACPI_STATE_S0)
379 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
381 acpi_disable_wakeup_devices(acpi_state);
382 acpi_leave_sleep_state(acpi_state);
384 /* reset firmware waking vector */
385 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
387 acpi_target_sleep_state = ACPI_STATE_S0;
389 acpi_resume_power_resources();
391 /* If we were woken with the fixed power button, provide a small
392 * hint to userspace in the form of a wakeup event on the fixed power
393 * button device (if it can be found).
395 * We delay the event generation til now, as the PM layer requires
396 * timekeeping to be running before we generate events. */
397 if (!pwr_btn_event_pending)
400 pwr_btn_event_pending = false;
401 pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL,
404 pm_wakeup_event(pwr_btn_dev, 0);
405 put_device(pwr_btn_dev);
410 * acpi_pm_end - Finish up suspend sequence.
412 static void acpi_pm_end(void)
415 * This is necessary in case acpi_pm_finish() is not called during a
416 * failing transition to a sleep state.
418 acpi_target_sleep_state = ACPI_STATE_S0;
419 acpi_sleep_tts_switch(acpi_target_sleep_state);
421 #else /* !CONFIG_ACPI_SLEEP */
422 #define acpi_target_sleep_state ACPI_STATE_S0
423 static inline void acpi_sleep_dmi_check(void) {}
424 #endif /* CONFIG_ACPI_SLEEP */
426 #ifdef CONFIG_SUSPEND
427 static u32 acpi_suspend_states[] = {
428 [PM_SUSPEND_ON] = ACPI_STATE_S0,
429 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
430 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
431 [PM_SUSPEND_MAX] = ACPI_STATE_S5
435 * acpi_suspend_begin - Set the target system sleep state to the state
436 * associated with given @pm_state, if supported.
438 static int acpi_suspend_begin(suspend_state_t pm_state)
440 u32 acpi_state = acpi_suspend_states[pm_state];
443 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
447 if (sleep_states[acpi_state]) {
448 acpi_target_sleep_state = acpi_state;
449 acpi_sleep_tts_switch(acpi_target_sleep_state);
451 printk(KERN_ERR "ACPI does not support this state: %d\n",
459 * acpi_suspend_enter - Actually enter a sleep state.
462 * Flush caches and go to sleep. For STR we have to call arch-specific
463 * assembly, which in turn call acpi_enter_sleep_state().
464 * It's unfortunate, but it works. Please fix if you're feeling frisky.
466 static int acpi_suspend_enter(suspend_state_t pm_state)
468 acpi_status status = AE_OK;
469 u32 acpi_state = acpi_target_sleep_state;
472 ACPI_FLUSH_CPU_CACHE();
474 switch (acpi_state) {
477 status = acpi_enter_sleep_state(acpi_state);
481 error = acpi_suspend_lowlevel();
484 pr_info(PREFIX "Low-level resume complete\n");
488 /* This violates the spec but is required for bug compatibility. */
489 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
491 /* Reprogram control registers */
492 acpi_leave_sleep_state_prep(acpi_state);
494 /* ACPI 3.0 specs (P62) says that it's the responsibility
495 * of the OSPM to clear the status bit [ implying that the
496 * POWER_BUTTON event should not reach userspace ]
498 * However, we do generate a small hint for userspace in the form of
499 * a wakeup event. We flag this condition for now and generate the
500 * event later, as we're currently too early in resume to be able to
501 * generate wakeup events.
503 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
504 acpi_event_status pwr_btn_status;
506 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
508 if (pwr_btn_status & ACPI_EVENT_FLAG_SET) {
509 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
511 pwr_btn_event_pending = true;
516 * Disable and clear GPE status before interrupt is enabled. Some GPEs
517 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
518 * acpi_leave_sleep_state will reenable specific GPEs later
520 acpi_disable_all_gpes();
521 /* Allow EC transactions to happen. */
522 acpi_ec_unblock_transactions_early();
524 suspend_nvs_restore();
526 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
529 static int acpi_suspend_state_valid(suspend_state_t pm_state)
535 case PM_SUSPEND_STANDBY:
537 acpi_state = acpi_suspend_states[pm_state];
539 return sleep_states[acpi_state];
545 static const struct platform_suspend_ops acpi_suspend_ops = {
546 .valid = acpi_suspend_state_valid,
547 .begin = acpi_suspend_begin,
548 .prepare_late = acpi_pm_prepare,
549 .enter = acpi_suspend_enter,
550 .wake = acpi_pm_finish,
555 * acpi_suspend_begin_old - Set the target system sleep state to the
556 * state associated with given @pm_state, if supported, and
557 * execute the _PTS control method. This function is used if the
558 * pre-ACPI 2.0 suspend ordering has been requested.
560 static int acpi_suspend_begin_old(suspend_state_t pm_state)
562 int error = acpi_suspend_begin(pm_state);
564 error = __acpi_pm_prepare();
570 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
573 static const struct platform_suspend_ops acpi_suspend_ops_old = {
574 .valid = acpi_suspend_state_valid,
575 .begin = acpi_suspend_begin_old,
576 .prepare_late = acpi_pm_pre_suspend,
577 .enter = acpi_suspend_enter,
578 .wake = acpi_pm_finish,
580 .recover = acpi_pm_finish,
583 static void acpi_sleep_suspend_setup(void)
587 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
591 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
592 if (ACPI_SUCCESS(status)) {
598 suspend_set_ops(old_suspend_ordering ?
599 &acpi_suspend_ops_old : &acpi_suspend_ops);
601 #else /* !CONFIG_SUSPEND */
602 static inline void acpi_sleep_suspend_setup(void) {}
603 #endif /* !CONFIG_SUSPEND */
605 #ifdef CONFIG_HIBERNATION
606 static unsigned long s4_hardware_signature;
607 static struct acpi_table_facs *facs;
608 static bool nosigcheck;
610 void __init acpi_no_s4_hw_signature(void)
615 static int acpi_hibernation_begin(void)
619 error = nvs_nosave ? 0 : suspend_nvs_alloc();
621 acpi_target_sleep_state = ACPI_STATE_S4;
622 acpi_sleep_tts_switch(acpi_target_sleep_state);
628 static int acpi_hibernation_enter(void)
630 acpi_status status = AE_OK;
632 ACPI_FLUSH_CPU_CACHE();
634 /* This shouldn't return. If it returns, we have a problem */
635 status = acpi_enter_sleep_state(ACPI_STATE_S4);
636 /* Reprogram control registers */
637 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
639 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
642 static void acpi_hibernation_leave(void)
645 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
649 /* Reprogram control registers */
650 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
651 /* Check the hardware signature */
652 if (facs && s4_hardware_signature != facs->hardware_signature) {
653 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
655 panic("ACPI S4 hardware signature mismatch");
657 /* Restore the NVS memory area */
658 suspend_nvs_restore();
659 /* Allow EC transactions to happen. */
660 acpi_ec_unblock_transactions_early();
663 static void acpi_pm_thaw(void)
665 acpi_ec_unblock_transactions();
666 acpi_enable_all_runtime_gpes();
669 static const struct platform_hibernation_ops acpi_hibernation_ops = {
670 .begin = acpi_hibernation_begin,
672 .pre_snapshot = acpi_pm_prepare,
673 .finish = acpi_pm_finish,
674 .prepare = acpi_pm_prepare,
675 .enter = acpi_hibernation_enter,
676 .leave = acpi_hibernation_leave,
677 .pre_restore = acpi_pm_freeze,
678 .restore_cleanup = acpi_pm_thaw,
682 * acpi_hibernation_begin_old - Set the target system sleep state to
683 * ACPI_STATE_S4 and execute the _PTS control method. This
684 * function is used if the pre-ACPI 2.0 suspend ordering has been
687 static int acpi_hibernation_begin_old(void)
691 * The _TTS object should always be evaluated before the _PTS object.
692 * When the old_suspended_ordering is true, the _PTS object is
693 * evaluated in the acpi_sleep_prepare.
695 acpi_sleep_tts_switch(ACPI_STATE_S4);
697 error = acpi_sleep_prepare(ACPI_STATE_S4);
701 error = suspend_nvs_alloc();
703 acpi_target_sleep_state = ACPI_STATE_S4;
709 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
712 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
713 .begin = acpi_hibernation_begin_old,
715 .pre_snapshot = acpi_pm_pre_suspend,
716 .prepare = acpi_pm_freeze,
717 .finish = acpi_pm_finish,
718 .enter = acpi_hibernation_enter,
719 .leave = acpi_hibernation_leave,
720 .pre_restore = acpi_pm_freeze,
721 .restore_cleanup = acpi_pm_thaw,
722 .recover = acpi_pm_finish,
725 static void acpi_sleep_hibernate_setup(void)
730 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
731 if (ACPI_FAILURE(status))
734 hibernation_set_ops(old_suspend_ordering ?
735 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
736 sleep_states[ACPI_STATE_S4] = 1;
737 pr_cont(KERN_CONT " S4");
741 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
743 s4_hardware_signature = facs->hardware_signature;
745 #else /* !CONFIG_HIBERNATION */
746 static inline void acpi_sleep_hibernate_setup(void) {}
747 #endif /* !CONFIG_HIBERNATION */
749 int acpi_suspend(u32 acpi_state)
751 suspend_state_t states[] = {
752 [1] = PM_SUSPEND_STANDBY,
753 [3] = PM_SUSPEND_MEM,
757 if (acpi_state < 6 && states[acpi_state])
758 return pm_suspend(states[acpi_state]);
764 static void acpi_power_off_prepare(void)
766 /* Prepare to power off the system */
767 acpi_sleep_prepare(ACPI_STATE_S5);
768 acpi_disable_all_gpes();
771 static void acpi_power_off(void)
773 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
774 printk(KERN_DEBUG "%s called\n", __func__);
776 acpi_enter_sleep_state(ACPI_STATE_S5);
779 int __init acpi_sleep_init(void)
787 acpi_sleep_dmi_check();
789 sleep_states[ACPI_STATE_S0] = 1;
790 pr_info(PREFIX "(supports S0");
792 acpi_sleep_suspend_setup();
793 acpi_sleep_hibernate_setup();
795 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
796 if (ACPI_SUCCESS(status)) {
797 sleep_states[ACPI_STATE_S5] = 1;
799 pm_power_off_prepare = acpi_power_off_prepare;
800 pm_power_off = acpi_power_off;
804 * Register the tts_notifier to reboot notifier list so that the _TTS
805 * object can also be evaluated when the system enters S5.
807 register_reboot_notifier(&tts_notifier);