[deliverable/linux.git] / include / linux / cpufreq.h

/*
 * linux/include/linux/cpufreq.h
 *
 * Copyright (C) 2001 Russell King
 *           (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef _LINUX_CPUFREQ_H
#define _LINUX_CPUFREQ_H

#include <linux/cpumask.h>
#include <linux/completion.h>
#include <linux/kobject.h>
#include <linux/notifier.h>
#include <linux/sysfs.h>

/*********************************************************************
 *                        CPUFREQ INTERFACE                          *
 *********************************************************************/
/*
 * Frequency values here are CPU kHz
 *
 * Maximum transition latency is in nanoseconds - if it's unknown,
 * CPUFREQ_ETERNAL shall be used.
 */

#define CPUFREQ_ETERNAL			(-1)
#define CPUFREQ_NAME_LEN		16
/* Print length for names. Extra 1 space for accomodating '\n' in prints */
#define CPUFREQ_NAME_PLEN		(CPUFREQ_NAME_LEN + 1)

struct cpufreq_governor;

struct cpufreq_freqs {
	unsigned int cpu;	/* cpu nr */
	unsigned int old;
	unsigned int new;
	u8 flags;		/* flags of cpufreq_driver, see below. */
};

struct cpufreq_cpuinfo {
	unsigned int		max_freq;
	unsigned int		min_freq;

	/* in 10^(-9) s = nanoseconds */
	unsigned int		transition_latency;
};

struct cpufreq_real_policy {
	unsigned int		min;    /* in kHz */
	unsigned int		max;    /* in kHz */
	unsigned int		policy; /* see above */
	struct cpufreq_governor	*governor; /* see below */
};

struct cpufreq_policy {
	/* CPUs sharing clock, require sw coordination */
	cpumask_var_t		cpus;	/* Online CPUs only */
	cpumask_var_t		related_cpus; /* Online + Offline CPUs */

	unsigned int		shared_type; /* ACPI: ANY or ALL affected CPUs
						should set cpufreq */
	unsigned int		cpu;    /* cpu nr of CPU managing this policy */
	unsigned int		last_cpu; /* cpu nr of previous CPU that managed
					   * this policy */
	struct cpufreq_cpuinfo	cpuinfo;/* see above */

	unsigned int		min;    /* in kHz */
	unsigned int		max;    /* in kHz */
	unsigned int		cur;    /* in kHz, only needed if cpufreq
					 * governors are used */
	unsigned int		policy; /* see above */
	struct cpufreq_governor	*governor; /* see below */
	void			*governor_data;
	bool			governor_enabled; /* governor start/stop flag */

	struct work_struct	update; /* if update_policy() needs to be
					 * called, but you're in IRQ context */

	struct cpufreq_real_policy	user_policy;

	struct list_head        policy_list;
	struct kobject		kobj;
	struct completion	kobj_unregister;

	/*
	 * The rules for this semaphore:
	 * - Any routine that wants to read from the policy structure will
	 *   do a down_read on this semaphore.
	 * - Any routine that will write to the policy structure and/or may take away
	 *   the policy altogether (eg. CPU hotplug), will hold this lock in write
	 *   mode before doing so.
	 *
	 * Additional rules:
	 * - Lock should not be held across
	 *     __cpufreq_governor(data, CPUFREQ_GOV_POLICY_EXIT);
	 */
	struct rw_semaphore	rwsem;
};

/* Only for ACPI */
#define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
#define CPUFREQ_SHARED_TYPE_HW	 (1) /* HW does needed coordination */
#define CPUFREQ_SHARED_TYPE_ALL	 (2) /* All dependent CPUs should set freq */
#define CPUFREQ_SHARED_TYPE_ANY	 (3) /* Freq can be set from any dependent CPU*/

#ifdef CONFIG_CPU_FREQ
struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
void cpufreq_cpu_put(struct cpufreq_policy *policy);
#else
static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
{
	return NULL;
}
static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
#endif

static inline bool policy_is_shared(struct cpufreq_policy *policy)
{
	return cpumask_weight(policy->cpus) > 1;
}

/* /sys/devices/system/cpu/cpufreq: entry point for global variables */
extern struct kobject *cpufreq_global_kobject;
int cpufreq_get_global_kobject(void);
void cpufreq_put_global_kobject(void);
int cpufreq_sysfs_create_file(const struct attribute *attr);
void cpufreq_sysfs_remove_file(const struct attribute *attr);

#ifdef CONFIG_CPU_FREQ
unsigned int cpufreq_get(unsigned int cpu);
unsigned int cpufreq_quick_get(unsigned int cpu);
unsigned int cpufreq_quick_get_max(unsigned int cpu);
void disable_cpufreq(void);

