LXR linux/include/linux/pm

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