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();
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
;
85 * The ACPI specification wants us to save NVS memory regions during hibernation
86 * and to restore them during the subsequent resume. Windows does that also for
87 * suspend to RAM. However, it is known that this mechanism does not work on
88 * all machines, so we allow the user to disable it with the help of the
89 * 'acpi_sleep=nonvs' kernel command line option.
91 static bool nvs_nosave
;
93 void __init
acpi_nvs_nosave(void)
99 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
100 * user to request that behavior by using the 'acpi_old_suspend_ordering'
101 * kernel command line option that causes the following variable to be set.
103 static bool old_suspend_ordering
;
105 void __init
acpi_old_suspend_ordering(void)
107 old_suspend_ordering
= true;
111 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
113 static int acpi_pm_freeze(void)
115 acpi_disable_all_gpes();
116 acpi_os_wait_events_complete(NULL
);
117 acpi_ec_block_transactions();
122 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
124 static int acpi_pm_pre_suspend(void)
132 * __acpi_pm_prepare - Prepare the platform to enter the target state.
134 * If necessary, set the firmware waking vector and do arch-specific
135 * nastiness to get the wakeup code to the waking vector.
137 static int __acpi_pm_prepare(void)
139 int error
= acpi_sleep_prepare(acpi_target_sleep_state
);
141 acpi_target_sleep_state
= ACPI_STATE_S0
;
147 * acpi_pm_prepare - Prepare the platform to enter the target sleep
148 * state and disable the GPEs.
150 static int acpi_pm_prepare(void)
152 int error
= __acpi_pm_prepare();
154 acpi_pm_pre_suspend();
160 * acpi_pm_finish - Instruct the platform to leave a sleep state.
162 * This is called after we wake back up (or if entering the sleep state
165 static void acpi_pm_finish(void)
167 u32 acpi_state
= acpi_target_sleep_state
;
169 acpi_ec_unblock_transactions();
171 if (acpi_state
== ACPI_STATE_S0
)
174 printk(KERN_INFO PREFIX
"Waking up from system sleep state S%d\n",
176 acpi_disable_wakeup_devices(acpi_state
);
177 acpi_leave_sleep_state(acpi_state
);
179 /* reset firmware waking vector */
180 acpi_set_firmware_waking_vector((acpi_physical_address
) 0);
182 acpi_target_sleep_state
= ACPI_STATE_S0
;
186 * acpi_pm_end - Finish up suspend sequence.
188 static void acpi_pm_end(void)
192 * This is necessary in case acpi_pm_finish() is not called during a
193 * failing transition to a sleep state.
195 acpi_target_sleep_state
= ACPI_STATE_S0
;
196 acpi_sleep_tts_switch(acpi_target_sleep_state
);
198 #else /* !CONFIG_ACPI_SLEEP */
199 #define acpi_target_sleep_state ACPI_STATE_S0
200 #endif /* CONFIG_ACPI_SLEEP */
202 #ifdef CONFIG_SUSPEND
203 extern void do_suspend_lowlevel(void);
205 static u32 acpi_suspend_states
[] = {
206 [PM_SUSPEND_ON
] = ACPI_STATE_S0
,
207 [PM_SUSPEND_STANDBY
] = ACPI_STATE_S1
,
208 [PM_SUSPEND_MEM
] = ACPI_STATE_S3
,
209 [PM_SUSPEND_MAX
] = ACPI_STATE_S5
213 * acpi_suspend_begin - Set the target system sleep state to the state
214 * associated with given @pm_state, if supported.
216 static int acpi_suspend_begin(suspend_state_t pm_state
)
218 u32 acpi_state
= acpi_suspend_states
[pm_state
];
221 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
225 if (sleep_states
[acpi_state
]) {
226 acpi_target_sleep_state
= acpi_state
;
227 acpi_sleep_tts_switch(acpi_target_sleep_state
);
229 printk(KERN_ERR
"ACPI does not support this state: %d\n",
237 * acpi_suspend_enter - Actually enter a sleep state.
240 * Flush caches and go to sleep. For STR we have to call arch-specific
241 * assembly, which in turn call acpi_enter_sleep_state().
242 * It's unfortunate, but it works. Please fix if you're feeling frisky.
244 static int acpi_suspend_enter(suspend_state_t pm_state
)
246 acpi_status status
= AE_OK
;
247 unsigned long flags
= 0;
248 u32 acpi_state
= acpi_target_sleep_state
;
250 ACPI_FLUSH_CPU_CACHE();
252 /* Do arch specific saving of state. */
253 if (acpi_state
== ACPI_STATE_S3
) {
254 int error
= acpi_save_state_mem();
260 local_irq_save(flags
);
261 switch (acpi_state
) {
264 status
= acpi_enter_sleep_state(acpi_state
);
268 do_suspend_lowlevel();
272 /* This violates the spec but is required for bug compatibility. */
273 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE
, 1);
275 /* Reprogram control registers and execute _BFS */
276 acpi_leave_sleep_state_prep(acpi_state
);
278 /* ACPI 3.0 specs (P62) says that it's the responsibility
279 * of the OSPM to clear the status bit [ implying that the
280 * POWER_BUTTON event should not reach userspace ]
282 if (ACPI_SUCCESS(status
) && (acpi_state
== ACPI_STATE_S3
))
283 acpi_clear_event(ACPI_EVENT_POWER_BUTTON
);
286 * Disable and clear GPE status before interrupt is enabled. Some GPEs
287 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
288 * acpi_leave_sleep_state will reenable specific GPEs later
290 acpi_disable_all_gpes();
291 /* Allow EC transactions to happen. */
292 acpi_ec_unblock_transactions_early();
294 local_irq_restore(flags
);
295 printk(KERN_DEBUG
"Back to C!\n");
297 /* restore processor state */
298 if (acpi_state
== ACPI_STATE_S3
)
299 acpi_restore_state_mem();
301 suspend_nvs_restore();
303 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
306 static int acpi_suspend_state_valid(suspend_state_t pm_state
)
312 case PM_SUSPEND_STANDBY
:
314 acpi_state
= acpi_suspend_states
[pm_state
];
316 return sleep_states
[acpi_state
];
322 static struct platform_suspend_ops acpi_suspend_ops
= {
323 .valid
= acpi_suspend_state_valid
,
324 .begin
= acpi_suspend_begin
,
325 .prepare_late
= acpi_pm_prepare
,
326 .enter
= acpi_suspend_enter
,
327 .wake
= acpi_pm_finish
,
332 * acpi_suspend_begin_old - Set the target system sleep state to the
333 * state associated with given @pm_state, if supported, and
334 * execute the _PTS control method. This function is used if the
335 * pre-ACPI 2.0 suspend ordering has been requested.
337 static int acpi_suspend_begin_old(suspend_state_t pm_state
)
339 int error
= acpi_suspend_begin(pm_state
);
341 error
= __acpi_pm_prepare();
347 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
350 static struct platform_suspend_ops acpi_suspend_ops_old
= {
351 .valid
= acpi_suspend_state_valid
,
352 .begin
= acpi_suspend_begin_old
,
353 .prepare_late
= acpi_pm_pre_suspend
,
354 .enter
= acpi_suspend_enter
,
355 .wake
= acpi_pm_finish
,
357 .recover
= acpi_pm_finish
,
360 static int __init
init_old_suspend_ordering(const struct dmi_system_id
*d
)
362 old_suspend_ordering
= true;
366 static struct dmi_system_id __initdata acpisleep_dmi_table
[] = {
368 .callback
= init_old_suspend_ordering
,
369 .ident
= "Abit KN9 (nForce4 variant)",
371 DMI_MATCH(DMI_BOARD_VENDOR
, "http://www.abit.com.tw/"),
372 DMI_MATCH(DMI_BOARD_NAME
, "KN9 Series(NF-CK804)"),
376 .callback
= init_old_suspend_ordering
,
377 .ident
= "HP xw4600 Workstation",
379 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
380 DMI_MATCH(DMI_PRODUCT_NAME
, "HP xw4600 Workstation"),
384 .callback
= init_old_suspend_ordering
,
385 .ident
= "Asus Pundit P1-AH2 (M2N8L motherboard)",
387 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTek Computer INC."),
388 DMI_MATCH(DMI_BOARD_NAME
, "M2N8L"),
392 .callback
= init_old_suspend_ordering
,
393 .ident
= "Panasonic CF51-2L",
395 DMI_MATCH(DMI_BOARD_VENDOR
,
396 "Matsushita Electric Industrial Co.,Ltd."),
397 DMI_MATCH(DMI_BOARD_NAME
, "CF51-2L"),
402 #endif /* CONFIG_SUSPEND */
404 #ifdef CONFIG_HIBERNATION
405 static unsigned long s4_hardware_signature
;
406 static struct acpi_table_facs
*facs
;
407 static bool nosigcheck
;
409 void __init
acpi_no_s4_hw_signature(void)
414 static int acpi_hibernation_begin(void)
418 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
420 acpi_target_sleep_state
= ACPI_STATE_S4
;
421 acpi_sleep_tts_switch(acpi_target_sleep_state
);
427 static int acpi_hibernation_enter(void)
429 acpi_status status
= AE_OK
;
430 unsigned long flags
= 0;
432 ACPI_FLUSH_CPU_CACHE();
434 local_irq_save(flags
);
435 /* This shouldn't return. If it returns, we have a problem */
436 status
= acpi_enter_sleep_state(ACPI_STATE_S4
);
437 /* Reprogram control registers and execute _BFS */
438 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
439 local_irq_restore(flags
);
441 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
444 static void acpi_hibernation_leave(void)
447 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
451 /* Reprogram control registers and execute _BFS */
452 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
453 /* Check the hardware signature */
454 if (facs
&& s4_hardware_signature
!= facs
->hardware_signature
) {
455 printk(KERN_EMERG
"ACPI: Hardware changed while hibernated, "
457 panic("ACPI S4 hardware signature mismatch");
459 /* Restore the NVS memory area */
460 suspend_nvs_restore();
461 /* Allow EC transactions to happen. */
462 acpi_ec_unblock_transactions_early();
465 static void acpi_pm_thaw(void)
467 acpi_ec_unblock_transactions();
468 acpi_enable_all_runtime_gpes();
471 static struct platform_hibernation_ops acpi_hibernation_ops
= {
472 .begin
= acpi_hibernation_begin
,
474 .pre_snapshot
= acpi_pm_prepare
,
475 .finish
= acpi_pm_finish
,
476 .prepare
= acpi_pm_prepare
,
477 .enter
= acpi_hibernation_enter
,
478 .leave
= acpi_hibernation_leave
,
479 .pre_restore
= acpi_pm_freeze
,
480 .restore_cleanup
= acpi_pm_thaw
,
484 * acpi_hibernation_begin_old - Set the target system sleep state to
485 * ACPI_STATE_S4 and execute the _PTS control method. This
486 * function is used if the pre-ACPI 2.0 suspend ordering has been
489 static int acpi_hibernation_begin_old(void)
493 * The _TTS object should always be evaluated before the _PTS object.
494 * When the old_suspended_ordering is true, the _PTS object is
495 * evaluated in the acpi_sleep_prepare.
497 acpi_sleep_tts_switch(ACPI_STATE_S4
);
499 error
= acpi_sleep_prepare(ACPI_STATE_S4
);
503 error
= suspend_nvs_alloc();
505 acpi_target_sleep_state
= ACPI_STATE_S4
;
511 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
514 static struct platform_hibernation_ops acpi_hibernation_ops_old
= {
515 .begin
= acpi_hibernation_begin_old
,
517 .pre_snapshot
= acpi_pm_pre_suspend
,
518 .prepare
= acpi_pm_freeze
,
519 .finish
= acpi_pm_finish
,
520 .enter
= acpi_hibernation_enter
,
521 .leave
= acpi_hibernation_leave
,
522 .pre_restore
= acpi_pm_freeze
,
523 .restore_cleanup
= acpi_pm_thaw
,
524 .recover
= acpi_pm_finish
,
526 #endif /* CONFIG_HIBERNATION */
528 int acpi_suspend(u32 acpi_state
)
530 suspend_state_t states
[] = {
531 [1] = PM_SUSPEND_STANDBY
,
532 [3] = PM_SUSPEND_MEM
,
536 if (acpi_state
< 6 && states
[acpi_state
])
537 return pm_suspend(states
[acpi_state
]);
543 #ifdef CONFIG_PM_SLEEP
545 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
546 * in the system sleep state given by %acpi_target_sleep_state
547 * @dev: device to examine; its driver model wakeup flags control
548 * whether it should be able to wake up the system
549 * @d_min_p: used to store the upper limit of allowed states range
550 * Return value: preferred power state of the device on success, -ENODEV on
551 * failure (ie. if there's no 'struct acpi_device' for @dev)
553 * Find the lowest power (highest number) ACPI device power state that
554 * device @dev can be in while the system is in the sleep state represented
555 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
556 * able to wake up the system from this sleep state. If @d_min_p is set,
557 * the highest power (lowest number) device power state of @dev allowed
558 * in this system sleep state is stored at the location pointed to by it.
560 * The caller must ensure that @dev is valid before using this function.
561 * The caller is also responsible for figuring out if the device is
562 * supposed to be able to wake up the system and passing this information
566 int acpi_pm_device_sleep_state(struct device
*dev
, int *d_min_p
)
568 acpi_handle handle
= DEVICE_ACPI_HANDLE(dev
);
569 struct acpi_device
*adev
;
570 char acpi_method
[] = "_SxD";
571 unsigned long long d_min
, d_max
;
573 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
574 printk(KERN_DEBUG
"ACPI handle has no context!\n");
578 acpi_method
[2] = '0' + acpi_target_sleep_state
;
580 * If the sleep state is S0, we will return D3, but if the device has
581 * _S0W, we will use the value from _S0W
583 d_min
= ACPI_STATE_D0
;
584 d_max
= ACPI_STATE_D3
;
587 * If present, _SxD methods return the minimum D-state (highest power
588 * state) we can use for the corresponding S-states. Otherwise, the
589 * minimum D-state is D0 (ACPI 3.x).
591 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
592 * provided -- that's our fault recovery, we ignore retval.
594 if (acpi_target_sleep_state
> ACPI_STATE_S0
)
595 acpi_evaluate_integer(handle
, acpi_method
, NULL
, &d_min
);
598 * If _PRW says we can wake up the system from the target sleep state,
599 * the D-state returned by _SxD is sufficient for that (we assume a
600 * wakeup-aware driver if wake is set). Still, if _SxW exists
601 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
602 * can wake the system. _S0W may be valid, too.
604 if (acpi_target_sleep_state
== ACPI_STATE_S0
||
605 (device_may_wakeup(dev
) && adev
->wakeup
.state
.enabled
&&
606 adev
->wakeup
.sleep_state
<= acpi_target_sleep_state
)) {
609 acpi_method
[3] = 'W';
610 status
= acpi_evaluate_integer(handle
, acpi_method
, NULL
,
612 if (ACPI_FAILURE(status
)) {
614 } else if (d_max
< d_min
) {
615 /* Warn the user of the broken DSDT */
616 printk(KERN_WARNING
"ACPI: Wrong value from %s\n",
629 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
630 * capability of given device
631 * @dev: device to handle
632 * @enable: 'true' - enable, 'false' - disable the wake-up capability
634 int acpi_pm_device_sleep_wake(struct device
*dev
, bool enable
)
637 struct acpi_device
*adev
;
640 if (!device_can_wakeup(dev
))
643 handle
= DEVICE_ACPI_HANDLE(dev
);
644 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
645 dev_dbg(dev
, "ACPI handle has no context in %s!\n", __func__
);
650 acpi_enable_wakeup_device_power(adev
, acpi_target_sleep_state
) :
651 acpi_disable_wakeup_device_power(adev
);
653 dev_info(dev
, "wake-up capability %s by ACPI\n",
654 enable
? "enabled" : "disabled");
660 static void acpi_power_off_prepare(void)
662 /* Prepare to power off the system */
663 acpi_sleep_prepare(ACPI_STATE_S5
);
664 acpi_disable_all_gpes();
667 static void acpi_power_off(void)
669 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
670 printk(KERN_DEBUG
"%s called\n", __func__
);
672 acpi_enter_sleep_state(ACPI_STATE_S5
);
676 * ACPI 2.0 created the optional _GTS and _BFS,
677 * but industry adoption has been neither rapid nor broad.
679 * Linux gets into trouble when it executes poorly validated
680 * paths through the BIOS, so disable _GTS and _BFS by default,
681 * but do speak up and offer the option to enable them.
683 void __init
acpi_gts_bfs_check(void)
687 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__GTS
, &dummy
)))
689 printk(KERN_NOTICE PREFIX
"BIOS offers _GTS\n");
690 printk(KERN_NOTICE PREFIX
"If \"acpi.gts=1\" improves suspend, "
691 "please notify linux-acpi@vger.kernel.org\n");
693 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__BFS
, &dummy
)))
695 printk(KERN_NOTICE PREFIX
"BIOS offers _BFS\n");
696 printk(KERN_NOTICE PREFIX
"If \"acpi.bfs=1\" improves resume, "
697 "please notify linux-acpi@vger.kernel.org\n");
701 int __init
acpi_sleep_init(void)
705 #ifdef CONFIG_SUSPEND
708 dmi_check_system(acpisleep_dmi_table
);
714 sleep_states
[ACPI_STATE_S0
] = 1;
715 printk(KERN_INFO PREFIX
"(supports S0");
717 #ifdef CONFIG_SUSPEND
718 for (i
= ACPI_STATE_S1
; i
< ACPI_STATE_S4
; i
++) {
719 status
= acpi_get_sleep_type_data(i
, &type_a
, &type_b
);
720 if (ACPI_SUCCESS(status
)) {
726 suspend_set_ops(old_suspend_ordering
?
727 &acpi_suspend_ops_old
: &acpi_suspend_ops
);
730 #ifdef CONFIG_HIBERNATION
731 status
= acpi_get_sleep_type_data(ACPI_STATE_S4
, &type_a
, &type_b
);
732 if (ACPI_SUCCESS(status
)) {
733 hibernation_set_ops(old_suspend_ordering
?
734 &acpi_hibernation_ops_old
: &acpi_hibernation_ops
);
735 sleep_states
[ACPI_STATE_S4
] = 1;
738 acpi_get_table(ACPI_SIG_FACS
, 1,
739 (struct acpi_table_header
**)&facs
);
741 s4_hardware_signature
=
742 facs
->hardware_signature
;
746 status
= acpi_get_sleep_type_data(ACPI_STATE_S5
, &type_a
, &type_b
);
747 if (ACPI_SUCCESS(status
)) {
748 sleep_states
[ACPI_STATE_S5
] = 1;
750 pm_power_off_prepare
= acpi_power_off_prepare
;
751 pm_power_off
= acpi_power_off
;
755 * Register the tts_notifier to reboot notifier list so that the _TTS
756 * object can also be evaluated when the system enters S5.
758 register_reboot_notifier(&tts_notifier
);
759 acpi_gts_bfs_check();