]>
Commit | Line | Data |
---|---|---|
4f86d3a8 LB |
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> | |
e1689795 | 16 | #include <linux/hrtimer.h> |
4f86d3a8 | 17 | |
86239ceb | 18 | #define CPUIDLE_STATE_MAX 10 |
4f86d3a8 | 19 | #define CPUIDLE_NAME_LEN 16 |
4fcb2fcd | 20 | #define CPUIDLE_DESC_LEN 32 |
4f86d3a8 | 21 | |
de477254 PG |
22 | struct module; |
23 | ||
4f86d3a8 | 24 | struct cpuidle_device; |
46bcfad7 | 25 | struct cpuidle_driver; |
4f86d3a8 LB |
26 | |
27 | ||
28 | /**************************** | |
29 | * CPUIDLE DEVICE INTERFACE * | |
30 | ****************************/ | |
31 | ||
4202735e | 32 | struct cpuidle_state_usage { |
dc7fd275 | 33 | unsigned long long disable; |
4202735e DD |
34 | unsigned long long usage; |
35 | unsigned long long time; /* in US */ | |
04dab58a RW |
36 | unsigned long long above; /* Number of times it's been too deep */ |
37 | unsigned long long below; /* Number of times it's been too shallow */ | |
64bdff69 RW |
38 | #ifdef CONFIG_SUSPEND |
39 | unsigned long long s2idle_usage; | |
40 | unsigned long long s2idle_time; /* in US */ | |
41 | #endif | |
4202735e DD |
42 | }; |
43 | ||
4f86d3a8 LB |
44 | struct cpuidle_state { |
45 | char name[CPUIDLE_NAME_LEN]; | |
4fcb2fcd | 46 | char desc[CPUIDLE_DESC_LEN]; |
4f86d3a8 LB |
47 | |
48 | unsigned int flags; | |
49 | unsigned int exit_latency; /* in US */ | |
02401c06 | 50 | int power_usage; /* in mW */ |
4f86d3a8 | 51 | unsigned int target_residency; /* in US */ |
cbc9ef02 | 52 | bool disabled; /* disabled on all CPUs */ |
4f86d3a8 | 53 | |
4f86d3a8 | 54 | int (*enter) (struct cpuidle_device *dev, |
46bcfad7 | 55 | struct cpuidle_driver *drv, |
e978aa7d | 56 | int index); |
1a022e3f BO |
57 | |
58 | int (*enter_dead) (struct cpuidle_device *dev, int index); | |
124cf911 RW |
59 | |
60 | /* | |
28ba086e | 61 | * CPUs execute ->enter_s2idle with the local tick or entire timekeeping |
124cf911 RW |
62 | * suspended, so it must not re-enable interrupts at any point (even |
63 | * temporarily) or attempt to change states of clock event devices. | |
64 | */ | |
28ba086e | 65 | void (*enter_s2idle) (struct cpuidle_device *dev, |
124cf911 RW |
66 | struct cpuidle_driver *drv, |
67 | int index); | |
4f86d3a8 LB |
68 | }; |
69 | ||
70 | /* Idle State Flags */ | |
9e9fc6f0 | 71 | #define CPUIDLE_FLAG_NONE (0x00) |
44021606 YL |
72 | #define CPUIDLE_FLAG_POLLING BIT(0) /* polling state */ |
73 | #define CPUIDLE_FLAG_COUPLED BIT(1) /* state applies to multiple cpus */ | |
74 | #define CPUIDLE_FLAG_TIMER_STOP BIT(2) /* timer is stopped on this state */ | |
4f86d3a8 | 75 | |
728ce22b | 76 | struct cpuidle_device_kobj; |
1a706438 DL |
77 | struct cpuidle_state_kobj; |
78 | struct cpuidle_driver_kobj; | |
728ce22b | 79 | |
4f86d3a8 | 80 | struct cpuidle_device { |
dcb84f33 | 81 | unsigned int registered:1; |
b5556a67 | 82 | unsigned int enabled:1; |
bb8313b6 | 83 | unsigned int use_deepest_state:1; |
5f26bdce | 84 | unsigned int poll_time_limit:1; |
4f86d3a8 | 85 | unsigned int cpu; |
6f9b83ac | 86 | ktime_t next_hrtimer; |
4f86d3a8 LB |
87 | |
88 | int last_residency; | |
4202735e | 89 | struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX]; |
4f86d3a8 | 90 | struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX]; |
bf4d1b5d | 91 | struct cpuidle_driver_kobj *kobj_driver; |
728ce22b | 92 | struct cpuidle_device_kobj *kobj_dev; |
4f86d3a8 | 93 | struct list_head device_list; |
4126c019 CC |
94 | |
95 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED | |
4126c019 CC |
96 | cpumask_t coupled_cpus; |
97 | struct cpuidle_coupled *coupled; | |
98 | #endif | |
4f86d3a8 LB |
99 | }; |
100 | ||
101 | DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices); | |
f08dbf8a | 102 | DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev); |
4f86d3a8 | 103 | |
4f86d3a8 LB |
104 | /**************************** |
105 | * CPUIDLE DRIVER INTERFACE * | |
106 | ****************************/ | |
107 | ||
108 | struct cpuidle_driver { | |
db70b044 | 109 | const char *name; |
4f86d3a8 | 110 | struct module *owner; |
42f67f2a | 111 | int refcnt; |
46bcfad7 | 112 | |
a06df062 DL |
113 | /* used by the cpuidle framework to setup the broadcast timer */ |
114 | unsigned int bctimer:1; | |
8aef33a7 | 115 | /* states array must be ordered in decreasing power consumption */ |
46bcfad7 DD |
116 | struct cpuidle_state states[CPUIDLE_STATE_MAX]; |
117 | int state_count; | |
118 | int safe_state_index; | |
82467a5a DL |
119 | |
120 | /* the driver handles the cpus in cpumask */ | |
6587fca2 | 121 | struct cpumask *cpumask; |
4f86d3a8 LB |
122 | }; |
123 | ||
124 | #ifdef CONFIG_CPU_IDLE | |
d91ee586 | 125 | extern void disable_cpuidle(void); |
ef2b22ac RW |
126 | extern bool cpuidle_not_available(struct cpuidle_driver *drv, |
127 | struct cpuidle_device *dev); | |
907e30f1 | 128 | |
907e30f1 | 129 | extern int cpuidle_select(struct cpuidle_driver *drv, |
45f1ff59 RW |
130 | struct cpuidle_device *dev, |
131 | bool *stop_tick); | |
907e30f1 DL |
132 | extern int cpuidle_enter(struct cpuidle_driver *drv, |
133 | struct cpuidle_device *dev, int index); | |
134 | extern void cpuidle_reflect(struct cpuidle_device *dev, int index); | |
135 | ||
4f86d3a8 | 136 | extern int cpuidle_register_driver(struct cpuidle_driver *drv); |
6e797a07 RW |
137 | extern struct cpuidle_driver *cpuidle_get_driver(void); |
138 | extern struct cpuidle_driver *cpuidle_driver_ref(void); | |
139 | extern void cpuidle_driver_unref(void); | |
4f86d3a8 LB |
140 | extern void cpuidle_unregister_driver(struct cpuidle_driver *drv); |
141 | extern int cpuidle_register_device(struct cpuidle_device *dev); | |
142 | extern void cpuidle_unregister_device(struct cpuidle_device *dev); | |
4c637b21 DL |
143 | extern int cpuidle_register(struct cpuidle_driver *drv, |
144 | const struct cpumask *const coupled_cpus); | |
145 | extern void cpuidle_unregister(struct cpuidle_driver *drv); | |
4f86d3a8 LB |
146 | extern void cpuidle_pause_and_lock(void); |
147 | extern void cpuidle_resume_and_unlock(void); | |
8651f97b PM |
148 | extern void cpuidle_pause(void); |
149 | extern void cpuidle_resume(void); | |
4f86d3a8 LB |
150 | extern int cpuidle_enable_device(struct cpuidle_device *dev); |
151 | extern void cpuidle_disable_device(struct cpuidle_device *dev); | |
1a022e3f BO |
152 | extern int cpuidle_play_dead(void); |
153 | ||
bf4d1b5d | 154 | extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev); |
9bd616e3 CM |
155 | static inline struct cpuidle_device *cpuidle_get_device(void) |
156 | {return __this_cpu_read(cpuidle_devices); } | |
4f86d3a8 | 157 | #else |
d91ee586 | 158 | static inline void disable_cpuidle(void) { } |
ef2b22ac RW |
159 | static inline bool cpuidle_not_available(struct cpuidle_driver *drv, |
160 | struct cpuidle_device *dev) | |
161 | {return true; } | |
907e30f1 | 162 | static inline int cpuidle_select(struct cpuidle_driver *drv, |
45f1ff59 | 163 | struct cpuidle_device *dev, bool *stop_tick) |
907e30f1 DL |
164 | {return -ENODEV; } |
165 | static inline int cpuidle_enter(struct cpuidle_driver *drv, | |
166 | struct cpuidle_device *dev, int index) | |
167 | {return -ENODEV; } | |
168 | static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { } | |
4f86d3a8 | 169 | static inline int cpuidle_register_driver(struct cpuidle_driver *drv) |
6b2c676b | 170 | {return -ENODEV; } |
752138df | 171 | static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; } |
6e797a07 RW |
172 | static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; } |
173 | static inline void cpuidle_driver_unref(void) {} | |
4f86d3a8 LB |
174 | static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { } |
175 | static inline int cpuidle_register_device(struct cpuidle_device *dev) | |
6b2c676b | 176 | {return -ENODEV; } |
4f86d3a8 | 177 | static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { } |
4c637b21 DL |
178 | static inline int cpuidle_register(struct cpuidle_driver *drv, |
179 | const struct cpumask *const coupled_cpus) | |
180 | {return -ENODEV; } | |
181 | static inline void cpuidle_unregister(struct cpuidle_driver *drv) { } | |
4f86d3a8 LB |
182 | static inline void cpuidle_pause_and_lock(void) { } |
183 | static inline void cpuidle_resume_and_unlock(void) { } | |
8651f97b PM |
184 | static inline void cpuidle_pause(void) { } |
185 | static inline void cpuidle_resume(void) { } | |
4f86d3a8 | 186 | static inline int cpuidle_enable_device(struct cpuidle_device *dev) |
6b2c676b | 187 | {return -ENODEV; } |
4f86d3a8 | 188 | static inline void cpuidle_disable_device(struct cpuidle_device *dev) { } |
1a022e3f | 189 | static inline int cpuidle_play_dead(void) {return -ENODEV; } |
87e9b9f1 RW |
190 | static inline struct cpuidle_driver *cpuidle_get_cpu_driver( |
191 | struct cpuidle_device *dev) {return NULL; } | |
9bd616e3 | 192 | static inline struct cpuidle_device *cpuidle_get_device(void) {return NULL; } |
87e9b9f1 RW |
193 | #endif |
194 | ||
bb8313b6 | 195 | #ifdef CONFIG_CPU_IDLE |
87e9b9f1 RW |
196 | extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv, |
197 | struct cpuidle_device *dev); | |
28ba086e | 198 | extern int cpuidle_enter_s2idle(struct cpuidle_driver *drv, |
87e9b9f1 | 199 | struct cpuidle_device *dev); |
bb8313b6 | 200 | extern void cpuidle_use_deepest_state(bool enable); |
87e9b9f1 | 201 | #else |
ef2b22ac RW |
202 | static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv, |
203 | struct cpuidle_device *dev) | |
204 | {return -ENODEV; } | |
28ba086e | 205 | static inline int cpuidle_enter_s2idle(struct cpuidle_driver *drv, |
ef2b22ac RW |
206 | struct cpuidle_device *dev) |
207 | {return -ENODEV; } | |
bb8313b6 JP |
208 | static inline void cpuidle_use_deepest_state(bool enable) |
209 | { | |
210 | } | |
4f86d3a8 LB |
211 | #endif |
212 | ||
faad3849 RW |
213 | /* kernel/sched/idle.c */ |
214 | extern void sched_idle_set_state(struct cpuidle_state *idle_state); | |
827a5aef | 215 | extern void default_idle_call(void); |
faad3849 | 216 | |
20ff51a3 CC |
217 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED |
218 | void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a); | |
c7a9b09b AB |
219 | #else |
220 | static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a) | |
221 | { | |
222 | } | |
20ff51a3 CC |
223 | #endif |
224 | ||
d7212cfb | 225 | #if defined(CONFIG_CPU_IDLE) && defined(CONFIG_ARCH_HAS_CPU_RELAX) |
1b39e3f8 | 226 | void cpuidle_poll_state_init(struct cpuidle_driver *drv); |
34c2f65b | 227 | #else |
1b39e3f8 | 228 | static inline void cpuidle_poll_state_init(struct cpuidle_driver *drv) {} |
34c2f65b RW |
229 | #endif |
230 | ||
4f86d3a8 LB |
231 | /****************************** |
232 | * CPUIDLE GOVERNOR INTERFACE * | |
233 | ******************************/ | |
234 | ||
235 | struct cpuidle_governor { | |
236 | char name[CPUIDLE_NAME_LEN]; | |
237 | struct list_head governor_list; | |
238 | unsigned int rating; | |
239 | ||
46bcfad7 DD |
240 | int (*enable) (struct cpuidle_driver *drv, |
241 | struct cpuidle_device *dev); | |
242 | void (*disable) (struct cpuidle_driver *drv, | |
243 | struct cpuidle_device *dev); | |
4f86d3a8 | 244 | |
46bcfad7 | 245 | int (*select) (struct cpuidle_driver *drv, |
45f1ff59 RW |
246 | struct cpuidle_device *dev, |
247 | bool *stop_tick); | |
e978aa7d | 248 | void (*reflect) (struct cpuidle_device *dev, int index); |
4f86d3a8 LB |
249 | }; |
250 | ||
251 | #ifdef CONFIG_CPU_IDLE | |
4f86d3a8 | 252 | extern int cpuidle_register_governor(struct cpuidle_governor *gov); |
0fc784fb | 253 | extern int cpuidle_governor_latency_req(unsigned int cpu); |
4f86d3a8 | 254 | #else |
4f86d3a8 LB |
255 | static inline int cpuidle_register_governor(struct cpuidle_governor *gov) |
256 | {return 0;} | |
4f86d3a8 LB |
257 | #endif |
258 | ||
db50a74d PP |
259 | #define __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, is_retention) \ |
260 | ({ \ | |
261 | int __ret = 0; \ | |
262 | \ | |
263 | if (!idx) { \ | |
264 | cpu_do_idle(); \ | |
265 | return idx; \ | |
266 | } \ | |
267 | \ | |
268 | if (!is_retention) \ | |
269 | __ret = cpu_pm_enter(); \ | |
270 | if (!__ret) { \ | |
271 | __ret = low_level_idle_enter(idx); \ | |
272 | if (!is_retention) \ | |
273 | cpu_pm_exit(); \ | |
274 | } \ | |
275 | \ | |
276 | __ret ? -1 : idx; \ | |
220276e0 SH |
277 | }) |
278 | ||
db50a74d PP |
279 | #define CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx) \ |
280 | __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, 0) | |
281 | ||
282 | #define CPU_PM_CPU_IDLE_ENTER_RETENTION(low_level_idle_enter, idx) \ | |
283 | __CPU_PM_CPU_IDLE_ENTER(low_level_idle_enter, idx, 1) | |
284 | ||
4f86d3a8 | 285 | #endif /* _LINUX_CPUIDLE_H */ |