2 * drivers/cpufreq/cpufreq_governor.h
4 * Header file for CPUFreq governors common code
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>
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.
17 #ifndef _CPUFREQ_GOVERNOR_H
18 #define _CPUFREQ_GOVERNOR_H
20 #include <linux/atomic.h>
21 #include <linux/irq_work.h>
22 #include <linux/cpufreq.h>
23 #include <linux/kernel_stat.h>
24 #include <linux/module.h>
25 #include <linux/mutex.h>
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
30 * governor will work on any processor with transition latency <= 10ms, using
31 * appropriate sampling rate.
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).
36 #define MIN_SAMPLING_RATE_RATIO (2)
37 #define LATENCY_MULTIPLIER (1000)
38 #define MIN_LATENCY_MULTIPLIER (20)
39 #define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000)
41 /* Ondemand Sampling types */
42 enum {OD_NORMAL_SAMPLE
, OD_SUB_SAMPLE
};
44 /* create helper routines */
45 #define define_get_cpu_dbs_routines(_dbs_info) \
46 static struct cpu_dbs_info *get_cpu_cdbs(int cpu) \
48 return &per_cpu(_dbs_info, cpu).cdbs; \
51 static void *get_cpu_dbs_info_s(int cpu) \
53 return &per_cpu(_dbs_info, cpu); \
58 * dbs: used as a shortform for demand based switching It helps to keep variable
59 * names smaller, simpler
61 * od_*: On-demand governor
62 * cs_*: Conservative governor
65 /* Governor demand based switching data (per-policy or global). */
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
;
76 struct list_head policy_dbs_list
;
78 * Protect concurrent updates to governor tunables from sysfs,
79 * policy_dbs_list and usage_count.
84 /* Governor's specific attributes */
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
,
93 #define gov_show_one(_gov, file_name) \
94 static ssize_t show_##file_name \
95 (struct dbs_data *dbs_data, char *buf) \
97 struct _gov##_dbs_tuners *tuners = dbs_data->tuners; \
98 return sprintf(buf, "%u\n", tuners->file_name); \
101 #define gov_show_one_common(file_name) \
102 static ssize_t show_##file_name \
103 (struct dbs_data *dbs_data, char *buf) \
105 return sprintf(buf, "%u\n", dbs_data->file_name); \
108 #define gov_attr_ro(_name) \
109 static struct governor_attr _name = \
110 __ATTR(_name, 0444, show_##_name, NULL)
112 #define gov_attr_rw(_name) \
113 static struct governor_attr _name = \
114 __ATTR(_name, 0644, show_##_name, store_##_name)
116 /* Common to all CPUs of a policy */
117 struct policy_dbs_info
{
118 struct cpufreq_policy
*policy
;
120 * Per policy mutex that serializes load evaluation from limit-change
123 struct mutex timer_mutex
;
125 u64 last_sample_time
;
128 struct irq_work irq_work
;
129 struct work_struct work
;
130 /* dbs_data may be shared between multiple policy objects */
131 struct dbs_data
*dbs_data
;
132 struct list_head list
;
133 /* Multiplier for increasing sample delay temporarily. */
134 unsigned int rate_mult
;
135 /* Status indicators */
136 bool is_shared
; /* This object is used by multiple CPUs */
137 bool work_in_progress
; /* Work is being queued up or in progress */
140 static inline void gov_update_sample_delay(struct policy_dbs_info
*policy_dbs
,
141 unsigned int delay_us
)
143 policy_dbs
->sample_delay_ns
= delay_us
* NSEC_PER_USEC
;
146 /* Per cpu structures */
147 struct cpu_dbs_info
{
152 * Used to keep track of load in the previous interval. However, when
153 * explicitly set to zero, it is used as a flag to ensure that we copy
154 * the previous load to the current interval only once, upon the first
157 unsigned int prev_load
;
158 struct update_util_data update_util
;
159 struct policy_dbs_info
*policy_dbs
;
162 struct od_cpu_dbs_info_s
{
163 struct cpu_dbs_info cdbs
;
164 struct cpufreq_frequency_table
*freq_table
;
165 unsigned int freq_lo
;
166 unsigned int freq_lo_delay_us
;
167 unsigned int freq_hi_delay_us
;
168 unsigned int sample_type
:1;
171 struct cs_cpu_dbs_info_s
{
172 struct cpu_dbs_info cdbs
;
173 unsigned int down_skip
;
174 unsigned int requested_freq
;
177 /* Per policy Governors sysfs tunables */
178 struct od_dbs_tuners
{
179 unsigned int powersave_bias
;
180 unsigned int io_is_busy
;
183 struct cs_dbs_tuners
{
184 unsigned int down_threshold
;
185 unsigned int freq_step
;
188 /* Common Governor data across policies */
189 struct dbs_governor
{
190 struct cpufreq_governor gov
;
192 #define GOV_ONDEMAND 0
193 #define GOV_CONSERVATIVE 1
195 struct kobj_type kobj_type
;
198 * Common data for platforms that don't set
199 * CPUFREQ_HAVE_GOVERNOR_PER_POLICY
201 struct dbs_data
*gdbs_data
;
203 struct cpu_dbs_info
*(*get_cpu_cdbs
)(int cpu
);
204 void *(*get_cpu_dbs_info_s
)(int cpu
);
205 unsigned int (*gov_dbs_timer
)(struct cpufreq_policy
*policy
);
206 int (*init
)(struct dbs_data
*dbs_data
, bool notify
);
207 void (*exit
)(struct dbs_data
*dbs_data
, bool notify
);
209 /* Governor specific ops, see below */
213 static inline struct dbs_governor
*dbs_governor_of(struct cpufreq_policy
*policy
)
215 return container_of(policy
->governor
, struct dbs_governor
, gov
);
218 /* Governor specific ops, will be passed to dbs_data->gov_ops */
220 void (*powersave_bias_init_cpu
)(int cpu
);
221 unsigned int (*powersave_bias_target
)(struct cpufreq_policy
*policy
,
222 unsigned int freq_next
, unsigned int relation
);
223 void (*freq_increase
)(struct cpufreq_policy
*policy
, unsigned int freq
);
226 extern struct mutex dbs_data_mutex
;
227 unsigned int dbs_update(struct cpufreq_policy
*policy
);
228 int cpufreq_governor_dbs(struct cpufreq_policy
*policy
, unsigned int event
);
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);
233 ssize_t
store_sampling_rate(struct dbs_data
*dbs_data
, const char *buf
,
235 #endif /* _CPUFREQ_GOVERNOR_H */