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 <[email protected]> 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 u16 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 /* 426 * Set by drivers that need to update internale upper and lower boundaries along 427 * with the target frequency and so the core and governors should also invoke 428 * the diver if the target frequency does not change, but the policy min or max 429 * may have changed. 430 */ 431 #define CPUFREQ_NEED_UPDATE_LIMITS BIT(8) 432 433 int cpufreq_register_driver(struct cpufreq_driver *driver_data); 434 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data); 435 436 bool cpufreq_driver_test_flags(u16 flags); 437 const char *cpufreq_get_current_driver(void); 438 void *cpufreq_get_driver_data(void); 439 440 static inline int cpufreq_thermal_control_enabled(struct cpufreq_driver *drv) 441 { 442 return IS_ENABLED(CONFIG_CPU_THERMAL) && 443 (drv->flags & CPUFREQ_IS_COOLING_DEV); 444 } 445 446 static inline void cpufreq_verify_within_limits(struct cpufreq_policy_data *policy, 447 unsigned int min, 448 unsigned int max) 449 { 450 if (policy->min < min) 451 policy->min = min; 452 if (policy->max < min) 453 policy->max = min; 454 if (policy->min > max) 455 policy->min = max; 456 if (policy->max > max) 457 policy->max = max; 458 if (policy->min > policy->max) 459 policy->min = policy->max; 460 return; 461 } 462 463 static inline void 464 cpufreq_verify_within_cpu_limits(struct cpufreq_policy_data *policy) 465 { 466 cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq, 467 policy->cpuinfo.max_freq); 468 } 469 470 #ifdef CONFIG_CPU_FREQ 471 void cpufreq_suspend(void); 472 void cpufreq_resume(void); 473 int cpufreq_generic_suspend(struct cpufreq_policy *policy); 474 #else 475 static inline void cpufreq_suspend(void) {} 476 static inline void cpufreq_resume(void) {} 477 #endif 478 479 /********************************************************************* 480 * CPUFREQ NOTIFIER INTERFACE * 481 *********************************************************************/ 482 483 #define CPUFREQ_TRANSITION_NOTIFIER (0) 484 #define CPUFREQ_POLICY_NOTIFIER (1) 485 486 /* Transition notifiers */ 487 #define CPUFREQ_PRECHANGE (0) 488 #define CPUFREQ_POSTCHANGE (1) 489 490 /* Policy Notifiers */ 491 #define CPUFREQ_CREATE_POLICY (0) 492 #define CPUFREQ_REMOVE_POLICY (1) 493 494 #ifdef CONFIG_CPU_FREQ 495 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list); 496 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list); 497 498 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy, 499 struct cpufreq_freqs *freqs); 500 void cpufreq_freq_transition_end(struct cpufreq_policy *policy, 501 struct cpufreq_freqs *freqs, int transition_failed); 502 503 #else /* CONFIG_CPU_FREQ */ 504 static inline int cpufreq_register_notifier(struct notifier_block *nb, 505 unsigned int list) 506 { 507 return 0; 508 } 509 static inline int cpufreq_unregister_notifier(struct notifier_block *nb, 510 unsigned int list) 511 { 512 return 0; 513 } 514 #endif /* !CONFIG_CPU_FREQ */ 515 516 /** 517 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch 518 * safe) 519 * @old: old value 520 * @div: divisor 521 * @mult: multiplier 522 * 523 * 524 * new = old * mult / div 525 */ 526 static inline unsigned long cpufreq_scale(unsigned long old, u_int div, 527 u_int mult) 528 { 529 #if BITS_PER_LONG == 32 530 u64 result = ((u64) old) * ((u64) mult); 531 do_div(result, div); 532 return (unsigned long) result; 533 534 #elif BITS_PER_LONG == 64 535 unsigned long result = old * ((u64) mult); 536 result /= div; 537 return result; 538 #endif 539 } 540 541 /********************************************************************* 542 * CPUFREQ GOVERNORS * 543 *********************************************************************/ 544 545 #define CPUFREQ_POLICY_UNKNOWN (0) 546 /* 547 * If (cpufreq_driver->target) exists, the ->governor decides what frequency 548 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these 549 * two generic policies are available: 550 */ 551 #define CPUFREQ_POLICY_POWERSAVE (1) 552 #define CPUFREQ_POLICY_PERFORMANCE (2) 553 554 /* 555 * The polling frequency depends on the capability of the processor. Default 556 * polling frequency is 1000 times the transition latency of the processor. The 557 * ondemand governor will work on any processor with transition latency <= 10ms, 558 * using appropriate sampling rate. 559 */ 560 #define LATENCY_MULTIPLIER (1000) 561 562 struct cpufreq_governor { 563 char name[CPUFREQ_NAME_LEN]; 564 int (*init)(struct cpufreq_policy *policy); 565 void (*exit)(struct cpufreq_policy *policy); 566 int (*start)(struct cpufreq_policy *policy); 567 void (*stop)(struct cpufreq_policy *policy); 568 void (*limits)(struct cpufreq_policy *policy); 569 ssize_t (*show_setspeed) (struct cpufreq_policy *policy, 570 char *buf); 571 int (*store_setspeed) (struct cpufreq_policy *policy, 572 unsigned int freq); 573 /* For governors which change frequency dynamically by themselves */ 574 bool dynamic_switching; 575 struct list_head governor_list; 576 struct module *owner; 577 }; 578 579 /* Pass a target to the cpufreq driver */ 580 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy, 581 unsigned int target_freq); 582 int cpufreq_driver_target(struct cpufreq_policy *policy, 583 unsigned int target_freq, 584 unsigned int relation); 585 int __cpufreq_driver_target(struct cpufreq_policy *policy, 586 unsigned int target_freq, 587 unsigned int relation); 588 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy, 589 unsigned int target_freq); 590 unsigned int cpufreq_policy_transition_delay_us(struct cpufreq_policy *policy); 591 int cpufreq_register_governor(struct cpufreq_governor *governor); 592 void cpufreq_unregister_governor(struct cpufreq_governor *governor); 593 int cpufreq_start_governor(struct cpufreq_policy *policy); 594 void cpufreq_stop_governor(struct cpufreq_policy *policy); 595 596 #define cpufreq_governor_init(__governor) \ 597 static int __init __governor##_init(void) \ 598 { \ 599 return cpufreq_register_governor(&__governor); \ 600 } \ 601 core_initcall(__governor##_init) 602 603 #define cpufreq_governor_exit(__governor) \ 604 static void __exit __governor##_exit(void) \ 605 { \ 606 return cpufreq_unregister_governor(&__governor); \ 607 } \ 608 module_exit(__governor##_exit) 609 610 struct cpufreq_governor *cpufreq_default_governor(void); 611 struct cpufreq_governor *cpufreq_fallback_governor(void); 612 613 static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy) 614 { 615 if (policy->max < policy->cur) 616 __cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H); 617 else if (policy->min > policy->cur) 618 __cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L); 619 } 620 621 /* Governor attribute set */ 622 struct gov_attr_set { 623 struct kobject kobj; 624 struct list_head policy_list; 625 struct mutex update_lock; 626 int usage_count; 627 }; 628 629 /* sysfs ops for cpufreq governors */ 630 extern const struct sysfs_ops governor_sysfs_ops; 631 632 void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node); 633 void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node); 634 unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node); 635 636 /* Governor sysfs attribute */ 637 struct governor_attr { 638 struct attribute attr; 639 ssize_t (*show)(struct gov_attr_set *attr_set, char *buf); 640 ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf, 641 size_t count); 642 }; 643 644 /********************************************************************* 645 * FREQUENCY TABLE HELPERS * 646 *********************************************************************/ 647 648 /* Special Values of .frequency field */ 649 #define CPUFREQ_ENTRY_INVALID ~0u 650 #define CPUFREQ_TABLE_END ~1u 651 /* Special Values of .flags field */ 652 #define CPUFREQ_BOOST_FREQ (1 << 0) 653 654 struct cpufreq_frequency_table { 655 unsigned int flags; 656 unsigned int driver_data; /* driver specific data, not used by core */ 657 unsigned int frequency; /* kHz - doesn't need to be in ascending 658 * order */ 659 }; 660 661 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP) 662 int dev_pm_opp_init_cpufreq_table(struct device *dev, 663 struct cpufreq_frequency_table **table); 664 void dev_pm_opp_free_cpufreq_table(struct device *dev, 665 struct cpufreq_frequency_table **table); 666 #else 667 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev, 668 struct cpufreq_frequency_table 669 **table) 670 { 671 return -EINVAL; 672 } 673 674 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev, 675 struct cpufreq_frequency_table 676 **table) 677 { 678 } 679 #endif 680 681 /* 682 * cpufreq_for_each_entry - iterate over a cpufreq_frequency_table 683 * @pos: the cpufreq_frequency_table * to use as a loop cursor. 684 * @table: the cpufreq_frequency_table * to iterate over. 685 */ 686 687 #define cpufreq_for_each_entry(pos, table) \ 688 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) 689 690 /* 691 * cpufreq_for_each_entry_idx - iterate over a cpufreq_frequency_table 692 * with index 693 * @pos: the cpufreq_frequency_table * to use as a loop cursor. 694 * @table: the cpufreq_frequency_table * to iterate over. 695 * @idx: the table entry currently being processed 696 */ 697 698 #define cpufreq_for_each_entry_idx(pos, table, idx) \ 699 for (pos = table, idx = 0; pos->frequency != CPUFREQ_TABLE_END; \ 700 pos++, idx++) 701 702 /* 703 * cpufreq_for_each_valid_entry - iterate over a cpufreq_frequency_table 704 * excluding CPUFREQ_ENTRY_INVALID frequencies. 705 * @pos: the cpufreq_frequency_table * to use as a loop cursor. 706 * @table: the cpufreq_frequency_table * to iterate over. 707 */ 708 709 #define cpufreq_for_each_valid_entry(pos, table) \ 710 for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++) \ 711 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \ 712 continue; \ 713 else 714 715 /* 716 * cpufreq_for_each_valid_entry_idx - iterate with index over a cpufreq 717 * frequency_table excluding CPUFREQ_ENTRY_INVALID frequencies. 718 * @pos: the cpufreq_frequency_table * to use as a loop cursor. 719 * @table: the cpufreq_frequency_table * to iterate over. 720 * @idx: the table entry currently being processed 721 */ 722 723 #define cpufreq_for_each_valid_entry_idx(pos, table, idx) \ 724 cpufreq_for_each_entry_idx(pos, table, idx) \ 725 if (pos->frequency == CPUFREQ_ENTRY_INVALID) \ 726 continue; \ 727 else 728 729 730 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy, 731 struct cpufreq_frequency_table *table); 732 733 int cpufreq_frequency_table_verify(struct cpufreq_policy_data *policy, 734 struct cpufreq_frequency_table *table); 735 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy_data *policy); 736 737 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy, 738 unsigned int target_freq, 739 unsigned int relation); 740 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy, 741 unsigned int freq); 742 743 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf); 744 745 #ifdef CONFIG_CPU_FREQ 746 int cpufreq_boost_trigger_state(int state); 747 int cpufreq_boost_enabled(void); 748 int cpufreq_enable_boost_support(void); 749 bool policy_has_boost_freq(struct cpufreq_policy *policy); 750 751 /* Find lowest freq at or above target in a table in ascending order */ 752 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy, 753 unsigned int target_freq) 754 { 755 struct cpufreq_frequency_table *table = policy->freq_table; 756 struct cpufreq_frequency_table *pos; 757 unsigned int freq; 758 int idx, best = -1; 759 760 cpufreq_for_each_valid_entry_idx(pos, table, idx) { 761 freq = pos->frequency; 762 763 if (freq >= target_freq) 764 return idx; 765 766 best = idx; 767 } 768 769 return best; 770 } 771 772 /* Find lowest freq at or above target in a table in descending order */ 773 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy, 774 unsigned int target_freq) 775 { 776 struct cpufreq_frequency_table *table = policy->freq_table; 777 struct cpufreq_frequency_table *pos; 778 unsigned int freq; 779 int idx, best = -1; 780 781 cpufreq_for_each_valid_entry_idx(pos, table, idx) { 782 freq = pos->frequency; 783 784 if (freq == target_freq) 785 return idx; 786 787 if (freq > target_freq) { 788 best = idx; 789 continue; 790 } 791 792 /* No freq found above target_freq */ 793 if (best == -1) 794 return idx; 795 796 return best; 797 } 798 799 return best; 800 } 801 802 /* Works only on sorted freq-tables */ 803 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy, 804 unsigned int target_freq) 805 { 806 target_freq = clamp_val(target_freq, policy->min, policy->max); 807 808 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING) 809 return cpufreq_table_find_index_al(policy, target_freq); 810 else 811 return cpufreq_table_find_index_dl(policy, target_freq); 812 } 813 814 /* Find highest freq at or below target in a table in ascending order */ 815 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy, 816 unsigned int target_freq) 817 { 818 struct cpufreq_frequency_table *table = policy->freq_table; 819 struct cpufreq_frequency_table *pos; 820 unsigned int freq; 821 int idx, best = -1; 822 823 cpufreq_for_each_valid_entry_idx(pos, table, idx) { 824 freq = pos->frequency; 825 826 if (freq == target_freq) 827 return idx; 828 829 if (freq < target_freq) { 830 best = idx; 831 continue; 832 } 833 834 /* No freq found below target_freq */ 835 if (best == -1) 836 return idx; 837 838 return best; 839 } 840 841 return best; 842 } 843 844 /* Find highest freq at or below target in a table in descending order */ 845 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy, 846 unsigned int target_freq) 847 { 848 struct cpufreq_frequency_table *table = policy->freq_table; 849 struct cpufreq_frequency_table *pos; 850 unsigned int freq; 851 int idx, best = -1; 852 853 cpufreq_for_each_valid_entry_idx(pos, table, idx) { 854 freq = pos->frequency; 855 856 if (freq <= target_freq) 857 return idx; 858 859 best = idx; 860 } 861 862 return best; 863 } 864 865 /* Works only on sorted freq-tables */ 866 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy, 867 unsigned int target_freq) 868 { 869 target_freq = clamp_val(target_freq, policy->min, policy->max); 870 871 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING) 872 return cpufreq_table_find_index_ah(policy, target_freq); 873 else 874 return cpufreq_table_find_index_dh(policy, target_freq); 875 } 876 877 /* Find closest freq to target in a table in ascending order */ 878 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy, 879 unsigned int target_freq) 880 { 881 struct cpufreq_frequency_table *table = policy->freq_table; 882 struct cpufreq_frequency_table *pos; 883 unsigned int freq; 884 int idx, best = -1; 885 886 cpufreq_for_each_valid_entry_idx(pos, table, idx) { 887 freq = pos->frequency; 888 889 if (freq == target_freq) 890 return idx; 891 892 if (freq < target_freq) { 893 best = idx; 894 continue; 895 } 896 897 /* No freq found below target_freq */ 898 if (best == -1) 899 return idx; 900 901 /* Choose the closest freq */ 902 if (target_freq - table[best].frequency > freq - target_freq) 903 return idx; 904 905 return best; 906 } 907 908 return best; 909 } 910 911 /* Find closest freq to target in a table in descending order */ 912 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy, 913 unsigned int target_freq) 914 { 915 struct cpufreq_frequency_table *table = policy->freq_table; 916 struct cpufreq_frequency_table *pos; 917 unsigned int freq; 918 int idx, best = -1; 919 920 cpufreq_for_each_valid_entry_idx(pos, table, idx) { 921 freq = pos->frequency; 922 923 if (freq == target_freq) 924 return idx; 925 926 if (freq > target_freq) { 927 best = idx; 928 continue; 929 } 930 931 /* No freq found above target_freq */ 932 if (best == -1) 933 return idx; 934 935 /* Choose the closest freq */ 936 if (table[best].frequency - target_freq > target_freq - freq) 937 return idx; 938 939 return best; 940 } 941 942 return best; 943 } 944 945 /* Works only on sorted freq-tables */ 946 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy, 947 unsigned int target_freq) 948 { 949 target_freq = clamp_val(target_freq, policy->min, policy->max); 950 951 if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING) 952 return cpufreq_table_find_index_ac(policy, target_freq); 953 else 954 return cpufreq_table_find_index_dc(policy, target_freq); 955 } 956 957 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy, 958 unsigned int target_freq, 959 unsigned int relation) 960 { 961 if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED)) 962 return cpufreq_table_index_unsorted(policy, target_freq, 963 relation); 964 965 switch (relation) { 966 case CPUFREQ_RELATION_L: 967 return cpufreq_table_find_index_l(policy, target_freq); 968 case CPUFREQ_RELATION_H: 969 return cpufreq_table_find_index_h(policy, target_freq); 970 case CPUFREQ_RELATION_C: 971 return cpufreq_table_find_index_c(policy, target_freq); 972 default: 973 WARN_ON_ONCE(1); 974 return 0; 975 } 976 } 977 978 static inline int cpufreq_table_count_valid_entries(const struct cpufreq_policy *policy) 979 { 980 struct cpufreq_frequency_table *pos; 981 int count = 0; 982 983 if (unlikely(!policy->freq_table)) 984 return 0; 985 986 cpufreq_for_each_valid_entry(pos, policy->freq_table) 987 count++; 988 989 return count; 990 } 991 #else 992 static inline int cpufreq_boost_trigger_state(int state) 993 { 994 return 0; 995 } 996 static inline int cpufreq_boost_enabled(void) 997 { 998 return 0; 999 } 1000 1001 static inline int cpufreq_enable_boost_support(void) 1002 { 1003 return -EINVAL; 1004 } 1005 1006 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy) 1007 { 1008 return false; 1009 } 1010 #endif 1011 1012 #if defined(CONFIG_ENERGY_MODEL) && defined(CONFIG_CPU_FREQ_GOV_SCHEDUTIL) 1013 void sched_cpufreq_governor_change(struct cpufreq_policy *policy, 1014 struct cpufreq_governor *old_gov); 1015 #else 1016 static inline void sched_cpufreq_governor_change(struct cpufreq_policy *policy, 1017 struct cpufreq_governor *old_gov) { } 1018 #endif 1019 1020 extern void arch_freq_prepare_all(void); 1021 extern unsigned int arch_freq_get_on_cpu(int cpu); 1022 1023 #ifndef arch_set_freq_scale 1024 static __always_inline 1025 void arch_set_freq_scale(const struct cpumask *cpus, 1026 unsigned long cur_freq, 1027 unsigned long max_freq) 1028 { 1029 } 1030 #endif 1031 1032 /* the following are really really optional */ 1033 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs; 1034 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs; 1035 extern struct freq_attr *cpufreq_generic_attr[]; 1036 int cpufreq_table_validate_and_sort(struct cpufreq_policy *policy); 1037 1038 unsigned int cpufreq_generic_get(unsigned int cpu); 1039 void cpufreq_generic_init(struct cpufreq_policy *policy, 1040 struct cpufreq_frequency_table *table, 1041 unsigned int transition_latency); 1042 #endif /* _LINUX_CPUFREQ_H */ 1043