u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
int cpufreq_update_policy(unsigned int cpu);
bool have_governor_per_policy(void);
struct kobject *get_governor_parent_kobj(struct cpufreq_policy *policy);
#else
static inline unsigned int cpufreq_get(unsigned int cpu)
{
	return 0;
}
static inline unsigned int cpufreq_quick_get(unsigned int cpu)
{
	return 0;
}
static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
{
	return 0;
}
static inline void disable_cpufreq(void) { }
#endif

/*********************************************************************
 *                      CPUFREQ DRIVER INTERFACE                     *
 *********************************************************************/

#define CPUFREQ_RELATION_L 0  /* lowest frequency at or above target */
#define CPUFREQ_RELATION_H 1  /* highest frequency below or at target */

struct freq_attr {
	struct attribute attr;
	ssize_t (*show)(struct cpufreq_policy *, char *);
	ssize_t (*store)(struct cpufreq_policy *, const char *, size_t count);
};

#define cpufreq_freq_attr_ro(_name)		\
static struct freq_attr _name =			\
__ATTR(_name, 0444, show_##_name, NULL)

#define cpufreq_freq_attr_ro_perm(_name, _perm)	\
static struct freq_attr _name =			\
__ATTR(_name, _perm, show_##_name, NULL)

#define cpufreq_freq_attr_rw(_name)		\
static struct freq_attr _name =			\
__ATTR(_name, 0644, show_##_name, store_##_name)

struct global_attr {
	struct attribute attr;
	ssize_t (*show)(struct kobject *kobj,
			struct attribute *attr, char *buf);
	ssize_t (*store)(struct kobject *a, struct attribute *b,
			 const char *c, size_t count);
};

#define define_one_global_ro(_name)		\
static struct global_attr _name =		\
__ATTR(_name, 0444, show_##_name, NULL)

#define define_one_global_rw(_name)		\
static struct global_attr _name =		\
__ATTR(_name, 0644, show_##_name, store_##_name)


struct cpufreq_driver {
	char			name[CPUFREQ_NAME_LEN];
	u8			flags;

	/* needed by all drivers */
	int	(*init)		(struct cpufreq_policy *policy);
	int	(*verify)	(struct cpufreq_policy *policy);

	/* define one out of two */
	int	(*setpolicy)	(struct cpufreq_policy *policy);
	int	(*target)	(struct cpufreq_policy *policy,	/* Deprecated */
				 unsigned int target_freq,
				 unsigned int relation);
	int	(*target_index)	(struct cpufreq_policy *policy,
				 unsigned int index);

	/* should be defined, if possible */
	unsigned int	(*get)	(unsigned int cpu);

	/* optional */
	int	(*bios_limit)	(int cpu, unsigned int *limit);

	int	(*exit)		(struct cpufreq_policy *policy);
	int	(*suspend)	(struct cpufreq_policy *policy);
	int	(*resume)	(struct cpufreq_policy *policy);
	struct freq_attr	**attr;
};

/* flags */
#define CPUFREQ_STICKY		(1 << 0)	/* driver isn't removed even if
						   all ->init() calls failed */
#define CPUFREQ_CONST_LOOPS	(1 << 1)	/* loops_per_jiffy or other
						   kernel "constants" aren't
						   affected by frequency
						   transitions */
#define CPUFREQ_PM_NO_WARN	(1 << 2)	/* don't warn on suspend/resume
						   speed mismatches */

/*
 * This should be set by platforms having multiple clock-domains, i.e.
 * supporting multiple policies. With this sysfs directories of governor would
 * be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
 * governor with different tunables for different clusters.
 */
#define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)

/*
 * Driver will do POSTCHANGE notifications from outside of their ->target()
 * routine and so must set cpufreq_driver->flags with this flag, so that core
 * can handle them specially.
 */
#define CPUFREQ_ASYNC_NOTIFICATION  (1 << 4)

/*
 * Set by drivers which want cpufreq core to check if CPU is running at a
 * frequency present in freq-table exposed by the driver. For these drivers if
 * CPU is found running at an out of table freq, we will try to set it to a freq
 * from the table. And if that fails, we will stop further boot process by
 * issuing a BUG_ON().
 */
#define CPUFREQ_NEED_INITIAL_FREQ_CHECK	(1 << 5)

int cpufreq_register_driver(struct cpufreq_driver *driver_data);
int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);

const char *cpufreq_get_current_driver(void);

static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
		unsigned int min, unsigned int max)
{
	if (policy->min < min)
		policy->min = min;
	if (policy->max < min)
		policy->max = min;
	if (policy->min > max)
		policy->min = max;
	if (policy->max > max)
		policy->max = max;
	if (policy->min > policy->max)
		policy->min = policy->max;
	return;
}

static inline void
cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
{
	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
			policy->cpuinfo.max_freq);
}

/*********************************************************************
 *                     CPUFREQ NOTIFIER INTERFACE                    *
 *********************************************************************/

#define CPUFREQ_TRANSITION_NOTIFIER	(0)
#define CPUFREQ_POLICY_NOTIFIER		(1)

/* Transition notifiers */
#define CPUFREQ_PRECHANGE		(0)
#define CPUFREQ_POSTCHANGE		(1)
#define CPUFREQ_RESUMECHANGE		(8)
#define CPUFREQ_SUSPENDCHANGE		(9)

/* Policy Notifiers  */
#define CPUFREQ_ADJUST			(0)
#define CPUFREQ_INCOMPATIBLE		(1)
#define CPUFREQ_NOTIFY			(2)
#define CPUFREQ_START			(3)
#define CPUFREQ_UPDATE_POLICY_CPU	(4)
#define CPUFREQ_CREATE_POLICY		(5)
#define CPUFREQ_REMOVE_POLICY		(6)

#ifdef CONFIG_CPU_FREQ
int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);

void cpufreq_notify_transition(struct cpufreq_policy *policy,
		struct cpufreq_freqs *freqs, unsigned int state);
void cpufreq_notify_post_transition(struct cpufreq_policy *policy,
		struct cpufreq_freqs *freqs, int transition_failed);

#else /* CONFIG_CPU_FREQ */
static inline int cpufreq_register_notifier(struct notifier_block *nb,
						unsigned int list)
{
	return 0;
}
static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
						unsigned int list)
{
	return 0;
}
#endif /* !CONFIG_CPU_FREQ */

