[mirror_ubuntu-bionic-kernel.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/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 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;

	/* 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)
#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
#define CPUFREQ_BOOST_FREQ    ~2

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

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

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