include/linux/pm_runtime.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * pm_runtime.h - Device run-time power management helper functions.
   4  *
   5  * Copyright (C) 2009 Rafael J. Wysocki <rjw@sisk.pl>
   6  */
   7
   8 #ifndef _LINUX_PM_RUNTIME_H
   9 #define _LINUX_PM_RUNTIME_H
  10
  11 #include <linux/device.h>
  12 #include <linux/notifier.h>
  13 #include <linux/pm.h>
  14
  15 #include <linux/jiffies.h>
  16
  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 */
  21 #define RPM_GET_PUT             0x04    /* Increment/decrement the
  22                                             usage_count */
  23 #define RPM_AUTO                0x08    /* Use autosuspend_delay */
  24
  25 #ifdef CONFIG_PM
  26 extern struct workqueue_struct *pm_wq;
  27
  28 static inline bool queue_pm_work(struct work_struct *work)
  29 {
  30         return queue_work(pm_wq, work);
  31 }
  32
  33 extern int pm_generic_runtime_suspend(struct device *dev);
  34 extern int pm_generic_runtime_resume(struct device *dev);
  35 extern int pm_runtime_force_suspend(struct device *dev);
  36 extern int pm_runtime_force_resume(struct device *dev);
  37
  38 extern int __pm_runtime_idle(struct device *dev, int rpmflags);
  39 extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
  40 extern int __pm_runtime_resume(struct device *dev, int rpmflags);
  41 extern int pm_runtime_get_if_in_use(struct device *dev);
  42 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
  43 extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
  44 extern int pm_runtime_barrier(struct device *dev);
  45 extern void pm_runtime_enable(struct device *dev);
  46 extern void __pm_runtime_disable(struct device *dev, bool check_resume);
  47 extern void pm_runtime_allow(struct device *dev);
  48 extern void pm_runtime_forbid(struct device *dev);
  49 extern void pm_runtime_no_callbacks(struct device *dev);
  50 extern void pm_runtime_irq_safe(struct device *dev);
  51 extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
  52 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
  53 extern u64 pm_runtime_autosuspend_expiration(struct device *dev);
  54 extern void pm_runtime_update_max_time_suspended(struct device *dev,
  55                                                  s64 delta_ns);
  56 extern void pm_runtime_set_memalloc_noio(struct device *dev, bool enable);
  57 extern void pm_runtime_get_suppliers(struct device *dev);
  58 extern void pm_runtime_put_suppliers(struct device *dev);
  59 extern void pm_runtime_new_link(struct device *dev);
  60 extern void pm_runtime_drop_link(struct device_link *link);
  61
  62 static inline void pm_suspend_ignore_children(struct device *dev, bool enable)
  63 {
  64         dev->power.ignore_children = enable;
  65 }
  66
  67 static inline void pm_runtime_get_noresume(struct device *dev)
  68 {
  69         atomic_inc(&dev->power.usage_count);
  70 }
  71
  72 static inline void pm_runtime_put_noidle(struct device *dev)
  73 {
  74         atomic_add_unless(&dev->power.usage_count, -1, 0);
  75 }
  76
  77 static inline bool pm_runtime_suspended(struct device *dev)
  78 {
  79         return dev->power.runtime_status == RPM_SUSPENDED
  80                 && !dev->power.disable_depth;
  81 }
  82
  83 static inline bool pm_runtime_active(struct device *dev)
  84 {
  85         return dev->power.runtime_status == RPM_ACTIVE
  86                 || dev->power.disable_depth;
  87 }
  88
  89 static inline bool pm_runtime_status_suspended(struct device *dev)
  90 {
  91         return dev->power.runtime_status == RPM_SUSPENDED;
  92 }
  93
  94 static inline bool pm_runtime_enabled(struct device *dev)
  95 {
  96         return !dev->power.disable_depth;
  97 }
  98
  99 static inline bool pm_runtime_callbacks_present(struct device *dev)
 100 {
 101         return !dev->power.no_callbacks;
 102 }
 103
 104 static inline void pm_runtime_mark_last_busy(struct device *dev)
 105 {
 106         WRITE_ONCE(dev->power.last_busy, ktime_get_mono_fast_ns());
 107 }
 108
 109 static inline bool pm_runtime_is_irq_safe(struct device *dev)
 110 {
 111         return dev->power.irq_safe;
 112 }
 113
 114 extern u64 pm_runtime_suspended_time(struct device *dev);
 115
 116 #else /* !CONFIG_PM */
 117
 118 static inline bool queue_pm_work(struct work_struct *work) { return false; }
 119
 120 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
 121 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
 122 static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
 123 static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
 124
 125 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
 126 {
 127         return -ENOSYS;
 128 }
 129 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
 130 {
 131         return -ENOSYS;
 132 }
 133 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
 134 {
 135         return 1;
 136 }
 137 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
 138 {
 139         return -ENOSYS;
 140 }
 141 static inline int pm_runtime_get_if_in_use(struct device *dev)
 142 {
 143         return -EINVAL;
 144 }
 145 static inline int __pm_runtime_set_status(struct device *dev,
 146                                             unsigned int status) { return 0; }
 147 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
 148 static inline void pm_runtime_enable(struct device *dev) {}
 149 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
 150 static inline void pm_runtime_allow(struct device *dev) {}
 151 static inline void pm_runtime_forbid(struct device *dev) {}
 152
 153 static inline void pm_suspend_ignore_children(struct device *dev, bool enable) {}
 154 static inline void pm_runtime_get_noresume(struct device *dev) {}
 155 static inline void pm_runtime_put_noidle(struct device *dev) {}
 156 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
 157 static inline bool pm_runtime_active(struct device *dev) { return true; }
 158 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
 159 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
 160
 161 static inline void pm_runtime_no_callbacks(struct device *dev) {}
 162 static inline void pm_runtime_irq_safe(struct device *dev) {}
 163 static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
 164
 165 static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
 166 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
 167 static inline void __pm_runtime_use_autosuspend(struct device *dev,
 168                                                 bool use) {}
 169 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
 170                                                 int delay) {}
 171 static inline u64 pm_runtime_autosuspend_expiration(
 172                                 struct device *dev) { return 0; }
 173 static inline void pm_runtime_set_memalloc_noio(struct device *dev,
 174                                                 bool enable){}
 175 static inline void pm_runtime_get_suppliers(struct device *dev) {}
 176 static inline void pm_runtime_put_suppliers(struct device *dev) {}
 177 static inline void pm_runtime_new_link(struct device *dev) {}
 178 static inline void pm_runtime_drop_link(struct device_link *link) {}
 179
 180 #endif /* !CONFIG_PM */
 181
 182 static inline int pm_runtime_idle(struct device *dev)
 183 {
 184         return __pm_runtime_idle(dev, 0);
 185 }
 186
 187 static inline int pm_runtime_suspend(struct device *dev)
 188 {
 189         return __pm_runtime_suspend(dev, 0);
 190 }
 191
 192 static inline int pm_runtime_autosuspend(struct device *dev)
 193 {
 194         return __pm_runtime_suspend(dev, RPM_AUTO);
 195 }
 196
 197 static inline int pm_runtime_resume(struct device *dev)
 198 {
 199         return __pm_runtime_resume(dev, 0);
 200 }
 201
 202 static inline int pm_request_idle(struct device *dev)
 203 {
 204         return __pm_runtime_idle(dev, RPM_ASYNC);
 205 }
 206
 207 static inline int pm_request_resume(struct device *dev)
 208 {
 209         return __pm_runtime_resume(dev, RPM_ASYNC);
 210 }
 211
 212 static inline int pm_request_autosuspend(struct device *dev)
 213 {
 214         return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
 215 }
 216
 217 static inline int pm_runtime_get(struct device *dev)
 218 {
 219         return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
 220 }
 221
 222 static inline int pm_runtime_get_sync(struct device *dev)
 223 {
 224         return __pm_runtime_resume(dev, RPM_GET_PUT);
 225 }
 226
 227 /**
 228  * pm_runtime_resume_and_get - Bump up usage counter of a device and resume it.
 229  * @dev: Target device.
 230  *
 231  * Resume @dev synchronously and if that is successful, increment its runtime
 232  * PM usage counter. Return 0 if the runtime PM usage counter of @dev has been
 233  * incremented or a negative error code otherwise.
 234  */
 235 static inline int pm_runtime_resume_and_get(struct device *dev)
 236 {
 237         int ret;
 238
 239         ret = __pm_runtime_resume(dev, RPM_GET_PUT);
 240         if (ret < 0) {
 241                 pm_runtime_put_noidle(dev);
 242                 return ret;
 243         }
 244
 245         return 0;
 246 }
 247
 248 static inline int pm_runtime_put(struct device *dev)
 249 {
 250         return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
 251 }
 252
 253 static inline int pm_runtime_put_autosuspend(struct device *dev)
 254 {
 255         return __pm_runtime_suspend(dev,
 256             RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
 257 }
 258
 259 static inline int pm_runtime_put_sync(struct device *dev)
 260 {
 261         return __pm_runtime_idle(dev, RPM_GET_PUT);
 262 }
 263
 264 static inline int pm_runtime_put_sync_suspend(struct device *dev)
 265 {
 266         return __pm_runtime_suspend(dev, RPM_GET_PUT);
 267 }
 268
 269 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
 270 {
 271         return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
 272 }
 273
 274 static inline int pm_runtime_set_active(struct device *dev)
 275 {
 276         return __pm_runtime_set_status(dev, RPM_ACTIVE);
 277 }
 278
 279 static inline int pm_runtime_set_suspended(struct device *dev)
 280 {
 281         return __pm_runtime_set_status(dev, RPM_SUSPENDED);
 282 }
 283
 284 static inline void pm_runtime_disable(struct device *dev)
 285 {
 286         __pm_runtime_disable(dev, true);
 287 }
 288
 289 static inline void pm_runtime_use_autosuspend(struct device *dev)
 290 {
 291         __pm_runtime_use_autosuspend(dev, true);
 292 }
 293
 294 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
 295 {
 296         __pm_runtime_use_autosuspend(dev, false);
 297 }
 298
 299 #endif