1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_PM_QOS_H
3 #define _LINUX_PM_QOS_H
4 /* interface for the pm_qos_power infrastructure of the linux kernel.
6 * Mark Gross <mgross@linux.intel.com>
8 #include <linux/plist.h>
9 #include <linux/notifier.h>
10 #include <linux/device.h>
11 #include <linux/workqueue.h>
15 PM_QOS_CPU_DMA_LATENCY,
16 PM_QOS_NETWORK_LATENCY,
17 PM_QOS_NETWORK_THROUGHPUT,
18 PM_QOS_MEMORY_BANDWIDTH,
20 /* insert new class ID */
24 enum pm_qos_flags_status {
25 PM_QOS_FLAGS_UNDEFINED = -1,
31 #define PM_QOS_DEFAULT_VALUE -1
33 #define PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
34 #define PM_QOS_NETWORK_LAT_DEFAULT_VALUE (2000 * USEC_PER_SEC)
35 #define PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE 0
36 #define PM_QOS_MEMORY_BANDWIDTH_DEFAULT_VALUE 0
37 #define PM_QOS_RESUME_LATENCY_DEFAULT_VALUE 0
38 #define PM_QOS_LATENCY_TOLERANCE_DEFAULT_VALUE 0
39 #define PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT (-1)
40 #define PM_QOS_LATENCY_ANY ((s32)(~(__u32)0 >> 1))
42 #define PM_QOS_FLAG_NO_POWER_OFF (1 << 0)
43 #define PM_QOS_FLAG_REMOTE_WAKEUP (1 << 1)
45 struct pm_qos_request {
46 struct plist_node node;
48 struct delayed_work work; /* for pm_qos_update_request_timeout */
51 struct pm_qos_flags_request {
52 struct list_head node;
53 s32 flags; /* Do not change to 64 bit */
56 enum dev_pm_qos_req_type {
57 DEV_PM_QOS_RESUME_LATENCY = 1,
58 DEV_PM_QOS_LATENCY_TOLERANCE,
62 struct dev_pm_qos_request {
63 enum dev_pm_qos_req_type type;
65 struct plist_node pnode;
66 struct pm_qos_flags_request flr;
73 PM_QOS_MAX, /* return the largest value */
74 PM_QOS_MIN, /* return the smallest value */
75 PM_QOS_SUM /* return the sum */
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
81 * types linux supports for 32 bit quantites
83 struct pm_qos_constraints {
84 struct plist_head list;
85 s32 target_value; /* Do not change to 64 bit */
87 s32 no_constraint_value;
88 enum pm_qos_type type;
89 struct blocking_notifier_head *notifiers;
93 struct list_head list;
94 s32 effective_flags; /* Do not change to 64 bit */
98 struct pm_qos_constraints resume_latency;
99 struct pm_qos_constraints latency_tolerance;
100 struct pm_qos_flags flags;
101 struct dev_pm_qos_request *resume_latency_req;
102 struct dev_pm_qos_request *latency_tolerance_req;
103 struct dev_pm_qos_request *flags_req;
106 /* Action requested to pm_qos_update_target */
107 enum pm_qos_req_action {
108 PM_QOS_ADD_REQ, /* Add a new request */
109 PM_QOS_UPDATE_REQ, /* Update an existing request */
110 PM_QOS_REMOVE_REQ /* Remove an existing request */
113 static inline int dev_pm_qos_request_active(struct dev_pm_qos_request *req)
115 return req->dev != NULL;
118 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
119 enum pm_qos_req_action action, int value);
120 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
121 struct pm_qos_flags_request *req,
122 enum pm_qos_req_action action, s32 val);
123 void pm_qos_add_request(struct pm_qos_request *req, int pm_qos_class,
125 void pm_qos_update_request(struct pm_qos_request *req,
127 void pm_qos_update_request_timeout(struct pm_qos_request *req,
128 s32 new_value, unsigned long timeout_us);
129 void pm_qos_remove_request(struct pm_qos_request *req);
131 int pm_qos_request(int pm_qos_class);
132 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier);
133 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier);
134 int pm_qos_request_active(struct pm_qos_request *req);
135 s32 pm_qos_read_value(struct pm_qos_constraints *c);
138 enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev, s32 mask);
139 enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev, s32 mask);
140 s32 __dev_pm_qos_read_value(struct device *dev);
141 s32 dev_pm_qos_read_value(struct device *dev);
142 int dev_pm_qos_add_request(struct device *dev, struct dev_pm_qos_request *req,
143 enum dev_pm_qos_req_type type, s32 value);
144 int dev_pm_qos_update_request(struct dev_pm_qos_request *req, s32 new_value);
145 int dev_pm_qos_remove_request(struct dev_pm_qos_request *req);
146 int dev_pm_qos_add_notifier(struct device *dev,
147 struct notifier_block *notifier);
148 int dev_pm_qos_remove_notifier(struct device *dev,
149 struct notifier_block *notifier);
150 void dev_pm_qos_constraints_init(struct device *dev);
151 void dev_pm_qos_constraints_destroy(struct device *dev);
152 int dev_pm_qos_add_ancestor_request(struct device *dev,
153 struct dev_pm_qos_request *req,
154 enum dev_pm_qos_req_type type, s32 value);
155 int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value);
156 void dev_pm_qos_hide_latency_limit(struct device *dev);
157 int dev_pm_qos_expose_flags(struct device *dev, s32 value);
158 void dev_pm_qos_hide_flags(struct device *dev);
159 int dev_pm_qos_update_flags(struct device *dev, s32 mask, bool set);
160 s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev);
161 int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val);
162 int dev_pm_qos_expose_latency_tolerance(struct device *dev);
163 void dev_pm_qos_hide_latency_tolerance(struct device *dev);
165 static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev)
167 return dev->power.qos->resume_latency_req->data.pnode.prio;
170 static inline s32 dev_pm_qos_requested_flags(struct device *dev)
172 return dev->power.qos->flags_req->data.flr.flags;
175 static inline s32 dev_pm_qos_raw_read_value(struct device *dev)
177 return IS_ERR_OR_NULL(dev->power.qos) ?
178 0 : pm_qos_read_value(&dev->power.qos->resume_latency);
181 static inline enum pm_qos_flags_status __dev_pm_qos_flags(struct device *dev,
183 { return PM_QOS_FLAGS_UNDEFINED; }
184 static inline enum pm_qos_flags_status dev_pm_qos_flags(struct device *dev,
186 { return PM_QOS_FLAGS_UNDEFINED; }
187 static inline s32 __dev_pm_qos_read_value(struct device *dev)
189 static inline s32 dev_pm_qos_read_value(struct device *dev)
191 static inline int dev_pm_qos_add_request(struct device *dev,
192 struct dev_pm_qos_request *req,
193 enum dev_pm_qos_req_type type,
196 static inline int dev_pm_qos_update_request(struct dev_pm_qos_request *req,
199 static inline int dev_pm_qos_remove_request(struct dev_pm_qos_request *req)
201 static inline int dev_pm_qos_add_notifier(struct device *dev,
202 struct notifier_block *notifier)
204 static inline int dev_pm_qos_remove_notifier(struct device *dev,
205 struct notifier_block *notifier)
207 static inline void dev_pm_qos_constraints_init(struct device *dev)
209 dev->power.power_state = PMSG_ON;
211 static inline void dev_pm_qos_constraints_destroy(struct device *dev)
213 dev->power.power_state = PMSG_INVALID;
215 static inline int dev_pm_qos_add_ancestor_request(struct device *dev,
216 struct dev_pm_qos_request *req,
217 enum dev_pm_qos_req_type type,
220 static inline int dev_pm_qos_expose_latency_limit(struct device *dev, s32 value)
222 static inline void dev_pm_qos_hide_latency_limit(struct device *dev) {}
223 static inline int dev_pm_qos_expose_flags(struct device *dev, s32 value)
225 static inline void dev_pm_qos_hide_flags(struct device *dev) {}
226 static inline int dev_pm_qos_update_flags(struct device *dev, s32 m, bool set)
228 static inline s32 dev_pm_qos_get_user_latency_tolerance(struct device *dev)
229 { return PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT; }
230 static inline int dev_pm_qos_update_user_latency_tolerance(struct device *dev, s32 val)
232 static inline int dev_pm_qos_expose_latency_tolerance(struct device *dev)
234 static inline void dev_pm_qos_hide_latency_tolerance(struct device *dev) {}
236 static inline s32 dev_pm_qos_requested_resume_latency(struct device *dev) { return 0; }
237 static inline s32 dev_pm_qos_requested_flags(struct device *dev) { return 0; }
238 static inline s32 dev_pm_qos_raw_read_value(struct device *dev) { return 0; }