]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/base/power/main.c
PM: Clean up PM_TRACE dependencies and drop unnecessary Kconfig option
[mirror_ubuntu-bionic-kernel.git] / drivers / base / power / main.c
CommitLineData
1da177e4
LT
1/*
2 * drivers/base/power/main.c - Where the driver meets power management.
3 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
6 *
7 * This file is released under the GPLv2
8 *
9 *
10 * The driver model core calls device_pm_add() when a device is registered.
b595076a 11 * This will initialize the embedded device_pm_info object in the device
1da177e4
LT
12 * and add it to the list of power-controlled devices. sysfs entries for
13 * controlling device power management will also be added.
14 *
1eede070
RW
15 * A separate list is used for keeping track of power info, because the power
16 * domain dependencies may differ from the ancestral dependencies that the
17 * subsystem list maintains.
1da177e4
LT
18 */
19
1da177e4 20#include <linux/device.h>
cd59abfc 21#include <linux/kallsyms.h>
11048dcf 22#include <linux/mutex.h>
cd59abfc 23#include <linux/pm.h>
5e928f77 24#include <linux/pm_runtime.h>
cd59abfc 25#include <linux/resume-trace.h>
2ed8d2b3 26#include <linux/interrupt.h>
f2511774 27#include <linux/sched.h>
5af84b82 28#include <linux/async.h>
1e75227e 29#include <linux/suspend.h>
11048dcf 30
cd59abfc 31#include "../base.h"
1da177e4
LT
32#include "power.h"
33
775b64d2 34/*
1eede070 35 * The entries in the dpm_list list are in a depth first order, simply
775b64d2
RW
36 * because children are guaranteed to be discovered after parents, and
37 * are inserted at the back of the list on discovery.
38 *
8e9394ce
GKH
39 * Since device_pm_add() may be called with a device lock held,
40 * we must never try to acquire a device lock while holding
775b64d2
RW
41 * dpm_list_mutex.
42 */
43
1eede070 44LIST_HEAD(dpm_list);
8a43a9ab
RW
45LIST_HEAD(dpm_prepared_list);
46LIST_HEAD(dpm_suspended_list);
47LIST_HEAD(dpm_noirq_list);
1da177e4 48
cd59abfc 49static DEFINE_MUTEX(dpm_list_mtx);
5af84b82 50static pm_message_t pm_transition;
1da177e4 51
098dff73
RW
52static int async_error;
53
5e928f77 54/**
20d652d7 55 * device_pm_init - Initialize the PM-related part of a device object.
5e928f77
RW
56 * @dev: Device object being initialized.
57 */
58void device_pm_init(struct device *dev)
59{
b8c76f6a 60 dev->power.in_suspend = false;
5af84b82 61 init_completion(&dev->power.completion);
152e1d59 62 complete_all(&dev->power.completion);
074037ec
RW
63 dev->power.wakeup = NULL;
64 spin_lock_init(&dev->power.lock);
5e928f77
RW
65 pm_runtime_init(dev);
66}
67
1eede070 68/**
20d652d7 69 * device_pm_lock - Lock the list of active devices used by the PM core.
1eede070
RW
70 */
71void device_pm_lock(void)
72{
73 mutex_lock(&dpm_list_mtx);
74}
75
76/**
20d652d7 77 * device_pm_unlock - Unlock the list of active devices used by the PM core.
1eede070
RW
78 */
79void device_pm_unlock(void)
80{
81 mutex_unlock(&dpm_list_mtx);
82}
075c1771 83
775b64d2 84/**
20d652d7
RW
85 * device_pm_add - Add a device to the PM core's list of active devices.
86 * @dev: Device to add to the list.
775b64d2 87 */
3b98aeaf 88void device_pm_add(struct device *dev)
1da177e4 89{
1da177e4 90 pr_debug("PM: Adding info for %s:%s\n",
5c1a07ab 91 dev->bus ? dev->bus->name : "No Bus", dev_name(dev));
11048dcf 92 mutex_lock(&dpm_list_mtx);
b64959e6
RW
93 if (dev->parent && dev->parent->power.in_suspend)
94 dev_warn(dev, "parent %s should not be sleeping\n",
95 dev_name(dev->parent));
3b98aeaf 96 list_add_tail(&dev->power.entry, &dpm_list);
11048dcf 97 mutex_unlock(&dpm_list_mtx);
1da177e4
LT
98}
99
775b64d2 100/**
20d652d7
RW
101 * device_pm_remove - Remove a device from the PM core's list of active devices.
102 * @dev: Device to be removed from the list.
775b64d2 103 */
9cddad77 104void device_pm_remove(struct device *dev)
1da177e4
LT
105{
106 pr_debug("PM: Removing info for %s:%s\n",
5c1a07ab 107 dev->bus ? dev->bus->name : "No Bus", dev_name(dev));
5af84b82 108 complete_all(&dev->power.completion);
11048dcf 109 mutex_lock(&dpm_list_mtx);
1da177e4 110 list_del_init(&dev->power.entry);
11048dcf 111 mutex_unlock(&dpm_list_mtx);
074037ec 112 device_wakeup_disable(dev);
5e928f77 113 pm_runtime_remove(dev);
775b64d2
RW
114}
115
ffa6a705 116/**
20d652d7
RW
117 * device_pm_move_before - Move device in the PM core's list of active devices.
118 * @deva: Device to move in dpm_list.
119 * @devb: Device @deva should come before.
ffa6a705
CH
120 */
121void device_pm_move_before(struct device *deva, struct device *devb)
122{
123 pr_debug("PM: Moving %s:%s before %s:%s\n",
5c1a07ab
RW
124 deva->bus ? deva->bus->name : "No Bus", dev_name(deva),
125 devb->bus ? devb->bus->name : "No Bus", dev_name(devb));
ffa6a705
CH
126 /* Delete deva from dpm_list and reinsert before devb. */
127 list_move_tail(&deva->power.entry, &devb->power.entry);
128}
129
130/**
20d652d7
RW
131 * device_pm_move_after - Move device in the PM core's list of active devices.
132 * @deva: Device to move in dpm_list.
133 * @devb: Device @deva should come after.
ffa6a705
CH
134 */
135void device_pm_move_after(struct device *deva, struct device *devb)
136{
137 pr_debug("PM: Moving %s:%s after %s:%s\n",
5c1a07ab
RW
138 deva->bus ? deva->bus->name : "No Bus", dev_name(deva),
139 devb->bus ? devb->bus->name : "No Bus", dev_name(devb));
ffa6a705
CH
140 /* Delete deva from dpm_list and reinsert after devb. */
141 list_move(&deva->power.entry, &devb->power.entry);
142}
143
144/**
20d652d7
RW
145 * device_pm_move_last - Move device to end of the PM core's list of devices.
146 * @dev: Device to move in dpm_list.
ffa6a705
CH
147 */
148void device_pm_move_last(struct device *dev)
149{
150 pr_debug("PM: Moving %s:%s to end of list\n",
5c1a07ab 151 dev->bus ? dev->bus->name : "No Bus", dev_name(dev));
ffa6a705
CH
152 list_move_tail(&dev->power.entry, &dpm_list);
153}
154
875ab0b7
RW
155static ktime_t initcall_debug_start(struct device *dev)
156{
157 ktime_t calltime = ktime_set(0, 0);
158
159 if (initcall_debug) {
160 pr_info("calling %s+ @ %i\n",
161 dev_name(dev), task_pid_nr(current));
162 calltime = ktime_get();
163 }
164
165 return calltime;
166}
167
168static void initcall_debug_report(struct device *dev, ktime_t calltime,
169 int error)
170{
171 ktime_t delta, rettime;
172
173 if (initcall_debug) {
174 rettime = ktime_get();
175 delta = ktime_sub(rettime, calltime);
176 pr_info("call %s+ returned %d after %Ld usecs\n", dev_name(dev),
177 error, (unsigned long long)ktime_to_ns(delta) >> 10);
178 }
179}
180
5af84b82
RW
181/**
182 * dpm_wait - Wait for a PM operation to complete.
183 * @dev: Device to wait for.
184 * @async: If unset, wait only if the device's power.async_suspend flag is set.
185 */
186static void dpm_wait(struct device *dev, bool async)
187{
188 if (!dev)
189 return;
190
0e06b4a8 191 if (async || (pm_async_enabled && dev->power.async_suspend))
5af84b82
RW
192 wait_for_completion(&dev->power.completion);
193}
194
195static int dpm_wait_fn(struct device *dev, void *async_ptr)
196{
197 dpm_wait(dev, *((bool *)async_ptr));
198 return 0;
199}
200
201static void dpm_wait_for_children(struct device *dev, bool async)
202{
203 device_for_each_child(dev, &async, dpm_wait_fn);
204}
205
1eede070 206/**
20d652d7
RW
207 * pm_op - Execute the PM operation appropriate for given PM event.
208 * @dev: Device to handle.
209 * @ops: PM operations to choose from.
210 * @state: PM transition of the system being carried out.
1eede070 211 */
d9ab7716
DT
212static int pm_op(struct device *dev,
213 const struct dev_pm_ops *ops,
214 pm_message_t state)
1eede070
RW
215{
216 int error = 0;
875ab0b7 217 ktime_t calltime;
f2511774 218
875ab0b7 219 calltime = initcall_debug_start(dev);
1eede070
RW
220
221 switch (state.event) {
222#ifdef CONFIG_SUSPEND
223 case PM_EVENT_SUSPEND:
224 if (ops->suspend) {
225 error = ops->suspend(dev);
226 suspend_report_result(ops->suspend, error);
227 }
228 break;
229 case PM_EVENT_RESUME:
230 if (ops->resume) {
231 error = ops->resume(dev);
232 suspend_report_result(ops->resume, error);
233 }
234 break;
235#endif /* CONFIG_SUSPEND */
236#ifdef CONFIG_HIBERNATION
237 case PM_EVENT_FREEZE:
238 case PM_EVENT_QUIESCE:
239 if (ops->freeze) {
240 error = ops->freeze(dev);
241 suspend_report_result(ops->freeze, error);
242 }
243 break;
244 case PM_EVENT_HIBERNATE:
245 if (ops->poweroff) {
246 error = ops->poweroff(dev);
247 suspend_report_result(ops->poweroff, error);
248 }
249 break;
250 case PM_EVENT_THAW:
251 case PM_EVENT_RECOVER:
252 if (ops->thaw) {
253 error = ops->thaw(dev);
254 suspend_report_result(ops->thaw, error);
255 }
256 break;
257 case PM_EVENT_RESTORE:
258 if (ops->restore) {
259 error = ops->restore(dev);
260 suspend_report_result(ops->restore, error);
261 }
262 break;
263#endif /* CONFIG_HIBERNATION */
264 default:
265 error = -EINVAL;
266 }
f2511774 267
875ab0b7 268 initcall_debug_report(dev, calltime, error);
f2511774 269
1eede070
RW
270 return error;
271}
272
273/**
20d652d7
RW
274 * pm_noirq_op - Execute the PM operation appropriate for given PM event.
275 * @dev: Device to handle.
276 * @ops: PM operations to choose from.
277 * @state: PM transition of the system being carried out.
1eede070 278 *
20d652d7
RW
279 * The driver of @dev will not receive interrupts while this function is being
280 * executed.
1eede070 281 */
d9ab7716
DT
282static int pm_noirq_op(struct device *dev,
283 const struct dev_pm_ops *ops,
1eede070
RW
284 pm_message_t state)
285{
286 int error = 0;
2cbb3ce1 287 ktime_t calltime = ktime_set(0, 0), delta, rettime;
f2511774
AV
288
289 if (initcall_debug) {
8cc6b39f
RW
290 pr_info("calling %s+ @ %i, parent: %s\n",
291 dev_name(dev), task_pid_nr(current),
292 dev->parent ? dev_name(dev->parent) : "none");
f2511774
AV
293 calltime = ktime_get();
294 }
1eede070
RW
295
296 switch (state.event) {
297#ifdef CONFIG_SUSPEND
298 case PM_EVENT_SUSPEND:
299 if (ops->suspend_noirq) {
300 error = ops->suspend_noirq(dev);
301 suspend_report_result(ops->suspend_noirq, error);
302 }
303 break;
304 case PM_EVENT_RESUME:
305 if (ops->resume_noirq) {
306 error = ops->resume_noirq(dev);
307 suspend_report_result(ops->resume_noirq, error);
308 }
309 break;
310#endif /* CONFIG_SUSPEND */
311#ifdef CONFIG_HIBERNATION
312 case PM_EVENT_FREEZE:
313 case PM_EVENT_QUIESCE:
314 if (ops->freeze_noirq) {
315 error = ops->freeze_noirq(dev);
316 suspend_report_result(ops->freeze_noirq, error);
317 }
318 break;
319 case PM_EVENT_HIBERNATE:
320 if (ops->poweroff_noirq) {
321 error = ops->poweroff_noirq(dev);
322 suspend_report_result(ops->poweroff_noirq, error);
323 }
324 break;
325 case PM_EVENT_THAW:
326 case PM_EVENT_RECOVER:
327 if (ops->thaw_noirq) {
328 error = ops->thaw_noirq(dev);
329 suspend_report_result(ops->thaw_noirq, error);
330 }
331 break;
332 case PM_EVENT_RESTORE:
333 if (ops->restore_noirq) {
334 error = ops->restore_noirq(dev);
335 suspend_report_result(ops->restore_noirq, error);
336 }
337 break;
338#endif /* CONFIG_HIBERNATION */
339 default:
340 error = -EINVAL;
341 }
f2511774
AV
342
343 if (initcall_debug) {
344 rettime = ktime_get();
345 delta = ktime_sub(rettime, calltime);
875ab0b7
RW
346 printk("initcall %s_i+ returned %d after %Ld usecs\n",
347 dev_name(dev), error,
348 (unsigned long long)ktime_to_ns(delta) >> 10);
f2511774
AV
349 }
350
1eede070
RW
351 return error;
352}
353
354static char *pm_verb(int event)
355{
356 switch (event) {
357 case PM_EVENT_SUSPEND:
358 return "suspend";
359 case PM_EVENT_RESUME:
360 return "resume";
361 case PM_EVENT_FREEZE:
362 return "freeze";
363 case PM_EVENT_QUIESCE:
364 return "quiesce";
365 case PM_EVENT_HIBERNATE:
366 return "hibernate";
367 case PM_EVENT_THAW:
368 return "thaw";
369 case PM_EVENT_RESTORE:
370 return "restore";
371 case PM_EVENT_RECOVER:
372 return "recover";
373 default:
374 return "(unknown PM event)";
375 }
376}
377
378static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
379{
380 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
381 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
382 ", may wakeup" : "");
383}
384
385static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
386 int error)
387{
388 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
5c1a07ab 389 dev_name(dev), pm_verb(state.event), info, error);
1eede070
RW
390}
391
ecf762b2
RW
392static void dpm_show_time(ktime_t starttime, pm_message_t state, char *info)
393{
394 ktime_t calltime;
0702d9ee 395 u64 usecs64;
ecf762b2
RW
396 int usecs;
397
398 calltime = ktime_get();
399 usecs64 = ktime_to_ns(ktime_sub(calltime, starttime));
400 do_div(usecs64, NSEC_PER_USEC);
401 usecs = usecs64;
402 if (usecs == 0)
403 usecs = 1;
404 pr_info("PM: %s%s%s of devices complete after %ld.%03ld msecs\n",
405 info ?: "", info ? " " : "", pm_verb(state.event),
406 usecs / USEC_PER_MSEC, usecs % USEC_PER_MSEC);
407}
408
cd59abfc
AS
409/*------------------------- Resume routines -------------------------*/
410
411/**
20d652d7
RW
412 * device_resume_noirq - Execute an "early resume" callback for given device.
413 * @dev: Device to handle.
414 * @state: PM transition of the system being carried out.
cd59abfc 415 *
20d652d7
RW
416 * The driver of @dev will not receive interrupts while this function is being
417 * executed.
cd59abfc 418 */
d1616302 419static int device_resume_noirq(struct device *dev, pm_message_t state)
cd59abfc
AS
420{
421 int error = 0;
422
423 TRACE_DEVICE(dev);
424 TRACE_RESUME(0);
425
33c33740 426 if (dev->bus && dev->bus->pm) {
1eede070
RW
427 pm_dev_dbg(dev, state, "EARLY ");
428 error = pm_noirq_op(dev, dev->bus->pm, state);
e7176a37
DB
429 if (error)
430 goto End;
775b64d2 431 }
33c33740 432
e7176a37
DB
433 if (dev->type && dev->type->pm) {
434 pm_dev_dbg(dev, state, "EARLY type ");
435 error = pm_noirq_op(dev, dev->type->pm, state);
436 if (error)
437 goto End;
438 }
439
440 if (dev->class && dev->class->pm) {
441 pm_dev_dbg(dev, state, "EARLY class ");
442 error = pm_noirq_op(dev, dev->class->pm, state);
443 }
444
445End:
775b64d2
RW
446 TRACE_RESUME(error);
447 return error;
448}
449
450/**
20d652d7
RW
451 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
452 * @state: PM transition of the system being carried out.
775b64d2 453 *
20d652d7
RW
454 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
455 * enable device drivers to receive interrupts.
775b64d2 456 */
d1616302 457void dpm_resume_noirq(pm_message_t state)
775b64d2 458{
ecf762b2 459 ktime_t starttime = ktime_get();
775b64d2 460
32bdfac5 461 mutex_lock(&dpm_list_mtx);
8a43a9ab
RW
462 while (!list_empty(&dpm_noirq_list)) {
463 struct device *dev = to_device(dpm_noirq_list.next);
5b219a51 464 int error;
d08a5ace
RW
465
466 get_device(dev);
5b219a51
RW
467 list_move_tail(&dev->power.entry, &dpm_suspended_list);
468 mutex_unlock(&dpm_list_mtx);
d08a5ace 469
5b219a51
RW
470 error = device_resume_noirq(dev, state);
471 if (error)
472 pm_dev_err(dev, state, " early", error);
d08a5ace 473
5b219a51 474 mutex_lock(&dpm_list_mtx);
d08a5ace
RW
475 put_device(dev);
476 }
32bdfac5 477 mutex_unlock(&dpm_list_mtx);
ecf762b2 478 dpm_show_time(starttime, state, "early");
2ed8d2b3 479 resume_device_irqs();
775b64d2 480}
d1616302 481EXPORT_SYMBOL_GPL(dpm_resume_noirq);
775b64d2 482
875ab0b7
RW
483/**
484 * legacy_resume - Execute a legacy (bus or class) resume callback for device.
0a884223
RD
485 * @dev: Device to resume.
486 * @cb: Resume callback to execute.
875ab0b7
RW
487 */
488static int legacy_resume(struct device *dev, int (*cb)(struct device *dev))
489{
490 int error;
491 ktime_t calltime;
492
493 calltime = initcall_debug_start(dev);
494
495 error = cb(dev);
496 suspend_report_result(cb, error);
497
498 initcall_debug_report(dev, calltime, error);
499
500 return error;
501}
502
775b64d2 503/**
97df8c12 504 * device_resume - Execute "resume" callbacks for given device.
20d652d7
RW
505 * @dev: Device to handle.
506 * @state: PM transition of the system being carried out.
5af84b82 507 * @async: If true, the device is being resumed asynchronously.
775b64d2 508 */
97df8c12 509static int device_resume(struct device *dev, pm_message_t state, bool async)
775b64d2
RW
510{
511 int error = 0;
512
513 TRACE_DEVICE(dev);
514 TRACE_RESUME(0);
cd59abfc 515
5af84b82 516 dpm_wait(dev->parent, async);
8e9394ce 517 device_lock(dev);
7a8d37a3 518
b8c76f6a 519 dev->power.in_suspend = false;
97df8c12 520
1eede070
RW
521 if (dev->bus) {
522 if (dev->bus->pm) {
523 pm_dev_dbg(dev, state, "");
adf09493 524 error = pm_op(dev, dev->bus->pm, state);
1eede070
RW
525 } else if (dev->bus->resume) {
526 pm_dev_dbg(dev, state, "legacy ");
875ab0b7 527 error = legacy_resume(dev, dev->bus->resume);
1eede070
RW
528 }
529 if (error)
530 goto End;
cd59abfc
AS
531 }
532
1eede070
RW
533 if (dev->type) {
534 if (dev->type->pm) {
535 pm_dev_dbg(dev, state, "type ");
536 error = pm_op(dev, dev->type->pm, state);
1eede070
RW
537 }
538 if (error)
539 goto End;
cd59abfc
AS
540 }
541
1eede070
RW
542 if (dev->class) {
543 if (dev->class->pm) {
544 pm_dev_dbg(dev, state, "class ");
545 error = pm_op(dev, dev->class->pm, state);
546 } else if (dev->class->resume) {
547 pm_dev_dbg(dev, state, "legacy class ");
875ab0b7 548 error = legacy_resume(dev, dev->class->resume);
1eede070 549 }
cd59abfc 550 }
1eede070 551 End:
8e9394ce 552 device_unlock(dev);
5af84b82 553 complete_all(&dev->power.completion);
7a8d37a3 554
cd59abfc
AS
555 TRACE_RESUME(error);
556 return error;
557}
558
5af84b82
RW
559static void async_resume(void *data, async_cookie_t cookie)
560{
561 struct device *dev = (struct device *)data;
562 int error;
563
97df8c12 564 error = device_resume(dev, pm_transition, true);
5af84b82
RW
565 if (error)
566 pm_dev_err(dev, pm_transition, " async", error);
567 put_device(dev);
568}
569
97df8c12 570static bool is_async(struct device *dev)
5af84b82 571{
97df8c12
RW
572 return dev->power.async_suspend && pm_async_enabled
573 && !pm_trace_is_enabled();
5af84b82
RW
574}
575
775b64d2 576/**
20d652d7
RW
577 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
578 * @state: PM transition of the system being carried out.
775b64d2 579 *
20d652d7
RW
580 * Execute the appropriate "resume" callback for all devices whose status
581 * indicates that they are suspended.
1eede070
RW
582 */
583static void dpm_resume(pm_message_t state)
584{
97df8c12 585 struct device *dev;
ecf762b2 586 ktime_t starttime = ktime_get();
1eede070 587
1eede070 588 mutex_lock(&dpm_list_mtx);
5af84b82 589 pm_transition = state;
098dff73 590 async_error = 0;
1eede070 591
8a43a9ab 592 list_for_each_entry(dev, &dpm_suspended_list, power.entry) {
97df8c12
RW
593 INIT_COMPLETION(dev->power.completion);
594 if (is_async(dev)) {
595 get_device(dev);
596 async_schedule(async_resume, dev);
597 }
598 }
599
8a43a9ab
RW
600 while (!list_empty(&dpm_suspended_list)) {
601 dev = to_device(dpm_suspended_list.next);
1eede070 602 get_device(dev);
5b219a51 603 if (!is_async(dev)) {
1eede070
RW
604 int error;
605
1eede070
RW
606 mutex_unlock(&dpm_list_mtx);
607
97df8c12 608 error = device_resume(dev, state, false);
1eede070
RW
609 if (error)
610 pm_dev_err(dev, state, "", error);
5b219a51
RW
611
612 mutex_lock(&dpm_list_mtx);
1eede070
RW
613 }
614 if (!list_empty(&dev->power.entry))
8a43a9ab 615 list_move_tail(&dev->power.entry, &dpm_prepared_list);
1eede070
RW
616 put_device(dev);
617 }
1eede070 618 mutex_unlock(&dpm_list_mtx);
5af84b82 619 async_synchronize_full();
ecf762b2 620 dpm_show_time(starttime, state, NULL);
1eede070
RW
621}
622
623/**
20d652d7
RW
624 * device_complete - Complete a PM transition for given device.
625 * @dev: Device to handle.
626 * @state: PM transition of the system being carried out.
1eede070 627 */
d1616302 628static void device_complete(struct device *dev, pm_message_t state)
1eede070 629{
8e9394ce 630 device_lock(dev);
1eede070
RW
631
632 if (dev->class && dev->class->pm && dev->class->pm->complete) {
633 pm_dev_dbg(dev, state, "completing class ");
634 dev->class->pm->complete(dev);
635 }
636
637 if (dev->type && dev->type->pm && dev->type->pm->complete) {
638 pm_dev_dbg(dev, state, "completing type ");
639 dev->type->pm->complete(dev);
640 }
641
adf09493 642 if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
1eede070 643 pm_dev_dbg(dev, state, "completing ");
adf09493 644 dev->bus->pm->complete(dev);
1eede070
RW
645 }
646
8e9394ce 647 device_unlock(dev);
1eede070
RW
648}
649
650/**
20d652d7
RW
651 * dpm_complete - Complete a PM transition for all non-sysdev devices.
652 * @state: PM transition of the system being carried out.
775b64d2 653 *
20d652d7
RW
654 * Execute the ->complete() callbacks for all devices whose PM status is not
655 * DPM_ON (this allows new devices to be registered).
cd59abfc 656 */
1eede070 657static void dpm_complete(pm_message_t state)
cd59abfc 658{
1eede070
RW
659 struct list_head list;
660
661 INIT_LIST_HEAD(&list);
cd59abfc 662 mutex_lock(&dpm_list_mtx);
8a43a9ab
RW
663 while (!list_empty(&dpm_prepared_list)) {
664 struct device *dev = to_device(dpm_prepared_list.prev);
cd59abfc 665
1eede070 666 get_device(dev);
b8c76f6a 667 dev->power.in_suspend = false;
5b219a51
RW
668 list_move(&dev->power.entry, &list);
669 mutex_unlock(&dpm_list_mtx);
1eede070 670
5b219a51
RW
671 device_complete(dev, state);
672 pm_runtime_put_sync(dev);
1eede070 673
5b219a51 674 mutex_lock(&dpm_list_mtx);
1eede070 675 put_device(dev);
cd59abfc 676 }
1eede070 677 list_splice(&list, &dpm_list);
cd59abfc
AS
678 mutex_unlock(&dpm_list_mtx);
679}
680
cd59abfc 681/**
20d652d7
RW
682 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
683 * @state: PM transition of the system being carried out.
cd59abfc 684 *
20d652d7
RW
685 * Execute "resume" callbacks for all devices and complete the PM transition of
686 * the system.
cd59abfc 687 */
d1616302 688void dpm_resume_end(pm_message_t state)
cd59abfc 689{
775b64d2 690 might_sleep();
1eede070
RW
691 dpm_resume(state);
692 dpm_complete(state);
cd59abfc 693}
d1616302 694EXPORT_SYMBOL_GPL(dpm_resume_end);
cd59abfc
AS
695
696
697/*------------------------- Suspend routines -------------------------*/
698
1eede070 699/**
20d652d7
RW
700 * resume_event - Return a "resume" message for given "suspend" sleep state.
701 * @sleep_state: PM message representing a sleep state.
702 *
703 * Return a PM message representing the resume event corresponding to given
704 * sleep state.
1eede070
RW
705 */
706static pm_message_t resume_event(pm_message_t sleep_state)
cd59abfc 707{
1eede070
RW
708 switch (sleep_state.event) {
709 case PM_EVENT_SUSPEND:
710 return PMSG_RESUME;
711 case PM_EVENT_FREEZE:
712 case PM_EVENT_QUIESCE:
713 return PMSG_RECOVER;
714 case PM_EVENT_HIBERNATE:
715 return PMSG_RESTORE;
cd59abfc 716 }
1eede070 717 return PMSG_ON;
cd59abfc
AS
718}
719
720/**
20d652d7
RW
721 * device_suspend_noirq - Execute a "late suspend" callback for given device.
722 * @dev: Device to handle.
723 * @state: PM transition of the system being carried out.
775b64d2 724 *
20d652d7
RW
725 * The driver of @dev will not receive interrupts while this function is being
726 * executed.
cd59abfc 727 */
d1616302 728static int device_suspend_noirq(struct device *dev, pm_message_t state)
775b64d2
RW
729{
730 int error = 0;
cd59abfc 731
e7176a37
DB
732 if (dev->class && dev->class->pm) {
733 pm_dev_dbg(dev, state, "LATE class ");
734 error = pm_noirq_op(dev, dev->class->pm, state);
735 if (error)
736 goto End;
737 }
738
739 if (dev->type && dev->type->pm) {
740 pm_dev_dbg(dev, state, "LATE type ");
741 error = pm_noirq_op(dev, dev->type->pm, state);
742 if (error)
743 goto End;
744 }
745
33c33740 746 if (dev->bus && dev->bus->pm) {
1eede070
RW
747 pm_dev_dbg(dev, state, "LATE ");
748 error = pm_noirq_op(dev, dev->bus->pm, state);
775b64d2 749 }
e7176a37
DB
750
751End:
775b64d2
RW
752 return error;
753}
754
755/**
20d652d7
RW
756 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
757 * @state: PM transition of the system being carried out.
775b64d2 758 *
20d652d7
RW
759 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
760 * handlers for all non-sysdev devices.
775b64d2 761 */
d1616302 762int dpm_suspend_noirq(pm_message_t state)
775b64d2 763{
ecf762b2 764 ktime_t starttime = ktime_get();
775b64d2
RW
765 int error = 0;
766
2ed8d2b3 767 suspend_device_irqs();
32bdfac5 768 mutex_lock(&dpm_list_mtx);
8a43a9ab
RW
769 while (!list_empty(&dpm_suspended_list)) {
770 struct device *dev = to_device(dpm_suspended_list.prev);
d08a5ace
RW
771
772 get_device(dev);
773 mutex_unlock(&dpm_list_mtx);
774
d1616302 775 error = device_suspend_noirq(dev, state);
d08a5ace
RW
776
777 mutex_lock(&dpm_list_mtx);
775b64d2 778 if (error) {
1eede070 779 pm_dev_err(dev, state, " late", error);
d08a5ace 780 put_device(dev);
775b64d2
RW
781 break;
782 }
d08a5ace 783 if (!list_empty(&dev->power.entry))
8a43a9ab 784 list_move(&dev->power.entry, &dpm_noirq_list);
d08a5ace 785 put_device(dev);
775b64d2 786 }
32bdfac5 787 mutex_unlock(&dpm_list_mtx);
775b64d2 788 if (error)
d1616302 789 dpm_resume_noirq(resume_event(state));
ecf762b2
RW
790 else
791 dpm_show_time(starttime, state, "late");
775b64d2
RW
792 return error;
793}
d1616302 794EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
775b64d2 795
875ab0b7
RW
796/**
797 * legacy_suspend - Execute a legacy (bus or class) suspend callback for device.
0a884223
RD
798 * @dev: Device to suspend.
799 * @state: PM transition of the system being carried out.
800 * @cb: Suspend callback to execute.
875ab0b7
RW
801 */
802static int legacy_suspend(struct device *dev, pm_message_t state,
803 int (*cb)(struct device *dev, pm_message_t state))
804{
805 int error;
806 ktime_t calltime;
807
808 calltime = initcall_debug_start(dev);
809
810 error = cb(dev, state);
811 suspend_report_result(cb, error);
812
813 initcall_debug_report(dev, calltime, error);
814
815 return error;
816}
817
775b64d2 818/**
20d652d7
RW
819 * device_suspend - Execute "suspend" callbacks for given device.
820 * @dev: Device to handle.
821 * @state: PM transition of the system being carried out.
5af84b82 822 * @async: If true, the device is being suspended asynchronously.
775b64d2 823 */
5af84b82 824static int __device_suspend(struct device *dev, pm_message_t state, bool async)
cd59abfc
AS
825{
826 int error = 0;
827
5af84b82 828 dpm_wait_for_children(dev, async);
8e9394ce 829 device_lock(dev);
7a8d37a3 830
5af84b82
RW
831 if (async_error)
832 goto End;
833
d83f905e
RW
834 if (pm_wakeup_pending()) {
835 async_error = -EBUSY;
836 goto End;
837 }
838
1eede070
RW
839 if (dev->class) {
840 if (dev->class->pm) {
841 pm_dev_dbg(dev, state, "class ");
842 error = pm_op(dev, dev->class->pm, state);
843 } else if (dev->class->suspend) {
844 pm_dev_dbg(dev, state, "legacy class ");
875ab0b7 845 error = legacy_suspend(dev, state, dev->class->suspend);
1eede070
RW
846 }
847 if (error)
848 goto End;
cd59abfc
AS
849 }
850
1eede070
RW
851 if (dev->type) {
852 if (dev->type->pm) {
853 pm_dev_dbg(dev, state, "type ");
854 error = pm_op(dev, dev->type->pm, state);
1eede070
RW
855 }
856 if (error)
857 goto End;
cd59abfc
AS
858 }
859
1eede070
RW
860 if (dev->bus) {
861 if (dev->bus->pm) {
862 pm_dev_dbg(dev, state, "");
adf09493 863 error = pm_op(dev, dev->bus->pm, state);
1eede070
RW
864 } else if (dev->bus->suspend) {
865 pm_dev_dbg(dev, state, "legacy ");
875ab0b7 866 error = legacy_suspend(dev, state, dev->bus->suspend);
1eede070 867 }
cd59abfc 868 }
5af84b82 869
1eede070 870 End:
8e9394ce 871 device_unlock(dev);
5af84b82 872 complete_all(&dev->power.completion);
7a8d37a3 873
098dff73
RW
874 if (error)
875 async_error = error;
876
cd59abfc
AS
877 return error;
878}
879
5af84b82
RW
880static void async_suspend(void *data, async_cookie_t cookie)
881{
882 struct device *dev = (struct device *)data;
883 int error;
884
885 error = __device_suspend(dev, pm_transition, true);
098dff73 886 if (error)
5af84b82 887 pm_dev_err(dev, pm_transition, " async", error);
5af84b82
RW
888
889 put_device(dev);
890}
891
892static int device_suspend(struct device *dev)
893{
894 INIT_COMPLETION(dev->power.completion);
895
0e06b4a8 896 if (pm_async_enabled && dev->power.async_suspend) {
5af84b82
RW
897 get_device(dev);
898 async_schedule(async_suspend, dev);
899 return 0;
900 }
901
902 return __device_suspend(dev, pm_transition, false);
903}
904
cd59abfc 905/**
20d652d7
RW
906 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
907 * @state: PM transition of the system being carried out.
cd59abfc 908 */
775b64d2 909static int dpm_suspend(pm_message_t state)
cd59abfc 910{
ecf762b2 911 ktime_t starttime = ktime_get();
cd59abfc
AS
912 int error = 0;
913
cd59abfc 914 mutex_lock(&dpm_list_mtx);
5af84b82
RW
915 pm_transition = state;
916 async_error = 0;
8a43a9ab
RW
917 while (!list_empty(&dpm_prepared_list)) {
918 struct device *dev = to_device(dpm_prepared_list.prev);
58aca232 919
1eede070 920 get_device(dev);
cd59abfc 921 mutex_unlock(&dpm_list_mtx);
1eede070 922
5af84b82 923 error = device_suspend(dev);
1eede070 924
1b3cbec1 925 mutex_lock(&dpm_list_mtx);
775b64d2 926 if (error) {
1eede070
RW
927 pm_dev_err(dev, state, "", error);
928 put_device(dev);
775b64d2
RW
929 break;
930 }
7a8d37a3 931 if (!list_empty(&dev->power.entry))
8a43a9ab 932 list_move(&dev->power.entry, &dpm_suspended_list);
1eede070 933 put_device(dev);
5af84b82
RW
934 if (async_error)
935 break;
cd59abfc
AS
936 }
937 mutex_unlock(&dpm_list_mtx);
5af84b82
RW
938 async_synchronize_full();
939 if (!error)
940 error = async_error;
ecf762b2
RW
941 if (!error)
942 dpm_show_time(starttime, state, NULL);
1eede070
RW
943 return error;
944}
945
946/**
20d652d7
RW
947 * device_prepare - Prepare a device for system power transition.
948 * @dev: Device to handle.
949 * @state: PM transition of the system being carried out.
950 *
951 * Execute the ->prepare() callback(s) for given device. No new children of the
952 * device may be registered after this function has returned.
1eede070 953 */
d1616302 954static int device_prepare(struct device *dev, pm_message_t state)
1eede070
RW
955{
956 int error = 0;
957
8e9394ce 958 device_lock(dev);
1eede070 959
adf09493 960 if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
1eede070 961 pm_dev_dbg(dev, state, "preparing ");
adf09493
RW
962 error = dev->bus->pm->prepare(dev);
963 suspend_report_result(dev->bus->pm->prepare, error);
1eede070
RW
964 if (error)
965 goto End;
966 }
967
968 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
969 pm_dev_dbg(dev, state, "preparing type ");
970 error = dev->type->pm->prepare(dev);
971 suspend_report_result(dev->type->pm->prepare, error);
972 if (error)
973 goto End;
974 }
975
976 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
977 pm_dev_dbg(dev, state, "preparing class ");
978 error = dev->class->pm->prepare(dev);
979 suspend_report_result(dev->class->pm->prepare, error);
980 }
981 End:
8e9394ce 982 device_unlock(dev);
1eede070
RW
983
984 return error;
985}
cd59abfc 986
1eede070 987/**
20d652d7
RW
988 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
989 * @state: PM transition of the system being carried out.
1eede070 990 *
20d652d7 991 * Execute the ->prepare() callback(s) for all devices.
1eede070
RW
992 */
993static int dpm_prepare(pm_message_t state)
994{
1eede070
RW
995 int error = 0;
996
1eede070 997 mutex_lock(&dpm_list_mtx);
1eede070
RW
998 while (!list_empty(&dpm_list)) {
999 struct device *dev = to_device(dpm_list.next);
1000
1001 get_device(dev);
1eede070
RW
1002 mutex_unlock(&dpm_list_mtx);
1003
5e928f77 1004 pm_runtime_get_noresume(dev);
1e75227e
RW
1005 if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
1006 pm_wakeup_event(dev, 0);
1007
a2867e08 1008 if (pm_wakeup_pending()) {
aa0baaef 1009 pm_runtime_put_sync(dev);
5e928f77
RW
1010 error = -EBUSY;
1011 } else {
1012 error = device_prepare(dev, state);
1013 }
1eede070
RW
1014
1015 mutex_lock(&dpm_list_mtx);
1016 if (error) {
1eede070
RW
1017 if (error == -EAGAIN) {
1018 put_device(dev);
886a7a33 1019 error = 0;
1eede070
RW
1020 continue;
1021 }
1e75227e
RW
1022 printk(KERN_INFO "PM: Device %s not prepared "
1023 "for power transition: code %d\n",
5c1a07ab 1024 dev_name(dev), error);
1eede070
RW
1025 put_device(dev);
1026 break;
1027 }
b8c76f6a 1028 dev->power.in_suspend = true;
1eede070 1029 if (!list_empty(&dev->power.entry))
8a43a9ab 1030 list_move_tail(&dev->power.entry, &dpm_prepared_list);
1eede070
RW
1031 put_device(dev);
1032 }
1eede070 1033 mutex_unlock(&dpm_list_mtx);
cd59abfc
AS
1034 return error;
1035}
1036
775b64d2 1037/**
20d652d7
RW
1038 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
1039 * @state: PM transition of the system being carried out.
775b64d2 1040 *
20d652d7
RW
1041 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
1042 * callbacks for them.
775b64d2 1043 */
d1616302 1044int dpm_suspend_start(pm_message_t state)
775b64d2
RW
1045{
1046 int error;
cd59abfc 1047
775b64d2 1048 might_sleep();
1eede070
RW
1049 error = dpm_prepare(state);
1050 if (!error)
1051 error = dpm_suspend(state);
cd59abfc 1052 return error;
cd59abfc 1053}
d1616302 1054EXPORT_SYMBOL_GPL(dpm_suspend_start);
cd59abfc
AS
1055
1056void __suspend_report_result(const char *function, void *fn, int ret)
1057{
c80cfb04
BH
1058 if (ret)
1059 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
cd59abfc
AS
1060}
1061EXPORT_SYMBOL_GPL(__suspend_report_result);
f8824cee
RW
1062
1063/**
1064 * device_pm_wait_for_dev - Wait for suspend/resume of a device to complete.
1065 * @dev: Device to wait for.
1066 * @subordinate: Device that needs to wait for @dev.
1067 */
098dff73 1068int device_pm_wait_for_dev(struct device *subordinate, struct device *dev)
f8824cee
RW
1069{
1070 dpm_wait(dev, subordinate->power.async_suspend);
098dff73 1071 return async_error;
f8824cee
RW
1072}
1073EXPORT_SYMBOL_GPL(device_pm_wait_for_dev);