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