blob: 4754ff6e70e6daa25b13df6f115745eb7bfb7e55 [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();
Alexey Starikovskiy2f3f22262007-09-24 14:33:21 +020073#endif
Rafael J. Wysockic9b6c8f2008-01-08 00:10:57 +010074 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
75 acpi_state);
Rafael J. Wysocki78f5f022010-07-06 22:09:38 -040076 acpi_enable_wakeup_devices(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/**
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200122 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
123 */
124static int acpi_pm_pre_suspend(void)
125{
126 acpi_pm_freeze();
127 suspend_nvs_save();
128 return 0;
129}
130
131/**
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200132 * __acpi_pm_prepare - Prepare the platform to enter the target state.
133 *
134 * If necessary, set the firmware waking vector and do arch-specific
135 * nastiness to get the wakeup code to the waking vector.
136 */
137static int __acpi_pm_prepare(void)
138{
139 int error = acpi_sleep_prepare(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200140 if (error)
141 acpi_target_sleep_state = ACPI_STATE_S0;
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200142
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200143 return error;
144}
145
146/**
147 * acpi_pm_prepare - Prepare the platform to enter the target sleep
148 * state and disable the GPEs.
149 */
150static int acpi_pm_prepare(void)
151{
152 int error = __acpi_pm_prepare();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200153 if (!error)
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200154 acpi_pm_pre_suspend();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200155
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200156 return error;
157}
158
159/**
160 * acpi_pm_finish - Instruct the platform to leave a sleep state.
161 *
162 * This is called after we wake back up (or if entering the sleep state
163 * failed).
164 */
165static void acpi_pm_finish(void)
166{
167 u32 acpi_state = acpi_target_sleep_state;
168
Len Brown42de5532010-06-12 01:15:40 -0400169 acpi_ec_unblock_transactions();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400170
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200171 if (acpi_state == ACPI_STATE_S0)
172 return;
173
174 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
175 acpi_state);
Rafael J. Wysocki78f5f022010-07-06 22:09:38 -0400176 acpi_disable_wakeup_devices(acpi_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200177 acpi_leave_sleep_state(acpi_state);
178
179 /* reset firmware waking vector */
180 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
181
182 acpi_target_sleep_state = ACPI_STATE_S0;
183}
184
185/**
186 * acpi_pm_end - Finish up suspend sequence.
187 */
188static void acpi_pm_end(void)
189{
Rafael J. Wysockie96c4b02010-07-06 18:28:35 -0400190 suspend_nvs_free();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200191 /*
192 * This is necessary in case acpi_pm_finish() is not called during a
193 * failing transition to a sleep state.
194 */
195 acpi_target_sleep_state = ACPI_STATE_S0;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800196 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200197}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200198#else /* !CONFIG_ACPI_SLEEP */
199#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400200#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200201
202#ifdef CONFIG_SUSPEND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203extern void do_suspend_lowlevel(void);
204
205static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500206 [PM_SUSPEND_ON] = ACPI_STATE_S0,
207 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
208 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500209 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210};
211
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200212/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400213 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200214 * associated with given @pm_state, if supported.
215 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400216static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
218 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200219 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200221 error = nvs_nosave ? 0 : suspend_nvs_alloc();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400222 if (error)
223 return error;
224
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200225 if (sleep_states[acpi_state]) {
226 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800227 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200228 } else {
229 printk(KERN_ERR "ACPI does not support this state: %d\n",
230 pm_state);
231 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200233 return error;
234}
235
236/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400237 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200238 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200240 * Flush caches and go to sleep. For STR we have to call arch-specific
241 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 * It's unfortunate, but it works. Please fix if you're feeling frisky.
243 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400244static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 acpi_status status = AE_OK;
247 unsigned long flags = 0;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200248 u32 acpi_state = acpi_target_sleep_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250 ACPI_FLUSH_CPU_CACHE();
251
252 /* Do arch specific saving of state. */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200253 if (acpi_state == ACPI_STATE_S3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 int error = acpi_save_state_mem();
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200255
Rafael J. Wysocki60417f52008-01-08 00:07:39 +0100256 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 return error;
258 }
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 local_irq_save(flags);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200261 switch (acpi_state) {
262 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 barrier();
264 status = acpi_enter_sleep_state(acpi_state);
265 break;
266
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200267 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 do_suspend_lowlevel();
269 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400271
Matthew Garrettb6dacf62010-05-11 13:49:25 -0400272 /* This violates the spec but is required for bug compatibility. */
273 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500274
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100275 /* Reprogram control registers and execute _BFS */
276 acpi_leave_sleep_state_prep(acpi_state);
277
Pavel Machek23b168d2008-02-05 19:27:12 +0100278 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400279 * of the OSPM to clear the status bit [ implying that the
280 * POWER_BUTTON event should not reach userspace ]
281 */
282 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
283 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
284
Shaohua Lia3627f62007-06-20 09:17:58 +0800285 /*
286 * Disable and clear GPE status before interrupt is enabled. Some GPEs
287 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
288 * acpi_leave_sleep_state will reenable specific GPEs later
289 */
Lin Ming3d97e422008-12-16 16:57:46 +0800290 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200291 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200292 acpi_ec_unblock_transactions_early();
Shaohua Lia3627f62007-06-20 09:17:58 +0800293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 local_irq_restore(flags);
295 printk(KERN_DEBUG "Back to C!\n");
296
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200297 /* restore processor state */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200298 if (acpi_state == ACPI_STATE_S3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 acpi_restore_state_mem();
300
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400301 suspend_nvs_restore();
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
304}
305
Len Brown2c6e33c2008-04-23 18:02:52 -0400306static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800307{
Johannes Berge8c9c502007-04-30 15:09:54 -0700308 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800309
Johannes Berge8c9c502007-04-30 15:09:54 -0700310 switch (pm_state) {
311 case PM_SUSPEND_ON:
312 case PM_SUSPEND_STANDBY:
313 case PM_SUSPEND_MEM:
314 acpi_state = acpi_suspend_states[pm_state];
315
316 return sleep_states[acpi_state];
317 default:
318 return 0;
319 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800320}
321
Len Brown2c6e33c2008-04-23 18:02:52 -0400322static struct platform_suspend_ops acpi_suspend_ops = {
323 .valid = acpi_suspend_state_valid,
324 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200325 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400326 .enter = acpi_suspend_enter,
Rafael J. Wysocki618d7fd2010-07-02 00:14:57 +0200327 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200328 .end = acpi_pm_end,
329};
330
331/**
332 * acpi_suspend_begin_old - Set the target system sleep state to the
333 * state associated with given @pm_state, if supported, and
334 * execute the _PTS control method. This function is used if the
335 * pre-ACPI 2.0 suspend ordering has been requested.
336 */
337static int acpi_suspend_begin_old(suspend_state_t pm_state)
338{
339 int error = acpi_suspend_begin(pm_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200340 if (!error)
341 error = __acpi_pm_prepare();
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200342
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200343 return error;
344}
345
346/*
347 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
348 * been requested.
349 */
350static struct platform_suspend_ops acpi_suspend_ops_old = {
351 .valid = acpi_suspend_state_valid,
352 .begin = acpi_suspend_begin_old,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200353 .prepare_late = acpi_pm_pre_suspend,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200354 .enter = acpi_suspend_enter,
Rafael J. Wysocki618d7fd2010-07-02 00:14:57 +0200355 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200356 .end = acpi_pm_end,
357 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700359
360static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
361{
362 old_suspend_ordering = true;
363 return 0;
364}
365
Rafael J. Wysocki53998642010-09-24 16:46:14 -0400366static int __init init_nvs_nosave(const struct dmi_system_id *d)
367{
368 acpi_nvs_nosave();
369 return 0;
370}
371
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700372static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
373 {
374 .callback = init_old_suspend_ordering,
375 .ident = "Abit KN9 (nForce4 variant)",
376 .matches = {
377 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
378 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
379 },
380 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200381 {
382 .callback = init_old_suspend_ordering,
383 .ident = "HP xw4600 Workstation",
384 .matches = {
385 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
386 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
387 },
388 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500389 {
Andy Whitcrofta1404492009-02-11 18:11:22 +0000390 .callback = init_old_suspend_ordering,
391 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
392 .matches = {
393 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
394 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
395 },
396 },
Zhang Rui45e77982009-03-15 22:13:44 -0400397 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800398 .callback = init_old_suspend_ordering,
399 .ident = "Panasonic CF51-2L",
400 .matches = {
401 DMI_MATCH(DMI_BOARD_VENDOR,
402 "Matsushita Electric Industrial Co.,Ltd."),
403 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
404 },
405 },
Rafael J. Wysocki53998642010-09-24 16:46:14 -0400406 {
407 .callback = init_nvs_nosave,
408 .ident = "Sony Vaio VGN-SR11M",
409 .matches = {
410 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
411 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
412 },
413 },
414 {
415 .callback = init_nvs_nosave,
416 .ident = "Everex StepNote Series",
417 .matches = {
418 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
419 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
420 },
421 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700422 {},
423};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200424#endif /* CONFIG_SUSPEND */
425
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200426#ifdef CONFIG_HIBERNATION
Shaohua Libdfe6b72008-07-23 21:28:41 -0700427static unsigned long s4_hardware_signature;
428static struct acpi_table_facs *facs;
429static bool nosigcheck;
430
431void __init acpi_no_s4_hw_signature(void)
432{
433 nosigcheck = true;
434}
435
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100436static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700437{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100438 int error;
439
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200440 error = nvs_nosave ? 0 : suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100441 if (!error) {
442 acpi_target_sleep_state = ACPI_STATE_S4;
443 acpi_sleep_tts_switch(acpi_target_sleep_state);
444 }
445
446 return error;
447}
448
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700449static int acpi_hibernation_enter(void)
450{
451 acpi_status status = AE_OK;
452 unsigned long flags = 0;
453
454 ACPI_FLUSH_CPU_CACHE();
455
456 local_irq_save(flags);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700457 /* This shouldn't return. If it returns, we have a problem */
458 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100459 /* Reprogram control registers and execute _BFS */
460 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700461 local_irq_restore(flags);
462
463 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
464}
465
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700466static void acpi_hibernation_leave(void)
467{
468 /*
469 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
470 * enable it here.
471 */
472 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100473 /* Reprogram control registers and execute _BFS */
474 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700475 /* Check the hardware signature */
476 if (facs && s4_hardware_signature != facs->hardware_signature) {
477 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
478 "cannot resume!\n");
479 panic("ACPI S4 hardware signature mismatch");
480 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100481 /* Restore the NVS memory area */
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400482 suspend_nvs_restore();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200483 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200484 acpi_ec_unblock_transactions_early();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700485}
486
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200487static void acpi_pm_thaw(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +0100488{
Rafael J. Wysockife955682010-04-09 01:40:38 +0200489 acpi_ec_unblock_transactions();
Lin Ming3d97e422008-12-16 16:57:46 +0800490 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700491}
492
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700493static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100494 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200495 .end = acpi_pm_end,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200496 .pre_snapshot = acpi_pm_prepare,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400497 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200498 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700499 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700500 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200501 .pre_restore = acpi_pm_freeze,
502 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700503};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200504
505/**
506 * acpi_hibernation_begin_old - Set the target system sleep state to
507 * ACPI_STATE_S4 and execute the _PTS control method. This
508 * function is used if the pre-ACPI 2.0 suspend ordering has been
509 * requested.
510 */
511static int acpi_hibernation_begin_old(void)
512{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800513 int error;
514 /*
515 * The _TTS object should always be evaluated before the _PTS object.
516 * When the old_suspended_ordering is true, the _PTS object is
517 * evaluated in the acpi_sleep_prepare.
518 */
519 acpi_sleep_tts_switch(ACPI_STATE_S4);
520
521 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200522
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100523 if (!error) {
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200524 if (!nvs_nosave)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400525 error = suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100526 if (!error)
527 acpi_target_sleep_state = ACPI_STATE_S4;
528 }
529 return error;
530}
531
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200532/*
533 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
534 * been requested.
535 */
536static struct platform_hibernation_ops acpi_hibernation_ops_old = {
537 .begin = acpi_hibernation_begin_old,
538 .end = acpi_pm_end,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200539 .pre_snapshot = acpi_pm_pre_suspend,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200540 .prepare = acpi_pm_freeze,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400541 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200542 .enter = acpi_hibernation_enter,
543 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200544 .pre_restore = acpi_pm_freeze,
545 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200546 .recover = acpi_pm_finish,
547};
548#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700549
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200550int acpi_suspend(u32 acpi_state)
551{
552 suspend_state_t states[] = {
553 [1] = PM_SUSPEND_STANDBY,
554 [3] = PM_SUSPEND_MEM,
555 [5] = PM_SUSPEND_MAX
556 };
557
558 if (acpi_state < 6 && states[acpi_state])
559 return pm_suspend(states[acpi_state]);
560 if (acpi_state == 4)
561 return hibernate();
562 return -EINVAL;
563}
564
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400565#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200566/**
567 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
568 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200569 * @dev: device to examine; its driver model wakeup flags control
570 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200571 * @d_min_p: used to store the upper limit of allowed states range
572 * Return value: preferred power state of the device on success, -ENODEV on
573 * failure (ie. if there's no 'struct acpi_device' for @dev)
574 *
575 * Find the lowest power (highest number) ACPI device power state that
576 * device @dev can be in while the system is in the sleep state represented
577 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
578 * able to wake up the system from this sleep state. If @d_min_p is set,
579 * the highest power (lowest number) device power state of @dev allowed
580 * in this system sleep state is stored at the location pointed to by it.
581 *
582 * The caller must ensure that @dev is valid before using this function.
583 * The caller is also responsible for figuring out if the device is
584 * supposed to be able to wake up the system and passing this information
585 * via @wake.
586 */
587
David Brownell2fe2de52008-06-05 01:15:40 +0200588int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200589{
590 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
591 struct acpi_device *adev;
592 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400593 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200594
595 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800596 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200597 return -ENODEV;
598 }
599
600 acpi_method[2] = '0' + acpi_target_sleep_state;
601 /*
602 * If the sleep state is S0, we will return D3, but if the device has
603 * _S0W, we will use the value from _S0W
604 */
605 d_min = ACPI_STATE_D0;
606 d_max = ACPI_STATE_D3;
607
608 /*
609 * If present, _SxD methods return the minimum D-state (highest power
610 * state) we can use for the corresponding S-states. Otherwise, the
611 * minimum D-state is D0 (ACPI 3.x).
612 *
613 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
614 * provided -- that's our fault recovery, we ignore retval.
615 */
616 if (acpi_target_sleep_state > ACPI_STATE_S0)
617 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
618
619 /*
620 * If _PRW says we can wake up the system from the target sleep state,
621 * the D-state returned by _SxD is sufficient for that (we assume a
622 * wakeup-aware driver if wake is set). Still, if _SxW exists
623 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
624 * can wake the system. _S0W may be valid, too.
625 */
626 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200627 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200628 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100629 acpi_status status;
630
Shaohua Lifd4aff12007-07-17 22:40:25 +0200631 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100632 status = acpi_evaluate_integer(handle, acpi_method, NULL,
633 &d_max);
634 if (ACPI_FAILURE(status)) {
635 d_max = d_min;
636 } else if (d_max < d_min) {
637 /* Warn the user of the broken DSDT */
638 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
639 acpi_method);
640 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200641 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100642 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200643 }
644
645 if (d_min_p)
646 *d_min_p = d_min;
647 return d_max;
648}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200649
650/**
651 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
652 * capability of given device
653 * @dev: device to handle
654 * @enable: 'true' - enable, 'false' - disable the wake-up capability
655 */
656int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
657{
658 acpi_handle handle;
659 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200660 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200661
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200662 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200663 return -EINVAL;
664
665 handle = DEVICE_ACPI_HANDLE(dev);
666 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200667 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200668 return -ENODEV;
669 }
670
Rafael J. Wysockie8b6f972010-06-25 01:18:39 +0200671 error = enable ?
672 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
673 acpi_disable_wakeup_device_power(adev);
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200674 if (!error)
675 dev_info(dev, "wake-up capability %s by ACPI\n",
676 enable ? "enabled" : "disabled");
677
678 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200679}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400680#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200681
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400682static void acpi_power_off_prepare(void)
683{
684 /* Prepare to power off the system */
685 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800686 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400687}
688
689static void acpi_power_off(void)
690{
691 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100692 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400693 local_irq_disable();
694 acpi_enter_sleep_state(ACPI_STATE_S5);
695}
696
Len Brown96f15ef2009-04-17 23:32:20 -0400697/*
698 * ACPI 2.0 created the optional _GTS and _BFS,
699 * but industry adoption has been neither rapid nor broad.
700 *
701 * Linux gets into trouble when it executes poorly validated
702 * paths through the BIOS, so disable _GTS and _BFS by default,
703 * but do speak up and offer the option to enable them.
704 */
705void __init acpi_gts_bfs_check(void)
706{
707 acpi_handle dummy;
708
709 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
710 {
711 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
712 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
713 "please notify linux-acpi@vger.kernel.org\n");
714 }
715 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
716 {
717 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
718 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
719 "please notify linux-acpi@vger.kernel.org\n");
720 }
721}
722
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500723int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200725 acpi_status status;
726 u8 type_a, type_b;
727#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500728 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700729
730 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200731#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
733 if (acpi_disabled)
734 return 0;
735
Frans Pop5a50fe72007-09-20 22:27:44 +0200736 sleep_states[ACPI_STATE_S0] = 1;
737 printk(KERN_INFO PREFIX "(supports S0");
738
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200739#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200740 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
742 if (ACPI_SUCCESS(status)) {
743 sleep_states[i] = 1;
744 printk(" S%d", i);
745 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200748 suspend_set_ops(old_suspend_ordering ?
749 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200750#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700751
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200752#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200753 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
754 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200755 hibernation_set_ops(old_suspend_ordering ?
756 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200757 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400758 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700759 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800760 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700761 (struct acpi_table_header **)&facs);
762 if (facs)
763 s4_hardware_signature =
764 facs->hardware_signature;
765 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200766 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700767#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400768 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
769 if (ACPI_SUCCESS(status)) {
770 sleep_states[ACPI_STATE_S5] = 1;
771 printk(" S5");
772 pm_power_off_prepare = acpi_power_off_prepare;
773 pm_power_off = acpi_power_off;
774 }
775 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800776 /*
777 * Register the tts_notifier to reboot notifier list so that the _TTS
778 * object can also be evaluated when the system enters S5.
779 */
780 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400781 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 return 0;
783}