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