include/linux/pm_runtime.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * pm_runtime.h - Device run-time power management helper functions.
98  * pm_runtime_get_if_in_use - Conditionally bump up runtime PM usage counter.
110  * pm_suspend_ignore_children - Set runtime PM behavior regarding children.
120 	dev->power.ignore_children = enable;  in pm_suspend_ignore_children()
124  * pm_runtime_get_noresume - Bump up runtime PM usage counter of a device.
129 	atomic_inc(&dev->power.usage_count);  in pm_runtime_get_noresume()
133  * pm_runtime_put_noidle - Drop runtime PM usage counter of a device.
140 	atomic_add_unless(&dev->power.usage_count, -1, 0);  in pm_runtime_put_noidle()
144  * pm_runtime_suspended - Check whether or not a device is runtime-suspended.
157 	return dev->power.runtime_status == RPM_SUSPENDED  in pm_runtime_suspended()
158 		&& !dev->power.disable_depth;  in pm_runtime_suspended()
162  * pm_runtime_active - Check whether or not a device is runtime-active.
175 	return dev->power.runtime_status == RPM_ACTIVE  in pm_runtime_active()
176 		|| dev->power.disable_depth;  in pm_runtime_active()
180  * pm_runtime_status_suspended - Check if runtime PM status is "suspended".
192 	return dev->power.runtime_status == RPM_SUSPENDED;  in pm_runtime_status_suspended()
196  * pm_runtime_enabled - Check if runtime PM is enabled.
207 	return !dev->power.disable_depth;  in pm_runtime_enabled()
211  * pm_runtime_has_no_callbacks - Check if runtime PM callbacks may be present.
219 	return dev->power.no_callbacks;  in pm_runtime_has_no_callbacks()
223  * pm_runtime_mark_last_busy - Update the last access time of a device.
231 	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());  in pm_runtime_mark_last_busy()
235  * pm_runtime_is_irq_safe - Check if runtime PM can work in interrupt context.
238  * Return %true if @dev has been marked as an "IRQ-safe" device (with respect
244 	return dev->power.irq_safe;  in pm_runtime_is_irq_safe()
260 	return -ENOSYS;  in __pm_runtime_idle()
264 	return -ENOSYS;  in __pm_runtime_suspend()
272 	return -ENOSYS;  in pm_schedule_suspend()
276 	return -EINVAL;  in pm_runtime_get_if_in_use()
281 	return -EINVAL;  in pm_runtime_get_if_active()
324  * pm_runtime_idle - Conditionally set up autosuspend of a device or suspend it.
328  * set up autosuspend of @dev or suspend it (depending on whether or not
337  * pm_runtime_suspend - Suspend a device synchronously.
346  * pm_runtime_autosuspend - Set up autosuspend of a device or suspend it.
349  * Set up autosuspend of @dev or suspend it (depending on whether or not
358  * pm_runtime_resume - Resume a device synchronously.
367  * pm_request_idle - Queue up "idle check" execution for a device.
370  * Queue up a work item to run an equivalent of pm_runtime_idle() for @dev
379  * pm_request_resume - Queue up runtime-resume of a device.
388  * pm_request_autosuspend - Queue up autosuspend of a device.
391  * Queue up a work item to run an equivalent pm_runtime_autosuspend() for @dev
400  * pm_runtime_get - Bump up usage counter and queue up resume of a device.
403  * Bump up the runtime PM usage counter of @dev and queue up a work item to
404  * carry out runtime-resume of it.
412  * pm_runtime_get_sync - Bump up usage counter of a device and resume it.
415  * Bump up the runtime PM usage counter of @dev and carry out runtime-resume of
431  * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
452  * pm_runtime_put - Drop device usage counter and queue up "idle check" if 0.
456  * equal to 0, queue up a work item for @dev like in pm_request_idle().
464  * pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
468  * equal to 0, queue up a work item for @dev like in pm_request_autosuspend().
477  * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
482  * return value, set up autosuspend of @dev or suspend it (depending on whether
495  * pm_runtime_put_sync_suspend - Drop device usage counter and suspend if 0.
499  * equal to 0, carry out runtime-suspend of @dev synchronously.
511  * pm_runtime_put_sync_autosuspend - Drop device usage counter and autosuspend if 0.
515  * equal to 0, set up autosuspend of @dev or suspend it synchronously (depending
528  * pm_runtime_set_active - Set runtime PM status to "active".
542  * pm_runtime_set_suspended - Set runtime PM status to "suspended".
556  * pm_runtime_disable - Disable runtime PM for a device.
571  * pm_runtime_use_autosuspend - Allow autosuspend to be used for a device.
575  * requested (or "autosuspend" will be handled as direct runtime-suspend for
588  * pm_runtime_dont_use_autosuspend - Prevent autosuspend from being used.
592  * means that "autosuspend" will be handled as direct runtime-suspend for it