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