blob: 70b284024d9ea52abb5d54f178815c39369c13ed [file] [log] [blame]
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +02001/*
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/pm.h>
14
Alan Stern15bcb912010-09-25 23:35:21 +020015#include <linux/jiffies.h>
16
Alan Stern3f9af052010-09-25 23:34:54 +020017/* 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 */
Alan Stern140a6c92010-09-25 23:35:07 +020021#define RPM_GET_PUT 0x04 /* Increment/decrement the
22 usage_count */
Alan Stern15bcb912010-09-25 23:35:21 +020023#define RPM_AUTO 0x08 /* Use autosuspend_delay */
Alan Stern3f9af052010-09-25 23:34:54 +020024
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020025#ifdef CONFIG_PM_RUNTIME
26
27extern struct workqueue_struct *pm_wq;
28
Alan Stern140a6c92010-09-25 23:35:07 +020029extern int __pm_runtime_idle(struct device *dev, int rpmflags);
30extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
31extern int __pm_runtime_resume(struct device *dev, int rpmflags);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020032extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020033extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
34extern int pm_runtime_barrier(struct device *dev);
35extern void pm_runtime_enable(struct device *dev);
36extern void __pm_runtime_disable(struct device *dev, bool check_resume);
Rafael J. Wysocki53823632010-01-23 22:02:51 +010037extern void pm_runtime_allow(struct device *dev);
38extern void pm_runtime_forbid(struct device *dev);
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +020039extern int pm_generic_runtime_idle(struct device *dev);
40extern int pm_generic_runtime_suspend(struct device *dev);
41extern int pm_generic_runtime_resume(struct device *dev);
Alan Stern7490e442010-09-25 23:35:15 +020042extern void pm_runtime_no_callbacks(struct device *dev);
Alan Sternc7b61de2010-12-01 00:14:42 +010043extern void pm_runtime_irq_safe(struct device *dev);
Alan Stern15bcb912010-09-25 23:35:21 +020044extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
45extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
46extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020047
48static inline bool pm_children_suspended(struct device *dev)
49{
50 return dev->power.ignore_children
51 || !atomic_read(&dev->power.child_count);
52}
53
54static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
55{
56 dev->power.ignore_children = enable;
57}
58
59static inline void pm_runtime_get_noresume(struct device *dev)
60{
61 atomic_inc(&dev->power.usage_count);
62}
63
64static inline void pm_runtime_put_noidle(struct device *dev)
65{
66 atomic_add_unless(&dev->power.usage_count, -1, 0);
67}
68
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +010069static inline bool device_run_wake(struct device *dev)
70{
71 return dev->power.run_wake;
72}
73
74static inline void device_set_run_wake(struct device *dev, bool enable)
75{
76 dev->power.run_wake = enable;
77}
78
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010079static inline bool pm_runtime_suspended(struct device *dev)
80{
Rafael J. Wysockif08f5a02010-12-16 17:11:58 +010081 return dev->power.runtime_status == RPM_SUSPENDED
82 && !dev->power.disable_depth;
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010083}
84
Kevin Hilmanf3393b62011-07-12 11:17:09 +020085static inline bool pm_runtime_status_suspended(struct device *dev)
86{
87 return dev->power.runtime_status == RPM_SUSPENDED;
88}
89
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +010090static inline bool pm_runtime_enabled(struct device *dev)
91{
92 return !dev->power.disable_depth;
93}
94
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +010095static inline bool pm_runtime_callbacks_present(struct device *dev)
96{
97 return !dev->power.no_callbacks;
98}
99
Alan Stern15bcb912010-09-25 23:35:21 +0200100static inline void pm_runtime_mark_last_busy(struct device *dev)
101{
102 ACCESS_ONCE(dev->power.last_busy) = jiffies;
103}
104
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200105#else /* !CONFIG_PM_RUNTIME */
106
Alan Stern140a6c92010-09-25 23:35:07 +0200107static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
108{
109 return -ENOSYS;
110}
111static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
112{
113 return -ENOSYS;
114}
115static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
116{
117 return 1;
118}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200119static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
120{
121 return -ENOSYS;
122}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200123static inline int __pm_runtime_set_status(struct device *dev,
124 unsigned int status) { return 0; }
125static inline int pm_runtime_barrier(struct device *dev) { return 0; }
126static inline void pm_runtime_enable(struct device *dev) {}
127static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100128static inline void pm_runtime_allow(struct device *dev) {}
129static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200130
131static inline bool pm_children_suspended(struct device *dev) { return false; }
132static inline void pm_suspend_ignore_children(struct device *dev, bool en) {}
133static inline void pm_runtime_get_noresume(struct device *dev) {}
134static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +0100135static inline bool device_run_wake(struct device *dev) { return false; }
136static inline void device_set_run_wake(struct device *dev, bool enable) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100137static inline bool pm_runtime_suspended(struct device *dev) { return false; }
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200138static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100139static inline bool pm_runtime_enabled(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200140
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200141static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
142static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
143static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
Alan Stern7490e442010-09-25 23:35:15 +0200144static inline void pm_runtime_no_callbacks(struct device *dev) {}
Alan Sternc7b61de2010-12-01 00:14:42 +0100145static inline void pm_runtime_irq_safe(struct device *dev) {}
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200146
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100147static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
Alan Stern15bcb912010-09-25 23:35:21 +0200148static inline void pm_runtime_mark_last_busy(struct device *dev) {}
149static inline void __pm_runtime_use_autosuspend(struct device *dev,
150 bool use) {}
151static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
152 int delay) {}
153static inline unsigned long pm_runtime_autosuspend_expiration(
154 struct device *dev) { return 0; }
155
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200156#endif /* !CONFIG_PM_RUNTIME */
157
Alan Stern140a6c92010-09-25 23:35:07 +0200158static inline int pm_runtime_idle(struct device *dev)
159{
160 return __pm_runtime_idle(dev, 0);
161}
162
163static inline int pm_runtime_suspend(struct device *dev)
164{
165 return __pm_runtime_suspend(dev, 0);
166}
167
Alan Stern15bcb912010-09-25 23:35:21 +0200168static inline int pm_runtime_autosuspend(struct device *dev)
169{
170 return __pm_runtime_suspend(dev, RPM_AUTO);
171}
172
Alan Stern140a6c92010-09-25 23:35:07 +0200173static inline int pm_runtime_resume(struct device *dev)
174{
175 return __pm_runtime_resume(dev, 0);
176}
177
178static inline int pm_request_idle(struct device *dev)
179{
180 return __pm_runtime_idle(dev, RPM_ASYNC);
181}
182
183static inline int pm_request_resume(struct device *dev)
184{
185 return __pm_runtime_resume(dev, RPM_ASYNC);
186}
187
Ming Lei5fc62aa2010-09-29 00:12:22 +0200188static inline int pm_request_autosuspend(struct device *dev)
189{
190 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
191}
192
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200193static inline int pm_runtime_get(struct device *dev)
194{
Alan Stern140a6c92010-09-25 23:35:07 +0200195 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200196}
197
198static inline int pm_runtime_get_sync(struct device *dev)
199{
Alan Stern140a6c92010-09-25 23:35:07 +0200200 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200201}
202
203static inline int pm_runtime_put(struct device *dev)
204{
Alan Stern140a6c92010-09-25 23:35:07 +0200205 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200206}
207
Alan Stern15bcb912010-09-25 23:35:21 +0200208static inline int pm_runtime_put_autosuspend(struct device *dev)
209{
210 return __pm_runtime_suspend(dev,
211 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
212}
213
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200214static inline int pm_runtime_put_sync(struct device *dev)
215{
Alan Stern140a6c92010-09-25 23:35:07 +0200216 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200217}
218
Alan Sternc7b61de2010-12-01 00:14:42 +0100219static inline int pm_runtime_put_sync_suspend(struct device *dev)
220{
221 return __pm_runtime_suspend(dev, RPM_GET_PUT);
222}
223
Alan Stern15bcb912010-09-25 23:35:21 +0200224static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
225{
226 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
227}
228
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200229static inline int pm_runtime_set_active(struct device *dev)
230{
231 return __pm_runtime_set_status(dev, RPM_ACTIVE);
232}
233
234static inline void pm_runtime_set_suspended(struct device *dev)
235{
236 __pm_runtime_set_status(dev, RPM_SUSPENDED);
237}
238
239static inline void pm_runtime_disable(struct device *dev)
240{
241 __pm_runtime_disable(dev, true);
242}
243
Alan Stern15bcb912010-09-25 23:35:21 +0200244static inline void pm_runtime_use_autosuspend(struct device *dev)
245{
246 __pm_runtime_use_autosuspend(dev, true);
247}
248
249static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
250{
251 __pm_runtime_use_autosuspend(dev, false);
252}
253
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200254#endif