[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / pm_qos.h

#ifndef _LINUX_PM_QOS_H
#define _LINUX_PM_QOS_H
/* interface for the pm_qos_power infrastructure of the linux kernel.
 *
 * Mark Gross <mgross@linux.intel.com>
 */
#include <linux/plist.h>
#include <linux/notifier.h>
#include <linux/miscdevice.h>
#include <linux/device.h>
#include <linux/workqueue.h>

enum {
	PM_QOS_RESERVED = 0,
	PM_QOS_CPU_DMA_LATENCY,
	PM_QOS_NETWORK_LATENCY,
	PM_QOS_NETWORK_THROUGHPUT,

	/* insert new class ID */
	PM_QOS_NUM_CLASSES,
};

enum pm_qos_flags_status {
	PM_QOS_FLAGS_UNDEFINED = -1,
	PM_QOS_FLAGS_NONE,
	PM_QOS_FLAGS_SOME,
	PM_QOS_FLAGS_ALL,
};

#define PM_QOS_DEFAULT_VALUE -1

#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE	(2000 * USEC_PER_SEC)
#define PM_QOS_NETWORK_LAT_DEFAULT_VALUE	(2000 * USEC_PER_SEC)
#define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE	0
#define PM_QOS_DEV_LAT_DEFAULT_VALUE		0

#define PM_QOS_FLAG_NO_POWER_OFF	(1 << 0)
#define PM_QOS_FLAG_REMOTE_WAKEUP	(1 << 1)

struct pm_qos_request {
	struct plist_node node;
	int pm_qos_class;
	struct delayed_work work; /* for pm_qos_update_request_timeout */
};

struct pm_qos_flags_request {
	struct list_head node;
	s32 flags;	/* Do not change to 64 bit */
};

enum dev_pm_qos_req_type {
	DEV_PM_QOS_LATENCY = 1,
	DEV_PM_QOS_FLAGS,
};

struct dev_pm_qos_request {
	enum dev_pm_qos_req_type type;
	union {
		struct plist_node pnode;
		struct pm_qos_flags_request flr;
	} data;
	struct device *dev;
};

enum pm_qos_type {
	PM_QOS_UNITIALIZED,
	PM_QOS_MAX,		/* return the largest value */
	PM_QOS_MIN		/* return the smallest value */
};

/*
 * Note: The lockless read path depends on the CPU accessing target_value
 * or effective_flags atomically.  Atomic access is only guaranteed on all CPU
 * types linux supports for 32 bit quantites
 */
struct pm_qos_constraints {
	struct plist_head list;
	s32 target_value;	/* Do not change to 64 bit */
	s32 default_value;
	enum pm_qos_type type;
	struct blocking_notifier_head *notifiers;
};

struct pm_qos_flags {
	struct list_head list;
	s32 effective_flags;	/* Do not change to 64 bit */
};

struct dev_pm_qos {
	struct pm_qos_constraints latency;
	struct pm_qos_flags flags;
	struct dev_pm_qos_request *latency_req;
	struct dev_pm_qos_request *flags_req;
};

/* Action requested to pm_qos_update_target */
enum pm_qos_req_action {
	PM_QOS_ADD_REQ,		/* Add a new request */
	PM_QOS_UPDATE_REQ,	/* Update an existing request */
	PM_QOS_REMOVE_REQ	/* Remove an existing request */
};

static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
{
	return req->dev != NULL;
}

int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
			 enum pm_qos_req_action action, int value);
bool pm_qos_update_flags(struct pm_qos_flags *pqf,
			 struct pm_qos_flags_request *req,
			 enum pm_qos_req_action action, s32 val);
void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
			s32 value);
void pm_qos_update_request(struct pm_qos_request *req,
			   s32 new_value);
void pm_qos_update_request_timeout(struct pm_qos_request *req,
				   s32 new_value, unsigned long timeout_us);
void pm_qos_remove_request(struct pm_qos_request *req);

int pm_qos_request(int pm_qos_class);
int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
int pm_qos_request_active(struct pm_qos_request *req);
s32 pm_qos_read_value(struct pm_qos_constraints *c);

#ifdef CONFIG_PM
enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
s32 __dev_pm_qos_read_value(struct device *dev);
s32 dev_pm_qos_read_value(struct device *dev);
int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
			   enum dev_pm_qos_req_type type, s32 value);
int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
int dev_pm_qos_add_notifier(struct device *dev,
			    struct notifier_block *notifier);
