[mirror_ubuntu-bionic-kernel.git] / include / linux / pm_opp.h

/*
 * Generic OPP Interface
 *
 * Copyright (C) 2009-2010 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.
 */

#ifndef __LINUX_OPP_H__
#define __LINUX_OPP_H__

#include <linux/err.h>
#include <linux/notifier.h>

struct clk;
struct regulator;
struct dev_pm_opp;
struct device;
struct opp_table;

enum dev_pm_opp_event {
	OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
};

/**
 * struct dev_pm_opp_supply - Power supply voltage/current values
 * @u_volt:	Target voltage in microvolts corresponding to this OPP
 * @u_volt_min:	Minimum voltage in microvolts corresponding to this OPP
 * @u_volt_max:	Maximum voltage in microvolts corresponding to this OPP
 * @u_amp:	Maximum current drawn by the device in microamperes
 *
 * This structure stores the voltage/current values for a single power supply.
 */
struct dev_pm_opp_supply {
	unsigned long u_volt;
	unsigned long u_volt_min;
	unsigned long u_volt_max;
	unsigned long u_amp;
};

/**
 * struct dev_pm_opp_info - OPP freq/voltage/current values
 * @rate:	Target clk rate in hz
 * @supplies:	Array of voltage/current values for all power supplies
 *
 * This structure stores the freq/voltage/current values for a single OPP.
 */
struct dev_pm_opp_info {
	unsigned long rate;
	struct dev_pm_opp_supply *supplies;
};

/**
 * struct dev_pm_set_opp_data - Set OPP data
 * @old_opp:	Old OPP info
 * @new_opp:	New OPP info
 * @regulators:	Array of regulator pointers
 * @regulator_count: Number of regulators
 * @clk:	Pointer to clk
 * @dev:	Pointer to the struct device
 *
 * This structure contains all information required for setting an OPP.
 */
struct dev_pm_set_opp_data {
	struct dev_pm_opp_info old_opp;
	struct dev_pm_opp_info new_opp;

	struct regulator **regulators;
	unsigned int regulator_count;
	struct clk *clk;
	struct device *dev;
};

#if defined(CONFIG_PM_OPP)

unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);

unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);

bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);

int dev_pm_opp_get_opp_count(struct device *dev);
unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
struct dev_pm_opp *dev_pm_opp_get_suspend_opp(struct device *dev);

struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
					      unsigned long freq,
					      bool available);

struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
					      unsigned long *freq);

struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
					     unsigned long *freq);

int dev_pm_opp_add(struct device *dev, unsigned long freq,
		   unsigned long u_volt);
void dev_pm_opp_remove(struct device *dev, unsigned long freq);

int dev_pm_opp_enable(struct device *dev, unsigned long freq);

int dev_pm_opp_disable(struct device *dev, unsigned long freq);

struct srcu_notifier_head *dev_pm_opp_get_notifier(struct device *dev);
int dev_pm_opp_set_supported_hw(struct device *dev, const u32 *versions,
				unsigned int count);
void dev_pm_opp_put_supported_hw(struct device *dev);
int dev_pm_opp_set_prop_name(struct device *dev, const char *name);
void dev_pm_opp_put_prop_name(struct device *dev);
struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count);
void dev_pm_opp_put_regulators(struct opp_table *opp_table);
int dev_pm_opp_register_set_opp_helper(struct device *dev, int (*set_opp)(struct dev_pm_set_opp_data *data));
void dev_pm_opp_register_put_opp_helper(struct device *dev);
int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask);
int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
void dev_pm_opp_remove_table(struct device *dev);
void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
#else
static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
{
	return 0;
}

static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
{
	return 0;
}

static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
{
	return false;
}

static inline int dev_pm_opp_get_opp_count(struct device *dev)
{
	return 0;
}

static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
{
	return 0;
}

static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
{
	return 0;
}

static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
{
	return 0;
}

