[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / cpufreq / cpufreq_governor.h

/*
 * drivers/cpufreq/cpufreq_governor.h
 *
 * Header file for CPUFreq governors common code
 *
 * Copyright	(C) 2001 Russell King
 *		(C) 2003 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>.
 *		(C) 2003 Jun Nakajima <jun.nakajima@intel.com>
 *		(C) 2009 Alexander Clouter <alex@digriz.org.uk>
 *		(c) 2012 Viresh Kumar <viresh.kumar@linaro.org>
 *
 * 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 _CPUFREQ_GOVERNOR_H
#define _CPUFREQ_GOVERNOR_H

#include <linux/cpufreq.h>
#include <linux/kobject.h>
#include <linux/mutex.h>
#include <linux/workqueue.h>
#include <linux/sysfs.h>

/*
 * The polling frequency depends on the capability of the processor. Default
 * polling frequency is 1000 times the transition latency of the processor. The
 * governor will work on any processor with transition latency <= 10mS, using
 * appropriate sampling rate.
 *
 * For CPUs with transition latency > 10mS (mostly drivers with CPUFREQ_ETERNAL)
 * this governor will not work. All times here are in uS.
 */
#define MIN_SAMPLING_RATE_RATIO			(2)
#define LATENCY_MULTIPLIER			(1000)
#define MIN_LATENCY_MULTIPLIER			(20)
#define TRANSITION_LATENCY_LIMIT		(10 * 1000 * 1000)

/* Ondemand Sampling types */
enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE};

/*
 * Macro for creating governors sysfs routines
 *
 * - gov_sys: One governor instance per whole system
 * - gov_pol: One governor instance per policy
 */

