blob: d34f067e2a7f31e5b391b22382b811913b407515 [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 Stern15bcb91d2010-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 Stern15bcb91d2010-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 Stern15bcb91d2010-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
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +010085static inline bool pm_runtime_enabled(struct device *dev)
86{
87 return !dev->power.disable_depth;
88}
89
Alan Stern15bcb91d2010-09-25 23:35:21 +020090static inline void pm_runtime_mark_last_busy(struct device *dev)
91{
92 ACCESS_ONCE(dev->power.last_busy) = jiffies;
93}
94
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020095#else /* !CONFIG_PM_RUNTIME */
96
Alan Stern140a6c92010-09-25 23:35:07 +020097static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
98{
99 return -ENOSYS;
100}
101static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
102{
103 return -ENOSYS;
104}
105static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
106{
107 return 1;
108}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200109static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
110{
111 return -ENOSYS;
112}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200113static inline int __pm_runtime_set_status(struct device *dev,
114 unsigned int status) { return 0; }
115static inline int pm_runtime_barrier(struct device *dev) { return 0; }
116static inline void pm_runtime_enable(struct device *dev) {}
117static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100118static inline void pm_runtime_allow(struct device *dev) {}
119static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200120
121static inline bool pm_children_suspended(struct device *dev) { return false; }
122static inline void pm_suspend_ignore_children(struct device *dev, bool en) {}
123static inline void pm_runtime_get_noresume(struct device *dev) {}
124static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +0100125static inline bool device_run_wake(struct device *dev) { return false; }
126static inline void device_set_run_wake(struct device *dev, bool enable) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100127static inline bool pm_runtime_suspended(struct device *dev) { return false; }
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100128static inline bool pm_runtime_enabled(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200129
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200130static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
131static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
132static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
Alan Stern7490e442010-09-25 23:35:15 +0200133static inline void pm_runtime_no_callbacks(struct device *dev) {}
Alan Sternc7b61de2010-12-01 00:14:42 +0100134static inline void pm_runtime_irq_safe(struct device *dev) {}
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200135
Alan Stern15bcb91d2010-09-25 23:35:21 +0200136static inline void pm_runtime_mark_last_busy(struct device *dev) {}
137static inline void __pm_runtime_use_autosuspend(struct device *dev,
138 bool use) {}
139static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
140 int delay) {}
141static inline unsigned long pm_runtime_autosuspend_expiration(
142 struct device *dev) { return 0; }
143
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200144#endif /* !CONFIG_PM_RUNTIME */
145
Alan Stern140a6c92010-09-25 23:35:07 +0200146static inline int pm_runtime_idle(struct device *dev)
147{
148 return __pm_runtime_idle(dev, 0);
149}
150
151static inline int pm_runtime_suspend(struct device *dev)
152{
153 return __pm_runtime_suspend(dev, 0);
154}
155
Alan Stern15bcb91d2010-09-25 23:35:21 +0200156static inline int pm_runtime_autosuspend(struct device *dev)
157{
158 return __pm_runtime_suspend(dev, RPM_AUTO);
159}
160
Alan Stern140a6c92010-09-25 23:35:07 +0200161static inline int pm_runtime_resume(struct device *dev)
162{
163 return __pm_runtime_resume(dev, 0);
164}
165
166static inline int pm_request_idle(struct device *dev)
167{
168 return __pm_runtime_idle(dev, RPM_ASYNC);
169}
170
171static inline int pm_request_resume(struct device *dev)
172{
173 return __pm_runtime_resume(dev, RPM_ASYNC);
174}
175
Ming Lei5fc62aa2010-09-29 00:12:22 +0200176static inline int pm_request_autosuspend(struct device *dev)
177{
178 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
179}
180
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200181static inline int pm_runtime_get(struct device *dev)
182{
Alan Stern140a6c92010-09-25 23:35:07 +0200183 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200184}
185
186static inline int pm_runtime_get_sync(struct device *dev)
187{
Alan Stern140a6c92010-09-25 23:35:07 +0200188 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200189}
190
191static inline int pm_runtime_put(struct device *dev)
192{
Alan Stern140a6c92010-09-25 23:35:07 +0200193 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200194}
195
Alan Stern15bcb91d2010-09-25 23:35:21 +0200196static inline int pm_runtime_put_autosuspend(struct device *dev)
197{
198 return __pm_runtime_suspend(dev,
199 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
200}
201
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200202static inline int pm_runtime_put_sync(struct device *dev)
203{
Alan Stern140a6c92010-09-25 23:35:07 +0200204 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200205}
206
Alan Sternc7b61de2010-12-01 00:14:42 +0100207static inline int pm_runtime_put_sync_suspend(struct device *dev)
208{
209 return __pm_runtime_suspend(dev, RPM_GET_PUT);
210}
211
Alan Stern15bcb91d2010-09-25 23:35:21 +0200212static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
213{
214 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
215}
216
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200217static inline int pm_runtime_set_active(struct device *dev)
218{
219 return __pm_runtime_set_status(dev, RPM_ACTIVE);
220}
221
222static inline void pm_runtime_set_suspended(struct device *dev)
223{
224 __pm_runtime_set_status(dev, RPM_SUSPENDED);
225}
226
227static inline void pm_runtime_disable(struct device *dev)
228{
229 __pm_runtime_disable(dev, true);
230}
231
Alan Stern15bcb91d2010-09-25 23:35:21 +0200232static inline void pm_runtime_use_autosuspend(struct device *dev)
233{
234 __pm_runtime_use_autosuspend(dev, true);
235}
236
237static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
238{
239 __pm_runtime_use_autosuspend(dev, false);
240}
241
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200242#endif