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 pm_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.
89 * If necessary, set the firmware waking vector and do arch-specific
90 * nastiness to get the wakeup code to the waking vector.
93 static int acpi_pm_prepare(suspend_state_t pm_state)
95 int error = acpi_sleep_prepare(acpi_target_sleep_state);
98 acpi_target_sleep_state = ACPI_STATE_S0;
104 * acpi_pm_enter - Actually enter a sleep state.
107 * Flush caches and go to sleep. For STR we have to call arch-specific
108 * assembly, which in turn call acpi_enter_sleep_state().
109 * It's unfortunate, but it works. Please fix if you're feeling frisky.
112 static int acpi_pm_enter(suspend_state_t pm_state)
114 acpi_status status = AE_OK;
115 unsigned long flags = 0;
116 u32 acpi_state = acpi_target_sleep_state;
118 ACPI_FLUSH_CPU_CACHE();
120 /* Do arch specific saving of state. */
121 if (acpi_state == ACPI_STATE_S3) {
122 int error = acpi_save_state_mem();
125 acpi_target_sleep_state = ACPI_STATE_S0;
130 local_irq_save(flags);
131 acpi_enable_wakeup_device(acpi_state);
132 switch (acpi_state) {
135 status = acpi_enter_sleep_state(acpi_state);
139 do_suspend_lowlevel();
143 /* ACPI 3.0 specs (P62) says that it's the responsabilty
144 * of the OSPM to clear the status bit [ implying that the
145 * POWER_BUTTON event should not reach userspace ]
147 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
148 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
150 local_irq_restore(flags);
151 printk(KERN_DEBUG "Back to C!\n");
153 /* restore processor state */
154 if (acpi_state == ACPI_STATE_S3)
155 acpi_restore_state_mem();
157 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
161 * acpi_pm_finish - Finish up suspend sequence.
164 * This is called after we wake back up (or if entering the sleep state
168 static int acpi_pm_finish(suspend_state_t pm_state)
170 u32 acpi_state = acpi_target_sleep_state;
172 acpi_leave_sleep_state(acpi_state);
173 acpi_disable_wakeup_device(acpi_state);
175 /* reset firmware waking vector */
176 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
178 acpi_target_sleep_state = ACPI_STATE_S0;
181 if (init_8259A_after_S1) {
182 printk("Broken toshiba laptop -> kicking interrupts\n");
189 static int acpi_pm_state_valid(suspend_state_t pm_state)
195 case PM_SUSPEND_STANDBY:
197 acpi_state = acpi_suspend_states[pm_state];
199 return sleep_states[acpi_state];
205 static struct pm_ops acpi_pm_ops = {
206 .valid = acpi_pm_state_valid,
207 .set_target = acpi_pm_set_target,
208 .prepare = acpi_pm_prepare,
209 .enter = acpi_pm_enter,
210 .finish = acpi_pm_finish,
214 * Toshiba fails to preserve interrupts over S1, reinitialization
215 * of 8259 is needed after S1 resume.
217 static int __init init_ints_after_s1(struct dmi_system_id *d)
219 printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
220 init_8259A_after_S1 = 1;
224 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
226 .callback = init_ints_after_s1,
227 .ident = "Toshiba Satellite 4030cdt",
228 .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
232 #endif /* CONFIG_SUSPEND */
234 #ifdef CONFIG_HIBERNATION
235 static int acpi_hibernation_prepare(void)
237 return acpi_sleep_prepare(ACPI_STATE_S4);
240 static int acpi_hibernation_enter(void)
242 acpi_status status = AE_OK;
243 unsigned long flags = 0;
245 ACPI_FLUSH_CPU_CACHE();
247 local_irq_save(flags);
248 acpi_enable_wakeup_device(ACPI_STATE_S4);
249 /* This shouldn't return. If it returns, we have a problem */
250 status = acpi_enter_sleep_state(ACPI_STATE_S4);
251 local_irq_restore(flags);
253 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
256 static void acpi_hibernation_finish(void)
259 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
263 acpi_leave_sleep_state(ACPI_STATE_S4);
264 acpi_disable_wakeup_device(ACPI_STATE_S4);
266 /* reset firmware waking vector */
267 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
270 static int acpi_hibernation_pre_restore(void)
274 status = acpi_hw_disable_all_gpes();
276 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
279 static void acpi_hibernation_restore_cleanup(void)
281 acpi_hw_enable_all_runtime_gpes();
284 static struct hibernation_ops acpi_hibernation_ops = {
285 .prepare = acpi_hibernation_prepare,
286 .enter = acpi_hibernation_enter,
287 .finish = acpi_hibernation_finish,
288 .pre_restore = acpi_hibernation_pre_restore,
289 .restore_cleanup = acpi_hibernation_restore_cleanup,
291 #endif /* CONFIG_HIBERNATION */
293 int acpi_suspend(u32 acpi_state)
295 suspend_state_t states[] = {
296 [1] = PM_SUSPEND_STANDBY,
297 [3] = PM_SUSPEND_MEM,
301 if (acpi_state < 6 && states[acpi_state])
302 return pm_suspend(states[acpi_state]);
308 #ifdef CONFIG_PM_SLEEP
310 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
311 * in the system sleep state given by %acpi_target_sleep_state
312 * @dev: device to examine
313 * @wake: if set, the device should be able to wake up the system
314 * @d_min_p: used to store the upper limit of allowed states range
315 * Return value: preferred power state of the device on success, -ENODEV on
316 * failure (ie. if there's no 'struct acpi_device' for @dev)
318 * Find the lowest power (highest number) ACPI device power state that
319 * device @dev can be in while the system is in the sleep state represented
320 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
321 * able to wake up the system from this sleep state. If @d_min_p is set,
322 * the highest power (lowest number) device power state of @dev allowed
323 * in this system sleep state is stored at the location pointed to by it.
325 * The caller must ensure that @dev is valid before using this function.
326 * The caller is also responsible for figuring out if the device is
327 * supposed to be able to wake up the system and passing this information
331 int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
333 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
334 struct acpi_device *adev;
335 char acpi_method[] = "_SxD";
336 unsigned long d_min, d_max;
338 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
339 printk(KERN_DEBUG "ACPI handle has no context!\n");
343 acpi_method[2] = '0' + acpi_target_sleep_state;
345 * If the sleep state is S0, we will return D3, but if the device has
346 * _S0W, we will use the value from _S0W
348 d_min = ACPI_STATE_D0;
349 d_max = ACPI_STATE_D3;
352 * If present, _SxD methods return the minimum D-state (highest power
353 * state) we can use for the corresponding S-states. Otherwise, the
354 * minimum D-state is D0 (ACPI 3.x).
356 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
357 * provided -- that's our fault recovery, we ignore retval.
359 if (acpi_target_sleep_state > ACPI_STATE_S0)
360 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
363 * If _PRW says we can wake up the system from the target sleep state,
364 * the D-state returned by _SxD is sufficient for that (we assume a
365 * wakeup-aware driver if wake is set). Still, if _SxW exists
366 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
367 * can wake the system. _S0W may be valid, too.
369 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
370 (wake && adev->wakeup.state.enabled &&
371 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
372 acpi_method[3] = 'W';
373 acpi_evaluate_integer(handle, acpi_method, NULL, &d_max);
385 static void acpi_power_off_prepare(void)
387 /* Prepare to power off the system */
388 acpi_sleep_prepare(ACPI_STATE_S5);
391 static void acpi_power_off(void)
393 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
394 printk("%s called\n", __FUNCTION__);
396 acpi_enter_sleep_state(ACPI_STATE_S5);
399 int __init acpi_sleep_init(void)
403 #ifdef CONFIG_SUSPEND
406 dmi_check_system(acpisleep_dmi_table);
412 sleep_states[ACPI_STATE_S0] = 1;
413 printk(KERN_INFO PREFIX "(supports S0");
415 #ifdef CONFIG_SUSPEND
416 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
417 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
418 if (ACPI_SUCCESS(status)) {
424 pm_set_ops(&acpi_pm_ops);
427 #ifdef CONFIG_HIBERNATION
428 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
429 if (ACPI_SUCCESS(status)) {
430 hibernation_set_ops(&acpi_hibernation_ops);
431 sleep_states[ACPI_STATE_S4] = 1;
435 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
436 if (ACPI_SUCCESS(status)) {
437 sleep_states[ACPI_STATE_S5] = 1;
439 pm_power_off_prepare = acpi_power_off_prepare;
440 pm_power_off = acpi_power_off;