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 <acpi/acpi_bus.h>
19 #include <acpi/acpi_drivers.h>
22 u8 sleep_states[ACPI_S_STATE_COUNT];
24 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
27 static struct pm_ops acpi_pm_ops;
29 extern void do_suspend_lowlevel(void);
31 static u32 acpi_suspend_states[] = {
32 [PM_SUSPEND_ON] = ACPI_STATE_S0,
33 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
34 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
35 [PM_SUSPEND_MAX] = ACPI_STATE_S5
38 static int init_8259A_after_S1;
41 * acpi_pm_set_target - Set the target system sleep state to the state
42 * associated with given @pm_state, if supported.
45 static int acpi_pm_set_target(suspend_state_t pm_state)
47 u32 acpi_state = acpi_suspend_states[pm_state];
50 if (sleep_states[acpi_state]) {
51 acpi_target_sleep_state = acpi_state;
53 printk(KERN_ERR "ACPI does not support this state: %d\n",
61 * acpi_pm_prepare - Do preliminary suspend work.
64 * If necessary, set the firmware waking vector and do arch-specific
65 * nastiness to get the wakeup code to the waking vector.
68 static int acpi_pm_prepare(suspend_state_t pm_state)
70 int error = acpi_sleep_prepare(acpi_target_sleep_state);
73 acpi_target_sleep_state = ACPI_STATE_S0;
79 * acpi_pm_enter - Actually enter a sleep state.
82 * Flush caches and go to sleep. For STR we have to call arch-specific
83 * assembly, which in turn call acpi_enter_sleep_state().
84 * It's unfortunate, but it works. Please fix if you're feeling frisky.
87 static int acpi_pm_enter(suspend_state_t pm_state)
89 acpi_status status = AE_OK;
90 unsigned long flags = 0;
91 u32 acpi_state = acpi_target_sleep_state;
93 ACPI_FLUSH_CPU_CACHE();
95 /* Do arch specific saving of state. */
96 if (acpi_state == ACPI_STATE_S3) {
97 int error = acpi_save_state_mem();
100 acpi_target_sleep_state = ACPI_STATE_S0;
105 local_irq_save(flags);
106 acpi_enable_wakeup_device(acpi_state);
107 switch (acpi_state) {
110 status = acpi_enter_sleep_state(acpi_state);
114 do_suspend_lowlevel();
118 /* ACPI 3.0 specs (P62) says that it's the responsabilty
119 * of the OSPM to clear the status bit [ implying that the
120 * POWER_BUTTON event should not reach userspace ]
122 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
123 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
125 local_irq_restore(flags);
126 printk(KERN_DEBUG "Back to C!\n");
128 /* restore processor state */
129 if (acpi_state == ACPI_STATE_S3)
130 acpi_restore_state_mem();
132 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
136 * acpi_pm_finish - Finish up suspend sequence.
139 * This is called after we wake back up (or if entering the sleep state
143 static int acpi_pm_finish(suspend_state_t pm_state)
145 u32 acpi_state = acpi_target_sleep_state;
147 acpi_leave_sleep_state(acpi_state);
148 acpi_disable_wakeup_device(acpi_state);
150 /* reset firmware waking vector */
151 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
153 acpi_target_sleep_state = ACPI_STATE_S0;
156 if (init_8259A_after_S1) {
157 printk("Broken toshiba laptop -> kicking interrupts\n");
164 static int acpi_pm_state_valid(suspend_state_t pm_state)
170 case PM_SUSPEND_STANDBY:
172 acpi_state = acpi_suspend_states[pm_state];
174 return sleep_states[acpi_state];
180 static struct pm_ops acpi_pm_ops = {
181 .valid = acpi_pm_state_valid,
182 .set_target = acpi_pm_set_target,
183 .prepare = acpi_pm_prepare,
184 .enter = acpi_pm_enter,
185 .finish = acpi_pm_finish,
189 * Toshiba fails to preserve interrupts over S1, reinitialization
190 * of 8259 is needed after S1 resume.
192 static int __init init_ints_after_s1(struct dmi_system_id *d)
194 printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
195 init_8259A_after_S1 = 1;
199 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
201 .callback = init_ints_after_s1,
202 .ident = "Toshiba Satellite 4030cdt",
203 .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
207 #endif /* CONFIG_SUSPEND */
209 #ifdef CONFIG_HIBERNATION
210 static int acpi_hibernation_prepare(void)
212 return acpi_sleep_prepare(ACPI_STATE_S4);
215 static int acpi_hibernation_enter(void)
217 acpi_status status = AE_OK;
218 unsigned long flags = 0;
220 ACPI_FLUSH_CPU_CACHE();
222 local_irq_save(flags);
223 acpi_enable_wakeup_device(ACPI_STATE_S4);
224 /* This shouldn't return. If it returns, we have a problem */
225 status = acpi_enter_sleep_state(ACPI_STATE_S4);
226 local_irq_restore(flags);
228 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
231 static void acpi_hibernation_finish(void)
233 acpi_leave_sleep_state(ACPI_STATE_S4);
234 acpi_disable_wakeup_device(ACPI_STATE_S4);
236 /* reset firmware waking vector */
237 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
240 static int acpi_hibernation_pre_restore(void)
244 status = acpi_hw_disable_all_gpes();
246 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
249 static void acpi_hibernation_restore_cleanup(void)
251 acpi_hw_enable_all_runtime_gpes();
254 static struct hibernation_ops acpi_hibernation_ops = {
255 .prepare = acpi_hibernation_prepare,
256 .enter = acpi_hibernation_enter,
257 .finish = acpi_hibernation_finish,
258 .pre_restore = acpi_hibernation_pre_restore,
259 .restore_cleanup = acpi_hibernation_restore_cleanup,
261 #endif /* CONFIG_HIBERNATION */
263 int acpi_suspend(u32 acpi_state)
265 suspend_state_t states[] = {
266 [1] = PM_SUSPEND_STANDBY,
267 [3] = PM_SUSPEND_MEM,
271 if (acpi_state < 6 && states[acpi_state])
272 return pm_suspend(states[acpi_state]);
279 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
280 * in the system sleep state given by %acpi_target_sleep_state
281 * @dev: device to examine
282 * @wake: if set, the device should be able to wake up the system
283 * @d_min_p: used to store the upper limit of allowed states range
284 * Return value: preferred power state of the device on success, -ENODEV on
285 * failure (ie. if there's no 'struct acpi_device' for @dev)
287 * Find the lowest power (highest number) ACPI device power state that
288 * device @dev can be in while the system is in the sleep state represented
289 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
290 * able to wake up the system from this sleep state. If @d_min_p is set,
291 * the highest power (lowest number) device power state of @dev allowed
292 * in this system sleep state is stored at the location pointed to by it.
294 * The caller must ensure that @dev is valid before using this function.
295 * The caller is also responsible for figuring out if the device is
296 * supposed to be able to wake up the system and passing this information
300 int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
302 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
303 struct acpi_device *adev;
304 char acpi_method[] = "_SxD";
305 unsigned long d_min, d_max;
307 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
308 printk(KERN_DEBUG "ACPI handle has no context!\n");
312 acpi_method[2] = '0' + acpi_target_sleep_state;
314 * If the sleep state is S0, we will return D3, but if the device has
315 * _S0W, we will use the value from _S0W
317 d_min = ACPI_STATE_D0;
318 d_max = ACPI_STATE_D3;
321 * If present, _SxD methods return the minimum D-state (highest power
322 * state) we can use for the corresponding S-states. Otherwise, the
323 * minimum D-state is D0 (ACPI 3.x).
325 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
326 * provided -- that's our fault recovery, we ignore retval.
328 if (acpi_target_sleep_state > ACPI_STATE_S0)
329 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
332 * If _PRW says we can wake up the system from the target sleep state,
333 * the D-state returned by _SxD is sufficient for that (we assume a
334 * wakeup-aware driver if wake is set). Still, if _SxW exists
335 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
336 * can wake the system. _S0W may be valid, too.
338 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
339 (wake && adev->wakeup.state.enabled &&
340 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
341 acpi_method[3] = 'W';
342 acpi_evaluate_integer(handle, acpi_method, NULL, &d_max);
353 int __init acpi_sleep_init(void)
357 #ifdef CONFIG_SUSPEND
360 dmi_check_system(acpisleep_dmi_table);
366 #ifdef CONFIG_SUSPEND
367 printk(KERN_INFO PREFIX "(supports");
368 for (i = ACPI_STATE_S0; i < ACPI_STATE_S4; i++) {
369 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
370 if (ACPI_SUCCESS(status)) {
377 pm_set_ops(&acpi_pm_ops);
380 #ifdef CONFIG_HIBERNATION
381 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
382 if (ACPI_SUCCESS(status)) {
383 hibernation_set_ops(&acpi_hibernation_ops);
384 sleep_states[ACPI_STATE_S4] = 1;
387 sleep_states[ACPI_STATE_S4] = 0;