xref: /linux-6.15/include/linux/pm_runtime.h (revision 0f5f5bcd)
1 /*
2  * pm_runtime.h - Device run-time power management helper functions.
3  *
4  * Copyright (C) 2009 Rafael J. Wysocki <[email protected]>
5  *
6  * This file is released under the GPLv2.
7  */
8 
9 #ifndef _LINUX_PM_RUNTIME_H
10 #define _LINUX_PM_RUNTIME_H
11 
12 #include <linux/device.h>
13 #include <linux/notifier.h>
14 #include <linux/pm.h>
15 
16 #include <linux/jiffies.h>
17 
18 /* Runtime PM flag argument bits */
19 #define RPM_ASYNC		0x01	/* Request is asynchronous */
20 #define RPM_NOWAIT		0x02	/* Don't wait for concurrent
21 					    state change */
22 #define RPM_GET_PUT		0x04	/* Increment/decrement the
23 					    usage_count */
24 #define RPM_AUTO		0x08	/* Use autosuspend_delay */
25 
26 #ifdef CONFIG_PM
27 extern int pm_generic_runtime_suspend(struct device *dev);
28 extern int pm_generic_runtime_resume(struct device *dev);
29 extern int pm_runtime_force_suspend(struct device *dev);
30 extern int pm_runtime_force_resume(struct device *dev);
31 #else
32 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
33 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
34 static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
35 static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
36 #endif
37 
38 #ifdef CONFIG_PM_RUNTIME
39 
40 extern struct workqueue_struct *pm_wq;
41 
42 extern int __pm_runtime_idle(struct device *dev, int rpmflags);
43 extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
44 extern int __pm_runtime_resume(struct device *dev, int rpmflags);
45 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
46 extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
47 extern int pm_runtime_barrier(struct device *dev);
48 extern void pm_runtime_enable(struct device *dev);
49 extern void __pm_runtime_disable(struct device *dev, bool check_resume);
50 extern void pm_runtime_allow(struct device *dev);
51 extern void pm_runtime_forbid(struct device *dev);
52 extern void pm_runtime_no_callbacks(struct device *dev);
53 extern void pm_runtime_irq_safe(struct device *dev);
54 extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
55 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
56 extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
57 extern void pm_runtime_update_max_time_suspended(struct device *dev,
58 						 s64 delta_ns);
59 extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
60 
61 static inline bool pm_children_suspended(struct device *dev)
62 {
63 	return dev->power.ignore_children
64 		|| !atomic_read(&dev->power.child_count);
65 }
66 
67 static inline void pm_runtime_get_noresume(struct device *dev)
68 {
69 	atomic_inc(&dev->power.usage_count);
70 }
71 
72 static inline void pm_runtime_put_noidle(struct device *dev)
73 {
74 	atomic_add_unless(&dev->power.usage_count, -1, 0);
75 }
76 
77 static inline bool device_run_wake(struct device *dev)
78 {
79 	return dev->power.run_wake;
80 }
81 
82 static inline void device_set_run_wake(struct device *dev, bool enable)
83 {
84 	dev->power.run_wake = enable;
85 }
86 
87 static inline bool pm_runtime_suspended(struct device *dev)
88 {
89 	return dev->power.runtime_status == RPM_SUSPENDED
90 		&& !dev->power.disable_depth;
91 }
92 
93 static inline bool pm_runtime_active(struct device *dev)
94 {
95 	return dev->power.runtime_status == RPM_ACTIVE
96 		|| dev->power.disable_depth;
97 }
98 
99 static inline bool pm_runtime_status_suspended(struct device *dev)
100 {
101 	return dev->power.runtime_status == RPM_SUSPENDED;
102 }
103 
104 static inline bool pm_runtime_suspended_if_enabled(struct device *dev)
105 {
106 	return pm_runtime_status_suspended(dev) && dev->power.disable_depth == 1;
107 }
108 
109 static inline bool pm_runtime_enabled(struct device *dev)
110 {
111 	return !dev->power.disable_depth;
112 }
113 
114 static inline bool pm_runtime_callbacks_present(struct device *dev)
115 {
116 	return !dev->power.no_callbacks;
117 }
118 
119 static inline void pm_runtime_mark_last_busy(struct device *dev)
120 {
121 	ACCESS_ONCE(dev->power.last_busy) = jiffies;
122 }
123 
124 #else /* !CONFIG_PM_RUNTIME */
125 
126 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
127 {
128 	return -ENOSYS;
129 }
130 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
131 {
132 	return -ENOSYS;
133 }
134 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
135 {
136 	return 1;
137 }
138 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
139 {
140 	return -ENOSYS;
141 }
142 static inline int __pm_runtime_set_status(struct device *dev,
143 					    unsigned int status) { return 0; }
144 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
145 static inline void pm_runtime_enable(struct device *dev) {}
146 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
147 static inline void pm_runtime_allow(struct device *dev) {}
148 static inline void pm_runtime_forbid(struct device *dev) {}
149 
150 static inline bool pm_children_suspended(struct device *dev) { return false; }
151 static inline void pm_runtime_get_noresume(struct device *dev) {}
152 static inline void pm_runtime_put_noidle(struct device *dev) {}
153 static inline bool device_run_wake(struct device *dev) { return false; }
154 static inline void device_set_run_wake(struct device *dev, bool enable) {}
155 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
156 static inline bool pm_runtime_active(struct device *dev) { return true; }
157 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
158 static inline bool pm_runtime_suspended_if_enabled(struct device *dev) { return false; }
159 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
160 
161 static inline void pm_runtime_no_callbacks(struct device *dev) {}
162 static inline void pm_runtime_irq_safe(struct device *dev) {}
163 
164 static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
165 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
166 static inline void __pm_runtime_use_autosuspend(struct device *dev,
167 						bool use) {}
168 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
169 						int delay) {}
170 static inline unsigned long pm_runtime_autosuspend_expiration(
171 				struct device *dev) { return 0; }
172 static inline void pm_runtime_set_memalloc_noio(struct device *dev,
173 						bool enable){}
174 
175 #endif /* !CONFIG_PM_RUNTIME */
176 
177 static inline int pm_runtime_idle(struct device *dev)
178 {
179 	return __pm_runtime_idle(dev, 0);
180 }
181 
182 static inline int pm_runtime_suspend(struct device *dev)
183 {
184 	return __pm_runtime_suspend(dev, 0);
185 }
186 
187 static inline int pm_runtime_autosuspend(struct device *dev)
188 {
189 	return __pm_runtime_suspend(dev, RPM_AUTO);
190 }
191 
192 static inline int pm_runtime_resume(struct device *dev)
193 {
194 	return __pm_runtime_resume(dev, 0);
195 }
196 
197 static inline int pm_request_idle(struct device *dev)
198 {
199 	return __pm_runtime_idle(dev, RPM_ASYNC);
200 }
201 
202 static inline int pm_request_resume(struct device *dev)
203 {
204 	return __pm_runtime_resume(dev, RPM_ASYNC);
205 }
206 
207 static inline int pm_request_autosuspend(struct device *dev)
208 {
209 	return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
210 }
211 
212 static inline int pm_runtime_get(struct device *dev)
213 {
214 	return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
215 }
216 
217 static inline int pm_runtime_get_sync(struct device *dev)
218 {
219 	return __pm_runtime_resume(dev, RPM_GET_PUT);
220 }
221 
222 static inline int pm_runtime_put(struct device *dev)
223 {
224 	return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
225 }
226 
227 static inline int pm_runtime_put_autosuspend(struct device *dev)
228 {
229 	return __pm_runtime_suspend(dev,
230 	    RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
231 }
232 
233 static inline int pm_runtime_put_sync(struct device *dev)
234 {
235 	return __pm_runtime_idle(dev, RPM_GET_PUT);
236 }
237 
238 static inline int pm_runtime_put_sync_suspend(struct device *dev)
239 {
240 	return __pm_runtime_suspend(dev, RPM_GET_PUT);
241 }
242 
243 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
244 {
245 	return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
246 }
247 
248 static inline int pm_runtime_set_active(struct device *dev)
249 {
250 	return __pm_runtime_set_status(dev, RPM_ACTIVE);
251 }
252 
253 static inline void pm_runtime_set_suspended(struct device *dev)
254 {
255 	__pm_runtime_set_status(dev, RPM_SUSPENDED);
256 }
257 
258 static inline void pm_runtime_disable(struct device *dev)
259 {
260 	__pm_runtime_disable(dev, true);
261 }
262 
263 static inline void pm_runtime_use_autosuspend(struct device *dev)
264 {
265 	__pm_runtime_use_autosuspend(dev, true);
266 }
267 
268 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
269 {
270 	__pm_runtime_use_autosuspend(dev, false);
271 }
272 
273 #endif
274