int dev_pm_qos_remove_notifier(struct device *dev,
			       struct notifier_block *notifier);
int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
void dev_pm_qos_constraints_init(struct device *dev);
void dev_pm_qos_constraints_destroy(struct device *dev);
int dev_pm_qos_add_ancestor_request(struct device *dev,
				    struct dev_pm_qos_request *req, s32 value);
#else
static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
							  s32 mask)
			{ return PM_QOS_FLAGS_UNDEFINED; }
static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
							s32 mask)
			{ return PM_QOS_FLAGS_UNDEFINED; }
static inline s32 __dev_pm_qos_read_value(struct device *dev)
			{ return 0; }
static inline s32 dev_pm_qos_read_value(struct device *dev)
			{ return 0; }
static inline int dev_pm_qos_add_request(struct device *dev,
					 struct dev_pm_qos_request *req,
					 enum dev_pm_qos_req_type type,
					 s32 value)
			{ return 0; }
static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
					    s32 new_value)
			{ return 0; }
static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
			{ return 0; }
static inline int dev_pm_qos_add_notifier(struct device *dev,
					  struct notifier_block *notifier)
			{ return 0; }
static inline int dev_pm_qos_remove_notifier(struct device *dev,
					     struct notifier_block *notifier)
			{ return 0; }
static inline int dev_pm_qos_add_global_notifier(
					struct notifier_block *notifier)
			{ return 0; }
static inline int dev_pm_qos_remove_global_notifier(
					struct notifier_block *notifier)
			{ return 0; }
static inline void dev_pm_qos_constraints_init(struct device *dev)
{
	dev->power.power_state = PMSG_ON;
}
static inline void dev_pm_qos_constraints_destroy(struct device *dev)
{
	dev->power.power_state = PMSG_INVALID;
}
static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
				    struct dev_pm_qos_request *req, s32 value)
			{ return 0; }
#endif

#ifdef CONFIG_PM_RUNTIME
int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
void dev_pm_qos_hide_latency_limit(struct device *dev);
int dev_pm_qos_expose_flags(struct device *dev, s32 value);
void dev_pm_qos_hide_flags(struct device *dev);
int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);

static inline s32 dev_pm_qos_requested_latency(struct device *dev)
{
	return dev->power.qos->latency_req->data.pnode.prio;
}

static inline s32 dev_pm_qos_requested_flags(struct device *dev)
{
	return dev->power.qos->flags_req->data.flr.flags;
}
#else
static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
			{ return 0; }
static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
			{ return 0; }
static inline void dev_pm_qos_hide_flags(struct device *dev) {}
static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
			{ return 0; }

static inline s32 dev_pm_qos_requested_latency(struct device *dev) { return 0; }
static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
#endif

#endif
Commit	Line	Data
e8db0be1 JP	1	#ifndef _LINUX_PM_QOS_H
e8db0be1 JP	2	#define _LINUX_PM_QOS_H
d82b3518 MG	3	/* interface for the pm_qos_power infrastructure of the linux kernel.
d82b3518 MG	4	*
bf1db69f	5	* Mark Gross <mgross@linux.intel.com>
d82b3518	6	*/
82f68251	7	#include <linux/plist.h>
d82b3518 MG	8	#include <linux/notifier.h>
d82b3518 MG	9	#include <linux/miscdevice.h>
1a9a9152	10	#include <linux/device.h>
c4772d19	11	#include <linux/workqueue.h>
d82b3518	12
d031e1de AF	13	enum {
	14	PM_QOS_RESERVED = 0,
	15	PM_QOS_CPU_DMA_LATENCY,
	16	PM_QOS_NETWORK_LATENCY,
	17	PM_QOS_NETWORK_THROUGHPUT,
	18
	19	/* insert new class ID */
	20	PM_QOS_NUM_CLASSES,
	21	};
d82b3518	22
ae0fb4b7 RW	23	enum pm_qos_flags_status {
	24	PM_QOS_FLAGS_UNDEFINED = -1,
	25	PM_QOS_FLAGS_NONE,
	26	PM_QOS_FLAGS_SOME,
	27	PM_QOS_FLAGS_ALL,
	28	};
	29
d82b3518 MG	30	#define PM_QOS_DEFAULT_VALUE -1
d82b3518 MG	31
333c5ae9 TC	32	#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
	33	#define PM_QOS_NETWORK_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
	34	#define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
