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