1 /*
2 * linux/include/linux/cpufreq.h
3 *
4 * Copyright (C) 2001 Russell King
5 * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
6 *
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
14 #include <linux/clk.h>
15 #include <linux/cpumask.h>
16 #include <linux/completion.h>
17 #include <linux/kobject.h>
18 #include <linux/notifier.h>
19 #include <linux/spinlock.h>
20 #include <linux/sysfs.h>
21
22 /*********************************************************************
23 * CPUFREQ INTERFACE *
24 *********************************************************************/
25 /*
26 * Frequency values here are CPU kHz
27 *
28 * Maximum transition latency is in nanoseconds - if it's unknown,
29 * CPUFREQ_ETERNAL shall be used.
30 */
31
32 #define CPUFREQ_ETERNAL (-1)
33 #define CPUFREQ_NAME_LEN 16
34 /* Print length for names. Extra 1 space for accommodating '\n' in prints */
35 #define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1)
36
37 struct cpufreq_governor;
38
39 enum cpufreq_table_sorting {
40 CPUFREQ_TABLE_UNSORTED,
41 CPUFREQ_TABLE_SORTED_ASCENDING,
42 CPUFREQ_TABLE_SORTED_DESCENDING
43 };
44
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 };
51
52 struct cpufreq_cpuinfo {
53 unsigned int max_freq;
54 unsigned int min_freq;
55
56 /* in 10^(-9) s = nanoseconds */
57 unsigned int transition_latency;
58 };
59
60 struct cpufreq_user_policy {
61 unsigned int min; /* in kHz */
62 unsigned int max; /* in kHz */
63 };
64
65 struct cpufreq_policy {
66 /* CPUs sharing clock, require sw coordination */
67 cpumask_var_t cpus; /* Online CPUs only */
68 cpumask_var_t related_cpus; /* Online + Offline CPUs */
69 cpumask_var_t real_cpus; /* Related and present */
70
71 unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs
72 should set cpufreq */
73 unsigned int cpu; /* cpu managing this policy, must be online */
74
75 struct clk *clk;
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 */
82 unsigned int restore_freq; /* = policy->cur before transition */
83 unsigned int suspend_freq; /* freq to set during suspend */
84
85 unsigned int policy; /* see above */
86 unsigned int last_policy; /* policy before unplug */
87 struct cpufreq_governor *governor; /* see below */
88 void *governor_data;
89 char last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
90
91 struct work_struct update; /* if update_policy() needs to be
92 * called, but you're in IRQ context */
93
94 struct cpufreq_user_policy user_policy;
95 struct cpufreq_frequency_table *freq_table;
96 enum cpufreq_table_sorting freq_table_sorted;
97
98 struct list_head policy_list;
99 struct kobject kobj;
100 struct completion kobj_unregister;
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.
109 */
110 struct rw_semaphore rwsem;
111
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 * frequency switching with the help of cpufreq_enable_fast_switch().
119 */
120 bool fast_switch_possible;
121 bool fast_switch_enabled;
122
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
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
139 /* Cached frequency lookup from cpufreq_driver_resolve_freq. */
140 unsigned int cached_target_freq;
141 int cached_resolved_idx;
142
143 /* Synchronization for frequency transitions */
144 bool transition_ongoing; /* Tracks transition status */
145 spinlock_t transition_lock;
146 wait_queue_head_t transition_wait;
147 struct task_struct *transition_task; /* Task which is doing the transition */
148
149 /* cpufreq-stats */
150 struct cpufreq_stats *stats;
151
152 /* For cpufreq driver's internal use */
153 void *driver_data;
154 };
155
156 /* Only for ACPI */
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*/
161
162 #ifdef CONFIG_CPU_FREQ
163 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
164 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
165 void cpufreq_cpu_put(struct cpufreq_policy *policy);
166 #else
cpufreq_cpu_get_raw(unsigned int cpu)167 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
168 {
169 return NULL;
170 }
cpufreq_cpu_get(unsigned int cpu)171 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
172 {
173 return NULL;
174 }
cpufreq_cpu_put(struct cpufreq_policy * policy)175 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
176 #endif
177
policy_is_shared(struct cpufreq_policy * policy)178 static inline bool policy_is_shared(struct cpufreq_policy *policy)
179 {
180 return cpumask_weight(policy->cpus) > 1;
181 }
182
183 /* /sys/devices/system/cpu/cpufreq: entry point for global variables */
184 extern struct kobject *cpufreq_global_kobject;
185
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);
191
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);
194 void cpufreq_update_policy(unsigned int cpu);
195 bool have_governor_per_policy(void);
196 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
197 void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
198 void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
199 #else
cpufreq_get(unsigned int cpu)200 static inline unsigned int cpufreq_get(unsigned int cpu)
201 {
202 return 0;
203 }
cpufreq_quick_get(unsigned int cpu)204 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
205 {
206 return 0;
207 }
cpufreq_quick_get_max(unsigned int cpu)208 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
209 {
210 return 0;
211 }
disable_cpufreq(void)212 static inline void disable_cpufreq(void) { }
213 #endif
214
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
cpufreq_stats_create_table(struct cpufreq_policy * policy)221 static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
cpufreq_stats_free_table(struct cpufreq_policy * policy)222 static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
cpufreq_stats_record_transition(struct cpufreq_policy * policy,unsigned int new_freq)223 static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
224 unsigned int new_freq) { }
225 #endif /* CONFIG_CPU_FREQ_STAT */
226
227 /*********************************************************************
228 * CPUFREQ DRIVER INTERFACE *
229 *********************************************************************/
230
231 #define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
232 #define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
233 #define CPUFREQ_RELATION_C 2 /* closest frequency to target */
234
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);
239 };
240
241 #define cpufreq_freq_attr_ro(_name) \
242 static struct freq_attr _name = \
243 __ATTR(_name, 0444, show_##_name, NULL)
244
245 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
246 static struct freq_attr _name = \
247 __ATTR(_name, _perm, show_##_name, NULL)
248
249 #define cpufreq_freq_attr_rw(_name) \
250 static struct freq_attr _name = \
251 __ATTR(_name, 0644, show_##_name, store_##_name)
252
253 #define cpufreq_freq_attr_wo(_name) \
254 static struct freq_attr _name = \
255 __ATTR(_name, 0200, NULL, store_##_name)
256
257 #define define_one_global_ro(_name) \
258 static struct kobj_attribute _name = \
259 __ATTR(_name, 0444, show_##_name, NULL)
260
261 #define define_one_global_rw(_name) \
262 static struct kobj_attribute _name = \
263 __ATTR(_name, 0644, show_##_name, store_##_name)
264
265
266 struct cpufreq_driver {
267 char name[CPUFREQ_NAME_LEN];
268 u8 flags;
269 void *driver_data;
270
271 /* needed by all drivers */
272 int (*init)(struct cpufreq_policy *policy);
273 int (*verify)(struct cpufreq_policy *policy);
274
275 /* define one out of two */
276 int (*setpolicy)(struct cpufreq_policy *policy);
277
278 /*
279 * On failure, should always restore frequency to policy->restore_freq
280 * (i.e. old freq).
281 */
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);
287 unsigned int (*fast_switch)(struct cpufreq_policy *policy,
288 unsigned int target_freq);
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
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 */
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);
318
319 /* should be defined, if possible */
320 unsigned int (*get)(unsigned int cpu);
321
322 /* optional */
323 int (*bios_limit)(int cpu, unsigned int *limit);
324
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);
329
330 /* Will be called after the driver is fully initialized */
331 void (*ready)(struct cpufreq_policy *policy);
332
333 struct freq_attr **attr;
334
335 /* platform specific boost support code */
336 bool boost_enabled;
337 int (*set_boost)(int state);
338 };
339
340 /* flags */
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 */
349
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
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
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
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
380 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
381 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
382
383 const char *cpufreq_get_current_driver(void);
384 void *cpufreq_get_driver_data(void);
385
cpufreq_verify_within_limits(struct cpufreq_policy * policy,unsigned int min,unsigned int max)386 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
387 unsigned int min, unsigned int max)
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
402 static inline void
cpufreq_verify_within_cpu_limits(struct cpufreq_policy * policy)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
409 #ifdef CONFIG_CPU_FREQ
410 void cpufreq_suspend(void);
411 void cpufreq_resume(void);
412 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
413 #else
cpufreq_suspend(void)414 static inline void cpufreq_suspend(void) {}
cpufreq_resume(void)415 static inline void cpufreq_resume(void) {}
416 #endif
417
418 /*********************************************************************
419 * CPUFREQ NOTIFIER INTERFACE *
420 *********************************************************************/
421
422 #define CPUFREQ_TRANSITION_NOTIFIER (0)
423 #define CPUFREQ_POLICY_NOTIFIER (1)
424
425 /* Transition notifiers */
426 #define CPUFREQ_PRECHANGE (0)
427 #define CPUFREQ_POSTCHANGE (1)
428
429 /* Policy Notifiers */
430 #define CPUFREQ_ADJUST (0)
431 #define CPUFREQ_NOTIFY (1)
432
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);
436
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);
441
442 #else /* CONFIG_CPU_FREQ */
cpufreq_register_notifier(struct notifier_block * nb,unsigned int list)443 static inline int cpufreq_register_notifier(struct notifier_block *nb,
444 unsigned int list)
445 {
446 return 0;
447 }
cpufreq_unregister_notifier(struct notifier_block * nb,unsigned int list)448 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
449 unsigned int list)
450 {
451 return 0;
452 }
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 */
cpufreq_scale(unsigned long old,u_int div,u_int mult)465 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
466 u_int mult)
467 {
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;
477 #endif
478 }
479
480 /*********************************************************************
481 * CPUFREQ GOVERNORS *
482 *********************************************************************/
483
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
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.
497 */
498 #define LATENCY_MULTIPLIER (1000)
499
500 struct cpufreq_governor {
501 char name[CPUFREQ_NAME_LEN];
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);
507 ssize_t (*show_setspeed) (struct cpufreq_policy *policy,
508 char *buf);
509 int (*store_setspeed) (struct cpufreq_policy *policy,
510 unsigned int freq);
511 /* For governors which change frequency dynamically by themselves */
512 bool dynamic_switching;
513 struct list_head governor_list;
514 struct module *owner;
515 };
516
517 /* Pass a target to the cpufreq driver */
518 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
519 unsigned int target_freq);
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);
526 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
527 unsigned int target_freq);
528 unsigned int cpufreq_policy_transition_delay_us(struct cpufreq_policy *policy);
529 int cpufreq_register_governor(struct cpufreq_governor *governor);
530 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
531
532 struct cpufreq_governor *cpufreq_default_governor(void);
533 struct cpufreq_governor *cpufreq_fallback_governor(void);
534
cpufreq_policy_apply_limits(struct cpufreq_policy * policy)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
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
566 /*********************************************************************
567 * FREQUENCY TABLE HELPERS *
568 *********************************************************************/
569
570 /* Special Values of .frequency field */
571 #define CPUFREQ_ENTRY_INVALID ~0u
572 #define CPUFREQ_TABLE_END ~1u
573 /* Special Values of .flags field */
574 #define CPUFREQ_BOOST_FREQ (1 << 0)
575
576 struct cpufreq_frequency_table {
577 unsigned int flags;
578 unsigned int driver_data; /* driver specific data, not used by core */
579 unsigned int frequency; /* kHz - doesn't need to be in ascending
580 * order */
581 };
582
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
dev_pm_opp_init_cpufreq_table(struct device * dev,struct cpufreq_frequency_table ** table)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
dev_pm_opp_free_cpufreq_table(struct device * dev,struct cpufreq_frequency_table ** table)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
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_entry_idx - iterate over a cpufreq_frequency_table
614 * with index
615 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
616 * @table: the cpufreq_frequency_table * to iterate over.
617 * @idx: the table entry currently being processed
618 */
619
620 #define cpufreq_for_each_entry_idx(pos, table, idx) \
621 for (pos = table, idx = 0; pos->frequency != CPUFREQ_TABLE_END; \
622 pos++, idx++)
623
624 /*
625 * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table
626 * excluding CPUFREQ_ENTRY_INVALID frequencies.
627 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
628 * @table: the cpufreq_frequency_table * to iterate over.
629 */
630
631 #define cpufreq_for_each_valid_entry(pos, table) \
632 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) \
633 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \
634 continue; \
635 else
636
637 /*
638 * cpufreq_for_each_valid_entry_idx - iterate with index over a cpufreq
639 * frequency_table excluding CPUFREQ_ENTRY_INVALID frequencies.
640 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
641 * @table: the cpufreq_frequency_table * to iterate over.
642 * @idx: the table entry currently being processed
643 */
644
645 #define cpufreq_for_each_valid_entry_idx(pos, table, idx) \
646 cpufreq_for_each_entry_idx(pos, table, idx) \
647 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \
648 continue; \
649 else
650
651
652 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
653 struct cpufreq_frequency_table *table);
654
655 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
656 struct cpufreq_frequency_table *table);
657 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
658
659 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
660 unsigned int target_freq,
661 unsigned int relation);
662 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
663 unsigned int freq);
664
665 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
666
667 #ifdef CONFIG_CPU_FREQ
668 int cpufreq_boost_trigger_state(int state);
669 int cpufreq_boost_enabled(void);
670 int cpufreq_enable_boost_support(void);
671 bool policy_has_boost_freq(struct cpufreq_policy *policy);
672
673 /* Find lowest freq at or above target in a table in ascending order */
cpufreq_table_find_index_al(struct cpufreq_policy * policy,unsigned int target_freq)674 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
675 unsigned int target_freq)
676 {
677 struct cpufreq_frequency_table *table = policy->freq_table;
678 struct cpufreq_frequency_table *pos;
679 unsigned int freq;
680 int idx, best = -1;
681
682 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
683 freq = pos->frequency;
684
685 if (freq >= target_freq)
686 return idx;
687
688 best = idx;
689 }
690
691 return best;
692 }
693
694 /* Find lowest freq at or above target in a table in descending order */
cpufreq_table_find_index_dl(struct cpufreq_policy * policy,unsigned int target_freq)695 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
696 unsigned int target_freq)
697 {
698 struct cpufreq_frequency_table *table = policy->freq_table;
699 struct cpufreq_frequency_table *pos;
700 unsigned int freq;
701 int idx, best = -1;
702
703 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
704 freq = pos->frequency;
705
706 if (freq == target_freq)
707 return idx;
708
709 if (freq > target_freq) {
710 best = idx;
711 continue;
712 }
713
714 /* No freq found above target_freq */
715 if (best == -1)
716 return idx;
717
718 return best;
719 }
720
721 return best;
722 }
723
724 /* Works only on sorted freq-tables */
cpufreq_table_find_index_l(struct cpufreq_policy * policy,unsigned int target_freq)725 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
726 unsigned int target_freq)
727 {
728 target_freq = clamp_val(target_freq, policy->min, policy->max);
729
730 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
731 return cpufreq_table_find_index_al(policy, target_freq);
732 else
733 return cpufreq_table_find_index_dl(policy, target_freq);
734 }
735
736 /* Find highest freq at or below target in a table in ascending order */
cpufreq_table_find_index_ah(struct cpufreq_policy * policy,unsigned int target_freq)737 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
738 unsigned int target_freq)
739 {
740 struct cpufreq_frequency_table *table = policy->freq_table;
741 struct cpufreq_frequency_table *pos;
742 unsigned int freq;
743 int idx, best = -1;
744
745 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
746 freq = pos->frequency;
747
748 if (freq == target_freq)
749 return idx;
750
751 if (freq < target_freq) {
752 best = idx;
753 continue;
754 }
755
756 /* No freq found below target_freq */
757 if (best == -1)
758 return idx;
759
760 return best;
761 }
762
763 return best;
764 }
765
766 /* Find highest freq at or below target in a table in descending order */
cpufreq_table_find_index_dh(struct cpufreq_policy * policy,unsigned int target_freq)767 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
768 unsigned int target_freq)
769 {
770 struct cpufreq_frequency_table *table = policy->freq_table;
771 struct cpufreq_frequency_table *pos;
772 unsigned int freq;
773 int idx, best = -1;
774
775 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
776 freq = pos->frequency;
777
778 if (freq <= target_freq)
779 return idx;
780
781 best = idx;
782 }
783
784 return best;
785 }
786
787 /* Works only on sorted freq-tables */
cpufreq_table_find_index_h(struct cpufreq_policy * policy,unsigned int target_freq)788 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
789 unsigned int target_freq)
790 {
791 target_freq = clamp_val(target_freq, policy->min, policy->max);
792
793 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
794 return cpufreq_table_find_index_ah(policy, target_freq);
795 else
796 return cpufreq_table_find_index_dh(policy, target_freq);
797 }
798
799 /* Find closest freq to target in a table in ascending order */
cpufreq_table_find_index_ac(struct cpufreq_policy * policy,unsigned int target_freq)800 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
801 unsigned int target_freq)
802 {
803 struct cpufreq_frequency_table *table = policy->freq_table;
804 struct cpufreq_frequency_table *pos;
805 unsigned int freq;
806 int idx, best = -1;
807
808 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
809 freq = pos->frequency;
810
811 if (freq == target_freq)
812 return idx;
813
814 if (freq < target_freq) {
815 best = idx;
816 continue;
817 }
818
819 /* No freq found below target_freq */
820 if (best == -1)
821 return idx;
822
823 /* Choose the closest freq */
824 if (target_freq - table[best].frequency > freq - target_freq)
825 return idx;
826
827 return best;
828 }
829
830 return best;
831 }
832
833 /* Find closest freq to target in a table in descending order */
cpufreq_table_find_index_dc(struct cpufreq_policy * policy,unsigned int target_freq)834 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
835 unsigned int target_freq)
836 {
837 struct cpufreq_frequency_table *table = policy->freq_table;
838 struct cpufreq_frequency_table *pos;
839 unsigned int freq;
840 int idx, best = -1;
841
842 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
843 freq = pos->frequency;
844
845 if (freq == target_freq)
846 return idx;
847
848 if (freq > target_freq) {
849 best = idx;
850 continue;
851 }
852
853 /* No freq found above target_freq */
854 if (best == -1)
855 return idx;
856
857 /* Choose the closest freq */
858 if (table[best].frequency - target_freq > target_freq - freq)
859 return idx;
860
861 return best;
862 }
863
864 return best;
865 }
866
867 /* Works only on sorted freq-tables */
cpufreq_table_find_index_c(struct cpufreq_policy * policy,unsigned int target_freq)868 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
869 unsigned int target_freq)
870 {
871 target_freq = clamp_val(target_freq, policy->min, policy->max);
872
873 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
874 return cpufreq_table_find_index_ac(policy, target_freq);
875 else
876 return cpufreq_table_find_index_dc(policy, target_freq);
877 }
878
cpufreq_frequency_table_target(struct cpufreq_policy * policy,unsigned int target_freq,unsigned int relation)879 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
880 unsigned int target_freq,
881 unsigned int relation)
882 {
883 if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
884 return cpufreq_table_index_unsorted(policy, target_freq,
885 relation);
886
887 switch (relation) {
888 case CPUFREQ_RELATION_L:
889 return cpufreq_table_find_index_l(policy, target_freq);
890 case CPUFREQ_RELATION_H:
891 return cpufreq_table_find_index_h(policy, target_freq);
892 case CPUFREQ_RELATION_C:
893 return cpufreq_table_find_index_c(policy, target_freq);
894 default:
895 pr_err("%s: Invalid relation: %d\n", __func__, relation);
896 return -EINVAL;
897 }
898 }
899
cpufreq_table_count_valid_entries(const struct cpufreq_policy * policy)900 static inline int cpufreq_table_count_valid_entries(const struct cpufreq_policy *policy)
901 {
902 struct cpufreq_frequency_table *pos;
903 int count = 0;
904
905 if (unlikely(!policy->freq_table))
906 return 0;
907
908 cpufreq_for_each_valid_entry(pos, policy->freq_table)
909 count++;
910
911 return count;
912 }
913 #else
cpufreq_boost_trigger_state(int state)914 static inline int cpufreq_boost_trigger_state(int state)
915 {
916 return 0;
917 }
cpufreq_boost_enabled(void)918 static inline int cpufreq_boost_enabled(void)
919 {
920 return 0;
921 }
922
cpufreq_enable_boost_support(void)923 static inline int cpufreq_enable_boost_support(void)
924 {
925 return -EINVAL;
926 }
927
policy_has_boost_freq(struct cpufreq_policy * policy)928 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
929 {
930 return false;
931 }
932 #endif
933
934 extern void arch_freq_prepare_all(void);
935 extern unsigned int arch_freq_get_on_cpu(int cpu);
936
937 extern void arch_set_freq_scale(struct cpumask *cpus, unsigned long cur_freq,
938 unsigned long max_freq);
939
940 /* the following are really really optional */
941 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
942 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
943 extern struct freq_attr *cpufreq_generic_attr[];
944 int cpufreq_table_validate_and_sort(struct cpufreq_policy *policy);
945
946 unsigned int cpufreq_generic_get(unsigned int cpu);
947 int cpufreq_generic_init(struct cpufreq_policy *policy,
948 struct cpufreq_frequency_table *table,
949 unsigned int transition_latency);
950 #endif /* _LINUX_CPUFREQ_H */
951