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