blob: 5f2c379ab7bfba1903158f5c3f94cf37631a6c44 [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/*
84 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
85 * user to request that behavior by using the 'acpi_old_suspend_ordering'
86 * kernel command line option that causes the following variable to be set.
87 */
88static bool old_suspend_ordering;
89
90void __init acpi_old_suspend_ordering(void)
91{
92 old_suspend_ordering = true;
93}
94
95/**
96 * acpi_pm_disable_gpes - Disable the GPEs.
97 */
98static int acpi_pm_disable_gpes(void)
99{
Lin Ming3d97e422008-12-16 16:57:46 +0800100 acpi_disable_all_gpes();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200101 return 0;
102}
103
104/**
105 * __acpi_pm_prepare - Prepare the platform to enter the target state.
106 *
107 * If necessary, set the firmware waking vector and do arch-specific
108 * nastiness to get the wakeup code to the waking vector.
109 */
110static int __acpi_pm_prepare(void)
111{
112 int error = acpi_sleep_prepare(acpi_target_sleep_state);
113
114 if (error)
115 acpi_target_sleep_state = ACPI_STATE_S0;
116 return error;
117}
118
119/**
120 * acpi_pm_prepare - Prepare the platform to enter the target sleep
121 * state and disable the GPEs.
122 */
123static int acpi_pm_prepare(void)
124{
125 int error = __acpi_pm_prepare();
126
127 if (!error)
Lin Ming3d97e422008-12-16 16:57:46 +0800128 acpi_disable_all_gpes();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200129 return error;
130}
131
132/**
133 * acpi_pm_finish - Instruct the platform to leave a sleep state.
134 *
135 * This is called after we wake back up (or if entering the sleep state
136 * failed).
137 */
138static void acpi_pm_finish(void)
139{
140 u32 acpi_state = acpi_target_sleep_state;
141
142 if (acpi_state == ACPI_STATE_S0)
143 return;
144
145 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
146 acpi_state);
147 acpi_disable_wakeup_device(acpi_state);
148 acpi_leave_sleep_state(acpi_state);
149
150 /* reset firmware waking vector */
151 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
152
153 acpi_target_sleep_state = ACPI_STATE_S0;
154}
155
156/**
157 * acpi_pm_end - Finish up suspend sequence.
158 */
159static void acpi_pm_end(void)
160{
161 /*
162 * This is necessary in case acpi_pm_finish() is not called during a
163 * failing transition to a sleep state.
164 */
165 acpi_target_sleep_state = ACPI_STATE_S0;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800166 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200167}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200168#else /* !CONFIG_ACPI_SLEEP */
169#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400170#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200171
172#ifdef CONFIG_SUSPEND
Rafael J. Wysocki5d8b5322009-01-16 23:09:14 +0100173/*
174 * According to the ACPI specification the BIOS should make sure that ACPI is
175 * enabled and SCI_EN bit is set on wake-up from S1 - S3 sleep states. Still,
176 * some BIOSes don't do that and therefore we use acpi_enable() to enable ACPI
177 * on such systems during resume. Unfortunately that doesn't help in
178 * particularly pathological cases in which SCI_EN has to be set directly on
179 * resume, although the specification states very clearly that this flag is
180 * owned by the hardware. The set_sci_en_on_resume variable will be set in such
181 * cases.
182 */
183static bool set_sci_en_on_resume;
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185extern void do_suspend_lowlevel(void);
186
187static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500188 [PM_SUSPEND_ON] = ACPI_STATE_S0,
189 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
190 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500191 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192};
193
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200194/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400195 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200196 * associated with given @pm_state, if supported.
197 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400198static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199{
200 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200201 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200203 if (sleep_states[acpi_state]) {
204 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800205 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200206 } else {
207 printk(KERN_ERR "ACPI does not support this state: %d\n",
208 pm_state);
209 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200211 return error;
212}
213
214/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400215 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200216 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200218 * Flush caches and go to sleep. For STR we have to call arch-specific
219 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 * It's unfortunate, but it works. Please fix if you're feeling frisky.
221 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400222static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
224 acpi_status status = AE_OK;
225 unsigned long flags = 0;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200226 u32 acpi_state = acpi_target_sleep_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
228 ACPI_FLUSH_CPU_CACHE();
229
230 /* Do arch specific saving of state. */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200231 if (acpi_state == ACPI_STATE_S3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 int error = acpi_save_state_mem();
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200233
Rafael J. Wysocki60417f52008-01-08 00:07:39 +0100234 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 return error;
236 }
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 local_irq_save(flags);
239 acpi_enable_wakeup_device(acpi_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200240 switch (acpi_state) {
241 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 barrier();
243 status = acpi_enter_sleep_state(acpi_state);
244 break;
245
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200246 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 do_suspend_lowlevel();
248 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400250
Rafael J. Wysockid0c71fe2008-10-04 00:05:05 +0200251 /* If ACPI is not enabled by the BIOS, we need to enable it here. */
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500252 if (set_sci_en_on_resume)
Bob Moore50ffba12009-02-23 15:02:07 +0800253 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500254 else
255 acpi_enable();
256
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100257 /* Reprogram control registers and execute _BFS */
258 acpi_leave_sleep_state_prep(acpi_state);
259
Pavel Machek23b168d2008-02-05 19:27:12 +0100260 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400261 * of the OSPM to clear the status bit [ implying that the
262 * POWER_BUTTON event should not reach userspace ]
263 */
264 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
265 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
266
Shaohua Lia3627f62007-06-20 09:17:58 +0800267 /*
268 * Disable and clear GPE status before interrupt is enabled. Some GPEs
269 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
270 * acpi_leave_sleep_state will reenable specific GPEs later
271 */
Lin Ming3d97e422008-12-16 16:57:46 +0800272 acpi_disable_all_gpes();
Shaohua Lia3627f62007-06-20 09:17:58 +0800273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 local_irq_restore(flags);
275 printk(KERN_DEBUG "Back to C!\n");
276
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200277 /* restore processor state */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200278 if (acpi_state == ACPI_STATE_S3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 acpi_restore_state_mem();
280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
282}
283
Len Brown2c6e33c2008-04-23 18:02:52 -0400284static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800285{
Johannes Berge8c9c502007-04-30 15:09:54 -0700286 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800287
Johannes Berge8c9c502007-04-30 15:09:54 -0700288 switch (pm_state) {
289 case PM_SUSPEND_ON:
290 case PM_SUSPEND_STANDBY:
291 case PM_SUSPEND_MEM:
292 acpi_state = acpi_suspend_states[pm_state];
293
294 return sleep_states[acpi_state];
295 default:
296 return 0;
297 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800298}
299
Len Brown2c6e33c2008-04-23 18:02:52 -0400300static struct platform_suspend_ops acpi_suspend_ops = {
301 .valid = acpi_suspend_state_valid,
302 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200303 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400304 .enter = acpi_suspend_enter,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200305 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200306 .end = acpi_pm_end,
307};
308
309/**
310 * acpi_suspend_begin_old - Set the target system sleep state to the
311 * state associated with given @pm_state, if supported, and
312 * execute the _PTS control method. This function is used if the
313 * pre-ACPI 2.0 suspend ordering has been requested.
314 */
315static int acpi_suspend_begin_old(suspend_state_t pm_state)
316{
317 int error = acpi_suspend_begin(pm_state);
318
319 if (!error)
320 error = __acpi_pm_prepare();
321 return error;
322}
323
324/*
325 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
326 * been requested.
327 */
328static struct platform_suspend_ops acpi_suspend_ops_old = {
329 .valid = acpi_suspend_state_valid,
330 .begin = acpi_suspend_begin_old,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200331 .prepare_late = acpi_pm_disable_gpes,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200332 .enter = acpi_suspend_enter,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200333 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200334 .end = acpi_pm_end,
335 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700337
338static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
339{
340 old_suspend_ordering = true;
341 return 0;
342}
343
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500344static int __init init_set_sci_en_on_resume(const struct dmi_system_id *d)
345{
346 set_sci_en_on_resume = true;
347 return 0;
348}
349
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700350static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
351 {
352 .callback = init_old_suspend_ordering,
353 .ident = "Abit KN9 (nForce4 variant)",
354 .matches = {
355 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
356 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
357 },
358 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200359 {
360 .callback = init_old_suspend_ordering,
361 .ident = "HP xw4600 Workstation",
362 .matches = {
363 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
364 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
365 },
366 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500367 {
368 .callback = init_set_sci_en_on_resume,
369 .ident = "Apple MacBook 1,1",
370 .matches = {
371 DMI_MATCH(DMI_SYS_VENDOR, "Apple Computer, Inc."),
372 DMI_MATCH(DMI_PRODUCT_NAME, "MacBook1,1"),
373 },
374 },
375 {
376 .callback = init_set_sci_en_on_resume,
377 .ident = "Apple MacMini 1,1",
378 .matches = {
379 DMI_MATCH(DMI_SYS_VENDOR, "Apple Computer, Inc."),
380 DMI_MATCH(DMI_PRODUCT_NAME, "Macmini1,1"),
381 },
382 },
Andy Whitcrofta1404492009-02-11 18:11:22 +0000383 {
384 .callback = init_old_suspend_ordering,
385 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
386 .matches = {
387 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
388 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
389 },
390 },
Zhang Rui45e77982009-03-15 22:13:44 -0400391 {
392 .callback = init_set_sci_en_on_resume,
393 .ident = "Toshiba Satellite L300",
394 .matches = {
395 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
396 DMI_MATCH(DMI_PRODUCT_NAME, "Satellite L300"),
397 },
398 },
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800399 {
Bartlomiej Zolnierkiewiczec79be22009-07-29 21:07:47 +0200400 .callback = init_set_sci_en_on_resume,
401 .ident = "Hewlett-Packard HP G7000 Notebook PC",
402 .matches = {
403 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
404 DMI_MATCH(DMI_PRODUCT_NAME, "HP G7000 Notebook PC"),
405 },
406 },
407 {
Len Browneb0ca842009-08-29 22:39:06 -0400408 .callback = init_set_sci_en_on_resume,
409 .ident = "Hewlett-Packard HP Pavilion dv3 Notebook PC",
410 .matches = {
411 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
412 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion dv3 Notebook PC"),
413 },
414 },
415 {
Gustavo Maciel Dias Vieira8a1cbf62009-10-19 09:41:53 -0200416 .callback = init_set_sci_en_on_resume,
417 .ident = "Hewlett-Packard Pavilion dv4",
418 .matches = {
419 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
420 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion dv4"),
421 },
422 },
423 {
Vaibhav Verma2839d392009-11-05 23:13:36 -0500424 .callback = init_set_sci_en_on_resume,
425 .ident = "Hewlett-Packard Pavilion dv7",
426 .matches = {
427 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
428 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion dv7"),
429 },
430 },
431 {
432 .callback = init_set_sci_en_on_resume,
Len Brown87c687b2009-11-23 11:44:12 -0500433 .ident = "Hewlett-Packard Compaq Presario C700 Notebook PC",
434 .matches = {
435 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
436 DMI_MATCH(DMI_PRODUCT_NAME, "Compaq Presario C700 Notebook PC"),
437 },
438 },
439 {
440 .callback = init_set_sci_en_on_resume,
Vaibhav Verma2839d392009-11-05 23:13:36 -0500441 .ident = "Hewlett-Packard Compaq Presario CQ40 Notebook PC",
442 .matches = {
443 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
444 DMI_MATCH(DMI_PRODUCT_NAME, "Compaq Presario CQ40 Notebook PC"),
445 },
446 },
447 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800448 .callback = init_old_suspend_ordering,
449 .ident = "Panasonic CF51-2L",
450 .matches = {
451 DMI_MATCH(DMI_BOARD_VENDOR,
452 "Matsushita Electric Industrial Co.,Ltd."),
453 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
454 },
455 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700456 {},
457};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200458#endif /* CONFIG_SUSPEND */
459
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200460#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki5d8b5322009-01-16 23:09:14 +0100461/*
462 * The ACPI specification wants us to save NVS memory regions during hibernation
463 * and to restore them during the subsequent resume. However, it is not certain
464 * if this mechanism is going to work on all machines, so we allow the user to
465 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
466 * option.
467 */
468static bool s4_no_nvs;
469
470void __init acpi_s4_no_nvs(void)
471{
472 s4_no_nvs = true;
473}
474
Shaohua Libdfe6b72008-07-23 21:28:41 -0700475static unsigned long s4_hardware_signature;
476static struct acpi_table_facs *facs;
477static bool nosigcheck;
478
479void __init acpi_no_s4_hw_signature(void)
480{
481 nosigcheck = true;
482}
483
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100484static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700485{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100486 int error;
487
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100488 error = s4_no_nvs ? 0 : hibernate_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100489 if (!error) {
490 acpi_target_sleep_state = ACPI_STATE_S4;
491 acpi_sleep_tts_switch(acpi_target_sleep_state);
492 }
493
494 return error;
495}
496
497static int acpi_hibernation_pre_snapshot(void)
498{
499 int error = acpi_pm_prepare();
500
501 if (!error)
502 hibernate_nvs_save();
503
504 return error;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700505}
506
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700507static int acpi_hibernation_enter(void)
508{
509 acpi_status status = AE_OK;
510 unsigned long flags = 0;
511
512 ACPI_FLUSH_CPU_CACHE();
513
514 local_irq_save(flags);
515 acpi_enable_wakeup_device(ACPI_STATE_S4);
516 /* This shouldn't return. If it returns, we have a problem */
517 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100518 /* Reprogram control registers and execute _BFS */
519 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700520 local_irq_restore(flags);
521
522 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
523}
524
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100525static void acpi_hibernation_finish(void)
526{
527 hibernate_nvs_free();
528 acpi_pm_finish();
529}
530
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700531static void acpi_hibernation_leave(void)
532{
533 /*
534 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
535 * enable it here.
536 */
537 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100538 /* Reprogram control registers and execute _BFS */
539 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700540 /* Check the hardware signature */
541 if (facs && s4_hardware_signature != facs->hardware_signature) {
542 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
543 "cannot resume!\n");
544 panic("ACPI S4 hardware signature mismatch");
545 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100546 /* Restore the NVS memory area */
547 hibernate_nvs_restore();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700548}
549
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200550static void acpi_pm_enable_gpes(void)
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700551{
Lin Ming3d97e422008-12-16 16:57:46 +0800552 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700553}
554
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700555static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100556 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200557 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100558 .pre_snapshot = acpi_hibernation_pre_snapshot,
559 .finish = acpi_hibernation_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200560 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700561 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700562 .leave = acpi_hibernation_leave,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200563 .pre_restore = acpi_pm_disable_gpes,
564 .restore_cleanup = acpi_pm_enable_gpes,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700565};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200566
567/**
568 * acpi_hibernation_begin_old - Set the target system sleep state to
569 * ACPI_STATE_S4 and execute the _PTS control method. This
570 * function is used if the pre-ACPI 2.0 suspend ordering has been
571 * requested.
572 */
573static int acpi_hibernation_begin_old(void)
574{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800575 int error;
576 /*
577 * The _TTS object should always be evaluated before the _PTS object.
578 * When the old_suspended_ordering is true, the _PTS object is
579 * evaluated in the acpi_sleep_prepare.
580 */
581 acpi_sleep_tts_switch(ACPI_STATE_S4);
582
583 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200584
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100585 if (!error) {
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100586 if (!s4_no_nvs)
587 error = hibernate_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100588 if (!error)
589 acpi_target_sleep_state = ACPI_STATE_S4;
590 }
591 return error;
592}
593
594static int acpi_hibernation_pre_snapshot_old(void)
595{
596 int error = acpi_pm_disable_gpes();
597
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200598 if (!error)
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100599 hibernate_nvs_save();
600
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200601 return error;
602}
603
604/*
605 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
606 * been requested.
607 */
608static struct platform_hibernation_ops acpi_hibernation_ops_old = {
609 .begin = acpi_hibernation_begin_old,
610 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100611 .pre_snapshot = acpi_hibernation_pre_snapshot_old,
612 .finish = acpi_hibernation_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200613 .prepare = acpi_pm_disable_gpes,
614 .enter = acpi_hibernation_enter,
615 .leave = acpi_hibernation_leave,
616 .pre_restore = acpi_pm_disable_gpes,
617 .restore_cleanup = acpi_pm_enable_gpes,
618 .recover = acpi_pm_finish,
619};
620#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700621
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200622int acpi_suspend(u32 acpi_state)
623{
624 suspend_state_t states[] = {
625 [1] = PM_SUSPEND_STANDBY,
626 [3] = PM_SUSPEND_MEM,
627 [5] = PM_SUSPEND_MAX
628 };
629
630 if (acpi_state < 6 && states[acpi_state])
631 return pm_suspend(states[acpi_state]);
632 if (acpi_state == 4)
633 return hibernate();
634 return -EINVAL;
635}
636
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400637#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200638/**
639 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
640 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200641 * @dev: device to examine; its driver model wakeup flags control
642 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200643 * @d_min_p: used to store the upper limit of allowed states range
644 * Return value: preferred power state of the device on success, -ENODEV on
645 * failure (ie. if there's no 'struct acpi_device' for @dev)
646 *
647 * Find the lowest power (highest number) ACPI device power state that
648 * device @dev can be in while the system is in the sleep state represented
649 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
650 * able to wake up the system from this sleep state. If @d_min_p is set,
651 * the highest power (lowest number) device power state of @dev allowed
652 * in this system sleep state is stored at the location pointed to by it.
653 *
654 * The caller must ensure that @dev is valid before using this function.
655 * The caller is also responsible for figuring out if the device is
656 * supposed to be able to wake up the system and passing this information
657 * via @wake.
658 */
659
David Brownell2fe2de52008-06-05 01:15:40 +0200660int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200661{
662 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
663 struct acpi_device *adev;
664 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400665 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200666
667 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800668 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200669 return -ENODEV;
670 }
671
672 acpi_method[2] = '0' + acpi_target_sleep_state;
673 /*
674 * If the sleep state is S0, we will return D3, but if the device has
675 * _S0W, we will use the value from _S0W
676 */
677 d_min = ACPI_STATE_D0;
678 d_max = ACPI_STATE_D3;
679
680 /*
681 * If present, _SxD methods return the minimum D-state (highest power
682 * state) we can use for the corresponding S-states. Otherwise, the
683 * minimum D-state is D0 (ACPI 3.x).
684 *
685 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
686 * provided -- that's our fault recovery, we ignore retval.
687 */
688 if (acpi_target_sleep_state > ACPI_STATE_S0)
689 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
690
691 /*
692 * If _PRW says we can wake up the system from the target sleep state,
693 * the D-state returned by _SxD is sufficient for that (we assume a
694 * wakeup-aware driver if wake is set). Still, if _SxW exists
695 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
696 * can wake the system. _S0W may be valid, too.
697 */
698 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200699 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200700 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100701 acpi_status status;
702
Shaohua Lifd4aff12007-07-17 22:40:25 +0200703 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100704 status = acpi_evaluate_integer(handle, acpi_method, NULL,
705 &d_max);
706 if (ACPI_FAILURE(status)) {
707 d_max = d_min;
708 } else if (d_max < d_min) {
709 /* Warn the user of the broken DSDT */
710 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
711 acpi_method);
712 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200713 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100714 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200715 }
716
717 if (d_min_p)
718 *d_min_p = d_min;
719 return d_max;
720}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200721
722/**
723 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
724 * capability of given device
725 * @dev: device to handle
726 * @enable: 'true' - enable, 'false' - disable the wake-up capability
727 */
728int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
729{
730 acpi_handle handle;
731 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200732 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200733
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200734 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200735 return -EINVAL;
736
737 handle = DEVICE_ACPI_HANDLE(dev);
738 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200739 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200740 return -ENODEV;
741 }
742
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200743 error = enable ?
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200744 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
745 acpi_disable_wakeup_device_power(adev);
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200746 if (!error)
747 dev_info(dev, "wake-up capability %s by ACPI\n",
748 enable ? "enabled" : "disabled");
749
750 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200751}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400752#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200753
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400754static void acpi_power_off_prepare(void)
755{
756 /* Prepare to power off the system */
757 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800758 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400759}
760
761static void acpi_power_off(void)
762{
763 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100764 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400765 local_irq_disable();
Alexey Starikovskiy9c1c6a12007-10-22 14:18:06 +0400766 acpi_enable_wakeup_device(ACPI_STATE_S5);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400767 acpi_enter_sleep_state(ACPI_STATE_S5);
768}
769
Len Brown96f15ef2009-04-17 23:32:20 -0400770/*
771 * ACPI 2.0 created the optional _GTS and _BFS,
772 * but industry adoption has been neither rapid nor broad.
773 *
774 * Linux gets into trouble when it executes poorly validated
775 * paths through the BIOS, so disable _GTS and _BFS by default,
776 * but do speak up and offer the option to enable them.
777 */
778void __init acpi_gts_bfs_check(void)
779{
780 acpi_handle dummy;
781
782 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
783 {
784 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
785 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
786 "please notify linux-acpi@vger.kernel.org\n");
787 }
788 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
789 {
790 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
791 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
792 "please notify linux-acpi@vger.kernel.org\n");
793 }
794}
795
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500796int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200798 acpi_status status;
799 u8 type_a, type_b;
800#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500801 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700802
803 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200804#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
806 if (acpi_disabled)
807 return 0;
808
Frans Pop5a50fe72007-09-20 22:27:44 +0200809 sleep_states[ACPI_STATE_S0] = 1;
810 printk(KERN_INFO PREFIX "(supports S0");
811
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200812#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200813 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
815 if (ACPI_SUCCESS(status)) {
816 sleep_states[i] = 1;
817 printk(" S%d", i);
818 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200821 suspend_set_ops(old_suspend_ordering ?
822 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200823#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700824
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200825#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200826 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
827 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200828 hibernation_set_ops(old_suspend_ordering ?
829 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200830 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400831 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700832 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800833 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700834 (struct acpi_table_header **)&facs);
835 if (facs)
836 s4_hardware_signature =
837 facs->hardware_signature;
838 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200839 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700840#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400841 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
842 if (ACPI_SUCCESS(status)) {
843 sleep_states[ACPI_STATE_S5] = 1;
844 printk(" S5");
845 pm_power_off_prepare = acpi_power_off_prepare;
846 pm_power_off = acpi_power_off;
847 }
848 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800849 /*
850 * Register the tts_notifier to reboot notifier list so that the _TTS
851 * object can also be evaluated when the system enters S5.
852 */
853 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400854 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 return 0;
856}