/**
 * cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
 * safe)
 * @old:   old value
 * @div:   divisor
 * @mult:  multiplier
 *
 *
 * new = old * mult / div
 */
static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
		u_int mult)
{
#if BITS_PER_LONG == 32
	u64 result = ((u64) old) * ((u64) mult);
	do_div(result, div);
	return (unsigned long) result;

#elif BITS_PER_LONG == 64
	unsigned long result = old * ((u64) mult);
	result /= div;
	return result;
#endif
}

/*********************************************************************
 *                          CPUFREQ GOVERNORS                        *
 *********************************************************************/

/*
 * If (cpufreq_driver->target) exists, the ->governor decides what frequency
 * within the limits is used. If (cpufreq_driver->setpolicy> exists, these
 * two generic policies are available:
 */
#define CPUFREQ_POLICY_POWERSAVE	(1)
#define CPUFREQ_POLICY_PERFORMANCE	(2)

/* Governor Events */
#define CPUFREQ_GOV_START	1
#define CPUFREQ_GOV_STOP	2
#define CPUFREQ_GOV_LIMITS	3
#define CPUFREQ_GOV_POLICY_INIT	4
#define CPUFREQ_GOV_POLICY_EXIT	5

struct cpufreq_governor {
	char	name[CPUFREQ_NAME_LEN];
	int	initialized;
	int	(*governor)	(struct cpufreq_policy *policy,
				 unsigned int event);
	ssize_t	(*show_setspeed)	(struct cpufreq_policy *policy,
					 char *buf);
	int	(*store_setspeed)	(struct cpufreq_policy *policy,
					 unsigned int freq);
	unsigned int max_transition_latency; /* HW must be able to switch to
			next freq faster than this value in nano secs or we
			will fallback to performance governor */
	struct list_head	governor_list;
	struct module		*owner;
};

/* Pass a target to the cpufreq driver */
int cpufreq_driver_target(struct cpufreq_policy *policy,
				 unsigned int target_freq,
				 unsigned int relation);
int __cpufreq_driver_target(struct cpufreq_policy *policy,
				   unsigned int target_freq,
				   unsigned int relation);
int cpufreq_register_governor(struct cpufreq_governor *governor);
void cpufreq_unregister_governor(struct cpufreq_governor *governor);

/* CPUFREQ DEFAULT GOVERNOR */
/*
 * Performance governor is fallback governor if any other gov failed to auto
 * load due latency restrictions
 */
#ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
extern struct cpufreq_governor cpufreq_gov_performance;
#endif
#ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
#define CPUFREQ_DEFAULT_GOVERNOR	(&cpufreq_gov_performance)
#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
extern struct cpufreq_governor cpufreq_gov_powersave;
#define CPUFREQ_DEFAULT_GOVERNOR	(&cpufreq_gov_powersave)
#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
extern struct cpufreq_governor cpufreq_gov_userspace;
#define CPUFREQ_DEFAULT_GOVERNOR	(&cpufreq_gov_userspace)
#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
extern struct cpufreq_governor cpufreq_gov_ondemand;
#define CPUFREQ_DEFAULT_GOVERNOR	(&cpufreq_gov_ondemand)
#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
extern struct cpufreq_governor cpufreq_gov_conservative;
#define CPUFREQ_DEFAULT_GOVERNOR	(&cpufreq_gov_conservative)
#endif

/*********************************************************************
 *                     FREQUENCY TABLE HELPERS                       *
 *********************************************************************/

#define CPUFREQ_ENTRY_INVALID ~0
#define CPUFREQ_TABLE_END     ~1

struct cpufreq_frequency_table {
	unsigned int	driver_data; /* driver specific data, not used by core */
	unsigned int	frequency; /* kHz - doesn't need to be in ascending
				    * order */
};

int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
				    struct cpufreq_frequency_table *table);

int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
				   struct cpufreq_frequency_table *table);
int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);

int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
				   struct cpufreq_frequency_table *table,
				   unsigned int target_freq,
				   unsigned int relation,
				   unsigned int *index);
int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
		unsigned int freq);

void cpufreq_frequency_table_update_policy_cpu(struct cpufreq_policy *policy);
ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);

/* the following funtion is for cpufreq core use only */
struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);

/* the following are really really optional */
extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
extern struct freq_attr *cpufreq_generic_attr[];
void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
				      unsigned int cpu);
void cpufreq_frequency_table_put_attr(unsigned int cpu);
int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
				      struct cpufreq_frequency_table *table);

int cpufreq_generic_init(struct cpufreq_policy *policy,
		struct cpufreq_frequency_table *table,
		unsigned int transition_latency);
static inline int cpufreq_generic_exit(struct cpufreq_policy *policy)
{
	cpufreq_frequency_table_put_attr(policy->cpu);
	return 0;
}

#endif /* _LINUX_CPUFREQ_H */
Commit	Line	Data
1da177e4	1	/*
bb176f7d	2	* linux/include/linux/cpufreq.h
1da177e4	3	*
bb176f7d VK	4	* Copyright (C) 2001 Russell King
bb176f7d VK	5	* (C) 2002 - 2003 Dominik Brodowski <linux@brodo.de>
335dc333	6	*
1da177e4 LT	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
5ff0a268 VK	14	#include <linux/cpumask.h>
5ff0a268 VK	15	#include <linux/completion.h>
1da177e4	16	#include <linux/kobject.h>
5ff0a268	17	#include <linux/notifier.h>
1da177e4	18	#include <linux/sysfs.h>
1da177e4	19
1da177e4	20	/*********************************************************************
74aca95d	21	* CPUFREQ INTERFACE *
1da177e4	22	*********************************************************************/
74aca95d VK	23	/*
	24	* Frequency values here are CPU kHz
	25	*
b53cc6ea	26	* Maximum transition latency is in nanoseconds - if it's unknown,
1da177e4 LT	27	* CPUFREQ_ETERNAL shall be used.
	28	*/
	29
74aca95d VK	30	#define CPUFREQ_ETERNAL (-1)
	31	#define CPUFREQ_NAME_LEN 16
	32	/* Print length for names. Extra 1 space for accomodating '\n' in prints */
	33	#define CPUFREQ_NAME_PLEN (CPUFREQ_NAME_LEN + 1)
	34
1da177e4 LT	35	struct cpufreq_governor;
1da177e4 LT	36
74aca95d VK	37	struct cpufreq_freqs {
	38	unsigned int cpu; /* cpu nr */
	39	unsigned int old;
	40	unsigned int new;
	41	u8 flags; /* flags of cpufreq_driver, see below. */
	42	};
