[thirdparty/linux.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

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

/* 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);
#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) {}
#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
cc749986 JP	37	struct pm_qos_request {
cc749986 JP	38	struct plist_node node;
82f68251	39	int pm_qos_class;
c4772d19	40	struct delayed_work work; /* for pm_qos_update_request_timeout */
82f68251	41	};
d82b3518	42
5efbe427 RW	43	struct pm_qos_flags_request {
	44	struct list_head node;
	45	s32 flags; /* Do not change to 64 bit */
	46	};
	47
ae0fb4b7 RW	48	enum dev_pm_qos_req_type {
	49	DEV_PM_QOS_LATENCY = 1,
	50	DEV_PM_QOS_FLAGS,
	51	};
	52
91ff4cb8	53	struct dev_pm_qos_request {
ae0fb4b7	54	enum dev_pm_qos_req_type type;
021c870b RW	55	union {
021c870b RW	56	struct plist_node pnode;
ae0fb4b7	57	struct pm_qos_flags_request flr;
021c870b	58	} data;
91ff4cb8 JP	59	struct device *dev;
	60	};
	61
4e1779ba JP	62	enum pm_qos_type {
	63	PM_QOS_UNITIALIZED,
	64	PM_QOS_MAX, /* return the largest value */
	65	PM_QOS_MIN /* return the smallest value */
	66	};
	67
	68	/*
5efbe427 RW	69	* Note: The lockless read path depends on the CPU accessing target_value
5efbe427 RW	70	* or effective_flags atomically. Atomic access is only guaranteed on all CPU
4e1779ba JP	71	* types linux supports for 32 bit quantites
	72	*/
	73	struct pm_qos_constraints {
	74	struct plist_head list;
	75	s32 target_value; /* Do not change to 64 bit */
	76	s32 default_value;
	77	enum pm_qos_type type;
	78	struct blocking_notifier_head *notifiers;
	79	};
	80
5efbe427 RW	81	struct pm_qos_flags {
	82	struct list_head list;
	83	s32 effective_flags; /* Do not change to 64 bit */
	84	};
	85
5f986c59 RW	86	struct dev_pm_qos {
5f986c59 RW	87	struct pm_qos_constraints latency;
ae0fb4b7	88	struct pm_qos_flags flags;
5f986c59 RW	89	};
5f986c59 RW	90
abe98ec2 JP	91	/* Action requested to pm_qos_update_target */
	92	enum pm_qos_req_action {
	93	PM_QOS_ADD_REQ, /* Add a new request */
	94	PM_QOS_UPDATE_REQ, /* Update an existing request */
	95	PM_QOS_REMOVE_REQ /* Remove an existing request */
	96	};
	97
91ff4cb8 JP	98	static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
91ff4cb8 JP	99	{
83618092	100	return req->dev != NULL;
91ff4cb8 JP	101	}
91ff4cb8 JP	102
abe98ec2 JP	103	int pm_qos_update_target(struct pm_qos_constraints c, struct plist_node node,
abe98ec2 JP	104	enum pm_qos_req_action action, int value);
5efbe427 RW	105	bool pm_qos_update_flags(struct pm_qos_flags *pqf,
	106	struct pm_qos_flags_request *req,
	107	enum pm_qos_req_action action, s32 val);
cc749986 JP	108	void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
	109	s32 value);
	110	void pm_qos_update_request(struct pm_qos_request *req,
e8db0be1	111	s32 new_value);
c4772d19 MH	112	void pm_qos_update_request_timeout(struct pm_qos_request *req,
c4772d19 MH	113	s32 new_value, unsigned long timeout_us);
cc749986	114	void pm_qos_remove_request(struct pm_qos_request *req);
d82b3518	115
ed77134b MG	116	int pm_qos_request(int pm_qos_class);
	117	int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
	118	int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
cc749986	119	int pm_qos_request_active(struct pm_qos_request *req);
b66213cd	120	s32 pm_qos_read_value(struct pm_qos_constraints *c);
91ff4cb8	121
a9b542ee	122	#ifdef CONFIG_PM
ae0fb4b7 RW	123	enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
ae0fb4b7 RW	124	enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
00dc9ad1	125	s32 __dev_pm_qos_read_value(struct device *dev);
1a9a9152	126	s32 dev_pm_qos_read_value(struct device *dev);
91ff4cb8	127	int dev_pm_qos_add_request(struct device dev, struct dev_pm_qos_request req,
ae0fb4b7	128	enum dev_pm_qos_req_type type, s32 value);
91ff4cb8 JP	129	int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
	130	int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
	131	int dev_pm_qos_add_notifier(struct device *dev,
	132	struct notifier_block *notifier);
	133	int dev_pm_qos_remove_notifier(struct device *dev,
	134	struct notifier_block *notifier);
b66213cd JP	135	int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
b66213cd JP	136	int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
91ff4cb8 JP	137	void dev_pm_qos_constraints_init(struct device *dev);
91ff4cb8 JP	138	void dev_pm_qos_constraints_destroy(struct device *dev);
40a5f8be RW	139	int dev_pm_qos_add_ancestor_request(struct device *dev,
40a5f8be RW	140	struct dev_pm_qos_request *req, s32 value);
e8db0be1	141	#else
ae0fb4b7 RW	142	static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
	143	s32 mask)
	144	{ return PM_QOS_FLAGS_UNDEFINED; }
	145	static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
	146	s32 mask)
	147	{ return PM_QOS_FLAGS_UNDEFINED; }
00dc9ad1 RW	148	static inline s32 __dev_pm_qos_read_value(struct device *dev)
00dc9ad1 RW	149	{ return 0; }
1a9a9152 RW	150	static inline s32 dev_pm_qos_read_value(struct device *dev)
1a9a9152 RW	151	{ return 0; }
91ff4cb8 JP	152	static inline int dev_pm_qos_add_request(struct device *dev,
91ff4cb8 JP	153	struct dev_pm_qos_request *req,
ae0fb4b7	154	enum dev_pm_qos_req_type type,
91ff4cb8 JP	155	s32 value)
	156	{ return 0; }
	157	static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
	158	s32 new_value)
	159	{ return 0; }
	160	static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
	161	{ return 0; }
	162	static inline int dev_pm_qos_add_notifier(struct device *dev,
	163	struct notifier_block *notifier)
	164	{ return 0; }
	165	static inline int dev_pm_qos_remove_notifier(struct device *dev,
	166	struct notifier_block *notifier)
	167	{ return 0; }
b66213cd JP	168	static inline int dev_pm_qos_add_global_notifier(
	169	struct notifier_block *notifier)
	170	{ return 0; }
	171	static inline int dev_pm_qos_remove_global_notifier(
	172	struct notifier_block *notifier)
	173	{ return 0; }
91ff4cb8	174	static inline void dev_pm_qos_constraints_init(struct device *dev)
1a9a9152 RW	175	{
	176	dev->power.power_state = PMSG_ON;
	177	}
91ff4cb8	178	static inline void dev_pm_qos_constraints_destroy(struct device *dev)
1a9a9152 RW	179	{
	180	dev->power.power_state = PMSG_INVALID;
	181	}
40a5f8be RW	182	static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
	183	struct dev_pm_qos_request *req, s32 value)
	184	{ return 0; }
e8db0be1	185	#endif
d82b3518	186
85dc0b8a RW	187	#ifdef CONFIG_PM_RUNTIME
	188	int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
	189	void dev_pm_qos_hide_latency_limit(struct device *dev);
	190	#else
	191	static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
	192	{ return 0; }
	193	static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
	194	#endif
	195
82f68251	196	#endif