[mirror_ubuntu-bionic-kernel.git] / drivers / opp / cpu.c

/*
 * Generic OPP helper interface for CPU device
 *
 * Copyright (C) 2009-2014 Texas Instruments Incorporated.
 *	Nishanth Menon
 *	Romit Dasgupta
 *	Kevin Hilman
 *
 * 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/cpu.h>
#include <linux/cpufreq.h>
#include <linux/err.h>
#include <linux/errno.h>
#include <linux/export.h>
#include <linux/slab.h>

#include "opp.h"

#ifdef CONFIG_CPU_FREQ

/**
 * dev_pm_opp_init_cpufreq_table() - create a cpufreq table for a device
 * @dev:	device for which we do this operation
 * @table:	Cpufreq table returned back to caller
 *
 * Generate a cpufreq table for a provided device- this assumes that the
 * opp table is already initialized and ready for usage.
 *
 * This function allocates required memory for the cpufreq table. It is
 * expected that the caller does the required maintenance such as freeing
 * the table as required.
 *
 * Returns -EINVAL for bad pointers, -ENODEV if the device is not found, -ENOMEM
 * if no memory available for the operation (table is not populated), returns 0
 * if successful and table is populated.
 *
 * WARNING: It is  important for the callers to ensure refreshing their copy of
 * the table if any of the mentioned functions have been invoked in the interim.
 */
int dev_pm_opp_init_cpufreq_table(struct device *dev,
				  struct cpufreq_frequency_table **table)
{
	struct dev_pm_opp *opp;
	struct cpufreq_frequency_table *freq_table = NULL;
	int i, max_opps, ret = 0;
	unsigned long rate;

	max_opps = dev_pm_opp_get_opp_count(dev);
	if (max_opps <= 0)
		return max_opps ? max_opps : -ENODATA;

	freq_table = kcalloc((max_opps + 1), sizeof(*freq_table), GFP_ATOMIC);
	if (!freq_table)
		return -ENOMEM;

	for (i = 0, rate = 0; i < max_opps; i++, rate++) {
		/* find next rate */
		opp = dev_pm_opp_find_freq_ceil(dev, &rate);
		if (IS_ERR(opp)) {
			ret = PTR_ERR(opp);
			goto out;
		}
		freq_table[i].driver_data = i;
		freq_table[i].frequency = rate / 1000;

		/* Is Boost/turbo opp ? */
		if (dev_pm_opp_is_turbo(opp))
			freq_table[i].flags = CPUFREQ_BOOST_FREQ;

		dev_pm_opp_put(opp);
	}

	freq_table[i].driver_data = i;
	freq_table[i].frequency = CPUFREQ_TABLE_END;

	*table = &freq_table[0];

out:
	if (ret)
		kfree(freq_table);

	return ret;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_init_cpufreq_table);

/**
 * dev_pm_opp_free_cpufreq_table() - free the cpufreq table
 * @dev:	device for which we do this operation
 * @table:	table to free
 *
 * Free up the table allocated by dev_pm_opp_init_cpufreq_table
 */
void dev_pm_opp_free_cpufreq_table(struct device *dev,
				   struct cpufreq_frequency_table **table)
{
	if (!table)
		return;

	kfree(*table);
	*table = NULL;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_free_cpufreq_table);
#endif	/* CONFIG_CPU_FREQ */

void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, bool of)
{
	struct device *cpu_dev;
	int cpu;

	WARN_ON(cpumask_empty(cpumask));

	for_each_cpu(cpu, cpumask) {
		cpu_dev = get_cpu_device(cpu);
		if (!cpu_dev) {
			pr_err("%s: failed to get cpu%d device\n", __func__,
			       cpu);
			continue;
		}

		if (of)
			dev_pm_opp_of_remove_table(cpu_dev);
		else
			dev_pm_opp_remove_table(cpu_dev);
	}
}

/**
 * dev_pm_opp_cpumask_remove_table() - Removes OPP table for @cpumask
 * @cpumask:	cpumask for which OPP table needs to be removed
 *
 * This removes the OPP tables for CPUs present in the @cpumask.
 * This should be used to remove all the OPPs entries associated with
 * the cpus in @cpumask.
 */
void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
{
	_dev_pm_opp_cpumask_remove_table(cpumask, false);
}
EXPORT_SYMBOL_GPL(dev_pm_opp_cpumask_remove_table);

