include/linux/cpufreq.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * linux/include/linux/cpufreq.h
   4  *
   5  * Copyright (C) 2001 Russell King
   6  *           (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
   7  */
   8 #ifndef _LINUX_CPUFREQ_H
   9 #define _LINUX_CPUFREQ_H
  10
  11 #include <linux/clk.h>
  12 #include <linux/cpumask.h>
  13 #include <linux/completion.h>
  14 #include <linux/kobject.h>
  15 #include <linux/notifier.h>
  16 #include <linux/pm_qos.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/sysfs.h>
  19
  20 /*********************************************************************
  21  *                        CPUFREQ INTERFACE                          *
  22  *********************************************************************/
  23 /*
  24  * Frequency values here are CPU kHz
  25  *
  26  * Maximum transition latency is in nanoseconds - if it's unknown,
  27  * CPUFREQ_ETERNAL shall be used.
  28  */
  29
  30 #define CPUFREQ_ETERNAL                 (-1)
  31 #define CPUFREQ_NAME_LEN                16
  32 /* Print length for names. Extra 1 space for accommodating '\n' in prints */
  33 #define CPUFREQ_NAME_PLEN               (CPUFREQ_NAME_LEN + 1)
  34
  35 struct cpufreq_governor;
  36
  37 enum cpufreq_table_sorting {
  38         CPUFREQ_TABLE_UNSORTED,
  39         CPUFREQ_TABLE_SORTED_ASCENDING,
  40         CPUFREQ_TABLE_SORTED_DESCENDING
  41 };
  42
  43 struct cpufreq_cpuinfo {
  44         unsigned int            max_freq;
  45         unsigned int            min_freq;
  46
  47         /* in 10^(-9) s = nanoseconds */
  48         unsigned int            transition_latency;
  49 };
  50
  51 struct cpufreq_policy {
  52         /* CPUs sharing clock, require sw coordination */
  53         cpumask_var_t           cpus;   /* Online CPUs only */
  54         cpumask_var_t           related_cpus; /* Online + Offline CPUs */
  55         cpumask_var_t           real_cpus; /* Related and present */
  56
  57         unsigned int            shared_type; /* ACPI: ANY or ALL affected CPUs
  58                                                 should set cpufreq */
  59         unsigned int            cpu;    /* cpu managing this policy, must be online */
  60
  61         struct clk              *clk;
  62         struct cpufreq_cpuinfo  cpuinfo;/* see above */
  63
  64         unsigned int            min;    /* in kHz */
  65         unsigned int            max;    /* in kHz */
  66         unsigned int            cur;    /* in kHz, only needed if cpufreq
  67                                          * governors are used */
  68         unsigned int            suspend_freq; /* freq to set during suspend */
  69
  70         unsigned int            policy; /* see above */
  71         unsigned int            last_policy; /* policy before unplug */
  72         struct cpufreq_governor *governor; /* see below */
  73         void                    *governor_data;
  74         char                    last_governor[CPUFREQ_NAME_LEN]; /* last governor used */
  75
  76         struct work_struct      update; /* if update_policy() needs to be
  77                                          * called, but you're in IRQ context */
  78
  79         struct freq_constraints constraints;
  80         struct freq_qos_request *min_freq_req;
  81         struct freq_qos_request *max_freq_req;
  82
  83         struct cpufreq_frequency_table  *freq_table;
  84         enum cpufreq_table_sorting freq_table_sorted;
  85
  86         struct list_head        policy_list;
  87         struct kobject          kobj;
  88         struct completion       kobj_unregister;
  89
  90         /*
  91          * The rules for this semaphore:
  92          * - Any routine that wants to read from the policy structure will
  93          *   do a down_read on this semaphore.
  94          * - Any routine that will write to the policy structure and/or may take away
  95          *   the policy altogether (eg. CPU hotplug), will hold this lock in write
  96          *   mode before doing so.
  97          */
  98         struct rw_semaphore     rwsem;
  99
 100         /*
 101          * Fast switch flags:
 102          * - fast_switch_possible should be set by the driver if it can
 103          *   guarantee that frequency can be changed on any CPU sharing the
 104          *   policy and that the change will affect all of the policy CPUs then.
 105          * - fast_switch_enabled is to be set by governors that support fast
 106          *   frequency switching with the help of cpufreq_enable_fast_switch().
 107          */
 108         bool                    fast_switch_possible;
 109         bool                    fast_switch_enabled;
 110
 111         /*
 112          * Set if the CPUFREQ_GOV_STRICT_TARGET flag is set for the current
 113          * governor.
 114          */
 115         bool                    strict_target;
 116
 117         /*
 118          * Preferred average time interval between consecutive invocations of
 119          * the driver to set the frequency for this policy.  To be set by the
 120          * scaling driver (0, which is the default, means no preference).
 121          */
 122         unsigned int            transition_delay_us;
 123
 124         /*
 125          * Remote DVFS flag (Not added to the driver structure as we don't want
 126          * to access another structure from scheduler hotpath).
 127          *
 128          * Should be set if CPUs can do DVFS on behalf of other CPUs from
 129          * different cpufreq policies.
 130          */
 131         bool                    dvfs_possible_from_any_cpu;
 132
 133          /* Cached frequency lookup from cpufreq_driver_resolve_freq. */
 134         unsigned int cached_target_freq;
 135         unsigned int cached_resolved_idx;
 136
 137         /* Synchronization for frequency transitions */
 138         bool                    transition_ongoing; /* Tracks transition status */
 139         spinlock_t              transition_lock;
 140         wait_queue_head_t       transition_wait;
 141         struct task_struct      *transition_task; /* Task which is doing the transition */
 142
 143         /* cpufreq-stats */
 144         struct cpufreq_stats    *stats;
 145
 146         /* For cpufreq driver's internal use */
 147         void                    *driver_data;
 148
 149         /* Pointer to the cooling device if used for thermal mitigation */
 150         struct thermal_cooling_device *cdev;
 151
 152         struct notifier_block nb_min;
 153         struct notifier_block nb_max;
 154 };
 155
 156 /*
 157  * Used for passing new cpufreq policy data to the cpufreq driver's ->verify()
 158  * callback for sanitization.  That callback is only expected to modify the min
 159  * and max values, if necessary, and specifically it must not update the
 160  * frequency table.
 161  */
 162 struct cpufreq_policy_data {
 163         struct cpufreq_cpuinfo          cpuinfo;
 164         struct cpufreq_frequency_table  *freq_table;
 165         unsigned int                    cpu;
 166         unsigned int                    min;    /* in kHz */
 167         unsigned int                    max;    /* in kHz */
 168 };
 169
 170 struct cpufreq_freqs {
 171         struct cpufreq_policy *policy;
 172         unsigned int old;
 173         unsigned int new;
 174         u8 flags;               /* flags of cpufreq_driver, see below. */
 175 };
 176
 177 /* Only for ACPI */
 178 #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
 179 #define CPUFREQ_SHARED_TYPE_HW   (1) /* HW does needed coordination */
 180 #define CPUFREQ_SHARED_TYPE_ALL  (2) /* All dependent CPUs should set freq */
 181 #define CPUFREQ_SHARED_TYPE_ANY  (3) /* Freq can be set from any dependent CPU*/
 182
 183 #ifdef CONFIG_CPU_FREQ
 184 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
 185 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
 186 void cpufreq_cpu_put(struct cpufreq_policy *policy);
 187 #else
 188 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
 189 {
 190         return NULL;
 191 }
 192 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
 193 {
 194         return NULL;
 195 }
 196 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
 197 #endif
 198
 199 static inline bool policy_is_inactive(struct cpufreq_policy *policy)
 200 {
 201         return cpumask_empty(policy->cpus);
 202 }
 203
 204 static inline bool policy_is_shared(struct cpufreq_policy *policy)
 205 {
 206         return cpumask_weight(policy->cpus) > 1;
 207 }
 208
 209 #ifdef CONFIG_CPU_FREQ
 210 unsigned int cpufreq_get(unsigned int cpu);
 211 unsigned int cpufreq_quick_get(unsigned int cpu);
 212 unsigned int cpufreq_quick_get_max(unsigned int cpu);
 213 unsigned int cpufreq_get_hw_max_freq(unsigned int cpu);
 214 void disable_cpufreq(void);
 215
 216 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
 217
 218 struct cpufreq_policy *cpufreq_cpu_acquire(unsigned int cpu);
 219 void cpufreq_cpu_release(struct cpufreq_policy *policy);
 220 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
 221 void refresh_frequency_limits(struct cpufreq_policy *policy);
 222 void cpufreq_update_policy(unsigned int cpu);
 223 void cpufreq_update_limits(unsigned int cpu);
 224 bool have_governor_per_policy(void);
 225 bool cpufreq_supports_freq_invariance(void);
 226 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
 227 void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
 228 void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
 229 #else
 230 static inline unsigned int cpufreq_get(unsigned int cpu)
 231 {
 232         return 0;
 233 }
 234 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
 235 {
 236         return 0;
 237 }
 238 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
 239 {
 240         return 0;
 241 }
 242 static inline unsigned int cpufreq_get_hw_max_freq(unsigned int cpu)
 243 {
 244         return 0;
 245 }
 246 static inline bool cpufreq_supports_freq_invariance(void)
 247 {
 248         return false;
 249 }
 250 static inline void disable_cpufreq(void) { }
 251 #endif
 252
 253 #ifdef CONFIG_CPU_FREQ_STAT
 254 void cpufreq_stats_create_table(struct cpufreq_policy *policy);
 255 void cpufreq_stats_free_table(struct cpufreq_policy *policy);
 256 void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
 257                                      unsigned int new_freq);
 258 #else
 259 static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
 260 static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
 261 static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
 262                                                    unsigned int new_freq) { }
 263 #endif /* CONFIG_CPU_FREQ_STAT */
 264
 265 /*********************************************************************
 266  *                      CPUFREQ DRIVER INTERFACE                     *
 267  *********************************************************************/
 268
 269 #define CPUFREQ_RELATION_L 0  /* lowest frequency at or above target */
 270 #define CPUFREQ_RELATION_H 1  /* highest frequency below or at target */
 271 #define CPUFREQ_RELATION_C 2  /* closest frequency to target */
 272
 273 struct freq_attr {
 274         struct attribute attr;
 275         ssize_t (*show)(struct cpufreq_policy *, char *);
 276         ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
 277 };
 278
 279 #define cpufreq_freq_attr_ro(_name)             \
 280 static struct freq_attr _name =                 \
 281 __ATTR(_name, 0444, show_##_name, NULL)
 282
 283 #define cpufreq_freq_attr_ro_perm(_name, _perm) \
 284 static struct freq_attr _name =                 \
 285 __ATTR(_name, _perm, show_##_name, NULL)
 286
 287 #define cpufreq_freq_attr_rw(_name)             \
 288 static struct freq_attr _name =                 \
 289 __ATTR(_name, 0644, show_##_name, store_##_name)
 290
 291 #define cpufreq_freq_attr_wo(_name)             \
 292 static struct freq_attr _name =                 \
 293 __ATTR(_name, 0200, NULL, store_##_name)
 294
 295 #define define_one_global_ro(_name)             \
 296 static struct kobj_attribute _name =            \
 297 __ATTR(_name, 0444, show_##_name, NULL)
 298
 299 #define define_one_global_rw(_name)             \
 300 static struct kobj_attribute _name =            \
 301 __ATTR(_name, 0644, show_##_name, store_##_name)
 302
 303
 304 struct cpufreq_driver {
 305         char            name[CPUFREQ_NAME_LEN];
 306         u16             flags;
 307         void            *driver_data;
 308
 309         /* needed by all drivers */
 310         int             (*init)(struct cpufreq_policy *policy);
 311         int             (*verify)(struct cpufreq_policy_data *policy);
 312
 313         /* define one out of two */
 314         int             (*setpolicy)(struct cpufreq_policy *policy);
 315
 316         int             (*target)(struct cpufreq_policy *policy,
 317                                   unsigned int target_freq,
 318                                   unsigned int relation);       /* Deprecated */
 319         int             (*target_index)(struct cpufreq_policy *policy,
 320                                         unsigned int index);
 321         unsigned int    (*fast_switch)(struct cpufreq_policy *policy,
 322                                        unsigned int target_freq);
 323
 324         /*
 325          * Caches and returns the lowest driver-supported frequency greater than
 326          * or equal to the target frequency, subject to any driver limitations.
 327          * Does not set the frequency. Only to be implemented for drivers with
 328          * target().
 329          */
 330         unsigned int    (*resolve_freq)(struct cpufreq_policy *policy,
 331                                         unsigned int target_freq);
 332
 333         /*
 334          * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
 335          * unset.
 336          *
 337          * get_intermediate should return a stable intermediate frequency
 338          * platform wants to switch to and target_intermediate() should set CPU
 339          * to that frequency, before jumping to the frequency corresponding
 340          * to 'index'. Core will take care of sending notifications and driver
 341          * doesn't have to handle them in target_intermediate() or
 342          * target_index().
 343          *
 344          * Drivers can return '0' from get_intermediate() in case they don't
 345          * wish to switch to intermediate frequency for some target frequency.
 346          * In that case core will directly call ->target_index().
 347          */
 348         unsigned int    (*get_intermediate)(struct cpufreq_policy *policy,
 349                                             unsigned int index);
 350         int             (*target_intermediate)(struct cpufreq_policy *policy,
 351                                                unsigned int index);
 352
 353         /* should be defined, if possible */
 354         unsigned int    (*get)(unsigned int cpu);
 355
 356         /* Called to update policy limits on firmware notifications. */
 357         void            (*update_limits)(unsigned int cpu);
 358
 359         /* optional */
 360         int             (*bios_limit)(int cpu, unsigned int *limit);
 361
 362         int             (*online)(struct cpufreq_policy *policy);
 363         int             (*offline)(struct cpufreq_policy *policy);
 364         int             (*exit)(struct cpufreq_policy *policy);
 365         void            (*stop_cpu)(struct cpufreq_policy *policy);
 366         int             (*suspend)(struct cpufreq_policy *policy);
 367         int             (*resume)(struct cpufreq_policy *policy);
 368
 369         /* Will be called after the driver is fully initialized */
 370         void            (*ready)(struct cpufreq_policy *policy);
 371
 372         struct freq_attr **attr;
 373
 374         /* platform specific boost support code */
 375         bool            boost_enabled;
 376         int             (*set_boost)(struct cpufreq_policy *policy, int state);
 377 };
 378
 379 /* flags */
 380
 381 /* driver isn't removed even if all ->init() calls failed */
 382 #define CPUFREQ_STICKY                          BIT(0)
 383
 384 /* loops_per_jiffy or other kernel "constants" aren't affected by frequency transitions */
 385 #define CPUFREQ_CONST_LOOPS                     BIT(1)
 386
 387 /* don't warn on suspend/resume speed mismatches */
 388 #define CPUFREQ_PM_NO_WARN                      BIT(2)
 389
 390 /*
 391  * This should be set by platforms having multiple clock-domains, i.e.
 392  * supporting multiple policies. With this sysfs directories of governor would
 393  * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
 394  * governor with different tunables for different clusters.
 395  */
 396 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY        BIT(3)
 397
 398 /*
 399  * Driver will do POSTCHANGE notifications from outside of their ->target()
 400  * routine and so must set cpufreq_driver->flags with this flag, so that core
 401  * can handle them specially.
 402  */
 403 #define CPUFREQ_ASYNC_NOTIFICATION              BIT(4)
 404
 405 /*
 406  * Set by drivers which want cpufreq core to check if CPU is running at a
 407  * frequency present in freq-table exposed by the driver. For these drivers if
 408  * CPU is found running at an out of table freq, we will try to set it to a freq
 409  * from the table. And if that fails, we will stop further boot process by
 410  * issuing a BUG_ON().
 411  */
 412 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK BIT(5)
 413
 414 /*
 415  * Set by drivers to disallow use of governors with "dynamic_switching" flag
 416  * set.
 417  */
 418 #define CPUFREQ_NO_AUTO_DYNAMIC_SWITCHING       BIT(6)
 419
 420 /*
 421  * Set by drivers that want the core to automatically register the cpufreq
 422  * driver as a thermal cooling device.
 423  */
 424 #define CPUFREQ_IS_COOLING_DEV                  BIT(7)
 425
 426 /*
 427  * Set by drivers that need to update internale upper and lower boundaries along
 428  * with the target frequency and so the core and governors should also invoke
 429  * the diver if the target frequency does not change, but the policy min or max
 430  * may have changed.
 431  */
 432 #define CPUFREQ_NEED_UPDATE_LIMITS              BIT(8)
 433
 434 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
 435 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
 436
 437 bool cpufreq_driver_test_flags(u16 flags);
 438 const char *cpufreq_get_current_driver(void);
 439 void *cpufreq_get_driver_data(void);
 440
 441 static inline int cpufreq_thermal_control_enabled(struct cpufreq_driver *drv)
 442 {
 443         return IS_ENABLED(CONFIG_CPU_THERMAL) &&
 444                 (drv->flags & CPUFREQ_IS_COOLING_DEV);
 445 }
 446
 447 static inline void cpufreq_verify_within_limits(struct cpufreq_policy_data *policy,
 448                                                 unsigned int min,
 449                                                 unsigned int max)
 450 {
 451         if (policy->min < min)
 452                 policy->min = min;
 453         if (policy->max < min)
 454                 policy->max = min;
 455         if (policy->min > max)
 456                 policy->min = max;
 457         if (policy->max > max)
 458                 policy->max = max;
 459         if (policy->min > policy->max)
 460                 policy->min = policy->max;
 461         return;
 462 }
 463
 464 static inline void
 465 cpufreq_verify_within_cpu_limits(struct cpufreq_policy_data *policy)
 466 {
 467         cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
 468                                      policy->cpuinfo.max_freq);
 469 }
 470
 471 #ifdef CONFIG_CPU_FREQ
 472 void cpufreq_suspend(void);
 473 void cpufreq_resume(void);
 474 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
 475 #else
 476 static inline void cpufreq_suspend(void) {}
 477 static inline void cpufreq_resume(void) {}
 478 #endif
 479
 480 /*********************************************************************
 481  *                     CPUFREQ NOTIFIER INTERFACE                    *
 482  *********************************************************************/
 483
 484 #define CPUFREQ_TRANSITION_NOTIFIER     (0)
 485 #define CPUFREQ_POLICY_NOTIFIER         (1)
 486
 487 /* Transition notifiers */
 488 #define CPUFREQ_PRECHANGE               (0)
 489 #define CPUFREQ_POSTCHANGE              (1)
 490
 491 /* Policy Notifiers  */
 492 #define CPUFREQ_CREATE_POLICY           (0)
 493 #define CPUFREQ_REMOVE_POLICY           (1)
 494
 495 #ifdef CONFIG_CPU_FREQ
 496 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
 497 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
 498
 499 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
 500                 struct cpufreq_freqs *freqs);
 501 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
 502                 struct cpufreq_freqs *freqs, int transition_failed);
 503
 504 #else /* CONFIG_CPU_FREQ */
 505 static inline int cpufreq_register_notifier(struct notifier_block *nb,
 506                                                 unsigned int list)
 507 {
 508         return 0;
 509 }
 510 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
 511                                                 unsigned int list)
 512 {
 513         return 0;
 514 }
 515 #endif /* !CONFIG_CPU_FREQ */
 516
 517 /**
 518  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
 519  * safe)
 520  * @old:   old value
 521  * @div:   divisor
 522  * @mult:  multiplier
 523  *
 524  *
 525  * new = old * mult / div
 526  */
 527 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
 528                 u_int mult)
 529 {
 530 #if BITS_PER_LONG == 32
 531         u64 result = ((u64) old) * ((u64) mult);
 532         do_div(result, div);
 533         return (unsigned long) result;
 534
 535 #elif BITS_PER_LONG == 64
 536         unsigned long result = old * ((u64) mult);
 537         result /= div;
 538         return result;
 539 #endif
 540 }
 541
 542 /*********************************************************************
 543  *                          CPUFREQ GOVERNORS                        *
 544  *********************************************************************/
 545
 546 #define CPUFREQ_POLICY_UNKNOWN          (0)
 547 /*
 548  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
 549  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
 550  * two generic policies are available:
 551  */
 552 #define CPUFREQ_POLICY_POWERSAVE        (1)
 553 #define CPUFREQ_POLICY_PERFORMANCE      (2)
 554
 555 /*
 556  * The polling frequency depends on the capability of the processor. Default
 557  * polling frequency is 1000 times the transition latency of the processor. The
 558  * ondemand governor will work on any processor with transition latency <= 10ms,
 559  * using appropriate sampling rate.
 560  */
 561 #define LATENCY_MULTIPLIER              (1000)
 562
 563 struct cpufreq_governor {
 564         char    name[CPUFREQ_NAME_LEN];
 565         int     (*init)(struct cpufreq_policy *policy);
 566         void    (*exit)(struct cpufreq_policy *policy);
 567         int     (*start)(struct cpufreq_policy *policy);
 568         void    (*stop)(struct cpufreq_policy *policy);
 569         void    (*limits)(struct cpufreq_policy *policy);
 570         ssize_t (*show_setspeed)        (struct cpufreq_policy *policy,
 571                                          char *buf);
 572         int     (*store_setspeed)       (struct cpufreq_policy *policy,
 573                                          unsigned int freq);
 574         struct list_head        governor_list;
 575         struct module           *owner;
 576         u8                      flags;
 577 };
 578
 579 /* Governor flags */
 580
 581 /* For governors which change frequency dynamically by themselves */
 582 #define CPUFREQ_GOV_DYNAMIC_SWITCHING   BIT(0)
 583
 584 /* For governors wanting the target frequency to be set exactly */
 585 #define CPUFREQ_GOV_STRICT_TARGET       BIT(1)
 586
 587
 588 /* Pass a target to the cpufreq driver */
 589 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
 590                                         unsigned int target_freq);
 591 int cpufreq_driver_target(struct cpufreq_policy *policy,
 592                                  unsigned int target_freq,
 593                                  unsigned int relation);
 594 int __cpufreq_driver_target(struct cpufreq_policy *policy,
 595                                    unsigned int target_freq,
 596                                    unsigned int relation);
 597 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
 598                                          unsigned int target_freq);
 599 unsigned int cpufreq_policy_transition_delay_us(struct cpufreq_policy *policy);
 600 int cpufreq_register_governor(struct cpufreq_governor *governor);
 601 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
 602 int cpufreq_start_governor(struct cpufreq_policy *policy);
 603 void cpufreq_stop_governor(struct cpufreq_policy *policy);
 604
 605 #define cpufreq_governor_init(__governor)                       \
 606 static int __init __governor##_init(void)                       \
 607 {                                                               \
 608         return cpufreq_register_governor(&__governor);  \
 609 }                                                               \
 610 core_initcall(__governor##_init)
 611
 612 #define cpufreq_governor_exit(__governor)                       \
 613 static void __exit __governor##_exit(void)                      \
 614 {                                                               \
 615         return cpufreq_unregister_governor(&__governor);        \
 616 }                                                               \
 617 module_exit(__governor##_exit)
 618
 619 struct cpufreq_governor *cpufreq_default_governor(void);
 620 struct cpufreq_governor *cpufreq_fallback_governor(void);
 621
 622 static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
 623 {
 624         if (policy->max < policy->cur)
 625                 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
 626         else if (policy->min > policy->cur)
 627                 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
 628 }
 629
 630 /* Governor attribute set */
 631 struct gov_attr_set {
 632         struct kobject kobj;
 633         struct list_head policy_list;
 634         struct mutex update_lock;
 635         int usage_count;
 636 };
 637
 638 /* sysfs ops for cpufreq governors */
 639 extern const struct sysfs_ops governor_sysfs_ops;
 640
 641 void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
 642 void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
 643 unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
 644
 645 /* Governor sysfs attribute */
 646 struct governor_attr {
 647         struct attribute attr;
 648         ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
 649         ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
 650                          size_t count);
 651 };
 652
 653 /*********************************************************************
 654  *                     FREQUENCY TABLE HELPERS                       *
 655  *********************************************************************/
 656
 657 /* Special Values of .frequency field */
 658 #define CPUFREQ_ENTRY_INVALID   ~0u
 659 #define CPUFREQ_TABLE_END       ~1u
 660 /* Special Values of .flags field */
 661 #define CPUFREQ_BOOST_FREQ      (1 << 0)
 662
 663 struct cpufreq_frequency_table {
 664         unsigned int    flags;
 665         unsigned int    driver_data; /* driver specific data, not used by core */
 666         unsigned int    frequency; /* kHz - doesn't need to be in ascending
 667                                     * order */
 668 };
 669
 670 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
 671 int dev_pm_opp_init_cpufreq_table(struct device *dev,
 672                                   struct cpufreq_frequency_table **table);
 673 void dev_pm_opp_free_cpufreq_table(struct device *dev,
 674                                    struct cpufreq_frequency_table **table);
 675 #else
 676 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
 677                                                 struct cpufreq_frequency_table
 678                                                 **table)
 679 {
 680         return -EINVAL;
 681 }
 682
 683 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
 684                                                  struct cpufreq_frequency_table
 685                                                  **table)
 686 {
 687 }
 688 #endif
 689
 690 /*
 691  * cpufreq_for_each_entry -     iterate over a cpufreq_frequency_table
 692  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
 693  * @table:      the cpufreq_frequency_table * to iterate over.
 694  */
 695
 696 #define cpufreq_for_each_entry(pos, table)      \
 697         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
 698
 699 /*
 700  * cpufreq_for_each_entry_idx - iterate over a cpufreq_frequency_table
 701  *      with index
 702  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
 703  * @table:      the cpufreq_frequency_table * to iterate over.
 704  * @idx:        the table entry currently being processed
 705  */
 706
 707 #define cpufreq_for_each_entry_idx(pos, table, idx)     \
 708         for (pos = table, idx = 0; pos->frequency != CPUFREQ_TABLE_END; \
 709                 pos++, idx++)
 710
 711 /*
 712  * cpufreq_for_each_valid_entry -     iterate over a cpufreq_frequency_table
 713  *      excluding CPUFREQ_ENTRY_INVALID frequencies.
 714  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
 715  * @table:      the cpufreq_frequency_table * to iterate over.
 716  */
 717
 718 #define cpufreq_for_each_valid_entry(pos, table)                        \
 719         for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)   \
 720                 if (pos->frequency == CPUFREQ_ENTRY_INVALID)            \
 721                         continue;                                       \
 722                 else
 723
 724 /*
 725  * cpufreq_for_each_valid_entry_idx -     iterate with index over a cpufreq
 726  *      frequency_table excluding CPUFREQ_ENTRY_INVALID frequencies.
 727  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
 728  * @table:      the cpufreq_frequency_table * to iterate over.
 729  * @idx:        the table entry currently being processed
 730  */
 731
 732 #define cpufreq_for_each_valid_entry_idx(pos, table, idx)               \
 733         cpufreq_for_each_entry_idx(pos, table, idx)                     \
 734                 if (pos->frequency == CPUFREQ_ENTRY_INVALID)            \
 735                         continue;                                       \
 736                 else
 737
 738
 739 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
 740                                     struct cpufreq_frequency_table *table);
 741
 742 int cpufreq_frequency_table_verify(struct cpufreq_policy_data *policy,
 743                                    struct cpufreq_frequency_table *table);
 744 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy_data *policy);
 745
 746 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
 747                                  unsigned int target_freq,
 748                                  unsigned int relation);
 749 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
 750                 unsigned int freq);
 751
 752 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
 753
 754 #ifdef CONFIG_CPU_FREQ
 755 int cpufreq_boost_trigger_state(int state);
 756 int cpufreq_boost_enabled(void);
 757 int cpufreq_enable_boost_support(void);
 758 bool policy_has_boost_freq(struct cpufreq_policy *policy);
 759
 760 /* Find lowest freq at or above target in a table in ascending order */
 761 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
 762                                               unsigned int target_freq)
 763 {
 764         struct cpufreq_frequency_table *table = policy->freq_table;
 765         struct cpufreq_frequency_table *pos;
 766         unsigned int freq;
 767         int idx, best = -1;
 768
 769         cpufreq_for_each_valid_entry_idx(pos, table, idx) {
 770                 freq = pos->frequency;
 771
 772                 if (freq >= target_freq)
 773                         return idx;
 774
 775                 best = idx;
 776         }
 777
 778         return best;
 779 }
 780
 781 /* Find lowest freq at or above target in a table in descending order */
 782 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
 783                                               unsigned int target_freq)
 784 {
 785         struct cpufreq_frequency_table *table = policy->freq_table;
 786         struct cpufreq_frequency_table *pos;
 787         unsigned int freq;
 788         int idx, best = -1;
 789
 790         cpufreq_for_each_valid_entry_idx(pos, table, idx) {
 791                 freq = pos->frequency;
 792
 793                 if (freq == target_freq)
 794                         return idx;
 795
 796                 if (freq > target_freq) {
 797                         best = idx;
 798                         continue;
 799                 }
 800
 801                 /* No freq found above target_freq */
 802                 if (best == -1)
 803                         return idx;
 804
 805                 return best;
 806         }
 807
 808         return best;
 809 }
 810
 811 /* Works only on sorted freq-tables */
 812 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
 813                                              unsigned int target_freq)
 814 {
 815         target_freq = clamp_val(target_freq, policy->min, policy->max);
 816
 817         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
 818                 return cpufreq_table_find_index_al(policy, target_freq);
 819         else
 820                 return cpufreq_table_find_index_dl(policy, target_freq);
 821 }
 822
 823 /* Find highest freq at or below target in a table in ascending order */
 824 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
 825                                               unsigned int target_freq)
 826 {
 827         struct cpufreq_frequency_table *table = policy->freq_table;
 828         struct cpufreq_frequency_table *pos;
 829         unsigned int freq;
 830         int idx, best = -1;
 831
 832         cpufreq_for_each_valid_entry_idx(pos, table, idx) {
 833                 freq = pos->frequency;
 834
 835                 if (freq == target_freq)
 836                         return idx;
 837
 838                 if (freq < target_freq) {
 839                         best = idx;
 840                         continue;
 841                 }
 842
 843                 /* No freq found below target_freq */
 844                 if (best == -1)
 845                         return idx;
 846
 847                 return best;
 848         }
 849
 850         return best;
 851 }
 852
 853 /* Find highest freq at or below target in a table in descending order */
 854 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
 855                                               unsigned int target_freq)
 856 {
 857         struct cpufreq_frequency_table *table = policy->freq_table;
 858         struct cpufreq_frequency_table *pos;
 859         unsigned int freq;
 860         int idx, best = -1;
 861
 862         cpufreq_for_each_valid_entry_idx(pos, table, idx) {
 863                 freq = pos->frequency;
 864
 865                 if (freq <= target_freq)
 866                         return idx;
 867
 868                 best = idx;
 869         }
 870
 871         return best;
 872 }
 873
 874 /* Works only on sorted freq-tables */
 875 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
 876                                              unsigned int target_freq)
 877 {
 878         target_freq = clamp_val(target_freq, policy->min, policy->max);
 879
 880         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
 881                 return cpufreq_table_find_index_ah(policy, target_freq);
 882         else
 883                 return cpufreq_table_find_index_dh(policy, target_freq);
 884 }
 885
 886 /* Find closest freq to target in a table in ascending order */
 887 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
 888                                               unsigned int target_freq)
 889 {
 890         struct cpufreq_frequency_table *table = policy->freq_table;
 891         struct cpufreq_frequency_table *pos;
 892         unsigned int freq;
 893         int idx, best = -1;
 894
 895         cpufreq_for_each_valid_entry_idx(pos, table, idx) {
 896                 freq = pos->frequency;
 897
 898                 if (freq == target_freq)
 899                         return idx;
 900
 901                 if (freq < target_freq) {
 902                         best = idx;
 903                         continue;
 904                 }
 905
 906                 /* No freq found below target_freq */
 907                 if (best == -1)
 908                         return idx;
 909
 910                 /* Choose the closest freq */
 911                 if (target_freq - table[best].frequency > freq - target_freq)
 912                         return idx;
 913
 914                 return best;
 915         }
 916
 917         return best;
 918 }
 919
 920 /* Find closest freq to target in a table in descending order */
 921 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
 922                                               unsigned int target_freq)
 923 {
 924         struct cpufreq_frequency_table *table = policy->freq_table;
 925         struct cpufreq_frequency_table *pos;
 926         unsigned int freq;
 927         int idx, best = -1;
 928
 929         cpufreq_for_each_valid_entry_idx(pos, table, idx) {
 930                 freq = pos->frequency;
 931
 932                 if (freq == target_freq)
 933                         return idx;
 934
 935                 if (freq > target_freq) {
 936                         best = idx;
 937                         continue;
 938                 }
 939
 940                 /* No freq found above target_freq */
 941                 if (best == -1)
 942                         return idx;
 943
 944                 /* Choose the closest freq */
 945                 if (table[best].frequency - target_freq > target_freq - freq)
 946                         return idx;
 947
 948                 return best;
 949         }
 950
 951         return best;
 952 }
 953
 954 /* Works only on sorted freq-tables */
 955 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
 956                                              unsigned int target_freq)
 957 {
 958         target_freq = clamp_val(target_freq, policy->min, policy->max);
 959
 960         if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
 961                 return cpufreq_table_find_index_ac(policy, target_freq);
 962         else
 963                 return cpufreq_table_find_index_dc(policy, target_freq);
 964 }
 965
 966 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
 967                                                  unsigned int target_freq,
 968                                                  unsigned int relation)
 969 {
 970         if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
 971                 return cpufreq_table_index_unsorted(policy, target_freq,
 972                                                     relation);
 973
 974         switch (relation) {
 975         case CPUFREQ_RELATION_L:
 976                 return cpufreq_table_find_index_l(policy, target_freq);
 977         case CPUFREQ_RELATION_H:
 978                 return cpufreq_table_find_index_h(policy, target_freq);
 979         case CPUFREQ_RELATION_C:
 980                 return cpufreq_table_find_index_c(policy, target_freq);
 981         default:
 982                 WARN_ON_ONCE(1);
 983                 return 0;
 984         }
 985 }
 986
 987 static inline int cpufreq_table_count_valid_entries(const struct cpufreq_policy *policy)
 988 {
 989         struct cpufreq_frequency_table *pos;
 990         int count = 0;
 991
 992         if (unlikely(!policy->freq_table))
 993                 return 0;
 994
 995         cpufreq_for_each_valid_entry(pos, policy->freq_table)
 996                 count++;
 997
 998         return count;
 999 }
