blob: cc401d147e727615c8255a951a08065ae954fb23 [file] [log] [blame]
Viresh Kumar4471a342012-10-26 00:47:42 +02001/*
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
Borislav Petkovbeb0ff32013-04-02 12:26:15 +000017#ifndef _CPUFREQ_GOVERNOR_H
18#define _CPUFREQ_GOVERNOR_H
Viresh Kumar4471a342012-10-26 00:47:42 +020019
Viresh Kumar4471a342012-10-26 00:47:42 +020020#include <linux/cpufreq.h>
Viresh Kumar5ff0a262013-08-06 22:53:03 +053021#include <linux/kernel_stat.h>
22#include <linux/module.h>
Viresh Kumar4471a342012-10-26 00:47:42 +020023#include <linux/mutex.h>
Viresh Kumar4471a342012-10-26 00:47:42 +020024
25/*
26 * The polling frequency depends on the capability of the processor. Default
27 * polling frequency is 1000 times the transition latency of the processor. The
Stratos Karafotisc4afc412013-08-26 21:42:21 +030028 * governor will work on any processor with transition latency <= 10ms, using
Viresh Kumar4471a342012-10-26 00:47:42 +020029 * appropriate sampling rate.
30 *
Stratos Karafotisc4afc412013-08-26 21:42:21 +030031 * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL)
32 * this governor will not work. All times here are in us (micro seconds).
Viresh Kumar4471a342012-10-26 00:47:42 +020033 */
34#define MIN_SAMPLING_RATE_RATIO (2)
35#define LATENCY_MULTIPLIER (1000)
Viresh Kumar98104ee2013-02-26 15:07:24 +053036#define MIN_LATENCY_MULTIPLIER (20)
Viresh Kumar4471a342012-10-26 00:47:42 +020037#define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000)
38
39/* Ondemand Sampling types */
40enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE};
41
Viresh Kumar4d5dcc42013-03-27 15:58:58 +000042/*
43 * Macro for creating governors sysfs routines
44 *
45 * - gov_sys: One governor instance per whole system
46 * - gov_pol: One governor instance per policy
47 */
48
49/* Create attributes */
50#define gov_sys_attr_ro(_name) \
51static struct global_attr _name##_gov_sys = \
52__ATTR(_name, 0444, show_##_name##_gov_sys, NULL)
53
54#define gov_sys_attr_rw(_name) \
55static struct global_attr _name##_gov_sys = \
56__ATTR(_name, 0644, show_##_name##_gov_sys, store_##_name##_gov_sys)
57
58#define gov_pol_attr_ro(_name) \
59static struct freq_attr _name##_gov_pol = \
60__ATTR(_name, 0444, show_##_name##_gov_pol, NULL)
61
62#define gov_pol_attr_rw(_name) \
63static struct freq_attr _name##_gov_pol = \
64__ATTR(_name, 0644, show_##_name##_gov_pol, store_##_name##_gov_pol)
65
66#define gov_sys_pol_attr_rw(_name) \
67 gov_sys_attr_rw(_name); \
68 gov_pol_attr_rw(_name)
69
70#define gov_sys_pol_attr_ro(_name) \
71 gov_sys_attr_ro(_name); \
72 gov_pol_attr_ro(_name)
73
74/* Create show/store routines */
75#define show_one(_gov, file_name) \
76static ssize_t show_##file_name##_gov_sys \
Viresh Kumar4471a342012-10-26 00:47:42 +020077(struct kobject *kobj, struct attribute *attr, char *buf) \
78{ \
Viresh Kumar4d5dcc42013-03-27 15:58:58 +000079 struct _gov##_dbs_tuners *tuners = _gov##_dbs_cdata.gdbs_data->tuners; \
80 return sprintf(buf, "%u\n", tuners->file_name); \
81} \
82 \
Viresh Kumarbb176f72013-06-19 14:19:33 +053083static ssize_t show_##file_name##_gov_pol \
Viresh Kumar4d5dcc42013-03-27 15:58:58 +000084(struct cpufreq_policy *policy, char *buf) \
85{ \
86 struct dbs_data *dbs_data = policy->governor_data; \
87 struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \
88 return sprintf(buf, "%u\n", tuners->file_name); \
Viresh Kumar4471a342012-10-26 00:47:42 +020089}
90
Viresh Kumar4d5dcc42013-03-27 15:58:58 +000091#define store_one(_gov, file_name) \
92static ssize_t store_##file_name##_gov_sys \
Viresh Kumarbb176f72013-06-19 14:19:33 +053093(struct kobject *kobj, struct attribute *attr, const char *buf, size_t count) \
Viresh Kumar4d5dcc42013-03-27 15:58:58 +000094{ \
95 struct dbs_data *dbs_data = _gov##_dbs_cdata.gdbs_data; \
96 return store_##file_name(dbs_data, buf, count); \
97} \
98 \
99static ssize_t store_##file_name##_gov_pol \
100(struct cpufreq_policy *policy, const char *buf, size_t count) \
101{ \
102 struct dbs_data *dbs_data = policy->governor_data; \
103 return store_##file_name(dbs_data, buf, count); \
104}
105
106#define show_store_one(_gov, file_name) \
107show_one(_gov, file_name); \
108store_one(_gov, file_name)
109
110/* create helper routines */
Viresh Kumar4471a342012-10-26 00:47:42 +0200111#define define_get_cpu_dbs_routines(_dbs_info) \
112static struct cpu_dbs_common_info *get_cpu_cdbs(int cpu) \
113{ \
114 return &per_cpu(_dbs_info, cpu).cdbs; \
115} \
116 \
117static void *get_cpu_dbs_info_s(int cpu) \
118{ \
119 return &per_cpu(_dbs_info, cpu); \
120}
121
122/*
123 * Abbreviations:
124 * dbs: used as a shortform for demand based switching It helps to keep variable
125 * names smaller, simpler
126 * cdbs: common dbs
Namhyung Kime5dde922013-02-28 05:38:00 +0000127 * od_*: On-demand governor
Viresh Kumar4471a342012-10-26 00:47:42 +0200128 * cs_*: Conservative governor
129 */
130
131/* Per cpu structures */
132struct cpu_dbs_common_info {
133 int cpu;
Viresh Kumar1e7586a2012-10-26 00:51:21 +0200134 u64 prev_cpu_idle;
135 u64 prev_cpu_wall;
136 u64 prev_cpu_nice;
Srivatsa S. Bhat18b46ab2014-06-08 02:11:43 +0530137 /*
Viresh Kumarc8ae4812014-06-09 14:21:24 +0530138 * Used to keep track of load in the previous interval. However, when
139 * explicitly set to zero, it is used as a flag to ensure that we copy
140 * the previous load to the current interval only once, upon the first
141 * wake-up from idle.
Srivatsa S. Bhat18b46ab2014-06-08 02:11:43 +0530142 */
Viresh Kumarc8ae4812014-06-09 14:21:24 +0530143 unsigned int prev_load;
Viresh Kumar4471a342012-10-26 00:47:42 +0200144 struct cpufreq_policy *cur_policy;
145 struct delayed_work work;
146 /*
147 * percpu mutex that serializes governor limit change with gov_dbs_timer
148 * invocation. We do not want gov_dbs_timer to run when user is changing
149 * the governor or limits.
150 */
151 struct mutex timer_mutex;
Fabio Baltierida53d612012-12-27 14:55:40 +0000152 ktime_t time_stamp;
Viresh Kumar4471a342012-10-26 00:47:42 +0200153};
154
155struct od_cpu_dbs_info_s {
156 struct cpu_dbs_common_info cdbs;
Viresh Kumar4471a342012-10-26 00:47:42 +0200157 struct cpufreq_frequency_table *freq_table;
158 unsigned int freq_lo;
159 unsigned int freq_lo_jiffies;
160 unsigned int freq_hi_jiffies;
161 unsigned int rate_mult;
162 unsigned int sample_type:1;
163};
164
165struct cs_cpu_dbs_info_s {
166 struct cpu_dbs_common_info cdbs;
167 unsigned int down_skip;
168 unsigned int requested_freq;
169 unsigned int enable:1;
170};
171
Stratos Karafotisc4afc412013-08-26 21:42:21 +0300172/* Per policy Governors sysfs tunables */
Viresh Kumar4471a342012-10-26 00:47:42 +0200173struct od_dbs_tuners {
Viresh Kumar6c4640c2013-08-05 12:28:02 +0530174 unsigned int ignore_nice_load;
Viresh Kumar4471a342012-10-26 00:47:42 +0200175 unsigned int sampling_rate;
176 unsigned int sampling_down_factor;
177 unsigned int up_threshold;
Viresh Kumar4471a342012-10-26 00:47:42 +0200178 unsigned int powersave_bias;
179 unsigned int io_is_busy;
180};
181
182struct cs_dbs_tuners {
Viresh Kumar6c4640c2013-08-05 12:28:02 +0530183 unsigned int ignore_nice_load;
Viresh Kumar4471a342012-10-26 00:47:42 +0200184 unsigned int sampling_rate;
185 unsigned int sampling_down_factor;
186 unsigned int up_threshold;
187 unsigned int down_threshold;
188 unsigned int freq_step;
189};
190
Stratos Karafotisc4afc412013-08-26 21:42:21 +0300191/* Common Governor data across policies */
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000192struct dbs_data;
193struct common_dbs_data {
Viresh Kumar4471a342012-10-26 00:47:42 +0200194 /* Common across governors */
195 #define GOV_ONDEMAND 0
196 #define GOV_CONSERVATIVE 1
197 int governor;
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000198 struct attribute_group *attr_group_gov_sys; /* one governor - system */
199 struct attribute_group *attr_group_gov_pol; /* one governor - policy */
Viresh Kumar4471a342012-10-26 00:47:42 +0200200
Viresh Kumar0b981e72013-10-02 14:13:18 +0530201 /*
202 * Common data for platforms that don't set
203 * CPUFREQ_HAVE_GOVERNOR_PER_POLICY
204 */
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000205 struct dbs_data *gdbs_data;
Viresh Kumar4471a342012-10-26 00:47:42 +0200206
207 struct cpu_dbs_common_info *(*get_cpu_cdbs)(int cpu);
208 void *(*get_cpu_dbs_info_s)(int cpu);
209 void (*gov_dbs_timer)(struct work_struct *work);
210 void (*gov_check_cpu)(int cpu, unsigned int load);
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000211 int (*init)(struct dbs_data *dbs_data);
212 void (*exit)(struct dbs_data *dbs_data);
Viresh Kumar4471a342012-10-26 00:47:42 +0200213
214 /* Governor specific ops, see below */
215 void *gov_ops;
216};
217
Stratos Karafotisc4afc412013-08-26 21:42:21 +0300218/* Governor Per policy data */
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000219struct dbs_data {
220 struct common_dbs_data *cdata;
221 unsigned int min_sampling_rate;
Viresh Kumara97c98a2013-04-30 14:32:17 +0000222 int usage_count;
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000223 void *tuners;
224
225 /* dbs_mutex protects dbs_enable in governor start/stop */
226 struct mutex mutex;
227};
228
Viresh Kumar4471a342012-10-26 00:47:42 +0200229/* Governor specific ops, will be passed to dbs_data->gov_ops */
230struct od_ops {
Viresh Kumar4471a342012-10-26 00:47:42 +0200231 void (*powersave_bias_init_cpu)(int cpu);
232 unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy,
233 unsigned int freq_next, unsigned int relation);
Viresh Kumar3a3e9e02013-08-06 22:53:05 +0530234 void (*freq_increase)(struct cpufreq_policy *policy, unsigned int freq);
Viresh Kumar4471a342012-10-26 00:47:42 +0200235};
236
237struct cs_ops {
238 struct notifier_block *notifier_block;
239};
240
241static inline int delay_for_sampling_rate(unsigned int sampling_rate)
242{
243 int delay = usecs_to_jiffies(sampling_rate);
244
245 /* We want all CPUs to do sampling nearly on same jiffy */
246 if (num_online_cpus() > 1)
247 delay -= jiffies % delay;
248
249 return delay;
250}
251
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000252#define declare_show_sampling_rate_min(_gov) \
253static ssize_t show_sampling_rate_min_gov_sys \
254(struct kobject *kobj, struct attribute *attr, char *buf) \
255{ \
256 struct dbs_data *dbs_data = _gov##_dbs_cdata.gdbs_data; \
257 return sprintf(buf, "%u\n", dbs_data->min_sampling_rate); \
258} \
259 \
260static ssize_t show_sampling_rate_min_gov_pol \
261(struct cpufreq_policy *policy, char *buf) \
262{ \
263 struct dbs_data *dbs_data = policy->governor_data; \
264 return sprintf(buf, "%u\n", dbs_data->min_sampling_rate); \
265}
266
Jane Li6f1e4ef2014-01-03 17:17:41 +0800267extern struct mutex cpufreq_governor_lock;
268
Viresh Kumar4471a342012-10-26 00:47:42 +0200269void dbs_check_cpu(struct dbs_data *dbs_data, int cpu);
Viresh Kumar44472662013-01-31 17:28:02 +0000270bool need_load_eval(struct cpu_dbs_common_info *cdbs,
271 unsigned int sampling_rate);
Viresh Kumar4d5dcc42013-03-27 15:58:58 +0000272int cpufreq_governor_dbs(struct cpufreq_policy *policy,
273 struct common_dbs_data *cdata, unsigned int event);
Viresh Kumar031299b2013-02-27 12:24:03 +0530274void gov_queue_work(struct dbs_data *dbs_data, struct cpufreq_policy *policy,
275 unsigned int delay, bool all_cpus);
Jacob Shinfb308092013-04-02 09:56:56 -0500276void od_register_powersave_bias_handler(unsigned int (*f)
277 (struct cpufreq_policy *, unsigned int, unsigned int),
278 unsigned int powersave_bias);
279void od_unregister_powersave_bias_handler(void);
Borislav Petkovbeb0ff32013-04-02 12:26:15 +0000280#endif /* _CPUFREQ_GOVERNOR_H */