1 /* SPDX-License-Identifier: GPL-2.0-only */
6  *           (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
30  * Maximum transition latency is in nanoseconds - if it's unknown,
34 #define CPUFREQ_ETERNAL			(-1)
51 	/* in 10^(-9) s = nanoseconds */
69 	unsigned int		max;    /* in kHz */  member
72 	unsigned int		suspend_freq; /* freq to set during suspend */
96 	 * - Any routine that wants to read from the policy structure will
98 	 * - Any routine that will write to the policy structure and/or may take away
106 	 * - fast_switch_possible should be set by the driver if it can
109 	 * - fast_switch_enabled is to be set by governors that support fast
160 	/* cpufreq-stats */
174  * Used for passing new cpufreq policy data to the cpufreq driver's ->verify()
176  * and max values, if necessary, and specifically it must not update the
184 	unsigned int			max;    /* in kHz */  member
197 #define CPUFREQ_SHARED_TYPE_ALL	 (2) /* All dependent CPUs should set freq */
198 #define CPUFREQ_SHARED_TYPE_ANY	 (3) /* Freq can be set from any dependent CPU*/
221 	return cpumask_empty(policy->cpus);  in DEFINE_FREE()
226 	return cpumask_weight(policy->cpus) > 1;  in policy_is_shared()
362 	 * ->fast_switch() replacement for drivers that use an internal
365 	 * if ->fast_switch is set too, because in those cases (under specific
387 	 * In that case core will directly call ->target_index().
430  * the diver if the target frequency does not change, but the policy min or max
445  * This should be set by platforms having multiple clock-domains, i.e.
453  * Driver will do POSTCHANGE notifications from outside of their ->target()
454  * routine and so must set cpufreq_driver->flags with this flag, so that core
461  * frequency present in freq-table exposed by the driver. For these drivers if
462  * CPU is found running at an out of table freq, we will try to set it to a freq
484 		(drv->flags & CPUFREQ_IS_COOLING_DEV);  in cpufreq_thermal_control_enabled()
489 						unsigned int max)  in cpufreq_verify_within_limits()  argument
491 	policy->max = clamp(policy->max, min, max);  in cpufreq_verify_within_limits()
492 	policy->min = clamp(policy->min, min, policy->max);  in cpufreq_verify_within_limits()
498 	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,  in cpufreq_verify_within_cpu_limits()
499 				     policy->cpuinfo.max_freq);  in cpufreq_verify_within_cpu_limits()
549  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
579  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
580  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
596 					 unsigned int freq);
652 	if (policy->max < policy->cur)  in cpufreq_policy_apply_limits()
653 		__cpufreq_driver_target(policy, policy->max,  in cpufreq_policy_apply_limits()
655 	else if (policy->min > policy->cur)  in cpufreq_policy_apply_limits()
656 		__cpufreq_driver_target(policy, policy->min,  in cpufreq_policy_apply_limits()
702 	unsigned int	frequency; /* kHz - doesn't need to be in ascending
707  * cpufreq_for_each_entry -	iterate over a cpufreq_frequency_table
713 	for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
716  * cpufreq_for_each_entry_idx -	iterate over a cpufreq_frequency_table
724 	for (pos = table, idx = 0; pos->frequency != CPUFREQ_TABLE_END; \
728  * cpufreq_for_each_valid_entry -     iterate over a cpufreq_frequency_table
735 	for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)	\
736 		if (pos->frequency == CPUFREQ_ENTRY_INVALID)		\
741  * cpufreq_for_each_valid_entry_idx -     iterate with index over a cpufreq
750 		if (pos->frequency == CPUFREQ_ENTRY_INVALID)		\
755  * cpufreq_for_each_efficient_entry_idx - iterate with index over a cpufreq
766 		if (efficiencies && (pos->flags & CPUFREQ_INEFFICIENT_FREQ))	\
780 				 unsigned int max, unsigned int relation);
782 		unsigned int freq);
790 /* Find lowest freq at or above target in a table in ascending order */
795 	struct cpufreq_frequency_table *table = policy->freq_table;  in cpufreq_table_find_index_al()
797 	unsigned int freq;  in cpufreq_table_find_index_al()  local
798 	int idx, best = -1;  in cpufreq_table_find_index_al()
801 		freq = pos->frequency;  in cpufreq_table_find_index_al()
803 		if (freq >= target_freq)  in cpufreq_table_find_index_al()
812 /* Find lowest freq at or above target in a table in descending order */
817 	struct cpufreq_frequency_table *table = policy->freq_table;  in cpufreq_table_find_index_dl()
819 	unsigned int freq;  in cpufreq_table_find_index_dl()  local
820 	int idx, best = -1;  in cpufreq_table_find_index_dl()
823 		freq = pos->frequency;  in cpufreq_table_find_index_dl()
825 		if (freq == target_freq)  in cpufreq_table_find_index_dl()
828 		if (freq > target_freq) {  in cpufreq_table_find_index_dl()
833 		/* No freq found above target_freq */  in cpufreq_table_find_index_dl()
834 		if (best == -1)  in cpufreq_table_find_index_dl()
845 			       unsigned int min, unsigned int max,  in find_index_l()  argument
848 	target_freq = clamp_val(target_freq, min, max);  in find_index_l()
850 	if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)  in find_index_l()
858 /* Works only on sorted freq-tables */
863 	return find_index_l(policy, target_freq, policy->min, policy->max, efficiencies);  in cpufreq_table_find_index_l()
866 /* Find highest freq at or below target in a table in ascending order */
871 	struct cpufreq_frequency_table *table = policy->freq_table;  in cpufreq_table_find_index_ah()
873 	unsigned int freq;  in cpufreq_table_find_index_ah()  local
874 	int idx, best = -1;  in cpufreq_table_find_index_ah()
877 		freq = pos->frequency;  in cpufreq_table_find_index_ah()
879 		if (freq == target_freq)  in cpufreq_table_find_index_ah()
882 		if (freq < target_freq) {  in cpufreq_table_find_index_ah()
887 		/* No freq found below target_freq */  in cpufreq_table_find_index_ah()
888 		if (best == -1)  in cpufreq_table_find_index_ah()
897 /* Find highest freq at or below target in a table in descending order */
902 	struct cpufreq_frequency_table *table = policy->freq_table;  in cpufreq_table_find_index_dh()
904 	unsigned int freq;  in cpufreq_table_find_index_dh()  local
905 	int idx, best = -1;  in cpufreq_table_find_index_dh()
908 		freq = pos->frequency;  in cpufreq_table_find_index_dh()
910 		if (freq <= target_freq)  in cpufreq_table_find_index_dh()
921 			       unsigned int min, unsigned int max,  in find_index_h()  argument
924 	target_freq = clamp_val(target_freq, min, max);  in find_index_h()
926 	if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)  in find_index_h()
934 /* Works only on sorted freq-tables */
939 	return find_index_h(policy, target_freq, policy->min, policy->max, efficiencies);  in cpufreq_table_find_index_h()
942 /* Find closest freq to target in a table in ascending order */
947 	struct cpufreq_frequency_table *table = policy->freq_table;  in cpufreq_table_find_index_ac()
949 	unsigned int freq;  in cpufreq_table_find_index_ac()  local
950 	int idx, best = -1;  in cpufreq_table_find_index_ac()
953 		freq = pos->frequency;  in cpufreq_table_find_index_ac()
955 		if (freq == target_freq)  in cpufreq_table_find_index_ac()
958 		if (freq < target_freq) {  in cpufreq_table_find_index_ac()
963 		/* No freq found below target_freq */  in cpufreq_table_find_index_ac()
964 		if (best == -1)  in cpufreq_table_find_index_ac()
967 		/* Choose the closest freq */  in cpufreq_table_find_index_ac()
968 		if (target_freq - table[best].frequency > freq - target_freq)  in cpufreq_table_find_index_ac()
977 /* Find closest freq to target in a table in descending order */
982 	struct cpufreq_frequency_table *table = policy->freq_table;  in cpufreq_table_find_index_dc()
984 	unsigned int freq;  in cpufreq_table_find_index_dc()  local
985 	int idx, best = -1;  in cpufreq_table_find_index_dc()
988 		freq = pos->frequency;  in cpufreq_table_find_index_dc()
990 		if (freq == target_freq)  in cpufreq_table_find_index_dc()
993 		if (freq > target_freq) {  in cpufreq_table_find_index_dc()
998 		/* No freq found above target_freq */  in cpufreq_table_find_index_dc()
999 		if (best == -1)  in cpufreq_table_find_index_dc()
1002 		/* Choose the closest freq */  in cpufreq_table_find_index_dc()
1003 		if (table[best].frequency - target_freq > target_freq - freq)  in cpufreq_table_find_index_dc()
1014 			       unsigned int min, unsigned int max,  in find_index_c()  argument
1017 	target_freq = clamp_val(target_freq, min, max);  in find_index_c()
1019 	if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)  in find_index_c()
1027 /* Works only on sorted freq-tables */
1032 	return find_index_c(policy, target_freq, policy->min, policy->max, efficiencies);  in cpufreq_table_find_index_c()
1036 					unsigned int min, unsigned int max,  in cpufreq_is_in_limits()  argument
1039 	unsigned int freq;  in cpufreq_is_in_limits()  local
1044 	freq = policy->freq_table[idx].frequency;  in cpufreq_is_in_limits()
1046 	return freq == clamp_val(freq, min, max);  in cpufreq_is_in_limits()
1052 						 unsigned int max,  in cpufreq_frequency_table_target()  argument
1055 	bool efficiencies = policy->efficiencies_available &&  in cpufreq_frequency_table_target()
1062 	if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))  in cpufreq_frequency_table_target()
1064 						    max, relation);  in cpufreq_frequency_table_target()
1068 		idx = find_index_l(policy, target_freq, min, max, efficiencies);  in cpufreq_frequency_table_target()
1071 		idx = find_index_h(policy, target_freq, min, max, efficiencies);  in cpufreq_frequency_table_target()
1074 		idx = find_index_c(policy, target_freq, min, max, efficiencies);  in cpufreq_frequency_table_target()
1081 	/* Limit frequency index to honor min and max */  in cpufreq_frequency_table_target()
1082 	if (!cpufreq_is_in_limits(policy, min, max, idx) && efficiencies) {  in cpufreq_frequency_table_target()
1095 	if (unlikely(!policy->freq_table))  in cpufreq_table_count_valid_entries()
1098 	cpufreq_for_each_valid_entry(pos, policy->freq_table)  in cpufreq_table_count_valid_entries()
1105  * cpufreq_table_set_inefficient() - Mark a frequency as inefficient
1121 	if (policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED)  in cpufreq_table_set_inefficient()
1122 		return -EINVAL;  in cpufreq_table_set_inefficient()
1124 	cpufreq_for_each_valid_entry(pos, policy->freq_table) {  in cpufreq_table_set_inefficient()
1125 		if (pos->frequency == frequency) {  in cpufreq_table_set_inefficient()
1126 			pos->flags |= CPUFREQ_INEFFICIENT_FREQ;  in cpufreq_table_set_inefficient()
1127 			policy->efficiencies_available = true;  in cpufreq_table_set_inefficient()
1132 	return -EINVAL;  in cpufreq_table_set_inefficient()
1143 		return -ENODEV;  in parse_perf_domain()
1189 	return -EOPNOTSUPP;  in cpufreq_boost_set_sw()
1196 	return -EINVAL;  in cpufreq_table_set_inefficient()
1203 	return -EOPNOTSUPP;  in of_perf_domain_get_sharing_cpumask()
1230 	dev_pm_opp_of_register_em(get_cpu_device(policy->cpu),  in cpufreq_register_em_with_opp()
1231 				  policy->related_cpus);  in cpufreq_register_em_with_opp()