blob: 73814877537dd2432674ca9359e3c36cf03af89c [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>
Paul Gortmaker246359d2011-05-27 07:08:41 -040013#include <linux/notifier.h>
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020014#include <linux/pm.h>
15
Alan Stern15bcb91d2010-09-25 23:35:21 +020016#include <linux/jiffies.h>
17
Alan Stern3f9af052010-09-25 23:34:54 +020018/* 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 */
Alan Stern140a6c92010-09-25 23:35:07 +020022#define RPM_GET_PUT 0x04 /* Increment/decrement the
23 usage_count */
Alan Stern15bcb91d2010-09-25 23:35:21 +020024#define RPM_AUTO 0x08 /* Use autosuspend_delay */
Alan Stern3f9af052010-09-25 23:34:54 +020025
Ulf Hansson717e5d42013-12-10 14:37:41 +010026#ifdef CONFIG_PM
Rafael J. Wysocki28cb5ef2014-07-23 01:00:36 +020027extern struct workqueue_struct *pm_wq;
28
29static inline bool queue_pm_work(struct work_struct *work)
30{
31 return queue_work(pm_wq, work);
32}
33
Ulf Hansson717e5d42013-12-10 14:37:41 +010034extern int pm_generic_runtime_suspend(struct device *dev);
35extern int pm_generic_runtime_resume(struct device *dev);
Ulf Hansson37f20412014-03-01 11:56:05 +010036extern int pm_runtime_force_suspend(struct device *dev);
37extern int pm_runtime_force_resume(struct device *dev);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020038
Alan Stern140a6c92010-09-25 23:35:07 +020039extern int __pm_runtime_idle(struct device *dev, int rpmflags);
40extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
41extern int __pm_runtime_resume(struct device *dev, int rpmflags);
Rafael J. Wysockia436b6a2015-12-17 02:54:26 +010042extern int pm_runtime_get_if_in_use(struct device *dev);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020043extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020044extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
45extern int pm_runtime_barrier(struct device *dev);
46extern void pm_runtime_enable(struct device *dev);
47extern void __pm_runtime_disable(struct device *dev, bool check_resume);
Rafael J. Wysocki53823632010-01-23 22:02:51 +010048extern void pm_runtime_allow(struct device *dev);
49extern void pm_runtime_forbid(struct device *dev);
Alan Stern7490e442010-09-25 23:35:15 +020050extern void pm_runtime_no_callbacks(struct device *dev);
Alan Sternc7b61de2010-12-01 00:14:42 +010051extern void pm_runtime_irq_safe(struct device *dev);
Alan Stern15bcb91d2010-09-25 23:35:21 +020052extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
53extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
54extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +010055extern void pm_runtime_update_max_time_suspended(struct device *dev,
56 s64 delta_ns);
Ming Leie8234072013-02-22 16:34:11 -080057extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +010058extern void pm_runtime_clean_up_links(struct device *dev);
59extern void pm_runtime_get_suppliers(struct device *dev);
60extern void pm_runtime_put_suppliers(struct device *dev);
Rafael J. Wysockibaa88092016-10-30 17:32:43 +010061extern void pm_runtime_new_link(struct device *dev);
62extern void pm_runtime_drop_link(struct device *dev);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020063
Ulf Hansson372a12e2016-04-08 13:40:53 +020064static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
65{
66 dev->power.ignore_children = enable;
67}
68
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020069static inline bool pm_children_suspended(struct device *dev)
70{
71 return dev->power.ignore_children
72 || !atomic_read(&dev->power.child_count);
73}
74
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020075static inline void pm_runtime_get_noresume(struct device *dev)
76{
77 atomic_inc(&dev->power.usage_count);
78}
79
80static inline void pm_runtime_put_noidle(struct device *dev)
81{
82 atomic_add_unless(&dev->power.usage_count, -1, 0);
83}
84
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +010085static inline bool device_run_wake(struct device *dev)
86{
87 return dev->power.run_wake;
88}
89
90static inline void device_set_run_wake(struct device *dev, bool enable)
91{
92 dev->power.run_wake = enable;
93}
94
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010095static inline bool pm_runtime_suspended(struct device *dev)
96{
Rafael J. Wysockif08f5a02010-12-16 17:11:58 +010097 return dev->power.runtime_status == RPM_SUSPENDED
98 && !dev->power.disable_depth;
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010099}
100
ShuoX Liufbadc582013-01-23 21:49:37 +0100101static inline bool pm_runtime_active(struct device *dev)
102{
103 return dev->power.runtime_status == RPM_ACTIVE
104 || dev->power.disable_depth;
105}
106
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200107static inline bool pm_runtime_status_suspended(struct device *dev)
108{
109 return dev->power.runtime_status == RPM_SUSPENDED;
110}
111
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100112static inline bool pm_runtime_enabled(struct device *dev)
113{
114 return !dev->power.disable_depth;
115}
116
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100117static inline bool pm_runtime_callbacks_present(struct device *dev)
118{
119 return !dev->power.no_callbacks;
120}
121
Alan Stern15bcb91d2010-09-25 23:35:21 +0200122static inline void pm_runtime_mark_last_busy(struct device *dev)
123{
124 ACCESS_ONCE(dev->power.last_busy) = jiffies;
125}
126
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100127static inline bool pm_runtime_is_irq_safe(struct device *dev)
128{
129 return dev->power.irq_safe;
130}
131
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100132#else /* !CONFIG_PM */
133
134static inline bool queue_pm_work(struct work_struct *work) { return false; }
135
136static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
137static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
138static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
139static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200140
Alan Stern140a6c92010-09-25 23:35:07 +0200141static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
142{
143 return -ENOSYS;
144}
145static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
146{
147 return -ENOSYS;
148}
149static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
150{
151 return 1;
152}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200153static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
154{
155 return -ENOSYS;
156}
Rafael J. Wysockia436b6a2015-12-17 02:54:26 +0100157static inline int pm_runtime_get_if_in_use(struct device *dev)
158{
159 return -EINVAL;
160}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200161static inline int __pm_runtime_set_status(struct device *dev,
162 unsigned int status) { return 0; }
163static inline int pm_runtime_barrier(struct device *dev) { return 0; }
164static inline void pm_runtime_enable(struct device *dev) {}
165static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100166static inline void pm_runtime_allow(struct device *dev) {}
167static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200168
Ulf Hansson372a12e2016-04-08 13:40:53 +0200169static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200170static inline bool pm_children_suspended(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200171static inline void pm_runtime_get_noresume(struct device *dev) {}
172static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +0100173static inline bool device_run_wake(struct device *dev) { return false; }
174static inline void device_set_run_wake(struct device *dev, bool enable) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100175static inline bool pm_runtime_suspended(struct device *dev) { return false; }
ShuoX Liufbadc582013-01-23 21:49:37 +0100176static inline bool pm_runtime_active(struct device *dev) { return true; }
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200177static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100178static inline bool pm_runtime_enabled(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200179
Alan Stern7490e442010-09-25 23:35:15 +0200180static inline void pm_runtime_no_callbacks(struct device *dev) {}
Alan Sternc7b61de2010-12-01 00:14:42 +0100181static inline void pm_runtime_irq_safe(struct device *dev) {}
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100182static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200183
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100184static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
Alan Stern15bcb91d2010-09-25 23:35:21 +0200185static inline void pm_runtime_mark_last_busy(struct device *dev) {}
186static inline void __pm_runtime_use_autosuspend(struct device *dev,
187 bool use) {}
188static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
189 int delay) {}
190static inline unsigned long pm_runtime_autosuspend_expiration(
191 struct device *dev) { return 0; }
Ming Leie8234072013-02-22 16:34:11 -0800192static inline void pm_runtime_set_memalloc_noio(struct device *dev,
193 bool enable){}
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100194static inline void pm_runtime_clean_up_links(struct device *dev) {}
195static inline void pm_runtime_get_suppliers(struct device *dev) {}
196static inline void pm_runtime_put_suppliers(struct device *dev) {}
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100197static inline void pm_runtime_new_link(struct device *dev) {}
198static inline void pm_runtime_drop_link(struct device *dev) {}
Alan Stern15bcb91d2010-09-25 23:35:21 +0200199
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100200#endif /* !CONFIG_PM */
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200201
Alan Stern140a6c92010-09-25 23:35:07 +0200202static inline int pm_runtime_idle(struct device *dev)
203{
204 return __pm_runtime_idle(dev, 0);
205}
206
207static inline int pm_runtime_suspend(struct device *dev)
208{
209 return __pm_runtime_suspend(dev, 0);
210}
211
Alan Stern15bcb91d2010-09-25 23:35:21 +0200212static inline int pm_runtime_autosuspend(struct device *dev)
213{
214 return __pm_runtime_suspend(dev, RPM_AUTO);
215}
216
Alan Stern140a6c92010-09-25 23:35:07 +0200217static inline int pm_runtime_resume(struct device *dev)
218{
219 return __pm_runtime_resume(dev, 0);
220}
221
222static inline int pm_request_idle(struct device *dev)
223{
224 return __pm_runtime_idle(dev, RPM_ASYNC);
225}
226
227static inline int pm_request_resume(struct device *dev)
228{
229 return __pm_runtime_resume(dev, RPM_ASYNC);
230}
231
Ming Lei5fc62aa2010-09-29 00:12:22 +0200232static inline int pm_request_autosuspend(struct device *dev)
233{
234 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
235}
236
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200237static inline int pm_runtime_get(struct device *dev)
238{
Alan Stern140a6c92010-09-25 23:35:07 +0200239 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200240}
241
242static inline int pm_runtime_get_sync(struct device *dev)
243{
Alan Stern140a6c92010-09-25 23:35:07 +0200244 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200245}
246
247static inline int pm_runtime_put(struct device *dev)
248{
Alan Stern140a6c92010-09-25 23:35:07 +0200249 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200250}
251
Alan Stern15bcb91d2010-09-25 23:35:21 +0200252static inline int pm_runtime_put_autosuspend(struct device *dev)
253{
254 return __pm_runtime_suspend(dev,
255 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
256}
257
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200258static inline int pm_runtime_put_sync(struct device *dev)
259{
Alan Stern140a6c92010-09-25 23:35:07 +0200260 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200261}
262
Alan Sternc7b61de2010-12-01 00:14:42 +0100263static inline int pm_runtime_put_sync_suspend(struct device *dev)
264{
265 return __pm_runtime_suspend(dev, RPM_GET_PUT);
266}
267
Alan Stern15bcb91d2010-09-25 23:35:21 +0200268static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
269{
270 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
271}
272
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200273static inline int pm_runtime_set_active(struct device *dev)
274{
275 return __pm_runtime_set_status(dev, RPM_ACTIVE);
276}
277
278static inline void pm_runtime_set_suspended(struct device *dev)
279{
280 __pm_runtime_set_status(dev, RPM_SUSPENDED);
281}
282
283static inline void pm_runtime_disable(struct device *dev)
284{
285 __pm_runtime_disable(dev, true);
286}
287
Alan Stern15bcb91d2010-09-25 23:35:21 +0200288static inline void pm_runtime_use_autosuspend(struct device *dev)
289{
290 __pm_runtime_use_autosuspend(dev, true);
291}
292
293static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
294{
295 __pm_runtime_use_autosuspend(dev, false);
296}
297
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200298#endif