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 |
18 | #define _CPUFREQ_GOVERNOR_H | |
4471a34f | 19 | |
2dd3e724 | 20 | #include <linux/atomic.h> |
9be4fd2c | 21 | #include <linux/irq_work.h> |
4471a34f | 22 | #include <linux/cpufreq.h> |
5ff0a268 VK |
23 | #include <linux/kernel_stat.h> |
24 | #include <linux/module.h> | |
4471a34f | 25 | #include <linux/mutex.h> |
4471a34f VK |
26 | |
27 | /* | |
28 | * The polling frequency depends on the capability of the processor. Default | |
29 | * polling frequency is 1000 times the transition latency of the processor. The | |
c4afc410 | 30 | * governor will work on any processor with transition latency <= 10ms, using |
4471a34f VK |
31 | * appropriate sampling rate. |
32 | * | |
c4afc410 SK |
33 | * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL) |
34 | * this governor will not work. All times here are in us (micro seconds). | |
4471a34f VK |
35 | */ |
36 | #define MIN_SAMPLING_RATE_RATIO (2) | |
37 | #define LATENCY_MULTIPLIER (1000) | |
98104ee2 | 38 | #define MIN_LATENCY_MULTIPLIER (20) |
4471a34f VK |
39 | #define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000) |
40 | ||
41 | /* Ondemand Sampling types */ | |
42 | enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE}; | |
43 | ||
4d5dcc42 | 44 | /* create helper routines */ |
4471a34f | 45 | #define define_get_cpu_dbs_routines(_dbs_info) \ |
875b8508 | 46 | static struct cpu_dbs_info *get_cpu_cdbs(int cpu) \ |
4471a34f VK |
47 | { \ |
48 | return &per_cpu(_dbs_info, cpu).cdbs; \ | |
49 | } \ | |
50 | \ | |
51 | static void *get_cpu_dbs_info_s(int cpu) \ | |
52 | { \ | |
53 | return &per_cpu(_dbs_info, cpu); \ | |
54 | } | |
55 | ||
56 | /* | |
57 | * Abbreviations: | |
58 | * dbs: used as a shortform for demand based switching It helps to keep variable | |
59 | * names smaller, simpler | |
60 | * cdbs: common dbs | |
e5dde92c | 61 | * od_*: On-demand governor |
4471a34f VK |
62 | * cs_*: Conservative governor |
63 | */ | |
64 | ||
bc505475 RW |
65 | /* Governor demand based switching data (per-policy or global). */ |
66 | struct dbs_data { | |
bc505475 RW |
67 | int usage_count; |
68 | void *tuners; | |
ff4b1789 VK |
69 | unsigned int min_sampling_rate; |
70 | unsigned int ignore_nice_load; | |
71 | unsigned int sampling_rate; | |
72 | unsigned int sampling_down_factor; | |
73 | unsigned int up_threshold; | |
c4435630 VK |
74 | |
75 | struct kobject kobj; | |
c54df071 VK |
76 | struct list_head policy_dbs_list; |
77 | /* | |
78 | * Protect concurrent updates to governor tunables from sysfs, | |
79 | * policy_dbs_list and usage_count. | |
80 | */ | |
c4435630 VK |
81 | struct mutex mutex; |
82 | }; | |
83 | ||
84 | /* Governor's specific attributes */ | |
85 | struct dbs_data; | |
86 | struct governor_attr { | |
87 | struct attribute attr; | |
88 | ssize_t (*show)(struct dbs_data *dbs_data, char *buf); | |
89 | ssize_t (*store)(struct dbs_data *dbs_data, const char *buf, | |
90 | size_t count); | |
bc505475 RW |
91 | }; |
92 | ||
c4435630 VK |
93 | #define gov_show_one(_gov, file_name) \ |
94 | static ssize_t show_##file_name \ | |
95 | (struct dbs_data *dbs_data, char *buf) \ | |
96 | { \ | |
97 | struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \ | |
98 | return sprintf(buf, "%u\n", tuners->file_name); \ | |
99 | } | |
100 | ||
101 | #define gov_show_one_common(file_name) \ | |
102 | static ssize_t show_##file_name \ | |
103 | (struct dbs_data *dbs_data, char *buf) \ | |
104 | { \ | |
105 | return sprintf(buf, "%u\n", dbs_data->file_name); \ | |
106 | } | |
107 | ||
108 | #define gov_attr_ro(_name) \ | |
109 | static struct governor_attr _name = \ | |
110 | __ATTR(_name, 0444, show_##_name, NULL) | |
111 | ||
112 | #define gov_attr_rw(_name) \ | |
113 | static struct governor_attr _name = \ | |
114 | __ATTR(_name, 0644, show_##_name, store_##_name) | |
115 | ||
44152cb8 | 116 | /* Common to all CPUs of a policy */ |
e40e7b25 | 117 | struct policy_dbs_info { |
44152cb8 VK |
118 | struct cpufreq_policy *policy; |
119 | /* | |
70f43e5e VK |
120 | * Per policy mutex that serializes load evaluation from limit-change |
121 | * and work-handler. | |
44152cb8 VK |
122 | */ |
123 | struct mutex timer_mutex; | |
70f43e5e | 124 | |
9be4fd2c RW |
125 | u64 last_sample_time; |
126 | s64 sample_delay_ns; | |
686cc637 | 127 | atomic_t work_count; |
9be4fd2c | 128 | struct irq_work irq_work; |
70f43e5e | 129 | struct work_struct work; |
bc505475 RW |
130 | /* dbs_data may be shared between multiple policy objects */ |
131 | struct dbs_data *dbs_data; | |
c54df071 | 132 | struct list_head list; |
e4db2813 RW |
133 | /* Status indicators */ |
134 | bool is_shared; /* This object is used by multiple CPUs */ | |
135 | bool work_in_progress; /* Work is being queued up or in progress */ | |
44152cb8 VK |
136 | }; |
137 | ||
e40e7b25 | 138 | static inline void gov_update_sample_delay(struct policy_dbs_info *policy_dbs, |
9be4fd2c RW |
139 | unsigned int delay_us) |
140 | { | |
e40e7b25 | 141 | policy_dbs->sample_delay_ns = delay_us * NSEC_PER_USEC; |
9be4fd2c RW |
142 | } |
143 | ||
4471a34f | 144 | /* Per cpu structures */ |
875b8508 | 145 | struct cpu_dbs_info { |
1e7586a1 VK |
146 | u64 prev_cpu_idle; |
147 | u64 prev_cpu_wall; | |
148 | u64 prev_cpu_nice; | |
18b46abd | 149 | /* |
c8ae481b VK |
150 | * Used to keep track of load in the previous interval. However, when |
151 | * explicitly set to zero, it is used as a flag to ensure that we copy | |
152 | * the previous load to the current interval only once, upon the first | |
153 | * wake-up from idle. | |
18b46abd | 154 | */ |
c8ae481b | 155 | unsigned int prev_load; |
9be4fd2c | 156 | struct update_util_data update_util; |
e40e7b25 | 157 | struct policy_dbs_info *policy_dbs; |
4471a34f VK |
158 | }; |
159 | ||
160 | struct od_cpu_dbs_info_s { | |
875b8508 | 161 | struct cpu_dbs_info cdbs; |
4471a34f VK |
162 | struct cpufreq_frequency_table *freq_table; |
163 | unsigned int freq_lo; | |
164 | unsigned int freq_lo_jiffies; | |
165 | unsigned int freq_hi_jiffies; | |
166 | unsigned int rate_mult; | |
167 | unsigned int sample_type:1; | |
168 | }; | |
169 | ||
170 | struct cs_cpu_dbs_info_s { | |
875b8508 | 171 | struct cpu_dbs_info cdbs; |
4471a34f VK |
172 | unsigned int down_skip; |
173 | unsigned int requested_freq; | |
4471a34f VK |
174 | }; |
175 | ||
c4afc410 | 176 | /* Per policy Governors sysfs tunables */ |
4471a34f | 177 | struct od_dbs_tuners { |
4471a34f VK |
178 | unsigned int powersave_bias; |
179 | unsigned int io_is_busy; | |
180 | }; | |
181 | ||
182 | struct cs_dbs_tuners { | |
4471a34f VK |
183 | unsigned int down_threshold; |
184 | unsigned int freq_step; | |
185 | }; | |
186 | ||
c4afc410 | 187 | /* Common Governor data across policies */ |
7bdad34d | 188 | struct dbs_governor { |
af926185 RW |
189 | struct cpufreq_governor gov; |
190 | ||
4471a34f VK |
191 | #define GOV_ONDEMAND 0 |
192 | #define GOV_CONSERVATIVE 1 | |
193 | int governor; | |
c4435630 | 194 | struct kobj_type kobj_type; |
4471a34f | 195 | |
0b981e70 VK |
196 | /* |
197 | * Common data for platforms that don't set | |
198 | * CPUFREQ_HAVE_GOVERNOR_PER_POLICY | |
199 | */ | |
4d5dcc42 | 200 | struct dbs_data *gdbs_data; |
4471a34f | 201 | |
875b8508 | 202 | struct cpu_dbs_info *(*get_cpu_cdbs)(int cpu); |
4471a34f | 203 | void *(*get_cpu_dbs_info_s)(int cpu); |
9be4fd2c | 204 | unsigned int (*gov_dbs_timer)(struct cpufreq_policy *policy); |
8e0484d2 VK |
205 | int (*init)(struct dbs_data *dbs_data, bool notify); |
206 | void (*exit)(struct dbs_data *dbs_data, bool notify); | |
4471a34f VK |
207 | |
208 | /* Governor specific ops, see below */ | |
209 | void *gov_ops; | |
210 | }; | |
211 | ||
ea59ee0d RW |
212 | static inline struct dbs_governor *dbs_governor_of(struct cpufreq_policy *policy) |
213 | { | |
214 | return container_of(policy->governor, struct dbs_governor, gov); | |
215 | } | |
216 | ||
4471a34f VK |
217 | /* Governor specific ops, will be passed to dbs_data->gov_ops */ |
218 | struct od_ops { | |
4471a34f VK |
219 | void (*powersave_bias_init_cpu)(int cpu); |
220 | unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy, | |
221 | unsigned int freq_next, unsigned int relation); | |
3a3e9e06 | 222 | void (*freq_increase)(struct cpufreq_policy *policy, unsigned int freq); |
4471a34f VK |
223 | }; |
224 | ||
4471a34f VK |
225 | static inline int delay_for_sampling_rate(unsigned int sampling_rate) |
226 | { | |
227 | int delay = usecs_to_jiffies(sampling_rate); | |
228 | ||
229 | /* We want all CPUs to do sampling nearly on same jiffy */ | |
230 | if (num_online_cpus() > 1) | |
231 | delay -= jiffies % delay; | |
232 | ||
233 | return delay; | |
234 | } | |
235 | ||
2bb8d94f | 236 | extern struct mutex dbs_data_mutex; |
4cccf755 | 237 | unsigned int dbs_update(struct cpufreq_policy *policy); |
906a6e5a | 238 | int cpufreq_governor_dbs(struct cpufreq_policy *policy, unsigned int event); |
fb30809e JS |
239 | void od_register_powersave_bias_handler(unsigned int (*f) |
240 | (struct cpufreq_policy *, unsigned int, unsigned int), | |
241 | unsigned int powersave_bias); | |
242 | void od_unregister_powersave_bias_handler(void); | |
aded387b VK |
243 | ssize_t store_sampling_rate(struct dbs_data *dbs_data, const char *buf, |
244 | size_t count); | |
beb0ff39 | 245 | #endif /* _CPUFREQ_GOVERNOR_H */ |