Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
bb176f7d | 2 | * linux/include/linux/cpufreq.h |
1da177e4 | 3 | * |
bb176f7d VK |
4 | * Copyright (C) 2001 Russell King |
5 | * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de> | |
335dc333 | 6 | * |
1da177e4 LT |
7 | * This program is free software; you can redistribute it and/or modify |
8 | * it under the terms of the GNU General Public License version 2 as | |
9 | * published by the Free Software Foundation. | |
10 | */ | |
11 | #ifndef _LINUX_CPUFREQ_H | |
12 | #define _LINUX_CPUFREQ_H | |
13 | ||
652ed95d | 14 | #include <linux/clk.h> |
5ff0a268 VK |
15 | #include <linux/cpumask.h> |
16 | #include <linux/completion.h> | |
1da177e4 | 17 | #include <linux/kobject.h> |
5ff0a268 | 18 | #include <linux/notifier.h> |
12478cf0 | 19 | #include <linux/spinlock.h> |
1da177e4 | 20 | #include <linux/sysfs.h> |
1da177e4 | 21 | |
1da177e4 | 22 | /********************************************************************* |
74aca95d | 23 | * CPUFREQ INTERFACE * |
1da177e4 | 24 | *********************************************************************/ |
74aca95d VK |
25 | /* |
26 | * Frequency values here are CPU kHz | |
27 | * | |
b53cc6ea | 28 | * Maximum transition latency is in nanoseconds - if it's unknown, |
1da177e4 LT |
29 | * CPUFREQ_ETERNAL shall be used. |
30 | */ | |
31 | ||
74aca95d VK |
32 | #define CPUFREQ_ETERNAL (-1) |
33 | #define CPUFREQ_NAME_LEN 16 | |
34 | /* Print length for names. Extra 1 space for accomodating '\n' in prints */ | |
35 | #define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1) | |
36 | ||
1da177e4 LT |
37 | struct cpufreq_governor; |
38 | ||
da0c6dc0 VK |
39 | enum cpufreq_table_sorting { |
40 | CPUFREQ_TABLE_UNSORTED, | |
41 | CPUFREQ_TABLE_SORTED_ASCENDING, | |
42 | CPUFREQ_TABLE_SORTED_DESCENDING | |
43 | }; | |
44 | ||
74aca95d VK |
45 | struct cpufreq_freqs { |
46 | unsigned int cpu; /* cpu nr */ | |
47 | unsigned int old; | |
48 | unsigned int new; | |
49 | u8 flags; /* flags of cpufreq_driver, see below. */ | |
50 | }; | |
8aa84ad8 | 51 | |
1da177e4 LT |
52 | struct cpufreq_cpuinfo { |
53 | unsigned int max_freq; | |
54 | unsigned int min_freq; | |
335dc333 TF |
55 | |
56 | /* in 10^(-9) s = nanoseconds */ | |
57 | unsigned int transition_latency; | |
1da177e4 LT |
58 | }; |
59 | ||
c7a7b418 | 60 | struct cpufreq_user_policy { |
1da177e4 LT |
61 | unsigned int min; /* in kHz */ |
62 | unsigned int max; /* in kHz */ | |
1da177e4 LT |
63 | }; |
64 | ||
65 | struct cpufreq_policy { | |
951fc5f4 VK |
66 | /* CPUs sharing clock, require sw coordination */ |
67 | cpumask_var_t cpus; /* Online CPUs only */ | |
68 | cpumask_var_t related_cpus; /* Online + Offline CPUs */ | |
559ed407 | 69 | cpumask_var_t real_cpus; /* Related and present */ |
951fc5f4 | 70 | |
62b36cc1 | 71 | unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs |
3b2d9942 | 72 | should set cpufreq */ |
9d16f207 | 73 | unsigned int cpu; /* cpu managing this policy, must be online */ |
9d16f207 | 74 | |
652ed95d | 75 | struct clk *clk; |
1da177e4 LT |
76 | struct cpufreq_cpuinfo cpuinfo;/* see above */ |
77 | ||
78 | unsigned int min; /* in kHz */ | |
79 | unsigned int max; /* in kHz */ | |
80 | unsigned int cur; /* in kHz, only needed if cpufreq | |
81 | * governors are used */ | |
1c03a2d0 | 82 | unsigned int restore_freq; /* = policy->cur before transition */ |
e28867ea VK |
83 | unsigned int suspend_freq; /* freq to set during suspend */ |
84 | ||
335dc333 | 85 | unsigned int policy; /* see above */ |
69030dd1 | 86 | unsigned int last_policy; /* policy before unplug */ |
1da177e4 | 87 | struct cpufreq_governor *governor; /* see below */ |
7bd353a9 | 88 | void *governor_data; |
4573237b | 89 | char last_governor[CPUFREQ_NAME_LEN]; /* last governor used */ |
1da177e4 | 90 | |
1da177e4 LT |
91 | struct work_struct update; /* if update_policy() needs to be |
92 | * called, but you're in IRQ context */ | |
93 | ||
c7a7b418 | 94 | struct cpufreq_user_policy user_policy; |
e0b3165b | 95 | struct cpufreq_frequency_table *freq_table; |
da0c6dc0 | 96 | enum cpufreq_table_sorting freq_table_sorted; |
1da177e4 | 97 | |
c88a1f8b | 98 | struct list_head policy_list; |
1da177e4 LT |
99 | struct kobject kobj; |
100 | struct completion kobj_unregister; | |
ad7722da | 101 | |
102 | /* | |
103 | * The rules for this semaphore: | |
104 | * - Any routine that wants to read from the policy structure will | |
105 | * do a down_read on this semaphore. | |
106 | * - Any routine that will write to the policy structure and/or may take away | |
107 | * the policy altogether (eg. CPU hotplug), will hold this lock in write | |
108 | * mode before doing so. | |
ad7722da | 109 | */ |
110 | struct rw_semaphore rwsem; | |
12478cf0 | 111 | |
b7898fda RW |
112 | /* |
113 | * Fast switch flags: | |
114 | * - fast_switch_possible should be set by the driver if it can | |
115 | * guarantee that frequency can be changed on any CPU sharing the | |
116 | * policy and that the change will affect all of the policy CPUs then. | |
117 | * - fast_switch_enabled is to be set by governors that support fast | |
118 | * freqnency switching with the help of cpufreq_enable_fast_switch(). | |
119 | */ | |
120 | bool fast_switch_possible; | |
121 | bool fast_switch_enabled; | |
122 | ||
e3c06236 SM |
123 | /* Cached frequency lookup from cpufreq_driver_resolve_freq. */ |
124 | unsigned int cached_target_freq; | |
125 | int cached_resolved_idx; | |
126 | ||
12478cf0 SB |
127 | /* Synchronization for frequency transitions */ |
128 | bool transition_ongoing; /* Tracks transition status */ | |
129 | spinlock_t transition_lock; | |
130 | wait_queue_head_t transition_wait; | |
ca654dc3 | 131 | struct task_struct *transition_task; /* Task which is doing the transition */ |
413fffc3 | 132 | |
a9aaf291 VK |
133 | /* cpufreq-stats */ |
134 | struct cpufreq_stats *stats; | |
135 | ||
413fffc3 VK |
136 | /* For cpufreq driver's internal use */ |
137 | void *driver_data; | |
1da177e4 LT |
138 | }; |
139 | ||
62b36cc1 | 140 | /* Only for ACPI */ |
46f18e3a VP |
141 | #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */ |
142 | #define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */ | |
143 | #define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */ | |
144 | #define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/ | |
1da177e4 | 145 | |
c75b505d | 146 | #ifdef CONFIG_CPU_FREQ |
1f0bd44e | 147 | struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu); |
74aca95d | 148 | struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu); |
3a3e9e06 | 149 | void cpufreq_cpu_put(struct cpufreq_policy *policy); |
c75b505d | 150 | #else |
1f0bd44e RW |
151 | static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu) |
152 | { | |
153 | return NULL; | |
154 | } | |
c75b505d DV |
155 | static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu) |
156 | { | |
157 | return NULL; | |
158 | } | |
159 | static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { } | |
160 | #endif | |
74aca95d | 161 | |
2624f90c FB |
162 | static inline bool policy_is_shared(struct cpufreq_policy *policy) |
163 | { | |
164 | return cpumask_weight(policy->cpus) > 1; | |
165 | } | |
166 | ||
74aca95d VK |
167 | /* /sys/devices/system/cpu/cpufreq: entry point for global variables */ |
168 | extern struct kobject *cpufreq_global_kobject; | |
1da177e4 | 169 | |
74aca95d VK |
170 | #ifdef CONFIG_CPU_FREQ |
171 | unsigned int cpufreq_get(unsigned int cpu); | |
172 | unsigned int cpufreq_quick_get(unsigned int cpu); | |
173 | unsigned int cpufreq_quick_get_max(unsigned int cpu); | |
174 | void disable_cpufreq(void); | |
1da177e4 | 175 | |
74aca95d VK |
176 | u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy); |
177 | int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu); | |
178 | int cpufreq_update_policy(unsigned int cpu); | |
179 | bool have_governor_per_policy(void); | |
180 | struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy); | |
b7898fda | 181 | void cpufreq_enable_fast_switch(struct cpufreq_policy *policy); |
6c9d9c81 | 182 | void cpufreq_disable_fast_switch(struct cpufreq_policy *policy); |
74aca95d VK |
183 | #else |
184 | static inline unsigned int cpufreq_get(unsigned int cpu) | |
1da177e4 | 185 | { |
74aca95d VK |
186 | return 0; |
187 | } | |
188 | static inline unsigned int cpufreq_quick_get(unsigned int cpu) | |
189 | { | |
190 | return 0; | |
191 | } | |
192 | static inline unsigned int cpufreq_quick_get_max(unsigned int cpu) | |
193 | { | |
194 | return 0; | |
195 | } | |
196 | static inline void disable_cpufreq(void) { } | |
1da177e4 | 197 | #endif |
1da177e4 | 198 | |
1aefc75b RW |
199 | #ifdef CONFIG_CPU_FREQ_STAT |
200 | void cpufreq_stats_create_table(struct cpufreq_policy *policy); | |
201 | void cpufreq_stats_free_table(struct cpufreq_policy *policy); | |
202 | void cpufreq_stats_record_transition(struct cpufreq_policy *policy, | |
203 | unsigned int new_freq); | |
204 | #else | |
205 | static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { } | |
206 | static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { } | |
207 | static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy, | |
208 | unsigned int new_freq) { } | |
209 | #endif /* CONFIG_CPU_FREQ_STAT */ | |
210 | ||
1da177e4 | 211 | /********************************************************************* |
74aca95d | 212 | * CPUFREQ DRIVER INTERFACE * |
1da177e4 LT |
213 | *********************************************************************/ |
214 | ||
74aca95d VK |
215 | #define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */ |
216 | #define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */ | |
5b0c0b16 | 217 | #define CPUFREQ_RELATION_C 2 /* closest frequency to target */ |
1da177e4 | 218 | |
74aca95d VK |
219 | struct freq_attr { |
220 | struct attribute attr; | |
221 | ssize_t (*show)(struct cpufreq_policy *, char *); | |
222 | ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count); | |
1da177e4 LT |
223 | }; |
224 | ||
74aca95d VK |
225 | #define cpufreq_freq_attr_ro(_name) \ |
226 | static struct freq_attr _name = \ | |
227 | __ATTR(_name, 0444, show_##_name, NULL) | |
1da177e4 | 228 | |
74aca95d VK |
229 | #define cpufreq_freq_attr_ro_perm(_name, _perm) \ |
230 | static struct freq_attr _name = \ | |
231 | __ATTR(_name, _perm, show_##_name, NULL) | |
1da177e4 | 232 | |
74aca95d VK |
233 | #define cpufreq_freq_attr_rw(_name) \ |
234 | static struct freq_attr _name = \ | |
235 | __ATTR(_name, 0644, show_##_name, store_##_name) | |
236 | ||
237 | struct global_attr { | |
238 | struct attribute attr; | |
239 | ssize_t (*show)(struct kobject *kobj, | |
240 | struct attribute *attr, char *buf); | |
241 | ssize_t (*store)(struct kobject *a, struct attribute *b, | |
242 | const char *c, size_t count); | |
243 | }; | |
244 | ||
245 | #define define_one_global_ro(_name) \ | |
246 | static struct global_attr _name = \ | |
247 | __ATTR(_name, 0444, show_##_name, NULL) | |
248 | ||
249 | #define define_one_global_rw(_name) \ | |
250 | static struct global_attr _name = \ | |
251 | __ATTR(_name, 0644, show_##_name, store_##_name) | |
1da177e4 | 252 | |
1da177e4 LT |
253 | |
254 | struct cpufreq_driver { | |
90452e61 VK |
255 | char name[CPUFREQ_NAME_LEN]; |
256 | u8 flags; | |
257 | void *driver_data; | |
1da177e4 LT |
258 | |
259 | /* needed by all drivers */ | |
90452e61 VK |
260 | int (*init)(struct cpufreq_policy *policy); |
261 | int (*verify)(struct cpufreq_policy *policy); | |
1da177e4 LT |
262 | |
263 | /* define one out of two */ | |
90452e61 | 264 | int (*setpolicy)(struct cpufreq_policy *policy); |
1c03a2d0 VK |
265 | |
266 | /* | |
267 | * On failure, should always restore frequency to policy->restore_freq | |
268 | * (i.e. old freq). | |
269 | */ | |
90452e61 VK |
270 | int (*target)(struct cpufreq_policy *policy, |
271 | unsigned int target_freq, | |
272 | unsigned int relation); /* Deprecated */ | |
273 | int (*target_index)(struct cpufreq_policy *policy, | |
274 | unsigned int index); | |
b7898fda RW |
275 | unsigned int (*fast_switch)(struct cpufreq_policy *policy, |
276 | unsigned int target_freq); | |
e3c06236 SM |
277 | |
278 | /* | |
279 | * Caches and returns the lowest driver-supported frequency greater than | |
280 | * or equal to the target frequency, subject to any driver limitations. | |
281 | * Does not set the frequency. Only to be implemented for drivers with | |
282 | * target(). | |
283 | */ | |
284 | unsigned int (*resolve_freq)(struct cpufreq_policy *policy, | |
285 | unsigned int target_freq); | |
286 | ||
1c03a2d0 VK |
287 | /* |
288 | * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION | |
289 | * unset. | |
290 | * | |
291 | * get_intermediate should return a stable intermediate frequency | |
292 | * platform wants to switch to and target_intermediate() should set CPU | |
293 | * to to that frequency, before jumping to the frequency corresponding | |
294 | * to 'index'. Core will take care of sending notifications and driver | |
295 | * doesn't have to handle them in target_intermediate() or | |
296 | * target_index(). | |
297 | * | |
298 | * Drivers can return '0' from get_intermediate() in case they don't | |
299 | * wish to switch to intermediate frequency for some target frequency. | |
300 | * In that case core will directly call ->target_index(). | |
301 | */ | |
90452e61 VK |
302 | unsigned int (*get_intermediate)(struct cpufreq_policy *policy, |
303 | unsigned int index); | |
304 | int (*target_intermediate)(struct cpufreq_policy *policy, | |
305 | unsigned int index); | |
1da177e4 LT |
306 | |
307 | /* should be defined, if possible */ | |
90452e61 | 308 | unsigned int (*get)(unsigned int cpu); |
1da177e4 LT |
309 | |
310 | /* optional */ | |
90452e61 | 311 | int (*bios_limit)(int cpu, unsigned int *limit); |
bf0b90e3 | 312 | |
90452e61 VK |
313 | int (*exit)(struct cpufreq_policy *policy); |
314 | void (*stop_cpu)(struct cpufreq_policy *policy); | |
315 | int (*suspend)(struct cpufreq_policy *policy); | |
316 | int (*resume)(struct cpufreq_policy *policy); | |
7c45cf31 VK |
317 | |
318 | /* Will be called after the driver is fully initialized */ | |
319 | void (*ready)(struct cpufreq_policy *policy); | |
320 | ||
90452e61 | 321 | struct freq_attr **attr; |
6f19efc0 LM |
322 | |
323 | /* platform specific boost support code */ | |
90452e61 VK |
324 | bool boost_enabled; |
325 | int (*set_boost)(int state); | |
1da177e4 LT |
326 | }; |
327 | ||
328 | /* flags */ | |
6461f018 VK |
329 | #define CPUFREQ_STICKY (1 << 0) /* driver isn't removed even if |
330 | all ->init() calls failed */ | |
331 | #define CPUFREQ_CONST_LOOPS (1 << 1) /* loops_per_jiffy or other | |
332 | kernel "constants" aren't | |
333 | affected by frequency | |
334 | transitions */ | |
335 | #define CPUFREQ_PM_NO_WARN (1 << 2) /* don't warn on suspend/resume | |
336 | speed mismatches */ | |
1da177e4 | 337 | |
0b981e70 VK |
338 | /* |
339 | * This should be set by platforms having multiple clock-domains, i.e. | |
340 | * supporting multiple policies. With this sysfs directories of governor would | |
341 | * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same | |
342 | * governor with different tunables for different clusters. | |
343 | */ | |
344 | #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3) | |
345 | ||
7dbf694d VK |
346 | /* |
347 | * Driver will do POSTCHANGE notifications from outside of their ->target() | |
348 | * routine and so must set cpufreq_driver->flags with this flag, so that core | |
349 | * can handle them specially. | |
350 | */ | |
351 | #define CPUFREQ_ASYNC_NOTIFICATION (1 << 4) | |
352 | ||
ae6b4271 VK |
353 | /* |
354 | * Set by drivers which want cpufreq core to check if CPU is running at a | |
355 | * frequency present in freq-table exposed by the driver. For these drivers if | |
356 | * CPU is found running at an out of table freq, we will try to set it to a freq | |
357 | * from the table. And if that fails, we will stop further boot process by | |
358 | * issuing a BUG_ON(). | |
359 | */ | |
360 | #define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5) | |
361 | ||
221dee28 LT |
362 | int cpufreq_register_driver(struct cpufreq_driver *driver_data); |
363 | int cpufreq_unregister_driver(struct cpufreq_driver *driver_data); | |
1da177e4 | 364 | |
74aca95d | 365 | const char *cpufreq_get_current_driver(void); |
51315cdf | 366 | void *cpufreq_get_driver_data(void); |
1da177e4 | 367 | |
bb176f7d VK |
368 | static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy, |
369 | unsigned int min, unsigned int max) | |
1da177e4 LT |
370 | { |
371 | if (policy->min < min) | |
372 | policy->min = min; | |
373 | if (policy->max < min) | |
374 | policy->max = min; | |
375 | if (policy->min > max) | |
376 | policy->min = max; | |
377 | if (policy->max > max) | |
378 | policy->max = max; | |
379 | if (policy->min > policy->max) | |
380 | policy->min = policy->max; | |
381 | return; | |
382 | } | |
383 | ||
be49e346 VK |
384 | static inline void |
385 | cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy) | |
386 | { | |
387 | cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq, | |
388 | policy->cpuinfo.max_freq); | |
389 | } | |
390 | ||
2f0aea93 VK |
391 | #ifdef CONFIG_CPU_FREQ |
392 | void cpufreq_suspend(void); | |
393 | void cpufreq_resume(void); | |
e28867ea | 394 | int cpufreq_generic_suspend(struct cpufreq_policy *policy); |
2f0aea93 VK |
395 | #else |
396 | static inline void cpufreq_suspend(void) {} | |
397 | static inline void cpufreq_resume(void) {} | |
398 | #endif | |
399 | ||
74aca95d VK |
400 | /********************************************************************* |
401 | * CPUFREQ NOTIFIER INTERFACE * | |
402 | *********************************************************************/ | |
6dad2a29 | 403 | |
74aca95d VK |
404 | #define CPUFREQ_TRANSITION_NOTIFIER (0) |
405 | #define CPUFREQ_POLICY_NOTIFIER (1) | |
1da177e4 | 406 | |
74aca95d VK |
407 | /* Transition notifiers */ |
408 | #define CPUFREQ_PRECHANGE (0) | |
409 | #define CPUFREQ_POSTCHANGE (1) | |
6dad2a29 | 410 | |
74aca95d VK |
411 | /* Policy Notifiers */ |
412 | #define CPUFREQ_ADJUST (0) | |
6bfb7c74 VK |
413 | #define CPUFREQ_NOTIFY (1) |
414 | #define CPUFREQ_START (2) | |
415 | #define CPUFREQ_CREATE_POLICY (3) | |
416 | #define CPUFREQ_REMOVE_POLICY (4) | |
6dad2a29 | 417 | |
74aca95d VK |
418 | #ifdef CONFIG_CPU_FREQ |
419 | int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list); | |
420 | int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list); | |
6dad2a29 | 421 | |
12478cf0 SB |
422 | void cpufreq_freq_transition_begin(struct cpufreq_policy *policy, |
423 | struct cpufreq_freqs *freqs); | |
424 | void cpufreq_freq_transition_end(struct cpufreq_policy *policy, | |
425 | struct cpufreq_freqs *freqs, int transition_failed); | |
1da177e4 | 426 | |
74aca95d VK |
427 | #else /* CONFIG_CPU_FREQ */ |
428 | static inline int cpufreq_register_notifier(struct notifier_block *nb, | |
429 | unsigned int list) | |
2eca40a8 RD |
430 | { |
431 | return 0; | |
432 | } | |
74aca95d VK |
433 | static inline int cpufreq_unregister_notifier(struct notifier_block *nb, |
434 | unsigned int list) | |
95235ca2 VP |
435 | { |
436 | return 0; | |
437 | } | |
74aca95d VK |
438 | #endif /* !CONFIG_CPU_FREQ */ |
439 | ||
440 | /** | |
441 | * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch | |
442 | * safe) | |
443 | * @old: old value | |
444 | * @div: divisor | |
445 | * @mult: multiplier | |
446 | * | |
447 | * | |
448 | * new = old * mult / div | |
449 | */ | |
450 | static inline unsigned long cpufreq_scale(unsigned long old, u_int div, | |
451 | u_int mult) | |
3d737108 | 452 | { |
74aca95d VK |
453 | #if BITS_PER_LONG == 32 |
454 | u64 result = ((u64) old) * ((u64) mult); | |
455 | do_div(result, div); | |
456 | return (unsigned long) result; | |
457 | ||
458 | #elif BITS_PER_LONG == 64 | |
459 | unsigned long result = old * ((u64) mult); | |
460 | result /= div; | |
461 | return result; | |
95235ca2 | 462 | #endif |
74aca95d | 463 | } |
95235ca2 | 464 | |
1da177e4 | 465 | /********************************************************************* |
74aca95d | 466 | * CPUFREQ GOVERNORS * |
1da177e4 LT |
467 | *********************************************************************/ |
468 | ||
74aca95d VK |
469 | /* |
470 | * If (cpufreq_driver->target) exists, the ->governor decides what frequency | |
471 | * within the limits is used. If (cpufreq_driver->setpolicy> exists, these | |
472 | * two generic policies are available: | |
473 | */ | |
474 | #define CPUFREQ_POLICY_POWERSAVE (1) | |
475 | #define CPUFREQ_POLICY_PERFORMANCE (2) | |
476 | ||
379480d8 RW |
477 | /* |
478 | * The polling frequency depends on the capability of the processor. Default | |
479 | * polling frequency is 1000 times the transition latency of the processor. The | |
480 | * ondemand governor will work on any processor with transition latency <= 10ms, | |
481 | * using appropriate sampling rate. | |
482 | * | |
483 | * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL) | |
484 | * the ondemand governor will not work. All times here are in us (microseconds). | |
485 | */ | |
486 | #define MIN_SAMPLING_RATE_RATIO (2) | |
487 | #define LATENCY_MULTIPLIER (1000) | |
488 | #define MIN_LATENCY_MULTIPLIER (20) | |
489 | #define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000) | |
490 | ||
74aca95d VK |
491 | struct cpufreq_governor { |
492 | char name[CPUFREQ_NAME_LEN]; | |
e788892b RW |
493 | int (*init)(struct cpufreq_policy *policy); |
494 | void (*exit)(struct cpufreq_policy *policy); | |
495 | int (*start)(struct cpufreq_policy *policy); | |
496 | void (*stop)(struct cpufreq_policy *policy); | |
497 | void (*limits)(struct cpufreq_policy *policy); | |
74aca95d VK |
498 | ssize_t (*show_setspeed) (struct cpufreq_policy *policy, |
499 | char *buf); | |
500 | int (*store_setspeed) (struct cpufreq_policy *policy, | |
501 | unsigned int freq); | |
502 | unsigned int max_transition_latency; /* HW must be able to switch to | |
503 | next freq faster than this value in nano secs or we | |
504 | will fallback to performance governor */ | |
505 | struct list_head governor_list; | |
506 | struct module *owner; | |
507 | }; | |
508 | ||
509 | /* Pass a target to the cpufreq driver */ | |
b7898fda RW |
510 | unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy, |
511 | unsigned int target_freq); | |
74aca95d VK |
512 | int cpufreq_driver_target(struct cpufreq_policy *policy, |
513 | unsigned int target_freq, | |
514 | unsigned int relation); | |
515 | int __cpufreq_driver_target(struct cpufreq_policy *policy, | |
516 | unsigned int target_freq, | |
517 | unsigned int relation); | |
e3c06236 SM |
518 | unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy, |
519 | unsigned int target_freq); | |
74aca95d VK |
520 | int cpufreq_register_governor(struct cpufreq_governor *governor); |
521 | void cpufreq_unregister_governor(struct cpufreq_governor *governor); | |
522 | ||
de1df26b RW |
523 | struct cpufreq_governor *cpufreq_default_governor(void); |
524 | struct cpufreq_governor *cpufreq_fallback_governor(void); | |
1da177e4 | 525 | |
bf2be2de VK |
526 | static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy) |
527 | { | |
528 | if (policy->max < policy->cur) | |
529 | __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H); | |
530 | else if (policy->min > policy->cur) | |
531 | __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L); | |
532 | } | |
533 | ||
66893b6a RW |
534 | /* Governor attribute set */ |
535 | struct gov_attr_set { | |
536 | struct kobject kobj; | |
537 | struct list_head policy_list; | |
538 | struct mutex update_lock; | |
539 | int usage_count; | |
540 | }; | |
541 | ||
542 | /* sysfs ops for cpufreq governors */ | |
543 | extern const struct sysfs_ops governor_sysfs_ops; | |
544 | ||
545 | void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node); | |
546 | void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node); | |
547 | unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node); | |
548 | ||
549 | /* Governor sysfs attribute */ | |
550 | struct governor_attr { | |
551 | struct attribute attr; | |
552 | ssize_t (*show)(struct gov_attr_set *attr_set, char *buf); | |
553 | ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf, | |
554 | size_t count); | |
555 | }; | |
556 | ||
1da177e4 LT |
557 | /********************************************************************* |
558 | * FREQUENCY TABLE HELPERS * | |
559 | *********************************************************************/ | |
560 | ||
7f4b0461 | 561 | /* Special Values of .frequency field */ |
2b1987a9 BH |
562 | #define CPUFREQ_ENTRY_INVALID ~0u |
563 | #define CPUFREQ_TABLE_END ~1u | |
7f4b0461 VK |
564 | /* Special Values of .flags field */ |
565 | #define CPUFREQ_BOOST_FREQ (1 << 0) | |
1da177e4 LT |
566 | |
567 | struct cpufreq_frequency_table { | |
7f4b0461 | 568 | unsigned int flags; |
50701588 | 569 | unsigned int driver_data; /* driver specific data, not used by core */ |
1da177e4 LT |
570 | unsigned int frequency; /* kHz - doesn't need to be in ascending |
571 | * order */ | |
572 | }; | |
573 | ||
a0dd7b79 NM |
574 | #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP) |
575 | int dev_pm_opp_init_cpufreq_table(struct device *dev, | |
576 | struct cpufreq_frequency_table **table); | |
577 | void dev_pm_opp_free_cpufreq_table(struct device *dev, | |
578 | struct cpufreq_frequency_table **table); | |
579 | #else | |
580 | static inline int dev_pm_opp_init_cpufreq_table(struct device *dev, | |
581 | struct cpufreq_frequency_table | |
582 | **table) | |
583 | { | |
584 | return -EINVAL; | |
585 | } | |
586 | ||
587 | static inline void dev_pm_opp_free_cpufreq_table(struct device *dev, | |
588 | struct cpufreq_frequency_table | |
589 | **table) | |
590 | { | |
591 | } | |
592 | #endif | |
593 | ||
27e289dc SK |
594 | /* |
595 | * cpufreq_for_each_entry - iterate over a cpufreq_frequency_table | |
596 | * @pos: the cpufreq_frequency_table * to use as a loop cursor. | |
597 | * @table: the cpufreq_frequency_table * to iterate over. | |
598 | */ | |
599 | ||
600 | #define cpufreq_for_each_entry(pos, table) \ | |
601 | for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) | |
602 | ||
603 | /* | |
604 | * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table | |
605 | * excluding CPUFREQ_ENTRY_INVALID frequencies. | |
606 | * @pos: the cpufreq_frequency_table * to use as a loop cursor. | |
607 | * @table: the cpufreq_frequency_table * to iterate over. | |
608 | */ | |
609 | ||
34b08705 RW |
610 | #define cpufreq_for_each_valid_entry(pos, table) \ |
611 | for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) \ | |
612 | if (pos->frequency == CPUFREQ_ENTRY_INVALID) \ | |
613 | continue; \ | |
614 | else | |
27e289dc | 615 | |
1da177e4 LT |
616 | int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy, |
617 | struct cpufreq_frequency_table *table); | |
618 | ||
619 | int cpufreq_frequency_table_verify(struct cpufreq_policy *policy, | |
620 | struct cpufreq_frequency_table *table); | |
18434512 | 621 | int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy); |
1da177e4 | 622 | |
da0c6dc0 VK |
623 | int cpufreq_table_index_unsorted(struct cpufreq_policy *policy, |
624 | unsigned int target_freq, | |
625 | unsigned int relation); | |
d3916691 VK |
626 | int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy, |
627 | unsigned int freq); | |
1da177e4 | 628 | |
74aca95d VK |
629 | ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf); |
630 | ||
6f19efc0 LM |
631 | #ifdef CONFIG_CPU_FREQ |
632 | int cpufreq_boost_trigger_state(int state); | |
6f19efc0 | 633 | int cpufreq_boost_enabled(void); |
44139ed4 VK |
634 | int cpufreq_enable_boost_support(void); |
635 | bool policy_has_boost_freq(struct cpufreq_policy *policy); | |
da0c6dc0 VK |
636 | |
637 | /* Find lowest freq at or above target in a table in ascending order */ | |
638 | static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy, | |
639 | unsigned int target_freq) | |
640 | { | |
641 | struct cpufreq_frequency_table *table = policy->freq_table; | |
642 | unsigned int freq; | |
643 | int i, best = -1; | |
644 | ||
645 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
646 | freq = table[i].frequency; | |
647 | ||
648 | if (freq >= target_freq) | |
649 | return i; | |
650 | ||
651 | best = i; | |
652 | } | |
653 | ||
654 | return best; | |
655 | } | |
656 | ||
657 | /* Find lowest freq at or above target in a table in descending order */ | |
658 | static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy, | |
659 | unsigned int target_freq) | |
660 | { | |
661 | struct cpufreq_frequency_table *table = policy->freq_table; | |
662 | unsigned int freq; | |
663 | int i, best = -1; | |
664 | ||
665 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
666 | freq = table[i].frequency; | |
667 | ||
668 | if (freq == target_freq) | |
669 | return i; | |
670 | ||
671 | if (freq > target_freq) { | |
672 | best = i; | |
673 | continue; | |
674 | } | |
675 | ||
676 | /* No freq found above target_freq */ | |
677 | if (best == -1) | |
678 | return i; | |
679 | ||
680 | return best; | |
681 | } | |
682 | ||
683 | return best; | |
684 | } | |
685 | ||
686 | /* Works only on sorted freq-tables */ | |
687 | static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy, | |
688 | unsigned int target_freq) | |
689 | { | |
690 | target_freq = clamp_val(target_freq, policy->min, policy->max); | |
691 | ||
692 | if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING) | |
693 | return cpufreq_table_find_index_al(policy, target_freq); | |
694 | else | |
695 | return cpufreq_table_find_index_dl(policy, target_freq); | |
696 | } | |
697 | ||
698 | /* Find highest freq at or below target in a table in ascending order */ | |
699 | static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy, | |
700 | unsigned int target_freq) | |
701 | { | |
702 | struct cpufreq_frequency_table *table = policy->freq_table; | |
703 | unsigned int freq; | |
704 | int i, best = -1; | |
705 | ||
706 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
707 | freq = table[i].frequency; | |
708 | ||
709 | if (freq == target_freq) | |
710 | return i; | |
711 | ||
712 | if (freq < target_freq) { | |
713 | best = i; | |
714 | continue; | |
715 | } | |
716 | ||
717 | /* No freq found below target_freq */ | |
718 | if (best == -1) | |
719 | return i; | |
720 | ||
721 | return best; | |
722 | } | |
723 | ||
724 | return best; | |
725 | } | |
726 | ||
727 | /* Find highest freq at or below target in a table in descending order */ | |
728 | static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy, | |
729 | unsigned int target_freq) | |
730 | { | |
731 | struct cpufreq_frequency_table *table = policy->freq_table; | |
732 | unsigned int freq; | |
733 | int i, best = -1; | |
734 | ||
735 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
736 | freq = table[i].frequency; | |
737 | ||
738 | if (freq <= target_freq) | |
739 | return i; | |
740 | ||
741 | best = i; | |
742 | } | |
743 | ||
744 | return best; | |
745 | } | |
746 | ||
747 | /* Works only on sorted freq-tables */ | |
748 | static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy, | |
749 | unsigned int target_freq) | |
750 | { | |
751 | target_freq = clamp_val(target_freq, policy->min, policy->max); | |
752 | ||
753 | if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING) | |
754 | return cpufreq_table_find_index_ah(policy, target_freq); | |
755 | else | |
756 | return cpufreq_table_find_index_dh(policy, target_freq); | |
757 | } | |
758 | ||
759 | /* Find closest freq to target in a table in ascending order */ | |
760 | static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy, | |
761 | unsigned int target_freq) | |
762 | { | |
763 | struct cpufreq_frequency_table *table = policy->freq_table; | |
764 | unsigned int freq; | |
765 | int i, best = -1; | |
766 | ||
767 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
768 | freq = table[i].frequency; | |
769 | ||
770 | if (freq == target_freq) | |
771 | return i; | |
772 | ||
773 | if (freq < target_freq) { | |
774 | best = i; | |
775 | continue; | |
776 | } | |
777 | ||
778 | /* No freq found below target_freq */ | |
779 | if (best == -1) | |
780 | return i; | |
781 | ||
782 | /* Choose the closest freq */ | |
783 | if (target_freq - table[best].frequency > freq - target_freq) | |
784 | return i; | |
785 | ||
786 | return best; | |
787 | } | |
788 | ||
789 | return best; | |
790 | } | |
791 | ||
792 | /* Find closest freq to target in a table in descending order */ | |
793 | static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy, | |
794 | unsigned int target_freq) | |
795 | { | |
796 | struct cpufreq_frequency_table *table = policy->freq_table; | |
797 | unsigned int freq; | |
798 | int i, best = -1; | |
799 | ||
800 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
801 | freq = table[i].frequency; | |
802 | ||
803 | if (freq == target_freq) | |
804 | return i; | |
805 | ||
806 | if (freq > target_freq) { | |
807 | best = i; | |
808 | continue; | |
809 | } | |
810 | ||
811 | /* No freq found above target_freq */ | |
812 | if (best == -1) | |
813 | return i; | |
814 | ||
815 | /* Choose the closest freq */ | |
816 | if (table[best].frequency - target_freq > target_freq - freq) | |
817 | return i; | |
818 | ||
819 | return best; | |
820 | } | |
821 | ||
822 | return best; | |
823 | } | |
824 | ||
825 | /* Works only on sorted freq-tables */ | |
826 | static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy, | |
827 | unsigned int target_freq) | |
828 | { | |
829 | target_freq = clamp_val(target_freq, policy->min, policy->max); | |
830 | ||
831 | if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING) | |
832 | return cpufreq_table_find_index_ac(policy, target_freq); | |
833 | else | |
834 | return cpufreq_table_find_index_dc(policy, target_freq); | |
835 | } | |
836 | ||
837 | static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy, | |
838 | unsigned int target_freq, | |
839 | unsigned int relation) | |
840 | { | |
841 | if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED)) | |
842 | return cpufreq_table_index_unsorted(policy, target_freq, | |
843 | relation); | |
844 | ||
845 | switch (relation) { | |
846 | case CPUFREQ_RELATION_L: | |
847 | return cpufreq_table_find_index_l(policy, target_freq); | |
848 | case CPUFREQ_RELATION_H: | |
849 | return cpufreq_table_find_index_h(policy, target_freq); | |
850 | case CPUFREQ_RELATION_C: | |
851 | return cpufreq_table_find_index_c(policy, target_freq); | |
852 | default: | |
853 | pr_err("%s: Invalid relation: %d\n", __func__, relation); | |
854 | return -EINVAL; | |
855 | } | |
856 | } | |
6f19efc0 LM |
857 | #else |
858 | static inline int cpufreq_boost_trigger_state(int state) | |
859 | { | |
860 | return 0; | |
861 | } | |
6f19efc0 LM |
862 | static inline int cpufreq_boost_enabled(void) |
863 | { | |
864 | return 0; | |
865 | } | |
44139ed4 VK |
866 | |
867 | static inline int cpufreq_enable_boost_support(void) | |
868 | { | |
869 | return -EINVAL; | |
870 | } | |
871 | ||
872 | static inline bool policy_has_boost_freq(struct cpufreq_policy *policy) | |
873 | { | |
874 | return false; | |
875 | } | |
6f19efc0 | 876 | #endif |
1da177e4 LT |
877 | |
878 | /* the following are really really optional */ | |
879 | extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs; | |
21c36d35 | 880 | extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs; |
18434512 | 881 | extern struct freq_attr *cpufreq_generic_attr[]; |
27047a60 VK |
882 | int cpufreq_table_validate_and_show(struct cpufreq_policy *policy, |
883 | struct cpufreq_frequency_table *table); | |
f4fd3797 | 884 | |
652ed95d | 885 | unsigned int cpufreq_generic_get(unsigned int cpu); |
70e9e778 VK |
886 | int cpufreq_generic_init(struct cpufreq_policy *policy, |
887 | struct cpufreq_frequency_table *table, | |
888 | unsigned int transition_latency); | |
1da177e4 | 889 | #endif /* _LINUX_CPUFREQ_H */ |