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 * 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_pm_prepare - Prepare the platform to enter the target state.
124 * If necessary, set the firmware waking vector and do arch-specific
125 * nastiness to get the wakeup code to the waking vector.
127 static int __acpi_pm_prepare(void)
129 int error
= acpi_sleep_prepare(acpi_target_sleep_state
);
134 acpi_target_sleep_state
= ACPI_STATE_S0
;
139 * acpi_pm_prepare - Prepare the platform to enter the target sleep
140 * state and disable the GPEs.
142 static int acpi_pm_prepare(void)
144 int error
= __acpi_pm_prepare();
153 * acpi_pm_finish - Instruct the platform to leave a sleep state.
155 * This is called after we wake back up (or if entering the sleep state
158 static void acpi_pm_finish(void)
160 u32 acpi_state
= acpi_target_sleep_state
;
163 acpi_ec_unblock_transactions();
165 if (acpi_state
== ACPI_STATE_S0
)
168 printk(KERN_INFO PREFIX
"Waking up from system sleep state S%d\n",
170 acpi_disable_wakeup_device(acpi_state
);
171 acpi_leave_sleep_state(acpi_state
);
173 /* reset firmware waking vector */
174 acpi_set_firmware_waking_vector((acpi_physical_address
) 0);
176 acpi_target_sleep_state
= ACPI_STATE_S0
;
180 * acpi_pm_end - Finish up suspend sequence.
182 static void acpi_pm_end(void)
185 * This is necessary in case acpi_pm_finish() is not called during a
186 * failing transition to a sleep state.
188 acpi_target_sleep_state
= ACPI_STATE_S0
;
189 acpi_sleep_tts_switch(acpi_target_sleep_state
);
191 #else /* !CONFIG_ACPI_SLEEP */
192 #define acpi_target_sleep_state ACPI_STATE_S0
193 #endif /* CONFIG_ACPI_SLEEP */
195 #ifdef CONFIG_SUSPEND
196 extern void do_suspend_lowlevel(void);
198 static u32 acpi_suspend_states
[] = {
199 [PM_SUSPEND_ON
] = ACPI_STATE_S0
,
200 [PM_SUSPEND_STANDBY
] = ACPI_STATE_S1
,
201 [PM_SUSPEND_MEM
] = ACPI_STATE_S3
,
202 [PM_SUSPEND_MAX
] = ACPI_STATE_S5
206 * acpi_suspend_begin - Set the target system sleep state to the state
207 * associated with given @pm_state, if supported.
209 static int acpi_suspend_begin(suspend_state_t pm_state
)
211 u32 acpi_state
= acpi_suspend_states
[pm_state
];
214 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
218 if (sleep_states
[acpi_state
]) {
219 acpi_target_sleep_state
= acpi_state
;
220 acpi_sleep_tts_switch(acpi_target_sleep_state
);
222 printk(KERN_ERR
"ACPI does not support this state: %d\n",
230 * acpi_suspend_enter - Actually enter a sleep state.
233 * Flush caches and go to sleep. For STR we have to call arch-specific
234 * assembly, which in turn call acpi_enter_sleep_state().
235 * It's unfortunate, but it works. Please fix if you're feeling frisky.
237 static int acpi_suspend_enter(suspend_state_t pm_state
)
239 acpi_status status
= AE_OK
;
240 unsigned long flags
= 0;
241 u32 acpi_state
= acpi_target_sleep_state
;
243 ACPI_FLUSH_CPU_CACHE();
245 /* Do arch specific saving of state. */
246 if (acpi_state
== ACPI_STATE_S3
) {
247 int error
= acpi_save_state_mem();
253 local_irq_save(flags
);
254 acpi_enable_wakeup_device(acpi_state
);
255 switch (acpi_state
) {
258 status
= acpi_enter_sleep_state(acpi_state
);
262 do_suspend_lowlevel();
266 /* This violates the spec but is required for bug compatibility. */
267 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE
, 1);
269 /* Reprogram control registers and execute _BFS */
270 acpi_leave_sleep_state_prep(acpi_state
);
272 /* ACPI 3.0 specs (P62) says that it's the responsibility
273 * of the OSPM to clear the status bit [ implying that the
274 * POWER_BUTTON event should not reach userspace ]
276 if (ACPI_SUCCESS(status
) && (acpi_state
== ACPI_STATE_S3
))
277 acpi_clear_event(ACPI_EVENT_POWER_BUTTON
);
280 * Disable and clear GPE status before interrupt is enabled. Some GPEs
281 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
282 * acpi_leave_sleep_state will reenable specific GPEs later
284 acpi_disable_all_gpes();
285 /* Allow EC transactions to happen. */
286 acpi_ec_unblock_transactions_early();
288 local_irq_restore(flags
);
289 printk(KERN_DEBUG
"Back to C!\n");
291 /* restore processor state */
292 if (acpi_state
== ACPI_STATE_S3
)
293 acpi_restore_state_mem();
295 suspend_nvs_restore();
297 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
300 static void acpi_suspend_finish(void)
305 static int acpi_suspend_state_valid(suspend_state_t pm_state
)
311 case PM_SUSPEND_STANDBY
:
313 acpi_state
= acpi_suspend_states
[pm_state
];
315 return sleep_states
[acpi_state
];
321 static struct platform_suspend_ops acpi_suspend_ops
= {
322 .valid
= acpi_suspend_state_valid
,
323 .begin
= acpi_suspend_begin
,
324 .prepare_late
= acpi_pm_prepare
,
325 .enter
= acpi_suspend_enter
,
326 .wake
= acpi_suspend_finish
,
331 * acpi_suspend_begin_old - Set the target system sleep state to the
332 * state associated with given @pm_state, if supported, and
333 * execute the _PTS control method. This function is used if the
334 * pre-ACPI 2.0 suspend ordering has been requested.
336 static int acpi_suspend_begin_old(suspend_state_t pm_state
)
338 int error
= acpi_suspend_begin(pm_state
);
341 error
= __acpi_pm_prepare();
346 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
349 static struct platform_suspend_ops acpi_suspend_ops_old
= {
350 .valid
= acpi_suspend_state_valid
,
351 .begin
= acpi_suspend_begin_old
,
352 .prepare_late
= acpi_pm_freeze
,
353 .enter
= acpi_suspend_enter
,
354 .wake
= acpi_suspend_finish
,
356 .recover
= acpi_pm_finish
,
359 static int __init
init_old_suspend_ordering(const struct dmi_system_id
*d
)
361 old_suspend_ordering
= true;
365 static int __init
init_nvs_nosave(const struct dmi_system_id
*d
)
371 static struct dmi_system_id __initdata acpisleep_dmi_table
[] = {
373 .callback
= init_old_suspend_ordering
,
374 .ident
= "Abit KN9 (nForce4 variant)",
376 DMI_MATCH(DMI_BOARD_VENDOR
, "http://www.abit.com.tw/"),
377 DMI_MATCH(DMI_BOARD_NAME
, "KN9 Series(NF-CK804)"),
381 .callback
= init_old_suspend_ordering
,
382 .ident
= "HP xw4600 Workstation",
384 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
385 DMI_MATCH(DMI_PRODUCT_NAME
, "HP xw4600 Workstation"),
389 .callback
= init_old_suspend_ordering
,
390 .ident
= "Asus Pundit P1-AH2 (M2N8L motherboard)",
392 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTek Computer INC."),
393 DMI_MATCH(DMI_BOARD_NAME
, "M2N8L"),
397 .callback
= init_old_suspend_ordering
,
398 .ident
= "Panasonic CF51-2L",
400 DMI_MATCH(DMI_BOARD_VENDOR
,
401 "Matsushita Electric Industrial Co.,Ltd."),
402 DMI_MATCH(DMI_BOARD_NAME
, "CF51-2L"),
406 .callback
= init_nvs_nosave
,
407 .ident
= "Sony Vaio VGN-SR11M",
409 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
410 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-SR11M"),
414 .callback
= init_nvs_nosave
,
415 .ident
= "Everex StepNote Series",
417 DMI_MATCH(DMI_SYS_VENDOR
, "Everex Systems, Inc."),
418 DMI_MATCH(DMI_PRODUCT_NAME
, "Everex StepNote Series"),
423 #endif /* CONFIG_SUSPEND */
425 #ifdef CONFIG_HIBERNATION
426 static unsigned long s4_hardware_signature
;
427 static struct acpi_table_facs
*facs
;
428 static bool nosigcheck
;
430 void __init
acpi_no_s4_hw_signature(void)
435 static int acpi_hibernation_begin(void)
439 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
441 acpi_target_sleep_state
= ACPI_STATE_S4
;
442 acpi_sleep_tts_switch(acpi_target_sleep_state
);
448 static int acpi_hibernation_pre_snapshot(void)
450 int error
= acpi_pm_prepare();
458 static int acpi_hibernation_enter(void)
460 acpi_status status
= AE_OK
;
461 unsigned long flags
= 0;
463 ACPI_FLUSH_CPU_CACHE();
465 local_irq_save(flags
);
466 acpi_enable_wakeup_device(ACPI_STATE_S4
);
467 /* This shouldn't return. If it returns, we have a problem */
468 status
= acpi_enter_sleep_state(ACPI_STATE_S4
);
469 /* Reprogram control registers and execute _BFS */
470 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
471 local_irq_restore(flags
);
473 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
476 static void acpi_hibernation_leave(void)
479 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
483 /* Reprogram control registers and execute _BFS */
484 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
485 /* Check the hardware signature */
486 if (facs
&& s4_hardware_signature
!= facs
->hardware_signature
) {
487 printk(KERN_EMERG
"ACPI: Hardware changed while hibernated, "
489 panic("ACPI S4 hardware signature mismatch");
491 /* Restore the NVS memory area */
492 suspend_nvs_restore();
493 /* Allow EC transactions to happen. */
494 acpi_ec_unblock_transactions_early();
497 static void acpi_pm_thaw(void)
499 acpi_ec_unblock_transactions();
500 acpi_enable_all_runtime_gpes();
503 static struct platform_hibernation_ops acpi_hibernation_ops
= {
504 .begin
= acpi_hibernation_begin
,
506 .pre_snapshot
= acpi_hibernation_pre_snapshot
,
507 .finish
= acpi_pm_finish
,
508 .prepare
= acpi_pm_prepare
,
509 .enter
= acpi_hibernation_enter
,
510 .leave
= acpi_hibernation_leave
,
511 .pre_restore
= acpi_pm_freeze
,
512 .restore_cleanup
= acpi_pm_thaw
,
516 * acpi_hibernation_begin_old - Set the target system sleep state to
517 * ACPI_STATE_S4 and execute the _PTS control method. This
518 * function is used if the pre-ACPI 2.0 suspend ordering has been
521 static int acpi_hibernation_begin_old(void)
525 * The _TTS object should always be evaluated before the _PTS object.
526 * When the old_suspended_ordering is true, the _PTS object is
527 * evaluated in the acpi_sleep_prepare.
529 acpi_sleep_tts_switch(ACPI_STATE_S4
);
531 error
= acpi_sleep_prepare(ACPI_STATE_S4
);
535 error
= suspend_nvs_alloc();
537 acpi_target_sleep_state
= ACPI_STATE_S4
;
542 static int acpi_hibernation_pre_snapshot_old(void)
550 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
553 static struct platform_hibernation_ops acpi_hibernation_ops_old
= {
554 .begin
= acpi_hibernation_begin_old
,
556 .pre_snapshot
= acpi_hibernation_pre_snapshot_old
,
557 .prepare
= acpi_pm_freeze
,
558 .finish
= acpi_pm_finish
,
559 .enter
= acpi_hibernation_enter
,
560 .leave
= acpi_hibernation_leave
,
561 .pre_restore
= acpi_pm_freeze
,
562 .restore_cleanup
= acpi_pm_thaw
,
563 .recover
= acpi_pm_finish
,
565 #endif /* CONFIG_HIBERNATION */
567 int acpi_suspend(u32 acpi_state
)
569 suspend_state_t states
[] = {
570 [1] = PM_SUSPEND_STANDBY
,
571 [3] = PM_SUSPEND_MEM
,
575 if (acpi_state
< 6 && states
[acpi_state
])
576 return pm_suspend(states
[acpi_state
]);
582 #ifdef CONFIG_PM_SLEEP
584 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
585 * in the system sleep state given by %acpi_target_sleep_state
586 * @dev: device to examine; its driver model wakeup flags control
587 * whether it should be able to wake up the system
588 * @d_min_p: used to store the upper limit of allowed states range
589 * Return value: preferred power state of the device on success, -ENODEV on
590 * failure (ie. if there's no 'struct acpi_device' for @dev)
592 * Find the lowest power (highest number) ACPI device power state that
593 * device @dev can be in while the system is in the sleep state represented
594 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
595 * able to wake up the system from this sleep state. If @d_min_p is set,
596 * the highest power (lowest number) device power state of @dev allowed
597 * in this system sleep state is stored at the location pointed to by it.
599 * The caller must ensure that @dev is valid before using this function.
600 * The caller is also responsible for figuring out if the device is
601 * supposed to be able to wake up the system and passing this information
605 int acpi_pm_device_sleep_state(struct device
*dev
, int *d_min_p
)
607 acpi_handle handle
= DEVICE_ACPI_HANDLE(dev
);
608 struct acpi_device
*adev
;
609 char acpi_method
[] = "_SxD";
610 unsigned long long d_min
, d_max
;
612 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
613 printk(KERN_DEBUG
"ACPI handle has no context!\n");
617 acpi_method
[2] = '0' + acpi_target_sleep_state
;
619 * If the sleep state is S0, we will return D3, but if the device has
620 * _S0W, we will use the value from _S0W
622 d_min
= ACPI_STATE_D0
;
623 d_max
= ACPI_STATE_D3
;
626 * If present, _SxD methods return the minimum D-state (highest power
627 * state) we can use for the corresponding S-states. Otherwise, the
628 * minimum D-state is D0 (ACPI 3.x).
630 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
631 * provided -- that's our fault recovery, we ignore retval.
633 if (acpi_target_sleep_state
> ACPI_STATE_S0
)
634 acpi_evaluate_integer(handle
, acpi_method
, NULL
, &d_min
);
637 * If _PRW says we can wake up the system from the target sleep state,
638 * the D-state returned by _SxD is sufficient for that (we assume a
639 * wakeup-aware driver if wake is set). Still, if _SxW exists
640 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
641 * can wake the system. _S0W may be valid, too.
643 if (acpi_target_sleep_state
== ACPI_STATE_S0
||
644 (device_may_wakeup(dev
) && adev
->wakeup
.state
.enabled
&&
645 adev
->wakeup
.sleep_state
<= acpi_target_sleep_state
)) {
648 acpi_method
[3] = 'W';
649 status
= acpi_evaluate_integer(handle
, acpi_method
, NULL
,
651 if (ACPI_FAILURE(status
)) {
653 } else if (d_max
< d_min
) {
654 /* Warn the user of the broken DSDT */
655 printk(KERN_WARNING
"ACPI: Wrong value from %s\n",
668 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
669 * capability of given device
670 * @dev: device to handle
671 * @enable: 'true' - enable, 'false' - disable the wake-up capability
673 int acpi_pm_device_sleep_wake(struct device
*dev
, bool enable
)
676 struct acpi_device
*adev
;
679 if (!device_can_wakeup(dev
))
682 handle
= DEVICE_ACPI_HANDLE(dev
);
683 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
684 dev_dbg(dev
, "ACPI handle has no context in %s!\n", __func__
);
689 error
= acpi_enable_wakeup_device_power(adev
,
690 acpi_target_sleep_state
);
692 acpi_enable_gpe(adev
->wakeup
.gpe_device
,
693 adev
->wakeup
.gpe_number
,
696 acpi_disable_gpe(adev
->wakeup
.gpe_device
, adev
->wakeup
.gpe_number
,
698 error
= acpi_disable_wakeup_device_power(adev
);
701 dev_info(dev
, "wake-up capability %s by ACPI\n",
702 enable
? "enabled" : "disabled");
708 static void acpi_power_off_prepare(void)
710 /* Prepare to power off the system */
711 acpi_sleep_prepare(ACPI_STATE_S5
);
712 acpi_disable_all_gpes();
715 static void acpi_power_off(void)
717 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
718 printk(KERN_DEBUG
"%s called\n", __func__
);
720 acpi_enable_wakeup_device(ACPI_STATE_S5
);
721 acpi_enter_sleep_state(ACPI_STATE_S5
);
725 * ACPI 2.0 created the optional _GTS and _BFS,
726 * but industry adoption has been neither rapid nor broad.
728 * Linux gets into trouble when it executes poorly validated
729 * paths through the BIOS, so disable _GTS and _BFS by default,
730 * but do speak up and offer the option to enable them.
732 void __init
acpi_gts_bfs_check(void)
736 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__GTS
, &dummy
)))
738 printk(KERN_NOTICE PREFIX
"BIOS offers _GTS\n");
739 printk(KERN_NOTICE PREFIX
"If \"acpi.gts=1\" improves suspend, "
740 "please notify linux-acpi@vger.kernel.org\n");
742 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__BFS
, &dummy
)))
744 printk(KERN_NOTICE PREFIX
"BIOS offers _BFS\n");
745 printk(KERN_NOTICE PREFIX
"If \"acpi.bfs=1\" improves resume, "
746 "please notify linux-acpi@vger.kernel.org\n");
750 int __init
acpi_sleep_init(void)
754 #ifdef CONFIG_SUSPEND
757 dmi_check_system(acpisleep_dmi_table
);
763 sleep_states
[ACPI_STATE_S0
] = 1;
764 printk(KERN_INFO PREFIX
"(supports S0");
766 #ifdef CONFIG_SUSPEND
767 for (i
= ACPI_STATE_S1
; i
< ACPI_STATE_S4
; i
++) {
768 status
= acpi_get_sleep_type_data(i
, &type_a
, &type_b
);
769 if (ACPI_SUCCESS(status
)) {
775 suspend_set_ops(old_suspend_ordering
?
776 &acpi_suspend_ops_old
: &acpi_suspend_ops
);
779 #ifdef CONFIG_HIBERNATION
780 status
= acpi_get_sleep_type_data(ACPI_STATE_S4
, &type_a
, &type_b
);
781 if (ACPI_SUCCESS(status
)) {
782 hibernation_set_ops(old_suspend_ordering
?
783 &acpi_hibernation_ops_old
: &acpi_hibernation_ops
);
784 sleep_states
[ACPI_STATE_S4
] = 1;
787 acpi_get_table(ACPI_SIG_FACS
, 1,
788 (struct acpi_table_header
**)&facs
);
790 s4_hardware_signature
=
791 facs
->hardware_signature
;
795 status
= acpi_get_sleep_type_data(ACPI_STATE_S5
, &type_a
, &type_b
);
796 if (ACPI_SUCCESS(status
)) {
797 sleep_states
[ACPI_STATE_S5
] = 1;
799 pm_power_off_prepare
= acpi_power_off_prepare
;
800 pm_power_off
= acpi_power_off
;
804 * Register the tts_notifier to reboot notifier list so that the _TTS
805 * object can also be evaluated when the system enters S5.
807 register_reboot_notifier(&tts_notifier
);
808 acpi_gts_bfs_check();