ACPI / power: Avoid maybe-uninitialized warning
[pandora-kernel.git] / drivers / acpi / sleep.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 #include <linux/reboot.h>
19 #include <linux/acpi.h>
20
21 #include <asm/io.h>
22
23 #include <acpi/acpi_bus.h>
24 #include <acpi/acpi_drivers.h>
25
26 #include "internal.h"
27 #include "sleep.h"
28
29 static u8 sleep_states[ACPI_S_STATE_COUNT];
30
31 static void acpi_sleep_tts_switch(u32 acpi_state)
32 {
33         union acpi_object in_arg = { ACPI_TYPE_INTEGER };
34         struct acpi_object_list arg_list = { 1, &in_arg };
35         acpi_status status = AE_OK;
36
37         in_arg.integer.value = acpi_state;
38         status = acpi_evaluate_object(NULL, "\\_TTS", &arg_list, NULL);
39         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
40                 /*
41                  * OS can't evaluate the _TTS object correctly. Some warning
42                  * message will be printed. But it won't break anything.
43                  */
44                 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
45         }
46 }
47
48 static int tts_notify_reboot(struct notifier_block *this,
49                         unsigned long code, void *x)
50 {
51         acpi_sleep_tts_switch(ACPI_STATE_S5);
52         return NOTIFY_DONE;
53 }
54
55 static struct notifier_block tts_notifier = {
56         .notifier_call  = tts_notify_reboot,
57         .next           = NULL,
58         .priority       = 0,
59 };
60
61 static int acpi_sleep_prepare(u32 acpi_state)
62 {
63 #ifdef CONFIG_ACPI_SLEEP
64         /* do we have a wakeup address for S2 and S3? */
65         if (acpi_state == ACPI_STATE_S3) {
66                 if (!acpi_wakeup_address) {
67                         return -EFAULT;
68                 }
69                 acpi_set_firmware_waking_vector(
70                                 (acpi_physical_address)acpi_wakeup_address);
71
72         }
73         ACPI_FLUSH_CPU_CACHE();
74 #endif
75         printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
76                 acpi_state);
77         acpi_enable_wakeup_devices(acpi_state);
78         acpi_enter_sleep_state_prep(acpi_state);
79         return 0;
80 }
81
82 #ifdef CONFIG_ACPI_SLEEP
83 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
84
85 /*
86  * The ACPI specification wants us to save NVS memory regions during hibernation
87  * and to restore them during the subsequent resume.  Windows does that also for
88  * suspend to RAM.  However, it is known that this mechanism does not work on
89  * all machines, so we allow the user to disable it with the help of the
90  * 'acpi_sleep=nonvs' kernel command line option.
91  */
92 static bool nvs_nosave;
93
94 void __init acpi_nvs_nosave(void)
95 {
96         nvs_nosave = true;
97 }
98
99 /*
100  * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
101  * user to request that behavior by using the 'acpi_old_suspend_ordering'
102  * kernel command line option that causes the following variable to be set.
103  */
104 static bool old_suspend_ordering;
105
106 void __init acpi_old_suspend_ordering(void)
107 {
108         old_suspend_ordering = true;
109 }
110
111 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
112 {
113         acpi_old_suspend_ordering();
114         return 0;
115 }
116
117 static int __init init_nvs_nosave(const struct dmi_system_id *d)
118 {
119         acpi_nvs_nosave();
120         return 0;
121 }
122
123 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
124         {
125         .callback = init_old_suspend_ordering,
126         .ident = "Abit KN9 (nForce4 variant)",
127         .matches = {
128                 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
129                 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
130                 },
131         },
132         {
133         .callback = init_old_suspend_ordering,
134         .ident = "HP xw4600 Workstation",
135         .matches = {
136                 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
137                 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
138                 },
139         },
140         {
141         .callback = init_old_suspend_ordering,
142         .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
143         .matches = {
144                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
145                 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
146                 },
147         },
148         {
149         .callback = init_old_suspend_ordering,
150         .ident = "Panasonic CF51-2L",
151         .matches = {
152                 DMI_MATCH(DMI_BOARD_VENDOR,
153                                 "Matsushita Electric Industrial Co.,Ltd."),
154                 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
155                 },
156         },
157         {
158         .callback = init_nvs_nosave,
159         .ident = "Sony Vaio VGN-FW41E_H",
160         .matches = {
161                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
162                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
163                 },
164         },
165         {
166         .callback = init_nvs_nosave,
167         .ident = "Sony Vaio VGN-FW21E",
168         .matches = {
169                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
170                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
171                 },
172         },
173         {
174         .callback = init_nvs_nosave,
175         .ident = "Sony Vaio VPCEB17FX",
176         .matches = {
177                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
178                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
179                 },
180         },
181         {
182         .callback = init_nvs_nosave,
183         .ident = "Sony Vaio VGN-SR11M",
184         .matches = {
185                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
186                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
187                 },
188         },
189         {
190         .callback = init_nvs_nosave,
191         .ident = "Everex StepNote Series",
192         .matches = {
193                 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
194                 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
195                 },
196         },
197         {
198         .callback = init_nvs_nosave,
199         .ident = "Sony Vaio VPCEB1Z1E",
200         .matches = {
201                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
202                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
203                 },
204         },
205         {
206         .callback = init_nvs_nosave,
207         .ident = "Sony Vaio VGN-NW130D",
208         .matches = {
209                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
210                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
211                 },
212         },
213         {
214         .callback = init_nvs_nosave,
215         .ident = "Sony Vaio VPCCW29FX",
216         .matches = {
217                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
218                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
219                 },
220         },
221         {
222         .callback = init_nvs_nosave,
223         .ident = "Averatec AV1020-ED2",
224         .matches = {
225                 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
226                 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
227                 },
228         },
229         {
230         .callback = init_old_suspend_ordering,
231         .ident = "Asus A8N-SLI DELUXE",
232         .matches = {
233                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
234                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
235                 },
236         },
237         {
238         .callback = init_old_suspend_ordering,
239         .ident = "Asus A8N-SLI Premium",
240         .matches = {
241                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
242                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
243                 },
244         },
245         {
246         .callback = init_nvs_nosave,
247         .ident = "Sony Vaio VGN-SR26GN_P",
248         .matches = {
249                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
250                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
251                 },
252         },
253         {
254         .callback = init_nvs_nosave,
255         .ident = "Sony Vaio VPCEB1S1E",
256         .matches = {
257                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
258                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
259                 },
260         },
261         {
262         .callback = init_nvs_nosave,
263         .ident = "Sony Vaio VGN-FW520F",
264         .matches = {
265                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
266                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
267                 },
268         },
269         {
270         .callback = init_nvs_nosave,
271         .ident = "Asus K54C",
272         .matches = {
273                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
274                 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
275                 },
276         },
277         {
278         .callback = init_nvs_nosave,
279         .ident = "Asus K54HR",
280         .matches = {
281                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
282                 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
283                 },
284         },
285         {},
286 };
287
288 static void acpi_sleep_dmi_check(void)
289 {
290         dmi_check_system(acpisleep_dmi_table);
291 }
292
293 /**
294  * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
295  */
296 static int acpi_pm_freeze(void)
297 {
298         acpi_disable_all_gpes();
299         acpi_os_wait_events_complete(NULL);
300         acpi_ec_block_transactions();
301         return 0;
302 }
303
304 /**
305  * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
306  */
307 static int acpi_pm_pre_suspend(void)
308 {
309         acpi_pm_freeze();
310         return suspend_nvs_save();
311 }
312
313 /**
314  *      __acpi_pm_prepare - Prepare the platform to enter the target state.
315  *
316  *      If necessary, set the firmware waking vector and do arch-specific
317  *      nastiness to get the wakeup code to the waking vector.
318  */
319 static int __acpi_pm_prepare(void)
320 {
321         int error = acpi_sleep_prepare(acpi_target_sleep_state);
322         if (error)
323                 acpi_target_sleep_state = ACPI_STATE_S0;
324
325         return error;
326 }
327
328 /**
329  *      acpi_pm_prepare - Prepare the platform to enter the target sleep
330  *              state and disable the GPEs.
331  */
332 static int acpi_pm_prepare(void)
333 {
334         int error = __acpi_pm_prepare();
335         if (!error)
336                 error = acpi_pm_pre_suspend();
337
338         return error;
339 }
340
341 /**
342  *      acpi_pm_finish - Instruct the platform to leave a sleep state.
343  *
344  *      This is called after we wake back up (or if entering the sleep state
345  *      failed).
346  */
347 static void acpi_pm_finish(void)
348 {
349         u32 acpi_state = acpi_target_sleep_state;
350
351         acpi_ec_unblock_transactions();
352         suspend_nvs_free();
353
354         if (acpi_state == ACPI_STATE_S0)
355                 return;
356
357         printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
358                 acpi_state);
359         acpi_disable_wakeup_devices(acpi_state);
360         acpi_leave_sleep_state(acpi_state);
361
362         /* reset firmware waking vector */
363         acpi_set_firmware_waking_vector((acpi_physical_address) 0);
364
365         acpi_target_sleep_state = ACPI_STATE_S0;
366 }
367
368 /**
369  *      acpi_pm_end - Finish up suspend sequence.
370  */
371 static void acpi_pm_end(void)
372 {
373         /*
374          * This is necessary in case acpi_pm_finish() is not called during a
375          * failing transition to a sleep state.
376          */
377         acpi_target_sleep_state = ACPI_STATE_S0;
378         acpi_sleep_tts_switch(acpi_target_sleep_state);
379 }
380 #else /* !CONFIG_ACPI_SLEEP */
381 #define acpi_target_sleep_state ACPI_STATE_S0
382 static inline void acpi_sleep_dmi_check(void) {}
383 #endif /* CONFIG_ACPI_SLEEP */
384
385 #ifdef CONFIG_SUSPEND
386 static u32 acpi_suspend_states[] = {
387         [PM_SUSPEND_ON] = ACPI_STATE_S0,
388         [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
389         [PM_SUSPEND_MEM] = ACPI_STATE_S3,
390         [PM_SUSPEND_MAX] = ACPI_STATE_S5
391 };
392
393 /**
394  *      acpi_suspend_begin - Set the target system sleep state to the state
395  *              associated with given @pm_state, if supported.
396  */
397 static int acpi_suspend_begin(suspend_state_t pm_state)
398 {
399         u32 acpi_state = acpi_suspend_states[pm_state];
400         int error = 0;
401
402         error = nvs_nosave ? 0 : suspend_nvs_alloc();
403         if (error)
404                 return error;
405
406         if (sleep_states[acpi_state]) {
407                 acpi_target_sleep_state = acpi_state;
408                 acpi_sleep_tts_switch(acpi_target_sleep_state);
409         } else {
410                 printk(KERN_ERR "ACPI does not support this state: %d\n",
411                         pm_state);
412                 error = -ENOSYS;
413         }
414         return error;
415 }
416
417 /**
418  *      acpi_suspend_enter - Actually enter a sleep state.
419  *      @pm_state: ignored
420  *
421  *      Flush caches and go to sleep. For STR we have to call arch-specific
422  *      assembly, which in turn call acpi_enter_sleep_state().
423  *      It's unfortunate, but it works. Please fix if you're feeling frisky.
424  */
425 static int acpi_suspend_enter(suspend_state_t pm_state)
426 {
427         acpi_status status = AE_OK;
428         u32 acpi_state = acpi_target_sleep_state;
429         int error;
430
431         ACPI_FLUSH_CPU_CACHE();
432
433         switch (acpi_state) {
434         case ACPI_STATE_S1:
435                 barrier();
436                 status = acpi_enter_sleep_state(acpi_state);
437                 break;
438
439         case ACPI_STATE_S3:
440                 error = acpi_suspend_lowlevel();
441                 if (error)
442                         return error;
443                 pr_info(PREFIX "Low-level resume complete\n");
444                 break;
445         }
446
447         /* This violates the spec but is required for bug compatibility. */
448         acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
449
450         /* Reprogram control registers and execute _BFS */
451         acpi_leave_sleep_state_prep(acpi_state);
452
453         /* ACPI 3.0 specs (P62) says that it's the responsibility
454          * of the OSPM to clear the status bit [ implying that the
455          * POWER_BUTTON event should not reach userspace ]
456          */
457         if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
458                 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
459
460         /*
461          * Disable and clear GPE status before interrupt is enabled. Some GPEs
462          * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
463          * acpi_leave_sleep_state will reenable specific GPEs later
464          */
465         acpi_disable_all_gpes();
466         /* Allow EC transactions to happen. */
467         acpi_ec_unblock_transactions_early();
468
469         suspend_nvs_restore();
470
471         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
472 }
473
474 static int acpi_suspend_state_valid(suspend_state_t pm_state)
475 {
476         u32 acpi_state;
477
478         switch (pm_state) {
479         case PM_SUSPEND_ON:
480         case PM_SUSPEND_STANDBY:
481         case PM_SUSPEND_MEM:
482                 acpi_state = acpi_suspend_states[pm_state];
483
484                 return sleep_states[acpi_state];
485         default:
486                 return 0;
487         }
488 }
489
490 static const struct platform_suspend_ops acpi_suspend_ops = {
491         .valid = acpi_suspend_state_valid,
492         .begin = acpi_suspend_begin,
493         .prepare_late = acpi_pm_prepare,
494         .enter = acpi_suspend_enter,
495         .wake = acpi_pm_finish,
496         .end = acpi_pm_end,
497 };
498
499 /**
500  *      acpi_suspend_begin_old - Set the target system sleep state to the
501  *              state associated with given @pm_state, if supported, and
502  *              execute the _PTS control method.  This function is used if the
503  *              pre-ACPI 2.0 suspend ordering has been requested.
504  */
505 static int acpi_suspend_begin_old(suspend_state_t pm_state)
506 {
507         int error = acpi_suspend_begin(pm_state);
508         if (!error)
509                 error = __acpi_pm_prepare();
510
511         return error;
512 }
513
514 /*
515  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
516  * been requested.
517  */
518 static const struct platform_suspend_ops acpi_suspend_ops_old = {
519         .valid = acpi_suspend_state_valid,
520         .begin = acpi_suspend_begin_old,
521         .prepare_late = acpi_pm_pre_suspend,
522         .enter = acpi_suspend_enter,
523         .wake = acpi_pm_finish,
524         .end = acpi_pm_end,
525         .recover = acpi_pm_finish,
526 };
527 #endif /* CONFIG_SUSPEND */
528
529 #ifdef CONFIG_HIBERNATION
530 static unsigned long s4_hardware_signature;
531 static struct acpi_table_facs *facs;
532 static bool nosigcheck;
533
534 void __init acpi_no_s4_hw_signature(void)
535 {
536         nosigcheck = true;
537 }
538
539 static int acpi_hibernation_begin(void)
540 {
541         int error;
542
543         error = nvs_nosave ? 0 : suspend_nvs_alloc();
544         if (!error) {
545                 acpi_target_sleep_state = ACPI_STATE_S4;
546                 acpi_sleep_tts_switch(acpi_target_sleep_state);
547         }
548
549         return error;
550 }
551
552 static int acpi_hibernation_enter(void)
553 {
554         acpi_status status = AE_OK;
555
556         ACPI_FLUSH_CPU_CACHE();
557
558         /* This shouldn't return.  If it returns, we have a problem */
559         status = acpi_enter_sleep_state(ACPI_STATE_S4);
560         /* Reprogram control registers and execute _BFS */
561         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
562
563         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
564 }
565
566 static void acpi_hibernation_leave(void)
567 {
568         /*
569          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
570          * enable it here.
571          */
572         acpi_enable();
573         /* Reprogram control registers and execute _BFS */
574         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
575         /* Check the hardware signature */
576         if (facs && s4_hardware_signature != facs->hardware_signature) {
577                 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
578                         "cannot resume!\n");
579                 panic("ACPI S4 hardware signature mismatch");
580         }
581         /* Restore the NVS memory area */
582         suspend_nvs_restore();
583         /* Allow EC transactions to happen. */
584         acpi_ec_unblock_transactions_early();
585 }
586
587 static void acpi_pm_thaw(void)
588 {
589         acpi_ec_unblock_transactions();
590         acpi_enable_all_runtime_gpes();
591 }
592
593 static const struct platform_hibernation_ops acpi_hibernation_ops = {
594         .begin = acpi_hibernation_begin,
595         .end = acpi_pm_end,
596         .pre_snapshot = acpi_pm_prepare,
597         .finish = acpi_pm_finish,
598         .prepare = acpi_pm_prepare,
599         .enter = acpi_hibernation_enter,
600         .leave = acpi_hibernation_leave,
601         .pre_restore = acpi_pm_freeze,
602         .restore_cleanup = acpi_pm_thaw,
603 };
604
605 /**
606  *      acpi_hibernation_begin_old - Set the target system sleep state to
607  *              ACPI_STATE_S4 and execute the _PTS control method.  This
608  *              function is used if the pre-ACPI 2.0 suspend ordering has been
609  *              requested.
610  */
611 static int acpi_hibernation_begin_old(void)
612 {
613         int error;
614         /*
615          * The _TTS object should always be evaluated before the _PTS object.
616          * When the old_suspended_ordering is true, the _PTS object is
617          * evaluated in the acpi_sleep_prepare.
618          */
619         acpi_sleep_tts_switch(ACPI_STATE_S4);
620
621         error = acpi_sleep_prepare(ACPI_STATE_S4);
622
623         if (!error) {
624                 if (!nvs_nosave)
625                         error = suspend_nvs_alloc();
626                 if (!error)
627                         acpi_target_sleep_state = ACPI_STATE_S4;
628         }
629         return error;
630 }
631
632 /*
633  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
634  * been requested.
635  */
636 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
637         .begin = acpi_hibernation_begin_old,
638         .end = acpi_pm_end,
639         .pre_snapshot = acpi_pm_pre_suspend,
640         .prepare = acpi_pm_freeze,
641         .finish = acpi_pm_finish,
642         .enter = acpi_hibernation_enter,
643         .leave = acpi_hibernation_leave,
644         .pre_restore = acpi_pm_freeze,
645         .restore_cleanup = acpi_pm_thaw,
646         .recover = acpi_pm_finish,
647 };
648 #endif /* CONFIG_HIBERNATION */
649
650 int acpi_suspend(u32 acpi_state)
651 {
652         suspend_state_t states[] = {
653                 [1] = PM_SUSPEND_STANDBY,
654                 [3] = PM_SUSPEND_MEM,
655                 [5] = PM_SUSPEND_MAX
656         };
657
658         if (acpi_state < 6 && states[acpi_state])
659                 return pm_suspend(states[acpi_state]);
660         if (acpi_state == 4)
661                 return hibernate();
662         return -EINVAL;
663 }
664
665 #ifdef CONFIG_PM
666 /**
667  *      acpi_pm_device_sleep_state - return preferred power state of ACPI device
668  *              in the system sleep state given by %acpi_target_sleep_state
669  *      @dev: device to examine; its driver model wakeup flags control
670  *              whether it should be able to wake up the system
671  *      @d_min_p: used to store the upper limit of allowed states range
672  *      Return value: preferred power state of the device on success, -ENODEV on
673  *              failure (ie. if there's no 'struct acpi_device' for @dev)
674  *
675  *      Find the lowest power (highest number) ACPI device power state that
676  *      device @dev can be in while the system is in the sleep state represented
677  *      by %acpi_target_sleep_state.  If @wake is nonzero, the device should be
678  *      able to wake up the system from this sleep state.  If @d_min_p is set,
679  *      the highest power (lowest number) device power state of @dev allowed
680  *      in this system sleep state is stored at the location pointed to by it.
681  *
682  *      The caller must ensure that @dev is valid before using this function.
683  *      The caller is also responsible for figuring out if the device is
684  *      supposed to be able to wake up the system and passing this information
685  *      via @wake.
686  */
687
688 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
689 {
690         acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
691         struct acpi_device *adev;
692         char acpi_method[] = "_SxD";
693         unsigned long long d_min, d_max;
694
695         if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
696                 printk(KERN_DEBUG "ACPI handle has no context!\n");
697                 return -ENODEV;
698         }
699
700         acpi_method[2] = '0' + acpi_target_sleep_state;
701         /*
702          * If the sleep state is S0, we will return D3, but if the device has
703          * _S0W, we will use the value from _S0W
704          */
705         d_min = ACPI_STATE_D0;
706         d_max = ACPI_STATE_D3;
707
708         /*
709          * If present, _SxD methods return the minimum D-state (highest power
710          * state) we can use for the corresponding S-states.  Otherwise, the
711          * minimum D-state is D0 (ACPI 3.x).
712          *
713          * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
714          * provided -- that's our fault recovery, we ignore retval.
715          */
716         if (acpi_target_sleep_state > ACPI_STATE_S0)
717                 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
718
719         /*
720          * If _PRW says we can wake up the system from the target sleep state,
721          * the D-state returned by _SxD is sufficient for that (we assume a
722          * wakeup-aware driver if wake is set).  Still, if _SxW exists
723          * (ACPI 3.x), it should return the maximum (lowest power) D-state that
724          * can wake the system.  _S0W may be valid, too.
725          */
726         if (acpi_target_sleep_state == ACPI_STATE_S0 ||
727             (device_may_wakeup(dev) && adev->wakeup.flags.valid &&
728              adev->wakeup.sleep_state >= acpi_target_sleep_state)) {
729                 acpi_status status;
730
731                 acpi_method[3] = 'W';
732                 status = acpi_evaluate_integer(handle, acpi_method, NULL,
733                                                 &d_max);
734                 if (ACPI_FAILURE(status)) {
735                         if (acpi_target_sleep_state != ACPI_STATE_S0 ||
736                             status != AE_NOT_FOUND)
737                                 d_max = d_min;
738                 } else if (d_max < d_min) {
739                         /* Warn the user of the broken DSDT */
740                         printk(KERN_WARNING "ACPI: Wrong value from %s\n",
741                                 acpi_method);
742                         /* Sanitize it */
743                         d_min = d_max;
744                 }
745         }
746
747         if (d_min_p)
748                 *d_min_p = d_min;
749         return d_max;
750 }
751 #endif /* CONFIG_PM */
752
753 #ifdef CONFIG_PM_SLEEP
754 /**
755  *      acpi_pm_device_sleep_wake - enable or disable the system wake-up
756  *                                  capability of given device
757  *      @dev: device to handle
758  *      @enable: 'true' - enable, 'false' - disable the wake-up capability
759  */
760 int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
761 {
762         acpi_handle handle;
763         struct acpi_device *adev;
764         int error;
765
766         if (!device_can_wakeup(dev))
767                 return -EINVAL;
768
769         handle = DEVICE_ACPI_HANDLE(dev);
770         if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
771                 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
772                 return -ENODEV;
773         }
774
775         error = enable ?
776                 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
777                 acpi_disable_wakeup_device_power(adev);
778         if (!error)
779                 dev_info(dev, "wake-up capability %s by ACPI\n",
780                                 enable ? "enabled" : "disabled");
781
782         return error;
783 }
784 #endif  /* CONFIG_PM_SLEEP */
785
786 static void acpi_power_off_prepare(void)
787 {
788         /* Prepare to power off the system */
789         acpi_sleep_prepare(ACPI_STATE_S5);
790         acpi_disable_all_gpes();
791 }
792
793 static void acpi_power_off(void)
794 {
795         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
796         printk(KERN_DEBUG "%s called\n", __func__);
797         local_irq_disable();
798         acpi_enter_sleep_state(ACPI_STATE_S5);
799 }
800
801 /*
802  * ACPI 2.0 created the optional _GTS and _BFS,
803  * but industry adoption has been neither rapid nor broad.
804  *
805  * Linux gets into trouble when it executes poorly validated
806  * paths through the BIOS, so disable _GTS and _BFS by default,
807  * but do speak up and offer the option to enable them.
808  */
809 static void __init acpi_gts_bfs_check(void)
810 {
811         acpi_handle dummy;
812
813         if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
814         {
815                 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
816                 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
817                         "please notify linux-acpi@vger.kernel.org\n");
818         }
819         if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
820         {
821                 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
822                 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
823                         "please notify linux-acpi@vger.kernel.org\n");
824         }
825 }
826
827 int __init acpi_sleep_init(void)
828 {
829         acpi_status status;
830         u8 type_a, type_b;
831 #ifdef CONFIG_SUSPEND
832         int i = 0;
833 #endif
834
835         if (acpi_disabled)
836                 return 0;
837
838         acpi_sleep_dmi_check();
839
840         sleep_states[ACPI_STATE_S0] = 1;
841         printk(KERN_INFO PREFIX "(supports S0");
842
843 #ifdef CONFIG_SUSPEND
844         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
845                 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
846                 if (ACPI_SUCCESS(status)) {
847                         sleep_states[i] = 1;
848                         printk(" S%d", i);
849                 }
850         }
851
852         suspend_set_ops(old_suspend_ordering ?
853                 &acpi_suspend_ops_old : &acpi_suspend_ops);
854 #endif
855
856 #ifdef CONFIG_HIBERNATION
857         status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
858         if (ACPI_SUCCESS(status)) {
859                 hibernation_set_ops(old_suspend_ordering ?
860                         &acpi_hibernation_ops_old : &acpi_hibernation_ops);
861                 sleep_states[ACPI_STATE_S4] = 1;
862                 printk(" S4");
863                 if (!nosigcheck) {
864                         acpi_get_table(ACPI_SIG_FACS, 1,
865                                 (struct acpi_table_header **)&facs);
866                         if (facs)
867                                 s4_hardware_signature =
868                                         facs->hardware_signature;
869                 }
870         }
871 #endif
872         status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
873         if (ACPI_SUCCESS(status)) {
874                 sleep_states[ACPI_STATE_S5] = 1;
875                 printk(" S5");
876                 pm_power_off_prepare = acpi_power_off_prepare;
877                 pm_power_off = acpi_power_off;
878         }
879         printk(")\n");
880         /*
881          * Register the tts_notifier to reboot notifier list so that the _TTS
882          * object can also be evaluated when the system enters S5.
883          */
884         register_reboot_notifier(&tts_notifier);
885         acpi_gts_bfs_check();
886         return 0;
887 }