blob: 93441c95c53b8d9053bcd25e9cb9f35ab0660ade [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. Wysockid8f3de02008-06-12 23:24:06 +020085 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
86 * user to request that behavior by using the 'acpi_old_suspend_ordering'
87 * kernel command line option that causes the following variable to be set.
88 */
89static bool old_suspend_ordering;
90
91void __init acpi_old_suspend_ordering(void)
92{
93 old_suspend_ordering = true;
94}
95
96/**
Rafael J. Wysockid5a64512010-04-09 01:39:40 +020097 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +020098 */
Rafael J. Wysockid5a64512010-04-09 01:39:40 +020099static int acpi_pm_freeze(void)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200100{
Lin Ming3d97e422008-12-16 16:57:46 +0800101 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200102 acpi_os_wait_events_complete(NULL);
Rafael J. Wysockife955682010-04-09 01:40:38 +0200103 acpi_ec_block_transactions();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200104 return 0;
105}
106
107/**
108 * __acpi_pm_prepare - Prepare the platform to enter the target state.
109 *
110 * If necessary, set the firmware waking vector and do arch-specific
111 * nastiness to get the wakeup code to the waking vector.
112 */
113static int __acpi_pm_prepare(void)
114{
115 int error = acpi_sleep_prepare(acpi_target_sleep_state);
116
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400117 suspend_nvs_save();
118
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200119 if (error)
120 acpi_target_sleep_state = ACPI_STATE_S0;
121 return error;
122}
123
124/**
125 * acpi_pm_prepare - Prepare the platform to enter the target sleep
126 * state and disable the GPEs.
127 */
128static int acpi_pm_prepare(void)
129{
130 int error = __acpi_pm_prepare();
131
132 if (!error)
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200133 acpi_pm_freeze();
134
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200135 return error;
136}
137
138/**
139 * acpi_pm_finish - Instruct the platform to leave a sleep state.
140 *
141 * This is called after we wake back up (or if entering the sleep state
142 * failed).
143 */
144static void acpi_pm_finish(void)
145{
146 u32 acpi_state = acpi_target_sleep_state;
147
Len Brown42de5532010-06-12 01:15:40 -0400148 acpi_ec_unblock_transactions();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400149
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200150 if (acpi_state == ACPI_STATE_S0)
151 return;
152
153 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
154 acpi_state);
Rafael J. Wysocki78f5f022010-07-06 22:09:38 -0400155 acpi_disable_wakeup_devices(acpi_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200156 acpi_leave_sleep_state(acpi_state);
157
158 /* reset firmware waking vector */
159 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
160
161 acpi_target_sleep_state = ACPI_STATE_S0;
162}
163
164/**
165 * acpi_pm_end - Finish up suspend sequence.
166 */
167static void acpi_pm_end(void)
168{
Rafael J. Wysockie96c4b02010-07-06 18:28:35 -0400169 suspend_nvs_free();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200170 /*
171 * This is necessary in case acpi_pm_finish() is not called during a
172 * failing transition to a sleep state.
173 */
174 acpi_target_sleep_state = ACPI_STATE_S0;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800175 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200176}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200177#else /* !CONFIG_ACPI_SLEEP */
178#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400179#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200180
181#ifdef CONFIG_SUSPEND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182extern void do_suspend_lowlevel(void);
183
184static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500185 [PM_SUSPEND_ON] = ACPI_STATE_S0,
186 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
187 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500188 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189};
190
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200191/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400192 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200193 * associated with given @pm_state, if supported.
194 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400195static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
197 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200198 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400200 error = suspend_nvs_alloc();
201
202 if (error)
203 return error;
204
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200205 if (sleep_states[acpi_state]) {
206 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800207 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200208 } else {
209 printk(KERN_ERR "ACPI does not support this state: %d\n",
210 pm_state);
211 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200213 return error;
214}
215
216/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400217 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200218 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200220 * Flush caches and go to sleep. For STR we have to call arch-specific
221 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 * It's unfortunate, but it works. Please fix if you're feeling frisky.
223 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400224static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
226 acpi_status status = AE_OK;
227 unsigned long flags = 0;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200228 u32 acpi_state = acpi_target_sleep_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230 ACPI_FLUSH_CPU_CACHE();
231
232 /* Do arch specific saving of state. */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200233 if (acpi_state == ACPI_STATE_S3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 int error = acpi_save_state_mem();
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200235
Rafael J. Wysocki60417f52008-01-08 00:07:39 +0100236 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 return error;
238 }
239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 local_irq_save(flags);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200241 switch (acpi_state) {
242 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 barrier();
244 status = acpi_enter_sleep_state(acpi_state);
245 break;
246
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200247 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 do_suspend_lowlevel();
249 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400251
Matthew Garrettb6dacf62010-05-11 13:49:25 -0400252 /* This violates the spec but is required for bug compatibility. */
253 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500254
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100255 /* Reprogram control registers and execute _BFS */
256 acpi_leave_sleep_state_prep(acpi_state);
257
Pavel Machek23b168d2008-02-05 19:27:12 +0100258 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400259 * of the OSPM to clear the status bit [ implying that the
260 * POWER_BUTTON event should not reach userspace ]
261 */
262 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
263 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
264
Shaohua Lia3627f62007-06-20 09:17:58 +0800265 /*
266 * Disable and clear GPE status before interrupt is enabled. Some GPEs
267 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
268 * acpi_leave_sleep_state will reenable specific GPEs later
269 */
Lin Ming3d97e422008-12-16 16:57:46 +0800270 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200271 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200272 acpi_ec_unblock_transactions_early();
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
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400281 suspend_nvs_restore();
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
284}
285
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200286static void acpi_suspend_finish(void)
287{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200288 acpi_pm_finish();
289}
290
Len Brown2c6e33c2008-04-23 18:02:52 -0400291static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800292{
Johannes Berge8c9c502007-04-30 15:09:54 -0700293 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800294
Johannes Berge8c9c502007-04-30 15:09:54 -0700295 switch (pm_state) {
296 case PM_SUSPEND_ON:
297 case PM_SUSPEND_STANDBY:
298 case PM_SUSPEND_MEM:
299 acpi_state = acpi_suspend_states[pm_state];
300
301 return sleep_states[acpi_state];
302 default:
303 return 0;
304 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800305}
306
Len Brown2c6e33c2008-04-23 18:02:52 -0400307static struct platform_suspend_ops acpi_suspend_ops = {
308 .valid = acpi_suspend_state_valid,
309 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200310 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400311 .enter = acpi_suspend_enter,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200312 .wake = acpi_suspend_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200313 .end = acpi_pm_end,
314};
315
316/**
317 * acpi_suspend_begin_old - Set the target system sleep state to the
318 * state associated with given @pm_state, if supported, and
319 * execute the _PTS control method. This function is used if the
320 * pre-ACPI 2.0 suspend ordering has been requested.
321 */
322static int acpi_suspend_begin_old(suspend_state_t pm_state)
323{
324 int error = acpi_suspend_begin(pm_state);
325
326 if (!error)
327 error = __acpi_pm_prepare();
328 return error;
329}
330
331/*
332 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
333 * been requested.
334 */
335static struct platform_suspend_ops acpi_suspend_ops_old = {
336 .valid = acpi_suspend_state_valid,
337 .begin = acpi_suspend_begin_old,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200338 .prepare_late = acpi_pm_freeze,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200339 .enter = acpi_suspend_enter,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200340 .wake = acpi_suspend_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200341 .end = acpi_pm_end,
342 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700344
345static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
346{
347 old_suspend_ordering = true;
348 return 0;
349}
350
351static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
352 {
353 .callback = init_old_suspend_ordering,
354 .ident = "Abit KN9 (nForce4 variant)",
355 .matches = {
356 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
357 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
358 },
359 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200360 {
361 .callback = init_old_suspend_ordering,
362 .ident = "HP xw4600 Workstation",
363 .matches = {
364 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
365 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
366 },
367 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500368 {
Andy Whitcrofta1404492009-02-11 18:11:22 +0000369 .callback = init_old_suspend_ordering,
370 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
371 .matches = {
372 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
373 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
374 },
375 },
Zhang Rui45e77982009-03-15 22:13:44 -0400376 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800377 .callback = init_old_suspend_ordering,
378 .ident = "Panasonic CF51-2L",
379 .matches = {
380 DMI_MATCH(DMI_BOARD_VENDOR,
381 "Matsushita Electric Industrial Co.,Ltd."),
382 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
383 },
384 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700385 {},
386};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200387#endif /* CONFIG_SUSPEND */
388
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200389#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki5d8b5322009-01-16 23:09:14 +0100390/*
391 * The ACPI specification wants us to save NVS memory regions during hibernation
392 * and to restore them during the subsequent resume. However, it is not certain
393 * if this mechanism is going to work on all machines, so we allow the user to
394 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
395 * option.
396 */
397static bool s4_no_nvs;
398
399void __init acpi_s4_no_nvs(void)
400{
401 s4_no_nvs = true;
402}
403
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
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400417 error = s4_no_nvs ? 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);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700444 /* This shouldn't return. If it returns, we have a problem */
445 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100446 /* Reprogram control registers and execute _BFS */
447 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700448 local_irq_restore(flags);
449
450 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
451}
452
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700453static void acpi_hibernation_leave(void)
454{
455 /*
456 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
457 * enable it here.
458 */
459 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100460 /* Reprogram control registers and execute _BFS */
461 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700462 /* Check the hardware signature */
463 if (facs && s4_hardware_signature != facs->hardware_signature) {
464 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
465 "cannot resume!\n");
466 panic("ACPI S4 hardware signature mismatch");
467 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100468 /* Restore the NVS memory area */
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400469 suspend_nvs_restore();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200470 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200471 acpi_ec_unblock_transactions_early();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700472}
473
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200474static void acpi_pm_thaw(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +0100475{
Rafael J. Wysockife955682010-04-09 01:40:38 +0200476 acpi_ec_unblock_transactions();
Lin Ming3d97e422008-12-16 16:57:46 +0800477 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700478}
479
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700480static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100481 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200482 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100483 .pre_snapshot = acpi_hibernation_pre_snapshot,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400484 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200485 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700486 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700487 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200488 .pre_restore = acpi_pm_freeze,
489 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700490};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200491
492/**
493 * acpi_hibernation_begin_old - Set the target system sleep state to
494 * ACPI_STATE_S4 and execute the _PTS control method. This
495 * function is used if the pre-ACPI 2.0 suspend ordering has been
496 * requested.
497 */
498static int acpi_hibernation_begin_old(void)
499{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800500 int error;
501 /*
502 * The _TTS object should always be evaluated before the _PTS object.
503 * When the old_suspended_ordering is true, the _PTS object is
504 * evaluated in the acpi_sleep_prepare.
505 */
506 acpi_sleep_tts_switch(ACPI_STATE_S4);
507
508 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200509
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100510 if (!error) {
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100511 if (!s4_no_nvs)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400512 error = suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100513 if (!error)
514 acpi_target_sleep_state = ACPI_STATE_S4;
515 }
516 return error;
517}
518
519static int acpi_hibernation_pre_snapshot_old(void)
520{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200521 acpi_pm_freeze();
Len Brown42de5532010-06-12 01:15:40 -0400522 suspend_nvs_save();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200523 return 0;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200524}
525
526/*
527 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
528 * been requested.
529 */
530static struct platform_hibernation_ops acpi_hibernation_ops_old = {
531 .begin = acpi_hibernation_begin_old,
532 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100533 .pre_snapshot = acpi_hibernation_pre_snapshot_old,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200534 .prepare = acpi_pm_freeze,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400535 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200536 .enter = acpi_hibernation_enter,
537 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200538 .pre_restore = acpi_pm_freeze,
539 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200540 .recover = acpi_pm_finish,
541};
542#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700543
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200544int acpi_suspend(u32 acpi_state)
545{
546 suspend_state_t states[] = {
547 [1] = PM_SUSPEND_STANDBY,
548 [3] = PM_SUSPEND_MEM,
549 [5] = PM_SUSPEND_MAX
550 };
551
552 if (acpi_state < 6 && states[acpi_state])
553 return pm_suspend(states[acpi_state]);
554 if (acpi_state == 4)
555 return hibernate();
556 return -EINVAL;
557}
558
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400559#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200560/**
561 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
562 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200563 * @dev: device to examine; its driver model wakeup flags control
564 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200565 * @d_min_p: used to store the upper limit of allowed states range
566 * Return value: preferred power state of the device on success, -ENODEV on
567 * failure (ie. if there's no 'struct acpi_device' for @dev)
568 *
569 * Find the lowest power (highest number) ACPI device power state that
570 * device @dev can be in while the system is in the sleep state represented
571 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
572 * able to wake up the system from this sleep state. If @d_min_p is set,
573 * the highest power (lowest number) device power state of @dev allowed
574 * in this system sleep state is stored at the location pointed to by it.
575 *
576 * The caller must ensure that @dev is valid before using this function.
577 * The caller is also responsible for figuring out if the device is
578 * supposed to be able to wake up the system and passing this information
579 * via @wake.
580 */
581
David Brownell2fe2de52008-06-05 01:15:40 +0200582int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200583{
584 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
585 struct acpi_device *adev;
586 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400587 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200588
589 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800590 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200591 return -ENODEV;
592 }
593
594 acpi_method[2] = '0' + acpi_target_sleep_state;
595 /*
596 * If the sleep state is S0, we will return D3, but if the device has
597 * _S0W, we will use the value from _S0W
598 */
599 d_min = ACPI_STATE_D0;
600 d_max = ACPI_STATE_D3;
601
602 /*
603 * If present, _SxD methods return the minimum D-state (highest power
604 * state) we can use for the corresponding S-states. Otherwise, the
605 * minimum D-state is D0 (ACPI 3.x).
606 *
607 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
608 * provided -- that's our fault recovery, we ignore retval.
609 */
610 if (acpi_target_sleep_state > ACPI_STATE_S0)
611 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
612
613 /*
614 * If _PRW says we can wake up the system from the target sleep state,
615 * the D-state returned by _SxD is sufficient for that (we assume a
616 * wakeup-aware driver if wake is set). Still, if _SxW exists
617 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
618 * can wake the system. _S0W may be valid, too.
619 */
620 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200621 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200622 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100623 acpi_status status;
624
Shaohua Lifd4aff12007-07-17 22:40:25 +0200625 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100626 status = acpi_evaluate_integer(handle, acpi_method, NULL,
627 &d_max);
628 if (ACPI_FAILURE(status)) {
629 d_max = d_min;
630 } else if (d_max < d_min) {
631 /* Warn the user of the broken DSDT */
632 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
633 acpi_method);
634 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200635 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100636 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200637 }
638
639 if (d_min_p)
640 *d_min_p = d_min;
641 return d_max;
642}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200643
644/**
645 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
646 * capability of given device
647 * @dev: device to handle
648 * @enable: 'true' - enable, 'false' - disable the wake-up capability
649 */
650int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
651{
652 acpi_handle handle;
653 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200654 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200655
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200656 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200657 return -EINVAL;
658
659 handle = DEVICE_ACPI_HANDLE(dev);
660 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200661 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200662 return -ENODEV;
663 }
664
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +0100665 if (enable) {
666 error = acpi_enable_wakeup_device_power(adev,
667 acpi_target_sleep_state);
668 if (!error)
669 acpi_enable_gpe(adev->wakeup.gpe_device,
670 adev->wakeup.gpe_number,
671 ACPI_GPE_TYPE_WAKE);
672 } else {
673 acpi_disable_gpe(adev->wakeup.gpe_device, adev->wakeup.gpe_number,
674 ACPI_GPE_TYPE_WAKE);
675 error = acpi_disable_wakeup_device_power(adev);
676 }
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200677 if (!error)
678 dev_info(dev, "wake-up capability %s by ACPI\n",
679 enable ? "enabled" : "disabled");
680
681 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200682}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400683#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200684
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400685static void acpi_power_off_prepare(void)
686{
687 /* Prepare to power off the system */
688 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800689 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400690}
691
692static void acpi_power_off(void)
693{
694 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100695 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400696 local_irq_disable();
697 acpi_enter_sleep_state(ACPI_STATE_S5);
698}
699
Len Brown96f15ef2009-04-17 23:32:20 -0400700/*
701 * ACPI 2.0 created the optional _GTS and _BFS,
702 * but industry adoption has been neither rapid nor broad.
703 *
704 * Linux gets into trouble when it executes poorly validated
705 * paths through the BIOS, so disable _GTS and _BFS by default,
706 * but do speak up and offer the option to enable them.
707 */
708void __init acpi_gts_bfs_check(void)
709{
710 acpi_handle dummy;
711
712 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
713 {
714 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
715 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
716 "please notify linux-acpi@vger.kernel.org\n");
717 }
718 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
719 {
720 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
721 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
722 "please notify linux-acpi@vger.kernel.org\n");
723 }
724}
725
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500726int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200728 acpi_status status;
729 u8 type_a, type_b;
730#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500731 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700732
733 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200734#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
736 if (acpi_disabled)
737 return 0;
738
Frans Pop5a50fe72007-09-20 22:27:44 +0200739 sleep_states[ACPI_STATE_S0] = 1;
740 printk(KERN_INFO PREFIX "(supports S0");
741
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200742#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200743 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
745 if (ACPI_SUCCESS(status)) {
746 sleep_states[i] = 1;
747 printk(" S%d", i);
748 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200751 suspend_set_ops(old_suspend_ordering ?
752 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200753#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700754
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200755#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200756 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
757 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200758 hibernation_set_ops(old_suspend_ordering ?
759 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200760 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400761 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700762 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800763 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700764 (struct acpi_table_header **)&facs);
765 if (facs)
766 s4_hardware_signature =
767 facs->hardware_signature;
768 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200769 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700770#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400771 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
772 if (ACPI_SUCCESS(status)) {
773 sleep_states[ACPI_STATE_S5] = 1;
774 printk(" S5");
775 pm_power_off_prepare = acpi_power_off_prepare;
776 pm_power_off = acpi_power_off;
777 }
778 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800779 /*
780 * Register the tts_notifier to reboot notifier list so that the _TTS
781 * object can also be evaluated when the system enters S5.
782 */
783 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400784 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 return 0;
786}