[mirror_ubuntu-bionic-kernel.git] / include / linux / cpuidle.h

/*
 * cpuidle.h - a generic framework for CPU idle power management
 *
 * (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
 *          Shaohua Li <shaohua.li@intel.com>
 *          Adam Belay <abelay@novell.com>
 *
 * This code is licenced under the GPL.
 */

#ifndef _LINUX_CPUIDLE_H
#define _LINUX_CPUIDLE_H

#include <linux/percpu.h>
#include <linux/list.h>
#include <linux/kobject.h>
#include <linux/completion.h>
#include <linux/hrtimer.h>

#define CPUIDLE_STATE_MAX	8
#define CPUIDLE_NAME_LEN	16
#define CPUIDLE_DESC_LEN	32

struct module;

struct cpuidle_device;
struct cpuidle_driver;


/****************************
 * CPUIDLE DEVICE INTERFACE *
 ****************************/

struct cpuidle_state_usage {
	void		*driver_data;

	unsigned long long	usage;
	unsigned long long	time; /* in US */
};

struct cpuidle_state {
	char		name[CPUIDLE_NAME_LEN];
	char		desc[CPUIDLE_DESC_LEN];

	unsigned int	flags;
	unsigned int	exit_latency; /* in US */
	int		power_usage; /* in mW */
	unsigned int	target_residency; /* in US */
	unsigned int    disable;

	int (*enter)	(struct cpuidle_device *dev,
			struct cpuidle_driver *drv,
			int index);

	int (*enter_dead) (struct cpuidle_device *dev, int index);
};

/* Idle State Flags */
#define CPUIDLE_FLAG_TIME_VALID	(0x01) /* is residency time measurable? */

#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)

/**
 * cpuidle_get_statedata - retrieves private driver state data
 * @st_usage: the state usage statistics
 */
static inline void *cpuidle_get_statedata(struct cpuidle_state_usage *st_usage)
{
	return st_usage->driver_data;
}

/**
 * cpuidle_set_statedata - stores private driver state data
 * @st_usage: the state usage statistics
 * @data: the private data
 */
static inline void
cpuidle_set_statedata(struct cpuidle_state_usage *st_usage, void *data)
{
	st_usage->driver_data = data;
}

struct cpuidle_state_kobj {
	struct cpuidle_state *state;
	struct cpuidle_state_usage *state_usage;
	struct completion kobj_unregister;
	struct kobject kobj;
};

struct cpuidle_device {
	unsigned int		registered:1;
	unsigned int		enabled:1;
	unsigned int		cpu;

	int			last_residency;
	int			state_count;
	struct cpuidle_state_usage	states_usage[CPUIDLE_STATE_MAX];
	struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];

	struct list_head 	device_list;
	struct kobject		kobj;
	struct completion	kobj_unregister;
};

DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);

/**
 * cpuidle_get_last_residency - retrieves the last state's residency time
 * @dev: the target CPU
 *
 * NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
 */
static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
{
	return dev->last_residency;
}


/****************************
 * CPUIDLE DRIVER INTERFACE *
 ****************************/

struct cpuidle_driver {
	const char		*name;
	struct module 		*owner;

	unsigned int		power_specified:1;
	/* set to 1 to use the core cpuidle time keeping (for all states). */
	unsigned int		en_core_tk_irqen:1;
	struct cpuidle_state	states[CPUIDLE_STATE_MAX];
	int			state_count;
	int			safe_state_index;
};

#ifdef CONFIG_CPU_IDLE
extern void disable_cpuidle(void);
extern int cpuidle_idle_call(void);
extern int cpuidle_register_driver(struct cpuidle_driver *drv);
struct cpuidle_driver *cpuidle_get_driver(void);
extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
extern int cpuidle_register_device(struct cpuidle_device *dev);
extern void cpuidle_unregister_device(struct cpuidle_device *dev);

