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