blob: 631ba33bbe9fdb2fe0fd3f73cb1ab1773b52f617 [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 Kumarda0c6dc2016-06-27 16:04:07 +053039enum cpufreq_table_sorting {
40 CPUFREQ_TABLE_UNSORTED,
41 CPUFREQ_TABLE_SORTED_ASCENDING,
42 CPUFREQ_TABLE_SORTED_DESCENDING
43};
44
Viresh Kumar74aca952013-08-06 22:53:04 +053045struct cpufreq_freqs {
46 unsigned int cpu; /* cpu nr */
47 unsigned int old;
48 unsigned int new;
49 u8 flags; /* flags of cpufreq_driver, see below. */
50};
Thomas Renninger8aa84ad2009-07-24 15:25:05 +020051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct cpufreq_cpuinfo {
53 unsigned int max_freq;
54 unsigned int min_freq;
Thiago Farina335dc332011-04-28 20:42:53 -030055
56 /* in 10^(-9) s = nanoseconds */
57 unsigned int transition_latency;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058};
59
Viresh Kumarc7a7b412015-08-03 08:36:19 +053060struct cpufreq_user_policy {
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 unsigned int min; /* in kHz */
62 unsigned int max; /* in kHz */
Linus Torvalds1da177e2005-04-16 15:20:36 -070063};
64
65struct cpufreq_policy {
Viresh Kumar951fc5f2013-01-31 02:03:53 +000066 /* CPUs sharing clock, require sw coordination */
67 cpumask_var_t cpus; /* Online CPUs only */
68 cpumask_var_t related_cpus; /* Online + Offline CPUs */
Rafael J. Wysocki559ed402015-07-26 02:07:47 +020069 cpumask_var_t real_cpus; /* Related and present */
Viresh Kumar951fc5f2013-01-31 02:03:53 +000070
Viresh Kumar62b36cc2013-02-01 06:40:02 +000071 unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs
Venkatesh Pallipadi3b2d9942005-12-14 15:05:00 -050072 should set cpufreq */
Saravana Kannan9d16f202015-05-18 10:43:31 +053073 unsigned int cpu; /* cpu managing this policy, must be online */
Saravana Kannan9d16f202015-05-18 10:43:31 +053074
Viresh Kumar652ed952014-01-09 20:38:43 +053075 struct clk *clk;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 struct cpufreq_cpuinfo cpuinfo;/* see above */
77
78 unsigned int min; /* in kHz */
79 unsigned int max; /* in kHz */
80 unsigned int cur; /* in kHz, only needed if cpufreq
81 * governors are used */
Viresh Kumar1c03a2d2014-06-02 22:49:28 +053082 unsigned int restore_freq; /* = policy->cur before transition */
Viresh Kumare28867e2014-03-04 11:00:27 +080083 unsigned int suspend_freq; /* freq to set during suspend */
84
Thiago Farina335dc332011-04-28 20:42:53 -030085 unsigned int policy; /* see above */
Srinivas Pandruvada69030dd2015-12-01 16:52:14 -080086 unsigned int last_policy; /* policy before unplug */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 struct cpufreq_governor *governor; /* see below */
Viresh Kumar7bd353a2013-03-27 15:58:57 +000088 void *governor_data;
Viresh Kumar45732372015-05-12 12:22:34 +053089 char last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 struct work_struct update; /* if update_policy() needs to be
92 * called, but you're in IRQ context */
93
Viresh Kumarc7a7b412015-08-03 08:36:19 +053094 struct cpufreq_user_policy user_policy;
Viresh Kumare0b31652014-03-10 14:53:33 +053095 struct cpufreq_frequency_table *freq_table;
Viresh Kumarda0c6dc2016-06-27 16:04:07 +053096 enum cpufreq_table_sorting freq_table_sorted;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Lukasz Majewskic88a1f82013-08-06 22:53:08 +053098 struct list_head policy_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 struct kobject kobj;
100 struct completion kobj_unregister;
viresh kumarad7722d2013-10-18 19:10:15 +0530101
102 /*
103 * The rules for this semaphore:
104 * - Any routine that wants to read from the policy structure will
105 * do a down_read on this semaphore.
106 * - Any routine that will write to the policy structure and/or may take away
107 * the policy altogether (eg. CPU hotplug), will hold this lock in write
108 * mode before doing so.
viresh kumarad7722d2013-10-18 19:10:15 +0530109 */
110 struct rw_semaphore rwsem;
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +0530111
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200112 /*
113 * Fast switch flags:
114 * - fast_switch_possible should be set by the driver if it can
115 * guarantee that frequency can be changed on any CPU sharing the
116 * policy and that the change will affect all of the policy CPUs then.
117 * - fast_switch_enabled is to be set by governors that support fast
118 * freqnency switching with the help of cpufreq_enable_fast_switch().
119 */
120 bool fast_switch_possible;
121 bool fast_switch_enabled;
122
Steve Mucklee3c06232016-07-13 13:25:25 -0700123 /* Cached frequency lookup from cpufreq_driver_resolve_freq. */
124 unsigned int cached_target_freq;
125 int cached_resolved_idx;
126
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +0530127 /* Synchronization for frequency transitions */
128 bool transition_ongoing; /* Tracks transition status */
129 spinlock_t transition_lock;
130 wait_queue_head_t transition_wait;
Srivatsa S. Bhatca654dc2014-05-05 12:52:39 +0530131 struct task_struct *transition_task; /* Task which is doing the transition */
Viresh Kumar413fffc2014-08-28 11:22:23 +0530132
Viresh Kumara9aaf292015-01-13 11:34:00 +0530133 /* cpufreq-stats */
134 struct cpufreq_stats *stats;
135
Viresh Kumar413fffc2014-08-28 11:22:23 +0530136 /* For cpufreq driver's internal use */
137 void *driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138};
139
Viresh Kumar62b36cc2013-02-01 06:40:02 +0000140/* Only for ACPI */
Venkatesh Pallipadi46f18e32006-06-26 00:34:43 -0400141#define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
142#define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
143#define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
144#define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Daniel Vetterc75b5052013-10-08 10:56:11 +0200146#ifdef CONFIG_CPU_FREQ
Rafael J. Wysocki1f0bd442015-09-16 02:17:49 +0200147struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
Viresh Kumar74aca952013-08-06 22:53:04 +0530148struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
Viresh Kumar3a3e9e02013-08-06 22:53:05 +0530149void cpufreq_cpu_put(struct cpufreq_policy *policy);
Daniel Vetterc75b5052013-10-08 10:56:11 +0200150#else
Rafael J. Wysocki1f0bd442015-09-16 02:17:49 +0200151static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
152{
153 return NULL;
154}
Daniel Vetterc75b5052013-10-08 10:56:11 +0200155static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
156{
157 return NULL;
158}
159static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
160#endif
Viresh Kumar74aca952013-08-06 22:53:04 +0530161
Fabio Baltieri2624f902013-01-31 09:44:40 +0000162static inline bool policy_is_shared(struct cpufreq_policy *policy)
163{
164 return cpumask_weight(policy->cpus) > 1;
165}
166
Viresh Kumar74aca952013-08-06 22:53:04 +0530167/* /sys/devices/system/cpu/cpufreq: entry point for global variables */
168extern struct kobject *cpufreq_global_kobject;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Viresh Kumar74aca952013-08-06 22:53:04 +0530170#ifdef CONFIG_CPU_FREQ
171unsigned int cpufreq_get(unsigned int cpu);
172unsigned int cpufreq_quick_get(unsigned int cpu);
173unsigned int cpufreq_quick_get_max(unsigned int cpu);
174void disable_cpufreq(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Viresh Kumar74aca952013-08-06 22:53:04 +0530176u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
177int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
178int cpufreq_update_policy(unsigned int cpu);
179bool have_governor_per_policy(void);
180struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200181void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
Rafael J. Wysocki6c9d9c82016-04-07 23:38:46 +0200182void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
Viresh Kumar74aca952013-08-06 22:53:04 +0530183#else
184static inline unsigned int cpufreq_get(unsigned int cpu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
Viresh Kumar74aca952013-08-06 22:53:04 +0530186 return 0;
187}
188static inline unsigned int cpufreq_quick_get(unsigned int cpu)
189{
190 return 0;
191}
192static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
193{
194 return 0;
195}
196static inline void disable_cpufreq(void) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Rafael J. Wysocki1aefc752016-05-31 22:14:44 +0200199#ifdef CONFIG_CPU_FREQ_STAT
200void cpufreq_stats_create_table(struct cpufreq_policy *policy);
201void cpufreq_stats_free_table(struct cpufreq_policy *policy);
202void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
203 unsigned int new_freq);
204#else
205static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
206static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
207static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
208 unsigned int new_freq) { }
209#endif /* CONFIG_CPU_FREQ_STAT */
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211/*********************************************************************
212 * CPUFREQ DRIVER INTERFACE *
213 *********************************************************************/
214
215#define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
216#define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
Stratos Karafotis5b0c0b12014-06-30 19:59:33 +0300217#define CPUFREQ_RELATION_C 2 /* closest frequency to target */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Viresh Kumar74aca952013-08-06 22:53:04 +0530219struct freq_attr {
220 struct attribute attr;
221 ssize_t (*show)(struct cpufreq_policy *, char *);
222 ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
223};
224
225#define cpufreq_freq_attr_ro(_name) \
226static struct freq_attr _name = \
227__ATTR(_name, 0444, show_##_name, NULL)
228
229#define cpufreq_freq_attr_ro_perm(_name, _perm) \
230static struct freq_attr _name = \
231__ATTR(_name, _perm, show_##_name, NULL)
232
233#define cpufreq_freq_attr_rw(_name) \
234static struct freq_attr _name = \
235__ATTR(_name, 0644, show_##_name, store_##_name)
236
237struct global_attr {
238 struct attribute attr;
239 ssize_t (*show)(struct kobject *kobj,
240 struct attribute *attr, char *buf);
241 ssize_t (*store)(struct kobject *a, struct attribute *b,
242 const char *c, size_t count);
243};
244
245#define define_one_global_ro(_name) \
246static struct global_attr _name = \
247__ATTR(_name, 0444, show_##_name, NULL)
248
249#define define_one_global_rw(_name) \
250static struct global_attr _name = \
251__ATTR(_name, 0644, show_##_name, store_##_name)
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
254struct cpufreq_driver {
Viresh Kumar90452e62014-11-27 06:07:49 +0530255 char name[CPUFREQ_NAME_LEN];
256 u8 flags;
257 void *driver_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
259 /* needed by all drivers */
Viresh Kumar90452e62014-11-27 06:07:49 +0530260 int (*init)(struct cpufreq_policy *policy);
261 int (*verify)(struct cpufreq_policy *policy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263 /* define one out of two */
Viresh Kumar90452e62014-11-27 06:07:49 +0530264 int (*setpolicy)(struct cpufreq_policy *policy);
Viresh Kumar1c03a2d2014-06-02 22:49:28 +0530265
266 /*
267 * On failure, should always restore frequency to policy->restore_freq
268 * (i.e. old freq).
269 */
Viresh Kumar90452e62014-11-27 06:07:49 +0530270 int (*target)(struct cpufreq_policy *policy,
271 unsigned int target_freq,
272 unsigned int relation); /* Deprecated */
273 int (*target_index)(struct cpufreq_policy *policy,
274 unsigned int index);
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200275 unsigned int (*fast_switch)(struct cpufreq_policy *policy,
276 unsigned int target_freq);
Steve Mucklee3c06232016-07-13 13:25:25 -0700277
278 /*
279 * Caches and returns the lowest driver-supported frequency greater than
280 * or equal to the target frequency, subject to any driver limitations.
281 * Does not set the frequency. Only to be implemented for drivers with
282 * target().
283 */
284 unsigned int (*resolve_freq)(struct cpufreq_policy *policy,
285 unsigned int target_freq);
286
Viresh Kumar1c03a2d2014-06-02 22:49:28 +0530287 /*
288 * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
289 * unset.
290 *
291 * get_intermediate should return a stable intermediate frequency
292 * platform wants to switch to and target_intermediate() should set CPU
293 * to to that frequency, before jumping to the frequency corresponding
294 * to 'index'. Core will take care of sending notifications and driver
295 * doesn't have to handle them in target_intermediate() or
296 * target_index().
297 *
298 * Drivers can return '0' from get_intermediate() in case they don't
299 * wish to switch to intermediate frequency for some target frequency.
300 * In that case core will directly call ->target_index().
301 */
Viresh Kumar90452e62014-11-27 06:07:49 +0530302 unsigned int (*get_intermediate)(struct cpufreq_policy *policy,
303 unsigned int index);
304 int (*target_intermediate)(struct cpufreq_policy *policy,
305 unsigned int index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307 /* should be defined, if possible */
Viresh Kumar90452e62014-11-27 06:07:49 +0530308 unsigned int (*get)(unsigned int cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310 /* optional */
Viresh Kumar90452e62014-11-27 06:07:49 +0530311 int (*bios_limit)(int cpu, unsigned int *limit);
venkatesh.pallipadi@intel.combf0b90e2008-08-04 11:59:07 -0700312
Viresh Kumar90452e62014-11-27 06:07:49 +0530313 int (*exit)(struct cpufreq_policy *policy);
314 void (*stop_cpu)(struct cpufreq_policy *policy);
315 int (*suspend)(struct cpufreq_policy *policy);
316 int (*resume)(struct cpufreq_policy *policy);
Viresh Kumar7c45cf32014-11-27 06:07:51 +0530317
318 /* Will be called after the driver is fully initialized */
319 void (*ready)(struct cpufreq_policy *policy);
320
Viresh Kumar90452e62014-11-27 06:07:49 +0530321 struct freq_attr **attr;
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100322
323 /* platform specific boost support code */
Viresh Kumar90452e62014-11-27 06:07:49 +0530324 bool boost_enabled;
325 int (*set_boost)(int state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326};
327
328/* flags */
Viresh Kumar6461f012013-10-02 14:13:17 +0530329#define CPUFREQ_STICKY (1 << 0) /* driver isn't removed even if
330 all ->init() calls failed */
331#define CPUFREQ_CONST_LOOPS (1 << 1) /* loops_per_jiffy or other
332 kernel "constants" aren't
333 affected by frequency
334 transitions */
335#define CPUFREQ_PM_NO_WARN (1 << 2) /* don't warn on suspend/resume
336 speed mismatches */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Viresh Kumar0b981e72013-10-02 14:13:18 +0530338/*
339 * This should be set by platforms having multiple clock-domains, i.e.
340 * supporting multiple policies. With this sysfs directories of governor would
341 * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
342 * governor with different tunables for different clusters.
343 */
344#define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
345
Viresh Kumar7dbf6942013-10-29 18:56:06 +0530346/*
347 * Driver will do POSTCHANGE notifications from outside of their ->target()
348 * routine and so must set cpufreq_driver->flags with this flag, so that core
349 * can handle them specially.
350 */
351#define CPUFREQ_ASYNC_NOTIFICATION (1 << 4)
352
Viresh Kumarae6b4272013-12-03 11:20:45 +0530353/*
354 * Set by drivers which want cpufreq core to check if CPU is running at a
355 * frequency present in freq-table exposed by the driver. For these drivers if
356 * CPU is found running at an out of table freq, we will try to set it to a freq
357 * from the table. And if that fails, we will stop further boot process by
358 * issuing a BUG_ON().
359 */
360#define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
361
Linus Torvalds221dee22007-02-26 14:55:48 -0800362int cpufreq_register_driver(struct cpufreq_driver *driver_data);
363int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Viresh Kumar74aca952013-08-06 22:53:04 +0530365const char *cpufreq_get_current_driver(void);
Thomas Petazzoni51315cd2014-10-19 11:30:27 +0200366void *cpufreq_get_driver_data(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Viresh Kumarbb176f72013-06-19 14:19:33 +0530368static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
369 unsigned int min, unsigned int max)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370{
371 if (policy->min < min)
372 policy->min = min;
373 if (policy->max < min)
374 policy->max = min;
375 if (policy->min > max)
376 policy->min = max;
377 if (policy->max > max)
378 policy->max = max;
379 if (policy->min > policy->max)
380 policy->min = policy->max;
381 return;
382}
383
Viresh Kumarbe49e342013-10-02 14:13:19 +0530384static inline void
385cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
386{
387 cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
388 policy->cpuinfo.max_freq);
389}
390
Viresh Kumar2f0aea92014-03-04 11:00:26 +0800391#ifdef CONFIG_CPU_FREQ
392void cpufreq_suspend(void);
393void cpufreq_resume(void);
Viresh Kumare28867e2014-03-04 11:00:27 +0800394int cpufreq_generic_suspend(struct cpufreq_policy *policy);
Viresh Kumar2f0aea92014-03-04 11:00:26 +0800395#else
396static inline void cpufreq_suspend(void) {}
397static inline void cpufreq_resume(void) {}
398#endif
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400/*********************************************************************
Viresh Kumar74aca952013-08-06 22:53:04 +0530401 * CPUFREQ NOTIFIER INTERFACE *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 *********************************************************************/
403
Viresh Kumar74aca952013-08-06 22:53:04 +0530404#define CPUFREQ_TRANSITION_NOTIFIER (0)
405#define CPUFREQ_POLICY_NOTIFIER (1)
406
407/* Transition notifiers */
408#define CPUFREQ_PRECHANGE (0)
409#define CPUFREQ_POSTCHANGE (1)
Viresh Kumar74aca952013-08-06 22:53:04 +0530410
411/* Policy Notifiers */
412#define CPUFREQ_ADJUST (0)
Viresh Kumar6bfb7c72015-08-03 08:36:14 +0530413#define CPUFREQ_NOTIFY (1)
414#define CPUFREQ_START (2)
415#define CPUFREQ_CREATE_POLICY (3)
416#define CPUFREQ_REMOVE_POLICY (4)
Viresh Kumar74aca952013-08-06 22:53:04 +0530417
418#ifdef CONFIG_CPU_FREQ
419int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
420int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
421
Srivatsa S. Bhat12478cf2014-03-24 13:35:44 +0530422void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
423 struct cpufreq_freqs *freqs);
424void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
425 struct cpufreq_freqs *freqs, int transition_failed);
Viresh Kumar74aca952013-08-06 22:53:04 +0530426
427#else /* CONFIG_CPU_FREQ */
428static inline int cpufreq_register_notifier(struct notifier_block *nb,
429 unsigned int list)
430{
431 return 0;
432}
433static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
434 unsigned int list)
435{
436 return 0;
437}
438#endif /* !CONFIG_CPU_FREQ */
439
440/**
441 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
442 * safe)
443 * @old: old value
444 * @div: divisor
445 * @mult: multiplier
446 *
447 *
448 * new = old * mult / div
449 */
450static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
451 u_int mult)
452{
453#if BITS_PER_LONG == 32
454 u64 result = ((u64) old) * ((u64) mult);
455 do_div(result, div);
456 return (unsigned long) result;
457
458#elif BITS_PER_LONG == 64
459 unsigned long result = old * ((u64) mult);
460 result /= div;
461 return result;
462#endif
463}
464
465/*********************************************************************
466 * CPUFREQ GOVERNORS *
467 *********************************************************************/
468
469/*
470 * If (cpufreq_driver->target) exists, the ->governor decides what frequency
471 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
472 * two generic policies are available:
473 */
474#define CPUFREQ_POLICY_POWERSAVE (1)
475#define CPUFREQ_POLICY_PERFORMANCE (2)
476
Rafael J. Wysocki379480d2016-03-22 02:51:56 +0100477/*
478 * The polling frequency depends on the capability of the processor. Default
479 * polling frequency is 1000 times the transition latency of the processor. The
480 * ondemand governor will work on any processor with transition latency <= 10ms,
481 * using appropriate sampling rate.
482 *
483 * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL)
484 * the ondemand governor will not work. All times here are in us (microseconds).
485 */
486#define MIN_SAMPLING_RATE_RATIO (2)
487#define LATENCY_MULTIPLIER (1000)
488#define MIN_LATENCY_MULTIPLIER (20)
489#define TRANSITION_LATENCY_LIMIT (10 * 1000 * 1000)
490
Viresh Kumar74aca952013-08-06 22:53:04 +0530491struct cpufreq_governor {
492 char name[CPUFREQ_NAME_LEN];
Rafael J. Wysockie7888922016-06-02 23:24:15 +0200493 int (*init)(struct cpufreq_policy *policy);
494 void (*exit)(struct cpufreq_policy *policy);
495 int (*start)(struct cpufreq_policy *policy);
496 void (*stop)(struct cpufreq_policy *policy);
497 void (*limits)(struct cpufreq_policy *policy);
Viresh Kumar74aca952013-08-06 22:53:04 +0530498 ssize_t (*show_setspeed) (struct cpufreq_policy *policy,
499 char *buf);
500 int (*store_setspeed) (struct cpufreq_policy *policy,
501 unsigned int freq);
502 unsigned int max_transition_latency; /* HW must be able to switch to
503 next freq faster than this value in nano secs or we
504 will fallback to performance governor */
505 struct list_head governor_list;
506 struct module *owner;
507};
508
509/* Pass a target to the cpufreq driver */
Rafael J. Wysockib7898fd2016-03-30 03:47:49 +0200510unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
511 unsigned int target_freq);
Viresh Kumar74aca952013-08-06 22:53:04 +0530512int cpufreq_driver_target(struct cpufreq_policy *policy,
513 unsigned int target_freq,
514 unsigned int relation);
515int __cpufreq_driver_target(struct cpufreq_policy *policy,
516 unsigned int target_freq,
517 unsigned int relation);
Steve Mucklee3c06232016-07-13 13:25:25 -0700518unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
519 unsigned int target_freq);
Viresh Kumar74aca952013-08-06 22:53:04 +0530520int cpufreq_register_governor(struct cpufreq_governor *governor);
521void cpufreq_unregister_governor(struct cpufreq_governor *governor);
522
Rafael J. Wysockide1df262016-02-05 02:37:42 +0100523struct cpufreq_governor *cpufreq_default_governor(void);
524struct cpufreq_governor *cpufreq_fallback_governor(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Viresh Kumarbf2be2d2016-05-18 17:55:31 +0530526static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
527{
528 if (policy->max < policy->cur)
529 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
530 else if (policy->min > policy->cur)
531 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
532}
533
Rafael J. Wysocki66893b62016-03-22 02:50:45 +0100534/* Governor attribute set */
535struct gov_attr_set {
536 struct kobject kobj;
537 struct list_head policy_list;
538 struct mutex update_lock;
539 int usage_count;
540};
541
542/* sysfs ops for cpufreq governors */
543extern const struct sysfs_ops governor_sysfs_ops;
544
545void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
546void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
547unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
548
549/* Governor sysfs attribute */
550struct governor_attr {
551 struct attribute attr;
552 ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
553 ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
554 size_t count);
555};
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557/*********************************************************************
558 * FREQUENCY TABLE HELPERS *
559 *********************************************************************/
560
Viresh Kumar7f4b0462014-03-28 19:11:47 +0530561/* Special Values of .frequency field */
Brian W Hart2b1987a2014-06-27 16:09:39 -0500562#define CPUFREQ_ENTRY_INVALID ~0u
563#define CPUFREQ_TABLE_END ~1u
Viresh Kumar7f4b0462014-03-28 19:11:47 +0530564/* Special Values of .flags field */
565#define CPUFREQ_BOOST_FREQ (1 << 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
567struct cpufreq_frequency_table {
Viresh Kumar7f4b0462014-03-28 19:11:47 +0530568 unsigned int flags;
Viresh Kumar50701582013-03-30 16:25:15 +0530569 unsigned int driver_data; /* driver specific data, not used by core */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 unsigned int frequency; /* kHz - doesn't need to be in ascending
571 * order */
572};
573
Nishanth Menona0dd7b72014-05-05 08:33:50 -0500574#if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
575int dev_pm_opp_init_cpufreq_table(struct device *dev,
576 struct cpufreq_frequency_table **table);
577void dev_pm_opp_free_cpufreq_table(struct device *dev,
578 struct cpufreq_frequency_table **table);
579#else
580static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
581 struct cpufreq_frequency_table
582 **table)
583{
584 return -EINVAL;
585}
586
587static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
588 struct cpufreq_frequency_table
589 **table)
590{
591}
592#endif
593
Stratos Karafotis27e289d2014-04-25 23:15:23 +0300594/*
595 * cpufreq_for_each_entry - iterate over a cpufreq_frequency_table
596 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
597 * @table: the cpufreq_frequency_table * to iterate over.
598 */
599
600#define cpufreq_for_each_entry(pos, table) \
601 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
602
603/*
604 * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table
605 * excluding CPUFREQ_ENTRY_INVALID frequencies.
606 * @pos: the cpufreq_frequency_table * to use as a loop cursor.
607 * @table: the cpufreq_frequency_table * to iterate over.
608 */
609
Rafael J. Wysocki34b08702016-02-26 00:22:57 +0100610#define cpufreq_for_each_valid_entry(pos, table) \
611 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) \
612 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \
613 continue; \
614 else
Stratos Karafotis27e289d2014-04-25 23:15:23 +0300615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
617 struct cpufreq_frequency_table *table);
618
619int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
620 struct cpufreq_frequency_table *table);
Viresh Kumar18434512013-10-03 20:27:55 +0530621int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Viresh Kumarda0c6dc2016-06-27 16:04:07 +0530623int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
624 unsigned int target_freq,
625 unsigned int relation);
Viresh Kumard3916692013-12-03 11:20:46 +0530626int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
627 unsigned int freq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Viresh Kumar74aca952013-08-06 22:53:04 +0530629ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
630
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100631#ifdef CONFIG_CPU_FREQ
632int cpufreq_boost_trigger_state(int state);
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100633int cpufreq_boost_enabled(void);
Viresh Kumar44139ed2015-07-29 16:23:09 +0530634int cpufreq_enable_boost_support(void);
635bool policy_has_boost_freq(struct cpufreq_policy *policy);
Viresh Kumarda0c6dc2016-06-27 16:04:07 +0530636
637/* Find lowest freq at or above target in a table in ascending order */
638static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
639 unsigned int target_freq)
640{
641 struct cpufreq_frequency_table *table = policy->freq_table;
642 unsigned int freq;
643 int i, best = -1;
644
645 for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
646 freq = table[i].frequency;
647
648 if (freq >= target_freq)
649 return i;
650
651 best = i;
652 }
653
654 return best;
655}
656
657/* Find lowest freq at or above target in a table in descending order */
658static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
659 unsigned int target_freq)
660{
661 struct cpufreq_frequency_table *table = policy->freq_table;
662 unsigned int freq;
663 int i, best = -1;
664
665 for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
666 freq = table[i].frequency;
667
668 if (freq == target_freq)
669 return i;
670
671 if (freq > target_freq) {
672 best = i;
673 continue;
674 }
675
676 /* No freq found above target_freq */
677 if (best == -1)
678 return i;
679
680 return best;
681 }
682
683 return best;
684}
685
686/* Works only on sorted freq-tables */
687static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
688 unsigned int target_freq)
689{
690 target_freq = clamp_val(target_freq, policy->min, policy->max);
691
692 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
693 return cpufreq_table_find_index_al(policy, target_freq);
694 else
695 return cpufreq_table_find_index_dl(policy, target_freq);
696}
697
698/* Find highest freq at or below target in a table in ascending order */
699static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
700 unsigned int target_freq)
701{
702 struct cpufreq_frequency_table *table = policy->freq_table;
703 unsigned int freq;
704 int i, best = -1;
705
706 for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
707 freq = table[i].frequency;
708
709 if (freq == target_freq)
710 return i;
711
712 if (freq < target_freq) {
713 best = i;
714 continue;
715 }
716
717 /* No freq found below target_freq */
718 if (best == -1)
719 return i;
720
721 return best;
722 }
723
724 return best;
725}
726
727/* Find highest freq at or below target in a table in descending order */
728static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
729 unsigned int target_freq)
730{
731 struct cpufreq_frequency_table *table = policy->freq_table;
732 unsigned int freq;
733 int i, best = -1;
734
735 for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
736 freq = table[i].frequency;
737
738 if (freq <= target_freq)
739 return i;
740
741 best = i;
742 }
743
744 return best;
745}
746
747/* Works only on sorted freq-tables */
748static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
749 unsigned int target_freq)
750{
751 target_freq = clamp_val(target_freq, policy->min, policy->max);
752
753 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
754 return cpufreq_table_find_index_ah(policy, target_freq);
755 else
756 return cpufreq_table_find_index_dh(policy, target_freq);
757}
758
759/* Find closest freq to target in a table in ascending order */
760static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
761 unsigned int target_freq)
762{
763 struct cpufreq_frequency_table *table = policy->freq_table;
764 unsigned int freq;
765 int i, best = -1;
766
767 for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
768 freq = table[i].frequency;
769
770 if (freq == target_freq)
771 return i;
772
773 if (freq < target_freq) {
774 best = i;
775 continue;
776 }
777
778 /* No freq found below target_freq */
779 if (best == -1)
780 return i;
781
782 /* Choose the closest freq */
783 if (target_freq - table[best].frequency > freq - target_freq)
784 return i;
785
786 return best;
787 }
788
789 return best;
790}
791
792/* Find closest freq to target in a table in descending order */
793static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
794 unsigned int target_freq)
795{
796 struct cpufreq_frequency_table *table = policy->freq_table;
797 unsigned int freq;
798 int i, best = -1;
799
800 for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) {
801 freq = table[i].frequency;
802
803 if (freq == target_freq)
804 return i;
805
806 if (freq > target_freq) {
807 best = i;
808 continue;
809 }
810
811 /* No freq found above target_freq */
812 if (best == -1)
813 return i;
814
815 /* Choose the closest freq */
816 if (table[best].frequency - target_freq > target_freq - freq)
817 return i;
818
819 return best;
820 }
821
822 return best;
823}
824
825/* Works only on sorted freq-tables */
826static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
827 unsigned int target_freq)
828{
829 target_freq = clamp_val(target_freq, policy->min, policy->max);
830
831 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
832 return cpufreq_table_find_index_ac(policy, target_freq);
833 else
834 return cpufreq_table_find_index_dc(policy, target_freq);
835}
836
837static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
838 unsigned int target_freq,
839 unsigned int relation)
840{
841 if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
842 return cpufreq_table_index_unsorted(policy, target_freq,
843 relation);
844
845 switch (relation) {
846 case CPUFREQ_RELATION_L:
847 return cpufreq_table_find_index_l(policy, target_freq);
848 case CPUFREQ_RELATION_H:
849 return cpufreq_table_find_index_h(policy, target_freq);
850 case CPUFREQ_RELATION_C:
851 return cpufreq_table_find_index_c(policy, target_freq);
852 default:
853 pr_err("%s: Invalid relation: %d\n", __func__, relation);
854 return -EINVAL;
855 }
856}
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100857#else
858static inline int cpufreq_boost_trigger_state(int state)
859{
860 return 0;
861}
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100862static inline int cpufreq_boost_enabled(void)
863{
864 return 0;
865}
Viresh Kumar44139ed2015-07-29 16:23:09 +0530866
867static inline int cpufreq_enable_boost_support(void)
868{
869 return -EINVAL;
870}
871
872static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
873{
874 return false;
875}
Lukasz Majewski6f19efc2013-12-20 15:24:49 +0100876#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
878/* the following are really really optional */
879extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
Bartlomiej Zolnierkiewicz21c36d32015-08-07 13:59:16 +0200880extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
Viresh Kumar18434512013-10-03 20:27:55 +0530881extern struct freq_attr *cpufreq_generic_attr[];
Viresh Kumar27047a62013-09-16 18:56:03 +0530882int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
883 struct cpufreq_frequency_table *table);
Lan Tianyuf4fd3792013-06-27 15:08:54 +0800884
Viresh Kumar652ed952014-01-09 20:38:43 +0530885unsigned int cpufreq_generic_get(unsigned int cpu);
Viresh Kumar70e9e772013-10-03 20:29:07 +0530886int cpufreq_generic_init(struct cpufreq_policy *policy,
887 struct cpufreq_frequency_table *table,
888 unsigned int transition_latency);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889#endif /* _LINUX_CPUFREQ_H */