xref: /linux-6.15/include/linux/cpufreq.h (revision cfd6ed45)
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 	 /* Cached frequency lookup from cpufreq_driver_resolve_freq. */
124 	unsigned int cached_target_freq;
125 	int cached_resolved_idx;
126 
127 	/* Synchronization for frequency transitions */
128 	bool			transition_ongoing; /* Tracks transition status */
129 	spinlock_t		transition_lock;
130 	wait_queue_head_t	transition_wait;
131 	struct task_struct	*transition_task; /* Task which is doing the transition */
132 
133 	/* cpufreq-stats */
134 	struct cpufreq_stats	*stats;
135 
136 	/* For cpufreq driver's internal use */
137 	void			*driver_data;
138 };
139 
140 /* Only for ACPI */
141 #define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
142 #define CPUFREQ_SHARED_TYPE_HW	 (1) /* HW does needed coordination */
143 #define CPUFREQ_SHARED_TYPE_ALL	 (2) /* All dependent CPUs should set freq */
144 #define CPUFREQ_SHARED_TYPE_ANY	 (3) /* Freq can be set from any dependent CPU*/
145 
146 #ifdef CONFIG_CPU_FREQ
147 struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu);
148 struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
149 void cpufreq_cpu_put(struct cpufreq_policy *policy);
150 #else
151 static inline struct cpufreq_policy *cpufreq_cpu_get_raw(unsigned int cpu)
152 {
153 	return NULL;
154 }
155 static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
156 {
157 	return NULL;
158 }
159 static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
160 #endif
161 
162 static inline bool policy_is_shared(struct cpufreq_policy *policy)
163 {
164 	return cpumask_weight(policy->cpus) > 1;
165 }
166 
167 /* /sys/devices/system/cpu/cpufreq: entry point for global variables */
168 extern struct kobject *cpufreq_global_kobject;
169 
170 #ifdef CONFIG_CPU_FREQ
171 unsigned int cpufreq_get(unsigned int cpu);
172 unsigned int cpufreq_quick_get(unsigned int cpu);
173 unsigned int cpufreq_quick_get_max(unsigned int cpu);
174 void disable_cpufreq(void);
175 
176 u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
177 int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
178 void cpufreq_update_policy(unsigned int cpu);
179 bool have_governor_per_policy(void);
180 struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
181 void cpufreq_enable_fast_switch(struct cpufreq_policy *policy);
182 void cpufreq_disable_fast_switch(struct cpufreq_policy *policy);
183 #else
184 static inline unsigned int cpufreq_get(unsigned int cpu)
185 {
186 	return 0;
187 }
188 static inline unsigned int cpufreq_quick_get(unsigned int cpu)
189 {
190 	return 0;
191 }
192 static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
193 {
194 	return 0;
195 }
196 static inline void disable_cpufreq(void) { }
197 #endif
198 
199 #ifdef CONFIG_CPU_FREQ_STAT
200 void cpufreq_stats_create_table(struct cpufreq_policy *policy);
201 void cpufreq_stats_free_table(struct cpufreq_policy *policy);
202 void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
203 				     unsigned int new_freq);
204 #else
205 static inline void cpufreq_stats_create_table(struct cpufreq_policy *policy) { }
206 static inline void cpufreq_stats_free_table(struct cpufreq_policy *policy) { }
207 static inline void cpufreq_stats_record_transition(struct cpufreq_policy *policy,
208 						   unsigned int new_freq) { }
209 #endif /* CONFIG_CPU_FREQ_STAT */
210 
211 /*********************************************************************
212  *                      CPUFREQ DRIVER INTERFACE                     *
213  *********************************************************************/
214 
215 #define CPUFREQ_RELATION_L 0  /* lowest frequency at or above target */
216 #define CPUFREQ_RELATION_H 1  /* highest frequency below or at target */
217 #define CPUFREQ_RELATION_C 2  /* closest frequency to target */
218 
219 struct freq_attr {
220 	struct attribute attr;
221 	ssize_t (*show)(struct cpufreq_policy *, char *);
222 	ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
223 };
224 
225 #define cpufreq_freq_attr_ro(_name)		\
226 static struct freq_attr _name =			\
227 __ATTR(_name, 0444, show_##_name, NULL)
228 
229 #define cpufreq_freq_attr_ro_perm(_name, _perm)	\
230 static struct freq_attr _name =			\
231 __ATTR(_name, _perm, show_##_name, NULL)
232 
233 #define cpufreq_freq_attr_rw(_name)		\
234 static struct freq_attr _name =			\
235 __ATTR(_name, 0644, show_##_name, store_##_name)
236 
237 #define cpufreq_freq_attr_wo(_name)		\
238 static struct freq_attr _name =			\
239 __ATTR(_name, 0200, NULL, store_##_name)
240 
241 struct global_attr {
242 	struct attribute attr;
243 	ssize_t (*show)(struct kobject *kobj,
244 			struct attribute *attr, char *buf);
245 	ssize_t (*store)(struct kobject *a, struct attribute *b,
246 			 const char *c, size_t count);
247 };
248 
249 #define define_one_global_ro(_name)		\
250 static struct global_attr _name =		\
251 __ATTR(_name, 0444, show_##_name, NULL)
252 
253 #define define_one_global_rw(_name)		\
254 static struct global_attr _name =		\
255 __ATTR(_name, 0644, show_##_name, store_##_name)
256 
257 
258 struct cpufreq_driver {
259 	char		name[CPUFREQ_NAME_LEN];
260 	u8		flags;
261 	void		*driver_data;
262 
263 	/* needed by all drivers */
264 	int		(*init)(struct cpufreq_policy *policy);
265 	int		(*verify)(struct cpufreq_policy *policy);
266 
267 	/* define one out of two */
268 	int		(*setpolicy)(struct cpufreq_policy *policy);
269 
270 	/*
271 	 * On failure, should always restore frequency to policy->restore_freq
272 	 * (i.e. old freq).
273 	 */
274 	int		(*target)(struct cpufreq_policy *policy,
275 				  unsigned int target_freq,
276 				  unsigned int relation);	/* Deprecated */
277 	int		(*target_index)(struct cpufreq_policy *policy,
278 					unsigned int index);
279 	unsigned int	(*fast_switch)(struct cpufreq_policy *policy,
280 				       unsigned int target_freq);
281 
282 	/*
283 	 * Caches and returns the lowest driver-supported frequency greater than
284 	 * or equal to the target frequency, subject to any driver limitations.
285 	 * Does not set the frequency. Only to be implemented for drivers with
286 	 * target().
287 	 */
288 	unsigned int	(*resolve_freq)(struct cpufreq_policy *policy,
289 					unsigned int target_freq);
290 
291 	/*
292 	 * Only for drivers with target_index() and CPUFREQ_ASYNC_NOTIFICATION
293 	 * unset.
294 	 *
295 	 * get_intermediate should return a stable intermediate frequency
296 	 * platform wants to switch to and target_intermediate() should set CPU
297 	 * to to that frequency, before jumping to the frequency corresponding
298 	 * to 'index'. Core will take care of sending notifications and driver
299 	 * doesn't have to handle them in target_intermediate() or
300 	 * target_index().
301 	 *
302 	 * Drivers can return '0' from get_intermediate() in case they don't
303 	 * wish to switch to intermediate frequency for some target frequency.
304 	 * In that case core will directly call ->target_index().
305 	 */
306 	unsigned int	(*get_intermediate)(struct cpufreq_policy *policy,
307 					    unsigned int index);
308 	int		(*target_intermediate)(struct cpufreq_policy *policy,
309 					       unsigned int index);
310 
311 	/* should be defined, if possible */
312 	unsigned int	(*get)(unsigned int cpu);
313 
314 	/* optional */
315 	int		(*bios_limit)(int cpu, unsigned int *limit);
316 
317 	int		(*exit)(struct cpufreq_policy *policy);
318 	void		(*stop_cpu)(struct cpufreq_policy *policy);
319 	int		(*suspend)(struct cpufreq_policy *policy);
320 	int		(*resume)(struct cpufreq_policy *policy);
321 
322 	/* Will be called after the driver is fully initialized */
323 	void		(*ready)(struct cpufreq_policy *policy);
324 
325 	struct freq_attr **attr;
326 
327 	/* platform specific boost support code */
328 	bool		boost_enabled;
329 	int		(*set_boost)(int state);
330 };
331 
332 /* flags */
333 #define CPUFREQ_STICKY		(1 << 0)	/* driver isn't removed even if
334 						   all ->init() calls failed */
335 #define CPUFREQ_CONST_LOOPS	(1 << 1)	/* loops_per_jiffy or other
336 						   kernel "constants" aren't
337 						   affected by frequency
338 						   transitions */
339 #define CPUFREQ_PM_NO_WARN	(1 << 2)	/* don't warn on suspend/resume
340 						   speed mismatches */
341 
342 /*
343  * This should be set by platforms having multiple clock-domains, i.e.
344  * supporting multiple policies. With this sysfs directories of governor would
345  * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
346  * governor with different tunables for different clusters.
347  */
348 #define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
349 
350 /*
351  * Driver will do POSTCHANGE notifications from outside of their ->target()
352  * routine and so must set cpufreq_driver->flags with this flag, so that core
353  * can handle them specially.
354  */
355 #define CPUFREQ_ASYNC_NOTIFICATION  (1 << 4)
356 
357 /*
358  * Set by drivers which want cpufreq core to check if CPU is running at a
359  * frequency present in freq-table exposed by the driver. For these drivers if
360  * CPU is found running at an out of table freq, we will try to set it to a freq
361  * from the table. And if that fails, we will stop further boot process by
362  * issuing a BUG_ON().
363  */
364 #define CPUFREQ_NEED_INITIAL_FREQ_CHECK	(1 << 5)
365 
366 int cpufreq_register_driver(struct cpufreq_driver *driver_data);
367 int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
368 
369 const char *cpufreq_get_current_driver(void);
370 void *cpufreq_get_driver_data(void);
371 
372 static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
373 		unsigned int min, unsigned int max)
374 {
375 	if (policy->min < min)
376 		policy->min = min;
377 	if (policy->max < min)
378 		policy->max = min;
379 	if (policy->min > max)
380 		policy->min = max;
381 	if (policy->max > max)
382 		policy->max = max;
383 	if (policy->min > policy->max)
384 		policy->min = policy->max;
385 	return;
386 }
387 
388 static inline void
389 cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
390 {
391 	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
392 			policy->cpuinfo.max_freq);
393 }
394 
395 #ifdef CONFIG_CPU_FREQ
396 void cpufreq_suspend(void);
397 void cpufreq_resume(void);
398 int cpufreq_generic_suspend(struct cpufreq_policy *policy);
399 #else
400 static inline void cpufreq_suspend(void) {}
401 static inline void cpufreq_resume(void) {}
402 #endif
403 
404 /*********************************************************************
405  *                     CPUFREQ NOTIFIER INTERFACE                    *
406  *********************************************************************/
407 
408 #define CPUFREQ_TRANSITION_NOTIFIER	(0)
409 #define CPUFREQ_POLICY_NOTIFIER		(1)
410 
411 /* Transition notifiers */
412 #define CPUFREQ_PRECHANGE		(0)
413 #define CPUFREQ_POSTCHANGE		(1)
414 
415 /* Policy Notifiers  */
416 #define CPUFREQ_ADJUST			(0)
417 #define CPUFREQ_NOTIFY			(1)
418 
419 #ifdef CONFIG_CPU_FREQ
420 int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
421 int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
422 
423 void cpufreq_freq_transition_begin(struct cpufreq_policy *policy,
424 		struct cpufreq_freqs *freqs);
425 void cpufreq_freq_transition_end(struct cpufreq_policy *policy,
426 		struct cpufreq_freqs *freqs, int transition_failed);
427 
428 #else /* CONFIG_CPU_FREQ */
429 static inline int cpufreq_register_notifier(struct notifier_block *nb,
430 						unsigned int list)
431 {
432 	return 0;
433 }
434 static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
435 						unsigned int list)
436 {
437 	return 0;
438 }
439 #endif /* !CONFIG_CPU_FREQ */
440 
441 /**
442  * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
443  * safe)
444  * @old:   old value
445  * @div:   divisor
446  * @mult:  multiplier
447  *
448  *
449  * new = old * mult / div
450  */
451 static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
452 		u_int mult)
453 {
454 #if BITS_PER_LONG == 32
455 	u64 result = ((u64) old) * ((u64) mult);
456 	do_div(result, div);
457 	return (unsigned long) result;
458 
459 #elif BITS_PER_LONG == 64
460 	unsigned long result = old * ((u64) mult);
461 	result /= div;
462 	return result;
463 #endif
464 }
465 
466 /*********************************************************************
467  *                          CPUFREQ GOVERNORS                        *
468  *********************************************************************/
469 
470 /*
471  * If (cpufreq_driver->target) exists, the ->governor decides what frequency
472  * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
473  * two generic policies are available:
474  */
475 #define CPUFREQ_POLICY_POWERSAVE	(1)
476 #define CPUFREQ_POLICY_PERFORMANCE	(2)
477 
478 /*
479  * The polling frequency depends on the capability of the processor. Default
480  * polling frequency is 1000 times the transition latency of the processor. The
481  * ondemand governor will work on any processor with transition latency <= 10ms,
482  * using appropriate sampling rate.
483  *
484  * For CPUs with transition latency > 10ms (mostly drivers with CPUFREQ_ETERNAL)
485  * the ondemand governor will not work. All times here are in us (microseconds).
486  */
487 #define MIN_SAMPLING_RATE_RATIO		(2)
488 #define LATENCY_MULTIPLIER		(1000)
489 #define MIN_LATENCY_MULTIPLIER		(20)
490 #define TRANSITION_LATENCY_LIMIT	(10 * 1000 * 1000)
491 
492 struct cpufreq_governor {
493 	char	name[CPUFREQ_NAME_LEN];
494 	int	(*init)(struct cpufreq_policy *policy);
495 	void	(*exit)(struct cpufreq_policy *policy);
496 	int	(*start)(struct cpufreq_policy *policy);
497 	void	(*stop)(struct cpufreq_policy *policy);
498 	void	(*limits)(struct cpufreq_policy *policy);
499 	ssize_t	(*show_setspeed)	(struct cpufreq_policy *policy,
500 					 char *buf);
501 	int	(*store_setspeed)	(struct cpufreq_policy *policy,
502 					 unsigned int freq);
503 	unsigned int max_transition_latency; /* HW must be able to switch to
504 			next freq faster than this value in nano secs or we
505 			will fallback to performance governor */
506 	struct list_head	governor_list;
507 	struct module		*owner;
508 };
509 
510 /* Pass a target to the cpufreq driver */
511 unsigned int cpufreq_driver_fast_switch(struct cpufreq_policy *policy,
512 					unsigned int target_freq);
513 int cpufreq_driver_target(struct cpufreq_policy *policy,
514 				 unsigned int target_freq,
515 				 unsigned int relation);
516 int __cpufreq_driver_target(struct cpufreq_policy *policy,
517 				   unsigned int target_freq,
518 				   unsigned int relation);
519 unsigned int cpufreq_driver_resolve_freq(struct cpufreq_policy *policy,
520 					 unsigned int target_freq);
521 int cpufreq_register_governor(struct cpufreq_governor *governor);
522 void cpufreq_unregister_governor(struct cpufreq_governor *governor);
523 
524 struct cpufreq_governor *cpufreq_default_governor(void);
525 struct cpufreq_governor *cpufreq_fallback_governor(void);
526 
527 static inline void cpufreq_policy_apply_limits(struct cpufreq_policy *policy)
528 {
529 	if (policy->max < policy->cur)
530 		__cpufreq_driver_target(policy, policy->max, CPUFREQ_RELATION_H);
531 	else if (policy->min > policy->cur)
532 		__cpufreq_driver_target(policy, policy->min, CPUFREQ_RELATION_L);
533 }
534 
535 /* Governor attribute set */
536 struct gov_attr_set {
537 	struct kobject kobj;
538 	struct list_head policy_list;
539 	struct mutex update_lock;
540 	int usage_count;
541 };
542 
543 /* sysfs ops for cpufreq governors */
544 extern const struct sysfs_ops governor_sysfs_ops;
545 
546 void gov_attr_set_init(struct gov_attr_set *attr_set, struct list_head *list_node);
547 void gov_attr_set_get(struct gov_attr_set *attr_set, struct list_head *list_node);
548 unsigned int gov_attr_set_put(struct gov_attr_set *attr_set, struct list_head *list_node);
549 
550 /* Governor sysfs attribute */
551 struct governor_attr {
552 	struct attribute attr;
553 	ssize_t (*show)(struct gov_attr_set *attr_set, char *buf);
554 	ssize_t (*store)(struct gov_attr_set *attr_set, const char *buf,
555 			 size_t count);
556 };
557 
558 /*********************************************************************
559  *                     FREQUENCY TABLE HELPERS                       *
560  *********************************************************************/
561 
562 /* Special Values of .frequency field */
563 #define CPUFREQ_ENTRY_INVALID	~0u
564 #define CPUFREQ_TABLE_END	~1u
565 /* Special Values of .flags field */
566 #define CPUFREQ_BOOST_FREQ	(1 << 0)
567 
568 struct cpufreq_frequency_table {
569 	unsigned int	flags;
570 	unsigned int	driver_data; /* driver specific data, not used by core */
571 	unsigned int	frequency; /* kHz - doesn't need to be in ascending
572 				    * order */
573 };
574 
575 #if defined(CONFIG_CPU_FREQ) && defined(CONFIG_PM_OPP)
576 int dev_pm_opp_init_cpufreq_table(struct device *dev,
577 				  struct cpufreq_frequency_table **table);
578 void dev_pm_opp_free_cpufreq_table(struct device *dev,
579 				   struct cpufreq_frequency_table **table);
580 #else
581 static inline int dev_pm_opp_init_cpufreq_table(struct device *dev,
582 						struct cpufreq_frequency_table
583 						**table)
584 {
585 	return -EINVAL;
586 }
587 
588 static inline void dev_pm_opp_free_cpufreq_table(struct device *dev,
589 						 struct cpufreq_frequency_table
590 						 **table)
591 {
592 }
593 #endif
594 
595 /*
596  * cpufreq_for_each_entry -	iterate over a cpufreq_frequency_table
597  * @pos:	the cpufreq_frequency_table * to use as a loop cursor.
598  * @table:	the cpufreq_frequency_table * to iterate over.
599  */
600 
601 #define cpufreq_for_each_entry(pos, table)	\
602 	for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)
603 
604 /*
605  * cpufreq_for_each_valid_entry -     iterate over a cpufreq_frequency_table
606  *	excluding CPUFREQ_ENTRY_INVALID frequencies.
607  * @pos:        the cpufreq_frequency_table * to use as a loop cursor.
608  * @table:      the cpufreq_frequency_table * to iterate over.
609  */
610 
611 #define cpufreq_for_each_valid_entry(pos, table)			\
612 	for (pos = table; pos->frequency != CPUFREQ_TABLE_END; pos++)	\
613 		if (pos->frequency == CPUFREQ_ENTRY_INVALID)		\
614 			continue;					\
615 		else
616 
617 int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
618 				    struct cpufreq_frequency_table *table);
619 
620 int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
621 				   struct cpufreq_frequency_table *table);
622 int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
623 
624 int cpufreq_table_index_unsorted(struct cpufreq_policy *policy,
625 				 unsigned int target_freq,
626 				 unsigned int relation);
627 int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
628 		unsigned int freq);
629 
630 ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);
631 
632 #ifdef CONFIG_CPU_FREQ
633 int cpufreq_boost_trigger_state(int state);
634 int cpufreq_boost_enabled(void);
635 int cpufreq_enable_boost_support(void);
636 bool policy_has_boost_freq(struct cpufreq_policy *policy);
637 
638 /* Find lowest freq at or above target in a table in ascending order */
639 static inline int cpufreq_table_find_index_al(struct cpufreq_policy *policy,
640 					      unsigned int target_freq)
641 {
642 	struct cpufreq_frequency_table *table = policy->freq_table;
643 	struct cpufreq_frequency_table *pos, *best = table - 1;
644 	unsigned int freq;
645 
646 	cpufreq_for_each_valid_entry(pos, table) {
647 		freq = pos->frequency;
648 
649 		if (freq >= target_freq)
650 			return pos - table;
651 
652 		best = pos;
653 	}
654 
655 	return best - table;
656 }
657 
658 /* Find lowest freq at or above target in a table in descending order */
659 static inline int cpufreq_table_find_index_dl(struct cpufreq_policy *policy,
660 					      unsigned int target_freq)
661 {
662 	struct cpufreq_frequency_table *table = policy->freq_table;
663 	struct cpufreq_frequency_table *pos, *best = table - 1;
664 	unsigned int freq;
665 
666 	cpufreq_for_each_valid_entry(pos, table) {
667 		freq = pos->frequency;
668 
669 		if (freq == target_freq)
670 			return pos - table;
671 
672 		if (freq > target_freq) {
673 			best = pos;
674 			continue;
675 		}
676 
677 		/* No freq found above target_freq */
678 		if (best == table - 1)
679 			return pos - table;
680 
681 		return best - table;
682 	}
683 
684 	return best - table;
685 }
686 
687 /* Works only on sorted freq-tables */
688 static inline int cpufreq_table_find_index_l(struct cpufreq_policy *policy,
689 					     unsigned int target_freq)
690 {
691 	target_freq = clamp_val(target_freq, policy->min, policy->max);
692 
693 	if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
694 		return cpufreq_table_find_index_al(policy, target_freq);
695 	else
696 		return cpufreq_table_find_index_dl(policy, target_freq);
697 }
698 
699 /* Find highest freq at or below target in a table in ascending order */
700 static inline int cpufreq_table_find_index_ah(struct cpufreq_policy *policy,
701 					      unsigned int target_freq)
702 {
703 	struct cpufreq_frequency_table *table = policy->freq_table;
704 	struct cpufreq_frequency_table *pos, *best = table - 1;
705 	unsigned int freq;
706 
707 	cpufreq_for_each_valid_entry(pos, table) {
708 		freq = pos->frequency;
709 
710 		if (freq == target_freq)
711 			return pos - table;
712 
713 		if (freq < target_freq) {
714 			best = pos;
715 			continue;
716 		}
717 
718 		/* No freq found below target_freq */
719 		if (best == table - 1)
720 			return pos - table;
721 
722 		return best - table;
723 	}
724 
725 	return best - table;
726 }
727 
728 /* Find highest freq at or below target in a table in descending order */
729 static inline int cpufreq_table_find_index_dh(struct cpufreq_policy *policy,
730 					      unsigned int target_freq)
731 {
732 	struct cpufreq_frequency_table *table = policy->freq_table;
733 	struct cpufreq_frequency_table *pos, *best = table - 1;
734 	unsigned int freq;
735 
736 	cpufreq_for_each_valid_entry(pos, table) {
737 		freq = pos->frequency;
738 
739 		if (freq <= target_freq)
740 			return pos - table;
741 
742 		best = pos;
743 	}
744 
745 	return best - table;
746 }
747 
748 /* Works only on sorted freq-tables */
749 static inline int cpufreq_table_find_index_h(struct cpufreq_policy *policy,
750 					     unsigned int target_freq)
751 {
752 	target_freq = clamp_val(target_freq, policy->min, policy->max);
753 
754 	if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
755 		return cpufreq_table_find_index_ah(policy, target_freq);
756 	else
757 		return cpufreq_table_find_index_dh(policy, target_freq);
758 }
759 
760 /* Find closest freq to target in a table in ascending order */
761 static inline int cpufreq_table_find_index_ac(struct cpufreq_policy *policy,
762 					      unsigned int target_freq)
763 {
764 	struct cpufreq_frequency_table *table = policy->freq_table;
765 	struct cpufreq_frequency_table *pos, *best = table - 1;
766 	unsigned int freq;
767 
768 	cpufreq_for_each_valid_entry(pos, table) {
769 		freq = pos->frequency;
770 
771 		if (freq == target_freq)
772 			return pos - table;
773 
774 		if (freq < target_freq) {
775 			best = pos;
776 			continue;
777 		}
778 
779 		/* No freq found below target_freq */
780 		if (best == table - 1)
781 			return pos - table;
782 
783 		/* Choose the closest freq */
784 		if (target_freq - best->frequency > freq - target_freq)
785 			return pos - table;
786 
787 		return best - table;
788 	}
789 
790 	return best - table;
791 }
792 
793 /* Find closest freq to target in a table in descending order */
794 static inline int cpufreq_table_find_index_dc(struct cpufreq_policy *policy,
795 					      unsigned int target_freq)
796 {
797 	struct cpufreq_frequency_table *table = policy->freq_table;
798 	struct cpufreq_frequency_table *pos, *best = table - 1;
799 	unsigned int freq;
800 
801 	cpufreq_for_each_valid_entry(pos, table) {
802 		freq = pos->frequency;
803 
804 		if (freq == target_freq)
805 			return pos - table;
806 
807 		if (freq > target_freq) {
808 			best = pos;
809 			continue;
810 		}
811 
812 		/* No freq found above target_freq */
813 		if (best == table - 1)
814 			return pos - table;
815 
816 		/* Choose the closest freq */
817 		if (best->frequency - target_freq > target_freq - freq)
818 			return pos - table;
819 
820 		return best - table;
821 	}
822 
823 	return best - table;
824 }
825 
826 /* Works only on sorted freq-tables */
827 static inline int cpufreq_table_find_index_c(struct cpufreq_policy *policy,
828 					     unsigned int target_freq)
829 {
830 	target_freq = clamp_val(target_freq, policy->min, policy->max);
831 
832 	if (policy->freq_table_sorted == CPUFREQ_TABLE_SORTED_ASCENDING)
833 		return cpufreq_table_find_index_ac(policy, target_freq);
834 	else
835 		return cpufreq_table_find_index_dc(policy, target_freq);
836 }
837 
838 static inline int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
839 						 unsigned int target_freq,
840 						 unsigned int relation)
841 {
842 	if (unlikely(policy->freq_table_sorted == CPUFREQ_TABLE_UNSORTED))
843 		return cpufreq_table_index_unsorted(policy, target_freq,
844 						    relation);
845 
846 	switch (relation) {
847 	case CPUFREQ_RELATION_L:
848 		return cpufreq_table_find_index_l(policy, target_freq);
849 	case CPUFREQ_RELATION_H:
850 		return cpufreq_table_find_index_h(policy, target_freq);
851 	case CPUFREQ_RELATION_C:
852 		return cpufreq_table_find_index_c(policy, target_freq);
853 	default:
854 		pr_err("%s: Invalid relation: %d\n", __func__, relation);
855 		return -EINVAL;
856 	}
857 }
858 #else
859 static inline int cpufreq_boost_trigger_state(int state)
860 {
861 	return 0;
862 }
863 static inline int cpufreq_boost_enabled(void)
864 {
865 	return 0;
866 }
867 
868 static inline int cpufreq_enable_boost_support(void)
869 {
870 	return -EINVAL;
871 }
872 
873 static inline bool policy_has_boost_freq(struct cpufreq_policy *policy)
874 {
875 	return false;
876 }
877 #endif
878 
879 /* the following are really really optional */
880 extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
881 extern struct freq_attr cpufreq_freq_attr_scaling_boost_freqs;
882 extern struct freq_attr *cpufreq_generic_attr[];
883 int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
884 				      struct cpufreq_frequency_table *table);
885 
886 unsigned int cpufreq_generic_get(unsigned int cpu);
887 int cpufreq_generic_init(struct cpufreq_policy *policy,
888 		struct cpufreq_frequency_table *table,
889 		unsigned int transition_latency);
890 #endif /* _LINUX_CPUFREQ_H */
891