extern void cpuidle_pause_and_lock(void);
extern void cpuidle_resume_and_unlock(void);
extern int cpuidle_enable_device(struct cpuidle_device *dev);
extern void cpuidle_disable_device(struct cpuidle_device *dev);
extern int cpuidle_wrap_enter(struct cpuidle_device *dev,
				struct cpuidle_driver *drv, int index,
				int (*enter)(struct cpuidle_device *dev,
					struct cpuidle_driver *drv, int index));
extern int cpuidle_play_dead(void);

#else
static inline void disable_cpuidle(void) { }
static inline int cpuidle_idle_call(void) { return -ENODEV; }
static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
{return -ENODEV; }
static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
static inline int cpuidle_register_device(struct cpuidle_device *dev)
{return -ENODEV; }
static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }

static inline void cpuidle_pause_and_lock(void) { }
static inline void cpuidle_resume_and_unlock(void) { }
static inline int cpuidle_enable_device(struct cpuidle_device *dev)
{return -ENODEV; }
static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
static inline int cpuidle_wrap_enter(struct cpuidle_device *dev,
				struct cpuidle_driver *drv, int index,
				int (*enter)(struct cpuidle_device *dev,
					struct cpuidle_driver *drv, int index))
{ return -ENODEV; }
static inline int cpuidle_play_dead(void) {return -ENODEV; }

#endif

/******************************
 * CPUIDLE GOVERNOR INTERFACE *
 ******************************/

struct cpuidle_governor {
	char			name[CPUIDLE_NAME_LEN];
	struct list_head 	governor_list;
	unsigned int		rating;

	int  (*enable)		(struct cpuidle_driver *drv,
					struct cpuidle_device *dev);
	void (*disable)		(struct cpuidle_driver *drv,
					struct cpuidle_device *dev);

	int  (*select)		(struct cpuidle_driver *drv,
					struct cpuidle_device *dev);
	void (*reflect)		(struct cpuidle_device *dev, int index);

	struct module 		*owner;
};

#ifdef CONFIG_CPU_IDLE

extern int cpuidle_register_governor(struct cpuidle_governor *gov);
extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);

#ifdef CONFIG_INTEL_IDLE
extern int intel_idle_cpu_init(int cpu);
#else
static inline int intel_idle_cpu_init(int cpu) { return -1; }
#endif

#else
static inline int intel_idle_cpu_init(int cpu) { return -1; }

static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
{return 0;}
static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }

#endif

#ifdef CONFIG_ARCH_HAS_CPU_RELAX
#define CPUIDLE_DRIVER_STATE_START	1
#else
#define CPUIDLE_DRIVER_STATE_START	0
#endif

#endif /* _LINUX_CPUIDLE_H */
Commit	Line	Data
4f86d3a8 LB	1	/*
	2	* cpuidle.h - a generic framework for CPU idle power management
	3	*
	4	* (C) 2007 Venkatesh Pallipadi <venkatesh.pallipadi@intel.com>
	5	* Shaohua Li <shaohua.li@intel.com>
	6	* Adam Belay <abelay@novell.com>
	7	*
	8	* This code is licenced under the GPL.
	9	*/
	10
	11	#ifndef _LINUX_CPUIDLE_H
	12	#define _LINUX_CPUIDLE_H
	13
	14	#include <linux/percpu.h>
	15	#include <linux/list.h>
4f86d3a8 LB	16	#include <linux/kobject.h>
4f86d3a8 LB	17	#include <linux/completion.h>
e1689795	18	#include <linux/hrtimer.h>
4f86d3a8 LB	19
	20	#define CPUIDLE_STATE_MAX 8
	21	#define CPUIDLE_NAME_LEN 16
4fcb2fcd	22	#define CPUIDLE_DESC_LEN 32
4f86d3a8	23
de477254 PG	24	struct module;
de477254 PG	25
4f86d3a8	26	struct cpuidle_device;
46bcfad7	27	struct cpuidle_driver;
4f86d3a8 LB	28
	29
	30	/****************************
	31	* CPUIDLE DEVICE INTERFACE *
	32	****************************/
	33
