1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * pm_runtime.h - Device run-time power management helper functions.
5 * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
8 #ifndef _LINUX_PM_RUNTIME_H
9 #define _LINUX_PM_RUNTIME_H
11 #include <linux/device.h>
12 #include <linux/notifier.h>
15 #include <linux/jiffies.h>
17 /* Runtime PM flag argument bits */
18 #define RPM_ASYNC 0x01 /* Request is asynchronous */
19 #define RPM_NOWAIT 0x02 /* Don't wait for concurrent
21 #define RPM_GET_PUT 0x04 /* Increment/decrement the
23 #define RPM_AUTO 0x08 /* Use autosuspend_delay */
26 extern struct workqueue_struct *pm_wq;
28 static inline bool queue_pm_work(struct work_struct *work)
30 return queue_work(pm_wq, work);
33 extern int pm_generic_runtime_suspend(struct device *dev);
34 extern int pm_generic_runtime_resume(struct device *dev);
35 extern int pm_runtime_force_suspend(struct device *dev);
36 extern int pm_runtime_force_resume(struct device *dev);
38 extern int __pm_runtime_idle(struct device *dev, int rpmflags);
39 extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
40 extern int __pm_runtime_resume(struct device *dev, int rpmflags);
41 extern int pm_runtime_get_if_active(struct device *dev, bool ign_usage_count);
42 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
43 extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
44 extern int pm_runtime_barrier(struct device *dev);
45 extern void pm_runtime_enable(struct device *dev);
46 extern void __pm_runtime_disable(struct device *dev, bool check_resume);
47 extern void pm_runtime_allow(struct device *dev);
48 extern void pm_runtime_forbid(struct device *dev);
49 extern void pm_runtime_no_callbacks(struct device *dev);
50 extern void pm_runtime_irq_safe(struct device *dev);
51 extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
52 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
53 extern u64 pm_runtime_autosuspend_expiration(struct device *dev);
54 extern void pm_runtime_update_max_time_suspended(struct device *dev,
56 extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
57 extern void pm_runtime_get_suppliers(struct device *dev);
58 extern void pm_runtime_put_suppliers(struct device *dev);
59 extern void pm_runtime_new_link(struct device *dev);
60 extern void pm_runtime_drop_link(struct device_link *link);
61 extern void pm_runtime_release_supplier(struct device_link *link);
63 extern int devm_pm_runtime_enable(struct device *dev);
66 * pm_runtime_get_if_in_use - Conditionally bump up runtime PM usage counter.
67 * @dev: Target device.
69 * Increment the runtime PM usage counter of @dev if its runtime PM status is
70 * %RPM_ACTIVE and its runtime PM usage counter is greater than 0.
72 static inline int pm_runtime_get_if_in_use(struct device *dev)
74 return pm_runtime_get_if_active(dev, false);
78 * pm_suspend_ignore_children - Set runtime PM behavior regarding children.
79 * @dev: Target device.
80 * @enable: Whether or not to ignore possible dependencies on children.
82 * The dependencies of @dev on its children will not be taken into account by
83 * the runtime PM framework going forward if @enable is %true, or they will
84 * be taken into account otherwise.
86 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
88 dev->power.ignore_children = enable;
92 * pm_runtime_get_noresume - Bump up runtime PM usage counter of a device.
93 * @dev: Target device.
95 static inline void pm_runtime_get_noresume(struct device *dev)
97 atomic_inc(&dev->power.usage_count);
101 * pm_runtime_put_noidle - Drop runtime PM usage counter of a device.
102 * @dev: Target device.
104 * Decrement the runtime PM usage counter of @dev unless it is 0 already.
106 static inline void pm_runtime_put_noidle(struct device *dev)
108 atomic_add_unless(&dev->power.usage_count, -1, 0);
112 * pm_runtime_suspended - Check whether or not a device is runtime-suspended.
113 * @dev: Target device.
115 * Return %true if runtime PM is enabled for @dev and its runtime PM status is
116 * %RPM_SUSPENDED, or %false otherwise.
118 * Note that the return value of this function can only be trusted if it is
119 * called under the runtime PM lock of @dev or under conditions in which
120 * runtime PM cannot be either disabled or enabled for @dev and its runtime PM
121 * status cannot change.
123 static inline bool pm_runtime_suspended(struct device *dev)
125 return dev->power.runtime_status == RPM_SUSPENDED
126 && !dev->power.disable_depth;
130 * pm_runtime_active - Check whether or not a device is runtime-active.
131 * @dev: Target device.
133 * Return %true if runtime PM is disabled for @dev or its runtime PM status is
134 * %RPM_ACTIVE, or %false otherwise.
136 * Note that the return value of this function can only be trusted if it is
137 * called under the runtime PM lock of @dev or under conditions in which
138 * runtime PM cannot be either disabled or enabled for @dev and its runtime PM
139 * status cannot change.
141 static inline bool pm_runtime_active(struct device *dev)
143 return dev->power.runtime_status == RPM_ACTIVE
144 || dev->power.disable_depth;
148 * pm_runtime_status_suspended - Check if runtime PM status is "suspended".
149 * @dev: Target device.
151 * Return %true if the runtime PM status of @dev is %RPM_SUSPENDED, or %false
152 * otherwise, regardless of whether or not runtime PM has been enabled for @dev.
154 * Note that the return value of this function can only be trusted if it is
155 * called under the runtime PM lock of @dev or under conditions in which the
156 * runtime PM status of @dev cannot change.
158 static inline bool pm_runtime_status_suspended(struct device *dev)
160 return dev->power.runtime_status == RPM_SUSPENDED;
164 * pm_runtime_enabled - Check if runtime PM is enabled.
165 * @dev: Target device.
167 * Return %true if runtime PM is enabled for @dev or %false otherwise.
169 * Note that the return value of this function can only be trusted if it is
170 * called under the runtime PM lock of @dev or under conditions in which
171 * runtime PM cannot be either disabled or enabled for @dev.
173 static inline bool pm_runtime_enabled(struct device *dev)
175 return !dev->power.disable_depth;
179 * pm_runtime_has_no_callbacks - Check if runtime PM callbacks may be present.
180 * @dev: Target device.
182 * Return %true if @dev is a special device without runtime PM callbacks or
185 static inline bool pm_runtime_has_no_callbacks(struct device *dev)
187 return dev->power.no_callbacks;
191 * pm_runtime_mark_last_busy - Update the last access time of a device.
192 * @dev: Target device.
194 * Update the last access time of @dev used by the runtime PM autosuspend
195 * mechanism to the current time as returned by ktime_get_mono_fast_ns().
197 static inline void pm_runtime_mark_last_busy(struct device *dev)
199 WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());
203 * pm_runtime_is_irq_safe - Check if runtime PM can work in interrupt context.
204 * @dev: Target device.
206 * Return %true if @dev has been marked as an "IRQ-safe" device (with respect
207 * to runtime PM), in which case its runtime PM callabcks can be expected to
208 * work correctly when invoked from interrupt handlers.
210 static inline bool pm_runtime_is_irq_safe(struct device *dev)
212 return dev->power.irq_safe;
215 extern u64 pm_runtime_suspended_time(struct device *dev);
217 #else /* !CONFIG_PM */
219 static inline bool queue_pm_work(struct work_struct *work) { return false; }
221 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
222 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
223 static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
224 static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
226 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
230 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
234 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
238 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
242 static inline int pm_runtime_get_if_in_use(struct device *dev)
246 static inline int pm_runtime_get_if_active(struct device *dev,
247 bool ign_usage_count)
251 static inline int __pm_runtime_set_status(struct device *dev,
252 unsigned int status) { return 0; }
253 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
254 static inline void pm_runtime_enable(struct device *dev) {}
255 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
256 static inline void pm_runtime_allow(struct device *dev) {}
257 static inline void pm_runtime_forbid(struct device *dev) {}
259 static inline int devm_pm_runtime_enable(struct device *dev) { return 0; }
261 static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
262 static inline void pm_runtime_get_noresume(struct device *dev) {}
263 static inline void pm_runtime_put_noidle(struct device *dev) {}
264 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
265 static inline bool pm_runtime_active(struct device *dev) { return true; }
266 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
267 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
269 static inline void pm_runtime_no_callbacks(struct device *dev) {}
270 static inline void pm_runtime_irq_safe(struct device *dev) {}
271 static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
273 static inline bool pm_runtime_has_no_callbacks(struct device *dev) { return false; }
274 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
275 static inline void __pm_runtime_use_autosuspend(struct device *dev,
277 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
279 static inline u64 pm_runtime_autosuspend_expiration(
280 struct device *dev) { return 0; }
281 static inline void pm_runtime_set_memalloc_noio(struct device *dev,
283 static inline void pm_runtime_get_suppliers(struct device *dev) {}
284 static inline void pm_runtime_put_suppliers(struct device *dev) {}
285 static inline void pm_runtime_new_link(struct device *dev) {}
286 static inline void pm_runtime_drop_link(struct device_link *link) {}
287 static inline void pm_runtime_release_supplier(struct device_link *link) {}
289 #endif /* !CONFIG_PM */
292 * pm_runtime_idle - Conditionally set up autosuspend of a device or suspend it.
293 * @dev: Target device.
295 * Invoke the "idle check" callback of @dev and, depending on its return value,
296 * set up autosuspend of @dev or suspend it (depending on whether or not
297 * autosuspend has been enabled for it).
299 static inline int pm_runtime_idle(struct device *dev)
301 return __pm_runtime_idle(dev, 0);
305 * pm_runtime_suspend - Suspend a device synchronously.
306 * @dev: Target device.
308 static inline int pm_runtime_suspend(struct device *dev)
310 return __pm_runtime_suspend(dev, 0);
314 * pm_runtime_autosuspend - Set up autosuspend of a device or suspend it.
315 * @dev: Target device.
317 * Set up autosuspend of @dev or suspend it (depending on whether or not
318 * autosuspend is enabled for it) without engaging its "idle check" callback.
320 static inline int pm_runtime_autosuspend(struct device *dev)
322 return __pm_runtime_suspend(dev, RPM_AUTO);
326 * pm_runtime_resume - Resume a device synchronously.
327 * @dev: Target device.
329 static inline int pm_runtime_resume(struct device *dev)
331 return __pm_runtime_resume(dev, 0);
335 * pm_request_idle - Queue up "idle check" execution for a device.
336 * @dev: Target device.
338 * Queue up a work item to run an equivalent of pm_runtime_idle() for @dev
341 static inline int pm_request_idle(struct device *dev)
343 return __pm_runtime_idle(dev, RPM_ASYNC);
347 * pm_request_resume - Queue up runtime-resume of a device.
348 * @dev: Target device.
350 static inline int pm_request_resume(struct device *dev)
352 return __pm_runtime_resume(dev, RPM_ASYNC);
356 * pm_request_autosuspend - Queue up autosuspend of a device.
357 * @dev: Target device.
359 * Queue up a work item to run an equivalent pm_runtime_autosuspend() for @dev
362 static inline int pm_request_autosuspend(struct device *dev)
364 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
368 * pm_runtime_get - Bump up usage counter and queue up resume of a device.
369 * @dev: Target device.
371 * Bump up the runtime PM usage counter of @dev and queue up a work item to
372 * carry out runtime-resume of it.
374 static inline int pm_runtime_get(struct device *dev)
376 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
380 * pm_runtime_get_sync - Bump up usage counter of a device and resume it.
381 * @dev: Target device.
383 * Bump up the runtime PM usage counter of @dev and carry out runtime-resume of
386 * The possible return values of this function are the same as for
387 * pm_runtime_resume() and the runtime PM usage counter of @dev remains
388 * incremented in all cases, even if it returns an error code.
390 static inline int pm_runtime_get_sync(struct device *dev)
392 return __pm_runtime_resume(dev, RPM_GET_PUT);
396 * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
397 * @dev: Target device.
399 * Resume @dev synchronously and if that is successful, increment its runtime
400 * PM usage counter. Return 0 if the runtime PM usage counter of @dev has been
401 * incremented or a negative error code otherwise.
403 static inline int pm_runtime_resume_and_get(struct device *dev)
407 ret = __pm_runtime_resume(dev, RPM_GET_PUT);
409 pm_runtime_put_noidle(dev);
417 * pm_runtime_put - Drop device usage counter and queue up "idle check" if 0.
418 * @dev: Target device.
420 * Decrement the runtime PM usage counter of @dev and if it turns out to be
421 * equal to 0, queue up a work item for @dev like in pm_request_idle().
423 static inline int pm_runtime_put(struct device *dev)
425 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
429 * pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
430 * @dev: Target device.
432 * Decrement the runtime PM usage counter of @dev and if it turns out to be
433 * equal to 0, queue up a work item for @dev like in pm_request_autosuspend().
435 static inline int pm_runtime_put_autosuspend(struct device *dev)
437 return __pm_runtime_suspend(dev,
438 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
442 * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
443 * @dev: Target device.
445 * Decrement the runtime PM usage counter of @dev and if it turns out to be
446 * equal to 0, invoke the "idle check" callback of @dev and, depending on its
447 * return value, set up autosuspend of @dev or suspend it (depending on whether
448 * or not autosuspend has been enabled for it).
450 * The possible return values of this function are the same as for
451 * pm_runtime_idle() and the runtime PM usage counter of @dev remains
452 * decremented in all cases, even if it returns an error code.
454 static inline int pm_runtime_put_sync(struct device *dev)
456 return __pm_runtime_idle(dev, RPM_GET_PUT);
460 * pm_runtime_put_sync_suspend - Drop device usage counter and suspend if 0.
461 * @dev: Target device.
463 * Decrement the runtime PM usage counter of @dev and if it turns out to be
464 * equal to 0, carry out runtime-suspend of @dev synchronously.
466 * The possible return values of this function are the same as for
467 * pm_runtime_suspend() and the runtime PM usage counter of @dev remains
468 * decremented in all cases, even if it returns an error code.
470 static inline int pm_runtime_put_sync_suspend(struct device *dev)
472 return __pm_runtime_suspend(dev, RPM_GET_PUT);
476 * pm_runtime_put_sync_autosuspend - Drop device usage counter and autosuspend if 0.
477 * @dev: Target device.
479 * Decrement the runtime PM usage counter of @dev and if it turns out to be
480 * equal to 0, set up autosuspend of @dev or suspend it synchronously (depending
481 * on whether or not autosuspend has been enabled for it).
483 * The possible return values of this function are the same as for
484 * pm_runtime_autosuspend() and the runtime PM usage counter of @dev remains
485 * decremented in all cases, even if it returns an error code.
487 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
489 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
493 * pm_runtime_set_active - Set runtime PM status to "active".
494 * @dev: Target device.
496 * Set the runtime PM status of @dev to %RPM_ACTIVE and ensure that dependencies
497 * of it will be taken into account.
499 * It is not valid to call this function for devices with runtime PM enabled.
501 static inline int pm_runtime_set_active(struct device *dev)
503 return __pm_runtime_set_status(dev, RPM_ACTIVE);
507 * pm_runtime_set_suspended - Set runtime PM status to "suspended".
508 * @dev: Target device.
510 * Set the runtime PM status of @dev to %RPM_SUSPENDED and ensure that
511 * dependencies of it will be taken into account.
513 * It is not valid to call this function for devices with runtime PM enabled.
515 static inline int pm_runtime_set_suspended(struct device *dev)
517 return __pm_runtime_set_status(dev, RPM_SUSPENDED);
521 * pm_runtime_disable - Disable runtime PM for a device.
522 * @dev: Target device.
524 * Prevent the runtime PM framework from working with @dev (by incrementing its
525 * "blocking" counter).
527 * For each invocation of this function for @dev there must be a matching
528 * pm_runtime_enable() call in order for runtime PM to be enabled for it.
530 static inline void pm_runtime_disable(struct device *dev)
532 __pm_runtime_disable(dev, true);
536 * pm_runtime_use_autosuspend - Allow autosuspend to be used for a device.
537 * @dev: Target device.
539 * Allow the runtime PM autosuspend mechanism to be used for @dev whenever
540 * requested (or "autosuspend" will be handled as direct runtime-suspend for
543 * NOTE: It's important to undo this with pm_runtime_dont_use_autosuspend()
544 * at driver exit time unless your driver initially enabled pm_runtime
545 * with devm_pm_runtime_enable() (which handles it for you).
547 static inline void pm_runtime_use_autosuspend(struct device *dev)
549 __pm_runtime_use_autosuspend(dev, true);
553 * pm_runtime_dont_use_autosuspend - Prevent autosuspend from being used.
554 * @dev: Target device.
556 * Prevent the runtime PM autosuspend mechanism from being used for @dev which
557 * means that "autosuspend" will be handled as direct runtime-suspend for it
560 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
562 __pm_runtime_use_autosuspend(dev, false);