]>
Commit | Line | Data |
---|---|---|
1802d0be | 1 | // SPDX-License-Identifier: GPL-2.0-only |
ec2cd81c RW |
2 | /* |
3 | * drivers/acpi/device_pm.c - ACPI device power management routines. | |
4 | * | |
5 | * Copyright (C) 2012, Intel Corp. | |
6 | * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> | |
7 | * | |
8 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
9 | * | |
ec2cd81c RW |
10 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
11 | */ | |
12 | ||
7b199811 | 13 | #include <linux/acpi.h> |
86b3832c | 14 | #include <linux/export.h> |
ec2cd81c | 15 | #include <linux/mutex.h> |
86b3832c | 16 | #include <linux/pm_qos.h> |
989561de | 17 | #include <linux/pm_domain.h> |
cd7bd02d | 18 | #include <linux/pm_runtime.h> |
33e4f80e | 19 | #include <linux/suspend.h> |
ec2cd81c | 20 | |
9ce4e607 RW |
21 | #include "internal.h" |
22 | ||
23 | #define _COMPONENT ACPI_POWER_COMPONENT | |
24 | ACPI_MODULE_NAME("device_pm"); | |
ec2cd81c | 25 | |
9ce4e607 RW |
26 | /** |
27 | * acpi_power_state_string - String representation of ACPI device power state. | |
28 | * @state: ACPI device power state to return the string representation of. | |
29 | */ | |
30 | const char *acpi_power_state_string(int state) | |
31 | { | |
32 | switch (state) { | |
33 | case ACPI_STATE_D0: | |
34 | return "D0"; | |
35 | case ACPI_STATE_D1: | |
36 | return "D1"; | |
37 | case ACPI_STATE_D2: | |
38 | return "D2"; | |
39 | case ACPI_STATE_D3_HOT: | |
40 | return "D3hot"; | |
41 | case ACPI_STATE_D3_COLD: | |
898fee4f | 42 | return "D3cold"; |
9ce4e607 RW |
43 | default: |
44 | return "(unknown)"; | |
45 | } | |
46 | } | |
47 | ||
48 | /** | |
49 | * acpi_device_get_power - Get power state of an ACPI device. | |
50 | * @device: Device to get the power state of. | |
51 | * @state: Place to store the power state of the device. | |
52 | * | |
53 | * This function does not update the device's power.state field, but it may | |
54 | * update its parent's power.state field (when the parent's power state is | |
55 | * unknown and the device's power state turns out to be D0). | |
56 | */ | |
57 | int acpi_device_get_power(struct acpi_device *device, int *state) | |
58 | { | |
59 | int result = ACPI_STATE_UNKNOWN; | |
60 | ||
61 | if (!device || !state) | |
62 | return -EINVAL; | |
63 | ||
64 | if (!device->flags.power_manageable) { | |
65 | /* TBD: Non-recursive algorithm for walking up hierarchy. */ | |
66 | *state = device->parent ? | |
67 | device->parent->power.state : ACPI_STATE_D0; | |
68 | goto out; | |
69 | } | |
70 | ||
71 | /* | |
75eb2d13 RW |
72 | * Get the device's power state from power resources settings and _PSC, |
73 | * if available. | |
9ce4e607 | 74 | */ |
75eb2d13 RW |
75 | if (device->power.flags.power_resources) { |
76 | int error = acpi_power_get_inferred_state(device, &result); | |
77 | if (error) | |
78 | return error; | |
79 | } | |
9ce4e607 | 80 | if (device->power.flags.explicit_get) { |
75eb2d13 | 81 | acpi_handle handle = device->handle; |
9ce4e607 | 82 | unsigned long long psc; |
75eb2d13 RW |
83 | acpi_status status; |
84 | ||
85 | status = acpi_evaluate_integer(handle, "_PSC", NULL, &psc); | |
9ce4e607 RW |
86 | if (ACPI_FAILURE(status)) |
87 | return -ENODEV; | |
88 | ||
75eb2d13 RW |
89 | /* |
90 | * The power resources settings may indicate a power state | |
20dacb71 RW |
91 | * shallower than the actual power state of the device, because |
92 | * the same power resources may be referenced by other devices. | |
75eb2d13 | 93 | * |
20dacb71 RW |
94 | * For systems predating ACPI 4.0 we assume that D3hot is the |
95 | * deepest state that can be supported. | |
75eb2d13 RW |
96 | */ |
97 | if (psc > result && psc < ACPI_STATE_D3_COLD) | |
98 | result = psc; | |
99 | else if (result == ACPI_STATE_UNKNOWN) | |
20dacb71 | 100 | result = psc > ACPI_STATE_D2 ? ACPI_STATE_D3_HOT : psc; |
9ce4e607 RW |
101 | } |
102 | ||
103 | /* | |
104 | * If we were unsure about the device parent's power state up to this | |
105 | * point, the fact that the device is in D0 implies that the parent has | |
644f17ad | 106 | * to be in D0 too, except if ignore_parent is set. |
9ce4e607 | 107 | */ |
644f17ad MW |
108 | if (!device->power.flags.ignore_parent && device->parent |
109 | && device->parent->power.state == ACPI_STATE_UNKNOWN | |
9ce4e607 RW |
110 | && result == ACPI_STATE_D0) |
111 | device->parent->power.state = ACPI_STATE_D0; | |
112 | ||
113 | *state = result; | |
114 | ||
115 | out: | |
116 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] power state is %s\n", | |
117 | device->pnp.bus_id, acpi_power_state_string(*state))); | |
118 | ||
119 | return 0; | |
120 | } | |
fe650c8b | 121 | EXPORT_SYMBOL(acpi_device_get_power); |
9ce4e607 | 122 | |
9c0f45e3 RW |
123 | static int acpi_dev_pm_explicit_set(struct acpi_device *adev, int state) |
124 | { | |
125 | if (adev->power.states[state].flags.explicit_set) { | |
126 | char method[5] = { '_', 'P', 'S', '0' + state, '\0' }; | |
127 | acpi_status status; | |
128 | ||
129 | status = acpi_evaluate_object(adev->handle, method, NULL, NULL); | |
130 | if (ACPI_FAILURE(status)) | |
131 | return -ENODEV; | |
132 | } | |
133 | return 0; | |
134 | } | |
135 | ||
9ce4e607 RW |
136 | /** |
137 | * acpi_device_set_power - Set power state of an ACPI device. | |
138 | * @device: Device to set the power state of. | |
139 | * @state: New power state to set. | |
140 | * | |
141 | * Callers must ensure that the device is power manageable before using this | |
142 | * function. | |
143 | */ | |
144 | int acpi_device_set_power(struct acpi_device *device, int state) | |
145 | { | |
20dacb71 | 146 | int target_state = state; |
9ce4e607 | 147 | int result = 0; |
9ce4e607 | 148 | |
2c7d132a RW |
149 | if (!device || !device->flags.power_manageable |
150 | || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD)) | |
9ce4e607 RW |
151 | return -EINVAL; |
152 | ||
153 | /* Make sure this is a valid target state */ | |
154 | ||
155 | if (state == device->power.state) { | |
b69137a7 RW |
156 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] already in %s\n", |
157 | device->pnp.bus_id, | |
9ce4e607 RW |
158 | acpi_power_state_string(state))); |
159 | return 0; | |
160 | } | |
161 | ||
20dacb71 RW |
162 | if (state == ACPI_STATE_D3_COLD) { |
163 | /* | |
164 | * For transitions to D3cold we need to execute _PS3 and then | |
165 | * possibly drop references to the power resources in use. | |
166 | */ | |
167 | state = ACPI_STATE_D3_HOT; | |
168 | /* If _PR3 is not available, use D3hot as the target state. */ | |
169 | if (!device->power.states[ACPI_STATE_D3_COLD].flags.valid) | |
170 | target_state = state; | |
171 | } else if (!device->power.states[state].flags.valid) { | |
b69137a7 RW |
172 | dev_warn(&device->dev, "Power state %s not supported\n", |
173 | acpi_power_state_string(state)); | |
9ce4e607 RW |
174 | return -ENODEV; |
175 | } | |
20dacb71 | 176 | |
644f17ad MW |
177 | if (!device->power.flags.ignore_parent && |
178 | device->parent && (state < device->parent->power.state)) { | |
b69137a7 | 179 | dev_warn(&device->dev, |
593298e6 AL |
180 | "Cannot transition to power state %s for parent in %s\n", |
181 | acpi_power_state_string(state), | |
182 | acpi_power_state_string(device->parent->power.state)); | |
9ce4e607 RW |
183 | return -ENODEV; |
184 | } | |
185 | ||
9ce4e607 RW |
186 | /* |
187 | * Transition Power | |
188 | * ---------------- | |
20dacb71 RW |
189 | * In accordance with ACPI 6, _PSx is executed before manipulating power |
190 | * resources, unless the target state is D0, in which case _PS0 is | |
191 | * supposed to be executed after turning the power resources on. | |
9ce4e607 | 192 | */ |
20dacb71 RW |
193 | if (state > ACPI_STATE_D0) { |
194 | /* | |
195 | * According to ACPI 6, devices cannot go from lower-power | |
196 | * (deeper) states to higher-power (shallower) states. | |
197 | */ | |
198 | if (state < device->power.state) { | |
199 | dev_warn(&device->dev, "Cannot transition from %s to %s\n", | |
200 | acpi_power_state_string(device->power.state), | |
201 | acpi_power_state_string(state)); | |
202 | return -ENODEV; | |
203 | } | |
204 | ||
205 | result = acpi_dev_pm_explicit_set(device, state); | |
9c0f45e3 RW |
206 | if (result) |
207 | goto end; | |
9ce4e607 | 208 | |
20dacb71 RW |
209 | if (device->power.flags.power_resources) |
210 | result = acpi_power_transition(device, target_state); | |
211 | } else { | |
212 | if (device->power.flags.power_resources) { | |
213 | result = acpi_power_transition(device, ACPI_STATE_D0); | |
214 | if (result) | |
215 | goto end; | |
216 | } | |
217 | result = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0); | |
e5656271 | 218 | } |
9ce4e607 | 219 | |
e78adb75 RW |
220 | end: |
221 | if (result) { | |
b69137a7 RW |
222 | dev_warn(&device->dev, "Failed to change power state to %s\n", |
223 | acpi_power_state_string(state)); | |
e78adb75 | 224 | } else { |
71b65445 | 225 | device->power.state = target_state; |
9ce4e607 RW |
226 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, |
227 | "Device [%s] transitioned to %s\n", | |
228 | device->pnp.bus_id, | |
229 | acpi_power_state_string(state))); | |
230 | } | |
231 | ||
232 | return result; | |
233 | } | |
234 | EXPORT_SYMBOL(acpi_device_set_power); | |
235 | ||
236 | int acpi_bus_set_power(acpi_handle handle, int state) | |
237 | { | |
238 | struct acpi_device *device; | |
239 | int result; | |
240 | ||
241 | result = acpi_bus_get_device(handle, &device); | |
242 | if (result) | |
243 | return result; | |
244 | ||
9ce4e607 RW |
245 | return acpi_device_set_power(device, state); |
246 | } | |
247 | EXPORT_SYMBOL(acpi_bus_set_power); | |
248 | ||
249 | int acpi_bus_init_power(struct acpi_device *device) | |
250 | { | |
251 | int state; | |
252 | int result; | |
253 | ||
254 | if (!device) | |
255 | return -EINVAL; | |
256 | ||
257 | device->power.state = ACPI_STATE_UNKNOWN; | |
cde1f95f SA |
258 | if (!acpi_device_is_present(device)) { |
259 | device->flags.initialized = false; | |
1b1f3e16 | 260 | return -ENXIO; |
cde1f95f | 261 | } |
9ce4e607 RW |
262 | |
263 | result = acpi_device_get_power(device, &state); | |
264 | if (result) | |
265 | return result; | |
266 | ||
a2367807 | 267 | if (state < ACPI_STATE_D3_COLD && device->power.flags.power_resources) { |
20dacb71 | 268 | /* Reference count the power resources. */ |
9ce4e607 | 269 | result = acpi_power_on_resources(device, state); |
a2367807 RW |
270 | if (result) |
271 | return result; | |
9ce4e607 | 272 | |
20dacb71 RW |
273 | if (state == ACPI_STATE_D0) { |
274 | /* | |
275 | * If _PSC is not present and the state inferred from | |
276 | * power resources appears to be D0, it still may be | |
277 | * necessary to execute _PS0 at this point, because | |
278 | * another device using the same power resources may | |
279 | * have been put into D0 previously and that's why we | |
280 | * see D0 here. | |
281 | */ | |
282 | result = acpi_dev_pm_explicit_set(device, state); | |
283 | if (result) | |
284 | return result; | |
285 | } | |
b3785492 | 286 | } else if (state == ACPI_STATE_UNKNOWN) { |
7cd8407d RW |
287 | /* |
288 | * No power resources and missing _PSC? Cross fingers and make | |
289 | * it D0 in hope that this is what the BIOS put the device into. | |
290 | * [We tried to force D0 here by executing _PS0, but that broke | |
291 | * Toshiba P870-303 in a nasty way.] | |
292 | */ | |
b3785492 | 293 | state = ACPI_STATE_D0; |
a2367807 RW |
294 | } |
295 | device->power.state = state; | |
296 | return 0; | |
9ce4e607 RW |
297 | } |
298 | ||
b9e95fc6 RW |
299 | /** |
300 | * acpi_device_fix_up_power - Force device with missing _PSC into D0. | |
301 | * @device: Device object whose power state is to be fixed up. | |
302 | * | |
303 | * Devices without power resources and _PSC, but having _PS0 and _PS3 defined, | |
304 | * are assumed to be put into D0 by the BIOS. However, in some cases that may | |
305 | * not be the case and this function should be used then. | |
306 | */ | |
307 | int acpi_device_fix_up_power(struct acpi_device *device) | |
308 | { | |
309 | int ret = 0; | |
310 | ||
311 | if (!device->power.flags.power_resources | |
312 | && !device->power.flags.explicit_get | |
313 | && device->power.state == ACPI_STATE_D0) | |
314 | ret = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0); | |
315 | ||
316 | return ret; | |
317 | } | |
78a898d0 | 318 | EXPORT_SYMBOL_GPL(acpi_device_fix_up_power); |
b9e95fc6 | 319 | |
202317a5 | 320 | int acpi_device_update_power(struct acpi_device *device, int *state_p) |
9ce4e607 | 321 | { |
9ce4e607 RW |
322 | int state; |
323 | int result; | |
324 | ||
202317a5 RW |
325 | if (device->power.state == ACPI_STATE_UNKNOWN) { |
326 | result = acpi_bus_init_power(device); | |
327 | if (!result && state_p) | |
328 | *state_p = device->power.state; | |
329 | ||
9ce4e607 | 330 | return result; |
202317a5 | 331 | } |
9ce4e607 RW |
332 | |
333 | result = acpi_device_get_power(device, &state); | |
334 | if (result) | |
335 | return result; | |
336 | ||
91bdad0b | 337 | if (state == ACPI_STATE_UNKNOWN) { |
511d5c42 | 338 | state = ACPI_STATE_D0; |
91bdad0b RW |
339 | result = acpi_device_set_power(device, state); |
340 | if (result) | |
341 | return result; | |
342 | } else { | |
343 | if (device->power.flags.power_resources) { | |
344 | /* | |
345 | * We don't need to really switch the state, bu we need | |
346 | * to update the power resources' reference counters. | |
347 | */ | |
348 | result = acpi_power_transition(device, state); | |
349 | if (result) | |
350 | return result; | |
351 | } | |
352 | device->power.state = state; | |
353 | } | |
354 | if (state_p) | |
9ce4e607 RW |
355 | *state_p = state; |
356 | ||
91bdad0b | 357 | return 0; |
9ce4e607 | 358 | } |
2bb3a2bf | 359 | EXPORT_SYMBOL_GPL(acpi_device_update_power); |
202317a5 RW |
360 | |
361 | int acpi_bus_update_power(acpi_handle handle, int *state_p) | |
362 | { | |
363 | struct acpi_device *device; | |
364 | int result; | |
365 | ||
366 | result = acpi_bus_get_device(handle, &device); | |
367 | return result ? result : acpi_device_update_power(device, state_p); | |
368 | } | |
9ce4e607 RW |
369 | EXPORT_SYMBOL_GPL(acpi_bus_update_power); |
370 | ||
371 | bool acpi_bus_power_manageable(acpi_handle handle) | |
372 | { | |
373 | struct acpi_device *device; | |
374 | int result; | |
375 | ||
376 | result = acpi_bus_get_device(handle, &device); | |
377 | return result ? false : device->flags.power_manageable; | |
378 | } | |
379 | EXPORT_SYMBOL(acpi_bus_power_manageable); | |
380 | ||
ec4602a9 RW |
381 | #ifdef CONFIG_PM |
382 | static DEFINE_MUTEX(acpi_pm_notifier_lock); | |
ff165679 | 383 | static DEFINE_MUTEX(acpi_pm_notifier_install_lock); |
ec4602a9 | 384 | |
33e4f80e RW |
385 | void acpi_pm_wakeup_event(struct device *dev) |
386 | { | |
387 | pm_wakeup_dev_event(dev, 0, acpi_s2idle_wakeup()); | |
388 | } | |
389 | EXPORT_SYMBOL_GPL(acpi_pm_wakeup_event); | |
390 | ||
c072530f RW |
391 | static void acpi_pm_notify_handler(acpi_handle handle, u32 val, void *not_used) |
392 | { | |
393 | struct acpi_device *adev; | |
394 | ||
395 | if (val != ACPI_NOTIFY_DEVICE_WAKE) | |
396 | return; | |
397 | ||
020a6375 RW |
398 | acpi_handle_debug(handle, "Wake notify\n"); |
399 | ||
c072530f RW |
400 | adev = acpi_bus_get_acpi_device(handle); |
401 | if (!adev) | |
402 | return; | |
403 | ||
404 | mutex_lock(&acpi_pm_notifier_lock); | |
405 | ||
406 | if (adev->wakeup.flags.notifier_present) { | |
33e4f80e | 407 | pm_wakeup_ws_event(adev->wakeup.ws, 0, acpi_s2idle_wakeup()); |
020a6375 | 408 | if (adev->wakeup.context.func) { |
d75f773c | 409 | acpi_handle_debug(handle, "Running %pS for %s\n", |
020a6375 RW |
410 | adev->wakeup.context.func, |
411 | dev_name(adev->wakeup.context.dev)); | |
64fd1c70 | 412 | adev->wakeup.context.func(&adev->wakeup.context); |
020a6375 | 413 | } |
c072530f RW |
414 | } |
415 | ||
416 | mutex_unlock(&acpi_pm_notifier_lock); | |
417 | ||
418 | acpi_bus_put_acpi_device(adev); | |
419 | } | |
420 | ||
ec4602a9 | 421 | /** |
c072530f RW |
422 | * acpi_add_pm_notifier - Register PM notify handler for given ACPI device. |
423 | * @adev: ACPI device to add the notify handler for. | |
424 | * @dev: Device to generate a wakeup event for while handling the notification. | |
64fd1c70 | 425 | * @func: Work function to execute when handling the notification. |
ec4602a9 RW |
426 | * |
427 | * NOTE: @adev need not be a run-wake or wakeup device to be a valid source of | |
428 | * PM wakeup events. For example, wakeup events may be generated for bridges | |
429 | * if one of the devices below the bridge is signaling wakeup, even if the | |
430 | * bridge itself doesn't have a wakeup GPE associated with it. | |
431 | */ | |
c072530f | 432 | acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, |
64fd1c70 | 433 | void (*func)(struct acpi_device_wakeup_context *context)) |
ec4602a9 RW |
434 | { |
435 | acpi_status status = AE_ALREADY_EXISTS; | |
436 | ||
64fd1c70 | 437 | if (!dev && !func) |
c072530f RW |
438 | return AE_BAD_PARAMETER; |
439 | ||
ff165679 | 440 | mutex_lock(&acpi_pm_notifier_install_lock); |
ec4602a9 RW |
441 | |
442 | if (adev->wakeup.flags.notifier_present) | |
443 | goto out; | |
444 | ||
c072530f RW |
445 | status = acpi_install_notify_handler(adev->handle, ACPI_SYSTEM_NOTIFY, |
446 | acpi_pm_notify_handler, NULL); | |
ec4602a9 RW |
447 | if (ACPI_FAILURE(status)) |
448 | goto out; | |
449 | ||
ff165679 VS |
450 | mutex_lock(&acpi_pm_notifier_lock); |
451 | adev->wakeup.ws = wakeup_source_register(dev_name(&adev->dev)); | |
452 | adev->wakeup.context.dev = dev; | |
453 | adev->wakeup.context.func = func; | |
ec4602a9 | 454 | adev->wakeup.flags.notifier_present = true; |
ff165679 | 455 | mutex_unlock(&acpi_pm_notifier_lock); |
ec4602a9 RW |
456 | |
457 | out: | |
ff165679 | 458 | mutex_unlock(&acpi_pm_notifier_install_lock); |
ec4602a9 RW |
459 | return status; |
460 | } | |
461 | ||
462 | /** | |
463 | * acpi_remove_pm_notifier - Unregister PM notifier from given ACPI device. | |
464 | * @adev: ACPI device to remove the notifier from. | |
465 | */ | |
c072530f | 466 | acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) |
ec4602a9 RW |
467 | { |
468 | acpi_status status = AE_BAD_PARAMETER; | |
469 | ||
ff165679 | 470 | mutex_lock(&acpi_pm_notifier_install_lock); |
ec4602a9 RW |
471 | |
472 | if (!adev->wakeup.flags.notifier_present) | |
473 | goto out; | |
474 | ||
475 | status = acpi_remove_notify_handler(adev->handle, | |
476 | ACPI_SYSTEM_NOTIFY, | |
c072530f | 477 | acpi_pm_notify_handler); |
ec4602a9 RW |
478 | if (ACPI_FAILURE(status)) |
479 | goto out; | |
480 | ||
ff165679 | 481 | mutex_lock(&acpi_pm_notifier_lock); |
64fd1c70 | 482 | adev->wakeup.context.func = NULL; |
c072530f RW |
483 | adev->wakeup.context.dev = NULL; |
484 | wakeup_source_unregister(adev->wakeup.ws); | |
ec4602a9 | 485 | adev->wakeup.flags.notifier_present = false; |
ff165679 | 486 | mutex_unlock(&acpi_pm_notifier_lock); |
ec4602a9 RW |
487 | |
488 | out: | |
ff165679 | 489 | mutex_unlock(&acpi_pm_notifier_install_lock); |
ec4602a9 RW |
490 | return status; |
491 | } | |
492 | ||
9ce4e607 RW |
493 | bool acpi_bus_can_wakeup(acpi_handle handle) |
494 | { | |
495 | struct acpi_device *device; | |
496 | int result; | |
497 | ||
498 | result = acpi_bus_get_device(handle, &device); | |
499 | return result ? false : device->wakeup.flags.valid; | |
500 | } | |
501 | EXPORT_SYMBOL(acpi_bus_can_wakeup); | |
502 | ||
8370c2dc RW |
503 | bool acpi_pm_device_can_wakeup(struct device *dev) |
504 | { | |
505 | struct acpi_device *adev = ACPI_COMPANION(dev); | |
506 | ||
507 | return adev ? acpi_device_can_wakeup(adev) : false; | |
508 | } | |
509 | ||
86b3832c | 510 | /** |
b25c77ef | 511 | * acpi_dev_pm_get_state - Get preferred power state of ACPI device. |
86b3832c RW |
512 | * @dev: Device whose preferred target power state to return. |
513 | * @adev: ACPI device node corresponding to @dev. | |
514 | * @target_state: System state to match the resultant device state. | |
fa1675b5 RW |
515 | * @d_min_p: Location to store the highest power state available to the device. |
516 | * @d_max_p: Location to store the lowest power state available to the device. | |
86b3832c | 517 | * |
fa1675b5 RW |
518 | * Find the lowest power (highest number) and highest power (lowest number) ACPI |
519 | * device power states that the device can be in while the system is in the | |
520 | * state represented by @target_state. Store the integer numbers representing | |
521 | * those stats in the memory locations pointed to by @d_max_p and @d_min_p, | |
522 | * respectively. | |
86b3832c RW |
523 | * |
524 | * Callers must ensure that @dev and @adev are valid pointers and that @adev | |
525 | * actually corresponds to @dev before using this function. | |
fa1675b5 RW |
526 | * |
527 | * Returns 0 on success or -ENODATA when one of the ACPI methods fails or | |
528 | * returns a value that doesn't make sense. The memory locations pointed to by | |
529 | * @d_max_p and @d_min_p are only modified on success. | |
86b3832c | 530 | */ |
b25c77ef | 531 | static int acpi_dev_pm_get_state(struct device *dev, struct acpi_device *adev, |
fa1675b5 | 532 | u32 target_state, int *d_min_p, int *d_max_p) |
86b3832c | 533 | { |
fa1675b5 RW |
534 | char method[] = { '_', 'S', '0' + target_state, 'D', '\0' }; |
535 | acpi_handle handle = adev->handle; | |
536 | unsigned long long ret; | |
537 | int d_min, d_max; | |
86b3832c | 538 | bool wakeup = false; |
bf8c6184 | 539 | bool has_sxd = false; |
fa1675b5 | 540 | acpi_status status; |
86b3832c | 541 | |
86b3832c | 542 | /* |
fa1675b5 RW |
543 | * If the system state is S0, the lowest power state the device can be |
544 | * in is D3cold, unless the device has _S0W and is supposed to signal | |
545 | * wakeup, in which case the return value of _S0W has to be used as the | |
546 | * lowest power state available to the device. | |
86b3832c RW |
547 | */ |
548 | d_min = ACPI_STATE_D0; | |
4c164ae7 | 549 | d_max = ACPI_STATE_D3_COLD; |
86b3832c RW |
550 | |
551 | /* | |
552 | * If present, _SxD methods return the minimum D-state (highest power | |
553 | * state) we can use for the corresponding S-states. Otherwise, the | |
554 | * minimum D-state is D0 (ACPI 3.x). | |
86b3832c RW |
555 | */ |
556 | if (target_state > ACPI_STATE_S0) { | |
fa1675b5 RW |
557 | /* |
558 | * We rely on acpi_evaluate_integer() not clobbering the integer | |
559 | * provided if AE_NOT_FOUND is returned. | |
560 | */ | |
561 | ret = d_min; | |
562 | status = acpi_evaluate_integer(handle, method, NULL, &ret); | |
563 | if ((ACPI_FAILURE(status) && status != AE_NOT_FOUND) | |
564 | || ret > ACPI_STATE_D3_COLD) | |
565 | return -ENODATA; | |
566 | ||
567 | /* | |
568 | * We need to handle legacy systems where D3hot and D3cold are | |
569 | * the same and 3 is returned in both cases, so fall back to | |
570 | * D3cold if D3hot is not a valid state. | |
571 | */ | |
572 | if (!adev->power.states[ret].flags.valid) { | |
573 | if (ret == ACPI_STATE_D3_HOT) | |
574 | ret = ACPI_STATE_D3_COLD; | |
575 | else | |
576 | return -ENODATA; | |
577 | } | |
bf8c6184 DD |
578 | |
579 | if (status == AE_OK) | |
580 | has_sxd = true; | |
581 | ||
fa1675b5 | 582 | d_min = ret; |
86b3832c RW |
583 | wakeup = device_may_wakeup(dev) && adev->wakeup.flags.valid |
584 | && adev->wakeup.sleep_state >= target_state; | |
20f97caf | 585 | } else { |
86b3832c RW |
586 | wakeup = adev->wakeup.flags.valid; |
587 | } | |
588 | ||
589 | /* | |
590 | * If _PRW says we can wake up the system from the target sleep state, | |
591 | * the D-state returned by _SxD is sufficient for that (we assume a | |
592 | * wakeup-aware driver if wake is set). Still, if _SxW exists | |
593 | * (ACPI 3.x), it should return the maximum (lowest power) D-state that | |
594 | * can wake the system. _S0W may be valid, too. | |
595 | */ | |
596 | if (wakeup) { | |
fa1675b5 RW |
597 | method[3] = 'W'; |
598 | status = acpi_evaluate_integer(handle, method, NULL, &ret); | |
599 | if (status == AE_NOT_FOUND) { | |
bf8c6184 DD |
600 | /* No _SxW. In this case, the ACPI spec says that we |
601 | * must not go into any power state deeper than the | |
602 | * value returned from _SxD. | |
603 | */ | |
604 | if (has_sxd && target_state > ACPI_STATE_S0) | |
86b3832c | 605 | d_max = d_min; |
fa1675b5 RW |
606 | } else if (ACPI_SUCCESS(status) && ret <= ACPI_STATE_D3_COLD) { |
607 | /* Fall back to D3cold if ret is not a valid state. */ | |
608 | if (!adev->power.states[ret].flags.valid) | |
609 | ret = ACPI_STATE_D3_COLD; | |
610 | ||
611 | d_max = ret > d_min ? ret : d_min; | |
612 | } else { | |
613 | return -ENODATA; | |
86b3832c RW |
614 | } |
615 | } | |
616 | ||
86b3832c RW |
617 | if (d_min_p) |
618 | *d_min_p = d_min; | |
fa1675b5 RW |
619 | |
620 | if (d_max_p) | |
621 | *d_max_p = d_max; | |
622 | ||
623 | return 0; | |
86b3832c | 624 | } |
cd7bd02d | 625 | |
a6ae7594 RW |
626 | /** |
627 | * acpi_pm_device_sleep_state - Get preferred power state of ACPI device. | |
628 | * @dev: Device whose preferred target power state to return. | |
629 | * @d_min_p: Location to store the upper limit of the allowed states range. | |
630 | * @d_max_in: Deepest low-power state to take into consideration. | |
631 | * Return value: Preferred power state of the device on success, -ENODEV | |
fa1675b5 RW |
632 | * if there's no 'struct acpi_device' for @dev, -EINVAL if @d_max_in is |
633 | * incorrect, or -ENODATA on ACPI method failure. | |
a6ae7594 RW |
634 | * |
635 | * The caller must ensure that @dev is valid before using this function. | |
636 | */ | |
637 | int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p, int d_max_in) | |
638 | { | |
a6ae7594 | 639 | struct acpi_device *adev; |
9b5c7a5a | 640 | int ret, d_min, d_max; |
fa1675b5 RW |
641 | |
642 | if (d_max_in < ACPI_STATE_D0 || d_max_in > ACPI_STATE_D3_COLD) | |
643 | return -EINVAL; | |
644 | ||
20dacb71 | 645 | if (d_max_in > ACPI_STATE_D2) { |
fa1675b5 RW |
646 | enum pm_qos_flags_status stat; |
647 | ||
648 | stat = dev_pm_qos_flags(dev, PM_QOS_FLAG_NO_POWER_OFF); | |
649 | if (stat == PM_QOS_FLAGS_ALL) | |
20dacb71 | 650 | d_max_in = ACPI_STATE_D2; |
fa1675b5 | 651 | } |
a6ae7594 | 652 | |
17653a3e RW |
653 | adev = ACPI_COMPANION(dev); |
654 | if (!adev) { | |
655 | dev_dbg(dev, "ACPI companion missing in %s!\n", __func__); | |
a6ae7594 RW |
656 | return -ENODEV; |
657 | } | |
658 | ||
fa1675b5 | 659 | ret = acpi_dev_pm_get_state(dev, adev, acpi_target_system_state(), |
9b5c7a5a | 660 | &d_min, &d_max); |
fa1675b5 RW |
661 | if (ret) |
662 | return ret; | |
663 | ||
9b5c7a5a | 664 | if (d_max_in < d_min) |
fa1675b5 RW |
665 | return -EINVAL; |
666 | ||
667 | if (d_max > d_max_in) { | |
9b5c7a5a | 668 | for (d_max = d_max_in; d_max > d_min; d_max--) { |
fa1675b5 RW |
669 | if (adev->power.states[d_max].flags.valid) |
670 | break; | |
671 | } | |
672 | } | |
9b5c7a5a RW |
673 | |
674 | if (d_min_p) | |
675 | *d_min_p = d_min; | |
676 | ||
fa1675b5 | 677 | return d_max; |
a6ae7594 RW |
678 | } |
679 | EXPORT_SYMBOL(acpi_pm_device_sleep_state); | |
680 | ||
e5cc8ef3 | 681 | /** |
c072530f | 682 | * acpi_pm_notify_work_func - ACPI devices wakeup notification work function. |
64fd1c70 | 683 | * @context: Device wakeup context. |
e5cc8ef3 | 684 | */ |
64fd1c70 | 685 | static void acpi_pm_notify_work_func(struct acpi_device_wakeup_context *context) |
e5cc8ef3 | 686 | { |
64fd1c70 | 687 | struct device *dev = context->dev; |
e5cc8ef3 | 688 | |
c072530f | 689 | if (dev) { |
e5cc8ef3 | 690 | pm_wakeup_event(dev, 0); |
64fd1c70 | 691 | pm_request_resume(dev); |
e5cc8ef3 RW |
692 | } |
693 | } | |
694 | ||
99d8845e RW |
695 | static DEFINE_MUTEX(acpi_wakeup_lock); |
696 | ||
1ba51a7c RW |
697 | static int __acpi_device_wakeup_enable(struct acpi_device *adev, |
698 | u32 target_state, int max_count) | |
dee8370c RW |
699 | { |
700 | struct acpi_device_wakeup *wakeup = &adev->wakeup; | |
99d8845e RW |
701 | acpi_status status; |
702 | int error = 0; | |
dee8370c | 703 | |
99d8845e | 704 | mutex_lock(&acpi_wakeup_lock); |
dee8370c | 705 | |
1ba51a7c | 706 | if (wakeup->enable_count >= max_count) |
99d8845e | 707 | goto out; |
235d81a6 | 708 | |
1ba51a7c RW |
709 | if (wakeup->enable_count > 0) |
710 | goto inc; | |
711 | ||
99d8845e RW |
712 | error = acpi_enable_wakeup_device_power(adev, target_state); |
713 | if (error) | |
714 | goto out; | |
dee8370c | 715 | |
99d8845e RW |
716 | status = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number); |
717 | if (ACPI_FAILURE(status)) { | |
dee8370c | 718 | acpi_disable_wakeup_device_power(adev); |
99d8845e RW |
719 | error = -EIO; |
720 | goto out; | |
dee8370c | 721 | } |
99d8845e | 722 | |
fbc9418f RW |
723 | acpi_handle_debug(adev->handle, "GPE%2X enabled for wakeup\n", |
724 | (unsigned int)wakeup->gpe_number); | |
725 | ||
1ba51a7c | 726 | inc: |
99d8845e RW |
727 | wakeup->enable_count++; |
728 | ||
729 | out: | |
730 | mutex_unlock(&acpi_wakeup_lock); | |
731 | return error; | |
732 | } | |
733 | ||
1ba51a7c RW |
734 | /** |
735 | * acpi_device_wakeup_enable - Enable wakeup functionality for device. | |
736 | * @adev: ACPI device to enable wakeup functionality for. | |
737 | * @target_state: State the system is transitioning into. | |
738 | * | |
739 | * Enable the GPE associated with @adev so that it can generate wakeup signals | |
740 | * for the device in response to external (remote) events and enable wakeup | |
741 | * power for it. | |
742 | * | |
743 | * Callers must ensure that @adev is a valid ACPI device node before executing | |
744 | * this function. | |
745 | */ | |
746 | static int acpi_device_wakeup_enable(struct acpi_device *adev, u32 target_state) | |
747 | { | |
748 | return __acpi_device_wakeup_enable(adev, target_state, 1); | |
749 | } | |
750 | ||
99d8845e RW |
751 | /** |
752 | * acpi_device_wakeup_disable - Disable wakeup functionality for device. | |
753 | * @adev: ACPI device to disable wakeup functionality for. | |
754 | * | |
755 | * Disable the GPE associated with @adev and disable wakeup power for it. | |
756 | * | |
757 | * Callers must ensure that @adev is a valid ACPI device node before executing | |
758 | * this function. | |
759 | */ | |
760 | static void acpi_device_wakeup_disable(struct acpi_device *adev) | |
761 | { | |
762 | struct acpi_device_wakeup *wakeup = &adev->wakeup; | |
763 | ||
764 | mutex_lock(&acpi_wakeup_lock); | |
765 | ||
766 | if (!wakeup->enable_count) | |
767 | goto out; | |
768 | ||
769 | acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number); | |
770 | acpi_disable_wakeup_device_power(adev); | |
771 | ||
772 | wakeup->enable_count--; | |
773 | ||
774 | out: | |
775 | mutex_unlock(&acpi_wakeup_lock); | |
dee8370c RW |
776 | } |
777 | ||
1ba51a7c RW |
778 | static int __acpi_pm_set_device_wakeup(struct device *dev, bool enable, |
779 | int max_count) | |
a6ae7594 | 780 | { |
a6ae7594 RW |
781 | struct acpi_device *adev; |
782 | int error; | |
783 | ||
17653a3e RW |
784 | adev = ACPI_COMPANION(dev); |
785 | if (!adev) { | |
786 | dev_dbg(dev, "ACPI companion missing in %s!\n", __func__); | |
a6ae7594 RW |
787 | return -ENODEV; |
788 | } | |
789 | ||
4d183d04 RW |
790 | if (!acpi_device_can_wakeup(adev)) |
791 | return -EINVAL; | |
792 | ||
99d8845e RW |
793 | if (!enable) { |
794 | acpi_device_wakeup_disable(adev); | |
795 | dev_dbg(dev, "Wakeup disabled by ACPI\n"); | |
796 | return 0; | |
797 | } | |
798 | ||
1ba51a7c RW |
799 | error = __acpi_device_wakeup_enable(adev, acpi_target_system_state(), |
800 | max_count); | |
a6ae7594 | 801 | if (!error) |
99d8845e | 802 | dev_dbg(dev, "Wakeup enabled by ACPI\n"); |
a6ae7594 RW |
803 | |
804 | return error; | |
805 | } | |
1ba51a7c RW |
806 | |
807 | /** | |
808 | * acpi_pm_set_device_wakeup - Enable/disable remote wakeup for given device. | |
809 | * @dev: Device to enable/disable to generate wakeup events. | |
810 | * @enable: Whether to enable or disable the wakeup functionality. | |
811 | */ | |
812 | int acpi_pm_set_device_wakeup(struct device *dev, bool enable) | |
813 | { | |
814 | return __acpi_pm_set_device_wakeup(dev, enable, 1); | |
815 | } | |
816 | EXPORT_SYMBOL_GPL(acpi_pm_set_device_wakeup); | |
817 | ||
818 | /** | |
819 | * acpi_pm_set_bridge_wakeup - Enable/disable remote wakeup for given bridge. | |
820 | * @dev: Bridge device to enable/disable to generate wakeup events. | |
821 | * @enable: Whether to enable or disable the wakeup functionality. | |
822 | */ | |
823 | int acpi_pm_set_bridge_wakeup(struct device *dev, bool enable) | |
824 | { | |
825 | return __acpi_pm_set_device_wakeup(dev, enable, INT_MAX); | |
826 | } | |
827 | EXPORT_SYMBOL_GPL(acpi_pm_set_bridge_wakeup); | |
e5cc8ef3 | 828 | |
e5cc8ef3 RW |
829 | /** |
830 | * acpi_dev_pm_low_power - Put ACPI device into a low-power state. | |
831 | * @dev: Device to put into a low-power state. | |
832 | * @adev: ACPI device node corresponding to @dev. | |
833 | * @system_state: System state to choose the device state for. | |
834 | */ | |
835 | static int acpi_dev_pm_low_power(struct device *dev, struct acpi_device *adev, | |
836 | u32 system_state) | |
837 | { | |
fa1675b5 | 838 | int ret, state; |
e5cc8ef3 RW |
839 | |
840 | if (!acpi_device_power_manageable(adev)) | |
841 | return 0; | |
842 | ||
fa1675b5 RW |
843 | ret = acpi_dev_pm_get_state(dev, adev, system_state, NULL, &state); |
844 | return ret ? ret : acpi_device_set_power(adev, state); | |
e5cc8ef3 RW |
845 | } |
846 | ||
847 | /** | |
848 | * acpi_dev_pm_full_power - Put ACPI device into the full-power state. | |
849 | * @adev: ACPI device node to put into the full-power state. | |
850 | */ | |
851 | static int acpi_dev_pm_full_power(struct acpi_device *adev) | |
852 | { | |
853 | return acpi_device_power_manageable(adev) ? | |
854 | acpi_device_set_power(adev, ACPI_STATE_D0) : 0; | |
855 | } | |
856 | ||
e5cc8ef3 | 857 | /** |
cbe25ce3 | 858 | * acpi_dev_suspend - Put device into a low-power state using ACPI. |
e5cc8ef3 | 859 | * @dev: Device to put into a low-power state. |
cbe25ce3 | 860 | * @wakeup: Whether or not to enable wakeup for the device. |
e5cc8ef3 | 861 | * |
cbe25ce3 | 862 | * Put the given device into a low-power state using the standard ACPI |
e5cc8ef3 RW |
863 | * mechanism. Set up remote wakeup if desired, choose the state to put the |
864 | * device into (this checks if remote wakeup is expected to work too), and set | |
865 | * the power state of the device. | |
866 | */ | |
cbe25ce3 | 867 | int acpi_dev_suspend(struct device *dev, bool wakeup) |
e5cc8ef3 | 868 | { |
79c0373f | 869 | struct acpi_device *adev = ACPI_COMPANION(dev); |
cbe25ce3 | 870 | u32 target_state = acpi_target_system_state(); |
e5cc8ef3 RW |
871 | int error; |
872 | ||
873 | if (!adev) | |
874 | return 0; | |
875 | ||
cbe25ce3 RW |
876 | if (wakeup && acpi_device_can_wakeup(adev)) { |
877 | error = acpi_device_wakeup_enable(adev, target_state); | |
99d8845e RW |
878 | if (error) |
879 | return -EAGAIN; | |
cbe25ce3 RW |
880 | } else { |
881 | wakeup = false; | |
99d8845e | 882 | } |
e5cc8ef3 | 883 | |
cbe25ce3 RW |
884 | error = acpi_dev_pm_low_power(dev, adev, target_state); |
885 | if (error && wakeup) | |
99d8845e | 886 | acpi_device_wakeup_disable(adev); |
e5cc8ef3 RW |
887 | |
888 | return error; | |
889 | } | |
cbe25ce3 | 890 | EXPORT_SYMBOL_GPL(acpi_dev_suspend); |
e5cc8ef3 RW |
891 | |
892 | /** | |
63705c40 | 893 | * acpi_dev_resume - Put device into the full-power state using ACPI. |
e5cc8ef3 RW |
894 | * @dev: Device to put into the full-power state. |
895 | * | |
896 | * Put the given device into the full-power state using the standard ACPI | |
63705c40 | 897 | * mechanism. Set the power state of the device to ACPI D0 and disable wakeup. |
e5cc8ef3 | 898 | */ |
63705c40 | 899 | int acpi_dev_resume(struct device *dev) |
e5cc8ef3 | 900 | { |
79c0373f | 901 | struct acpi_device *adev = ACPI_COMPANION(dev); |
e5cc8ef3 RW |
902 | int error; |
903 | ||
904 | if (!adev) | |
905 | return 0; | |
906 | ||
907 | error = acpi_dev_pm_full_power(adev); | |
99d8845e | 908 | acpi_device_wakeup_disable(adev); |
e5cc8ef3 RW |
909 | return error; |
910 | } | |
63705c40 | 911 | EXPORT_SYMBOL_GPL(acpi_dev_resume); |
e5cc8ef3 RW |
912 | |
913 | /** | |
914 | * acpi_subsys_runtime_suspend - Suspend device using ACPI. | |
915 | * @dev: Device to suspend. | |
916 | * | |
917 | * Carry out the generic runtime suspend procedure for @dev and use ACPI to put | |
918 | * it into a runtime low-power state. | |
919 | */ | |
920 | int acpi_subsys_runtime_suspend(struct device *dev) | |
921 | { | |
922 | int ret = pm_generic_runtime_suspend(dev); | |
cbe25ce3 | 923 | return ret ? ret : acpi_dev_suspend(dev, true); |
e5cc8ef3 RW |
924 | } |
925 | EXPORT_SYMBOL_GPL(acpi_subsys_runtime_suspend); | |
926 | ||
927 | /** | |
928 | * acpi_subsys_runtime_resume - Resume device using ACPI. | |
929 | * @dev: Device to Resume. | |
930 | * | |
931 | * Use ACPI to put the given device into the full-power state and carry out the | |
932 | * generic runtime resume procedure for it. | |
933 | */ | |
934 | int acpi_subsys_runtime_resume(struct device *dev) | |
935 | { | |
63705c40 | 936 | int ret = acpi_dev_resume(dev); |
e5cc8ef3 RW |
937 | return ret ? ret : pm_generic_runtime_resume(dev); |
938 | } | |
939 | EXPORT_SYMBOL_GPL(acpi_subsys_runtime_resume); | |
e5cc8ef3 RW |
940 | |
941 | #ifdef CONFIG_PM_SLEEP | |
c2ebf788 UH |
942 | static bool acpi_dev_needs_resume(struct device *dev, struct acpi_device *adev) |
943 | { | |
944 | u32 sys_target = acpi_target_system_state(); | |
945 | int ret, state; | |
946 | ||
9a51c6b1 RW |
947 | if (!pm_runtime_suspended(dev) || !adev || (adev->wakeup.flags.valid && |
948 | device_may_wakeup(dev) != !!adev->wakeup.prepare_count)) | |
c2ebf788 UH |
949 | return true; |
950 | ||
951 | if (sys_target == ACPI_STATE_S0) | |
952 | return false; | |
953 | ||
954 | if (adev->power.flags.dsw_present) | |
955 | return true; | |
956 | ||
957 | ret = acpi_dev_pm_get_state(dev, adev, sys_target, NULL, &state); | |
958 | if (ret) | |
959 | return true; | |
960 | ||
961 | return state != adev->power.state; | |
962 | } | |
963 | ||
e5cc8ef3 RW |
964 | /** |
965 | * acpi_subsys_prepare - Prepare device for system transition to a sleep state. | |
966 | * @dev: Device to prepare. | |
967 | */ | |
968 | int acpi_subsys_prepare(struct device *dev) | |
969 | { | |
f25c0ae2 | 970 | struct acpi_device *adev = ACPI_COMPANION(dev); |
f25c0ae2 | 971 | |
08810a41 RW |
972 | if (dev->driver && dev->driver->pm && dev->driver->pm->prepare) { |
973 | int ret = dev->driver->pm->prepare(dev); | |
f25c0ae2 | 974 | |
08810a41 RW |
975 | if (ret < 0) |
976 | return ret; | |
977 | ||
978 | if (!ret && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE)) | |
979 | return 0; | |
980 | } | |
f25c0ae2 | 981 | |
c2ebf788 | 982 | return !acpi_dev_needs_resume(dev, adev); |
e5cc8ef3 RW |
983 | } |
984 | EXPORT_SYMBOL_GPL(acpi_subsys_prepare); | |
985 | ||
e4da817d UH |
986 | /** |
987 | * acpi_subsys_complete - Finalize device's resume during system resume. | |
988 | * @dev: Device to handle. | |
989 | */ | |
990 | void acpi_subsys_complete(struct device *dev) | |
991 | { | |
992 | pm_generic_complete(dev); | |
993 | /* | |
994 | * If the device had been runtime-suspended before the system went into | |
995 | * the sleep state it is going out of and it has never been resumed till | |
996 | * now, resume it in case the firmware powered it up. | |
997 | */ | |
db68daff | 998 | if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) |
e4da817d UH |
999 | pm_request_resume(dev); |
1000 | } | |
1001 | EXPORT_SYMBOL_GPL(acpi_subsys_complete); | |
1002 | ||
92858c47 RW |
1003 | /** |
1004 | * acpi_subsys_suspend - Run the device driver's suspend callback. | |
1005 | * @dev: Device to handle. | |
1006 | * | |
05087360 RW |
1007 | * Follow PCI and resume devices from runtime suspend before running their |
1008 | * system suspend callbacks, unless the driver can cope with runtime-suspended | |
1009 | * devices during system suspend and there are no ACPI-specific reasons for | |
1010 | * resuming them. | |
92858c47 RW |
1011 | */ |
1012 | int acpi_subsys_suspend(struct device *dev) | |
1013 | { | |
05087360 RW |
1014 | if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) || |
1015 | acpi_dev_needs_resume(dev, ACPI_COMPANION(dev))) | |
1016 | pm_runtime_resume(dev); | |
1017 | ||
92858c47 RW |
1018 | return pm_generic_suspend(dev); |
1019 | } | |
4cf563c5 | 1020 | EXPORT_SYMBOL_GPL(acpi_subsys_suspend); |
92858c47 | 1021 | |
e5cc8ef3 RW |
1022 | /** |
1023 | * acpi_subsys_suspend_late - Suspend device using ACPI. | |
1024 | * @dev: Device to suspend. | |
1025 | * | |
1026 | * Carry out the generic late suspend procedure for @dev and use ACPI to put | |
1027 | * it into a low-power state during system transition into a sleep state. | |
1028 | */ | |
1029 | int acpi_subsys_suspend_late(struct device *dev) | |
1030 | { | |
05087360 RW |
1031 | int ret; |
1032 | ||
1033 | if (dev_pm_smart_suspend_and_suspended(dev)) | |
1034 | return 0; | |
1035 | ||
1036 | ret = pm_generic_suspend_late(dev); | |
cbe25ce3 | 1037 | return ret ? ret : acpi_dev_suspend(dev, device_may_wakeup(dev)); |
e5cc8ef3 RW |
1038 | } |
1039 | EXPORT_SYMBOL_GPL(acpi_subsys_suspend_late); | |
1040 | ||
05087360 RW |
1041 | /** |
1042 | * acpi_subsys_suspend_noirq - Run the device driver's "noirq" suspend callback. | |
1043 | * @dev: Device to suspend. | |
1044 | */ | |
1045 | int acpi_subsys_suspend_noirq(struct device *dev) | |
1046 | { | |
db68daff RW |
1047 | int ret; |
1048 | ||
1049 | if (dev_pm_smart_suspend_and_suspended(dev)) { | |
1050 | dev->power.may_skip_resume = true; | |
05087360 | 1051 | return 0; |
db68daff RW |
1052 | } |
1053 | ||
1054 | ret = pm_generic_suspend_noirq(dev); | |
1055 | if (ret) | |
1056 | return ret; | |
05087360 | 1057 | |
db68daff RW |
1058 | /* |
1059 | * If the target system sleep state is suspend-to-idle, it is sufficient | |
1060 | * to check whether or not the device's wakeup settings are good for | |
1061 | * runtime PM. Otherwise, the pm_resume_via_firmware() check will cause | |
1062 | * acpi_subsys_complete() to take care of fixing up the device's state | |
1063 | * anyway, if need be. | |
1064 | */ | |
1065 | dev->power.may_skip_resume = device_may_wakeup(dev) || | |
1066 | !device_can_wakeup(dev); | |
1067 | ||
1068 | return 0; | |
05087360 RW |
1069 | } |
1070 | EXPORT_SYMBOL_GPL(acpi_subsys_suspend_noirq); | |
1071 | ||
1072 | /** | |
1073 | * acpi_subsys_resume_noirq - Run the device driver's "noirq" resume callback. | |
1074 | * @dev: Device to handle. | |
1075 | */ | |
3cd7957e | 1076 | static int acpi_subsys_resume_noirq(struct device *dev) |
05087360 | 1077 | { |
db68daff RW |
1078 | if (dev_pm_may_skip_resume(dev)) |
1079 | return 0; | |
1080 | ||
05087360 RW |
1081 | /* |
1082 | * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend | |
1083 | * during system suspend, so update their runtime PM status to "active" | |
1084 | * as they will be put into D0 going forward. | |
1085 | */ | |
1086 | if (dev_pm_smart_suspend_and_suspended(dev)) | |
1087 | pm_runtime_set_active(dev); | |
1088 | ||
1089 | return pm_generic_resume_noirq(dev); | |
1090 | } | |
05087360 | 1091 | |
e5cc8ef3 RW |
1092 | /** |
1093 | * acpi_subsys_resume_early - Resume device using ACPI. | |
1094 | * @dev: Device to Resume. | |
1095 | * | |
1096 | * Use ACPI to put the given device into the full-power state and carry out the | |
1097 | * generic early resume procedure for it during system transition into the | |
1098 | * working state. | |
1099 | */ | |
3cd7957e | 1100 | static int acpi_subsys_resume_early(struct device *dev) |
e5cc8ef3 | 1101 | { |
63705c40 | 1102 | int ret = acpi_dev_resume(dev); |
e5cc8ef3 RW |
1103 | return ret ? ret : pm_generic_resume_early(dev); |
1104 | } | |
92858c47 RW |
1105 | |
1106 | /** | |
1107 | * acpi_subsys_freeze - Run the device driver's freeze callback. | |
1108 | * @dev: Device to handle. | |
1109 | */ | |
1110 | int acpi_subsys_freeze(struct device *dev) | |
1111 | { | |
1112 | /* | |
501debd4 RW |
1113 | * Resume all runtime-suspended devices before creating a snapshot |
1114 | * image of system memory, because the restore kernel generally cannot | |
1115 | * be expected to always handle them consistently and they need to be | |
1116 | * put into the runtime-active metastate during system resume anyway, | |
1117 | * so it is better to ensure that the state saved in the image will be | |
1118 | * always consistent with that. | |
92858c47 | 1119 | */ |
501debd4 | 1120 | pm_runtime_resume(dev); |
05087360 | 1121 | |
92858c47 RW |
1122 | return pm_generic_freeze(dev); |
1123 | } | |
4cf563c5 | 1124 | EXPORT_SYMBOL_GPL(acpi_subsys_freeze); |
92858c47 | 1125 | |
05087360 | 1126 | /** |
3cd7957e RW |
1127 | * acpi_subsys_restore_early - Restore device using ACPI. |
1128 | * @dev: Device to restore. | |
05087360 | 1129 | */ |
3cd7957e | 1130 | int acpi_subsys_restore_early(struct device *dev) |
05087360 | 1131 | { |
3cd7957e RW |
1132 | int ret = acpi_dev_resume(dev); |
1133 | return ret ? ret : pm_generic_restore_early(dev); | |
05087360 | 1134 | } |
3cd7957e | 1135 | EXPORT_SYMBOL_GPL(acpi_subsys_restore_early); |
c95b7595 RW |
1136 | |
1137 | /** | |
1138 | * acpi_subsys_poweroff - Run the device driver's poweroff callback. | |
1139 | * @dev: Device to handle. | |
1140 | * | |
1141 | * Follow PCI and resume devices from runtime suspend before running their | |
1142 | * system poweroff callbacks, unless the driver can cope with runtime-suspended | |
1143 | * devices during system suspend and there are no ACPI-specific reasons for | |
1144 | * resuming them. | |
1145 | */ | |
1146 | int acpi_subsys_poweroff(struct device *dev) | |
1147 | { | |
1148 | if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) || | |
1149 | acpi_dev_needs_resume(dev, ACPI_COMPANION(dev))) | |
1150 | pm_runtime_resume(dev); | |
1151 | ||
1152 | return pm_generic_poweroff(dev); | |
1153 | } | |
1154 | EXPORT_SYMBOL_GPL(acpi_subsys_poweroff); | |
1155 | ||
1156 | /** | |
1157 | * acpi_subsys_poweroff_late - Run the device driver's poweroff callback. | |
1158 | * @dev: Device to handle. | |
1159 | * | |
1160 | * Carry out the generic late poweroff procedure for @dev and use ACPI to put | |
1161 | * it into a low-power state during system transition into a sleep state. | |
1162 | */ | |
1163 | static int acpi_subsys_poweroff_late(struct device *dev) | |
1164 | { | |
1165 | int ret; | |
1166 | ||
1167 | if (dev_pm_smart_suspend_and_suspended(dev)) | |
1168 | return 0; | |
1169 | ||
1170 | ret = pm_generic_poweroff_late(dev); | |
1171 | if (ret) | |
1172 | return ret; | |
1173 | ||
1174 | return acpi_dev_suspend(dev, device_may_wakeup(dev)); | |
1175 | } | |
1176 | ||
1177 | /** | |
1178 | * acpi_subsys_poweroff_noirq - Run the driver's "noirq" poweroff callback. | |
1179 | * @dev: Device to suspend. | |
1180 | */ | |
1181 | static int acpi_subsys_poweroff_noirq(struct device *dev) | |
1182 | { | |
1183 | if (dev_pm_smart_suspend_and_suspended(dev)) | |
1184 | return 0; | |
1185 | ||
1186 | return pm_generic_poweroff_noirq(dev); | |
1187 | } | |
e5cc8ef3 RW |
1188 | #endif /* CONFIG_PM_SLEEP */ |
1189 | ||
1190 | static struct dev_pm_domain acpi_general_pm_domain = { | |
1191 | .ops = { | |
e5cc8ef3 RW |
1192 | .runtime_suspend = acpi_subsys_runtime_suspend, |
1193 | .runtime_resume = acpi_subsys_runtime_resume, | |
e5cc8ef3 RW |
1194 | #ifdef CONFIG_PM_SLEEP |
1195 | .prepare = acpi_subsys_prepare, | |
e4da817d | 1196 | .complete = acpi_subsys_complete, |
92858c47 | 1197 | .suspend = acpi_subsys_suspend, |
e5cc8ef3 | 1198 | .suspend_late = acpi_subsys_suspend_late, |
05087360 RW |
1199 | .suspend_noirq = acpi_subsys_suspend_noirq, |
1200 | .resume_noirq = acpi_subsys_resume_noirq, | |
e5cc8ef3 | 1201 | .resume_early = acpi_subsys_resume_early, |
92858c47 | 1202 | .freeze = acpi_subsys_freeze, |
c95b7595 RW |
1203 | .poweroff = acpi_subsys_poweroff, |
1204 | .poweroff_late = acpi_subsys_poweroff_late, | |
1205 | .poweroff_noirq = acpi_subsys_poweroff_noirq, | |
3cd7957e | 1206 | .restore_early = acpi_subsys_restore_early, |
e5cc8ef3 RW |
1207 | #endif |
1208 | }, | |
1209 | }; | |
1210 | ||
91d66cd2 UH |
1211 | /** |
1212 | * acpi_dev_pm_detach - Remove ACPI power management from the device. | |
1213 | * @dev: Device to take care of. | |
1214 | * @power_off: Whether or not to try to remove power from the device. | |
1215 | * | |
1216 | * Remove the device from the general ACPI PM domain and remove its wakeup | |
1217 | * notifier. If @power_off is set, additionally remove power from the device if | |
1218 | * possible. | |
1219 | * | |
1220 | * Callers must ensure proper synchronization of this function with power | |
1221 | * management callbacks. | |
1222 | */ | |
1223 | static void acpi_dev_pm_detach(struct device *dev, bool power_off) | |
1224 | { | |
1225 | struct acpi_device *adev = ACPI_COMPANION(dev); | |
1226 | ||
1227 | if (adev && dev->pm_domain == &acpi_general_pm_domain) { | |
989561de | 1228 | dev_pm_domain_set(dev, NULL); |
91d66cd2 UH |
1229 | acpi_remove_pm_notifier(adev); |
1230 | if (power_off) { | |
1231 | /* | |
1232 | * If the device's PM QoS resume latency limit or flags | |
1233 | * have been exposed to user space, they have to be | |
1234 | * hidden at this point, so that they don't affect the | |
1235 | * choice of the low-power state to put the device into. | |
1236 | */ | |
1237 | dev_pm_qos_hide_latency_limit(dev); | |
1238 | dev_pm_qos_hide_flags(dev); | |
99d8845e | 1239 | acpi_device_wakeup_disable(adev); |
91d66cd2 UH |
1240 | acpi_dev_pm_low_power(dev, adev, ACPI_STATE_S0); |
1241 | } | |
1242 | } | |
1243 | } | |
1244 | ||
e5cc8ef3 RW |
1245 | /** |
1246 | * acpi_dev_pm_attach - Prepare device for ACPI power management. | |
1247 | * @dev: Device to prepare. | |
b88ce2a4 | 1248 | * @power_on: Whether or not to power on the device. |
e5cc8ef3 RW |
1249 | * |
1250 | * If @dev has a valid ACPI handle that has a valid struct acpi_device object | |
1251 | * attached to it, install a wakeup notification handler for the device and | |
b88ce2a4 RW |
1252 | * add it to the general ACPI PM domain. If @power_on is set, the device will |
1253 | * be put into the ACPI D0 state before the function returns. | |
e5cc8ef3 RW |
1254 | * |
1255 | * This assumes that the @dev's bus type uses generic power management callbacks | |
1256 | * (or doesn't use any power management callbacks at all). | |
1257 | * | |
1258 | * Callers must ensure proper synchronization of this function with power | |
1259 | * management callbacks. | |
1260 | */ | |
b88ce2a4 | 1261 | int acpi_dev_pm_attach(struct device *dev, bool power_on) |
e5cc8ef3 | 1262 | { |
79c0373f | 1263 | struct acpi_device *adev = ACPI_COMPANION(dev); |
e5cc8ef3 RW |
1264 | |
1265 | if (!adev) | |
919b7308 | 1266 | return 0; |
e5cc8ef3 | 1267 | |
712e960f MW |
1268 | /* |
1269 | * Only attach the power domain to the first device if the | |
1270 | * companion is shared by multiple. This is to prevent doing power | |
1271 | * management twice. | |
1272 | */ | |
1273 | if (!acpi_device_is_first_physical_node(adev, dev)) | |
919b7308 | 1274 | return 0; |
712e960f | 1275 | |
c072530f | 1276 | acpi_add_pm_notifier(adev, dev, acpi_pm_notify_work_func); |
989561de | 1277 | dev_pm_domain_set(dev, &acpi_general_pm_domain); |
b88ce2a4 RW |
1278 | if (power_on) { |
1279 | acpi_dev_pm_full_power(adev); | |
99d8845e | 1280 | acpi_device_wakeup_disable(adev); |
b88ce2a4 | 1281 | } |
86f1e15f UH |
1282 | |
1283 | dev->pm_domain->detach = acpi_dev_pm_detach; | |
919b7308 | 1284 | return 1; |
e5cc8ef3 RW |
1285 | } |
1286 | EXPORT_SYMBOL_GPL(acpi_dev_pm_attach); | |
ec4602a9 | 1287 | #endif /* CONFIG_PM */ |