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_suspend_ignore_children(struct device *dev, bool enable)
  56 {
  57         dev->power.ignore_children = enable;
  58 }
  59
  60 static inline void pm_runtime_get_noresume(struct device *dev)
  61 {
  62         atomic_inc(&dev->power.usage_count);
  63 }
  64
  65 static inline void pm_runtime_put_noidle(struct device *dev)
  66 {
  67         atomic_add_unless(&dev->power.usage_count, -1, 0);
  68 }
  69
  70 static inline bool device_run_wake(struct device *dev)
  71 {
  72         return dev->power.run_wake;
  73 }
  74
  75 static inline void device_set_run_wake(struct device *dev, bool enable)
  76 {
  77         dev->power.run_wake = enable;
  78 }
  79
  80 static inline bool pm_runtime_suspended(struct device *dev)
  81 {
  82         return dev->power.runtime_status == RPM_SUSPENDED
  83                 && !dev->power.disable_depth;
  84 }
  85
  86 static inline bool pm_runtime_status_suspended(struct device *dev)
  87 {
  88         return dev->power.runtime_status == RPM_SUSPENDED;
  89 }
  90
  91 static inline bool pm_runtime_enabled(struct device *dev)
  92 {
  93         return !dev->power.disable_depth;
  94 }
  95
  96 static inline bool pm_runtime_callbacks_present(struct device *dev)
  97 {
  98         return !dev->power.no_callbacks;
  99 }
 100
 101 static inline void pm_runtime_mark_last_busy(struct device *dev)
 102 {
 103         ACCESS_ONCE(dev->power.last_busy) = jiffies;
 104 }
 105
 106 #else /* !CONFIG_PM_RUNTIME */
 107
 108 static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
 109 {
 110         return -ENOSYS;
 111 }
 112 static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
 113 {
 114         return -ENOSYS;
 115 }
 116 static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
 117 {
 118         return 1;
 119 }
 120 static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
 121 {
 122         return -ENOSYS;
 123 }
 124 static inline int __pm_runtime_set_status(struct device *dev,
 125                                             unsigned int status) { return 0; }
 126 static inline int pm_runtime_barrier(struct device *dev) { return 0; }
 127 static inline void pm_runtime_enable(struct device *dev) {}
 128 static inline void __pm_runtime_disable(struct device *dev, bool c) {}
 129 static inline void pm_runtime_allow(struct device *dev) {}
 130 static inline void pm_runtime_forbid(struct device *dev) {}
 131
 132 static inline bool pm_children_suspended(struct device *dev) { return false; }
 133 static inline void pm_suspend_ignore_children(struct device *dev, bool en) {}
 134 static inline void pm_runtime_get_noresume(struct device *dev) {}
 135 static inline void pm_runtime_put_noidle(struct device *dev) {}
 136 static inline bool device_run_wake(struct device *dev) { return false; }
 137 static inline void device_set_run_wake(struct device *dev, bool enable) {}
 138 static inline bool pm_runtime_suspended(struct device *dev) { return false; }
 139 static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
 140 static inline bool pm_runtime_enabled(struct device *dev) { return false; }
 141
 142 static inline int pm_generic_runtime_idle(struct device *dev) { return 0; }
 143 static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
 144 static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
 145 static inline void pm_runtime_no_callbacks(struct device *dev) {}
 146 static inline void pm_runtime_irq_safe(struct device *dev) {}
 147
 148 static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
 149 static inline void pm_runtime_mark_last_busy(struct device *dev) {}
 150 static inline void __pm_runtime_use_autosuspend(struct device *dev,
 151                                                 bool use) {}
 152 static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
 153                                                 int delay) {}
 154 static inline unsigned long pm_runtime_autosuspend_expiration(
 155                                 struct device *dev) { return 0; }
 156
 157 #endif /* !CONFIG_PM_RUNTIME */
 158
 159 static inline int pm_runtime_idle(struct device *dev)
 160 {
 161         return __pm_runtime_idle(dev, 0);
 162 }
 163
 164 static inline int pm_runtime_suspend(struct device *dev)
 165 {
 166         return __pm_runtime_suspend(dev, 0);
 167 }
 168
 169 static inline int pm_runtime_autosuspend(struct device *dev)
 170 {
 171         return __pm_runtime_suspend(dev, RPM_AUTO);
 172 }
 173
 174 static inline int pm_runtime_resume(struct device *dev)
 175 {
 176         return __pm_runtime_resume(dev, 0);
 177 }
 178
 179 static inline int pm_request_idle(struct device *dev)
 180 {
 181         return __pm_runtime_idle(dev, RPM_ASYNC);
 182 }
 183
 184 static inline int pm_request_resume(struct device *dev)
 185 {
 186         return __pm_runtime_resume(dev, RPM_ASYNC);
 187 }
 188
 189 static inline int pm_request_autosuspend(struct device *dev)
 190 {
 191         return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
 192 }
 193
 194 static inline int pm_runtime_get(struct device *dev)
 195 {
 196         return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
 197 }
 198
 199 static inline int pm_runtime_get_sync(struct device *dev)
 200 {
 201         return __pm_runtime_resume(dev, RPM_GET_PUT);
 202 }
 203
 204 static inline int pm_runtime_put(struct device *dev)
 205 {
 206         return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
 207 }
 208
 209 static inline int pm_runtime_put_autosuspend(struct device *dev)
 210 {
 211         return __pm_runtime_suspend(dev,
 212             RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
 213 }
 214
 215 static inline int pm_runtime_put_sync(struct device *dev)
 216 {
 217         return __pm_runtime_idle(dev, RPM_GET_PUT);
 218 }
 219
 220 static inline int pm_runtime_put_sync_suspend(struct device *dev)
 221 {
 222         return __pm_runtime_suspend(dev, RPM_GET_PUT);
 223 }
 224
 225 static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
 226 {
 227         return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
 228 }
 229
 230 static inline int pm_runtime_set_active(struct device *dev)
 231 {
 232         return __pm_runtime_set_status(dev, RPM_ACTIVE);
 233 }
 234
 235 static inline void pm_runtime_set_suspended(struct device *dev)
 236 {
 237         __pm_runtime_set_status(dev, RPM_SUSPENDED);
 238 }
 239
 240 static inline void pm_runtime_disable(struct device *dev)
 241 {
 242         __pm_runtime_disable(dev, true);
 243 }
 244
 245 static inline void pm_runtime_use_autosuspend(struct device *dev)
 246 {
 247         __pm_runtime_use_autosuspend(dev, true);
 248 }
 249
 250 static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
 251 {
 252         __pm_runtime_use_autosuspend(dev, false);
 253 }
 254
 255 struct pm_clk_notifier_block {
 256         struct notifier_block nb;
 257         struct dev_pm_domain *pm_domain;
 258         char *con_ids[];
 259 };
 260
 261 #ifdef CONFIG_PM_CLK
 262 extern int pm_clk_init(struct device *dev);
 263 extern void pm_clk_destroy(struct device *dev);
 264 extern int pm_clk_add(struct device *dev, const char *con_id);
 265 extern void pm_clk_remove(struct device *dev, const char *con_id);
 266 extern int pm_clk_suspend(struct device *dev);
 267 extern int pm_clk_resume(struct device *dev);
 268 #else
 269 static inline int pm_clk_init(struct device *dev)
 270 {
 271         return -EINVAL;
 272 }
 273 static inline void pm_clk_destroy(struct device *dev)
 274 {
 275 }
 276 static inline int pm_clk_add(struct device *dev, const char *con_id)
 277 {
 278         return -EINVAL;
 279 }
 280 static inline void pm_clk_remove(struct device *dev, const char *con_id)
 281 {
 282 }
 283 #define pm_clk_suspend  NULL
 284 #define pm_clk_resume   NULL
 285 #endif
 286
 287 #ifdef CONFIG_HAVE_CLK
 288 extern void pm_clk_add_notifier(struct bus_type *bus,
 289                                         struct pm_clk_notifier_block *clknb);
 290 #else
 291 static inline void pm_clk_add_notifier(struct bus_type *bus,
 292                                         struct pm_clk_notifier_block *clknb)
 293 {
 294 }
 295 #endif
 296
 297 #endif