[mirror_ubuntu-bionic-kernel.git] / drivers / cpufreq / freq_table.c

/*
 * linux/drivers/cpufreq/freq_table.c
 *
 * Copyright (C) 2002 - 2003 Dominik Brodowski
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/cpufreq.h>
#include <linux/module.h>

/*********************************************************************
 *                     FREQUENCY TABLE HELPERS                       *
 *********************************************************************/

int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
				    struct cpufreq_frequency_table *table)
{
	struct cpufreq_frequency_table *pos;
	unsigned int min_freq = ~0;
	unsigned int max_freq = 0;
	unsigned int freq;

	cpufreq_for_each_valid_entry(pos, table) {
		freq = pos->frequency;

		if (!cpufreq_boost_enabled()
		    && (pos->flags & CPUFREQ_BOOST_FREQ))
			continue;

		pr_debug("table entry %u: %u kHz\n", (int)(pos - table), freq);
		if (freq < min_freq)
			min_freq = freq;
		if (freq > max_freq)
			max_freq = freq;
	}

	policy->min = policy->cpuinfo.min_freq = min_freq;
	policy->max = policy->cpuinfo.max_freq = max_freq;

	if (policy->min == ~0)
		return -EINVAL;
	else
		return 0;
}
EXPORT_SYMBOL_GPL(cpufreq_frequency_table_cpuinfo);


int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
				   struct cpufreq_frequency_table *table)
{
	struct cpufreq_frequency_table *pos;
	unsigned int freq, next_larger = ~0;
	bool found = false;

	pr_debug("request for verification of policy (%u - %u kHz) for cpu %u\n",
					policy->min, policy->max, policy->cpu);

	cpufreq_verify_within_cpu_limits(policy);

	cpufreq_for_each_valid_entry(pos, table) {
		freq = pos->frequency;

		if ((freq >= policy->min) && (freq <= policy->max)) {
			found = true;
			break;
		}

		if ((next_larger > freq) && (freq > policy->max))
			next_larger = freq;
	}

	if (!found) {
		policy->max = next_larger;
		cpufreq_verify_within_cpu_limits(policy);
	}

	pr_debug("verification lead to (%u - %u kHz) for cpu %u\n",
				policy->min, policy->max, policy->cpu);

	return 0;
}
EXPORT_SYMBOL_GPL(cpufreq_frequency_table_verify);

/*
 * Generic routine to verify policy & frequency table, requires driver to set
 * policy->freq_table prior to it.
 */
int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy)
{
	struct cpufreq_frequency_table *table =
		cpufreq_frequency_get_table(policy->cpu);
	if (!table)
		return -ENODEV;

	return cpufreq_frequency_table_verify(policy, table);
}
EXPORT_SYMBOL_GPL(cpufreq_generic_frequency_table_verify);

int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
				   struct cpufreq_frequency_table *table,
				   unsigned int target_freq,
				   unsigned int relation,
				   unsigned int *index)
{
	struct cpufreq_frequency_table optimal = {
		.driver_data = ~0,
		.frequency = 0,
	};
	struct cpufreq_frequency_table suboptimal = {
		.driver_data = ~0,
		.frequency = 0,
	};
	struct cpufreq_frequency_table *pos;
	unsigned int freq, i = 0;

	pr_debug("request for target %u kHz (relation: %u) for cpu %u\n",
					target_freq, relation, policy->cpu);

	switch (relation) {
	case CPUFREQ_RELATION_H:
		suboptimal.frequency = ~0;
		break;
	case CPUFREQ_RELATION_L:
		optimal.frequency = ~0;
		break;
	}

	cpufreq_for_each_valid_entry(pos, table) {
		freq = pos->frequency;

		i = pos - table;
		if ((freq < policy->min) || (freq > policy->max))
			continue;
		if (freq == target_freq) {
			optimal.driver_data = i;
			break;
		}
		switch (relation) {
		case CPUFREQ_RELATION_H:
			if (freq < target_freq) {
				if (freq >= optimal.frequency) {
					optimal.frequency = freq;
					optimal.driver_data = i;
				}
			} else {
				if (freq <= suboptimal.frequency) {
					suboptimal.frequency = freq;
					suboptimal.driver_data = i;
				}
			}
			break;
		case CPUFREQ_RELATION_L:
			if (freq > target_freq) {
				if (freq <= optimal.frequency) {
					optimal.frequency = freq;
					optimal.driver_data = i;
				}
			} else {
				if (freq >= suboptimal.frequency) {
					suboptimal.frequency = freq;
					suboptimal.driver_data = i;
				}
			}
			break;
		}
	}
	if (optimal.driver_data > i) {
		if (suboptimal.driver_data > i)
			return -EINVAL;
		*index = suboptimal.driver_data;
	} else
		*index = optimal.driver_data;

	pr_debug("target index is %u, freq is:%u kHz\n", *index,
		 table[*index].frequency);

	return 0;
}
EXPORT_SYMBOL_GPL(cpufreq_frequency_table_target);

