[deliverable/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,
};

#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 dev_pm_qos_request {
	struct plist_node node;
	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 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 dev_pm_qos {
	struct pm_qos_constraints latency;
};

/* 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);
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
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,
			   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 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,
					 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
d82b3518 MG	23	#define PM_QOS_DEFAULT_VALUE -1
d82b3518 MG	24
333c5ae9 TC	25	#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
	26	#define PM_QOS_NETWORK_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
	27	#define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
91ff4cb8	28	#define PM_QOS_DEV_LAT_DEFAULT_VALUE 0
333c5ae9	29
cc749986 JP	30	struct pm_qos_request {
cc749986 JP	31	struct plist_node node;
82f68251	32	int pm_qos_class;
c4772d19	33	struct delayed_work work; /* for pm_qos_update_request_timeout */
82f68251	34	};
d82b3518	35
91ff4cb8 JP	36	struct dev_pm_qos_request {
	37	struct plist_node node;
	38	struct device *dev;
	39	};
	40
4e1779ba JP	41	enum pm_qos_type {
	42	PM_QOS_UNITIALIZED,
	43	PM_QOS_MAX, /* return the largest value */
	44	PM_QOS_MIN /* return the smallest value */
	45	};
	46
	47	/*
	48	* Note: The lockless read path depends on the CPU accessing
	49	* target_value atomically. Atomic access is only guaranteed on all CPU
	50	* types linux supports for 32 bit quantites
	51	*/
	52	struct pm_qos_constraints {
	53	struct plist_head list;
	54	s32 target_value; /* Do not change to 64 bit */
	55	s32 default_value;
	56	enum pm_qos_type type;
	57	struct blocking_notifier_head *notifiers;
	58	};
	59
5f986c59 RW	60	struct dev_pm_qos {
	61	struct pm_qos_constraints latency;
	62	};
	63
abe98ec2 JP	64	/* Action requested to pm_qos_update_target */
	65	enum pm_qos_req_action {
	66	PM_QOS_ADD_REQ, /* Add a new request */
	67	PM_QOS_UPDATE_REQ, /* Update an existing request */
	68	PM_QOS_REMOVE_REQ /* Remove an existing request */
	69	};
	70
91ff4cb8 JP	71	static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
91ff4cb8 JP	72	{
83618092	73	return req->dev != NULL;
91ff4cb8 JP	74	}
91ff4cb8 JP	75
abe98ec2 JP	76	int pm_qos_update_target(struct pm_qos_constraints c, struct plist_node node,
abe98ec2 JP	77	enum pm_qos_req_action action, int value);
cc749986 JP	78	void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
	79	s32 value);
	80	void pm_qos_update_request(struct pm_qos_request *req,
e8db0be1	81	s32 new_value);
c4772d19 MH	82	void pm_qos_update_request_timeout(struct pm_qos_request *req,
c4772d19 MH	83	s32 new_value, unsigned long timeout_us);
cc749986	84	void pm_qos_remove_request(struct pm_qos_request *req);
d82b3518	85
ed77134b MG	86	int pm_qos_request(int pm_qos_class);
	87	int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
	88	int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
cc749986	89	int pm_qos_request_active(struct pm_qos_request *req);
b66213cd	90	s32 pm_qos_read_value(struct pm_qos_constraints *c);
91ff4cb8	91
a9b542ee	92	#ifdef CONFIG_PM
00dc9ad1	93	s32 __dev_pm_qos_read_value(struct device *dev);
1a9a9152	94	s32 dev_pm_qos_read_value(struct device *dev);
91ff4cb8 JP	95	int dev_pm_qos_add_request(struct device dev, struct dev_pm_qos_request req,
	96	s32 value);
	97	int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
	98	int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
	99	int dev_pm_qos_add_notifier(struct device *dev,
	100	struct notifier_block *notifier);
	101	int dev_pm_qos_remove_notifier(struct device *dev,
	102	struct notifier_block *notifier);
b66213cd JP	103	int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
b66213cd JP	104	int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
91ff4cb8 JP	105	void dev_pm_qos_constraints_init(struct device *dev);
91ff4cb8 JP	106	void dev_pm_qos_constraints_destroy(struct device *dev);
40a5f8be RW	107	int dev_pm_qos_add_ancestor_request(struct device *dev,
40a5f8be RW	108	struct dev_pm_qos_request *req, s32 value);
e8db0be1	109	#else
00dc9ad1 RW	110	static inline s32 __dev_pm_qos_read_value(struct device *dev)
00dc9ad1 RW	111	{ return 0; }
1a9a9152 RW	112	static inline s32 dev_pm_qos_read_value(struct device *dev)
1a9a9152 RW	113	{ return 0; }
91ff4cb8 JP	114	static inline int dev_pm_qos_add_request(struct device *dev,
	115	struct dev_pm_qos_request *req,
	116	s32 value)
	117	{ return 0; }
	118	static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
	119	s32 new_value)
	120	{ return 0; }
	121	static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
	122	{ return 0; }
	123	static inline int dev_pm_qos_add_notifier(struct device *dev,
	124	struct notifier_block *notifier)
	125	{ return 0; }
	126	static inline int dev_pm_qos_remove_notifier(struct device *dev,
	127	struct notifier_block *notifier)
	128	{ return 0; }
b66213cd JP	129	static inline int dev_pm_qos_add_global_notifier(
	130	struct notifier_block *notifier)
	131	{ return 0; }
	132	static inline int dev_pm_qos_remove_global_notifier(
	133	struct notifier_block *notifier)
	134	{ return 0; }
91ff4cb8	135	static inline void dev_pm_qos_constraints_init(struct device *dev)
1a9a9152 RW	136	{
	137	dev->power.power_state = PMSG_ON;
	138	}
91ff4cb8	139	static inline void dev_pm_qos_constraints_destroy(struct device *dev)
1a9a9152 RW	140	{
	141	dev->power.power_state = PMSG_INVALID;
	142	}
40a5f8be RW	143	static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
	144	struct dev_pm_qos_request *req, s32 value)
	145	{ return 0; }
e8db0be1	146	#endif
d82b3518	147
85dc0b8a RW	148	#ifdef CONFIG_PM_RUNTIME
	149	int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
	150	void dev_pm_qos_hide_latency_limit(struct device *dev);
	151	#else
	152	static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
	153	{ return 0; }
	154	static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
	155	#endif
	156
82f68251	157	#endif