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