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