91ff4cb8	35	#define PM_QOS_DEV_LAT_DEFAULT_VALUE 0
333c5ae9	36
e39473d0 RW	37	#define PM_QOS_FLAG_NO_POWER_OFF (1 << 0)
	38	#define PM_QOS_FLAG_REMOTE_WAKEUP (1 << 1)
	39
cc749986 JP	40	struct pm_qos_request {
cc749986 JP	41	struct plist_node node;
82f68251	42	int pm_qos_class;
c4772d19	43	struct delayed_work work; /* for pm_qos_update_request_timeout */
82f68251	44	};
d82b3518	45
5efbe427 RW	46	struct pm_qos_flags_request {
	47	struct list_head node;
	48	s32 flags; /* Do not change to 64 bit */
	49	};
	50
ae0fb4b7 RW	51	enum dev_pm_qos_req_type {
	52	DEV_PM_QOS_LATENCY = 1,
	53	DEV_PM_QOS_FLAGS,
	54	};
	55
91ff4cb8	56	struct dev_pm_qos_request {
ae0fb4b7	57	enum dev_pm_qos_req_type type;
021c870b RW	58	union {
021c870b RW	59	struct plist_node pnode;
ae0fb4b7	60	struct pm_qos_flags_request flr;
021c870b	61	} data;
91ff4cb8 JP	62	struct device *dev;
	63	};
	64
4e1779ba JP	65	enum pm_qos_type {
	66	PM_QOS_UNITIALIZED,
	67	PM_QOS_MAX, /* return the largest value */
	68	PM_QOS_MIN /* return the smallest value */
	69	};
	70
	71	/*
5efbe427 RW	72	* Note: The lockless read path depends on the CPU accessing target_value
5efbe427 RW	73	* or effective_flags atomically. Atomic access is only guaranteed on all CPU
4e1779ba JP	74	* types linux supports for 32 bit quantites
	75	*/
	76	struct pm_qos_constraints {
	77	struct plist_head list;
	78	s32 target_value; /* Do not change to 64 bit */
	79	s32 default_value;
	80	enum pm_qos_type type;
	81	struct blocking_notifier_head *notifiers;
	82	};
	83
5efbe427 RW	84	struct pm_qos_flags {
	85	struct list_head list;
	86	s32 effective_flags; /* Do not change to 64 bit */
	87	};
	88
5f986c59 RW	89	struct dev_pm_qos {
5f986c59 RW	90	struct pm_qos_constraints latency;
ae0fb4b7	91	struct pm_qos_flags flags;
e39473d0 RW	92	struct dev_pm_qos_request *latency_req;
e39473d0 RW	93	struct dev_pm_qos_request *flags_req;
5f986c59 RW	94	};
5f986c59 RW	95
abe98ec2 JP	96	/* Action requested to pm_qos_update_target */
	97	enum pm_qos_req_action {
	98	PM_QOS_ADD_REQ, /* Add a new request */
	99	PM_QOS_UPDATE_REQ, /* Update an existing request */
	100	PM_QOS_REMOVE_REQ /* Remove an existing request */
	101	};
	102
91ff4cb8 JP	103	static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
91ff4cb8 JP	104	{
83618092	105	return req->dev != NULL;
91ff4cb8 JP	106	}
91ff4cb8 JP	107
abe98ec2 JP	108	int pm_qos_update_target(struct pm_qos_constraints c, struct plist_node node,
abe98ec2 JP	109	enum pm_qos_req_action action, int value);
5efbe427 RW	110	bool pm_qos_update_flags(struct pm_qos_flags *pqf,
	111	struct pm_qos_flags_request *req,
	112	enum pm_qos_req_action action, s32 val);
cc749986 JP	113	void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
	114	s32 value);
	115	void pm_qos_update_request(struct pm_qos_request *req,
e8db0be1	116	s32 new_value);
c4772d19 MH	117	void pm_qos_update_request_timeout(struct pm_qos_request *req,
c4772d19 MH	118	s32 new_value, unsigned long timeout_us);
cc749986	119	void pm_qos_remove_request(struct pm_qos_request *req);
d82b3518	120
ed77134b MG	121	int pm_qos_request(int pm_qos_class);
	122	int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
	123	int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
