blob: ca4823e675e28e2edc81fe6e48160464c4d25dcb [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 Stern3f9af0512010-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 Stern3f9af0512010-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 void pm_runtime_get_noresume(struct device *dev)
70{
71 atomic_inc(&dev->power.usage_count);
72}
73
74static inline void pm_runtime_put_noidle(struct device *dev)
75{
76 atomic_add_unless(&dev->power.usage_count, -1, 0);
77}
78
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +010079static inline bool device_run_wake(struct device *dev)
80{
81 return dev->power.run_wake;
82}
83
84static inline void device_set_run_wake(struct device *dev, bool enable)
85{
86 dev->power.run_wake = enable;
87}
88
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010089static inline bool pm_runtime_suspended(struct device *dev)
90{
Rafael J. Wysockif08f5a02010-12-16 17:11:58 +010091 return dev->power.runtime_status == RPM_SUSPENDED
92 && !dev->power.disable_depth;
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +010093}
94
ShuoX Liufbadc582013-01-23 21:49:37 +010095static inline bool pm_runtime_active(struct device *dev)
96{
97 return dev->power.runtime_status == RPM_ACTIVE
98 || dev->power.disable_depth;
99}
100
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200101static inline bool pm_runtime_status_suspended(struct device *dev)
102{
103 return dev->power.runtime_status == RPM_SUSPENDED;
104}
105
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100106static inline bool pm_runtime_enabled(struct device *dev)
107{
108 return !dev->power.disable_depth;
109}
110
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100111static inline bool pm_runtime_callbacks_present(struct device *dev)
112{
113 return !dev->power.no_callbacks;
114}
115
Alan Stern15bcb91d2010-09-25 23:35:21 +0200116static inline void pm_runtime_mark_last_busy(struct device *dev)
117{
118 ACCESS_ONCE(dev->power.last_busy) = jiffies;
119}
120
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100121static inline bool pm_runtime_is_irq_safe(struct device *dev)
122{
123 return dev->power.irq_safe;
124}
125
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100126#else /* !CONFIG_PM */
127
128static inline bool queue_pm_work(struct work_struct *work) { return false; }
129
130static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
131static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
132static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
133static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200134
Alan Stern140a6c92010-09-25 23:35:07 +0200135static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
136{
137 return -ENOSYS;
138}
139static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
140{
141 return -ENOSYS;
142}
143static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
144{
145 return 1;
146}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200147static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
148{
149 return -ENOSYS;
150}
Rafael J. Wysockia436b6a2015-12-17 02:54:26 +0100151static inline int pm_runtime_get_if_in_use(struct device *dev)
152{
153 return -EINVAL;
154}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200155static inline int __pm_runtime_set_status(struct device *dev,
156 unsigned int status) { return 0; }
157static inline int pm_runtime_barrier(struct device *dev) { return 0; }
158static inline void pm_runtime_enable(struct device *dev) {}
159static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100160static inline void pm_runtime_allow(struct device *dev) {}
161static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200162
Ulf Hansson372a12e2016-04-08 13:40:53 +0200163static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200164static inline void pm_runtime_get_noresume(struct device *dev) {}
165static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysocki7a1a8eb2009-12-03 21:19:18 +0100166static inline bool device_run_wake(struct device *dev) { return false; }
167static inline void device_set_run_wake(struct device *dev, bool enable) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100168static inline bool pm_runtime_suspended(struct device *dev) { return false; }
ShuoX Liufbadc582013-01-23 21:49:37 +0100169static inline bool pm_runtime_active(struct device *dev) { return true; }
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200170static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100171static inline bool pm_runtime_enabled(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200172
Alan Stern7490e442010-09-25 23:35:15 +0200173static inline void pm_runtime_no_callbacks(struct device *dev) {}
Alan Sternc7b61de2010-12-01 00:14:42 +0100174static inline void pm_runtime_irq_safe(struct device *dev) {}
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100175static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200176
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100177static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
Alan Stern15bcb91d2010-09-25 23:35:21 +0200178static inline void pm_runtime_mark_last_busy(struct device *dev) {}
179static inline void __pm_runtime_use_autosuspend(struct device *dev,
180 bool use) {}
181static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
182 int delay) {}
183static inline unsigned long pm_runtime_autosuspend_expiration(
184 struct device *dev) { return 0; }
Ming Leie8234072013-02-22 16:34:11 -0800185static inline void pm_runtime_set_memalloc_noio(struct device *dev,
186 bool enable){}
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100187static inline void pm_runtime_clean_up_links(struct device *dev) {}
188static inline void pm_runtime_get_suppliers(struct device *dev) {}
189static inline void pm_runtime_put_suppliers(struct device *dev) {}
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100190static inline void pm_runtime_new_link(struct device *dev) {}
191static inline void pm_runtime_drop_link(struct device *dev) {}
Alan Stern15bcb91d2010-09-25 23:35:21 +0200192
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100193#endif /* !CONFIG_PM */
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200194
Alan Stern140a6c92010-09-25 23:35:07 +0200195static inline int pm_runtime_idle(struct device *dev)
196{
197 return __pm_runtime_idle(dev, 0);
198}
199
200static inline int pm_runtime_suspend(struct device *dev)
201{
202 return __pm_runtime_suspend(dev, 0);
203}
204
Alan Stern15bcb91d2010-09-25 23:35:21 +0200205static inline int pm_runtime_autosuspend(struct device *dev)
206{
207 return __pm_runtime_suspend(dev, RPM_AUTO);
208}
209
Alan Stern140a6c92010-09-25 23:35:07 +0200210static inline int pm_runtime_resume(struct device *dev)
211{
212 return __pm_runtime_resume(dev, 0);
213}
214
215static inline int pm_request_idle(struct device *dev)
216{
217 return __pm_runtime_idle(dev, RPM_ASYNC);
218}
219
220static inline int pm_request_resume(struct device *dev)
221{
222 return __pm_runtime_resume(dev, RPM_ASYNC);
223}
224
Ming Lei5fc62aa2010-09-29 00:12:22 +0200225static inline int pm_request_autosuspend(struct device *dev)
226{
227 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
228}
229
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200230static inline int pm_runtime_get(struct device *dev)
231{
Alan Stern140a6c92010-09-25 23:35:07 +0200232 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200233}
234
235static inline int pm_runtime_get_sync(struct device *dev)
236{
Alan Stern140a6c92010-09-25 23:35:07 +0200237 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200238}
239
240static inline int pm_runtime_put(struct device *dev)
241{
Alan Stern140a6c92010-09-25 23:35:07 +0200242 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200243}
244
Alan Stern15bcb91d2010-09-25 23:35:21 +0200245static inline int pm_runtime_put_autosuspend(struct device *dev)
246{
247 return __pm_runtime_suspend(dev,
248 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
249}
250
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200251static inline int pm_runtime_put_sync(struct device *dev)
252{
Alan Stern140a6c92010-09-25 23:35:07 +0200253 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200254}
255
Alan Sternc7b61de2010-12-01 00:14:42 +0100256static inline int pm_runtime_put_sync_suspend(struct device *dev)
257{
258 return __pm_runtime_suspend(dev, RPM_GET_PUT);
259}
260
Alan Stern15bcb91d2010-09-25 23:35:21 +0200261static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
262{
263 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
264}
265
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200266static inline int pm_runtime_set_active(struct device *dev)
267{
268 return __pm_runtime_set_status(dev, RPM_ACTIVE);
269}
270
Ulf Hanssonb1a60992016-10-17 20:17:00 +0200271static inline int pm_runtime_set_suspended(struct device *dev)
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200272{
Ulf Hanssonb1a60992016-10-17 20:17:00 +0200273 return __pm_runtime_set_status(dev, RPM_SUSPENDED);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200274}
275
276static inline void pm_runtime_disable(struct device *dev)
277{
278 __pm_runtime_disable(dev, true);
279}
280
Alan Stern15bcb91d2010-09-25 23:35:21 +0200281static inline void pm_runtime_use_autosuspend(struct device *dev)
282{
283 __pm_runtime_use_autosuspend(dev, true);
284}
285
286static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
287{
288 __pm_runtime_use_autosuspend(dev, false);
289}
290
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200291#endif