blob: 5b7c52e4a00f09001becab5df101e7e5fa4dabc8 [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. 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
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400148 suspend_nvs_free();
Len Brown42de5532010-06-12 01:15:40 -0400149 acpi_ec_unblock_transactions();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400150
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200151 if (acpi_state == ACPI_STATE_S0)
152 return;
153
154 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
155 acpi_state);
156 acpi_disable_wakeup_device(acpi_state);
157 acpi_leave_sleep_state(acpi_state);
158
159 /* reset firmware waking vector */
160 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
161
162 acpi_target_sleep_state = ACPI_STATE_S0;
163}
164
165/**
166 * acpi_pm_end - Finish up suspend sequence.
167 */
168static void acpi_pm_end(void)
169{
170 /*
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);
241 acpi_enable_wakeup_device(acpi_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200242 switch (acpi_state) {
243 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 barrier();
245 status = acpi_enter_sleep_state(acpi_state);
246 break;
247
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200248 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 do_suspend_lowlevel();
250 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400252
Matthew Garrettb6dacf62010-05-11 13:49:25 -0400253 /* This violates the spec but is required for bug compatibility. */
254 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500255
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100256 /* Reprogram control registers and execute _BFS */
257 acpi_leave_sleep_state_prep(acpi_state);
258
Pavel Machek23b168d2008-02-05 19:27:12 +0100259 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400260 * of the OSPM to clear the status bit [ implying that the
261 * POWER_BUTTON event should not reach userspace ]
262 */
263 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
264 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
265
Shaohua Lia3627f62007-06-20 09:17:58 +0800266 /*
267 * Disable and clear GPE status before interrupt is enabled. Some GPEs
268 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
269 * acpi_leave_sleep_state will reenable specific GPEs later
270 */
Lin Ming3d97e422008-12-16 16:57:46 +0800271 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200272 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200273 acpi_ec_unblock_transactions_early();
Shaohua Lia3627f62007-06-20 09:17:58 +0800274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 local_irq_restore(flags);
276 printk(KERN_DEBUG "Back to C!\n");
277
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200278 /* restore processor state */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200279 if (acpi_state == ACPI_STATE_S3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 acpi_restore_state_mem();
281
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400282 suspend_nvs_restore();
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
285}
286
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200287static void acpi_suspend_finish(void)
288{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200289 acpi_pm_finish();
290}
291
Len Brown2c6e33c2008-04-23 18:02:52 -0400292static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800293{
Johannes Berge8c9c502007-04-30 15:09:54 -0700294 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800295
Johannes Berge8c9c502007-04-30 15:09:54 -0700296 switch (pm_state) {
297 case PM_SUSPEND_ON:
298 case PM_SUSPEND_STANDBY:
299 case PM_SUSPEND_MEM:
300 acpi_state = acpi_suspend_states[pm_state];
301
302 return sleep_states[acpi_state];
303 default:
304 return 0;
305 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800306}
307
Len Brown2c6e33c2008-04-23 18:02:52 -0400308static struct platform_suspend_ops acpi_suspend_ops = {
309 .valid = acpi_suspend_state_valid,
310 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200311 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400312 .enter = acpi_suspend_enter,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200313 .wake = acpi_suspend_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200314 .end = acpi_pm_end,
315};
316
317/**
318 * acpi_suspend_begin_old - Set the target system sleep state to the
319 * state associated with given @pm_state, if supported, and
320 * execute the _PTS control method. This function is used if the
321 * pre-ACPI 2.0 suspend ordering has been requested.
322 */
323static int acpi_suspend_begin_old(suspend_state_t pm_state)
324{
325 int error = acpi_suspend_begin(pm_state);
326
327 if (!error)
328 error = __acpi_pm_prepare();
329 return error;
330}
331
332/*
333 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
334 * been requested.
335 */
336static struct platform_suspend_ops acpi_suspend_ops_old = {
337 .valid = acpi_suspend_state_valid,
338 .begin = acpi_suspend_begin_old,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200339 .prepare_late = acpi_pm_freeze,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200340 .enter = acpi_suspend_enter,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200341 .wake = acpi_suspend_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200342 .end = acpi_pm_end,
343 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700345
346static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
347{
348 old_suspend_ordering = true;
349 return 0;
350}
351
352static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
353 {
354 .callback = init_old_suspend_ordering,
355 .ident = "Abit KN9 (nForce4 variant)",
356 .matches = {
357 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
358 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
359 },
360 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200361 {
362 .callback = init_old_suspend_ordering,
363 .ident = "HP xw4600 Workstation",
364 .matches = {
365 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
366 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
367 },
368 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500369 {
Andy Whitcrofta1404492009-02-11 18:11:22 +0000370 .callback = init_old_suspend_ordering,
371 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
372 .matches = {
373 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
374 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
375 },
376 },
Zhang Rui45e77982009-03-15 22:13:44 -0400377 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800378 .callback = init_old_suspend_ordering,
379 .ident = "Panasonic CF51-2L",
380 .matches = {
381 DMI_MATCH(DMI_BOARD_VENDOR,
382 "Matsushita Electric Industrial Co.,Ltd."),
383 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
384 },
385 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700386 {},
387};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200388#endif /* CONFIG_SUSPEND */
389
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200390#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki5d8b5322009-01-16 23:09:14 +0100391/*
392 * The ACPI specification wants us to save NVS memory regions during hibernation
393 * and to restore them during the subsequent resume. However, it is not certain
394 * if this mechanism is going to work on all machines, so we allow the user to
395 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
396 * option.
397 */
398static bool s4_no_nvs;
399
400void __init acpi_s4_no_nvs(void)
401{
402 s4_no_nvs = true;
403}
404
Shaohua Libdfe6b72008-07-23 21:28:41 -0700405static unsigned long s4_hardware_signature;
406static struct acpi_table_facs *facs;
407static bool nosigcheck;
408
409void __init acpi_no_s4_hw_signature(void)
410{
411 nosigcheck = true;
412}
413
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100414static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700415{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100416 int error;
417
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400418 error = s4_no_nvs ? 0 : suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100419 if (!error) {
420 acpi_target_sleep_state = ACPI_STATE_S4;
421 acpi_sleep_tts_switch(acpi_target_sleep_state);
422 }
423
424 return error;
425}
426
427static int acpi_hibernation_pre_snapshot(void)
428{
429 int error = acpi_pm_prepare();
430
431 if (!error)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400432 suspend_nvs_save();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100433
434 return error;
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700435}
436
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700437static int acpi_hibernation_enter(void)
438{
439 acpi_status status = AE_OK;
440 unsigned long flags = 0;
441
442 ACPI_FLUSH_CPU_CACHE();
443
444 local_irq_save(flags);
445 acpi_enable_wakeup_device(ACPI_STATE_S4);
446 /* This shouldn't return. If it returns, we have a problem */
447 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100448 /* Reprogram control registers and execute _BFS */
449 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700450 local_irq_restore(flags);
451
452 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
453}
454
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700455static void acpi_hibernation_leave(void)
456{
457 /*
458 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
459 * enable it here.
460 */
461 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100462 /* Reprogram control registers and execute _BFS */
463 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700464 /* Check the hardware signature */
465 if (facs && s4_hardware_signature != facs->hardware_signature) {
466 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
467 "cannot resume!\n");
468 panic("ACPI S4 hardware signature mismatch");
469 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100470 /* Restore the NVS memory area */
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400471 suspend_nvs_restore();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200472 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200473 acpi_ec_unblock_transactions_early();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700474}
475
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200476static void acpi_pm_thaw(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +0100477{
Rafael J. Wysockife955682010-04-09 01:40:38 +0200478 acpi_ec_unblock_transactions();
Lin Ming3d97e422008-12-16 16:57:46 +0800479 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700480}
481
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700482static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100483 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200484 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100485 .pre_snapshot = acpi_hibernation_pre_snapshot,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400486 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200487 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700488 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700489 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200490 .pre_restore = acpi_pm_freeze,
491 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700492};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200493
494/**
495 * acpi_hibernation_begin_old - Set the target system sleep state to
496 * ACPI_STATE_S4 and execute the _PTS control method. This
497 * function is used if the pre-ACPI 2.0 suspend ordering has been
498 * requested.
499 */
500static int acpi_hibernation_begin_old(void)
501{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800502 int error;
503 /*
504 * The _TTS object should always be evaluated before the _PTS object.
505 * When the old_suspended_ordering is true, the _PTS object is
506 * evaluated in the acpi_sleep_prepare.
507 */
508 acpi_sleep_tts_switch(ACPI_STATE_S4);
509
510 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200511
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100512 if (!error) {
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100513 if (!s4_no_nvs)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400514 error = suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100515 if (!error)
516 acpi_target_sleep_state = ACPI_STATE_S4;
517 }
518 return error;
519}
520
521static int acpi_hibernation_pre_snapshot_old(void)
522{
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200523 acpi_pm_freeze();
Len Brown42de5532010-06-12 01:15:40 -0400524 suspend_nvs_save();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200525 return 0;
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200526}
527
528/*
529 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
530 * been requested.
531 */
532static struct platform_hibernation_ops acpi_hibernation_ops_old = {
533 .begin = acpi_hibernation_begin_old,
534 .end = acpi_pm_end,
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100535 .pre_snapshot = acpi_hibernation_pre_snapshot_old,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200536 .prepare = acpi_pm_freeze,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400537 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200538 .enter = acpi_hibernation_enter,
539 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200540 .pre_restore = acpi_pm_freeze,
541 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200542 .recover = acpi_pm_finish,
543};
544#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700545
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200546int acpi_suspend(u32 acpi_state)
547{
548 suspend_state_t states[] = {
549 [1] = PM_SUSPEND_STANDBY,
550 [3] = PM_SUSPEND_MEM,
551 [5] = PM_SUSPEND_MAX
552 };
553
554 if (acpi_state < 6 && states[acpi_state])
555 return pm_suspend(states[acpi_state]);
556 if (acpi_state == 4)
557 return hibernate();
558 return -EINVAL;
559}
560
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400561#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200562/**
563 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
564 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200565 * @dev: device to examine; its driver model wakeup flags control
566 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200567 * @d_min_p: used to store the upper limit of allowed states range
568 * Return value: preferred power state of the device on success, -ENODEV on
569 * failure (ie. if there's no 'struct acpi_device' for @dev)
570 *
571 * Find the lowest power (highest number) ACPI device power state that
572 * device @dev can be in while the system is in the sleep state represented
573 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
574 * able to wake up the system from this sleep state. If @d_min_p is set,
575 * the highest power (lowest number) device power state of @dev allowed
576 * in this system sleep state is stored at the location pointed to by it.
577 *
578 * The caller must ensure that @dev is valid before using this function.
579 * The caller is also responsible for figuring out if the device is
580 * supposed to be able to wake up the system and passing this information
581 * via @wake.
582 */
583
David Brownell2fe2de52008-06-05 01:15:40 +0200584int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200585{
586 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
587 struct acpi_device *adev;
588 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400589 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200590
591 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800592 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200593 return -ENODEV;
594 }
595
596 acpi_method[2] = '0' + acpi_target_sleep_state;
597 /*
598 * If the sleep state is S0, we will return D3, but if the device has
599 * _S0W, we will use the value from _S0W
600 */
601 d_min = ACPI_STATE_D0;
602 d_max = ACPI_STATE_D3;
603
604 /*
605 * If present, _SxD methods return the minimum D-state (highest power
606 * state) we can use for the corresponding S-states. Otherwise, the
607 * minimum D-state is D0 (ACPI 3.x).
608 *
609 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
610 * provided -- that's our fault recovery, we ignore retval.
611 */
612 if (acpi_target_sleep_state > ACPI_STATE_S0)
613 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
614
615 /*
616 * If _PRW says we can wake up the system from the target sleep state,
617 * the D-state returned by _SxD is sufficient for that (we assume a
618 * wakeup-aware driver if wake is set). Still, if _SxW exists
619 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
620 * can wake the system. _S0W may be valid, too.
621 */
622 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200623 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200624 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100625 acpi_status status;
626
Shaohua Lifd4aff12007-07-17 22:40:25 +0200627 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100628 status = acpi_evaluate_integer(handle, acpi_method, NULL,
629 &d_max);
630 if (ACPI_FAILURE(status)) {
631 d_max = d_min;
632 } else if (d_max < d_min) {
633 /* Warn the user of the broken DSDT */
634 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
635 acpi_method);
636 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200637 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100638 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200639 }
640
641 if (d_min_p)
642 *d_min_p = d_min;
643 return d_max;
644}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200645
646/**
647 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
648 * capability of given device
649 * @dev: device to handle
650 * @enable: 'true' - enable, 'false' - disable the wake-up capability
651 */
652int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
653{
654 acpi_handle handle;
655 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200656 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200657
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200658 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200659 return -EINVAL;
660
661 handle = DEVICE_ACPI_HANDLE(dev);
662 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200663 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200664 return -ENODEV;
665 }
666
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +0100667 if (enable) {
668 error = acpi_enable_wakeup_device_power(adev,
669 acpi_target_sleep_state);
670 if (!error)
671 acpi_enable_gpe(adev->wakeup.gpe_device,
672 adev->wakeup.gpe_number,
673 ACPI_GPE_TYPE_WAKE);
674 } else {
675 acpi_disable_gpe(adev->wakeup.gpe_device, adev->wakeup.gpe_number,
676 ACPI_GPE_TYPE_WAKE);
677 error = acpi_disable_wakeup_device_power(adev);
678 }
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200679 if (!error)
680 dev_info(dev, "wake-up capability %s by ACPI\n",
681 enable ? "enabled" : "disabled");
682
683 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200684}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400685#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200686
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400687static void acpi_power_off_prepare(void)
688{
689 /* Prepare to power off the system */
690 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800691 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400692}
693
694static void acpi_power_off(void)
695{
696 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100697 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400698 local_irq_disable();
Alexey Starikovskiy9c1c6a12007-10-22 14:18:06 +0400699 acpi_enable_wakeup_device(ACPI_STATE_S5);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400700 acpi_enter_sleep_state(ACPI_STATE_S5);
701}
702
Len Brown96f15ef2009-04-17 23:32:20 -0400703/*
704 * ACPI 2.0 created the optional _GTS and _BFS,
705 * but industry adoption has been neither rapid nor broad.
706 *
707 * Linux gets into trouble when it executes poorly validated
708 * paths through the BIOS, so disable _GTS and _BFS by default,
709 * but do speak up and offer the option to enable them.
710 */
711void __init acpi_gts_bfs_check(void)
712{
713 acpi_handle dummy;
714
715 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
716 {
717 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
718 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
719 "please notify linux-acpi@vger.kernel.org\n");
720 }
721 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
722 {
723 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
724 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
725 "please notify linux-acpi@vger.kernel.org\n");
726 }
727}
728
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500729int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200731 acpi_status status;
732 u8 type_a, type_b;
733#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500734 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700735
736 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200737#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
739 if (acpi_disabled)
740 return 0;
741
Frans Pop5a50fe72007-09-20 22:27:44 +0200742 sleep_states[ACPI_STATE_S0] = 1;
743 printk(KERN_INFO PREFIX "(supports S0");
744
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200745#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200746 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
748 if (ACPI_SUCCESS(status)) {
749 sleep_states[i] = 1;
750 printk(" S%d", i);
751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200754 suspend_set_ops(old_suspend_ordering ?
755 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200756#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700757
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200758#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200759 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
760 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200761 hibernation_set_ops(old_suspend_ordering ?
762 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200763 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400764 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700765 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800766 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700767 (struct acpi_table_header **)&facs);
768 if (facs)
769 s4_hardware_signature =
770 facs->hardware_signature;
771 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200772 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700773#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400774 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
775 if (ACPI_SUCCESS(status)) {
776 sleep_states[ACPI_STATE_S5] = 1;
777 printk(" S5");
778 pm_power_off_prepare = acpi_power_off_prepare;
779 pm_power_off = acpi_power_off;
780 }
781 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800782 /*
783 * Register the tts_notifier to reboot notifier list so that the _TTS
784 * object can also be evaluated when the system enters S5.
785 */
786 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400787 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 return 0;
789}