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