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