8aa84ad8	43
1da177e4 LT	44	struct cpufreq_cpuinfo {
	45	unsigned int max_freq;
	46	unsigned int min_freq;
335dc333 TF	47
	48	/* in 10^(-9) s = nanoseconds */
	49	unsigned int transition_latency;
1da177e4 LT	50	};
	51
	52	struct cpufreq_real_policy {
	53	unsigned int min; /* in kHz */
	54	unsigned int max; /* in kHz */
335dc333	55	unsigned int policy; /* see above */
1da177e4 LT	56	struct cpufreq_governor governor; / see below */
	57	};
	58
	59	struct cpufreq_policy {
951fc5f4 VK	60	/* CPUs sharing clock, require sw coordination */
	61	cpumask_var_t cpus; /* Online CPUs only */
	62	cpumask_var_t related_cpus; /* Online + Offline CPUs */
	63
62b36cc1	64	unsigned int shared_type; /* ACPI: ANY or ALL affected CPUs
3b2d9942	65	should set cpufreq */
b8eed8af VK	66	unsigned int cpu; /* cpu nr of CPU managing this policy */
	67	unsigned int last_cpu; /* cpu nr of previous CPU that managed
	68	* this policy */
1da177e4 LT	69	struct cpufreq_cpuinfo cpuinfo;/* see above */
	70
	71	unsigned int min; /* in kHz */
	72	unsigned int max; /* in kHz */
	73	unsigned int cur; /* in kHz, only needed if cpufreq
	74	* governors are used */
335dc333	75	unsigned int policy; /* see above */
1da177e4	76	struct cpufreq_governor governor; / see below */
7bd353a9	77	void *governor_data;
95731ebb	78	bool governor_enabled; /* governor start/stop flag */
1da177e4	79
1da177e4 LT	80	struct work_struct update; /* if update_policy() needs to be
	81	* called, but you're in IRQ context */
	82
	83	struct cpufreq_real_policy user_policy;
	84
c88a1f8b	85	struct list_head policy_list;
1da177e4 LT	86	struct kobject kobj;
1da177e4 LT	87	struct completion kobj_unregister;
ad7722da	88
	89	/*
	90	* The rules for this semaphore:
	91	* - Any routine that wants to read from the policy structure will
	92	* do a down_read on this semaphore.
	93	* - Any routine that will write to the policy structure and/or may take away
	94	* the policy altogether (eg. CPU hotplug), will hold this lock in write
	95	* mode before doing so.
	96	*
	97	* Additional rules:
	98	* - Lock should not be held across
	99	* __cpufreq_governor(data, CPUFREQ_GOV_POLICY_EXIT);
	100	*/
	101	struct rw_semaphore rwsem;
1da177e4 LT	102	};
1da177e4 LT	103
62b36cc1	104	/* Only for ACPI */
46f18e3a VP	105	#define CPUFREQ_SHARED_TYPE_NONE (0) /* None */
	106	#define CPUFREQ_SHARED_TYPE_HW (1) /* HW does needed coordination */
	107	#define CPUFREQ_SHARED_TYPE_ALL (2) /* All dependent CPUs should set freq */
	108	#define CPUFREQ_SHARED_TYPE_ANY (3) /* Freq can be set from any dependent CPU*/
1da177e4	109
c75b505d	110	#ifdef CONFIG_CPU_FREQ
74aca95d	111	struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
3a3e9e06	112	void cpufreq_cpu_put(struct cpufreq_policy *policy);
c75b505d DV	113	#else
	114	static inline struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu)
	115	{
	116	return NULL;
	117	}
	118	static inline void cpufreq_cpu_put(struct cpufreq_policy *policy) { }
	119	#endif
74aca95d	120
2624f90c FB	121	static inline bool policy_is_shared(struct cpufreq_policy *policy)
	122	{
	123	return cpumask_weight(policy->cpus) > 1;
	124	}
	125
74aca95d VK	126	/* /sys/devices/system/cpu/cpufreq: entry point for global variables */
	127	extern struct kobject *cpufreq_global_kobject;
	128	int cpufreq_get_global_kobject(void);
	129	void cpufreq_put_global_kobject(void);
	130	int cpufreq_sysfs_create_file(const struct attribute *attr);
	131	void cpufreq_sysfs_remove_file(const struct attribute *attr);
1da177e4	132
74aca95d VK	133	#ifdef CONFIG_CPU_FREQ
	134	unsigned int cpufreq_get(unsigned int cpu);
	135	unsigned int cpufreq_quick_get(unsigned int cpu);
	136	unsigned int cpufreq_quick_get_max(unsigned int cpu);
	137	void disable_cpufreq(void);
1da177e4	138
74aca95d VK	139	u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
	140	int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
	141	int cpufreq_update_policy(unsigned int cpu);
	142	bool have_governor_per_policy(void);
	143	struct kobject get_governor_parent_kobj(struct cpufreq_policy policy);
	144	#else
	145	static inline unsigned int cpufreq_get(unsigned int cpu)
1da177e4	146	{
74aca95d VK	147	return 0;
	148	}
	149	static inline unsigned int cpufreq_quick_get(unsigned int cpu)
	150	{
	151	return 0;
	152	}
	153	static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
	154	{
	155	return 0;
	156	}
	157	static inline void disable_cpufreq(void) { }
