2 * drivers/base/power/runtime.c - Helper functions for device runtime PM
4 * Copyright (c) 2009 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
5 * Copyright (C) 2010 Alan Stern <stern@rowland.harvard.edu>
7 * This file is released under the GPLv2.
10 #include <linux/sched.h>
11 #include <linux/export.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/pm_wakeirq.h>
14 #include <trace/events/rpm.h>
17 typedef int (*pm_callback_t
)(struct device
*);
19 static pm_callback_t
__rpm_get_callback(struct device
*dev
, size_t cb_offset
)
22 const struct dev_pm_ops
*ops
;
25 ops
= &dev
->pm_domain
->ops
;
26 else if (dev
->type
&& dev
->type
->pm
)
28 else if (dev
->class && dev
->class->pm
)
30 else if (dev
->bus
&& dev
->bus
->pm
)
36 cb
= *(pm_callback_t
*)((void *)ops
+ cb_offset
);
40 if (!cb
&& dev
->driver
&& dev
->driver
->pm
)
41 cb
= *(pm_callback_t
*)((void *)dev
->driver
->pm
+ cb_offset
);
46 #define RPM_GET_CALLBACK(dev, callback) \
47 __rpm_get_callback(dev, offsetof(struct dev_pm_ops, callback))
49 static int rpm_resume(struct device
*dev
, int rpmflags
);
50 static int rpm_suspend(struct device
*dev
, int rpmflags
);
53 * update_pm_runtime_accounting - Update the time accounting of power states
54 * @dev: Device to update the accounting for
56 * In order to be able to have time accounting of the various power states
57 * (as used by programs such as PowerTOP to show the effectiveness of runtime
58 * PM), we need to track the time spent in each state.
59 * update_pm_runtime_accounting must be called each time before the
60 * runtime_status field is updated, to account the time in the old state
63 void update_pm_runtime_accounting(struct device
*dev
)
65 unsigned long now
= jiffies
;
68 delta
= now
- dev
->power
.accounting_timestamp
;
70 dev
->power
.accounting_timestamp
= now
;
72 if (dev
->power
.disable_depth
> 0)
75 if (dev
->power
.runtime_status
== RPM_SUSPENDED
)
76 dev
->power
.suspended_jiffies
+= delta
;
78 dev
->power
.active_jiffies
+= delta
;
81 static void __update_runtime_status(struct device
*dev
, enum rpm_status status
)
83 update_pm_runtime_accounting(dev
);
84 dev
->power
.runtime_status
= status
;
88 * pm_runtime_deactivate_timer - Deactivate given device's suspend timer.
89 * @dev: Device to handle.
91 static void pm_runtime_deactivate_timer(struct device
*dev
)
93 if (dev
->power
.timer_expires
> 0) {
94 del_timer(&dev
->power
.suspend_timer
);
95 dev
->power
.timer_expires
= 0;
100 * pm_runtime_cancel_pending - Deactivate suspend timer and cancel requests.
101 * @dev: Device to handle.
103 static void pm_runtime_cancel_pending(struct device
*dev
)
105 pm_runtime_deactivate_timer(dev
);
107 * In case there's a request pending, make sure its work function will
108 * return without doing anything.
110 dev
->power
.request
= RPM_REQ_NONE
;
114 * pm_runtime_autosuspend_expiration - Get a device's autosuspend-delay expiration time.
115 * @dev: Device to handle.
117 * Compute the autosuspend-delay expiration time based on the device's
118 * power.last_busy time. If the delay has already expired or is disabled
119 * (negative) or the power.use_autosuspend flag isn't set, return 0.
120 * Otherwise return the expiration time in jiffies (adjusted to be nonzero).
122 * This function may be called either with or without dev->power.lock held.
123 * Either way it can be racy, since power.last_busy may be updated at any time.
125 unsigned long pm_runtime_autosuspend_expiration(struct device
*dev
)
127 int autosuspend_delay
;
129 unsigned long last_busy
;
130 unsigned long expires
= 0;
132 if (!dev
->power
.use_autosuspend
)
135 autosuspend_delay
= ACCESS_ONCE(dev
->power
.autosuspend_delay
);
136 if (autosuspend_delay
< 0)
139 last_busy
= ACCESS_ONCE(dev
->power
.last_busy
);
140 elapsed
= jiffies
- last_busy
;
142 goto out
; /* jiffies has wrapped around. */
145 * If the autosuspend_delay is >= 1 second, align the timer by rounding
146 * up to the nearest second.
148 expires
= last_busy
+ msecs_to_jiffies(autosuspend_delay
);
149 if (autosuspend_delay
>= 1000)
150 expires
= round_jiffies(expires
);
152 if (elapsed
>= expires
- last_busy
)
153 expires
= 0; /* Already expired. */
158 EXPORT_SYMBOL_GPL(pm_runtime_autosuspend_expiration
);
160 static int dev_memalloc_noio(struct device
*dev
, void *data
)
162 return dev
->power
.memalloc_noio
;
166 * pm_runtime_set_memalloc_noio - Set a device's memalloc_noio flag.
167 * @dev: Device to handle.
168 * @enable: True for setting the flag and False for clearing the flag.
170 * Set the flag for all devices in the path from the device to the
171 * root device in the device tree if @enable is true, otherwise clear
172 * the flag for devices in the path whose siblings don't set the flag.
174 * The function should only be called by block device, or network
175 * device driver for solving the deadlock problem during runtime
178 * If memory allocation with GFP_KERNEL is called inside runtime
179 * resume/suspend callback of any one of its ancestors(or the
180 * block device itself), the deadlock may be triggered inside the
181 * memory allocation since it might not complete until the block
182 * device becomes active and the involed page I/O finishes. The
183 * situation is pointed out first by Alan Stern. Network device
184 * are involved in iSCSI kind of situation.
186 * The lock of dev_hotplug_mutex is held in the function for handling
187 * hotplug race because pm_runtime_set_memalloc_noio() may be called
190 * The function should be called between device_add() and device_del()
191 * on the affected device(block/network device).
193 void pm_runtime_set_memalloc_noio(struct device
*dev
, bool enable
)
195 static DEFINE_MUTEX(dev_hotplug_mutex
);
197 mutex_lock(&dev_hotplug_mutex
);
201 /* hold power lock since bitfield is not SMP-safe. */
202 spin_lock_irq(&dev
->power
.lock
);
203 enabled
= dev
->power
.memalloc_noio
;
204 dev
->power
.memalloc_noio
= enable
;
205 spin_unlock_irq(&dev
->power
.lock
);
208 * not need to enable ancestors any more if the device
211 if (enabled
&& enable
)
217 * clear flag of the parent device only if all the
218 * children don't set the flag because ancestor's
219 * flag was set by any one of the descendants.
221 if (!dev
|| (!enable
&&
222 device_for_each_child(dev
, NULL
,
226 mutex_unlock(&dev_hotplug_mutex
);
228 EXPORT_SYMBOL_GPL(pm_runtime_set_memalloc_noio
);
231 * rpm_check_suspend_allowed - Test whether a device may be suspended.
232 * @dev: Device to test.
234 static int rpm_check_suspend_allowed(struct device
*dev
)
238 if (dev
->power
.runtime_error
)
240 else if (dev
->power
.disable_depth
> 0)
242 else if (atomic_read(&dev
->power
.usage_count
) > 0)
244 else if (!pm_children_suspended(dev
))
247 /* Pending resume requests take precedence over suspends. */
248 else if ((dev
->power
.deferred_resume
249 && dev
->power
.runtime_status
== RPM_SUSPENDING
)
250 || (dev
->power
.request_pending
251 && dev
->power
.request
== RPM_REQ_RESUME
))
253 else if (__dev_pm_qos_read_value(dev
) < 0)
255 else if (dev
->power
.runtime_status
== RPM_SUSPENDED
)
262 * __rpm_callback - Run a given runtime PM callback for a given device.
263 * @cb: Runtime PM callback to run.
264 * @dev: Device to run the callback for.
266 static int __rpm_callback(int (*cb
)(struct device
*), struct device
*dev
)
267 __releases(&dev
->power
.lock
) __acquires(&dev
->power
.lock
)
271 if (dev
->power
.irq_safe
)
272 spin_unlock(&dev
->power
.lock
);
274 spin_unlock_irq(&dev
->power
.lock
);
278 if (dev
->power
.irq_safe
)
279 spin_lock(&dev
->power
.lock
);
281 spin_lock_irq(&dev
->power
.lock
);
287 * rpm_idle - Notify device bus type if the device can be suspended.
288 * @dev: Device to notify the bus type about.
289 * @rpmflags: Flag bits.
291 * Check if the device's runtime PM status allows it to be suspended. If
292 * another idle notification has been started earlier, return immediately. If
293 * the RPM_ASYNC flag is set then queue an idle-notification request; otherwise
294 * run the ->runtime_idle() callback directly. If the ->runtime_idle callback
295 * doesn't exist or if it returns 0, call rpm_suspend with the RPM_AUTO flag.
297 * This function must be called under dev->power.lock with interrupts disabled.
299 static int rpm_idle(struct device
*dev
, int rpmflags
)
301 int (*callback
)(struct device
*);
304 trace_rpm_idle(dev
, rpmflags
);
305 retval
= rpm_check_suspend_allowed(dev
);
307 ; /* Conditions are wrong. */
309 /* Idle notifications are allowed only in the RPM_ACTIVE state. */
310 else if (dev
->power
.runtime_status
!= RPM_ACTIVE
)
314 * Any pending request other than an idle notification takes
315 * precedence over us, except that the timer may be running.
317 else if (dev
->power
.request_pending
&&
318 dev
->power
.request
> RPM_REQ_IDLE
)
321 /* Act as though RPM_NOWAIT is always set. */
322 else if (dev
->power
.idle_notification
)
323 retval
= -EINPROGRESS
;
327 /* Pending requests need to be canceled. */
328 dev
->power
.request
= RPM_REQ_NONE
;
330 if (dev
->power
.no_callbacks
)
333 /* Carry out an asynchronous or a synchronous idle notification. */
334 if (rpmflags
& RPM_ASYNC
) {
335 dev
->power
.request
= RPM_REQ_IDLE
;
336 if (!dev
->power
.request_pending
) {
337 dev
->power
.request_pending
= true;
338 queue_work(pm_wq
, &dev
->power
.work
);
340 trace_rpm_return_int(dev
, _THIS_IP_
, 0);
344 dev
->power
.idle_notification
= true;
346 callback
= RPM_GET_CALLBACK(dev
, runtime_idle
);
349 retval
= __rpm_callback(callback
, dev
);
351 dev
->power
.idle_notification
= false;
352 wake_up_all(&dev
->power
.wait_queue
);
355 trace_rpm_return_int(dev
, _THIS_IP_
, retval
);
356 return retval
? retval
: rpm_suspend(dev
, rpmflags
| RPM_AUTO
);
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.
364 static int rpm_callback(int (*cb
)(struct device
*), struct device
*dev
)
371 if (dev
->power
.memalloc_noio
) {
372 unsigned int noio_flag
;
375 * Deadlock might be caused if memory allocation with
376 * GFP_KERNEL happens inside runtime_suspend and
377 * runtime_resume callbacks of one block device's
378 * ancestor or the block device itself. Network
379 * device might be thought as part of iSCSI block
380 * device, so network device and its ancestor should
381 * be marked as memalloc_noio too.
383 noio_flag
= memalloc_noio_save();
384 retval
= __rpm_callback(cb
, dev
);
385 memalloc_noio_restore(noio_flag
);
387 retval
= __rpm_callback(cb
, dev
);
390 dev
->power
.runtime_error
= retval
;
391 return retval
!= -EACCES
? retval
: -EIO
;
395 * rpm_suspend - Carry out runtime suspend of given device.
396 * @dev: Device to suspend.
397 * @rpmflags: Flag bits.
399 * Check if the device's runtime PM status allows it to be suspended.
400 * Cancel a pending idle notification, autosuspend or suspend. If
401 * another suspend has been started earlier, either return immediately
402 * or wait for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC
403 * flags. If the RPM_ASYNC flag is set then queue a suspend request;
404 * otherwise run the ->runtime_suspend() callback directly. When
405 * ->runtime_suspend succeeded, if a deferred resume was requested while
406 * the callback was running then carry it out, otherwise send an idle
407 * notification for its parent (if the suspend succeeded and both
408 * ignore_children of parent->power and irq_safe of dev->power are not set).
409 * If ->runtime_suspend failed with -EAGAIN or -EBUSY, and if the RPM_AUTO
410 * flag is set and the next autosuspend-delay expiration time is in the
411 * future, schedule another autosuspend attempt.
413 * This function must be called under dev->power.lock with interrupts disabled.
415 static int rpm_suspend(struct device
*dev
, int rpmflags
)
416 __releases(&dev
->power
.lock
) __acquires(&dev
->power
.lock
)
418 int (*callback
)(struct device
*);
419 struct device
*parent
= NULL
;
422 trace_rpm_suspend(dev
, rpmflags
);
425 retval
= rpm_check_suspend_allowed(dev
);
428 ; /* Conditions are wrong. */
430 /* Synchronous suspends are not allowed in the RPM_RESUMING state. */
431 else if (dev
->power
.runtime_status
== RPM_RESUMING
&&
432 !(rpmflags
& RPM_ASYNC
))
437 /* If the autosuspend_delay time hasn't expired yet, reschedule. */
438 if ((rpmflags
& RPM_AUTO
)
439 && dev
->power
.runtime_status
!= RPM_SUSPENDING
) {
440 unsigned long expires
= pm_runtime_autosuspend_expiration(dev
);
443 /* Pending requests need to be canceled. */
444 dev
->power
.request
= RPM_REQ_NONE
;
447 * Optimization: If the timer is already running and is
448 * set to expire at or before the autosuspend delay,
449 * avoid the overhead of resetting it. Just let it
450 * expire; pm_suspend_timer_fn() will take care of the
453 if (!(dev
->power
.timer_expires
&& time_before_eq(
454 dev
->power
.timer_expires
, expires
))) {
455 dev
->power
.timer_expires
= expires
;
456 mod_timer(&dev
->power
.suspend_timer
, expires
);
458 dev
->power
.timer_autosuspends
= 1;
463 /* Other scheduled or pending requests need to be canceled. */
464 pm_runtime_cancel_pending(dev
);
466 if (dev
->power
.runtime_status
== RPM_SUSPENDING
) {
469 if (rpmflags
& (RPM_ASYNC
| RPM_NOWAIT
)) {
470 retval
= -EINPROGRESS
;
474 if (dev
->power
.irq_safe
) {
475 spin_unlock(&dev
->power
.lock
);
479 spin_lock(&dev
->power
.lock
);
483 /* Wait for the other suspend running in parallel with us. */
485 prepare_to_wait(&dev
->power
.wait_queue
, &wait
,
486 TASK_UNINTERRUPTIBLE
);
487 if (dev
->power
.runtime_status
!= RPM_SUSPENDING
)
490 spin_unlock_irq(&dev
->power
.lock
);
494 spin_lock_irq(&dev
->power
.lock
);
496 finish_wait(&dev
->power
.wait_queue
, &wait
);
500 if (dev
->power
.no_callbacks
)
501 goto no_callback
; /* Assume success. */
503 /* Carry out an asynchronous or a synchronous suspend. */
504 if (rpmflags
& RPM_ASYNC
) {
505 dev
->power
.request
= (rpmflags
& RPM_AUTO
) ?
506 RPM_REQ_AUTOSUSPEND
: RPM_REQ_SUSPEND
;
507 if (!dev
->power
.request_pending
) {
508 dev
->power
.request_pending
= true;
509 queue_work(pm_wq
, &dev
->power
.work
);
514 __update_runtime_status(dev
, RPM_SUSPENDING
);
516 callback
= RPM_GET_CALLBACK(dev
, runtime_suspend
);
518 dev_pm_enable_wake_irq(dev
);
519 retval
= rpm_callback(callback
, dev
);
524 __update_runtime_status(dev
, RPM_SUSPENDED
);
525 pm_runtime_deactivate_timer(dev
);
528 parent
= dev
->parent
;
529 atomic_add_unless(&parent
->power
.child_count
, -1, 0);
531 wake_up_all(&dev
->power
.wait_queue
);
533 if (dev
->power
.deferred_resume
) {
534 dev
->power
.deferred_resume
= false;
540 /* Maybe the parent is now able to suspend. */
541 if (parent
&& !parent
->power
.ignore_children
&& !dev
->power
.irq_safe
) {
542 spin_unlock(&dev
->power
.lock
);
544 spin_lock(&parent
->power
.lock
);
545 rpm_idle(parent
, RPM_ASYNC
);
546 spin_unlock(&parent
->power
.lock
);
548 spin_lock(&dev
->power
.lock
);
552 trace_rpm_return_int(dev
, _THIS_IP_
, retval
);
557 dev_pm_disable_wake_irq(dev
);
558 __update_runtime_status(dev
, RPM_ACTIVE
);
559 dev
->power
.deferred_resume
= false;
560 wake_up_all(&dev
->power
.wait_queue
);
562 if (retval
== -EAGAIN
|| retval
== -EBUSY
) {
563 dev
->power
.runtime_error
= 0;
566 * If the callback routine failed an autosuspend, and
567 * if the last_busy time has been updated so that there
568 * is a new autosuspend expiration time, automatically
569 * reschedule another autosuspend.
571 if ((rpmflags
& RPM_AUTO
) &&
572 pm_runtime_autosuspend_expiration(dev
) != 0)
575 pm_runtime_cancel_pending(dev
);
581 * rpm_resume - Carry out runtime resume of given device.
582 * @dev: Device to resume.
583 * @rpmflags: Flag bits.
585 * Check if the device's runtime PM status allows it to be resumed. Cancel
586 * any scheduled or pending requests. If another resume has been started
587 * earlier, either return immediately or wait for it to finish, depending on the
588 * RPM_NOWAIT and RPM_ASYNC flags. Similarly, if there's a suspend running in
589 * parallel with this function, either tell the other process to resume after
590 * suspending (deferred_resume) or wait for it to finish. If the RPM_ASYNC
591 * flag is set then queue a resume request; otherwise run the
592 * ->runtime_resume() callback directly. Queue an idle notification for the
593 * device if the resume succeeded.
595 * This function must be called under dev->power.lock with interrupts disabled.
597 static int rpm_resume(struct device
*dev
, int rpmflags
)
598 __releases(&dev
->power
.lock
) __acquires(&dev
->power
.lock
)
600 int (*callback
)(struct device
*);
601 struct device
*parent
= NULL
;
604 trace_rpm_resume(dev
, rpmflags
);
607 if (dev
->power
.runtime_error
)
609 else if (dev
->power
.disable_depth
== 1 && dev
->power
.is_suspended
610 && dev
->power
.runtime_status
== RPM_ACTIVE
)
612 else if (dev
->power
.disable_depth
> 0)
618 * Other scheduled or pending requests need to be canceled. Small
619 * optimization: If an autosuspend timer is running, leave it running
620 * rather than cancelling it now only to restart it again in the near
623 dev
->power
.request
= RPM_REQ_NONE
;
624 if (!dev
->power
.timer_autosuspends
)
625 pm_runtime_deactivate_timer(dev
);
627 if (dev
->power
.runtime_status
== RPM_ACTIVE
) {
632 if (dev
->power
.runtime_status
== RPM_RESUMING
633 || dev
->power
.runtime_status
== RPM_SUSPENDING
) {
636 if (rpmflags
& (RPM_ASYNC
| RPM_NOWAIT
)) {
637 if (dev
->power
.runtime_status
== RPM_SUSPENDING
)
638 dev
->power
.deferred_resume
= true;
640 retval
= -EINPROGRESS
;
644 if (dev
->power
.irq_safe
) {
645 spin_unlock(&dev
->power
.lock
);
649 spin_lock(&dev
->power
.lock
);
653 /* Wait for the operation carried out in parallel with us. */
655 prepare_to_wait(&dev
->power
.wait_queue
, &wait
,
656 TASK_UNINTERRUPTIBLE
);
657 if (dev
->power
.runtime_status
!= RPM_RESUMING
658 && dev
->power
.runtime_status
!= RPM_SUSPENDING
)
661 spin_unlock_irq(&dev
->power
.lock
);
665 spin_lock_irq(&dev
->power
.lock
);
667 finish_wait(&dev
->power
.wait_queue
, &wait
);
672 * See if we can skip waking up the parent. This is safe only if
673 * power.no_callbacks is set, because otherwise we don't know whether
674 * the resume will actually succeed.
676 if (dev
->power
.no_callbacks
&& !parent
&& dev
->parent
) {
677 spin_lock_nested(&dev
->parent
->power
.lock
, SINGLE_DEPTH_NESTING
);
678 if (dev
->parent
->power
.disable_depth
> 0
679 || dev
->parent
->power
.ignore_children
680 || dev
->parent
->power
.runtime_status
== RPM_ACTIVE
) {
681 atomic_inc(&dev
->parent
->power
.child_count
);
682 spin_unlock(&dev
->parent
->power
.lock
);
684 goto no_callback
; /* Assume success. */
686 spin_unlock(&dev
->parent
->power
.lock
);
689 /* Carry out an asynchronous or a synchronous resume. */
690 if (rpmflags
& RPM_ASYNC
) {
691 dev
->power
.request
= RPM_REQ_RESUME
;
692 if (!dev
->power
.request_pending
) {
693 dev
->power
.request_pending
= true;
694 queue_work(pm_wq
, &dev
->power
.work
);
700 if (!parent
&& dev
->parent
) {
702 * Increment the parent's usage counter and resume it if
703 * necessary. Not needed if dev is irq-safe; then the
704 * parent is permanently resumed.
706 parent
= dev
->parent
;
707 if (dev
->power
.irq_safe
)
709 spin_unlock(&dev
->power
.lock
);
711 pm_runtime_get_noresume(parent
);
713 spin_lock(&parent
->power
.lock
);
715 * We can resume if the parent's runtime PM is disabled or it
716 * is set to ignore children.
718 if (!parent
->power
.disable_depth
719 && !parent
->power
.ignore_children
) {
720 rpm_resume(parent
, 0);
721 if (parent
->power
.runtime_status
!= RPM_ACTIVE
)
724 spin_unlock(&parent
->power
.lock
);
726 spin_lock(&dev
->power
.lock
);
733 if (dev
->power
.no_callbacks
)
734 goto no_callback
; /* Assume success. */
736 __update_runtime_status(dev
, RPM_RESUMING
);
738 callback
= RPM_GET_CALLBACK(dev
, runtime_resume
);
740 dev_pm_disable_wake_irq(dev
);
741 retval
= rpm_callback(callback
, dev
);
743 __update_runtime_status(dev
, RPM_SUSPENDED
);
744 pm_runtime_cancel_pending(dev
);
745 dev_pm_enable_wake_irq(dev
);
748 __update_runtime_status(dev
, RPM_ACTIVE
);
749 pm_runtime_mark_last_busy(dev
);
751 atomic_inc(&parent
->power
.child_count
);
753 wake_up_all(&dev
->power
.wait_queue
);
756 rpm_idle(dev
, RPM_ASYNC
);
759 if (parent
&& !dev
->power
.irq_safe
) {
760 spin_unlock_irq(&dev
->power
.lock
);
762 pm_runtime_put(parent
);
764 spin_lock_irq(&dev
->power
.lock
);
767 trace_rpm_return_int(dev
, _THIS_IP_
, retval
);
773 * pm_runtime_work - Universal runtime PM work function.
774 * @work: Work structure used for scheduling the execution of this function.
776 * Use @work to get the device object the work is to be done for, determine what
777 * is to be done and execute the appropriate runtime PM function.
779 static void pm_runtime_work(struct work_struct
*work
)
781 struct device
*dev
= container_of(work
, struct device
, power
.work
);
782 enum rpm_request req
;
784 spin_lock_irq(&dev
->power
.lock
);
786 if (!dev
->power
.request_pending
)
789 req
= dev
->power
.request
;
790 dev
->power
.request
= RPM_REQ_NONE
;
791 dev
->power
.request_pending
= false;
797 rpm_idle(dev
, RPM_NOWAIT
);
799 case RPM_REQ_SUSPEND
:
800 rpm_suspend(dev
, RPM_NOWAIT
);
802 case RPM_REQ_AUTOSUSPEND
:
803 rpm_suspend(dev
, RPM_NOWAIT
| RPM_AUTO
);
806 rpm_resume(dev
, RPM_NOWAIT
);
811 spin_unlock_irq(&dev
->power
.lock
);
815 * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
816 * @data: Device pointer passed by pm_schedule_suspend().
818 * Check if the time is right and queue a suspend request.
820 static void pm_suspend_timer_fn(unsigned long data
)
822 struct device
*dev
= (struct device
*)data
;
824 unsigned long expires
;
826 spin_lock_irqsave(&dev
->power
.lock
, flags
);
828 expires
= dev
->power
.timer_expires
;
829 /* If 'expire' is after 'jiffies' we've been called too early. */
830 if (expires
> 0 && !time_after(expires
, jiffies
)) {
831 dev
->power
.timer_expires
= 0;
832 rpm_suspend(dev
, dev
->power
.timer_autosuspends
?
833 (RPM_ASYNC
| RPM_AUTO
) : RPM_ASYNC
);
836 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
840 * pm_schedule_suspend - Set up a timer to submit a suspend request in future.
841 * @dev: Device to suspend.
842 * @delay: Time to wait before submitting a suspend request, in milliseconds.
844 int pm_schedule_suspend(struct device
*dev
, unsigned int delay
)
849 spin_lock_irqsave(&dev
->power
.lock
, flags
);
852 retval
= rpm_suspend(dev
, RPM_ASYNC
);
856 retval
= rpm_check_suspend_allowed(dev
);
860 /* Other scheduled or pending requests need to be canceled. */
861 pm_runtime_cancel_pending(dev
);
863 dev
->power
.timer_expires
= jiffies
+ msecs_to_jiffies(delay
);
864 dev
->power
.timer_expires
+= !dev
->power
.timer_expires
;
865 dev
->power
.timer_autosuspends
= 0;
866 mod_timer(&dev
->power
.suspend_timer
, dev
->power
.timer_expires
);
869 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
873 EXPORT_SYMBOL_GPL(pm_schedule_suspend
);
876 * __pm_runtime_idle - Entry point for runtime idle operations.
877 * @dev: Device to send idle notification for.
878 * @rpmflags: Flag bits.
880 * If the RPM_GET_PUT flag is set, decrement the device's usage count and
881 * return immediately if it is larger than zero. Then carry out an idle
882 * notification, either synchronous or asynchronous.
884 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
885 * or if pm_runtime_irq_safe() has been called.
887 int __pm_runtime_idle(struct device
*dev
, int rpmflags
)
892 might_sleep_if(!(rpmflags
& RPM_ASYNC
) && !dev
->power
.irq_safe
);
894 if (rpmflags
& RPM_GET_PUT
) {
895 if (!atomic_dec_and_test(&dev
->power
.usage_count
))
899 spin_lock_irqsave(&dev
->power
.lock
, flags
);
900 retval
= rpm_idle(dev
, rpmflags
);
901 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
905 EXPORT_SYMBOL_GPL(__pm_runtime_idle
);
908 * __pm_runtime_suspend - Entry point for runtime put/suspend operations.
909 * @dev: Device to suspend.
910 * @rpmflags: Flag bits.
912 * If the RPM_GET_PUT flag is set, decrement the device's usage count and
913 * return immediately if it is larger than zero. Then carry out a suspend,
914 * either synchronous or asynchronous.
916 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
917 * or if pm_runtime_irq_safe() has been called.
919 int __pm_runtime_suspend(struct device
*dev
, int rpmflags
)
924 might_sleep_if(!(rpmflags
& RPM_ASYNC
) && !dev
->power
.irq_safe
);
926 if (rpmflags
& RPM_GET_PUT
) {
927 if (!atomic_dec_and_test(&dev
->power
.usage_count
))
931 spin_lock_irqsave(&dev
->power
.lock
, flags
);
932 retval
= rpm_suspend(dev
, rpmflags
);
933 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
937 EXPORT_SYMBOL_GPL(__pm_runtime_suspend
);
940 * __pm_runtime_resume - Entry point for runtime resume operations.
941 * @dev: Device to resume.
942 * @rpmflags: Flag bits.
944 * If the RPM_GET_PUT flag is set, increment the device's usage count. Then
945 * carry out a resume, either synchronous or asynchronous.
947 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
948 * or if pm_runtime_irq_safe() has been called.
950 int __pm_runtime_resume(struct device
*dev
, int rpmflags
)
955 might_sleep_if(!(rpmflags
& RPM_ASYNC
) && !dev
->power
.irq_safe
);
957 if (rpmflags
& RPM_GET_PUT
)
958 atomic_inc(&dev
->power
.usage_count
);
960 spin_lock_irqsave(&dev
->power
.lock
, flags
);
961 retval
= rpm_resume(dev
, rpmflags
);
962 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
966 EXPORT_SYMBOL_GPL(__pm_runtime_resume
);
969 * __pm_runtime_set_status - Set runtime PM status of a device.
970 * @dev: Device to handle.
971 * @status: New runtime PM status of the device.
973 * If runtime PM of the device is disabled or its power.runtime_error field is
974 * different from zero, the status may be changed either to RPM_ACTIVE, or to
975 * RPM_SUSPENDED, as long as that reflects the actual state of the device.
976 * However, if the device has a parent and the parent is not active, and the
977 * parent's power.ignore_children flag is unset, the device's status cannot be
978 * set to RPM_ACTIVE, so -EBUSY is returned in that case.
980 * If successful, __pm_runtime_set_status() clears the power.runtime_error field
981 * and the device parent's counter of unsuspended children is modified to
982 * reflect the new status. If the new status is RPM_SUSPENDED, an idle
983 * notification request for the parent is submitted.
985 int __pm_runtime_set_status(struct device
*dev
, unsigned int status
)
987 struct device
*parent
= dev
->parent
;
989 bool notify_parent
= false;
992 if (status
!= RPM_ACTIVE
&& status
!= RPM_SUSPENDED
)
995 spin_lock_irqsave(&dev
->power
.lock
, flags
);
997 if (!dev
->power
.runtime_error
&& !dev
->power
.disable_depth
) {
1002 if (dev
->power
.runtime_status
== status
)
1005 if (status
== RPM_SUSPENDED
) {
1006 /* It always is possible to set the status to 'suspended'. */
1008 atomic_add_unless(&parent
->power
.child_count
, -1, 0);
1009 notify_parent
= !parent
->power
.ignore_children
;
1015 spin_lock_nested(&parent
->power
.lock
, SINGLE_DEPTH_NESTING
);
1018 * It is invalid to put an active child under a parent that is
1019 * not active, has runtime PM enabled and the
1020 * 'power.ignore_children' flag unset.
1022 if (!parent
->power
.disable_depth
1023 && !parent
->power
.ignore_children
1024 && parent
->power
.runtime_status
!= RPM_ACTIVE
)
1026 else if (dev
->power
.runtime_status
== RPM_SUSPENDED
)
1027 atomic_inc(&parent
->power
.child_count
);
1029 spin_unlock(&parent
->power
.lock
);
1036 __update_runtime_status(dev
, status
);
1037 dev
->power
.runtime_error
= 0;
1039 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
1042 pm_request_idle(parent
);
1046 EXPORT_SYMBOL_GPL(__pm_runtime_set_status
);
1049 * __pm_runtime_barrier - Cancel pending requests and wait for completions.
1050 * @dev: Device to handle.
1052 * Flush all pending requests for the device from pm_wq and wait for all
1053 * runtime PM operations involving the device in progress to complete.
1055 * Should be called under dev->power.lock with interrupts disabled.
1057 static void __pm_runtime_barrier(struct device
*dev
)
1059 pm_runtime_deactivate_timer(dev
);
1061 if (dev
->power
.request_pending
) {
1062 dev
->power
.request
= RPM_REQ_NONE
;
1063 spin_unlock_irq(&dev
->power
.lock
);
1065 cancel_work_sync(&dev
->power
.work
);
1067 spin_lock_irq(&dev
->power
.lock
);
1068 dev
->power
.request_pending
= false;
1071 if (dev
->power
.runtime_status
== RPM_SUSPENDING
1072 || dev
->power
.runtime_status
== RPM_RESUMING
1073 || dev
->power
.idle_notification
) {
1076 /* Suspend, wake-up or idle notification in progress. */
1078 prepare_to_wait(&dev
->power
.wait_queue
, &wait
,
1079 TASK_UNINTERRUPTIBLE
);
1080 if (dev
->power
.runtime_status
!= RPM_SUSPENDING
1081 && dev
->power
.runtime_status
!= RPM_RESUMING
1082 && !dev
->power
.idle_notification
)
1084 spin_unlock_irq(&dev
->power
.lock
);
1088 spin_lock_irq(&dev
->power
.lock
);
1090 finish_wait(&dev
->power
.wait_queue
, &wait
);
1095 * pm_runtime_barrier - Flush pending requests and wait for completions.
1096 * @dev: Device to handle.
1098 * Prevent the device from being suspended by incrementing its usage counter and
1099 * if there's a pending resume request for the device, wake the device up.
1100 * Next, make sure that all pending requests for the device have been flushed
1101 * from pm_wq and wait for all runtime PM operations involving the device in
1102 * progress to complete.
1105 * 1, if there was a resume request pending and the device had to be woken up,
1108 int pm_runtime_barrier(struct device
*dev
)
1112 pm_runtime_get_noresume(dev
);
1113 spin_lock_irq(&dev
->power
.lock
);
1115 if (dev
->power
.request_pending
1116 && dev
->power
.request
== RPM_REQ_RESUME
) {
1121 __pm_runtime_barrier(dev
);
1123 spin_unlock_irq(&dev
->power
.lock
);
1124 pm_runtime_put_noidle(dev
);
1128 EXPORT_SYMBOL_GPL(pm_runtime_barrier
);
1131 * __pm_runtime_disable - Disable runtime PM of a device.
1132 * @dev: Device to handle.
1133 * @check_resume: If set, check if there's a resume request for the device.
1135 * Increment power.disable_depth for the device and if it was zero previously,
1136 * cancel all pending runtime PM requests for the device and wait for all
1137 * operations in progress to complete. The device can be either active or
1138 * suspended after its runtime PM has been disabled.
1140 * If @check_resume is set and there's a resume request pending when
1141 * __pm_runtime_disable() is called and power.disable_depth is zero, the
1142 * function will wake up the device before disabling its runtime PM.
1144 void __pm_runtime_disable(struct device
*dev
, bool check_resume
)
1146 spin_lock_irq(&dev
->power
.lock
);
1148 if (dev
->power
.disable_depth
> 0) {
1149 dev
->power
.disable_depth
++;
1154 * Wake up the device if there's a resume request pending, because that
1155 * means there probably is some I/O to process and disabling runtime PM
1156 * shouldn't prevent the device from processing the I/O.
1158 if (check_resume
&& dev
->power
.request_pending
1159 && dev
->power
.request
== RPM_REQ_RESUME
) {
1161 * Prevent suspends and idle notifications from being carried
1162 * out after we have woken up the device.
1164 pm_runtime_get_noresume(dev
);
1168 pm_runtime_put_noidle(dev
);
1171 if (!dev
->power
.disable_depth
++)
1172 __pm_runtime_barrier(dev
);
1175 spin_unlock_irq(&dev
->power
.lock
);
1177 EXPORT_SYMBOL_GPL(__pm_runtime_disable
);
1180 * pm_runtime_enable - Enable runtime PM of a device.
1181 * @dev: Device to handle.
1183 void pm_runtime_enable(struct device
*dev
)
1185 unsigned long flags
;
1187 spin_lock_irqsave(&dev
->power
.lock
, flags
);
1189 if (dev
->power
.disable_depth
> 0)
1190 dev
->power
.disable_depth
--;
1192 dev_warn(dev
, "Unbalanced %s!\n", __func__
);
1194 spin_unlock_irqrestore(&dev
->power
.lock
, flags
);
1196 EXPORT_SYMBOL_GPL(pm_runtime_enable
);
1199 * pm_runtime_forbid - Block runtime PM of a device.
1200 * @dev: Device to handle.
1202 * Increase the device's usage count and clear its power.runtime_auto flag,
1203 * so that it cannot be suspended at run time until pm_runtime_allow() is called
1206 void pm_runtime_forbid(struct device
*dev
)
1208 spin_lock_irq(&dev
->power
.lock
);
1209 if (!dev
->power
.runtime_auto
)
1212 dev
->power
.runtime_auto
= false;
1213 atomic_inc(&dev
->power
.usage_count
);
1217 spin_unlock_irq(&dev
->power
.lock
);
1219 EXPORT_SYMBOL_GPL(pm_runtime_forbid
);
1222 * pm_runtime_allow - Unblock runtime PM of a device.
1223 * @dev: Device to handle.
1225 * Decrease the device's usage count and set its power.runtime_auto flag.
1227 void pm_runtime_allow(struct device
*dev
)
1229 spin_lock_irq(&dev
->power
.lock
);
1230 if (dev
->power
.runtime_auto
)
1233 dev
->power
.runtime_auto
= true;
1234 if (atomic_dec_and_test(&dev
->power
.usage_count
))
1235 rpm_idle(dev
, RPM_AUTO
);
1238 spin_unlock_irq(&dev
->power
.lock
);
1240 EXPORT_SYMBOL_GPL(pm_runtime_allow
);
1243 * pm_runtime_no_callbacks - Ignore runtime PM callbacks for a device.
1244 * @dev: Device to handle.
1246 * Set the power.no_callbacks flag, which tells the PM core that this
1247 * device is power-managed through its parent and has no runtime PM
1248 * callbacks of its own. The runtime sysfs attributes will be removed.
1250 void pm_runtime_no_callbacks(struct device
*dev
)
1252 spin_lock_irq(&dev
->power
.lock
);
1253 dev
->power
.no_callbacks
= 1;
1254 spin_unlock_irq(&dev
->power
.lock
);
1255 if (device_is_registered(dev
))
1256 rpm_sysfs_remove(dev
);
1258 EXPORT_SYMBOL_GPL(pm_runtime_no_callbacks
);
1261 * pm_runtime_irq_safe - Leave interrupts disabled during callbacks.
1262 * @dev: Device to handle
1264 * Set the power.irq_safe flag, which tells the PM core that the
1265 * ->runtime_suspend() and ->runtime_resume() callbacks for this device should
1266 * always be invoked with the spinlock held and interrupts disabled. It also
1267 * causes the parent's usage counter to be permanently incremented, preventing
1268 * the parent from runtime suspending -- otherwise an irq-safe child might have
1269 * to wait for a non-irq-safe parent.
1271 void pm_runtime_irq_safe(struct device
*dev
)
1274 pm_runtime_get_sync(dev
->parent
);
1275 spin_lock_irq(&dev
->power
.lock
);
1276 dev
->power
.irq_safe
= 1;
1277 spin_unlock_irq(&dev
->power
.lock
);
1279 EXPORT_SYMBOL_GPL(pm_runtime_irq_safe
);
1282 * update_autosuspend - Handle a change to a device's autosuspend settings.
1283 * @dev: Device to handle.
1284 * @old_delay: The former autosuspend_delay value.
1285 * @old_use: The former use_autosuspend value.
1287 * Prevent runtime suspend if the new delay is negative and use_autosuspend is
1288 * set; otherwise allow it. Send an idle notification if suspends are allowed.
1290 * This function must be called under dev->power.lock with interrupts disabled.
1292 static void update_autosuspend(struct device
*dev
, int old_delay
, int old_use
)
1294 int delay
= dev
->power
.autosuspend_delay
;
1296 /* Should runtime suspend be prevented now? */
1297 if (dev
->power
.use_autosuspend
&& delay
< 0) {
1299 /* If it used to be allowed then prevent it. */
1300 if (!old_use
|| old_delay
>= 0) {
1301 atomic_inc(&dev
->power
.usage_count
);
1306 /* Runtime suspend should be allowed now. */
1309 /* If it used to be prevented then allow it. */
1310 if (old_use
&& old_delay
< 0)
1311 atomic_dec(&dev
->power
.usage_count
);
1313 /* Maybe we can autosuspend now. */
1314 rpm_idle(dev
, RPM_AUTO
);
1319 * pm_runtime_set_autosuspend_delay - Set a device's autosuspend_delay value.
1320 * @dev: Device to handle.
1321 * @delay: Value of the new delay in milliseconds.
1323 * Set the device's power.autosuspend_delay value. If it changes to negative
1324 * and the power.use_autosuspend flag is set, prevent runtime suspends. If it
1325 * changes the other way, allow runtime suspends.
1327 void pm_runtime_set_autosuspend_delay(struct device
*dev
, int delay
)
1329 int old_delay
, old_use
;
1331 spin_lock_irq(&dev
->power
.lock
);
1332 old_delay
= dev
->power
.autosuspend_delay
;
1333 old_use
= dev
->power
.use_autosuspend
;
1334 dev
->power
.autosuspend_delay
= delay
;
1335 update_autosuspend(dev
, old_delay
, old_use
);
1336 spin_unlock_irq(&dev
->power
.lock
);
1338 EXPORT_SYMBOL_GPL(pm_runtime_set_autosuspend_delay
);
1341 * __pm_runtime_use_autosuspend - Set a device's use_autosuspend flag.
1342 * @dev: Device to handle.
1343 * @use: New value for use_autosuspend.
1345 * Set the device's power.use_autosuspend flag, and allow or prevent runtime
1346 * suspends as needed.
1348 void __pm_runtime_use_autosuspend(struct device
*dev
, bool use
)
1350 int old_delay
, old_use
;
1352 spin_lock_irq(&dev
->power
.lock
);
1353 old_delay
= dev
->power
.autosuspend_delay
;
1354 old_use
= dev
->power
.use_autosuspend
;
1355 dev
->power
.use_autosuspend
= use
;
1356 update_autosuspend(dev
, old_delay
, old_use
);
1357 spin_unlock_irq(&dev
->power
.lock
);
1359 EXPORT_SYMBOL_GPL(__pm_runtime_use_autosuspend
);
1362 * pm_runtime_init - Initialize runtime PM fields in given device object.
1363 * @dev: Device object to initialize.
1365 void pm_runtime_init(struct device
*dev
)
1367 dev
->power
.runtime_status
= RPM_SUSPENDED
;
1368 dev
->power
.idle_notification
= false;
1370 dev
->power
.disable_depth
= 1;
1371 atomic_set(&dev
->power
.usage_count
, 0);
1373 dev
->power
.runtime_error
= 0;
1375 atomic_set(&dev
->power
.child_count
, 0);
1376 pm_suspend_ignore_children(dev
, false);
1377 dev
->power
.runtime_auto
= true;
1379 dev
->power
.request_pending
= false;
1380 dev
->power
.request
= RPM_REQ_NONE
;
1381 dev
->power
.deferred_resume
= false;
1382 dev
->power
.accounting_timestamp
= jiffies
;
1383 INIT_WORK(&dev
->power
.work
, pm_runtime_work
);
1385 dev
->power
.timer_expires
= 0;
1386 setup_timer(&dev
->power
.suspend_timer
, pm_suspend_timer_fn
,
1387 (unsigned long)dev
);
1389 init_waitqueue_head(&dev
->power
.wait_queue
);
1393 * pm_runtime_remove - Prepare for removing a device from device hierarchy.
1394 * @dev: Device object being removed from device hierarchy.
1396 void pm_runtime_remove(struct device
*dev
)
1398 __pm_runtime_disable(dev
, false);
1400 /* Change the status back to 'suspended' to match the initial status. */
1401 if (dev
->power
.runtime_status
== RPM_ACTIVE
)
1402 pm_runtime_set_suspended(dev
);
1403 if (dev
->power
.irq_safe
&& dev
->parent
)
1404 pm_runtime_put(dev
->parent
);
1408 * pm_runtime_force_suspend - Force a device into suspend state if needed.
1409 * @dev: Device to suspend.
1411 * Disable runtime PM so we safely can check the device's runtime PM status and
1412 * if it is active, invoke it's .runtime_suspend callback to bring it into
1413 * suspend state. Keep runtime PM disabled to preserve the state unless we
1416 * Typically this function may be invoked from a system suspend callback to make
1417 * sure the device is put into low power state.
1419 int pm_runtime_force_suspend(struct device
*dev
)
1421 int (*callback
)(struct device
*);
1424 pm_runtime_disable(dev
);
1425 if (pm_runtime_status_suspended(dev
))
1428 callback
= RPM_GET_CALLBACK(dev
, runtime_suspend
);
1435 ret
= callback(dev
);
1439 pm_runtime_set_suspended(dev
);
1442 pm_runtime_enable(dev
);
1445 EXPORT_SYMBOL_GPL(pm_runtime_force_suspend
);
1448 * pm_runtime_force_resume - Force a device into resume state.
1449 * @dev: Device to resume.
1451 * Prior invoking this function we expect the user to have brought the device
1452 * into low power state by a call to pm_runtime_force_suspend(). Here we reverse
1453 * those actions and brings the device into full power. We update the runtime PM
1454 * status and re-enables runtime PM.
1456 * Typically this function may be invoked from a system resume callback to make
1457 * sure the device is put into full power state.
1459 int pm_runtime_force_resume(struct device
*dev
)
1461 int (*callback
)(struct device
*);
1464 callback
= RPM_GET_CALLBACK(dev
, runtime_resume
);
1471 ret
= callback(dev
);
1475 pm_runtime_set_active(dev
);
1476 pm_runtime_mark_last_busy(dev
);
1478 pm_runtime_enable(dev
);
1481 EXPORT_SYMBOL_GPL(pm_runtime_force_resume
);