[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*/

struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
void cpufreq_cpu_put(struct cpufreq_policy *policy);

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)

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)

#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);

#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);

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
74aca95d	110	struct cpufreq_policy *cpufreq_cpu_get(unsigned int cpu);
3a3e9e06	111	void cpufreq_cpu_put(struct cpufreq_policy *policy);
74aca95d	112
2624f90c FB	113	static inline bool policy_is_shared(struct cpufreq_policy *policy)
	114	{
	115	return cpumask_weight(policy->cpus) > 1;
	116	}
	117
74aca95d VK	118	/* /sys/devices/system/cpu/cpufreq: entry point for global variables */
	119	extern struct kobject *cpufreq_global_kobject;
	120	int cpufreq_get_global_kobject(void);
	121	void cpufreq_put_global_kobject(void);
	122	int cpufreq_sysfs_create_file(const struct attribute *attr);
	123	void cpufreq_sysfs_remove_file(const struct attribute *attr);
1da177e4	124
74aca95d VK	125	#ifdef CONFIG_CPU_FREQ
	126	unsigned int cpufreq_get(unsigned int cpu);
	127	unsigned int cpufreq_quick_get(unsigned int cpu);
	128	unsigned int cpufreq_quick_get_max(unsigned int cpu);
	129	void disable_cpufreq(void);
1da177e4	130
74aca95d VK	131	u64 get_cpu_idle_time(unsigned int cpu, u64 *wall, int io_busy);
	132	int cpufreq_get_policy(struct cpufreq_policy *policy, unsigned int cpu);
	133	int cpufreq_update_policy(unsigned int cpu);
	134	bool have_governor_per_policy(void);
	135	struct kobject get_governor_parent_kobj(struct cpufreq_policy policy);
	136	#else
	137	static inline unsigned int cpufreq_get(unsigned int cpu)
1da177e4	138	{
74aca95d VK	139	return 0;
	140	}
	141	static inline unsigned int cpufreq_quick_get(unsigned int cpu)
	142	{
	143	return 0;
	144	}
	145	static inline unsigned int cpufreq_quick_get_max(unsigned int cpu)
	146	{
	147	return 0;
	148	}
	149	static inline void disable_cpufreq(void) { }
