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