[mirror_ubuntu-artful-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/hrtimer.h>

#define CPUIDLE_STATE_MAX	10
#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 {
	unsigned long long	disable;
	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 */
	bool		disabled; /* disabled on all CPUs */

	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_FLAG_COUPLED	(0x02) /* state applies to multiple cpus */
#define CPUIDLE_FLAG_TIMER_STOP (0x04)  /* timer is stopped on this state */

#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)

struct cpuidle_device_kobj;
struct cpuidle_state_kobj;
struct cpuidle_driver_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 cpuidle_driver_kobj *kobj_driver;
	struct cpuidle_device_kobj *kobj_dev;
	struct list_head 	device_list;

#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
	int			safe_state_index;
	cpumask_t		coupled_cpus;
	struct cpuidle_coupled	*coupled;
#endif
};

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;
	int                     refcnt;

        /* used by the cpuidle framework to setup the broadcast timer */
	unsigned int            bctimer:1;
	/* states array must be ordered in decreasing power consumption */
	struct cpuidle_state	states[CPUIDLE_STATE_MAX];
	int			state_count;
	int			safe_state_index;

	/* the driver handles the cpus in cpumask */
	struct cpumask		*cpumask;
};

#ifdef CONFIG_CPU_IDLE
extern void disable_cpuidle(void);

extern int cpuidle_enabled(struct cpuidle_driver *drv,
			  struct cpuidle_device *dev);
extern int cpuidle_select(struct cpuidle_driver *drv,
			  struct cpuidle_device *dev);
extern int cpuidle_enter(struct cpuidle_driver *drv,
			 struct cpuidle_device *dev, int index);
extern void cpuidle_reflect(struct cpuidle_device *dev, int index);

extern int cpuidle_register_driver(struct cpuidle_driver *drv);
extern struct cpuidle_driver *cpuidle_get_driver(void);
extern struct cpuidle_driver *cpuidle_driver_ref(void);
extern void cpuidle_driver_unref(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 int cpuidle_register(struct cpuidle_driver *drv,
			    const struct cpumask *const coupled_cpus);
extern void cpuidle_unregister(struct cpuidle_driver *drv);
extern void cpuidle_pause_and_lock(void);
extern void cpuidle_resume_and_unlock(void);
extern void cpuidle_pause(void);
extern void cpuidle_resume(void);
extern int cpuidle_enable_device(struct cpuidle_device *dev);
extern void cpuidle_disable_device(struct cpuidle_device *dev);
extern int cpuidle_play_dead(void);

extern struct cpuidle_driver *cpuidle_get_cpu_driver(struct cpuidle_device *dev);
#else
static inline void disable_cpuidle(void) { }
static inline int cpuidle_enabled(struct cpuidle_driver *drv,
				  struct cpuidle_device *dev)
{return -ENODEV; }
static inline int cpuidle_select(struct cpuidle_driver *drv,
				 struct cpuidle_device *dev)
{return -ENODEV; }
static inline int cpuidle_enter(struct cpuidle_driver *drv,
				struct cpuidle_device *dev, int index)
{return -ENODEV; }
static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
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 struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
static inline void cpuidle_driver_unref(void) {}
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 int cpuidle_register(struct cpuidle_driver *drv,
				   const struct cpumask *const coupled_cpus)
{return -ENODEV; }
static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
static inline void cpuidle_pause_and_lock(void) { }
static inline void cpuidle_resume_and_unlock(void) { }
static inline void cpuidle_pause(void) { }
static inline void cpuidle_resume(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_play_dead(void) {return -ENODEV; }
static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
	struct cpuidle_device *dev) {return NULL; }
#endif

#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a);
#else
static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device *dev, atomic_t *a)
{
}
#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);
#else
static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
{return 0;}
#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>
e1689795	16	#include <linux/hrtimer.h>
4f86d3a8	17
86239ceb	18	#define CPUIDLE_STATE_MAX 10
4f86d3a8	19	#define CPUIDLE_NAME_LEN 16
4fcb2fcd	20	#define CPUIDLE_DESC_LEN 32
4f86d3a8	21
de477254 PG	22	struct module;
de477254 PG	23
4f86d3a8	24	struct cpuidle_device;
46bcfad7	25	struct cpuidle_driver;
4f86d3a8 LB	26
	27
	28	/****************************
	29	* CPUIDLE DEVICE INTERFACE *
	30	****************************/
	31
4202735e	32	struct cpuidle_state_usage {
dc7fd275	33	unsigned long long disable;
4202735e DD	34	unsigned long long usage;
	35	unsigned long long time; /* in US */
	36	};
	37
