[mirror_ubuntu-zesty-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/module.h>
#include <linux/kobject.h>
#include <linux/completion.h>

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

struct cpuidle_device;


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

struct cpuidle_state {
	char		name[CPUIDLE_NAME_LEN];
	char		desc[CPUIDLE_DESC_LEN];
	void		*driver_data;

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

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

	int (*enter)	(struct cpuidle_device *dev,
			 struct cpuidle_state *state);
};

/* Idle State Flags */
#define CPUIDLE_FLAG_TIME_VALID	(0x01) /* is residency time measurable? */
#define CPUIDLE_FLAG_IGNORE	(0x100) /* ignore during this idle period */

#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)

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

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

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

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

	int			last_residency;
	int			state_count;
	struct cpuidle_state	states[CPUIDLE_STATE_MAX];
	struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
	struct cpuidle_state	*last_state;

	struct list_head 	device_list;
	struct kobject		kobj;
	struct completion	kobj_unregister;
	void			*governor_data;
	struct cpuidle_state	*safe_state;

	int (*prepare)		(struct cpuidle_device *dev);
};

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 {
	char			name[CPUIDLE_NAME_LEN];
	struct module 		*owner;
};

#ifdef CONFIG_CPU_IDLE
extern void disable_cpuidle(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);

#else
static inline void disable_cpuidle(void) { }

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) { }

#endif

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

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

	int  (*enable)		(struct cpuidle_device *dev);
	void (*disable)		(struct cpuidle_device *dev);

	int  (*select)		(struct cpuidle_device *dev);
	void (*reflect)		(struct cpuidle_device *dev);

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

#else

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>
	16	#include <linux/module.h>
	17	#include <linux/kobject.h>
	18	#include <linux/completion.h>
	19
	20	#define CPUIDLE_STATE_MAX 8
	21	#define CPUIDLE_NAME_LEN 16
4fcb2fcd	22	#define CPUIDLE_DESC_LEN 32
4f86d3a8 LB	23
	24	struct cpuidle_device;
	25
	26
	27	/****************************
	28	* CPUIDLE DEVICE INTERFACE *
	29	****************************/
	30
	31	struct cpuidle_state {
	32	char name[CPUIDLE_NAME_LEN];
4fcb2fcd	33	char desc[CPUIDLE_DESC_LEN];
4f86d3a8 LB	34	void *driver_data;
	35
	36	unsigned int flags;
	37	unsigned int exit_latency; /* in US */
	38	unsigned int power_usage; /* in mW */
	39	unsigned int target_residency; /* in US */
	40
8b78cf60 YY	41	unsigned long long usage;
8b78cf60 YY	42	unsigned long long time; /* in US */
4f86d3a8 LB	43
	44	int (enter) (struct cpuidle_device dev,
	45	struct cpuidle_state *state);
	46	};
	47
	48	/* Idle State Flags */
	49	#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