1da177e4	158	#endif
1da177e4 LT	159
1da177e4 LT	160	/*********************************************************************
74aca95d	161	* CPUFREQ DRIVER INTERFACE *
1da177e4 LT	162	*********************************************************************/
1da177e4 LT	163
74aca95d VK	164	#define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
74aca95d VK	165	#define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
1da177e4	166
74aca95d VK	167	struct freq_attr {
	168	struct attribute attr;
	169	ssize_t (show)(struct cpufreq_policy , char *);
	170	ssize_t (store)(struct cpufreq_policy , const char *, size_t count);
1da177e4 LT	171	};
1da177e4 LT	172
74aca95d VK	173	#define cpufreq_freq_attr_ro(_name) \
	174	static struct freq_attr _name = \
	175	__ATTR(_name, 0444, show_##_name, NULL)
1da177e4	176
74aca95d VK	177	#define cpufreq_freq_attr_ro_perm(_name, _perm) \
	178	static struct freq_attr _name = \
	179	__ATTR(_name, _perm, show_##_name, NULL)
1da177e4	180
74aca95d VK	181	#define cpufreq_freq_attr_rw(_name) \
	182	static struct freq_attr _name = \
	183	__ATTR(_name, 0644, show_##_name, store_##_name)
	184
	185	struct global_attr {
	186	struct attribute attr;
	187	ssize_t (show)(struct kobject kobj,
	188	struct attribute attr, char buf);
	189	ssize_t (store)(struct kobject a, struct attribute *b,
	190	const char *c, size_t count);
	191	};
	192
	193	#define define_one_global_ro(_name) \
	194	static struct global_attr _name = \
	195	__ATTR(_name, 0444, show_##_name, NULL)
	196
	197	#define define_one_global_rw(_name) \
	198	static struct global_attr _name = \
	199	__ATTR(_name, 0644, show_##_name, store_##_name)
1da177e4	200
1da177e4 LT	201
1da177e4 LT	202	struct cpufreq_driver {
1da177e4 LT	203	char name[CPUFREQ_NAME_LEN];
	204	u8 flags;
	205
	206	/* needed by all drivers */
	207	int (init) (struct cpufreq_policy policy);
	208	int (verify) (struct cpufreq_policy policy);
	209
	210	/* define one out of two */
	211	int (setpolicy) (struct cpufreq_policy policy);
9c0ebcf7	212	int (target) (struct cpufreq_policy policy, /* Deprecated */
1da177e4 LT	213	unsigned int target_freq,
1da177e4 LT	214	unsigned int relation);
9c0ebcf7 VK	215	int (target_index) (struct cpufreq_policy policy,
9c0ebcf7 VK	216	unsigned int index);
1da177e4 LT	217
	218	/* should be defined, if possible */
	219	unsigned int (*get) (unsigned int cpu);
	220
	221	/* optional */
e2f74f35	222	int (bios_limit) (int cpu, unsigned int limit);
bf0b90e3	223
1da177e4	224	int (exit) (struct cpufreq_policy policy);
7ca64e2d	225	int (suspend) (struct cpufreq_policy policy);
1da177e4 LT	226	int (resume) (struct cpufreq_policy policy);
	227	struct freq_attr **attr;
	228	};
	229
	230	/* flags */
6461f018 VK	231	#define CPUFREQ_STICKY (1 << 0) /* driver isn't removed even if
	232	all ->init() calls failed */
	233	#define CPUFREQ_CONST_LOOPS (1 << 1) /* loops_per_jiffy or other
	234	kernel "constants" aren't
	235	affected by frequency
	236	transitions */
	237	#define CPUFREQ_PM_NO_WARN (1 << 2) /* don't warn on suspend/resume
	238	speed mismatches */
1da177e4	239
0b981e70 VK	240	/*
	241	* This should be set by platforms having multiple clock-domains, i.e.
	242	* supporting multiple policies. With this sysfs directories of governor would
	243	* be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
	244	* governor with different tunables for different clusters.
	245	*/
	246	#define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
	247
7dbf694d VK	248	/*
	249	* Driver will do POSTCHANGE notifications from outside of their ->target()
	250	* routine and so must set cpufreq_driver->flags with this flag, so that core
	251	* can handle them specially.
	252	*/
	253	#define CPUFREQ_ASYNC_NOTIFICATION (1 << 4)
	254
ae6b4271 VK	255	/*
	256	* Set by drivers which want cpufreq core to check if CPU is running at a
	257	* frequency present in freq-table exposed by the driver. For these drivers if
	258	* CPU is found running at an out of table freq, we will try to set it to a freq
	259	* from the table. And if that fails, we will stop further boot process by
	260	* issuing a BUG_ON().
	261	*/
	262	#define CPUFREQ_NEED_INITIAL_FREQ_CHECK (1 << 5)
	263
221dee28 LT	264	int cpufreq_register_driver(struct cpufreq_driver *driver_data);
221dee28 LT	265	int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
1da177e4	266
74aca95d	267	const char *cpufreq_get_current_driver(void);
1da177e4	268
bb176f7d VK	269	static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
bb176f7d VK	270	unsigned int min, unsigned int max)
1da177e4 LT	271	{
	272	if (policy->min < min)
	273	policy->min = min;
	274	if (policy->max < min)
	275	policy->max = min;
	276	if (policy->min > max)
	277	policy->min = max;
	278	if (policy->max > max)
	279	policy->max = max;
	280	if (policy->min > policy->max)
	281	policy->min = policy->max;
	282	return;
	283	}
	284
be49e346 VK	285	static inline void
	286	cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
	287	{
	288	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
	289	policy->cpuinfo.max_freq);
	290	}
	291
74aca95d VK	292	/*********************************************************************
	293	* CPUFREQ NOTIFIER INTERFACE *
	294	*********************************************************************/
6dad2a29	295
74aca95d VK	296	#define CPUFREQ_TRANSITION_NOTIFIER (0)
74aca95d VK	297	#define CPUFREQ_POLICY_NOTIFIER (1)
1da177e4	298
74aca95d VK	299	/* Transition notifiers */
	300	#define CPUFREQ_PRECHANGE (0)
	301	#define CPUFREQ_POSTCHANGE (1)
	302	#define CPUFREQ_RESUMECHANGE (8)
	303	#define CPUFREQ_SUSPENDCHANGE (9)
6dad2a29	304
74aca95d VK	305	/* Policy Notifiers */
	306	#define CPUFREQ_ADJUST (0)
	307	#define CPUFREQ_INCOMPATIBLE (1)
	308	#define CPUFREQ_NOTIFY (2)
	309	#define CPUFREQ_START (3)
	310	#define CPUFREQ_UPDATE_POLICY_CPU (4)
fcd7af91 VK	311	#define CPUFREQ_CREATE_POLICY (5)
fcd7af91 VK	312	#define CPUFREQ_REMOVE_POLICY (6)
6dad2a29	313
74aca95d VK	314	#ifdef CONFIG_CPU_FREQ
	315	int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
	316	int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
6dad2a29	317
74aca95d VK	318	void cpufreq_notify_transition(struct cpufreq_policy *policy,
74aca95d VK	319	struct cpufreq_freqs *freqs, unsigned int state);
f7ba3b41 VK	320	void cpufreq_notify_post_transition(struct cpufreq_policy *policy,
f7ba3b41 VK	321	struct cpufreq_freqs *freqs, int transition_failed);
1da177e4	322
74aca95d VK	323	#else /* CONFIG_CPU_FREQ */
	324	static inline int cpufreq_register_notifier(struct notifier_block *nb,
	325	unsigned int list)
2eca40a8 RD	326	{
	327	return 0;
	328	}
74aca95d VK	329	static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
74aca95d VK	330	unsigned int list)
95235ca2 VP	331	{
	332	return 0;
	333	}
74aca95d VK	334	#endif /* !CONFIG_CPU_FREQ */
	335
	336	/**
	337	* cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
	338	* safe)
	339	* @old: old value
	340	* @div: divisor
	341	* @mult: multiplier
	342	*
	343	*
	344	* new = old * mult / div
	345	*/
	346	static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
	347	u_int mult)
3d737108	348	{
74aca95d VK	349	#if BITS_PER_LONG == 32
	350	u64 result = ((u64) old) * ((u64) mult);
	351	do_div(result, div);
	352	return (unsigned long) result;
	353
	354	#elif BITS_PER_LONG == 64
	355	unsigned long result = old * ((u64) mult);
	356	result /= div;
	357	return result;
95235ca2	358	#endif
74aca95d	359	}
95235ca2	360
1da177e4	361	/*********************************************************************
74aca95d	362	* CPUFREQ GOVERNORS *
1da177e4 LT	363	*********************************************************************/
1da177e4 LT	364
74aca95d VK	365	/*
	366	* If (cpufreq_driver->target) exists, the ->governor decides what frequency
	367	* within the limits is used. If (cpufreq_driver->setpolicy> exists, these
	368	* two generic policies are available:
	369	*/
	370	#define CPUFREQ_POLICY_POWERSAVE (1)
	371	#define CPUFREQ_POLICY_PERFORMANCE (2)
	372
	373	/* Governor Events */
	374	#define CPUFREQ_GOV_START 1
	375	#define CPUFREQ_GOV_STOP 2
	376	#define CPUFREQ_GOV_LIMITS 3
	377	#define CPUFREQ_GOV_POLICY_INIT 4
	378	#define CPUFREQ_GOV_POLICY_EXIT 5
	379
	380	struct cpufreq_governor {
	381	char name[CPUFREQ_NAME_LEN];
	382	int initialized;
	383	int (governor) (struct cpufreq_policy policy,
	384	unsigned int event);
	385	ssize_t (show_setspeed) (struct cpufreq_policy policy,
	386	char *buf);
	387	int (store_setspeed) (struct cpufreq_policy policy,
	388	unsigned int freq);
	389	unsigned int max_transition_latency; /* HW must be able to switch to
	390	next freq faster than this value in nano secs or we
	391	will fallback to performance governor */
	392	struct list_head governor_list;
	393	struct module *owner;
	394	};
	395
	396	/* Pass a target to the cpufreq driver */
	397	int cpufreq_driver_target(struct cpufreq_policy *policy,
	398	unsigned int target_freq,
	399	unsigned int relation);
	400	int __cpufreq_driver_target(struct cpufreq_policy *policy,
	401	unsigned int target_freq,
	402	unsigned int relation);
	403	int cpufreq_register_governor(struct cpufreq_governor *governor);
	404	void cpufreq_unregister_governor(struct cpufreq_governor *governor);
	405
	406	/* CPUFREQ DEFAULT GOVERNOR */
1c256245	407	/*
bb176f7d VK	408	* Performance governor is fallback governor if any other gov failed to auto
	409	* load due latency restrictions
	410	*/
6afde10c	411	#ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
1da177e4	412	extern struct cpufreq_governor cpufreq_gov_performance;
6afde10c	413	#endif
1c256245 TR	414	#ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
1c256245 TR	415	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_performance)
30d221db AG	416	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
	417	extern struct cpufreq_governor cpufreq_gov_powersave;
	418	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_powersave)
