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