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