[linux-2.6-block.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].driver_data == CPUFREQ_BOOST_FREQ)
			continue;

		pr_debug("table entry %u: %u kHz, %u driver_data\n",
					i, freq, table[i].driver_data);
		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 is %u (%u kHz, %u)\n", *index, table[*index].frequency,
		table[*index].driver_data);

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