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();
73 acpi_enable_wakeup_device_prep(acpi_state
);
75 printk(KERN_INFO PREFIX
"Preparing to enter system sleep state S%d\n",
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_disable_gpes - Disable the GPEs.
99 static int acpi_pm_disable_gpes(void)
101 acpi_disable_all_gpes();
106 * __acpi_pm_prepare - Prepare the platform to enter the target state.
108 * If necessary, set the firmware waking vector and do arch-specific
109 * nastiness to get the wakeup code to the waking vector.
111 static int __acpi_pm_prepare(void)
113 int error
= acpi_sleep_prepare(acpi_target_sleep_state
);
116 acpi_target_sleep_state
= ACPI_STATE_S0
;
121 * acpi_pm_prepare - Prepare the platform to enter the target sleep
122 * state and disable the GPEs.
124 static int acpi_pm_prepare(void)
126 int error
= __acpi_pm_prepare();
129 acpi_disable_all_gpes();
134 * acpi_pm_finish - Instruct the platform to leave a sleep state.
136 * This is called after we wake back up (or if entering the sleep state
139 static void acpi_pm_finish(void)
141 u32 acpi_state
= acpi_target_sleep_state
;
143 if (acpi_state
== ACPI_STATE_S0
)
146 printk(KERN_INFO PREFIX
"Waking up from system sleep state S%d\n",
148 acpi_disable_wakeup_device(acpi_state
);
149 acpi_leave_sleep_state(acpi_state
);
151 /* reset firmware waking vector */
152 acpi_set_firmware_waking_vector((acpi_physical_address
) 0);
154 acpi_target_sleep_state
= ACPI_STATE_S0
;
158 * acpi_pm_end - Finish up suspend sequence.
160 static void acpi_pm_end(void)
163 * This is necessary in case acpi_pm_finish() is not called during a
164 * failing transition to a sleep state.
166 acpi_target_sleep_state
= ACPI_STATE_S0
;
167 acpi_sleep_tts_switch(acpi_target_sleep_state
);
169 #else /* !CONFIG_ACPI_SLEEP */
170 #define acpi_target_sleep_state ACPI_STATE_S0
171 #endif /* CONFIG_ACPI_SLEEP */
173 #ifdef CONFIG_SUSPEND
174 extern void do_suspend_lowlevel(void);
176 static u32 acpi_suspend_states
[] = {
177 [PM_SUSPEND_ON
] = ACPI_STATE_S0
,
178 [PM_SUSPEND_STANDBY
] = ACPI_STATE_S1
,
179 [PM_SUSPEND_MEM
] = ACPI_STATE_S3
,
180 [PM_SUSPEND_MAX
] = ACPI_STATE_S5
184 * acpi_suspend_begin - Set the target system sleep state to the state
185 * associated with given @pm_state, if supported.
187 static int acpi_suspend_begin(suspend_state_t pm_state
)
189 u32 acpi_state
= acpi_suspend_states
[pm_state
];
192 if (sleep_states
[acpi_state
]) {
193 acpi_target_sleep_state
= acpi_state
;
194 acpi_sleep_tts_switch(acpi_target_sleep_state
);
196 printk(KERN_ERR
"ACPI does not support this state: %d\n",
204 * acpi_suspend_enter - Actually enter a sleep state.
207 * Flush caches and go to sleep. For STR we have to call arch-specific
208 * assembly, which in turn call acpi_enter_sleep_state().
209 * It's unfortunate, but it works. Please fix if you're feeling frisky.
211 static int acpi_suspend_enter(suspend_state_t pm_state
)
213 acpi_status status
= AE_OK
;
214 unsigned long flags
= 0;
215 u32 acpi_state
= acpi_target_sleep_state
;
217 ACPI_FLUSH_CPU_CACHE();
219 /* Do arch specific saving of state. */
220 if (acpi_state
== ACPI_STATE_S3
) {
221 int error
= acpi_save_state_mem();
227 local_irq_save(flags
);
228 acpi_enable_wakeup_device(acpi_state
);
229 switch (acpi_state
) {
232 status
= acpi_enter_sleep_state(acpi_state
);
236 do_suspend_lowlevel();
240 /* This violates the spec but is required for bug compatibility. */
241 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE
, 1);
243 /* Reprogram control registers and execute _BFS */
244 acpi_leave_sleep_state_prep(acpi_state
);
246 /* ACPI 3.0 specs (P62) says that it's the responsibility
247 * of the OSPM to clear the status bit [ implying that the
248 * POWER_BUTTON event should not reach userspace ]
250 if (ACPI_SUCCESS(status
) && (acpi_state
== ACPI_STATE_S3
))
251 acpi_clear_event(ACPI_EVENT_POWER_BUTTON
);
254 * Disable and clear GPE status before interrupt is enabled. Some GPEs
255 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
256 * acpi_leave_sleep_state will reenable specific GPEs later
258 acpi_disable_all_gpes();
260 local_irq_restore(flags
);
261 printk(KERN_DEBUG
"Back to C!\n");
263 /* restore processor state */
264 if (acpi_state
== ACPI_STATE_S3
)
265 acpi_restore_state_mem();
267 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
270 static int acpi_suspend_state_valid(suspend_state_t pm_state
)
276 case PM_SUSPEND_STANDBY
:
278 acpi_state
= acpi_suspend_states
[pm_state
];
280 return sleep_states
[acpi_state
];
286 static struct platform_suspend_ops acpi_suspend_ops
= {
287 .valid
= acpi_suspend_state_valid
,
288 .begin
= acpi_suspend_begin
,
289 .prepare_late
= acpi_pm_prepare
,
290 .enter
= acpi_suspend_enter
,
291 .wake
= acpi_pm_finish
,
296 * acpi_suspend_begin_old - Set the target system sleep state to the
297 * state associated with given @pm_state, if supported, and
298 * execute the _PTS control method. This function is used if the
299 * pre-ACPI 2.0 suspend ordering has been requested.
301 static int acpi_suspend_begin_old(suspend_state_t pm_state
)
303 int error
= acpi_suspend_begin(pm_state
);
306 error
= __acpi_pm_prepare();
311 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
314 static struct platform_suspend_ops acpi_suspend_ops_old
= {
315 .valid
= acpi_suspend_state_valid
,
316 .begin
= acpi_suspend_begin_old
,
317 .prepare_late
= acpi_pm_disable_gpes
,
318 .enter
= acpi_suspend_enter
,
319 .wake
= acpi_pm_finish
,
321 .recover
= acpi_pm_finish
,
324 static int __init
init_old_suspend_ordering(const struct dmi_system_id
*d
)
326 old_suspend_ordering
= true;
330 static struct dmi_system_id __initdata acpisleep_dmi_table
[] = {
332 .callback
= init_old_suspend_ordering
,
333 .ident
= "Abit KN9 (nForce4 variant)",
335 DMI_MATCH(DMI_BOARD_VENDOR
, "http://www.abit.com.tw/"),
336 DMI_MATCH(DMI_BOARD_NAME
, "KN9 Series(NF-CK804)"),
340 .callback
= init_old_suspend_ordering
,
341 .ident
= "HP xw4600 Workstation",
343 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
344 DMI_MATCH(DMI_PRODUCT_NAME
, "HP xw4600 Workstation"),
348 .callback
= init_old_suspend_ordering
,
349 .ident
= "Asus Pundit P1-AH2 (M2N8L motherboard)",
351 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTek Computer INC."),
352 DMI_MATCH(DMI_BOARD_NAME
, "M2N8L"),
356 .callback
= init_old_suspend_ordering
,
357 .ident
= "Panasonic CF51-2L",
359 DMI_MATCH(DMI_BOARD_VENDOR
,
360 "Matsushita Electric Industrial Co.,Ltd."),
361 DMI_MATCH(DMI_BOARD_NAME
, "CF51-2L"),
366 #endif /* CONFIG_SUSPEND */
368 #ifdef CONFIG_HIBERNATION
370 * The ACPI specification wants us to save NVS memory regions during hibernation
371 * and to restore them during the subsequent resume. However, it is not certain
372 * if this mechanism is going to work on all machines, so we allow the user to
373 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
376 static bool s4_no_nvs
;
378 void __init
acpi_s4_no_nvs(void)
383 static unsigned long s4_hardware_signature
;
384 static struct acpi_table_facs
*facs
;
385 static bool nosigcheck
;
387 void __init
acpi_no_s4_hw_signature(void)
392 static int acpi_hibernation_begin(void)
396 error
= s4_no_nvs
? 0 : hibernate_nvs_alloc();
398 acpi_target_sleep_state
= ACPI_STATE_S4
;
399 acpi_sleep_tts_switch(acpi_target_sleep_state
);
405 static int acpi_hibernation_pre_snapshot(void)
407 int error
= acpi_pm_prepare();
410 hibernate_nvs_save();
415 static int acpi_hibernation_enter(void)
417 acpi_status status
= AE_OK
;
418 unsigned long flags
= 0;
420 ACPI_FLUSH_CPU_CACHE();
422 local_irq_save(flags
);
423 acpi_enable_wakeup_device(ACPI_STATE_S4
);
424 /* This shouldn't return. If it returns, we have a problem */
425 status
= acpi_enter_sleep_state(ACPI_STATE_S4
);
426 /* Reprogram control registers and execute _BFS */
427 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
428 local_irq_restore(flags
);
430 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
433 static void acpi_hibernation_finish(void)
435 hibernate_nvs_free();
439 static void acpi_hibernation_leave(void)
442 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
446 /* Reprogram control registers and execute _BFS */
447 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
448 /* Check the hardware signature */
449 if (facs
&& s4_hardware_signature
!= facs
->hardware_signature
) {
450 printk(KERN_EMERG
"ACPI: Hardware changed while hibernated, "
452 panic("ACPI S4 hardware signature mismatch");
454 /* Restore the NVS memory area */
455 hibernate_nvs_restore();
458 static void acpi_pm_enable_gpes(void)
460 acpi_enable_all_runtime_gpes();
463 static struct platform_hibernation_ops acpi_hibernation_ops
= {
464 .begin
= acpi_hibernation_begin
,
466 .pre_snapshot
= acpi_hibernation_pre_snapshot
,
467 .finish
= acpi_hibernation_finish
,
468 .prepare
= acpi_pm_prepare
,
469 .enter
= acpi_hibernation_enter
,
470 .leave
= acpi_hibernation_leave
,
471 .pre_restore
= acpi_pm_disable_gpes
,
472 .restore_cleanup
= acpi_pm_enable_gpes
,
476 * acpi_hibernation_begin_old - Set the target system sleep state to
477 * ACPI_STATE_S4 and execute the _PTS control method. This
478 * function is used if the pre-ACPI 2.0 suspend ordering has been
481 static int acpi_hibernation_begin_old(void)
485 * The _TTS object should always be evaluated before the _PTS object.
486 * When the old_suspended_ordering is true, the _PTS object is
487 * evaluated in the acpi_sleep_prepare.
489 acpi_sleep_tts_switch(ACPI_STATE_S4
);
491 error
= acpi_sleep_prepare(ACPI_STATE_S4
);
495 error
= hibernate_nvs_alloc();
497 acpi_target_sleep_state
= ACPI_STATE_S4
;
502 static int acpi_hibernation_pre_snapshot_old(void)
504 int error
= acpi_pm_disable_gpes();
507 hibernate_nvs_save();
513 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
516 static struct platform_hibernation_ops acpi_hibernation_ops_old
= {
517 .begin
= acpi_hibernation_begin_old
,
519 .pre_snapshot
= acpi_hibernation_pre_snapshot_old
,
520 .finish
= acpi_hibernation_finish
,
521 .prepare
= acpi_pm_disable_gpes
,
522 .enter
= acpi_hibernation_enter
,
523 .leave
= acpi_hibernation_leave
,
524 .pre_restore
= acpi_pm_disable_gpes
,
525 .restore_cleanup
= acpi_pm_enable_gpes
,
526 .recover
= acpi_pm_finish
,
528 #endif /* CONFIG_HIBERNATION */
530 int acpi_suspend(u32 acpi_state
)
532 suspend_state_t states
[] = {
533 [1] = PM_SUSPEND_STANDBY
,
534 [3] = PM_SUSPEND_MEM
,
538 if (acpi_state
< 6 && states
[acpi_state
])
539 return pm_suspend(states
[acpi_state
]);
545 #ifdef CONFIG_PM_SLEEP
547 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
548 * in the system sleep state given by %acpi_target_sleep_state
549 * @dev: device to examine; its driver model wakeup flags control
550 * whether it should be able to wake up the system
551 * @d_min_p: used to store the upper limit of allowed states range
552 * Return value: preferred power state of the device on success, -ENODEV on
553 * failure (ie. if there's no 'struct acpi_device' for @dev)
555 * Find the lowest power (highest number) ACPI device power state that
556 * device @dev can be in while the system is in the sleep state represented
557 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
558 * able to wake up the system from this sleep state. If @d_min_p is set,
559 * the highest power (lowest number) device power state of @dev allowed
560 * in this system sleep state is stored at the location pointed to by it.
562 * The caller must ensure that @dev is valid before using this function.
563 * The caller is also responsible for figuring out if the device is
564 * supposed to be able to wake up the system and passing this information
568 int acpi_pm_device_sleep_state(struct device
*dev
, int *d_min_p
)
570 acpi_handle handle
= DEVICE_ACPI_HANDLE(dev
);
571 struct acpi_device
*adev
;
572 char acpi_method
[] = "_SxD";
573 unsigned long long d_min
, d_max
;
575 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
576 printk(KERN_DEBUG
"ACPI handle has no context!\n");
580 acpi_method
[2] = '0' + acpi_target_sleep_state
;
582 * If the sleep state is S0, we will return D3, but if the device has
583 * _S0W, we will use the value from _S0W
585 d_min
= ACPI_STATE_D0
;
586 d_max
= ACPI_STATE_D3
;
589 * If present, _SxD methods return the minimum D-state (highest power
590 * state) we can use for the corresponding S-states. Otherwise, the
591 * minimum D-state is D0 (ACPI 3.x).
593 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
594 * provided -- that's our fault recovery, we ignore retval.
596 if (acpi_target_sleep_state
> ACPI_STATE_S0
)
597 acpi_evaluate_integer(handle
, acpi_method
, NULL
, &d_min
);
600 * If _PRW says we can wake up the system from the target sleep state,
601 * the D-state returned by _SxD is sufficient for that (we assume a
602 * wakeup-aware driver if wake is set). Still, if _SxW exists
603 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
604 * can wake the system. _S0W may be valid, too.
606 if (acpi_target_sleep_state
== ACPI_STATE_S0
||
607 (device_may_wakeup(dev
) && adev
->wakeup
.state
.enabled
&&
608 adev
->wakeup
.sleep_state
<= acpi_target_sleep_state
)) {
611 acpi_method
[3] = 'W';
612 status
= acpi_evaluate_integer(handle
, acpi_method
, NULL
,
614 if (ACPI_FAILURE(status
)) {
616 } else if (d_max
< d_min
) {
617 /* Warn the user of the broken DSDT */
618 printk(KERN_WARNING
"ACPI: Wrong value from %s\n",
631 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
632 * capability of given device
633 * @dev: device to handle
634 * @enable: 'true' - enable, 'false' - disable the wake-up capability
636 int acpi_pm_device_sleep_wake(struct device
*dev
, bool enable
)
639 struct acpi_device
*adev
;
642 if (!device_can_wakeup(dev
))
645 handle
= DEVICE_ACPI_HANDLE(dev
);
646 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
647 dev_dbg(dev
, "ACPI handle has no context in %s!\n", __func__
);
652 acpi_enable_wakeup_device_power(adev
, acpi_target_sleep_state
) :
653 acpi_disable_wakeup_device_power(adev
);
655 dev_info(dev
, "wake-up capability %s by ACPI\n",
656 enable
? "enabled" : "disabled");
662 static void acpi_power_off_prepare(void)
664 /* Prepare to power off the system */
665 acpi_sleep_prepare(ACPI_STATE_S5
);
666 acpi_disable_all_gpes();
669 static void acpi_power_off(void)
671 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
672 printk(KERN_DEBUG
"%s called\n", __func__
);
674 acpi_enable_wakeup_device(ACPI_STATE_S5
);
675 acpi_enter_sleep_state(ACPI_STATE_S5
);
679 * ACPI 2.0 created the optional _GTS and _BFS,
680 * but industry adoption has been neither rapid nor broad.
682 * Linux gets into trouble when it executes poorly validated
683 * paths through the BIOS, so disable _GTS and _BFS by default,
684 * but do speak up and offer the option to enable them.
686 void __init
acpi_gts_bfs_check(void)
690 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__GTS
, &dummy
)))
692 printk(KERN_NOTICE PREFIX
"BIOS offers _GTS\n");
693 printk(KERN_NOTICE PREFIX
"If \"acpi.gts=1\" improves suspend, "
694 "please notify linux-acpi@vger.kernel.org\n");
696 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__BFS
, &dummy
)))
698 printk(KERN_NOTICE PREFIX
"BIOS offers _BFS\n");
699 printk(KERN_NOTICE PREFIX
"If \"acpi.bfs=1\" improves resume, "
700 "please notify linux-acpi@vger.kernel.org\n");
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
)) {
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;
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;
753 pm_power_off_prepare
= acpi_power_off_prepare
;
754 pm_power_off
= acpi_power_off
;
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
);
762 acpi_gts_bfs_check();