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_in_use(struct device *dev);
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);
62 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
64 dev->power.ignore_children = enable;
67 static inline void pm_runtime_get_noresume(struct device *dev)
69 atomic_inc(&dev->power.usage_count);
72 static inline void pm_runtime_put_noidle(struct device *dev)
74 atomic_add_unless(&dev->power.usage_count, -1, 0);
77 static inline bool pm_runtime_suspended(struct device *dev)
79 return dev->power.runtime_status == RPM_SUSPENDED
80 && !dev->power.disable_depth;
83 static inline bool pm_runtime_active(struct device *dev)
85 return dev->power.runtime_status == RPM_ACTIVE
86 || dev->power.disable_depth;
89 static inline bool pm_runtime_status_suspended(struct device *dev)
91 return dev->power.runtime_status == RPM_SUSPENDED;
94 static inline bool pm_runtime_enabled(struct device *dev)
96 return !dev->power.disable_depth;
99 static inline bool pm_runtime_callbacks_present(struct device *dev)
101 return !dev->power.no_callbacks;
104 static inline void pm_runtime_mark_last_busy(struct device *dev)
106 WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());
109 static inline bool pm_runtime_is_irq_safe(struct device *dev)
111 return dev->power.irq_safe;
114 extern u64 pm_runtime_suspended_time(struct device *dev);
116 #else /* !CONFIG_PM */
118 static inline bool queue_pm_work(struct work_struct *work) { return false; }
120 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
121 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
122 static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
123 static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
125 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
129 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
133 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
137 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
141 static inline int pm_runtime_get_if_in_use(struct device *dev)
145 static inline int __pm_runtime_set_status(struct device *dev,
146 unsigned int status) { return 0; }
147 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
148 static inline void pm_runtime_enable(struct device *dev) {}
149 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
150 static inline void pm_runtime_allow(struct device *dev) {}
151 static inline void pm_runtime_forbid(struct device *dev) {}
153 static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
154 static inline void pm_runtime_get_noresume(struct device *dev) {}
155 static inline void pm_runtime_put_noidle(struct device *dev) {}
156 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
157 static inline bool pm_runtime_active(struct device *dev) { return true; }
158 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
159 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
161 static inline void pm_runtime_no_callbacks(struct device *dev) {}
162 static inline void pm_runtime_irq_safe(struct device *dev) {}
163 static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
165 static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
166 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
167 static inline void __pm_runtime_use_autosuspend(struct device *dev,
169 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
171 static inline u64 pm_runtime_autosuspend_expiration(
172 struct device *dev) { return 0; }
173 static inline void pm_runtime_set_memalloc_noio(struct device *dev,
175 static inline void pm_runtime_get_suppliers(struct device *dev) {}
176 static inline void pm_runtime_put_suppliers(struct device *dev) {}
177 static inline void pm_runtime_new_link(struct device *dev) {}
178 static inline void pm_runtime_drop_link(struct device_link *link) {}
180 #endif /* !CONFIG_PM */
182 static inline int pm_runtime_idle(struct device *dev)
184 return __pm_runtime_idle(dev, 0);
187 static inline int pm_runtime_suspend(struct device *dev)
189 return __pm_runtime_suspend(dev, 0);
192 static inline int pm_runtime_autosuspend(struct device *dev)
194 return __pm_runtime_suspend(dev, RPM_AUTO);
197 static inline int pm_runtime_resume(struct device *dev)
199 return __pm_runtime_resume(dev, 0);
202 static inline int pm_request_idle(struct device *dev)
204 return __pm_runtime_idle(dev, RPM_ASYNC);
207 static inline int pm_request_resume(struct device *dev)
209 return __pm_runtime_resume(dev, RPM_ASYNC);
212 static inline int pm_request_autosuspend(struct device *dev)
214 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
217 static inline int pm_runtime_get(struct device *dev)
219 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
222 static inline int pm_runtime_get_sync(struct device *dev)
224 return __pm_runtime_resume(dev, RPM_GET_PUT);
228 * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
229 * @dev: Target device.
231 * Resume @dev synchronously and if that is successful, increment its runtime
232 * PM usage counter. Return 0 if the runtime PM usage counter of @dev has been
233 * incremented or a negative error code otherwise.
235 static inline int pm_runtime_resume_and_get(struct device *dev)
239 ret = __pm_runtime_resume(dev, RPM_GET_PUT);
241 pm_runtime_put_noidle(dev);
248 static inline int pm_runtime_put(struct device *dev)
250 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
253 static inline int pm_runtime_put_autosuspend(struct device *dev)
255 return __pm_runtime_suspend(dev,
256 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
259 static inline int pm_runtime_put_sync(struct device *dev)
261 return __pm_runtime_idle(dev, RPM_GET_PUT);
264 static inline int pm_runtime_put_sync_suspend(struct device *dev)
266 return __pm_runtime_suspend(dev, RPM_GET_PUT);
269 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
271 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
274 static inline int pm_runtime_set_active(struct device *dev)
276 return __pm_runtime_set_status(dev, RPM_ACTIVE);
279 static inline int pm_runtime_set_suspended(struct device *dev)
281 return __pm_runtime_set_status(dev, RPM_SUSPENDED);
284 static inline void pm_runtime_disable(struct device *dev)
286 __pm_runtime_disable(dev, true);
289 static inline void pm_runtime_use_autosuspend(struct device *dev)
291 __pm_runtime_use_autosuspend(dev, true);
294 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
296 __pm_runtime_use_autosuspend(dev, false);