include/linux/cpuidle.h

   1 /*
   2  * cpuidle.h - a generic framework for CPU idle power management
   3  *
   4  * (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
   5  *          Shaohua Li <shaohua.li@intel.com>
   6  *          Adam Belay <abelay@novell.com>
   7  *
   8  * This code is licenced under the GPL.
   9  */
  10
  11 #ifndef _LINUX_CPUIDLE_H
  12 #define _LINUX_CPUIDLE_H
  13
  14 #include <linux/percpu.h>
  15 #include <linux/list.h>
  16 #include <linux/hrtimer.h>
  17
  18 #define CPUIDLE_STATE_MAX       10
  19 #define CPUIDLE_NAME_LEN        16
  20 #define CPUIDLE_DESC_LEN        32
  21
  22 struct module;
  23
  24 struct cpuidle_device;
  25 struct cpuidle_driver;
  26
  27
  28 /****************************
  29  * CPUIDLE DEVICE INTERFACE *
  30  ****************************/
  31
  32 struct cpuidle_state_usage {
  33         unsigned long long      disable;
  34         unsigned long long      usage;
  35         unsigned long long      time; /* in US */
  36 #ifdef CONFIG_SUSPEND
  37         unsigned long long      s2idle_usage;
  38         unsigned long long      s2idle_time; /* in US */
  39 #endif
  40 };
  41
  42 struct cpuidle_state {
  43         char            name[CPUIDLE_NAME_LEN];
  44         char            desc[CPUIDLE_DESC_LEN];
  45
  46         unsigned int    flags;
  47         unsigned int    exit_latency; /* in US */
  48         int             power_usage; /* in mW */
  49         unsigned int    target_residency; /* in US */
  50         bool            disabled; /* disabled on all CPUs */
  51
  52         int (*enter)    (struct cpuidle_device *dev,
  53                         struct cpuidle_driver *drv,
  54                         int index);
  55
  56         int (*enter_dead) (struct cpuidle_device *dev, int index);
  57
  58         /*
  59          * CPUs execute ->enter_s2idle with the local tick or entire timekeeping
  60          * suspended, so it must not re-enable interrupts at any point (even
  61          * temporarily) or attempt to change states of clock event devices.
  62          */
  63         void (*enter_s2idle) (struct cpuidle_device *dev,
  64                               struct cpuidle_driver *drv,
  65                               int index);
  66 };
  67
  68 /* Idle State Flags */
  69 #define CPUIDLE_FLAG_NONE       (0x00)
  70 #define CPUIDLE_FLAG_POLLING    (0x01) /* polling state */
  71 #define CPUIDLE_FLAG_COUPLED    (0x02) /* state applies to multiple cpus */
  72 #define CPUIDLE_FLAG_TIMER_STOP (0x04)  /* timer is stopped on this state */
  73
  74 #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
  75
  76 struct cpuidle_device_kobj;
  77 struct cpuidle_state_kobj;
  78 struct cpuidle_driver_kobj;
  79
  80 struct cpuidle_device {
  81         unsigned int            registered:1;
  82         unsigned int            enabled:1;
  83         unsigned int            use_deepest_state:1;
  84         unsigned int            cpu;
  85
  86         int                     last_residency;
  87         struct cpuidle_state_usage      states_usage[CPUIDLE_STATE_MAX];
  88         struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
  89         struct cpuidle_driver_kobj *kobj_driver;
  90         struct cpuidle_device_kobj *kobj_dev;
  91         struct list_head        device_list;
  92
  93 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
  94         cpumask_t               coupled_cpus;
  95         struct cpuidle_coupled  *coupled;
  96 #endif
  97 };
  98
  99 DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
 100 DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev);
 101
 102 /**
 103  * cpuidle_get_last_residency - retrieves the last state's residency time
 104  * @dev: the target CPU
 105  */
 106 static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
 107 {
 108         return dev->last_residency;
 109 }
 110
 111
 112 /****************************
 113  * CPUIDLE DRIVER INTERFACE *
 114  ****************************/
 115
 116 struct cpuidle_driver {
 117         const char              *name;
 118         struct module           *owner;
 119         int                     refcnt;
 120
 121         /* used by the cpuidle framework to setup the broadcast timer */
 122         unsigned int            bctimer:1;
 123         /* states array must be ordered in decreasing power consumption */
 124         struct cpuidle_state    states[CPUIDLE_STATE_MAX];
 125         int                     state_count;
 126         int                     safe_state_index;
 127
 128         /* the driver handles the cpus in cpumask */
 129         struct cpumask          *cpumask;
 130 };
 131
 132 #ifdef CONFIG_CPU_IDLE
 133 extern void disable_cpuidle(void);
 134 extern bool cpuidle_not_available(struct cpuidle_driver *drv,
 135                                   struct cpuidle_device *dev);
 136
 137 extern int cpuidle_select(struct cpuidle_driver *drv,
 138                           struct cpuidle_device *dev);
 139 extern int cpuidle_enter(struct cpuidle_driver *drv,
 140                          struct cpuidle_device *dev, int index);
 141 extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
 142
 143 extern int cpuidle_register_driver(struct cpuidle_driver *drv);
 144 extern struct cpuidle_driver *cpuidle_get_driver(void);
 145 extern struct cpuidle_driver *cpuidle_driver_ref(void);
 146 extern void cpuidle_driver_unref(void);
 147 extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
 148 extern int cpuidle_register_device(struct cpuidle_device *dev);
 149 extern void cpuidle_unregister_device(struct cpuidle_device *dev);
 150 extern int cpuidle_register(struct cpuidle_driver *drv,
 151                             const struct cpumask *const coupled_cpus);
 152 extern void cpuidle_unregister(struct cpuidle_driver *drv);
 153 extern void cpuidle_pause_and_lock(void);
 154 extern void cpuidle_resume_and_unlock(void);
 155 extern void cpuidle_pause(void);
 156 extern void cpuidle_resume(void);
 157 extern int cpuidle_enable_device(struct cpuidle_device *dev);
 158 extern void cpuidle_disable_device(struct cpuidle_device *dev);
 159 extern int cpuidle_play_dead(void);
 160
 161 extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
 162 static inline struct cpuidle_device *cpuidle_get_device(void)
 163 {return __this_cpu_read(cpuidle_devices); }
 164 #else
 165 static inline void disable_cpuidle(void) { }
 166 static inline bool cpuidle_not_available(struct cpuidle_driver *drv,
 167                                          struct cpuidle_device *dev)
 168 {return true; }
 169 static inline int cpuidle_select(struct cpuidle_driver *drv,
 170                                  struct cpuidle_device *dev)
 171 {return -ENODEV; }
 172 static inline int cpuidle_enter(struct cpuidle_driver *drv,
 173                                 struct cpuidle_device *dev, int index)
 174 {return -ENODEV; }
 175 static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
 176 static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
 177 {return -ENODEV; }
 178 static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
 179 static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
 180 static inline void cpuidle_driver_unref(void) {}
 181 static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
 182 static inline int cpuidle_register_device(struct cpuidle_device *dev)
 183 {return -ENODEV; }
 184 static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
 185 static inline int cpuidle_register(struct cpuidle_driver *drv,
 186                                    const struct cpumask *const coupled_cpus)
 187 {return -ENODEV; }
 188 static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
 189 static inline void cpuidle_pause_and_lock(void) { }
 190 static inline void cpuidle_resume_and_unlock(void) { }
 191 static inline void cpuidle_pause(void) { }
 192 static inline void cpuidle_resume(void) { }
 193 static inline int cpuidle_enable_device(struct cpuidle_device *dev)
 194 {return -ENODEV; }
 195 static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
 196 static inline int cpuidle_play_dead(void) {return -ENODEV; }
 197 static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
 198         struct cpuidle_device *dev) {return NULL; }
 199 static inline struct cpuidle_device *cpuidle_get_device(void) {return NULL; }
 200 #endif
 201
 202 #ifdef CONFIG_CPU_IDLE
 203 extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
 204                                       struct cpuidle_device *dev);
 205 extern int cpuidle_enter_s2idle(struct cpuidle_driver *drv,
 206                                 struct cpuidle_device *dev);
 207 extern void cpuidle_use_deepest_state(bool enable);
 208 #else
 209 static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
 210                                              struct cpuidle_device *dev)
 211 {return -ENODEV; }
 212 static inline int cpuidle_enter_s2idle(struct cpuidle_driver *drv,
 213                                        struct cpuidle_device *dev)
 214 {return -ENODEV; }
 215 static inline void cpuidle_use_deepest_state(bool enable)
 216 {
 217 }
 218 #endif
 219
 220 /* kernel/sched/idle.c */
 221 extern void sched_idle_set_state(struct cpuidle_state *idle_state);
 222 extern void default_idle_call(void);
 223
 224 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
 225 void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
 226 #else
 227 static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
 228 {
 229 }
 230 #endif
 231
 232 #if defined(CONFIG_CPU_IDLE) && defined(CONFIG_ARCH_HAS_CPU_RELAX)
 233 void cpuidle_poll_state_init(struct cpuidle_driver *drv);
 234 #else
 235 static inline void cpuidle_poll_state_init(struct cpuidle_driver *drv) {}
 236 #endif
 237
 238 /******************************
 239  * CPUIDLE GOVERNOR INTERFACE *
 240  ******************************/
 241
 242 struct cpuidle_governor {
 243         char                    name[CPUIDLE_NAME_LEN];
 244         struct list_head        governor_list;
 245         unsigned int            rating;
 246
 247         int  (*enable)          (struct cpuidle_driver *drv,
 248                                         struct cpuidle_device *dev);
 249         void (*disable)         (struct cpuidle_driver *drv,
 250                                         struct cpuidle_device *dev);
 251
 252         int  (*select)          (struct cpuidle_driver *drv,
 253                                         struct cpuidle_device *dev);
 254         void (*reflect)         (struct cpuidle_device *dev, int index);
 255 };
 256
 257 #ifdef CONFIG_CPU_IDLE
 258 extern int cpuidle_register_governor(struct cpuidle_governor *gov);
 259 #else
 260 static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
 261 {return 0;}
 262 #endif
 263
 264 #define __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, is_retention) \
 265 ({                                                                      \
 266         int __ret = 0;                                                  \
 267                                                                         \
 268         if (!idx) {                                                     \
 269                 cpu_do_idle();                                          \
 270                 return idx;                                             \
 271         }                                                               \
 272                                                                         \
 273         if (!is_retention)                                              \
 274                 __ret =  cpu_pm_enter();                                \
 275         if (!__ret) {                                                   \
 276                 __ret = low_level_idle_enter(idx);                      \
 277                 if (!is_retention)                                      \
 278                         cpu_pm_exit();                                  \
 279         }                                                               \
 280                                                                         \
 281         __ret ? -1 : idx;                                               \
 282 })
 283
 284 #define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx)        \
 285         __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, 0)
 286
 287 #define CPU_PM_CPU_IDLE_ENTER_RETENTION(low_level_idle_enter, idx)      \
 288         __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, 1)
 289
 290 #endif /* _LINUX_CPUIDLE_H */