xref: /linux/include/linux/pm_runtime.h (revision 53edfecef66bfa65882ae065ed1a52f466c88979)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * pm_runtime.h - Device run-time power management helper functions.
4  *
5  * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
6  */
7 
8 #ifndef _LINUX_PM_RUNTIME_H
9 #define _LINUX_PM_RUNTIME_H
10 
11 #include <linux/device.h>
12 #include <linux/notifier.h>
13 #include <linux/pm.h>
14 
15 #include <linux/jiffies.h>
16 
17 /* Runtime PM flag argument bits */
18 #define RPM_ASYNC		0x01	/* Request is asynchronous */
19 #define RPM_NOWAIT		0x02	/* Don't wait for concurrent
20 					    state change */
21 #define RPM_GET_PUT		0x04	/* Increment/decrement the
22 					    usage_count */
23 #define RPM_AUTO		0x08	/* Use autosuspend_delay */
24 
25 /*
26  * Use this for defining a set of PM operations to be used in all situations
27  * (system suspend, hibernation or runtime PM).
28  *
29  * Note that the behaviour differs from the deprecated UNIVERSAL_DEV_PM_OPS()
30  * macro, which uses the provided callbacks for both runtime PM and system
31  * sleep, while DEFINE_RUNTIME_DEV_PM_OPS() uses pm_runtime_force_suspend()
32  * and pm_runtime_force_resume() for its system sleep callbacks.
33  *
34  * If the underlying dev_pm_ops struct symbol has to be exported, use
35  * EXPORT_RUNTIME_DEV_PM_OPS() or EXPORT_GPL_RUNTIME_DEV_PM_OPS() instead.
36  */
37 #define DEFINE_RUNTIME_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn) \
38 	_DEFINE_DEV_PM_OPS(name, pm_runtime_force_suspend, \
39 			   pm_runtime_force_resume, suspend_fn, \
40 			   resume_fn, idle_fn)
41 
42 #define EXPORT_RUNTIME_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn) \
43 	EXPORT_DEV_PM_OPS(name) = { \
44 		RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) \
45 	}
46 #define EXPORT_GPL_RUNTIME_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn) \
47 	EXPORT_GPL_DEV_PM_OPS(name) = { \
48 		RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) \
49 	}
50 #define EXPORT_NS_RUNTIME_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn, ns) \
51 	EXPORT_NS_DEV_PM_OPS(name, ns) = { \
52 		RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) \
53 	}
54 #define EXPORT_NS_GPL_RUNTIME_DEV_PM_OPS(name, suspend_fn, resume_fn, idle_fn, ns) \
55 	EXPORT_NS_GPL_DEV_PM_OPS(name, ns) = { \
56 		RUNTIME_PM_OPS(suspend_fn, resume_fn, idle_fn) \
57 	}
58 
59 #ifdef CONFIG_PM
60 extern struct workqueue_struct *pm_wq;
61 
queue_pm_work(struct work_struct * work)62 static inline bool queue_pm_work(struct work_struct *work)
63 {
64 	return queue_work(pm_wq, work);
65 }
66 
67 extern int pm_generic_runtime_suspend(struct device *dev);
68 extern int pm_generic_runtime_resume(struct device *dev);
69 extern int pm_runtime_force_suspend(struct device *dev);
70 
71 extern int __pm_runtime_idle(struct device *dev, int rpmflags);
72 extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
73 extern int __pm_runtime_resume(struct device *dev, int rpmflags);
74 extern int pm_runtime_get_if_active(struct device *dev);
75 extern int pm_runtime_get_if_in_use(struct device *dev);
76 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
77 extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
78 extern int pm_runtime_barrier(struct device *dev);
79 extern bool pm_runtime_block_if_disabled(struct device *dev);
80 extern void pm_runtime_unblock(struct device *dev);
81 extern void pm_runtime_enable(struct device *dev);
82 extern void __pm_runtime_disable(struct device *dev, bool check_resume);
83 extern void pm_runtime_allow(struct device *dev);
84 extern void pm_runtime_forbid(struct device *dev);
85 extern void pm_runtime_no_callbacks(struct device *dev);
86 extern void pm_runtime_irq_safe(struct device *dev);
87 extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
88 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
89 extern u64 pm_runtime_autosuspend_expiration(struct device *dev);
90 extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
91 extern void pm_runtime_get_suppliers(struct device *dev);
92 extern void pm_runtime_put_suppliers(struct device *dev);
93 extern void pm_runtime_new_link(struct device *dev);
94 extern void pm_runtime_drop_link(struct device_link *link);
95 extern void pm_runtime_release_supplier(struct device_link *link);
96 
97 int devm_pm_runtime_set_active_enabled(struct device *dev);
98 extern int devm_pm_runtime_enable(struct device *dev);
99 int devm_pm_runtime_get_noresume(struct device *dev);
100 
101 /**
102  * pm_suspend_ignore_children - Set runtime PM behavior regarding children.
103  * @dev: Target device.
104  * @enable: Whether or not to ignore possible dependencies on children.
105  *
106  * The dependencies of @dev on its children will not be taken into account by
107  * the runtime PM framework going forward if @enable is %true, or they will
108  * be taken into account otherwise.
109  */
pm_suspend_ignore_children(struct device * dev,bool enable)110 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
111 {
112 	dev->power.ignore_children = enable;
113 }
114 
115 /**
116  * pm_runtime_get_noresume - Bump up runtime PM usage counter of a device.
117  * @dev: Target device.
118  */
pm_runtime_get_noresume(struct device * dev)119 static inline void pm_runtime_get_noresume(struct device *dev)
120 {
121 	atomic_inc(&dev->power.usage_count);
122 }
123 
124 /**
125  * pm_runtime_put_noidle - Drop runtime PM usage counter of a device.
126  * @dev: Target device.
127  *
128  * Decrement the runtime PM usage counter of @dev unless it is 0 already.
129  */
pm_runtime_put_noidle(struct device * dev)130 static inline void pm_runtime_put_noidle(struct device *dev)
131 {
132 	atomic_add_unless(&dev->power.usage_count, -1, 0);
133 }
134 
135 /**
136  * pm_runtime_suspended - Check whether or not a device is runtime-suspended.
137  * @dev: Target device.
138  *
139  * Return %true if runtime PM is enabled for @dev and its runtime PM status is
140  * %RPM_SUSPENDED, or %false otherwise.
141  *
142  * Note that the return value of this function can only be trusted if it is
143  * called under the runtime PM lock of @dev or under conditions in which
144  * runtime PM cannot be either disabled or enabled for @dev and its runtime PM
145  * status cannot change.
146  */
pm_runtime_suspended(struct device * dev)147 static inline bool pm_runtime_suspended(struct device *dev)
148 {
149 	return dev->power.runtime_status == RPM_SUSPENDED
150 		&& !dev->power.disable_depth;
151 }
152 
153 /**
154  * pm_runtime_active - Check whether or not a device is runtime-active.
155  * @dev: Target device.
156  *
157  * Return %true if runtime PM is disabled for @dev or its runtime PM status is
158  * %RPM_ACTIVE, or %false otherwise.
159  *
160  * Note that the return value of this function can only be trusted if it is
161  * called under the runtime PM lock of @dev or under conditions in which
162  * runtime PM cannot be either disabled or enabled for @dev and its runtime PM
163  * status cannot change.
164  */
pm_runtime_active(struct device * dev)165 static inline bool pm_runtime_active(struct device *dev)
166 {
167 	return dev->power.runtime_status == RPM_ACTIVE
168 		|| dev->power.disable_depth;
169 }
170 
171 /**
172  * pm_runtime_status_suspended - Check if runtime PM status is "suspended".
173  * @dev: Target device.
174  *
175  * Return %true if the runtime PM status of @dev is %RPM_SUSPENDED, or %false
176  * otherwise, regardless of whether or not runtime PM has been enabled for @dev.
177  *
178  * Note that the return value of this function can only be trusted if it is
179  * called under the runtime PM lock of @dev or under conditions in which the
180  * runtime PM status of @dev cannot change.
181  */
pm_runtime_status_suspended(struct device * dev)182 static inline bool pm_runtime_status_suspended(struct device *dev)
183 {
184 	return dev->power.runtime_status == RPM_SUSPENDED;
185 }
186 
187 /**
188  * pm_runtime_enabled - Check if runtime PM is enabled.
189  * @dev: Target device.
190  *
191  * Return %true if runtime PM is enabled for @dev or %false otherwise.
192  *
193  * Note that the return value of this function can only be trusted if it is
194  * called under the runtime PM lock of @dev or under conditions in which
195  * runtime PM cannot be either disabled or enabled for @dev.
196  */
pm_runtime_enabled(struct device * dev)197 static inline bool pm_runtime_enabled(struct device *dev)
198 {
199 	return !dev->power.disable_depth;
200 }
201 
202 /**
203  * pm_runtime_blocked - Check if runtime PM enabling is blocked.
204  * @dev: Target device.
205  *
206  * Do not call this function outside system suspend/resume code paths.
207  */
pm_runtime_blocked(struct device * dev)208 static inline bool pm_runtime_blocked(struct device *dev)
209 {
210 	return dev->power.last_status == RPM_BLOCKED;
211 }
212 
213 /**
214  * pm_runtime_has_no_callbacks - Check if runtime PM callbacks may be present.
215  * @dev: Target device.
216  *
217  * Return %true if @dev is a special device without runtime PM callbacks or
218  * %false otherwise.
219  */
pm_runtime_has_no_callbacks(struct device * dev)220 static inline bool pm_runtime_has_no_callbacks(struct device *dev)
221 {
222 	return dev->power.no_callbacks;
223 }
224 
225 /**
226  * pm_runtime_mark_last_busy - Update the last access time of a device.
227  * @dev: Target device.
228  *
229  * Update the last access time of @dev used by the runtime PM autosuspend
230  * mechanism to the current time as returned by ktime_get_mono_fast_ns().
231  */
pm_runtime_mark_last_busy(struct device * dev)232 static inline void pm_runtime_mark_last_busy(struct device *dev)
233 {
234 	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());
235 }
236 
237 /**
238  * pm_runtime_is_irq_safe - Check if runtime PM can work in interrupt context.
239  * @dev: Target device.
240  *
241  * Return %true if @dev has been marked as an "IRQ-safe" device (with respect
242  * to runtime PM), in which case its runtime PM callabcks can be expected to
243  * work correctly when invoked from interrupt handlers.
244  */
pm_runtime_is_irq_safe(struct device * dev)245 static inline bool pm_runtime_is_irq_safe(struct device *dev)
246 {
247 	return dev->power.irq_safe;
248 }
249 
250 extern u64 pm_runtime_suspended_time(struct device *dev);
251 
252 #else /* !CONFIG_PM */
253 
queue_pm_work(struct work_struct * work)254 static inline bool queue_pm_work(struct work_struct *work) { return false; }
255 
pm_generic_runtime_suspend(struct device * dev)256 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
pm_generic_runtime_resume(struct device * dev)257 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
pm_runtime_force_suspend(struct device * dev)258 static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
259 
__pm_runtime_idle(struct device * dev,int rpmflags)260 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
261 {
262 	return -ENOSYS;
263 }
__pm_runtime_suspend(struct device * dev,int rpmflags)264 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
265 {
266 	return -ENOSYS;
267 }
__pm_runtime_resume(struct device * dev,int rpmflags)268 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
269 {
270 	return 1;
271 }
pm_schedule_suspend(struct device * dev,unsigned int delay)272 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
273 {
274 	return -ENOSYS;
275 }
pm_runtime_get_if_in_use(struct device * dev)276 static inline int pm_runtime_get_if_in_use(struct device *dev)
277 {
278 	return -EINVAL;
279 }
pm_runtime_get_if_active(struct device * dev)280 static inline int pm_runtime_get_if_active(struct device *dev)
281 {
282 	return -EINVAL;
283 }
__pm_runtime_set_status(struct device * dev,unsigned int status)284 static inline int __pm_runtime_set_status(struct device *dev,
285 					    unsigned int status) { return 0; }
pm_runtime_barrier(struct device * dev)286 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
pm_runtime_block_if_disabled(struct device * dev)287 static inline bool pm_runtime_block_if_disabled(struct device *dev) { return true; }
pm_runtime_unblock(struct device * dev)288 static inline void pm_runtime_unblock(struct device *dev) {}
pm_runtime_enable(struct device * dev)289 static inline void pm_runtime_enable(struct device *dev) {}
__pm_runtime_disable(struct device * dev,bool c)290 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
pm_runtime_blocked(struct device * dev)291 static inline bool pm_runtime_blocked(struct device *dev) { return true; }
pm_runtime_allow(struct device * dev)292 static inline void pm_runtime_allow(struct device *dev) {}
pm_runtime_forbid(struct device * dev)293 static inline void pm_runtime_forbid(struct device *dev) {}
294 
devm_pm_runtime_set_active_enabled(struct device * dev)295 static inline int devm_pm_runtime_set_active_enabled(struct device *dev) { return 0; }
devm_pm_runtime_enable(struct device * dev)296 static inline int devm_pm_runtime_enable(struct device *dev) { return 0; }
devm_pm_runtime_get_noresume(struct device * dev)297 static inline int devm_pm_runtime_get_noresume(struct device *dev) { return 0; }
298 
pm_suspend_ignore_children(struct device * dev,bool enable)299 static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
pm_runtime_get_noresume(struct device * dev)300 static inline void pm_runtime_get_noresume(struct device *dev) {}
pm_runtime_put_noidle(struct device * dev)301 static inline void pm_runtime_put_noidle(struct device *dev) {}
pm_runtime_suspended(struct device * dev)302 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
pm_runtime_active(struct device * dev)303 static inline bool pm_runtime_active(struct device *dev) { return true; }
pm_runtime_status_suspended(struct device * dev)304 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
pm_runtime_enabled(struct device * dev)305 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
306 
pm_runtime_no_callbacks(struct device * dev)307 static inline void pm_runtime_no_callbacks(struct device *dev) {}
pm_runtime_irq_safe(struct device * dev)308 static inline void pm_runtime_irq_safe(struct device *dev) {}
pm_runtime_is_irq_safe(struct device * dev)309 static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
310 
pm_runtime_has_no_callbacks(struct device * dev)311 static inline bool pm_runtime_has_no_callbacks(struct device *dev) { return false; }
pm_runtime_mark_last_busy(struct device * dev)312 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
__pm_runtime_use_autosuspend(struct device * dev,bool use)313 static inline void __pm_runtime_use_autosuspend(struct device *dev,
314 						bool use) {}
pm_runtime_set_autosuspend_delay(struct device * dev,int delay)315 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
316 						int delay) {}
pm_runtime_autosuspend_expiration(struct device * dev)317 static inline u64 pm_runtime_autosuspend_expiration(
318 				struct device *dev) { return 0; }
pm_runtime_set_memalloc_noio(struct device * dev,bool enable)319 static inline void pm_runtime_set_memalloc_noio(struct device *dev,
320 						bool enable){}
pm_runtime_get_suppliers(struct device * dev)321 static inline void pm_runtime_get_suppliers(struct device *dev) {}
pm_runtime_put_suppliers(struct device * dev)322 static inline void pm_runtime_put_suppliers(struct device *dev) {}
pm_runtime_new_link(struct device * dev)323 static inline void pm_runtime_new_link(struct device *dev) {}
pm_runtime_drop_link(struct device_link * link)324 static inline void pm_runtime_drop_link(struct device_link *link) {}
pm_runtime_release_supplier(struct device_link * link)325 static inline void pm_runtime_release_supplier(struct device_link *link) {}
326 
327 #endif /* !CONFIG_PM */
328 
329 #ifdef CONFIG_PM_SLEEP
330 
331 bool pm_runtime_need_not_resume(struct device *dev);
332 int pm_runtime_force_resume(struct device *dev);
333 
334 #else /* !CONFIG_PM_SLEEP */
335 
pm_runtime_need_not_resume(struct device * dev)336 static inline bool pm_runtime_need_not_resume(struct device *dev) {return true; }
pm_runtime_force_resume(struct device * dev)337 static inline int pm_runtime_force_resume(struct device *dev) { return -ENXIO; }
338 
339 #endif /* CONFIG_PM_SLEEP */
340 
341 /**
342  * pm_runtime_idle - Conditionally set up autosuspend of a device or suspend it.
343  * @dev: Target device.
344  *
345  * Invoke the "idle check" callback of @dev and, depending on its return value,
346  * set up autosuspend of @dev or suspend it (depending on whether or not
347  * autosuspend has been enabled for it).
348  *
349  * Return:
350  * * 0: Success.
351  * * -EINVAL: Runtime PM error.
352  * * -EACCES: Runtime PM disabled.
353  * * -EAGAIN: Runtime PM usage_count non-zero, Runtime PM status change ongoing
354  *            or device not in %RPM_ACTIVE state.
355  * * -EBUSY: Runtime PM child_count non-zero.
356  * * -EPERM: Device PM QoS resume latency 0.
357  * * -EINPROGRESS: Suspend already in progress.
358  * * -ENOSYS: CONFIG_PM not enabled.
359  * * 1: Device already suspended.
360  * Other values and conditions for the above values are possible as returned by
361  * Runtime PM idle and suspend callbacks.
362  */
pm_runtime_idle(struct device * dev)363 static inline int pm_runtime_idle(struct device *dev)
364 {
365 	return __pm_runtime_idle(dev, 0);
366 }
367 
368 /**
369  * pm_runtime_suspend - Suspend a device synchronously.
370  * @dev: Target device.
371  *
372  * Return:
373  * * 0: Success.
374  * * -EINVAL: Runtime PM error.
375  * * -EACCES: Runtime PM disabled.
376  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
377  * * -EBUSY: Runtime PM child_count non-zero.
378  * * -EPERM: Device PM QoS resume latency 0.
379  * * -ENOSYS: CONFIG_PM not enabled.
380  * * 1: Device already suspended.
381  * Other values and conditions for the above values are possible as returned by
382  * Runtime PM suspend callbacks.
383  */
pm_runtime_suspend(struct device * dev)384 static inline int pm_runtime_suspend(struct device *dev)
385 {
386 	return __pm_runtime_suspend(dev, 0);
387 }
388 
389 /**
390  * pm_runtime_autosuspend - Update the last access time and set up autosuspend
391  * of a device.
392  * @dev: Target device.
393  *
394  * First update the last access time, then set up autosuspend of @dev or suspend
395  * it (depending on whether or not autosuspend is enabled for it) without
396  * engaging its "idle check" callback.
397  *
398  * Return:
399  * * 0: Success.
400  * * -EINVAL: Runtime PM error.
401  * * -EACCES: Runtime PM disabled.
402  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
403  * * -EBUSY: Runtime PM child_count non-zero.
404  * * -EPERM: Device PM QoS resume latency 0.
405  * * -ENOSYS: CONFIG_PM not enabled.
406  * * 1: Device already suspended.
407  * Other values and conditions for the above values are possible as returned by
408  * Runtime PM suspend callbacks.
409  */
pm_runtime_autosuspend(struct device * dev)410 static inline int pm_runtime_autosuspend(struct device *dev)
411 {
412 	pm_runtime_mark_last_busy(dev);
413 	return __pm_runtime_suspend(dev, RPM_AUTO);
414 }
415 
416 /**
417  * pm_runtime_resume - Resume a device synchronously.
418  * @dev: Target device.
419  */
pm_runtime_resume(struct device * dev)420 static inline int pm_runtime_resume(struct device *dev)
421 {
422 	return __pm_runtime_resume(dev, 0);
423 }
424 
425 /**
426  * pm_request_idle - Queue up "idle check" execution for a device.
427  * @dev: Target device.
428  *
429  * Queue up a work item to run an equivalent of pm_runtime_idle() for @dev
430  * asynchronously.
431  *
432  * Return:
433  * * 0: Success.
434  * * -EINVAL: Runtime PM error.
435  * * -EACCES: Runtime PM disabled.
436  * * -EAGAIN: Runtime PM usage_count non-zero, Runtime PM status change ongoing
437  *            or device not in %RPM_ACTIVE state.
438  * * -EBUSY: Runtime PM child_count non-zero.
439  * * -EPERM: Device PM QoS resume latency 0.
440  * * -EINPROGRESS: Suspend already in progress.
441  * * -ENOSYS: CONFIG_PM not enabled.
442  * * 1: Device already suspended.
443  */
pm_request_idle(struct device * dev)444 static inline int pm_request_idle(struct device *dev)
445 {
446 	return __pm_runtime_idle(dev, RPM_ASYNC);
447 }
448 
449 /**
450  * pm_request_resume - Queue up runtime-resume of a device.
451  * @dev: Target device.
452  */
pm_request_resume(struct device * dev)453 static inline int pm_request_resume(struct device *dev)
454 {
455 	return __pm_runtime_resume(dev, RPM_ASYNC);
456 }
457 
458 /**
459  * pm_request_autosuspend - Update the last access time and queue up autosuspend
460  * of a device.
461  * @dev: Target device.
462  *
463  * Update the last access time of a device and queue up a work item to run an
464  * equivalent pm_runtime_autosuspend() for @dev asynchronously.
465  *
466  * Return:
467  * * 0: Success.
468  * * -EINVAL: Runtime PM error.
469  * * -EACCES: Runtime PM disabled.
470  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
471  * * -EBUSY: Runtime PM child_count non-zero.
472  * * -EPERM: Device PM QoS resume latency 0.
473  * * -EINPROGRESS: Suspend already in progress.
474  * * -ENOSYS: CONFIG_PM not enabled.
475  * * 1: Device already suspended.
476  */
pm_request_autosuspend(struct device * dev)477 static inline int pm_request_autosuspend(struct device *dev)
478 {
479 	pm_runtime_mark_last_busy(dev);
480 	return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
481 }
482 
483 /**
484  * pm_runtime_get - Bump up usage counter and queue up resume of a device.
485  * @dev: Target device.
486  *
487  * Bump up the runtime PM usage counter of @dev and queue up a work item to
488  * carry out runtime-resume of it.
489  */
pm_runtime_get(struct device * dev)490 static inline int pm_runtime_get(struct device *dev)
491 {
492 	return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
493 }
494 
495 /**
496  * pm_runtime_get_sync - Bump up usage counter of a device and resume it.
497  * @dev: Target device.
498  *
499  * Bump up the runtime PM usage counter of @dev and carry out runtime-resume of
500  * it synchronously.
501  *
502  * The possible return values of this function are the same as for
503  * pm_runtime_resume() and the runtime PM usage counter of @dev remains
504  * incremented in all cases, even if it returns an error code.
505  * Consider using pm_runtime_resume_and_get() instead of it, especially
506  * if its return value is checked by the caller, as this is likely to result
507  * in cleaner code.
508  */
pm_runtime_get_sync(struct device * dev)509 static inline int pm_runtime_get_sync(struct device *dev)
510 {
511 	return __pm_runtime_resume(dev, RPM_GET_PUT);
512 }
513 
514 /**
515  * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
516  * @dev: Target device.
517  *
518  * Resume @dev synchronously and if that is successful, increment its runtime
519  * PM usage counter. Return 0 if the runtime PM usage counter of @dev has been
520  * incremented or a negative error code otherwise.
521  */
pm_runtime_resume_and_get(struct device * dev)522 static inline int pm_runtime_resume_and_get(struct device *dev)
523 {
524 	int ret;
525 
526 	ret = __pm_runtime_resume(dev, RPM_GET_PUT);
527 	if (ret < 0) {
528 		pm_runtime_put_noidle(dev);
529 		return ret;
530 	}
531 
532 	return 0;
533 }
534 
535 /**
536  * pm_runtime_put - Drop device usage counter and queue up "idle check" if 0.
537  * @dev: Target device.
538  *
539  * Decrement the runtime PM usage counter of @dev and if it turns out to be
540  * equal to 0, queue up a work item for @dev like in pm_request_idle().
541  *
542  * Return:
543  * * 0: Success.
544  * * -EINVAL: Runtime PM error.
545  * * -EACCES: Runtime PM disabled.
546  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
547  * * -EBUSY: Runtime PM child_count non-zero.
548  * * -EPERM: Device PM QoS resume latency 0.
549  * * -EINPROGRESS: Suspend already in progress.
550  * * -ENOSYS: CONFIG_PM not enabled.
551  * * 1: Device already suspended.
552  */
pm_runtime_put(struct device * dev)553 static inline int pm_runtime_put(struct device *dev)
554 {
555 	return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
556 }
557 
DEFINE_FREE(pm_runtime_put,struct device *,if (_T)pm_runtime_put (_T))558 DEFINE_FREE(pm_runtime_put, struct device *, if (_T) pm_runtime_put(_T))
559 
560 /**
561  * __pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
562  * @dev: Target device.
563  *
564  * Decrement the runtime PM usage counter of @dev and if it turns out to be
565  * equal to 0, queue up a work item for @dev like in pm_request_autosuspend().
566  *
567  * Return:
568  * * 0: Success.
569  * * -EINVAL: Runtime PM error.
570  * * -EACCES: Runtime PM disabled.
571  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
572  * * -EBUSY: Runtime PM child_count non-zero.
573  * * -EPERM: Device PM QoS resume latency 0.
574  * * -EINPROGRESS: Suspend already in progress.
575  * * -ENOSYS: CONFIG_PM not enabled.
576  * * 1: Device already suspended.
577  */
578 static inline int __pm_runtime_put_autosuspend(struct device *dev)
579 {
580 	return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
581 }
582 
583 /**
584  * pm_runtime_put_autosuspend - Update the last access time of a device, drop
585  * its usage counter and queue autosuspend if the usage counter becomes 0.
586  * @dev: Target device.
587  *
588  * Update the last access time of @dev, decrement runtime PM usage counter of
589  * @dev and if it turns out to be equal to 0, queue up a work item for @dev like
590  * in pm_request_autosuspend().
591  *
592  * Return:
593  * * 0: Success.
594  * * -EINVAL: Runtime PM error.
595  * * -EACCES: Runtime PM disabled.
596  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
597  * * -EBUSY: Runtime PM child_count non-zero.
598  * * -EPERM: Device PM QoS resume latency 0.
599  * * -EINPROGRESS: Suspend already in progress.
600  * * -ENOSYS: CONFIG_PM not enabled.
601  * * 1: Device already suspended.
602  */
pm_runtime_put_autosuspend(struct device * dev)603 static inline int pm_runtime_put_autosuspend(struct device *dev)
604 {
605 	pm_runtime_mark_last_busy(dev);
606 	return __pm_runtime_put_autosuspend(dev);
607 }
608 
609 /**
610  * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
611  * @dev: Target device.
612  *
613  * Decrement the runtime PM usage counter of @dev and if it turns out to be
614  * equal to 0, invoke the "idle check" callback of @dev and, depending on its
615  * return value, set up autosuspend of @dev or suspend it (depending on whether
616  * or not autosuspend has been enabled for it).
617  *
618  * The runtime PM usage counter of @dev remains decremented in all cases, even
619  * if it returns an error code.
620  *
621  * Return:
622  * * 0: Success.
623  * * -EINVAL: Runtime PM error.
624  * * -EACCES: Runtime PM disabled.
625  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
626  * * -EBUSY: Runtime PM child_count non-zero.
627  * * -EPERM: Device PM QoS resume latency 0.
628  * * -ENOSYS: CONFIG_PM not enabled.
629  * * 1: Device already suspended.
630  * Other values and conditions for the above values are possible as returned by
631  * Runtime PM suspend callbacks.
632  */
pm_runtime_put_sync(struct device * dev)633 static inline int pm_runtime_put_sync(struct device *dev)
634 {
635 	return __pm_runtime_idle(dev, RPM_GET_PUT);
636 }
637 
638 /**
639  * pm_runtime_put_sync_suspend - Drop device usage counter and suspend if 0.
640  * @dev: Target device.
641  *
642  * Decrement the runtime PM usage counter of @dev and if it turns out to be
643  * equal to 0, carry out runtime-suspend of @dev synchronously.
644  *
645  * The runtime PM usage counter of @dev remains decremented in all cases, even
646  * if it returns an error code.
647  *
648  * Return:
649  * * 0: Success.
650  * * -EINVAL: Runtime PM error.
651  * * -EACCES: Runtime PM disabled.
652  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
653  * * -EAGAIN: usage_count non-zero or Runtime PM status change ongoing.
654  * * -EBUSY: Runtime PM child_count non-zero.
655  * * -EPERM: Device PM QoS resume latency 0.
656  * * -ENOSYS: CONFIG_PM not enabled.
657  * * 1: Device already suspended.
658  * Other values and conditions for the above values are possible as returned by
659  * Runtime PM suspend callbacks.
660  */
pm_runtime_put_sync_suspend(struct device * dev)661 static inline int pm_runtime_put_sync_suspend(struct device *dev)
662 {
663 	return __pm_runtime_suspend(dev, RPM_GET_PUT);
664 }
665 
666 /**
667  * pm_runtime_put_sync_autosuspend - Update the last access time of a device,
668  * drop device usage counter and autosuspend if 0.
669  * @dev: Target device.
670  *
671  * Update the last access time of @dev, decrement the runtime PM usage counter
672  * of @dev and if it turns out to be equal to 0, set up autosuspend of @dev or
673  * suspend it synchronously (depending on whether or not autosuspend has been
674  * enabled for it).
675  *
676  * The runtime PM usage counter of @dev remains decremented in all cases, even
677  * if it returns an error code.
678  *
679  * Return:
680  * * 0: Success.
681  * * -EINVAL: Runtime PM error.
682  * * -EACCES: Runtime PM disabled.
683  * * -EAGAIN: Runtime PM usage_count non-zero or Runtime PM status change ongoing.
684  * * -EBUSY: Runtime PM child_count non-zero.
685  * * -EPERM: Device PM QoS resume latency 0.
686  * * -EINPROGRESS: Suspend already in progress.
687  * * -ENOSYS: CONFIG_PM not enabled.
688  * * 1: Device already suspended.
689  * Other values and conditions for the above values are possible as returned by
690  * Runtime PM suspend callbacks.
691  */
pm_runtime_put_sync_autosuspend(struct device * dev)692 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
693 {
694 	pm_runtime_mark_last_busy(dev);
695 	return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
696 }
697 
698 /**
699  * pm_runtime_set_active - Set runtime PM status to "active".
700  * @dev: Target device.
701  *
702  * Set the runtime PM status of @dev to %RPM_ACTIVE and ensure that dependencies
703  * of it will be taken into account.
704  *
705  * It is not valid to call this function for devices with runtime PM enabled.
706  */
pm_runtime_set_active(struct device * dev)707 static inline int pm_runtime_set_active(struct device *dev)
708 {
709 	return __pm_runtime_set_status(dev, RPM_ACTIVE);
710 }
711 
712 /**
713  * pm_runtime_set_suspended - Set runtime PM status to "suspended".
714  * @dev: Target device.
715  *
716  * Set the runtime PM status of @dev to %RPM_SUSPENDED and ensure that
717  * dependencies of it will be taken into account.
718  *
719  * It is not valid to call this function for devices with runtime PM enabled.
720  */
pm_runtime_set_suspended(struct device * dev)721 static inline int pm_runtime_set_suspended(struct device *dev)
722 {
723 	return __pm_runtime_set_status(dev, RPM_SUSPENDED);
724 }
725 
726 /**
727  * pm_runtime_disable - Disable runtime PM for a device.
728  * @dev: Target device.
729  *
730  * Prevent the runtime PM framework from working with @dev by incrementing its
731  * "disable" counter.
732  *
733  * If the counter is zero when this function runs and there is a pending runtime
734  * resume request for @dev, it will be resumed.  If the counter is still zero at
735  * that point, all of the pending runtime PM requests for @dev will be canceled
736  * and all runtime PM operations in progress involving it will be waited for to
737  * complete.
738  *
739  * For each invocation of this function for @dev, there must be a matching
740  * pm_runtime_enable() call, so that runtime PM is eventually enabled for it
741  * again.
742  */
pm_runtime_disable(struct device * dev)743 static inline void pm_runtime_disable(struct device *dev)
744 {
745 	__pm_runtime_disable(dev, true);
746 }
747 
748 /**
749  * pm_runtime_use_autosuspend - Allow autosuspend to be used for a device.
750  * @dev: Target device.
751  *
752  * Allow the runtime PM autosuspend mechanism to be used for @dev whenever
753  * requested (or "autosuspend" will be handled as direct runtime-suspend for
754  * it).
755  *
756  * NOTE: It's important to undo this with pm_runtime_dont_use_autosuspend()
757  * at driver exit time unless your driver initially enabled pm_runtime
758  * with devm_pm_runtime_enable() (which handles it for you).
759  */
pm_runtime_use_autosuspend(struct device * dev)760 static inline void pm_runtime_use_autosuspend(struct device *dev)
761 {
762 	__pm_runtime_use_autosuspend(dev, true);
763 }
764 
765 /**
766  * pm_runtime_dont_use_autosuspend - Prevent autosuspend from being used.
767  * @dev: Target device.
768  *
769  * Prevent the runtime PM autosuspend mechanism from being used for @dev which
770  * means that "autosuspend" will be handled as direct runtime-suspend for it
771  * going forward.
772  */
pm_runtime_dont_use_autosuspend(struct device * dev)773 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
774 {
775 	__pm_runtime_use_autosuspend(dev, false);
776 }
777 
778 #endif
779