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 */ | |
36 | }; | |
37 | ||
4f86d3a8 LB |
38 | struct cpuidle_state { |
39 | char name[CPUIDLE_NAME_LEN]; | |
4fcb2fcd | 40 | char desc[CPUIDLE_DESC_LEN]; |
4f86d3a8 LB |
41 | |
42 | unsigned int flags; | |
43 | unsigned int exit_latency; /* in US */ | |
02401c06 | 44 | int power_usage; /* in mW */ |
4f86d3a8 | 45 | unsigned int target_residency; /* in US */ |
cbc9ef02 | 46 | bool disabled; /* disabled on all CPUs */ |
4f86d3a8 | 47 | |
4f86d3a8 | 48 | int (*enter) (struct cpuidle_device *dev, |
46bcfad7 | 49 | struct cpuidle_driver *drv, |
e978aa7d | 50 | int index); |
1a022e3f BO |
51 | |
52 | int (*enter_dead) (struct cpuidle_device *dev, int index); | |
124cf911 RW |
53 | |
54 | /* | |
55 | * CPUs execute ->enter_freeze 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. | |
58 | */ | |
59 | void (*enter_freeze) (struct cpuidle_device *dev, | |
60 | struct cpuidle_driver *drv, | |
61 | int index); | |
4f86d3a8 LB |
62 | }; |
63 | ||
64 | /* Idle State Flags */ | |
4126c019 | 65 | #define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */ |
b60e6a0e | 66 | #define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */ |
4f86d3a8 LB |
67 | |
68 | #define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000) | |
69 | ||
728ce22b | 70 | struct cpuidle_device_kobj; |
1a706438 DL |
71 | struct cpuidle_state_kobj; |
72 | struct cpuidle_driver_kobj; | |
728ce22b | 73 | |
4f86d3a8 | 74 | struct cpuidle_device { |
dcb84f33 | 75 | unsigned int registered:1; |
b5556a67 | 76 | unsigned int enabled:1; |
4f86d3a8 LB |
77 | unsigned int cpu; |
78 | ||
79 | int last_residency; | |
4202735e | 80 | struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX]; |
4f86d3a8 | 81 | struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX]; |
bf4d1b5d | 82 | struct cpuidle_driver_kobj *kobj_driver; |
728ce22b | 83 | struct cpuidle_device_kobj *kobj_dev; |
4f86d3a8 | 84 | struct list_head device_list; |
4126c019 CC |
85 | |
86 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED | |
87 | int safe_state_index; | |
88 | cpumask_t coupled_cpus; | |
89 | struct cpuidle_coupled *coupled; | |
90 | #endif | |
4f86d3a8 LB |
91 | }; |
92 | ||
93 | DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices); | |
f08dbf8a | 94 | DECLARE_PER_CPU(struct cpuidle_device, cpuidle_dev); |
4f86d3a8 LB |
95 | |
96 | /** | |
97 | * cpuidle_get_last_residency - retrieves the last state's residency time | |
98 | * @dev: the target CPU | |
4f86d3a8 LB |
99 | */ |
100 | static inline int cpuidle_get_last_residency(struct cpuidle_device *dev) | |
101 | { | |
102 | return dev->last_residency; | |
103 | } | |
104 | ||
105 | ||
106 | /**************************** | |
107 | * CPUIDLE DRIVER INTERFACE * | |
108 | ****************************/ | |
109 | ||
110 | struct cpuidle_driver { | |
db70b044 | 111 | const char *name; |
4f86d3a8 | 112 | struct module *owner; |
42f67f2a | 113 | int refcnt; |
46bcfad7 | 114 | |
a06df062 DL |
115 | /* used by the cpuidle framework to setup the broadcast timer */ |
116 | unsigned int bctimer:1; | |
8aef33a7 | 117 | /* states array must be ordered in decreasing power consumption */ |
46bcfad7 DD |
118 | struct cpuidle_state states[CPUIDLE_STATE_MAX]; |
119 | int state_count; | |
120 | int safe_state_index; | |
82467a5a DL |
121 | |
122 | /* the driver handles the cpus in cpumask */ | |
6587fca2 | 123 | struct cpumask *cpumask; |
4f86d3a8 LB |
124 | }; |
125 | ||
126 | #ifdef CONFIG_CPU_IDLE | |
d91ee586 | 127 | extern void disable_cpuidle(void); |
ef2b22ac RW |
128 | extern bool cpuidle_not_available(struct cpuidle_driver *drv, |
129 | struct cpuidle_device *dev); | |
907e30f1 | 130 | |
907e30f1 DL |
131 | extern int cpuidle_select(struct cpuidle_driver *drv, |
132 | struct cpuidle_device *dev); | |
133 | extern int cpuidle_enter(struct cpuidle_driver *drv, | |
134 | struct cpuidle_device *dev, int index); | |
135 | extern void cpuidle_reflect(struct cpuidle_device *dev, int index); | |
136 | ||
4f86d3a8 | 137 | extern int cpuidle_register_driver(struct cpuidle_driver *drv); |
6e797a07 RW |
138 | extern struct cpuidle_driver *cpuidle_get_driver(void); |
139 | extern struct cpuidle_driver *cpuidle_driver_ref(void); | |
140 | extern void cpuidle_driver_unref(void); | |
4f86d3a8 LB |
141 | extern void cpuidle_unregister_driver(struct cpuidle_driver *drv); |
142 | extern int cpuidle_register_device(struct cpuidle_device *dev); | |
143 | extern void cpuidle_unregister_device(struct cpuidle_device *dev); | |
4c637b21 DL |
144 | extern int cpuidle_register(struct cpuidle_driver *drv, |
145 | const struct cpumask *const coupled_cpus); | |
146 | extern void cpuidle_unregister(struct cpuidle_driver *drv); | |
4f86d3a8 LB |
147 | extern void cpuidle_pause_and_lock(void); |
148 | extern void cpuidle_resume_and_unlock(void); | |
8651f97b PM |
149 | extern void cpuidle_pause(void); |
150 | extern void cpuidle_resume(void); | |
4f86d3a8 LB |
151 | extern int cpuidle_enable_device(struct cpuidle_device *dev); |
152 | extern void cpuidle_disable_device(struct cpuidle_device *dev); | |
1a022e3f | 153 | extern int cpuidle_play_dead(void); |
ef2b22ac RW |
154 | extern int cpuidle_find_deepest_state(struct cpuidle_driver *drv, |
155 | struct cpuidle_device *dev); | |
156 | extern int cpuidle_enter_freeze(struct cpuidle_driver *drv, | |
157 | struct cpuidle_device *dev); | |
1a022e3f | 158 | |
bf4d1b5d | 159 | extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev); |
4f86d3a8 | 160 | #else |
d91ee586 | 161 | static inline void disable_cpuidle(void) { } |
ef2b22ac RW |
162 | static inline bool cpuidle_not_available(struct cpuidle_driver *drv, |
163 | struct cpuidle_device *dev) | |
164 | {return true; } | |
907e30f1 DL |
165 | static inline int cpuidle_select(struct cpuidle_driver *drv, |
166 | struct cpuidle_device *dev) | |
167 | {return -ENODEV; } | |
168 | static inline int cpuidle_enter(struct cpuidle_driver *drv, | |
169 | struct cpuidle_device *dev, int index) | |
170 | {return -ENODEV; } | |
171 | static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { } | |
4f86d3a8 | 172 | static inline int cpuidle_register_driver(struct cpuidle_driver *drv) |
6b2c676b | 173 | {return -ENODEV; } |
752138df | 174 | static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; } |
6e797a07 RW |
175 | static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; } |
176 | static inline void cpuidle_driver_unref(void) {} | |
4f86d3a8 LB |
177 | static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { } |
178 | static inline int cpuidle_register_device(struct cpuidle_device *dev) | |
6b2c676b | 179 | {return -ENODEV; } |
4f86d3a8 | 180 | static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { } |
4c637b21 DL |
181 | static inline int cpuidle_register(struct cpuidle_driver *drv, |
182 | const struct cpumask *const coupled_cpus) | |
183 | {return -ENODEV; } | |
184 | static inline void cpuidle_unregister(struct cpuidle_driver *drv) { } | |
4f86d3a8 LB |
185 | static inline void cpuidle_pause_and_lock(void) { } |
186 | static inline void cpuidle_resume_and_unlock(void) { } | |
8651f97b PM |
187 | static inline void cpuidle_pause(void) { } |
188 | static inline void cpuidle_resume(void) { } | |
4f86d3a8 | 189 | static inline int cpuidle_enable_device(struct cpuidle_device *dev) |
6b2c676b | 190 | {return -ENODEV; } |
4f86d3a8 | 191 | static inline void cpuidle_disable_device(struct cpuidle_device *dev) { } |
1a022e3f | 192 | static inline int cpuidle_play_dead(void) {return -ENODEV; } |
ef2b22ac RW |
193 | static inline int cpuidle_find_deepest_state(struct cpuidle_driver *drv, |
194 | struct cpuidle_device *dev) | |
195 | {return -ENODEV; } | |
196 | static inline int cpuidle_enter_freeze(struct cpuidle_driver *drv, | |
197 | struct cpuidle_device *dev) | |
198 | {return -ENODEV; } | |
c8cc7d4d DL |
199 | static inline struct cpuidle_driver *cpuidle_get_cpu_driver( |
200 | struct cpuidle_device *dev) {return NULL; } | |
4f86d3a8 LB |
201 | #endif |
202 | ||
20ff51a3 CC |
203 | #ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED |
204 | void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a); | |
c7a9b09b AB |
205 | #else |
206 | static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a) | |
207 | { | |
208 | } | |
20ff51a3 CC |
209 | #endif |
210 | ||
4f86d3a8 LB |
211 | /****************************** |
212 | * CPUIDLE GOVERNOR INTERFACE * | |
213 | ******************************/ | |
214 | ||
215 | struct cpuidle_governor { | |
216 | char name[CPUIDLE_NAME_LEN]; | |
217 | struct list_head governor_list; | |
218 | unsigned int rating; | |
219 | ||
46bcfad7 DD |
220 | int (*enable) (struct cpuidle_driver *drv, |
221 | struct cpuidle_device *dev); | |
222 | void (*disable) (struct cpuidle_driver *drv, | |
223 | struct cpuidle_device *dev); | |
4f86d3a8 | 224 | |
46bcfad7 DD |
225 | int (*select) (struct cpuidle_driver *drv, |
226 | struct cpuidle_device *dev); | |
e978aa7d | 227 | void (*reflect) (struct cpuidle_device *dev, int index); |
4f86d3a8 LB |
228 | |
229 | struct module *owner; | |
230 | }; | |
231 | ||
232 | #ifdef CONFIG_CPU_IDLE | |
4f86d3a8 | 233 | extern int cpuidle_register_governor(struct cpuidle_governor *gov); |
4f86d3a8 | 234 | #else |
4f86d3a8 LB |
235 | static inline int cpuidle_register_governor(struct cpuidle_governor *gov) |
236 | {return 0;} | |
4f86d3a8 LB |
237 | #endif |
238 | ||
9a0b8415 | 239 | #ifdef CONFIG_ARCH_HAS_CPU_RELAX |
240 | #define CPUIDLE_DRIVER_STATE_START 1 | |
241 | #else | |
242 | #define CPUIDLE_DRIVER_STATE_START 0 | |
243 | #endif | |
244 | ||
4f86d3a8 | 245 | #endif /* _LINUX_CPUIDLE_H */ |