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; | |
8847e038 | 74 | unsigned int io_is_busy; |
c4435630 VK |
75 | |
76 | struct kobject kobj; | |
c54df071 VK |
77 | struct list_head policy_dbs_list; |
78 | /* | |
79 | * Protect concurrent updates to governor tunables from sysfs, | |
80 | * policy_dbs_list and usage_count. | |
81 | */ | |
c4435630 VK |
82 | struct mutex mutex; |
83 | }; | |
84 | ||
85 | /* Governor's specific attributes */ | |
86 | struct dbs_data; | |
87 | struct governor_attr { | |
88 | struct attribute attr; | |
89 | ssize_t (*show)(struct dbs_data *dbs_data, char *buf); | |
90 | ssize_t (*store)(struct dbs_data *dbs_data, const char *buf, | |
91 | size_t count); | |
bc505475 RW |
92 | }; |
93 | ||
c4435630 VK |
94 | #define gov_show_one(_gov, file_name) \ |
95 | static ssize_t show_##file_name \ | |
96 | (struct dbs_data *dbs_data, char *buf) \ | |
97 | { \ | |
98 | struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \ | |
99 | return sprintf(buf, "%u\n", tuners->file_name); \ | |
100 | } | |
101 | ||
102 | #define gov_show_one_common(file_name) \ | |
103 | static ssize_t show_##file_name \ | |
104 | (struct dbs_data *dbs_data, char *buf) \ | |
105 | { \ | |
106 | return sprintf(buf, "%u\n", dbs_data->file_name); \ | |
107 | } | |
108 | ||
109 | #define gov_attr_ro(_name) \ | |
110 | static struct governor_attr _name = \ | |
111 | __ATTR(_name, 0444, show_##_name, NULL) | |
112 | ||
113 | #define gov_attr_rw(_name) \ | |
114 | static struct governor_attr _name = \ | |
115 | __ATTR(_name, 0644, show_##_name, store_##_name) | |
116 | ||
44152cb8 | 117 | /* Common to all CPUs of a policy */ |
e40e7b25 | 118 | struct policy_dbs_info { |
44152cb8 VK |
119 | struct cpufreq_policy *policy; |
120 | /* | |
70f43e5e VK |
121 | * Per policy mutex that serializes load evaluation from limit-change |
122 | * and work-handler. | |
44152cb8 VK |
123 | */ |
124 | struct mutex timer_mutex; | |
70f43e5e | 125 | |
9be4fd2c RW |
126 | u64 last_sample_time; |
127 | s64 sample_delay_ns; | |
686cc637 | 128 | atomic_t work_count; |
9be4fd2c | 129 | struct irq_work irq_work; |
70f43e5e | 130 | struct work_struct work; |
bc505475 RW |
131 | /* dbs_data may be shared between multiple policy objects */ |
132 | struct dbs_data *dbs_data; | |
c54df071 | 133 | struct list_head list; |
57dc3bcd RW |
134 | /* Multiplier for increasing sample delay temporarily. */ |
135 | unsigned int rate_mult; | |
e4db2813 RW |
136 | /* Status indicators */ |
137 | bool is_shared; /* This object is used by multiple CPUs */ | |
138 | bool work_in_progress; /* Work is being queued up or in progress */ | |
44152cb8 VK |
139 | }; |
140 | ||
e40e7b25 | 141 | static inline void gov_update_sample_delay(struct policy_dbs_info *policy_dbs, |
9be4fd2c RW |
142 | unsigned int delay_us) |
143 | { | |
e40e7b25 | 144 | policy_dbs->sample_delay_ns = delay_us * NSEC_PER_USEC; |
9be4fd2c RW |
145 | } |
146 | ||
4471a34f | 147 | /* Per cpu structures */ |
875b8508 | 148 | struct cpu_dbs_info { |
1e7586a1 VK |
149 | u64 prev_cpu_idle; |
150 | u64 prev_cpu_wall; | |
151 | u64 prev_cpu_nice; | |
18b46abd | 152 | /* |
c8ae481b VK |
153 | * Used to keep track of load in the previous interval. However, when |
154 | * explicitly set to zero, it is used as a flag to ensure that we copy | |
155 | * the previous load to the current interval only once, upon the first | |
156 | * wake-up from idle. | |
18b46abd | 157 | */ |
c8ae481b | 158 | unsigned int prev_load; |
9be4fd2c | 159 | struct update_util_data update_util; |
e40e7b25 | 160 | struct policy_dbs_info *policy_dbs; |
4471a34f VK |
161 | }; |
162 | ||
163 | struct od_cpu_dbs_info_s { | |
875b8508 | 164 | struct cpu_dbs_info cdbs; |
4471a34f VK |
165 | struct cpufreq_frequency_table *freq_table; |
166 | unsigned int freq_lo; | |
07aa4402 RW |
167 | unsigned int freq_lo_delay_us; |
168 | unsigned int freq_hi_delay_us; | |
4471a34f VK |
169 | unsigned int sample_type:1; |
170 | }; | |
171 | ||
172 | struct cs_cpu_dbs_info_s { | |
875b8508 | 173 | struct cpu_dbs_info cdbs; |
4471a34f VK |
174 | unsigned int down_skip; |
175 | unsigned int requested_freq; | |
4471a34f VK |
176 | }; |
177 | ||
c4afc410 | 178 | /* Per policy Governors sysfs tunables */ |
4471a34f | 179 | struct od_dbs_tuners { |
4471a34f | 180 | unsigned int powersave_bias; |
4471a34f VK |
181 | }; |
182 | ||
183 | struct cs_dbs_tuners { | |
4471a34f VK |
184 | unsigned int down_threshold; |
185 | unsigned int freq_step; | |
186 | }; | |
187 | ||
c4afc410 | 188 | /* Common Governor data across policies */ |
7bdad34d | 189 | struct dbs_governor { |
af926185 RW |
190 | struct cpufreq_governor gov; |
191 | ||
4471a34f VK |
192 | #define GOV_ONDEMAND 0 |
193 | #define GOV_CONSERVATIVE 1 | |
194 | int governor; | |
c4435630 | 195 | struct kobj_type kobj_type; |
4471a34f | 196 | |
0b981e70 VK |
197 | /* |
198 | * Common data for platforms that don't set | |
199 | * CPUFREQ_HAVE_GOVERNOR_PER_POLICY | |
200 | */ | |
4d5dcc42 | 201 | struct dbs_data *gdbs_data; |
4471a34f | 202 | |
875b8508 | 203 | struct cpu_dbs_info *(*get_cpu_cdbs)(int cpu); |
4471a34f | 204 | void *(*get_cpu_dbs_info_s)(int cpu); |
9be4fd2c | 205 | unsigned int (*gov_dbs_timer)(struct cpufreq_policy *policy); |
8e0484d2 VK |
206 | int (*init)(struct dbs_data *dbs_data, bool notify); |
207 | void (*exit)(struct dbs_data *dbs_data, bool notify); | |
702c9e54 | 208 | void (*start)(struct cpufreq_policy *policy); |
4471a34f VK |
209 | |
210 | /* Governor specific ops, see below */ | |
211 | void *gov_ops; | |
212 | }; | |
213 | ||
ea59ee0d RW |
214 | static inline struct dbs_governor *dbs_governor_of(struct cpufreq_policy *policy) |
215 | { | |
216 | return container_of(policy->governor, struct dbs_governor, gov); | |
217 | } | |
218 | ||
4471a34f VK |
219 | /* Governor specific ops, will be passed to dbs_data->gov_ops */ |
220 | struct od_ops { | |
4471a34f VK |
221 | void (*powersave_bias_init_cpu)(int cpu); |
222 | unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy, | |
223 | unsigned int freq_next, unsigned int relation); | |
4471a34f VK |
224 | }; |
225 | ||
2bb8d94f | 226 | extern struct mutex dbs_data_mutex; |
4cccf755 | 227 | unsigned int dbs_update(struct cpufreq_policy *policy); |
906a6e5a | 228 | int cpufreq_governor_dbs(struct cpufreq_policy *policy, unsigned int event); |
fb30809e JS |
229 | void od_register_powersave_bias_handler(unsigned int (*f) |
230 | (struct cpufreq_policy *, unsigned int, unsigned int), | |
231 | unsigned int powersave_bias); | |
232 | void od_unregister_powersave_bias_handler(void); | |
aded387b VK |
233 | ssize_t store_sampling_rate(struct dbs_data *dbs_data, const char *buf, |
234 | size_t count); | |
beb0ff39 | 235 | #endif /* _CPUFREQ_GOVERNOR_H */ |