99181c8f023e995ddee02db168d9ef682a74bd4e
[sfrench/cifs-2.6.git] / drivers / acpi / sleep / main.c
1 /*
2  * sleep.c - ACPI sleep support.
3  *
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
8  *
9  * This file is released under the GPLv2.
10  *
11  */
12
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
19 #include <asm/io.h>
20
21 #include <acpi/acpi_bus.h>
22 #include <acpi/acpi_drivers.h>
23 #include "sleep.h"
24
25 u8 sleep_states[ACPI_S_STATE_COUNT];
26
27 #ifdef CONFIG_PM_SLEEP
28 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
29 #endif
30
31 int acpi_sleep_prepare(u32 acpi_state)
32 {
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) {
37                         return -EFAULT;
38                 }
39                 acpi_set_firmware_waking_vector((acpi_physical_address)
40                                                 virt_to_phys((void *)
41                                                              acpi_wakeup_address));
42
43         }
44         ACPI_FLUSH_CPU_CACHE();
45         acpi_enable_wakeup_device_prep(acpi_state);
46 #endif
47         acpi_enter_sleep_state_prep(acpi_state);
48         return 0;
49 }
50
51 #ifdef CONFIG_SUSPEND
52 static struct platform_suspend_ops acpi_pm_ops;
53
54 extern void do_suspend_lowlevel(void);
55
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
61 };
62
63 static int init_8259A_after_S1;
64
65 /**
66  *      acpi_pm_set_target - Set the target system sleep state to the state
67  *              associated with given @pm_state, if supported.
68  */
69
70 static int acpi_pm_set_target(suspend_state_t pm_state)
71 {
72         u32 acpi_state = acpi_suspend_states[pm_state];
73         int error = 0;
74
75         if (sleep_states[acpi_state]) {
76                 acpi_target_sleep_state = acpi_state;
77         } else {
78                 printk(KERN_ERR "ACPI does not support this state: %d\n",
79                         pm_state);
80                 error = -ENOSYS;
81         }
82         return error;
83 }
84
85 /**
86  *      acpi_pm_prepare - Do preliminary suspend work.
87  *
88  *      If necessary, set the firmware waking vector and do arch-specific
89  *      nastiness to get the wakeup code to the waking vector.
90  */
91
92 static int acpi_pm_prepare(void)
93 {
94         int error = acpi_sleep_prepare(acpi_target_sleep_state);
95
96         if (error)
97                 acpi_target_sleep_state = ACPI_STATE_S0;
98
99         return error;
100 }
101
102 /**
103  *      acpi_pm_enter - Actually enter a sleep state.
104  *      @pm_state: ignored
105  *
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.
109  */
110
111 static int acpi_pm_enter(suspend_state_t pm_state)
112 {
113         acpi_status status = AE_OK;
114         unsigned long flags = 0;
115         u32 acpi_state = acpi_target_sleep_state;
116
117         ACPI_FLUSH_CPU_CACHE();
118
119         /* Do arch specific saving of state. */
120         if (acpi_state == ACPI_STATE_S3) {
121                 int error = acpi_save_state_mem();
122
123                 if (error) {
124                         acpi_target_sleep_state = ACPI_STATE_S0;
125                         return error;
126                 }
127         }
128
129         local_irq_save(flags);
130         acpi_enable_wakeup_device(acpi_state);
131         switch (acpi_state) {
132         case ACPI_STATE_S1:
133                 barrier();
134                 status = acpi_enter_sleep_state(acpi_state);
135                 break;
136
137         case ACPI_STATE_S3:
138                 do_suspend_lowlevel();
139                 break;
140         }
141
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 ]
145          */
146         if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
147                 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
148
149         local_irq_restore(flags);
150         printk(KERN_DEBUG "Back to C!\n");
151
152         /* restore processor state */
153         if (acpi_state == ACPI_STATE_S3)
154                 acpi_restore_state_mem();
155
156         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
157 }
158
159 /**
160  *      acpi_pm_finish - Finish up suspend sequence.
161  *
162  *      This is called after we wake back up (or if entering the sleep state
163  *      failed). 
164  */
165
166 static void acpi_pm_finish(void)
167 {
168         u32 acpi_state = acpi_target_sleep_state;
169
170         acpi_disable_wakeup_device(acpi_state);
171         acpi_leave_sleep_state(acpi_state);
172
173         /* reset firmware waking vector */
174         acpi_set_firmware_waking_vector((acpi_physical_address) 0);
175
176         acpi_target_sleep_state = ACPI_STATE_S0;
177
178 #ifdef CONFIG_X86
179         if (init_8259A_after_S1) {
180                 printk("Broken toshiba laptop -> kicking interrupts\n");
181                 init_8259A(0);
182         }
183 #endif
184 }
185
186 static int acpi_pm_state_valid(suspend_state_t pm_state)
187 {
188         u32 acpi_state;
189
190         switch (pm_state) {
191         case PM_SUSPEND_ON:
192         case PM_SUSPEND_STANDBY:
193         case PM_SUSPEND_MEM:
194                 acpi_state = acpi_suspend_states[pm_state];
195
196                 return sleep_states[acpi_state];
197         default:
198                 return 0;
199         }
200 }
201
202 static struct platform_suspend_ops acpi_pm_ops = {
203         .valid = acpi_pm_state_valid,
204         .set_target = acpi_pm_set_target,
205         .prepare = acpi_pm_prepare,
206         .enter = acpi_pm_enter,
207         .finish = acpi_pm_finish,
208 };
209
210 /*
211  * Toshiba fails to preserve interrupts over S1, reinitialization
212  * of 8259 is needed after S1 resume.
213  */
214 static int __init init_ints_after_s1(const struct dmi_system_id *d)
215 {
216         printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
217         init_8259A_after_S1 = 1;
218         return 0;
219 }
220
221 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
222         {
223          .callback = init_ints_after_s1,
224          .ident = "Toshiba Satellite 4030cdt",
225          .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
226          },
227         {},
228 };
229 #endif /* CONFIG_SUSPEND */
230
231 #ifdef CONFIG_HIBERNATION
232 static int acpi_hibernation_start(void)
233 {
234         acpi_target_sleep_state = ACPI_STATE_S4;
235         return 0;
236 }
237
238 static int acpi_hibernation_prepare(void)
239 {
240         return acpi_sleep_prepare(ACPI_STATE_S4);
241 }
242
243 static int acpi_hibernation_enter(void)
244 {
245         acpi_status status = AE_OK;
246         unsigned long flags = 0;
247
248         ACPI_FLUSH_CPU_CACHE();
249
250         local_irq_save(flags);
251         acpi_enable_wakeup_device(ACPI_STATE_S4);
252         /* This shouldn't return.  If it returns, we have a problem */
253         status = acpi_enter_sleep_state(ACPI_STATE_S4);
254         local_irq_restore(flags);
255
256         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
257 }
258
259 static void acpi_hibernation_leave(void)
260 {
261         /*
262          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
263          * enable it here.
264          */
265         acpi_enable();
266 }
267
268 static void acpi_hibernation_finish(void)
269 {
270         /*
271          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
272          * enable it here.
273          */
274         acpi_enable();
275         acpi_disable_wakeup_device(ACPI_STATE_S4);
276         acpi_leave_sleep_state(ACPI_STATE_S4);
277
278         /* reset firmware waking vector */
279         acpi_set_firmware_waking_vector((acpi_physical_address) 0);
280
281         acpi_target_sleep_state = ACPI_STATE_S0;
282 }
283
284 static int acpi_hibernation_pre_restore(void)
285 {
286         acpi_status status;
287
288         status = acpi_hw_disable_all_gpes();
289
290         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
291 }
292
293 static void acpi_hibernation_restore_cleanup(void)
294 {
295         acpi_hw_enable_all_runtime_gpes();
296 }
297
298 static struct platform_hibernation_ops acpi_hibernation_ops = {
299         .start = acpi_hibernation_start,
300         .pre_snapshot = acpi_hibernation_prepare,
301         .finish = acpi_hibernation_finish,
302         .prepare = acpi_hibernation_prepare,
303         .enter = acpi_hibernation_enter,
304         .leave = acpi_hibernation_leave,
305         .pre_restore = acpi_hibernation_pre_restore,
306         .restore_cleanup = acpi_hibernation_restore_cleanup,
307 };
308 #endif                          /* CONFIG_HIBERNATION */
309
310 int acpi_suspend(u32 acpi_state)
311 {
312         suspend_state_t states[] = {
313                 [1] = PM_SUSPEND_STANDBY,
314                 [3] = PM_SUSPEND_MEM,
315                 [5] = PM_SUSPEND_MAX
316         };
317
318         if (acpi_state < 6 && states[acpi_state])
319                 return pm_suspend(states[acpi_state]);
320         if (acpi_state == 4)
321                 return hibernate();
322         return -EINVAL;
323 }
324
325 #ifdef CONFIG_PM_SLEEP
326 /**
327  *      acpi_pm_device_sleep_state - return preferred power state of ACPI device
328  *              in the system sleep state given by %acpi_target_sleep_state
329  *      @dev: device to examine
330  *      @wake: if set, the device should be able to wake up the system
331  *      @d_min_p: used to store the upper limit of allowed states range
332  *      Return value: preferred power state of the device on success, -ENODEV on
333  *              failure (ie. if there's no 'struct acpi_device' for @dev)
334  *
335  *      Find the lowest power (highest number) ACPI device power state that
336  *      device @dev can be in while the system is in the sleep state represented
337  *      by %acpi_target_sleep_state.  If @wake is nonzero, the device should be
338  *      able to wake up the system from this sleep state.  If @d_min_p is set,
339  *      the highest power (lowest number) device power state of @dev allowed
340  *      in this system sleep state is stored at the location pointed to by it.
341  *
342  *      The caller must ensure that @dev is valid before using this function.
343  *      The caller is also responsible for figuring out if the device is
344  *      supposed to be able to wake up the system and passing this information
345  *      via @wake.
346  */
347
348 int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
349 {
350         acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
351         struct acpi_device *adev;
352         char acpi_method[] = "_SxD";
353         unsigned long d_min, d_max;
354
355         if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
356                 printk(KERN_DEBUG "ACPI handle has no context!\n");
357                 return -ENODEV;
358         }
359
360         acpi_method[2] = '0' + acpi_target_sleep_state;
361         /*
362          * If the sleep state is S0, we will return D3, but if the device has
363          * _S0W, we will use the value from _S0W
364          */
365         d_min = ACPI_STATE_D0;
366         d_max = ACPI_STATE_D3;
367
368         /*
369          * If present, _SxD methods return the minimum D-state (highest power
370          * state) we can use for the corresponding S-states.  Otherwise, the
371          * minimum D-state is D0 (ACPI 3.x).
372          *
373          * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
374          * provided -- that's our fault recovery, we ignore retval.
375          */
376         if (acpi_target_sleep_state > ACPI_STATE_S0)
377                 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
378
379         /*
380          * If _PRW says we can wake up the system from the target sleep state,
381          * the D-state returned by _SxD is sufficient for that (we assume a
382          * wakeup-aware driver if wake is set).  Still, if _SxW exists
383          * (ACPI 3.x), it should return the maximum (lowest power) D-state that
384          * can wake the system.  _S0W may be valid, too.
385          */
386         if (acpi_target_sleep_state == ACPI_STATE_S0 ||
387             (wake && adev->wakeup.state.enabled &&
388              adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
389                 acpi_status status;
390
391                 acpi_method[3] = 'W';
392                 status = acpi_evaluate_integer(handle, acpi_method, NULL,
393                                                 &d_max);
394                 if (ACPI_FAILURE(status)) {
395                         d_max = d_min;
396                 } else if (d_max < d_min) {
397                         /* Warn the user of the broken DSDT */
398                         printk(KERN_WARNING "ACPI: Wrong value from %s\n",
399                                 acpi_method);
400                         /* Sanitize it */
401                         d_min = d_max;
402                 }
403         }
404
405         if (d_min_p)
406                 *d_min_p = d_min;
407         return d_max;
408 }
409 #endif
410
411 static void acpi_power_off_prepare(void)
412 {
413         /* Prepare to power off the system */
414         acpi_sleep_prepare(ACPI_STATE_S5);
415 }
416
417 static void acpi_power_off(void)
418 {
419         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
420         printk("%s called\n", __FUNCTION__);
421         local_irq_disable();
422         acpi_enable_wakeup_device(ACPI_STATE_S5);
423         acpi_enter_sleep_state(ACPI_STATE_S5);
424 }
425
426 int __init acpi_sleep_init(void)
427 {
428         acpi_status status;
429         u8 type_a, type_b;
430 #ifdef CONFIG_SUSPEND
431         int i = 0;
432
433         dmi_check_system(acpisleep_dmi_table);
434 #endif
435
436         if (acpi_disabled)
437                 return 0;
438
439         sleep_states[ACPI_STATE_S0] = 1;
440         printk(KERN_INFO PREFIX "(supports S0");
441
442 #ifdef CONFIG_SUSPEND
443         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
444                 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
445                 if (ACPI_SUCCESS(status)) {
446                         sleep_states[i] = 1;
447                         printk(" S%d", i);
448                 }
449         }
450
451         suspend_set_ops(&acpi_pm_ops);
452 #endif
453
454 #ifdef CONFIG_HIBERNATION
455         status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
456         if (ACPI_SUCCESS(status)) {
457                 hibernation_set_ops(&acpi_hibernation_ops);
458                 sleep_states[ACPI_STATE_S4] = 1;
459                 printk(" S4");
460         }
461 #endif
462         status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
463         if (ACPI_SUCCESS(status)) {
464                 sleep_states[ACPI_STATE_S5] = 1;
465                 printk(" S5");
466                 pm_power_off_prepare = acpi_power_off_prepare;
467                 pm_power_off = acpi_power_off;
468         }
469         printk(")\n");
470         return 0;
471 }