xref: /linux-6.15/include/linux/pm_runtime.h (revision 9d54c8a3)
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 #else
30 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
31 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
32 #endif
33 
34 #ifdef CONFIG_PM_RUNTIME
35 
36 extern struct workqueue_struct *pm_wq;
37 
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_schedule_suspend(struct device *dev, unsigned int delay);
42 extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
43 extern int pm_runtime_barrier(struct device *dev);
44 extern void pm_runtime_enable(struct device *dev);
45 extern void __pm_runtime_disable(struct device *dev, bool check_resume);
46 extern void pm_runtime_allow(struct device *dev);
47 extern void pm_runtime_forbid(struct device *dev);
48 extern void pm_runtime_no_callbacks(struct device *dev);
49 extern void pm_runtime_irq_safe(struct device *dev);
50 extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
51 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
52 extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
53 extern void pm_runtime_update_max_time_suspended(struct device *dev,
54 						 s64 delta_ns);
55 extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
56 
57 static inline bool pm_children_suspended(struct device *dev)
58 {
59 	return dev->power.ignore_children
60 		|| !atomic_read(&dev->power.child_count);
61 }
62 
63 static inline void pm_runtime_get_noresume(struct device *dev)
64 {
65 	atomic_inc(&dev->power.usage_count);
66 }
67 
68 static inline void pm_runtime_put_noidle(struct device *dev)
69 {
70 	atomic_add_unless(&dev->power.usage_count, -1, 0);
71 }
72 
73 static inline bool device_run_wake(struct device *dev)
74 {
75 	return dev->power.run_wake;
76 }
77 
78 static inline void device_set_run_wake(struct device *dev, bool enable)
79 {
80 	dev->power.run_wake = enable;
81 }
82 
83 static inline bool pm_runtime_suspended(struct device *dev)
84 {
85 	return dev->power.runtime_status == RPM_SUSPENDED
86 		&& !dev->power.disable_depth;
87 }
88 
89 static inline bool pm_runtime_active(struct device *dev)
90 {
91 	return dev->power.runtime_status == RPM_ACTIVE
92 		|| dev->power.disable_depth;
93 }
94 
95 static inline bool pm_runtime_status_suspended(struct device *dev)
96 {
97 	return dev->power.runtime_status == RPM_SUSPENDED;
98 }
99 
100 static inline bool pm_runtime_enabled(struct device *dev)
101 {
102 	return !dev->power.disable_depth;
103 }
104 
105 static inline bool pm_runtime_callbacks_present(struct device *dev)
106 {
107 	return !dev->power.no_callbacks;
108 }
109 
110 static inline void pm_runtime_mark_last_busy(struct device *dev)
111 {
112 	ACCESS_ONCE(dev->power.last_busy) = jiffies;
113 }
114 
115 #else /* !CONFIG_PM_RUNTIME */
116 
117 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
118 {
119 	return -ENOSYS;
120 }
121 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
122 {
123 	return -ENOSYS;
124 }
125 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
126 {
127 	return 1;
128 }
129 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
130 {
131 	return -ENOSYS;
132 }
133 static inline int __pm_runtime_set_status(struct device *dev,
134 					    unsigned int status) { return 0; }
135 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
136 static inline void pm_runtime_enable(struct device *dev) {}
137 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
138 static inline void pm_runtime_allow(struct device *dev) {}
139 static inline void pm_runtime_forbid(struct device *dev) {}
140 
141 static inline bool pm_children_suspended(struct device *dev) { return false; }
142 static inline void pm_runtime_get_noresume(struct device *dev) {}
143 static inline void pm_runtime_put_noidle(struct device *dev) {}
144 static inline bool device_run_wake(struct device *dev) { return false; }
145 static inline void device_set_run_wake(struct device *dev, bool enable) {}
146 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
147 static inline bool pm_runtime_active(struct device *dev) { return true; }
148 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
149 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
150 
151 static inline void pm_runtime_no_callbacks(struct device *dev) {}
152 static inline void pm_runtime_irq_safe(struct device *dev) {}
153 
154 static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
155 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
156 static inline void __pm_runtime_use_autosuspend(struct device *dev,
157 						bool use) {}
158 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
159 						int delay) {}
160 static inline unsigned long pm_runtime_autosuspend_expiration(
161 				struct device *dev) { return 0; }
162 static inline void pm_runtime_set_memalloc_noio(struct device *dev,
163 						bool enable){}
164 
165 #endif /* !CONFIG_PM_RUNTIME */
166 
167 static inline int pm_runtime_idle(struct device *dev)
168 {
169 	return __pm_runtime_idle(dev, 0);
170 }
171 
172 static inline int pm_runtime_suspend(struct device *dev)
173 {
174 	return __pm_runtime_suspend(dev, 0);
175 }
176 
177 static inline int pm_runtime_autosuspend(struct device *dev)
178 {
179 	return __pm_runtime_suspend(dev, RPM_AUTO);
180 }
181 
182 static inline int pm_runtime_resume(struct device *dev)
183 {
184 	return __pm_runtime_resume(dev, 0);
185 }
186 
187 static inline int pm_request_idle(struct device *dev)
188 {
189 	return __pm_runtime_idle(dev, RPM_ASYNC);
190 }
191 
192 static inline int pm_request_resume(struct device *dev)
193 {
194 	return __pm_runtime_resume(dev, RPM_ASYNC);
195 }
196 
197 static inline int pm_request_autosuspend(struct device *dev)
198 {
199 	return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
200 }
201 
202 static inline int pm_runtime_get(struct device *dev)
203 {
204 	return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
205 }
206 
207 static inline int pm_runtime_get_sync(struct device *dev)
208 {
209 	return __pm_runtime_resume(dev, RPM_GET_PUT);
210 }
211 
212 static inline int pm_runtime_put(struct device *dev)
213 {
214 	return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
215 }
216 
217 static inline int pm_runtime_put_autosuspend(struct device *dev)
218 {
219 	return __pm_runtime_suspend(dev,
220 	    RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
221 }
222 
223 static inline int pm_runtime_put_sync(struct device *dev)
224 {
225 	return __pm_runtime_idle(dev, RPM_GET_PUT);
226 }
227 
228 static inline int pm_runtime_put_sync_suspend(struct device *dev)
229 {
230 	return __pm_runtime_suspend(dev, RPM_GET_PUT);
231 }
232 
233 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
234 {
235 	return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
236 }
237 
238 static inline int pm_runtime_set_active(struct device *dev)
239 {
240 	return __pm_runtime_set_status(dev, RPM_ACTIVE);
241 }
242 
243 static inline void pm_runtime_set_suspended(struct device *dev)
244 {
245 	__pm_runtime_set_status(dev, RPM_SUSPENDED);
246 }
247 
248 static inline void pm_runtime_disable(struct device *dev)
249 {
250 	__pm_runtime_disable(dev, true);
251 }
252 
253 static inline void pm_runtime_use_autosuspend(struct device *dev)
254 {
255 	__pm_runtime_use_autosuspend(dev, true);
256 }
257 
258 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
259 {
260 	__pm_runtime_use_autosuspend(dev, false);
261 }
262 
263 #endif
264