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