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;
133 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
135 static int acpi_pm_freeze(void)
137 acpi_disable_all_gpes();
138 acpi_os_wait_events_complete();
139 acpi_ec_block_transactions();
144 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
146 static int acpi_pm_pre_suspend(void)
149 return suspend_nvs_save();
153 * __acpi_pm_prepare - Prepare the platform to enter the target state.
155 * If necessary, set the firmware waking vector and do arch-specific
156 * nastiness to get the wakeup code to the waking vector.
158 static int __acpi_pm_prepare(void)
160 int error
= acpi_sleep_prepare(acpi_target_sleep_state
);
162 acpi_target_sleep_state
= ACPI_STATE_S0
;
168 * acpi_pm_prepare - Prepare the platform to enter the target sleep
169 * state and disable the GPEs.
171 static int acpi_pm_prepare(void)
173 int error
= __acpi_pm_prepare();
175 error
= acpi_pm_pre_suspend();
180 static int find_powerf_dev(struct device
*dev
, void *data
)
182 struct acpi_device
*device
= to_acpi_device(dev
);
183 const char *hid
= acpi_device_hid(device
);
185 return !strcmp(hid
, ACPI_BUTTON_HID_POWERF
);
189 * acpi_pm_finish - Instruct the platform to leave a sleep state.
191 * This is called after we wake back up (or if entering the sleep state
194 static void acpi_pm_finish(void)
196 struct device
*pwr_btn_dev
;
197 u32 acpi_state
= acpi_target_sleep_state
;
199 acpi_ec_unblock_transactions();
202 if (acpi_state
== ACPI_STATE_S0
)
205 printk(KERN_INFO PREFIX
"Waking up from system sleep state S%d\n",
207 acpi_disable_wakeup_devices(acpi_state
);
208 acpi_leave_sleep_state(acpi_state
);
210 /* reset firmware waking vector */
211 acpi_set_firmware_waking_vector((acpi_physical_address
) 0);
213 acpi_target_sleep_state
= ACPI_STATE_S0
;
215 /* If we were woken with the fixed power button, provide a small
216 * hint to userspace in the form of a wakeup event on the fixed power
217 * button device (if it can be found).
219 * We delay the event generation til now, as the PM layer requires
220 * timekeeping to be running before we generate events. */
221 if (!pwr_btn_event_pending
)
224 pwr_btn_event_pending
= false;
225 pwr_btn_dev
= bus_find_device(&acpi_bus_type
, NULL
, NULL
,
228 pm_wakeup_event(pwr_btn_dev
, 0);
229 put_device(pwr_btn_dev
);
234 * acpi_pm_end - Finish up suspend sequence.
236 static void acpi_pm_end(void)
239 * This is necessary in case acpi_pm_finish() is not called during a
240 * failing transition to a sleep state.
242 acpi_target_sleep_state
= ACPI_STATE_S0
;
243 acpi_sleep_tts_switch(acpi_target_sleep_state
);
245 #else /* !CONFIG_ACPI_SLEEP */
246 #define acpi_target_sleep_state ACPI_STATE_S0
247 #endif /* CONFIG_ACPI_SLEEP */
249 #ifdef CONFIG_SUSPEND
250 static u32 acpi_suspend_states
[] = {
251 [PM_SUSPEND_ON
] = ACPI_STATE_S0
,
252 [PM_SUSPEND_STANDBY
] = ACPI_STATE_S1
,
253 [PM_SUSPEND_MEM
] = ACPI_STATE_S3
,
254 [PM_SUSPEND_MAX
] = ACPI_STATE_S5
258 * acpi_suspend_begin - Set the target system sleep state to the state
259 * associated with given @pm_state, if supported.
261 static int acpi_suspend_begin(suspend_state_t pm_state
)
263 u32 acpi_state
= acpi_suspend_states
[pm_state
];
266 error
= (nvs_nosave
|| nvs_nosave_s3
) ? 0 : suspend_nvs_alloc();
270 if (sleep_states
[acpi_state
]) {
271 acpi_target_sleep_state
= acpi_state
;
272 acpi_sleep_tts_switch(acpi_target_sleep_state
);
274 printk(KERN_ERR
"ACPI does not support this state: %d\n",
282 * acpi_suspend_enter - Actually enter a sleep state.
285 * Flush caches and go to sleep. For STR we have to call arch-specific
286 * assembly, which in turn call acpi_enter_sleep_state().
287 * It's unfortunate, but it works. Please fix if you're feeling frisky.
289 static int acpi_suspend_enter(suspend_state_t pm_state
)
291 acpi_status status
= AE_OK
;
292 u32 acpi_state
= acpi_target_sleep_state
;
295 ACPI_FLUSH_CPU_CACHE();
297 switch (acpi_state
) {
300 status
= acpi_enter_sleep_state(acpi_state
);
304 error
= acpi_suspend_lowlevel();
307 pr_info(PREFIX
"Low-level resume complete\n");
311 /* This violates the spec but is required for bug compatibility. */
312 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE
, 1);
314 /* Reprogram control registers */
315 acpi_leave_sleep_state_prep(acpi_state
);
317 /* ACPI 3.0 specs (P62) says that it's the responsibility
318 * of the OSPM to clear the status bit [ implying that the
319 * POWER_BUTTON event should not reach userspace ]
321 * However, we do generate a small hint for userspace in the form of
322 * a wakeup event. We flag this condition for now and generate the
323 * event later, as we're currently too early in resume to be able to
324 * generate wakeup events.
326 if (ACPI_SUCCESS(status
) && (acpi_state
== ACPI_STATE_S3
)) {
327 acpi_event_status pwr_btn_status
;
329 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON
, &pwr_btn_status
);
331 if (pwr_btn_status
& ACPI_EVENT_FLAG_SET
) {
332 acpi_clear_event(ACPI_EVENT_POWER_BUTTON
);
334 pwr_btn_event_pending
= true;
339 * Disable and clear GPE status before interrupt is enabled. Some GPEs
340 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
341 * acpi_leave_sleep_state will reenable specific GPEs later
343 acpi_disable_all_gpes();
344 /* Allow EC transactions to happen. */
345 acpi_ec_unblock_transactions_early();
347 suspend_nvs_restore();
349 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
352 static int acpi_suspend_state_valid(suspend_state_t pm_state
)
358 case PM_SUSPEND_STANDBY
:
360 acpi_state
= acpi_suspend_states
[pm_state
];
362 return sleep_states
[acpi_state
];
368 static const struct platform_suspend_ops acpi_suspend_ops
= {
369 .valid
= acpi_suspend_state_valid
,
370 .begin
= acpi_suspend_begin
,
371 .prepare_late
= acpi_pm_prepare
,
372 .enter
= acpi_suspend_enter
,
373 .wake
= acpi_pm_finish
,
378 * acpi_suspend_begin_old - Set the target system sleep state to the
379 * state associated with given @pm_state, if supported, and
380 * execute the _PTS control method. This function is used if the
381 * pre-ACPI 2.0 suspend ordering has been requested.
383 static int acpi_suspend_begin_old(suspend_state_t pm_state
)
385 int error
= acpi_suspend_begin(pm_state
);
387 error
= __acpi_pm_prepare();
393 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
396 static const struct platform_suspend_ops acpi_suspend_ops_old
= {
397 .valid
= acpi_suspend_state_valid
,
398 .begin
= acpi_suspend_begin_old
,
399 .prepare_late
= acpi_pm_pre_suspend
,
400 .enter
= acpi_suspend_enter
,
401 .wake
= acpi_pm_finish
,
403 .recover
= acpi_pm_finish
,
406 static int __init
init_old_suspend_ordering(const struct dmi_system_id
*d
)
408 old_suspend_ordering
= true;
412 static int __init
init_nvs_nosave(const struct dmi_system_id
*d
)
418 static struct dmi_system_id __initdata acpisleep_dmi_table
[] = {
420 .callback
= init_old_suspend_ordering
,
421 .ident
= "Abit KN9 (nForce4 variant)",
423 DMI_MATCH(DMI_BOARD_VENDOR
, "http://www.abit.com.tw/"),
424 DMI_MATCH(DMI_BOARD_NAME
, "KN9 Series(NF-CK804)"),
428 .callback
= init_old_suspend_ordering
,
429 .ident
= "HP xw4600 Workstation",
431 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
432 DMI_MATCH(DMI_PRODUCT_NAME
, "HP xw4600 Workstation"),
436 .callback
= init_old_suspend_ordering
,
437 .ident
= "Asus Pundit P1-AH2 (M2N8L motherboard)",
439 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTek Computer INC."),
440 DMI_MATCH(DMI_BOARD_NAME
, "M2N8L"),
444 .callback
= init_old_suspend_ordering
,
445 .ident
= "Panasonic CF51-2L",
447 DMI_MATCH(DMI_BOARD_VENDOR
,
448 "Matsushita Electric Industrial Co.,Ltd."),
449 DMI_MATCH(DMI_BOARD_NAME
, "CF51-2L"),
453 .callback
= init_nvs_nosave
,
454 .ident
= "Sony Vaio VGN-FW21E",
456 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
457 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-FW21E"),
461 .callback
= init_nvs_nosave
,
462 .ident
= "Sony Vaio VPCEB17FX",
464 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
465 DMI_MATCH(DMI_PRODUCT_NAME
, "VPCEB17FX"),
469 .callback
= init_nvs_nosave
,
470 .ident
= "Sony Vaio VGN-SR11M",
472 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
473 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-SR11M"),
477 .callback
= init_nvs_nosave
,
478 .ident
= "Everex StepNote Series",
480 DMI_MATCH(DMI_SYS_VENDOR
, "Everex Systems, Inc."),
481 DMI_MATCH(DMI_PRODUCT_NAME
, "Everex StepNote Series"),
485 .callback
= init_nvs_nosave
,
486 .ident
= "Sony Vaio VPCEB1Z1E",
488 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
489 DMI_MATCH(DMI_PRODUCT_NAME
, "VPCEB1Z1E"),
493 .callback
= init_nvs_nosave
,
494 .ident
= "Sony Vaio VGN-NW130D",
496 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
497 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-NW130D"),
501 .callback
= init_nvs_nosave
,
502 .ident
= "Sony Vaio VPCCW29FX",
504 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
505 DMI_MATCH(DMI_PRODUCT_NAME
, "VPCCW29FX"),
509 .callback
= init_nvs_nosave
,
510 .ident
= "Averatec AV1020-ED2",
512 DMI_MATCH(DMI_SYS_VENDOR
, "AVERATEC"),
513 DMI_MATCH(DMI_PRODUCT_NAME
, "1000 Series"),
517 .callback
= init_old_suspend_ordering
,
518 .ident
= "Asus A8N-SLI DELUXE",
520 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTeK Computer INC."),
521 DMI_MATCH(DMI_BOARD_NAME
, "A8N-SLI DELUXE"),
525 .callback
= init_old_suspend_ordering
,
526 .ident
= "Asus A8N-SLI Premium",
528 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTeK Computer INC."),
529 DMI_MATCH(DMI_BOARD_NAME
, "A8N-SLI Premium"),
533 .callback
= init_nvs_nosave
,
534 .ident
= "Sony Vaio VGN-SR26GN_P",
536 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
537 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-SR26GN_P"),
541 .callback
= init_nvs_nosave
,
542 .ident
= "Sony Vaio VPCEB1S1E",
544 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
545 DMI_MATCH(DMI_PRODUCT_NAME
, "VPCEB1S1E"),
549 .callback
= init_nvs_nosave
,
550 .ident
= "Sony Vaio VGN-FW520F",
552 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
553 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-FW520F"),
557 .callback
= init_nvs_nosave
,
558 .ident
= "Asus K54C",
560 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK Computer Inc."),
561 DMI_MATCH(DMI_PRODUCT_NAME
, "K54C"),
565 .callback
= init_nvs_nosave
,
566 .ident
= "Asus K54HR",
568 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK Computer Inc."),
569 DMI_MATCH(DMI_PRODUCT_NAME
, "K54HR"),
574 #endif /* CONFIG_SUSPEND */
576 #ifdef CONFIG_HIBERNATION
577 static unsigned long s4_hardware_signature
;
578 static struct acpi_table_facs
*facs
;
579 static bool nosigcheck
;
581 void __init
acpi_no_s4_hw_signature(void)
586 static int acpi_hibernation_begin(void)
590 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
592 acpi_target_sleep_state
= ACPI_STATE_S4
;
593 acpi_sleep_tts_switch(acpi_target_sleep_state
);
599 static int acpi_hibernation_enter(void)
601 acpi_status status
= AE_OK
;
603 ACPI_FLUSH_CPU_CACHE();
605 /* This shouldn't return. If it returns, we have a problem */
606 status
= acpi_enter_sleep_state(ACPI_STATE_S4
);
607 /* Reprogram control registers */
608 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
610 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
613 static void acpi_hibernation_leave(void)
616 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
620 /* Reprogram control registers */
621 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
622 /* Check the hardware signature */
623 if (facs
&& s4_hardware_signature
!= facs
->hardware_signature
) {
624 printk(KERN_EMERG
"ACPI: Hardware changed while hibernated, "
626 panic("ACPI S4 hardware signature mismatch");
628 /* Restore the NVS memory area */
629 suspend_nvs_restore();
630 /* Allow EC transactions to happen. */
631 acpi_ec_unblock_transactions_early();
634 static void acpi_pm_thaw(void)
636 acpi_ec_unblock_transactions();
637 acpi_enable_all_runtime_gpes();
640 static const struct platform_hibernation_ops acpi_hibernation_ops
= {
641 .begin
= acpi_hibernation_begin
,
643 .pre_snapshot
= acpi_pm_prepare
,
644 .finish
= acpi_pm_finish
,
645 .prepare
= acpi_pm_prepare
,
646 .enter
= acpi_hibernation_enter
,
647 .leave
= acpi_hibernation_leave
,
648 .pre_restore
= acpi_pm_freeze
,
649 .restore_cleanup
= acpi_pm_thaw
,
653 * acpi_hibernation_begin_old - Set the target system sleep state to
654 * ACPI_STATE_S4 and execute the _PTS control method. This
655 * function is used if the pre-ACPI 2.0 suspend ordering has been
658 static int acpi_hibernation_begin_old(void)
662 * The _TTS object should always be evaluated before the _PTS object.
663 * When the old_suspended_ordering is true, the _PTS object is
664 * evaluated in the acpi_sleep_prepare.
666 acpi_sleep_tts_switch(ACPI_STATE_S4
);
668 error
= acpi_sleep_prepare(ACPI_STATE_S4
);
672 error
= suspend_nvs_alloc();
674 acpi_target_sleep_state
= ACPI_STATE_S4
;
680 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
683 static const struct platform_hibernation_ops acpi_hibernation_ops_old
= {
684 .begin
= acpi_hibernation_begin_old
,
686 .pre_snapshot
= acpi_pm_pre_suspend
,
687 .prepare
= acpi_pm_freeze
,
688 .finish
= acpi_pm_finish
,
689 .enter
= acpi_hibernation_enter
,
690 .leave
= acpi_hibernation_leave
,
691 .pre_restore
= acpi_pm_freeze
,
692 .restore_cleanup
= acpi_pm_thaw
,
693 .recover
= acpi_pm_finish
,
695 #endif /* CONFIG_HIBERNATION */
697 int acpi_suspend(u32 acpi_state
)
699 suspend_state_t states
[] = {
700 [1] = PM_SUSPEND_STANDBY
,
701 [3] = PM_SUSPEND_MEM
,
705 if (acpi_state
< 6 && states
[acpi_state
])
706 return pm_suspend(states
[acpi_state
]);
712 static void acpi_power_off_prepare(void)
714 /* Prepare to power off the system */
715 acpi_sleep_prepare(ACPI_STATE_S5
);
716 acpi_disable_all_gpes();
719 static void acpi_power_off(void)
721 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
722 printk(KERN_DEBUG
"%s called\n", __func__
);
724 acpi_enter_sleep_state(ACPI_STATE_S5
);
727 int __init
acpi_sleep_init(void)
731 #ifdef CONFIG_SUSPEND
734 dmi_check_system(acpisleep_dmi_table
);
740 sleep_states
[ACPI_STATE_S0
] = 1;
741 printk(KERN_INFO PREFIX
"(supports S0");
743 #ifdef CONFIG_SUSPEND
744 for (i
= ACPI_STATE_S1
; i
< ACPI_STATE_S4
; i
++) {
745 status
= acpi_get_sleep_type_data(i
, &type_a
, &type_b
);
746 if (ACPI_SUCCESS(status
)) {
748 printk(KERN_CONT
" S%d", i
);
752 suspend_set_ops(old_suspend_ordering
?
753 &acpi_suspend_ops_old
: &acpi_suspend_ops
);
756 #ifdef CONFIG_HIBERNATION
757 status
= acpi_get_sleep_type_data(ACPI_STATE_S4
, &type_a
, &type_b
);
758 if (ACPI_SUCCESS(status
)) {
759 hibernation_set_ops(old_suspend_ordering
?
760 &acpi_hibernation_ops_old
: &acpi_hibernation_ops
);
761 sleep_states
[ACPI_STATE_S4
] = 1;
762 printk(KERN_CONT
" S4");
764 acpi_get_table(ACPI_SIG_FACS
, 1,
765 (struct acpi_table_header
**)&facs
);
767 s4_hardware_signature
=
768 facs
->hardware_signature
;
772 status
= acpi_get_sleep_type_data(ACPI_STATE_S5
, &type_a
, &type_b
);
773 if (ACPI_SUCCESS(status
)) {
774 sleep_states
[ACPI_STATE_S5
] = 1;
775 printk(KERN_CONT
" S5");
776 pm_power_off_prepare
= acpi_power_off_prepare
;
777 pm_power_off
= acpi_power_off
;
779 printk(KERN_CONT
")\n");
781 * Register the tts_notifier to reboot notifier list so that the _TTS
782 * object can also be evaluated when the system enters S5.
784 register_reboot_notifier(&tts_notifier
);