blob: 2862c781b37266aecee8052dac047aa2bcb31ef2 [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;
Zhang Ruid7f0eea2009-12-30 15:36:42 +080083
84/*
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +020085 * 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
98/*
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +020099 * 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/**
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200111 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200112 */
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200113static int acpi_pm_freeze(void)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200114{
Lin Ming3d97e422008-12-16 16:57:46 +0800115 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200116 acpi_os_wait_events_complete(NULL);
Rafael J. Wysockife955682010-04-09 01:40:38 +0200117 acpi_ec_block_transactions();
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
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400131 suspend_nvs_save();
132
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200133 if (error)
134 acpi_target_sleep_state = ACPI_STATE_S0;
135 return error;
136}
137
138/**
139 * acpi_pm_prepare - Prepare the platform to enter the target sleep
140 * state and disable the GPEs.
141 */
142static int acpi_pm_prepare(void)
143{
144 int error = __acpi_pm_prepare();
145
146 if (!error)
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200147 acpi_pm_freeze();
148
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200149 return error;
150}
151
152/**
153 * acpi_pm_finish - Instruct the platform to leave a sleep state.
154 *
155 * This is called after we wake back up (or if entering the sleep state
156 * failed).
157 */
158static void acpi_pm_finish(void)
159{
160 u32 acpi_state = acpi_target_sleep_state;
161
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400162 suspend_nvs_free();
Len Brown42de55322010-06-12 01:15:40 -0400163 acpi_ec_unblock_transactions();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400164
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200165 if (acpi_state == ACPI_STATE_S0)
166 return;
167
168 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
169 acpi_state);
170 acpi_disable_wakeup_device(acpi_state);
171 acpi_leave_sleep_state(acpi_state);
172
173 /* reset firmware waking vector */
174 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
175
176 acpi_target_sleep_state = ACPI_STATE_S0;
177}
178
179/**
180 * acpi_pm_end - Finish up suspend sequence.
181 */
182static void acpi_pm_end(void)
183{
184 /*
185 * This is necessary in case acpi_pm_finish() is not called during a
186 * failing transition to a sleep state.
187 */
188 acpi_target_sleep_state = ACPI_STATE_S0;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800189 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200190}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200191#else /* !CONFIG_ACPI_SLEEP */
192#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400193#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200194
195#ifdef CONFIG_SUSPEND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196extern void do_suspend_lowlevel(void);
197
198static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500199 [PM_SUSPEND_ON] = ACPI_STATE_S0,
200 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
201 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500202 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203};
204
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200205/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400206 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200207 * associated with given @pm_state, if supported.
208 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400209static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210{
211 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200212 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200214 error = nvs_nosave ? 0 : suspend_nvs_alloc();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400215 if (error)
216 return error;
217
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200218 if (sleep_states[acpi_state]) {
219 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800220 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200221 } else {
222 printk(KERN_ERR "ACPI does not support this state: %d\n",
223 pm_state);
224 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200226 return error;
227}
228
229/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400230 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200231 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200233 * Flush caches and go to sleep. For STR we have to call arch-specific
234 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 * It's unfortunate, but it works. Please fix if you're feeling frisky.
236 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400237static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
239 acpi_status status = AE_OK;
240 unsigned long flags = 0;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200241 u32 acpi_state = acpi_target_sleep_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 ACPI_FLUSH_CPU_CACHE();
244
245 /* Do arch specific saving of state. */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200246 if (acpi_state == ACPI_STATE_S3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 int error = acpi_save_state_mem();
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200248
Rafael J. Wysocki60417f52008-01-08 00:07:39 +0100249 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 return error;
251 }
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 local_irq_save(flags);
254 acpi_enable_wakeup_device(acpi_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200255 switch (acpi_state) {
256 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 barrier();
258 status = acpi_enter_sleep_state(acpi_state);
259 break;
260
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200261 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 do_suspend_lowlevel();
263 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400265
Matthew Garrettb6dacf62010-05-11 13:49:25 -0400266 /* This violates the spec but is required for bug compatibility. */
267 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500268
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100269 /* Reprogram control registers and execute _BFS */
270 acpi_leave_sleep_state_prep(acpi_state);
271
Pavel Machek23b168d2008-02-05 19:27:12 +0100272 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400273 * of the OSPM to clear the status bit [ implying that the
274 * POWER_BUTTON event should not reach userspace ]
275 */
276 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
277 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
278
Shaohua Lia3627f62007-06-20 09:17:58 +0800279 /*
280 * Disable and clear GPE status before interrupt is enabled. Some GPEs
281 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
282 * acpi_leave_sleep_state will reenable specific GPEs later
283 */
Lin Ming3d97e422008-12-16 16:57:46 +0800284 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200285 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200286 acpi_ec_unblock_transactions_early();
Shaohua Lia3627f62007-06-20 09:17:58 +0800287
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 local_irq_restore(flags);
289 printk(KERN_DEBUG "Back to C!\n");
290
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200291 /* restore processor state */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200292 if (acpi_state == ACPI_STATE_S3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 acpi_restore_state_mem();
294
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400295 suspend_nvs_restore();
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
298}
299
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200300static void acpi_suspend_finish(void)
301{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200302 acpi_pm_finish();
303}
304
Len Brown2c6e33c2008-04-23 18:02:52 -0400305static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800306{
Johannes Berge8c9c502007-04-30 15:09:54 -0700307 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800308
Johannes Berge8c9c502007-04-30 15:09:54 -0700309 switch (pm_state) {
310 case PM_SUSPEND_ON:
311 case PM_SUSPEND_STANDBY:
312 case PM_SUSPEND_MEM:
313 acpi_state = acpi_suspend_states[pm_state];
314
315 return sleep_states[acpi_state];
316 default:
317 return 0;
318 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800319}
320
Len Brown2c6e33c2008-04-23 18:02:52 -0400321static struct platform_suspend_ops acpi_suspend_ops = {
322 .valid = acpi_suspend_state_valid,
323 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200324 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400325 .enter = acpi_suspend_enter,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200326 .wake = acpi_suspend_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200327 .end = acpi_pm_end,
328};
329
330/**
331 * acpi_suspend_begin_old - Set the target system sleep state to the
332 * state associated with given @pm_state, if supported, and
333 * execute the _PTS control method. This function is used if the
334 * pre-ACPI 2.0 suspend ordering has been requested.
335 */
336static int acpi_suspend_begin_old(suspend_state_t pm_state)
337{
338 int error = acpi_suspend_begin(pm_state);
339
340 if (!error)
341 error = __acpi_pm_prepare();
342 return error;
343}
344
345/*
346 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
347 * been requested.
348 */
349static struct platform_suspend_ops acpi_suspend_ops_old = {
350 .valid = acpi_suspend_state_valid,
351 .begin = acpi_suspend_begin_old,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200352 .prepare_late = acpi_pm_freeze,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200353 .enter = acpi_suspend_enter,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200354 .wake = acpi_suspend_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200355 .end = acpi_pm_end,
356 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700358
359static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
360{
361 old_suspend_ordering = true;
362 return 0;
363}
364
365static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
366 {
367 .callback = init_old_suspend_ordering,
368 .ident = "Abit KN9 (nForce4 variant)",
369 .matches = {
370 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
371 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
372 },
373 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200374 {
375 .callback = init_old_suspend_ordering,
376 .ident = "HP xw4600 Workstation",
377 .matches = {
378 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
379 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
380 },
381 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500382 {
Andy Whitcrofta1404492009-02-11 18:11:22 +0000383 .callback = init_old_suspend_ordering,
384 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
385 .matches = {
386 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
387 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
388 },
389 },
Zhang Rui45e77982009-03-15 22:13:44 -0400390 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800391 .callback = init_old_suspend_ordering,
392 .ident = "Panasonic CF51-2L",
393 .matches = {
394 DMI_MATCH(DMI_BOARD_VENDOR,
395 "Matsushita Electric Industrial Co.,Ltd."),
396 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
397 },
398 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700399 {},
400};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200401#endif /* CONFIG_SUSPEND */
402
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200403#ifdef CONFIG_HIBERNATION
Shaohua Libdfe6b72008-07-23 21:28:41 -0700404static unsigned long s4_hardware_signature;
405static struct acpi_table_facs *facs;
406static bool nosigcheck;
407
408void __init acpi_no_s4_hw_signature(void)
409{
410 nosigcheck = true;
411}
412
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100413static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700414{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100415 int error;
416
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200417 error = nvs_nosave ? 0 : suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100418 if (!error) {
419 acpi_target_sleep_state = ACPI_STATE_S4;
420 acpi_sleep_tts_switch(acpi_target_sleep_state);
421 }
422
423 return error;
424}
425
426static int acpi_hibernation_pre_snapshot(void)
427{
428 int error = acpi_pm_prepare();
429
430 if (!error)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400431 suspend_nvs_save();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100432
433 return error;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700434}
435
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700436static int acpi_hibernation_enter(void)
437{
438 acpi_status status = AE_OK;
439 unsigned long flags = 0;
440
441 ACPI_FLUSH_CPU_CACHE();
442
443 local_irq_save(flags);
444 acpi_enable_wakeup_device(ACPI_STATE_S4);
445 /* This shouldn't return. If it returns, we have a problem */
446 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100447 /* Reprogram control registers and execute _BFS */
448 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700449 local_irq_restore(flags);
450
451 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
452}
453
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700454static void acpi_hibernation_leave(void)
455{
456 /*
457 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
458 * enable it here.
459 */
460 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100461 /* Reprogram control registers and execute _BFS */
462 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700463 /* Check the hardware signature */
464 if (facs && s4_hardware_signature != facs->hardware_signature) {
465 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
466 "cannot resume!\n");
467 panic("ACPI S4 hardware signature mismatch");
468 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100469 /* Restore the NVS memory area */
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400470 suspend_nvs_restore();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200471 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200472 acpi_ec_unblock_transactions_early();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700473}
474
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200475static void acpi_pm_thaw(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +0100476{
Rafael J. Wysockife955682010-04-09 01:40:38 +0200477 acpi_ec_unblock_transactions();
Lin Ming3d97e422008-12-16 16:57:46 +0800478 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700479}
480
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700481static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100482 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200483 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100484 .pre_snapshot = acpi_hibernation_pre_snapshot,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400485 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200486 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700487 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700488 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200489 .pre_restore = acpi_pm_freeze,
490 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700491};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200492
493/**
494 * acpi_hibernation_begin_old - Set the target system sleep state to
495 * ACPI_STATE_S4 and execute the _PTS control method. This
496 * function is used if the pre-ACPI 2.0 suspend ordering has been
497 * requested.
498 */
499static int acpi_hibernation_begin_old(void)
500{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800501 int error;
502 /*
503 * The _TTS object should always be evaluated before the _PTS object.
504 * When the old_suspended_ordering is true, the _PTS object is
505 * evaluated in the acpi_sleep_prepare.
506 */
507 acpi_sleep_tts_switch(ACPI_STATE_S4);
508
509 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200510
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100511 if (!error) {
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200512 if (!nvs_nosave)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400513 error = suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100514 if (!error)
515 acpi_target_sleep_state = ACPI_STATE_S4;
516 }
517 return error;
518}
519
520static int acpi_hibernation_pre_snapshot_old(void)
521{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200522 acpi_pm_freeze();
Len Brown42de55322010-06-12 01:15:40 -0400523 suspend_nvs_save();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200524 return 0;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200525}
526
527/*
528 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
529 * been requested.
530 */
531static struct platform_hibernation_ops acpi_hibernation_ops_old = {
532 .begin = acpi_hibernation_begin_old,
533 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100534 .pre_snapshot = acpi_hibernation_pre_snapshot_old,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200535 .prepare = acpi_pm_freeze,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400536 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200537 .enter = acpi_hibernation_enter,
538 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200539 .pre_restore = acpi_pm_freeze,
540 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200541 .recover = acpi_pm_finish,
542};
543#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700544
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200545int acpi_suspend(u32 acpi_state)
546{
547 suspend_state_t states[] = {
548 [1] = PM_SUSPEND_STANDBY,
549 [3] = PM_SUSPEND_MEM,
550 [5] = PM_SUSPEND_MAX
551 };
552
553 if (acpi_state < 6 && states[acpi_state])
554 return pm_suspend(states[acpi_state]);
555 if (acpi_state == 4)
556 return hibernate();
557 return -EINVAL;
558}
559
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400560#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200561/**
562 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
563 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200564 * @dev: device to examine; its driver model wakeup flags control
565 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200566 * @d_min_p: used to store the upper limit of allowed states range
567 * Return value: preferred power state of the device on success, -ENODEV on
568 * failure (ie. if there's no 'struct acpi_device' for @dev)
569 *
570 * Find the lowest power (highest number) ACPI device power state that
571 * device @dev can be in while the system is in the sleep state represented
572 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
573 * able to wake up the system from this sleep state. If @d_min_p is set,
574 * the highest power (lowest number) device power state of @dev allowed
575 * in this system sleep state is stored at the location pointed to by it.
576 *
577 * The caller must ensure that @dev is valid before using this function.
578 * The caller is also responsible for figuring out if the device is
579 * supposed to be able to wake up the system and passing this information
580 * via @wake.
581 */
582
David Brownell2fe2de52008-06-05 01:15:40 +0200583int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200584{
585 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
586 struct acpi_device *adev;
587 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400588 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200589
590 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800591 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200592 return -ENODEV;
593 }
594
595 acpi_method[2] = '0' + acpi_target_sleep_state;
596 /*
597 * If the sleep state is S0, we will return D3, but if the device has
598 * _S0W, we will use the value from _S0W
599 */
600 d_min = ACPI_STATE_D0;
601 d_max = ACPI_STATE_D3;
602
603 /*
604 * If present, _SxD methods return the minimum D-state (highest power
605 * state) we can use for the corresponding S-states. Otherwise, the
606 * minimum D-state is D0 (ACPI 3.x).
607 *
608 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
609 * provided -- that's our fault recovery, we ignore retval.
610 */
611 if (acpi_target_sleep_state > ACPI_STATE_S0)
612 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
613
614 /*
615 * If _PRW says we can wake up the system from the target sleep state,
616 * the D-state returned by _SxD is sufficient for that (we assume a
617 * wakeup-aware driver if wake is set). Still, if _SxW exists
618 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
619 * can wake the system. _S0W may be valid, too.
620 */
621 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200622 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200623 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100624 acpi_status status;
625
Shaohua Lifd4aff12007-07-17 22:40:25 +0200626 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100627 status = acpi_evaluate_integer(handle, acpi_method, NULL,
628 &d_max);
629 if (ACPI_FAILURE(status)) {
630 d_max = d_min;
631 } else if (d_max < d_min) {
632 /* Warn the user of the broken DSDT */
633 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
634 acpi_method);
635 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200636 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100637 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200638 }
639
640 if (d_min_p)
641 *d_min_p = d_min;
642 return d_max;
643}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200644
645/**
646 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
647 * capability of given device
648 * @dev: device to handle
649 * @enable: 'true' - enable, 'false' - disable the wake-up capability
650 */
651int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
652{
653 acpi_handle handle;
654 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200655 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200656
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200657 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200658 return -EINVAL;
659
660 handle = DEVICE_ACPI_HANDLE(dev);
661 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200662 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200663 return -ENODEV;
664 }
665
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +0100666 if (enable) {
667 error = acpi_enable_wakeup_device_power(adev,
668 acpi_target_sleep_state);
669 if (!error)
670 acpi_enable_gpe(adev->wakeup.gpe_device,
671 adev->wakeup.gpe_number,
672 ACPI_GPE_TYPE_WAKE);
673 } else {
674 acpi_disable_gpe(adev->wakeup.gpe_device, adev->wakeup.gpe_number,
675 ACPI_GPE_TYPE_WAKE);
676 error = acpi_disable_wakeup_device_power(adev);
677 }
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200678 if (!error)
679 dev_info(dev, "wake-up capability %s by ACPI\n",
680 enable ? "enabled" : "disabled");
681
682 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200683}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400684#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200685
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400686static void acpi_power_off_prepare(void)
687{
688 /* Prepare to power off the system */
689 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800690 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400691}
692
693static void acpi_power_off(void)
694{
695 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100696 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400697 local_irq_disable();
Alexey Starikovskiy9c1c6a12007-10-22 14:18:06 +0400698 acpi_enable_wakeup_device(ACPI_STATE_S5);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400699 acpi_enter_sleep_state(ACPI_STATE_S5);
700}
701
Len Brown96f15ef2009-04-17 23:32:20 -0400702/*
703 * ACPI 2.0 created the optional _GTS and _BFS,
704 * but industry adoption has been neither rapid nor broad.
705 *
706 * Linux gets into trouble when it executes poorly validated
707 * paths through the BIOS, so disable _GTS and _BFS by default,
708 * but do speak up and offer the option to enable them.
709 */
710void __init acpi_gts_bfs_check(void)
711{
712 acpi_handle dummy;
713
714 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
715 {
716 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
717 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
718 "please notify linux-acpi@vger.kernel.org\n");
719 }
720 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
721 {
722 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
723 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
724 "please notify linux-acpi@vger.kernel.org\n");
725 }
726}
727
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500728int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200730 acpi_status status;
731 u8 type_a, type_b;
732#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500733 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700734
735 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200736#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738 if (acpi_disabled)
739 return 0;
740
Frans Pop5a50fe72007-09-20 22:27:44 +0200741 sleep_states[ACPI_STATE_S0] = 1;
742 printk(KERN_INFO PREFIX "(supports S0");
743
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200744#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200745 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
747 if (ACPI_SUCCESS(status)) {
748 sleep_states[i] = 1;
749 printk(" S%d", i);
750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200753 suspend_set_ops(old_suspend_ordering ?
754 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200755#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700756
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200757#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200758 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
759 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200760 hibernation_set_ops(old_suspend_ordering ?
761 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200762 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400763 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700764 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800765 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700766 (struct acpi_table_header **)&facs);
767 if (facs)
768 s4_hardware_signature =
769 facs->hardware_signature;
770 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200771 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700772#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400773 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
774 if (ACPI_SUCCESS(status)) {
775 sleep_states[ACPI_STATE_S5] = 1;
776 printk(" S5");
777 pm_power_off_prepare = acpi_power_off_prepare;
778 pm_power_off = acpi_power_off;
779 }
780 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800781 /*
782 * Register the tts_notifier to reboot notifier list so that the _TTS
783 * object can also be evaluated when the system enters S5.
784 */
785 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400786 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 return 0;
788}