1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * pm_runtime.h - Device run-time power management helper functions.
42 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
52 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
63  * pm_runtime_get_if_in_use - Conditionally bump up runtime PM usage counter.
75  * pm_suspend_ignore_children - Set runtime PM behavior regarding children.
85 	dev->power.ignore_children = enable;  in pm_suspend_ignore_children()
89  * pm_runtime_get_noresume - Bump up runtime PM usage counter of a device.
94 	atomic_inc(&dev->power.usage_count);  in pm_runtime_get_noresume()
98  * pm_runtime_put_noidle - Drop runtime PM usage counter of a device.
105 	atomic_add_unless(&dev->power.usage_count, -1, 0);  in pm_runtime_put_noidle()
109  * pm_runtime_suspended - Check whether or not a device is runtime-suspended.
122 	return dev->power.runtime_status == RPM_SUSPENDED  in pm_runtime_suspended()
123 		&& !dev->power.disable_depth;  in pm_runtime_suspended()
127  * pm_runtime_active - Check whether or not a device is runtime-active.
140 	return dev->power.runtime_status == RPM_ACTIVE  in pm_runtime_active()
141 		|| dev->power.disable_depth;  in pm_runtime_active()
145  * pm_runtime_status_suspended - Check if runtime PM status is "suspended".
157 	return dev->power.runtime_status == RPM_SUSPENDED;  in pm_runtime_status_suspended()
161  * pm_runtime_enabled - Check if runtime PM is enabled.
172 	return !dev->power.disable_depth;  in pm_runtime_enabled()
176  * pm_runtime_has_no_callbacks - Check if runtime PM callbacks may be present.
184 	return dev->power.no_callbacks;  in pm_runtime_has_no_callbacks()
188  * pm_runtime_mark_last_busy - Update the last access time of a device.
191  * Update the last access time of @dev used by the runtime PM autosuspend
196 	WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());  in pm_runtime_mark_last_busy()
200  * pm_runtime_is_irq_safe - Check if runtime PM can work in interrupt context.
203  * Return %true if @dev has been marked as an "IRQ-safe" device (with respect
209 	return dev->power.irq_safe;  in pm_runtime_is_irq_safe()
225 	return -ENOSYS;  in __pm_runtime_idle()
229 	return -ENOSYS;  in __pm_runtime_suspend()
235 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)  in pm_schedule_suspend()  argument
237 	return -ENOSYS;  in pm_schedule_suspend()
241 	return -EINVAL;  in pm_runtime_get_if_in_use()
246 	return -EINVAL;  in pm_runtime_get_if_active()
273 						int delay) {}  in pm_runtime_set_autosuspend_delay()  argument
286  * pm_runtime_idle - Conditionally set up autosuspend of a device or suspend it.
290  * set up autosuspend of @dev or suspend it (depending on whether or not
291  * autosuspend has been enabled for it).
299  * pm_runtime_suspend - Suspend a device synchronously.
308  * pm_runtime_autosuspend - Set up autosuspend of a device or suspend it.
311  * Set up autosuspend of @dev or suspend it (depending on whether or not
312  * autosuspend is enabled for it) without engaging its "idle check" callback.
320  * pm_runtime_resume - Resume a device synchronously.
329  * pm_request_idle - Queue up "idle check" execution for a device.
341  * pm_request_resume - Queue up runtime-resume of a device.
350  * pm_request_autosuspend - Queue up autosuspend of a device.
362  * pm_runtime_get - Bump up usage counter and queue up resume of a device.
366  * carry out runtime-resume of it.
374  * pm_runtime_get_sync - Bump up usage counter of a device and resume it.
377  * Bump up the runtime PM usage counter of @dev and carry out runtime-resume of
390  * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
411  * pm_runtime_put - Drop device usage counter and queue up "idle check" if 0.
423  * pm_runtime_put_autosuspend - Drop device usage counter and queue autosuspend if 0.
436  * pm_runtime_put_sync - Drop device usage counter and run "idle check" if 0.
441  * return value, set up autosuspend of @dev or suspend it (depending on whether
442  * or not autosuspend has been enabled for it).
454  * pm_runtime_put_sync_suspend - Drop device usage counter and suspend if 0.
458  * equal to 0, carry out runtime-suspend of @dev synchronously.
470  * pm_runtime_put_sync_autosuspend - Drop device usage counter and autosuspend if 0.
474  * equal to 0, set up autosuspend of @dev or suspend it synchronously (depending
475  * on whether or not autosuspend has been enabled for it).
487  * pm_runtime_set_active - Set runtime PM status to "active".
501  * pm_runtime_set_suspended - Set runtime PM status to "suspended".
515  * pm_runtime_disable - Disable runtime PM for a device.
530  * pm_runtime_use_autosuspend - Allow autosuspend to be used for a device.
533  * Allow the runtime PM autosuspend mechanism to be used for @dev whenever
534  * requested (or "autosuspend" will be handled as direct runtime-suspend for
543  * pm_runtime_dont_use_autosuspend - Prevent autosuspend from being used.
546  * Prevent the runtime PM autosuspend mechanism from being used for @dev which
547  * means that "autosuspend" will be handled as direct runtime-suspend for it