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> | |
4f86d3a8 LB |
16 | #include <linux/kobject.h> |
17 | #include <linux/completion.h> | |
e1689795 | 18 | #include <linux/hrtimer.h> |
4f86d3a8 LB |
19 | |
20 | #define CPUIDLE_STATE_MAX 8 | |
21 | #define CPUIDLE_NAME_LEN 16 | |
4fcb2fcd | 22 | #define CPUIDLE_DESC_LEN 32 |
4f86d3a8 | 23 | |
de477254 PG |
24 | struct module; |
25 | ||
4f86d3a8 | 26 | struct cpuidle_device; |
46bcfad7 | 27 | struct cpuidle_driver; |
4f86d3a8 LB |
28 | |
29 | ||
30 | /**************************** | |
31 | * CPUIDLE DEVICE INTERFACE * | |
32 | ****************************/ | |
33 | ||
4202735e DD |
34 | struct cpuidle_state_usage { |
35 | void *driver_data; | |
36 | ||
dc7fd275 | 37 | unsigned long long disable; |
4202735e DD |
38 | unsigned long long usage; |
39 | unsigned long long time; /* in US */ | |
40 | }; | |
41 | ||
4f86d3a8 LB |
42 | struct cpuidle_state { |
43 | char name[CPUIDLE_NAME_LEN]; | |
4fcb2fcd | 44 | char desc[CPUIDLE_DESC_LEN]; |
4f86d3a8 LB |
45 | |
46 | unsigned int flags; | |
47 | unsigned int exit_latency; /* in US */ | |
02401c06 | 48 | int power_usage; /* in mW */ |
4f86d3a8 | 49 | unsigned int target_residency; /* in US */ |
cbc9ef02 | 50 | bool disabled; /* disabled on all CPUs */ |
4f86d3a8 | 51 | |
4f86d3a8 | 52 | int (*enter) (struct cpuidle_device *dev, |
46bcfad7 | 53 | struct cpuidle_driver *drv, |
e978aa7d | 54 | int index); |
1a022e3f BO |
55 | |
56 | int (*enter_dead) (struct cpuidle_device *dev, int index); | |
4f86d3a8 LB |
57 | }; |
58 | ||
59 | /* Idle State Flags */ | |
60 | #define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */ | |
4126c019 | 61 | #define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */ |
4f86d3a8 LB |
62 | |
63 | #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000) | |
64 | ||
65 | /** | |
66 | * cpuidle_get_statedata - retrieves private driver state data | |
4202735e | 67 | * @st_usage: the state usage statistics |
4f86d3a8 | 68 | */ |
4202735e | 69 | static inline void *cpuidle_get_statedata(struct cpuidle_state_usage *st_usage) |
4f86d3a8 | 70 | { |
4202735e | 71 | return st_usage->driver_data; |
4f86d3a8 LB |
72 | } |
73 | ||
74 | /** | |
75 | * cpuidle_set_statedata - stores private driver state data | |
4202735e | 76 | * @st_usage: the state usage statistics |
4f86d3a8 LB |
77 | * @data: the private data |
78 | */ | |
79 | static inline void | |
4202735e | 80 | cpuidle_set_statedata(struct cpuidle_state_usage *st_usage, void *data) |
4f86d3a8 | 81 | { |
4202735e | 82 | st_usage->driver_data = data; |
4f86d3a8 LB |
83 | } |
84 | ||
4f86d3a8 | 85 | struct cpuidle_device { |
dcb84f33 | 86 | unsigned int registered:1; |
b5556a67 | 87 | unsigned int enabled:1; |
4f86d3a8 LB |
88 | unsigned int cpu; |
89 | ||
90 | int last_residency; | |
91 | int state_count; | |
4202735e | 92 | struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX]; |
4f86d3a8 | 93 | struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX]; |
4f86d3a8 LB |
94 | |
95 | struct list_head device_list; | |
96 | struct kobject kobj; | |
97 | struct completion kobj_unregister; | |
4126c019 CC |
98 | |
99 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED | |
100 | int safe_state_index; | |
101 | cpumask_t coupled_cpus; | |
102 | struct cpuidle_coupled *coupled; | |
103 | #endif | |
4f86d3a8 LB |
104 | }; |
105 | ||
106 | DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices); | |
107 | ||
108 | /** | |
109 | * cpuidle_get_last_residency - retrieves the last state's residency time | |
110 | * @dev: the target CPU | |
111 | * | |
112 | * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set | |
113 | */ | |
114 | static inline int cpuidle_get_last_residency(struct cpuidle_device *dev) | |
115 | { | |
116 | return dev->last_residency; | |
117 | } | |
118 | ||
119 | ||
120 | /**************************** | |
121 | * CPUIDLE DRIVER INTERFACE * | |
122 | ****************************/ | |
123 | ||
124 | struct cpuidle_driver { | |
db70b044 | 125 | const char *name; |
4f86d3a8 | 126 | struct module *owner; |
42f67f2a | 127 | int refcnt; |
46bcfad7 DD |
128 | |
129 | unsigned int power_specified:1; | |
e1689795 RL |
130 | /* set to 1 to use the core cpuidle time keeping (for all states). */ |
131 | unsigned int en_core_tk_irqen:1; | |
46bcfad7 DD |
132 | struct cpuidle_state states[CPUIDLE_STATE_MAX]; |
133 | int state_count; | |
134 | int safe_state_index; | |
4f86d3a8 LB |
135 | }; |
136 | ||
137 | #ifdef CONFIG_CPU_IDLE | |
d91ee586 | 138 | extern void disable_cpuidle(void); |
a0bfa137 | 139 | extern int cpuidle_idle_call(void); |
4f86d3a8 | 140 | extern int cpuidle_register_driver(struct cpuidle_driver *drv); |
6e797a07 RW |
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); | |
4f86d3a8 LB |
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 | ||
148 | extern void cpuidle_pause_and_lock(void); | |
149 | extern void cpuidle_resume_and_unlock(void); | |
8651f97b PM |
150 | extern void cpuidle_pause(void); |
151 | extern void cpuidle_resume(void); | |
4f86d3a8 LB |
152 | extern int cpuidle_enable_device(struct cpuidle_device *dev); |
153 | extern void cpuidle_disable_device(struct cpuidle_device *dev); | |
e1689795 RL |
154 | extern int cpuidle_wrap_enter(struct cpuidle_device *dev, |
155 | struct cpuidle_driver *drv, int index, | |
156 | int (*enter)(struct cpuidle_device *dev, | |
157 | struct cpuidle_driver *drv, int index)); | |
1a022e3f BO |
158 | extern int cpuidle_play_dead(void); |
159 | ||
4f86d3a8 | 160 | #else |
d91ee586 | 161 | static inline void disable_cpuidle(void) { } |
a0bfa137 | 162 | static inline int cpuidle_idle_call(void) { return -ENODEV; } |
4f86d3a8 | 163 | static inline int cpuidle_register_driver(struct cpuidle_driver *drv) |
6b2c676b | 164 | {return -ENODEV; } |
752138df | 165 | static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; } |
6e797a07 RW |
166 | static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; } |
167 | static inline void cpuidle_driver_unref(void) {} | |
4f86d3a8 LB |
168 | static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { } |
169 | static inline int cpuidle_register_device(struct cpuidle_device *dev) | |
6b2c676b | 170 | {return -ENODEV; } |
4f86d3a8 LB |
171 | static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { } |
172 | ||
173 | static inline void cpuidle_pause_and_lock(void) { } | |
174 | static inline void cpuidle_resume_and_unlock(void) { } | |
8651f97b PM |
175 | static inline void cpuidle_pause(void) { } |
176 | static inline void cpuidle_resume(void) { } | |
4f86d3a8 | 177 | static inline int cpuidle_enable_device(struct cpuidle_device *dev) |
6b2c676b | 178 | {return -ENODEV; } |
4f86d3a8 | 179 | static inline void cpuidle_disable_device(struct cpuidle_device *dev) { } |
e1689795 RL |
180 | static inline int cpuidle_wrap_enter(struct cpuidle_device *dev, |
181 | struct cpuidle_driver *drv, int index, | |
182 | int (*enter)(struct cpuidle_device *dev, | |
183 | struct cpuidle_driver *drv, int index)) | |
184 | { return -ENODEV; } | |
1a022e3f | 185 | static inline int cpuidle_play_dead(void) {return -ENODEV; } |
4f86d3a8 LB |
186 | |
187 | #endif | |
188 | ||
20ff51a3 CC |
189 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED |
190 | void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a); | |
c7a9b09b AB |
191 | #else |
192 | static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a) | |
193 | { | |
194 | } | |
20ff51a3 CC |
195 | #endif |
196 | ||
4f86d3a8 LB |
197 | /****************************** |
198 | * CPUIDLE GOVERNOR INTERFACE * | |
199 | ******************************/ | |
200 | ||
201 | struct cpuidle_governor { | |
202 | char name[CPUIDLE_NAME_LEN]; | |
203 | struct list_head governor_list; | |
204 | unsigned int rating; | |
205 | ||
46bcfad7 DD |
206 | int (*enable) (struct cpuidle_driver *drv, |
207 | struct cpuidle_device *dev); | |
208 | void (*disable) (struct cpuidle_driver *drv, | |
209 | struct cpuidle_device *dev); | |
4f86d3a8 | 210 | |
46bcfad7 DD |
211 | int (*select) (struct cpuidle_driver *drv, |
212 | struct cpuidle_device *dev); | |
e978aa7d | 213 | void (*reflect) (struct cpuidle_device *dev, int index); |
4f86d3a8 LB |
214 | |
215 | struct module *owner; | |
216 | }; | |
217 | ||
218 | #ifdef CONFIG_CPU_IDLE | |
219 | ||
220 | extern int cpuidle_register_governor(struct cpuidle_governor *gov); | |
221 | extern void cpuidle_unregister_governor(struct cpuidle_governor *gov); | |
222 | ||
223 | #else | |
224 | ||
225 | static inline int cpuidle_register_governor(struct cpuidle_governor *gov) | |
226 | {return 0;} | |
227 | static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { } | |
228 | ||
229 | #endif | |
230 | ||
9a0b8415 | 231 | #ifdef CONFIG_ARCH_HAS_CPU_RELAX |
232 | #define CPUIDLE_DRIVER_STATE_START 1 | |
233 | #else | |
234 | #define CPUIDLE_DRIVER_STATE_START 0 | |
235 | #endif | |
236 | ||
4f86d3a8 | 237 | #endif /* _LINUX_CPUIDLE_H */ |