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 void 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 cpufreq_freq_attr_wo(_name)             \
 238 static struct freq_attr _name =                 \
 239 __ATTR(_name, 0200, NULL, store_##_name)
 240
 241 struct global_attr {
 242         struct attribute attr;
 243         ssize_t (*show)(struct kobject *kobj,
 244                         struct attribute *attr, char *buf);
 245         ssize_t (*store)(struct kobject *a, struct attribute *b,
 246                          const char *c, size_t count);
 247 };
 248
 249 #define define_one_global_ro(_name)             \
 250 static struct global_attr _name =               \
 251 __ATTR(_name, 0444, show_##_name, NULL)
 252
 253 #define define_one_global_rw(_name)             \
 254 static struct global_attr _name =               \
 255 __ATTR(_name, 0644, show_##_name, store_##_name)
 256
 257
 258 struct cpufreq_driver {
 259         char            name[CPUFREQ_NAME_LEN];
 260         u8              flags;
 261         void            *driver_data;
 262
 263         /* needed by all drivers */
 264         int             (*init)(struct cpufreq_policy *policy);
 265         int             (*verify)(struct cpufreq_policy *policy);
 266
 267         /* define one out of two */
 268         int             (*setpolicy)(struct cpufreq_policy *policy);
 269
 270         /*
 271          * On failure, should always restore frequency to policy->restore_freq
 272          * (i.e. old freq).
 273          */
 274         int             (*target)(struct cpufreq_policy *policy,
 275                                   unsigned int target_freq,
 276                                   unsigned int relation);       /* Deprecated */
 277         int             (*target_index)(struct cpufreq_policy *policy,
 278                                         unsigned int index);
 279         unsigned int    (*fast_switch)(struct cpufreq_policy *policy,
 280                                        unsigned int target_freq);
 281
 282         /*
 283          * Caches and returns the lowest driver-supported frequency greater than
 284          * or equal to the target frequency, subject to any driver limitations.
 285          * Does not set the frequency. Only to be implemented for drivers with
 286          * target().
 287          */
 288         unsigned int    (*resolve_freq)(struct cpufreq_policy *policy,
 289                                         unsigned int target_freq);
 290
 291         /*
 292          * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
 293          * unset.
 294          *
 295          * get_intermediate should return a stable intermediate frequency
 296          * platform wants to switch to and target_intermediate() should set CPU
 297          * to to that frequency, before jumping to the frequency corresponding
 298          * to 'index'. Core will take care of sending notifications and driver
 299          * doesn't have to handle them in target_intermediate() or
 300          * target_index().
 301          *
 302          * Drivers can return '0' from get_intermediate() in case they don't
 303          * wish to switch to intermediate frequency for some target frequency.
 304          * In that case core will directly call ->target_index().
 305          */
 306         unsigned int    (*get_intermediate)(struct cpufreq_policy *policy,
 307                                             unsigned int index);
 308         int             (*target_intermediate)(struct cpufreq_policy *policy,
 309                                                unsigned int index);
 310
 311         /* should be defined, if possible */
 312         unsigned int    (*get)(unsigned int cpu);
 313
 314         /* optional */
 315         int             (*bios_limit)(int cpu, unsigned int *limit);
 316
 317         int             (*exit)(struct cpufreq_policy *policy);
 318         void            (*stop_cpu)(struct cpufreq_policy *policy);
 319         int             (*suspend)(struct cpufreq_policy *policy);
 320         int             (*resume)(struct cpufreq_policy *policy);
 321
 322         /* Will be called after the driver is fully initialized */
 323         void            (*ready)(struct cpufreq_policy *policy);
 324
 325         struct freq_attr **attr;
 326
 327         /* platform specific boost support code */
 328         bool            boost_enabled;
 329         int             (*set_boost)(int state);
 330 };
 331
 332 /* flags */
 333 #define CPUFREQ_STICKY          (1 << 0)        /* driver isn't removed even if
 334                                                    all ->init() calls failed */
 335 #define CPUFREQ_CONST_LOOPS     (1 << 1)        /* loops_per_jiffy or other
 336                                                    kernel "constants" aren't
 337                                                    affected by frequency
 338                                                    transitions */
 339 #define CPUFREQ_PM_NO_WARN      (1 << 2)        /* don't warn on suspend/resume
 340                                                    speed mismatches */
 341
 342 /*
 343  * This should be set by platforms having multiple clock-domains, i.e.
 344  * supporting multiple policies. With this sysfs directories of governor would
 345  * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
 346  * governor with different tunables for different clusters.
 347  */
 348 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
 349
 350 /*
 351  * Driver will do POSTCHANGE notifications from outside of their ->target()
 352  * routine and so must set cpufreq_driver->flags with this flag, so that core
 353  * can handle them specially.
 354  */
 355 #define CPUFREQ_ASYNC_NOTIFICATION  (1 << 4)
 356
 357 /*
 358  * Set by drivers which want cpufreq core to check if CPU is running at a
 359  * frequency present in freq-table exposed by the driver. For these drivers if
 360  * CPU is found running at an out of table freq, we will try to set it to a freq
 361  * from the table. And if that fails, we will stop further boot process by
 362  * issuing a BUG_ON().
 363  */
 364 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
 365
 366 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
 367 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
 368
 369 const char *cpufreq_get_current_driver(void);
 370 void *cpufreq_get_driver_data(void);
 371
 372 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
 373                 unsigned int min, unsigned int max)
 374 {
 375         if (policy->min < min)
 376                 policy->min = min;
 377         if (policy->max < min)
 378                 policy->max = min;
 379         if (policy->min > max)
 380                 policy->min = max;
 381         if (policy->max > max)
 382                 policy->max = max;
 383         if (policy->min > policy->max)
 384                 policy->min = policy->max;
 385         return;
 386 }
 387
 388 static inline void
 389 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
 390 {
 391         cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
 392                         policy->cpuinfo.max_freq);
 393 }
 394
 395 #ifdef CONFIG_CPU_FREQ
 396 void cpufreq_suspend(void);
 397 void cpufreq_resume(void);
 398 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
 399 #else
 400 static inline void cpufreq_suspend(void) {}
 401 static inline void cpufreq_resume(void) {}
 402 #endif
 403
 404 /*********************************************************************
 405  *                     CPUFREQ NOTIFIER INTERFACE                    *
 406  *********************************************************************/
 407
 408 #define CPUFREQ_TRANSITION_NOTIFIER     (0)
 409 #define CPUFREQ_POLICY_NOTIFIER         (1)
 410
 411 /* Transition notifiers */
 412 #define CPUFREQ_PRECHANGE               (0)
 413 #define CPUFREQ_POSTCHANGE              (1)
 414
 415 /* Policy Notifiers  */
 416 #define CPUFREQ_ADJUST                  (0)
 417 #define CPUFREQ_NOTIFY                  (1)
 418 #define CPUFREQ_START                   (2)
 419
 420 #ifdef CONFIG_CPU_FREQ
 421 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
 422 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
 423
 424 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
 425                 struct cpufreq_freqs *freqs);
 426 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
 427                 struct cpufreq_freqs *freqs, int transition_failed);
 428
 429 #else /* CONFIG_CPU_FREQ */
 430 static inline int cpufreq_register_notifier(struct notifier_block *nb,
 431                                                 unsigned int list)
 432 {
 433         return 0;
 434 }
 435 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
 436                                                 unsigned int list)
 437 {
 438         return 0;
 439 }
 440 #endif /* !CONFIG_CPU_FREQ */
 441
 442 /**
 443  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
 444  * safe)
 445  * @old:   old value
 446  * @div:   divisor
 447  * @mult:  multiplier
 448  *
 449  *
 450  * new = old * mult / div
 451  */
 452 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
 453                 u_int mult)
 454 {
 455 #if BITS_PER_LONG == 32
 456         u64 result = ((u64) old) * ((u64) mult);
 457         do_div(result, div);
 458         return (unsigned long) result;
 459
 460 #elif BITS_PER_LONG == 64
 461         unsigned long result = old * ((u64) mult);
 462         result /= div;
 463         return result;
 464 #endif
 465 }
 466
 467 /*********************************************************************
 468  *                          CPUFREQ GOVERNORS                        *
 469  *********************************************************************/
 470
 471 /*
 472  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
 473  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
 474  * two generic policies are available:
 475  */
 476 #define CPUFREQ_POLICY_POWERSAVE        (1)
 477 #define CPUFREQ_POLICY_PERFORMANCE      (2)
 478
 479 /*
 480  * The polling frequency depends on the capability of the processor. Default
 481  * polling frequency is 1000 times the transition latency of the processor. The
 482  * ondemand governor will work on any processor with transition latency <= 10ms,
 483  * using appropriate sampling rate.
 484  *
 485  * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL)
 486  * the ondemand governor will not work. All times here are in us (microseconds).
 487  */
 488 #define MIN_SAMPLING_RATE_RATIO         (2)
 489 #define LATENCY_MULTIPLIER              (1000)
 490 #define MIN_LATENCY_MULTIPLIER          (20)
 491 #define TRANSITION_LATENCY_LIMIT        (10 * 1000 * 1000)
 492
 493 struct cpufreq_governor {
 494         char    name[CPUFREQ_NAME_LEN];
 495         int     (*init)(struct cpufreq_policy *policy);
 496         void    (*exit)(struct cpufreq_policy *policy);
 497         int     (*start)(struct cpufreq_policy *policy);
 498         void    (*stop)(struct cpufreq_policy *policy);
 499         void    (*limits)(struct cpufreq_policy *policy);
 500         ssize_t (*show_setspeed)        (struct cpufreq_policy *policy,
 501                                          char *buf);
 502         int     (*store_setspeed)       (struct cpufreq_policy *policy,
 503                                          unsigned int freq);
 504         unsigned int max_transition_latency; /* HW must be able to switch to
 505                         next freq faster than this value in nano secs or we
 506                         will fallback to performance governor */
 507         struct list_head        governor_list;
 508         struct module           *owner;
 509 };
 510
 511 /* Pass a target to the cpufreq driver */
 512 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
 513                                         unsigned int target_freq);
 514 int cpufreq_driver_target(struct cpufreq_policy *policy,
 515                                  unsigned int target_freq,
 516                                  unsigned int relation);
 517 int __cpufreq_driver_target(struct cpufreq_policy *policy,
 518                                    unsigned int target_freq,
 519                                    unsigned int relation);
 520 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
 521                                          unsigned int target_freq);
 522 int cpufreq_register_governor(struct cpufreq_governor *governor);
 523 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
 524
 525 struct cpufreq_governor *cpufreq_default_governor(void);
 526 struct cpufreq_governor *cpufreq_fallback_governor(void);
 527
 528 static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
 529 {
 530         if (policy->max < policy->cur)
 531                 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
 532         else if (policy->min > policy->cur)
 533                 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
 534 }
 535
 536 /* Governor attribute set */
 537 struct gov_attr_set {
 538         struct kobject kobj;
 539         struct list_head policy_list;
 540         struct mutex update_lock;
 541         int usage_count;
 542 };
 543
 544 /* sysfs ops for cpufreq governors */
 545 extern const struct sysfs_ops governor_sysfs_ops;
 546
 547 void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
 548 void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
 549 unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
 550
 551 /* Governor sysfs attribute */
 552 struct governor_attr {
 553         struct attribute attr;
 554         ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
 555         ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
 556                          size_t count);
 557 };
 558
 559 /*********************************************************************
 560  *                     FREQUENCY TABLE HELPERS                       *
 561  *********************************************************************/
 562
 563 /* Special Values of .frequency field */
 564 #define CPUFREQ_ENTRY_INVALID   ~0u
 565 #define CPUFREQ_TABLE_END       ~1u
 566 /* Special Values of .flags field */
 567 #define CPUFREQ_BOOST_FREQ      (1 << 0)
 568
 569 struct cpufreq_frequency_table {
 570         unsigned int    flags;
 571         unsigned int    driver_data; /* driver specific data, not used by core */
 572         unsigned int    frequency; /* kHz - doesn't need to be in ascending
 573                                     * order */
 574 };
 575
 576 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
 577 int dev_pm_opp_init_cpufreq_table(struct device *dev,
 578                                   struct cpufreq_frequency_table **table);
 579 void dev_pm_opp_free_cpufreq_table(struct device *dev,
 580                                    struct cpufreq_frequency_table **table);
 581 #else
 582 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
 583                                                 struct cpufreq_frequency_table
 584                                                 **table)
 585 {
 586         return -EINVAL;
 587 }
 588
 589 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
 590                                                  struct cpufreq_frequency_table
 591                                                  **table)
 592 {
 593 }
 594 #endif
 595
 596 /*
 597  * cpufreq_for_each_entry -     iterate over a cpufreq_frequency_table
 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_entry(pos, table)      \
 603         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
 604
 605 /*
 606  * cpufreq_for_each_valid_entry -     iterate over a cpufreq_frequency_table
 607  *      excluding CPUFREQ_ENTRY_INVALID frequencies.
 608  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
 609  * @table:      the cpufreq_frequency_table * to iterate over.
 610  */
 611
 612 #define cpufreq_for_each_valid_entry(pos, table)                        \
 613         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)   \
 614                 if (pos->frequency == CPUFREQ_ENTRY_INVALID)            \
 615                         continue;                                       \
 616                 else
 617
 618 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
 619                                     struct cpufreq_frequency_table *table);
 620
 621 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
 622                                    struct cpufreq_frequency_table *table);
 623 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
 624
 625 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
 626                                  unsigned int target_freq,
 627                                  unsigned int relation);
 628 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
 629                 unsigned int freq);
 630
 631 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
 632
 633 #ifdef CONFIG_CPU_FREQ
 634 int cpufreq_boost_trigger_state(int state);
 635 int cpufreq_boost_enabled(void);
 636 int cpufreq_enable_boost_support(void);
 637 bool policy_has_boost_freq(struct cpufreq_policy *policy);
 638
 639 /* Find lowest freq at or above target in a table in ascending order */
 640 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
 641                                               unsigned int target_freq)
 642 {
 643         struct cpufreq_frequency_table *table = policy->freq_table;
 644         struct cpufreq_frequency_table *pos, *best = table - 1;
 645         unsigned int freq;
 646
 647         cpufreq_for_each_valid_entry(pos, table) {
 648                 freq = pos->frequency;
 649
 650                 if (freq >= target_freq)
 651                         return pos - table;
 652
 653                 best = pos;
 654         }
 655
 656         return best - table;
 657 }
 658
 659 /* Find lowest freq at or above target in a table in descending order */
 660 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
 661                                               unsigned int target_freq)
 662 {
 663         struct cpufreq_frequency_table *table = policy->freq_table;
 664         struct cpufreq_frequency_table *pos, *best = table - 1;
 665         unsigned int freq;
 666
 667         cpufreq_for_each_valid_entry(pos, table) {
 668                 freq = pos->frequency;
 669
 670                 if (freq == target_freq)
 671                         return pos - table;
 672
 673                 if (freq > target_freq) {
 674                         best = pos;
 675                         continue;
 676                 }
 677
 678                 /* No freq found above target_freq */
 679                 if (best == table - 1)
 680                         return pos - table;
 681
 682                 return best - table;
 683         }
 684
 685         return best - table;
 686 }
 687
 688 /* Works only on sorted freq-tables */
 689 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
 690                                              unsigned int target_freq)
 691 {
 692         target_freq = clamp_val(target_freq, policy->min, policy->max);
 693
 694         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
 695                 return cpufreq_table_find_index_al(policy, target_freq);
 696         else
 697                 return cpufreq_table_find_index_dl(policy, target_freq);
 698 }
 699
 700 /* Find highest freq at or below target in a table in ascending order */
 701 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
 702                                               unsigned int target_freq)
 703 {
 704         struct cpufreq_frequency_table *table = policy->freq_table;
 705         struct cpufreq_frequency_table *pos, *best = table - 1;
 706         unsigned int freq;
 707
 708         cpufreq_for_each_valid_entry(pos, table) {
 709                 freq = pos->frequency;
 710
 711                 if (freq == target_freq)
 712                         return pos - table;
 713
 714                 if (freq < target_freq) {
 715                         best = pos;
 716                         continue;
 717                 }
 718
 719                 /* No freq found below target_freq */
 720                 if (best == table - 1)
 721                         return pos - table;
 722
 723                 return best - table;
 724         }
 725
 726         return best - table;
 727 }
 728
 729 /* Find highest freq at or below target in a table in descending order */
 730 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
 731                                               unsigned int target_freq)
 732 {
 733         struct cpufreq_frequency_table *table = policy->freq_table;
 734         struct cpufreq_frequency_table *pos, *best = table - 1;
 735         unsigned int freq;
 736
 737         cpufreq_for_each_valid_entry(pos, table) {
 738                 freq = pos->frequency;
 739
 740                 if (freq <= target_freq)
 741                         return pos - table;
 742
 743                 best = pos;
 744         }
 745
 746         return best - table;
 747 }
 748
 749 /* Works only on sorted freq-tables */
 750 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
 751                                              unsigned int target_freq)
 752 {
 753         target_freq = clamp_val(target_freq, policy->min, policy->max);
 754
 755         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
 756                 return cpufreq_table_find_index_ah(policy, target_freq);
 757         else
 758                 return cpufreq_table_find_index_dh(policy, target_freq);
 759 }
 760
 761 /* Find closest freq to target in a table in ascending order */
 762 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
 763                                               unsigned int target_freq)
 764 {
 765         struct cpufreq_frequency_table *table = policy->freq_table;
 766         struct cpufreq_frequency_table *pos, *best = table - 1;
 767         unsigned int freq;
 768
 769         cpufreq_for_each_valid_entry(pos, table) {
 770                 freq = pos->frequency;
 771
 772                 if (freq == target_freq)
 773                         return pos - table;
 774
 775                 if (freq < target_freq) {
 776                         best = pos;
 777                         continue;
 778                 }
 779
 780                 /* No freq found below target_freq */
 781                 if (best == table - 1)
 782                         return pos - table;
 783
 784                 /* Choose the closest freq */
 785                 if (target_freq - best->frequency > freq - target_freq)
 786                         return pos - table;
 787
 788                 return best - table;
 789         }
 790
 791         return best - table;
 792 }
 793
 794 /* Find closest freq to target in a table in descending order */
 795 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
 796                                               unsigned int target_freq)
 797 {
 798         struct cpufreq_frequency_table *table = policy->freq_table;
 799         struct cpufreq_frequency_table *pos, *best = table - 1;
 800         unsigned int freq;
 801
 802         cpufreq_for_each_valid_entry(pos, table) {
 803                 freq = pos->frequency;
 804
 805                 if (freq == target_freq)
 806                         return pos - table;
 807
 808                 if (freq > target_freq) {
 809                         best = pos;
 810                         continue;
 811                 }
 812
 813                 /* No freq found above target_freq */
 814                 if (best == table - 1)
 815                         return pos - table;
 816
 817                 /* Choose the closest freq */
 818                 if (best->frequency - target_freq > target_freq - freq)
 819                         return pos - table;
 820
 821                 return best - table;
 822         }
 823
 824         return best - table;
 825 }
 826
 827 /* Works only on sorted freq-tables */
 828 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
 829                                              unsigned int target_freq)
 830 {
 831         target_freq = clamp_val(target_freq, policy->min, policy->max);
 832
 833         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
 834                 return cpufreq_table_find_index_ac(policy, target_freq);
 835         else
 836                 return cpufreq_table_find_index_dc(policy, target_freq);
 837 }
 838
 839 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
 840                                                  unsigned int target_freq,
 841                                                  unsigned int relation)
 842 {
 843         if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
 844                 return cpufreq_table_index_unsorted(policy, target_freq,
 845                                                     relation);
 846
 847         switch (relation) {
 848         case CPUFREQ_RELATION_L:
 849                 return cpufreq_table_find_index_l(policy, target_freq);
 850         case CPUFREQ_RELATION_H:
 851                 return cpufreq_table_find_index_h(policy, target_freq);
 852         case CPUFREQ_RELATION_C:
 853                 return cpufreq_table_find_index_c(policy, target_freq);
 854         default:
 855                 pr_err("%s: Invalid relation: %d\n", __func__, relation);
 856                 return -EINVAL;
 857         }
 858 }
 859 #else
 860 static inline int cpufreq_boost_trigger_state(int state)
 861 {
 862         return 0;
 863 }
 864 static inline int cpufreq_boost_enabled(void)
 865 {
 866         return 0;
 867 }
 868
 869 static inline int cpufreq_enable_boost_support(void)
 870 {
 871         return -EINVAL;
 872 }
 873
 874 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
 875 {
 876         return false;
 877 }
 878 #endif
 879
 880 /* the following are really really optional */
 881 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
 882 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
 883 extern struct freq_attr *cpufreq_generic_attr[];
 884 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
 885                                       struct cpufreq_frequency_table *table);
 886
 887 unsigned int cpufreq_generic_get(unsigned int cpu);
 888 int cpufreq_generic_init(struct cpufreq_policy *policy,
 889                 struct cpufreq_frequency_table *table,
 890                 unsigned int transition_latency);
 891 #endif /* _LINUX_CPUFREQ_H */