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