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