Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / kernel / common / b06c0b2f087ab498d51d50f5ae353133b602f614 / . / include / linux / pm_runtime.h
blob: f0fc4700b6ff53adfb8584162ae0bb3c522237a2 [file] [log] [blame]
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]1/*
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 -0400[diff] [blame]13#include <linux/notifier.h>
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]14#include <linux/pm.h>
15
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]16#include <linux/jiffies.h>
17
Alan Stern3f9af052010-09-25 23:34:54 +0200[diff] [blame]18/* 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 +0200[diff] [blame]22#define RPM_GET_PUT 0x04 /* Increment/decrement the
23 usage_count */
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]24#define RPM_AUTO 0x08 /* Use autosuspend_delay */
Alan Stern3f9af052010-09-25 23:34:54 +0200[diff] [blame]25
Ulf Hansson717e5d42013-12-10 14:37:41 +0100[diff] [blame]26#ifdef CONFIG_PM
Rafael J. Wysocki28cb5ef2014-07-23 01:00:36 +0200[diff] [blame]27extern 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 +0100[diff] [blame]34extern int pm_generic_runtime_suspend(struct device *dev);
35extern int pm_generic_runtime_resume(struct device *dev);
Ulf Hansson37f20412014-03-01 11:56:05 +0100[diff] [blame]36extern 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 +0200[diff] [blame]38
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]39extern 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 +0100[diff] [blame]42extern int pm_runtime_get_if_in_use(struct device *dev);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]43extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]44extern 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 +0100[diff] [blame]48extern void pm_runtime_allow(struct device *dev);
49extern void pm_runtime_forbid(struct device *dev);
Alan Stern7490e442010-09-25 23:35:15 +0200[diff] [blame]50extern void pm_runtime_no_callbacks(struct device *dev);
Alan Sternc7b61de2010-12-01 00:14:42 +0100[diff] [blame]51extern void pm_runtime_irq_safe(struct device *dev);
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]52extern 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 +0100[diff] [blame]55extern void pm_runtime_update_max_time_suspended(struct device *dev,
56 s64 delta_ns);
Ming Leie8234072013-02-22 16:34:11 -0800[diff] [blame]57extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100[diff] [blame]58extern void pm_runtime_clean_up_links(struct device *dev);
Rafael J. Wysockib06c0b2f2018-06-12 10:24:13 +0200[diff] [blame^]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 +0100[diff] [blame]61extern 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 +0200[diff] [blame]63
Ulf Hansson372a12e2016-04-08 13:40:53 +0200[diff] [blame]64static 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 +0200[diff] [blame]69static 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. Wysockid690b2c2010-03-06 21:28:37 +0100[diff] [blame]79static inline bool pm_runtime_suspended(struct device *dev)
80{
Rafael J. Wysockif08f5a02010-12-16 17:11:58 +0100[diff] [blame]81 return dev->power.runtime_status == RPM_SUSPENDED
82 && !dev->power.disable_depth;
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100[diff] [blame]83}
84
ShuoX Liufbadc582013-01-23 21:49:37 +0100[diff] [blame]85static inline bool pm_runtime_active(struct device *dev)
86{
87 return dev->power.runtime_status == RPM_ACTIVE
88 || dev->power.disable_depth;
89}
90
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200[diff] [blame]91static inline bool pm_runtime_status_suspended(struct device *dev)
92{
93 return dev->power.runtime_status == RPM_SUSPENDED;
94}
95
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100[diff] [blame]96static inline bool pm_runtime_enabled(struct device *dev)
97{
98 return !dev->power.disable_depth;
99}
100
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100[diff] [blame]101static inline bool pm_runtime_callbacks_present(struct device *dev)
102{
103 return !dev->power.no_callbacks;
104}
105
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]106static inline void pm_runtime_mark_last_busy(struct device *dev)
107{
Mark Rutland6aa7de02017-10-23 14:07:29 -0700[diff] [blame]108 WRITE_ONCE(dev->power.last_busy, jiffies);
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]109}
110
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100[diff] [blame]111static inline bool pm_runtime_is_irq_safe(struct device *dev)
112{
113 return dev->power.irq_safe;
114}
115
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100[diff] [blame]116#else /* !CONFIG_PM */
117
118static inline bool queue_pm_work(struct work_struct *work) { return false; }
119
120static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
121static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
122static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
123static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]124
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]125static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
126{
127 return -ENOSYS;
128}
129static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
130{
131 return -ENOSYS;
132}
133static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
134{
135 return 1;
136}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]137static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
138{
139 return -ENOSYS;
140}
Rafael J. Wysockia436b6a2015-12-17 02:54:26 +0100[diff] [blame]141static inline int pm_runtime_get_if_in_use(struct device *dev)
142{
143 return -EINVAL;
144}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]145static inline int __pm_runtime_set_status(struct device *dev,
146 unsigned int status) { return 0; }
147static inline int pm_runtime_barrier(struct device *dev) { return 0; }
148static inline void pm_runtime_enable(struct device *dev) {}
149static inline void __pm_runtime_disable(struct device *dev, bool c) {}
Rafael J. Wysocki53823632010-01-23 22:02:51 +0100[diff] [blame]150static inline void pm_runtime_allow(struct device *dev) {}
151static inline void pm_runtime_forbid(struct device *dev) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]152
Ulf Hansson372a12e2016-04-08 13:40:53 +0200[diff] [blame]153static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]154static inline void pm_runtime_get_noresume(struct device *dev) {}
155static inline void pm_runtime_put_noidle(struct device *dev) {}
Rafael J. Wysockid690b2c2010-03-06 21:28:37 +0100[diff] [blame]156static inline bool pm_runtime_suspended(struct device *dev) { return false; }
ShuoX Liufbadc582013-01-23 21:49:37 +0100[diff] [blame]157static inline bool pm_runtime_active(struct device *dev) { return true; }
Kevin Hilmanf3393b62011-07-12 11:17:09 +0200[diff] [blame]158static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
Rafael J. Wysocki4b31db82010-12-24 15:04:06 +0100[diff] [blame]159static inline bool pm_runtime_enabled(struct device *dev) { return false; }
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]160
Alan Stern7490e442010-09-25 23:35:15 +0200[diff] [blame]161static inline void pm_runtime_no_callbacks(struct device *dev) {}
Alan Sternc7b61de2010-12-01 00:14:42 +0100[diff] [blame]162static inline void pm_runtime_irq_safe(struct device *dev) {}
Krzysztof Kozlowski3fb15812014-11-14 09:47:25 +0100[diff] [blame]163static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
Rafael J. Wysocki2f60ba72010-05-10 23:09:30 +0200[diff] [blame]164
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100[diff] [blame]165static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]166static inline void pm_runtime_mark_last_busy(struct device *dev) {}
167static inline void __pm_runtime_use_autosuspend(struct device *dev,
168 bool use) {}
169static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
170 int delay) {}
171static inline unsigned long pm_runtime_autosuspend_expiration(
172 struct device *dev) { return 0; }
Ming Leie8234072013-02-22 16:34:11 -0800[diff] [blame]173static inline void pm_runtime_set_memalloc_noio(struct device *dev,
174 bool enable){}
Rafael J. Wysocki21d5c572016-10-30 17:32:31 +0100[diff] [blame]175static inline void pm_runtime_clean_up_links(struct device *dev) {}
Rafael J. Wysockib06c0b2f2018-06-12 10:24:13 +0200[diff] [blame^]176static inline void pm_runtime_get_suppliers(struct device *dev) {}
177static inline void pm_runtime_put_suppliers(struct device *dev) {}
Rafael J. Wysockibaa88092016-10-30 17:32:43 +0100[diff] [blame]178static inline void pm_runtime_new_link(struct device *dev) {}
179static inline void pm_runtime_drop_link(struct device *dev) {}
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]180
Rafael J. Wysockid30d8192014-11-27 22:38:05 +0100[diff] [blame]181#endif /* !CONFIG_PM */
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]182
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]183static inline int pm_runtime_idle(struct device *dev)
184{
185 return __pm_runtime_idle(dev, 0);
186}
187
188static inline int pm_runtime_suspend(struct device *dev)
189{
190 return __pm_runtime_suspend(dev, 0);
191}
192
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]193static inline int pm_runtime_autosuspend(struct device *dev)
194{
195 return __pm_runtime_suspend(dev, RPM_AUTO);
196}
197
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]198static inline int pm_runtime_resume(struct device *dev)
199{
200 return __pm_runtime_resume(dev, 0);
201}
202
203static inline int pm_request_idle(struct device *dev)
204{
205 return __pm_runtime_idle(dev, RPM_ASYNC);
206}
207
208static inline int pm_request_resume(struct device *dev)
209{
210 return __pm_runtime_resume(dev, RPM_ASYNC);
211}
212
Ming Lei5fc62aa2010-09-29 00:12:22 +0200[diff] [blame]213static inline int pm_request_autosuspend(struct device *dev)
214{
215 return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
216}
217
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]218static inline int pm_runtime_get(struct device *dev)
219{
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]220 return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]221}
222
223static inline int pm_runtime_get_sync(struct device *dev)
224{
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]225 return __pm_runtime_resume(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]226}
227
228static inline int pm_runtime_put(struct device *dev)
229{
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]230 return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]231}
232
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]233static inline int pm_runtime_put_autosuspend(struct device *dev)
234{
235 return __pm_runtime_suspend(dev,
236 RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
237}
238
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]239static inline int pm_runtime_put_sync(struct device *dev)
240{
Alan Stern140a6c92010-09-25 23:35:07 +0200[diff] [blame]241 return __pm_runtime_idle(dev, RPM_GET_PUT);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]242}
243
Alan Sternc7b61de2010-12-01 00:14:42 +0100[diff] [blame]244static inline int pm_runtime_put_sync_suspend(struct device *dev)
245{
246 return __pm_runtime_suspend(dev, RPM_GET_PUT);
247}
248
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]249static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
250{
251 return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
252}
253
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]254static inline int pm_runtime_set_active(struct device *dev)
255{
256 return __pm_runtime_set_status(dev, RPM_ACTIVE);
257}
258
Ulf Hanssonb1a60992016-10-17 20:17:00 +0200[diff] [blame]259static inline int pm_runtime_set_suspended(struct device *dev)
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]260{
Ulf Hanssonb1a60992016-10-17 20:17:00 +0200[diff] [blame]261 return __pm_runtime_set_status(dev, RPM_SUSPENDED);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]262}
263
264static inline void pm_runtime_disable(struct device *dev)
265{
266 __pm_runtime_disable(dev, true);
267}
268
Alan Stern15bcb91d2010-09-25 23:35:21 +0200[diff] [blame]269static inline void pm_runtime_use_autosuspend(struct device *dev)
270{
271 __pm_runtime_use_autosuspend(dev, true);
272}
273
274static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
275{
276 __pm_runtime_use_autosuspend(dev, false);
277}
278
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200[diff] [blame]279#endif