1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * linux/include/linux/cpufreq.h
5 * Copyright (C) 2001 Russell King
6 * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
8 #ifndef _LINUX_CPUFREQ_H
9 #define _LINUX_CPUFREQ_H
11 #include <linux/clk.h>
12 #include <linux/cpu.h>
13 #include <linux/cpumask.h>
14 #include <linux/completion.h>
15 #include <linux/kobject.h>
16 #include <linux/notifier.h>
18 #include <linux/of_device.h>
19 #include <linux/pm_opp.h>
20 #include <linux/pm_qos.h>
21 #include <linux/spinlock.h>
22 #include <linux/sysfs.h>
24 /*********************************************************************
26 *********************************************************************/
28 * Frequency values here are CPU kHz
30 * Maximum transition latency is in nanoseconds - if it's unknown,
31 * CPUFREQ_ETERNAL shall be used.
34 #define CPUFREQ_ETERNAL (-1)
35 #define CPUFREQ_NAME_LEN 16
36 /* Print length for names. Extra 1 space for accommodating '\n' in prints */
37 #define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1)
39 struct cpufreq_governor;
41 enum cpufreq_table_sorting {
42 CPUFREQ_TABLE_UNSORTED,
43 CPUFREQ_TABLE_SORTED_ASCENDING,
44 CPUFREQ_TABLE_SORTED_DESCENDING
47 struct cpufreq_cpuinfo {
48 unsigned int max_freq;
49 unsigned int min_freq;
51 /* in 10^(-9) s = nanoseconds */
52 unsigned int transition_latency;
55 struct cpufreq_policy {
56 /* CPUs sharing clock, require sw coordination */
57 cpumask_var_t cpus; /* Online CPUs only */
58 cpumask_var_t related_cpus; /* Online + Offline CPUs */
59 cpumask_var_t real_cpus; /* Related and present */
61 unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs
63 unsigned int cpu; /* cpu managing this policy, must be online */
66 struct cpufreq_cpuinfo cpuinfo;/* see above */
68 unsigned int min; /* in kHz */
69 unsigned int max; /* in kHz */
70 unsigned int cur; /* in kHz, only needed if cpufreq
71 * governors are used */
72 unsigned int suspend_freq; /* freq to set during suspend */
74 unsigned int policy; /* see above */
75 unsigned int last_policy; /* policy before unplug */
76 struct cpufreq_governor *governor; /* see below */
78 char last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
80 struct work_struct update; /* if update_policy() needs to be
81 * called, but you're in IRQ context */
83 struct freq_constraints constraints;
84 struct freq_qos_request *min_freq_req;
85 struct freq_qos_request *max_freq_req;
87 struct cpufreq_frequency_table *freq_table;
88 enum cpufreq_table_sorting freq_table_sorted;
90 struct list_head policy_list;
92 struct completion kobj_unregister;
95 * The rules for this semaphore:
96 * - Any routine that wants to read from the policy structure will
97 * do a down_read on this semaphore.
98 * - Any routine that will write to the policy structure and/or may take away
99 * the policy altogether (eg. CPU hotplug), will hold this lock in write
100 * mode before doing so.
102 struct rw_semaphore rwsem;
106 * - fast_switch_possible should be set by the driver if it can
107 * guarantee that frequency can be changed on any CPU sharing the
108 * policy and that the change will affect all of the policy CPUs then.
109 * - fast_switch_enabled is to be set by governors that support fast
110 * frequency switching with the help of cpufreq_enable_fast_switch().
112 bool fast_switch_possible;
113 bool fast_switch_enabled;
116 * Set if the CPUFREQ_GOV_STRICT_TARGET flag is set for the current
122 * Preferred average time interval between consecutive invocations of
123 * the driver to set the frequency for this policy. To be set by the
124 * scaling driver (0, which is the default, means no preference).
126 unsigned int transition_delay_us;
129 * Remote DVFS flag (Not added to the driver structure as we don't want
130 * to access another structure from scheduler hotpath).
132 * Should be set if CPUs can do DVFS on behalf of other CPUs from
133 * different cpufreq policies.
135 bool dvfs_possible_from_any_cpu;
137 /* Cached frequency lookup from cpufreq_driver_resolve_freq. */
138 unsigned int cached_target_freq;
139 unsigned int cached_resolved_idx;
141 /* Synchronization for frequency transitions */
142 bool transition_ongoing; /* Tracks transition status */
143 spinlock_t transition_lock;
144 wait_queue_head_t transition_wait;
145 struct task_struct *transition_task; /* Task which is doing the transition */
148 struct cpufreq_stats *stats;
150 /* For cpufreq driver's internal use */
153 /* Pointer to the cooling device if used for thermal mitigation */
154 struct thermal_cooling_device *cdev;
156 struct notifier_block nb_min;
157 struct notifier_block nb_max;
161 * Used for passing new cpufreq policy data to the cpufreq driver's ->verify()
162 * callback for sanitization. That callback is only expected to modify the min
163 * and max values, if necessary, and specifically it must not update the
166 struct cpufreq_policy_data {
167 struct cpufreq_cpuinfo cpuinfo;
168 struct cpufreq_frequency_table *freq_table;
170 unsigned int min; /* in kHz */
171 unsigned int max; /* in kHz */
174 struct cpufreq_freqs {
175 struct cpufreq_policy *policy;
178 u8 flags; /* flags of cpufreq_driver, see below. */
182 #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
183 #define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
184 #define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
185 #define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
187 #ifdef CONFIG_CPU_FREQ
188 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
189 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
190 void cpufreq_cpu_put(struct cpufreq_policy *policy);
192 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
196 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
200 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
203 static inline bool policy_is_inactive(struct cpufreq_policy *policy)
205 return cpumask_empty(policy->cpus);
208 static inline bool policy_is_shared(struct cpufreq_policy *policy)
210 return cpumask_weight(policy->cpus) > 1;
213 #ifdef CONFIG_CPU_FREQ
214 unsigned int cpufreq_get(unsigned int cpu);
215 unsigned int cpufreq_quick_get(unsigned int cpu);
216 unsigned int cpufreq_quick_get_max(unsigned int cpu);
217 unsigned int cpufreq_get_hw_max_freq(unsigned int cpu);
218 void disable_cpufreq(void);
220 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
222 struct cpufreq_policy *cpufreq_cpu_acquire(unsigned int cpu);
223 void cpufreq_cpu_release(struct cpufreq_policy *policy);
224 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
225 void refresh_frequency_limits(struct cpufreq_policy *policy);
226 void cpufreq_update_policy(unsigned int cpu);
227 void cpufreq_update_limits(unsigned int cpu);
228 bool have_governor_per_policy(void);
229 bool cpufreq_supports_freq_invariance(void);
230 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
231 void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
232 void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
234 static inline unsigned int cpufreq_get(unsigned int cpu)
238 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
242 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
246 static inline unsigned int cpufreq_get_hw_max_freq(unsigned int cpu)
250 static inline bool cpufreq_supports_freq_invariance(void)
254 static inline void disable_cpufreq(void) { }
257 #ifdef CONFIG_CPU_FREQ_STAT
258 void cpufreq_stats_create_table(struct cpufreq_policy *policy);
259 void cpufreq_stats_free_table(struct cpufreq_policy *policy);
260 void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
261 unsigned int new_freq);
263 static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
264 static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
265 static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
266 unsigned int new_freq) { }
267 #endif /* CONFIG_CPU_FREQ_STAT */
269 /*********************************************************************
270 * CPUFREQ DRIVER INTERFACE *
271 *********************************************************************/
273 #define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
274 #define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
275 #define CPUFREQ_RELATION_C 2 /* closest frequency to target */
278 struct attribute attr;
279 ssize_t (*show)(struct cpufreq_policy *, char *);
280 ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
283 #define cpufreq_freq_attr_ro(_name) \
284 static struct freq_attr _name = \
285 __ATTR(_name, 0444, show_##_name, NULL)
287 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
288 static struct freq_attr _name = \
289 __ATTR(_name, _perm, show_##_name, NULL)
291 #define cpufreq_freq_attr_rw(_name) \
292 static struct freq_attr _name = \
293 __ATTR(_name, 0644, show_##_name, store_##_name)
295 #define cpufreq_freq_attr_wo(_name) \
296 static struct freq_attr _name = \
297 __ATTR(_name, 0200, NULL, store_##_name)
299 #define define_one_global_ro(_name) \
300 static struct kobj_attribute _name = \
301 __ATTR(_name, 0444, show_##_name, NULL)
303 #define define_one_global_rw(_name) \
304 static struct kobj_attribute _name = \
305 __ATTR(_name, 0644, show_##_name, store_##_name)
308 struct cpufreq_driver {
309 char name[CPUFREQ_NAME_LEN];
313 /* needed by all drivers */
314 int (*init)(struct cpufreq_policy *policy);
315 int (*verify)(struct cpufreq_policy_data *policy);
317 /* define one out of two */
318 int (*setpolicy)(struct cpufreq_policy *policy);
320 int (*target)(struct cpufreq_policy *policy,
321 unsigned int target_freq,
322 unsigned int relation); /* Deprecated */
323 int (*target_index)(struct cpufreq_policy *policy,
325 unsigned int (*fast_switch)(struct cpufreq_policy *policy,
326 unsigned int target_freq);
328 * ->fast_switch() replacement for drivers that use an internal
329 * representation of performance levels and can pass hints other than
330 * the target performance level to the hardware.
332 void (*adjust_perf)(unsigned int cpu,
333 unsigned long min_perf,
334 unsigned long target_perf,
335 unsigned long capacity);
338 * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
341 * get_intermediate should return a stable intermediate frequency
342 * platform wants to switch to and target_intermediate() should set CPU
343 * to that frequency, before jumping to the frequency corresponding
344 * to 'index'. Core will take care of sending notifications and driver
345 * doesn't have to handle them in target_intermediate() or
348 * Drivers can return '0' from get_intermediate() in case they don't
349 * wish to switch to intermediate frequency for some target frequency.
350 * In that case core will directly call ->target_index().
352 unsigned int (*get_intermediate)(struct cpufreq_policy *policy,
354 int (*target_intermediate)(struct cpufreq_policy *policy,
357 /* should be defined, if possible */
358 unsigned int (*get)(unsigned int cpu);
360 /* Called to update policy limits on firmware notifications. */
361 void (*update_limits)(unsigned int cpu);
364 int (*bios_limit)(int cpu, unsigned int *limit);
366 int (*online)(struct cpufreq_policy *policy);
367 int (*offline)(struct cpufreq_policy *policy);
368 int (*exit)(struct cpufreq_policy *policy);
369 int (*suspend)(struct cpufreq_policy *policy);
370 int (*resume)(struct cpufreq_policy *policy);
372 struct freq_attr **attr;
374 /* platform specific boost support code */
376 int (*set_boost)(struct cpufreq_policy *policy, int state);
379 * Set by drivers that want to register with the energy model after the
380 * policy is properly initialized, but before the governor is started.
382 void (*register_em)(struct cpufreq_policy *policy);
388 * Set by drivers that need to update internale upper and lower boundaries along
389 * with the target frequency and so the core and governors should also invoke
390 * the diver if the target frequency does not change, but the policy min or max
393 #define CPUFREQ_NEED_UPDATE_LIMITS BIT(0)
395 /* loops_per_jiffy or other kernel "constants" aren't affected by frequency transitions */
396 #define CPUFREQ_CONST_LOOPS BIT(1)
399 * Set by drivers that want the core to automatically register the cpufreq
400 * driver as a thermal cooling device.
402 #define CPUFREQ_IS_COOLING_DEV BIT(2)
405 * This should be set by platforms having multiple clock-domains, i.e.
406 * supporting multiple policies. With this sysfs directories of governor would
407 * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
408 * governor with different tunables for different clusters.
410 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY BIT(3)
413 * Driver will do POSTCHANGE notifications from outside of their ->target()
414 * routine and so must set cpufreq_driver->flags with this flag, so that core
415 * can handle them specially.
417 #define CPUFREQ_ASYNC_NOTIFICATION BIT(4)
420 * Set by drivers which want cpufreq core to check if CPU is running at a
421 * frequency present in freq-table exposed by the driver. For these drivers if
422 * CPU is found running at an out of table freq, we will try to set it to a freq
423 * from the table. And if that fails, we will stop further boot process by
424 * issuing a BUG_ON().
426 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK BIT(5)
429 * Set by drivers to disallow use of governors with "dynamic_switching" flag
432 #define CPUFREQ_NO_AUTO_DYNAMIC_SWITCHING BIT(6)
434 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
435 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
437 bool cpufreq_driver_test_flags(u16 flags);
438 const char *cpufreq_get_current_driver(void);
439 void *cpufreq_get_driver_data(void);
441 static inline int cpufreq_thermal_control_enabled(struct cpufreq_driver *drv)
443 return IS_ENABLED(CONFIG_CPU_THERMAL) &&
444 (drv->flags & CPUFREQ_IS_COOLING_DEV);
447 static inline void cpufreq_verify_within_limits(struct cpufreq_policy_data *policy,
451 if (policy->min < min)
453 if (policy->max < min)
455 if (policy->min > max)
457 if (policy->max > max)
459 if (policy->min > policy->max)
460 policy->min = policy->max;
465 cpufreq_verify_within_cpu_limits(struct cpufreq_policy_data *policy)
467 cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
468 policy->cpuinfo.max_freq);
471 #ifdef CONFIG_CPU_FREQ
472 void cpufreq_suspend(void);
473 void cpufreq_resume(void);
474 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
476 static inline void cpufreq_suspend(void) {}
477 static inline void cpufreq_resume(void) {}
480 /*********************************************************************
481 * CPUFREQ NOTIFIER INTERFACE *
482 *********************************************************************/
484 #define CPUFREQ_TRANSITION_NOTIFIER (0)
485 #define CPUFREQ_POLICY_NOTIFIER (1)
487 /* Transition notifiers */
488 #define CPUFREQ_PRECHANGE (0)
489 #define CPUFREQ_POSTCHANGE (1)
491 /* Policy Notifiers */
492 #define CPUFREQ_CREATE_POLICY (0)
493 #define CPUFREQ_REMOVE_POLICY (1)
495 #ifdef CONFIG_CPU_FREQ
496 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
497 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
499 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
500 struct cpufreq_freqs *freqs);
501 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
502 struct cpufreq_freqs *freqs, int transition_failed);
504 #else /* CONFIG_CPU_FREQ */
505 static inline int cpufreq_register_notifier(struct notifier_block *nb,
510 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
515 #endif /* !CONFIG_CPU_FREQ */
518 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
525 * new = old * mult / div
527 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
530 #if BITS_PER_LONG == 32
531 u64 result = ((u64) old) * ((u64) mult);
533 return (unsigned long) result;
535 #elif BITS_PER_LONG == 64
536 unsigned long result = old * ((u64) mult);
542 /*********************************************************************
543 * CPUFREQ GOVERNORS *
544 *********************************************************************/
546 #define CPUFREQ_POLICY_UNKNOWN (0)
548 * If (cpufreq_driver->target) exists, the ->governor decides what frequency
549 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
550 * two generic policies are available:
552 #define CPUFREQ_POLICY_POWERSAVE (1)
553 #define CPUFREQ_POLICY_PERFORMANCE (2)
556 * The polling frequency depends on the capability of the processor. Default
557 * polling frequency is 1000 times the transition latency of the processor. The
558 * ondemand governor will work on any processor with transition latency <= 10ms,
559 * using appropriate sampling rate.
561 #define LATENCY_MULTIPLIER (1000)
563 struct cpufreq_governor {
564 char name[CPUFREQ_NAME_LEN];
565 int (*init)(struct cpufreq_policy *policy);
566 void (*exit)(struct cpufreq_policy *policy);
567 int (*start)(struct cpufreq_policy *policy);
568 void (*stop)(struct cpufreq_policy *policy);
569 void (*limits)(struct cpufreq_policy *policy);
570 ssize_t (*show_setspeed) (struct cpufreq_policy *policy,
572 int (*store_setspeed) (struct cpufreq_policy *policy,
574 struct list_head governor_list;
575 struct module *owner;
581 /* For governors which change frequency dynamically by themselves */
582 #define CPUFREQ_GOV_DYNAMIC_SWITCHING BIT(0)
584 /* For governors wanting the target frequency to be set exactly */
585 #define CPUFREQ_GOV_STRICT_TARGET BIT(1)
588 /* Pass a target to the cpufreq driver */
589 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
590 unsigned int target_freq);
591 void cpufreq_driver_adjust_perf(unsigned int cpu,
592 unsigned long min_perf,
593 unsigned long target_perf,
594 unsigned long capacity);
595 bool cpufreq_driver_has_adjust_perf(void);
596 int cpufreq_driver_target(struct cpufreq_policy *policy,
597 unsigned int target_freq,
598 unsigned int relation);
599 int __cpufreq_driver_target(struct cpufreq_policy *policy,
600 unsigned int target_freq,
601 unsigned int relation);
602 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
603 unsigned int target_freq);
604 unsigned int cpufreq_policy_transition_delay_us(struct cpufreq_policy *policy);
605 int cpufreq_register_governor(struct cpufreq_governor *governor);
606 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
607 int cpufreq_start_governor(struct cpufreq_policy *policy);
608 void cpufreq_stop_governor(struct cpufreq_policy *policy);
610 #define cpufreq_governor_init(__governor) \
611 static int __init __governor##_init(void) \
613 return cpufreq_register_governor(&__governor); \
615 core_initcall(__governor##_init)
617 #define cpufreq_governor_exit(__governor) \
618 static void __exit __governor##_exit(void) \
620 return cpufreq_unregister_governor(&__governor); \
622 module_exit(__governor##_exit)
624 struct cpufreq_governor *cpufreq_default_governor(void);
625 struct cpufreq_governor *cpufreq_fallback_governor(void);
627 static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
629 if (policy->max < policy->cur)
630 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
631 else if (policy->min > policy->cur)
632 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
635 /* Governor attribute set */
636 struct gov_attr_set {
638 struct list_head policy_list;
639 struct mutex update_lock;
643 /* sysfs ops for cpufreq governors */
644 extern const struct sysfs_ops governor_sysfs_ops;
646 void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
647 void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
648 unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
650 /* Governor sysfs attribute */
651 struct governor_attr {
652 struct attribute attr;
653 ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
654 ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
658 /*********************************************************************
659 * FREQUENCY TABLE HELPERS *
660 *********************************************************************/
662 /* Special Values of .frequency field */
663 #define CPUFREQ_ENTRY_INVALID ~0u
664 #define CPUFREQ_TABLE_END ~1u
665 /* Special Values of .flags field */
666 #define CPUFREQ_BOOST_FREQ (1 << 0)
668 struct cpufreq_frequency_table {
670 unsigned int driver_data; /* driver specific data, not used by core */
671 unsigned int frequency; /* kHz - doesn't need to be in ascending
675 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
676 int dev_pm_opp_init_cpufreq_table(struct device *dev,
677 struct cpufreq_frequency_table **table);
678 void dev_pm_opp_free_cpufreq_table(struct device *dev,
679 struct cpufreq_frequency_table **table);
681 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
682 struct cpufreq_frequency_table
688 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
689 struct cpufreq_frequency_table
696 * cpufreq_for_each_entry - iterate over a cpufreq_frequency_table
697 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
698 * @table: the cpufreq_frequency_table * to iterate over.
701 #define cpufreq_for_each_entry(pos, table) \
702 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
705 * cpufreq_for_each_entry_idx - iterate over a cpufreq_frequency_table
707 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
708 * @table: the cpufreq_frequency_table * to iterate over.
709 * @idx: the table entry currently being processed
712 #define cpufreq_for_each_entry_idx(pos, table, idx) \
713 for (pos = table, idx = 0; pos->frequency != CPUFREQ_TABLE_END; \
717 * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table
718 * excluding CPUFREQ_ENTRY_INVALID frequencies.
719 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
720 * @table: the cpufreq_frequency_table * to iterate over.
723 #define cpufreq_for_each_valid_entry(pos, table) \
724 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) \
725 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \
730 * cpufreq_for_each_valid_entry_idx - iterate with index over a cpufreq
731 * frequency_table excluding CPUFREQ_ENTRY_INVALID frequencies.
732 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
733 * @table: the cpufreq_frequency_table * to iterate over.
734 * @idx: the table entry currently being processed
737 #define cpufreq_for_each_valid_entry_idx(pos, table, idx) \
738 cpufreq_for_each_entry_idx(pos, table, idx) \
739 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \
744 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
745 struct cpufreq_frequency_table *table);
747 int cpufreq_frequency_table_verify(struct cpufreq_policy_data *policy,
748 struct cpufreq_frequency_table *table);
749 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy_data *policy);
751 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
752 unsigned int target_freq,
753 unsigned int relation);
754 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
757 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
759 #ifdef CONFIG_CPU_FREQ
760 int cpufreq_boost_trigger_state(int state);
761 int cpufreq_boost_enabled(void);
762 int cpufreq_enable_boost_support(void);
763 bool policy_has_boost_freq(struct cpufreq_policy *policy);
765 /* Find lowest freq at or above target in a table in ascending order */
766 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
767 unsigned int target_freq)
769 struct cpufreq_frequency_table *table = policy->freq_table;
770 struct cpufreq_frequency_table *pos;
774 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
775 freq = pos->frequency;
777 if (freq >= target_freq)
786 /* Find lowest freq at or above target in a table in descending order */
787 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
788 unsigned int target_freq)
790 struct cpufreq_frequency_table *table = policy->freq_table;
791 struct cpufreq_frequency_table *pos;
795 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
796 freq = pos->frequency;
798 if (freq == target_freq)
801 if (freq > target_freq) {
806 /* No freq found above target_freq */
816 /* Works only on sorted freq-tables */
817 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
818 unsigned int target_freq)
820 target_freq = clamp_val(target_freq, policy->min, policy->max);
822 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
823 return cpufreq_table_find_index_al(policy, target_freq);
825 return cpufreq_table_find_index_dl(policy, target_freq);
828 /* Find highest freq at or below target in a table in ascending order */
829 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
830 unsigned int target_freq)
832 struct cpufreq_frequency_table *table = policy->freq_table;
833 struct cpufreq_frequency_table *pos;
837 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
838 freq = pos->frequency;
840 if (freq == target_freq)
843 if (freq < target_freq) {
848 /* No freq found below target_freq */
858 /* Find highest freq at or below target in a table in descending order */
859 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
860 unsigned int target_freq)
862 struct cpufreq_frequency_table *table = policy->freq_table;
863 struct cpufreq_frequency_table *pos;
867 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
868 freq = pos->frequency;
870 if (freq <= target_freq)
879 /* Works only on sorted freq-tables */
880 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
881 unsigned int target_freq)
883 target_freq = clamp_val(target_freq, policy->min, policy->max);
885 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
886 return cpufreq_table_find_index_ah(policy, target_freq);
888 return cpufreq_table_find_index_dh(policy, target_freq);
891 /* Find closest freq to target in a table in ascending order */
892 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
893 unsigned int target_freq)
895 struct cpufreq_frequency_table *table = policy->freq_table;
896 struct cpufreq_frequency_table *pos;
900 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
901 freq = pos->frequency;
903 if (freq == target_freq)
906 if (freq < target_freq) {
911 /* No freq found below target_freq */
915 /* Choose the closest freq */
916 if (target_freq - table[best].frequency > freq - target_freq)
925 /* Find closest freq to target in a table in descending order */
926 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
927 unsigned int target_freq)
929 struct cpufreq_frequency_table *table = policy->freq_table;
930 struct cpufreq_frequency_table *pos;
934 cpufreq_for_each_valid_entry_idx(pos, table, idx) {
935 freq = pos->frequency;
937 if (freq == target_freq)
940 if (freq > target_freq) {
945 /* No freq found above target_freq */
949 /* Choose the closest freq */
950 if (table[best].frequency - target_freq > target_freq - freq)
959 /* Works only on sorted freq-tables */
960 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
961 unsigned int target_freq)
963 target_freq = clamp_val(target_freq, policy->min, policy->max);
965 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
966 return cpufreq_table_find_index_ac(policy, target_freq);
968 return cpufreq_table_find_index_dc(policy, target_freq);
971 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
972 unsigned int target_freq,
973 unsigned int relation)
975 if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
976 return cpufreq_table_index_unsorted(policy, target_freq,
980 case CPUFREQ_RELATION_L:
981 return cpufreq_table_find_index_l(policy, target_freq);
982 case CPUFREQ_RELATION_H:
983 return cpufreq_table_find_index_h(policy, target_freq);
984 case CPUFREQ_RELATION_C:
985 return cpufreq_table_find_index_c(policy, target_freq);
992 static inline int cpufreq_table_count_valid_entries(const struct cpufreq_policy *policy)
994 struct cpufreq_frequency_table *pos;
997 if (unlikely(!policy->freq_table))
1000 cpufreq_for_each_valid_entry(pos, policy->freq_table)
1006 static inline int parse_perf_domain(int cpu, const char *list_name,
1007 const char *cell_name)
1009 struct device_node *cpu_np;
1010 struct of_phandle_args args;
1013 cpu_np = of_cpu_device_node_get(cpu);
1017 ret = of_parse_phandle_with_args(cpu_np, list_name, cell_name, 0,
1022 of_node_put(cpu_np);
1024 return args.args[0];
1027 static inline int of_perf_domain_get_sharing_cpumask(int pcpu, const char *list_name,
1028 const char *cell_name, struct cpumask *cpumask)
1033 ret = parse_perf_domain(pcpu, list_name, cell_name);
1038 cpumask_set_cpu(pcpu, cpumask);
1040 for_each_possible_cpu(cpu) {
1044 ret = parse_perf_domain(pcpu, list_name, cell_name);
1048 if (target_idx == ret)
1049 cpumask_set_cpu(cpu, cpumask);
1055 static inline int cpufreq_boost_trigger_state(int state)
1059 static inline int cpufreq_boost_enabled(void)
1064 static inline int cpufreq_enable_boost_support(void)
1069 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
1074 static inline int of_perf_domain_get_sharing_cpumask(int pcpu, const char *list_name,
1075 const char *cell_name, struct cpumask *cpumask)
1081 #if defined(CONFIG_ENERGY_MODEL) && defined(CONFIG_CPU_FREQ_GOV_SCHEDUTIL)
1082 void sched_cpufreq_governor_change(struct cpufreq_policy *policy,
1083 struct cpufreq_governor *old_gov);
1085 static inline void sched_cpufreq_governor_change(struct cpufreq_policy *policy,
1086 struct cpufreq_governor *old_gov) { }
1089 extern void arch_freq_prepare_all(void);
1090 extern unsigned int arch_freq_get_on_cpu(int cpu);
1092 #ifndef arch_set_freq_scale
1093 static __always_inline
1094 void arch_set_freq_scale(const struct cpumask *cpus,
1095 unsigned long cur_freq,
1096 unsigned long max_freq)
1100 /* the following are really really optional */
1101 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
1102 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
1103 extern struct freq_attr *cpufreq_generic_attr[];
1104 int cpufreq_table_validate_and_sort(struct cpufreq_policy *policy);
1106 unsigned int cpufreq_generic_get(unsigned int cpu);
1107 void cpufreq_generic_init(struct cpufreq_policy *policy,
1108 struct cpufreq_frequency_table *table,
1109 unsigned int transition_latency);
1111 static inline void cpufreq_register_em_with_opp(struct cpufreq_policy *policy)
1113 dev_pm_opp_of_register_em(get_cpu_device(policy->cpu),
1114 policy->related_cpus);
1116 #endif /* _LINUX_CPUFREQ_H */