Documentation/cpu-freq/governors.txt

   1      CPU frequency and voltage scaling code in the Linux(TM) kernel
   2
   3
   4                          L i n u x    C P U F r e q
   5
   6                       C P U F r e q   G o v e r n o r s
   7
   8                    - information for users and developers -
   9
  10
  11                     Dominik Brodowski  <linux@brodo.de>
  12             some additions and corrections by Nico Golde <nico@ngolde.de>
  13
  14
  15
  16    Clock scaling allows you to change the clock speed of the CPUs on the
  17     fly. This is a nice method to save battery power, because the lower
  18             the clock speed, the less power the CPU consumes.
  19
  20
  21 Contents:
  22 ---------
  23 1.   What is a CPUFreq Governor?
  24
  25 2.   Governors In the Linux Kernel
  26 2.1  Performance
  27 2.2  Powersave
  28 2.3  Userspace
  29 2.4  Ondemand
  30 2.5  Conservative
  31 2.6  Interactive
  32
  33 3.   The Governor Interface in the CPUfreq Core
  34
  35
  36
  37 1. What Is A CPUFreq Governor?
  38 ==============================
  39
  40 Most cpufreq drivers (in fact, all except one, longrun) or even most
  41 cpu frequency scaling algorithms only offer the CPU to be set to one
  42 frequency. In order to offer dynamic frequency scaling, the cpufreq
  43 core must be able to tell these drivers of a "target frequency". So
  44 these specific drivers will be transformed to offer a "->target"
  45 call instead of the existing "->setpolicy" call. For "longrun", all
  46 stays the same, though.
  47
  48 How to decide what frequency within the CPUfreq policy should be used?
  49 That's done using "cpufreq governors". Two are already in this patch
  50 -- they're the already existing "powersave" and "performance" which
  51 set the frequency statically to the lowest or highest frequency,
  52 respectively. At least two more such governors will be ready for
  53 addition in the near future, but likely many more as there are various
  54 different theories and models about dynamic frequency scaling
  55 around. Using such a generic interface as cpufreq offers to scaling
  56 governors, these can be tested extensively, and the best one can be
  57 selected for each specific use.
  58
  59 Basically, it's the following flow graph:
  60
  61 CPU can be set to switch independently   |         CPU can only be set
  62       within specific "limits"           |       to specific frequencies
  63
  64                                  "CPUfreq policy"
  65                 consists of frequency limits (policy->{min,max})
  66                      and CPUfreq governor to be used
  67                          /                    \
  68                         /                      \
  69                        /                       the cpufreq governor decides
  70                       /                        (dynamically or statically)
  71                      /                         what target_freq to set within
  72                     /                          the limits of policy->{min,max}
  73                    /                                \
  74                   /                                  \
  75         Using the ->setpolicy call,              Using the ->target call,
  76             the limits and the                    the frequency closest
  77              "policy" is set.                     to target_freq is set.
  78                                                   It is assured that it
  79                                                   is within policy->{min,max}
  80
  81
  82 2. Governors In the Linux Kernel
  83 ================================
  84
  85 2.1 Performance
  86 ---------------
  87
  88 The CPUfreq governor "performance" sets the CPU statically to the
  89 highest frequency within the borders of scaling_min_freq and
  90 scaling_max_freq.
  91
  92
  93 2.2 Powersave
  94 -------------
  95
  96 The CPUfreq governor "powersave" sets the CPU statically to the
  97 lowest frequency within the borders of scaling_min_freq and
  98 scaling_max_freq.
  99
 100
 101 2.3 Userspace
 102 -------------
 103
 104 The CPUfreq governor "userspace" allows the user, or any userspace
 105 program running with UID "root", to set the CPU to a specific frequency
 106 by making a sysfs file "scaling_setspeed" available in the CPU-device
 107 directory.
 108
 109
 110 2.4 Ondemand
 111 ------------
 112
 113 The CPUfreq governor "ondemand" sets the CPU depending on the
 114 current usage. To do this the CPU must have the capability to
 115 switch the frequency very quickly.  There are a number of sysfs file
 116 accessible parameters:
 117
 118 sampling_rate: measured in uS (10^-6 seconds), this is how often you
 119 want the kernel to look at the CPU usage and to make decisions on
 120 what to do about the frequency.  Typically this is set to values of
 121 around '10000' or more. It's default value is (cmp. with users-guide.txt):
 122 transition_latency * 1000
 123 Be aware that transition latency is in ns and sampling_rate is in us, so you
 124 get the same sysfs value by default.
 125 Sampling rate should always get adjusted considering the transition latency
 126 To set the sampling rate 750 times as high as the transition latency
 127 in the bash (as said, 1000 is default), do:
 128 echo `$(($(cat cpuinfo_transition_latency) * 750 / 1000)) \
 129     >ondemand/sampling_rate
 130
 131 show_sampling_rate_min:
 132 The sampling rate is limited by the HW transition latency:
 133 transition_latency * 100
 134 Or by kernel restrictions:
 135 If CONFIG_NO_HZ is set, the limit is 10ms fixed.
 136 If CONFIG_NO_HZ is not set or no_hz=off boot parameter is used, the
 137 limits depend on the CONFIG_HZ option:
 138 HZ=1000: min=20000us  (20ms)
 139 HZ=250:  min=80000us  (80ms)
 140 HZ=100:  min=200000us (200ms)
 141 The highest value of kernel and HW latency restrictions is shown and
 142 used as the minimum sampling rate.
 143
 144 show_sampling_rate_max: THIS INTERFACE IS DEPRECATED, DON'T USE IT.
 145
 146 up_threshold: defines what the average CPU usage between the samplings
 147 of 'sampling_rate' needs to be for the kernel to make a decision on
 148 whether it should increase the frequency.  For example when it is set
 149 to its default value of '95' it means that between the checking
 150 intervals the CPU needs to be on average more than 95% in use to then
 151 decide that the CPU frequency needs to be increased.
 152
 153 ignore_nice_load: this parameter takes a value of '0' or '1'. When
 154 set to '0' (its default), all processes are counted towards the
 155 'cpu utilisation' value.  When set to '1', the processes that are
 156 run with a 'nice' value will not count (and thus be ignored) in the
 157 overall usage calculation.  This is useful if you are running a CPU
 158 intensive calculation on your laptop that you do not care how long it
 159 takes to complete as you can 'nice' it and prevent it from taking part
 160 in the deciding process of whether to increase your CPU frequency.
 161
 162 sampling_down_factor: this parameter controls the rate at which the
 163 kernel makes a decision on when to decrease the frequency while running
 164 at top speed. When set to 1 (the default) decisions to reevaluate load
 165 are made at the same interval regardless of current clock speed. But
 166 when set to greater than 1 (e.g. 100) it acts as a multiplier for the
 167 scheduling interval for reevaluating load when the CPU is at its top
 168 speed due to high load. This improves performance by reducing the overhead
 169 of load evaluation and helping the CPU stay at its top speed when truly
 170 busy, rather than shifting back and forth in speed. This tunable has no
 171 effect on behavior at lower speeds/lower CPU loads.
 172
 173
 174 2.5 Conservative
 175 ----------------
 176
 177 The CPUfreq governor "conservative", much like the "ondemand"
 178 governor, sets the CPU depending on the current usage.  It differs in
 179 behaviour in that it gracefully increases and decreases the CPU speed
 180 rather than jumping to max speed the moment there is any load on the
 181 CPU.  This behaviour more suitable in a battery powered environment.
 182 The governor is tweaked in the same manner as the "ondemand" governor
 183 through sysfs with the addition of:
 184
 185 freq_step: this describes what percentage steps the cpu freq should be
 186 increased and decreased smoothly by.  By default the cpu frequency will
 187 increase in 5% chunks of your maximum cpu frequency.  You can change this
 188 value to anywhere between 0 and 100 where '0' will effectively lock your
 189 CPU at a speed regardless of its load whilst '100' will, in theory, make
 190 it behave identically to the "ondemand" governor.
 191
 192 down_threshold: same as the 'up_threshold' found for the "ondemand"
 193 governor but for the opposite direction.  For example when set to its
 194 default value of '20' it means that if the CPU usage needs to be below
 195 20% between samples to have the frequency decreased.
 196
 197
 198 2.6 Interactive
 199 ---------------
 200
 201 The CPUfreq governor "interactive" is designed for latency-sensitive,
 202 interactive workloads. This governor sets the CPU speed depending on
 203 usage, similar to "ondemand" and "conservative" governors, but with a
 204 different set of configurable behaviors.
 205
 206 The tuneable values for this governor are:
 207
 208 target_loads: CPU load values used to adjust speed to influence the
 209 current CPU load toward that value.  In general, the lower the target
 210 load, the more often the governor will raise CPU speeds to bring load
 211 below the target.  The format is a single target load, optionally
 212 followed by pairs of CPU speeds and CPU loads to target at or above
 213 those speeds.  Colons can be used between the speeds and associated
 214 target loads for readability.  For example:
 215
 216    85 1000000:90 1700000:99
 217
 218 targets CPU load 85% below speed 1GHz, 90% at or above 1GHz, until
 219 1.7GHz and above, at which load 99% is targeted.  If speeds are
 220 specified these must appear in ascending order.  Higher target load
 221 values are typically specified for higher speeds, that is, target load
 222 values also usually appear in an ascending order. The default is
 223 target load 90% for all speeds.
 224
 225 min_sample_time: The minimum amount of time to spend at the current
 226 frequency before ramping down. Default is 80000 uS.
 227
 228 hispeed_freq: An intermediate "hi speed" at which to initially ramp
 229 when CPU load hits the value specified in go_hispeed_load.  If load
 230 stays high for the amount of time specified in above_hispeed_delay,
 231 then speed may be bumped higher.  Default is the maximum speed
 232 allowed by the policy at governor initialization time.
 233
 234 go_hispeed_load: The CPU load at which to ramp to hispeed_freq.
 235 Default is 99%.
 236
 237 above_hispeed_delay: When speed is at or above hispeed_freq, wait for
 238 this long before raising speed in response to continued high load.
 239 Default is 20000 uS.
 240
 241 timer_rate: Sample rate for reevaluating CPU load when the CPU is not
 242 idle.  A deferrable timer is used, such that the CPU will not be woken
 243 from idle to service this timer until something else needs to run.
 244 (The maximum time to allow deferring this timer when not running at
 245 minimum speed is configurable via timer_slack.)  Default is 20000 uS.
 246
 247 timer_slack: Maximum additional time to defer handling the governor
 248 sampling timer beyond timer_rate when running at speeds above the
 249 minimum.  For platforms that consume additional power at idle when
 250 CPUs are running at speeds greater than minimum, this places an upper
 251 bound on how long the timer will be deferred prior to re-evaluating
 252 load and dropping speed.  For example, if timer_rate is 20000uS and
 253 timer_slack is 10000uS then timers will be deferred for up to 30msec
 254 when not at lowest speed.  A value of -1 means defer timers
 255 indefinitely at all speeds.  Default is 80000 uS.
 256
 257 boost: If non-zero, immediately boost speed of all CPUs to at least
 258 hispeed_freq until zero is written to this attribute.  If zero, allow
 259 CPU speeds to drop below hispeed_freq according to load as usual.
 260 Default is zero.
 261
 262 boostpulse: On each write, immediately boost speed of all CPUs to
 263 hispeed_freq for at least the period of time specified by
 264 boostpulse_duration, after which speeds are allowed to drop below
 265 hispeed_freq according to load as usual.
 266
 267 boostpulse_duration: Length of time to hold CPU speed at hispeed_freq
 268 on a write to boostpulse, before allowing speed to drop according to
 269 load as usual.  Default is 80000 uS.
 270
 271 3. The Governor Interface in the CPUfreq Core
 272 =============================================
 273
 274 A new governor must register itself with the CPUfreq core using
 275 "cpufreq_register_governor". The struct cpufreq_governor, which has to
 276 be passed to that function, must contain the following values:
 277
 278 governor->name -            A unique name for this governor
 279 governor->governor -        The governor callback function
 280 governor->owner -           .THIS_MODULE for the governor module (if
 281                             appropriate)
 282
 283 The governor->governor callback is called with the current (or to-be-set)
 284 cpufreq_policy struct for that CPU, and an unsigned int event. The
 285 following events are currently defined:
 286
 287 CPUFREQ_GOV_START:   This governor shall start its duty for the CPU
 288                      policy->cpu
 289 CPUFREQ_GOV_STOP:    This governor shall end its duty for the CPU
 290                      policy->cpu
 291 CPUFREQ_GOV_LIMITS:  The limits for CPU policy->cpu have changed to
 292                      policy->min and policy->max.
 293
 294 If you need other "events" externally of your driver, _only_ use the
 295 cpufreq_governor_l(unsigned int cpu, unsigned int event) call to the
 296 CPUfreq core to ensure proper locking.
 297
 298
 299 The CPUfreq governor may call the CPU processor driver using one of
 300 these two functions:
 301
 302 int cpufreq_driver_target(struct cpufreq_policy *policy,
 303                                  unsigned int target_freq,
 304                                  unsigned int relation);
 305
 306 int __cpufreq_driver_target(struct cpufreq_policy *policy,
 307                                    unsigned int target_freq,
 308                                    unsigned int relation);
 309
 310 target_freq must be within policy->min and policy->max, of course.
 311 What's the difference between these two functions? When your governor
 312 still is in a direct code path of a call to governor->governor, the
 313 per-CPU cpufreq lock is still held in the cpufreq core, and there's
 314 no need to lock it again (in fact, this would cause a deadlock). So
 315 use __cpufreq_driver_target only in these cases. In all other cases
 316 (for example, when there's a "daemonized" function that wakes up
 317 every second), use cpufreq_driver_target to lock the cpufreq per-CPU
 318 lock before the command is passed to the cpufreq processor driver.
 319