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