blob: 3bde594a997986ce5d4056aef075d9cf19e45bff [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * sleep.c - ACPI sleep support.
3 *
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -05004 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * 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>
Zhao Yakuie49f7112008-08-12 10:20:22 +080018#include <linux/reboot.h>
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +040019
20#include <asm/io.h>
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <acpi/acpi_bus.h>
23#include <acpi/acpi_drivers.h>
Bjorn Helgaase60cc7a2009-03-13 12:08:26 -060024
25#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include "sleep.h"
27
28u8 sleep_states[ACPI_S_STATE_COUNT];
29
Zhao Yakuie49f7112008-08-12 10:20:22 +080030static 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
Rafael J. Wysockic9b6c8f2008-01-08 00:10:57 +010060static int acpi_sleep_prepare(u32 acpi_state)
Alexey Starikovskiy2f3f22262007-09-24 14:33:21 +020061{
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 }
H. Peter Anvin4b4f7282008-06-24 23:03:48 +020068 acpi_set_firmware_waking_vector(
69 (acpi_physical_address)acpi_wakeup_address);
Alexey Starikovskiy2f3f22262007-09-24 14:33:21 +020070
71 }
72 ACPI_FLUSH_CPU_CACHE();
73 acpi_enable_wakeup_device_prep(acpi_state);
74#endif
Rafael J. Wysockic9b6c8f2008-01-08 00:10:57 +010075 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
76 acpi_state);
Alexey Starikovskiy2f3f22262007-09-24 14:33:21 +020077 acpi_enter_sleep_state_prep(acpi_state);
78 return 0;
79}
80
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -040081#ifdef CONFIG_ACPI_SLEEP
Len Brownb8490752008-10-23 00:45:18 -040082static u32 acpi_target_sleep_state = ACPI_STATE_S0;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +020083/*
Zhang Ruid7f0eea2009-12-30 15:36:42 +080084 * 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
100/*
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200101 * 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/**
113 * acpi_pm_disable_gpes - Disable the GPEs.
114 */
115static int acpi_pm_disable_gpes(void)
116{
Lin Ming3d97e422008-12-16 16:57:46 +0800117 acpi_disable_all_gpes();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200118 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 */
127static 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 */
140static int acpi_pm_prepare(void)
141{
142 int error = __acpi_pm_prepare();
143
144 if (!error)
Lin Ming3d97e422008-12-16 16:57:46 +0800145 acpi_disable_all_gpes();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200146 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 */
155static 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 */
176static 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;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800183 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200184}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200185#else /* !CONFIG_ACPI_SLEEP */
186#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400187#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200188
189#ifdef CONFIG_SUSPEND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190extern void do_suspend_lowlevel(void);
191
192static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500193 [PM_SUSPEND_ON] = ACPI_STATE_S0,
194 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
195 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500196 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197};
198
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200199/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400200 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200201 * associated with given @pm_state, if supported.
202 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400203static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
205 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200206 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200208 if (sleep_states[acpi_state]) {
209 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800210 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200211 } else {
212 printk(KERN_ERR "ACPI does not support this state: %d\n",
213 pm_state);
214 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200216 return error;
217}
218
219/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400220 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200221 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200223 * Flush caches and go to sleep. For STR we have to call arch-specific
224 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 * It's unfortunate, but it works. Please fix if you're feeling frisky.
226 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400227static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
229 acpi_status status = AE_OK;
230 unsigned long flags = 0;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200231 u32 acpi_state = acpi_target_sleep_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233 ACPI_FLUSH_CPU_CACHE();
234
235 /* Do arch specific saving of state. */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200236 if (acpi_state == ACPI_STATE_S3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 int error = acpi_save_state_mem();
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200238
Rafael J. Wysocki60417f52008-01-08 00:07:39 +0100239 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return error;
241 }
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 local_irq_save(flags);
244 acpi_enable_wakeup_device(acpi_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200245 switch (acpi_state) {
246 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 barrier();
248 status = acpi_enter_sleep_state(acpi_state);
249 break;
250
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200251 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 do_suspend_lowlevel();
253 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400255
Rafael J. Wysockid0c71fe2008-10-04 00:05:05 +0200256 /* If ACPI is not enabled by the BIOS, we need to enable it here. */
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500257 if (set_sci_en_on_resume)
Bob Moore50ffba12009-02-23 15:02:07 +0800258 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500259 else
260 acpi_enable();
261
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100262 /* Reprogram control registers and execute _BFS */
263 acpi_leave_sleep_state_prep(acpi_state);
264
Pavel Machek23b168d2008-02-05 19:27:12 +0100265 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400266 * 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
Shaohua Lia3627f62007-06-20 09:17:58 +0800272 /*
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 */
Lin Ming3d97e422008-12-16 16:57:46 +0800277 acpi_disable_all_gpes();
Shaohua Lia3627f62007-06-20 09:17:58 +0800278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 local_irq_restore(flags);
280 printk(KERN_DEBUG "Back to C!\n");
281
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200282 /* restore processor state */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200283 if (acpi_state == ACPI_STATE_S3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 acpi_restore_state_mem();
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
287}
288
Len Brown2c6e33c2008-04-23 18:02:52 -0400289static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800290{
Johannes Berge8c9c502007-04-30 15:09:54 -0700291 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800292
Johannes Berge8c9c502007-04-30 15:09:54 -0700293 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 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800303}
304
Len Brown2c6e33c2008-04-23 18:02:52 -0400305static struct platform_suspend_ops acpi_suspend_ops = {
306 .valid = acpi_suspend_state_valid,
307 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200308 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400309 .enter = acpi_suspend_enter,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200310 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200311 .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 */
320static 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 */
333static struct platform_suspend_ops acpi_suspend_ops_old = {
334 .valid = acpi_suspend_state_valid,
335 .begin = acpi_suspend_begin_old,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200336 .prepare_late = acpi_pm_disable_gpes,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200337 .enter = acpi_suspend_enter,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200338 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200339 .end = acpi_pm_end,
340 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700342
343static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
344{
345 old_suspend_ordering = true;
346 return 0;
347}
348
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500349static 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
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700355static 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 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200364 {
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 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500372 {
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 },
Andy Whitcrofta1404492009-02-11 18:11:22 +0000388 {
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 },
Zhang Rui45e77982009-03-15 22:13:44 -0400396 {
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 },
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800404 {
Bartlomiej Zolnierkiewiczec79be22009-07-29 21:07:47 +0200405 .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 {
Len Browneb0ca842009-08-29 22:39:06 -0400413 .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 {
Gustavo Maciel Dias Vieira8a1cbf62009-10-19 09:41:53 -0200421 .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 {
Vaibhav Verma2839d392009-11-05 23:13:36 -0500429 .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,
Len Brown87c687b2009-11-23 11:44:12 -0500438 .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,
Vaibhav Verma2839d392009-11-05 23:13:36 -0500446 .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 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800453 .callback = init_old_suspend_ordering,
454 .ident = "Panasonic CF51-2L",
455 .matches = {
456 DMI_MATCH(DMI_BOARD_VENDOR,
457 "Matsushita Electric Industrial Co.,Ltd."),
458 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
459 },
460 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700461 {},
462};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200463#endif /* CONFIG_SUSPEND */
464
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200465#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki5d8b5322009-01-16 23:09:14 +0100466/*
467 * The ACPI specification wants us to save NVS memory regions during hibernation
468 * and to restore them during the subsequent resume. However, it is not certain
469 * if this mechanism is going to work on all machines, so we allow the user to
470 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
471 * option.
472 */
473static bool s4_no_nvs;
474
475void __init acpi_s4_no_nvs(void)
476{
477 s4_no_nvs = true;
478}
479
Shaohua Libdfe6b72008-07-23 21:28:41 -0700480static unsigned long s4_hardware_signature;
481static struct acpi_table_facs *facs;
482static bool nosigcheck;
483
484void __init acpi_no_s4_hw_signature(void)
485{
486 nosigcheck = true;
487}
488
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100489static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700490{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100491 int error;
492
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100493 error = s4_no_nvs ? 0 : hibernate_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100494 if (!error) {
495 acpi_target_sleep_state = ACPI_STATE_S4;
496 acpi_sleep_tts_switch(acpi_target_sleep_state);
497 }
498
499 return error;
500}
501
502static int acpi_hibernation_pre_snapshot(void)
503{
504 int error = acpi_pm_prepare();
505
506 if (!error)
507 hibernate_nvs_save();
508
509 return error;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700510}
511
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700512static int acpi_hibernation_enter(void)
513{
514 acpi_status status = AE_OK;
515 unsigned long flags = 0;
516
517 ACPI_FLUSH_CPU_CACHE();
518
519 local_irq_save(flags);
520 acpi_enable_wakeup_device(ACPI_STATE_S4);
521 /* This shouldn't return. If it returns, we have a problem */
522 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100523 /* Reprogram control registers and execute _BFS */
524 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700525 local_irq_restore(flags);
526
527 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
528}
529
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100530static void acpi_hibernation_finish(void)
531{
532 hibernate_nvs_free();
533 acpi_pm_finish();
534}
535
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700536static void acpi_hibernation_leave(void)
537{
538 /*
539 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
540 * enable it here.
541 */
542 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100543 /* Reprogram control registers and execute _BFS */
544 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700545 /* Check the hardware signature */
546 if (facs && s4_hardware_signature != facs->hardware_signature) {
547 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
548 "cannot resume!\n");
549 panic("ACPI S4 hardware signature mismatch");
550 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100551 /* Restore the NVS memory area */
552 hibernate_nvs_restore();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700553}
554
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200555static void acpi_pm_enable_gpes(void)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700556{
Lin Ming3d97e422008-12-16 16:57:46 +0800557 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700558}
559
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700560static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100561 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200562 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100563 .pre_snapshot = acpi_hibernation_pre_snapshot,
564 .finish = acpi_hibernation_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200565 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700566 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700567 .leave = acpi_hibernation_leave,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200568 .pre_restore = acpi_pm_disable_gpes,
569 .restore_cleanup = acpi_pm_enable_gpes,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700570};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200571
572/**
573 * acpi_hibernation_begin_old - Set the target system sleep state to
574 * ACPI_STATE_S4 and execute the _PTS control method. This
575 * function is used if the pre-ACPI 2.0 suspend ordering has been
576 * requested.
577 */
578static int acpi_hibernation_begin_old(void)
579{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800580 int error;
581 /*
582 * The _TTS object should always be evaluated before the _PTS object.
583 * When the old_suspended_ordering is true, the _PTS object is
584 * evaluated in the acpi_sleep_prepare.
585 */
586 acpi_sleep_tts_switch(ACPI_STATE_S4);
587
588 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200589
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100590 if (!error) {
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100591 if (!s4_no_nvs)
592 error = hibernate_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100593 if (!error)
594 acpi_target_sleep_state = ACPI_STATE_S4;
595 }
596 return error;
597}
598
599static int acpi_hibernation_pre_snapshot_old(void)
600{
601 int error = acpi_pm_disable_gpes();
602
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200603 if (!error)
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100604 hibernate_nvs_save();
605
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200606 return error;
607}
608
609/*
610 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
611 * been requested.
612 */
613static struct platform_hibernation_ops acpi_hibernation_ops_old = {
614 .begin = acpi_hibernation_begin_old,
615 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100616 .pre_snapshot = acpi_hibernation_pre_snapshot_old,
617 .finish = acpi_hibernation_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200618 .prepare = acpi_pm_disable_gpes,
619 .enter = acpi_hibernation_enter,
620 .leave = acpi_hibernation_leave,
621 .pre_restore = acpi_pm_disable_gpes,
622 .restore_cleanup = acpi_pm_enable_gpes,
623 .recover = acpi_pm_finish,
624};
625#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700626
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200627int acpi_suspend(u32 acpi_state)
628{
629 suspend_state_t states[] = {
630 [1] = PM_SUSPEND_STANDBY,
631 [3] = PM_SUSPEND_MEM,
632 [5] = PM_SUSPEND_MAX
633 };
634
635 if (acpi_state < 6 && states[acpi_state])
636 return pm_suspend(states[acpi_state]);
637 if (acpi_state == 4)
638 return hibernate();
639 return -EINVAL;
640}
641
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400642#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200643/**
644 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
645 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200646 * @dev: device to examine; its driver model wakeup flags control
647 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200648 * @d_min_p: used to store the upper limit of allowed states range
649 * Return value: preferred power state of the device on success, -ENODEV on
650 * failure (ie. if there's no 'struct acpi_device' for @dev)
651 *
652 * Find the lowest power (highest number) ACPI device power state that
653 * device @dev can be in while the system is in the sleep state represented
654 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
655 * able to wake up the system from this sleep state. If @d_min_p is set,
656 * the highest power (lowest number) device power state of @dev allowed
657 * in this system sleep state is stored at the location pointed to by it.
658 *
659 * The caller must ensure that @dev is valid before using this function.
660 * The caller is also responsible for figuring out if the device is
661 * supposed to be able to wake up the system and passing this information
662 * via @wake.
663 */
664
David Brownell2fe2de52008-06-05 01:15:40 +0200665int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200666{
667 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
668 struct acpi_device *adev;
669 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400670 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200671
672 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800673 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200674 return -ENODEV;
675 }
676
677 acpi_method[2] = '0' + acpi_target_sleep_state;
678 /*
679 * If the sleep state is S0, we will return D3, but if the device has
680 * _S0W, we will use the value from _S0W
681 */
682 d_min = ACPI_STATE_D0;
683 d_max = ACPI_STATE_D3;
684
685 /*
686 * If present, _SxD methods return the minimum D-state (highest power
687 * state) we can use for the corresponding S-states. Otherwise, the
688 * minimum D-state is D0 (ACPI 3.x).
689 *
690 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
691 * provided -- that's our fault recovery, we ignore retval.
692 */
693 if (acpi_target_sleep_state > ACPI_STATE_S0)
694 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
695
696 /*
697 * If _PRW says we can wake up the system from the target sleep state,
698 * the D-state returned by _SxD is sufficient for that (we assume a
699 * wakeup-aware driver if wake is set). Still, if _SxW exists
700 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
701 * can wake the system. _S0W may be valid, too.
702 */
703 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200704 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200705 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100706 acpi_status status;
707
Shaohua Lifd4aff12007-07-17 22:40:25 +0200708 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100709 status = acpi_evaluate_integer(handle, acpi_method, NULL,
710 &d_max);
711 if (ACPI_FAILURE(status)) {
712 d_max = d_min;
713 } else if (d_max < d_min) {
714 /* Warn the user of the broken DSDT */
715 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
716 acpi_method);
717 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200718 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100719 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200720 }
721
722 if (d_min_p)
723 *d_min_p = d_min;
724 return d_max;
725}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200726
727/**
728 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
729 * capability of given device
730 * @dev: device to handle
731 * @enable: 'true' - enable, 'false' - disable the wake-up capability
732 */
733int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
734{
735 acpi_handle handle;
736 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200737 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200738
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200739 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200740 return -EINVAL;
741
742 handle = DEVICE_ACPI_HANDLE(dev);
743 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200744 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200745 return -ENODEV;
746 }
747
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +0100748 if (enable) {
749 error = acpi_enable_wakeup_device_power(adev,
750 acpi_target_sleep_state);
751 if (!error)
752 acpi_enable_gpe(adev->wakeup.gpe_device,
753 adev->wakeup.gpe_number,
754 ACPI_GPE_TYPE_WAKE);
755 } else {
756 acpi_disable_gpe(adev->wakeup.gpe_device, adev->wakeup.gpe_number,
757 ACPI_GPE_TYPE_WAKE);
758 error = acpi_disable_wakeup_device_power(adev);
759 }
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200760 if (!error)
761 dev_info(dev, "wake-up capability %s by ACPI\n",
762 enable ? "enabled" : "disabled");
763
764 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200765}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400766#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200767
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400768static void acpi_power_off_prepare(void)
769{
770 /* Prepare to power off the system */
771 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800772 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400773}
774
775static void acpi_power_off(void)
776{
777 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100778 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400779 local_irq_disable();
Alexey Starikovskiy9c1c6a12007-10-22 14:18:06 +0400780 acpi_enable_wakeup_device(ACPI_STATE_S5);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400781 acpi_enter_sleep_state(ACPI_STATE_S5);
782}
783
Len Brown96f15ef2009-04-17 23:32:20 -0400784/*
785 * ACPI 2.0 created the optional _GTS and _BFS,
786 * but industry adoption has been neither rapid nor broad.
787 *
788 * Linux gets into trouble when it executes poorly validated
789 * paths through the BIOS, so disable _GTS and _BFS by default,
790 * but do speak up and offer the option to enable them.
791 */
792void __init acpi_gts_bfs_check(void)
793{
794 acpi_handle dummy;
795
796 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
797 {
798 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
799 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
800 "please notify linux-acpi@vger.kernel.org\n");
801 }
802 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
803 {
804 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
805 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
806 "please notify linux-acpi@vger.kernel.org\n");
807 }
808}
809
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500810int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200812 acpi_status status;
813 u8 type_a, type_b;
814#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500815 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700816
817 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200818#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820 if (acpi_disabled)
821 return 0;
822
Frans Pop5a50fe72007-09-20 22:27:44 +0200823 sleep_states[ACPI_STATE_S0] = 1;
824 printk(KERN_INFO PREFIX "(supports S0");
825
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200826#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200827 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
829 if (ACPI_SUCCESS(status)) {
830 sleep_states[i] = 1;
831 printk(" S%d", i);
832 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200835 suspend_set_ops(old_suspend_ordering ?
836 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200837#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700838
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200839#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200840 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
841 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200842 hibernation_set_ops(old_suspend_ordering ?
843 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200844 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400845 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700846 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800847 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700848 (struct acpi_table_header **)&facs);
849 if (facs)
850 s4_hardware_signature =
851 facs->hardware_signature;
852 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200853 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700854#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400855 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
856 if (ACPI_SUCCESS(status)) {
857 sleep_states[ACPI_STATE_S5] = 1;
858 printk(" S5");
859 pm_power_off_prepare = acpi_power_off_prepare;
860 pm_power_off = acpi_power_off;
861 }
862 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800863 /*
864 * Register the tts_notifier to reboot notifier list so that the _TTS
865 * object can also be evaluated when the system enters S5.
866 */
867 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400868 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 return 0;
870}