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