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