4f86d3a8 LB	38	struct cpuidle_state {
4f86d3a8 LB	39	char name[CPUIDLE_NAME_LEN];
4fcb2fcd	40	char desc[CPUIDLE_DESC_LEN];
4f86d3a8 LB	41
	42	unsigned int flags;
	43	unsigned int exit_latency; /* in US */
02401c06	44	int power_usage; /* in mW */
4f86d3a8	45	unsigned int target_residency; /* in US */
cbc9ef02	46	bool disabled; /* disabled on all CPUs */
4f86d3a8	47
4f86d3a8	48	int (enter) (struct cpuidle_device dev,
46bcfad7	49	struct cpuidle_driver *drv,
e978aa7d	50	int index);
1a022e3f BO	51
1a022e3f BO	52	int (enter_dead) (struct cpuidle_device dev, int index);
4f86d3a8 LB	53	};
	54
	55	/* Idle State Flags */
	56	#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
4126c019	57	#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
b60e6a0e	58	#define CPUIDLE_FLAG_TIMER_STOP (0x04) /* timer is stopped on this state */
4f86d3a8 LB	59
	60	#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
	61
728ce22b	62	struct cpuidle_device_kobj;
1a706438 DL	63	struct cpuidle_state_kobj;
1a706438 DL	64	struct cpuidle_driver_kobj;
728ce22b	65
4f86d3a8	66	struct cpuidle_device {
dcb84f33	67	unsigned int registered:1;
b5556a67	68	unsigned int enabled:1;
4f86d3a8 LB	69	unsigned int cpu;
	70
	71	int last_residency;
	72	int state_count;
4202735e	73	struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8	74	struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
bf4d1b5d	75	struct cpuidle_driver_kobj *kobj_driver;
728ce22b	76	struct cpuidle_device_kobj *kobj_dev;
4f86d3a8	77	struct list_head device_list;
4126c019 CC	78
	79	#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
	80	int safe_state_index;
	81	cpumask_t coupled_cpus;
	82	struct cpuidle_coupled *coupled;
	83	#endif
4f86d3a8 LB	84	};
	85
	86	DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
	87
	88	/**
	89	* cpuidle_get_last_residency - retrieves the last state's residency time
	90	* @dev: the target CPU
	91	*
	92	* NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
	93	*/
	94	static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
	95	{
	96	return dev->last_residency;
	97	}
	98
	99
	100	/****************************
	101	* CPUIDLE DRIVER INTERFACE *
	102	****************************/
	103
	104	struct cpuidle_driver {
db70b044	105	const char *name;
4f86d3a8	106	struct module *owner;
42f67f2a	107	int refcnt;
46bcfad7	108
a06df062 DL	109	/* used by the cpuidle framework to setup the broadcast timer */
a06df062 DL	110	unsigned int bctimer:1;
8aef33a7	111	/* states array must be ordered in decreasing power consumption */
46bcfad7 DD	112	struct cpuidle_state states[CPUIDLE_STATE_MAX];
	113	int state_count;
	114	int safe_state_index;
82467a5a DL	115
82467a5a DL	116	/* the driver handles the cpus in cpumask */
6587fca2	117	struct cpumask *cpumask;
4f86d3a8 LB	118	};
	119
	120	#ifdef CONFIG_CPU_IDLE
d91ee586	121	extern void disable_cpuidle(void);
907e30f1 DL	122
	123	extern int cpuidle_enabled(struct cpuidle_driver *drv,
	124	struct cpuidle_device *dev);
	125	extern int cpuidle_select(struct cpuidle_driver *drv,
	126	struct cpuidle_device *dev);
	127	extern int cpuidle_enter(struct cpuidle_driver *drv,
	128	struct cpuidle_device *dev, int index);
	129	extern void cpuidle_reflect(struct cpuidle_device *dev, int index);
	130
4f86d3a8	131	extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07 RW	132	extern struct cpuidle_driver *cpuidle_get_driver(void);
	133	extern struct cpuidle_driver *cpuidle_driver_ref(void);
	134	extern void cpuidle_driver_unref(void);
4f86d3a8 LB	135	extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
	136	extern int cpuidle_register_device(struct cpuidle_device *dev);
	137	extern void cpuidle_unregister_device(struct cpuidle_device *dev);
4c637b21 DL	138	extern int cpuidle_register(struct cpuidle_driver *drv,
	139	const struct cpumask *const coupled_cpus);
	140	extern void cpuidle_unregister(struct cpuidle_driver *drv);
