[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 <[email protected]>
 */
#include <linux/plist.h>
#include <linux/notifier.h>
#include <linux/miscdevice.h>
#include <linux/device.h>

#define PM_QOS_RESERVED 0
#define PM_QOS_CPU_DMA_LATENCY 1
#define PM_QOS_NETWORK_LATENCY 2
#define PM_QOS_NETWORK_THROUGHPUT 3

#define PM_QOS_NUM_CLASSES 4
#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 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;
};

/* 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 != 0;
}

#ifdef CONFIG_PM
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_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);

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);
#else
static inline int pm_qos_update_target(struct pm_qos_constraints *c,
				       struct plist_node *node,
				       enum pm_qos_req_action action,
				       int value)
			{ return 0; }
static inline void pm_qos_add_request(struct pm_qos_request *req,
				      int pm_qos_class, s32 value)
			{ return; }
static inline void pm_qos_update_request(struct pm_qos_request *req,
					 s32 new_value)
			{ return; }
static inline void pm_qos_remove_request(struct pm_qos_request *req)
			{ return; }

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