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