1 | /* |
2 | * pm_runtime.h - Device run-time power management helper functions. |
3 | * |
4 | * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl> |
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 struct workqueue_struct *pm_wq; |
28 | |
29 | static inline bool queue_pm_work(struct work_struct *work) |
30 | { |
31 | return queue_work(pm_wq, work); |
32 | } |
33 | |
34 | extern int pm_generic_runtime_suspend(struct device *dev); |
35 | extern int pm_generic_runtime_resume(struct device *dev); |
36 | extern int pm_runtime_force_suspend(struct device *dev); |
37 | extern int pm_runtime_force_resume(struct device *dev); |
38 | |
39 | extern int __pm_runtime_idle(struct device *dev, int rpmflags); |
40 | extern int __pm_runtime_suspend(struct device *dev, int rpmflags); |
41 | extern int __pm_runtime_resume(struct device *dev, int rpmflags); |
42 | extern int pm_runtime_get_if_in_use(struct device *dev); |
43 | extern int pm_schedule_suspend(struct device *dev, unsigned int delay); |
44 | extern int __pm_runtime_set_status(struct device *dev, unsigned int status); |
45 | extern int pm_runtime_barrier(struct device *dev); |
46 | extern void pm_runtime_enable(struct device *dev); |
47 | extern void __pm_runtime_disable(struct device *dev, bool check_resume); |
48 | extern void pm_runtime_allow(struct device *dev); |
49 | extern void pm_runtime_forbid(struct device *dev); |
50 | extern void pm_runtime_no_callbacks(struct device *dev); |
51 | extern void pm_runtime_irq_safe(struct device *dev); |
52 | extern void __pm_runtime_use_autosuspend(struct device *dev, bool use); |
53 | extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay); |
54 | extern u64 pm_runtime_autosuspend_expiration(struct device *dev); |
55 | extern void pm_runtime_update_max_time_suspended(struct device *dev, |
56 | s64 delta_ns); |
57 | extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable); |
58 | extern void pm_runtime_clean_up_links(struct device *dev); |
59 | extern void pm_runtime_get_suppliers(struct device *dev); |
60 | extern void pm_runtime_put_suppliers(struct device *dev); |
61 | extern void pm_runtime_new_link(struct device *dev); |
62 | extern void pm_runtime_drop_link(struct device *dev); |
63 | |
64 | static inline void pm_suspend_ignore_children(struct device *dev, bool enable) |
65 | { |
66 | dev->power.ignore_children = enable; |
67 | } |
68 | |
69 | static inline void pm_runtime_get_noresume(struct device *dev) |
70 | { |
71 | atomic_inc(&dev->power.usage_count); |
72 | } |
73 | |
74 | static inline void pm_runtime_put_noidle(struct device *dev) |
75 | { |
76 | atomic_add_unless(&dev->power.usage_count, -1, 0); |
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_active(struct device *dev) |
86 | { |
87 | return dev->power.runtime_status == RPM_ACTIVE |
88 | || dev->power.disable_depth; |
89 | } |
90 | |
91 | static inline bool pm_runtime_status_suspended(struct device *dev) |
92 | { |
93 | return dev->power.runtime_status == RPM_SUSPENDED; |
94 | } |
95 | |
96 | static inline bool pm_runtime_enabled(struct device *dev) |
97 | { |
98 | return !dev->power.disable_depth; |
99 | } |
100 | |
101 | static inline bool pm_runtime_callbacks_present(struct device *dev) |
102 | { |
103 | return !dev->power.no_callbacks; |
104 | } |
105 | |
106 | static inline void pm_runtime_mark_last_busy(struct device *dev) |
107 | { |
108 | WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns()); |
109 | } |
110 | |
111 | static inline bool pm_runtime_is_irq_safe(struct device *dev) |
112 | { |
113 | return dev->power.irq_safe; |
114 | } |
115 | |
116 | extern u64 pm_runtime_suspended_time(struct device *dev); |
117 | |
118 | #else /* !CONFIG_PM */ |
119 | |
120 | static inline bool queue_pm_work(struct work_struct *work) { return false; } |
121 | |
122 | static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; } |
123 | static inline int pm_generic_runtime_resume(struct device *dev) { return 0; } |
124 | static inline int pm_runtime_force_suspend(struct device *dev) { return 0; } |
125 | static inline int pm_runtime_force_resume(struct device *dev) { return 0; } |
126 | |
127 | static inline int __pm_runtime_idle(struct device *dev, int rpmflags) |
128 | { |
129 | return -ENOSYS; |
130 | } |
131 | static inline int __pm_runtime_suspend(struct device *dev, int rpmflags) |
132 | { |
133 | return -ENOSYS; |
134 | } |
135 | static inline int __pm_runtime_resume(struct device *dev, int rpmflags) |
136 | { |
137 | return 1; |
138 | } |
139 | static inline int pm_schedule_suspend(struct device *dev, unsigned int delay) |
140 | { |
141 | return -ENOSYS; |
142 | } |
143 | static inline int pm_runtime_get_if_in_use(struct device *dev) |
144 | { |
145 | return -EINVAL; |
146 | } |
147 | static inline int __pm_runtime_set_status(struct device *dev, |
148 | unsigned int status) { return 0; } |
149 | static inline int pm_runtime_barrier(struct device *dev) { return 0; } |
150 | static inline void pm_runtime_enable(struct device *dev) {} |
151 | static inline void __pm_runtime_disable(struct device *dev, bool c) {} |
152 | static inline void pm_runtime_allow(struct device *dev) {} |
153 | static inline void pm_runtime_forbid(struct device *dev) {} |
154 | |
155 | static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {} |
156 | static inline void pm_runtime_get_noresume(struct device *dev) {} |
157 | static inline void pm_runtime_put_noidle(struct device *dev) {} |
158 | static inline bool pm_runtime_suspended(struct device *dev) { return false; } |
159 | static inline bool pm_runtime_active(struct device *dev) { return true; } |
160 | static inline bool pm_runtime_status_suspended(struct device *dev) { return false; } |
161 | static inline bool pm_runtime_enabled(struct device *dev) { return false; } |
162 | |
163 | static inline void pm_runtime_no_callbacks(struct device *dev) {} |
164 | static inline void pm_runtime_irq_safe(struct device *dev) {} |
165 | static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; } |
166 | |
167 | static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; } |
168 | static inline void pm_runtime_mark_last_busy(struct device *dev) {} |
169 | static inline void __pm_runtime_use_autosuspend(struct device *dev, |
170 | bool use) {} |
171 | static inline void pm_runtime_set_autosuspend_delay(struct device *dev, |
172 | int delay) {} |
173 | static inline u64 pm_runtime_autosuspend_expiration( |
174 | struct device *dev) { return 0; } |
175 | static inline void pm_runtime_set_memalloc_noio(struct device *dev, |
176 | bool enable){} |
177 | static inline void pm_runtime_clean_up_links(struct device *dev) {} |
178 | static inline void pm_runtime_get_suppliers(struct device *dev) {} |
179 | static inline void pm_runtime_put_suppliers(struct device *dev) {} |
180 | static inline void pm_runtime_new_link(struct device *dev) {} |
181 | static inline void pm_runtime_drop_link(struct device *dev) {} |
182 | |
183 | #endif /* !CONFIG_PM */ |
184 | |
185 | static inline int pm_runtime_idle(struct device *dev) |
186 | { |
187 | return __pm_runtime_idle(dev, 0); |
188 | } |
189 | |
190 | static inline int pm_runtime_suspend(struct device *dev) |
191 | { |
192 | return __pm_runtime_suspend(dev, 0); |
193 | } |
194 | |
195 | static inline int pm_runtime_autosuspend(struct device *dev) |
196 | { |
197 | return __pm_runtime_suspend(dev, RPM_AUTO); |
198 | } |
199 | |
200 | static inline int pm_runtime_resume(struct device *dev) |
201 | { |
202 | return __pm_runtime_resume(dev, 0); |
203 | } |
204 | |
205 | static inline int pm_request_idle(struct device *dev) |
206 | { |
207 | return __pm_runtime_idle(dev, RPM_ASYNC); |
208 | } |
209 | |
210 | static inline int pm_request_resume(struct device *dev) |
211 | { |
212 | return __pm_runtime_resume(dev, RPM_ASYNC); |
213 | } |
214 | |
215 | static inline int pm_request_autosuspend(struct device *dev) |
216 | { |
217 | return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO); |
218 | } |
219 | |
220 | static inline int pm_runtime_get(struct device *dev) |
221 | { |
222 | return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC); |
223 | } |
224 | |
225 | static inline int pm_runtime_get_sync(struct device *dev) |
226 | { |
227 | return __pm_runtime_resume(dev, RPM_GET_PUT); |
228 | } |
229 | |
230 | static inline int pm_runtime_put(struct device *dev) |
231 | { |
232 | return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC); |
233 | } |
234 | |
235 | static inline int pm_runtime_put_autosuspend(struct device *dev) |
236 | { |
237 | return __pm_runtime_suspend(dev, |
238 | RPM_GET_PUT | RPM_ASYNC | RPM_AUTO); |
239 | } |
240 | |
241 | static inline int pm_runtime_put_sync(struct device *dev) |
242 | { |
243 | return __pm_runtime_idle(dev, RPM_GET_PUT); |
244 | } |
245 | |
246 | static inline int pm_runtime_put_sync_suspend(struct device *dev) |
247 | { |
248 | return __pm_runtime_suspend(dev, RPM_GET_PUT); |
249 | } |
250 | |
251 | static inline int pm_runtime_put_sync_autosuspend(struct device *dev) |
252 | { |
253 | return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO); |
254 | } |
255 | |
256 | static inline int pm_runtime_set_active(struct device *dev) |
257 | { |
258 | return __pm_runtime_set_status(dev, RPM_ACTIVE); |
259 | } |
260 | |
261 | static inline int pm_runtime_set_suspended(struct device *dev) |
262 | { |
263 | return __pm_runtime_set_status(dev, RPM_SUSPENDED); |
264 | } |
265 | |
266 | static inline void pm_runtime_disable(struct device *dev) |
267 | { |
268 | __pm_runtime_disable(dev, true); |
269 | } |
270 | |
271 | static inline void pm_runtime_use_autosuspend(struct device *dev) |
272 | { |
273 | __pm_runtime_use_autosuspend(dev, true); |
274 | } |
275 | |
276 | static inline void pm_runtime_dont_use_autosuspend(struct device *dev) |
277 | { |
278 | __pm_runtime_use_autosuspend(dev, false); |
279 | } |
280 | |
281 | #endif |
282 | |