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