4f86d3a8 LB	141	extern void cpuidle_pause_and_lock(void);
4f86d3a8 LB	142	extern void cpuidle_resume_and_unlock(void);
8651f97b PM	143	extern void cpuidle_pause(void);
8651f97b PM	144	extern void cpuidle_resume(void);
4f86d3a8 LB	145	extern int cpuidle_enable_device(struct cpuidle_device *dev);
4f86d3a8 LB	146	extern void cpuidle_disable_device(struct cpuidle_device *dev);
1a022e3f BO	147	extern int cpuidle_play_dead(void);
1a022e3f BO	148
bf4d1b5d	149	extern struct cpuidle_driver cpuidle_get_cpu_driver(struct cpuidle_device dev);
4f86d3a8	150	#else
d91ee586	151	static inline void disable_cpuidle(void) { }
907e30f1 DL	152	static inline int cpuidle_enabled(struct cpuidle_driver *drv,
	153	struct cpuidle_device *dev)
	154	{return -ENODEV; }
	155	static inline int cpuidle_select(struct cpuidle_driver *drv,
	156	struct cpuidle_device *dev)
	157	{return -ENODEV; }
	158	static inline int cpuidle_enter(struct cpuidle_driver *drv,
	159	struct cpuidle_device *dev, int index)
	160	{return -ENODEV; }
	161	static inline void cpuidle_reflect(struct cpuidle_device *dev, int index) { }
4f86d3a8	162	static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b	163	{return -ENODEV; }
752138df	164	static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07 RW	165	static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
6e797a07 RW	166	static inline void cpuidle_driver_unref(void) {}
4f86d3a8 LB	167	static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
4f86d3a8 LB	168	static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b	169	{return -ENODEV; }
4f86d3a8	170	static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
4c637b21 DL	171	static inline int cpuidle_register(struct cpuidle_driver *drv,
	172	const struct cpumask *const coupled_cpus)
	173	{return -ENODEV; }
	174	static inline void cpuidle_unregister(struct cpuidle_driver *drv) { }
4f86d3a8 LB	175	static inline void cpuidle_pause_and_lock(void) { }
4f86d3a8 LB	176	static inline void cpuidle_resume_and_unlock(void) { }
8651f97b PM	177	static inline void cpuidle_pause(void) { }
8651f97b PM	178	static inline void cpuidle_resume(void) { }
4f86d3a8	179	static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b	180	{return -ENODEV; }
4f86d3a8	181	static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
1a022e3f	182	static inline int cpuidle_play_dead(void) {return -ENODEV; }
c8cc7d4d DL	183	static inline struct cpuidle_driver *cpuidle_get_cpu_driver(
c8cc7d4d DL	184	struct cpuidle_device *dev) {return NULL; }
4f86d3a8 LB	185	#endif
4f86d3a8 LB	186
20ff51a3 CC	187	#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
20ff51a3 CC	188	void cpuidle_coupled_parallel_barrier(struct cpuidle_device dev, atomic_t a);
c7a9b09b AB	189	#else
	190	static inline void cpuidle_coupled_parallel_barrier(struct cpuidle_device dev, atomic_t a)
	191	{
	192	}
20ff51a3 CC	193	#endif
20ff51a3 CC	194
4f86d3a8 LB	195	/******************************
	196	* CPUIDLE GOVERNOR INTERFACE *
	197	******************************/
	198
	199	struct cpuidle_governor {
	200	char name[CPUIDLE_NAME_LEN];
	201	struct list_head governor_list;
	202	unsigned int rating;
	203
46bcfad7 DD	204	int (enable) (struct cpuidle_driver drv,
	205	struct cpuidle_device *dev);
	206	void (disable) (struct cpuidle_driver drv,
	207	struct cpuidle_device *dev);
4f86d3a8	208
46bcfad7 DD	209	int (select) (struct cpuidle_driver drv,
46bcfad7 DD	210	struct cpuidle_device *dev);
e978aa7d	211	void (reflect) (struct cpuidle_device dev, int index);
4f86d3a8 LB	212
	213	struct module *owner;
	214	};
	215
	216	#ifdef CONFIG_CPU_IDLE
4f86d3a8	217	extern int cpuidle_register_governor(struct cpuidle_governor *gov);
4f86d3a8	218	#else
4f86d3a8 LB	219	static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
4f86d3a8 LB	220	{return 0;}
4f86d3a8 LB	221	#endif
4f86d3a8 LB	222
9a0b8415	223	#ifdef CONFIG_ARCH_HAS_CPU_RELAX
	224	#define CPUIDLE_DRIVER_STATE_START 1
	225	#else
	226	#define CPUIDLE_DRIVER_STATE_START 0
	227	#endif
	228
4f86d3a8	229	#endif /* _LINUX_CPUIDLE_H */