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