include/linux/pm_runtime.h

   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>
  13 #include <linux/notifier.h>
  14 #include <linux/pm.h>
  15
  16 #include <linux/jiffies.h>
  17
  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 */
  22 #define RPM_GET_PUT             0x04    /* Increment/decrement the
  23                                             usage_count */
  24 #define RPM_AUTO                0x08    /* Use autosuspend_delay */
  25
  26 #ifdef CONFIG_PM_RUNTIME
  27
  28 extern struct workqueue_struct *pm_wq;
  29
  30 extern int __pm_runtime_idle(struct device *dev, int rpmflags);
  31 extern int __pm_runtime_suspend(struct device *dev, int rpmflags);
  32 extern int __pm_runtime_resume(struct device *dev, int rpmflags);
  33 extern int pm_schedule_suspend(struct device *dev, unsigned int delay);
  34 extern int __pm_runtime_set_status(struct device *dev, unsigned int status);
  35 extern int pm_runtime_barrier(struct device *dev);
  36 extern void pm_runtime_enable(struct device *dev);
  37 extern void __pm_runtime_disable(struct device *dev, bool check_resume);
  38 extern void pm_runtime_allow(struct device *dev);
  39 extern void pm_runtime_forbid(struct device *dev);
  40 extern int pm_generic_runtime_idle(struct device *dev);
  41 extern int pm_generic_runtime_suspend(struct device *dev);
  42 extern int pm_generic_runtime_resume(struct device *dev);
  43 extern void pm_runtime_no_callbacks(struct device *dev);
  44 extern void pm_runtime_irq_safe(struct device *dev);
  45 extern void __pm_runtime_use_autosuspend(struct device *dev, bool use);
  46 extern void pm_runtime_set_autosuspend_delay(struct device *dev, int delay);
  47 extern unsigned long pm_runtime_autosuspend_expiration(struct device *dev);
  48
  49 static inline bool pm_children_suspended(struct device *dev)
  50 {
  51         return dev->power.ignore_children
  52                 || !atomic_read(&dev->power.child_count);
  53 }
  54
  55 static inline void pm_runtime_get_noresume(struct device *dev)
  56 {
  57         atomic_inc(&dev->power.usage_count);
  58 }
  59
  60 static inline void pm_runtime_put_noidle(struct device *dev)
  61 {
  62         atomic_add_unless(&dev->power.usage_count, -1, 0);
  63 }
  64
  65 static inline bool device_run_wake(struct device *dev)
  66 {
  67         return dev->power.run_wake;
  68 }
  69
  70 static inline void device_set_run_wake(struct device *dev, bool enable)
  71 {
  72         dev->power.run_wake = enable;
  73 }
  74
  75 static inline bool pm_runtime_suspended(struct device *dev)
  76 {
  77         return dev->power.runtime_status == RPM_SUSPENDED
  78                 && !dev->power.disable_depth;
  79 }
  80
  81 static inline bool pm_runtime_status_suspended(struct device *dev)
  82 {
  83         return dev->power.runtime_status == RPM_SUSPENDED;
  84 }
  85
  86 static inline bool pm_runtime_enabled(struct device *dev)
  87 {
  88         return !dev->power.disable_depth;
  89 }
  90
  91 static inline bool pm_runtime_callbacks_present(struct device *dev)
  92 {
  93         return !dev->power.no_callbacks;
  94 }
  95
  96 static inline void pm_runtime_mark_last_busy(struct device *dev)
  97 {
  98         ACCESS_ONCE(dev->power.last_busy) = jiffies;
  99 }
 100
 101 #else /* !CONFIG_PM_RUNTIME */
 102
 103 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
 104 {
 105         return -ENOSYS;
 106 }
 107 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
 108 {
 109         return -ENOSYS;
 110 }
 111 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
 112 {
 113         return 1;
 114 }
 115 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
 116 {
 117         return -ENOSYS;
 118 }
 119 static inline int __pm_runtime_set_status(struct device *dev,
 120                                             unsigned int status) { return 0; }
 121 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
 122 static inline void pm_runtime_enable(struct device *dev) {}
 123 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
 124 static inline void pm_runtime_allow(struct device *dev) {}
 125 static inline void pm_runtime_forbid(struct device *dev) {}
 126
 127 static inline bool pm_children_suspended(struct device *dev) { return false; }
 128 static inline void pm_runtime_get_noresume(struct device *dev) {}
 129 static inline void pm_runtime_put_noidle(struct device *dev) {}
 130 static inline bool device_run_wake(struct device *dev) { return false; }
 131 static inline void device_set_run_wake(struct device *dev, bool enable) {}
 132 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
 133 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
 134 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
 135
 136 static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
 137 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
 138 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
 139 static inline void pm_runtime_no_callbacks(struct device *dev) {}
 140 static inline void pm_runtime_irq_safe(struct device *dev) {}
 141
 142 static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
 143 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
 144 static inline void __pm_runtime_use_autosuspend(struct device *dev,
 145                                                 bool use) {}
 146 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
 147                                                 int delay) {}
 148 static inline unsigned long pm_runtime_autosuspend_expiration(
 149                                 struct device *dev) { return 0; }
 150
 151 #endif /* !CONFIG_PM_RUNTIME */
 152
 153 static inline int pm_runtime_idle(struct device *dev)
 154 {
 155         return __pm_runtime_idle(dev, 0);
 156 }
 157
 158 static inline int pm_runtime_suspend(struct device *dev)
 159 {
 160         return __pm_runtime_suspend(dev, 0);
 161 }
 162
 163 static inline int pm_runtime_autosuspend(struct device *dev)
 164 {
 165         return __pm_runtime_suspend(dev, RPM_AUTO);
 166 }
 167
 168 static inline int pm_runtime_resume(struct device *dev)
 169 {
 170         return __pm_runtime_resume(dev, 0);
 171 }
 172
 173 static inline int pm_request_idle(struct device *dev)
 174 {
 175         return __pm_runtime_idle(dev, RPM_ASYNC);
 176 }
 177
 178 static inline int pm_request_resume(struct device *dev)
 179 {
 180         return __pm_runtime_resume(dev, RPM_ASYNC);
 181 }
 182
 183 static inline int pm_request_autosuspend(struct device *dev)
 184 {
 185         return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
 186 }
 187
 188 static inline int pm_runtime_get(struct device *dev)
 189 {
 190         return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
 191 }
 192
 193 static inline int pm_runtime_get_sync(struct device *dev)
 194 {
 195         return __pm_runtime_resume(dev, RPM_GET_PUT);
 196 }
 197
 198 static inline int pm_runtime_put(struct device *dev)
 199 {
 200         return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
 201 }
 202
 203 static inline int pm_runtime_put_autosuspend(struct device *dev)
 204 {
 205         return __pm_runtime_suspend(dev,
 206             RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
 207 }
 208
 209 static inline int pm_runtime_put_sync(struct device *dev)
 210 {
 211         return __pm_runtime_idle(dev, RPM_GET_PUT);
 212 }
 213
 214 static inline int pm_runtime_put_sync_suspend(struct device *dev)
 215 {
 216         return __pm_runtime_suspend(dev, RPM_GET_PUT);
 217 }
 218
 219 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
 220 {
 221         return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
 222 }
 223
 224 static inline int pm_runtime_set_active(struct device *dev)
 225 {
 226         return __pm_runtime_set_status(dev, RPM_ACTIVE);
 227 }
 228
 229 static inline void pm_runtime_set_suspended(struct device *dev)
 230 {
 231         __pm_runtime_set_status(dev, RPM_SUSPENDED);
 232 }
 233
 234 static inline void pm_runtime_disable(struct device *dev)
 235 {
 236         __pm_runtime_disable(dev, true);
 237 }
 238
 239 static inline void pm_runtime_use_autosuspend(struct device *dev)
 240 {
 241         __pm_runtime_use_autosuspend(dev, true);
 242 }
 243
 244 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
 245 {
 246         __pm_runtime_use_autosuspend(dev, false);
 247 }
 248
 249 #endif