4202735e DD	34	struct cpuidle_state_usage {
	35	void *driver_data;
	36
	37	unsigned long long usage;
	38	unsigned long long time; /* in US */
	39	};
	40
4f86d3a8 LB	41	struct cpuidle_state {
4f86d3a8 LB	42	char name[CPUIDLE_NAME_LEN];
4fcb2fcd	43	char desc[CPUIDLE_DESC_LEN];
4f86d3a8 LB	44
	45	unsigned int flags;
	46	unsigned int exit_latency; /* in US */
02401c06	47	int power_usage; /* in mW */
4f86d3a8	48	unsigned int target_residency; /* in US */
3a53396b	49	unsigned int disable;
4f86d3a8	50
4f86d3a8	51	int (enter) (struct cpuidle_device dev,
46bcfad7	52	struct cpuidle_driver *drv,
e978aa7d	53	int index);
1a022e3f BO	54
1a022e3f BO	55	int (enter_dead) (struct cpuidle_device dev, int index);
4f86d3a8 LB	56	};
	57
	58	/* Idle State Flags */
	59	#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
4f86d3a8 LB	60
	61	#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
	62
	63	/**
	64	* cpuidle_get_statedata - retrieves private driver state data
4202735e	65	* @st_usage: the state usage statistics
4f86d3a8	66	*/
4202735e	67	static inline void cpuidle_get_statedata(struct cpuidle_state_usage st_usage)
4f86d3a8	68	{
4202735e	69	return st_usage->driver_data;
4f86d3a8 LB	70	}
	71
	72	/**
	73	* cpuidle_set_statedata - stores private driver state data
4202735e	74	* @st_usage: the state usage statistics
4f86d3a8 LB	75	* @data: the private data
	76	*/
	77	static inline void
4202735e	78	cpuidle_set_statedata(struct cpuidle_state_usage st_usage, void data)
4f86d3a8	79	{
4202735e	80	st_usage->driver_data = data;
4f86d3a8 LB	81	}
	82
	83	struct cpuidle_state_kobj {
	84	struct cpuidle_state *state;
4202735e	85	struct cpuidle_state_usage *state_usage;
4f86d3a8 LB	86	struct completion kobj_unregister;
	87	struct kobject kobj;
	88	};
	89
	90	struct cpuidle_device {
dcb84f33	91	unsigned int registered:1;
b5556a67	92	unsigned int enabled:1;
4f86d3a8 LB	93	unsigned int cpu;
	94
	95	int last_residency;
	96	int state_count;
4202735e	97	struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8	98	struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
4f86d3a8 LB	99
	100	struct list_head device_list;
	101	struct kobject kobj;
	102	struct completion kobj_unregister;
4f86d3a8 LB	103	};
	104
	105	DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
	106
	107	/**
	108	* cpuidle_get_last_residency - retrieves the last state's residency time
	109	* @dev: the target CPU
	110	*
	111	* NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
	112	*/
	113	static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
	114	{
	115	return dev->last_residency;
	116	}
	117
	118
	119	/****************************
	120	* CPUIDLE DRIVER INTERFACE *
	121	****************************/
	122
	123	struct cpuidle_driver {
db70b044	124	const char *name;
4f86d3a8	125	struct module *owner;
46bcfad7 DD	126
46bcfad7 DD	127	unsigned int power_specified:1;
e1689795 RL	128	/* set to 1 to use the core cpuidle time keeping (for all states). */
e1689795 RL	129	unsigned int en_core_tk_irqen:1;
46bcfad7 DD	130	struct cpuidle_state states[CPUIDLE_STATE_MAX];
	131	int state_count;
	132	int safe_state_index;
4f86d3a8 LB	133	};
	134
	135	#ifdef CONFIG_CPU_IDLE
