blob: 3ec2358f8692d11027e6af927402fcbc0f039da2 [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 Stern15bcb91d2010-09-25 23:35:21 +020043extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
44extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
45extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020046
47static inline bool pm_children_suspended(struct device *dev)
48{
49 return dev->power.ignore_children
50 || !atomic_read(&dev->power.child_count);
51}
52
53static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
54{
55 dev->power.ignore_children = enable;
56}
57
58static inline void pm_runtime_get_noresume(struct device *dev)
59{
60 atomic_inc(&dev->power.usage_count);
61}
62
63static inline void pm_runtime_put_noidle(struct device *dev)
64{
65 atomic_add_unless(&dev->power.usage_count, -1, 0);
66}
67
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +010068static inline bool device_run_wake(struct device *dev)
69{
70 return dev->power.run_wake;
71}
72
73static inline void device_set_run_wake(struct device *dev, bool enable)
74{
75 dev->power.run_wake = enable;
76}
77
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010078static inline bool pm_runtime_suspended(struct device *dev)
79{
80 return dev->power.runtime_status == RPM_SUSPENDED;
81}
82
Alan Stern15bcb91d2010-09-25 23:35:21 +020083static inline void pm_runtime_mark_last_busy(struct device *dev)
84{
85 ACCESS_ONCE(dev->power.last_busy) = jiffies;
86}
87
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020088#else /* !CONFIG_PM_RUNTIME */
89
Alan Stern140a6c92010-09-25 23:35:07 +020090static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
91{
92 return -ENOSYS;
93}
94static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
95{
96 return -ENOSYS;
97}
98static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
99{
100 return 1;
101}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200102static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
103{
104 return -ENOSYS;
105}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200106static inline int __pm_runtime_set_status(struct device *dev,
107 unsigned int status) { return 0; }
108static inline int pm_runtime_barrier(struct device *dev) { return 0; }
109static inline void pm_runtime_enable(struct device *dev) {}
110static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100111static inline void pm_runtime_allow(struct device *dev) {}
112static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200113
114static inline bool pm_children_suspended(struct device *dev) { return false; }
115static inline void pm_suspend_ignore_children(struct device *dev, bool en) {}
116static inline void pm_runtime_get_noresume(struct device *dev) {}
117static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +0100118static inline bool device_run_wake(struct device *dev) { return false; }
119static inline void device_set_run_wake(struct device *dev, bool enable) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100120static inline bool pm_runtime_suspended(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200121
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200122static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
123static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
124static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
Alan Stern7490e442010-09-25 23:35:15 +0200125static inline void pm_runtime_no_callbacks(struct device *dev) {}
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200126
Alan Stern15bcb91d2010-09-25 23:35:21 +0200127static inline void pm_runtime_mark_last_busy(struct device *dev) {}
128static inline void __pm_runtime_use_autosuspend(struct device *dev,
129 bool use) {}
130static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
131 int delay) {}
132static inline unsigned long pm_runtime_autosuspend_expiration(
133 struct device *dev) { return 0; }
134
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200135#endif /* !CONFIG_PM_RUNTIME */
136
Alan Stern140a6c92010-09-25 23:35:07 +0200137static inline int pm_runtime_idle(struct device *dev)
138{
139 return __pm_runtime_idle(dev, 0);
140}
141
142static inline int pm_runtime_suspend(struct device *dev)
143{
144 return __pm_runtime_suspend(dev, 0);
145}
146
Alan Stern15bcb91d2010-09-25 23:35:21 +0200147static inline int pm_runtime_autosuspend(struct device *dev)
148{
149 return __pm_runtime_suspend(dev, RPM_AUTO);
150}
151
Alan Stern140a6c92010-09-25 23:35:07 +0200152static inline int pm_runtime_resume(struct device *dev)
153{
154 return __pm_runtime_resume(dev, 0);
155}
156
157static inline int pm_request_idle(struct device *dev)
158{
159 return __pm_runtime_idle(dev, RPM_ASYNC);
160}
161
162static inline int pm_request_resume(struct device *dev)
163{
164 return __pm_runtime_resume(dev, RPM_ASYNC);
165}
166
Ming Lei5fc62aa2010-09-29 00:12:22 +0200167static inline int pm_request_autosuspend(struct device *dev)
168{
169 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
170}
171
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200172static inline int pm_runtime_get(struct device *dev)
173{
Alan Stern140a6c92010-09-25 23:35:07 +0200174 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200175}
176
177static inline int pm_runtime_get_sync(struct device *dev)
178{
Alan Stern140a6c92010-09-25 23:35:07 +0200179 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200180}
181
182static inline int pm_runtime_put(struct device *dev)
183{
Alan Stern140a6c92010-09-25 23:35:07 +0200184 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200185}
186
Alan Stern15bcb91d2010-09-25 23:35:21 +0200187static inline int pm_runtime_put_autosuspend(struct device *dev)
188{
189 return __pm_runtime_suspend(dev,
190 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
191}
192
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200193static inline int pm_runtime_put_sync(struct device *dev)
194{
Alan Stern140a6c92010-09-25 23:35:07 +0200195 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200196}
197
Alan Stern15bcb91d2010-09-25 23:35:21 +0200198static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
199{
200 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
201}
202
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200203static inline int pm_runtime_set_active(struct device *dev)
204{
205 return __pm_runtime_set_status(dev, RPM_ACTIVE);
206}
207
208static inline void pm_runtime_set_suspended(struct device *dev)
209{
210 __pm_runtime_set_status(dev, RPM_SUSPENDED);
211}
212
213static inline void pm_runtime_disable(struct device *dev)
214{
215 __pm_runtime_disable(dev, true);
216}
217
Alan Stern15bcb91d2010-09-25 23:35:21 +0200218static inline void pm_runtime_use_autosuspend(struct device *dev)
219{
220 __pm_runtime_use_autosuspend(dev, true);
221}
222
223static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
224{
225 __pm_runtime_use_autosuspend(dev, false);
226}
227
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200228#endif