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 static bool acpi_sleep_state_supported(u8 sleep_state)
86 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
87 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
88 || (acpi_gbl_FADT.sleep_control.address
89 && acpi_gbl_FADT.sleep_status.address));
92 #ifdef CONFIG_ACPI_SLEEP
93 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
95 u32 acpi_target_system_state(void)
97 return acpi_target_sleep_state;
100 static bool pwr_btn_event_pending;
103 * The ACPI specification wants us to save NVS memory regions during hibernation
104 * and to restore them during the subsequent resume. Windows does that also for
105 * suspend to RAM. However, it is known that this mechanism does not work on
106 * all machines, so we allow the user to disable it with the help of the
107 * 'acpi_sleep=nonvs' kernel command line option.
109 static bool nvs_nosave;
111 void __init acpi_nvs_nosave(void)
117 * The ACPI specification wants us to save NVS memory regions during hibernation
118 * but says nothing about saving NVS during S3. Not all versions of Windows
119 * save NVS on S3 suspend either, and it is clear that not all systems need
120 * NVS to be saved at S3 time. To improve suspend/resume time, allow the
121 * user to disable saving NVS on S3 if their system does not require it, but
122 * continue to save/restore NVS for S4 as specified.
124 static bool nvs_nosave_s3;
126 void __init acpi_nvs_nosave_s3(void)
128 nvs_nosave_s3 = true;
132 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
133 * user to request that behavior by using the 'acpi_old_suspend_ordering'
134 * kernel command line option that causes the following variable to be set.
136 static bool old_suspend_ordering;
138 void __init acpi_old_suspend_ordering(void)
140 old_suspend_ordering = true;
143 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
145 acpi_old_suspend_ordering();
149 static int __init init_nvs_nosave(const struct dmi_system_id *d)
155 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
157 .callback = init_old_suspend_ordering,
158 .ident = "Abit KN9 (nForce4 variant)",
160 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
161 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
165 .callback = init_old_suspend_ordering,
166 .ident = "HP xw4600 Workstation",
168 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
169 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
173 .callback = init_old_suspend_ordering,
174 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
176 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
177 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
181 .callback = init_old_suspend_ordering,
182 .ident = "Panasonic CF51-2L",
184 DMI_MATCH(DMI_BOARD_VENDOR,
185 "Matsushita Electric Industrial Co.,Ltd."),
186 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
190 .callback = init_nvs_nosave,
191 .ident = "Sony Vaio VGN-FW41E_H",
193 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
194 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
198 .callback = init_nvs_nosave,
199 .ident = "Sony Vaio VGN-FW21E",
201 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
202 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
206 .callback = init_nvs_nosave,
207 .ident = "Sony Vaio VGN-FW21M",
209 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
210 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
214 .callback = init_nvs_nosave,
215 .ident = "Sony Vaio VPCEB17FX",
217 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
218 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
222 .callback = init_nvs_nosave,
223 .ident = "Sony Vaio VGN-SR11M",
225 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
226 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
230 .callback = init_nvs_nosave,
231 .ident = "Everex StepNote Series",
233 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
234 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
238 .callback = init_nvs_nosave,
239 .ident = "Sony Vaio VPCEB1Z1E",
241 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
242 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
246 .callback = init_nvs_nosave,
247 .ident = "Sony Vaio VGN-NW130D",
249 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
250 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
254 .callback = init_nvs_nosave,
255 .ident = "Sony Vaio VPCCW29FX",
257 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
258 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
262 .callback = init_nvs_nosave,
263 .ident = "Averatec AV1020-ED2",
265 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
266 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
270 .callback = init_old_suspend_ordering,
271 .ident = "Asus A8N-SLI DELUXE",
273 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
274 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
278 .callback = init_old_suspend_ordering,
279 .ident = "Asus A8N-SLI Premium",
281 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
282 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
286 .callback = init_nvs_nosave,
287 .ident = "Sony Vaio VGN-SR26GN_P",
289 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
290 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
294 .callback = init_nvs_nosave,
295 .ident = "Sony Vaio VPCEB1S1E",
297 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
298 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
302 .callback = init_nvs_nosave,
303 .ident = "Sony Vaio VGN-FW520F",
305 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
306 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
310 .callback = init_nvs_nosave,
311 .ident = "Asus K54C",
313 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
314 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
318 .callback = init_nvs_nosave,
319 .ident = "Asus K54HR",
321 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
322 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
328 static void acpi_sleep_dmi_check(void)
330 dmi_check_system(acpisleep_dmi_table);
334 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
336 static int acpi_pm_freeze(void)
338 acpi_disable_all_gpes();
339 acpi_os_wait_events_complete();
340 acpi_ec_block_transactions();
345 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
347 static int acpi_pm_pre_suspend(void)
350 return suspend_nvs_save();
354 * __acpi_pm_prepare - Prepare the platform to enter the target state.
356 * If necessary, set the firmware waking vector and do arch-specific
357 * nastiness to get the wakeup code to the waking vector.
359 static int __acpi_pm_prepare(void)
361 int error = acpi_sleep_prepare(acpi_target_sleep_state);
363 acpi_target_sleep_state = ACPI_STATE_S0;
369 * acpi_pm_prepare - Prepare the platform to enter the target sleep
370 * state and disable the GPEs.
372 static int acpi_pm_prepare(void)
374 int error = __acpi_pm_prepare();
376 error = acpi_pm_pre_suspend();
381 static int find_powerf_dev(struct device *dev, void *data)
383 struct acpi_device *device = to_acpi_device(dev);
384 const char *hid = acpi_device_hid(device);
386 return !strcmp(hid, ACPI_BUTTON_HID_POWERF);
390 * acpi_pm_finish - Instruct the platform to leave a sleep state.
392 * This is called after we wake back up (or if entering the sleep state
395 static void acpi_pm_finish(void)
397 struct device *pwr_btn_dev;
398 u32 acpi_state = acpi_target_sleep_state;
400 acpi_ec_unblock_transactions();
403 if (acpi_state == ACPI_STATE_S0)
406 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
408 acpi_disable_wakeup_devices(acpi_state);
409 acpi_leave_sleep_state(acpi_state);
411 /* reset firmware waking vector */
412 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
414 acpi_target_sleep_state = ACPI_STATE_S0;
416 acpi_resume_power_resources();
418 /* If we were woken with the fixed power button, provide a small
419 * hint to userspace in the form of a wakeup event on the fixed power
420 * button device (if it can be found).
422 * We delay the event generation til now, as the PM layer requires
423 * timekeeping to be running before we generate events. */
424 if (!pwr_btn_event_pending)
427 pwr_btn_event_pending = false;
428 pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL,
431 pm_wakeup_event(pwr_btn_dev, 0);
432 put_device(pwr_btn_dev);
437 * acpi_pm_end - Finish up suspend sequence.
439 static void acpi_pm_end(void)
442 * This is necessary in case acpi_pm_finish() is not called during a
443 * failing transition to a sleep state.
445 acpi_target_sleep_state = ACPI_STATE_S0;
446 acpi_sleep_tts_switch(acpi_target_sleep_state);
448 #else /* !CONFIG_ACPI_SLEEP */
449 #define acpi_target_sleep_state ACPI_STATE_S0
450 static inline void acpi_sleep_dmi_check(void) {}
451 #endif /* CONFIG_ACPI_SLEEP */
453 #ifdef CONFIG_SUSPEND
454 static u32 acpi_suspend_states[] = {
455 [PM_SUSPEND_ON] = ACPI_STATE_S0,
456 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
457 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
458 [PM_SUSPEND_MAX] = ACPI_STATE_S5
462 * acpi_suspend_begin - Set the target system sleep state to the state
463 * associated with given @pm_state, if supported.
465 static int acpi_suspend_begin(suspend_state_t pm_state)
467 u32 acpi_state = acpi_suspend_states[pm_state];
470 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
474 if (sleep_states[acpi_state]) {
475 acpi_target_sleep_state = acpi_state;
476 acpi_sleep_tts_switch(acpi_target_sleep_state);
478 printk(KERN_ERR "ACPI does not support this state: %d\n",
486 * acpi_suspend_enter - Actually enter a sleep state.
489 * Flush caches and go to sleep. For STR we have to call arch-specific
490 * assembly, which in turn call acpi_enter_sleep_state().
491 * It's unfortunate, but it works. Please fix if you're feeling frisky.
493 static int acpi_suspend_enter(suspend_state_t pm_state)
495 acpi_status status = AE_OK;
496 u32 acpi_state = acpi_target_sleep_state;
499 ACPI_FLUSH_CPU_CACHE();
501 switch (acpi_state) {
504 status = acpi_enter_sleep_state(acpi_state);
508 error = acpi_suspend_lowlevel();
511 pr_info(PREFIX "Low-level resume complete\n");
515 /* This violates the spec but is required for bug compatibility. */
516 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
518 /* Reprogram control registers */
519 acpi_leave_sleep_state_prep(acpi_state);
521 /* ACPI 3.0 specs (P62) says that it's the responsibility
522 * of the OSPM to clear the status bit [ implying that the
523 * POWER_BUTTON event should not reach userspace ]
525 * However, we do generate a small hint for userspace in the form of
526 * a wakeup event. We flag this condition for now and generate the
527 * event later, as we're currently too early in resume to be able to
528 * generate wakeup events.
530 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
531 acpi_event_status pwr_btn_status;
533 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
535 if (pwr_btn_status & ACPI_EVENT_FLAG_SET) {
536 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
538 pwr_btn_event_pending = true;
543 * Disable and clear GPE status before interrupt is enabled. Some GPEs
544 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
545 * acpi_leave_sleep_state will reenable specific GPEs later
547 acpi_disable_all_gpes();
548 /* Allow EC transactions to happen. */
549 acpi_ec_unblock_transactions_early();
551 suspend_nvs_restore();
553 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
556 static int acpi_suspend_state_valid(suspend_state_t pm_state)
562 case PM_SUSPEND_STANDBY:
564 acpi_state = acpi_suspend_states[pm_state];
566 return sleep_states[acpi_state];
572 static const struct platform_suspend_ops acpi_suspend_ops = {
573 .valid = acpi_suspend_state_valid,
574 .begin = acpi_suspend_begin,
575 .prepare_late = acpi_pm_prepare,
576 .enter = acpi_suspend_enter,
577 .wake = acpi_pm_finish,
582 * acpi_suspend_begin_old - Set the target system sleep state to the
583 * state associated with given @pm_state, if supported, and
584 * execute the _PTS control method. This function is used if the
585 * pre-ACPI 2.0 suspend ordering has been requested.
587 static int acpi_suspend_begin_old(suspend_state_t pm_state)
589 int error = acpi_suspend_begin(pm_state);
591 error = __acpi_pm_prepare();
597 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
600 static const struct platform_suspend_ops acpi_suspend_ops_old = {
601 .valid = acpi_suspend_state_valid,
602 .begin = acpi_suspend_begin_old,
603 .prepare_late = acpi_pm_pre_suspend,
604 .enter = acpi_suspend_enter,
605 .wake = acpi_pm_finish,
607 .recover = acpi_pm_finish,
610 static void acpi_sleep_suspend_setup(void)
614 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
615 if (acpi_sleep_state_supported(i))
618 suspend_set_ops(old_suspend_ordering ?
619 &acpi_suspend_ops_old : &acpi_suspend_ops);
621 #else /* !CONFIG_SUSPEND */
622 static inline void acpi_sleep_suspend_setup(void) {}
623 #endif /* !CONFIG_SUSPEND */
625 #ifdef CONFIG_HIBERNATION
626 static unsigned long s4_hardware_signature;
627 static struct acpi_table_facs *facs;
628 static bool nosigcheck;
630 void __init acpi_no_s4_hw_signature(void)
635 static int acpi_hibernation_begin(void)
639 error = nvs_nosave ? 0 : suspend_nvs_alloc();
641 acpi_target_sleep_state = ACPI_STATE_S4;
642 acpi_sleep_tts_switch(acpi_target_sleep_state);
648 static int acpi_hibernation_enter(void)
650 acpi_status status = AE_OK;
652 ACPI_FLUSH_CPU_CACHE();
654 /* This shouldn't return. If it returns, we have a problem */
655 status = acpi_enter_sleep_state(ACPI_STATE_S4);
656 /* Reprogram control registers */
657 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
659 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
662 static void acpi_hibernation_leave(void)
665 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
669 /* Reprogram control registers */
670 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
671 /* Check the hardware signature */
672 if (facs && s4_hardware_signature != facs->hardware_signature) {
673 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
675 panic("ACPI S4 hardware signature mismatch");
677 /* Restore the NVS memory area */
678 suspend_nvs_restore();
679 /* Allow EC transactions to happen. */
680 acpi_ec_unblock_transactions_early();
683 static void acpi_pm_thaw(void)
685 acpi_ec_unblock_transactions();
686 acpi_enable_all_runtime_gpes();
689 static const struct platform_hibernation_ops acpi_hibernation_ops = {
690 .begin = acpi_hibernation_begin,
692 .pre_snapshot = acpi_pm_prepare,
693 .finish = acpi_pm_finish,
694 .prepare = acpi_pm_prepare,
695 .enter = acpi_hibernation_enter,
696 .leave = acpi_hibernation_leave,
697 .pre_restore = acpi_pm_freeze,
698 .restore_cleanup = acpi_pm_thaw,
702 * acpi_hibernation_begin_old - Set the target system sleep state to
703 * ACPI_STATE_S4 and execute the _PTS control method. This
704 * function is used if the pre-ACPI 2.0 suspend ordering has been
707 static int acpi_hibernation_begin_old(void)
711 * The _TTS object should always be evaluated before the _PTS object.
712 * When the old_suspended_ordering is true, the _PTS object is
713 * evaluated in the acpi_sleep_prepare.
715 acpi_sleep_tts_switch(ACPI_STATE_S4);
717 error = acpi_sleep_prepare(ACPI_STATE_S4);
721 error = suspend_nvs_alloc();
723 acpi_target_sleep_state = ACPI_STATE_S4;
729 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
732 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
733 .begin = acpi_hibernation_begin_old,
735 .pre_snapshot = acpi_pm_pre_suspend,
736 .prepare = acpi_pm_freeze,
737 .finish = acpi_pm_finish,
738 .enter = acpi_hibernation_enter,
739 .leave = acpi_hibernation_leave,
740 .pre_restore = acpi_pm_freeze,
741 .restore_cleanup = acpi_pm_thaw,
742 .recover = acpi_pm_finish,
745 static void acpi_sleep_hibernate_setup(void)
747 if (!acpi_sleep_state_supported(ACPI_STATE_S4))
750 hibernation_set_ops(old_suspend_ordering ?
751 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
752 sleep_states[ACPI_STATE_S4] = 1;
756 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
758 s4_hardware_signature = facs->hardware_signature;
760 #else /* !CONFIG_HIBERNATION */
761 static inline void acpi_sleep_hibernate_setup(void) {}
762 #endif /* !CONFIG_HIBERNATION */
764 int acpi_suspend(u32 acpi_state)
766 suspend_state_t states[] = {
767 [1] = PM_SUSPEND_STANDBY,
768 [3] = PM_SUSPEND_MEM,
772 if (acpi_state < 6 && states[acpi_state])
773 return pm_suspend(states[acpi_state]);
779 static void acpi_power_off_prepare(void)
781 /* Prepare to power off the system */
782 acpi_sleep_prepare(ACPI_STATE_S5);
783 acpi_disable_all_gpes();
786 static void acpi_power_off(void)
788 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
789 printk(KERN_DEBUG "%s called\n", __func__);
791 acpi_enter_sleep_state(ACPI_STATE_S5);
794 int __init acpi_sleep_init(void)
796 char supported[ACPI_S_STATE_COUNT * 3 + 1];
797 char *pos = supported;
803 acpi_sleep_dmi_check();
805 sleep_states[ACPI_STATE_S0] = 1;
807 acpi_sleep_suspend_setup();
808 acpi_sleep_hibernate_setup();
810 if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
811 sleep_states[ACPI_STATE_S5] = 1;
812 pm_power_off_prepare = acpi_power_off_prepare;
813 pm_power_off = acpi_power_off;
817 for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
819 pos += sprintf(pos, " S%d", i);
821 pr_info(PREFIX "(supports%s)\n", supported);
824 * Register the tts_notifier to reboot notifier list so that the _TTS
825 * object can also be evaluated when the system enters S5.
827 register_reboot_notifier(&tts_notifier);