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_set_target - Set the target system sleep state to the state
67 * associated with given @pm_state, if supported.
70 static int acpi_pm_set_target(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 - Finish up suspend sequence.
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");
193 static int acpi_pm_state_valid(suspend_state_t pm_state)
199 case PM_SUSPEND_STANDBY:
201 acpi_state = acpi_suspend_states[pm_state];
203 return sleep_states[acpi_state];
209 static struct platform_suspend_ops acpi_pm_ops = {
210 .valid = acpi_pm_state_valid,
211 .set_target = acpi_pm_set_target,
212 .prepare = acpi_pm_prepare,
213 .enter = acpi_pm_enter,
214 .finish = acpi_pm_finish,
218 * Toshiba fails to preserve interrupts over S1, reinitialization
219 * of 8259 is needed after S1 resume.
221 static int __init init_ints_after_s1(const struct dmi_system_id *d)
223 printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
224 init_8259A_after_S1 = 1;
228 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
230 .callback = init_ints_after_s1,
231 .ident = "Toshiba Satellite 4030cdt",
232 .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
236 #endif /* CONFIG_SUSPEND */
238 #ifdef CONFIG_HIBERNATION
239 static int acpi_hibernation_start(void)
241 acpi_target_sleep_state = ACPI_STATE_S4;
245 static int acpi_hibernation_prepare(void)
247 return acpi_sleep_prepare(ACPI_STATE_S4);
250 static int acpi_hibernation_enter(void)
252 acpi_status status = AE_OK;
253 unsigned long flags = 0;
255 ACPI_FLUSH_CPU_CACHE();
257 local_irq_save(flags);
258 acpi_enable_wakeup_device(ACPI_STATE_S4);
259 /* This shouldn't return. If it returns, we have a problem */
260 status = acpi_enter_sleep_state(ACPI_STATE_S4);
261 local_irq_restore(flags);
263 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
266 static void acpi_hibernation_leave(void)
269 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
275 static void acpi_hibernation_finish(void)
277 acpi_disable_wakeup_device(ACPI_STATE_S4);
278 acpi_leave_sleep_state(ACPI_STATE_S4);
280 /* reset firmware waking vector */
281 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
283 acpi_target_sleep_state = ACPI_STATE_S0;
286 static int acpi_hibernation_pre_restore(void)
290 status = acpi_hw_disable_all_gpes();
292 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
295 static void acpi_hibernation_restore_cleanup(void)
297 acpi_hw_enable_all_runtime_gpes();
300 static struct platform_hibernation_ops acpi_hibernation_ops = {
301 .start = acpi_hibernation_start,
302 .pre_snapshot = acpi_hibernation_prepare,
303 .finish = acpi_hibernation_finish,
304 .prepare = acpi_hibernation_prepare,
305 .enter = acpi_hibernation_enter,
306 .leave = acpi_hibernation_leave,
307 .pre_restore = acpi_hibernation_pre_restore,
308 .restore_cleanup = acpi_hibernation_restore_cleanup,
310 #endif /* CONFIG_HIBERNATION */
312 int acpi_suspend(u32 acpi_state)
314 suspend_state_t states[] = {
315 [1] = PM_SUSPEND_STANDBY,
316 [3] = PM_SUSPEND_MEM,
320 if (acpi_state < 6 && states[acpi_state])
321 return pm_suspend(states[acpi_state]);
327 #ifdef CONFIG_PM_SLEEP
329 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
330 * in the system sleep state given by %acpi_target_sleep_state
331 * @dev: device to examine
332 * @wake: if set, the device should be able to wake up the system
333 * @d_min_p: used to store the upper limit of allowed states range
334 * Return value: preferred power state of the device on success, -ENODEV on
335 * failure (ie. if there's no 'struct acpi_device' for @dev)
337 * Find the lowest power (highest number) ACPI device power state that
338 * device @dev can be in while the system is in the sleep state represented
339 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
340 * able to wake up the system from this sleep state. If @d_min_p is set,
341 * the highest power (lowest number) device power state of @dev allowed
342 * in this system sleep state is stored at the location pointed to by it.
344 * The caller must ensure that @dev is valid before using this function.
345 * The caller is also responsible for figuring out if the device is
346 * supposed to be able to wake up the system and passing this information
350 int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
352 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
353 struct acpi_device *adev;
354 char acpi_method[] = "_SxD";
355 unsigned long d_min, d_max;
357 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
358 printk(KERN_DEBUG "ACPI handle has no context!\n");
362 acpi_method[2] = '0' + acpi_target_sleep_state;
364 * If the sleep state is S0, we will return D3, but if the device has
365 * _S0W, we will use the value from _S0W
367 d_min = ACPI_STATE_D0;
368 d_max = ACPI_STATE_D3;
371 * If present, _SxD methods return the minimum D-state (highest power
372 * state) we can use for the corresponding S-states. Otherwise, the
373 * minimum D-state is D0 (ACPI 3.x).
375 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
376 * provided -- that's our fault recovery, we ignore retval.
378 if (acpi_target_sleep_state > ACPI_STATE_S0)
379 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
382 * If _PRW says we can wake up the system from the target sleep state,
383 * the D-state returned by _SxD is sufficient for that (we assume a
384 * wakeup-aware driver if wake is set). Still, if _SxW exists
385 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
386 * can wake the system. _S0W may be valid, too.
388 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
389 (wake && adev->wakeup.state.enabled &&
390 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
391 acpi_method[3] = 'W';
392 acpi_evaluate_integer(handle, acpi_method, NULL, &d_max);
404 static void acpi_power_off_prepare(void)
406 /* Prepare to power off the system */
407 acpi_sleep_prepare(ACPI_STATE_S5);
410 static void acpi_power_off(void)
412 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
413 printk("%s called\n", __FUNCTION__);
415 acpi_enable_wakeup_device(ACPI_STATE_S5);
416 acpi_enter_sleep_state(ACPI_STATE_S5);
419 int __init acpi_sleep_init(void)
423 #ifdef CONFIG_SUSPEND
426 dmi_check_system(acpisleep_dmi_table);
432 sleep_states[ACPI_STATE_S0] = 1;
433 printk(KERN_INFO PREFIX "(supports S0");
435 #ifdef CONFIG_SUSPEND
436 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
437 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
438 if (ACPI_SUCCESS(status)) {
444 suspend_set_ops(&acpi_pm_ops);
447 #ifdef CONFIG_HIBERNATION
448 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
449 if (ACPI_SUCCESS(status)) {
450 hibernation_set_ops(&acpi_hibernation_ops);
451 sleep_states[ACPI_STATE_S4] = 1;
455 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
456 if (ACPI_SUCCESS(status)) {
457 sleep_states[ACPI_STATE_S5] = 1;
459 pm_power_off_prepare = acpi_power_off_prepare;
460 pm_power_off = acpi_power_off;