int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
		unsigned int freq)
{
	struct cpufreq_frequency_table *pos, *table;

	table = cpufreq_frequency_get_table(policy->cpu);
	if (unlikely(!table)) {
		pr_debug("%s: Unable to find frequency table\n", __func__);
		return -ENOENT;
	}

	cpufreq_for_each_valid_entry(pos, table)
		if (pos->frequency == freq)
			return pos - table;

	return -EINVAL;
}
EXPORT_SYMBOL_GPL(cpufreq_frequency_table_get_index);

/**
 * show_available_freqs - show available frequencies for the specified CPU
 */
static ssize_t show_available_freqs(struct cpufreq_policy *policy, char *buf,
				    bool show_boost)
{
	ssize_t count = 0;
	struct cpufreq_frequency_table *pos, *table = policy->freq_table;

	if (!table)
		return -ENODEV;

	cpufreq_for_each_valid_entry(pos, table) {
		/*
		 * show_boost = true and driver_data = BOOST freq
		 * display BOOST freqs
		 *
		 * show_boost = false and driver_data = BOOST freq
		 * show_boost = true and driver_data != BOOST freq
		 * continue - do not display anything
		 *
		 * show_boost = false and driver_data != BOOST freq
		 * display NON BOOST freqs
		 */
		if (show_boost ^ (pos->flags & CPUFREQ_BOOST_FREQ))
			continue;

		count += sprintf(&buf[count], "%d ", pos->frequency);
	}
	count += sprintf(&buf[count], "\n");

	return count;

}

#define cpufreq_attr_available_freq(_name)	  \
struct freq_attr cpufreq_freq_attr_##_name##_freqs =     \
__ATTR_RO(_name##_frequencies)

/**
 * show_scaling_available_frequencies - show available normal frequencies for
 * the specified CPU
 */
static ssize_t scaling_available_frequencies_show(struct cpufreq_policy *policy,
						  char *buf)
{
	return show_available_freqs(policy, buf, false);
}
cpufreq_attr_available_freq(scaling_available);
EXPORT_SYMBOL_GPL(cpufreq_freq_attr_scaling_available_freqs);

/**
 * show_available_boost_freqs - show available boost frequencies for
 * the specified CPU
 */
static ssize_t scaling_boost_frequencies_show(struct cpufreq_policy *policy,
					      char *buf)
{
	return show_available_freqs(policy, buf, true);
}
cpufreq_attr_available_freq(scaling_boost);
EXPORT_SYMBOL_GPL(cpufreq_freq_attr_scaling_boost_freqs);

struct freq_attr *cpufreq_generic_attr[] = {
	&cpufreq_freq_attr_scaling_available_freqs,
#ifdef CONFIG_CPU_FREQ_BOOST_SW
	&cpufreq_freq_attr_scaling_boost_freqs,
#endif
	NULL,
};
EXPORT_SYMBOL_GPL(cpufreq_generic_attr);

int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
				      struct cpufreq_frequency_table *table)
{
	int ret = cpufreq_frequency_table_cpuinfo(policy, table);

	if (!ret)
		policy->freq_table = table;

	return ret;
}
EXPORT_SYMBOL_GPL(cpufreq_table_validate_and_show);

struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);

struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu)
{
	struct cpufreq_policy *policy = cpufreq_cpu_get_raw(cpu);
	return policy ? policy->freq_table : NULL;
}
EXPORT_SYMBOL_GPL(cpufreq_frequency_get_table);

