blob: 2307604064b3bd9650eaa7ce504d9a9d4b4dfefd [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
Stephen Hemminger01eac602010-10-18 18:47:25 -070028static u8 sleep_states[ACPI_S_STATE_COUNT];
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
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
Jan Beulich091aad62010-12-07 14:52:25 +000082static u32 acpi_target_sleep_state = ACPI_STATE_S0;
83
Zhang Ruid7f0eea2009-12-30 15:36:42 +080084/*
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +020085 * The ACPI specification wants us to save NVS memory regions during hibernation
86 * and to restore them during the subsequent resume. Windows does that also for
87 * suspend to RAM. However, it is known that this mechanism does not work on
88 * all machines, so we allow the user to disable it with the help of the
89 * 'acpi_sleep=nonvs' kernel command line option.
90 */
91static bool nvs_nosave;
92
93void __init acpi_nvs_nosave(void)
94{
95 nvs_nosave = true;
96}
97
98/*
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +020099 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
100 * user to request that behavior by using the 'acpi_old_suspend_ordering'
101 * kernel command line option that causes the following variable to be set.
102 */
103static bool old_suspend_ordering;
104
105void __init acpi_old_suspend_ordering(void)
106{
107 old_suspend_ordering = true;
108}
109
110/**
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200111 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200112 */
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200113static int acpi_pm_freeze(void)
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200114{
Lin Ming3d97e422008-12-16 16:57:46 +0800115 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200116 acpi_os_wait_events_complete(NULL);
Rafael J. Wysockife955682010-04-09 01:40:38 +0200117 acpi_ec_block_transactions();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200118 return 0;
119}
120
121/**
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200122 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
123 */
124static int acpi_pm_pre_suspend(void)
125{
126 acpi_pm_freeze();
Jiri Slaby26fcaf62011-01-07 01:42:31 +0100127 return suspend_nvs_save();
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200128}
129
130/**
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200131 * __acpi_pm_prepare - Prepare the platform to enter the target state.
132 *
133 * If necessary, set the firmware waking vector and do arch-specific
134 * nastiness to get the wakeup code to the waking vector.
135 */
136static int __acpi_pm_prepare(void)
137{
138 int error = acpi_sleep_prepare(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200139 if (error)
140 acpi_target_sleep_state = ACPI_STATE_S0;
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200141
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200142 return error;
143}
144
145/**
146 * acpi_pm_prepare - Prepare the platform to enter the target sleep
147 * state and disable the GPEs.
148 */
149static int acpi_pm_prepare(void)
150{
151 int error = __acpi_pm_prepare();
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200152 if (!error)
Jiri Slaby26fcaf62011-01-07 01:42:31 +0100153 error = acpi_pm_pre_suspend();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200154
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200155 return error;
156}
157
158/**
159 * acpi_pm_finish - Instruct the platform to leave a sleep state.
160 *
161 * This is called after we wake back up (or if entering the sleep state
162 * failed).
163 */
164static void acpi_pm_finish(void)
165{
166 u32 acpi_state = acpi_target_sleep_state;
167
Len Brown42de5532010-06-12 01:15:40 -0400168 acpi_ec_unblock_transactions();
Rafael J. Wysockid551d812011-01-19 22:27:55 +0100169 suspend_nvs_free();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400170
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200171 if (acpi_state == ACPI_STATE_S0)
172 return;
173
174 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
175 acpi_state);
Rafael J. Wysocki78f5f022010-07-06 22:09:38 -0400176 acpi_disable_wakeup_devices(acpi_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200177 acpi_leave_sleep_state(acpi_state);
178
179 /* reset firmware waking vector */
180 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
181
182 acpi_target_sleep_state = ACPI_STATE_S0;
183}
184
185/**
186 * acpi_pm_end - Finish up suspend sequence.
187 */
188static void acpi_pm_end(void)
189{
190 /*
191 * This is necessary in case acpi_pm_finish() is not called during a
192 * failing transition to a sleep state.
193 */
194 acpi_target_sleep_state = ACPI_STATE_S0;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800195 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200196}
Rafael J. Wysocki92daa7b2008-10-23 21:46:43 +0200197#else /* !CONFIG_ACPI_SLEEP */
198#define acpi_target_sleep_state ACPI_STATE_S0
Rafael J. Wysocki5d1e0722008-10-22 14:58:43 -0400199#endif /* CONFIG_ACPI_SLEEP */
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200200
201#ifdef CONFIG_SUSPEND
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202extern void do_suspend_lowlevel(void);
203
204static u32 acpi_suspend_states[] = {
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500205 [PM_SUSPEND_ON] = ACPI_STATE_S0,
206 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
207 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500208 [PM_SUSPEND_MAX] = ACPI_STATE_S5
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200211/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400212 * acpi_suspend_begin - Set the target system sleep state to the state
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200213 * associated with given @pm_state, if supported.
214 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400215static int acpi_suspend_begin(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
217 u32 acpi_state = acpi_suspend_states[pm_state];
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200218 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200220 error = nvs_nosave ? 0 : suspend_nvs_alloc();
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400221 if (error)
222 return error;
223
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200224 if (sleep_states[acpi_state]) {
225 acpi_target_sleep_state = acpi_state;
Zhao Yakuie49f7112008-08-12 10:20:22 +0800226 acpi_sleep_tts_switch(acpi_target_sleep_state);
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200227 } else {
228 printk(KERN_ERR "ACPI does not support this state: %d\n",
229 pm_state);
230 error = -ENOSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 }
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200232 return error;
233}
234
235/**
Len Brown2c6e33c2008-04-23 18:02:52 -0400236 * acpi_suspend_enter - Actually enter a sleep state.
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200237 * @pm_state: ignored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 *
Rafael J. Wysocki50ad1472007-07-24 11:58:39 +0200239 * Flush caches and go to sleep. For STR we have to call arch-specific
240 * assembly, which in turn call acpi_enter_sleep_state().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * It's unfortunate, but it works. Please fix if you're feeling frisky.
242 */
Len Brown2c6e33c2008-04-23 18:02:52 -0400243static int acpi_suspend_enter(suspend_state_t pm_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
245 acpi_status status = AE_OK;
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200246 u32 acpi_state = acpi_target_sleep_state;
Rafael J. Wysocki979f11b2011-02-08 23:42:09 +0100247 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249 ACPI_FLUSH_CPU_CACHE();
250
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200251 switch (acpi_state) {
252 case ACPI_STATE_S1:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 barrier();
254 status = acpi_enter_sleep_state(acpi_state);
255 break;
256
Rafael J. Wysockie9b3aba2007-07-17 22:40:06 +0200257 case ACPI_STATE_S3:
Rafael J. Wysocki979f11b2011-02-08 23:42:09 +0100258 error = acpi_save_state_mem();
259 if (error)
260 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 do_suspend_lowlevel();
Rafael J. Wysocki7a63f082011-02-08 23:41:57 +0100262 pr_info(PREFIX "Low-level resume complete\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
Arnaud Patard872d83d2006-04-27 05:25:00 -0400265
Matthew Garrettb6dacf62010-05-11 13:49:25 -0400266 /* This violates the spec but is required for bug compatibility. */
267 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500268
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100269 /* Reprogram control registers and execute _BFS */
270 acpi_leave_sleep_state_prep(acpi_state);
271
Pavel Machek23b168d2008-02-05 19:27:12 +0100272 /* ACPI 3.0 specs (P62) says that it's the responsibility
Arnaud Patard872d83d2006-04-27 05:25:00 -0400273 * of the OSPM to clear the status bit [ implying that the
274 * POWER_BUTTON event should not reach userspace ]
275 */
276 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
277 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
278
Shaohua Lia3627f62007-06-20 09:17:58 +0800279 /*
280 * Disable and clear GPE status before interrupt is enabled. Some GPEs
281 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
282 * acpi_leave_sleep_state will reenable specific GPEs later
283 */
Lin Ming3d97e422008-12-16 16:57:46 +0800284 acpi_disable_all_gpes();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200285 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200286 acpi_ec_unblock_transactions_early();
Shaohua Lia3627f62007-06-20 09:17:58 +0800287
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
Lionel Debroux2f55ac02010-11-16 14:14:02 +0100309static const struct platform_suspend_ops acpi_suspend_ops = {
Len Brown2c6e33c2008-04-23 18:02:52 -0400310 .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 */
Lionel Debroux2f55ac02010-11-16 14:14:02 +0100337static const struct platform_suspend_ops acpi_suspend_ops_old = {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200338 .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
Rafael J. Wysocki53998642010-09-24 16:46:14 -0400353static int __init init_nvs_nosave(const struct dmi_system_id *d)
354{
355 acpi_nvs_nosave();
356 return 0;
357}
358
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700359static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
360 {
361 .callback = init_old_suspend_ordering,
362 .ident = "Abit KN9 (nForce4 variant)",
363 .matches = {
364 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
365 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
366 },
367 },
Rafael J. Wysocki4fb507b2008-10-14 22:54:06 +0200368 {
369 .callback = init_old_suspend_ordering,
370 .ident = "HP xw4600 Workstation",
371 .matches = {
372 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
373 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
374 },
375 },
Rafael J. Wysocki65df7842008-11-26 17:53:13 -0500376 {
Andy Whitcrofta1404492009-02-11 18:11:22 +0000377 .callback = init_old_suspend_ordering,
378 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
379 .matches = {
380 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
381 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
382 },
383 },
Zhang Rui45e77982009-03-15 22:13:44 -0400384 {
Zhao Yakui2a9ef8e2009-03-18 16:36:25 +0800385 .callback = init_old_suspend_ordering,
386 .ident = "Panasonic CF51-2L",
387 .matches = {
388 DMI_MATCH(DMI_BOARD_VENDOR,
389 "Matsushita Electric Industrial Co.,Ltd."),
390 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
391 },
392 },
Rafael J. Wysocki53998642010-09-24 16:46:14 -0400393 {
394 .callback = init_nvs_nosave,
395 .ident = "Sony Vaio VGN-SR11M",
396 .matches = {
397 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
398 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
399 },
400 },
401 {
402 .callback = init_nvs_nosave,
403 .ident = "Everex StepNote Series",
404 .matches = {
405 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
406 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
407 },
408 },
Rafael J. Wysockiaf489312010-10-17 21:01:21 +0200409 {
410 .callback = init_nvs_nosave,
411 .ident = "Sony Vaio VPCEB1Z1E",
412 .matches = {
413 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
414 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
415 },
416 },
Rafael J. Wysocki291a73c2010-12-12 21:10:42 +0100417 {
418 .callback = init_nvs_nosave,
419 .ident = "Sony Vaio VGN-NW130D",
420 .matches = {
421 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
422 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
423 },
424 },
Rafael J. Wysocki7b330702011-01-06 23:37:01 +0100425 {
426 .callback = init_nvs_nosave,
427 .ident = "Averatec AV1020-ED2",
428 .matches = {
429 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
430 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
431 },
432 },
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700433 {},
434};
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200435#endif /* CONFIG_SUSPEND */
436
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200437#ifdef CONFIG_HIBERNATION
Shaohua Libdfe6b72008-07-23 21:28:41 -0700438static unsigned long s4_hardware_signature;
439static struct acpi_table_facs *facs;
440static bool nosigcheck;
441
442void __init acpi_no_s4_hw_signature(void)
443{
444 nosigcheck = true;
445}
446
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100447static int acpi_hibernation_begin(void)
Rafael J. Wysocki74f270a2007-10-18 03:04:42 -0700448{
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100449 int error;
450
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200451 error = nvs_nosave ? 0 : suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100452 if (!error) {
453 acpi_target_sleep_state = ACPI_STATE_S4;
454 acpi_sleep_tts_switch(acpi_target_sleep_state);
455 }
456
457 return error;
458}
459
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700460static int acpi_hibernation_enter(void)
461{
462 acpi_status status = AE_OK;
463 unsigned long flags = 0;
464
465 ACPI_FLUSH_CPU_CACHE();
466
467 local_irq_save(flags);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700468 /* This shouldn't return. If it returns, we have a problem */
469 status = acpi_enter_sleep_state(ACPI_STATE_S4);
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100470 /* Reprogram control registers and execute _BFS */
471 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700472 local_irq_restore(flags);
473
474 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
475}
476
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700477static void acpi_hibernation_leave(void)
478{
479 /*
480 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
481 * enable it here.
482 */
483 acpi_enable();
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100484 /* Reprogram control registers and execute _BFS */
485 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
Shaohua Libdfe6b72008-07-23 21:28:41 -0700486 /* Check the hardware signature */
487 if (facs && s4_hardware_signature != facs->hardware_signature) {
488 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
489 "cannot resume!\n");
490 panic("ACPI S4 hardware signature mismatch");
491 }
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100492 /* Restore the NVS memory area */
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400493 suspend_nvs_restore();
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200494 /* Allow EC transactions to happen. */
Rafael J. Wysockife955682010-04-09 01:40:38 +0200495 acpi_ec_unblock_transactions_early();
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700496}
497
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200498static void acpi_pm_thaw(void)
Rafael J. Wysockif6bb13a2010-03-04 01:52:58 +0100499{
Rafael J. Wysockife955682010-04-09 01:40:38 +0200500 acpi_ec_unblock_transactions();
Lin Ming3d97e422008-12-16 16:57:46 +0800501 acpi_enable_all_runtime_gpes();
Rafael J. Wysockia634cc12007-07-19 01:47:30 -0700502}
503
Lionel Debroux073ef1f2010-11-09 21:48:49 +0100504static const struct platform_hibernation_ops acpi_hibernation_ops = {
Rafael J. Wysockicaea99e2008-01-08 00:08:44 +0100505 .begin = acpi_hibernation_begin,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200506 .end = acpi_pm_end,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200507 .pre_snapshot = acpi_pm_prepare,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400508 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200509 .prepare = acpi_pm_prepare,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700510 .enter = acpi_hibernation_enter,
Rafael J. Wysockic7e08312007-10-18 03:04:55 -0700511 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200512 .pre_restore = acpi_pm_freeze,
513 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700514};
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200515
516/**
517 * acpi_hibernation_begin_old - Set the target system sleep state to
518 * ACPI_STATE_S4 and execute the _PTS control method. This
519 * function is used if the pre-ACPI 2.0 suspend ordering has been
520 * requested.
521 */
522static int acpi_hibernation_begin_old(void)
523{
Zhao Yakuie49f7112008-08-12 10:20:22 +0800524 int error;
525 /*
526 * The _TTS object should always be evaluated before the _PTS object.
527 * When the old_suspended_ordering is true, the _PTS object is
528 * evaluated in the acpi_sleep_prepare.
529 */
530 acpi_sleep_tts_switch(ACPI_STATE_S4);
531
532 error = acpi_sleep_prepare(ACPI_STATE_S4);
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200533
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100534 if (!error) {
Rafael J. Wysocki72ad5d72010-07-23 22:59:09 +0200535 if (!nvs_nosave)
Matthew Garrettdd4c4f12010-05-28 16:32:14 -0400536 error = suspend_nvs_alloc();
Rafael J. Wysocki3f4b0ef2008-10-26 20:52:15 +0100537 if (!error)
538 acpi_target_sleep_state = ACPI_STATE_S4;
539 }
540 return error;
541}
542
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200543/*
544 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
545 * been requested.
546 */
Lionel Debroux073ef1f2010-11-09 21:48:49 +0100547static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200548 .begin = acpi_hibernation_begin_old,
549 .end = acpi_pm_end,
Rafael J. Wysockic5f7a1b2010-07-02 00:14:09 +0200550 .pre_snapshot = acpi_pm_pre_suspend,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200551 .prepare = acpi_pm_freeze,
Matthew Garrett2a6b6972010-05-28 16:32:15 -0400552 .finish = acpi_pm_finish,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200553 .enter = acpi_hibernation_enter,
554 .leave = acpi_hibernation_leave,
Rafael J. Wysockid5a64512010-04-09 01:39:40 +0200555 .pre_restore = acpi_pm_freeze,
556 .restore_cleanup = acpi_pm_thaw,
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200557 .recover = acpi_pm_finish,
558};
559#endif /* CONFIG_HIBERNATION */
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700560
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200561int acpi_suspend(u32 acpi_state)
562{
563 suspend_state_t states[] = {
564 [1] = PM_SUSPEND_STANDBY,
565 [3] = PM_SUSPEND_MEM,
566 [5] = PM_SUSPEND_MAX
567 };
568
569 if (acpi_state < 6 && states[acpi_state])
570 return pm_suspend(states[acpi_state]);
571 if (acpi_state == 4)
572 return hibernate();
573 return -EINVAL;
574}
575
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200576#ifdef CONFIG_PM_OPS
Shaohua Lifd4aff12007-07-17 22:40:25 +0200577/**
578 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
579 * in the system sleep state given by %acpi_target_sleep_state
David Brownell2fe2de52008-06-05 01:15:40 +0200580 * @dev: device to examine; its driver model wakeup flags control
581 * whether it should be able to wake up the system
Shaohua Lifd4aff12007-07-17 22:40:25 +0200582 * @d_min_p: used to store the upper limit of allowed states range
583 * Return value: preferred power state of the device on success, -ENODEV on
584 * failure (ie. if there's no 'struct acpi_device' for @dev)
585 *
586 * Find the lowest power (highest number) ACPI device power state that
587 * device @dev can be in while the system is in the sleep state represented
588 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
589 * able to wake up the system from this sleep state. If @d_min_p is set,
590 * the highest power (lowest number) device power state of @dev allowed
591 * in this system sleep state is stored at the location pointed to by it.
592 *
593 * The caller must ensure that @dev is valid before using this function.
594 * The caller is also responsible for figuring out if the device is
595 * supposed to be able to wake up the system and passing this information
596 * via @wake.
597 */
598
David Brownell2fe2de52008-06-05 01:15:40 +0200599int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
Shaohua Lifd4aff12007-07-17 22:40:25 +0200600{
601 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
602 struct acpi_device *adev;
603 char acpi_method[] = "_SxD";
Matthew Wilcox27663c52008-10-10 02:22:59 -0400604 unsigned long long d_min, d_max;
Shaohua Lifd4aff12007-07-17 22:40:25 +0200605
606 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Shaohua Liead77592007-08-23 15:01:13 +0800607 printk(KERN_DEBUG "ACPI handle has no context!\n");
Shaohua Lifd4aff12007-07-17 22:40:25 +0200608 return -ENODEV;
609 }
610
611 acpi_method[2] = '0' + acpi_target_sleep_state;
612 /*
613 * If the sleep state is S0, we will return D3, but if the device has
614 * _S0W, we will use the value from _S0W
615 */
616 d_min = ACPI_STATE_D0;
617 d_max = ACPI_STATE_D3;
618
619 /*
620 * If present, _SxD methods return the minimum D-state (highest power
621 * state) we can use for the corresponding S-states. Otherwise, the
622 * minimum D-state is D0 (ACPI 3.x).
623 *
624 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
625 * provided -- that's our fault recovery, we ignore retval.
626 */
627 if (acpi_target_sleep_state > ACPI_STATE_S0)
628 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
629
630 /*
631 * If _PRW says we can wake up the system from the target sleep state,
632 * the D-state returned by _SxD is sufficient for that (we assume a
633 * wakeup-aware driver if wake is set). Still, if _SxW exists
634 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
635 * can wake the system. _S0W may be valid, too.
636 */
637 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200638 (device_may_wakeup(dev) &&
Shaohua Lifd4aff12007-07-17 22:40:25 +0200639 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100640 acpi_status status;
641
Shaohua Lifd4aff12007-07-17 22:40:25 +0200642 acpi_method[3] = 'W';
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100643 status = acpi_evaluate_integer(handle, acpi_method, NULL,
644 &d_max);
645 if (ACPI_FAILURE(status)) {
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200646 if (acpi_target_sleep_state != ACPI_STATE_S0 ||
647 status != AE_NOT_FOUND)
648 d_max = d_min;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100649 } else if (d_max < d_min) {
650 /* Warn the user of the broken DSDT */
651 printk(KERN_WARNING "ACPI: Wrong value from %s\n",
652 acpi_method);
653 /* Sanitize it */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200654 d_min = d_max;
Rafael J. Wysockiad3399c2008-01-11 00:10:38 +0100655 }
Shaohua Lifd4aff12007-07-17 22:40:25 +0200656 }
657
658 if (d_min_p)
659 *d_min_p = d_min;
660 return d_max;
661}
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200662#endif /* CONFIG_PM_OPS */
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200663
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200664#ifdef CONFIG_PM_SLEEP
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200665/**
666 * acpi_pm_device_sleep_wake - enable or disable the system wake-up
667 * capability of given device
668 * @dev: device to handle
669 * @enable: 'true' - enable, 'false' - disable the wake-up capability
670 */
671int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
672{
673 acpi_handle handle;
674 struct acpi_device *adev;
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200675 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200676
Rafael J. Wysocki0baed8d2009-09-08 23:16:24 +0200677 if (!device_can_wakeup(dev))
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200678 return -EINVAL;
679
680 handle = DEVICE_ACPI_HANDLE(dev);
681 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200682 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200683 return -ENODEV;
684 }
685
Rafael J. Wysockie8b6f972010-06-25 01:18:39 +0200686 error = enable ?
687 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
688 acpi_disable_wakeup_device_power(adev);
Rafael J. Wysockidf8db912009-09-08 23:13:49 +0200689 if (!error)
690 dev_info(dev, "wake-up capability %s by ACPI\n",
691 enable ? "enabled" : "disabled");
692
693 return error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200694}
Rafael J. Wysocki761afb82010-10-14 23:24:13 +0200695#endif /* CONFIG_PM_SLEEP */
Shaohua Lifd4aff12007-07-17 22:40:25 +0200696
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400697static void acpi_power_off_prepare(void)
698{
699 /* Prepare to power off the system */
700 acpi_sleep_prepare(ACPI_STATE_S5);
Lin Ming3d97e422008-12-16 16:57:46 +0800701 acpi_disable_all_gpes();
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400702}
703
704static void acpi_power_off(void)
705{
706 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
Frank Seidel4d939152009-02-04 17:03:07 +0100707 printk(KERN_DEBUG "%s called\n", __func__);
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400708 local_irq_disable();
709 acpi_enter_sleep_state(ACPI_STATE_S5);
710}
711
Len Brown96f15ef2009-04-17 23:32:20 -0400712/*
713 * ACPI 2.0 created the optional _GTS and _BFS,
714 * but industry adoption has been neither rapid nor broad.
715 *
716 * Linux gets into trouble when it executes poorly validated
717 * paths through the BIOS, so disable _GTS and _BFS by default,
718 * but do speak up and offer the option to enable them.
719 */
Stephen Hemminger01eac602010-10-18 18:47:25 -0700720static void __init acpi_gts_bfs_check(void)
Len Brown96f15ef2009-04-17 23:32:20 -0400721{
722 acpi_handle dummy;
723
724 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
725 {
726 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
727 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
728 "please notify linux-acpi@vger.kernel.org\n");
729 }
730 if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
731 {
732 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
733 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
734 "please notify linux-acpi@vger.kernel.org\n");
735 }
736}
737
Alexey Starikovskiyaafbcd12007-02-10 01:32:16 -0500738int __init acpi_sleep_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200740 acpi_status status;
741 u8 type_a, type_b;
742#ifdef CONFIG_SUSPEND
Alexey Starikovskiye2a5b422005-03-18 16:20:46 -0500743 int i = 0;
Carlos Corbachoe41fb7c2008-07-23 21:28:43 -0700744
745 dmi_check_system(acpisleep_dmi_table);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200746#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
748 if (acpi_disabled)
749 return 0;
750
Frans Pop5a50fe72007-09-20 22:27:44 +0200751 sleep_states[ACPI_STATE_S0] = 1;
752 printk(KERN_INFO PREFIX "(supports S0");
753
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200754#ifdef CONFIG_SUSPEND
Frans Pop5a50fe72007-09-20 22:27:44 +0200755 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
757 if (ACPI_SUCCESS(status)) {
758 sleep_states[i] = 1;
759 printk(" S%d", i);
760 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200763 suspend_set_ops(old_suspend_ordering ?
764 &acpi_suspend_ops_old : &acpi_suspend_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200765#endif
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700766
Rafael J. Wysockib0cb1a12007-07-29 23:24:36 +0200767#ifdef CONFIG_HIBERNATION
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200768 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
769 if (ACPI_SUCCESS(status)) {
Rafael J. Wysockid8f3de02008-06-12 23:24:06 +0200770 hibernation_set_ops(old_suspend_ordering ?
771 &acpi_hibernation_ops_old : &acpi_hibernation_ops);
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200772 sleep_states[ACPI_STATE_S4] = 1;
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400773 printk(" S4");
Shaohua Libdfe6b72008-07-23 21:28:41 -0700774 if (!nosigcheck) {
Lin Ming3d97e422008-12-16 16:57:46 +0800775 acpi_get_table(ACPI_SIG_FACS, 1,
Shaohua Libdfe6b72008-07-23 21:28:41 -0700776 (struct acpi_table_header **)&facs);
777 if (facs)
778 s4_hardware_signature =
779 facs->hardware_signature;
780 }
Rafael J. Wysocki296699d2007-07-29 23:27:18 +0200781 }
Rafael J. Wysockia3d25c22007-05-09 02:33:18 -0700782#endif
Alexey Starikovskiyf216cc32007-09-20 21:32:35 +0400783 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
784 if (ACPI_SUCCESS(status)) {
785 sleep_states[ACPI_STATE_S5] = 1;
786 printk(" S5");
787 pm_power_off_prepare = acpi_power_off_prepare;
788 pm_power_off = acpi_power_off;
789 }
790 printk(")\n");
Zhao Yakuie49f7112008-08-12 10:20:22 +0800791 /*
792 * Register the tts_notifier to reboot notifier list so that the _TTS
793 * object can also be evaluated when the system enters S5.
794 */
795 register_reboot_notifier(&tts_notifier);
Len Brown96f15ef2009-04-17 23:32:20 -0400796 acpi_gts_bfs_check();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 return 0;
798}