1da177e4 LT	419	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
1da177e4 LT	420	extern struct cpufreq_governor cpufreq_gov_userspace;
1c256245 TR	421	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_userspace)
	422	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
	423	extern struct cpufreq_governor cpufreq_gov_ondemand;
	424	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_ondemand)
	425	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
	426	extern struct cpufreq_governor cpufreq_gov_conservative;
	427	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_conservative)
1da177e4 LT	428	#endif
1da177e4 LT	429
1da177e4 LT	430	/*********************************************************************
	431	* FREQUENCY TABLE HELPERS *
	432	*********************************************************************/
	433
	434	#define CPUFREQ_ENTRY_INVALID ~0
	435	#define CPUFREQ_TABLE_END ~1
	436
	437	struct cpufreq_frequency_table {
50701588	438	unsigned int driver_data; /* driver specific data, not used by core */
1da177e4 LT	439	unsigned int frequency; /* kHz - doesn't need to be in ascending
	440	* order */
	441	};
	442
	443	int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
	444	struct cpufreq_frequency_table *table);
	445
	446	int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
	447	struct cpufreq_frequency_table *table);
18434512	448	int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
1da177e4 LT	449
	450	int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
	451	struct cpufreq_frequency_table *table,
	452	unsigned int target_freq,
	453	unsigned int relation,
	454	unsigned int *index);