/**
 * dev_pm_opp_set_sharing_cpus() - Mark OPP table as shared by few CPUs
 * @cpu_dev:	CPU device for which we do this operation
 * @cpumask:	cpumask of the CPUs which share the OPP table with @cpu_dev
 *
 * This marks OPP table of the @cpu_dev as shared by the CPUs present in
 * @cpumask.
 *
 * Returns -ENODEV if OPP table isn't already present.
 */
int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev,
				const struct cpumask *cpumask)
{
	struct opp_device *opp_dev;
	struct opp_table *opp_table;
	struct device *dev;
	int cpu, ret = 0;

	opp_table = _find_opp_table(cpu_dev);
	if (IS_ERR(opp_table))
		return PTR_ERR(opp_table);

	for_each_cpu(cpu, cpumask) {
		if (cpu == cpu_dev->id)
			continue;

		dev = get_cpu_device(cpu);
		if (!dev) {
			dev_err(cpu_dev, "%s: failed to get cpu%d device\n",
				__func__, cpu);
			continue;
		}

		opp_dev = _add_opp_dev(dev, opp_table);
		if (!opp_dev) {
			dev_err(dev, "%s: failed to add opp-dev for cpu%d device\n",
				__func__, cpu);
			continue;
		}

		/* Mark opp-table as multiple CPUs are sharing it now */
		opp_table->shared_opp = OPP_TABLE_ACCESS_SHARED;
	}

	dev_pm_opp_put_opp_table(opp_table);

	return ret;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_set_sharing_cpus);

/**
 * dev_pm_opp_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with @cpu_dev
 * @cpu_dev:	CPU device for which we do this operation
 * @cpumask:	cpumask to update with information of sharing CPUs
 *
 * This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
 *
 * Returns -ENODEV if OPP table isn't already present and -EINVAL if the OPP
 * table's status is access-unknown.
 */
int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
{
	struct opp_device *opp_dev;
	struct opp_table *opp_table;
	int ret = 0;

	opp_table = _find_opp_table(cpu_dev);
	if (IS_ERR(opp_table))
		return PTR_ERR(opp_table);

	if (opp_table->shared_opp == OPP_TABLE_ACCESS_UNKNOWN) {
		ret = -EINVAL;
		goto put_opp_table;
	}

	cpumask_clear(cpumask);

	if (opp_table->shared_opp == OPP_TABLE_ACCESS_SHARED) {
		list_for_each_entry(opp_dev, &opp_table->dev_list, node)
			cpumask_set_cpu(opp_dev->dev->id, cpumask);
	} else {
		cpumask_set_cpu(cpu_dev->id, cpumask);
	}

put_opp_table:
	dev_pm_opp_put_opp_table(opp_table);

	return ret;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_get_sharing_cpus);
Commit	Line	Data
a0dd7b79	1	/*
33692dc3	2	* Generic OPP helper interface for CPU device
a0dd7b79 NM	3	*
	4	* Copyright (C) 2009-2014 Texas Instruments Incorporated.
	5	* Nishanth Menon
	6	* Romit Dasgupta
	7	* Kevin Hilman
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*/
d6d2a528 VK	13
	14	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
	15
f59d3ee8	16	#include <linux/cpu.h>
a0dd7b79	17	#include <linux/cpufreq.h>
a0dd7b79 NM	18	#include <linux/err.h>
	19	#include <linux/errno.h>
	20	#include <linux/export.h>
