[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/clk.h>
#include <linux/cpumask.h>
#include <linux/completion.h>
#include <linux/kobject.h>
#include <linux/notifier.h>
#include <linux/spinlock.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 clk		*clk;
	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		suspend_freq; /* freq to set during suspend */

	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 cpufreq_frequency_table	*freq_table;

	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;

	/* Synchronization for frequency transitions */
	bool			transition_ongoing; /* Tracks transition status */
	spinlock_t		transition_lock;
	wait_queue_head_t	transition_wait;
};

/* 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);
	void	(*stop_cpu)	(struct cpufreq_policy *policy);
	int	(*suspend)	(struct cpufreq_policy *policy);
	int	(*resume)	(struct cpufreq_policy *policy);
	struct freq_attr	**attr;

	/* platform specific boost support code */
	bool                    boost_supported;
	bool                    boost_enabled;
	int     (*set_boost)    (int state);
};

/* 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);
}

#ifdef CONFIG_CPU_FREQ
void cpufreq_suspend(void);
void cpufreq_resume(void);
int cpufreq_generic_suspend(struct cpufreq_policy *policy);
#else
static inline void cpufreq_suspend(void) {}
static inline void cpufreq_resume(void) {}
#endif

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

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

/* Transition notifiers */
#define CPUFREQ_PRECHANGE		(0)
#define CPUFREQ_POSTCHANGE		(1)

/* 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_freq_transition_begin(struct cpufreq_policy *policy,
		struct cpufreq_freqs *freqs);
void cpufreq_freq_transition_end(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                       *
 *********************************************************************/

/* Special Values of .frequency field */
#define CPUFREQ_ENTRY_INVALID	~0
#define CPUFREQ_TABLE_END	~1
/* Special Values of .flags field */
#define CPUFREQ_BOOST_FREQ	(1 << 0)

struct cpufreq_frequency_table {
	unsigned int	flags;
	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);

ssize_t cpufreq_show_cpus(const struct cpumask *mask, char *buf);

#ifdef CONFIG_CPU_FREQ
int cpufreq_boost_trigger_state(int state);
int cpufreq_boost_supported(void);
int cpufreq_boost_enabled(void);
#else
static inline int cpufreq_boost_trigger_state(int state)
{
	return 0;
}
static inline int cpufreq_boost_supported(void)
{
	return 0;
}
static inline int cpufreq_boost_enabled(void)
{
	return 0;
}
#endif
/* 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[];
int cpufreq_table_validate_and_show(struct cpufreq_policy *policy,
				      struct cpufreq_frequency_table *table);

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