GNU Linux-libre 4.9.337-gnu1
[releases.git] / include / linux / cpufreq.h
1 /*
2  * linux/include/linux/cpufreq.h
3  *
4  * Copyright (C) 2001 Russell King
5  *           (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
6  *
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
14 #include <linux/clk.h>
15 #include <linux/cpumask.h>
16 #include <linux/completion.h>
17 #include <linux/kobject.h>
18 #include <linux/notifier.h>
19 #include <linux/spinlock.h>
20 #include <linux/sysfs.h>
21
22 /*********************************************************************
23  *                        CPUFREQ INTERFACE                          *
24  *********************************************************************/
25 /*
26  * Frequency values here are CPU kHz
27  *
28  * Maximum transition latency is in nanoseconds - if it's unknown,
29  * CPUFREQ_ETERNAL shall be used.
30  */
31
32 #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
37 struct cpufreq_governor;
38
39 enum cpufreq_table_sorting {
40         CPUFREQ_TABLE_UNSORTED,
41         CPUFREQ_TABLE_SORTED_ASCENDING,
42         CPUFREQ_TABLE_SORTED_DESCENDING
43 };
44
45 struct 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 };
51
52 struct cpufreq_cpuinfo {
53         unsigned int            max_freq;
54         unsigned int            min_freq;
55
56         /* in 10^(-9) s = nanoseconds */
57         unsigned int            transition_latency;
58 };
59
60 struct cpufreq_user_policy {
61         unsigned int            min;    /* in kHz */
62         unsigned int            max;    /* in kHz */
63 };
64
65 struct cpufreq_policy {
66         /* CPUs sharing clock, require sw coordination */
67         cpumask_var_t           cpus;   /* Online CPUs only */
68         cpumask_var_t           related_cpus; /* Online + Offline CPUs */
69         cpumask_var_t           real_cpus; /* Related and present */
70
71         unsigned int            shared_type; /* ACPI: ANY or ALL affected CPUs
72                                                 should set cpufreq */
73         unsigned int            cpu;    /* cpu managing this policy, must be online */
74
75         struct clk              *clk;
76         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 */
82         unsigned int            restore_freq; /* = policy->cur before transition */
83         unsigned int            suspend_freq; /* freq to set during suspend */
84
85         unsigned int            policy; /* see above */
86         unsigned int            last_policy; /* policy before unplug */
87         struct cpufreq_governor *governor; /* see below */
88         void                    *governor_data;
89         char                    last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
90
91         struct work_struct      update; /* if update_policy() needs to be
92                                          * called, but you're in IRQ context */
93
94         struct cpufreq_user_policy user_policy;
95         struct cpufreq_frequency_table  *freq_table;
96         enum cpufreq_table_sorting freq_table_sorted;
97
98         struct list_head        policy_list;
99         struct kobject          kobj;
100         struct completion       kobj_unregister;
101
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.
109          */
110         struct rw_semaphore     rwsem;
111
112         /*
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
123          /* Cached frequency lookup from cpufreq_driver_resolve_freq. */
124         unsigned int cached_target_freq;
125         int cached_resolved_idx;
126
127         /* Synchronization for frequency transitions */
128         bool                    transition_ongoing; /* Tracks transition status */
129         spinlock_t              transition_lock;
130         wait_queue_head_t       transition_wait;
131         struct task_struct      *transition_task; /* Task which is doing the transition */
132
133         /* cpufreq-stats */
134         struct cpufreq_stats    *stats;
135
136         /* For cpufreq driver's internal use */
137         void                    *driver_data;
138 };
139
140 /* Only for ACPI */
141 #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*/
145
146 #ifdef CONFIG_CPU_FREQ
147 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
148 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
149 void cpufreq_cpu_put(struct cpufreq_policy *policy);
150 #else
151 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
152 {
153         return NULL;
154 }
155 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
156 {
157         return NULL;
158 }
159 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
160 #endif
161
162 static inline bool policy_is_shared(struct cpufreq_policy *policy)
163 {
164         return cpumask_weight(policy->cpus) > 1;
165 }
166
167 /* /sys/devices/system/cpu/cpufreq: entry point for global variables */
168 extern struct kobject *cpufreq_global_kobject;
169
170 #ifdef CONFIG_CPU_FREQ
171 unsigned int cpufreq_get(unsigned int cpu);
172 unsigned int cpufreq_quick_get(unsigned int cpu);
173 unsigned int cpufreq_quick_get_max(unsigned int cpu);
174 void disable_cpufreq(void);
175
176 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
177 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
178 int cpufreq_update_policy(unsigned int cpu);
179 bool have_governor_per_policy(void);
180 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
181 void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
182 void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
183 #else
184 static inline unsigned int cpufreq_get(unsigned int cpu)
185 {
186         return 0;
187 }
188 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
189 {
190         return 0;
191 }
192 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
193 {
194         return 0;
195 }
196 static inline void disable_cpufreq(void) { }
197 #endif
198
199 #ifdef CONFIG_CPU_FREQ_STAT
200 void cpufreq_stats_create_table(struct cpufreq_policy *policy);
201 void cpufreq_stats_free_table(struct cpufreq_policy *policy);
202 void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
203                                      unsigned int new_freq);
204 #else
205 static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
206 static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
207 static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
208                                                    unsigned int new_freq) { }
209 #endif /* CONFIG_CPU_FREQ_STAT */
210
211 /*********************************************************************
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 */
217 #define CPUFREQ_RELATION_C 2  /* closest frequency to target */
218
219 struct 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)             \
226 static struct freq_attr _name =                 \
227 __ATTR(_name, 0444, show_##_name, NULL)
228
229 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
230 static struct freq_attr _name =                 \
231 __ATTR(_name, _perm, show_##_name, NULL)
232
233 #define cpufreq_freq_attr_rw(_name)             \
234 static struct freq_attr _name =                 \
235 __ATTR(_name, 0644, show_##_name, store_##_name)
236
237 #define define_one_global_ro(_name)             \
238 static struct kobj_attribute _name =            \
239 __ATTR(_name, 0444, show_##_name, NULL)
240
241 #define define_one_global_rw(_name)             \
242 static struct kobj_attribute _name =            \
243 __ATTR(_name, 0644, show_##_name, store_##_name)
244
245
246 struct cpufreq_driver {
247         char            name[CPUFREQ_NAME_LEN];
248         u8              flags;
249         void            *driver_data;
250
251         /* needed by all drivers */
252         int             (*init)(struct cpufreq_policy *policy);
253         int             (*verify)(struct cpufreq_policy *policy);
254
255         /* define one out of two */
256         int             (*setpolicy)(struct cpufreq_policy *policy);
257
258         /*
259          * On failure, should always restore frequency to policy->restore_freq
260          * (i.e. old freq).
261          */
262         int             (*target)(struct cpufreq_policy *policy,
263                                   unsigned int target_freq,
264                                   unsigned int relation);       /* Deprecated */
265         int             (*target_index)(struct cpufreq_policy *policy,
266                                         unsigned int index);
267         unsigned int    (*fast_switch)(struct cpufreq_policy *policy,
268                                        unsigned int target_freq);
269
270         /*
271          * Caches and returns the lowest driver-supported frequency greater than
272          * or equal to the target frequency, subject to any driver limitations.
273          * Does not set the frequency. Only to be implemented for drivers with
274          * target().
275          */
276         unsigned int    (*resolve_freq)(struct cpufreq_policy *policy,
277                                         unsigned int target_freq);
278
279         /*
280          * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
281          * unset.
282          *
283          * get_intermediate should return a stable intermediate frequency
284          * platform wants to switch to and target_intermediate() should set CPU
285          * to to that frequency, before jumping to the frequency corresponding
286          * to 'index'. Core will take care of sending notifications and driver
287          * doesn't have to handle them in target_intermediate() or
288          * target_index().
289          *
290          * Drivers can return '0' from get_intermediate() in case they don't
291          * wish to switch to intermediate frequency for some target frequency.
292          * In that case core will directly call ->target_index().
293          */
294         unsigned int    (*get_intermediate)(struct cpufreq_policy *policy,
295                                             unsigned int index);
296         int             (*target_intermediate)(struct cpufreq_policy *policy,
297                                                unsigned int index);
298
299         /* should be defined, if possible */
300         unsigned int    (*get)(unsigned int cpu);
301
302         /* optional */
303         int             (*bios_limit)(int cpu, unsigned int *limit);
304
305         int             (*exit)(struct cpufreq_policy *policy);
306         void            (*stop_cpu)(struct cpufreq_policy *policy);
307         int             (*suspend)(struct cpufreq_policy *policy);
308         int             (*resume)(struct cpufreq_policy *policy);
309
310         /* Will be called after the driver is fully initialized */
311         void            (*ready)(struct cpufreq_policy *policy);
312
313         struct freq_attr **attr;
314
315         /* platform specific boost support code */
316         bool            boost_enabled;
317         int             (*set_boost)(int state);
318 };
319
320 /* flags */
321 #define CPUFREQ_STICKY          (1 << 0)        /* driver isn't removed even if
322                                                    all ->init() calls failed */
323 #define CPUFREQ_CONST_LOOPS     (1 << 1)        /* loops_per_jiffy or other
324                                                    kernel "constants" aren't
325                                                    affected by frequency
326                                                    transitions */
327 #define CPUFREQ_PM_NO_WARN      (1 << 2)        /* don't warn on suspend/resume
328                                                    speed mismatches */
329
330 /*
331  * This should be set by platforms having multiple clock-domains, i.e.
332  * supporting multiple policies. With this sysfs directories of governor would
333  * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
334  * governor with different tunables for different clusters.
335  */
336 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
337
338 /*
339  * Driver will do POSTCHANGE notifications from outside of their ->target()
340  * routine and so must set cpufreq_driver->flags with this flag, so that core
341  * can handle them specially.
342  */
343 #define CPUFREQ_ASYNC_NOTIFICATION  (1 << 4)
344
345 /*
346  * Set by drivers which want cpufreq core to check if CPU is running at a
347  * frequency present in freq-table exposed by the driver. For these drivers if
348  * CPU is found running at an out of table freq, we will try to set it to a freq
349  * from the table. And if that fails, we will stop further boot process by
350  * issuing a BUG_ON().
351  */
352 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
353
354 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
355 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
356
357 const char *cpufreq_get_current_driver(void);
358 void *cpufreq_get_driver_data(void);
359
360 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
361                 unsigned int min, unsigned int max)
362 {
363         if (policy->min < min)
364                 policy->min = min;
365         if (policy->max < min)
366                 policy->max = min;
367         if (policy->min > max)
368                 policy->min = max;
369         if (policy->max > max)
370                 policy->max = max;
371         if (policy->min > policy->max)
372                 policy->min = policy->max;
373         return;
374 }
375
376 static inline void
377 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
378 {
379         cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
380                         policy->cpuinfo.max_freq);
381 }
382
383 #ifdef CONFIG_CPU_FREQ
384 void cpufreq_suspend(void);
385 void cpufreq_resume(void);
386 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
387 #else
388 static inline void cpufreq_suspend(void) {}
389 static inline void cpufreq_resume(void) {}
390 #endif
391
392 /*********************************************************************
393  *                     CPUFREQ NOTIFIER INTERFACE                    *
394  *********************************************************************/
395
396 #define CPUFREQ_TRANSITION_NOTIFIER     (0)
397 #define CPUFREQ_POLICY_NOTIFIER         (1)
398
399 /* Transition notifiers */
400 #define CPUFREQ_PRECHANGE               (0)
401 #define CPUFREQ_POSTCHANGE              (1)
402
403 /* Policy Notifiers  */
404 #define CPUFREQ_ADJUST                  (0)
405 #define CPUFREQ_NOTIFY                  (1)
406 #define CPUFREQ_START                   (2)
407 #define CPUFREQ_CREATE_POLICY           (3)
408 #define CPUFREQ_REMOVE_POLICY           (4)
409
410 #ifdef CONFIG_CPU_FREQ
411 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
412 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
413
414 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
415                 struct cpufreq_freqs *freqs);
416 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
417                 struct cpufreq_freqs *freqs, int transition_failed);
418
419 #else /* CONFIG_CPU_FREQ */
420 static inline int cpufreq_register_notifier(struct notifier_block *nb,
421                                                 unsigned int list)
422 {
423         return 0;
424 }
425 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
426                                                 unsigned int list)
427 {
428         return 0;
429 }
430 #endif /* !CONFIG_CPU_FREQ */
431
432 /**
433  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
434  * safe)
435  * @old:   old value
436  * @div:   divisor
437  * @mult:  multiplier
438  *
439  *
440  * new = old * mult / div
441  */
442 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
443                 u_int mult)
444 {
445 #if BITS_PER_LONG == 32
446         u64 result = ((u64) old) * ((u64) mult);
447         do_div(result, div);
448         return (unsigned long) result;
449
450 #elif BITS_PER_LONG == 64
451         unsigned long result = old * ((u64) mult);
452         result /= div;
453         return result;
454 #endif
455 }
456
457 /*********************************************************************
458  *                          CPUFREQ GOVERNORS                        *
459  *********************************************************************/
460
461 /*
462  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
463  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
464  * two generic policies are available:
465  */
466 #define CPUFREQ_POLICY_POWERSAVE        (1)
467 #define CPUFREQ_POLICY_PERFORMANCE      (2)
468
469 /*
470  * The polling frequency depends on the capability of the processor. Default
471  * polling frequency is 1000 times the transition latency of the processor. The
472  * ondemand governor will work on any processor with transition latency <= 10ms,
473  * using appropriate sampling rate.
474  *
475  * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL)
476  * the ondemand governor will not work. All times here are in us (microseconds).
477  */
478 #define MIN_SAMPLING_RATE_RATIO         (2)
479 #define LATENCY_MULTIPLIER              (1000)
480 #define MIN_LATENCY_MULTIPLIER          (20)
481 #define TRANSITION_LATENCY_LIMIT        (10 * 1000 * 1000)
482
483 struct cpufreq_governor {
484         char    name[CPUFREQ_NAME_LEN];
485         int     (*init)(struct cpufreq_policy *policy);
486         void    (*exit)(struct cpufreq_policy *policy);
487         int     (*start)(struct cpufreq_policy *policy);
488         void    (*stop)(struct cpufreq_policy *policy);
489         void    (*limits)(struct cpufreq_policy *policy);
490         ssize_t (*show_setspeed)        (struct cpufreq_policy *policy,
491                                          char *buf);
492         int     (*store_setspeed)       (struct cpufreq_policy *policy,
493                                          unsigned int freq);
494         unsigned int max_transition_latency; /* HW must be able to switch to
495                         next freq faster than this value in nano secs or we
496                         will fallback to performance governor */
497         struct list_head        governor_list;
498         struct module           *owner;
499 };
500
501 /* Pass a target to the cpufreq driver */
502 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
503                                         unsigned int target_freq);
504 int cpufreq_driver_target(struct cpufreq_policy *policy,
505                                  unsigned int target_freq,
506                                  unsigned int relation);
507 int __cpufreq_driver_target(struct cpufreq_policy *policy,
508                                    unsigned int target_freq,
509                                    unsigned int relation);
510 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
511                                          unsigned int target_freq);
512 int cpufreq_register_governor(struct cpufreq_governor *governor);
513 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
514
515 struct cpufreq_governor *cpufreq_default_governor(void);
516 struct cpufreq_governor *cpufreq_fallback_governor(void);
517
518 static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
519 {
520         if (policy->max < policy->cur)
521                 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
522         else if (policy->min > policy->cur)
523                 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
524 }
525
526 /* Governor attribute set */
527 struct gov_attr_set {
528         struct kobject kobj;
529         struct list_head policy_list;
530         struct mutex update_lock;
531         int usage_count;
532 };
533
534 /* sysfs ops for cpufreq governors */
535 extern const struct sysfs_ops governor_sysfs_ops;
536
537 void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
538 void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
539 unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
540
541 /* Governor sysfs attribute */
542 struct governor_attr {
543         struct attribute attr;
544         ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
545         ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
546                          size_t count);
547 };
548
549 /*********************************************************************
550  *                     FREQUENCY TABLE HELPERS                       *
551  *********************************************************************/
552
553 /* Special Values of .frequency field */
554 #define CPUFREQ_ENTRY_INVALID   ~0u
555 #define CPUFREQ_TABLE_END       ~1u
556 /* Special Values of .flags field */
557 #define CPUFREQ_BOOST_FREQ      (1 << 0)
558
559 struct cpufreq_frequency_table {
560         unsigned int    flags;
561         unsigned int    driver_data; /* driver specific data, not used by core */
562         unsigned int    frequency; /* kHz - doesn't need to be in ascending
563                                     * order */
564 };
565
566 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
567 int dev_pm_opp_init_cpufreq_table(struct device *dev,
568                                   struct cpufreq_frequency_table **table);
569 void dev_pm_opp_free_cpufreq_table(struct device *dev,
570                                    struct cpufreq_frequency_table **table);
571 #else
572 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
573                                                 struct cpufreq_frequency_table
574                                                 **table)
575 {
576         return -EINVAL;
577 }
578
579 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
580                                                  struct cpufreq_frequency_table
581                                                  **table)
582 {
583 }
584 #endif
585
586 /*
587  * cpufreq_for_each_entry -     iterate over a cpufreq_frequency_table
588  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
589  * @table:      the cpufreq_frequency_table * to iterate over.
590  */
591
592 #define cpufreq_for_each_entry(pos, table)      \
593         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
594
595 /*
596  * cpufreq_for_each_valid_entry -     iterate over a cpufreq_frequency_table
597  *      excluding CPUFREQ_ENTRY_INVALID frequencies.
598  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
599  * @table:      the cpufreq_frequency_table * to iterate over.
600  */
601
602 #define cpufreq_for_each_valid_entry(pos, table)                        \
603         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)   \
604                 if (pos->frequency == CPUFREQ_ENTRY_INVALID)            \
605                         continue;                                       \
606                 else
607
608 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
609                                     struct cpufreq_frequency_table *table);
610
611 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
612                                    struct cpufreq_frequency_table *table);
613 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
614
615 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
616                                  unsigned int target_freq,
617                                  unsigned int relation);
618 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
619                 unsigned int freq);
620
621 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
622
623 #ifdef CONFIG_CPU_FREQ
624 int cpufreq_boost_trigger_state(int state);
625 int cpufreq_boost_enabled(void);
626 int cpufreq_enable_boost_support(void);
627 bool policy_has_boost_freq(struct cpufreq_policy *policy);
628
629 /* Find lowest freq at or above target in a table in ascending order */
630 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
631                                               unsigned int target_freq)
632 {
633         struct cpufreq_frequency_table *table = policy->freq_table;
634         struct cpufreq_frequency_table *pos, *best = table - 1;
635         unsigned int freq;
636
637         cpufreq_for_each_valid_entry(pos, table) {
638                 freq = pos->frequency;
639
640                 if (freq >= target_freq)
641                         return pos - table;
642
643                 best = pos;
644         }
645
646         return best - table;
647 }
648
649 /* Find lowest freq at or above target in a table in descending order */
650 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
651                                               unsigned int target_freq)
652 {
653         struct cpufreq_frequency_table *table = policy->freq_table;
654         struct cpufreq_frequency_table *pos, *best = table - 1;
655         unsigned int freq;
656
657         cpufreq_for_each_valid_entry(pos, table) {
658                 freq = pos->frequency;
659
660                 if (freq == target_freq)
661                         return pos - table;
662
663                 if (freq > target_freq) {
664                         best = pos;
665                         continue;
666                 }
667
668                 /* No freq found above target_freq */
669                 if (best == table - 1)
670                         return pos - table;
671
672                 return best - table;
673         }
674
675         return best - table;
676 }
677
678 /* Works only on sorted freq-tables */
679 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
680                                              unsigned int target_freq)
681 {
682         target_freq = clamp_val(target_freq, policy->min, policy->max);
683
684         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
685                 return cpufreq_table_find_index_al(policy, target_freq);
686         else
687                 return cpufreq_table_find_index_dl(policy, target_freq);
688 }
689
690 /* Find highest freq at or below target in a table in ascending order */
691 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
692                                               unsigned int target_freq)
693 {
694         struct cpufreq_frequency_table *table = policy->freq_table;
695         struct cpufreq_frequency_table *pos, *best = table - 1;
696         unsigned int freq;
697
698         cpufreq_for_each_valid_entry(pos, table) {
699                 freq = pos->frequency;
700
701                 if (freq == target_freq)
702                         return pos - table;
703
704                 if (freq < target_freq) {
705                         best = pos;
706                         continue;
707                 }
708
709                 /* No freq found below target_freq */
710                 if (best == table - 1)
711                         return pos - table;
712
713                 return best - table;
714         }
715
716         return best - table;
717 }
718
719 /* Find highest freq at or below target in a table in descending order */
720 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
721                                               unsigned int target_freq)
722 {
723         struct cpufreq_frequency_table *table = policy->freq_table;
724         struct cpufreq_frequency_table *pos, *best = table - 1;
725         unsigned int freq;
726
727         cpufreq_for_each_valid_entry(pos, table) {
728                 freq = pos->frequency;
729
730                 if (freq <= target_freq)
731                         return pos - table;
732
733                 best = pos;
734         }
735
736         return best - table;
737 }
738
739 /* Works only on sorted freq-tables */
740 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
741                                              unsigned int target_freq)
742 {
743         target_freq = clamp_val(target_freq, policy->min, policy->max);
744
745         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
746                 return cpufreq_table_find_index_ah(policy, target_freq);
747         else
748                 return cpufreq_table_find_index_dh(policy, target_freq);
749 }
750
751 /* Find closest freq to target in a table in ascending order */
752 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
753                                               unsigned int target_freq)
754 {
755         struct cpufreq_frequency_table *table = policy->freq_table;
756         struct cpufreq_frequency_table *pos, *best = table - 1;
757         unsigned int freq;
758
759         cpufreq_for_each_valid_entry(pos, table) {
760                 freq = pos->frequency;
761
762                 if (freq == target_freq)
763                         return pos - table;
764
765                 if (freq < target_freq) {
766                         best = pos;
767                         continue;
768                 }
769
770                 /* No freq found below target_freq */
771                 if (best == table - 1)
772                         return pos - table;
773
774                 /* Choose the closest freq */
775                 if (target_freq - best->frequency > freq - target_freq)
776                         return pos - table;
777
778                 return best - table;
779         }
780
781         return best - table;
782 }
783
784 /* Find closest freq to target in a table in descending order */
785 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
786                                               unsigned int target_freq)
787 {
788         struct cpufreq_frequency_table *table = policy->freq_table;
789         struct cpufreq_frequency_table *pos, *best = table - 1;
790         unsigned int freq;
791
792         cpufreq_for_each_valid_entry(pos, table) {
793                 freq = pos->frequency;
794
795                 if (freq == target_freq)
796                         return pos - table;
797
798                 if (freq > target_freq) {
799                         best = pos;
800                         continue;
801                 }
802
803                 /* No freq found above target_freq */
804                 if (best == table - 1)
805                         return pos - table;
806
807                 /* Choose the closest freq */
808                 if (best->frequency - target_freq > target_freq - freq)
809                         return pos - table;
810
811                 return best - table;
812         }
813
814         return best - table;
815 }
816
817 /* Works only on sorted freq-tables */
818 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
819                                              unsigned int target_freq)
820 {
821         target_freq = clamp_val(target_freq, policy->min, policy->max);
822
823         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
824                 return cpufreq_table_find_index_ac(policy, target_freq);
825         else
826                 return cpufreq_table_find_index_dc(policy, target_freq);
827 }
828
829 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
830                                                  unsigned int target_freq,
831                                                  unsigned int relation)
832 {
833         if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
834                 return cpufreq_table_index_unsorted(policy, target_freq,
835                                                     relation);
836
837         switch (relation) {
838         case CPUFREQ_RELATION_L:
839                 return cpufreq_table_find_index_l(policy, target_freq);
840         case CPUFREQ_RELATION_H:
841                 return cpufreq_table_find_index_h(policy, target_freq);
842         case CPUFREQ_RELATION_C:
843                 return cpufreq_table_find_index_c(policy, target_freq);
844         default:
845                 pr_err("%s: Invalid relation: %d\n", __func__, relation);
846                 return -EINVAL;
847         }
848 }
849 #else
850 static inline int cpufreq_boost_trigger_state(int state)
851 {
852         return 0;
853 }
854 static inline int cpufreq_boost_enabled(void)
855 {
856         return 0;
857 }
858
859 static inline int cpufreq_enable_boost_support(void)
860 {
861         return -EINVAL;
862 }
863
864 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
865 {
866         return false;
867 }
868 #endif
869
870 /* the following are really really optional */
871 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
872 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
873 extern struct freq_attr *cpufreq_generic_attr[];
874 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
875                                       struct cpufreq_frequency_table *table);
876
877 unsigned int cpufreq_generic_get(unsigned int cpu);
878 int cpufreq_generic_init(struct cpufreq_policy *policy,
879                 struct cpufreq_frequency_table *table,
880                 unsigned int transition_latency);
881 #endif /* _LINUX_CPUFREQ_H */