2 * cpuidle.h - a generic framework for CPU idle power management
4 * (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
5 * Shaohua Li <shaohua.li@intel.com>
6 * Adam Belay <abelay@novell.com>
8 * This code is licenced under the GPL.
11 #ifndef _LINUX_CPUIDLE_H
12 #define _LINUX_CPUIDLE_H
14 #include <linux/percpu.h>
15 #include <linux/list.h>
16 #include <linux/hrtimer.h>
18 #define CPUIDLE_STATE_MAX 10
19 #define CPUIDLE_NAME_LEN 16
20 #define CPUIDLE_DESC_LEN 32
24 struct cpuidle_device
;
25 struct cpuidle_driver
;
28 /****************************
29 * CPUIDLE DEVICE INTERFACE *
30 ****************************/
32 struct cpuidle_state_usage
{
33 unsigned long long disable
;
34 unsigned long long usage
;
35 unsigned long long time
; /* in US */
38 struct cpuidle_state
{
39 char name
[CPUIDLE_NAME_LEN
];
40 char desc
[CPUIDLE_DESC_LEN
];
43 unsigned int exit_latency
; /* in US */
44 int power_usage
; /* in mW */
45 unsigned int target_residency
; /* in US */
46 bool disabled
; /* disabled on all CPUs */
48 int (*enter
) (struct cpuidle_device
*dev
,
49 struct cpuidle_driver
*drv
,
52 int (*enter_dead
) (struct cpuidle_device
*dev
, int index
);
55 * CPUs execute ->enter_s2idle with the local tick or entire timekeeping
56 * suspended, so it must not re-enable interrupts at any point (even
57 * temporarily) or attempt to change states of clock event devices.
59 void (*enter_s2idle
) (struct cpuidle_device
*dev
,
60 struct cpuidle_driver
*drv
,
64 /* Idle State Flags */
65 #define CPUIDLE_FLAG_NONE (0x00)
66 #define CPUIDLE_FLAG_POLLING (0x01) /* polling state */
67 #define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
68 #define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
70 #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
72 struct cpuidle_device_kobj
;
73 struct cpuidle_state_kobj
;
74 struct cpuidle_driver_kobj
;
76 struct cpuidle_device
{
77 unsigned int registered
:1;
78 unsigned int enabled
:1;
79 unsigned int use_deepest_state
:1;
83 struct cpuidle_state_usage states_usage
[CPUIDLE_STATE_MAX
];
84 struct cpuidle_state_kobj
*kobjs
[CPUIDLE_STATE_MAX
];
85 struct cpuidle_driver_kobj
*kobj_driver
;
86 struct cpuidle_device_kobj
*kobj_dev
;
87 struct list_head device_list
;
89 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
90 cpumask_t coupled_cpus
;
91 struct cpuidle_coupled
*coupled
;
95 DECLARE_PER_CPU(struct cpuidle_device
*, cpuidle_devices
);
96 DECLARE_PER_CPU(struct cpuidle_device
, cpuidle_dev
);
99 * cpuidle_get_last_residency - retrieves the last state's residency time
100 * @dev: the target CPU
102 static inline int cpuidle_get_last_residency(struct cpuidle_device
*dev
)
104 return dev
->last_residency
;
108 /****************************
109 * CPUIDLE DRIVER INTERFACE *
110 ****************************/
112 struct cpuidle_driver
{
114 struct module
*owner
;
117 /* used by the cpuidle framework to setup the broadcast timer */
118 unsigned int bctimer
:1;
119 /* states array must be ordered in decreasing power consumption */
120 struct cpuidle_state states
[CPUIDLE_STATE_MAX
];
122 int safe_state_index
;
124 /* the driver handles the cpus in cpumask */
125 struct cpumask
*cpumask
;
128 #ifdef CONFIG_CPU_IDLE
129 extern void disable_cpuidle(void);
130 extern bool cpuidle_not_available(struct cpuidle_driver
*drv
,
131 struct cpuidle_device
*dev
);
133 extern int cpuidle_select(struct cpuidle_driver
*drv
,
134 struct cpuidle_device
*dev
,
136 extern int cpuidle_enter(struct cpuidle_driver
*drv
,
137 struct cpuidle_device
*dev
, int index
);
138 extern void cpuidle_reflect(struct cpuidle_device
*dev
, int index
);
140 extern int cpuidle_register_driver(struct cpuidle_driver
*drv
);
141 extern struct cpuidle_driver
*cpuidle_get_driver(void);
142 extern struct cpuidle_driver
*cpuidle_driver_ref(void);
143 extern void cpuidle_driver_unref(void);
144 extern void cpuidle_unregister_driver(struct cpuidle_driver
*drv
);
145 extern int cpuidle_register_device(struct cpuidle_device
*dev
);
146 extern void cpuidle_unregister_device(struct cpuidle_device
*dev
);
147 extern int cpuidle_register(struct cpuidle_driver
*drv
,
148 const struct cpumask
*const coupled_cpus
);
149 extern void cpuidle_unregister(struct cpuidle_driver
*drv
);
150 extern void cpuidle_pause_and_lock(void);
151 extern void cpuidle_resume_and_unlock(void);
152 extern void cpuidle_pause(void);
153 extern void cpuidle_resume(void);
154 extern int cpuidle_enable_device(struct cpuidle_device
*dev
);
155 extern void cpuidle_disable_device(struct cpuidle_device
*dev
);
156 extern int cpuidle_play_dead(void);
158 extern struct cpuidle_driver
*cpuidle_get_cpu_driver(struct cpuidle_device
*dev
);
159 static inline struct cpuidle_device
*cpuidle_get_device(void)
160 {return __this_cpu_read(cpuidle_devices
); }
161 extern unsigned int cpuidle_get_target_residency(int cpu
, int state
);
163 static inline void disable_cpuidle(void) { }
164 static inline bool cpuidle_not_available(struct cpuidle_driver
*drv
,
165 struct cpuidle_device
*dev
)
167 static inline int cpuidle_select(struct cpuidle_driver
*drv
,
168 struct cpuidle_device
*dev
, bool *stop_tick
)
170 static inline int cpuidle_enter(struct cpuidle_driver
*drv
,
171 struct cpuidle_device
*dev
, int index
)
173 static inline void cpuidle_reflect(struct cpuidle_device
*dev
, int index
) { }
174 static inline int cpuidle_register_driver(struct cpuidle_driver
*drv
)
176 static inline struct cpuidle_driver
*cpuidle_get_driver(void) {return NULL
; }
177 static inline struct cpuidle_driver
*cpuidle_driver_ref(void) {return NULL
; }
178 static inline void cpuidle_driver_unref(void) {}
179 static inline void cpuidle_unregister_driver(struct cpuidle_driver
*drv
) { }
180 static inline int cpuidle_register_device(struct cpuidle_device
*dev
)
182 static inline void cpuidle_unregister_device(struct cpuidle_device
*dev
) { }
183 static inline int cpuidle_register(struct cpuidle_driver
*drv
,
184 const struct cpumask
*const coupled_cpus
)
186 static inline void cpuidle_unregister(struct cpuidle_driver
*drv
) { }
187 static inline void cpuidle_pause_and_lock(void) { }
188 static inline void cpuidle_resume_and_unlock(void) { }
189 static inline void cpuidle_pause(void) { }
190 static inline void cpuidle_resume(void) { }
191 static inline int cpuidle_enable_device(struct cpuidle_device
*dev
)
193 static inline void cpuidle_disable_device(struct cpuidle_device
*dev
) { }
194 static inline int cpuidle_play_dead(void) {return -ENODEV
; }
195 static inline struct cpuidle_driver
*cpuidle_get_cpu_driver(
196 struct cpuidle_device
*dev
) {return NULL
; }
197 static inline struct cpuidle_device
*cpuidle_get_device(void) {return NULL
; }
198 static inline unsigned int cpuidle_get_target_residency(int cpu
, int state
) {return UINT_MAX
;}
201 #ifdef CONFIG_CPU_IDLE
202 extern int cpuidle_find_deepest_state(struct cpuidle_driver
*drv
,
203 struct cpuidle_device
*dev
);
204 extern int cpuidle_enter_s2idle(struct cpuidle_driver
*drv
,
205 struct cpuidle_device
*dev
);
206 extern void cpuidle_use_deepest_state(bool enable
);
208 static inline int cpuidle_find_deepest_state(struct cpuidle_driver
*drv
,
209 struct cpuidle_device
*dev
)
211 static inline int cpuidle_enter_s2idle(struct cpuidle_driver
*drv
,
212 struct cpuidle_device
*dev
)
214 static inline void cpuidle_use_deepest_state(bool enable
)
219 /* kernel/sched/idle.c */
220 extern void sched_idle_set_state(struct cpuidle_state
*idle_state
, int index
);
221 extern void default_idle_call(void);
223 #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
224 void cpuidle_coupled_parallel_barrier(struct cpuidle_device
*dev
, atomic_t
*a
);
226 static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device
*dev
, atomic_t
*a
)
231 #if defined(CONFIG_CPU_IDLE) && defined(CONFIG_ARCH_HAS_CPU_RELAX)
232 void cpuidle_poll_state_init(struct cpuidle_driver
*drv
);
234 static inline void cpuidle_poll_state_init(struct cpuidle_driver
*drv
) {}
237 /******************************
238 * CPUIDLE GOVERNOR INTERFACE *
239 ******************************/
241 struct cpuidle_governor
{
242 char name
[CPUIDLE_NAME_LEN
];
243 struct list_head governor_list
;
246 int (*enable
) (struct cpuidle_driver
*drv
,
247 struct cpuidle_device
*dev
);
248 void (*disable
) (struct cpuidle_driver
*drv
,
249 struct cpuidle_device
*dev
);
251 int (*select
) (struct cpuidle_driver
*drv
,
252 struct cpuidle_device
*dev
,
254 void (*reflect
) (struct cpuidle_device
*dev
, int index
);
257 #ifdef CONFIG_CPU_IDLE
258 extern int cpuidle_register_governor(struct cpuidle_governor
*gov
);
260 static inline int cpuidle_register_governor(struct cpuidle_governor
*gov
)
264 #define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx) \
273 __ret = cpu_pm_enter(); \
275 __ret = low_level_idle_enter(idx); \
282 #endif /* _LINUX_CPUIDLE_H */