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>
21 #include <acpi/acpi_bus.h>
22 #include <acpi/acpi_drivers.h>
25 u8 sleep_states[ACPI_S_STATE_COUNT];
27 static int acpi_sleep_prepare(u32 acpi_state)
29 #ifdef CONFIG_ACPI_SLEEP
30 /* do we have a wakeup address for S2 and S3? */
31 if (acpi_state == ACPI_STATE_S3) {
32 if (!acpi_wakeup_address) {
35 acpi_set_firmware_waking_vector(
36 (acpi_physical_address)acpi_wakeup_address);
39 ACPI_FLUSH_CPU_CACHE();
40 acpi_enable_wakeup_device_prep(acpi_state);
42 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
44 acpi_enter_sleep_state_prep(acpi_state);
48 #ifdef CONFIG_PM_SLEEP
49 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
52 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
53 * user to request that behavior by using the 'acpi_old_suspend_ordering'
54 * kernel command line option that causes the following variable to be set.
56 static bool old_suspend_ordering;
58 void __init acpi_old_suspend_ordering(void)
60 old_suspend_ordering = true;
64 * acpi_pm_disable_gpes - Disable the GPEs.
66 static int acpi_pm_disable_gpes(void)
68 acpi_hw_disable_all_gpes();
73 * __acpi_pm_prepare - Prepare the platform to enter the target state.
75 * If necessary, set the firmware waking vector and do arch-specific
76 * nastiness to get the wakeup code to the waking vector.
78 static int __acpi_pm_prepare(void)
80 int error = acpi_sleep_prepare(acpi_target_sleep_state);
83 acpi_target_sleep_state = ACPI_STATE_S0;
88 * acpi_pm_prepare - Prepare the platform to enter the target sleep
89 * state and disable the GPEs.
91 static int acpi_pm_prepare(void)
93 int error = __acpi_pm_prepare();
96 acpi_hw_disable_all_gpes();
101 * acpi_pm_finish - Instruct the platform to leave a sleep state.
103 * This is called after we wake back up (or if entering the sleep state
106 static void acpi_pm_finish(void)
108 u32 acpi_state = acpi_target_sleep_state;
110 if (acpi_state == ACPI_STATE_S0)
113 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
115 acpi_disable_wakeup_device(acpi_state);
116 acpi_leave_sleep_state(acpi_state);
118 /* reset firmware waking vector */
119 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
121 acpi_target_sleep_state = ACPI_STATE_S0;
125 * acpi_pm_end - Finish up suspend sequence.
127 static void acpi_pm_end(void)
130 * This is necessary in case acpi_pm_finish() is not called during a
131 * failing transition to a sleep state.
133 acpi_target_sleep_state = ACPI_STATE_S0;
135 #endif /* CONFIG_PM_SLEEP */
137 #ifdef CONFIG_SUSPEND
138 extern void do_suspend_lowlevel(void);
140 static u32 acpi_suspend_states[] = {
141 [PM_SUSPEND_ON] = ACPI_STATE_S0,
142 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
143 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
144 [PM_SUSPEND_MAX] = ACPI_STATE_S5
148 * acpi_suspend_begin - Set the target system sleep state to the state
149 * associated with given @pm_state, if supported.
151 static int acpi_suspend_begin(suspend_state_t pm_state)
153 u32 acpi_state = acpi_suspend_states[pm_state];
156 if (sleep_states[acpi_state]) {
157 acpi_target_sleep_state = acpi_state;
159 printk(KERN_ERR "ACPI does not support this state: %d\n",
167 * acpi_suspend_enter - Actually enter a sleep state.
170 * Flush caches and go to sleep. For STR we have to call arch-specific
171 * assembly, which in turn call acpi_enter_sleep_state().
172 * It's unfortunate, but it works. Please fix if you're feeling frisky.
174 static int acpi_suspend_enter(suspend_state_t pm_state)
176 acpi_status status = AE_OK;
177 unsigned long flags = 0;
178 u32 acpi_state = acpi_target_sleep_state;
180 ACPI_FLUSH_CPU_CACHE();
182 /* Do arch specific saving of state. */
183 if (acpi_state == ACPI_STATE_S3) {
184 int error = acpi_save_state_mem();
190 local_irq_save(flags);
191 acpi_enable_wakeup_device(acpi_state);
192 switch (acpi_state) {
195 status = acpi_enter_sleep_state(acpi_state);
199 do_suspend_lowlevel();
203 /* Reprogram control registers and execute _BFS */
204 acpi_leave_sleep_state_prep(acpi_state);
206 /* ACPI 3.0 specs (P62) says that it's the responsibility
207 * of the OSPM to clear the status bit [ implying that the
208 * POWER_BUTTON event should not reach userspace ]
210 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
211 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
214 * Disable and clear GPE status before interrupt is enabled. Some GPEs
215 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
216 * acpi_leave_sleep_state will reenable specific GPEs later
218 acpi_hw_disable_all_gpes();
220 local_irq_restore(flags);
221 printk(KERN_DEBUG "Back to C!\n");
223 /* restore processor state */
224 if (acpi_state == ACPI_STATE_S3)
225 acpi_restore_state_mem();
227 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
230 static int acpi_suspend_state_valid(suspend_state_t pm_state)
236 case PM_SUSPEND_STANDBY:
238 acpi_state = acpi_suspend_states[pm_state];
240 return sleep_states[acpi_state];
246 static struct platform_suspend_ops acpi_suspend_ops = {
247 .valid = acpi_suspend_state_valid,
248 .begin = acpi_suspend_begin,
249 .prepare = acpi_pm_prepare,
250 .enter = acpi_suspend_enter,
251 .finish = acpi_pm_finish,
256 * acpi_suspend_begin_old - Set the target system sleep state to the
257 * state associated with given @pm_state, if supported, and
258 * execute the _PTS control method. This function is used if the
259 * pre-ACPI 2.0 suspend ordering has been requested.
261 static int acpi_suspend_begin_old(suspend_state_t pm_state)
263 int error = acpi_suspend_begin(pm_state);
266 error = __acpi_pm_prepare();
271 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
274 static struct platform_suspend_ops acpi_suspend_ops_old = {
275 .valid = acpi_suspend_state_valid,
276 .begin = acpi_suspend_begin_old,
277 .prepare = acpi_pm_disable_gpes,
278 .enter = acpi_suspend_enter,
279 .finish = acpi_pm_finish,
281 .recover = acpi_pm_finish,
284 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
286 old_suspend_ordering = true;
290 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
292 .callback = init_old_suspend_ordering,
293 .ident = "Abit KN9 (nForce4 variant)",
295 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
296 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
301 #endif /* CONFIG_SUSPEND */
303 #ifdef CONFIG_HIBERNATION
304 static unsigned long s4_hardware_signature;
305 static struct acpi_table_facs *facs;
306 static bool nosigcheck;
308 void __init acpi_no_s4_hw_signature(void)
313 static int acpi_hibernation_begin(void)
315 acpi_target_sleep_state = ACPI_STATE_S4;
319 static int acpi_hibernation_enter(void)
321 acpi_status status = AE_OK;
322 unsigned long flags = 0;
324 ACPI_FLUSH_CPU_CACHE();
326 local_irq_save(flags);
327 acpi_enable_wakeup_device(ACPI_STATE_S4);
328 /* This shouldn't return. If it returns, we have a problem */
329 status = acpi_enter_sleep_state(ACPI_STATE_S4);
330 /* Reprogram control registers and execute _BFS */
331 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
332 local_irq_restore(flags);
334 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
337 static void acpi_hibernation_leave(void)
340 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
344 /* Reprogram control registers and execute _BFS */
345 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
346 /* Check the hardware signature */
347 if (facs && s4_hardware_signature != facs->hardware_signature) {
348 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
350 panic("ACPI S4 hardware signature mismatch");
354 static void acpi_pm_enable_gpes(void)
356 acpi_hw_enable_all_runtime_gpes();
359 static struct platform_hibernation_ops acpi_hibernation_ops = {
360 .begin = acpi_hibernation_begin,
362 .pre_snapshot = acpi_pm_prepare,
363 .finish = acpi_pm_finish,
364 .prepare = acpi_pm_prepare,
365 .enter = acpi_hibernation_enter,
366 .leave = acpi_hibernation_leave,
367 .pre_restore = acpi_pm_disable_gpes,
368 .restore_cleanup = acpi_pm_enable_gpes,
372 * acpi_hibernation_begin_old - Set the target system sleep state to
373 * ACPI_STATE_S4 and execute the _PTS control method. This
374 * function is used if the pre-ACPI 2.0 suspend ordering has been
377 static int acpi_hibernation_begin_old(void)
379 int error = acpi_sleep_prepare(ACPI_STATE_S4);
382 acpi_target_sleep_state = ACPI_STATE_S4;
387 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
390 static struct platform_hibernation_ops acpi_hibernation_ops_old = {
391 .begin = acpi_hibernation_begin_old,
393 .pre_snapshot = acpi_pm_disable_gpes,
394 .finish = acpi_pm_finish,
395 .prepare = acpi_pm_disable_gpes,
396 .enter = acpi_hibernation_enter,
397 .leave = acpi_hibernation_leave,
398 .pre_restore = acpi_pm_disable_gpes,
399 .restore_cleanup = acpi_pm_enable_gpes,
400 .recover = acpi_pm_finish,
402 #endif /* CONFIG_HIBERNATION */
404 int acpi_suspend(u32 acpi_state)
406 suspend_state_t states[] = {
407 [1] = PM_SUSPEND_STANDBY,
408 [3] = PM_SUSPEND_MEM,
412 if (acpi_state < 6 && states[acpi_state])
413 return pm_suspend(states[acpi_state]);
419 #ifdef CONFIG_PM_SLEEP
421 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
422 * in the system sleep state given by %acpi_target_sleep_state
423 * @dev: device to examine; its driver model wakeup flags control
424 * whether it should be able to wake up the system
425 * @d_min_p: used to store the upper limit of allowed states range
426 * Return value: preferred power state of the device on success, -ENODEV on
427 * failure (ie. if there's no 'struct acpi_device' for @dev)
429 * Find the lowest power (highest number) ACPI device power state that
430 * device @dev can be in while the system is in the sleep state represented
431 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
432 * able to wake up the system from this sleep state. If @d_min_p is set,
433 * the highest power (lowest number) device power state of @dev allowed
434 * in this system sleep state is stored at the location pointed to by it.
436 * The caller must ensure that @dev is valid before using this function.
437 * The caller is also responsible for figuring out if the device is
438 * supposed to be able to wake up the system and passing this information
442 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
444 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
445 struct acpi_device *adev;
446 char acpi_method[] = "_SxD";
447 unsigned long long d_min, d_max;
449 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
450 printk(KERN_DEBUG "ACPI handle has no context!\n");
454 acpi_method[2] = '0' + acpi_target_sleep_state;
456 * If the sleep state is S0, we will return D3, but if the device has
457 * _S0W, we will use the value from _S0W
459 d_min = ACPI_STATE_D0;
460 d_max = ACPI_STATE_D3;
463 * If present, _SxD methods return the minimum D-state (highest power
464 * state) we can use for the corresponding S-states. Otherwise, the
465 * minimum D-state is D0 (ACPI 3.x).
467 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
468 * provided -- that's our fault recovery, we ignore retval.
470 if (acpi_target_sleep_state > ACPI_STATE_S0)
471 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
474 * If _PRW says we can wake up the system from the target sleep state,
475 * the D-state returned by _SxD is sufficient for that (we assume a
476 * wakeup-aware driver if wake is set). Still, if _SxW exists
477 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
478 * can wake the system. _S0W may be valid, too.
480 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
481 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
482 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
485 acpi_method[3] = 'W';
486 status = acpi_evaluate_integer(handle, acpi_method, NULL,
488 if (ACPI_FAILURE(status)) {
490 } else if (d_max < d_min) {
491 /* Warn the user of the broken DSDT */
492 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
505 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
506 * capability of given device
507 * @dev: device to handle
508 * @enable: 'true' - enable, 'false' - disable the wake-up capability
510 int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
513 struct acpi_device *adev;
515 if (!device_may_wakeup(dev))
518 handle = DEVICE_ACPI_HANDLE(dev);
519 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
520 printk(KERN_DEBUG "ACPI handle has no context!\n");
525 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
526 acpi_disable_wakeup_device_power(adev);
530 static void acpi_power_off_prepare(void)
532 /* Prepare to power off the system */
533 acpi_sleep_prepare(ACPI_STATE_S5);
534 acpi_hw_disable_all_gpes();
537 static void acpi_power_off(void)
539 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
540 printk("%s called\n", __func__);
542 acpi_enable_wakeup_device(ACPI_STATE_S5);
543 acpi_enter_sleep_state(ACPI_STATE_S5);
546 int __init acpi_sleep_init(void)
550 #ifdef CONFIG_SUSPEND
553 dmi_check_system(acpisleep_dmi_table);
559 sleep_states[ACPI_STATE_S0] = 1;
560 printk(KERN_INFO PREFIX "(supports S0");
562 #ifdef CONFIG_SUSPEND
563 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
564 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
565 if (ACPI_SUCCESS(status)) {
571 suspend_set_ops(old_suspend_ordering ?
572 &acpi_suspend_ops_old : &acpi_suspend_ops);
575 #ifdef CONFIG_HIBERNATION
576 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
577 if (ACPI_SUCCESS(status)) {
578 hibernation_set_ops(old_suspend_ordering ?
579 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
580 sleep_states[ACPI_STATE_S4] = 1;
583 acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS,
584 (struct acpi_table_header **)&facs);
586 s4_hardware_signature =
587 facs->hardware_signature;
591 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
592 if (ACPI_SUCCESS(status)) {
593 sleep_states[ACPI_STATE_S5] = 1;
595 pm_power_off_prepare = acpi_power_off_prepare;
596 pm_power_off = acpi_power_off;