a0dd7b79 NM	21	#include <linux/slab.h>
a0dd7b79 NM	22
f59d3ee8 VK	23	#include "opp.h"
f59d3ee8 VK	24
33692dc3	25	#ifdef CONFIG_CPU_FREQ
f59d3ee8	26
a0dd7b79 NM	27	/**
	28	* dev_pm_opp_init_cpufreq_table() - create a cpufreq table for a device
	29	* @dev: device for which we do this operation
	30	* @table: Cpufreq table returned back to caller
	31	*
	32	* Generate a cpufreq table for a provided device- this assumes that the
2c2709dc	33	* opp table is already initialized and ready for usage.
a0dd7b79 NM	34	*
	35	* This function allocates required memory for the cpufreq table. It is
	36	* expected that the caller does the required maintenance such as freeing
	37	* the table as required.
	38	*
	39	* Returns -EINVAL for bad pointers, -ENODEV if the device is not found, -ENOMEM
	40	* if no memory available for the operation (table is not populated), returns 0
	41	* if successful and table is populated.
	42	*
	43	* WARNING: It is important for the callers to ensure refreshing their copy of
	44	* the table if any of the mentioned functions have been invoked in the interim.
a0dd7b79 NM	45	*/
	46	int dev_pm_opp_init_cpufreq_table(struct device *dev,
	47	struct cpufreq_frequency_table **table)
	48	{
	49	struct dev_pm_opp *opp;
	50	struct cpufreq_frequency_table *freq_table = NULL;
	51	int i, max_opps, ret = 0;
	52	unsigned long rate;
	53
a0dd7b79	54	max_opps = dev_pm_opp_get_opp_count(dev);
8a31d9d9 VK	55	if (max_opps <= 0)
8a31d9d9 VK	56	return max_opps ? max_opps : -ENODATA;
a0dd7b79	57
d3599920	58	freq_table = kcalloc((max_opps + 1), sizeof(*freq_table), GFP_ATOMIC);
8a31d9d9 VK	59	if (!freq_table)
8a31d9d9 VK	60	return -ENOMEM;
a0dd7b79 NM	61
	62	for (i = 0, rate = 0; i < max_opps; i++, rate++) {
	63	/* find next rate */
	64	opp = dev_pm_opp_find_freq_ceil(dev, &rate);
	65	if (IS_ERR(opp)) {
	66	ret = PTR_ERR(opp);
	67	goto out;
	68	}
	69	freq_table[i].driver_data = i;
	70	freq_table[i].frequency = rate / 1000;
79eea44a BZ	71
	72	/* Is Boost/turbo opp ? */
	73	if (dev_pm_opp_is_turbo(opp))
	74	freq_table[i].flags = CPUFREQ_BOOST_FREQ;
8a31d9d9 VK	75
8a31d9d9 VK	76	dev_pm_opp_put(opp);
a0dd7b79 NM	77	}
	78
	79	freq_table[i].driver_data = i;
	80	freq_table[i].frequency = CPUFREQ_TABLE_END;
	81
	82	*table = &freq_table[0];
	83
	84	out:
a0dd7b79 NM	85	if (ret)
	86	kfree(freq_table);
	87
	88	return ret;
	89	}
	90	EXPORT_SYMBOL_GPL(dev_pm_opp_init_cpufreq_table);
	91
	92	/**
	93	* dev_pm_opp_free_cpufreq_table() - free the cpufreq table
	94	* @dev: device for which we do this operation
	95	* @table: table to free
	96	*
	97	* Free up the table allocated by dev_pm_opp_init_cpufreq_table
	98	*/
	99	void dev_pm_opp_free_cpufreq_table(struct device *dev,
	100	struct cpufreq_frequency_table **table)
	101	{
	102	if (!table)
	103	return;
	104
	105	kfree(*table);
	106	*table = NULL;
	107	}
	108	EXPORT_SYMBOL_GPL(dev_pm_opp_free_cpufreq_table);
33692dc3	109	#endif /* CONFIG_CPU_FREQ */
f59d3ee8	110
f47b72a1	111	void _dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask, bool of)
f59d3ee8 VK	112	{
	113	struct device *cpu_dev;
	114	int cpu;
	115
	116	WARN_ON(cpumask_empty(cpumask));
	117
	118	for_each_cpu(cpu, cpumask) {
	119	cpu_dev = get_cpu_device(cpu);
	120	if (!cpu_dev) {
	121	pr_err("%s: failed to get cpu%d device\n", __func__,
	122	cpu);
	123	continue;
	124	}
	125
411466c5 SH	126	if (of)
	127	dev_pm_opp_of_remove_table(cpu_dev);
	128	else
	129	dev_pm_opp_remove_table(cpu_dev);
f59d3ee8 VK	130	}
f59d3ee8 VK	131	}
411466c5 SH	132
	133	/**
	134	* dev_pm_opp_cpumask_remove_table() - Removes OPP table for @cpumask
	135	* @cpumask: cpumask for which OPP table needs to be removed
	136	*
	137	* This removes the OPP tables for CPUs present in the @cpumask.
	138	* This should be used to remove all the OPPs entries associated with
	139	* the cpus in @cpumask.
411466c5 SH	140	*/
	141	void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
	142	{
	143	_dev_pm_opp_cpumask_remove_table(cpumask, false);
	144	}
	145	EXPORT_SYMBOL_GPL(dev_pm_opp_cpumask_remove_table);
	146
