PM: QoS: Introduce frequency QoS
[linux-2.6-block.git] / include / linux / pm_qos.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
e8db0be1
JP
2#ifndef _LINUX_PM_QOS_H
3#define _LINUX_PM_QOS_H
d82b3518
MG
4/* interface for the pm_qos_power infrastructure of the linux kernel.
5 *
bf1db69f 6 * Mark Gross <mgross@linux.intel.com>
d82b3518 7 */
82f68251 8#include <linux/plist.h>
d82b3518 9#include <linux/notifier.h>
1a9a9152 10#include <linux/device.h>
c4772d19 11#include <linux/workqueue.h>
d82b3518 12
d031e1de
AF
13enum {
14 PM_QOS_RESERVED = 0,
15 PM_QOS_CPU_DMA_LATENCY,
d031e1de
AF
16
17 /* insert new class ID */
18 PM_QOS_NUM_CLASSES,
19};
d82b3518 20
ae0fb4b7
RW
21enum pm_qos_flags_status {
22 PM_QOS_FLAGS_UNDEFINED = -1,
23 PM_QOS_FLAGS_NONE,
24 PM_QOS_FLAGS_SOME,
25 PM_QOS_FLAGS_ALL,
26};
27
0759e80b
RW
28#define PM_QOS_DEFAULT_VALUE (-1)
29#define PM_QOS_LATENCY_ANY S32_MAX
30#define PM_QOS_LATENCY_ANY_NS ((s64)PM_QOS_LATENCY_ANY * NSEC_PER_USEC)
d82b3518 31
333c5ae9 32#define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
0759e80b
RW
33#define PM_QOS_RESUME_LATENCY_DEFAULT_VALUE PM_QOS_LATENCY_ANY
34#define PM_QOS_RESUME_LATENCY_NO_CONSTRAINT PM_QOS_LATENCY_ANY
35#define PM_QOS_RESUME_LATENCY_NO_CONSTRAINT_NS PM_QOS_LATENCY_ANY_NS
2d984ad1 36#define PM_QOS_LATENCY_TOLERANCE_DEFAULT_VALUE 0
208637b3
VK
37#define PM_QOS_MIN_FREQUENCY_DEFAULT_VALUE 0
38#define PM_QOS_MAX_FREQUENCY_DEFAULT_VALUE (-1)
2d984ad1 39#define PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT (-1)
333c5ae9 40
e39473d0 41#define PM_QOS_FLAG_NO_POWER_OFF (1 << 0)
e39473d0 42
cc749986
JP
43struct pm_qos_request {
44 struct plist_node node;
82f68251 45 int pm_qos_class;
c4772d19 46 struct delayed_work work; /* for pm_qos_update_request_timeout */
82f68251 47};
d82b3518 48
5efbe427
RW
49struct pm_qos_flags_request {
50 struct list_head node;
51 s32 flags; /* Do not change to 64 bit */
52};
53
ae0fb4b7 54enum dev_pm_qos_req_type {
b02f6695 55 DEV_PM_QOS_RESUME_LATENCY = 1,
2d984ad1 56 DEV_PM_QOS_LATENCY_TOLERANCE,
208637b3
VK
57 DEV_PM_QOS_MIN_FREQUENCY,
58 DEV_PM_QOS_MAX_FREQUENCY,
ae0fb4b7
RW
59 DEV_PM_QOS_FLAGS,
60};
61
91ff4cb8 62struct dev_pm_qos_request {
ae0fb4b7 63 enum dev_pm_qos_req_type type;
021c870b
RW
64 union {
65 struct plist_node pnode;
ae0fb4b7 66 struct pm_qos_flags_request flr;
021c870b 67 } data;
91ff4cb8
JP
68 struct device *dev;
69};
70
4e1779ba
JP
71enum pm_qos_type {
72 PM_QOS_UNITIALIZED,
73 PM_QOS_MAX, /* return the largest value */
7990da71
TV
74 PM_QOS_MIN, /* return the smallest value */
75 PM_QOS_SUM /* return the sum */
4e1779ba
JP
76};
77
78/*
5efbe427
RW
79 * Note: The lockless read path depends on the CPU accessing target_value
80 * or effective_flags atomically. Atomic access is only guaranteed on all CPU
4e1779ba
JP
81 * types linux supports for 32 bit quantites
82 */
83struct pm_qos_constraints {
84 struct plist_head list;
85 s32 target_value; /* Do not change to 64 bit */
86 s32 default_value;
327adaed 87 s32 no_constraint_value;
4e1779ba
JP
88 enum pm_qos_type type;
89 struct blocking_notifier_head *notifiers;
90};
91
5efbe427
RW
92struct pm_qos_flags {
93 struct list_head list;
94 s32 effective_flags; /* Do not change to 64 bit */
95};
96
5f986c59 97struct dev_pm_qos {
b02f6695 98 struct pm_qos_constraints resume_latency;
2d984ad1 99 struct pm_qos_constraints latency_tolerance;
208637b3
VK
100 struct pm_qos_constraints min_frequency;
101 struct pm_qos_constraints max_frequency;
ae0fb4b7 102 struct pm_qos_flags flags;
b02f6695 103 struct dev_pm_qos_request *resume_latency_req;
2d984ad1 104 struct dev_pm_qos_request *latency_tolerance_req;
e39473d0 105 struct dev_pm_qos_request *flags_req;
208637b3
VK
106 struct dev_pm_qos_request *min_frequency_req;
107 struct dev_pm_qos_request *max_frequency_req;
5f986c59
RW
108};
109
abe98ec2
JP
110/* Action requested to pm_qos_update_target */
111enum pm_qos_req_action {
112 PM_QOS_ADD_REQ, /* Add a new request */
113 PM_QOS_UPDATE_REQ, /* Update an existing request */
114 PM_QOS_REMOVE_REQ /* Remove an existing request */
115};
116
91ff4cb8
JP
117static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
118{
83618092 119 return req->dev != NULL;
91ff4cb8
JP
120}
121
abe98ec2
JP
122int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
123 enum pm_qos_req_action action, int value);
5efbe427
RW
124bool pm_qos_update_flags(struct pm_qos_flags *pqf,
125 struct pm_qos_flags_request *req,
126 enum pm_qos_req_action action, s32 val);
cc749986
JP
127void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
128 s32 value);
129void pm_qos_update_request(struct pm_qos_request *req,
e8db0be1 130 s32 new_value);
c4772d19
MH
131void pm_qos_update_request_timeout(struct pm_qos_request *req,
132 s32 new_value, unsigned long timeout_us);
cc749986 133void pm_qos_remove_request(struct pm_qos_request *req);
d82b3518 134
ed77134b
MG
135int pm_qos_request(int pm_qos_class);
136int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
137int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
cc749986 138int pm_qos_request_active(struct pm_qos_request *req);
b66213cd 139s32 pm_qos_read_value(struct pm_qos_constraints *c);
91ff4cb8 140
a9b542ee 141#ifdef CONFIG_PM
ae0fb4b7
RW
142enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
143enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
8262331e 144s32 __dev_pm_qos_resume_latency(struct device *dev);
2a79ea5e 145s32 dev_pm_qos_read_value(struct device *dev, enum dev_pm_qos_req_type type);
91ff4cb8 146int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
ae0fb4b7 147 enum dev_pm_qos_req_type type, s32 value);
91ff4cb8
JP
148int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
149int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
150int dev_pm_qos_add_notifier(struct device *dev,
0b07ee94
VK
151 struct notifier_block *notifier,
152 enum dev_pm_qos_req_type type);
91ff4cb8 153int dev_pm_qos_remove_notifier(struct device *dev,
0b07ee94
VK
154 struct notifier_block *notifier,
155 enum dev_pm_qos_req_type type);
91ff4cb8
JP
156void dev_pm_qos_constraints_init(struct device *dev);
157void dev_pm_qos_constraints_destroy(struct device *dev);
40a5f8be 158int dev_pm_qos_add_ancestor_request(struct device *dev,
71d821fd
RW
159 struct dev_pm_qos_request *req,
160 enum dev_pm_qos_req_type type, s32 value);
d30d819d
RW
161int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
162void dev_pm_qos_hide_latency_limit(struct device *dev);
163int dev_pm_qos_expose_flags(struct device *dev, s32 value);
164void dev_pm_qos_hide_flags(struct device *dev);
165int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
166s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev);
167int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val);
13b2c4a0
MW
168int dev_pm_qos_expose_latency_tolerance(struct device *dev);
169void dev_pm_qos_hide_latency_tolerance(struct device *dev);
d30d819d
RW
170
171static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
172{
173 return dev->power.qos->resume_latency_req->data.pnode.prio;
174}
175
176static inline s32 dev_pm_qos_requested_flags(struct device *dev)
177{
178 return dev->power.qos->flags_req->data.flr.flags;
179}
6dbf5cea 180
8262331e 181static inline s32 dev_pm_qos_raw_resume_latency(struct device *dev)
6dbf5cea
RW
182{
183 return IS_ERR_OR_NULL(dev->power.qos) ?
0759e80b
RW
184 PM_QOS_RESUME_LATENCY_NO_CONSTRAINT :
185 pm_qos_read_value(&dev->power.qos->resume_latency);
6dbf5cea 186}
e8db0be1 187#else
ae0fb4b7
RW
188static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
189 s32 mask)
190 { return PM_QOS_FLAGS_UNDEFINED; }
191static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
192 s32 mask)
193 { return PM_QOS_FLAGS_UNDEFINED; }
8262331e 194static inline s32 __dev_pm_qos_resume_latency(struct device *dev)
0759e80b 195 { return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT; }
2a79ea5e
VK
196static inline s32 dev_pm_qos_read_value(struct device *dev,
197 enum dev_pm_qos_req_type type)
198{
199 switch (type) {
200 case DEV_PM_QOS_RESUME_LATENCY:
201 return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT;
208637b3
VK
202 case DEV_PM_QOS_MIN_FREQUENCY:
203 return PM_QOS_MIN_FREQUENCY_DEFAULT_VALUE;
204 case DEV_PM_QOS_MAX_FREQUENCY:
205 return PM_QOS_MAX_FREQUENCY_DEFAULT_VALUE;
2a79ea5e
VK
206 default:
207 WARN_ON(1);
208 return 0;
209 }
210}
211
91ff4cb8
JP
212static inline int dev_pm_qos_add_request(struct device *dev,
213 struct dev_pm_qos_request *req,
ae0fb4b7 214 enum dev_pm_qos_req_type type,
91ff4cb8
JP
215 s32 value)
216 { return 0; }
217static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
218 s32 new_value)
219 { return 0; }
220static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
221 { return 0; }
222static inline int dev_pm_qos_add_notifier(struct device *dev,
0b07ee94
VK
223 struct notifier_block *notifier,
224 enum dev_pm_qos_req_type type)
91ff4cb8
JP
225 { return 0; }
226static inline int dev_pm_qos_remove_notifier(struct device *dev,
0b07ee94
VK
227 struct notifier_block *notifier,
228 enum dev_pm_qos_req_type type)
91ff4cb8
JP
229 { return 0; }
230static inline void dev_pm_qos_constraints_init(struct device *dev)
1a9a9152
RW
231{
232 dev->power.power_state = PMSG_ON;
233}
91ff4cb8 234static inline void dev_pm_qos_constraints_destroy(struct device *dev)
1a9a9152
RW
235{
236 dev->power.power_state = PMSG_INVALID;
237}
40a5f8be 238static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
71d821fd
RW
239 struct dev_pm_qos_request *req,
240 enum dev_pm_qos_req_type type,
241 s32 value)
40a5f8be 242 { return 0; }
85dc0b8a
RW
243static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
244 { return 0; }
245static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
e39473d0
RW
246static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
247 { return 0; }
248static inline void dev_pm_qos_hide_flags(struct device *dev) {}
249static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
250 { return 0; }
2d984ad1
RW
251static inline s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev)
252 { return PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT; }
253static inline int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val)
254 { return 0; }
13b2c4a0
MW
255static inline int dev_pm_qos_expose_latency_tolerance(struct device *dev)
256 { return 0; }
257static inline void dev_pm_qos_hide_latency_tolerance(struct device *dev) {}
e39473d0 258
0759e80b
RW
259static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
260{
261 return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT;
262}
e39473d0 263static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
8262331e 264static inline s32 dev_pm_qos_raw_resume_latency(struct device *dev)
0759e80b
RW
265{
266 return PM_QOS_RESUME_LATENCY_NO_CONSTRAINT;
267}
85dc0b8a
RW
268#endif
269
77751a46
RW
270#define FREQ_QOS_MIN_DEFAULT_VALUE 0
271#define FREQ_QOS_MAX_DEFAULT_VALUE (-1)
272
273enum freq_qos_req_type {
274 FREQ_QOS_MIN = 1,
275 FREQ_QOS_MAX,
276};
277
278struct freq_constraints {
279 struct pm_qos_constraints min_freq;
280 struct blocking_notifier_head min_freq_notifiers;
281 struct pm_qos_constraints max_freq;
282 struct blocking_notifier_head max_freq_notifiers;
283};
284
285struct freq_qos_request {
286 enum freq_qos_req_type type;
287 struct plist_node pnode;
288 struct freq_constraints *qos;
289};
290
291static inline int freq_qos_request_active(struct freq_qos_request *req)
292{
293 return !IS_ERR_OR_NULL(req->qos);
294}
295
296void freq_constraints_init(struct freq_constraints *qos);
297
298s32 freq_qos_read_value(struct freq_constraints *qos,
299 enum freq_qos_req_type type);
300
301int freq_qos_add_request(struct freq_constraints *qos,
302 struct freq_qos_request *req,
303 enum freq_qos_req_type type, s32 value);
304int freq_qos_update_request(struct freq_qos_request *req, s32 new_value);
305int freq_qos_remove_request(struct freq_qos_request *req);
306
307int freq_qos_add_notifier(struct freq_constraints *qos,
308 enum freq_qos_req_type type,
309 struct notifier_block *notifier);
310int freq_qos_remove_notifier(struct freq_constraints *qos,
311 enum freq_qos_req_type type,
312 struct notifier_block *notifier);
313
82f68251 314#endif