1da177e4	150	#endif
1da177e4 LT	151
1da177e4 LT	152	/*********************************************************************
74aca95d	153	* CPUFREQ DRIVER INTERFACE *
1da177e4 LT	154	*********************************************************************/
1da177e4 LT	155
74aca95d VK	156	#define CPUFREQ_RELATION_L 0 /* lowest frequency at or above target */
74aca95d VK	157	#define CPUFREQ_RELATION_H 1 /* highest frequency below or at target */
1da177e4	158
74aca95d VK	159	struct freq_attr {
	160	struct attribute attr;
	161	ssize_t (show)(struct cpufreq_policy , char *);
	162	ssize_t (store)(struct cpufreq_policy , const char *, size_t count);
1da177e4 LT	163	};
1da177e4 LT	164
74aca95d VK	165	#define cpufreq_freq_attr_ro(_name) \
	166	static struct freq_attr _name = \
	167	__ATTR(_name, 0444, show_##_name, NULL)
1da177e4	168
74aca95d VK	169	#define cpufreq_freq_attr_ro_perm(_name, _perm) \
	170	static struct freq_attr _name = \
	171	__ATTR(_name, _perm, show_##_name, NULL)
1da177e4	172
74aca95d VK	173	#define cpufreq_freq_attr_rw(_name) \
	174	static struct freq_attr _name = \
	175	__ATTR(_name, 0644, show_##_name, store_##_name)
	176
	177	struct global_attr {
	178	struct attribute attr;
	179	ssize_t (show)(struct kobject kobj,
	180	struct attribute attr, char buf);
	181	ssize_t (store)(struct kobject a, struct attribute *b,
	182	const char *c, size_t count);
	183	};
	184
	185	#define define_one_global_ro(_name) \
	186	static struct global_attr _name = \
	187	__ATTR(_name, 0444, show_##_name, NULL)
	188
	189	#define define_one_global_rw(_name) \
	190	static struct global_attr _name = \
	191	__ATTR(_name, 0644, show_##_name, store_##_name)
1da177e4	192
1da177e4 LT	193
1da177e4 LT	194	struct cpufreq_driver {
1da177e4 LT	195	char name[CPUFREQ_NAME_LEN];
	196	u8 flags;
	197
	198	/* needed by all drivers */
	199	int (init) (struct cpufreq_policy policy);
	200	int (verify) (struct cpufreq_policy policy);
	201
	202	/* define one out of two */
	203	int (setpolicy) (struct cpufreq_policy policy);
9c0ebcf7	204	int (target) (struct cpufreq_policy policy, /* Deprecated */
1da177e4 LT	205	unsigned int target_freq,
1da177e4 LT	206	unsigned int relation);
9c0ebcf7 VK	207	int (target_index) (struct cpufreq_policy policy,
9c0ebcf7 VK	208	unsigned int index);
1da177e4 LT	209
	210	/* should be defined, if possible */
	211	unsigned int (*get) (unsigned int cpu);
	212
	213	/* optional */
e2f74f35	214	int (bios_limit) (int cpu, unsigned int limit);
bf0b90e3	215
1da177e4	216	int (exit) (struct cpufreq_policy policy);
7ca64e2d	217	int (suspend) (struct cpufreq_policy policy);
1da177e4 LT	218	int (resume) (struct cpufreq_policy policy);
	219	struct freq_attr **attr;
	220	};
	221
	222	/* flags */
6461f018 VK	223	#define CPUFREQ_STICKY (1 << 0) /* driver isn't removed even if
	224	all ->init() calls failed */
	225	#define CPUFREQ_CONST_LOOPS (1 << 1) /* loops_per_jiffy or other
	226	kernel "constants" aren't
	227	affected by frequency
	228	transitions */
	229	#define CPUFREQ_PM_NO_WARN (1 << 2) /* don't warn on suspend/resume
	230	speed mismatches */
1da177e4	231
0b981e70 VK	232	/*
	233	* This should be set by platforms having multiple clock-domains, i.e.
	234	* supporting multiple policies. With this sysfs directories of governor would
	235	* be created in cpu/cpu<num>/cpufreq/ directory and so they can use the same
	236	* governor with different tunables for different clusters.
	237	*/
	238	#define CPUFREQ_HAVE_GOVERNOR_PER_POLICY (1 << 3)
	239
221dee28 LT	240	int cpufreq_register_driver(struct cpufreq_driver *driver_data);
221dee28 LT	241	int cpufreq_unregister_driver(struct cpufreq_driver *driver_data);
1da177e4	242
74aca95d	243	const char *cpufreq_get_current_driver(void);
1da177e4	244
bb176f7d VK	245	static inline void cpufreq_verify_within_limits(struct cpufreq_policy *policy,
bb176f7d VK	246	unsigned int min, unsigned int max)
1da177e4 LT	247	{
	248	if (policy->min < min)
	249	policy->min = min;
	250	if (policy->max < min)
	251	policy->max = min;
	252	if (policy->min > max)
	253	policy->min = max;
	254	if (policy->max > max)
	255	policy->max = max;
	256	if (policy->min > policy->max)
	257	policy->min = policy->max;
	258	return;
	259	}
	260
be49e346 VK	261	static inline void
	262	cpufreq_verify_within_cpu_limits(struct cpufreq_policy *policy)
	263	{
	264	cpufreq_verify_within_limits(policy, policy->cpuinfo.min_freq,
	265	policy->cpuinfo.max_freq);
	266	}
	267
74aca95d VK	268	/*********************************************************************
	269	* CPUFREQ NOTIFIER INTERFACE *
	270	*********************************************************************/
6dad2a29	271
74aca95d VK	272	#define CPUFREQ_TRANSITION_NOTIFIER (0)
74aca95d VK	273	#define CPUFREQ_POLICY_NOTIFIER (1)
1da177e4	274
74aca95d VK	275	/* Transition notifiers */
	276	#define CPUFREQ_PRECHANGE (0)
	277	#define CPUFREQ_POSTCHANGE (1)
	278	#define CPUFREQ_RESUMECHANGE (8)
	279	#define CPUFREQ_SUSPENDCHANGE (9)
6dad2a29	280
74aca95d VK	281	/* Policy Notifiers */
	282	#define CPUFREQ_ADJUST (0)
	283	#define CPUFREQ_INCOMPATIBLE (1)
	284	#define CPUFREQ_NOTIFY (2)
	285	#define CPUFREQ_START (3)
	286	#define CPUFREQ_UPDATE_POLICY_CPU (4)
6dad2a29	287
74aca95d VK	288	#ifdef CONFIG_CPU_FREQ
	289	int cpufreq_register_notifier(struct notifier_block *nb, unsigned int list);
	290	int cpufreq_unregister_notifier(struct notifier_block *nb, unsigned int list);
6dad2a29	291
74aca95d VK	292	void cpufreq_notify_transition(struct cpufreq_policy *policy,
74aca95d VK	293	struct cpufreq_freqs *freqs, unsigned int state);
1da177e4	294
74aca95d VK	295	#else /* CONFIG_CPU_FREQ */
	296	static inline int cpufreq_register_notifier(struct notifier_block *nb,
	297	unsigned int list)
2eca40a8 RD	298	{
	299	return 0;
	300	}
74aca95d VK	301	static inline int cpufreq_unregister_notifier(struct notifier_block *nb,
74aca95d VK	302	unsigned int list)
95235ca2 VP	303	{
	304	return 0;
	305	}
74aca95d VK	306	#endif /* !CONFIG_CPU_FREQ */
	307
	308	/**
	309	* cpufreq_scale - "old * mult / div" calculation for large values (32-bit-arch
	310	* safe)
	311	* @old: old value
	312	* @div: divisor
	313	* @mult: multiplier
	314	*
	315	*
	316	* new = old * mult / div
	317	*/
	318	static inline unsigned long cpufreq_scale(unsigned long old, u_int div,
	319	u_int mult)
3d737108	320	{
74aca95d VK	321	#if BITS_PER_LONG == 32
	322	u64 result = ((u64) old) * ((u64) mult);
	323	do_div(result, div);
	324	return (unsigned long) result;
	325
	326	#elif BITS_PER_LONG == 64
	327	unsigned long result = old * ((u64) mult);
	328	result /= div;
	329	return result;
95235ca2	330	#endif
74aca95d	331	}
95235ca2	332
1da177e4	333	/*********************************************************************
74aca95d	334	* CPUFREQ GOVERNORS *
1da177e4 LT	335	*********************************************************************/
1da177e4 LT	336
74aca95d VK	337	/*
	338	* If (cpufreq_driver->target) exists, the ->governor decides what frequency
	339	* within the limits is used. If (cpufreq_driver->setpolicy> exists, these
	340	* two generic policies are available:
	341	*/
	342	#define CPUFREQ_POLICY_POWERSAVE (1)
	343	#define CPUFREQ_POLICY_PERFORMANCE (2)
	344
	345	/* Governor Events */
	346	#define CPUFREQ_GOV_START 1
	347	#define CPUFREQ_GOV_STOP 2
	348	#define CPUFREQ_GOV_LIMITS 3
	349	#define CPUFREQ_GOV_POLICY_INIT 4
	350	#define CPUFREQ_GOV_POLICY_EXIT 5
	351
	352	struct cpufreq_governor {
	353	char name[CPUFREQ_NAME_LEN];
	354	int initialized;
	355	int (governor) (struct cpufreq_policy policy,
	356	unsigned int event);
	357	ssize_t (show_setspeed) (struct cpufreq_policy policy,
	358	char *buf);
	359	int (store_setspeed) (struct cpufreq_policy policy,
	360	unsigned int freq);
	361	unsigned int max_transition_latency; /* HW must be able to switch to
	362	next freq faster than this value in nano secs or we
	363	will fallback to performance governor */
	364	struct list_head governor_list;
	365	struct module *owner;
	366	};
	367
	368	/* Pass a target to the cpufreq driver */
	369	int cpufreq_driver_target(struct cpufreq_policy *policy,
	370	unsigned int target_freq,
	371	unsigned int relation);
	372	int __cpufreq_driver_target(struct cpufreq_policy *policy,
	373	unsigned int target_freq,
	374	unsigned int relation);
	375	int cpufreq_register_governor(struct cpufreq_governor *governor);
	376	void cpufreq_unregister_governor(struct cpufreq_governor *governor);
	377
	378	/* CPUFREQ DEFAULT GOVERNOR */
1c256245	379	/*
bb176f7d VK	380	* Performance governor is fallback governor if any other gov failed to auto
	381	* load due latency restrictions
	382	*/
6afde10c	383	#ifdef CONFIG_CPU_FREQ_GOV_PERFORMANCE
1da177e4	384	extern struct cpufreq_governor cpufreq_gov_performance;
6afde10c	385	#endif
1c256245 TR	386	#ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_PERFORMANCE
1c256245 TR	387	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_performance)
30d221db AG	388	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_POWERSAVE)
	389	extern struct cpufreq_governor cpufreq_gov_powersave;
	390	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_powersave)
1da177e4 LT	391	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_USERSPACE)
1da177e4 LT	392	extern struct cpufreq_governor cpufreq_gov_userspace;
1c256245 TR	393	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_userspace)
	394	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_ONDEMAND)
	395	extern struct cpufreq_governor cpufreq_gov_ondemand;
	396	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_ondemand)
	397	#elif defined(CONFIG_CPU_FREQ_DEFAULT_GOV_CONSERVATIVE)
	398	extern struct cpufreq_governor cpufreq_gov_conservative;
	399	#define CPUFREQ_DEFAULT_GOVERNOR (&cpufreq_gov_conservative)
