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 <trace/events/rpm.h>
16 typedef int (*pm_callback_t)(struct device *);
18 static pm_callback_t __rpm_get_callback(struct device *dev, size_t cb_offset)
21 const struct dev_pm_ops *ops;
24 ops = &dev->pm_domain->ops;
25 else if (dev->type && dev->type->pm)
27 else if (dev->class && dev->class->pm)
29 else if (dev->bus && dev->bus->pm)
35 cb = *(pm_callback_t *)((void *)ops + cb_offset);
39 if (!cb && dev->driver && dev->driver->pm)
40 cb = *(pm_callback_t *)((void *)dev->driver->pm + cb_offset);
45 #define RPM_GET_CALLBACK(dev, callback) \
46 __rpm_get_callback(dev, offsetof(struct dev_pm_ops, callback))
48 #ifdef CONFIG_PM_RUNTIME
50 static int rpm_resume(struct device *dev, int rpmflags);
51 static int rpm_suspend(struct device *dev, int rpmflags);
54 * update_pm_runtime_accounting - Update the time accounting of power states
55 * @dev: Device to update the accounting for
57 * In order to be able to have time accounting of the various power states
58 * (as used by programs such as PowerTOP to show the effectiveness of runtime
59 * PM), we need to track the time spent in each state.
60 * update_pm_runtime_accounting must be called each time before the
61 * runtime_status field is updated, to account the time in the old state
64 void update_pm_runtime_accounting(struct device *dev)
66 unsigned long now = jiffies;
69 delta = now - dev->power.accounting_timestamp;
71 dev->power.accounting_timestamp = now;
73 if (dev->power.disable_depth > 0)
76 if (dev->power.runtime_status == RPM_SUSPENDED)
77 dev->power.suspended_jiffies += delta;
79 dev->power.active_jiffies += delta;
82 static void __update_runtime_status(struct device *dev, enum rpm_status status)
84 update_pm_runtime_accounting(dev);
85 dev->power.runtime_status = status;
89 * pm_runtime_deactivate_timer - Deactivate given device's suspend timer.
90 * @dev: Device to handle.
92 static void pm_runtime_deactivate_timer(struct device *dev)
94 if (dev->power.timer_expires > 0) {
95 del_timer(&dev->power.suspend_timer);
96 dev->power.timer_expires = 0;
101 * pm_runtime_cancel_pending - Deactivate suspend timer and cancel requests.
102 * @dev: Device to handle.
104 static void pm_runtime_cancel_pending(struct device *dev)
106 pm_runtime_deactivate_timer(dev);
108 * In case there's a request pending, make sure its work function will
109 * return without doing anything.
111 dev->power.request = RPM_REQ_NONE;
115 * pm_runtime_autosuspend_expiration - Get a device's autosuspend-delay expiration time.
116 * @dev: Device to handle.
118 * Compute the autosuspend-delay expiration time based on the device's
119 * power.last_busy time. If the delay has already expired or is disabled
120 * (negative) or the power.use_autosuspend flag isn't set, return 0.
121 * Otherwise return the expiration time in jiffies (adjusted to be nonzero).
123 * This function may be called either with or without dev->power.lock held.
124 * Either way it can be racy, since power.last_busy may be updated at any time.
126 unsigned long pm_runtime_autosuspend_expiration(struct device *dev)
128 int autosuspend_delay;
130 unsigned long last_busy;
131 unsigned long expires = 0;
133 if (!dev->power.use_autosuspend)
136 autosuspend_delay = ACCESS_ONCE(dev->power.autosuspend_delay);
137 if (autosuspend_delay < 0)
140 last_busy = ACCESS_ONCE(dev->power.last_busy);
141 elapsed = jiffies - last_busy;
143 goto out; /* jiffies has wrapped around. */
146 * If the autosuspend_delay is >= 1 second, align the timer by rounding
147 * up to the nearest second.
149 expires = last_busy + msecs_to_jiffies(autosuspend_delay);
150 if (autosuspend_delay >= 1000)
151 expires = round_jiffies(expires);
153 if (elapsed >= expires - last_busy)
154 expires = 0; /* Already expired. */
159 EXPORT_SYMBOL_GPL(pm_runtime_autosuspend_expiration);
161 static int dev_memalloc_noio(struct device *dev, void *data)
163 return dev->power.memalloc_noio;
167 * pm_runtime_set_memalloc_noio - Set a device's memalloc_noio flag.
168 * @dev: Device to handle.
169 * @enable: True for setting the flag and False for clearing the flag.
171 * Set the flag for all devices in the path from the device to the
172 * root device in the device tree if @enable is true, otherwise clear
173 * the flag for devices in the path whose siblings don't set the flag.
175 * The function should only be called by block device, or network
176 * device driver for solving the deadlock problem during runtime
179 * If memory allocation with GFP_KERNEL is called inside runtime
180 * resume/suspend callback of any one of its ancestors(or the
181 * block device itself), the deadlock may be triggered inside the
182 * memory allocation since it might not complete until the block
183 * device becomes active and the involed page I/O finishes. The
184 * situation is pointed out first by Alan Stern. Network device
185 * are involved in iSCSI kind of situation.
187 * The lock of dev_hotplug_mutex is held in the function for handling
188 * hotplug race because pm_runtime_set_memalloc_noio() may be called
191 * The function should be called between device_add() and device_del()
192 * on the affected device(block/network device).
194 void pm_runtime_set_memalloc_noio(struct device *dev, bool enable)
196 static DEFINE_MUTEX(dev_hotplug_mutex);
198 mutex_lock(&dev_hotplug_mutex);
202 /* hold power lock since bitfield is not SMP-safe. */
203 spin_lock_irq(&dev->power.lock);
204 enabled = dev->power.memalloc_noio;
205 dev->power.memalloc_noio = enable;
206 spin_unlock_irq(&dev->power.lock);
209 * not need to enable ancestors any more if the device
212 if (enabled && enable)
218 * clear flag of the parent device only if all the
219 * children don't set the flag because ancestor's
220 * flag was set by any one of the descendants.
222 if (!dev || (!enable &&
223 device_for_each_child(dev, NULL,
227 mutex_unlock(&dev_hotplug_mutex);
229 EXPORT_SYMBOL_GPL(pm_runtime_set_memalloc_noio);
232 * rpm_check_suspend_allowed - Test whether a device may be suspended.
233 * @dev: Device to test.
235 static int rpm_check_suspend_allowed(struct device *dev)
239 if (dev->power.runtime_error)
241 else if (dev->power.disable_depth > 0)
243 else if (atomic_read(&dev->power.usage_count) > 0)
245 else if (!pm_children_suspended(dev))
248 /* Pending resume requests take precedence over suspends. */
249 else if ((dev->power.deferred_resume
250 && dev->power.runtime_status == RPM_SUSPENDING)
251 || (dev->power.request_pending
252 && dev->power.request == RPM_REQ_RESUME))
254 else if (__dev_pm_qos_read_value(dev) < 0)
256 else if (dev->power.runtime_status == RPM_SUSPENDED)
263 * __rpm_callback - Run a given runtime PM callback for a given device.
264 * @cb: Runtime PM callback to run.
265 * @dev: Device to run the callback for.
267 static int __rpm_callback(int (*cb)(struct device *), struct device *dev)
268 __releases(&dev->power.lock) __acquires(&dev->power.lock)
272 if (dev->power.irq_safe)
273 spin_unlock(&dev->power.lock);
275 spin_unlock_irq(&dev->power.lock);
279 if (dev->power.irq_safe)
280 spin_lock(&dev->power.lock);
282 spin_lock_irq(&dev->power.lock);
288 * rpm_idle - Notify device bus type if the device can be suspended.
289 * @dev: Device to notify the bus type about.
290 * @rpmflags: Flag bits.
292 * Check if the device's runtime PM status allows it to be suspended. If
293 * another idle notification has been started earlier, return immediately. If
294 * the RPM_ASYNC flag is set then queue an idle-notification request; otherwise
295 * run the ->runtime_idle() callback directly. If the ->runtime_idle callback
296 * doesn't exist or if it returns 0, call rpm_suspend with the RPM_AUTO flag.
298 * This function must be called under dev->power.lock with interrupts disabled.
300 static int rpm_idle(struct device *dev, int rpmflags)
302 int (*callback)(struct device *);
305 trace_rpm_idle(dev, rpmflags);
306 retval = rpm_check_suspend_allowed(dev);
308 ; /* Conditions are wrong. */
310 /* Idle notifications are allowed only in the RPM_ACTIVE state. */
311 else if (dev->power.runtime_status != RPM_ACTIVE)
315 * Any pending request other than an idle notification takes
316 * precedence over us, except that the timer may be running.
318 else if (dev->power.request_pending &&
319 dev->power.request > RPM_REQ_IDLE)
322 /* Act as though RPM_NOWAIT is always set. */
323 else if (dev->power.idle_notification)
324 retval = -EINPROGRESS;
328 /* Pending requests need to be canceled. */
329 dev->power.request = RPM_REQ_NONE;
331 if (dev->power.no_callbacks)
334 /* Carry out an asynchronous or a synchronous idle notification. */
335 if (rpmflags & RPM_ASYNC) {
336 dev->power.request = RPM_REQ_IDLE;
337 if (!dev->power.request_pending) {
338 dev->power.request_pending = true;
339 queue_work(pm_wq, &dev->power.work);
341 trace_rpm_return_int(dev, _THIS_IP_, 0);
345 dev->power.idle_notification = true;
347 callback = RPM_GET_CALLBACK(dev, runtime_idle);
350 retval = __rpm_callback(callback, dev);
352 dev->power.idle_notification = false;
353 wake_up_all(&dev->power.wait_queue);
356 trace_rpm_return_int(dev, _THIS_IP_, retval);
357 return retval ? retval : rpm_suspend(dev, rpmflags | RPM_AUTO);
361 * rpm_callback - Run a given runtime PM callback for a given device.
362 * @cb: Runtime PM callback to run.
363 * @dev: Device to run the callback for.
365 static int rpm_callback(int (*cb)(struct device *), struct device *dev)
372 if (dev->power.memalloc_noio) {
373 unsigned int noio_flag;
376 * Deadlock might be caused if memory allocation with
377 * GFP_KERNEL happens inside runtime_suspend and
378 * runtime_resume callbacks of one block device's
379 * ancestor or the block device itself. Network
380 * device might be thought as part of iSCSI block
381 * device, so network device and its ancestor should
382 * be marked as memalloc_noio too.
384 noio_flag = memalloc_noio_save();
385 retval = __rpm_callback(cb, dev);
386 memalloc_noio_restore(noio_flag);
388 retval = __rpm_callback(cb, dev);
391 dev->power.runtime_error = retval;
392 return retval != -EACCES ? retval : -EIO;
396 * rpm_suspend - Carry out runtime suspend of given device.
397 * @dev: Device to suspend.
398 * @rpmflags: Flag bits.
400 * Check if the device's runtime PM status allows it to be suspended.
401 * Cancel a pending idle notification, autosuspend or suspend. If
402 * another suspend has been started earlier, either return immediately
403 * or wait for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC
404 * flags. If the RPM_ASYNC flag is set then queue a suspend request;
405 * otherwise run the ->runtime_suspend() callback directly. When
406 * ->runtime_suspend succeeded, if a deferred resume was requested while
407 * the callback was running then carry it out, otherwise send an idle
408 * notification for its parent (if the suspend succeeded and both
409 * ignore_children of parent->power and irq_safe of dev->power are not set).
410 * If ->runtime_suspend failed with -EAGAIN or -EBUSY, and if the RPM_AUTO
411 * flag is set and the next autosuspend-delay expiration time is in the
412 * future, schedule another autosuspend attempt.
414 * This function must be called under dev->power.lock with interrupts disabled.
416 static int rpm_suspend(struct device *dev, int rpmflags)
417 __releases(&dev->power.lock) __acquires(&dev->power.lock)
419 int (*callback)(struct device *);
420 struct device *parent = NULL;
423 trace_rpm_suspend(dev, rpmflags);
426 retval = rpm_check_suspend_allowed(dev);
429 ; /* Conditions are wrong. */
431 /* Synchronous suspends are not allowed in the RPM_RESUMING state. */
432 else if (dev->power.runtime_status == RPM_RESUMING &&
433 !(rpmflags & RPM_ASYNC))
438 /* If the autosuspend_delay time hasn't expired yet, reschedule. */
439 if ((rpmflags & RPM_AUTO)
440 && dev->power.runtime_status != RPM_SUSPENDING) {
441 unsigned long expires = pm_runtime_autosuspend_expiration(dev);
444 /* Pending requests need to be canceled. */
445 dev->power.request = RPM_REQ_NONE;
448 * Optimization: If the timer is already running and is
449 * set to expire at or before the autosuspend delay,
450 * avoid the overhead of resetting it. Just let it
451 * expire; pm_suspend_timer_fn() will take care of the
454 if (!(dev->power.timer_expires && time_before_eq(
455 dev->power.timer_expires, expires))) {
456 dev->power.timer_expires = expires;
457 mod_timer(&dev->power.suspend_timer, expires);
459 dev->power.timer_autosuspends = 1;
464 /* Other scheduled or pending requests need to be canceled. */
465 pm_runtime_cancel_pending(dev);
467 if (dev->power.runtime_status == RPM_SUSPENDING) {
470 if (rpmflags & (RPM_ASYNC | RPM_NOWAIT)) {
471 retval = -EINPROGRESS;
475 if (dev->power.irq_safe) {
476 spin_unlock(&dev->power.lock);
480 spin_lock(&dev->power.lock);
484 /* Wait for the other suspend running in parallel with us. */
486 prepare_to_wait(&dev->power.wait_queue, &wait,
487 TASK_UNINTERRUPTIBLE);
488 if (dev->power.runtime_status != RPM_SUSPENDING)
491 spin_unlock_irq(&dev->power.lock);
495 spin_lock_irq(&dev->power.lock);
497 finish_wait(&dev->power.wait_queue, &wait);
501 if (dev->power.no_callbacks)
502 goto no_callback; /* Assume success. */
504 /* Carry out an asynchronous or a synchronous suspend. */
505 if (rpmflags & RPM_ASYNC) {
506 dev->power.request = (rpmflags & RPM_AUTO) ?
507 RPM_REQ_AUTOSUSPEND : RPM_REQ_SUSPEND;
508 if (!dev->power.request_pending) {
509 dev->power.request_pending = true;
510 queue_work(pm_wq, &dev->power.work);
515 __update_runtime_status(dev, RPM_SUSPENDING);
517 callback = RPM_GET_CALLBACK(dev, runtime_suspend);
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 __update_runtime_status(dev, RPM_ACTIVE);
558 dev->power.deferred_resume = false;
559 wake_up_all(&dev->power.wait_queue);
561 if (retval == -EAGAIN || retval == -EBUSY) {
562 dev->power.runtime_error = 0;
565 * If the callback routine failed an autosuspend, and
566 * if the last_busy time has been updated so that there
567 * is a new autosuspend expiration time, automatically
568 * reschedule another autosuspend.
570 if ((rpmflags & RPM_AUTO) &&
571 pm_runtime_autosuspend_expiration(dev) != 0)
574 pm_runtime_cancel_pending(dev);
580 * rpm_resume - Carry out runtime resume of given device.
581 * @dev: Device to resume.
582 * @rpmflags: Flag bits.
584 * Check if the device's runtime PM status allows it to be resumed. Cancel
585 * any scheduled or pending requests. If another resume has been started
586 * earlier, either return immediately or wait for it to finish, depending on the
587 * RPM_NOWAIT and RPM_ASYNC flags. Similarly, if there's a suspend running in
588 * parallel with this function, either tell the other process to resume after
589 * suspending (deferred_resume) or wait for it to finish. If the RPM_ASYNC
590 * flag is set then queue a resume request; otherwise run the
591 * ->runtime_resume() callback directly. Queue an idle notification for the
592 * device if the resume succeeded.
594 * This function must be called under dev->power.lock with interrupts disabled.
596 static int rpm_resume(struct device *dev, int rpmflags)
597 __releases(&dev->power.lock) __acquires(&dev->power.lock)
599 int (*callback)(struct device *);
600 struct device *parent = NULL;
603 trace_rpm_resume(dev, rpmflags);
606 if (dev->power.runtime_error)
608 else if (dev->power.disable_depth == 1 && dev->power.is_suspended
609 && dev->power.runtime_status == RPM_ACTIVE)
611 else if (dev->power.disable_depth > 0)
617 * Other scheduled or pending requests need to be canceled. Small
618 * optimization: If an autosuspend timer is running, leave it running
619 * rather than cancelling it now only to restart it again in the near
622 dev->power.request = RPM_REQ_NONE;
623 if (!dev->power.timer_autosuspends)
624 pm_runtime_deactivate_timer(dev);
626 if (dev->power.runtime_status == RPM_ACTIVE) {
631 if (dev->power.runtime_status == RPM_RESUMING
632 || dev->power.runtime_status == RPM_SUSPENDING) {
635 if (rpmflags & (RPM_ASYNC | RPM_NOWAIT)) {
636 if (dev->power.runtime_status == RPM_SUSPENDING)
637 dev->power.deferred_resume = true;
639 retval = -EINPROGRESS;
643 if (dev->power.irq_safe) {
644 spin_unlock(&dev->power.lock);
648 spin_lock(&dev->power.lock);
652 /* Wait for the operation carried out in parallel with us. */
654 prepare_to_wait(&dev->power.wait_queue, &wait,
655 TASK_UNINTERRUPTIBLE);
656 if (dev->power.runtime_status != RPM_RESUMING
657 && dev->power.runtime_status != RPM_SUSPENDING)
660 spin_unlock_irq(&dev->power.lock);
664 spin_lock_irq(&dev->power.lock);
666 finish_wait(&dev->power.wait_queue, &wait);
671 * See if we can skip waking up the parent. This is safe only if
672 * power.no_callbacks is set, because otherwise we don't know whether
673 * the resume will actually succeed.
675 if (dev->power.no_callbacks && !parent && dev->parent) {
676 spin_lock_nested(&dev->parent->power.lock, SINGLE_DEPTH_NESTING);
677 if (dev->parent->power.disable_depth > 0
678 || dev->parent->power.ignore_children
679 || dev->parent->power.runtime_status == RPM_ACTIVE) {
680 atomic_inc(&dev->parent->power.child_count);
681 spin_unlock(&dev->parent->power.lock);
683 goto no_callback; /* Assume success. */
685 spin_unlock(&dev->parent->power.lock);
688 /* Carry out an asynchronous or a synchronous resume. */
689 if (rpmflags & RPM_ASYNC) {
690 dev->power.request = RPM_REQ_RESUME;
691 if (!dev->power.request_pending) {
692 dev->power.request_pending = true;
693 queue_work(pm_wq, &dev->power.work);
699 if (!parent && dev->parent) {
701 * Increment the parent's usage counter and resume it if
702 * necessary. Not needed if dev is irq-safe; then the
703 * parent is permanently resumed.
705 parent = dev->parent;
706 if (dev->power.irq_safe)
708 spin_unlock(&dev->power.lock);
710 pm_runtime_get_noresume(parent);
712 spin_lock(&parent->power.lock);
714 * We can resume if the parent's runtime PM is disabled or it
715 * is set to ignore children.
717 if (!parent->power.disable_depth
718 && !parent->power.ignore_children) {
719 rpm_resume(parent, 0);
720 if (parent->power.runtime_status != RPM_ACTIVE)
723 spin_unlock(&parent->power.lock);
725 spin_lock(&dev->power.lock);
732 if (dev->power.no_callbacks)
733 goto no_callback; /* Assume success. */
735 __update_runtime_status(dev, RPM_RESUMING);
737 callback = RPM_GET_CALLBACK(dev, runtime_resume);
739 retval = rpm_callback(callback, dev);
741 __update_runtime_status(dev, RPM_SUSPENDED);
742 pm_runtime_cancel_pending(dev);
745 __update_runtime_status(dev, RPM_ACTIVE);
747 atomic_inc(&parent->power.child_count);
749 wake_up_all(&dev->power.wait_queue);
752 rpm_idle(dev, RPM_ASYNC);
755 if (parent && !dev->power.irq_safe) {
756 spin_unlock_irq(&dev->power.lock);
758 pm_runtime_put(parent);
760 spin_lock_irq(&dev->power.lock);
763 trace_rpm_return_int(dev, _THIS_IP_, retval);
769 * pm_runtime_work - Universal runtime PM work function.
770 * @work: Work structure used for scheduling the execution of this function.
772 * Use @work to get the device object the work is to be done for, determine what
773 * is to be done and execute the appropriate runtime PM function.
775 static void pm_runtime_work(struct work_struct *work)
777 struct device *dev = container_of(work, struct device, power.work);
778 enum rpm_request req;
780 spin_lock_irq(&dev->power.lock);
782 if (!dev->power.request_pending)
785 req = dev->power.request;
786 dev->power.request = RPM_REQ_NONE;
787 dev->power.request_pending = false;
793 rpm_idle(dev, RPM_NOWAIT);
795 case RPM_REQ_SUSPEND:
796 rpm_suspend(dev, RPM_NOWAIT);
798 case RPM_REQ_AUTOSUSPEND:
799 rpm_suspend(dev, RPM_NOWAIT | RPM_AUTO);
802 rpm_resume(dev, RPM_NOWAIT);
807 spin_unlock_irq(&dev->power.lock);
811 * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
812 * @data: Device pointer passed by pm_schedule_suspend().
814 * Check if the time is right and queue a suspend request.
816 static void pm_suspend_timer_fn(unsigned long data)
818 struct device *dev = (struct device *)data;
820 unsigned long expires;
822 spin_lock_irqsave(&dev->power.lock, flags);
824 expires = dev->power.timer_expires;
825 /* If 'expire' is after 'jiffies' we've been called too early. */
826 if (expires > 0 && !time_after(expires, jiffies)) {
827 dev->power.timer_expires = 0;
828 rpm_suspend(dev, dev->power.timer_autosuspends ?
829 (RPM_ASYNC | RPM_AUTO) : RPM_ASYNC);
832 spin_unlock_irqrestore(&dev->power.lock, flags);
836 * pm_schedule_suspend - Set up a timer to submit a suspend request in future.
837 * @dev: Device to suspend.
838 * @delay: Time to wait before submitting a suspend request, in milliseconds.
840 int pm_schedule_suspend(struct device *dev, unsigned int delay)
845 spin_lock_irqsave(&dev->power.lock, flags);
848 retval = rpm_suspend(dev, RPM_ASYNC);
852 retval = rpm_check_suspend_allowed(dev);
856 /* Other scheduled or pending requests need to be canceled. */
857 pm_runtime_cancel_pending(dev);
859 dev->power.timer_expires = jiffies + msecs_to_jiffies(delay);
860 dev->power.timer_expires += !dev->power.timer_expires;
861 dev->power.timer_autosuspends = 0;
862 mod_timer(&dev->power.suspend_timer, dev->power.timer_expires);
865 spin_unlock_irqrestore(&dev->power.lock, flags);
869 EXPORT_SYMBOL_GPL(pm_schedule_suspend);
872 * __pm_runtime_idle - Entry point for runtime idle operations.
873 * @dev: Device to send idle notification for.
874 * @rpmflags: Flag bits.
876 * If the RPM_GET_PUT flag is set, decrement the device's usage count and
877 * return immediately if it is larger than zero. Then carry out an idle
878 * notification, either synchronous or asynchronous.
880 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
881 * or if pm_runtime_irq_safe() has been called.
883 int __pm_runtime_idle(struct device *dev, int rpmflags)
888 might_sleep_if(!(rpmflags & RPM_ASYNC) && !dev->power.irq_safe);
890 if (rpmflags & RPM_GET_PUT) {
891 if (!atomic_dec_and_test(&dev->power.usage_count))
895 spin_lock_irqsave(&dev->power.lock, flags);
896 retval = rpm_idle(dev, rpmflags);
897 spin_unlock_irqrestore(&dev->power.lock, flags);
901 EXPORT_SYMBOL_GPL(__pm_runtime_idle);
904 * __pm_runtime_suspend - Entry point for runtime put/suspend operations.
905 * @dev: Device to suspend.
906 * @rpmflags: Flag bits.
908 * If the RPM_GET_PUT flag is set, decrement the device's usage count and
909 * return immediately if it is larger than zero. Then carry out a suspend,
910 * either synchronous or asynchronous.
912 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
913 * or if pm_runtime_irq_safe() has been called.
915 int __pm_runtime_suspend(struct device *dev, int rpmflags)
920 might_sleep_if(!(rpmflags & RPM_ASYNC) && !dev->power.irq_safe);
922 if (rpmflags & RPM_GET_PUT) {
923 if (!atomic_dec_and_test(&dev->power.usage_count))
927 spin_lock_irqsave(&dev->power.lock, flags);
928 retval = rpm_suspend(dev, rpmflags);
929 spin_unlock_irqrestore(&dev->power.lock, flags);
933 EXPORT_SYMBOL_GPL(__pm_runtime_suspend);
936 * __pm_runtime_resume - Entry point for runtime resume operations.
937 * @dev: Device to resume.
938 * @rpmflags: Flag bits.
940 * If the RPM_GET_PUT flag is set, increment the device's usage count. Then
941 * carry out a resume, either synchronous or asynchronous.
943 * This routine may be called in atomic context if the RPM_ASYNC flag is set,
944 * or if pm_runtime_irq_safe() has been called.
946 int __pm_runtime_resume(struct device *dev, int rpmflags)
951 might_sleep_if(!(rpmflags & RPM_ASYNC) && !dev->power.irq_safe);
953 if (rpmflags & RPM_GET_PUT)
954 atomic_inc(&dev->power.usage_count);
956 spin_lock_irqsave(&dev->power.lock, flags);
957 retval = rpm_resume(dev, rpmflags);
958 spin_unlock_irqrestore(&dev->power.lock, flags);
962 EXPORT_SYMBOL_GPL(__pm_runtime_resume);
965 * __pm_runtime_set_status - Set runtime PM status of a device.
966 * @dev: Device to handle.
967 * @status: New runtime PM status of the device.
969 * If runtime PM of the device is disabled or its power.runtime_error field is
970 * different from zero, the status may be changed either to RPM_ACTIVE, or to
971 * RPM_SUSPENDED, as long as that reflects the actual state of the device.
972 * However, if the device has a parent and the parent is not active, and the
973 * parent's power.ignore_children flag is unset, the device's status cannot be
974 * set to RPM_ACTIVE, so -EBUSY is returned in that case.
976 * If successful, __pm_runtime_set_status() clears the power.runtime_error field
977 * and the device parent's counter of unsuspended children is modified to
978 * reflect the new status. If the new status is RPM_SUSPENDED, an idle
979 * notification request for the parent is submitted.
981 int __pm_runtime_set_status(struct device *dev, unsigned int status)
983 struct device *parent = dev->parent;
985 bool notify_parent = false;
988 if (status != RPM_ACTIVE && status != RPM_SUSPENDED)
991 spin_lock_irqsave(&dev->power.lock, flags);
993 if (!dev->power.runtime_error && !dev->power.disable_depth) {
998 if (dev->power.runtime_status == status)
1001 if (status == RPM_SUSPENDED) {
1002 /* It always is possible to set the status to 'suspended'. */
1004 atomic_add_unless(&parent->power.child_count, -1, 0);
1005 notify_parent = !parent->power.ignore_children;
1011 spin_lock_nested(&parent->power.lock, SINGLE_DEPTH_NESTING);
1014 * It is invalid to put an active child under a parent that is
1015 * not active, has runtime PM enabled and the
1016 * 'power.ignore_children' flag unset.
1018 if (!parent->power.disable_depth
1019 && !parent->power.ignore_children
1020 && parent->power.runtime_status != RPM_ACTIVE)
1022 else if (dev->power.runtime_status == RPM_SUSPENDED)
1023 atomic_inc(&parent->power.child_count);
1025 spin_unlock(&parent->power.lock);
1032 __update_runtime_status(dev, status);
1033 dev->power.runtime_error = 0;
1035 spin_unlock_irqrestore(&dev->power.lock, flags);
1038 pm_request_idle(parent);
1042 EXPORT_SYMBOL_GPL(__pm_runtime_set_status);
1045 * __pm_runtime_barrier - Cancel pending requests and wait for completions.
1046 * @dev: Device to handle.
1048 * Flush all pending requests for the device from pm_wq and wait for all
1049 * runtime PM operations involving the device in progress to complete.
1051 * Should be called under dev->power.lock with interrupts disabled.
1053 static void __pm_runtime_barrier(struct device *dev)
1055 pm_runtime_deactivate_timer(dev);
1057 if (dev->power.request_pending) {
1058 dev->power.request = RPM_REQ_NONE;
1059 spin_unlock_irq(&dev->power.lock);
1061 cancel_work_sync(&dev->power.work);
1063 spin_lock_irq(&dev->power.lock);
1064 dev->power.request_pending = false;
1067 if (dev->power.runtime_status == RPM_SUSPENDING
1068 || dev->power.runtime_status == RPM_RESUMING
1069 || dev->power.idle_notification) {
1072 /* Suspend, wake-up or idle notification in progress. */
1074 prepare_to_wait(&dev->power.wait_queue, &wait,
1075 TASK_UNINTERRUPTIBLE);
1076 if (dev->power.runtime_status != RPM_SUSPENDING
1077 && dev->power.runtime_status != RPM_RESUMING
1078 && !dev->power.idle_notification)
1080 spin_unlock_irq(&dev->power.lock);
1084 spin_lock_irq(&dev->power.lock);
1086 finish_wait(&dev->power.wait_queue, &wait);
1091 * pm_runtime_barrier - Flush pending requests and wait for completions.
1092 * @dev: Device to handle.
1094 * Prevent the device from being suspended by incrementing its usage counter and
1095 * if there's a pending resume request for the device, wake the device up.
1096 * Next, make sure that all pending requests for the device have been flushed
1097 * from pm_wq and wait for all runtime PM operations involving the device in
1098 * progress to complete.
1101 * 1, if there was a resume request pending and the device had to be woken up,
1104 int pm_runtime_barrier(struct device *dev)
1108 pm_runtime_get_noresume(dev);
1109 spin_lock_irq(&dev->power.lock);
1111 if (dev->power.request_pending
1112 && dev->power.request == RPM_REQ_RESUME) {
1117 __pm_runtime_barrier(dev);
1119 spin_unlock_irq(&dev->power.lock);
1120 pm_runtime_put_noidle(dev);
1124 EXPORT_SYMBOL_GPL(pm_runtime_barrier);
1127 * __pm_runtime_disable - Disable runtime PM of a device.
1128 * @dev: Device to handle.
1129 * @check_resume: If set, check if there's a resume request for the device.
1131 * Increment power.disable_depth for the device and if it was zero previously,
1132 * cancel all pending runtime PM requests for the device and wait for all
1133 * operations in progress to complete. The device can be either active or
1134 * suspended after its runtime PM has been disabled.
1136 * If @check_resume is set and there's a resume request pending when
1137 * __pm_runtime_disable() is called and power.disable_depth is zero, the
1138 * function will wake up the device before disabling its runtime PM.
1140 void __pm_runtime_disable(struct device *dev, bool check_resume)
1142 spin_lock_irq(&dev->power.lock);
1144 if (dev->power.disable_depth > 0) {
1145 dev->power.disable_depth++;
1150 * Wake up the device if there's a resume request pending, because that
1151 * means there probably is some I/O to process and disabling runtime PM
1152 * shouldn't prevent the device from processing the I/O.
1154 if (check_resume && dev->power.request_pending
1155 && dev->power.request == RPM_REQ_RESUME) {
1157 * Prevent suspends and idle notifications from being carried
1158 * out after we have woken up the device.
1160 pm_runtime_get_noresume(dev);
1164 pm_runtime_put_noidle(dev);
1167 if (!dev->power.disable_depth++)
1168 __pm_runtime_barrier(dev);
1171 spin_unlock_irq(&dev->power.lock);
1173 EXPORT_SYMBOL_GPL(__pm_runtime_disable);
1176 * pm_runtime_enable - Enable runtime PM of a device.
1177 * @dev: Device to handle.
1179 void pm_runtime_enable(struct device *dev)
1181 unsigned long flags;
1183 spin_lock_irqsave(&dev->power.lock, flags);
1185 if (dev->power.disable_depth > 0)
1186 dev->power.disable_depth--;
1188 dev_warn(dev, "Unbalanced %s!\n", __func__);
1190 spin_unlock_irqrestore(&dev->power.lock, flags);
1192 EXPORT_SYMBOL_GPL(pm_runtime_enable);
1195 * pm_runtime_forbid - Block runtime PM of a device.
1196 * @dev: Device to handle.
1198 * Increase the device's usage count and clear its power.runtime_auto flag,
1199 * so that it cannot be suspended at run time until pm_runtime_allow() is called
1202 void pm_runtime_forbid(struct device *dev)
1204 spin_lock_irq(&dev->power.lock);
1205 if (!dev->power.runtime_auto)
1208 dev->power.runtime_auto = false;
1209 atomic_inc(&dev->power.usage_count);
1213 spin_unlock_irq(&dev->power.lock);
1215 EXPORT_SYMBOL_GPL(pm_runtime_forbid);
1218 * pm_runtime_allow - Unblock runtime PM of a device.
1219 * @dev: Device to handle.
1221 * Decrease the device's usage count and set its power.runtime_auto flag.
1223 void pm_runtime_allow(struct device *dev)
1225 spin_lock_irq(&dev->power.lock);
1226 if (dev->power.runtime_auto)
1229 dev->power.runtime_auto = true;
1230 if (atomic_dec_and_test(&dev->power.usage_count))
1231 rpm_idle(dev, RPM_AUTO);
1234 spin_unlock_irq(&dev->power.lock);
1236 EXPORT_SYMBOL_GPL(pm_runtime_allow);
1239 * pm_runtime_no_callbacks - Ignore runtime PM callbacks for a device.
1240 * @dev: Device to handle.
1242 * Set the power.no_callbacks flag, which tells the PM core that this
1243 * device is power-managed through its parent and has no runtime PM
1244 * callbacks of its own. The runtime sysfs attributes will be removed.
1246 void pm_runtime_no_callbacks(struct device *dev)
1248 spin_lock_irq(&dev->power.lock);
1249 dev->power.no_callbacks = 1;
1250 spin_unlock_irq(&dev->power.lock);
1251 if (device_is_registered(dev))
1252 rpm_sysfs_remove(dev);
1254 EXPORT_SYMBOL_GPL(pm_runtime_no_callbacks);
1257 * pm_runtime_irq_safe - Leave interrupts disabled during callbacks.
1258 * @dev: Device to handle
1260 * Set the power.irq_safe flag, which tells the PM core that the
1261 * ->runtime_suspend() and ->runtime_resume() callbacks for this device should
1262 * always be invoked with the spinlock held and interrupts disabled. It also
1263 * causes the parent's usage counter to be permanently incremented, preventing
1264 * the parent from runtime suspending -- otherwise an irq-safe child might have
1265 * to wait for a non-irq-safe parent.
1267 void pm_runtime_irq_safe(struct device *dev)
1270 pm_runtime_get_sync(dev->parent);
1271 spin_lock_irq(&dev->power.lock);
1272 dev->power.irq_safe = 1;
1273 spin_unlock_irq(&dev->power.lock);
1275 EXPORT_SYMBOL_GPL(pm_runtime_irq_safe);
1278 * update_autosuspend - Handle a change to a device's autosuspend settings.
1279 * @dev: Device to handle.
1280 * @old_delay: The former autosuspend_delay value.
1281 * @old_use: The former use_autosuspend value.
1283 * Prevent runtime suspend if the new delay is negative and use_autosuspend is
1284 * set; otherwise allow it. Send an idle notification if suspends are allowed.
1286 * This function must be called under dev->power.lock with interrupts disabled.
1288 static void update_autosuspend(struct device *dev, int old_delay, int old_use)
1290 int delay = dev->power.autosuspend_delay;
1292 /* Should runtime suspend be prevented now? */
1293 if (dev->power.use_autosuspend && delay < 0) {
1295 /* If it used to be allowed then prevent it. */
1296 if (!old_use || old_delay >= 0) {
1297 atomic_inc(&dev->power.usage_count);
1302 /* Runtime suspend should be allowed now. */
1305 /* If it used to be prevented then allow it. */
1306 if (old_use && old_delay < 0)
1307 atomic_dec(&dev->power.usage_count);
1309 /* Maybe we can autosuspend now. */
1310 rpm_idle(dev, RPM_AUTO);
1315 * pm_runtime_set_autosuspend_delay - Set a device's autosuspend_delay value.
1316 * @dev: Device to handle.
1317 * @delay: Value of the new delay in milliseconds.
1319 * Set the device's power.autosuspend_delay value. If it changes to negative
1320 * and the power.use_autosuspend flag is set, prevent runtime suspends. If it
1321 * changes the other way, allow runtime suspends.
1323 void pm_runtime_set_autosuspend_delay(struct device *dev, int delay)
1325 int old_delay, old_use;
1327 spin_lock_irq(&dev->power.lock);
1328 old_delay = dev->power.autosuspend_delay;
1329 old_use = dev->power.use_autosuspend;
1330 dev->power.autosuspend_delay = delay;
1331 update_autosuspend(dev, old_delay, old_use);
1332 spin_unlock_irq(&dev->power.lock);
1334 EXPORT_SYMBOL_GPL(pm_runtime_set_autosuspend_delay);
1337 * __pm_runtime_use_autosuspend - Set a device's use_autosuspend flag.
1338 * @dev: Device to handle.
1339 * @use: New value for use_autosuspend.
1341 * Set the device's power.use_autosuspend flag, and allow or prevent runtime
1342 * suspends as needed.
1344 void __pm_runtime_use_autosuspend(struct device *dev, bool use)
1346 int old_delay, old_use;
1348 spin_lock_irq(&dev->power.lock);
1349 old_delay = dev->power.autosuspend_delay;
1350 old_use = dev->power.use_autosuspend;
1351 dev->power.use_autosuspend = use;
1352 update_autosuspend(dev, old_delay, old_use);
1353 spin_unlock_irq(&dev->power.lock);
1355 EXPORT_SYMBOL_GPL(__pm_runtime_use_autosuspend);
1358 * pm_runtime_init - Initialize runtime PM fields in given device object.
1359 * @dev: Device object to initialize.
1361 void pm_runtime_init(struct device *dev)
1363 dev->power.runtime_status = RPM_SUSPENDED;
1364 dev->power.idle_notification = false;
1366 dev->power.disable_depth = 1;
1367 atomic_set(&dev->power.usage_count, 0);
1369 dev->power.runtime_error = 0;
1371 atomic_set(&dev->power.child_count, 0);
1372 pm_suspend_ignore_children(dev, false);
1373 dev->power.runtime_auto = true;
1375 dev->power.request_pending = false;
1376 dev->power.request = RPM_REQ_NONE;
1377 dev->power.deferred_resume = false;
1378 dev->power.accounting_timestamp = jiffies;
1379 INIT_WORK(&dev->power.work, pm_runtime_work);
1381 dev->power.timer_expires = 0;
1382 setup_timer(&dev->power.suspend_timer, pm_suspend_timer_fn,
1383 (unsigned long)dev);
1385 init_waitqueue_head(&dev->power.wait_queue);
1389 * pm_runtime_remove - Prepare for removing a device from device hierarchy.
1390 * @dev: Device object being removed from device hierarchy.
1392 void pm_runtime_remove(struct device *dev)
1394 __pm_runtime_disable(dev, false);
1396 /* Change the status back to 'suspended' to match the initial status. */
1397 if (dev->power.runtime_status == RPM_ACTIVE)
1398 pm_runtime_set_suspended(dev);
1399 if (dev->power.irq_safe && dev->parent)
1400 pm_runtime_put(dev->parent);
1405 * pm_runtime_force_suspend - Force a device into suspend state if needed.
1406 * @dev: Device to suspend.
1408 * Disable runtime PM so we safely can check the device's runtime PM status and
1409 * if it is active, invoke it's .runtime_suspend callback to bring it into
1410 * suspend state. Keep runtime PM disabled to preserve the state unless we
1413 * Typically this function may be invoked from a system suspend callback to make
1414 * sure the device is put into low power state.
1416 int pm_runtime_force_suspend(struct device *dev)
1418 int (*callback)(struct device *);
1421 pm_runtime_disable(dev);
1424 * Note that pm_runtime_status_suspended() returns false while
1425 * !CONFIG_PM_RUNTIME, which means the device will be put into low
1428 if (pm_runtime_status_suspended(dev))
1431 callback = RPM_GET_CALLBACK(dev, runtime_suspend);
1438 ret = callback(dev);
1442 pm_runtime_set_suspended(dev);
1445 pm_runtime_enable(dev);
1448 EXPORT_SYMBOL_GPL(pm_runtime_force_suspend);
1451 * pm_runtime_force_resume - Force a device into resume state.
1452 * @dev: Device to resume.
1454 * Prior invoking this function we expect the user to have brought the device
1455 * into low power state by a call to pm_runtime_force_suspend(). Here we reverse
1456 * those actions and brings the device into full power. We update the runtime PM
1457 * status and re-enables runtime PM.
1459 * Typically this function may be invoked from a system resume callback to make
1460 * sure the device is put into full power state.
1462 int pm_runtime_force_resume(struct device *dev)
1464 int (*callback)(struct device *);
1467 callback = RPM_GET_CALLBACK(dev, runtime_resume);
1474 ret = callback(dev);
1478 pm_runtime_set_active(dev);
1479 pm_runtime_mark_last_busy(dev);
1481 pm_runtime_enable(dev);
1484 EXPORT_SYMBOL_GPL(pm_runtime_force_resume);