71abbbf8	50	#define CPUIDLE_FLAG_IGNORE (0x100) /* ignore during this idle period */
4f86d3a8 LB	51
	52	#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
	53
	54	/**
	55	* cpuidle_get_statedata - retrieves private driver state data
	56	* @state: the state
	57	*/
	58	static inline void * cpuidle_get_statedata(struct cpuidle_state *state)
	59	{
	60	return state->driver_data;
	61	}
	62
	63	/**
	64	* cpuidle_set_statedata - stores private driver state data
	65	* @state: the state
	66	* @data: the private data
	67	*/
	68	static inline void
	69	cpuidle_set_statedata(struct cpuidle_state state, void data)
	70	{
	71	state->driver_data = data;
	72	}
	73
	74	struct cpuidle_state_kobj {
	75	struct cpuidle_state *state;
	76	struct completion kobj_unregister;
	77	struct kobject kobj;
	78	};
	79
	80	struct cpuidle_device {
dcb84f33	81	unsigned int registered:1;
b5556a67	82	unsigned int enabled:1;
71abbbf8	83	unsigned int power_specified:1;
4f86d3a8 LB	84	unsigned int cpu;
	85
	86	int last_residency;
	87	int state_count;
	88	struct cpuidle_state states[CPUIDLE_STATE_MAX];
	89	struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
	90	struct cpuidle_state *last_state;
	91
	92	struct list_head device_list;
	93	struct kobject kobj;
	94	struct completion kobj_unregister;
	95	void *governor_data;
ddc081a1	96	struct cpuidle_state *safe_state;
71abbbf8 AL	97
71abbbf8 AL	98	int (prepare) (struct cpuidle_device dev);
4f86d3a8 LB	99	};
	100
	101	DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
	102
	103	/**
	104	* cpuidle_get_last_residency - retrieves the last state's residency time
	105	* @dev: the target CPU
	106	*
	107	* NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
	108	*/
	109	static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
	110	{
	111	return dev->last_residency;
	112	}
	113
	114
	115	/****************************
	116	* CPUIDLE DRIVER INTERFACE *
	117	****************************/
	118
	119	struct cpuidle_driver {
	120	char name[CPUIDLE_NAME_LEN];
	121	struct module *owner;
	122	};
	123
	124	#ifdef CONFIG_CPU_IDLE
d91ee586	125	extern void disable_cpuidle(void);
4f86d3a8 LB	126
4f86d3a8 LB	127	extern int cpuidle_register_driver(struct cpuidle_driver *drv);
752138df	128	struct cpuidle_driver *cpuidle_get_driver(void);
4f86d3a8 LB	129	extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
	130	extern int cpuidle_register_device(struct cpuidle_device *dev);
	131	extern void cpuidle_unregister_device(struct cpuidle_device *dev);
	132
	133	extern void cpuidle_pause_and_lock(void);
	134	extern void cpuidle_resume_and_unlock(void);
	135	extern int cpuidle_enable_device(struct cpuidle_device *dev);
	136	extern void cpuidle_disable_device(struct cpuidle_device *dev);
	137
	138	#else
d91ee586	139	static inline void disable_cpuidle(void) { }
4f86d3a8 LB	140
4f86d3a8 LB	141	static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b	142	{return -ENODEV; }
752138df	143	static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
4f86d3a8 LB	144	static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
4f86d3a8 LB	145	static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b	146	{return -ENODEV; }
4f86d3a8 LB	147	static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
	148
	149	static inline void cpuidle_pause_and_lock(void) { }
	150	static inline void cpuidle_resume_and_unlock(void) { }
	151	static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b	152	{return -ENODEV; }
4f86d3a8 LB	153	static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
	154
	155	#endif
	156
	157	/******************************
	158	* CPUIDLE GOVERNOR INTERFACE *
	159	******************************/
	160
	161	struct cpuidle_governor {
	162	char name[CPUIDLE_NAME_LEN];
	163	struct list_head governor_list;
	164	unsigned int rating;
	165
	166	int (enable) (struct cpuidle_device dev);
	167	void (disable) (struct cpuidle_device dev);
	168
	169	int (select) (struct cpuidle_device dev);
	170	void (reflect) (struct cpuidle_device dev);
	171
	172	struct module *owner;
	173	};
	174
	175	#ifdef CONFIG_CPU_IDLE
	176
	177	extern int cpuidle_register_governor(struct cpuidle_governor *gov);
	178	extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
	179
	180	#else
	181
	182	static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
	183	{return 0;}
	184	static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
	185
	186	#endif
	187
9a0b8415	188	#ifdef CONFIG_ARCH_HAS_CPU_RELAX
	189	#define CPUIDLE_DRIVER_STATE_START 1
	190	#else
	191	#define CPUIDLE_DRIVER_STATE_START 0
	192	#endif
	193
4f86d3a8	194	#endif /* _LINUX_CPUIDLE_H */