d3916691 VK	455	int cpufreq_frequency_table_get_index(struct cpufreq_policy *policy,
d3916691 VK	456	unsigned int freq);
1da177e4	457
74aca95d VK	458	void cpufreq_frequency_table_update_policy_cpu(struct cpufreq_policy *policy);
	459	ssize_t cpufreq_show_cpus(const struct cpumask mask, char buf);
	460
	461	/* the following funtion is for cpufreq core use only */
1da177e4	462	struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
1da177e4 LT	463
	464	/* the following are really really optional */
	465	extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
18434512	466	extern struct freq_attr *cpufreq_generic_attr[];
335dc333	467	void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
1da177e4	468	unsigned int cpu);
1da177e4	469	void cpufreq_frequency_table_put_attr(unsigned int cpu);
27047a60 VK	470	int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
27047a60 VK	471	struct cpufreq_frequency_table *table);
f4fd3797	472
70e9e778 VK	473	int cpufreq_generic_init(struct cpufreq_policy *policy,
	474	struct cpufreq_frequency_table *table,
	475	unsigned int transition_latency);
18434512 VK	476	static inline int cpufreq_generic_exit(struct cpufreq_policy *policy)
	477	{
	478	cpufreq_frequency_table_put_attr(policy->cpu);
	479	return 0;
	480	}
	481
1da177e4	482	#endif /* _LINUX_CPUFREQ_H */