static inline struct dev_pm_opp *dev_pm_opp_get_suspend_opp(struct device *dev)
{
	return NULL;
}

static inline struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
					unsigned long freq, bool available)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
					unsigned long *freq)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
					unsigned long *freq)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
					unsigned long u_volt)
{
	return -ENOTSUPP;
}

static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
{
}

static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
{
	return 0;
}

static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
{
	return 0;
}

static inline struct srcu_notifier_head *dev_pm_opp_get_notifier(
							struct device *dev)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline int dev_pm_opp_set_supported_hw(struct device *dev,
					      const u32 *versions,
					      unsigned int count)
{
	return -ENOTSUPP;
}

static inline void dev_pm_opp_put_supported_hw(struct device *dev) {}

static inline int dev_pm_opp_register_set_opp_helper(struct device *dev,
			int (*set_opp)(struct dev_pm_set_opp_data *data))
{
	return -ENOTSUPP;
}

static inline void dev_pm_opp_register_put_opp_helper(struct device *dev) {}

static inline int dev_pm_opp_set_prop_name(struct device *dev, const char *name)
{
	return -ENOTSUPP;
}

static inline void dev_pm_opp_put_prop_name(struct device *dev) {}

static inline struct opp_table *dev_pm_opp_set_regulators(struct device *dev, const char * const names[], unsigned int count)
{
	return ERR_PTR(-ENOTSUPP);
}

static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}

static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
{
	return -ENOTSUPP;
}

static inline int dev_pm_opp_set_sharing_cpus(struct device *cpu_dev, const struct cpumask *cpumask)
{
	return -ENOTSUPP;
}

static inline int dev_pm_opp_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
{
	return -EINVAL;
}

static inline void dev_pm_opp_remove_table(struct device *dev)
{
}

static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
{
}

#endif		/* CONFIG_PM_OPP */

#if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
int dev_pm_opp_of_add_table(struct device *dev);
void dev_pm_opp_of_remove_table(struct device *dev);
int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask);
#else
static inline int dev_pm_opp_of_add_table(struct device *dev)
{
	return -ENOTSUPP;
}

static inline void dev_pm_opp_of_remove_table(struct device *dev)
{
}

static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
{
	return -ENOTSUPP;
}

static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
{
}

static inline int dev_pm_opp_of_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
{
	return -ENOTSUPP;
}
#endif

#endif		/* __LINUX_OPP_H__ */
Commit	Line	Data
e1f60b29 NM	1	/*
	2	* Generic OPP Interface
	3	*
	4	* Copyright (C) 2009-2010 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	*/
	13
	14	#ifndef __LINUX_OPP_H__
	15	#define __LINUX_OPP_H__
	16
	17	#include <linux/err.h>
03ca370f	18	#include <linux/notifier.h>
e1f60b29	19
94735585 VK	20	struct clk;
94735585 VK	21	struct regulator;
47d43ba7	22	struct dev_pm_opp;
313162d0	23	struct device;
91291d9a	24	struct opp_table;
e1f60b29	25
47d43ba7	26	enum dev_pm_opp_event {
129eec55	27	OPP_EVENT_ADD, OPP_EVENT_REMOVE, OPP_EVENT_ENABLE, OPP_EVENT_DISABLE,
03ca370f MH	28	};
03ca370f MH	29
0f0fe7e0 VK	30	/**
	31	* struct dev_pm_opp_supply - Power supply voltage/current values
	32	* @u_volt: Target voltage in microvolts corresponding to this OPP
	33	* @u_volt_min: Minimum voltage in microvolts corresponding to this OPP
	34	* @u_volt_max: Maximum voltage in microvolts corresponding to this OPP
	35	* @u_amp: Maximum current drawn by the device in microamperes
	36	*
	37	* This structure stores the voltage/current values for a single power supply.
	38	*/
	39	struct dev_pm_opp_supply {
	40	unsigned long u_volt;
	41	unsigned long u_volt_min;
	42	unsigned long u_volt_max;
	43	unsigned long u_amp;
	44	};
	45
