]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/base/power/runtime.c
PM / runtime: Avoid false-positive warnings from might_sleep_if()
[mirror_ubuntu-zesty-kernel.git] / drivers / base / power / runtime.c
CommitLineData
5e928f77 1/*
62052ab1 2 * drivers/base/power/runtime.c - Helper functions for device runtime PM
5e928f77
RW
3 *
4 * Copyright (c) 2009 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
1bfee5bc 5 * Copyright (C) 2010 Alan Stern <stern@rowland.harvard.edu>
5e928f77
RW
6 *
7 * This file is released under the GPLv2.
8 */
9
10#include <linux/sched.h>
1b6bc32f 11#include <linux/export.h>
5e928f77 12#include <linux/pm_runtime.h>
4990d4fe 13#include <linux/pm_wakeirq.h>
c3dc2f14 14#include <trace/events/rpm.h>
21d5c57b
RW
15
16#include "../base.h"
7490e442 17#include "power.h"
5e928f77 18
dbcd2d72 19typedef int (*pm_callback_t)(struct device *);
5f59df79 20
dbcd2d72 21static pm_callback_t __rpm_get_callback(struct device *dev, size_t cb_offset)
5f59df79 22{
dbcd2d72
AH
23 pm_callback_t cb;
24 const struct dev_pm_ops *ops;
25
26 if (dev->pm_domain)
27 ops = &dev->pm_domain->ops;
28 else if (dev->type && dev->type->pm)
29 ops = dev->type->pm;
30 else if (dev->class && dev->class->pm)
31 ops = dev->class->pm;
32 else if (dev->bus && dev->bus->pm)
33 ops = dev->bus->pm;
34 else
35 ops = NULL;
36
37 if (ops)
38 cb = *(pm_callback_t *)((void *)ops + cb_offset);
39 else
40 cb = NULL;
41
42 if (!cb && dev->driver && dev->driver->pm)
43 cb = *(pm_callback_t *)((void *)dev->driver->pm + cb_offset);
44
45 return cb;
5f59df79
UH
46}
47
dbcd2d72
AH
48#define RPM_GET_CALLBACK(dev, callback) \
49 __rpm_get_callback(dev, offsetof(struct dev_pm_ops, callback))
50
140a6c94 51static int rpm_resume(struct device *dev, int rpmflags);
7490e442 52static int rpm_suspend(struct device *dev, int rpmflags);
5e928f77 53
4769373c
AS
54/**
55 * update_pm_runtime_accounting - Update the time accounting of power states
56 * @dev: Device to update the accounting for
57 *
58 * In order to be able to have time accounting of the various power states
59 * (as used by programs such as PowerTOP to show the effectiveness of runtime
60 * PM), we need to track the time spent in each state.
61 * update_pm_runtime_accounting must be called each time before the
62 * runtime_status field is updated, to account the time in the old state
63 * correctly.
64 */
65void update_pm_runtime_accounting(struct device *dev)
66{
67 unsigned long now = jiffies;
def0c0a3 68 unsigned long delta;
4769373c
AS
69
70 delta = now - dev->power.accounting_timestamp;
71
4769373c
AS
72 dev->power.accounting_timestamp = now;
73
74 if (dev->power.disable_depth > 0)
75 return;
76
77 if (dev->power.runtime_status == RPM_SUSPENDED)
78 dev->power.suspended_jiffies += delta;
79 else
80 dev->power.active_jiffies += delta;
81}
82
83static void __update_runtime_status(struct device *dev, enum rpm_status status)
84{
85 update_pm_runtime_accounting(dev);
86 dev->power.runtime_status = status;
87}
88
5e928f77
RW
89/**
90 * pm_runtime_deactivate_timer - Deactivate given device's suspend timer.
91 * @dev: Device to handle.
92 */
93static void pm_runtime_deactivate_timer(struct device *dev)
94{
95 if (dev->power.timer_expires > 0) {
96 del_timer(&dev->power.suspend_timer);
97 dev->power.timer_expires = 0;
98 }
99}
100
101/**
102 * pm_runtime_cancel_pending - Deactivate suspend timer and cancel requests.
103 * @dev: Device to handle.
104 */
105static void pm_runtime_cancel_pending(struct device *dev)
106{
107 pm_runtime_deactivate_timer(dev);
108 /*
109 * In case there's a request pending, make sure its work function will
110 * return without doing anything.
111 */
112 dev->power.request = RPM_REQ_NONE;
113}
114
15bcb91d
AS
115/*
116 * pm_runtime_autosuspend_expiration - Get a device's autosuspend-delay expiration time.
117 * @dev: Device to handle.
118 *
119 * Compute the autosuspend-delay expiration time based on the device's
120 * power.last_busy time. If the delay has already expired or is disabled
121 * (negative) or the power.use_autosuspend flag isn't set, return 0.
122 * Otherwise return the expiration time in jiffies (adjusted to be nonzero).
123 *
124 * This function may be called either with or without dev->power.lock held.
125 * Either way it can be racy, since power.last_busy may be updated at any time.
126 */
127unsigned long pm_runtime_autosuspend_expiration(struct device *dev)
128{
129 int autosuspend_delay;
130 long elapsed;
131 unsigned long last_busy;
132 unsigned long expires = 0;
133
134 if (!dev->power.use_autosuspend)
135 goto out;
136
137 autosuspend_delay = ACCESS_ONCE(dev->power.autosuspend_delay);
138 if (autosuspend_delay < 0)
139 goto out;
140
141 last_busy = ACCESS_ONCE(dev->power.last_busy);
142 elapsed = jiffies - last_busy;
143 if (elapsed < 0)
144 goto out; /* jiffies has wrapped around. */
145
146 /*
147 * If the autosuspend_delay is >= 1 second, align the timer by rounding
148 * up to the nearest second.
149 */
150 expires = last_busy + msecs_to_jiffies(autosuspend_delay);
151 if (autosuspend_delay >= 1000)
152 expires = round_jiffies(expires);
153 expires += !expires;
154 if (elapsed >= expires - last_busy)
155 expires = 0; /* Already expired. */
156
157 out:
158 return expires;
159}
160EXPORT_SYMBOL_GPL(pm_runtime_autosuspend_expiration);
161
e823407f
ML
162static int dev_memalloc_noio(struct device *dev, void *data)
163{
164 return dev->power.memalloc_noio;
165}
166
167/*
168 * pm_runtime_set_memalloc_noio - Set a device's memalloc_noio flag.
169 * @dev: Device to handle.
170 * @enable: True for setting the flag and False for clearing the flag.
171 *
172 * Set the flag for all devices in the path from the device to the
173 * root device in the device tree if @enable is true, otherwise clear
174 * the flag for devices in the path whose siblings don't set the flag.
175 *
176 * The function should only be called by block device, or network
177 * device driver for solving the deadlock problem during runtime
178 * resume/suspend:
179 *
180 * If memory allocation with GFP_KERNEL is called inside runtime
181 * resume/suspend callback of any one of its ancestors(or the
182 * block device itself), the deadlock may be triggered inside the
183 * memory allocation since it might not complete until the block
184 * device becomes active and the involed page I/O finishes. The
185 * situation is pointed out first by Alan Stern. Network device
186 * are involved in iSCSI kind of situation.
187 *
188 * The lock of dev_hotplug_mutex is held in the function for handling
189 * hotplug race because pm_runtime_set_memalloc_noio() may be called
190 * in async probe().
191 *
192 * The function should be called between device_add() and device_del()
193 * on the affected device(block/network device).
194 */
195void pm_runtime_set_memalloc_noio(struct device *dev, bool enable)
196{
197 static DEFINE_MUTEX(dev_hotplug_mutex);
198
199 mutex_lock(&dev_hotplug_mutex);
200 for (;;) {
201 bool enabled;
202
203 /* hold power lock since bitfield is not SMP-safe. */
204 spin_lock_irq(&dev->power.lock);
205 enabled = dev->power.memalloc_noio;
206 dev->power.memalloc_noio = enable;
207 spin_unlock_irq(&dev->power.lock);
208
209 /*
210 * not need to enable ancestors any more if the device
211 * has been enabled.
212 */
213 if (enabled && enable)
214 break;
215
216 dev = dev->parent;
217
218 /*
219 * clear flag of the parent device only if all the
220 * children don't set the flag because ancestor's
221 * flag was set by any one of the descendants.
222 */
223 if (!dev || (!enable &&
224 device_for_each_child(dev, NULL,
225 dev_memalloc_noio)))
226 break;
227 }
228 mutex_unlock(&dev_hotplug_mutex);
229}
230EXPORT_SYMBOL_GPL(pm_runtime_set_memalloc_noio);
231
5e928f77 232/**
1bfee5bc
AS
233 * rpm_check_suspend_allowed - Test whether a device may be suspended.
234 * @dev: Device to test.
5e928f77 235 */
1bfee5bc 236static int rpm_check_suspend_allowed(struct device *dev)
5e928f77
RW
237{
238 int retval = 0;
239
5e928f77
RW
240 if (dev->power.runtime_error)
241 retval = -EINVAL;
632e270e
RW
242 else if (dev->power.disable_depth > 0)
243 retval = -EACCES;
244 else if (atomic_read(&dev->power.usage_count) > 0)
5e928f77 245 retval = -EAGAIN;
62006c17
UH
246 else if (!dev->power.ignore_children &&
247 atomic_read(&dev->power.child_count))
5e928f77 248 retval = -EBUSY;
1bfee5bc
AS
249
250 /* Pending resume requests take precedence over suspends. */
251 else if ((dev->power.deferred_resume
78ca7c37 252 && dev->power.runtime_status == RPM_SUSPENDING)
1bfee5bc
AS
253 || (dev->power.request_pending
254 && dev->power.request == RPM_REQ_RESUME))
255 retval = -EAGAIN;
55d7ec45
RW
256 else if (__dev_pm_qos_read_value(dev) < 0)
257 retval = -EPERM;
1bfee5bc
AS
258 else if (dev->power.runtime_status == RPM_SUSPENDED)
259 retval = 1;
260
261 return retval;
262}
263
21d5c57b
RW
264static int rpm_get_suppliers(struct device *dev)
265{
266 struct device_link *link;
267
268 list_for_each_entry_rcu(link, &dev->links.suppliers, c_node) {
269 int retval;
270
271 if (!(link->flags & DL_FLAG_PM_RUNTIME))
272 continue;
273
274 if (READ_ONCE(link->status) == DL_STATE_SUPPLIER_UNBIND ||
275 link->rpm_active)
276 continue;
277
278 retval = pm_runtime_get_sync(link->supplier);
279 if (retval < 0) {
280 pm_runtime_put_noidle(link->supplier);
281 return retval;
282 }
283 link->rpm_active = true;
284 }
285 return 0;
286}
287
288static void rpm_put_suppliers(struct device *dev)
289{
290 struct device_link *link;
291
292 list_for_each_entry_rcu(link, &dev->links.suppliers, c_node)
293 if (link->rpm_active &&
294 READ_ONCE(link->status) != DL_STATE_SUPPLIER_UNBIND) {
295 pm_runtime_put(link->supplier);
296 link->rpm_active = false;
297 }
298}
299
ad3c36a5
RW
300/**
301 * __rpm_callback - Run a given runtime PM callback for a given device.
302 * @cb: Runtime PM callback to run.
303 * @dev: Device to run the callback for.
304 */
305static int __rpm_callback(int (*cb)(struct device *), struct device *dev)
306 __releases(&dev->power.lock) __acquires(&dev->power.lock)
307{
21d5c57b 308 int retval, idx;
baa8809f 309 bool use_links = dev->power.links_count > 0;
ad3c36a5 310
21d5c57b 311 if (dev->power.irq_safe) {
ad3c36a5 312 spin_unlock(&dev->power.lock);
21d5c57b 313 } else {
ad3c36a5
RW
314 spin_unlock_irq(&dev->power.lock);
315
21d5c57b
RW
316 /*
317 * Resume suppliers if necessary.
318 *
319 * The device's runtime PM status cannot change until this
320 * routine returns, so it is safe to read the status outside of
321 * the lock.
322 */
baa8809f 323 if (use_links && dev->power.runtime_status == RPM_RESUMING) {
21d5c57b
RW
324 idx = device_links_read_lock();
325
326 retval = rpm_get_suppliers(dev);
327 if (retval)
328 goto fail;
329
330 device_links_read_unlock(idx);
331 }
332 }
333
ad3c36a5
RW
334 retval = cb(dev);
335
21d5c57b 336 if (dev->power.irq_safe) {
ad3c36a5 337 spin_lock(&dev->power.lock);
21d5c57b
RW
338 } else {
339 /*
340 * If the device is suspending and the callback has returned
341 * success, drop the usage counters of the suppliers that have
342 * been reference counted on its resume.
343 *
344 * Do that if resume fails too.
345 */
baa8809f
RW
346 if (use_links
347 && ((dev->power.runtime_status == RPM_SUSPENDING && !retval)
348 || (dev->power.runtime_status == RPM_RESUMING && retval))) {
21d5c57b
RW
349 idx = device_links_read_lock();
350
351 fail:
352 rpm_put_suppliers(dev);
353
354 device_links_read_unlock(idx);
355 }
356
ad3c36a5 357 spin_lock_irq(&dev->power.lock);
21d5c57b 358 }
ad3c36a5
RW
359
360 return retval;
361}
362
1bfee5bc 363/**
140a6c94 364 * rpm_idle - Notify device bus type if the device can be suspended.
1bfee5bc
AS
365 * @dev: Device to notify the bus type about.
366 * @rpmflags: Flag bits.
367 *
62052ab1 368 * Check if the device's runtime PM status allows it to be suspended. If
1bfee5bc
AS
369 * another idle notification has been started earlier, return immediately. If
370 * the RPM_ASYNC flag is set then queue an idle-notification request; otherwise
d66e6db2
UH
371 * run the ->runtime_idle() callback directly. If the ->runtime_idle callback
372 * doesn't exist or if it returns 0, call rpm_suspend with the RPM_AUTO flag.
1bfee5bc
AS
373 *
374 * This function must be called under dev->power.lock with interrupts disabled.
375 */
140a6c94 376static int rpm_idle(struct device *dev, int rpmflags)
1bfee5bc 377{
71c63122 378 int (*callback)(struct device *);
1bfee5bc
AS
379 int retval;
380
d7737ce9 381 trace_rpm_idle_rcuidle(dev, rpmflags);
1bfee5bc
AS
382 retval = rpm_check_suspend_allowed(dev);
383 if (retval < 0)
384 ; /* Conditions are wrong. */
385
386 /* Idle notifications are allowed only in the RPM_ACTIVE state. */
387 else if (dev->power.runtime_status != RPM_ACTIVE)
388 retval = -EAGAIN;
389
390 /*
391 * Any pending request other than an idle notification takes
392 * precedence over us, except that the timer may be running.
393 */
394 else if (dev->power.request_pending &&
395 dev->power.request > RPM_REQ_IDLE)
396 retval = -EAGAIN;
397
398 /* Act as though RPM_NOWAIT is always set. */
399 else if (dev->power.idle_notification)
400 retval = -EINPROGRESS;
5e928f77
RW
401 if (retval)
402 goto out;
403
1bfee5bc
AS
404 /* Pending requests need to be canceled. */
405 dev->power.request = RPM_REQ_NONE;
406
45f0a85c 407 if (dev->power.no_callbacks)
7490e442 408 goto out;
7490e442 409
1bfee5bc
AS
410 /* Carry out an asynchronous or a synchronous idle notification. */
411 if (rpmflags & RPM_ASYNC) {
412 dev->power.request = RPM_REQ_IDLE;
413 if (!dev->power.request_pending) {
414 dev->power.request_pending = true;
415 queue_work(pm_wq, &dev->power.work);
5e928f77 416 }
d7737ce9 417 trace_rpm_return_int_rcuidle(dev, _THIS_IP_, 0);
45f0a85c 418 return 0;
5e928f77
RW
419 }
420
421 dev->power.idle_notification = true;
422
dbcd2d72 423 callback = RPM_GET_CALLBACK(dev, runtime_idle);
35cd133c 424
ad3c36a5 425 if (callback)
45f0a85c 426 retval = __rpm_callback(callback, dev);
5e928f77
RW
427
428 dev->power.idle_notification = false;
429 wake_up_all(&dev->power.wait_queue);
430
431 out:
d7737ce9 432 trace_rpm_return_int_rcuidle(dev, _THIS_IP_, retval);
d66e6db2 433 return retval ? retval : rpm_suspend(dev, rpmflags | RPM_AUTO);
5e928f77
RW
434}
435
71c63122
RW
436/**
437 * rpm_callback - Run a given runtime PM callback for a given device.
438 * @cb: Runtime PM callback to run.
439 * @dev: Device to run the callback for.
440 */
441static int rpm_callback(int (*cb)(struct device *), struct device *dev)
71c63122
RW
442{
443 int retval;
444
445 if (!cb)
446 return -ENOSYS;
447
db88175f
ML
448 if (dev->power.memalloc_noio) {
449 unsigned int noio_flag;
450
451 /*
452 * Deadlock might be caused if memory allocation with
453 * GFP_KERNEL happens inside runtime_suspend and
454 * runtime_resume callbacks of one block device's
455 * ancestor or the block device itself. Network
456 * device might be thought as part of iSCSI block
457 * device, so network device and its ancestor should
458 * be marked as memalloc_noio too.
459 */
460 noio_flag = memalloc_noio_save();
461 retval = __rpm_callback(cb, dev);
462 memalloc_noio_restore(noio_flag);
463 } else {
464 retval = __rpm_callback(cb, dev);
465 }
71c63122 466
71c63122 467 dev->power.runtime_error = retval;
632e270e 468 return retval != -EACCES ? retval : -EIO;
71c63122
RW
469}
470
5e928f77 471/**
62052ab1 472 * rpm_suspend - Carry out runtime suspend of given device.
5e928f77 473 * @dev: Device to suspend.
3f9af051 474 * @rpmflags: Flag bits.
5e928f77 475 *
47d8f0ba
ML
476 * Check if the device's runtime PM status allows it to be suspended.
477 * Cancel a pending idle notification, autosuspend or suspend. If
478 * another suspend has been started earlier, either return immediately
479 * or wait for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC
480 * flags. If the RPM_ASYNC flag is set then queue a suspend request;
857b36c7
ML
481 * otherwise run the ->runtime_suspend() callback directly. When
482 * ->runtime_suspend succeeded, if a deferred resume was requested while
483 * the callback was running then carry it out, otherwise send an idle
484 * notification for its parent (if the suspend succeeded and both
485 * ignore_children of parent->power and irq_safe of dev->power are not set).
886486b7
AS
486 * If ->runtime_suspend failed with -EAGAIN or -EBUSY, and if the RPM_AUTO
487 * flag is set and the next autosuspend-delay expiration time is in the
488 * future, schedule another autosuspend attempt.
5e928f77
RW
489 *
490 * This function must be called under dev->power.lock with interrupts disabled.
491 */
140a6c94 492static int rpm_suspend(struct device *dev, int rpmflags)
5e928f77
RW
493 __releases(&dev->power.lock) __acquires(&dev->power.lock)
494{
71c63122 495 int (*callback)(struct device *);
5e928f77 496 struct device *parent = NULL;
1bfee5bc 497 int retval;
5e928f77 498
77893577 499 trace_rpm_suspend_rcuidle(dev, rpmflags);
5e928f77
RW
500
501 repeat:
1bfee5bc 502 retval = rpm_check_suspend_allowed(dev);
5e928f77 503
1bfee5bc
AS
504 if (retval < 0)
505 ; /* Conditions are wrong. */
506
507 /* Synchronous suspends are not allowed in the RPM_RESUMING state. */
508 else if (dev->power.runtime_status == RPM_RESUMING &&
509 !(rpmflags & RPM_ASYNC))
5e928f77 510 retval = -EAGAIN;
1bfee5bc 511 if (retval)
5e928f77 512 goto out;
5e928f77 513
15bcb91d
AS
514 /* If the autosuspend_delay time hasn't expired yet, reschedule. */
515 if ((rpmflags & RPM_AUTO)
516 && dev->power.runtime_status != RPM_SUSPENDING) {
517 unsigned long expires = pm_runtime_autosuspend_expiration(dev);
518
519 if (expires != 0) {
520 /* Pending requests need to be canceled. */
521 dev->power.request = RPM_REQ_NONE;
522
523 /*
524 * Optimization: If the timer is already running and is
525 * set to expire at or before the autosuspend delay,
526 * avoid the overhead of resetting it. Just let it
527 * expire; pm_suspend_timer_fn() will take care of the
528 * rest.
529 */
530 if (!(dev->power.timer_expires && time_before_eq(
531 dev->power.timer_expires, expires))) {
532 dev->power.timer_expires = expires;
533 mod_timer(&dev->power.suspend_timer, expires);
534 }
535 dev->power.timer_autosuspends = 1;
536 goto out;
537 }
538 }
539
5e928f77
RW
540 /* Other scheduled or pending requests need to be canceled. */
541 pm_runtime_cancel_pending(dev);
542
5e928f77
RW
543 if (dev->power.runtime_status == RPM_SUSPENDING) {
544 DEFINE_WAIT(wait);
545
1bfee5bc 546 if (rpmflags & (RPM_ASYNC | RPM_NOWAIT)) {
5e928f77
RW
547 retval = -EINPROGRESS;
548 goto out;
549 }
550
ad3c36a5
RW
551 if (dev->power.irq_safe) {
552 spin_unlock(&dev->power.lock);
553
554 cpu_relax();
555
556 spin_lock(&dev->power.lock);
557 goto repeat;
558 }
559
5e928f77
RW
560 /* Wait for the other suspend running in parallel with us. */
561 for (;;) {
562 prepare_to_wait(&dev->power.wait_queue, &wait,
563 TASK_UNINTERRUPTIBLE);
564 if (dev->power.runtime_status != RPM_SUSPENDING)
565 break;
566
567 spin_unlock_irq(&dev->power.lock);
568
569 schedule();
570
571 spin_lock_irq(&dev->power.lock);
572 }
573 finish_wait(&dev->power.wait_queue, &wait);
574 goto repeat;
575 }
576
7490e442
AS
577 if (dev->power.no_callbacks)
578 goto no_callback; /* Assume success. */
579
1bfee5bc
AS
580 /* Carry out an asynchronous or a synchronous suspend. */
581 if (rpmflags & RPM_ASYNC) {
15bcb91d
AS
582 dev->power.request = (rpmflags & RPM_AUTO) ?
583 RPM_REQ_AUTOSUSPEND : RPM_REQ_SUSPEND;
1bfee5bc
AS
584 if (!dev->power.request_pending) {
585 dev->power.request_pending = true;
586 queue_work(pm_wq, &dev->power.work);
587 }
588 goto out;
589 }
590
8d4b9d1b 591 __update_runtime_status(dev, RPM_SUSPENDING);
5e928f77 592
dbcd2d72 593 callback = RPM_GET_CALLBACK(dev, runtime_suspend);
35cd133c 594
bed57030 595 dev_pm_enable_wake_irq_check(dev, true);
71c63122 596 retval = rpm_callback(callback, dev);
00dc9ad1
RW
597 if (retval)
598 goto fail;
886486b7 599
7490e442 600 no_callback:
857b36c7
ML
601 __update_runtime_status(dev, RPM_SUSPENDED);
602 pm_runtime_deactivate_timer(dev);
5e928f77 603
857b36c7
ML
604 if (dev->parent) {
605 parent = dev->parent;
606 atomic_add_unless(&parent->power.child_count, -1, 0);
5e928f77
RW
607 }
608 wake_up_all(&dev->power.wait_queue);
609
610 if (dev->power.deferred_resume) {
58a34de7 611 dev->power.deferred_resume = false;
140a6c94 612 rpm_resume(dev, 0);
5e928f77
RW
613 retval = -EAGAIN;
614 goto out;
615 }
616
c3810c88 617 /* Maybe the parent is now able to suspend. */
c7b61de5 618 if (parent && !parent->power.ignore_children && !dev->power.irq_safe) {
c3810c88 619 spin_unlock(&dev->power.lock);
5e928f77 620
c3810c88
AS
621 spin_lock(&parent->power.lock);
622 rpm_idle(parent, RPM_ASYNC);
623 spin_unlock(&parent->power.lock);
5e928f77 624
c3810c88 625 spin_lock(&dev->power.lock);
5e928f77
RW
626 }
627
628 out:
77893577 629 trace_rpm_return_int_rcuidle(dev, _THIS_IP_, retval);
5e928f77
RW
630
631 return retval;
00dc9ad1
RW
632
633 fail:
bed57030 634 dev_pm_disable_wake_irq_check(dev);
00dc9ad1 635 __update_runtime_status(dev, RPM_ACTIVE);
00dc9ad1 636 dev->power.deferred_resume = false;
f2791d73
AS
637 wake_up_all(&dev->power.wait_queue);
638
00dc9ad1
RW
639 if (retval == -EAGAIN || retval == -EBUSY) {
640 dev->power.runtime_error = 0;
641
642 /*
643 * If the callback routine failed an autosuspend, and
644 * if the last_busy time has been updated so that there
645 * is a new autosuspend expiration time, automatically
646 * reschedule another autosuspend.
647 */
648 if ((rpmflags & RPM_AUTO) &&
649 pm_runtime_autosuspend_expiration(dev) != 0)
650 goto repeat;
651 } else {
652 pm_runtime_cancel_pending(dev);
653 }
00dc9ad1 654 goto out;
5e928f77
RW
655}
656
657/**
62052ab1 658 * rpm_resume - Carry out runtime resume of given device.
5e928f77 659 * @dev: Device to resume.
3f9af051 660 * @rpmflags: Flag bits.
5e928f77 661 *
62052ab1 662 * Check if the device's runtime PM status allows it to be resumed. Cancel
1bfee5bc 663 * any scheduled or pending requests. If another resume has been started
25985edc 664 * earlier, either return immediately or wait for it to finish, depending on the
1bfee5bc
AS
665 * RPM_NOWAIT and RPM_ASYNC flags. Similarly, if there's a suspend running in
666 * parallel with this function, either tell the other process to resume after
667 * suspending (deferred_resume) or wait for it to finish. If the RPM_ASYNC
668 * flag is set then queue a resume request; otherwise run the
669 * ->runtime_resume() callback directly. Queue an idle notification for the
670 * device if the resume succeeded.
5e928f77
RW
671 *
672 * This function must be called under dev->power.lock with interrupts disabled.
673 */
140a6c94 674static int rpm_resume(struct device *dev, int rpmflags)
5e928f77
RW
675 __releases(&dev->power.lock) __acquires(&dev->power.lock)
676{
71c63122 677 int (*callback)(struct device *);
5e928f77
RW
678 struct device *parent = NULL;
679 int retval = 0;
680
d44c950e 681 trace_rpm_resume_rcuidle(dev, rpmflags);
5e928f77
RW
682
683 repeat:
1bfee5bc 684 if (dev->power.runtime_error)
5e928f77 685 retval = -EINVAL;
6f3c77b0
KH
686 else if (dev->power.disable_depth == 1 && dev->power.is_suspended
687 && dev->power.runtime_status == RPM_ACTIVE)
688 retval = 1;
1bfee5bc 689 else if (dev->power.disable_depth > 0)
632e270e 690 retval = -EACCES;
1bfee5bc 691 if (retval)
5e928f77 692 goto out;
5e928f77 693
15bcb91d
AS
694 /*
695 * Other scheduled or pending requests need to be canceled. Small
696 * optimization: If an autosuspend timer is running, leave it running
697 * rather than cancelling it now only to restart it again in the near
698 * future.
699 */
700 dev->power.request = RPM_REQ_NONE;
701 if (!dev->power.timer_autosuspends)
702 pm_runtime_deactivate_timer(dev);
5e928f77 703
1bfee5bc 704 if (dev->power.runtime_status == RPM_ACTIVE) {
5e928f77 705 retval = 1;
5e928f77 706 goto out;
1bfee5bc 707 }
5e928f77
RW
708
709 if (dev->power.runtime_status == RPM_RESUMING
710 || dev->power.runtime_status == RPM_SUSPENDING) {
711 DEFINE_WAIT(wait);
712
1bfee5bc 713 if (rpmflags & (RPM_ASYNC | RPM_NOWAIT)) {
5e928f77
RW
714 if (dev->power.runtime_status == RPM_SUSPENDING)
715 dev->power.deferred_resume = true;
1bfee5bc
AS
716 else
717 retval = -EINPROGRESS;
5e928f77
RW
718 goto out;
719 }
720
ad3c36a5
RW
721 if (dev->power.irq_safe) {
722 spin_unlock(&dev->power.lock);
723
724 cpu_relax();
725
726 spin_lock(&dev->power.lock);
727 goto repeat;
728 }
729
5e928f77
RW
730 /* Wait for the operation carried out in parallel with us. */
731 for (;;) {
732 prepare_to_wait(&dev->power.wait_queue, &wait,
733 TASK_UNINTERRUPTIBLE);
734 if (dev->power.runtime_status != RPM_RESUMING
735 && dev->power.runtime_status != RPM_SUSPENDING)
736 break;
737
738 spin_unlock_irq(&dev->power.lock);
739
740 schedule();
741
742 spin_lock_irq(&dev->power.lock);
743 }
744 finish_wait(&dev->power.wait_queue, &wait);
745 goto repeat;
746 }
747
7490e442
AS
748 /*
749 * See if we can skip waking up the parent. This is safe only if
750 * power.no_callbacks is set, because otherwise we don't know whether
751 * the resume will actually succeed.
752 */
753 if (dev->power.no_callbacks && !parent && dev->parent) {
d63be5f9 754 spin_lock_nested(&dev->parent->power.lock, SINGLE_DEPTH_NESTING);
7490e442
AS
755 if (dev->parent->power.disable_depth > 0
756 || dev->parent->power.ignore_children
757 || dev->parent->power.runtime_status == RPM_ACTIVE) {
758 atomic_inc(&dev->parent->power.child_count);
759 spin_unlock(&dev->parent->power.lock);
7f321c26 760 retval = 1;
7490e442
AS
761 goto no_callback; /* Assume success. */
762 }
763 spin_unlock(&dev->parent->power.lock);
764 }
765
1bfee5bc
AS
766 /* Carry out an asynchronous or a synchronous resume. */
767 if (rpmflags & RPM_ASYNC) {
768 dev->power.request = RPM_REQ_RESUME;
769 if (!dev->power.request_pending) {
770 dev->power.request_pending = true;
771 queue_work(pm_wq, &dev->power.work);
772 }
773 retval = 0;
774 goto out;
775 }
776
5e928f77
RW
777 if (!parent && dev->parent) {
778 /*
c7b61de5
AS
779 * Increment the parent's usage counter and resume it if
780 * necessary. Not needed if dev is irq-safe; then the
781 * parent is permanently resumed.
5e928f77
RW
782 */
783 parent = dev->parent;
c7b61de5
AS
784 if (dev->power.irq_safe)
785 goto skip_parent;
862f89b3 786 spin_unlock(&dev->power.lock);
5e928f77
RW
787
788 pm_runtime_get_noresume(parent);
789
862f89b3 790 spin_lock(&parent->power.lock);
5e928f77 791 /*
216ef0b6
UH
792 * Resume the parent if it has runtime PM enabled and not been
793 * set to ignore its children.
5e928f77
RW
794 */
795 if (!parent->power.disable_depth
796 && !parent->power.ignore_children) {
140a6c94 797 rpm_resume(parent, 0);
5e928f77
RW
798 if (parent->power.runtime_status != RPM_ACTIVE)
799 retval = -EBUSY;
800 }
862f89b3 801 spin_unlock(&parent->power.lock);
5e928f77 802
862f89b3 803 spin_lock(&dev->power.lock);
5e928f77
RW
804 if (retval)
805 goto out;
806 goto repeat;
807 }
c7b61de5 808 skip_parent:
5e928f77 809
7490e442
AS
810 if (dev->power.no_callbacks)
811 goto no_callback; /* Assume success. */
812
8d4b9d1b 813 __update_runtime_status(dev, RPM_RESUMING);
5e928f77 814
dbcd2d72 815 callback = RPM_GET_CALLBACK(dev, runtime_resume);
35cd133c 816
bed57030 817 dev_pm_disable_wake_irq_check(dev);
71c63122 818 retval = rpm_callback(callback, dev);
5e928f77 819 if (retval) {
8d4b9d1b 820 __update_runtime_status(dev, RPM_SUSPENDED);
5e928f77 821 pm_runtime_cancel_pending(dev);
bed57030 822 dev_pm_enable_wake_irq_check(dev, false);
5e928f77 823 } else {
7490e442 824 no_callback:
8d4b9d1b 825 __update_runtime_status(dev, RPM_ACTIVE);
56f487c7 826 pm_runtime_mark_last_busy(dev);
5e928f77
RW
827 if (parent)
828 atomic_inc(&parent->power.child_count);
829 }
830 wake_up_all(&dev->power.wait_queue);
831
7f321c26 832 if (retval >= 0)
140a6c94 833 rpm_idle(dev, RPM_ASYNC);
5e928f77
RW
834
835 out:
c7b61de5 836 if (parent && !dev->power.irq_safe) {
5e928f77
RW
837 spin_unlock_irq(&dev->power.lock);
838
839 pm_runtime_put(parent);
840
841 spin_lock_irq(&dev->power.lock);
842 }
843
d44c950e 844 trace_rpm_return_int_rcuidle(dev, _THIS_IP_, retval);
5e928f77
RW
845
846 return retval;
847}
848
5e928f77 849/**
62052ab1 850 * pm_runtime_work - Universal runtime PM work function.
5e928f77
RW
851 * @work: Work structure used for scheduling the execution of this function.
852 *
853 * Use @work to get the device object the work is to be done for, determine what
62052ab1 854 * is to be done and execute the appropriate runtime PM function.
5e928f77
RW
855 */
856static void pm_runtime_work(struct work_struct *work)
857{
858 struct device *dev = container_of(work, struct device, power.work);
859 enum rpm_request req;
860
861 spin_lock_irq(&dev->power.lock);
862
863 if (!dev->power.request_pending)
864 goto out;
865
866 req = dev->power.request;
867 dev->power.request = RPM_REQ_NONE;
868 dev->power.request_pending = false;
869
870 switch (req) {
871 case RPM_REQ_NONE:
872 break;
873 case RPM_REQ_IDLE:
140a6c94 874 rpm_idle(dev, RPM_NOWAIT);
5e928f77
RW
875 break;
876 case RPM_REQ_SUSPEND:
140a6c94 877 rpm_suspend(dev, RPM_NOWAIT);
5e928f77 878 break;
15bcb91d
AS
879 case RPM_REQ_AUTOSUSPEND:
880 rpm_suspend(dev, RPM_NOWAIT | RPM_AUTO);
881 break;
5e928f77 882 case RPM_REQ_RESUME:
140a6c94 883 rpm_resume(dev, RPM_NOWAIT);
5e928f77
RW
884 break;
885 }
886
887 out:
888 spin_unlock_irq(&dev->power.lock);
889}
890
5e928f77
RW
891/**
892 * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
893 * @data: Device pointer passed by pm_schedule_suspend().
894 *
1bfee5bc 895 * Check if the time is right and queue a suspend request.
5e928f77
RW
896 */
897static void pm_suspend_timer_fn(unsigned long data)
898{
899 struct device *dev = (struct device *)data;
900 unsigned long flags;
901 unsigned long expires;
902
903 spin_lock_irqsave(&dev->power.lock, flags);
904
905 expires = dev->power.timer_expires;
906 /* If 'expire' is after 'jiffies' we've been called too early. */
907 if (expires > 0 && !time_after(expires, jiffies)) {
908 dev->power.timer_expires = 0;
15bcb91d
AS
909 rpm_suspend(dev, dev->power.timer_autosuspends ?
910 (RPM_ASYNC | RPM_AUTO) : RPM_ASYNC);
5e928f77
RW
911 }
912
913 spin_unlock_irqrestore(&dev->power.lock, flags);
914}
915
916/**
917 * pm_schedule_suspend - Set up a timer to submit a suspend request in future.
918 * @dev: Device to suspend.
919 * @delay: Time to wait before submitting a suspend request, in milliseconds.
920 */
921int pm_schedule_suspend(struct device *dev, unsigned int delay)
922{
923 unsigned long flags;
1bfee5bc 924 int retval;
5e928f77
RW
925
926 spin_lock_irqsave(&dev->power.lock, flags);
927
5e928f77 928 if (!delay) {
140a6c94 929 retval = rpm_suspend(dev, RPM_ASYNC);
5e928f77
RW
930 goto out;
931 }
932
1bfee5bc 933 retval = rpm_check_suspend_allowed(dev);
5e928f77
RW
934 if (retval)
935 goto out;
936
1bfee5bc
AS
937 /* Other scheduled or pending requests need to be canceled. */
938 pm_runtime_cancel_pending(dev);
939
5e928f77 940 dev->power.timer_expires = jiffies + msecs_to_jiffies(delay);
1bfee5bc 941 dev->power.timer_expires += !dev->power.timer_expires;
15bcb91d 942 dev->power.timer_autosuspends = 0;
5e928f77
RW
943 mod_timer(&dev->power.suspend_timer, dev->power.timer_expires);
944
945 out:
946 spin_unlock_irqrestore(&dev->power.lock, flags);
947
948 return retval;
949}
950EXPORT_SYMBOL_GPL(pm_schedule_suspend);
951
5e928f77 952/**
62052ab1 953 * __pm_runtime_idle - Entry point for runtime idle operations.
140a6c94
AS
954 * @dev: Device to send idle notification for.
955 * @rpmflags: Flag bits.
956 *
957 * If the RPM_GET_PUT flag is set, decrement the device's usage count and
958 * return immediately if it is larger than zero. Then carry out an idle
959 * notification, either synchronous or asynchronous.
960 *
311aab73
CC
961 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
962 * or if pm_runtime_irq_safe() has been called.
5e928f77 963 */
140a6c94 964int __pm_runtime_idle(struct device *dev, int rpmflags)
5e928f77
RW
965{
966 unsigned long flags;
967 int retval;
968
140a6c94
AS
969 if (rpmflags & RPM_GET_PUT) {
970 if (!atomic_dec_and_test(&dev->power.usage_count))
971 return 0;
972 }
973
a9306a63
RW
974 might_sleep_if(!(rpmflags & RPM_ASYNC) && !dev->power.irq_safe);
975
5e928f77 976 spin_lock_irqsave(&dev->power.lock, flags);
140a6c94 977 retval = rpm_idle(dev, rpmflags);
5e928f77
RW
978 spin_unlock_irqrestore(&dev->power.lock, flags);
979
980 return retval;
981}
140a6c94 982EXPORT_SYMBOL_GPL(__pm_runtime_idle);
5e928f77
RW
983
984/**
62052ab1 985 * __pm_runtime_suspend - Entry point for runtime put/suspend operations.
140a6c94 986 * @dev: Device to suspend.
3f9af051 987 * @rpmflags: Flag bits.
5e928f77 988 *
15bcb91d
AS
989 * If the RPM_GET_PUT flag is set, decrement the device's usage count and
990 * return immediately if it is larger than zero. Then carry out a suspend,
991 * either synchronous or asynchronous.
140a6c94 992 *
311aab73
CC
993 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
994 * or if pm_runtime_irq_safe() has been called.
5e928f77 995 */
140a6c94 996int __pm_runtime_suspend(struct device *dev, int rpmflags)
5e928f77 997{
140a6c94 998 unsigned long flags;
1d531c14 999 int retval;
5e928f77 1000
15bcb91d
AS
1001 if (rpmflags & RPM_GET_PUT) {
1002 if (!atomic_dec_and_test(&dev->power.usage_count))
1003 return 0;
1004 }
1005
a9306a63
RW
1006 might_sleep_if(!(rpmflags & RPM_ASYNC) && !dev->power.irq_safe);
1007
140a6c94
AS
1008 spin_lock_irqsave(&dev->power.lock, flags);
1009 retval = rpm_suspend(dev, rpmflags);
1010 spin_unlock_irqrestore(&dev->power.lock, flags);
5e928f77
RW
1011
1012 return retval;
1013}
140a6c94 1014EXPORT_SYMBOL_GPL(__pm_runtime_suspend);
5e928f77
RW
1015
1016/**
62052ab1 1017 * __pm_runtime_resume - Entry point for runtime resume operations.
140a6c94 1018 * @dev: Device to resume.
3f9af051 1019 * @rpmflags: Flag bits.
5e928f77 1020 *
140a6c94
AS
1021 * If the RPM_GET_PUT flag is set, increment the device's usage count. Then
1022 * carry out a resume, either synchronous or asynchronous.
1023 *
311aab73
CC
1024 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
1025 * or if pm_runtime_irq_safe() has been called.
5e928f77 1026 */
140a6c94 1027int __pm_runtime_resume(struct device *dev, int rpmflags)
5e928f77 1028{
140a6c94
AS
1029 unsigned long flags;
1030 int retval;
5e928f77 1031
a9306a63
RW
1032 might_sleep_if(!(rpmflags & RPM_ASYNC) && !dev->power.irq_safe &&
1033 dev->power.runtime_status != RPM_ACTIVE);
311aab73 1034
140a6c94
AS
1035 if (rpmflags & RPM_GET_PUT)
1036 atomic_inc(&dev->power.usage_count);
1037
1038 spin_lock_irqsave(&dev->power.lock, flags);
1039 retval = rpm_resume(dev, rpmflags);
1040 spin_unlock_irqrestore(&dev->power.lock, flags);
5e928f77
RW
1041
1042 return retval;
1043}
140a6c94 1044EXPORT_SYMBOL_GPL(__pm_runtime_resume);
5e928f77 1045
a436b6a1
RW
1046/**
1047 * pm_runtime_get_if_in_use - Conditionally bump up the device's usage counter.
1048 * @dev: Device to handle.
1049 *
1050 * Return -EINVAL if runtime PM is disabled for the device.
1051 *
1052 * If that's not the case and if the device's runtime PM status is RPM_ACTIVE
1053 * and the runtime PM usage counter is nonzero, increment the counter and
1054 * return 1. Otherwise return 0 without changing the counter.
1055 */
1056int pm_runtime_get_if_in_use(struct device *dev)
1057{
1058 unsigned long flags;
1059 int retval;
1060
1061 spin_lock_irqsave(&dev->power.lock, flags);
1062 retval = dev->power.disable_depth > 0 ? -EINVAL :
1063 dev->power.runtime_status == RPM_ACTIVE
1064 && atomic_inc_not_zero(&dev->power.usage_count);
1065 spin_unlock_irqrestore(&dev->power.lock, flags);
1066 return retval;
1067}
1068EXPORT_SYMBOL_GPL(pm_runtime_get_if_in_use);
1069
5e928f77 1070/**
62052ab1 1071 * __pm_runtime_set_status - Set runtime PM status of a device.
5e928f77 1072 * @dev: Device to handle.
62052ab1 1073 * @status: New runtime PM status of the device.
5e928f77 1074 *
62052ab1 1075 * If runtime PM of the device is disabled or its power.runtime_error field is
5e928f77
RW
1076 * different from zero, the status may be changed either to RPM_ACTIVE, or to
1077 * RPM_SUSPENDED, as long as that reflects the actual state of the device.
1078 * However, if the device has a parent and the parent is not active, and the
1079 * parent's power.ignore_children flag is unset, the device's status cannot be
1080 * set to RPM_ACTIVE, so -EBUSY is returned in that case.
1081 *
1082 * If successful, __pm_runtime_set_status() clears the power.runtime_error field
1083 * and the device parent's counter of unsuspended children is modified to
1084 * reflect the new status. If the new status is RPM_SUSPENDED, an idle
1085 * notification request for the parent is submitted.
1086 */
1087int __pm_runtime_set_status(struct device *dev, unsigned int status)
1088{
1089 struct device *parent = dev->parent;
1090 unsigned long flags;
1091 bool notify_parent = false;
1092 int error = 0;
1093
1094 if (status != RPM_ACTIVE && status != RPM_SUSPENDED)
1095 return -EINVAL;
1096
1097 spin_lock_irqsave(&dev->power.lock, flags);
1098
1099 if (!dev->power.runtime_error && !dev->power.disable_depth) {
1100 error = -EAGAIN;
1101 goto out;
1102 }
1103
1104 if (dev->power.runtime_status == status)
1105 goto out_set;
1106
1107 if (status == RPM_SUSPENDED) {
a8636c89
UH
1108 /*
1109 * It is invalid to suspend a device with an active child,
1110 * unless it has been set to ignore its children.
1111 */
1112 if (!dev->power.ignore_children &&
1113 atomic_read(&dev->power.child_count)) {
1114 dev_err(dev, "runtime PM trying to suspend device but active child\n");
1115 error = -EBUSY;
1116 goto out;
1117 }
1118
5e928f77
RW
1119 if (parent) {
1120 atomic_add_unless(&parent->power.child_count, -1, 0);
1121 notify_parent = !parent->power.ignore_children;
1122 }
1123 goto out_set;
1124 }
1125
1126 if (parent) {
bab636b9 1127 spin_lock_nested(&parent->power.lock, SINGLE_DEPTH_NESTING);
5e928f77
RW
1128
1129 /*
1130 * It is invalid to put an active child under a parent that is
62052ab1 1131 * not active, has runtime PM enabled and the
5e928f77
RW
1132 * 'power.ignore_children' flag unset.
1133 */
1134 if (!parent->power.disable_depth
1135 && !parent->power.ignore_children
71723f95
LW
1136 && parent->power.runtime_status != RPM_ACTIVE) {
1137 dev_err(dev, "runtime PM trying to activate child device %s but parent (%s) is not active\n",
1138 dev_name(dev),
1139 dev_name(parent));
5e928f77 1140 error = -EBUSY;
71723f95 1141 } else if (dev->power.runtime_status == RPM_SUSPENDED) {
965c4ac0 1142 atomic_inc(&parent->power.child_count);
71723f95 1143 }
5e928f77 1144
862f89b3 1145 spin_unlock(&parent->power.lock);
5e928f77
RW
1146
1147 if (error)
1148 goto out;
1149 }
1150
1151 out_set:
8d4b9d1b 1152 __update_runtime_status(dev, status);
5e928f77
RW
1153 dev->power.runtime_error = 0;
1154 out:
1155 spin_unlock_irqrestore(&dev->power.lock, flags);
1156
1157 if (notify_parent)
1158 pm_request_idle(parent);
1159
1160 return error;
1161}
1162EXPORT_SYMBOL_GPL(__pm_runtime_set_status);
1163
1164/**
1165 * __pm_runtime_barrier - Cancel pending requests and wait for completions.
1166 * @dev: Device to handle.
1167 *
1168 * Flush all pending requests for the device from pm_wq and wait for all
62052ab1 1169 * runtime PM operations involving the device in progress to complete.
5e928f77
RW
1170 *
1171 * Should be called under dev->power.lock with interrupts disabled.
1172 */
1173static void __pm_runtime_barrier(struct device *dev)
1174{
1175 pm_runtime_deactivate_timer(dev);
1176
1177 if (dev->power.request_pending) {
1178 dev->power.request = RPM_REQ_NONE;
1179 spin_unlock_irq(&dev->power.lock);
1180
1181 cancel_work_sync(&dev->power.work);
1182
1183 spin_lock_irq(&dev->power.lock);
1184 dev->power.request_pending = false;
1185 }
1186
1187 if (dev->power.runtime_status == RPM_SUSPENDING
1188 || dev->power.runtime_status == RPM_RESUMING
1189 || dev->power.idle_notification) {
1190 DEFINE_WAIT(wait);
1191
1192 /* Suspend, wake-up or idle notification in progress. */
1193 for (;;) {
1194 prepare_to_wait(&dev->power.wait_queue, &wait,
1195 TASK_UNINTERRUPTIBLE);
1196 if (dev->power.runtime_status != RPM_SUSPENDING
1197 && dev->power.runtime_status != RPM_RESUMING
1198 && !dev->power.idle_notification)
1199 break;
1200 spin_unlock_irq(&dev->power.lock);
1201
1202 schedule();
1203
1204 spin_lock_irq(&dev->power.lock);
1205 }
1206 finish_wait(&dev->power.wait_queue, &wait);
1207 }
1208}
1209
1210/**
1211 * pm_runtime_barrier - Flush pending requests and wait for completions.
1212 * @dev: Device to handle.
1213 *
1214 * Prevent the device from being suspended by incrementing its usage counter and
1215 * if there's a pending resume request for the device, wake the device up.
1216 * Next, make sure that all pending requests for the device have been flushed
62052ab1 1217 * from pm_wq and wait for all runtime PM operations involving the device in
5e928f77
RW
1218 * progress to complete.
1219 *
1220 * Return value:
1221 * 1, if there was a resume request pending and the device had to be woken up,
1222 * 0, otherwise
1223 */
1224int pm_runtime_barrier(struct device *dev)
1225{
1226 int retval = 0;
1227
1228 pm_runtime_get_noresume(dev);
1229 spin_lock_irq(&dev->power.lock);
1230
1231 if (dev->power.request_pending
1232 && dev->power.request == RPM_REQ_RESUME) {
140a6c94 1233 rpm_resume(dev, 0);
5e928f77
RW
1234 retval = 1;
1235 }
1236
1237 __pm_runtime_barrier(dev);
1238
1239 spin_unlock_irq(&dev->power.lock);
1240 pm_runtime_put_noidle(dev);
1241
1242 return retval;
1243}
1244EXPORT_SYMBOL_GPL(pm_runtime_barrier);
1245
1246/**
62052ab1 1247 * __pm_runtime_disable - Disable runtime PM of a device.
5e928f77
RW
1248 * @dev: Device to handle.
1249 * @check_resume: If set, check if there's a resume request for the device.
1250 *
7b60894f 1251 * Increment power.disable_depth for the device and if it was zero previously,
62052ab1 1252 * cancel all pending runtime PM requests for the device and wait for all
5e928f77 1253 * operations in progress to complete. The device can be either active or
62052ab1 1254 * suspended after its runtime PM has been disabled.
5e928f77
RW
1255 *
1256 * If @check_resume is set and there's a resume request pending when
1257 * __pm_runtime_disable() is called and power.disable_depth is zero, the
62052ab1 1258 * function will wake up the device before disabling its runtime PM.
5e928f77
RW
1259 */
1260void __pm_runtime_disable(struct device *dev, bool check_resume)
1261{
1262 spin_lock_irq(&dev->power.lock);
1263
1264 if (dev->power.disable_depth > 0) {
1265 dev->power.disable_depth++;
1266 goto out;
1267 }
1268
1269 /*
1270 * Wake up the device if there's a resume request pending, because that
62052ab1 1271 * means there probably is some I/O to process and disabling runtime PM
5e928f77
RW
1272 * shouldn't prevent the device from processing the I/O.
1273 */
1274 if (check_resume && dev->power.request_pending
1275 && dev->power.request == RPM_REQ_RESUME) {
1276 /*
1277 * Prevent suspends and idle notifications from being carried
1278 * out after we have woken up the device.
1279 */
1280 pm_runtime_get_noresume(dev);
1281
140a6c94 1282 rpm_resume(dev, 0);
5e928f77
RW
1283
1284 pm_runtime_put_noidle(dev);
1285 }
1286
1287 if (!dev->power.disable_depth++)
1288 __pm_runtime_barrier(dev);
1289
1290 out:
1291 spin_unlock_irq(&dev->power.lock);
1292}
1293EXPORT_SYMBOL_GPL(__pm_runtime_disable);
1294
1295/**
62052ab1 1296 * pm_runtime_enable - Enable runtime PM of a device.
5e928f77
RW
1297 * @dev: Device to handle.
1298 */
1299void pm_runtime_enable(struct device *dev)
1300{
1301 unsigned long flags;
1302
1303 spin_lock_irqsave(&dev->power.lock, flags);
1304
1305 if (dev->power.disable_depth > 0)
1306 dev->power.disable_depth--;
1307 else
1308 dev_warn(dev, "Unbalanced %s!\n", __func__);
1309
1310 spin_unlock_irqrestore(&dev->power.lock, flags);
1311}
1312EXPORT_SYMBOL_GPL(pm_runtime_enable);
1313
53823639 1314/**
62052ab1 1315 * pm_runtime_forbid - Block runtime PM of a device.
53823639
RW
1316 * @dev: Device to handle.
1317 *
1318 * Increase the device's usage count and clear its power.runtime_auto flag,
1319 * so that it cannot be suspended at run time until pm_runtime_allow() is called
1320 * for it.
1321 */
1322void pm_runtime_forbid(struct device *dev)
1323{
1324 spin_lock_irq(&dev->power.lock);
1325 if (!dev->power.runtime_auto)
1326 goto out;
1327
1328 dev->power.runtime_auto = false;
1329 atomic_inc(&dev->power.usage_count);
140a6c94 1330 rpm_resume(dev, 0);
53823639
RW
1331
1332 out:
1333 spin_unlock_irq(&dev->power.lock);
1334}
1335EXPORT_SYMBOL_GPL(pm_runtime_forbid);
1336
1337/**
62052ab1 1338 * pm_runtime_allow - Unblock runtime PM of a device.
53823639
RW
1339 * @dev: Device to handle.
1340 *
1341 * Decrease the device's usage count and set its power.runtime_auto flag.
1342 */
1343void pm_runtime_allow(struct device *dev)
1344{
1345 spin_lock_irq(&dev->power.lock);
1346 if (dev->power.runtime_auto)
1347 goto out;
1348
1349 dev->power.runtime_auto = true;
1350 if (atomic_dec_and_test(&dev->power.usage_count))
fe7450b0 1351 rpm_idle(dev, RPM_AUTO | RPM_ASYNC);
53823639
RW
1352
1353 out:
1354 spin_unlock_irq(&dev->power.lock);
1355}
1356EXPORT_SYMBOL_GPL(pm_runtime_allow);
1357
7490e442 1358/**
62052ab1 1359 * pm_runtime_no_callbacks - Ignore runtime PM callbacks for a device.
7490e442
AS
1360 * @dev: Device to handle.
1361 *
1362 * Set the power.no_callbacks flag, which tells the PM core that this
62052ab1
RW
1363 * device is power-managed through its parent and has no runtime PM
1364 * callbacks of its own. The runtime sysfs attributes will be removed.
7490e442
AS
1365 */
1366void pm_runtime_no_callbacks(struct device *dev)
1367{
1368 spin_lock_irq(&dev->power.lock);
1369 dev->power.no_callbacks = 1;
1370 spin_unlock_irq(&dev->power.lock);
1371 if (device_is_registered(dev))
1372 rpm_sysfs_remove(dev);
1373}
1374EXPORT_SYMBOL_GPL(pm_runtime_no_callbacks);
1375
c7b61de5
AS
1376/**
1377 * pm_runtime_irq_safe - Leave interrupts disabled during callbacks.
1378 * @dev: Device to handle
1379 *
1380 * Set the power.irq_safe flag, which tells the PM core that the
1381 * ->runtime_suspend() and ->runtime_resume() callbacks for this device should
1382 * always be invoked with the spinlock held and interrupts disabled. It also
1383 * causes the parent's usage counter to be permanently incremented, preventing
1384 * the parent from runtime suspending -- otherwise an irq-safe child might have
1385 * to wait for a non-irq-safe parent.
1386 */
1387void pm_runtime_irq_safe(struct device *dev)
1388{
1389 if (dev->parent)
1390 pm_runtime_get_sync(dev->parent);
1391 spin_lock_irq(&dev->power.lock);
1392 dev->power.irq_safe = 1;
1393 spin_unlock_irq(&dev->power.lock);
1394}
1395EXPORT_SYMBOL_GPL(pm_runtime_irq_safe);
1396
15bcb91d
AS
1397/**
1398 * update_autosuspend - Handle a change to a device's autosuspend settings.
1399 * @dev: Device to handle.
1400 * @old_delay: The former autosuspend_delay value.
1401 * @old_use: The former use_autosuspend value.
1402 *
1403 * Prevent runtime suspend if the new delay is negative and use_autosuspend is
1404 * set; otherwise allow it. Send an idle notification if suspends are allowed.
1405 *
1406 * This function must be called under dev->power.lock with interrupts disabled.
1407 */
1408static void update_autosuspend(struct device *dev, int old_delay, int old_use)
1409{
1410 int delay = dev->power.autosuspend_delay;
1411
1412 /* Should runtime suspend be prevented now? */
1413 if (dev->power.use_autosuspend && delay < 0) {
1414
1415 /* If it used to be allowed then prevent it. */
1416 if (!old_use || old_delay >= 0) {
1417 atomic_inc(&dev->power.usage_count);
1418 rpm_resume(dev, 0);
1419 }
1420 }
1421
1422 /* Runtime suspend should be allowed now. */
1423 else {
1424
1425 /* If it used to be prevented then allow it. */
1426 if (old_use && old_delay < 0)
1427 atomic_dec(&dev->power.usage_count);
1428
1429 /* Maybe we can autosuspend now. */
1430 rpm_idle(dev, RPM_AUTO);
1431 }
1432}
1433
1434/**
1435 * pm_runtime_set_autosuspend_delay - Set a device's autosuspend_delay value.
1436 * @dev: Device to handle.
1437 * @delay: Value of the new delay in milliseconds.
1438 *
1439 * Set the device's power.autosuspend_delay value. If it changes to negative
62052ab1
RW
1440 * and the power.use_autosuspend flag is set, prevent runtime suspends. If it
1441 * changes the other way, allow runtime suspends.
15bcb91d
AS
1442 */
1443void pm_runtime_set_autosuspend_delay(struct device *dev, int delay)
1444{
1445 int old_delay, old_use;
1446
1447 spin_lock_irq(&dev->power.lock);
1448 old_delay = dev->power.autosuspend_delay;
1449 old_use = dev->power.use_autosuspend;
1450 dev->power.autosuspend_delay = delay;
1451 update_autosuspend(dev, old_delay, old_use);
1452 spin_unlock_irq(&dev->power.lock);
1453}
1454EXPORT_SYMBOL_GPL(pm_runtime_set_autosuspend_delay);
1455
1456/**
1457 * __pm_runtime_use_autosuspend - Set a device's use_autosuspend flag.
1458 * @dev: Device to handle.
1459 * @use: New value for use_autosuspend.
1460 *
62052ab1 1461 * Set the device's power.use_autosuspend flag, and allow or prevent runtime
15bcb91d
AS
1462 * suspends as needed.
1463 */
1464void __pm_runtime_use_autosuspend(struct device *dev, bool use)
1465{
1466 int old_delay, old_use;
1467
1468 spin_lock_irq(&dev->power.lock);
1469 old_delay = dev->power.autosuspend_delay;
1470 old_use = dev->power.use_autosuspend;
1471 dev->power.use_autosuspend = use;
1472 update_autosuspend(dev, old_delay, old_use);
1473 spin_unlock_irq(&dev->power.lock);
1474}
1475EXPORT_SYMBOL_GPL(__pm_runtime_use_autosuspend);
1476
5e928f77 1477/**
62052ab1 1478 * pm_runtime_init - Initialize runtime PM fields in given device object.
5e928f77
RW
1479 * @dev: Device object to initialize.
1480 */
1481void pm_runtime_init(struct device *dev)
1482{
5e928f77
RW
1483 dev->power.runtime_status = RPM_SUSPENDED;
1484 dev->power.idle_notification = false;
1485
1486 dev->power.disable_depth = 1;
1487 atomic_set(&dev->power.usage_count, 0);
1488
1489 dev->power.runtime_error = 0;
1490
1491 atomic_set(&dev->power.child_count, 0);
1492 pm_suspend_ignore_children(dev, false);
53823639 1493 dev->power.runtime_auto = true;
5e928f77
RW
1494
1495 dev->power.request_pending = false;
1496 dev->power.request = RPM_REQ_NONE;
1497 dev->power.deferred_resume = false;
8d4b9d1b 1498 dev->power.accounting_timestamp = jiffies;
5e928f77
RW
1499 INIT_WORK(&dev->power.work, pm_runtime_work);
1500
1501 dev->power.timer_expires = 0;
1502 setup_timer(&dev->power.suspend_timer, pm_suspend_timer_fn,
1503 (unsigned long)dev);
1504
1505 init_waitqueue_head(&dev->power.wait_queue);
1506}
1507
5de85b9d
UH
1508/**
1509 * pm_runtime_reinit - Re-initialize runtime PM fields in given device object.
1510 * @dev: Device object to re-initialize.
1511 */
1512void pm_runtime_reinit(struct device *dev)
1513{
1514 if (!pm_runtime_enabled(dev)) {
1515 if (dev->power.runtime_status == RPM_ACTIVE)
1516 pm_runtime_set_suspended(dev);
1517 if (dev->power.irq_safe) {
1518 spin_lock_irq(&dev->power.lock);
1519 dev->power.irq_safe = 0;
1520 spin_unlock_irq(&dev->power.lock);
1521 if (dev->parent)
1522 pm_runtime_put(dev->parent);
1523 }
1524 }
1525}
1526
5e928f77
RW
1527/**
1528 * pm_runtime_remove - Prepare for removing a device from device hierarchy.
1529 * @dev: Device object being removed from device hierarchy.
1530 */
1531void pm_runtime_remove(struct device *dev)
1532{
1533 __pm_runtime_disable(dev, false);
5de85b9d 1534 pm_runtime_reinit(dev);
5e928f77 1535}
37f20416 1536
21d5c57b
RW
1537/**
1538 * pm_runtime_clean_up_links - Prepare links to consumers for driver removal.
1539 * @dev: Device whose driver is going to be removed.
1540 *
1541 * Check links from this device to any consumers and if any of them have active
1542 * runtime PM references to the device, drop the usage counter of the device
1543 * (once per link).
1544 *
1545 * Links with the DL_FLAG_STATELESS flag set are ignored.
1546 *
1547 * Since the device is guaranteed to be runtime-active at the point this is
1548 * called, nothing else needs to be done here.
1549 *
1550 * Moreover, this is called after device_links_busy() has returned 'false', so
1551 * the status of each link is guaranteed to be DL_STATE_SUPPLIER_UNBIND and
1552 * therefore rpm_active can't be manipulated concurrently.
1553 */
1554void pm_runtime_clean_up_links(struct device *dev)
1555{
1556 struct device_link *link;
1557 int idx;
1558
1559 idx = device_links_read_lock();
1560
1561 list_for_each_entry_rcu(link, &dev->links.consumers, s_node) {
1562 if (link->flags & DL_FLAG_STATELESS)
1563 continue;
1564
1565 if (link->rpm_active) {
1566 pm_runtime_put_noidle(dev);
1567 link->rpm_active = false;
1568 }
1569 }
1570
1571 device_links_read_unlock(idx);
1572}
1573
1574/**
1575 * pm_runtime_get_suppliers - Resume and reference-count supplier devices.
1576 * @dev: Consumer device.
1577 */
1578void pm_runtime_get_suppliers(struct device *dev)
1579{
1580 struct device_link *link;
1581 int idx;
1582
1583 idx = device_links_read_lock();
1584
1585 list_for_each_entry_rcu(link, &dev->links.suppliers, c_node)
1586 if (link->flags & DL_FLAG_PM_RUNTIME)
1587 pm_runtime_get_sync(link->supplier);
1588
1589 device_links_read_unlock(idx);
1590}
1591
1592/**
1593 * pm_runtime_put_suppliers - Drop references to supplier devices.
1594 * @dev: Consumer device.
1595 */
1596void pm_runtime_put_suppliers(struct device *dev)
1597{
1598 struct device_link *link;
1599 int idx;
1600
1601 idx = device_links_read_lock();
1602
1603 list_for_each_entry_rcu(link, &dev->links.suppliers, c_node)
1604 if (link->flags & DL_FLAG_PM_RUNTIME)
1605 pm_runtime_put(link->supplier);
1606
1607 device_links_read_unlock(idx);
1608}
1609
baa8809f
RW
1610void pm_runtime_new_link(struct device *dev)
1611{
1612 spin_lock_irq(&dev->power.lock);
1613 dev->power.links_count++;
1614 spin_unlock_irq(&dev->power.lock);
1615}
1616
1617void pm_runtime_drop_link(struct device *dev)
1618{
1619 spin_lock_irq(&dev->power.lock);
1620 WARN_ON(dev->power.links_count == 0);
1621 dev->power.links_count--;
1622 spin_unlock_irq(&dev->power.lock);
1623}
1624
37f20416
UH
1625/**
1626 * pm_runtime_force_suspend - Force a device into suspend state if needed.
1627 * @dev: Device to suspend.
1628 *
1629 * Disable runtime PM so we safely can check the device's runtime PM status and
1630 * if it is active, invoke it's .runtime_suspend callback to bring it into
1631 * suspend state. Keep runtime PM disabled to preserve the state unless we
1632 * encounter errors.
1633 *
1634 * Typically this function may be invoked from a system suspend callback to make
1635 * sure the device is put into low power state.
1636 */
1637int pm_runtime_force_suspend(struct device *dev)
1638{
1639 int (*callback)(struct device *);
1640 int ret = 0;
1641
1642 pm_runtime_disable(dev);
37f20416
UH
1643 if (pm_runtime_status_suspended(dev))
1644 return 0;
1645
dbcd2d72 1646 callback = RPM_GET_CALLBACK(dev, runtime_suspend);
37f20416
UH
1647
1648 if (!callback) {
1649 ret = -ENOSYS;
1650 goto err;
1651 }
1652
1653 ret = callback(dev);
1654 if (ret)
1655 goto err;
1656
1d9174fb
UH
1657 /*
1658 * Increase the runtime PM usage count for the device's parent, in case
1659 * when we find the device being used when system suspend was invoked.
1660 * This informs pm_runtime_force_resume() to resume the parent
1661 * immediately, which is needed to be able to resume its children,
1662 * when not deferring the resume to be managed via runtime PM.
1663 */
1664 if (dev->parent && atomic_read(&dev->power.usage_count) > 1)
1665 pm_runtime_get_noresume(dev->parent);
1666
37f20416
UH
1667 pm_runtime_set_suspended(dev);
1668 return 0;
1669err:
1670 pm_runtime_enable(dev);
1671 return ret;
1672}
1673EXPORT_SYMBOL_GPL(pm_runtime_force_suspend);
1674
1675/**
1d9174fb 1676 * pm_runtime_force_resume - Force a device into resume state if needed.
37f20416
UH
1677 * @dev: Device to resume.
1678 *
1679 * Prior invoking this function we expect the user to have brought the device
1680 * into low power state by a call to pm_runtime_force_suspend(). Here we reverse
1d9174fb
UH
1681 * those actions and brings the device into full power, if it is expected to be
1682 * used on system resume. To distinguish that, we check whether the runtime PM
1683 * usage count is greater than 1 (the PM core increases the usage count in the
1684 * system PM prepare phase), as that indicates a real user (such as a subsystem,
1685 * driver, userspace, etc.) is using it. If that is the case, the device is
1686 * expected to be used on system resume as well, so then we resume it. In the
1687 * other case, we defer the resume to be managed via runtime PM.
37f20416 1688 *
1d9174fb 1689 * Typically this function may be invoked from a system resume callback.
37f20416
UH
1690 */
1691int pm_runtime_force_resume(struct device *dev)
1692{
1693 int (*callback)(struct device *);
1694 int ret = 0;
1695
dbcd2d72 1696 callback = RPM_GET_CALLBACK(dev, runtime_resume);
37f20416
UH
1697
1698 if (!callback) {
1699 ret = -ENOSYS;
1700 goto out;
1701 }
1702
9f5b5274
UH
1703 if (!pm_runtime_status_suspended(dev))
1704 goto out;
1705
1d9174fb
UH
1706 /*
1707 * Decrease the parent's runtime PM usage count, if we increased it
1708 * during system suspend in pm_runtime_force_suspend().
1709 */
1710 if (atomic_read(&dev->power.usage_count) > 1) {
1711 if (dev->parent)
1712 pm_runtime_put_noidle(dev->parent);
1713 } else {
1714 goto out;
1715 }
1716
0ae3aeef 1717 ret = pm_runtime_set_active(dev);
37f20416
UH
1718 if (ret)
1719 goto out;
1720
0ae3aeef
UH
1721 ret = callback(dev);
1722 if (ret) {
1723 pm_runtime_set_suspended(dev);
1724 goto out;
1725 }
1726
37f20416
UH
1727 pm_runtime_mark_last_busy(dev);
1728out:
1729 pm_runtime_enable(dev);
1730 return ret;
1731}
1732EXPORT_SYMBOL_GPL(pm_runtime_force_resume);