blob: 775a3236343d5a4c47717c086ffae02e9d6946b8 [file] [log] [blame]
Jean Pihete8db0be2011-08-25 15:35:03 +02001#ifndef _LINUX_PM_QOS_H
2#define _LINUX_PM_QOS_H
3/* interface for the pm_qos_power infrastructure of the linux kernel.
4 *
5 * Mark Gross <mgross@linux.intel.com>
6 */
7#include <linux/plist.h>
8#include <linux/notifier.h>
9#include <linux/miscdevice.h>
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +020010#include <linux/device.h>
Jean Pihete8db0be2011-08-25 15:35:03 +020011
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
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
Jean Pihet91ff4cb2011-08-25 15:35:41 +020023#define PM_QOS_DEV_LAT_DEFAULT_VALUE 0
Jean Pihete8db0be2011-08-25 15:35:03 +020024
Jean Pihetcc749982011-08-25 15:35:12 +020025struct pm_qos_request {
26 struct plist_node node;
Jean Pihete8db0be2011-08-25 15:35:03 +020027 int pm_qos_class;
28};
29
Jean Pihet91ff4cb2011-08-25 15:35:41 +020030struct dev_pm_qos_request {
31 struct plist_node node;
32 struct device *dev;
33};
34
Jean Pihet4e1779b2011-08-25 15:35:27 +020035enum 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 */
46struct 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
Jean Pihetabe98ec2011-08-25 15:35:34 +020054/* Action requested to pm_qos_update_target */
55enum 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
Jean Pihet91ff4cb2011-08-25 15:35:41 +020061static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
62{
63 return req->dev != 0;
64}
65
Jean Pihete8db0be2011-08-25 15:35:03 +020066#ifdef CONFIG_PM
Jean Pihetabe98ec2011-08-25 15:35:34 +020067int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
68 enum pm_qos_req_action action, int value);
Jean Pihetcc749982011-08-25 15:35:12 +020069void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
70 s32 value);
71void pm_qos_update_request(struct pm_qos_request *req,
Jean Pihete8db0be2011-08-25 15:35:03 +020072 s32 new_value);
Jean Pihetcc749982011-08-25 15:35:12 +020073void pm_qos_remove_request(struct pm_qos_request *req);
Jean Pihete8db0be2011-08-25 15:35:03 +020074
75int pm_qos_request(int pm_qos_class);
76int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
77int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
Jean Pihetcc749982011-08-25 15:35:12 +020078int pm_qos_request_active(struct pm_qos_request *req);
Jean Pihetb66213c2011-08-25 15:35:47 +020079s32 pm_qos_read_value(struct pm_qos_constraints *c);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020080
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +010081s32 __dev_pm_qos_read_value(struct device *dev);
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +020082s32 dev_pm_qos_read_value(struct device *dev);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020083int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
84 s32 value);
85int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
86int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
87int dev_pm_qos_add_notifier(struct device *dev,
88 struct notifier_block *notifier);
89int dev_pm_qos_remove_notifier(struct device *dev,
90 struct notifier_block *notifier);
Jean Pihetb66213c2011-08-25 15:35:47 +020091int dev_pm_qos_add_global_notifier(struct notifier_block *notifier);
92int dev_pm_qos_remove_global_notifier(struct notifier_block *notifier);
Jean Pihet91ff4cb2011-08-25 15:35:41 +020093void dev_pm_qos_constraints_init(struct device *dev);
94void dev_pm_qos_constraints_destroy(struct device *dev);
Jean Pihete8db0be2011-08-25 15:35:03 +020095#else
Jean Pihetabe98ec2011-08-25 15:35:34 +020096static inline int pm_qos_update_target(struct pm_qos_constraints *c,
97 struct plist_node *node,
98 enum pm_qos_req_action action,
99 int value)
100 { return 0; }
Jean Pihetcc749982011-08-25 15:35:12 +0200101static inline void pm_qos_add_request(struct pm_qos_request *req,
Jean Pihete8db0be2011-08-25 15:35:03 +0200102 int pm_qos_class, s32 value)
103 { return; }
Jean Pihetcc749982011-08-25 15:35:12 +0200104static inline void pm_qos_update_request(struct pm_qos_request *req,
Jean Pihete8db0be2011-08-25 15:35:03 +0200105 s32 new_value)
106 { return; }
Jean Pihetcc749982011-08-25 15:35:12 +0200107static inline void pm_qos_remove_request(struct pm_qos_request *req)
Jean Pihete8db0be2011-08-25 15:35:03 +0200108 { return; }
109
110static inline int pm_qos_request(int pm_qos_class)
111 { return 0; }
112static inline int pm_qos_add_notifier(int pm_qos_class,
113 struct notifier_block *notifier)
114 { return 0; }
115static inline int pm_qos_remove_notifier(int pm_qos_class,
116 struct notifier_block *notifier)
117 { return 0; }
Jean Pihetcc749982011-08-25 15:35:12 +0200118static inline int pm_qos_request_active(struct pm_qos_request *req)
Jean Pihete8db0be2011-08-25 15:35:03 +0200119 { return 0; }
Jean Pihetb66213c2011-08-25 15:35:47 +0200120static inline s32 pm_qos_read_value(struct pm_qos_constraints *c)
121 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200122
Rafael J. Wysocki00dc9ad2011-12-01 00:01:31 +0100123static inline s32 __dev_pm_qos_read_value(struct device *dev)
124 { return 0; }
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200125static inline s32 dev_pm_qos_read_value(struct device *dev)
126 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200127static inline int dev_pm_qos_add_request(struct device *dev,
128 struct dev_pm_qos_request *req,
129 s32 value)
130 { return 0; }
131static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
132 s32 new_value)
133 { return 0; }
134static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
135 { return 0; }
136static inline int dev_pm_qos_add_notifier(struct device *dev,
137 struct notifier_block *notifier)
138 { return 0; }
139static inline int dev_pm_qos_remove_notifier(struct device *dev,
140 struct notifier_block *notifier)
141 { return 0; }
Jean Pihetb66213c2011-08-25 15:35:47 +0200142static inline int dev_pm_qos_add_global_notifier(
143 struct notifier_block *notifier)
144 { return 0; }
145static inline int dev_pm_qos_remove_global_notifier(
146 struct notifier_block *notifier)
147 { return 0; }
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200148static inline void dev_pm_qos_constraints_init(struct device *dev)
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200149{
150 dev->power.power_state = PMSG_ON;
151}
Jean Pihet91ff4cb2011-08-25 15:35:41 +0200152static inline void dev_pm_qos_constraints_destroy(struct device *dev)
Rafael J. Wysocki1a9a9152011-09-29 22:29:44 +0200153{
154 dev->power.power_state = PMSG_INVALID;
155}
Jean Pihete8db0be2011-08-25 15:35:03 +0200156#endif
157
158#endif