]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/acpi/sleep/main.c
ACPI: Separate invocations of _GTS and _BFS from _PTS and _WAK
[mirror_ubuntu-artful-kernel.git] / drivers / acpi / sleep / main.c
CommitLineData
1da177e4
LT
1/*
2 * sleep.c - ACPI sleep support.
3 *
e2a5b420 4 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
1da177e4
LT
5 * 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>
f216cc37
AS
18
19#include <asm/io.h>
20
1da177e4
LT
21#include <acpi/acpi_bus.h>
22#include <acpi/acpi_drivers.h>
23#include "sleep.h"
24
25u8 sleep_states[ACPI_S_STATE_COUNT];
26
853298bc 27#ifdef CONFIG_PM_SLEEP
296699de 28static u32 acpi_target_sleep_state = ACPI_STATE_S0;
853298bc 29#endif
296699de 30
2f3f2226
AS
31int acpi_sleep_prepare(u32 acpi_state)
32{
33#ifdef CONFIG_ACPI_SLEEP
34 /* do we have a wakeup address for S2 and S3? */
35 if (acpi_state == ACPI_STATE_S3) {
36 if (!acpi_wakeup_address) {
37 return -EFAULT;
38 }
39 acpi_set_firmware_waking_vector((acpi_physical_address)
40 virt_to_phys((void *)
41 acpi_wakeup_address));
42
43 }
44 ACPI_FLUSH_CPU_CACHE();
45 acpi_enable_wakeup_device_prep(acpi_state);
46#endif
2f3f2226
AS
47 acpi_enter_sleep_state_prep(acpi_state);
48 return 0;
49}
50
296699de 51#ifdef CONFIG_SUSPEND
26398a70 52static struct platform_suspend_ops acpi_pm_ops;
1da177e4 53
1da177e4
LT
54extern void do_suspend_lowlevel(void);
55
56static u32 acpi_suspend_states[] = {
e2a5b420
AS
57 [PM_SUSPEND_ON] = ACPI_STATE_S0,
58 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
59 [PM_SUSPEND_MEM] = ACPI_STATE_S3,
e2a5b420 60 [PM_SUSPEND_MAX] = ACPI_STATE_S5
1da177e4
LT
61};
62
63static int init_8259A_after_S1;
64
e9b3aba8 65/**
c697eece 66 * acpi_pm_begin - Set the target system sleep state to the state
e9b3aba8
RW
67 * associated with given @pm_state, if supported.
68 */
69
c697eece 70static int acpi_pm_begin(suspend_state_t pm_state)
e9b3aba8
RW
71{
72 u32 acpi_state = acpi_suspend_states[pm_state];
73 int error = 0;
74
75 if (sleep_states[acpi_state]) {
76 acpi_target_sleep_state = acpi_state;
77 } else {
78 printk(KERN_ERR "ACPI does not support this state: %d\n",
79 pm_state);
80 error = -ENOSYS;
81 }
82 return error;
83}
84
1da177e4
LT
85/**
86 * acpi_pm_prepare - Do preliminary suspend work.
1da177e4 87 *
e9b3aba8
RW
88 * If necessary, set the firmware waking vector and do arch-specific
89 * nastiness to get the wakeup code to the waking vector.
1da177e4
LT
90 */
91
e6c5eb95 92static int acpi_pm_prepare(void)
1da177e4 93{
e9b3aba8 94 int error = acpi_sleep_prepare(acpi_target_sleep_state);
1da177e4 95
e9b3aba8
RW
96 if (error)
97 acpi_target_sleep_state = ACPI_STATE_S0;
98
99 return error;
1da177e4
LT
100}
101
1da177e4
LT
102/**
103 * acpi_pm_enter - Actually enter a sleep state.
e9b3aba8 104 * @pm_state: ignored
1da177e4 105 *
50ad147a
RW
106 * Flush caches and go to sleep. For STR we have to call arch-specific
107 * assembly, which in turn call acpi_enter_sleep_state().
1da177e4
LT
108 * It's unfortunate, but it works. Please fix if you're feeling frisky.
109 */
110
111static int acpi_pm_enter(suspend_state_t pm_state)
112{
113 acpi_status status = AE_OK;
114 unsigned long flags = 0;
e9b3aba8 115 u32 acpi_state = acpi_target_sleep_state;
1da177e4
LT
116
117 ACPI_FLUSH_CPU_CACHE();
118
119 /* Do arch specific saving of state. */
50ad147a 120 if (acpi_state == ACPI_STATE_S3) {
1da177e4 121 int error = acpi_save_state_mem();
e9b3aba8
RW
122
123 if (error) {
124 acpi_target_sleep_state = ACPI_STATE_S0;
1da177e4 125 return error;
e9b3aba8 126 }
1da177e4
LT
127 }
128
1da177e4
LT
129 local_irq_save(flags);
130 acpi_enable_wakeup_device(acpi_state);
e9b3aba8
RW
131 switch (acpi_state) {
132 case ACPI_STATE_S1:
1da177e4
LT
133 barrier();
134 status = acpi_enter_sleep_state(acpi_state);
135 break;
136
e9b3aba8 137 case ACPI_STATE_S3:
1da177e4
LT
138 do_suspend_lowlevel();
139 break;
1da177e4 140 }
872d83d0 141
c95d47a8
RW
142 /* Reprogram control registers and execute _BFS */
143 acpi_leave_sleep_state_prep(acpi_state);
144
872d83d0
AP
145 /* ACPI 3.0 specs (P62) says that it's the responsabilty
146 * of the OSPM to clear the status bit [ implying that the
147 * POWER_BUTTON event should not reach userspace ]
148 */
149 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
150 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
151
a3627f67
SL
152 /*
153 * Disable and clear GPE status before interrupt is enabled. Some GPEs
154 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
155 * acpi_leave_sleep_state will reenable specific GPEs later
156 */
157 acpi_hw_disable_all_gpes();
158
1da177e4
LT
159 local_irq_restore(flags);
160 printk(KERN_DEBUG "Back to C!\n");
161
e9b3aba8 162 /* restore processor state */
50ad147a 163 if (acpi_state == ACPI_STATE_S3)
1da177e4
LT
164 acpi_restore_state_mem();
165
1da177e4
LT
166 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
167}
168
1da177e4 169/**
c697eece 170 * acpi_pm_finish - Instruct the platform to leave a sleep state.
1da177e4
LT
171 *
172 * This is called after we wake back up (or if entering the sleep state
173 * failed).
174 */
175
e6c5eb95 176static void acpi_pm_finish(void)
1da177e4 177{
e9b3aba8 178 u32 acpi_state = acpi_target_sleep_state;
1da177e4 179
1da177e4 180 acpi_disable_wakeup_device(acpi_state);
1dbc1fda 181 acpi_leave_sleep_state(acpi_state);
1da177e4
LT
182
183 /* reset firmware waking vector */
184 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
185
e9b3aba8
RW
186 acpi_target_sleep_state = ACPI_STATE_S0;
187
e8b2fd01 188#ifdef CONFIG_X86
1da177e4
LT
189 if (init_8259A_after_S1) {
190 printk("Broken toshiba laptop -> kicking interrupts\n");
191 init_8259A(0);
192 }
e8b2fd01 193#endif
1da177e4
LT
194}
195
c697eece
RW
196/**
197 * acpi_pm_end - Finish up suspend sequence.
198 */
199
200static void acpi_pm_end(void)
201{
202 /*
203 * This is necessary in case acpi_pm_finish() is not called during a
204 * failing transition to a sleep state.
205 */
206 acpi_target_sleep_state = ACPI_STATE_S0;
207}
208
eb9289eb
SL
209static int acpi_pm_state_valid(suspend_state_t pm_state)
210{
e8c9c502 211 u32 acpi_state;
eb9289eb 212
e8c9c502
JB
213 switch (pm_state) {
214 case PM_SUSPEND_ON:
215 case PM_SUSPEND_STANDBY:
216 case PM_SUSPEND_MEM:
217 acpi_state = acpi_suspend_states[pm_state];
218
219 return sleep_states[acpi_state];
220 default:
221 return 0;
222 }
eb9289eb
SL
223}
224
26398a70 225static struct platform_suspend_ops acpi_pm_ops = {
eb9289eb 226 .valid = acpi_pm_state_valid,
c697eece 227 .begin = acpi_pm_begin,
e2a5b420
AS
228 .prepare = acpi_pm_prepare,
229 .enter = acpi_pm_enter,
230 .finish = acpi_pm_finish,
c697eece 231 .end = acpi_pm_end,
1da177e4
LT
232};
233
296699de
RW
234/*
235 * Toshiba fails to preserve interrupts over S1, reinitialization
236 * of 8259 is needed after S1 resume.
237 */
1855256c 238static int __init init_ints_after_s1(const struct dmi_system_id *d)
296699de
RW
239{
240 printk(KERN_WARNING "%s with broken S1 detected.\n", d->ident);
241 init_8259A_after_S1 = 1;
242 return 0;
243}
244
245static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
246 {
247 .callback = init_ints_after_s1,
248 .ident = "Toshiba Satellite 4030cdt",
249 .matches = {DMI_MATCH(DMI_PRODUCT_NAME, "S4030CDT/4.3"),},
250 },
251 {},
252};
253#endif /* CONFIG_SUSPEND */
254
b0cb1a19 255#ifdef CONFIG_HIBERNATION
74f270af
RW
256static int acpi_hibernation_start(void)
257{
258 acpi_target_sleep_state = ACPI_STATE_S4;
259 return 0;
260}
261
a3d25c27
RW
262static int acpi_hibernation_prepare(void)
263{
264 return acpi_sleep_prepare(ACPI_STATE_S4);
265}
266
267static int acpi_hibernation_enter(void)
268{
269 acpi_status status = AE_OK;
270 unsigned long flags = 0;
271
272 ACPI_FLUSH_CPU_CACHE();
273
274 local_irq_save(flags);
275 acpi_enable_wakeup_device(ACPI_STATE_S4);
276 /* This shouldn't return. If it returns, we have a problem */
277 status = acpi_enter_sleep_state(ACPI_STATE_S4);
c95d47a8
RW
278 /* Reprogram control registers and execute _BFS */
279 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
a3d25c27
RW
280 local_irq_restore(flags);
281
282 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
283}
284
c7e0831d
RW
285static void acpi_hibernation_leave(void)
286{
287 /*
288 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
289 * enable it here.
290 */
291 acpi_enable();
c95d47a8
RW
292 /* Reprogram control registers and execute _BFS */
293 acpi_leave_sleep_state_prep(ACPI_STATE_S4);
c7e0831d
RW
294}
295
a3d25c27
RW
296static void acpi_hibernation_finish(void)
297{
a3d25c27 298 acpi_disable_wakeup_device(ACPI_STATE_S4);
1dbc1fda 299 acpi_leave_sleep_state(ACPI_STATE_S4);
a3d25c27
RW
300
301 /* reset firmware waking vector */
302 acpi_set_firmware_waking_vector((acpi_physical_address) 0);
74f270af
RW
303
304 acpi_target_sleep_state = ACPI_STATE_S0;
a3d25c27
RW
305}
306
a634cc10
RW
307static int acpi_hibernation_pre_restore(void)
308{
309 acpi_status status;
310
311 status = acpi_hw_disable_all_gpes();
312
313 return ACPI_SUCCESS(status) ? 0 : -EFAULT;
314}
315
316static void acpi_hibernation_restore_cleanup(void)
317{
318 acpi_hw_enable_all_runtime_gpes();
319}
320
b3dac3b3 321static struct platform_hibernation_ops acpi_hibernation_ops = {
74f270af
RW
322 .start = acpi_hibernation_start,
323 .pre_snapshot = acpi_hibernation_prepare,
324 .finish = acpi_hibernation_finish,
a3d25c27
RW
325 .prepare = acpi_hibernation_prepare,
326 .enter = acpi_hibernation_enter,
c7e0831d 327 .leave = acpi_hibernation_leave,
a634cc10
RW
328 .pre_restore = acpi_hibernation_pre_restore,
329 .restore_cleanup = acpi_hibernation_restore_cleanup,
a3d25c27 330};
b0cb1a19 331#endif /* CONFIG_HIBERNATION */
a3d25c27 332
296699de
RW
333int acpi_suspend(u32 acpi_state)
334{
335 suspend_state_t states[] = {
336 [1] = PM_SUSPEND_STANDBY,
337 [3] = PM_SUSPEND_MEM,
338 [5] = PM_SUSPEND_MAX
339 };
340
341 if (acpi_state < 6 && states[acpi_state])
342 return pm_suspend(states[acpi_state]);
343 if (acpi_state == 4)
344 return hibernate();
345 return -EINVAL;
346}
347
853298bc 348#ifdef CONFIG_PM_SLEEP
fd4aff1a
SL
349/**
350 * acpi_pm_device_sleep_state - return preferred power state of ACPI device
351 * in the system sleep state given by %acpi_target_sleep_state
352 * @dev: device to examine
353 * @wake: if set, the device should be able to wake up the system
354 * @d_min_p: used to store the upper limit of allowed states range
355 * Return value: preferred power state of the device on success, -ENODEV on
356 * failure (ie. if there's no 'struct acpi_device' for @dev)
357 *
358 * Find the lowest power (highest number) ACPI device power state that
359 * device @dev can be in while the system is in the sleep state represented
360 * by %acpi_target_sleep_state. If @wake is nonzero, the device should be
361 * able to wake up the system from this sleep state. If @d_min_p is set,
362 * the highest power (lowest number) device power state of @dev allowed
363 * in this system sleep state is stored at the location pointed to by it.
364 *
365 * The caller must ensure that @dev is valid before using this function.
366 * The caller is also responsible for figuring out if the device is
367 * supposed to be able to wake up the system and passing this information
368 * via @wake.
369 */
370
371int acpi_pm_device_sleep_state(struct device *dev, int wake, int *d_min_p)
372{
373 acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
374 struct acpi_device *adev;
375 char acpi_method[] = "_SxD";
376 unsigned long d_min, d_max;
377
378 if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
ead77594 379 printk(KERN_DEBUG "ACPI handle has no context!\n");
fd4aff1a
SL
380 return -ENODEV;
381 }
382
383 acpi_method[2] = '0' + acpi_target_sleep_state;
384 /*
385 * If the sleep state is S0, we will return D3, but if the device has
386 * _S0W, we will use the value from _S0W
387 */
388 d_min = ACPI_STATE_D0;
389 d_max = ACPI_STATE_D3;
390
391 /*
392 * If present, _SxD methods return the minimum D-state (highest power
393 * state) we can use for the corresponding S-states. Otherwise, the
394 * minimum D-state is D0 (ACPI 3.x).
395 *
396 * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
397 * provided -- that's our fault recovery, we ignore retval.
398 */
399 if (acpi_target_sleep_state > ACPI_STATE_S0)
400 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
401
402 /*
403 * If _PRW says we can wake up the system from the target sleep state,
404 * the D-state returned by _SxD is sufficient for that (we assume a
405 * wakeup-aware driver if wake is set). Still, if _SxW exists
406 * (ACPI 3.x), it should return the maximum (lowest power) D-state that
407 * can wake the system. _S0W may be valid, too.
408 */
409 if (acpi_target_sleep_state == ACPI_STATE_S0 ||
410 (wake && adev->wakeup.state.enabled &&
411 adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
412 acpi_method[3] = 'W';
413 acpi_evaluate_integer(handle, acpi_method, NULL, &d_max);
414 /* Sanity check */
415 if (d_max < d_min)
416 d_min = d_max;
417 }
418
419 if (d_min_p)
420 *d_min_p = d_min;
421 return d_max;
422}
853298bc 423#endif
fd4aff1a 424
f216cc37
AS
425static void acpi_power_off_prepare(void)
426{
427 /* Prepare to power off the system */
428 acpi_sleep_prepare(ACPI_STATE_S5);
429}
430
431static void acpi_power_off(void)
432{
433 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
434 printk("%s called\n", __FUNCTION__);
435 local_irq_disable();
9c1c6a1b 436 acpi_enable_wakeup_device(ACPI_STATE_S5);
f216cc37
AS
437 acpi_enter_sleep_state(ACPI_STATE_S5);
438}
439
aafbcd16 440int __init acpi_sleep_init(void)
1da177e4 441{
296699de
RW
442 acpi_status status;
443 u8 type_a, type_b;
444#ifdef CONFIG_SUSPEND
e2a5b420 445 int i = 0;
1da177e4
LT
446
447 dmi_check_system(acpisleep_dmi_table);
296699de 448#endif
1da177e4
LT
449
450 if (acpi_disabled)
451 return 0;
452
5a50fe70
FP
453 sleep_states[ACPI_STATE_S0] = 1;
454 printk(KERN_INFO PREFIX "(supports S0");
455
296699de 456#ifdef CONFIG_SUSPEND
5a50fe70 457 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
1da177e4
LT
458 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
459 if (ACPI_SUCCESS(status)) {
460 sleep_states[i] = 1;
461 printk(" S%d", i);
462 }
1da177e4 463 }
1da177e4 464
26398a70 465 suspend_set_ops(&acpi_pm_ops);
296699de 466#endif
a3d25c27 467
b0cb1a19 468#ifdef CONFIG_HIBERNATION
296699de
RW
469 status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
470 if (ACPI_SUCCESS(status)) {
a3d25c27 471 hibernation_set_ops(&acpi_hibernation_ops);
296699de 472 sleep_states[ACPI_STATE_S4] = 1;
f216cc37 473 printk(" S4");
296699de 474 }
a3d25c27 475#endif
f216cc37
AS
476 status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
477 if (ACPI_SUCCESS(status)) {
478 sleep_states[ACPI_STATE_S5] = 1;
479 printk(" S5");
480 pm_power_off_prepare = acpi_power_off_prepare;
481 pm_power_off = acpi_power_off;
482 }
483 printk(")\n");
1da177e4
LT
484 return 0;
485}