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