94735585 VK	46	/**
	47	* struct dev_pm_opp_info - OPP freq/voltage/current values
	48	* @rate: Target clk rate in hz
	49	* @supplies: Array of voltage/current values for all power supplies
	50	*
	51	* This structure stores the freq/voltage/current values for a single OPP.
	52	*/
	53	struct dev_pm_opp_info {
	54	unsigned long rate;
	55	struct dev_pm_opp_supply *supplies;
	56	};
	57
	58	/**
	59	* struct dev_pm_set_opp_data - Set OPP data
	60	* @old_opp: Old OPP info
	61	* @new_opp: New OPP info
	62	* @regulators: Array of regulator pointers
	63	* @regulator_count: Number of regulators
	64	* @clk: Pointer to clk
	65	* @dev: Pointer to the struct device
	66	*
	67	* This structure contains all information required for setting an OPP.
	68	*/
	69	struct dev_pm_set_opp_data {
	70	struct dev_pm_opp_info old_opp;
	71	struct dev_pm_opp_info new_opp;
	72
	73	struct regulator **regulators;
	74	unsigned int regulator_count;
	75	struct clk *clk;
	76	struct device *dev;
	77	};
	78
e1f60b29 NM	79	#if defined(CONFIG_PM_OPP)
e1f60b29 NM	80
47d43ba7	81	unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp);
e1f60b29	82
47d43ba7	83	unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp);
e1f60b29	84
19445b25 BZ	85	bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp);
19445b25 BZ	86
5d4879cd	87	int dev_pm_opp_get_opp_count(struct device *dev);
3ca9bb33	88	unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev);
655c9df9	89	unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev);
21743447	90	unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev);
4eafbd15	91	struct dev_pm_opp dev_pm_opp_get_suspend_opp(struct device dev);
e1f60b29	92
47d43ba7 NM	93	struct dev_pm_opp dev_pm_opp_find_freq_exact(struct device dev,
	94	unsigned long freq,
	95	bool available);
e1f60b29	96
47d43ba7 NM	97	struct dev_pm_opp dev_pm_opp_find_freq_floor(struct device dev,
47d43ba7 NM	98	unsigned long *freq);
e1f60b29	99
47d43ba7 NM	100	struct dev_pm_opp dev_pm_opp_find_freq_ceil(struct device dev,
47d43ba7 NM	101	unsigned long *freq);
e1f60b29	102
5d4879cd NM	103	int dev_pm_opp_add(struct device *dev, unsigned long freq,
5d4879cd NM	104	unsigned long u_volt);
129eec55	105	void dev_pm_opp_remove(struct device *dev, unsigned long freq);
e1f60b29	106
5d4879cd	107	int dev_pm_opp_enable(struct device *dev, unsigned long freq);
e1f60b29	108
5d4879cd	109	int dev_pm_opp_disable(struct device *dev, unsigned long freq);
e1f60b29	110
5d4879cd	111	struct srcu_notifier_head dev_pm_opp_get_notifier(struct device dev);
7de36b0a VK	112	int dev_pm_opp_set_supported_hw(struct device dev, const u32 versions,
	113	unsigned int count);
	114	void dev_pm_opp_put_supported_hw(struct device *dev);