1da177e4 LT	400	#endif
1da177e4 LT	401
1da177e4 LT	402	/*********************************************************************
	403	* FREQUENCY TABLE HELPERS *
	404	*********************************************************************/
	405
	406	#define CPUFREQ_ENTRY_INVALID ~0
	407	#define CPUFREQ_TABLE_END ~1
	408
	409	struct cpufreq_frequency_table {
50701588	410	unsigned int driver_data; /* driver specific data, not used by core */
1da177e4 LT	411	unsigned int frequency; /* kHz - doesn't need to be in ascending
	412	* order */
	413	};
	414
	415	int cpufreq_frequency_table_cpuinfo(struct cpufreq_policy *policy,
	416	struct cpufreq_frequency_table *table);
	417
	418	int cpufreq_frequency_table_verify(struct cpufreq_policy *policy,
	419	struct cpufreq_frequency_table *table);
18434512	420	int cpufreq_generic_frequency_table_verify(struct cpufreq_policy *policy);
1da177e4 LT	421
	422	int cpufreq_frequency_table_target(struct cpufreq_policy *policy,
	423	struct cpufreq_frequency_table *table,
	424	unsigned int target_freq,
	425	unsigned int relation,
	426	unsigned int *index);
	427
74aca95d VK	428	void cpufreq_frequency_table_update_policy_cpu(struct cpufreq_policy *policy);
	429	ssize_t cpufreq_show_cpus(const struct cpumask mask, char buf);
	430
	431	/* the following funtion is for cpufreq core use only */
1da177e4	432	struct cpufreq_frequency_table *cpufreq_frequency_get_table(unsigned int cpu);
1da177e4 LT	433
	434	/* the following are really really optional */
	435	extern struct freq_attr cpufreq_freq_attr_scaling_available_freqs;
18434512	436	extern struct freq_attr *cpufreq_generic_attr[];
335dc333	437	void cpufreq_frequency_table_get_attr(struct cpufreq_frequency_table *table,
1da177e4	438	unsigned int cpu);
1da177e4	439	void cpufreq_frequency_table_put_attr(unsigned int cpu);
27047a60 VK	440	int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
27047a60 VK	441	struct cpufreq_frequency_table *table);
f4fd3797	442
70e9e778 VK	443	int cpufreq_generic_init(struct cpufreq_policy *policy,
	444	struct cpufreq_frequency_table *table,
	445	unsigned int transition_latency);
18434512 VK	446	static inline int cpufreq_generic_exit(struct cpufreq_policy *policy)
	447	{
	448	cpufreq_frequency_table_put_attr(policy->cpu);
	449	return 0;
	450	}
	451
1da177e4	452	#endif /* _LINUX_CPUFREQ_H */