MODULE_AUTHOR("Dominik Brodowski <linux@brodo.de>");
MODULE_DESCRIPTION("CPUfreq frequency table helpers");
MODULE_LICENSE("GPL");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/drivers/cpufreq/freq_table.c
	3	*
	4	* Copyright (C) 2002 - 2003 Dominik Brodowski
4f743694 DB	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*
1da177e4 LT	10	*/
1da177e4 LT	11
db701151 VK	12	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
db701151 VK	13
1da177e4	14	#include <linux/cpufreq.h>
5ff0a268	15	#include <linux/module.h>
1da177e4	16
1da177e4 LT	17	/*********************************************************************
	18	* FREQUENCY TABLE HELPERS *
	19	*********************************************************************/
	20
	21	int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
	22	struct cpufreq_frequency_table *table)
	23	{
041526f9	24	struct cpufreq_frequency_table *pos;
1da177e4 LT	25	unsigned int min_freq = ~0;
1da177e4 LT	26	unsigned int max_freq = 0;
041526f9	27	unsigned int freq;
1da177e4	28
041526f9 SK	29	cpufreq_for_each_valid_entry(pos, table) {
041526f9 SK	30	freq = pos->frequency;
1da177e4	31
6f19efc0	32	if (!cpufreq_boost_enabled()
041526f9	33	&& (pos->flags & CPUFREQ_BOOST_FREQ))
6f19efc0 LM	34	continue;
6f19efc0 LM	35
041526f9	36	pr_debug("table entry %u: %u kHz\n", (int)(pos - table), freq);
1da177e4 LT	37	if (freq < min_freq)
	38	min_freq = freq;
	39	if (freq > max_freq)
	40	max_freq = freq;
	41	}
	42
	43	policy->min = policy->cpuinfo.min_freq = min_freq;
	44	policy->max = policy->cpuinfo.max_freq = max_freq;
	45
	46	if (policy->min == ~0)
	47	return -EINVAL;
	48	else
	49	return 0;
	50	}
	51	EXPORT_SYMBOL_GPL(cpufreq_frequency_table_cpuinfo);
	52
	53
	54	int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
	55	struct cpufreq_frequency_table *table)
	56	{
041526f9 SK	57	struct cpufreq_frequency_table *pos;
041526f9 SK	58	unsigned int freq, next_larger = ~0;
77db50c4	59	bool found = false;
1da177e4	60
2d06d8c4	61	pr_debug("request for verification of policy (%u - %u kHz) for cpu %u\n",
e08f5f5b	62	policy->min, policy->max, policy->cpu);
1da177e4	63
be49e346	64	cpufreq_verify_within_cpu_limits(policy);
1da177e4	65
041526f9 SK	66	cpufreq_for_each_valid_entry(pos, table) {
	67	freq = pos->frequency;
	68
77db50c4 VK	69	if ((freq >= policy->min) && (freq <= policy->max)) {
	70	found = true;
	71	break;
	72	}
	73
	74	if ((next_larger > freq) && (freq > policy->max))
1da177e4 LT	75	next_larger = freq;
	76	}
	77
77db50c4	78	if (!found) {
1da177e4	79	policy->max = next_larger;
be49e346	80	cpufreq_verify_within_cpu_limits(policy);
77db50c4	81	}
1da177e4	82
2d06d8c4	83	pr_debug("verification lead to (%u - %u kHz) for cpu %u\n",
e08f5f5b	84	policy->min, policy->max, policy->cpu);
1da177e4 LT	85
	86	return 0;
	87	}
	88	EXPORT_SYMBOL_GPL(cpufreq_frequency_table_verify);
	89
18434512	90	/*
e0b3165b VK	91	* Generic routine to verify policy & frequency table, requires driver to set
e0b3165b VK	92	* policy->freq_table prior to it.
18434512 VK	93	*/
	94	int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy)
	95	{
	96	struct cpufreq_frequency_table *table =
	97	cpufreq_frequency_get_table(policy->cpu);
	98	if (!table)
	99	return -ENODEV;
	100
	101	return cpufreq_frequency_table_verify(policy, table);
	102	}
	103	EXPORT_SYMBOL_GPL(cpufreq_generic_frequency_table_verify);
