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