[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	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_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;

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

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

#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
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);
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>
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
dc7fd275	37	unsigned long long disable;
4202735e DD	38	unsigned long long usage;
	39	unsigned long long time; /* in US */
	40	};
	41
4f86d3a8 LB	42	struct cpuidle_state {
4f86d3a8 LB	43	char name[CPUIDLE_NAME_LEN];
4fcb2fcd	44	char desc[CPUIDLE_DESC_LEN];
4f86d3a8 LB	45
	46	unsigned int flags;
	47	unsigned int exit_latency; /* in US */
02401c06	48	int power_usage; /* in mW */
4f86d3a8	49	unsigned int target_residency; /* in US */
cbc9ef02	50	bool disabled; /* disabled on all CPUs */
4f86d3a8	51
4f86d3a8	52	int (enter) (struct cpuidle_device dev,
46bcfad7	53	struct cpuidle_driver *drv,
e978aa7d	54	int index);
1a022e3f BO	55
1a022e3f BO	56	int (enter_dead) (struct cpuidle_device dev, int index);
4f86d3a8 LB	57	};
	58
	59	/* Idle State Flags */
	60	#define CPUIDLE_FLAG_TIME_VALID (0x01) /* is residency time measurable? */
4126c019	61	#define CPUIDLE_FLAG_COUPLED (0x02) /* state applies to multiple cpus */
4f86d3a8 LB	62
	63	#define CPUIDLE_DRIVER_FLAGS_MASK (0xFFFF0000)
	64
	65	/**
	66	* cpuidle_get_statedata - retrieves private driver state data
4202735e	67	* @st_usage: the state usage statistics
4f86d3a8	68	*/
4202735e	69	static inline void cpuidle_get_statedata(struct cpuidle_state_usage st_usage)
4f86d3a8	70	{
4202735e	71	return st_usage->driver_data;
4f86d3a8 LB	72	}
	73
	74	/**
	75	* cpuidle_set_statedata - stores private driver state data
4202735e	76	* @st_usage: the state usage statistics
4f86d3a8 LB	77	* @data: the private data
	78	*/
	79	static inline void
4202735e	80	cpuidle_set_statedata(struct cpuidle_state_usage st_usage, void data)
4f86d3a8	81	{
4202735e	82	st_usage->driver_data = data;
4f86d3a8 LB	83	}
	84
	85	struct cpuidle_state_kobj {
	86	struct cpuidle_state *state;
4202735e	87	struct cpuidle_state_usage *state_usage;
4f86d3a8 LB	88	struct completion kobj_unregister;
	89	struct kobject kobj;
	90	};
	91
	92	struct cpuidle_device {
dcb84f33	93	unsigned int registered:1;
b5556a67	94	unsigned int enabled:1;
4f86d3a8 LB	95	unsigned int cpu;
	96
	97	int last_residency;
	98	int state_count;
4202735e	99	struct cpuidle_state_usage states_usage[CPUIDLE_STATE_MAX];
4f86d3a8	100	struct cpuidle_state_kobj *kobjs[CPUIDLE_STATE_MAX];
4f86d3a8 LB	101
	102	struct list_head device_list;
	103	struct kobject kobj;
	104	struct completion kobj_unregister;
4126c019 CC	105
	106	#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
	107	int safe_state_index;
	108	cpumask_t coupled_cpus;
	109	struct cpuidle_coupled *coupled;
	110	#endif
4f86d3a8 LB	111	};
	112
	113	DECLARE_PER_CPU(struct cpuidle_device *, cpuidle_devices);
	114
	115	/**
	116	* cpuidle_get_last_residency - retrieves the last state's residency time
	117	* @dev: the target CPU
	118	*
	119	* NOTE: this value is invalid if CPUIDLE_FLAG_TIME_VALID isn't set
	120	*/
	121	static inline int cpuidle_get_last_residency(struct cpuidle_device *dev)
	122	{
	123	return dev->last_residency;
	124	}
	125
	126
	127	/****************************
	128	* CPUIDLE DRIVER INTERFACE *
	129	****************************/
	130
	131	struct cpuidle_driver {
db70b044	132	const char *name;
4f86d3a8	133	struct module *owner;
46bcfad7 DD	134
46bcfad7 DD	135	unsigned int power_specified:1;
e1689795 RL	136	/* set to 1 to use the core cpuidle time keeping (for all states). */
e1689795 RL	137	unsigned int en_core_tk_irqen:1;
46bcfad7 DD	138	struct cpuidle_state states[CPUIDLE_STATE_MAX];
	139	int state_count;
	140	int safe_state_index;
4f86d3a8 LB	141	};
	142
	143	#ifdef CONFIG_CPU_IDLE
d91ee586	144	extern void disable_cpuidle(void);
a0bfa137	145	extern int cpuidle_idle_call(void);
4f86d3a8	146	extern int cpuidle_register_driver(struct cpuidle_driver *drv);
6e797a07 RW	147	extern struct cpuidle_driver *cpuidle_get_driver(void);
	148	extern struct cpuidle_driver *cpuidle_driver_ref(void);
	149	extern void cpuidle_driver_unref(void);
