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