1000 #else
1001 static inline int cpufreq_boost_trigger_state(int state)
1002 {
1003         return 0;
1004 }
1005 static inline int cpufreq_boost_enabled(void)
1006 {
1007         return 0;
1008 }
1009
1010 static inline int cpufreq_enable_boost_support(void)
1011 {
1012         return -EINVAL;
1013 }
1014
1015 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
1016 {
1017         return false;
1018 }
1019 #endif
1020
1021 #if defined(CONFIG_ENERGY_MODEL) && defined(CONFIG_CPU_FREQ_GOV_SCHEDUTIL)
1022 void sched_cpufreq_governor_change(struct cpufreq_policy *policy,
1023                         struct cpufreq_governor *old_gov);
1024 #else
1025 static inline void sched_cpufreq_governor_change(struct cpufreq_policy *policy,
1026                         struct cpufreq_governor *old_gov) { }
1027 #endif
1028
1029 extern void arch_freq_prepare_all(void);
1030 extern unsigned int arch_freq_get_on_cpu(int cpu);
1031
1032 #ifndef arch_set_freq_scale
1033 static __always_inline
1034 void arch_set_freq_scale(const struct cpumask *cpus,
1035                          unsigned long cur_freq,
1036                          unsigned long max_freq)
1037 {
1038 }
1039 #endif
1040
1041 /* the following are really really optional */
1042 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
1043 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
1044 extern struct freq_attr *cpufreq_generic_attr[];
1045 int cpufreq_table_validate_and_sort(struct cpufreq_policy *policy);
1046
1047 unsigned int cpufreq_generic_get(unsigned int cpu);
1048 void cpufreq_generic_init(struct cpufreq_policy *policy,
1049                 struct cpufreq_frequency_table *table,
1050                 unsigned int transition_latency);
1051 #endif /* _LINUX_CPUFREQ_H */