blob: c378776628b4b5eaf28a3ac5ca9cd0e38fc377b6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Viresh Kumarbb176f72013-06-19 14:19:33 +05302 * linux/include/linux/cpufreq.h
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Viresh Kumarbb176f72013-06-19 14:19:33 +05304 * Copyright (C) 2001 Russell King
5 * (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
Thiago Farina335dc332011-04-28 20:42:53 -03006 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * 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
Viresh Kumar652ed952014-01-09 20:38:43 +053014#include <linux/clk.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/cpumask.h>
Viresh Kumar5ff0a262013-08-06 22:53:03 +053016#include <linux/completion.h>
17#include <linux/kobject.h>
18#include <linux/notifier.h>
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +053019#include <linux/spinlock.h>
Viresh Kumar5ff0a262013-08-06 22:53:03 +053020#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Linus Torvalds1da177e2005-04-16 15:20:36 -070022/*********************************************************************
Viresh Kumar74aca952013-08-06 22:53:04 +053023 * CPUFREQ INTERFACE *
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 *********************************************************************/
Viresh Kumar74aca952013-08-06 22:53:04 +053025/*
26 * Frequency values here are CPU kHz
27 *
Dave Jonesb53cc6e2005-05-31 19:03:47 -070028 * Maximum transition latency is in nanoseconds - if it's unknown,
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 * CPUFREQ_ETERNAL shall be used.
30 */
31
Viresh Kumar74aca952013-08-06 22:53:04 +053032#define CPUFREQ_ETERNAL (-1)
33#define CPUFREQ_NAME_LEN 16
34/* Print length for names. Extra 1 space for accomodating '\n' in prints */
35#define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1)
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037struct cpufreq_governor;
38
Viresh Kumar74aca952013-08-06 22:53:04 +053039struct cpufreq_freqs {
40 unsigned int cpu; /* cpu nr */
41 unsigned int old;
42 unsigned int new;
43 u8 flags; /* flags of cpufreq_driver, see below. */
44};
Thomas Renninger8aa84ad2009-07-24 15:25:05 +020045
Linus Torvalds1da177e2005-04-16 15:20:36 -070046struct cpufreq_cpuinfo {
47 unsigned int max_freq;
48 unsigned int min_freq;
Thiago Farina335dc332011-04-28 20:42:53 -030049
50 /* in 10^(-9) s = nanoseconds */
51 unsigned int transition_latency;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052};
53
Viresh Kumarc7a7b412015-08-03 08:36:19 +053054struct cpufreq_user_policy {
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 unsigned int min; /* in kHz */
56 unsigned int max; /* in kHz */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057};
58
59struct cpufreq_policy {
Viresh Kumar951fc5f2013-01-31 02:03:53 +000060 /* CPUs sharing clock, require sw coordination */
61 cpumask_var_t cpus; /* Online CPUs only */
62 cpumask_var_t related_cpus; /* Online + Offline CPUs */
Rafael J. Wysocki559ed402015-07-26 02:07:47 +020063 cpumask_var_t real_cpus; /* Related and present */
Viresh Kumar951fc5f2013-01-31 02:03:53 +000064
Viresh Kumar62b36cc2013-02-01 06:40:02 +000065 unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -050066 should set cpufreq */
Saravana Kannan9d16f202015-05-18 10:43:31 +053067 unsigned int cpu; /* cpu managing this policy, must be online */
Saravana Kannan9d16f202015-05-18 10:43:31 +053068
Viresh Kumar652ed952014-01-09 20:38:43 +053069 struct clk *clk;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 struct cpufreq_cpuinfo cpuinfo;/* see above */
71
72 unsigned int min; /* in kHz */
73 unsigned int max; /* in kHz */
74 unsigned int cur; /* in kHz, only needed if cpufreq
75 * governors are used */
Viresh Kumar1c03a2d2014-06-02 22:49:28 +053076 unsigned int restore_freq; /* = policy->cur before transition */
Viresh Kumare28867e2014-03-04 11:00:27 +080077 unsigned int suspend_freq; /* freq to set during suspend */
78
Thiago Farina335dc332011-04-28 20:42:53 -030079 unsigned int policy; /* see above */
Srinivas Pandruvada69030dd12015-12-01 16:52:14 -080080 unsigned int last_policy; /* policy before unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 struct cpufreq_governor *governor; /* see below */
Viresh Kumar7bd353a2013-03-27 15:58:57 +000082 void *governor_data;
Viresh Kumar45732372015-05-12 12:22:34 +053083 char last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 struct work_struct update; /* if update_policy() needs to be
86 * called, but you're in IRQ context */
87
Viresh Kumarc7a7b412015-08-03 08:36:19 +053088 struct cpufreq_user_policy user_policy;
Viresh Kumare0b31652014-03-10 14:53:33 +053089 struct cpufreq_frequency_table *freq_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Lukasz Majewskic88a1f82013-08-06 22:53:08 +053091 struct list_head policy_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 struct kobject kobj;
93 struct completion kobj_unregister;
viresh kumarad7722d2013-10-18 19:10:15 +053094
95 /*
96 * The rules for this semaphore:
97 * - Any routine that wants to read from the policy structure will
98 * do a down_read on this semaphore.
99 * - Any routine that will write to the policy structure and/or may take away
100 * the policy altogether (eg. CPU hotplug), will hold this lock in write
101 * mode before doing so.
viresh kumarad7722d2013-10-18 19:10:15 +0530102 */
103 struct rw_semaphore rwsem;
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +0530104
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200105 /*
106 * Fast switch flags:
107 * - fast_switch_possible should be set by the driver if it can
108 * guarantee that frequency can be changed on any CPU sharing the
109 * policy and that the change will affect all of the policy CPUs then.
110 * - fast_switch_enabled is to be set by governors that support fast
111 * freqnency switching with the help of cpufreq_enable_fast_switch().
112 */
113 bool fast_switch_possible;
114 bool fast_switch_enabled;
115
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +0530116 /* Synchronization for frequency transitions */
117 bool transition_ongoing; /* Tracks transition status */
118 spinlock_t transition_lock;
119 wait_queue_head_t transition_wait;
Srivatsa S. Bhatca654dc2014-05-05 12:52:39 +0530120 struct task_struct *transition_task; /* Task which is doing the transition */
Viresh Kumar413fffc2014-08-28 11:22:23 +0530121
Viresh Kumara9aaf292015-01-13 11:34:00 +0530122 /* cpufreq-stats */
123 struct cpufreq_stats *stats;
124
Viresh Kumar413fffc2014-08-28 11:22:23 +0530125 /* For cpufreq driver's internal use */
126 void *driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128
Viresh Kumar62b36cc2013-02-01 06:40:02 +0000129/* Only for ACPI */
Venkatesh Pallipadi46f18e32006-06-26 00:34:43 -0400130#define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
131#define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
132#define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
133#define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Daniel Vetterc75b5052013-10-08 10:56:11 +0200135#ifdef CONFIG_CPU_FREQ
Rafael J. Wysocki1f0bd442015-09-16 02:17:49 +0200136struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
Viresh Kumar74aca952013-08-06 22:53:04 +0530137struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
Viresh Kumar3a3e9e02013-08-06 22:53:05 +0530138void cpufreq_cpu_put(struct cpufreq_policy *policy);
Daniel Vetterc75b5052013-10-08 10:56:11 +0200139#else
Rafael J. Wysocki1f0bd442015-09-16 02:17:49 +0200140static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
141{
142 return NULL;
143}
Daniel Vetterc75b5052013-10-08 10:56:11 +0200144static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
145{
146 return NULL;
147}
148static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
149#endif
Viresh Kumar74aca952013-08-06 22:53:04 +0530150
Fabio Baltieri2624f902013-01-31 09:44:40 +0000151static inline bool policy_is_shared(struct cpufreq_policy *policy)
152{
153 return cpumask_weight(policy->cpus) > 1;
154}
155
Viresh Kumar74aca952013-08-06 22:53:04 +0530156/* /sys/devices/system/cpu/cpufreq: entry point for global variables */
157extern struct kobject *cpufreq_global_kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Viresh Kumar74aca952013-08-06 22:53:04 +0530159#ifdef CONFIG_CPU_FREQ
160unsigned int cpufreq_get(unsigned int cpu);
161unsigned int cpufreq_quick_get(unsigned int cpu);
162unsigned int cpufreq_quick_get_max(unsigned int cpu);
163void disable_cpufreq(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Viresh Kumar74aca952013-08-06 22:53:04 +0530165u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
166int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
167int cpufreq_update_policy(unsigned int cpu);
168bool have_governor_per_policy(void);
169struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200170void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
Rafael J. Wysocki6c9d9c82016-04-07 23:38:46 +0200171void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
Viresh Kumar74aca952013-08-06 22:53:04 +0530172#else
173static inline unsigned int cpufreq_get(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Viresh Kumar74aca952013-08-06 22:53:04 +0530175 return 0;
176}
177static inline unsigned int cpufreq_quick_get(unsigned int cpu)
178{
179 return 0;
180}
181static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
182{
183 return 0;
184}
185static inline void disable_cpufreq(void) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Rafael J. Wysocki1aefc752016-05-31 22:14:44 +0200188#ifdef CONFIG_CPU_FREQ_STAT
189void cpufreq_stats_create_table(struct cpufreq_policy *policy);
190void cpufreq_stats_free_table(struct cpufreq_policy *policy);
191void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
192 unsigned int new_freq);
193#else
194static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
195static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
196static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
197 unsigned int new_freq) { }
198#endif /* CONFIG_CPU_FREQ_STAT */
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200/*********************************************************************
201 * CPUFREQ DRIVER INTERFACE *
202 *********************************************************************/
203
204#define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
205#define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
Stratos Karafotis5b0c0b12014-06-30 19:59:33 +0300206#define CPUFREQ_RELATION_C 2 /* closest frequency to target */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Viresh Kumar74aca952013-08-06 22:53:04 +0530208struct freq_attr {
209 struct attribute attr;
210 ssize_t (*show)(struct cpufreq_policy *, char *);
211 ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
212};
213
214#define cpufreq_freq_attr_ro(_name) \
215static struct freq_attr _name = \
216__ATTR(_name, 0444, show_##_name, NULL)
217
218#define cpufreq_freq_attr_ro_perm(_name, _perm) \
219static struct freq_attr _name = \
220__ATTR(_name, _perm, show_##_name, NULL)
221
222#define cpufreq_freq_attr_rw(_name) \
223static struct freq_attr _name = \
224__ATTR(_name, 0644, show_##_name, store_##_name)
225
226struct global_attr {
227 struct attribute attr;
228 ssize_t (*show)(struct kobject *kobj,
229 struct attribute *attr, char *buf);
230 ssize_t (*store)(struct kobject *a, struct attribute *b,
231 const char *c, size_t count);
232};
233
234#define define_one_global_ro(_name) \
235static struct global_attr _name = \
236__ATTR(_name, 0444, show_##_name, NULL)
237
238#define define_one_global_rw(_name) \
239static struct global_attr _name = \
240__ATTR(_name, 0644, show_##_name, store_##_name)
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243struct cpufreq_driver {
Viresh Kumar90452e612014-11-27 06:07:49 +0530244 char name[CPUFREQ_NAME_LEN];
245 u8 flags;
246 void *driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 /* needed by all drivers */
Viresh Kumar90452e612014-11-27 06:07:49 +0530249 int (*init)(struct cpufreq_policy *policy);
250 int (*verify)(struct cpufreq_policy *policy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252 /* define one out of two */
Viresh Kumar90452e612014-11-27 06:07:49 +0530253 int (*setpolicy)(struct cpufreq_policy *policy);
Viresh Kumar1c03a2d2014-06-02 22:49:28 +0530254
255 /*
256 * On failure, should always restore frequency to policy->restore_freq
257 * (i.e. old freq).
258 */
Viresh Kumar90452e612014-11-27 06:07:49 +0530259 int (*target)(struct cpufreq_policy *policy,
260 unsigned int target_freq,
261 unsigned int relation); /* Deprecated */
262 int (*target_index)(struct cpufreq_policy *policy,
263 unsigned int index);
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200264 unsigned int (*fast_switch)(struct cpufreq_policy *policy,
265 unsigned int target_freq);
Viresh Kumar1c03a2d2014-06-02 22:49:28 +0530266 /*
267 * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
268 * unset.
269 *
270 * get_intermediate should return a stable intermediate frequency
271 * platform wants to switch to and target_intermediate() should set CPU
272 * to to that frequency, before jumping to the frequency corresponding
273 * to 'index'. Core will take care of sending notifications and driver
274 * doesn't have to handle them in target_intermediate() or
275 * target_index().
276 *
277 * Drivers can return '0' from get_intermediate() in case they don't
278 * wish to switch to intermediate frequency for some target frequency.
279 * In that case core will directly call ->target_index().
280 */
Viresh Kumar90452e612014-11-27 06:07:49 +0530281 unsigned int (*get_intermediate)(struct cpufreq_policy *policy,
282 unsigned int index);
283 int (*target_intermediate)(struct cpufreq_policy *policy,
284 unsigned int index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286 /* should be defined, if possible */
Viresh Kumar90452e612014-11-27 06:07:49 +0530287 unsigned int (*get)(unsigned int cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 /* optional */
Viresh Kumar90452e612014-11-27 06:07:49 +0530290 int (*bios_limit)(int cpu, unsigned int *limit);
venkatesh.pallipadi@intel.combf0b90e2008-08-04 11:59:07 -0700291
Viresh Kumar90452e612014-11-27 06:07:49 +0530292 int (*exit)(struct cpufreq_policy *policy);
293 void (*stop_cpu)(struct cpufreq_policy *policy);
294 int (*suspend)(struct cpufreq_policy *policy);
295 int (*resume)(struct cpufreq_policy *policy);
Viresh Kumar7c45cf32014-11-27 06:07:51 +0530296
297 /* Will be called after the driver is fully initialized */
298 void (*ready)(struct cpufreq_policy *policy);
299
Viresh Kumar90452e612014-11-27 06:07:49 +0530300 struct freq_attr **attr;
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100301
302 /* platform specific boost support code */
Viresh Kumar90452e612014-11-27 06:07:49 +0530303 bool boost_enabled;
304 int (*set_boost)(int state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305};
306
307/* flags */
Viresh Kumar6461f012013-10-02 14:13:17 +0530308#define CPUFREQ_STICKY (1 << 0) /* driver isn't removed even if
309 all ->init() calls failed */
310#define CPUFREQ_CONST_LOOPS (1 << 1) /* loops_per_jiffy or other
311 kernel "constants" aren't
312 affected by frequency
313 transitions */
314#define CPUFREQ_PM_NO_WARN (1 << 2) /* don't warn on suspend/resume
315 speed mismatches */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Viresh Kumar0b981e72013-10-02 14:13:18 +0530317/*
318 * This should be set by platforms having multiple clock-domains, i.e.
319 * supporting multiple policies. With this sysfs directories of governor would
320 * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
321 * governor with different tunables for different clusters.
322 */
323#define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
324
Viresh Kumar7dbf6942013-10-29 18:56:06 +0530325/*
326 * Driver will do POSTCHANGE notifications from outside of their ->target()
327 * routine and so must set cpufreq_driver->flags with this flag, so that core
328 * can handle them specially.
329 */
330#define CPUFREQ_ASYNC_NOTIFICATION (1 << 4)
331
Viresh Kumarae6b4272013-12-03 11:20:45 +0530332/*
333 * Set by drivers which want cpufreq core to check if CPU is running at a
334 * frequency present in freq-table exposed by the driver. For these drivers if
335 * CPU is found running at an out of table freq, we will try to set it to a freq
336 * from the table. And if that fails, we will stop further boot process by
337 * issuing a BUG_ON().
338 */
339#define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
340
Linus Torvalds221dee22007-02-26 14:55:48 -0800341int cpufreq_register_driver(struct cpufreq_driver *driver_data);
342int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Viresh Kumar74aca952013-08-06 22:53:04 +0530344const char *cpufreq_get_current_driver(void);
Thomas Petazzoni51315cd2014-10-19 11:30:27 +0200345void *cpufreq_get_driver_data(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Viresh Kumarbb176f72013-06-19 14:19:33 +0530347static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
348 unsigned int min, unsigned int max)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349{
350 if (policy->min < min)
351 policy->min = min;
352 if (policy->max < min)
353 policy->max = min;
354 if (policy->min > max)
355 policy->min = max;
356 if (policy->max > max)
357 policy->max = max;
358 if (policy->min > policy->max)
359 policy->min = policy->max;
360 return;
361}
362
Viresh Kumarbe49e342013-10-02 14:13:19 +0530363static inline void
364cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
365{
366 cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
367 policy->cpuinfo.max_freq);
368}
369
Viresh Kumar2f0aea92014-03-04 11:00:26 +0800370#ifdef CONFIG_CPU_FREQ
371void cpufreq_suspend(void);
372void cpufreq_resume(void);
Viresh Kumare28867e2014-03-04 11:00:27 +0800373int cpufreq_generic_suspend(struct cpufreq_policy *policy);
Viresh Kumar2f0aea92014-03-04 11:00:26 +0800374#else
375static inline void cpufreq_suspend(void) {}
376static inline void cpufreq_resume(void) {}
377#endif
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379/*********************************************************************
Viresh Kumar74aca952013-08-06 22:53:04 +0530380 * CPUFREQ NOTIFIER INTERFACE *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 *********************************************************************/
382
Viresh Kumar74aca952013-08-06 22:53:04 +0530383#define CPUFREQ_TRANSITION_NOTIFIER (0)
384#define CPUFREQ_POLICY_NOTIFIER (1)
385
386/* Transition notifiers */
387#define CPUFREQ_PRECHANGE (0)
388#define CPUFREQ_POSTCHANGE (1)
Viresh Kumar74aca952013-08-06 22:53:04 +0530389
390/* Policy Notifiers */
391#define CPUFREQ_ADJUST (0)
Viresh Kumar6bfb7c72015-08-03 08:36:14 +0530392#define CPUFREQ_NOTIFY (1)
393#define CPUFREQ_START (2)
394#define CPUFREQ_CREATE_POLICY (3)
395#define CPUFREQ_REMOVE_POLICY (4)
Viresh Kumar74aca952013-08-06 22:53:04 +0530396
397#ifdef CONFIG_CPU_FREQ
398int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
399int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
400
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +0530401void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
402 struct cpufreq_freqs *freqs);
403void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
404 struct cpufreq_freqs *freqs, int transition_failed);
Viresh Kumar74aca952013-08-06 22:53:04 +0530405
406#else /* CONFIG_CPU_FREQ */
407static inline int cpufreq_register_notifier(struct notifier_block *nb,
408 unsigned int list)
409{
410 return 0;
411}
412static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
413 unsigned int list)
414{
415 return 0;
416}
417#endif /* !CONFIG_CPU_FREQ */
418
419/**
420 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
421 * safe)
422 * @old: old value
423 * @div: divisor
424 * @mult: multiplier
425 *
426 *
427 * new = old * mult / div
428 */
429static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
430 u_int mult)
431{
432#if BITS_PER_LONG == 32
433 u64 result = ((u64) old) * ((u64) mult);
434 do_div(result, div);
435 return (unsigned long) result;
436
437#elif BITS_PER_LONG == 64
438 unsigned long result = old * ((u64) mult);
439 result /= div;
440 return result;
441#endif
442}
443
444/*********************************************************************
445 * CPUFREQ GOVERNORS *
446 *********************************************************************/
447
448/*
449 * If (cpufreq_driver->target) exists, the ->governor decides what frequency
450 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
451 * two generic policies are available:
452 */
453#define CPUFREQ_POLICY_POWERSAVE (1)
454#define CPUFREQ_POLICY_PERFORMANCE (2)
455
Rafael J. Wysocki379480d2016-03-22 02:51:56 +0100456/*
457 * The polling frequency depends on the capability of the processor. Default
458 * polling frequency is 1000 times the transition latency of the processor. The
459 * ondemand governor will work on any processor with transition latency <= 10ms,
460 * using appropriate sampling rate.
461 *
462 * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL)
463 * the ondemand governor will not work. All times here are in us (microseconds).
464 */
465#define MIN_SAMPLING_RATE_RATIO (2)
466#define LATENCY_MULTIPLIER (1000)
467#define MIN_LATENCY_MULTIPLIER (20)
468#define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000)
469
Viresh Kumar74aca952013-08-06 22:53:04 +0530470struct cpufreq_governor {
471 char name[CPUFREQ_NAME_LEN];
Rafael J. Wysockie7888922016-06-02 23:24:15 +0200472 int (*init)(struct cpufreq_policy *policy);
473 void (*exit)(struct cpufreq_policy *policy);
474 int (*start)(struct cpufreq_policy *policy);
475 void (*stop)(struct cpufreq_policy *policy);
476 void (*limits)(struct cpufreq_policy *policy);
Viresh Kumar74aca952013-08-06 22:53:04 +0530477 ssize_t (*show_setspeed) (struct cpufreq_policy *policy,
478 char *buf);
479 int (*store_setspeed) (struct cpufreq_policy *policy,
480 unsigned int freq);
481 unsigned int max_transition_latency; /* HW must be able to switch to
482 next freq faster than this value in nano secs or we
483 will fallback to performance governor */
484 struct list_head governor_list;
485 struct module *owner;
486};
487
488/* Pass a target to the cpufreq driver */
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200489unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
490 unsigned int target_freq);
Viresh Kumar74aca952013-08-06 22:53:04 +0530491int cpufreq_driver_target(struct cpufreq_policy *policy,
492 unsigned int target_freq,
493 unsigned int relation);
494int __cpufreq_driver_target(struct cpufreq_policy *policy,
495 unsigned int target_freq,
496 unsigned int relation);
497int cpufreq_register_governor(struct cpufreq_governor *governor);
498void cpufreq_unregister_governor(struct cpufreq_governor *governor);
499
Rafael J. Wysockide1df262016-02-05 02:37:42 +0100500struct cpufreq_governor *cpufreq_default_governor(void);
501struct cpufreq_governor *cpufreq_fallback_governor(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Viresh Kumarbf2be2d2016-05-18 17:55:31 +0530503static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
504{
505 if (policy->max < policy->cur)
506 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
507 else if (policy->min > policy->cur)
508 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
509}
510
Rafael J. Wysocki66893b62016-03-22 02:50:45 +0100511/* Governor attribute set */
512struct gov_attr_set {
513 struct kobject kobj;
514 struct list_head policy_list;
515 struct mutex update_lock;
516 int usage_count;
517};
518
519/* sysfs ops for cpufreq governors */
520extern const struct sysfs_ops governor_sysfs_ops;
521
522void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
523void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
524unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
525
526/* Governor sysfs attribute */
527struct governor_attr {
528 struct attribute attr;
529 ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
530 ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
531 size_t count);
532};
533
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534/*********************************************************************
535 * FREQUENCY TABLE HELPERS *
536 *********************************************************************/
537
Viresh Kumar7f4b0462014-03-28 19:11:47 +0530538/* Special Values of .frequency field */
Brian W Hart2b1987a2014-06-27 16:09:39 -0500539#define CPUFREQ_ENTRY_INVALID ~0u
540#define CPUFREQ_TABLE_END ~1u
Viresh Kumar7f4b0462014-03-28 19:11:47 +0530541/* Special Values of .flags field */
542#define CPUFREQ_BOOST_FREQ (1 << 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544struct cpufreq_frequency_table {
Viresh Kumar7f4b0462014-03-28 19:11:47 +0530545 unsigned int flags;
Viresh Kumar50701582013-03-30 16:25:15 +0530546 unsigned int driver_data; /* driver specific data, not used by core */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 unsigned int frequency; /* kHz - doesn't need to be in ascending
548 * order */
549};
550
Nishanth Menona0dd7b72014-05-05 08:33:50 -0500551#if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
552int dev_pm_opp_init_cpufreq_table(struct device *dev,
553 struct cpufreq_frequency_table **table);
554void dev_pm_opp_free_cpufreq_table(struct device *dev,
555 struct cpufreq_frequency_table **table);
556#else
557static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
558 struct cpufreq_frequency_table
559 **table)
560{
561 return -EINVAL;
562}
563
564static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
565 struct cpufreq_frequency_table
566 **table)
567{
568}
569#endif
570
Stratos Karafotis27e289d2014-04-25 23:15:23 +0300571/*
572 * cpufreq_for_each_entry - iterate over a cpufreq_frequency_table
573 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
574 * @table: the cpufreq_frequency_table * to iterate over.
575 */
576
577#define cpufreq_for_each_entry(pos, table) \
578 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
579
580/*
581 * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table
582 * excluding CPUFREQ_ENTRY_INVALID frequencies.
583 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
584 * @table: the cpufreq_frequency_table * to iterate over.
585 */
586
Rafael J. Wysocki34b08702016-02-26 00:22:57 +0100587#define cpufreq_for_each_valid_entry(pos, table) \
588 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) \
589 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \
590 continue; \
591 else
Stratos Karafotis27e289d2014-04-25 23:15:23 +0300592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
594 struct cpufreq_frequency_table *table);
595
596int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
597 struct cpufreq_frequency_table *table);
Viresh Kumar18434512013-10-03 20:27:55 +0530598int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 unsigned int target_freq,
Viresh Kumard218ed72016-06-03 10:58:51 +0530602 unsigned int relation);
Viresh Kumard3916692013-12-03 11:20:46 +0530603int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
604 unsigned int freq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605
Viresh Kumar74aca952013-08-06 22:53:04 +0530606ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
607
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100608#ifdef CONFIG_CPU_FREQ
609int cpufreq_boost_trigger_state(int state);
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100610int cpufreq_boost_enabled(void);
Viresh Kumar44139ed2015-07-29 16:23:09 +0530611int cpufreq_enable_boost_support(void);
612bool policy_has_boost_freq(struct cpufreq_policy *policy);
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100613#else
614static inline int cpufreq_boost_trigger_state(int state)
615{
616 return 0;
617}
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100618static inline int cpufreq_boost_enabled(void)
619{
620 return 0;
621}
Viresh Kumar44139ed2015-07-29 16:23:09 +0530622
623static inline int cpufreq_enable_boost_support(void)
624{
625 return -EINVAL;
626}
627
628static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
629{
630 return false;
631}
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100632#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634/* the following are really really optional */
635extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
Bartlomiej Zolnierkiewicz21c36d32015-08-07 13:59:16 +0200636extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
Viresh Kumar18434512013-10-03 20:27:55 +0530637extern struct freq_attr *cpufreq_generic_attr[];
Viresh Kumar27047a62013-09-16 18:56:03 +0530638int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
639 struct cpufreq_frequency_table *table);
Lan Tianyuf4fd3792013-06-27 15:08:54 +0800640
Viresh Kumar652ed952014-01-09 20:38:43 +0530641unsigned int cpufreq_generic_get(unsigned int cpu);
Viresh Kumar70e9e772013-10-03 20:29:07 +0530642int cpufreq_generic_init(struct cpufreq_policy *policy,
643 struct cpufreq_frequency_table *table,
644 unsigned int transition_latency);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645#endif /* _LINUX_CPUFREQ_H */