cpufreq: governors: Remove code redundancy between governors
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / cpufreq.h
CommitLineData
1da177e4
LT
1/*
2 * linux/include/linux/cpufreq.h
3 *
4 * Copyright (C) 2001 Russell King
5 * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
335dc333 6 *
1da177e4
LT
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11#ifndef _LINUX_CPUFREQ_H
12#define _LINUX_CPUFREQ_H
13
2aacdfff 14#include <asm/cputime.h>
83933af4 15#include <linux/mutex.h>
1da177e4
LT
16#include <linux/notifier.h>
17#include <linux/threads.h>
1da177e4
LT
18#include <linux/kobject.h>
19#include <linux/sysfs.h>
20#include <linux/completion.h>
21#include <linux/workqueue.h>
22#include <linux/cpumask.h>
4e57b681 23#include <asm/div64.h>
1da177e4
LT
24
25#define CPUFREQ_NAME_LEN 16
4b972f0b 26/* Print length for names. Extra 1 space for accomodating '\n' in prints */
27#define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1)
1da177e4
LT
28
29
30/*********************************************************************
31 * CPUFREQ NOTIFIER INTERFACE *
32 *********************************************************************/
33
1da177e4
LT
34#define CPUFREQ_TRANSITION_NOTIFIER (0)
35#define CPUFREQ_POLICY_NOTIFIER (1)
36
6070b5de
SS
37#ifdef CONFIG_CPU_FREQ
38int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
39int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
a7b422cd 40extern void disable_cpufreq(void);
6070b5de
SS
41#else /* CONFIG_CPU_FREQ */
42static inline int cpufreq_register_notifier(struct notifier_block *nb,
43 unsigned int list)
44{
45 return 0;
46}
47static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
48 unsigned int list)
49{
50 return 0;
51}
a7b422cd 52static inline void disable_cpufreq(void) { }
6070b5de 53#endif /* CONFIG_CPU_FREQ */
1da177e4
LT
54
55/* if (cpufreq_driver->target) exists, the ->governor decides what frequency
56 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
57 * two generic policies are available:
58 */
59
60#define CPUFREQ_POLICY_POWERSAVE (1)
61#define CPUFREQ_POLICY_PERFORMANCE (2)
62
335dc333
TF
63/* Frequency values here are CPU kHz so that hardware which doesn't run
64 * with some frequencies can complain without having to guess what per
65 * cent / per mille means.
b53cc6ea 66 * Maximum transition latency is in nanoseconds - if it's unknown,
1da177e4
LT
67 * CPUFREQ_ETERNAL shall be used.
68 */
69
70struct cpufreq_governor;
71
8aa84ad8
TR
72/* /sys/devices/system/cpu/cpufreq: entry point for global variables */
73extern struct kobject *cpufreq_global_kobject;
74
1da177e4
LT
75#define CPUFREQ_ETERNAL (-1)
76struct cpufreq_cpuinfo {
77 unsigned int max_freq;
78 unsigned int min_freq;
335dc333
TF
79
80 /* in 10^(-9) s = nanoseconds */
81 unsigned int transition_latency;
1da177e4
LT
82};
83
84struct cpufreq_real_policy {
85 unsigned int min; /* in kHz */
86 unsigned int max; /* in kHz */
335dc333 87 unsigned int policy; /* see above */
1da177e4
LT
88 struct cpufreq_governor *governor; /* see below */
89};
90
91struct cpufreq_policy {
951fc5f4
VK
92 /* CPUs sharing clock, require sw coordination */
93 cpumask_var_t cpus; /* Online CPUs only */
94 cpumask_var_t related_cpus; /* Online + Offline CPUs */
95
3b2d9942
VP
96 unsigned int shared_type; /* ANY or ALL affected CPUs
97 should set cpufreq */
b8eed8af
VK
98 unsigned int cpu; /* cpu nr of CPU managing this policy */
99 unsigned int last_cpu; /* cpu nr of previous CPU that managed
100 * this policy */
1da177e4
LT
101 struct cpufreq_cpuinfo cpuinfo;/* see above */
102
103 unsigned int min; /* in kHz */
104 unsigned int max; /* in kHz */
105 unsigned int cur; /* in kHz, only needed if cpufreq
106 * governors are used */
335dc333 107 unsigned int policy; /* see above */
1da177e4
LT
108 struct cpufreq_governor *governor; /* see below */
109
1da177e4
LT
110 struct work_struct update; /* if update_policy() needs to be
111 * called, but you're in IRQ context */
112
113 struct cpufreq_real_policy user_policy;
114
115 struct kobject kobj;
116 struct completion kobj_unregister;
117};
118
b8eed8af
VK
119#define CPUFREQ_ADJUST (0)
120#define CPUFREQ_INCOMPATIBLE (1)
121#define CPUFREQ_NOTIFY (2)
122#define CPUFREQ_START (3)
123#define CPUFREQ_UPDATE_POLICY_CPU (4)
1da177e4 124
46f18e3a
VP
125#define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
126#define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
127#define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
128#define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
1da177e4 129
2624f90c
FB
130static inline bool policy_is_shared(struct cpufreq_policy *policy)
131{
132 return cpumask_weight(policy->cpus) > 1;
133}
134
1da177e4
LT
135/******************** cpufreq transition notifiers *******************/
136
137#define CPUFREQ_PRECHANGE (0)
138#define CPUFREQ_POSTCHANGE (1)
139#define CPUFREQ_RESUMECHANGE (8)
42d4dc3f 140#define CPUFREQ_SUSPENDCHANGE (9)
1da177e4
LT
141
142struct cpufreq_freqs {
143 unsigned int cpu; /* cpu nr */
144 unsigned int old;
145 unsigned int new;
146 u8 flags; /* flags of cpufreq_driver, see below. */
147};
148
149
150/**
151 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch safe)
152 * @old: old value
153 * @div: divisor
154 * @mult: multiplier
155 *
156 *
157 * new = old * mult / div
158 */
159static inline unsigned long cpufreq_scale(unsigned long old, u_int div, u_int mult)
160{
161#if BITS_PER_LONG == 32
162
163 u64 result = ((u64) old) * ((u64) mult);
164 do_div(result, div);
165 return (unsigned long) result;
166
167#elif BITS_PER_LONG == 64
168
169 unsigned long result = old * ((u64) mult);
170 result /= div;
171 return result;
172
173#endif
174};
175
176/*********************************************************************
177 * CPUFREQ GOVERNORS *
178 *********************************************************************/
179
180#define CPUFREQ_GOV_START 1
181#define CPUFREQ_GOV_STOP 2
182#define CPUFREQ_GOV_LIMITS 3
183
184struct cpufreq_governor {
185 char name[CPUFREQ_NAME_LEN];
335dc333 186 int (*governor) (struct cpufreq_policy *policy,
1da177e4 187 unsigned int event);
9e76988e
VP
188 ssize_t (*show_setspeed) (struct cpufreq_policy *policy,
189 char *buf);
335dc333 190 int (*store_setspeed) (struct cpufreq_policy *policy,
9e76988e 191 unsigned int freq);
1c256245
TR
192 unsigned int max_transition_latency; /* HW must be able to switch to
193 next freq faster than this value in nano secs or we
194 will fallback to performance governor */
1da177e4
LT
195 struct list_head governor_list;
196 struct module *owner;
197};
198
335dc333
TF
199/*
200 * Pass a target to the cpufreq driver.
1da177e4
LT
201 */
202extern int cpufreq_driver_target(struct cpufreq_policy *policy,
203 unsigned int target_freq,
204 unsigned int relation);
205extern int __cpufreq_driver_target(struct cpufreq_policy *policy,
206 unsigned int target_freq,
207 unsigned int relation);
208
209
bf0b90e3 210extern int __cpufreq_driver_getavg(struct cpufreq_policy *policy,
211 unsigned int cpu);
dfde5d62 212
1da177e4
LT
213int cpufreq_register_governor(struct cpufreq_governor *governor);
214void cpufreq_unregister_governor(struct cpufreq_governor *governor);
215
216
217/*********************************************************************
218 * CPUFREQ DRIVER INTERFACE *
219 *********************************************************************/
220
221#define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
222#define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
223
224struct freq_attr;
225
226struct cpufreq_driver {
227 struct module *owner;
228 char name[CPUFREQ_NAME_LEN];
229 u8 flags;
230
231 /* needed by all drivers */
232 int (*init) (struct cpufreq_policy *policy);
233 int (*verify) (struct cpufreq_policy *policy);
234
235 /* define one out of two */
236 int (*setpolicy) (struct cpufreq_policy *policy);
237 int (*target) (struct cpufreq_policy *policy,
238 unsigned int target_freq,
239 unsigned int relation);
240
241 /* should be defined, if possible */
242 unsigned int (*get) (unsigned int cpu);
243
244 /* optional */
bf0b90e3 245 unsigned int (*getavg) (struct cpufreq_policy *policy,
246 unsigned int cpu);
e2f74f35 247 int (*bios_limit) (int cpu, unsigned int *limit);
bf0b90e3 248
1da177e4 249 int (*exit) (struct cpufreq_policy *policy);
7ca64e2d 250 int (*suspend) (struct cpufreq_policy *policy);
1da177e4
LT
251 int (*resume) (struct cpufreq_policy *policy);
252 struct freq_attr **attr;
253};
254
255/* flags */
256
335dc333 257#define CPUFREQ_STICKY 0x01 /* the driver isn't removed even if
1da177e4 258 * all ->init() calls failed */
335dc333 259#define CPUFREQ_CONST_LOOPS 0x02 /* loops_per_jiffy or other kernel
1da177e4
LT
260 * "constants" aren't affected by
261 * frequency transitions */
42d4dc3f
BH
262#define CPUFREQ_PM_NO_WARN 0x04 /* don't warn on suspend/resume speed
263 * mismatches */
1da177e4 264
221dee28
LT
265int cpufreq_register_driver(struct cpufreq_driver *driver_data);
266int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
1da177e4
LT
267
268
269void cpufreq_notify_transition(struct cpufreq_freqs *freqs, unsigned int state);
270
271
335dc333 272static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy, unsigned int min, unsigned int max)
1da177e4
LT
273{
274 if (policy->min < min)
275 policy->min = min;
276 if (policy->max < min)
277 policy->max = min;
278 if (policy->min > max)
279 policy->min = max;
280 if (policy->max > max)
281 policy->max = max;
282 if (policy->min > policy->max)
283 policy->min = policy->max;
284 return;
285}
286
287struct freq_attr {
288 struct attribute attr;
289 ssize_t (*show)(struct cpufreq_policy *, char *);
290 ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
291};
292
6dad2a29
BP
293#define cpufreq_freq_attr_ro(_name) \
294static struct freq_attr _name = \
295__ATTR(_name, 0444, show_##_name, NULL)
296
297#define cpufreq_freq_attr_ro_perm(_name, _perm) \
298static struct freq_attr _name = \
299__ATTR(_name, _perm, show_##_name, NULL)
300
6dad2a29
BP
301#define cpufreq_freq_attr_rw(_name) \
302static struct freq_attr _name = \
303__ATTR(_name, 0644, show_##_name, store_##_name)
304
8aa84ad8
TR
305struct global_attr {
306 struct attribute attr;
307 ssize_t (*show)(struct kobject *kobj,
308 struct attribute *attr, char *buf);
309 ssize_t (*store)(struct kobject *a, struct attribute *b,
310 const char *c, size_t count);
311};
1da177e4 312
6dad2a29
BP
313#define define_one_global_ro(_name) \
314static struct global_attr _name = \
315__ATTR(_name, 0444, show_##_name, NULL)
316
317#define define_one_global_rw(_name) \
318static struct global_attr _name = \
319__ATTR(_name, 0644, show_##_name, store_##_name)
320
ab45bd9b
BP
321struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
322void cpufreq_cpu_put(struct cpufreq_policy *data);
323const char *cpufreq_get_current_driver(void);
6dad2a29 324
1da177e4
LT
325/*********************************************************************
326 * CPUFREQ 2.6. INTERFACE *
327 *********************************************************************/
1da177e4
LT
328int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
329int cpufreq_update_policy(unsigned int cpu);
330
2eca40a8 331#ifdef CONFIG_CPU_FREQ
ff0ce684
LT
332/* query the current CPU frequency (in kHz). If zero, cpufreq couldn't detect it */
333unsigned int cpufreq_get(unsigned int cpu);
2eca40a8
RD
334#else
335static inline unsigned int cpufreq_get(unsigned int cpu)
336{
337 return 0;
338}
339#endif
1da177e4 340
ff0ce684 341/* query the last known CPU freq (in kHz). If zero, cpufreq couldn't detect it */
95235ca2
VP
342#ifdef CONFIG_CPU_FREQ
343unsigned int cpufreq_quick_get(unsigned int cpu);
3d737108 344unsigned int cpufreq_quick_get_max(unsigned int cpu);
95235ca2
VP
345#else
346static inline unsigned int cpufreq_quick_get(unsigned int cpu)
347{
348 return 0;
349}
3d737108
JB
350static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
351{
352 return 0;
353}
95235ca2
VP
354#endif
355
1da177e4
LT
356
357/*********************************************************************
358 * CPUFREQ DEFAULT GOVERNOR *
359 *********************************************************************/
360
361
1c256245
TR
362/*
363 Performance governor is fallback governor if any other gov failed to
364 auto load due latency restrictions
365*/
6afde10c 366#ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
1da177e4 367extern struct cpufreq_governor cpufreq_gov_performance;
6afde10c 368#endif
1c256245
TR
369#ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
370#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_performance)
30d221db
AG
371#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
372extern struct cpufreq_governor cpufreq_gov_powersave;
373#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_powersave)
1da177e4
LT
374#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
375extern struct cpufreq_governor cpufreq_gov_userspace;
1c256245
TR
376#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_userspace)
377#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
378extern struct cpufreq_governor cpufreq_gov_ondemand;
379#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_ondemand)
380#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
381extern struct cpufreq_governor cpufreq_gov_conservative;
382#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_conservative)
1da177e4
LT
383#endif
384
385
386/*********************************************************************
387 * FREQUENCY TABLE HELPERS *
388 *********************************************************************/
389
390#define CPUFREQ_ENTRY_INVALID ~0
391#define CPUFREQ_TABLE_END ~1
392
393struct cpufreq_frequency_table {
394 unsigned int index; /* any */
395 unsigned int frequency; /* kHz - doesn't need to be in ascending
396 * order */
397};
398
399int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
400 struct cpufreq_frequency_table *table);
401
402int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
403 struct cpufreq_frequency_table *table);
404
405int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
406 struct cpufreq_frequency_table *table,
407 unsigned int target_freq,
408 unsigned int relation,
409 unsigned int *index);
410
411/* the following 3 funtions are for cpufreq core use only */
412struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
1da177e4
LT
413
414/* the following are really really optional */
415extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
416
335dc333 417void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
1da177e4 418 unsigned int cpu);
b8eed8af 419void cpufreq_frequency_table_update_policy_cpu(struct cpufreq_policy *policy);
1da177e4
LT
420
421void cpufreq_frequency_table_put_attr(unsigned int cpu);
1da177e4 422#endif /* _LINUX_CPUFREQ_H */