Linux Audio

Check our new training course

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