2c93104f VK	147	/**
	148	* dev_pm_opp_set_sharing_cpus() - Mark OPP table as shared by few CPUs
	149	* @cpu_dev: CPU device for which we do this operation
	150	* @cpumask: cpumask of the CPUs which share the OPP table with @cpu_dev
	151	*
	152	* This marks OPP table of the @cpu_dev as shared by the CPUs present in
	153	* @cpumask.
	154	*
	155	* Returns -ENODEV if OPP table isn't already present.
2c93104f	156	*/
dde370b2	157	int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev,
ddbb74bc	158	const struct cpumask *cpumask)
2c93104f VK	159	{
	160	struct opp_device *opp_dev;
	161	struct opp_table *opp_table;
	162	struct device *dev;
	163	int cpu, ret = 0;
	164
2c93104f	165	opp_table = _find_opp_table(cpu_dev);
5b650b38 VK	166	if (IS_ERR(opp_table))
5b650b38 VK	167	return PTR_ERR(opp_table);
2c93104f VK	168
	169	for_each_cpu(cpu, cpumask) {
	170	if (cpu == cpu_dev->id)
	171	continue;
	172
	173	dev = get_cpu_device(cpu);
	174	if (!dev) {
	175	dev_err(cpu_dev, "%s: failed to get cpu%d device\n",
	176	__func__, cpu);
	177	continue;
	178	}
	179
	180	opp_dev = _add_opp_dev(dev, opp_table);
	181	if (!opp_dev) {
	182	dev_err(dev, "%s: failed to add opp-dev for cpu%d device\n",
	183	__func__, cpu);
	184	continue;
	185	}
46e7a4e1 VK	186
46e7a4e1 VK	187	/* Mark opp-table as multiple CPUs are sharing it now */
79ee2e8f	188	opp_table->shared_opp = OPP_TABLE_ACCESS_SHARED;
2c93104f	189	}
5b650b38 VK	190
5b650b38 VK	191	dev_pm_opp_put_opp_table(opp_table);
2c93104f VK	192
	193	return ret;
	194	}
	195	EXPORT_SYMBOL_GPL(dev_pm_opp_set_sharing_cpus);
6f707daa VK	196
	197	/**
	198	* dev_pm_opp_get_sharing_cpus() - Get cpumask of CPUs sharing OPPs with @cpu_dev
	199	* @cpu_dev: CPU device for which we do this operation
	200	* @cpumask: cpumask to update with information of sharing CPUs
	201	*
	202	* This updates the @cpumask with CPUs that are sharing OPPs with @cpu_dev.
	203	*
79ee2e8f VK	204	* Returns -ENODEV if OPP table isn't already present and -EINVAL if the OPP
79ee2e8f VK	205	* table's status is access-unknown.
6f707daa	206	*/
ddbb74bc	207	int dev_pm_opp_get_sharing_cpus(struct device cpu_dev, struct cpumask cpumask)
6f707daa VK	208	{
	209	struct opp_device *opp_dev;
	210	struct opp_table *opp_table;
	211	int ret = 0;
	212
6f707daa	213	opp_table = _find_opp_table(cpu_dev);
5b650b38 VK	214	if (IS_ERR(opp_table))
5b650b38 VK	215	return PTR_ERR(opp_table);
6f707daa	216
79ee2e8f VK	217	if (opp_table->shared_opp == OPP_TABLE_ACCESS_UNKNOWN) {
79ee2e8f VK	218	ret = -EINVAL;
5b650b38	219	goto put_opp_table;
79ee2e8f VK	220	}
79ee2e8f VK	221
6f707daa VK	222	cpumask_clear(cpumask);
6f707daa VK	223
79ee2e8f	224	if (opp_table->shared_opp == OPP_TABLE_ACCESS_SHARED) {
6f707daa VK	225	list_for_each_entry(opp_dev, &opp_table->dev_list, node)
	226	cpumask_set_cpu(opp_dev->dev->id, cpumask);
	227	} else {
	228	cpumask_set_cpu(cpu_dev->id, cpumask);
	229	}
	230
5b650b38 VK	231	put_opp_table:
5b650b38 VK	232	dev_pm_opp_put_opp_table(opp_table);
6f707daa VK	233
	234	return ret;
	235	}
	236	EXPORT_SYMBOL_GPL(dev_pm_opp_get_sharing_cpus);