d91ee586	136	extern void disable_cpuidle(void);
a0bfa137	137	extern int cpuidle_idle_call(void);
4f86d3a8	138	extern int cpuidle_register_driver(struct cpuidle_driver *drv);
752138df	139	struct cpuidle_driver *cpuidle_get_driver(void);
4f86d3a8 LB	140	extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
	141	extern int cpuidle_register_device(struct cpuidle_device *dev);
	142	extern void cpuidle_unregister_device(struct cpuidle_device *dev);
	143
	144	extern void cpuidle_pause_and_lock(void);
	145	extern void cpuidle_resume_and_unlock(void);
	146	extern int cpuidle_enable_device(struct cpuidle_device *dev);
	147	extern void cpuidle_disable_device(struct cpuidle_device *dev);
e1689795 RL	148	extern int cpuidle_wrap_enter(struct cpuidle_device *dev,
	149	struct cpuidle_driver *drv, int index,
	150	int (enter)(struct cpuidle_device dev,
	151	struct cpuidle_driver *drv, int index));
1a022e3f BO	152	extern int cpuidle_play_dead(void);
1a022e3f BO	153
4f86d3a8	154	#else
d91ee586	155	static inline void disable_cpuidle(void) { }
a0bfa137	156	static inline int cpuidle_idle_call(void) { return -ENODEV; }
4f86d3a8	157	static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b	158	{return -ENODEV; }
752138df	159	static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
4f86d3a8 LB	160	static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
4f86d3a8 LB	161	static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b	162	{return -ENODEV; }
4f86d3a8 LB	163	static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
	164
	165	static inline void cpuidle_pause_and_lock(void) { }
	166	static inline void cpuidle_resume_and_unlock(void) { }
	167	static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b	168	{return -ENODEV; }
4f86d3a8	169	static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
e1689795 RL	170	static inline int cpuidle_wrap_enter(struct cpuidle_device *dev,
	171	struct cpuidle_driver *drv, int index,
	172	int (enter)(struct cpuidle_device dev,
	173	struct cpuidle_driver *drv, int index))
	174	{ return -ENODEV; }
1a022e3f	175	static inline int cpuidle_play_dead(void) {return -ENODEV; }
4f86d3a8 LB	176
	177	#endif
	178
	179	/******************************
	180	* CPUIDLE GOVERNOR INTERFACE *
	181	******************************/
	182
	183	struct cpuidle_governor {
	184	char name[CPUIDLE_NAME_LEN];
	185	struct list_head governor_list;
	186	unsigned int rating;
	187
46bcfad7 DD	188	int (enable) (struct cpuidle_driver drv,
	189	struct cpuidle_device *dev);
	190	void (disable) (struct cpuidle_driver drv,
	191	struct cpuidle_device *dev);
4f86d3a8	192
46bcfad7 DD	193	int (select) (struct cpuidle_driver drv,
46bcfad7 DD	194	struct cpuidle_device *dev);
e978aa7d	195	void (reflect) (struct cpuidle_device dev, int index);
4f86d3a8 LB	196
	197	struct module *owner;
	198	};
	199
	200	#ifdef CONFIG_CPU_IDLE
	201
	202	extern int cpuidle_register_governor(struct cpuidle_governor *gov);
	203	extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
	204
65b7f839 TR	205	#ifdef CONFIG_INTEL_IDLE
65b7f839 TR	206	extern int intel_idle_cpu_init(int cpu);
4f86d3a8	207	#else
65b7f839 TR	208	static inline int intel_idle_cpu_init(int cpu) { return -1; }
	209	#endif
	210
	211	#else
	212	static inline int intel_idle_cpu_init(int cpu) { return -1; }
4f86d3a8 LB	213
	214	static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
	215	{return 0;}
	216	static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
	217
	218	#endif
	219
9a0b8415	220	#ifdef CONFIG_ARCH_HAS_CPU_RELAX
	221	#define CPUIDLE_DRIVER_STATE_START 1
	222	#else
	223	#define CPUIDLE_DRIVER_STATE_START 0
	224	#endif
	225
4f86d3a8	226	#endif /* _LINUX_CPUIDLE_H */