drivers/cpufreq/cpufreq_governor.h

   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
  17 #ifndef _CPUFREQ_GOVERNOR_H
  18 #define _CPUFREQ_GOVERNOR_H
  19
  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>
  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
  30  * governor will work on any processor with transition latency <= 10ms, using
  31  * appropriate sampling rate.
  32  *
  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).
  35  */
  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)
  40
  41 /* Ondemand Sampling types */
  42 enum {OD_NORMAL_SAMPLE, OD_SUB_SAMPLE};
  43
  44 /*
  45  * Macro for creating governors sysfs routines
  46  *
  47  * - gov_sys: One governor instance per whole system
  48  * - gov_pol: One governor instance per policy
  49  */
  50
  51 /* Create attributes */
  52 #define gov_sys_attr_ro(_name)                                          \
  53 static struct global_attr _name##_gov_sys =                             \
  54 __ATTR(_name, 0444, show_##_name##_gov_sys, NULL)
  55
  56 #define gov_sys_attr_rw(_name)                                          \
  57 static struct global_attr _name##_gov_sys =                             \
  58 __ATTR(_name, 0644, show_##_name##_gov_sys, store_##_name##_gov_sys)
  59
  60 #define gov_pol_attr_ro(_name)                                          \
  61 static struct freq_attr _name##_gov_pol =                               \
  62 __ATTR(_name, 0444, show_##_name##_gov_pol, NULL)
  63
  64 #define gov_pol_attr_rw(_name)                                          \
  65 static struct freq_attr _name##_gov_pol =                               \
  66 __ATTR(_name, 0644, show_##_name##_gov_pol, store_##_name##_gov_pol)
  67
  68 #define gov_sys_pol_attr_rw(_name)                                      \
  69         gov_sys_attr_rw(_name);                                         \
  70         gov_pol_attr_rw(_name)
  71
  72 #define gov_sys_pol_attr_ro(_name)                                      \
  73         gov_sys_attr_ro(_name);                                         \
  74         gov_pol_attr_ro(_name)
  75
  76 /* Create show/store routines */
  77 #define show_one(_gov, file_name)                                       \
  78 static ssize_t show_##file_name##_gov_sys                               \
  79 (struct kobject *kobj, struct attribute *attr, char *buf)               \
  80 {                                                                       \
  81         struct _gov##_dbs_tuners *tuners = _gov##_dbs_gov.gdbs_data->tuners; \
  82         return sprintf(buf, "%u\n", tuners->file_name);                 \
  83 }                                                                       \
  84                                                                         \
  85 static ssize_t show_##file_name##_gov_pol                               \
  86 (struct cpufreq_policy *policy, char *buf)                              \
  87 {                                                                       \
  88         struct dbs_data *dbs_data = policy->governor_data;              \
  89         struct _gov##_dbs_tuners *tuners = dbs_data->tuners;            \
  90         return sprintf(buf, "%u\n", tuners->file_name);                 \
  91 }
  92
  93 #define store_one(_gov, file_name)                                      \
  94 static ssize_t store_##file_name##_gov_sys                              \
  95 (struct kobject *kobj, struct attribute *attr, const char *buf, size_t count) \
  96 {                                                                       \
  97         struct dbs_data *dbs_data = _gov##_dbs_gov.gdbs_data;           \
  98         return store_##file_name(dbs_data, buf, count);                 \
  99 }                                                                       \
 100                                                                         \
 101 static ssize_t store_##file_name##_gov_pol                              \
 102 (struct cpufreq_policy *policy, const char *buf, size_t count)          \
 103 {                                                                       \
 104         struct dbs_data *dbs_data = policy->governor_data;              \
 105         return store_##file_name(dbs_data, buf, count);                 \
 106 }
 107
 108 #define show_store_one(_gov, file_name)                                 \
 109 show_one(_gov, file_name);                                              \
 110 store_one(_gov, file_name)
 111
 112 /* create helper routines */
 113 #define define_get_cpu_dbs_routines(_dbs_info)                          \
 114 static struct cpu_dbs_info *get_cpu_cdbs(int cpu)                       \
 115 {                                                                       \
 116         return &per_cpu(_dbs_info, cpu).cdbs;                           \
 117 }                                                                       \
 118                                                                         \
 119 static void *get_cpu_dbs_info_s(int cpu)                                \
 120 {                                                                       \
 121         return &per_cpu(_dbs_info, cpu);                                \
 122 }
 123
 124 /*
 125  * Abbreviations:
 126  * dbs: used as a shortform for demand based switching It helps to keep variable
 127  *      names smaller, simpler
 128  * cdbs: common dbs
 129  * od_*: On-demand governor
 130  * cs_*: Conservative governor
 131  */
 132
 133 /* Common to all CPUs of a policy */
 134 struct policy_dbs_info {
 135         struct cpufreq_policy *policy;
 136         /*
 137          * Per policy mutex that serializes load evaluation from limit-change
 138          * and work-handler.
 139          */
 140         struct mutex timer_mutex;
 141
 142         u64 last_sample_time;
 143         s64 sample_delay_ns;
 144         atomic_t skip_work;
 145         struct irq_work irq_work;
 146         struct work_struct work;
 147 };
 148
 149 static inline void gov_update_sample_delay(struct policy_dbs_info *policy_dbs,
 150                                            unsigned int delay_us)
 151 {
 152         policy_dbs->sample_delay_ns = delay_us * NSEC_PER_USEC;
 153 }
 154
 155 /* Per cpu structures */
 156 struct cpu_dbs_info {
 157         u64 prev_cpu_idle;
 158         u64 prev_cpu_wall;
 159         u64 prev_cpu_nice;
 160         /*
 161          * Used to keep track of load in the previous interval. However, when
 162          * explicitly set to zero, it is used as a flag to ensure that we copy
 163          * the previous load to the current interval only once, upon the first
 164          * wake-up from idle.
 165          */
 166         unsigned int prev_load;
 167         struct update_util_data update_util;
 168         struct policy_dbs_info *policy_dbs;
 169 };
 170
 171 struct od_cpu_dbs_info_s {
 172         struct cpu_dbs_info cdbs;
 173         struct cpufreq_frequency_table *freq_table;
 174         unsigned int freq_lo;
 175         unsigned int freq_lo_jiffies;
 176         unsigned int freq_hi_jiffies;
 177         unsigned int rate_mult;
 178         unsigned int sample_type:1;
 179 };
 180
 181 struct cs_cpu_dbs_info_s {
 182         struct cpu_dbs_info cdbs;
 183         unsigned int down_skip;
 184         unsigned int requested_freq;
 185 };
 186
 187 /* Per policy Governors sysfs tunables */
 188 struct od_dbs_tuners {
 189         unsigned int ignore_nice_load;
 190         unsigned int sampling_rate;
 191         unsigned int sampling_down_factor;
 192         unsigned int up_threshold;
 193         unsigned int powersave_bias;
 194         unsigned int io_is_busy;
 195 };
 196
 197 struct cs_dbs_tuners {
 198         unsigned int ignore_nice_load;
 199         unsigned int sampling_rate;
 200         unsigned int sampling_down_factor;
 201         unsigned int up_threshold;
 202         unsigned int down_threshold;
 203         unsigned int freq_step;
 204 };
 205
 206 /* Common Governor data across policies */
 207 struct dbs_data;
 208 struct dbs_governor {
 209         struct cpufreq_governor gov;
 210
 211         #define GOV_ONDEMAND            0
 212         #define GOV_CONSERVATIVE        1
 213         int governor;
 214         struct attribute_group *attr_group_gov_sys; /* one governor - system */
 215         struct attribute_group *attr_group_gov_pol; /* one governor - policy */
 216
 217         /*
 218          * Common data for platforms that don't set
 219          * CPUFREQ_HAVE_GOVERNOR_PER_POLICY
 220          */
 221         struct dbs_data *gdbs_data;
 222
 223         struct cpu_dbs_info *(*get_cpu_cdbs)(int cpu);
 224         void *(*get_cpu_dbs_info_s)(int cpu);
 225         unsigned int (*gov_dbs_timer)(struct cpufreq_policy *policy);
 226         void (*gov_check_cpu)(int cpu, unsigned int load);
 227         int (*init)(struct dbs_data *dbs_data, bool notify);
 228         void (*exit)(struct dbs_data *dbs_data, bool notify);
 229
 230         /* Governor specific ops, see below */
 231         void *gov_ops;
 232 };
 233
 234 static inline struct dbs_governor *dbs_governor_of(struct cpufreq_policy *policy)
 235 {
 236         return container_of(policy->governor, struct dbs_governor, gov);
 237 }
 238
 239 /* Governor Per policy data */
 240 struct dbs_data {
 241         unsigned int min_sampling_rate;
 242         int usage_count;
 243         void *tuners;
 244 };
 245
 246 /* Governor specific ops, will be passed to dbs_data->gov_ops */
 247 struct od_ops {
 248         void (*powersave_bias_init_cpu)(int cpu);
 249         unsigned int (*powersave_bias_target)(struct cpufreq_policy *policy,
 250                         unsigned int freq_next, unsigned int relation);
 251         void (*freq_increase)(struct cpufreq_policy *policy, unsigned int freq);
 252 };
 253
 254 static inline int delay_for_sampling_rate(unsigned int sampling_rate)
 255 {
 256         int delay = usecs_to_jiffies(sampling_rate);
 257
 258         /* We want all CPUs to do sampling nearly on same jiffy */
 259         if (num_online_cpus() > 1)
 260                 delay -= jiffies % delay;
 261
 262         return delay;
 263 }
 264
 265 #define declare_show_sampling_rate_min(_gov)                            \
 266 static ssize_t show_sampling_rate_min_gov_sys                           \
 267 (struct kobject *kobj, struct attribute *attr, char *buf)               \
 268 {                                                                       \
 269         struct dbs_data *dbs_data = _gov##_dbs_gov.gdbs_data;           \
 270         return sprintf(buf, "%u\n", dbs_data->min_sampling_rate);       \
 271 }                                                                       \
 272                                                                         \
 273 static ssize_t show_sampling_rate_min_gov_pol                           \
 274 (struct cpufreq_policy *policy, char *buf)                              \
 275 {                                                                       \
 276         struct dbs_data *dbs_data = policy->governor_data;              \
 277         return sprintf(buf, "%u\n", dbs_data->min_sampling_rate);       \
 278 }
 279
 280 extern struct mutex dbs_data_mutex;
 281 extern struct mutex cpufreq_governor_lock;
 282 void dbs_check_cpu(struct cpufreq_policy *policy, int cpu);
 283 int cpufreq_governor_dbs(struct cpufreq_policy *policy, unsigned int event);
 284 void od_register_powersave_bias_handler(unsigned int (*f)
 285                 (struct cpufreq_policy *, unsigned int, unsigned int),
 286                 unsigned int powersave_bias);
 287 void od_unregister_powersave_bias_handler(void);
 288 #endif /* _CPUFREQ_GOVERNOR_H */