01fb4d3c VK	115	int dev_pm_opp_set_prop_name(struct device dev, const char name);
01fb4d3c VK	116	void dev_pm_opp_put_prop_name(struct device *dev);
dfbe4678 VK	117	struct opp_table dev_pm_opp_set_regulators(struct device dev, const char * const names[], unsigned int count);
dfbe4678 VK	118	void dev_pm_opp_put_regulators(struct opp_table *opp_table);
4dab160e VK	119	int dev_pm_opp_register_set_opp_helper(struct device dev, int (set_opp)(struct dev_pm_set_opp_data *data));
4dab160e VK	120	void dev_pm_opp_register_put_opp_helper(struct device *dev);
6a0712f6	121	int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq);
ddbb74bc AB	122	int dev_pm_opp_set_sharing_cpus(struct device cpu_dev, const struct cpumask cpumask);
ddbb74bc AB	123	int dev_pm_opp_get_sharing_cpus(struct device cpu_dev, struct cpumask cpumask);
411466c5 SH	124	void dev_pm_opp_remove_table(struct device *dev);
411466c5 SH	125	void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask);
e1f60b29	126	#else
47d43ba7	127	static inline unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
e1f60b29 NM	128	{
	129	return 0;
	130	}
	131
47d43ba7	132	static inline unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
e1f60b29 NM	133	{
	134	return 0;
	135	}
	136
19445b25 BZ	137	static inline bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
	138	{
	139	return false;
	140	}
	141
5d4879cd	142	static inline int dev_pm_opp_get_opp_count(struct device *dev)
e1f60b29 NM	143	{
	144	return 0;
	145	}
	146
3ca9bb33 VK	147	static inline unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
	148	{
	149	return 0;
	150	}
	151
655c9df9 VK	152	static inline unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
	153	{
	154	return 0;
	155	}
	156
21743447 VK	157	static inline unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
	158	{
	159	return 0;
	160	}
	161
4eafbd15 BZ	162	static inline struct dev_pm_opp dev_pm_opp_get_suspend_opp(struct device dev)
	163	{
	164	return NULL;
	165	}
	166
47d43ba7	167	static inline struct dev_pm_opp dev_pm_opp_find_freq_exact(struct device dev,
e1f60b29 NM	168	unsigned long freq, bool available)
e1f60b29 NM	169	{
d708b384	170	return ERR_PTR(-ENOTSUPP);
e1f60b29 NM	171	}
e1f60b29 NM	172
47d43ba7	173	static inline struct dev_pm_opp dev_pm_opp_find_freq_floor(struct device dev,
e1f60b29 NM	174	unsigned long *freq)
e1f60b29 NM	175	{
d708b384	176	return ERR_PTR(-ENOTSUPP);
e1f60b29 NM	177	}
e1f60b29 NM	178
47d43ba7	179	static inline struct dev_pm_opp dev_pm_opp_find_freq_ceil(struct device dev,
e1f60b29 NM	180	unsigned long *freq)
e1f60b29 NM	181	{
d708b384	182	return ERR_PTR(-ENOTSUPP);
e1f60b29 NM	183	}
e1f60b29 NM	184
5d4879cd	185	static inline int dev_pm_opp_add(struct device *dev, unsigned long freq,
e1f60b29 NM	186	unsigned long u_volt)
e1f60b29 NM	187	{
d708b384	188	return -ENOTSUPP;
e1f60b29 NM	189	}
e1f60b29 NM	190
129eec55 VK	191	static inline void dev_pm_opp_remove(struct device *dev, unsigned long freq)
	192	{
	193	}
	194
5d4879cd	195	static inline int dev_pm_opp_enable(struct device *dev, unsigned long freq)
e1f60b29 NM	196	{
	197	return 0;
	198	}
	199
5d4879cd	200	static inline int dev_pm_opp_disable(struct device *dev, unsigned long freq)
e1f60b29 NM	201	{
	202	return 0;
	203	}
03ca370f	204
5d4879cd NM	205	static inline struct srcu_notifier_head *dev_pm_opp_get_notifier(
5d4879cd NM	206	struct device *dev)
03ca370f	207	{
d708b384	208	return ERR_PTR(-ENOTSUPP);
03ca370f	209	}
7de36b0a VK	210
	211	static inline int dev_pm_opp_set_supported_hw(struct device *dev,
	212	const u32 *versions,
	213	unsigned int count)
	214	{
d708b384	215	return -ENOTSUPP;
7de36b0a VK	216	}
	217
	218	static inline void dev_pm_opp_put_supported_hw(struct device *dev) {}
	219