cc749986	124	int pm_qos_request_active(struct pm_qos_request *req);
b66213cd	125	s32 pm_qos_read_value(struct pm_qos_constraints *c);
91ff4cb8	126
a9b542ee	127	#ifdef CONFIG_PM
ae0fb4b7 RW	128	enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
ae0fb4b7 RW	129	enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
00dc9ad1	130	s32 __dev_pm_qos_read_value(struct device *dev);
1a9a9152	131	s32 dev_pm_qos_read_value(struct device *dev);
91ff4cb8	132	int dev_pm_qos_add_request(struct device dev, struct dev_pm_qos_request req,
ae0fb4b7	133	enum dev_pm_qos_req_type type, s32 value);
91ff4cb8 JP	134	int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
	135	int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
	136	int dev_pm_qos_add_notifier(struct device *dev,
	137	struct notifier_block *notifier);
	138	int dev_pm_qos_remove_notifier(struct device *dev,
	139	struct notifier_block *notifier);
b66213cd JP	140	int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
b66213cd JP	141	int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
91ff4cb8 JP	142	void dev_pm_qos_constraints_init(struct device *dev);
91ff4cb8 JP	143	void dev_pm_qos_constraints_destroy(struct device *dev);
40a5f8be RW	144	int dev_pm_qos_add_ancestor_request(struct device *dev,
40a5f8be RW	145	struct dev_pm_qos_request *req, s32 value);
e8db0be1	146	#else
ae0fb4b7 RW	147	static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
	148	s32 mask)
	149	{ return PM_QOS_FLAGS_UNDEFINED; }
	150	static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
	151	s32 mask)
	152	{ return PM_QOS_FLAGS_UNDEFINED; }
00dc9ad1 RW	153	static inline s32 __dev_pm_qos_read_value(struct device *dev)
00dc9ad1 RW	154	{ return 0; }
1a9a9152 RW	155	static inline s32 dev_pm_qos_read_value(struct device *dev)
1a9a9152 RW	156	{ return 0; }
91ff4cb8 JP	157	static inline int dev_pm_qos_add_request(struct device *dev,
91ff4cb8 JP	158	struct dev_pm_qos_request *req,
ae0fb4b7	159	enum dev_pm_qos_req_type type,
91ff4cb8 JP	160	s32 value)
	161	{ return 0; }
	162	static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
	163	s32 new_value)
	164	{ return 0; }
	165	static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
	166	{ return 0; }
	167	static inline int dev_pm_qos_add_notifier(struct device *dev,
	168	struct notifier_block *notifier)
	169	{ return 0; }
	170	static inline int dev_pm_qos_remove_notifier(struct device *dev,
	171	struct notifier_block *notifier)
	172	{ return 0; }
b66213cd JP	173	static inline int dev_pm_qos_add_global_notifier(
	174	struct notifier_block *notifier)
	175	{ return 0; }
	176	static inline int dev_pm_qos_remove_global_notifier(
	177	struct notifier_block *notifier)
	178	{ return 0; }
91ff4cb8	179	static inline void dev_pm_qos_constraints_init(struct device *dev)
1a9a9152 RW	180	{
	181	dev->power.power_state = PMSG_ON;
	182	}
91ff4cb8	183	static inline void dev_pm_qos_constraints_destroy(struct device *dev)
1a9a9152 RW	184	{
	185	dev->power.power_state = PMSG_INVALID;
	186	}
40a5f8be RW	187	static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
	188	struct dev_pm_qos_request *req, s32 value)
	189	{ return 0; }
e8db0be1	190	#endif
d82b3518	191
85dc0b8a RW	192	#ifdef CONFIG_PM_RUNTIME
	193	int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
	194	void dev_pm_qos_hide_latency_limit(struct device *dev);
e39473d0 RW	195	int dev_pm_qos_expose_flags(struct device *dev, s32 value);
	196	void dev_pm_qos_hide_flags(struct device *dev);
	197	int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
	198
	199	static inline s32 dev_pm_qos_requested_latency(struct device *dev)
	200	{
	201	return dev->power.qos->latency_req->data.pnode.prio;
	202	}
	203
	204	static inline s32 dev_pm_qos_requested_flags(struct device *dev)
	205	{
	206	return dev->power.qos->flags_req->data.flr.flags;
	207	}
85dc0b8a RW	208	#else
	209	static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
	210	{ return 0; }
	211	static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
e39473d0 RW	212	static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
	213	{ return 0; }
	214	static inline void dev_pm_qos_hide_flags(struct device *dev) {}
	215	static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
	216	{ return 0; }
	217
	218	static inline s32 dev_pm_qos_requested_latency(struct device *dev) { return 0; }
	219	static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
85dc0b8a RW	220	#endif
85dc0b8a RW	221
82f68251	222	#endif