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