[deliverable/linux.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)
{
	unsigned int min_freq = ~0;
	unsigned int max_freq = 0;
	unsigned int i;

	for (i = 0; (table[i].frequency != CPUFREQ_TABLE_END); i++) {
		unsigned int freq = table[i].frequency;
		if (freq == CPUFREQ_ENTRY_INVALID) {
			pr_debug("table entry %u is invalid, skipping\n", i);

			continue;
		}
		if (!cpufreq_boost_enabled()
		    && (table[i].flags & CPUFREQ_BOOST_FREQ))
			continue;

		pr_debug("table entry %u: %u kHz\n", i, 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)
{
	unsigned int next_larger = ~0, freq, i = 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);

	for (; freq = table[i].frequency, freq != CPUFREQ_TABLE_END; i++) {
		if (freq == CPUFREQ_ENTRY_INVALID)
			continue;
		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,
	};
	unsigned int i;

	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;
	}

	for (i = 0; (table[i].frequency != CPUFREQ_TABLE_END); i++) {
		unsigned int freq = table[i].frequency;
		if (freq == CPUFREQ_ENTRY_INVALID)
			continue;
		if ((freq < policy->min) || (freq > policy->max))
			continue;
		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 *table;
	int i;

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

	for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
		if (table[i].frequency == freq)
			return i;
	}

	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)
{
	unsigned int i = 0;
	ssize_t count = 0;
	struct cpufreq_frequency_table *table = policy->freq_table;

	if (!table)
		return -ENODEV;

	for (i = 0; (table[i].frequency != CPUFREQ_TABLE_END); i++) {
		if (table[i].frequency == CPUFREQ_ENTRY_INVALID)
			continue;
		/*
		 * 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 ^ (table[i].flags & CPUFREQ_BOOST_FREQ))
			continue;

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