/* Create attributes */
#define gov_sys_attr_ro(_name)						\
static struct global_attr _name##_gov_sys =				\
__ATTR(_name, 0444, show_##_name##_gov_sys, NULL)

#define gov_sys_attr_rw(_name)						\
static struct global_attr _name##_gov_sys =				\
__ATTR(_name, 0644, show_##_name##_gov_sys, store_##_name##_gov_sys)

#define gov_pol_attr_ro(_name)						\
static struct freq_attr _name##_gov_pol =				\
__ATTR(_name, 0444, show_##_name##_gov_pol, NULL)

#define gov_pol_attr_rw(_name)						\
static struct freq_attr _name##_gov_pol =				\
__ATTR(_name, 0644, show_##_name##_gov_pol, store_##_name##_gov_pol)

#define gov_sys_pol_attr_rw(_name)					\
	gov_sys_attr_rw(_name);						\
	gov_pol_attr_rw(_name)

#define gov_sys_pol_attr_ro(_name)					\
	gov_sys_attr_ro(_name);						\
	gov_pol_attr_ro(_name)

/* Create show/store routines */
#define show_one(_gov, file_name)					\
static ssize_t show_##file_name##_gov_sys				\
(struct kobject *kobj, struct attribute *attr, char *buf)		\
{									\
	struct _gov##_dbs_tuners *tuners = _gov##_dbs_cdata.gdbs_data->tuners; \
	return sprintf(buf, "%u\n", tuners->file_name);			\
}									\
									\
static ssize_t show_##file_name##_gov_pol					\
(struct cpufreq_policy *policy, char *buf)				\
{									\
	struct dbs_data *dbs_data = policy->governor_data;		\
	struct _gov##_dbs_tuners *tuners = dbs_data->tuners;		\
	return sprintf(buf, "%u\n", tuners->file_name);			\
}

#define store_one(_gov, file_name)					\
static ssize_t store_##file_name##_gov_sys				\
(struct kobject *kobj, struct attribute *attr, const char *buf, size_t count)	\
{									\
	struct dbs_data *dbs_data = _gov##_dbs_cdata.gdbs_data;		\
	return store_##file_name(dbs_data, buf, count);			\
}									\
									\
static ssize_t store_##file_name##_gov_pol				\
(struct cpufreq_policy *policy, const char *buf, size_t count)		\
{									\
	struct dbs_data *dbs_data = policy->governor_data;		\
	return store_##file_name(dbs_data, buf, count);			\
}

#define show_store_one(_gov, file_name)					\
show_one(_gov, file_name);						\
store_one(_gov, file_name)

/* create helper routines */
#define define_get_cpu_dbs_routines(_dbs_info)				\
static struct cpu_dbs_common_info *get_cpu_cdbs(int cpu)		\
{									\
	return &per_cpu(_dbs_info, cpu).cdbs;				\
}									\
									\
static void *get_cpu_dbs_info_s(int cpu)				\
{									\
	return &per_cpu(_dbs_info, cpu);				\
}

/*
 * Abbreviations:
 * dbs: used as a shortform for demand based switching It helps to keep variable
 *	names smaller, simpler
 * cdbs: common dbs
 * od_*: On-demand governor
 * cs_*: Conservative governor
 */

/* Per cpu structures */
struct cpu_dbs_common_info {
	int cpu;
	u64 prev_cpu_idle;
	u64 prev_cpu_wall;
	u64 prev_cpu_nice;
	struct cpufreq_policy *cur_policy;
	struct delayed_work work;
	/*
	 * percpu mutex that serializes governor limit change with gov_dbs_timer
	 * invocation. We do not want gov_dbs_timer to run when user is changing
	 * the governor or limits.
	 */
	struct mutex timer_mutex;
	ktime_t time_stamp;
};

struct od_cpu_dbs_info_s {
	struct cpu_dbs_common_info cdbs;
	struct cpufreq_frequency_table *freq_table;
	unsigned int freq_lo;
	unsigned int freq_lo_jiffies;
	unsigned int freq_hi_jiffies;
	unsigned int rate_mult;
	unsigned int sample_type:1;
};

struct cs_cpu_dbs_info_s {
	struct cpu_dbs_common_info cdbs;
	unsigned int down_skip;
	unsigned int requested_freq;
	unsigned int enable:1;
};

/* Per policy Governers sysfs tunables */
struct od_dbs_tuners {
	unsigned int ignore_nice;
	unsigned int sampling_rate;
	unsigned int sampling_down_factor;
	unsigned int up_threshold;
	unsigned int adj_up_threshold;
	unsigned int powersave_bias;
	unsigned int io_is_busy;
};

struct cs_dbs_tuners {
	unsigned int ignore_nice;
	unsigned int sampling_rate;
	unsigned int sampling_down_factor;
	unsigned int up_threshold;
	unsigned int down_threshold;
	unsigned int freq_step;
};

/* Common Governer data across policies */
struct dbs_data;
struct common_dbs_data {
	/* Common across governors */
	#define GOV_ONDEMAND		0
	#define GOV_CONSERVATIVE	1
	int governor;
	struct attribute_group *attr_group_gov_sys; /* one governor - system */
	struct attribute_group *attr_group_gov_pol; /* one governor - policy */

	/* Common data for platforms that don't set have_governor_per_policy */
	struct dbs_data *gdbs_data;

	struct cpu_dbs_common_info *(*get_cpu_cdbs)(int cpu);
	void *(*get_cpu_dbs_info_s)(int cpu);
	void (*gov_dbs_timer)(struct work_struct *work);
	void (*gov_check_cpu)(int cpu, unsigned int load);
	int (*init)(struct dbs_data *dbs_data);
	void (*exit)(struct dbs_data *dbs_data);

	/* Governor specific ops, see below */
	void *gov_ops;
};

/* Governer Per policy data */
struct dbs_data {
	struct common_dbs_data *cdata;
	unsigned int min_sampling_rate;
	int usage_count;
	void *tuners;

	/* dbs_mutex protects dbs_enable in governor start/stop */
	struct mutex mutex;
};

/* Governor specific ops, will be passed to dbs_data->gov_ops */
struct od_ops {
	void (*powersave_bias_init_cpu)(int cpu);
	unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy,
			unsigned int freq_next, unsigned int relation);
	void (*freq_increase)(struct cpufreq_policy *p, unsigned int freq);
};

struct cs_ops {
	struct notifier_block *notifier_block;
};

static inline int delay_for_sampling_rate(unsigned int sampling_rate)
{
	int delay = usecs_to_jiffies(sampling_rate);

	/* We want all CPUs to do sampling nearly on same jiffy */
	if (num_online_cpus() > 1)
		delay -= jiffies % delay;

	return delay;
}

#define declare_show_sampling_rate_min(_gov)				\
static ssize_t show_sampling_rate_min_gov_sys				\
(struct kobject *kobj, struct attribute *attr, char *buf)		\
{									\
	struct dbs_data *dbs_data = _gov##_dbs_cdata.gdbs_data;		\
	return sprintf(buf, "%u\n", dbs_data->min_sampling_rate);	\
}									\
									\
static ssize_t show_sampling_rate_min_gov_pol				\
(struct cpufreq_policy *policy, char *buf)				\
{									\
	struct dbs_data *dbs_data = policy->governor_data;		\
	return sprintf(buf, "%u\n", dbs_data->min_sampling_rate);	\
}

u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
void dbs_check_cpu(struct dbs_data *dbs_data, int cpu);
bool need_load_eval(struct cpu_dbs_common_info *cdbs,
		unsigned int sampling_rate);
int cpufreq_governor_dbs(struct cpufreq_policy *policy,
		struct common_dbs_data *cdata, unsigned int event);
void gov_queue_work(struct dbs_data *dbs_data, struct cpufreq_policy *policy,
		unsigned int delay, bool all_cpus);
void od_register_powersave_bias_handler(unsigned int (*f)
		(struct cpufreq_policy *, unsigned int, unsigned int),
		unsigned int powersave_bias);
void od_unregister_powersave_bias_handler(void);
#endif /* _CPUFREQ_GOVERNOR_H */
Commit	Line	Data
4471a34f VK	1	/*
	2	* drivers/cpufreq/cpufreq_governor.h
	3	*
	4	* Header file for CPUFreq governors common code
	5	*
	6	* Copyright (C) 2001 Russell King
	7	* (C) 2003 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>.
	8	* (C) 2003 Jun Nakajima <jun.nakajima@intel.com>
	9	* (C) 2009 Alexander Clouter <alex@digriz.org.uk>
	10	* (c) 2012 Viresh Kumar <viresh.kumar@linaro.org>
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License version 2 as
	14	* published by the Free Software Foundation.
	15	*/
	16
beb0ff39 BP	17	#ifndef _CPUFREQ_GOVERNOR_H
beb0ff39 BP	18	#define _CPUFREQ_GOVERNOR_H
4471a34f	19
4471a34f VK	20	#include <linux/cpufreq.h>
	21	#include <linux/kobject.h>
	22	#include <linux/mutex.h>
	23	#include <linux/workqueue.h>
	24	#include <linux/sysfs.h>
	25
	26	/*
	27	* The polling frequency depends on the capability of the processor. Default
	28	* polling frequency is 1000 times the transition latency of the processor. The
	29	* governor will work on any processor with transition latency <= 10mS, using
	30	* appropriate sampling rate.
	31	*
	32	* For CPUs with transition latency > 10mS (mostly drivers with CPUFREQ_ETERNAL)
	33	* this governor will not work. All times here are in uS.
	34	*/
	35	#define MIN_SAMPLING_RATE_RATIO (2)
	36	#define LATENCY_MULTIPLIER (1000)
98104ee2	37	#define MIN_LATENCY_MULTIPLIER (20)
4471a34f VK	38	#define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000)
	39
	40	/* Ondemand Sampling types */
	41	enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE};
	42
4d5dcc42 VK	43	/*
	44	* Macro for creating governors sysfs routines
	45	*
	46	* - gov_sys: One governor instance per whole system
	47	* - gov_pol: One governor instance per policy
	48	*/
	49
	50	/* Create attributes */
	51	#define gov_sys_attr_ro(_name) \
	52	static struct global_attr _name##_gov_sys = \
	53	__ATTR(_name, 0444, show_##_name##_gov_sys, NULL)
	54
	55	#define gov_sys_attr_rw(_name) \
	56	static struct global_attr _name##_gov_sys = \
	57	__ATTR(_name, 0644, show_##_name##_gov_sys, store_##_name##_gov_sys)
	58
	59	#define gov_pol_attr_ro(_name) \
	60	static struct freq_attr _name##_gov_pol = \
	61	__ATTR(_name, 0444, show_##_name##_gov_pol, NULL)
	62
	63	#define gov_pol_attr_rw(_name) \
	64	static struct freq_attr _name##_gov_pol = \
	65	__ATTR(_name, 0644, show_##_name##_gov_pol, store_##_name##_gov_pol)
	66
	67	#define gov_sys_pol_attr_rw(_name) \
	68	gov_sys_attr_rw(_name); \
	69	gov_pol_attr_rw(_name)
	70
	71	#define gov_sys_pol_attr_ro(_name) \
	72	gov_sys_attr_ro(_name); \
	73	gov_pol_attr_ro(_name)
	74
	75	/* Create show/store routines */
	76	#define show_one(_gov, file_name) \
	77	static ssize_t show_##file_name##_gov_sys \
4471a34f VK	78	(struct kobject kobj, struct attribute attr, char *buf) \
4471a34f VK	79	{ \
4d5dcc42 VK	80	struct _gov##_dbs_tuners *tuners = _gov##_dbs_cdata.gdbs_data->tuners; \
	81	return sprintf(buf, "%u\n", tuners->file_name); \
	82	} \
	83	\
	84	static ssize_t show_##file_name##_gov_pol \
	85	(struct cpufreq_policy policy, char buf) \
	86	{ \
	87	struct dbs_data *dbs_data = policy->governor_data; \
	88	struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \
	89	return sprintf(buf, "%u\n", tuners->file_name); \
	90	}
	91
	92	#define store_one(_gov, file_name) \
	93	static ssize_t store_##file_name##_gov_sys \
	94	(struct kobject kobj, struct attribute attr, const char *buf, size_t count) \
	95	{ \
	96	struct dbs_data *dbs_data = _gov##_dbs_cdata.gdbs_data; \
	97	return store_##file_name(dbs_data, buf, count); \
	98	} \
	99	\
	100	static ssize_t store_##file_name##_gov_pol \
	101	(struct cpufreq_policy policy, const char buf, size_t count) \
	102	{ \
	103	struct dbs_data *dbs_data = policy->governor_data; \
	104	return store_##file_name(dbs_data, buf, count); \
4471a34f VK	105	}
4471a34f VK	106
4d5dcc42 VK	107	#define show_store_one(_gov, file_name) \
	108	show_one(_gov, file_name); \
	109	store_one(_gov, file_name)
	110
	111	/* create helper routines */
4471a34f VK	112	#define define_get_cpu_dbs_routines(_dbs_info) \
	113	static struct cpu_dbs_common_info *get_cpu_cdbs(int cpu) \
	114	{ \
	115	return &per_cpu(_dbs_info, cpu).cdbs; \
	116	} \
	117	\
	118	static void *get_cpu_dbs_info_s(int cpu) \
	119	{ \
	120	return &per_cpu(_dbs_info, cpu); \
	121	}
	122
	123	/*
	124	* Abbreviations:
	125	* dbs: used as a shortform for demand based switching It helps to keep variable
	126	* names smaller, simpler
	127	* cdbs: common dbs
e5dde92c	128	* od_*: On-demand governor
4471a34f VK	129	* cs_*: Conservative governor
	130	*/
	131
	132	/* Per cpu structures */
	133	struct cpu_dbs_common_info {
	134	int cpu;
1e7586a1 VK	135	u64 prev_cpu_idle;
	136	u64 prev_cpu_wall;
	137	u64 prev_cpu_nice;
4471a34f VK	138	struct cpufreq_policy *cur_policy;
	139	struct delayed_work work;
	140	/*
	141	* percpu mutex that serializes governor limit change with gov_dbs_timer
	142	* invocation. We do not want gov_dbs_timer to run when user is changing
	143	* the governor or limits.
	144	*/
	145	struct mutex timer_mutex;
da53d61e	146	ktime_t time_stamp;
4471a34f VK	147	};
	148
	149	struct od_cpu_dbs_info_s {
	150	struct cpu_dbs_common_info cdbs;
4471a34f VK	151	struct cpufreq_frequency_table *freq_table;
	152	unsigned int freq_lo;
	153	unsigned int freq_lo_jiffies;
	154	unsigned int freq_hi_jiffies;
	155	unsigned int rate_mult;
	156	unsigned int sample_type:1;
	157	};
	158
	159	struct cs_cpu_dbs_info_s {
	160	struct cpu_dbs_common_info cdbs;
	161	unsigned int down_skip;
	162	unsigned int requested_freq;
	163	unsigned int enable:1;
	164	};
	165
4d5dcc42	166	/* Per policy Governers sysfs tunables */
4471a34f VK	167	struct od_dbs_tuners {
	168	unsigned int ignore_nice;
	169	unsigned int sampling_rate;
	170	unsigned int sampling_down_factor;
	171	unsigned int up_threshold;
4bd4e428	172	unsigned int adj_up_threshold;
4471a34f VK	173	unsigned int powersave_bias;
	174	unsigned int io_is_busy;
	175	};
	176
	177	struct cs_dbs_tuners {
	178	unsigned int ignore_nice;
	179	unsigned int sampling_rate;
	180	unsigned int sampling_down_factor;
	181	unsigned int up_threshold;
	182	unsigned int down_threshold;
	183	unsigned int freq_step;
	184	};
	185
4d5dcc42 VK	186	/* Common Governer data across policies */
	187	struct dbs_data;
	188	struct common_dbs_data {
4471a34f VK	189	/* Common across governors */
	190	#define GOV_ONDEMAND 0
	191	#define GOV_CONSERVATIVE 1
	192	int governor;
4d5dcc42 VK	193	struct attribute_group attr_group_gov_sys; / one governor - system */
4d5dcc42 VK	194	struct attribute_group attr_group_gov_pol; / one governor - policy */
4471a34f	195
4d5dcc42 VK	196	/* Common data for platforms that don't set have_governor_per_policy */
4d5dcc42 VK	197	struct dbs_data *gdbs_data;
4471a34f VK	198
	199	struct cpu_dbs_common_info (get_cpu_cdbs)(int cpu);
	200	void (get_cpu_dbs_info_s)(int cpu);
	201	void (gov_dbs_timer)(struct work_struct work);
	202	void (*gov_check_cpu)(int cpu, unsigned int load);
4d5dcc42 VK	203	int (init)(struct dbs_data dbs_data);
4d5dcc42 VK	204	void (exit)(struct dbs_data dbs_data);
4471a34f VK	205
	206	/* Governor specific ops, see below */
	207	void *gov_ops;
	208	};
	209
4d5dcc42 VK	210	/* Governer Per policy data */
	211	struct dbs_data {
	212	struct common_dbs_data *cdata;
	213	unsigned int min_sampling_rate;
a97c98ad	214	int usage_count;
4d5dcc42 VK	215	void *tuners;
	216
	217	/* dbs_mutex protects dbs_enable in governor start/stop */
	218	struct mutex mutex;
	219	};
	220
4471a34f VK	221	/* Governor specific ops, will be passed to dbs_data->gov_ops */
4471a34f VK	222	struct od_ops {
4471a34f VK	223	void (*powersave_bias_init_cpu)(int cpu);
	224	unsigned int (powersave_bias_target)(struct cpufreq_policy policy,
	225	unsigned int freq_next, unsigned int relation);
	226	void (freq_increase)(struct cpufreq_policy p, unsigned int freq);
	227	};
	228
	229	struct cs_ops {
	230	struct notifier_block *notifier_block;
	231	};
	232
	233	static inline int delay_for_sampling_rate(unsigned int sampling_rate)
	234	{
	235	int delay = usecs_to_jiffies(sampling_rate);
	236
	237	/* We want all CPUs to do sampling nearly on same jiffy */
	238	if (num_online_cpus() > 1)
	239	delay -= jiffies % delay;
	240
	241	return delay;
	242	}
	243
4d5dcc42 VK	244	#define declare_show_sampling_rate_min(_gov) \
	245	static ssize_t show_sampling_rate_min_gov_sys \
	246	(struct kobject kobj, struct attribute attr, char *buf) \
	247	{ \
	248	struct dbs_data *dbs_data = _gov##_dbs_cdata.gdbs_data; \
	249	return sprintf(buf, "%u\n", dbs_data->min_sampling_rate); \
	250	} \
	251	\
	252	static ssize_t show_sampling_rate_min_gov_pol \
	253	(struct cpufreq_policy policy, char buf) \
	254	{ \
	255	struct dbs_data *dbs_data = policy->governor_data; \
	256	return sprintf(buf, "%u\n", dbs_data->min_sampling_rate); \
	257	}
	258
9366d840	259	u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
4471a34f	260	void dbs_check_cpu(struct dbs_data *dbs_data, int cpu);
4447266b VK	261	bool need_load_eval(struct cpu_dbs_common_info *cdbs,
4447266b VK	262	unsigned int sampling_rate);
4d5dcc42 VK	263	int cpufreq_governor_dbs(struct cpufreq_policy *policy,
4d5dcc42 VK	264	struct common_dbs_data *cdata, unsigned int event);
031299b3 VK	265	void gov_queue_work(struct dbs_data dbs_data, struct cpufreq_policy policy,
031299b3 VK	266	unsigned int delay, bool all_cpus);
fb30809e JS	267	void od_register_powersave_bias_handler(unsigned int (*f)
	268	(struct cpufreq_policy *, unsigned int, unsigned int),
	269	unsigned int powersave_bias);
	270	void od_unregister_powersave_bias_handler(void);
beb0ff39	271	#endif /* _CPUFREQ_GOVERNOR_H */