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_enabled(struct device *dev)
 102{
 103        return !dev->power.disable_depth;
 104}
 105
 106static inline bool pm_runtime_callbacks_present(struct device *dev)
 107{
 108        return !dev->power.no_callbacks;
 109}
 110
 111static inline void pm_runtime_mark_last_busy(struct device *dev)
 112{
 113        ACCESS_ONCE(dev->power.last_busy) = jiffies;
 114}
 115
 116static inline bool pm_runtime_is_irq_safe(struct device *dev)
 117{
 118        return dev->power.irq_safe;
 119}
 120
 121#else /* !CONFIG_PM */
 122
 123static inline bool queue_pm_work(struct work_struct *work) { return false; }
 124
 125static inline int pm_generic_runtime_suspend(struct device *dev) { return 0; }
 126static inline int pm_generic_runtime_resume(struct device *dev) { return 0; }
 127static inline int pm_runtime_force_suspend(struct device *dev) { return 0; }
 128static inline int pm_runtime_force_resume(struct device *dev) { return 0; }
 129
 130static inline int __pm_runtime_idle(struct device *dev, int rpmflags)
 131{
 132        return -ENOSYS;
 133}
 134static inline int __pm_runtime_suspend(struct device *dev, int rpmflags)
 135{
 136        return -ENOSYS;
 137}
 138static inline int __pm_runtime_resume(struct device *dev, int rpmflags)
 139{
 140        return 1;
 141}
 142static inline int pm_schedule_suspend(struct device *dev, unsigned int delay)
 143{
 144        return -ENOSYS;
 145}
 146static inline int __pm_runtime_set_status(struct device *dev,
 147                                            unsigned int status) { return 0; }
 148static inline int pm_runtime_barrier(struct device *dev) { return 0; }
 149static inline void pm_runtime_enable(struct device *dev) {}
 150static inline void __pm_runtime_disable(struct device *dev, bool c) {}
 151static inline void pm_runtime_allow(struct device *dev) {}
 152static inline void pm_runtime_forbid(struct device *dev) {}
 153
 154static inline bool pm_children_suspended(struct device *dev) { return false; }
 155static inline void pm_runtime_get_noresume(struct device *dev) {}
 156static inline void pm_runtime_put_noidle(struct device *dev) {}
 157static inline bool device_run_wake(struct device *dev) { return false; }
 158static inline void device_set_run_wake(struct device *dev, bool enable) {}
 159static inline bool pm_runtime_suspended(struct device *dev) { return false; }
 160static inline bool pm_runtime_active(struct device *dev) { return true; }
 161static inline bool pm_runtime_status_suspended(struct device *dev) { return false; }
 162static inline bool pm_runtime_enabled(struct device *dev) { return false; }
 163
 164static inline void pm_runtime_no_callbacks(struct device *dev) {}
 165static inline void pm_runtime_irq_safe(struct device *dev) {}
 166static inline bool pm_runtime_is_irq_safe(struct device *dev) { return false; }
 167
 168static inline bool pm_runtime_callbacks_present(struct device *dev) { return false; }
 169static inline void pm_runtime_mark_last_busy(struct device *dev) {}
 170static inline void __pm_runtime_use_autosuspend(struct device *dev,
 171                                                bool use) {}
 172static inline void pm_runtime_set_autosuspend_delay(struct device *dev,
 173                                                int delay) {}
 174static inline unsigned long pm_runtime_autosuspend_expiration(
 175                                struct device *dev) { return 0; }
 176static inline void pm_runtime_set_memalloc_noio(struct device *dev,
 177                                                bool enable){}
 178
 179#endif /* !CONFIG_PM */
 180
 181static inline int pm_runtime_idle(struct device *dev)
 182{
 183        return __pm_runtime_idle(dev, 0);
 184}
 185
 186static inline int pm_runtime_suspend(struct device *dev)
 187{
 188        return __pm_runtime_suspend(dev, 0);
 189}
 190
 191static inline int pm_runtime_autosuspend(struct device *dev)
 192{
 193        return __pm_runtime_suspend(dev, RPM_AUTO);
 194}
 195
 196static inline int pm_runtime_resume(struct device *dev)
 197{
 198        return __pm_runtime_resume(dev, 0);
 199}
 200
 201static inline int pm_request_idle(struct device *dev)
 202{
 203        return __pm_runtime_idle(dev, RPM_ASYNC);
 204}
 205
 206static inline int pm_request_resume(struct device *dev)
 207{
 208        return __pm_runtime_resume(dev, RPM_ASYNC);
 209}
 210
 211static inline int pm_request_autosuspend(struct device *dev)
 212{
 213        return __pm_runtime_suspend(dev, RPM_ASYNC | RPM_AUTO);
 214}
 215
 216static inline int pm_runtime_get(struct device *dev)
 217{
 218        return __pm_runtime_resume(dev, RPM_GET_PUT | RPM_ASYNC);
 219}
 220
 221static inline int pm_runtime_get_sync(struct device *dev)
 222{
 223        return __pm_runtime_resume(dev, RPM_GET_PUT);
 224}
 225
 226static inline int pm_runtime_put(struct device *dev)
 227{
 228        return __pm_runtime_idle(dev, RPM_GET_PUT | RPM_ASYNC);
 229}
 230
 231static inline int pm_runtime_put_autosuspend(struct device *dev)
 232{
 233        return __pm_runtime_suspend(dev,
 234            RPM_GET_PUT | RPM_ASYNC | RPM_AUTO);
 235}
 236
 237static inline int pm_runtime_put_sync(struct device *dev)
 238{
 239        return __pm_runtime_idle(dev, RPM_GET_PUT);
 240}
 241
 242static inline int pm_runtime_put_sync_suspend(struct device *dev)
 243{
 244        return __pm_runtime_suspend(dev, RPM_GET_PUT);
 245}
 246
 247static inline int pm_runtime_put_sync_autosuspend(struct device *dev)
 248{
 249        return __pm_runtime_suspend(dev, RPM_GET_PUT | RPM_AUTO);
 250}
 251
 252static inline int pm_runtime_set_active(struct device *dev)
 253{
 254        return __pm_runtime_set_status(dev, RPM_ACTIVE);
 255}
 256
 257static inline void pm_runtime_set_suspended(struct device *dev)
 258{
 259        __pm_runtime_set_status(dev, RPM_SUSPENDED);
 260}
 261
 262static inline void pm_runtime_disable(struct device *dev)
 263{
 264        __pm_runtime_disable(dev, true);
 265}
 266
 267static inline void pm_runtime_use_autosuspend(struct device *dev)
 268{
 269        __pm_runtime_use_autosuspend(dev, true);
 270}
 271
 272static inline void pm_runtime_dont_use_autosuspend(struct device *dev)
 273{
 274        __pm_runtime_use_autosuspend(dev, false);
 275}
 276
 277#endif
 278