1da177e4 LT	104
	105	int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
	106	struct cpufreq_frequency_table *table,
	107	unsigned int target_freq,
	108	unsigned int relation,
	109	unsigned int *index)
	110	{
484944a5	111	struct cpufreq_frequency_table optimal = {
50701588	112	.driver_data = ~0,
484944a5 DJ	113	.frequency = 0,
	114	};
	115	struct cpufreq_frequency_table suboptimal = {
50701588	116	.driver_data = ~0,
484944a5 DJ	117	.frequency = 0,
484944a5 DJ	118	};
041526f9 SK	119	struct cpufreq_frequency_table *pos;
041526f9 SK	120	unsigned int freq, i = 0;
1da177e4	121
2d06d8c4	122	pr_debug("request for target %u kHz (relation: %u) for cpu %u\n",
e08f5f5b	123	target_freq, relation, policy->cpu);
1da177e4 LT	124
	125	switch (relation) {
	126	case CPUFREQ_RELATION_H:
1da177e4 LT	127	suboptimal.frequency = ~0;
	128	break;
	129	case CPUFREQ_RELATION_L:
	130	optimal.frequency = ~0;
1da177e4 LT	131	break;
	132	}
	133
041526f9 SK	134	cpufreq_for_each_valid_entry(pos, table) {
	135	freq = pos->frequency;
	136
	137	i = pos - table;
1da177e4 LT	138	if ((freq < policy->min) \|\| (freq > policy->max))
1da177e4 LT	139	continue;
1e498856 SK	140	if (freq == target_freq) {
	141	optimal.driver_data = i;
	142	break;
	143	}
97acec55	144	switch (relation) {
1da177e4	145	case CPUFREQ_RELATION_H:
1e498856	146	if (freq < target_freq) {
1da177e4 LT	147	if (freq >= optimal.frequency) {
1da177e4 LT	148	optimal.frequency = freq;
50701588	149	optimal.driver_data = i;
1da177e4 LT	150	}
	151	} else {
	152	if (freq <= suboptimal.frequency) {
	153	suboptimal.frequency = freq;
50701588	154	suboptimal.driver_data = i;
1da177e4 LT	155	}
	156	}
	157	break;
	158	case CPUFREQ_RELATION_L:
1e498856	159	if (freq > target_freq) {
1da177e4 LT	160	if (freq <= optimal.frequency) {
1da177e4 LT	161	optimal.frequency = freq;
50701588	162	optimal.driver_data = i;
1da177e4 LT	163	}
	164	} else {
	165	if (freq >= suboptimal.frequency) {
	166	suboptimal.frequency = freq;
50701588	167	suboptimal.driver_data = i;
1da177e4 LT	168	}
	169	}
	170	break;
	171	}
	172	}
50701588 VK	173	if (optimal.driver_data > i) {
50701588 VK	174	if (suboptimal.driver_data > i)
1da177e4	175	return -EINVAL;
50701588	176	*index = suboptimal.driver_data;
1da177e4	177	} else
50701588	178	*index = optimal.driver_data;
1da177e4	179
ae87f10f VK	180	pr_debug("target index is %u, freq is:%u kHz\n", *index,
ae87f10f VK	181	table[*index].frequency);
1da177e4 LT	182
	183	return 0;
	184	}
	185	EXPORT_SYMBOL_GPL(cpufreq_frequency_table_target);
	186
d3916691 VK	187	int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
	188	unsigned int freq)
	189	{
041526f9	190	struct cpufreq_frequency_table pos, table;
d3916691 VK	191
	192	table = cpufreq_frequency_get_table(policy->cpu);
	193	if (unlikely(!table)) {
	194	pr_debug("%s: Unable to find frequency table\n", __func__);
	195	return -ENOENT;
	196	}
	197
041526f9 SK	198	cpufreq_for_each_valid_entry(pos, table)
	199	if (pos->frequency == freq)
	200	return pos - table;
d3916691 VK	201
	202	return -EINVAL;
	203	}
	204	EXPORT_SYMBOL_GPL(cpufreq_frequency_table_get_index);
	205
