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_device_prep(acpi_state
);
77 acpi_enable_wakeup_device(acpi_state
);
78 acpi_enter_sleep_state_prep(acpi_state
);
82 #ifdef CONFIG_ACPI_SLEEP
83 static u32 acpi_target_sleep_state
= ACPI_STATE_S0
;
86 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
87 * user to request that behavior by using the 'acpi_old_suspend_ordering'
88 * kernel command line option that causes the following variable to be set.
90 static bool old_suspend_ordering
;
92 void __init
acpi_old_suspend_ordering(void)
94 old_suspend_ordering
= true;
98 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
100 static int acpi_pm_freeze(void)
102 acpi_disable_all_gpes();
103 acpi_os_wait_events_complete(NULL
);
104 acpi_ec_block_transactions();
109 * __acpi_pm_prepare - Prepare the platform to enter the target state.
111 * If necessary, set the firmware waking vector and do arch-specific
112 * nastiness to get the wakeup code to the waking vector.
114 static int __acpi_pm_prepare(void)
116 int error
= acpi_sleep_prepare(acpi_target_sleep_state
);
121 acpi_target_sleep_state
= ACPI_STATE_S0
;
126 * acpi_pm_prepare - Prepare the platform to enter the target sleep
127 * state and disable the GPEs.
129 static int acpi_pm_prepare(void)
131 int error
= __acpi_pm_prepare();
140 * acpi_pm_finish - Instruct the platform to leave a sleep state.
142 * This is called after we wake back up (or if entering the sleep state
145 static void acpi_pm_finish(void)
147 u32 acpi_state
= acpi_target_sleep_state
;
149 acpi_ec_unblock_transactions();
151 if (acpi_state
== ACPI_STATE_S0
)
154 printk(KERN_INFO PREFIX
"Waking up from system sleep state S%d\n",
156 acpi_disable_wakeup_device(acpi_state
);
157 acpi_leave_sleep_state(acpi_state
);
159 /* reset firmware waking vector */
160 acpi_set_firmware_waking_vector((acpi_physical_address
) 0);
162 acpi_target_sleep_state
= ACPI_STATE_S0
;
166 * acpi_pm_end - Finish up suspend sequence.
168 static void acpi_pm_end(void)
172 * This is necessary in case acpi_pm_finish() is not called during a
173 * failing transition to a sleep state.
175 acpi_target_sleep_state
= ACPI_STATE_S0
;
176 acpi_sleep_tts_switch(acpi_target_sleep_state
);
178 #else /* !CONFIG_ACPI_SLEEP */
179 #define acpi_target_sleep_state ACPI_STATE_S0
180 #endif /* CONFIG_ACPI_SLEEP */
182 #ifdef CONFIG_SUSPEND
183 extern void do_suspend_lowlevel(void);
185 static u32 acpi_suspend_states
[] = {
186 [PM_SUSPEND_ON
] = ACPI_STATE_S0
,
187 [PM_SUSPEND_STANDBY
] = ACPI_STATE_S1
,
188 [PM_SUSPEND_MEM
] = ACPI_STATE_S3
,
189 [PM_SUSPEND_MAX
] = ACPI_STATE_S5
193 * acpi_suspend_begin - Set the target system sleep state to the state
194 * associated with given @pm_state, if supported.
196 static int acpi_suspend_begin(suspend_state_t pm_state
)
198 u32 acpi_state
= acpi_suspend_states
[pm_state
];
201 error
= suspend_nvs_alloc();
206 if (sleep_states
[acpi_state
]) {
207 acpi_target_sleep_state
= acpi_state
;
208 acpi_sleep_tts_switch(acpi_target_sleep_state
);
210 printk(KERN_ERR
"ACPI does not support this state: %d\n",
218 * acpi_suspend_enter - Actually enter a sleep state.
221 * Flush caches and go to sleep. For STR we have to call arch-specific
222 * assembly, which in turn call acpi_enter_sleep_state().
223 * It's unfortunate, but it works. Please fix if you're feeling frisky.
225 static int acpi_suspend_enter(suspend_state_t pm_state
)
227 acpi_status status
= AE_OK
;
228 unsigned long flags
= 0;
229 u32 acpi_state
= acpi_target_sleep_state
;
231 ACPI_FLUSH_CPU_CACHE();
233 /* Do arch specific saving of state. */
234 if (acpi_state
== ACPI_STATE_S3
) {
235 int error
= acpi_save_state_mem();
241 local_irq_save(flags
);
242 switch (acpi_state
) {
245 status
= acpi_enter_sleep_state(acpi_state
);
249 do_suspend_lowlevel();
253 /* This violates the spec but is required for bug compatibility. */
254 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE
, 1);
256 /* Reprogram control registers and execute _BFS */
257 acpi_leave_sleep_state_prep(acpi_state
);
259 /* ACPI 3.0 specs (P62) says that it's the responsibility
260 * of the OSPM to clear the status bit [ implying that the
261 * POWER_BUTTON event should not reach userspace ]
263 if (ACPI_SUCCESS(status
) && (acpi_state
== ACPI_STATE_S3
))
264 acpi_clear_event(ACPI_EVENT_POWER_BUTTON
);
267 * Disable and clear GPE status before interrupt is enabled. Some GPEs
268 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
269 * acpi_leave_sleep_state will reenable specific GPEs later
271 acpi_disable_all_gpes();
272 /* Allow EC transactions to happen. */
273 acpi_ec_unblock_transactions_early();
275 local_irq_restore(flags
);
276 printk(KERN_DEBUG
"Back to C!\n");
278 /* restore processor state */
279 if (acpi_state
== ACPI_STATE_S3
)
280 acpi_restore_state_mem();
282 suspend_nvs_restore();
284 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
287 static void acpi_suspend_finish(void)
292 static int acpi_suspend_state_valid(suspend_state_t pm_state
)
298 case PM_SUSPEND_STANDBY
:
300 acpi_state
= acpi_suspend_states
[pm_state
];
302 return sleep_states
[acpi_state
];
308 static struct platform_suspend_ops acpi_suspend_ops
= {
309 .valid
= acpi_suspend_state_valid
,
310 .begin
= acpi_suspend_begin
,
311 .prepare_late
= acpi_pm_prepare
,
312 .enter
= acpi_suspend_enter
,
313 .wake
= acpi_suspend_finish
,
318 * acpi_suspend_begin_old - Set the target system sleep state to the
319 * state associated with given @pm_state, if supported, and
320 * execute the _PTS control method. This function is used if the
321 * pre-ACPI 2.0 suspend ordering has been requested.
323 static int acpi_suspend_begin_old(suspend_state_t pm_state
)
325 int error
= acpi_suspend_begin(pm_state
);
328 error
= __acpi_pm_prepare();
333 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
336 static struct platform_suspend_ops acpi_suspend_ops_old
= {
337 .valid
= acpi_suspend_state_valid
,
338 .begin
= acpi_suspend_begin_old
,
339 .prepare_late
= acpi_pm_freeze
,
340 .enter
= acpi_suspend_enter
,
341 .wake
= acpi_suspend_finish
,
343 .recover
= acpi_pm_finish
,
346 static int __init
init_old_suspend_ordering(const struct dmi_system_id
*d
)
348 old_suspend_ordering
= true;
352 static struct dmi_system_id __initdata acpisleep_dmi_table
[] = {
354 .callback
= init_old_suspend_ordering
,
355 .ident
= "Abit KN9 (nForce4 variant)",
357 DMI_MATCH(DMI_BOARD_VENDOR
, "http://www.abit.com.tw/"),
358 DMI_MATCH(DMI_BOARD_NAME
, "KN9 Series(NF-CK804)"),
362 .callback
= init_old_suspend_ordering
,
363 .ident
= "HP xw4600 Workstation",
365 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
366 DMI_MATCH(DMI_PRODUCT_NAME
, "HP xw4600 Workstation"),
370 .callback
= init_old_suspend_ordering
,
371 .ident
= "Asus Pundit P1-AH2 (M2N8L motherboard)",
373 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTek Computer INC."),
374 DMI_MATCH(DMI_BOARD_NAME
, "M2N8L"),
378 .callback
= init_old_suspend_ordering
,
379 .ident
= "Panasonic CF51-2L",
381 DMI_MATCH(DMI_BOARD_VENDOR
,
382 "Matsushita Electric Industrial Co.,Ltd."),
383 DMI_MATCH(DMI_BOARD_NAME
, "CF51-2L"),
388 #endif /* CONFIG_SUSPEND */
390 #ifdef CONFIG_HIBERNATION
392 * The ACPI specification wants us to save NVS memory regions during hibernation
393 * and to restore them during the subsequent resume. However, it is not certain
394 * if this mechanism is going to work on all machines, so we allow the user to
395 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
398 static bool s4_no_nvs
;
400 void __init
acpi_s4_no_nvs(void)
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
= s4_no_nvs
? 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_pre_snapshot(void)
429 int error
= acpi_pm_prepare();
437 static int acpi_hibernation_enter(void)
439 acpi_status status
= AE_OK
;
440 unsigned long flags
= 0;
442 ACPI_FLUSH_CPU_CACHE();
444 local_irq_save(flags
);
445 /* This shouldn't return. If it returns, we have a problem */
446 status
= acpi_enter_sleep_state(ACPI_STATE_S4
);
447 /* Reprogram control registers and execute _BFS */
448 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
449 local_irq_restore(flags
);
451 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
454 static void acpi_hibernation_leave(void)
457 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
461 /* Reprogram control registers and execute _BFS */
462 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
463 /* Check the hardware signature */
464 if (facs
&& s4_hardware_signature
!= facs
->hardware_signature
) {
465 printk(KERN_EMERG
"ACPI: Hardware changed while hibernated, "
467 panic("ACPI S4 hardware signature mismatch");
469 /* Restore the NVS memory area */
470 suspend_nvs_restore();
471 /* Allow EC transactions to happen. */
472 acpi_ec_unblock_transactions_early();
475 static void acpi_pm_thaw(void)
477 acpi_ec_unblock_transactions();
478 acpi_enable_all_runtime_gpes();
481 static struct platform_hibernation_ops acpi_hibernation_ops
= {
482 .begin
= acpi_hibernation_begin
,
484 .pre_snapshot
= acpi_hibernation_pre_snapshot
,
485 .finish
= acpi_pm_finish
,
486 .prepare
= acpi_pm_prepare
,
487 .enter
= acpi_hibernation_enter
,
488 .leave
= acpi_hibernation_leave
,
489 .pre_restore
= acpi_pm_freeze
,
490 .restore_cleanup
= acpi_pm_thaw
,
494 * acpi_hibernation_begin_old - Set the target system sleep state to
495 * ACPI_STATE_S4 and execute the _PTS control method. This
496 * function is used if the pre-ACPI 2.0 suspend ordering has been
499 static int acpi_hibernation_begin_old(void)
503 * The _TTS object should always be evaluated before the _PTS object.
504 * When the old_suspended_ordering is true, the _PTS object is
505 * evaluated in the acpi_sleep_prepare.
507 acpi_sleep_tts_switch(ACPI_STATE_S4
);
509 error
= acpi_sleep_prepare(ACPI_STATE_S4
);
513 error
= suspend_nvs_alloc();
515 acpi_target_sleep_state
= ACPI_STATE_S4
;
520 static int acpi_hibernation_pre_snapshot_old(void)
528 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
531 static struct platform_hibernation_ops acpi_hibernation_ops_old
= {
532 .begin
= acpi_hibernation_begin_old
,
534 .pre_snapshot
= acpi_hibernation_pre_snapshot_old
,
535 .prepare
= acpi_pm_freeze
,
536 .finish
= acpi_pm_finish
,
537 .enter
= acpi_hibernation_enter
,
538 .leave
= acpi_hibernation_leave
,
539 .pre_restore
= acpi_pm_freeze
,
540 .restore_cleanup
= acpi_pm_thaw
,
541 .recover
= acpi_pm_finish
,
543 #endif /* CONFIG_HIBERNATION */
545 int acpi_suspend(u32 acpi_state
)
547 suspend_state_t states
[] = {
548 [1] = PM_SUSPEND_STANDBY
,
549 [3] = PM_SUSPEND_MEM
,
553 if (acpi_state
< 6 && states
[acpi_state
])
554 return pm_suspend(states
[acpi_state
]);
560 #ifdef CONFIG_PM_SLEEP
562 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
563 * in the system sleep state given by %acpi_target_sleep_state
564 * @dev: device to examine; its driver model wakeup flags control
565 * whether it should be able to wake up the system
566 * @d_min_p: used to store the upper limit of allowed states range
567 * Return value: preferred power state of the device on success, -ENODEV on
568 * failure (ie. if there's no 'struct acpi_device' for @dev)
570 * Find the lowest power (highest number) ACPI device power state that
571 * device @dev can be in while the system is in the sleep state represented
572 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
573 * able to wake up the system from this sleep state. If @d_min_p is set,
574 * the highest power (lowest number) device power state of @dev allowed
575 * in this system sleep state is stored at the location pointed to by it.
577 * The caller must ensure that @dev is valid before using this function.
578 * The caller is also responsible for figuring out if the device is
579 * supposed to be able to wake up the system and passing this information
583 int acpi_pm_device_sleep_state(struct device
*dev
, int *d_min_p
)
585 acpi_handle handle
= DEVICE_ACPI_HANDLE(dev
);
586 struct acpi_device
*adev
;
587 char acpi_method
[] = "_SxD";
588 unsigned long long d_min
, d_max
;
590 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
591 printk(KERN_DEBUG
"ACPI handle has no context!\n");
595 acpi_method
[2] = '0' + acpi_target_sleep_state
;
597 * If the sleep state is S0, we will return D3, but if the device has
598 * _S0W, we will use the value from _S0W
600 d_min
= ACPI_STATE_D0
;
601 d_max
= ACPI_STATE_D3
;
604 * If present, _SxD methods return the minimum D-state (highest power
605 * state) we can use for the corresponding S-states. Otherwise, the
606 * minimum D-state is D0 (ACPI 3.x).
608 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
609 * provided -- that's our fault recovery, we ignore retval.
611 if (acpi_target_sleep_state
> ACPI_STATE_S0
)
612 acpi_evaluate_integer(handle
, acpi_method
, NULL
, &d_min
);
615 * If _PRW says we can wake up the system from the target sleep state,
616 * the D-state returned by _SxD is sufficient for that (we assume a
617 * wakeup-aware driver if wake is set). Still, if _SxW exists
618 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
619 * can wake the system. _S0W may be valid, too.
621 if (acpi_target_sleep_state
== ACPI_STATE_S0
||
622 (device_may_wakeup(dev
) && adev
->wakeup
.state
.enabled
&&
623 adev
->wakeup
.sleep_state
<= acpi_target_sleep_state
)) {
626 acpi_method
[3] = 'W';
627 status
= acpi_evaluate_integer(handle
, acpi_method
, NULL
,
629 if (ACPI_FAILURE(status
)) {
631 } else if (d_max
< d_min
) {
632 /* Warn the user of the broken DSDT */
633 printk(KERN_WARNING
"ACPI: Wrong value from %s\n",
646 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
647 * capability of given device
648 * @dev: device to handle
649 * @enable: 'true' - enable, 'false' - disable the wake-up capability
651 int acpi_pm_device_sleep_wake(struct device
*dev
, bool enable
)
654 struct acpi_device
*adev
;
657 if (!device_can_wakeup(dev
))
660 handle
= DEVICE_ACPI_HANDLE(dev
);
661 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
662 dev_dbg(dev
, "ACPI handle has no context in %s!\n", __func__
);
667 error
= acpi_enable_wakeup_device_power(adev
,
668 acpi_target_sleep_state
);
670 acpi_enable_gpe(adev
->wakeup
.gpe_device
,
671 adev
->wakeup
.gpe_number
,
674 acpi_disable_gpe(adev
->wakeup
.gpe_device
, adev
->wakeup
.gpe_number
,
676 error
= acpi_disable_wakeup_device_power(adev
);
679 dev_info(dev
, "wake-up capability %s by ACPI\n",
680 enable
? "enabled" : "disabled");
686 static void acpi_power_off_prepare(void)
688 /* Prepare to power off the system */
689 acpi_sleep_prepare(ACPI_STATE_S5
);
690 acpi_disable_all_gpes();
693 static void acpi_power_off(void)
695 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
696 printk(KERN_DEBUG
"%s called\n", __func__
);
698 acpi_enter_sleep_state(ACPI_STATE_S5
);
702 * ACPI 2.0 created the optional _GTS and _BFS,
703 * but industry adoption has been neither rapid nor broad.
705 * Linux gets into trouble when it executes poorly validated
706 * paths through the BIOS, so disable _GTS and _BFS by default,
707 * but do speak up and offer the option to enable them.
709 void __init
acpi_gts_bfs_check(void)
713 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__GTS
, &dummy
)))
715 printk(KERN_NOTICE PREFIX
"BIOS offers _GTS\n");
716 printk(KERN_NOTICE PREFIX
"If \"acpi.gts=1\" improves suspend, "
717 "please notify linux-acpi@vger.kernel.org\n");
719 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__BFS
, &dummy
)))
721 printk(KERN_NOTICE PREFIX
"BIOS offers _BFS\n");
722 printk(KERN_NOTICE PREFIX
"If \"acpi.bfs=1\" improves resume, "
723 "please notify linux-acpi@vger.kernel.org\n");
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
)) {
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;
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;
776 pm_power_off_prepare
= acpi_power_off_prepare
;
777 pm_power_off
= acpi_power_off
;
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
);
785 acpi_gts_bfs_check();