4dab160e VK	220	static inline int dev_pm_opp_register_set_opp_helper(struct device *dev,
	221	int (set_opp)(struct dev_pm_set_opp_data data))
	222	{
	223	return -ENOTSUPP;
	224	}
	225
	226	static inline void dev_pm_opp_register_put_opp_helper(struct device *dev) {}
	227
01fb4d3c VK	228	static inline int dev_pm_opp_set_prop_name(struct device dev, const char name)
01fb4d3c VK	229	{
d708b384	230	return -ENOTSUPP;
01fb4d3c VK	231	}
	232
	233	static inline void dev_pm_opp_put_prop_name(struct device *dev) {}
	234
dfbe4678	235	static inline struct opp_table dev_pm_opp_set_regulators(struct device dev, const char * const names[], unsigned int count)
9f8ea969	236	{
91291d9a	237	return ERR_PTR(-ENOTSUPP);
9f8ea969 VK	238	}
9f8ea969 VK	239
dfbe4678	240	static inline void dev_pm_opp_put_regulators(struct opp_table *opp_table) {}
9f8ea969	241
6a0712f6 VK	242	static inline int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
6a0712f6 VK	243	{
d708b384	244	return -ENOTSUPP;
6a0712f6 VK	245	}
6a0712f6 VK	246
ddbb74bc	247	static inline int dev_pm_opp_set_sharing_cpus(struct device cpu_dev, const struct cpumask cpumask)
642aa8ce	248	{
d708b384	249	return -ENOTSUPP;
642aa8ce VK	250	}
642aa8ce VK	251
ddbb74bc	252	static inline int dev_pm_opp_get_sharing_cpus(struct device cpu_dev, struct cpumask cpumask)
6f707daa VK	253	{
	254	return -EINVAL;
	255	}
	256
411466c5 SH	257	static inline void dev_pm_opp_remove_table(struct device *dev)
	258	{
	259	}
	260
	261	static inline void dev_pm_opp_cpumask_remove_table(const struct cpumask *cpumask)
	262	{
	263	}
	264
a96d69d1	265	#endif /* CONFIG_PM_OPP */
e1f60b29	266
d6561bb2	267	#if defined(CONFIG_PM_OPP) && defined(CONFIG_OF)
8f8d37b2 VK	268	int dev_pm_opp_of_add_table(struct device *dev);
8f8d37b2 VK	269	void dev_pm_opp_of_remove_table(struct device *dev);
ddbb74bc AB	270	int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask);
	271	void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask);
	272	int dev_pm_opp_of_get_sharing_cpus(struct device cpu_dev, struct cpumask cpumask);
d6561bb2	273	#else
8f8d37b2	274	static inline int dev_pm_opp_of_add_table(struct device *dev)
d6561bb2	275	{
d708b384	276	return -ENOTSUPP;
d6561bb2	277	}
129eec55	278
8f8d37b2	279	static inline void dev_pm_opp_of_remove_table(struct device *dev)
129eec55 VK	280	{
129eec55 VK	281	}
8d4d4e98	282
ddbb74bc	283	static inline int dev_pm_opp_of_cpumask_add_table(const struct cpumask *cpumask)
8d4d4e98	284	{
d708b384	285	return -ENOTSUPP;
8d4d4e98 VK	286	}
8d4d4e98 VK	287
ddbb74bc	288	static inline void dev_pm_opp_of_cpumask_remove_table(const struct cpumask *cpumask)
8d4d4e98 VK	289	{
	290	}
	291
ddbb74bc	292	static inline int dev_pm_opp_of_get_sharing_cpus(struct device cpu_dev, struct cpumask cpumask)
8d4d4e98	293	{
d708b384	294	return -ENOTSUPP;
8d4d4e98	295	}
d6561bb2 SG	296	#endif
d6561bb2 SG	297
e1f60b29	298	#endif /* __LINUX_OPP_H__ */