Rafael J. Wysocki | 5e928f7 | 2009-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 Gortmaker | 246359d | 2011-05-27 07:08:41 -0400 | [diff] [blame] | 13 | #include <linux/notifier.h> |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 14 | #include <linux/pm.h> |
| 15 | |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 16 | #include <linux/jiffies.h> |
| 17 | |
Alan Stern | 3f9af05 | 2010-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 Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 22 | #define RPM_GET_PUT 0x04 /* Increment/decrement the |
| 23 | usage_count */ |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 24 | #define RPM_AUTO 0x08 /* Use autosuspend_delay */ |
Alan Stern | 3f9af05 | 2010-09-25 23:34:54 +0200 | [diff] [blame] | 25 | |
Ulf Hansson | 717e5d4 | 2013-12-10 14:37:41 +0100 | [diff] [blame] | 26 | #ifdef CONFIG_PM |
Rafael J. Wysocki | 28cb5ef | 2014-07-23 01:00:36 +0200 | [diff] [blame] | 27 | extern struct workqueue_struct *pm_wq; |
| 28 | |
| 29 | static inline bool queue_pm_work(struct work_struct *work) |
| 30 | { |
| 31 | return queue_work(pm_wq, work); |
| 32 | } |
| 33 | |
Ulf Hansson | 717e5d4 | 2013-12-10 14:37:41 +0100 | [diff] [blame] | 34 | extern int pm_generic_runtime_suspend(struct device *dev); |
| 35 | extern int pm_generic_runtime_resume(struct device *dev); |
Ulf Hansson | 37f2041 | 2014-03-01 11:56:05 +0100 | [diff] [blame] | 36 | extern int pm_runtime_force_suspend(struct device *dev); |
| 37 | extern int pm_runtime_force_resume(struct device *dev); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 38 | |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 39 | extern int __pm_runtime_idle(struct device *dev, int rpmflags); |
| 40 | extern int __pm_runtime_suspend(struct device *dev, int rpmflags); |
| 41 | extern int __pm_runtime_resume(struct device *dev, int rpmflags); |
Rafael J. Wysocki | a436b6a | 2015-12-17 02:54:26 +0100 | [diff] [blame] | 42 | extern int pm_runtime_get_if_in_use(struct device *dev); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 43 | extern int pm_schedule_suspend(struct device *dev, unsigned int delay); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 44 | extern int __pm_runtime_set_status(struct device *dev, unsigned int status); |
| 45 | extern int pm_runtime_barrier(struct device *dev); |
| 46 | extern void pm_runtime_enable(struct device *dev); |
| 47 | extern void __pm_runtime_disable(struct device *dev, bool check_resume); |
Rafael J. Wysocki | 5382363 | 2010-01-23 22:02:51 +0100 | [diff] [blame] | 48 | extern void pm_runtime_allow(struct device *dev); |
| 49 | extern void pm_runtime_forbid(struct device *dev); |
Alan Stern | 7490e44 | 2010-09-25 23:35:15 +0200 | [diff] [blame] | 50 | extern void pm_runtime_no_callbacks(struct device *dev); |
Alan Stern | c7b61de | 2010-12-01 00:14:42 +0100 | [diff] [blame] | 51 | extern void pm_runtime_irq_safe(struct device *dev); |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 52 | extern void __pm_runtime_use_autosuspend(struct device *dev, bool use); |
| 53 | extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay); |
| 54 | extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev); |
Rafael J. Wysocki | 00dc9ad | 2011-12-01 00:01:31 +0100 | [diff] [blame] | 55 | extern void pm_runtime_update_max_time_suspended(struct device *dev, |
| 56 | s64 delta_ns); |
Ming Lei | e823407 | 2013-02-22 16:34:11 -0800 | [diff] [blame] | 57 | extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 58 | |
Ulf Hansson | 372a12e | 2016-04-08 13:40:53 +0200 | [diff] [blame] | 59 | static inline void pm_suspend_ignore_children(struct device *dev, bool enable) |
| 60 | { |
| 61 | dev->power.ignore_children = enable; |
| 62 | } |
| 63 | |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 64 | static inline bool pm_children_suspended(struct device *dev) |
| 65 | { |
| 66 | return dev->power.ignore_children |
| 67 | || !atomic_read(&dev->power.child_count); |
| 68 | } |
| 69 | |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 70 | static inline void pm_runtime_get_noresume(struct device *dev) |
| 71 | { |
| 72 | atomic_inc(&dev->power.usage_count); |
| 73 | } |
| 74 | |
| 75 | static inline void pm_runtime_put_noidle(struct device *dev) |
| 76 | { |
| 77 | atomic_add_unless(&dev->power.usage_count, -1, 0); |
| 78 | } |
| 79 | |
Rafael J. Wysocki | 7a1a8eb | 2009-12-03 21:19:18 +0100 | [diff] [blame] | 80 | static inline bool device_run_wake(struct device *dev) |
| 81 | { |
| 82 | return dev->power.run_wake; |
| 83 | } |
| 84 | |
| 85 | static inline void device_set_run_wake(struct device *dev, bool enable) |
| 86 | { |
| 87 | dev->power.run_wake = enable; |
| 88 | } |
| 89 | |
Rafael J. Wysocki | d690b2c | 2010-03-06 21:28:37 +0100 | [diff] [blame] | 90 | static inline bool pm_runtime_suspended(struct device *dev) |
| 91 | { |
Rafael J. Wysocki | f08f5a0 | 2010-12-16 17:11:58 +0100 | [diff] [blame] | 92 | return dev->power.runtime_status == RPM_SUSPENDED |
| 93 | && !dev->power.disable_depth; |
Rafael J. Wysocki | d690b2c | 2010-03-06 21:28:37 +0100 | [diff] [blame] | 94 | } |
| 95 | |
ShuoX Liu | fbadc58 | 2013-01-23 21:49:37 +0100 | [diff] [blame] | 96 | static inline bool pm_runtime_active(struct device *dev) |
| 97 | { |
| 98 | return dev->power.runtime_status == RPM_ACTIVE |
| 99 | || dev->power.disable_depth; |
| 100 | } |
| 101 | |
Kevin Hilman | f3393b6 | 2011-07-12 11:17:09 +0200 | [diff] [blame] | 102 | static inline bool pm_runtime_status_suspended(struct device *dev) |
| 103 | { |
| 104 | return dev->power.runtime_status == RPM_SUSPENDED; |
| 105 | } |
| 106 | |
Rafael J. Wysocki | 4b31db8 | 2010-12-24 15:04:06 +0100 | [diff] [blame] | 107 | static inline bool pm_runtime_enabled(struct device *dev) |
| 108 | { |
| 109 | return !dev->power.disable_depth; |
| 110 | } |
| 111 | |
Rafael J. Wysocki | cb8f51b | 2011-02-08 23:26:02 +0100 | [diff] [blame] | 112 | static inline bool pm_runtime_callbacks_present(struct device *dev) |
| 113 | { |
| 114 | return !dev->power.no_callbacks; |
| 115 | } |
| 116 | |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 117 | static inline void pm_runtime_mark_last_busy(struct device *dev) |
| 118 | { |
| 119 | ACCESS_ONCE(dev->power.last_busy) = jiffies; |
| 120 | } |
| 121 | |
Krzysztof Kozlowski | 3fb1581 | 2014-11-14 09:47:25 +0100 | [diff] [blame] | 122 | static inline bool pm_runtime_is_irq_safe(struct device *dev) |
| 123 | { |
| 124 | return dev->power.irq_safe; |
| 125 | } |
| 126 | |
Rafael J. Wysocki | d30d819 | 2014-11-27 22:38:05 +0100 | [diff] [blame] | 127 | #else /* !CONFIG_PM */ |
| 128 | |
| 129 | static inline bool queue_pm_work(struct work_struct *work) { return false; } |
| 130 | |
| 131 | static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; } |
| 132 | static inline int pm_generic_runtime_resume(struct device *dev) { return 0; } |
| 133 | static inline int pm_runtime_force_suspend(struct device *dev) { return 0; } |
| 134 | static inline int pm_runtime_force_resume(struct device *dev) { return 0; } |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 135 | |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 136 | static inline int __pm_runtime_idle(struct device *dev, int rpmflags) |
| 137 | { |
| 138 | return -ENOSYS; |
| 139 | } |
| 140 | static inline int __pm_runtime_suspend(struct device *dev, int rpmflags) |
| 141 | { |
| 142 | return -ENOSYS; |
| 143 | } |
| 144 | static inline int __pm_runtime_resume(struct device *dev, int rpmflags) |
| 145 | { |
| 146 | return 1; |
| 147 | } |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 148 | static inline int pm_schedule_suspend(struct device *dev, unsigned int delay) |
| 149 | { |
| 150 | return -ENOSYS; |
| 151 | } |
Rafael J. Wysocki | a436b6a | 2015-12-17 02:54:26 +0100 | [diff] [blame] | 152 | static inline int pm_runtime_get_if_in_use(struct device *dev) |
| 153 | { |
| 154 | return -EINVAL; |
| 155 | } |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 156 | static inline int __pm_runtime_set_status(struct device *dev, |
| 157 | unsigned int status) { return 0; } |
| 158 | static inline int pm_runtime_barrier(struct device *dev) { return 0; } |
| 159 | static inline void pm_runtime_enable(struct device *dev) {} |
| 160 | static inline void __pm_runtime_disable(struct device *dev, bool c) {} |
Rafael J. Wysocki | 5382363 | 2010-01-23 22:02:51 +0100 | [diff] [blame] | 161 | static inline void pm_runtime_allow(struct device *dev) {} |
| 162 | static inline void pm_runtime_forbid(struct device *dev) {} |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 163 | |
Ulf Hansson | 372a12e | 2016-04-08 13:40:53 +0200 | [diff] [blame] | 164 | static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {} |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 165 | static inline bool pm_children_suspended(struct device *dev) { return false; } |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 166 | static inline void pm_runtime_get_noresume(struct device *dev) {} |
| 167 | static inline void pm_runtime_put_noidle(struct device *dev) {} |
Rafael J. Wysocki | 7a1a8eb | 2009-12-03 21:19:18 +0100 | [diff] [blame] | 168 | static inline bool device_run_wake(struct device *dev) { return false; } |
| 169 | static inline void device_set_run_wake(struct device *dev, bool enable) {} |
Rafael J. Wysocki | d690b2c | 2010-03-06 21:28:37 +0100 | [diff] [blame] | 170 | static inline bool pm_runtime_suspended(struct device *dev) { return false; } |
ShuoX Liu | fbadc58 | 2013-01-23 21:49:37 +0100 | [diff] [blame] | 171 | static inline bool pm_runtime_active(struct device *dev) { return true; } |
Kevin Hilman | f3393b6 | 2011-07-12 11:17:09 +0200 | [diff] [blame] | 172 | static inline bool pm_runtime_status_suspended(struct device *dev) { return false; } |
Rafael J. Wysocki | 4b31db8 | 2010-12-24 15:04:06 +0100 | [diff] [blame] | 173 | static inline bool pm_runtime_enabled(struct device *dev) { return false; } |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 174 | |
Alan Stern | 7490e44 | 2010-09-25 23:35:15 +0200 | [diff] [blame] | 175 | static inline void pm_runtime_no_callbacks(struct device *dev) {} |
Alan Stern | c7b61de | 2010-12-01 00:14:42 +0100 | [diff] [blame] | 176 | static inline void pm_runtime_irq_safe(struct device *dev) {} |
Krzysztof Kozlowski | 3fb1581 | 2014-11-14 09:47:25 +0100 | [diff] [blame] | 177 | static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; } |
Rafael J. Wysocki | 2f60ba7 | 2010-05-10 23:09:30 +0200 | [diff] [blame] | 178 | |
Rafael J. Wysocki | cb8f51b | 2011-02-08 23:26:02 +0100 | [diff] [blame] | 179 | static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; } |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 180 | static inline void pm_runtime_mark_last_busy(struct device *dev) {} |
| 181 | static inline void __pm_runtime_use_autosuspend(struct device *dev, |
| 182 | bool use) {} |
| 183 | static inline void pm_runtime_set_autosuspend_delay(struct device *dev, |
| 184 | int delay) {} |
| 185 | static inline unsigned long pm_runtime_autosuspend_expiration( |
| 186 | struct device *dev) { return 0; } |
Ming Lei | e823407 | 2013-02-22 16:34:11 -0800 | [diff] [blame] | 187 | static inline void pm_runtime_set_memalloc_noio(struct device *dev, |
| 188 | bool enable){} |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 189 | |
Rafael J. Wysocki | d30d819 | 2014-11-27 22:38:05 +0100 | [diff] [blame] | 190 | #endif /* !CONFIG_PM */ |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 191 | |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 192 | static inline int pm_runtime_idle(struct device *dev) |
| 193 | { |
| 194 | return __pm_runtime_idle(dev, 0); |
| 195 | } |
| 196 | |
| 197 | static inline int pm_runtime_suspend(struct device *dev) |
| 198 | { |
| 199 | return __pm_runtime_suspend(dev, 0); |
| 200 | } |
| 201 | |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 202 | static inline int pm_runtime_autosuspend(struct device *dev) |
| 203 | { |
| 204 | return __pm_runtime_suspend(dev, RPM_AUTO); |
| 205 | } |
| 206 | |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 207 | static inline int pm_runtime_resume(struct device *dev) |
| 208 | { |
| 209 | return __pm_runtime_resume(dev, 0); |
| 210 | } |
| 211 | |
| 212 | static inline int pm_request_idle(struct device *dev) |
| 213 | { |
| 214 | return __pm_runtime_idle(dev, RPM_ASYNC); |
| 215 | } |
| 216 | |
| 217 | static inline int pm_request_resume(struct device *dev) |
| 218 | { |
| 219 | return __pm_runtime_resume(dev, RPM_ASYNC); |
| 220 | } |
| 221 | |
Ming Lei | 5fc62aa | 2010-09-29 00:12:22 +0200 | [diff] [blame] | 222 | static inline int pm_request_autosuspend(struct device *dev) |
| 223 | { |
| 224 | return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO); |
| 225 | } |
| 226 | |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 227 | static inline int pm_runtime_get(struct device *dev) |
| 228 | { |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 229 | return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | static inline int pm_runtime_get_sync(struct device *dev) |
| 233 | { |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 234 | return __pm_runtime_resume(dev, RPM_GET_PUT); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 235 | } |
| 236 | |
| 237 | static inline int pm_runtime_put(struct device *dev) |
| 238 | { |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 239 | return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 240 | } |
| 241 | |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 242 | static inline int pm_runtime_put_autosuspend(struct device *dev) |
| 243 | { |
| 244 | return __pm_runtime_suspend(dev, |
| 245 | RPM_GET_PUT | RPM_ASYNC | RPM_AUTO); |
| 246 | } |
| 247 | |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 248 | static inline int pm_runtime_put_sync(struct device *dev) |
| 249 | { |
Alan Stern | 140a6c9 | 2010-09-25 23:35:07 +0200 | [diff] [blame] | 250 | return __pm_runtime_idle(dev, RPM_GET_PUT); |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 251 | } |
| 252 | |
Alan Stern | c7b61de | 2010-12-01 00:14:42 +0100 | [diff] [blame] | 253 | static inline int pm_runtime_put_sync_suspend(struct device *dev) |
| 254 | { |
| 255 | return __pm_runtime_suspend(dev, RPM_GET_PUT); |
| 256 | } |
| 257 | |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 258 | static inline int pm_runtime_put_sync_autosuspend(struct device *dev) |
| 259 | { |
| 260 | return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO); |
| 261 | } |
| 262 | |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 263 | static inline int pm_runtime_set_active(struct device *dev) |
| 264 | { |
| 265 | return __pm_runtime_set_status(dev, RPM_ACTIVE); |
| 266 | } |
| 267 | |
| 268 | static inline void pm_runtime_set_suspended(struct device *dev) |
| 269 | { |
| 270 | __pm_runtime_set_status(dev, RPM_SUSPENDED); |
| 271 | } |
| 272 | |
| 273 | static inline void pm_runtime_disable(struct device *dev) |
| 274 | { |
| 275 | __pm_runtime_disable(dev, true); |
| 276 | } |
| 277 | |
Alan Stern | 15bcb91d | 2010-09-25 23:35:21 +0200 | [diff] [blame] | 278 | static inline void pm_runtime_use_autosuspend(struct device *dev) |
| 279 | { |
| 280 | __pm_runtime_use_autosuspend(dev, true); |
| 281 | } |
| 282 | |
| 283 | static inline void pm_runtime_dont_use_autosuspend(struct device *dev) |
| 284 | { |
| 285 | __pm_runtime_use_autosuspend(dev, false); |
| 286 | } |
| 287 | |
Rafael J. Wysocki | 5e928f7 | 2009-08-18 23:38:32 +0200 | [diff] [blame] | 288 | #endif |