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 #ifdef CONFIG_PM_SLEEP
28 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
31 int acpi_sleep_prepare(u32 acpi_state)
33 #ifdef CONFIG_ACPI_SLEEP
34 /* do we have a wakeup address for S2 and S3? */
35 if (acpi_state == ACPI_STATE_S3) {
36 if (!acpi_wakeup_address) {
39 acpi_set_firmware_waking_vector((acpi_physical_address)
41 acpi_wakeup_address));
44 ACPI_FLUSH_CPU_CACHE();
45 acpi_enable_wakeup_device_prep(acpi_state);
47 acpi_enter_sleep_state_prep(acpi_state);
52 static struct platform_suspend_ops acpi_pm_ops;
54 extern void do_suspend_lowlevel(void);
56 static u32 acpi_suspend_states[] = {
57 [PM_SUSPEND_ON] = ACPI_STATE_S0,
58 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
59 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
60 [PM_SUSPEND_MAX] = ACPI_STATE_S5
63 static int init_8259A_after_S1;
66 * acpi_pm_begin - Set the target system sleep state to the state
67 * associated with given @pm_state, if supported.
70 static int acpi_pm_begin(suspend_state_t pm_state)
72 u32 acpi_state = acpi_suspend_states[pm_state];
75 if (sleep_states[acpi_state]) {
76 acpi_target_sleep_state = acpi_state;
78 printk(KERN_ERR "ACPI does not support this state: %d\n",
86 * acpi_pm_prepare - Do preliminary suspend work.
88 * If necessary, set the firmware waking vector and do arch-specific
89 * nastiness to get the wakeup code to the waking vector.
92 static int acpi_pm_prepare(void)
94 int error = acpi_sleep_prepare(acpi_target_sleep_state);
97 acpi_target_sleep_state = ACPI_STATE_S0;
103 * acpi_pm_enter - Actually enter a sleep state.
106 * Flush caches and go to sleep. For STR we have to call arch-specific
107 * assembly, which in turn call acpi_enter_sleep_state().
108 * It's unfortunate, but it works. Please fix if you're feeling frisky.
111 static int acpi_pm_enter(suspend_state_t pm_state)
113 acpi_status status = AE_OK;
114 unsigned long flags = 0;
115 u32 acpi_state = acpi_target_sleep_state;
117 ACPI_FLUSH_CPU_CACHE();
119 /* Do arch specific saving of state. */
120 if (acpi_state == ACPI_STATE_S3) {
121 int error = acpi_save_state_mem();
124 acpi_target_sleep_state = ACPI_STATE_S0;
129 local_irq_save(flags);
130 acpi_enable_wakeup_device(acpi_state);
131 switch (acpi_state) {
134 status = acpi_enter_sleep_state(acpi_state);
138 do_suspend_lowlevel();
142 /* ACPI 3.0 specs (P62) says that it's the responsabilty
143 * of the OSPM to clear the status bit [ implying that the
144 * POWER_BUTTON event should not reach userspace ]
146 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
147 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
150 * Disable and clear GPE status before interrupt is enabled. Some GPEs
151 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
152 * acpi_leave_sleep_state will reenable specific GPEs later
154 acpi_hw_disable_all_gpes();
156 local_irq_restore(flags);
157 printk(KERN_DEBUG "Back to C!\n");
159 /* restore processor state */
160 if (acpi_state == ACPI_STATE_S3)
161 acpi_restore_state_mem();
163 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
167 * acpi_pm_finish - Instruct the platform to leave a sleep state.
169 * This is called after we wake back up (or if entering the sleep state
173 static void acpi_pm_finish(void)
175 u32 acpi_state = acpi_target_sleep_state;
177 acpi_disable_wakeup_device(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;
186 if (init_8259A_after_S1) {
187 printk("Broken toshiba laptop -> kicking interrupts\n");
194 * acpi_pm_end - Finish up suspend sequence.
197 static void acpi_pm_end(void)
200 * This is necessary in case acpi_pm_finish() is not called during a
201 * failing transition to a sleep state.
203 acpi_target_sleep_state = ACPI_STATE_S0;
206 static int acpi_pm_state_valid(suspend_state_t pm_state)
212 case PM_SUSPEND_STANDBY:
214 acpi_state = acpi_suspend_states[pm_state];
216 return sleep_states[acpi_state];
222 static struct platform_suspend_ops acpi_pm_ops = {
223 .valid = acpi_pm_state_valid,
224 .begin = acpi_pm_begin,
225 .prepare = acpi_pm_prepare,
226 .enter = acpi_pm_enter,
227 .finish = acpi_pm_finish,
232 * Toshiba fails to preserve interrupts over S1, reinitialization
233 * of 8259 is needed after S1 resume.
235 static int __init init_ints_after_s1(const struct dmi_system_id *d)
237 printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
238 init_8259A_after_S1 = 1;
242 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
244 .callback = init_ints_after_s1,
245 .ident = "Toshiba Satellite 4030cdt",
246 .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
250 #endif /* CONFIG_SUSPEND */
252 #ifdef CONFIG_HIBERNATION
253 static int acpi_hibernation_start(void)
255 acpi_target_sleep_state = ACPI_STATE_S4;
259 static int acpi_hibernation_prepare(void)
261 return acpi_sleep_prepare(ACPI_STATE_S4);
264 static int acpi_hibernation_enter(void)
266 acpi_status status = AE_OK;
267 unsigned long flags = 0;
269 ACPI_FLUSH_CPU_CACHE();
271 local_irq_save(flags);
272 acpi_enable_wakeup_device(ACPI_STATE_S4);
273 /* This shouldn't return. If it returns, we have a problem */
274 status = acpi_enter_sleep_state(ACPI_STATE_S4);
275 local_irq_restore(flags);
277 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
280 static void acpi_hibernation_leave(void)
283 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
289 static void acpi_hibernation_finish(void)
291 acpi_disable_wakeup_device(ACPI_STATE_S4);
292 acpi_leave_sleep_state(ACPI_STATE_S4);
294 /* reset firmware waking vector */
295 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
297 acpi_target_sleep_state = ACPI_STATE_S0;
300 static int acpi_hibernation_pre_restore(void)
304 status = acpi_hw_disable_all_gpes();
306 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
309 static void acpi_hibernation_restore_cleanup(void)
311 acpi_hw_enable_all_runtime_gpes();
314 static struct platform_hibernation_ops acpi_hibernation_ops = {
315 .start = acpi_hibernation_start,
316 .pre_snapshot = acpi_hibernation_prepare,
317 .finish = acpi_hibernation_finish,
318 .prepare = acpi_hibernation_prepare,
319 .enter = acpi_hibernation_enter,
320 .leave = acpi_hibernation_leave,
321 .pre_restore = acpi_hibernation_pre_restore,
322 .restore_cleanup = acpi_hibernation_restore_cleanup,
324 #endif /* CONFIG_HIBERNATION */
326 int acpi_suspend(u32 acpi_state)
328 suspend_state_t states[] = {
329 [1] = PM_SUSPEND_STANDBY,
330 [3] = PM_SUSPEND_MEM,
334 if (acpi_state < 6 && states[acpi_state])
335 return pm_suspend(states[acpi_state]);
341 #ifdef CONFIG_PM_SLEEP
343 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
344 * in the system sleep state given by %acpi_target_sleep_state
345 * @dev: device to examine
346 * @wake: if set, the device should be able to wake up the system
347 * @d_min_p: used to store the upper limit of allowed states range
348 * Return value: preferred power state of the device on success, -ENODEV on
349 * failure (ie. if there's no 'struct acpi_device' for @dev)
351 * Find the lowest power (highest number) ACPI device power state that
352 * device @dev can be in while the system is in the sleep state represented
353 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
354 * able to wake up the system from this sleep state. If @d_min_p is set,
355 * the highest power (lowest number) device power state of @dev allowed
356 * in this system sleep state is stored at the location pointed to by it.
358 * The caller must ensure that @dev is valid before using this function.
359 * The caller is also responsible for figuring out if the device is
360 * supposed to be able to wake up the system and passing this information
364 int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
366 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
367 struct acpi_device *adev;
368 char acpi_method[] = "_SxD";
369 unsigned long d_min, d_max;
371 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
372 printk(KERN_DEBUG "ACPI handle has no context!\n");
376 acpi_method[2] = '0' + acpi_target_sleep_state;
378 * If the sleep state is S0, we will return D3, but if the device has
379 * _S0W, we will use the value from _S0W
381 d_min = ACPI_STATE_D0;
382 d_max = ACPI_STATE_D3;
385 * If present, _SxD methods return the minimum D-state (highest power
386 * state) we can use for the corresponding S-states. Otherwise, the
387 * minimum D-state is D0 (ACPI 3.x).
389 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
390 * provided -- that's our fault recovery, we ignore retval.
392 if (acpi_target_sleep_state > ACPI_STATE_S0)
393 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
396 * If _PRW says we can wake up the system from the target sleep state,
397 * the D-state returned by _SxD is sufficient for that (we assume a
398 * wakeup-aware driver if wake is set). Still, if _SxW exists
399 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
400 * can wake the system. _S0W may be valid, too.
402 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
403 (wake && adev->wakeup.state.enabled &&
404 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
405 acpi_method[3] = 'W';
406 acpi_evaluate_integer(handle, acpi_method, NULL, &d_max);
418 static void acpi_power_off_prepare(void)
420 /* Prepare to power off the system */
421 acpi_sleep_prepare(ACPI_STATE_S5);
424 static void acpi_power_off(void)
426 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
427 printk("%s called\n", __FUNCTION__);
429 acpi_enable_wakeup_device(ACPI_STATE_S5);
430 acpi_enter_sleep_state(ACPI_STATE_S5);
433 int __init acpi_sleep_init(void)
437 #ifdef CONFIG_SUSPEND
440 dmi_check_system(acpisleep_dmi_table);
446 sleep_states[ACPI_STATE_S0] = 1;
447 printk(KERN_INFO PREFIX "(supports S0");
449 #ifdef CONFIG_SUSPEND
450 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
451 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
452 if (ACPI_SUCCESS(status)) {
458 suspend_set_ops(&acpi_pm_ops);
461 #ifdef CONFIG_HIBERNATION
462 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
463 if (ACPI_SUCCESS(status)) {
464 hibernation_set_ops(&acpi_hibernation_ops);
465 sleep_states[ACPI_STATE_S4] = 1;
469 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
470 if (ACPI_SUCCESS(status)) {
471 sleep_states[ACPI_STATE_S5] = 1;
473 pm_power_off_prepare = acpi_power_off_prepare;
474 pm_power_off = acpi_power_off;