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