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>
23 #include <acpi/acpi_bus.h>
24 #include <acpi/acpi_drivers.h>
29 static u8 sleep_states
[ACPI_S_STATE_COUNT
];
31 static void acpi_sleep_tts_switch(u32 acpi_state
)
33 union acpi_object in_arg
= { ACPI_TYPE_INTEGER
};
34 struct acpi_object_list arg_list
= { 1, &in_arg
};
35 acpi_status status
= AE_OK
;
37 in_arg
.integer
.value
= acpi_state
;
38 status
= acpi_evaluate_object(NULL
, "\\_TTS", &arg_list
, NULL
);
39 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
41 * OS can't evaluate the _TTS object correctly. Some warning
42 * message will be printed. But it won't break anything.
44 printk(KERN_NOTICE
"Failure in evaluating _TTS object\n");
48 static int tts_notify_reboot(struct notifier_block
*this,
49 unsigned long code
, void *x
)
51 acpi_sleep_tts_switch(ACPI_STATE_S5
);
55 static struct notifier_block tts_notifier
= {
56 .notifier_call
= tts_notify_reboot
,
61 static int acpi_sleep_prepare(u32 acpi_state
)
63 #ifdef CONFIG_ACPI_SLEEP
64 /* do we have a wakeup address for S2 and S3? */
65 if (acpi_state
== ACPI_STATE_S3
) {
66 if (!acpi_wakeup_address
) {
69 acpi_set_firmware_waking_vector(
70 (acpi_physical_address
)acpi_wakeup_address
);
73 ACPI_FLUSH_CPU_CACHE();
75 printk(KERN_INFO PREFIX
"Preparing to enter system sleep state S%d\n",
77 acpi_enable_wakeup_devices(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 * The ACPI specification wants us to save NVS memory regions during hibernation
87 * and to restore them during the subsequent resume. Windows does that also for
88 * suspend to RAM. However, it is known that this mechanism does not work on
89 * all machines, so we allow the user to disable it with the help of the
90 * 'acpi_sleep=nonvs' kernel command line option.
92 static bool nvs_nosave
;
94 void __init
acpi_nvs_nosave(void)
100 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
101 * user to request that behavior by using the 'acpi_old_suspend_ordering'
102 * kernel command line option that causes the following variable to be set.
104 static bool old_suspend_ordering
;
106 void __init
acpi_old_suspend_ordering(void)
108 old_suspend_ordering
= true;
112 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
114 static int acpi_pm_freeze(void)
116 acpi_disable_all_gpes();
117 acpi_os_wait_events_complete(NULL
);
118 acpi_ec_block_transactions();
123 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
125 static int acpi_pm_pre_suspend(void)
128 return suspend_nvs_save();
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 error
= 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();
172 if (acpi_state
== ACPI_STATE_S0
)
175 printk(KERN_INFO PREFIX
"Waking up from system sleep state S%d\n",
177 acpi_disable_wakeup_devices(acpi_state
);
178 acpi_leave_sleep_state(acpi_state
);
180 /* reset firmware waking vector */
181 acpi_set_firmware_waking_vector((acpi_physical_address
) 0);
183 acpi_target_sleep_state
= ACPI_STATE_S0
;
187 * acpi_pm_end - Finish up suspend sequence.
189 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 static u32 acpi_suspend_states
[] = {
204 [PM_SUSPEND_ON
] = ACPI_STATE_S0
,
205 [PM_SUSPEND_STANDBY
] = ACPI_STATE_S1
,
206 [PM_SUSPEND_MEM
] = ACPI_STATE_S3
,
207 [PM_SUSPEND_MAX
] = ACPI_STATE_S5
211 * acpi_suspend_begin - Set the target system sleep state to the state
212 * associated with given @pm_state, if supported.
214 static int acpi_suspend_begin(suspend_state_t pm_state
)
216 u32 acpi_state
= acpi_suspend_states
[pm_state
];
219 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
223 if (sleep_states
[acpi_state
]) {
224 acpi_target_sleep_state
= acpi_state
;
225 acpi_sleep_tts_switch(acpi_target_sleep_state
);
227 printk(KERN_ERR
"ACPI does not support this state: %d\n",
235 * acpi_suspend_enter - Actually enter a sleep state.
238 * Flush caches and go to sleep. For STR we have to call arch-specific
239 * assembly, which in turn call acpi_enter_sleep_state().
240 * It's unfortunate, but it works. Please fix if you're feeling frisky.
242 static int acpi_suspend_enter(suspend_state_t pm_state
)
244 acpi_status status
= AE_OK
;
245 u32 acpi_state
= acpi_target_sleep_state
;
248 ACPI_FLUSH_CPU_CACHE();
250 switch (acpi_state
) {
253 status
= acpi_enter_sleep_state(acpi_state
);
257 error
= acpi_suspend_lowlevel();
260 pr_info(PREFIX
"Low-level resume complete\n");
264 /* This violates the spec but is required for bug compatibility. */
265 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE
, 1);
267 /* Reprogram control registers and execute _BFS */
268 acpi_leave_sleep_state_prep(acpi_state
);
270 /* ACPI 3.0 specs (P62) says that it's the responsibility
271 * of the OSPM to clear the status bit [ implying that the
272 * POWER_BUTTON event should not reach userspace ]
274 if (ACPI_SUCCESS(status
) && (acpi_state
== ACPI_STATE_S3
))
275 acpi_clear_event(ACPI_EVENT_POWER_BUTTON
);
278 * Disable and clear GPE status before interrupt is enabled. Some GPEs
279 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
280 * acpi_leave_sleep_state will reenable specific GPEs later
282 acpi_disable_all_gpes();
283 /* Allow EC transactions to happen. */
284 acpi_ec_unblock_transactions_early();
286 suspend_nvs_restore();
288 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
291 static int acpi_suspend_state_valid(suspend_state_t pm_state
)
297 case PM_SUSPEND_STANDBY
:
299 acpi_state
= acpi_suspend_states
[pm_state
];
301 return sleep_states
[acpi_state
];
307 static const struct platform_suspend_ops acpi_suspend_ops
= {
308 .valid
= acpi_suspend_state_valid
,
309 .begin
= acpi_suspend_begin
,
310 .prepare_late
= acpi_pm_prepare
,
311 .enter
= acpi_suspend_enter
,
312 .wake
= acpi_pm_finish
,
317 * acpi_suspend_begin_old - Set the target system sleep state to the
318 * state associated with given @pm_state, if supported, and
319 * execute the _PTS control method. This function is used if the
320 * pre-ACPI 2.0 suspend ordering has been requested.
322 static int acpi_suspend_begin_old(suspend_state_t pm_state
)
324 int error
= acpi_suspend_begin(pm_state
);
326 error
= __acpi_pm_prepare();
332 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
335 static const struct platform_suspend_ops acpi_suspend_ops_old
= {
336 .valid
= acpi_suspend_state_valid
,
337 .begin
= acpi_suspend_begin_old
,
338 .prepare_late
= acpi_pm_pre_suspend
,
339 .enter
= acpi_suspend_enter
,
340 .wake
= acpi_pm_finish
,
342 .recover
= acpi_pm_finish
,
345 static int __init
init_old_suspend_ordering(const struct dmi_system_id
*d
)
347 old_suspend_ordering
= true;
351 static int __init
init_nvs_nosave(const struct dmi_system_id
*d
)
357 static struct dmi_system_id __initdata acpisleep_dmi_table
[] = {
359 .callback
= init_old_suspend_ordering
,
360 .ident
= "Abit KN9 (nForce4 variant)",
362 DMI_MATCH(DMI_BOARD_VENDOR
, "http://www.abit.com.tw/"),
363 DMI_MATCH(DMI_BOARD_NAME
, "KN9 Series(NF-CK804)"),
367 .callback
= init_old_suspend_ordering
,
368 .ident
= "HP xw4600 Workstation",
370 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
371 DMI_MATCH(DMI_PRODUCT_NAME
, "HP xw4600 Workstation"),
375 .callback
= init_old_suspend_ordering
,
376 .ident
= "Asus Pundit P1-AH2 (M2N8L motherboard)",
378 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTek Computer INC."),
379 DMI_MATCH(DMI_BOARD_NAME
, "M2N8L"),
383 .callback
= init_old_suspend_ordering
,
384 .ident
= "Panasonic CF51-2L",
386 DMI_MATCH(DMI_BOARD_VENDOR
,
387 "Matsushita Electric Industrial Co.,Ltd."),
388 DMI_MATCH(DMI_BOARD_NAME
, "CF51-2L"),
392 .callback
= init_nvs_nosave
,
393 .ident
= "Sony Vaio VGN-SR11M",
395 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
396 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-SR11M"),
400 .callback
= init_nvs_nosave
,
401 .ident
= "Everex StepNote Series",
403 DMI_MATCH(DMI_SYS_VENDOR
, "Everex Systems, Inc."),
404 DMI_MATCH(DMI_PRODUCT_NAME
, "Everex StepNote Series"),
408 .callback
= init_nvs_nosave
,
409 .ident
= "Sony Vaio VPCEB1Z1E",
411 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
412 DMI_MATCH(DMI_PRODUCT_NAME
, "VPCEB1Z1E"),
416 .callback
= init_nvs_nosave
,
417 .ident
= "Sony Vaio VGN-NW130D",
419 DMI_MATCH(DMI_SYS_VENDOR
, "Sony Corporation"),
420 DMI_MATCH(DMI_PRODUCT_NAME
, "VGN-NW130D"),
424 .callback
= init_nvs_nosave
,
425 .ident
= "Averatec AV1020-ED2",
427 DMI_MATCH(DMI_SYS_VENDOR
, "AVERATEC"),
428 DMI_MATCH(DMI_PRODUCT_NAME
, "1000 Series"),
433 #endif /* CONFIG_SUSPEND */
435 #ifdef CONFIG_HIBERNATION
436 static unsigned long s4_hardware_signature
;
437 static struct acpi_table_facs
*facs
;
438 static bool nosigcheck
;
440 void __init
acpi_no_s4_hw_signature(void)
445 static int acpi_hibernation_begin(void)
449 error
= nvs_nosave
? 0 : suspend_nvs_alloc();
451 acpi_target_sleep_state
= ACPI_STATE_S4
;
452 acpi_sleep_tts_switch(acpi_target_sleep_state
);
458 static int acpi_hibernation_enter(void)
460 acpi_status status
= AE_OK
;
462 ACPI_FLUSH_CPU_CACHE();
464 /* This shouldn't return. If it returns, we have a problem */
465 status
= acpi_enter_sleep_state(ACPI_STATE_S4
);
466 /* Reprogram control registers and execute _BFS */
467 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
469 return ACPI_SUCCESS(status
) ? 0 : -EFAULT
;
472 static void acpi_hibernation_leave(void)
475 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
479 /* Reprogram control registers and execute _BFS */
480 acpi_leave_sleep_state_prep(ACPI_STATE_S4
);
481 /* Check the hardware signature */
482 if (facs
&& s4_hardware_signature
!= facs
->hardware_signature
) {
483 printk(KERN_EMERG
"ACPI: Hardware changed while hibernated, "
485 panic("ACPI S4 hardware signature mismatch");
487 /* Restore the NVS memory area */
488 suspend_nvs_restore();
489 /* Allow EC transactions to happen. */
490 acpi_ec_unblock_transactions_early();
493 static void acpi_pm_thaw(void)
495 acpi_ec_unblock_transactions();
496 acpi_enable_all_runtime_gpes();
499 static const struct platform_hibernation_ops acpi_hibernation_ops
= {
500 .begin
= acpi_hibernation_begin
,
502 .pre_snapshot
= acpi_pm_prepare
,
503 .finish
= acpi_pm_finish
,
504 .prepare
= acpi_pm_prepare
,
505 .enter
= acpi_hibernation_enter
,
506 .leave
= acpi_hibernation_leave
,
507 .pre_restore
= acpi_pm_freeze
,
508 .restore_cleanup
= acpi_pm_thaw
,
512 * acpi_hibernation_begin_old - Set the target system sleep state to
513 * ACPI_STATE_S4 and execute the _PTS control method. This
514 * function is used if the pre-ACPI 2.0 suspend ordering has been
517 static int acpi_hibernation_begin_old(void)
521 * The _TTS object should always be evaluated before the _PTS object.
522 * When the old_suspended_ordering is true, the _PTS object is
523 * evaluated in the acpi_sleep_prepare.
525 acpi_sleep_tts_switch(ACPI_STATE_S4
);
527 error
= acpi_sleep_prepare(ACPI_STATE_S4
);
531 error
= suspend_nvs_alloc();
533 acpi_target_sleep_state
= ACPI_STATE_S4
;
539 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
542 static const struct platform_hibernation_ops acpi_hibernation_ops_old
= {
543 .begin
= acpi_hibernation_begin_old
,
545 .pre_snapshot
= acpi_pm_pre_suspend
,
546 .prepare
= acpi_pm_freeze
,
547 .finish
= acpi_pm_finish
,
548 .enter
= acpi_hibernation_enter
,
549 .leave
= acpi_hibernation_leave
,
550 .pre_restore
= acpi_pm_freeze
,
551 .restore_cleanup
= acpi_pm_thaw
,
552 .recover
= acpi_pm_finish
,
554 #endif /* CONFIG_HIBERNATION */
556 int acpi_suspend(u32 acpi_state
)
558 suspend_state_t states
[] = {
559 [1] = PM_SUSPEND_STANDBY
,
560 [3] = PM_SUSPEND_MEM
,
564 if (acpi_state
< 6 && states
[acpi_state
])
565 return pm_suspend(states
[acpi_state
]);
573 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
574 * in the system sleep state given by %acpi_target_sleep_state
575 * @dev: device to examine; its driver model wakeup flags control
576 * whether it should be able to wake up the system
577 * @d_min_p: used to store the upper limit of allowed states range
578 * Return value: preferred power state of the device on success, -ENODEV on
579 * failure (ie. if there's no 'struct acpi_device' for @dev)
581 * Find the lowest power (highest number) ACPI device power state that
582 * device @dev can be in while the system is in the sleep state represented
583 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
584 * able to wake up the system from this sleep state. If @d_min_p is set,
585 * the highest power (lowest number) device power state of @dev allowed
586 * in this system sleep state is stored at the location pointed to by it.
588 * The caller must ensure that @dev is valid before using this function.
589 * The caller is also responsible for figuring out if the device is
590 * supposed to be able to wake up the system and passing this information
594 int acpi_pm_device_sleep_state(struct device
*dev
, int *d_min_p
)
596 acpi_handle handle
= DEVICE_ACPI_HANDLE(dev
);
597 struct acpi_device
*adev
;
598 char acpi_method
[] = "_SxD";
599 unsigned long long d_min
, d_max
;
601 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
602 printk(KERN_DEBUG
"ACPI handle has no context!\n");
606 acpi_method
[2] = '0' + acpi_target_sleep_state
;
608 * If the sleep state is S0, we will return D3, but if the device has
609 * _S0W, we will use the value from _S0W
611 d_min
= ACPI_STATE_D0
;
612 d_max
= ACPI_STATE_D3
;
615 * If present, _SxD methods return the minimum D-state (highest power
616 * state) we can use for the corresponding S-states. Otherwise, the
617 * minimum D-state is D0 (ACPI 3.x).
619 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
620 * provided -- that's our fault recovery, we ignore retval.
622 if (acpi_target_sleep_state
> ACPI_STATE_S0
)
623 acpi_evaluate_integer(handle
, acpi_method
, NULL
, &d_min
);
626 * If _PRW says we can wake up the system from the target sleep state,
627 * the D-state returned by _SxD is sufficient for that (we assume a
628 * wakeup-aware driver if wake is set). Still, if _SxW exists
629 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
630 * can wake the system. _S0W may be valid, too.
632 if (acpi_target_sleep_state
== ACPI_STATE_S0
||
633 (device_may_wakeup(dev
) &&
634 adev
->wakeup
.sleep_state
<= acpi_target_sleep_state
)) {
637 acpi_method
[3] = 'W';
638 status
= acpi_evaluate_integer(handle
, acpi_method
, NULL
,
640 if (ACPI_FAILURE(status
)) {
641 if (acpi_target_sleep_state
!= ACPI_STATE_S0
||
642 status
!= AE_NOT_FOUND
)
644 } else if (d_max
< d_min
) {
645 /* Warn the user of the broken DSDT */
646 printk(KERN_WARNING
"ACPI: Wrong value from %s\n",
657 #endif /* CONFIG_PM */
659 #ifdef CONFIG_PM_SLEEP
661 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
662 * capability of given device
663 * @dev: device to handle
664 * @enable: 'true' - enable, 'false' - disable the wake-up capability
666 int acpi_pm_device_sleep_wake(struct device
*dev
, bool enable
)
669 struct acpi_device
*adev
;
672 if (!device_can_wakeup(dev
))
675 handle
= DEVICE_ACPI_HANDLE(dev
);
676 if (!handle
|| ACPI_FAILURE(acpi_bus_get_device(handle
, &adev
))) {
677 dev_dbg(dev
, "ACPI handle has no context in %s!\n", __func__
);
682 acpi_enable_wakeup_device_power(adev
, acpi_target_sleep_state
) :
683 acpi_disable_wakeup_device_power(adev
);
685 dev_info(dev
, "wake-up capability %s by ACPI\n",
686 enable
? "enabled" : "disabled");
690 #endif /* CONFIG_PM_SLEEP */
692 static void acpi_power_off_prepare(void)
694 /* Prepare to power off the system */
695 acpi_sleep_prepare(ACPI_STATE_S5
);
696 acpi_disable_all_gpes();
699 static void acpi_power_off(void)
701 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
702 printk(KERN_DEBUG
"%s called\n", __func__
);
704 acpi_enter_sleep_state(ACPI_STATE_S5
);
708 * ACPI 2.0 created the optional _GTS and _BFS,
709 * but industry adoption has been neither rapid nor broad.
711 * Linux gets into trouble when it executes poorly validated
712 * paths through the BIOS, so disable _GTS and _BFS by default,
713 * but do speak up and offer the option to enable them.
715 static void __init
acpi_gts_bfs_check(void)
719 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__GTS
, &dummy
)))
721 printk(KERN_NOTICE PREFIX
"BIOS offers _GTS\n");
722 printk(KERN_NOTICE PREFIX
"If \"acpi.gts=1\" improves suspend, "
723 "please notify linux-acpi@vger.kernel.org\n");
725 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT
, METHOD_NAME__BFS
, &dummy
)))
727 printk(KERN_NOTICE PREFIX
"BIOS offers _BFS\n");
728 printk(KERN_NOTICE PREFIX
"If \"acpi.bfs=1\" improves resume, "
729 "please notify linux-acpi@vger.kernel.org\n");
733 int __init
acpi_sleep_init(void)
737 #ifdef CONFIG_SUSPEND
740 dmi_check_system(acpisleep_dmi_table
);
746 sleep_states
[ACPI_STATE_S0
] = 1;
747 printk(KERN_INFO PREFIX
"(supports S0");
749 #ifdef CONFIG_SUSPEND
750 for (i
= ACPI_STATE_S1
; i
< ACPI_STATE_S4
; i
++) {
751 status
= acpi_get_sleep_type_data(i
, &type_a
, &type_b
);
752 if (ACPI_SUCCESS(status
)) {
758 suspend_set_ops(old_suspend_ordering
?
759 &acpi_suspend_ops_old
: &acpi_suspend_ops
);
762 #ifdef CONFIG_HIBERNATION
763 status
= acpi_get_sleep_type_data(ACPI_STATE_S4
, &type_a
, &type_b
);
764 if (ACPI_SUCCESS(status
)) {
765 hibernation_set_ops(old_suspend_ordering
?
766 &acpi_hibernation_ops_old
: &acpi_hibernation_ops
);
767 sleep_states
[ACPI_STATE_S4
] = 1;
770 acpi_get_table(ACPI_SIG_FACS
, 1,
771 (struct acpi_table_header
**)&facs
);
773 s4_hardware_signature
=
774 facs
->hardware_signature
;
778 status
= acpi_get_sleep_type_data(ACPI_STATE_S5
, &type_a
, &type_b
);
779 if (ACPI_SUCCESS(status
)) {
780 sleep_states
[ACPI_STATE_S5
] = 1;
782 pm_power_off_prepare
= acpi_power_off_prepare
;
783 pm_power_off
= acpi_power_off
;
787 * Register the tts_notifier to reboot notifier list so that the _TTS
788 * object can also be evaluated when the system enters S5.
790 register_reboot_notifier(&tts_notifier
);
791 acpi_gts_bfs_check();