blob: 5529c7023956526d731a397550a8472745a5e155 [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/**
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200108 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
109 */
110static int acpi_pm_pre_suspend(void)
111{
112 acpi_pm_freeze();
113 suspend_nvs_save();
114 return 0;
115}
116
117/**
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200118 * __acpi_pm_prepare - Prepare the platform to enter the target state.
119 *
120 * If necessary, set the firmware waking vector and do arch-specific
121 * nastiness to get the wakeup code to the waking vector.
122 */
123static int __acpi_pm_prepare(void)
124{
125 int error = acpi_sleep_prepare(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200126 if (error)
127 acpi_target_sleep_state = ACPI_STATE_S0;
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200128
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200129 return error;
130}
131
132/**
133 * acpi_pm_prepare - Prepare the platform to enter the target sleep
134 * state and disable the GPEs.
135 */
136static int acpi_pm_prepare(void)
137{
138 int error = __acpi_pm_prepare();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200139 if (!error)
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200140 acpi_pm_pre_suspend();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200141
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200142 return error;
143}
144
145/**
146 * acpi_pm_finish - Instruct the platform to leave a sleep state.
147 *
148 * This is called after we wake back up (or if entering the sleep state
149 * failed).
150 */
151static void acpi_pm_finish(void)
152{
153 u32 acpi_state = acpi_target_sleep_state;
154
Len Brown42de5532010-06-12 01:15:40 -0400155 acpi_ec_unblock_transactions();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400156
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200157 if (acpi_state == ACPI_STATE_S0)
158 return;
159
160 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
161 acpi_state);
Rafael J. Wysocki78f5f022010-07-06 22:09:38 -0400162 acpi_disable_wakeup_devices(acpi_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200163 acpi_leave_sleep_state(acpi_state);
164
165 /* reset firmware waking vector */
166 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
167
168 acpi_target_sleep_state = ACPI_STATE_S0;
169}
170
171/**
172 * acpi_pm_end - Finish up suspend sequence.
173 */
174static void acpi_pm_end(void)
175{
Rafael J. Wysockie96c4b02010-07-06 18:28:35 -0400176 suspend_nvs_free();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200177 /*
178 * This is necessary in case acpi_pm_finish() is not called during a
179 * failing transition to a sleep state.
180 */
181 acpi_target_sleep_state = ACPI_STATE_S0;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800182 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200183}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200184#else /* !CONFIG_ACPI_SLEEP */
185#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400186#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200187
188#ifdef CONFIG_SUSPEND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189extern void do_suspend_lowlevel(void);
190
191static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500192 [PM_SUSPEND_ON] = ACPI_STATE_S0,
193 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
194 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500195 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196};
197
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200198/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400199 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200200 * associated with given @pm_state, if supported.
201 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400202static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
204 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200205 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400207 error = suspend_nvs_alloc();
208
209 if (error)
210 return error;
211
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200212 if (sleep_states[acpi_state]) {
213 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800214 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200215 } else {
216 printk(KERN_ERR "ACPI does not support this state: %d\n",
217 pm_state);
218 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200220 return error;
221}
222
223/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400224 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200225 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200227 * Flush caches and go to sleep. For STR we have to call arch-specific
228 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 * It's unfortunate, but it works. Please fix if you're feeling frisky.
230 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400231static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
233 acpi_status status = AE_OK;
234 unsigned long flags = 0;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200235 u32 acpi_state = acpi_target_sleep_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237 ACPI_FLUSH_CPU_CACHE();
238
239 /* Do arch specific saving of state. */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200240 if (acpi_state == ACPI_STATE_S3) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 int error = acpi_save_state_mem();
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200242
Rafael J. Wysocki60417f52008-01-08 00:07:39 +0100243 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 return error;
245 }
246
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 local_irq_save(flags);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200248 switch (acpi_state) {
249 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 barrier();
251 status = acpi_enter_sleep_state(acpi_state);
252 break;
253
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200254 case ACPI_STATE_S3:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 do_suspend_lowlevel();
256 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400258
Matthew Garrettb6dacf62010-05-11 13:49:25 -0400259 /* This violates the spec but is required for bug compatibility. */
260 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500261
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100262 /* Reprogram control registers and execute _BFS */
263 acpi_leave_sleep_state_prep(acpi_state);
264
Pavel Machek23b168d2008-02-05 19:27:12 +0100265 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400266 * of the OSPM to clear the status bit [ implying that the
267 * POWER_BUTTON event should not reach userspace ]
268 */
269 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
270 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
271
Shaohua Lia3627f62007-06-20 09:17:58 +0800272 /*
273 * Disable and clear GPE status before interrupt is enabled. Some GPEs
274 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
275 * acpi_leave_sleep_state will reenable specific GPEs later
276 */
Lin Ming3d97e422008-12-16 16:57:46 +0800277 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200278 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200279 acpi_ec_unblock_transactions_early();
Shaohua Lia3627f62007-06-20 09:17:58 +0800280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 local_irq_restore(flags);
282 printk(KERN_DEBUG "Back to C!\n");
283
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200284 /* restore processor state */
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200285 if (acpi_state == ACPI_STATE_S3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 acpi_restore_state_mem();
287
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400288 suspend_nvs_restore();
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
291}
292
Len Brown2c6e33c2008-04-23 18:02:52 -0400293static int acpi_suspend_state_valid(suspend_state_t pm_state)
Shaohua Lieb9289e2005-10-30 15:00:01 -0800294{
Johannes Berge8c9c502007-04-30 15:09:54 -0700295 u32 acpi_state;
Shaohua Lieb9289e2005-10-30 15:00:01 -0800296
Johannes Berge8c9c502007-04-30 15:09:54 -0700297 switch (pm_state) {
298 case PM_SUSPEND_ON:
299 case PM_SUSPEND_STANDBY:
300 case PM_SUSPEND_MEM:
301 acpi_state = acpi_suspend_states[pm_state];
302
303 return sleep_states[acpi_state];
304 default:
305 return 0;
306 }
Shaohua Lieb9289e2005-10-30 15:00:01 -0800307}
308
Len Brown2c6e33c2008-04-23 18:02:52 -0400309static struct platform_suspend_ops acpi_suspend_ops = {
310 .valid = acpi_suspend_state_valid,
311 .begin = acpi_suspend_begin,
Rafael J. Wysocki6a7c7ea2009-04-19 20:08:42 +0200312 .prepare_late = acpi_pm_prepare,
Len Brown2c6e33c2008-04-23 18:02:52 -0400313 .enter = acpi_suspend_enter,
Rafael J. Wysocki618d7fd2010-07-02 00:14:57 +0200314 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200315 .end = acpi_pm_end,
316};
317
318/**
319 * acpi_suspend_begin_old - Set the target system sleep state to the
320 * state associated with given @pm_state, if supported, and
321 * execute the _PTS control method. This function is used if the
322 * pre-ACPI 2.0 suspend ordering has been requested.
323 */
324static int acpi_suspend_begin_old(suspend_state_t pm_state)
325{
326 int error = acpi_suspend_begin(pm_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200327 if (!error)
328 error = __acpi_pm_prepare();
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200329
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200330 return error;
331}
332
333/*
334 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
335 * been requested.
336 */
337static struct platform_suspend_ops acpi_suspend_ops_old = {
338 .valid = acpi_suspend_state_valid,
339 .begin = acpi_suspend_begin_old,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200340 .prepare_late = acpi_pm_pre_suspend,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200341 .enter = acpi_suspend_enter,
Rafael J. Wysocki618d7fd2010-07-02 00:14:57 +0200342 .wake = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200343 .end = acpi_pm_end,
344 .recover = acpi_pm_finish,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345};
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700346
347static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
348{
349 old_suspend_ordering = true;
350 return 0;
351}
352
353static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
354 {
355 .callback = init_old_suspend_ordering,
356 .ident = "Abit KN9 (nForce4 variant)",
357 .matches = {
358 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
359 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
360 },
361 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200362 {
363 .callback = init_old_suspend_ordering,
364 .ident = "HP xw4600 Workstation",
365 .matches = {
366 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
367 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
368 },
369 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500370 {
Andy Whitcrofta1404492009-02-11 18:11:22 +0000371 .callback = init_old_suspend_ordering,
372 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
373 .matches = {
374 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
375 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
376 },
377 },
Zhang Rui45e77982009-03-15 22:13:44 -0400378 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800379 .callback = init_old_suspend_ordering,
380 .ident = "Panasonic CF51-2L",
381 .matches = {
382 DMI_MATCH(DMI_BOARD_VENDOR,
383 "Matsushita Electric Industrial Co.,Ltd."),
384 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
385 },
386 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700387 {},
388};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200389#endif /* CONFIG_SUSPEND */
390
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200391#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki5d8b5322009-01-16 23:09:14 +0100392/*
393 * The ACPI specification wants us to save NVS memory regions during hibernation
394 * and to restore them during the subsequent resume. However, it is not certain
395 * if this mechanism is going to work on all machines, so we allow the user to
396 * disable this mechanism using the 'acpi_sleep=s4_nonvs' kernel command line
397 * option.
398 */
399static bool s4_no_nvs;
400
401void __init acpi_s4_no_nvs(void)
402{
403 s4_no_nvs = true;
404}
405
Shaohua Libdfe6b72008-07-23 21:28:41 -0700406static unsigned long s4_hardware_signature;
407static struct acpi_table_facs *facs;
408static bool nosigcheck;
409
410void __init acpi_no_s4_hw_signature(void)
411{
412 nosigcheck = true;
413}
414
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100415static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700416{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100417 int error;
418
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400419 error = s4_no_nvs ? 0 : suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100420 if (!error) {
421 acpi_target_sleep_state = ACPI_STATE_S4;
422 acpi_sleep_tts_switch(acpi_target_sleep_state);
423 }
424
425 return error;
426}
427
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700428static int acpi_hibernation_enter(void)
429{
430 acpi_status status = AE_OK;
431 unsigned long flags = 0;
432
433 ACPI_FLUSH_CPU_CACHE();
434
435 local_irq_save(flags);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700436 /* This shouldn't return. If it returns, we have a problem */
437 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100438 /* Reprogram control registers and execute _BFS */
439 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700440 local_irq_restore(flags);
441
442 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
443}
444
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700445static void acpi_hibernation_leave(void)
446{
447 /*
448 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
449 * enable it here.
450 */
451 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100452 /* Reprogram control registers and execute _BFS */
453 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700454 /* Check the hardware signature */
455 if (facs && s4_hardware_signature != facs->hardware_signature) {
456 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
457 "cannot resume!\n");
458 panic("ACPI S4 hardware signature mismatch");
459 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100460 /* Restore the NVS memory area */
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400461 suspend_nvs_restore();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200462 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200463 acpi_ec_unblock_transactions_early();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700464}
465
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200466static void acpi_pm_thaw(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +0100467{
Rafael J. Wysockife955682010-04-09 01:40:38 +0200468 acpi_ec_unblock_transactions();
Lin Ming3d97e422008-12-16 16:57:46 +0800469 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700470}
471
Rafael J. Wysockib3dac3b2007-10-18 03:04:43 -0700472static struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100473 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200474 .end = acpi_pm_end,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200475 .pre_snapshot = acpi_pm_prepare,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400476 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200477 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700478 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700479 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200480 .pre_restore = acpi_pm_freeze,
481 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700482};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200483
484/**
485 * acpi_hibernation_begin_old - Set the target system sleep state to
486 * ACPI_STATE_S4 and execute the _PTS control method. This
487 * function is used if the pre-ACPI 2.0 suspend ordering has been
488 * requested.
489 */
490static int acpi_hibernation_begin_old(void)
491{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800492 int error;
493 /*
494 * The _TTS object should always be evaluated before the _PTS object.
495 * When the old_suspended_ordering is true, the _PTS object is
496 * evaluated in the acpi_sleep_prepare.
497 */
498 acpi_sleep_tts_switch(ACPI_STATE_S4);
499
500 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200501
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100502 if (!error) {
Rafael J. Wysockiba84ed92008-10-26 20:56:30 +0100503 if (!s4_no_nvs)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400504 error = suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100505 if (!error)
506 acpi_target_sleep_state = ACPI_STATE_S4;
507 }
508 return error;
509}
510
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200511/*
512 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
513 * been requested.
514 */
515static struct platform_hibernation_ops acpi_hibernation_ops_old = {
516 .begin = acpi_hibernation_begin_old,
517 .end = acpi_pm_end,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200518 .pre_snapshot = acpi_pm_pre_suspend,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200519 .prepare = acpi_pm_freeze,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400520 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200521 .enter = acpi_hibernation_enter,
522 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200523 .pre_restore = acpi_pm_freeze,
524 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200525 .recover = acpi_pm_finish,
526};
527#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700528
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200529int acpi_suspend(u32 acpi_state)
530{
531 suspend_state_t states[] = {
532 [1] = PM_SUSPEND_STANDBY,
533 [3] = PM_SUSPEND_MEM,
534 [5] = PM_SUSPEND_MAX
535 };
536
537 if (acpi_state < 6 && states[acpi_state])
538 return pm_suspend(states[acpi_state]);
539 if (acpi_state == 4)
540 return hibernate();
541 return -EINVAL;
542}
543
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400544#ifdef CONFIG_PM_SLEEP
Shaohua Lifd4aff12007-07-17 22:40:25 +0200545/**
546 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
547 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200548 * @dev: device to examine; its driver model wakeup flags control
549 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200550 * @d_min_p: used to store the upper limit of allowed states range
551 * Return value: preferred power state of the device on success, -ENODEV on
552 * failure (ie. if there's no 'struct acpi_device' for @dev)
553 *
554 * Find the lowest power (highest number) ACPI device power state that
555 * device @dev can be in while the system is in the sleep state represented
556 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
557 * able to wake up the system from this sleep state. If @d_min_p is set,
558 * the highest power (lowest number) device power state of @dev allowed
559 * in this system sleep state is stored at the location pointed to by it.
560 *
561 * The caller must ensure that @dev is valid before using this function.
562 * The caller is also responsible for figuring out if the device is
563 * supposed to be able to wake up the system and passing this information
564 * via @wake.
565 */
566
David Brownell2fe2de52008-06-05 01:15:40 +0200567int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200568{
569 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
570 struct acpi_device *adev;
571 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400572 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200573
574 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800575 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200576 return -ENODEV;
577 }
578
579 acpi_method[2] = '0' + acpi_target_sleep_state;
580 /*
581 * If the sleep state is S0, we will return D3, but if the device has
582 * _S0W, we will use the value from _S0W
583 */
584 d_min = ACPI_STATE_D0;
585 d_max = ACPI_STATE_D3;
586
587 /*
588 * If present, _SxD methods return the minimum D-state (highest power
589 * state) we can use for the corresponding S-states. Otherwise, the
590 * minimum D-state is D0 (ACPI 3.x).
591 *
592 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
593 * provided -- that's our fault recovery, we ignore retval.
594 */
595 if (acpi_target_sleep_state > ACPI_STATE_S0)
596 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
597
598 /*
599 * If _PRW says we can wake up the system from the target sleep state,
600 * the D-state returned by _SxD is sufficient for that (we assume a
601 * wakeup-aware driver if wake is set). Still, if _SxW exists
602 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
603 * can wake the system. _S0W may be valid, too.
604 */
605 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
David Brownell2fe2de52008-06-05 01:15:40 +0200606 (device_may_wakeup(dev) && adev->wakeup.state.enabled &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200607 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100608 acpi_status status;
609
Shaohua Lifd4aff12007-07-17 22:40:25 +0200610 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100611 status = acpi_evaluate_integer(handle, acpi_method, NULL,
612 &d_max);
613 if (ACPI_FAILURE(status)) {
614 d_max = d_min;
615 } else if (d_max < d_min) {
616 /* Warn the user of the broken DSDT */
617 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
618 acpi_method);
619 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200620 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100621 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200622 }
623
624 if (d_min_p)
625 *d_min_p = d_min;
626 return d_max;
627}
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200628
629/**
630 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
631 * capability of given device
632 * @dev: device to handle
633 * @enable: 'true' - enable, 'false' - disable the wake-up capability
634 */
635int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
636{
637 acpi_handle handle;
638 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200639 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200640
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200641 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200642 return -EINVAL;
643
644 handle = DEVICE_ACPI_HANDLE(dev);
645 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200646 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200647 return -ENODEV;
648 }
649
Rafael J. Wysocki9630bdd2010-02-17 23:41:07 +0100650 if (enable) {
651 error = acpi_enable_wakeup_device_power(adev,
652 acpi_target_sleep_state);
653 if (!error)
654 acpi_enable_gpe(adev->wakeup.gpe_device,
655 adev->wakeup.gpe_number,
656 ACPI_GPE_TYPE_WAKE);
657 } else {
658 acpi_disable_gpe(adev->wakeup.gpe_device, adev->wakeup.gpe_number,
659 ACPI_GPE_TYPE_WAKE);
660 error = acpi_disable_wakeup_device_power(adev);
661 }
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200662 if (!error)
663 dev_info(dev, "wake-up capability %s by ACPI\n",
664 enable ? "enabled" : "disabled");
665
666 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200667}
Alexey Starikovskiy853298b2007-09-25 18:45:15 +0400668#endif
Shaohua Lifd4aff12007-07-17 22:40:25 +0200669
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400670static void acpi_power_off_prepare(void)
671{
672 /* Prepare to power off the system */
673 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800674 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400675}
676
677static void acpi_power_off(void)
678{
679 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100680 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400681 local_irq_disable();
682 acpi_enter_sleep_state(ACPI_STATE_S5);
683}
684
Len Brown96f15ef2009-04-17 23:32:20 -0400685/*
686 * ACPI 2.0 created the optional _GTS and _BFS,
687 * but industry adoption has been neither rapid nor broad.
688 *
689 * Linux gets into trouble when it executes poorly validated
690 * paths through the BIOS, so disable _GTS and _BFS by default,
691 * but do speak up and offer the option to enable them.
692 */
693void __init acpi_gts_bfs_check(void)
694{
695 acpi_handle dummy;
696
697 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
698 {
699 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
700 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
701 "please notify linux-acpi@vger.kernel.org\n");
702 }
703 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
704 {
705 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
706 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
707 "please notify linux-acpi@vger.kernel.org\n");
708 }
709}
710
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500711int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200713 acpi_status status;
714 u8 type_a, type_b;
715#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500716 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700717
718 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200719#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721 if (acpi_disabled)
722 return 0;
723
Frans Pop5a50fe72007-09-20 22:27:44 +0200724 sleep_states[ACPI_STATE_S0] = 1;
725 printk(KERN_INFO PREFIX "(supports S0");
726
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200727#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200728 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
730 if (ACPI_SUCCESS(status)) {
731 sleep_states[i] = 1;
732 printk(" S%d", i);
733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200736 suspend_set_ops(old_suspend_ordering ?
737 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200738#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700739
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200740#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200741 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
742 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200743 hibernation_set_ops(old_suspend_ordering ?
744 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200745 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400746 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700747 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800748 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700749 (struct acpi_table_header **)&facs);
750 if (facs)
751 s4_hardware_signature =
752 facs->hardware_signature;
753 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200754 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700755#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400756 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
757 if (ACPI_SUCCESS(status)) {
758 sleep_states[ACPI_STATE_S5] = 1;
759 printk(" S5");
760 pm_power_off_prepare = acpi_power_off_prepare;
761 pm_power_off = acpi_power_off;
762 }
763 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800764 /*
765 * Register the tts_notifier to reboot notifier list so that the _TTS
766 * object can also be evaluated when the system enters S5.
767 */
768 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400769 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 return 0;
771}