1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * pm_runtime.h - Device run-time power management helper functions.
78 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
88 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
100  * pm_suspend_ignore_children - Set runtime PM behavior regarding children.
110 	dev->power.ignore_children = enable;  in pm_suspend_ignore_children()
114  * pm_runtime_get_noresume - Bump up runtime PM usage counter of a device.
119 	atomic_inc(&dev->power.usage_count);  in pm_runtime_get_noresume()
123  * pm_runtime_put_noidle - Drop runtime PM usage counter of a device.
130 	atomic_add_unless(&dev->power.usage_count, -1, 0);  in pm_runtime_put_noidle()
134  * pm_runtime_suspended - Check whether or not a device is runtime-suspended.
147 	return dev->power.runtime_status == RPM_SUSPENDED  in pm_runtime_suspended()
148 		&& !dev->power.disable_depth;  in pm_runtime_suspended()
152  * pm_runtime_active - Check whether or not a device is runtime-active.
165 	return dev->power.runtime_status == RPM_ACTIVE  in pm_runtime_active()
166 		|| dev->power.disable_depth;  in pm_runtime_active()
170  * pm_runtime_status_suspended - Check if runtime PM status is "suspended".
182 	return dev->power.runtime_status == RPM_SUSPENDED;  in pm_runtime_status_suspended()
186  * pm_runtime_enabled - Check if runtime PM is enabled.
197 	return !dev->power.disable_depth;  in pm_runtime_enabled()
201  * pm_runtime_has_no_callbacks - Check if runtime PM callbacks may be present.
209 	return dev->power.no_callbacks;  in pm_runtime_has_no_callbacks()
213  * pm_runtime_mark_last_busy - Update the last access time of a device.
216  * Update the last access time of @dev used by the runtime PM autosuspend
221 	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());  in pm_runtime_mark_last_busy()
225  * pm_runtime_is_irq_safe - Check if runtime PM can work in interrupt context.
228  * Return %true if @dev has been marked as an "IRQ-safe" device (with respect
234 	return dev->power.irq_safe;  in pm_runtime_is_irq_safe()
251 	return -ENOSYS;  in __pm_runtime_idle()
255 	return -ENOSYS;  in __pm_runtime_suspend()
261 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)  in pm_schedule_suspend()  argument
263 	return -ENOSYS;  in pm_schedule_suspend()
267 	return -EINVAL;  in pm_runtime_get_if_in_use()
271 	return -EINVAL;  in pm_runtime_get_if_active()
300 						int delay) {}  in pm_runtime_set_autosuspend_delay()  argument
314  * pm_runtime_idle - Conditionally set up autosuspend of a device or suspend it.
318  * set up autosuspend of @dev or suspend it (depending on whether or not
319  * autosuspend has been enabled for it).
327  * pm_runtime_suspend - Suspend a device synchronously.
336  * pm_runtime_autosuspend - Set up autosuspend of a device or suspend it.
339  * Set up autosuspend of @dev or suspend it (depending on whether or not
340  * autosuspend is enabled for it) without engaging its "idle check" callback.
348  * pm_runtime_resume - Resume a device synchronously.
357  * pm_request_idle - Queue up "idle check" execution for a device.
369  * pm_request_resume - Queue up runtime-resume of a device.
378  * pm_request_autosuspend - Queue up autosuspend of a device.
390  * pm_runtime_get - Bump up usage counter and queue up resume of a device.
394  * carry out runtime-resume of it.
402  * pm_runtime_get_sync - Bump up usage counter of a device and resume it.
405  * Bump up the runtime PM usage counter of @dev and carry out runtime-resume of
421  * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
442  * pm_runtime_put - Drop device usage counter and queue up "idle check" if 0.
454  * __pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
466  * pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
479  * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
484  * return value, set up autosuspend of @dev or suspend it (depending on whether
485  * or not autosuspend has been enabled for it).
497  * pm_runtime_put_sync_suspend - Drop device usage counter and suspend if 0.
501  * equal to 0, carry out runtime-suspend of @dev synchronously.
513  * pm_runtime_put_sync_autosuspend - Drop device usage counter and autosuspend if 0.
517  * equal to 0, set up autosuspend of @dev or suspend it synchronously (depending
518  * on whether or not autosuspend has been enabled for it).
530  * pm_runtime_set_active - Set runtime PM status to "active".
544  * pm_runtime_set_suspended - Set runtime PM status to "suspended".
558  * pm_runtime_disable - Disable runtime PM for a device.
573  * pm_runtime_use_autosuspend - Allow autosuspend to be used for a device.
576  * Allow the runtime PM autosuspend mechanism to be used for @dev whenever
577  * requested (or "autosuspend" will be handled as direct runtime-suspend for
590  * pm_runtime_dont_use_autosuspend - Prevent autosuspend from being used.
593  * Prevent the runtime PM autosuspend mechanism from being used for @dev which
594  * means that "autosuspend" will be handled as direct runtime-suspend for it