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