blob: c2ee87138e4affb30f620f69c98907f7b256a449 [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. Wysocki5e928f72009-08-18 23:38:32 +020061
Ulf Hansson372a12e2016-04-08 13:40:53 +020062static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
63{
64 dev->power.ignore_children = enable;
65}
66
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020067static inline bool pm_children_suspended(struct device *dev)
68{
69 return dev->power.ignore_children
70 || !atomic_read(&dev->power.child_count);
71}
72
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020073static inline void pm_runtime_get_noresume(struct device *dev)
74{
75 atomic_inc(&dev->power.usage_count);
76}
77
78static inline void pm_runtime_put_noidle(struct device *dev)
79{
80 atomic_add_unless(&dev->power.usage_count, -1, 0);
81}
82
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +010083static inline bool device_run_wake(struct device *dev)
84{
85 return dev->power.run_wake;
86}
87
88static inline void device_set_run_wake(struct device *dev, bool enable)
89{
90 dev->power.run_wake = enable;
91}
92
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010093static inline bool pm_runtime_suspended(struct device *dev)
94{
Rafael J. Wysockif08f5a02010-12-16 17:11:58 +010095 return dev->power.runtime_status == RPM_SUSPENDED
96 && !dev->power.disable_depth;
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010097}
98
ShuoX Liufbadc582013-01-23 21:49:37 +010099static inline bool pm_runtime_active(struct device *dev)
100{
101 return dev->power.runtime_status == RPM_ACTIVE
102 || dev->power.disable_depth;
103}
104
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200105static inline bool pm_runtime_status_suspended(struct device *dev)
106{
107 return dev->power.runtime_status == RPM_SUSPENDED;
108}
109
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100110static inline bool pm_runtime_enabled(struct device *dev)
111{
112 return !dev->power.disable_depth;
113}
114
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100115static inline bool pm_runtime_callbacks_present(struct device *dev)
116{
117 return !dev->power.no_callbacks;
118}
119
Alan Stern15bcb91d2010-09-25 23:35:21 +0200120static inline void pm_runtime_mark_last_busy(struct device *dev)
121{
122 ACCESS_ONCE(dev->power.last_busy) = jiffies;
123}
124
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100125static inline bool pm_runtime_is_irq_safe(struct device *dev)
126{
127 return dev->power.irq_safe;
128}
129
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100130#else /* !CONFIG_PM */
131
132static inline bool queue_pm_work(struct work_struct *work) { return false; }
133
134static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
135static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
136static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
137static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200138
Alan Stern140a6c92010-09-25 23:35:07 +0200139static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
140{
141 return -ENOSYS;
142}
143static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
144{
145 return -ENOSYS;
146}
147static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
148{
149 return 1;
150}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200151static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
152{
153 return -ENOSYS;
154}
Rafael J. Wysockia436b6a2015-12-17 02:54:26 +0100155static inline int pm_runtime_get_if_in_use(struct device *dev)
156{
157 return -EINVAL;
158}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200159static inline int __pm_runtime_set_status(struct device *dev,
160 unsigned int status) { return 0; }
161static inline int pm_runtime_barrier(struct device *dev) { return 0; }
162static inline void pm_runtime_enable(struct device *dev) {}
163static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100164static inline void pm_runtime_allow(struct device *dev) {}
165static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200166
Ulf Hansson372a12e2016-04-08 13:40:53 +0200167static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200168static inline bool pm_children_suspended(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200169static inline void pm_runtime_get_noresume(struct device *dev) {}
170static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +0100171static inline bool device_run_wake(struct device *dev) { return false; }
172static inline void device_set_run_wake(struct device *dev, bool enable) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100173static inline bool pm_runtime_suspended(struct device *dev) { return false; }
ShuoX Liufbadc582013-01-23 21:49:37 +0100174static inline bool pm_runtime_active(struct device *dev) { return true; }
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200175static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100176static inline bool pm_runtime_enabled(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200177
Alan Stern7490e442010-09-25 23:35:15 +0200178static inline void pm_runtime_no_callbacks(struct device *dev) {}
Alan Sternc7b61de2010-12-01 00:14:42 +0100179static inline void pm_runtime_irq_safe(struct device *dev) {}
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100180static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200181
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100182static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
Alan Stern15bcb91d2010-09-25 23:35:21 +0200183static inline void pm_runtime_mark_last_busy(struct device *dev) {}
184static inline void __pm_runtime_use_autosuspend(struct device *dev,
185 bool use) {}
186static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
187 int delay) {}
188static inline unsigned long pm_runtime_autosuspend_expiration(
189 struct device *dev) { return 0; }
Ming Leie8234072013-02-22 16:34:11 -0800190static inline void pm_runtime_set_memalloc_noio(struct device *dev,
191 bool enable){}
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100192static inline void pm_runtime_clean_up_links(struct device *dev) {}
193static inline void pm_runtime_get_suppliers(struct device *dev) {}
194static inline void pm_runtime_put_suppliers(struct device *dev) {}
Alan Stern15bcb91d2010-09-25 23:35:21 +0200195
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100196#endif /* !CONFIG_PM */
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200197
Alan Stern140a6c92010-09-25 23:35:07 +0200198static inline int pm_runtime_idle(struct device *dev)
199{
200 return __pm_runtime_idle(dev, 0);
201}
202
203static inline int pm_runtime_suspend(struct device *dev)
204{
205 return __pm_runtime_suspend(dev, 0);
206}
207
Alan Stern15bcb91d2010-09-25 23:35:21 +0200208static inline int pm_runtime_autosuspend(struct device *dev)
209{
210 return __pm_runtime_suspend(dev, RPM_AUTO);
211}
212
Alan Stern140a6c92010-09-25 23:35:07 +0200213static inline int pm_runtime_resume(struct device *dev)
214{
215 return __pm_runtime_resume(dev, 0);
216}
217
218static inline int pm_request_idle(struct device *dev)
219{
220 return __pm_runtime_idle(dev, RPM_ASYNC);
221}
222
223static inline int pm_request_resume(struct device *dev)
224{
225 return __pm_runtime_resume(dev, RPM_ASYNC);
226}
227
Ming Lei5fc62aa2010-09-29 00:12:22 +0200228static inline int pm_request_autosuspend(struct device *dev)
229{
230 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
231}
232
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200233static inline int pm_runtime_get(struct device *dev)
234{
Alan Stern140a6c92010-09-25 23:35:07 +0200235 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200236}
237
238static inline int pm_runtime_get_sync(struct device *dev)
239{
Alan Stern140a6c92010-09-25 23:35:07 +0200240 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200241}
242
243static inline int pm_runtime_put(struct device *dev)
244{
Alan Stern140a6c92010-09-25 23:35:07 +0200245 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200246}
247
Alan Stern15bcb91d2010-09-25 23:35:21 +0200248static inline int pm_runtime_put_autosuspend(struct device *dev)
249{
250 return __pm_runtime_suspend(dev,
251 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
252}
253
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200254static inline int pm_runtime_put_sync(struct device *dev)
255{
Alan Stern140a6c92010-09-25 23:35:07 +0200256 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200257}
258
Alan Sternc7b61de2010-12-01 00:14:42 +0100259static inline int pm_runtime_put_sync_suspend(struct device *dev)
260{
261 return __pm_runtime_suspend(dev, RPM_GET_PUT);
262}
263
Alan Stern15bcb91d2010-09-25 23:35:21 +0200264static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
265{
266 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
267}
268
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200269static inline int pm_runtime_set_active(struct device *dev)
270{
271 return __pm_runtime_set_status(dev, RPM_ACTIVE);
272}
273
274static inline void pm_runtime_set_suspended(struct device *dev)
275{
276 __pm_runtime_set_status(dev, RPM_SUSPENDED);
277}
278
279static inline void pm_runtime_disable(struct device *dev)
280{
281 __pm_runtime_disable(dev, true);
282}
283
Alan Stern15bcb91d2010-09-25 23:35:21 +0200284static inline void pm_runtime_use_autosuspend(struct device *dev)
285{
286 __pm_runtime_use_autosuspend(dev, true);
287}
288
289static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
290{
291 __pm_runtime_use_autosuspend(dev, false);
292}
293
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200294#endif