4f86d3a8 LB	150	extern void cpuidle_unregister_driver(struct cpuidle_driver *drv);
	151	extern int cpuidle_register_device(struct cpuidle_device *dev);
	152	extern void cpuidle_unregister_device(struct cpuidle_device *dev);
	153
	154	extern void cpuidle_pause_and_lock(void);
	155	extern void cpuidle_resume_and_unlock(void);
8651f97b PM	156	extern void cpuidle_pause(void);
8651f97b PM	157	extern void cpuidle_resume(void);
4f86d3a8 LB	158	extern int cpuidle_enable_device(struct cpuidle_device *dev);
4f86d3a8 LB	159	extern void cpuidle_disable_device(struct cpuidle_device *dev);
e1689795 RL	160	extern int cpuidle_wrap_enter(struct cpuidle_device *dev,
	161	struct cpuidle_driver *drv, int index,
	162	int (enter)(struct cpuidle_device dev,
	163	struct cpuidle_driver *drv, int index));
1a022e3f BO	164	extern int cpuidle_play_dead(void);
1a022e3f BO	165
4f86d3a8	166	#else
d91ee586	167	static inline void disable_cpuidle(void) { }
a0bfa137	168	static inline int cpuidle_idle_call(void) { return -ENODEV; }
4f86d3a8	169	static inline int cpuidle_register_driver(struct cpuidle_driver *drv)
6b2c676b	170	{return -ENODEV; }
752138df	171	static inline struct cpuidle_driver *cpuidle_get_driver(void) {return NULL; }
6e797a07 RW	172	static inline struct cpuidle_driver *cpuidle_driver_ref(void) {return NULL; }
6e797a07 RW	173	static inline void cpuidle_driver_unref(void) {}
4f86d3a8 LB	174	static inline void cpuidle_unregister_driver(struct cpuidle_driver *drv) { }
4f86d3a8 LB	175	static inline int cpuidle_register_device(struct cpuidle_device *dev)
6b2c676b	176	{return -ENODEV; }
4f86d3a8 LB	177	static inline void cpuidle_unregister_device(struct cpuidle_device *dev) { }
	178
	179	static inline void cpuidle_pause_and_lock(void) { }
	180	static inline void cpuidle_resume_and_unlock(void) { }
8651f97b PM	181	static inline void cpuidle_pause(void) { }
8651f97b PM	182	static inline void cpuidle_resume(void) { }
4f86d3a8	183	static inline int cpuidle_enable_device(struct cpuidle_device *dev)
6b2c676b	184	{return -ENODEV; }
4f86d3a8	185	static inline void cpuidle_disable_device(struct cpuidle_device *dev) { }
e1689795 RL	186	static inline int cpuidle_wrap_enter(struct cpuidle_device *dev,
	187	struct cpuidle_driver *drv, int index,
	188	int (enter)(struct cpuidle_device dev,
	189	struct cpuidle_driver *drv, int index))
	190	{ return -ENODEV; }
1a022e3f	191	static inline int cpuidle_play_dead(void) {return -ENODEV; }
4f86d3a8 LB	192
	193	#endif
	194
20ff51a3 CC	195	#ifdef CONFIG_ARCH_NEEDS_CPU_IDLE_COUPLED
	196	void cpuidle_coupled_parallel_barrier(struct cpuidle_device dev, atomic_t a);
	197	#endif
	198
4f86d3a8 LB	199	/******************************
	200	* CPUIDLE GOVERNOR INTERFACE *
	201	******************************/
	202
	203	struct cpuidle_governor {
	204	char name[CPUIDLE_NAME_LEN];
	205	struct list_head governor_list;
	206	unsigned int rating;
	207
46bcfad7 DD	208	int (enable) (struct cpuidle_driver drv,
	209	struct cpuidle_device *dev);
	210	void (disable) (struct cpuidle_driver drv,
	211	struct cpuidle_device *dev);
4f86d3a8	212
46bcfad7 DD	213	int (select) (struct cpuidle_driver drv,
46bcfad7 DD	214	struct cpuidle_device *dev);
e978aa7d	215	void (reflect) (struct cpuidle_device dev, int index);
4f86d3a8 LB	216
	217	struct module *owner;
	218	};
	219
	220	#ifdef CONFIG_CPU_IDLE
	221
	222	extern int cpuidle_register_governor(struct cpuidle_governor *gov);
	223	extern void cpuidle_unregister_governor(struct cpuidle_governor *gov);
	224
	225	#else
	226
	227	static inline int cpuidle_register_governor(struct cpuidle_governor *gov)
	228	{return 0;}
	229	static inline void cpuidle_unregister_governor(struct cpuidle_governor *gov) { }
	230
	231	#endif
	232
9a0b8415	233	#ifdef CONFIG_ARCH_HAS_CPU_RELAX
	234	#define CPUIDLE_DRIVER_STATE_START 1
	235	#else
	236	#define CPUIDLE_DRIVER_STATE_START 0
	237	#endif
	238
4f86d3a8	239	#endif /* _LINUX_CPUIDLE_H */