1da177e4	206	/**
e32d22f7	207	* show_available_freqs - show available frequencies for the specified CPU
1da177e4	208	*/
6f19efc0 LM	209	static ssize_t show_available_freqs(struct cpufreq_policy policy, char buf,
6f19efc0 LM	210	bool show_boost)
1da177e4	211	{
1da177e4	212	ssize_t count = 0;
041526f9	213	struct cpufreq_frequency_table pos, table = policy->freq_table;
1da177e4	214
e0b3165b	215	if (!table)
1da177e4 LT	216	return -ENODEV;
1da177e4 LT	217
041526f9	218	cpufreq_for_each_valid_entry(pos, table) {
6f19efc0 LM	219	/*
	220	* show_boost = true and driver_data = BOOST freq
	221	* display BOOST freqs
	222	*
	223	* show_boost = false and driver_data = BOOST freq
	224	* show_boost = true and driver_data != BOOST freq
	225	* continue - do not display anything
	226	*
	227	* show_boost = false and driver_data != BOOST freq
	228	* display NON BOOST freqs
	229	*/
041526f9	230	if (show_boost ^ (pos->flags & CPUFREQ_BOOST_FREQ))
6f19efc0 LM	231	continue;
6f19efc0 LM	232
041526f9	233	count += sprintf(&buf[count], "%d ", pos->frequency);
1da177e4 LT	234	}
	235	count += sprintf(&buf[count], "\n");
	236
	237	return count;
	238
	239	}
	240
6f19efc0 LM	241	#define cpufreq_attr_available_freq(_name) \
	242	struct freq_attr cpufreq_freq_attr_##_name##_freqs = \
	243	__ATTR_RO(_name##_frequencies)
	244
	245	/**
	246	* show_scaling_available_frequencies - show available normal frequencies for
	247	* the specified CPU
	248	*/
	249	static ssize_t scaling_available_frequencies_show(struct cpufreq_policy *policy,
	250	char *buf)
	251	{
	252	return show_available_freqs(policy, buf, false);
	253	}
	254	cpufreq_attr_available_freq(scaling_available);
1da177e4 LT	255	EXPORT_SYMBOL_GPL(cpufreq_freq_attr_scaling_available_freqs);
1da177e4 LT	256
6f19efc0 LM	257	/**
	258	* show_available_boost_freqs - show available boost frequencies for
	259	* the specified CPU
	260	*/
	261	static ssize_t scaling_boost_frequencies_show(struct cpufreq_policy *policy,
	262	char *buf)
	263	{
	264	return show_available_freqs(policy, buf, true);
	265	}
	266	cpufreq_attr_available_freq(scaling_boost);
	267	EXPORT_SYMBOL_GPL(cpufreq_freq_attr_scaling_boost_freqs);
	268
18434512 VK	269	struct freq_attr *cpufreq_generic_attr[] = {
18434512 VK	270	&cpufreq_freq_attr_scaling_available_freqs,
6f19efc0 LM	271	#ifdef CONFIG_CPU_FREQ_BOOST_SW
	272	&cpufreq_freq_attr_scaling_boost_freqs,
	273	#endif
18434512 VK	274	NULL,
	275	};
	276	EXPORT_SYMBOL_GPL(cpufreq_generic_attr);
	277
27047a60 VK	278	int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
	279	struct cpufreq_frequency_table *table)
	280	{
	281	int ret = cpufreq_frequency_table_cpuinfo(policy, table);
	282
	283	if (!ret)
e0b3165b	284	policy->freq_table = table;
27047a60 VK	285
	286	return ret;
	287	}
	288	EXPORT_SYMBOL_GPL(cpufreq_table_validate_and_show);
	289
e0b3165b	290	struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
b8eed8af	291
1da177e4 LT	292	struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu)
1da177e4 LT	293	{
e0b3165b VK	294	struct cpufreq_policy *policy = cpufreq_cpu_get_raw(cpu);
e0b3165b VK	295	return policy ? policy->freq_table : NULL;
1da177e4 LT	296	}
	297	EXPORT_SYMBOL_GPL(cpufreq_frequency_get_table);
	298
97acec55 DJ	299	MODULE_AUTHOR("Dominik Brodowski <linux@brodo.de>");
	300	MODULE_DESCRIPTION("CPUfreq frequency table helpers");
	301	MODULE_LICENSE("GPL");