include/linux/pm_runtime.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * pm_runtime.h - Device run-time power management helper functions.
64  * pm_runtime_get_if_in_use - Conditionally bump up runtime PM usage counter.
67  * Increment the runtime PM usage counter of @dev if its runtime PM status is
68  * %RPM_ACTIVE and its runtime PM usage counter is greater than 0.
76  * pm_suspend_ignore_children - Set runtime PM behavior regarding children.
86 	dev->power.ignore_children = enable;  in pm_suspend_ignore_children()
90  * pm_runtime_get_noresume - Bump up runtime PM usage counter of a device.
95 	atomic_inc(&dev->power.usage_count);  in pm_runtime_get_noresume()
99  * pm_runtime_put_noidle - Drop runtime PM usage counter of a device.
102  * Decrement the runtime PM usage counter of @dev unless it is 0 already.
106 	atomic_add_unless(&dev->power.usage_count, -1, 0);  in pm_runtime_put_noidle()
110  * pm_runtime_suspended - Check whether or not a device is runtime-suspended.
123 	return dev->power.runtime_status == RPM_SUSPENDED  in pm_runtime_suspended()
124 		&& !dev->power.disable_depth;  in pm_runtime_suspended()
128  * pm_runtime_active - Check whether or not a device is runtime-active.
141 	return dev->power.runtime_status == RPM_ACTIVE  in pm_runtime_active()
142 		|| dev->power.disable_depth;  in pm_runtime_active()
146  * pm_runtime_status_suspended - Check if runtime PM status is "suspended".
158 	return dev->power.runtime_status == RPM_SUSPENDED;  in pm_runtime_status_suspended()
162  * pm_runtime_enabled - Check if runtime PM is enabled.
173 	return !dev->power.disable_depth;  in pm_runtime_enabled()
177  * pm_runtime_has_no_callbacks - Check if runtime PM callbacks may be present.
185 	return dev->power.no_callbacks;  in pm_runtime_has_no_callbacks()
189  * pm_runtime_mark_last_busy - Update the last access time of a device.
197 	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());  in pm_runtime_mark_last_busy()
201  * pm_runtime_is_irq_safe - Check if runtime PM can work in interrupt context.
204  * Return %true if @dev has been marked as an "IRQ-safe" device (with respect
210 	return dev->power.irq_safe;  in pm_runtime_is_irq_safe()
226 	return -ENOSYS;  in __pm_runtime_idle()
230 	return -ENOSYS;  in __pm_runtime_suspend()
238 	return -ENOSYS;  in pm_schedule_suspend()
242 	return -EINVAL;  in pm_runtime_get_if_in_use()
247 	return -EINVAL;  in pm_runtime_get_if_active()
288  * pm_runtime_idle - Conditionally set up autosuspend of a device or suspend it.
292  * set up autosuspend of @dev or suspend it (depending on whether or not
301  * pm_runtime_suspend - Suspend a device synchronously.
310  * pm_runtime_autosuspend - Set up autosuspend of a device or suspend it.
313  * Set up autosuspend of @dev or suspend it (depending on whether or not
322  * pm_runtime_resume - Resume a device synchronously.
331  * pm_request_idle - Queue up "idle check" execution for a device.
334  * Queue up a work item to run an equivalent of pm_runtime_idle() for @dev
343  * pm_request_resume - Queue up runtime-resume of a device.
352  * pm_request_autosuspend - Queue up autosuspend of a device.
355  * Queue up a work item to run an equivalent pm_runtime_autosuspend() for @dev
364  * pm_runtime_get - Bump up usage counter and queue up resume of a device.
367  * Bump up the runtime PM usage counter of @dev and queue up a work item to
368  * carry out runtime-resume of it.
376  * pm_runtime_get_sync - Bump up usage counter of a device and resume it.
379  * Bump up the runtime PM usage counter of @dev and carry out runtime-resume of
383  * pm_runtime_resume() and the runtime PM usage counter of @dev remains
392  * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
396  * PM usage counter. Return 0 if the runtime PM usage counter of @dev has been
413  * pm_runtime_put - Drop device usage counter and queue up "idle check" if 0.
416  * Decrement the runtime PM usage counter of @dev and if it turns out to be
417  * equal to 0, queue up a work item for @dev like in pm_request_idle().
425  * pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
428  * Decrement the runtime PM usage counter of @dev and if it turns out to be
429  * equal to 0, queue up a work item for @dev like in pm_request_autosuspend().
438  * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
441  * Decrement the runtime PM usage counter of @dev and if it turns out to be
443  * return value, set up autosuspend of @dev or suspend it (depending on whether
447  * pm_runtime_idle() and the runtime PM usage counter of @dev remains
456  * pm_runtime_put_sync_suspend - Drop device usage counter and suspend if 0.
459  * Decrement the runtime PM usage counter of @dev and if it turns out to be
460  * equal to 0, carry out runtime-suspend of @dev synchronously.
463  * pm_runtime_suspend() and the runtime PM usage counter of @dev remains
472  * pm_runtime_put_sync_autosuspend - Drop device usage counter and autosuspend if 0.
475  * Decrement the runtime PM usage counter of @dev and if it turns out to be
476  * equal to 0, set up autosuspend of @dev or suspend it synchronously (depending
480  * pm_runtime_autosuspend() and the runtime PM usage counter of @dev remains
489  * pm_runtime_set_active - Set runtime PM status to "active".
503  * pm_runtime_set_suspended - Set runtime PM status to "suspended".
517  * pm_runtime_disable - Disable runtime PM for a device.
521  * "blocking" counter).
532  * pm_runtime_use_autosuspend - Allow autosuspend to be used for a device.
536  * requested (or "autosuspend" will be handled as direct runtime-suspend for
545  * pm_runtime_dont_use_autosuspend - Prevent autosuspend from being used.
549  * means that "autosuspend" will be handled as direct runtime-suspend for it