blob: 83edf8698118628fa72d890d8fd844eeade86366 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Mark Grossd82b3512008-02-04 22:30:08 -08002/*
3 * This module exposes the interface to kernel space for specifying
4 * QoS dependencies. It provides infrastructure for registration of:
5 *
Mark Grossed771342010-05-06 01:59:26 +02006 * Dependents on a QoS value : register requests
Mark Grossd82b3512008-02-04 22:30:08 -08007 * Watchers of QoS value : get notified when target QoS value changes
8 *
9 * This QoS design is best effort based. Dependents register their QoS needs.
10 * Watchers register to keep track of the current QoS needs of the system.
11 *
12 * There are 3 basic classes of QoS parameter: latency, timeout, throughput
13 * each have defined units:
14 * latency: usec
15 * timeout: usec <-- currently not used.
16 * throughput: kbs (kilo byte / sec)
17 *
Mark Grossed771342010-05-06 01:59:26 +020018 * There are lists of pm_qos_objects each one wrapping requests, notifiers
Mark Grossd82b3512008-02-04 22:30:08 -080019 *
Mark Grossed771342010-05-06 01:59:26 +020020 * User mode requests on a QOS parameter register themselves to the
Mark Grossd82b3512008-02-04 22:30:08 -080021 * subsystem by opening the device node /dev/... and writing there request to
22 * the node. As long as the process holds a file handle open to the node the
23 * client continues to be accounted for. Upon file release the usermode
Mark Grossed771342010-05-06 01:59:26 +020024 * request is removed and a new qos target is computed. This way when the
25 * request that the application has is cleaned up when closes the file
Mark Grossd82b3512008-02-04 22:30:08 -080026 * pointer or exits the pm_qos_object will get an opportunity to clean up.
27 *
Richard Hughesbf1db692008-08-05 13:01:35 -070028 * Mark Gross <mgross@linux.intel.com>
Mark Grossd82b3512008-02-04 22:30:08 -080029 */
30
Mark Grossed771342010-05-06 01:59:26 +020031/*#define DEBUG*/
32
Jean Pihete8db0be2011-08-25 15:35:03 +020033#include <linux/pm_qos.h>
Mark Grossd82b3512008-02-04 22:30:08 -080034#include <linux/sched.h>
35#include <linux/spinlock.h>
36#include <linux/slab.h>
37#include <linux/time.h>
38#include <linux/fs.h>
39#include <linux/device.h>
40#include <linux/miscdevice.h>
41#include <linux/string.h>
42#include <linux/platform_device.h>
43#include <linux/init.h>
Rafael J. Wysocki0775a602011-05-27 00:05:23 +020044#include <linux/kernel.h>
Nishanth Menonf5f4eda2014-12-05 11:19:08 -060045#include <linux/debugfs.h>
46#include <linux/seq_file.h>
Mark Grossd82b3512008-02-04 22:30:08 -080047
48#include <linux/uaccess.h>
Paul Gortmaker6e5fdee2011-05-26 16:00:52 -040049#include <linux/export.h>
Sahara247e9ee2013-06-21 11:12:28 +090050#include <trace/events/power.h>
Mark Grossd82b3512008-02-04 22:30:08 -080051
52/*
Jean Pihetcc749982011-08-25 15:35:12 +020053 * locking rule: all changes to constraints or notifiers lists
Mark Grossd82b3512008-02-04 22:30:08 -080054 * or pm_qos_object list and pm_qos_objects need to happen with pm_qos_lock
55 * held, taken with _irqsave. One lock to rule them all
56 */
Mark Grossd82b3512008-02-04 22:30:08 -080057struct pm_qos_object {
Jean Pihet4e1779b2011-08-25 15:35:27 +020058 struct pm_qos_constraints *constraints;
Mark Grossd82b3512008-02-04 22:30:08 -080059 struct miscdevice pm_qos_power_miscdev;
60 char *name;
Mark Grossd82b3512008-02-04 22:30:08 -080061};
62
James Bottomley5f279842010-07-19 02:00:18 +020063static DEFINE_SPINLOCK(pm_qos_lock);
64
Mark Grossd82b3512008-02-04 22:30:08 -080065static struct pm_qos_object null_pm_qos;
Jean Pihet4e1779b2011-08-25 15:35:27 +020066
Mark Grossd82b3512008-02-04 22:30:08 -080067static BLOCKING_NOTIFIER_HEAD(cpu_dma_lat_notifier);
Jean Pihet4e1779b2011-08-25 15:35:27 +020068static struct pm_qos_constraints cpu_dma_constraints = {
69 .list = PLIST_HEAD_INIT(cpu_dma_constraints.list),
Tim Chen333c5ae2011-02-11 12:49:04 -080070 .target_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
71 .default_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
Rafael J. Wysocki327adae2014-02-11 00:35:29 +010072 .no_constraint_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
James Bottomley5f279842010-07-19 02:00:18 +020073 .type = PM_QOS_MIN,
Jean Pihet4e1779b2011-08-25 15:35:27 +020074 .notifiers = &cpu_dma_lat_notifier,
75};
76static struct pm_qos_object cpu_dma_pm_qos = {
77 .constraints = &cpu_dma_constraints,
Dominik Brodowskia6f05b92011-11-06 21:54:12 +010078 .name = "cpu_dma_latency",
Mark Grossd82b3512008-02-04 22:30:08 -080079};
80
Mark Grossd82b3512008-02-04 22:30:08 -080081static struct pm_qos_object *pm_qos_array[] = {
82 &null_pm_qos,
83 &cpu_dma_pm_qos,
Mark Grossd82b3512008-02-04 22:30:08 -080084};
85
Mark Grossd82b3512008-02-04 22:30:08 -080086static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
87 size_t count, loff_t *f_pos);
Thomas Renningerf9b9e802011-02-28 22:06:34 +010088static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
89 size_t count, loff_t *f_pos);
Mark Grossd82b3512008-02-04 22:30:08 -080090static int pm_qos_power_open(struct inode *inode, struct file *filp);
91static int pm_qos_power_release(struct inode *inode, struct file *filp);
92
93static const struct file_operations pm_qos_power_fops = {
94 .write = pm_qos_power_write,
Thomas Renningerf9b9e802011-02-28 22:06:34 +010095 .read = pm_qos_power_read,
Mark Grossd82b3512008-02-04 22:30:08 -080096 .open = pm_qos_power_open,
97 .release = pm_qos_power_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +020098 .llseek = noop_llseek,
Mark Grossd82b3512008-02-04 22:30:08 -080099};
100
James Bottomley5f279842010-07-19 02:00:18 +0200101/* unlocked internal variant */
Jean Pihetabe98ec2011-08-25 15:35:34 +0200102static inline int pm_qos_get_value(struct pm_qos_constraints *c)
Mark Grossd82b3512008-02-04 22:30:08 -0800103{
Tomeu Vizoso7990da72014-09-03 17:49:32 +0200104 struct plist_node *node;
105 int total_value = 0;
106
Jean Pihetabe98ec2011-08-25 15:35:34 +0200107 if (plist_head_empty(&c->list))
Rafael J. Wysocki327adae2014-02-11 00:35:29 +0100108 return c->no_constraint_value;
James Bottomley5f279842010-07-19 02:00:18 +0200109
Jean Pihetabe98ec2011-08-25 15:35:34 +0200110 switch (c->type) {
James Bottomley5f279842010-07-19 02:00:18 +0200111 case PM_QOS_MIN:
Jean Pihetabe98ec2011-08-25 15:35:34 +0200112 return plist_first(&c->list)->prio;
James Bottomley5f279842010-07-19 02:00:18 +0200113
114 case PM_QOS_MAX:
Jean Pihetabe98ec2011-08-25 15:35:34 +0200115 return plist_last(&c->list)->prio;
James Bottomley5f279842010-07-19 02:00:18 +0200116
Tomeu Vizoso7990da72014-09-03 17:49:32 +0200117 case PM_QOS_SUM:
118 plist_for_each(node, &c->list)
119 total_value += node->prio;
120
121 return total_value;
122
James Bottomley5f279842010-07-19 02:00:18 +0200123 default:
124 /* runtime check for not using enum */
125 BUG();
Luis Gonzalez Fernandezc6a57bf2012-09-07 21:35:21 +0200126 return PM_QOS_DEFAULT_VALUE;
James Bottomley5f279842010-07-19 02:00:18 +0200127 }
Mark Grossd82b3512008-02-04 22:30:08 -0800128}
129
Jean Pihetb66213c2011-08-25 15:35:47 +0200130s32 pm_qos_read_value(struct pm_qos_constraints *c)
Tim Chen333c5ae2011-02-11 12:49:04 -0800131{
Jean Pihetabe98ec2011-08-25 15:35:34 +0200132 return c->target_value;
Tim Chen333c5ae2011-02-11 12:49:04 -0800133}
134
Jean Pihetabe98ec2011-08-25 15:35:34 +0200135static inline void pm_qos_set_value(struct pm_qos_constraints *c, s32 value)
Tim Chen333c5ae2011-02-11 12:49:04 -0800136{
Jean Pihetabe98ec2011-08-25 15:35:34 +0200137 c->target_value = value;
Tim Chen333c5ae2011-02-11 12:49:04 -0800138}
139
Yangtao Li96c69352018-11-06 09:38:06 -0500140static int pm_qos_debug_show(struct seq_file *s, void *unused)
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600141{
142 struct pm_qos_object *qos = (struct pm_qos_object *)s->private;
143 struct pm_qos_constraints *c;
144 struct pm_qos_request *req;
145 char *type;
146 unsigned long flags;
147 int tot_reqs = 0;
148 int active_reqs = 0;
149
150 if (IS_ERR_OR_NULL(qos)) {
151 pr_err("%s: bad qos param!\n", __func__);
152 return -EINVAL;
153 }
154 c = qos->constraints;
155 if (IS_ERR_OR_NULL(c)) {
156 pr_err("%s: Bad constraints on qos?\n", __func__);
157 return -EINVAL;
158 }
159
160 /* Lock to ensure we have a snapshot */
161 spin_lock_irqsave(&pm_qos_lock, flags);
162 if (plist_head_empty(&c->list)) {
163 seq_puts(s, "Empty!\n");
164 goto out;
165 }
166
167 switch (c->type) {
168 case PM_QOS_MIN:
169 type = "Minimum";
170 break;
171 case PM_QOS_MAX:
172 type = "Maximum";
173 break;
174 case PM_QOS_SUM:
175 type = "Sum";
176 break;
177 default:
178 type = "Unknown";
179 }
180
181 plist_for_each_entry(req, &c->list, node) {
182 char *state = "Default";
183
184 if ((req->node).prio != c->default_value) {
185 active_reqs++;
186 state = "Active";
187 }
188 tot_reqs++;
189 seq_printf(s, "%d: %d: %s\n", tot_reqs,
190 (req->node).prio, state);
191 }
192
193 seq_printf(s, "Type=%s, Value=%d, Requests: active=%d / total=%d\n",
194 type, pm_qos_get_value(c), active_reqs, tot_reqs);
195
196out:
197 spin_unlock_irqrestore(&pm_qos_lock, flags);
198 return 0;
199}
200
Yangtao Li96c69352018-11-06 09:38:06 -0500201DEFINE_SHOW_ATTRIBUTE(pm_qos_debug);
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600202
Jean Pihetabe98ec2011-08-25 15:35:34 +0200203/**
204 * pm_qos_update_target - manages the constraints list and calls the notifiers
205 * if needed
206 * @c: constraints data struct
207 * @node: request to add to the list, to update or to remove
208 * @action: action to take on the constraints list
209 * @value: value of the request to add or update
210 *
211 * This function returns 1 if the aggregated constraint value has changed, 0
212 * otherwise.
213 */
214int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
215 enum pm_qos_req_action action, int value)
Mark Grossd82b3512008-02-04 22:30:08 -0800216{
Mark Grossd82b3512008-02-04 22:30:08 -0800217 unsigned long flags;
Jean Pihetabe98ec2011-08-25 15:35:34 +0200218 int prev_value, curr_value, new_value;
Rafael J. Wysocki2d984ad2014-02-11 00:35:38 +0100219 int ret;
Mark Grossd82b3512008-02-04 22:30:08 -0800220
221 spin_lock_irqsave(&pm_qos_lock, flags);
Jean Pihetabe98ec2011-08-25 15:35:34 +0200222 prev_value = pm_qos_get_value(c);
223 if (value == PM_QOS_DEFAULT_VALUE)
224 new_value = c->default_value;
225 else
226 new_value = value;
227
228 switch (action) {
229 case PM_QOS_REMOVE_REQ:
230 plist_del(node, &c->list);
231 break;
232 case PM_QOS_UPDATE_REQ:
James Bottomley5f279842010-07-19 02:00:18 +0200233 /*
234 * to change the list, we atomically remove, reinit
235 * with new value and add, then see if the extremal
236 * changed
237 */
Jean Pihetabe98ec2011-08-25 15:35:34 +0200238 plist_del(node, &c->list);
Gustavo A. R. Silvafe43e2c2018-03-30 16:18:44 -0500239 /* fall through */
Jean Pihetabe98ec2011-08-25 15:35:34 +0200240 case PM_QOS_ADD_REQ:
241 plist_node_init(node, new_value);
242 plist_add(node, &c->list);
243 break;
244 default:
245 /* no action */
246 ;
Mark Grossd82b3512008-02-04 22:30:08 -0800247 }
Jean Pihetabe98ec2011-08-25 15:35:34 +0200248
249 curr_value = pm_qos_get_value(c);
250 pm_qos_set_value(c, curr_value);
251
Mark Grossd82b3512008-02-04 22:30:08 -0800252 spin_unlock_irqrestore(&pm_qos_lock, flags);
253
Sahara247e9ee2013-06-21 11:12:28 +0900254 trace_pm_qos_update_target(action, prev_value, curr_value);
Jean Pihetabe98ec2011-08-25 15:35:34 +0200255 if (prev_value != curr_value) {
Rafael J. Wysocki2d984ad2014-02-11 00:35:38 +0100256 ret = 1;
257 if (c->notifiers)
258 blocking_notifier_call_chain(c->notifiers,
259 (unsigned long)curr_value,
260 NULL);
Jean Pihetabe98ec2011-08-25 15:35:34 +0200261 } else {
Rafael J. Wysocki2d984ad2014-02-11 00:35:38 +0100262 ret = 0;
Jean Pihetabe98ec2011-08-25 15:35:34 +0200263 }
Rafael J. Wysocki2d984ad2014-02-11 00:35:38 +0100264 return ret;
Mark Grossd82b3512008-02-04 22:30:08 -0800265}
266
Mark Grossd82b3512008-02-04 22:30:08 -0800267/**
Rafael J. Wysocki5efbe422012-10-23 01:07:46 +0200268 * pm_qos_flags_remove_req - Remove device PM QoS flags request.
269 * @pqf: Device PM QoS flags set to remove the request from.
270 * @req: Request to remove from the set.
271 */
272static void pm_qos_flags_remove_req(struct pm_qos_flags *pqf,
273 struct pm_qos_flags_request *req)
274{
275 s32 val = 0;
276
277 list_del(&req->node);
278 list_for_each_entry(req, &pqf->list, node)
279 val |= req->flags;
280
281 pqf->effective_flags = val;
282}
283
284/**
285 * pm_qos_update_flags - Update a set of PM QoS flags.
286 * @pqf: Set of flags to update.
287 * @req: Request to add to the set, to modify, or to remove from the set.
288 * @action: Action to take on the set.
289 * @val: Value of the request to add or modify.
290 *
291 * Update the given set of PM QoS flags and call notifiers if the aggregate
292 * value has changed. Returns 1 if the aggregate constraint value has changed,
293 * 0 otherwise.
294 */
295bool pm_qos_update_flags(struct pm_qos_flags *pqf,
296 struct pm_qos_flags_request *req,
297 enum pm_qos_req_action action, s32 val)
298{
299 unsigned long irqflags;
300 s32 prev_value, curr_value;
301
302 spin_lock_irqsave(&pm_qos_lock, irqflags);
303
304 prev_value = list_empty(&pqf->list) ? 0 : pqf->effective_flags;
305
306 switch (action) {
307 case PM_QOS_REMOVE_REQ:
308 pm_qos_flags_remove_req(pqf, req);
309 break;
310 case PM_QOS_UPDATE_REQ:
311 pm_qos_flags_remove_req(pqf, req);
Gustavo A. R. Silvafe43e2c2018-03-30 16:18:44 -0500312 /* fall through */
Rafael J. Wysocki5efbe422012-10-23 01:07:46 +0200313 case PM_QOS_ADD_REQ:
314 req->flags = val;
315 INIT_LIST_HEAD(&req->node);
316 list_add_tail(&req->node, &pqf->list);
317 pqf->effective_flags |= val;
318 break;
319 default:
320 /* no action */
321 ;
322 }
323
324 curr_value = list_empty(&pqf->list) ? 0 : pqf->effective_flags;
325
326 spin_unlock_irqrestore(&pm_qos_lock, irqflags);
327
Sahara247e9ee2013-06-21 11:12:28 +0900328 trace_pm_qos_update_flags(action, prev_value, curr_value);
Rafael J. Wysocki5efbe422012-10-23 01:07:46 +0200329 return prev_value != curr_value;
330}
331
332/**
Mark Grossed771342010-05-06 01:59:26 +0200333 * pm_qos_request - returns current system wide qos expectation
Mark Grossd82b3512008-02-04 22:30:08 -0800334 * @pm_qos_class: identification of which qos value is requested
335 *
Tim Chen333c5ae2011-02-11 12:49:04 -0800336 * This function returns the current target value.
Mark Grossd82b3512008-02-04 22:30:08 -0800337 */
Mark Grossed771342010-05-06 01:59:26 +0200338int pm_qos_request(int pm_qos_class)
Mark Grossd82b3512008-02-04 22:30:08 -0800339{
Jean Pihetabe98ec2011-08-25 15:35:34 +0200340 return pm_qos_read_value(pm_qos_array[pm_qos_class]->constraints);
Mark Grossd82b3512008-02-04 22:30:08 -0800341}
Mark Grossed771342010-05-06 01:59:26 +0200342EXPORT_SYMBOL_GPL(pm_qos_request);
Mark Grossd82b3512008-02-04 22:30:08 -0800343
Jean Pihetcc749982011-08-25 15:35:12 +0200344int pm_qos_request_active(struct pm_qos_request *req)
James Bottomley82f68252010-07-05 22:53:06 +0200345{
346 return req->pm_qos_class != 0;
347}
348EXPORT_SYMBOL_GPL(pm_qos_request_active);
349
Stephen Boyd40fea92f2013-08-13 14:12:40 -0700350static void __pm_qos_update_request(struct pm_qos_request *req,
351 s32 new_value)
352{
353 trace_pm_qos_update_request(req->pm_qos_class, new_value);
354
355 if (new_value != req->node.prio)
356 pm_qos_update_target(
357 pm_qos_array[req->pm_qos_class]->constraints,
358 &req->node, PM_QOS_UPDATE_REQ, new_value);
359}
360
Mark Grossd82b3512008-02-04 22:30:08 -0800361/**
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200362 * pm_qos_work_fn - the timeout handler of pm_qos_update_request_timeout
363 * @work: work struct for the delayed work (timeout)
364 *
365 * This cancels the timeout request by falling back to the default at timeout.
366 */
367static void pm_qos_work_fn(struct work_struct *work)
368{
369 struct pm_qos_request *req = container_of(to_delayed_work(work),
370 struct pm_qos_request,
371 work);
372
Stephen Boyd40fea92f2013-08-13 14:12:40 -0700373 __pm_qos_update_request(req, PM_QOS_DEFAULT_VALUE);
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200374}
375
376/**
Mark Grossed771342010-05-06 01:59:26 +0200377 * pm_qos_add_request - inserts new qos request into the list
Jean Pihetcc749982011-08-25 15:35:12 +0200378 * @req: pointer to a preallocated handle
Saravana Kannan25cc69e2010-08-26 20:18:43 +0200379 * @pm_qos_class: identifies which list of qos request to use
Mark Grossd82b3512008-02-04 22:30:08 -0800380 * @value: defines the qos request
381 *
382 * This function inserts a new entry in the pm_qos_class list of requested qos
Richard Hughesbf1db692008-08-05 13:01:35 -0700383 * performance characteristics. It recomputes the aggregate QoS expectations
Jean Pihetcc749982011-08-25 15:35:12 +0200384 * for the pm_qos_class of parameters and initializes the pm_qos_request
Saravana Kannan25cc69e2010-08-26 20:18:43 +0200385 * handle. Caller needs to save this handle for later use in updates and
386 * removal.
Mark Grossd82b3512008-02-04 22:30:08 -0800387 */
Saravana Kannan25cc69e2010-08-26 20:18:43 +0200388
Jean Pihetcc749982011-08-25 15:35:12 +0200389void pm_qos_add_request(struct pm_qos_request *req,
James Bottomley82f68252010-07-05 22:53:06 +0200390 int pm_qos_class, s32 value)
Mark Grossd82b3512008-02-04 22:30:08 -0800391{
Jean Pihetabe98ec2011-08-25 15:35:34 +0200392 if (!req) /*guard against callers passing in null */
393 return;
Mark Grossd82b3512008-02-04 22:30:08 -0800394
Jean Pihetcc749982011-08-25 15:35:12 +0200395 if (pm_qos_request_active(req)) {
James Bottomley82f68252010-07-05 22:53:06 +0200396 WARN(1, KERN_ERR "pm_qos_add_request() called for already added request\n");
397 return;
Mark Grossd82b3512008-02-04 22:30:08 -0800398 }
Jean Pihetcc749982011-08-25 15:35:12 +0200399 req->pm_qos_class = pm_qos_class;
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200400 INIT_DELAYED_WORK(&req->work, pm_qos_work_fn);
Saharaae8822b2013-06-21 11:12:29 +0900401 trace_pm_qos_add_request(pm_qos_class, value);
Jean Pihetabe98ec2011-08-25 15:35:34 +0200402 pm_qos_update_target(pm_qos_array[pm_qos_class]->constraints,
403 &req->node, PM_QOS_ADD_REQ, value);
Mark Grossd82b3512008-02-04 22:30:08 -0800404}
Mark Grossed771342010-05-06 01:59:26 +0200405EXPORT_SYMBOL_GPL(pm_qos_add_request);
Mark Grossd82b3512008-02-04 22:30:08 -0800406
407/**
Mark Grossed771342010-05-06 01:59:26 +0200408 * pm_qos_update_request - modifies an existing qos request
Jean Pihetcc749982011-08-25 15:35:12 +0200409 * @req : handle to list element holding a pm_qos request to use
Mark Grossd82b3512008-02-04 22:30:08 -0800410 * @value: defines the qos request
411 *
Mark Grossed771342010-05-06 01:59:26 +0200412 * Updates an existing qos request for the pm_qos_class of parameters along
Mark Grossd82b3512008-02-04 22:30:08 -0800413 * with updating the target pm_qos_class value.
414 *
Mark Grossed771342010-05-06 01:59:26 +0200415 * Attempts are made to make this code callable on hot code paths.
Mark Grossd82b3512008-02-04 22:30:08 -0800416 */
Jean Pihetcc749982011-08-25 15:35:12 +0200417void pm_qos_update_request(struct pm_qos_request *req,
James Bottomley5f279842010-07-19 02:00:18 +0200418 s32 new_value)
Mark Grossd82b3512008-02-04 22:30:08 -0800419{
Jean Pihetcc749982011-08-25 15:35:12 +0200420 if (!req) /*guard against callers passing in null */
James Bottomley5f279842010-07-19 02:00:18 +0200421 return;
Mark Grossed771342010-05-06 01:59:26 +0200422
Jean Pihetcc749982011-08-25 15:35:12 +0200423 if (!pm_qos_request_active(req)) {
James Bottomley82f68252010-07-05 22:53:06 +0200424 WARN(1, KERN_ERR "pm_qos_update_request() called for unknown object\n");
425 return;
426 }
427
Tejun Heoa81f80f2016-09-16 15:49:33 -0400428 cancel_delayed_work_sync(&req->work);
Stephen Boyd40fea92f2013-08-13 14:12:40 -0700429 __pm_qos_update_request(req, new_value);
Mark Grossd82b3512008-02-04 22:30:08 -0800430}
Mark Grossed771342010-05-06 01:59:26 +0200431EXPORT_SYMBOL_GPL(pm_qos_update_request);
Mark Grossd82b3512008-02-04 22:30:08 -0800432
433/**
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200434 * pm_qos_update_request_timeout - modifies an existing qos request temporarily.
435 * @req : handle to list element holding a pm_qos request to use
436 * @new_value: defines the temporal qos request
437 * @timeout_us: the effective duration of this qos request in usecs.
438 *
439 * After timeout_us, this qos request is cancelled automatically.
440 */
441void pm_qos_update_request_timeout(struct pm_qos_request *req, s32 new_value,
442 unsigned long timeout_us)
443{
444 if (!req)
445 return;
446 if (WARN(!pm_qos_request_active(req),
447 "%s called for unknown object.", __func__))
448 return;
449
Tejun Heoed1ac6e2013-01-11 13:37:33 +0100450 cancel_delayed_work_sync(&req->work);
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200451
Saharaae8822b2013-06-21 11:12:29 +0900452 trace_pm_qos_update_request_timeout(req->pm_qos_class,
453 new_value, timeout_us);
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200454 if (new_value != req->node.prio)
455 pm_qos_update_target(
456 pm_qos_array[req->pm_qos_class]->constraints,
457 &req->node, PM_QOS_UPDATE_REQ, new_value);
458
459 schedule_delayed_work(&req->work, usecs_to_jiffies(timeout_us));
460}
461
462/**
Mark Grossed771342010-05-06 01:59:26 +0200463 * pm_qos_remove_request - modifies an existing qos request
Jean Pihetcc749982011-08-25 15:35:12 +0200464 * @req: handle to request list element
Mark Grossd82b3512008-02-04 22:30:08 -0800465 *
Jean Pihetcc749982011-08-25 15:35:12 +0200466 * Will remove pm qos request from the list of constraints and
Mark Grossed771342010-05-06 01:59:26 +0200467 * recompute the current target value for the pm_qos_class. Call this
468 * on slow code paths.
Mark Grossd82b3512008-02-04 22:30:08 -0800469 */
Jean Pihetcc749982011-08-25 15:35:12 +0200470void pm_qos_remove_request(struct pm_qos_request *req)
Mark Grossd82b3512008-02-04 22:30:08 -0800471{
Jean Pihetabe98ec2011-08-25 15:35:34 +0200472 if (!req) /*guard against callers passing in null */
Mark Grossed771342010-05-06 01:59:26 +0200473 return;
474 /* silent return to keep pcm code cleaner */
475
Jean Pihetcc749982011-08-25 15:35:12 +0200476 if (!pm_qos_request_active(req)) {
James Bottomley82f68252010-07-05 22:53:06 +0200477 WARN(1, KERN_ERR "pm_qos_remove_request() called for unknown object\n");
478 return;
479 }
480
Tejun Heoed1ac6e2013-01-11 13:37:33 +0100481 cancel_delayed_work_sync(&req->work);
MyungJoo Hamc4772d12012-03-28 23:31:24 +0200482
Saharaae8822b2013-06-21 11:12:29 +0900483 trace_pm_qos_remove_request(req->pm_qos_class, PM_QOS_DEFAULT_VALUE);
Jean Pihetabe98ec2011-08-25 15:35:34 +0200484 pm_qos_update_target(pm_qos_array[req->pm_qos_class]->constraints,
485 &req->node, PM_QOS_REMOVE_REQ,
486 PM_QOS_DEFAULT_VALUE);
Jean Pihetcc749982011-08-25 15:35:12 +0200487 memset(req, 0, sizeof(*req));
Mark Grossd82b3512008-02-04 22:30:08 -0800488}
Mark Grossed771342010-05-06 01:59:26 +0200489EXPORT_SYMBOL_GPL(pm_qos_remove_request);
Mark Grossd82b3512008-02-04 22:30:08 -0800490
491/**
492 * pm_qos_add_notifier - sets notification entry for changes to target value
493 * @pm_qos_class: identifies which qos target changes should be notified.
494 * @notifier: notifier block managed by caller.
495 *
496 * will register the notifier into a notification chain that gets called
Richard Hughesbf1db692008-08-05 13:01:35 -0700497 * upon changes to the pm_qos_class target value.
Mark Grossd82b3512008-02-04 22:30:08 -0800498 */
Mark Grossed771342010-05-06 01:59:26 +0200499int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier)
Mark Grossd82b3512008-02-04 22:30:08 -0800500{
501 int retval;
502
503 retval = blocking_notifier_chain_register(
Jean Pihet4e1779b2011-08-25 15:35:27 +0200504 pm_qos_array[pm_qos_class]->constraints->notifiers,
505 notifier);
Mark Grossd82b3512008-02-04 22:30:08 -0800506
507 return retval;
508}
509EXPORT_SYMBOL_GPL(pm_qos_add_notifier);
510
511/**
512 * pm_qos_remove_notifier - deletes notification entry from chain.
513 * @pm_qos_class: identifies which qos target changes are notified.
514 * @notifier: notifier block to be removed.
515 *
516 * will remove the notifier from the notification chain that gets called
Richard Hughesbf1db692008-08-05 13:01:35 -0700517 * upon changes to the pm_qos_class target value.
Mark Grossd82b3512008-02-04 22:30:08 -0800518 */
519int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier)
520{
521 int retval;
522
523 retval = blocking_notifier_chain_unregister(
Jean Pihet4e1779b2011-08-25 15:35:27 +0200524 pm_qos_array[pm_qos_class]->constraints->notifiers,
525 notifier);
Mark Grossd82b3512008-02-04 22:30:08 -0800526
527 return retval;
528}
529EXPORT_SYMBOL_GPL(pm_qos_remove_notifier);
530
Jean Pihet4a31a332011-08-25 15:35:20 +0200531/* User space interface to PM QoS classes via misc devices */
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600532static int register_pm_qos_misc(struct pm_qos_object *qos, struct dentry *d)
Jean Pihet4a31a332011-08-25 15:35:20 +0200533{
534 qos->pm_qos_power_miscdev.minor = MISC_DYNAMIC_MINOR;
535 qos->pm_qos_power_miscdev.name = qos->name;
536 qos->pm_qos_power_miscdev.fops = &pm_qos_power_fops;
537
Greg Kroah-Hartman659dc452019-01-22 16:21:47 +0100538 debugfs_create_file(qos->name, S_IRUGO, d, (void *)qos,
539 &pm_qos_debug_fops);
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600540
Jean Pihet4a31a332011-08-25 15:35:20 +0200541 return misc_register(&qos->pm_qos_power_miscdev);
542}
543
544static int find_pm_qos_object_by_minor(int minor)
545{
546 int pm_qos_class;
547
Saharad24c2a42013-06-20 11:33:57 +0900548 for (pm_qos_class = PM_QOS_CPU_DMA_LATENCY;
Jean Pihet4a31a332011-08-25 15:35:20 +0200549 pm_qos_class < PM_QOS_NUM_CLASSES; pm_qos_class++) {
550 if (minor ==
551 pm_qos_array[pm_qos_class]->pm_qos_power_miscdev.minor)
552 return pm_qos_class;
553 }
554 return -1;
555}
556
Mark Grossd82b3512008-02-04 22:30:08 -0800557static int pm_qos_power_open(struct inode *inode, struct file *filp)
558{
Mark Grossd82b3512008-02-04 22:30:08 -0800559 long pm_qos_class;
560
561 pm_qos_class = find_pm_qos_object_by_minor(iminor(inode));
Saharad24c2a42013-06-20 11:33:57 +0900562 if (pm_qos_class >= PM_QOS_CPU_DMA_LATENCY) {
Jean Pihetcc749982011-08-25 15:35:12 +0200563 struct pm_qos_request *req = kzalloc(sizeof(*req), GFP_KERNEL);
James Bottomley82f68252010-07-05 22:53:06 +0200564 if (!req)
565 return -ENOMEM;
566
567 pm_qos_add_request(req, pm_qos_class, PM_QOS_DEFAULT_VALUE);
568 filp->private_data = req;
Mark Grossed771342010-05-06 01:59:26 +0200569
Guennadi Liakhovetski6513fd62011-11-03 10:12:36 +0100570 return 0;
Mark Grossd82b3512008-02-04 22:30:08 -0800571 }
Mark Grossd82b3512008-02-04 22:30:08 -0800572 return -EPERM;
573}
574
575static int pm_qos_power_release(struct inode *inode, struct file *filp)
576{
Jean Pihetcc749982011-08-25 15:35:12 +0200577 struct pm_qos_request *req;
Mark Grossd82b3512008-02-04 22:30:08 -0800578
James Bottomley82f68252010-07-05 22:53:06 +0200579 req = filp->private_data;
Mark Grossed771342010-05-06 01:59:26 +0200580 pm_qos_remove_request(req);
James Bottomley82f68252010-07-05 22:53:06 +0200581 kfree(req);
Mark Grossd82b3512008-02-04 22:30:08 -0800582
583 return 0;
584}
585
Mark Grossed771342010-05-06 01:59:26 +0200586
Thomas Renningerf9b9e802011-02-28 22:06:34 +0100587static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
588 size_t count, loff_t *f_pos)
589{
590 s32 value;
591 unsigned long flags;
Jean Pihetcc749982011-08-25 15:35:12 +0200592 struct pm_qos_request *req = filp->private_data;
Thomas Renningerf9b9e802011-02-28 22:06:34 +0100593
Jean Pihetcc749982011-08-25 15:35:12 +0200594 if (!req)
Thomas Renningerf9b9e802011-02-28 22:06:34 +0100595 return -EINVAL;
Jean Pihetcc749982011-08-25 15:35:12 +0200596 if (!pm_qos_request_active(req))
Thomas Renningerf9b9e802011-02-28 22:06:34 +0100597 return -EINVAL;
598
Thomas Renningerf9b9e802011-02-28 22:06:34 +0100599 spin_lock_irqsave(&pm_qos_lock, flags);
Jean Pihetabe98ec2011-08-25 15:35:34 +0200600 value = pm_qos_get_value(pm_qos_array[req->pm_qos_class]->constraints);
Thomas Renningerf9b9e802011-02-28 22:06:34 +0100601 spin_unlock_irqrestore(&pm_qos_lock, flags);
602
603 return simple_read_from_buffer(buf, count, f_pos, &value, sizeof(s32));
604}
605
Mark Grossd82b3512008-02-04 22:30:08 -0800606static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
607 size_t count, loff_t *f_pos)
608{
609 s32 value;
Jean Pihetcc749982011-08-25 15:35:12 +0200610 struct pm_qos_request *req;
Mark Grossd82b3512008-02-04 22:30:08 -0800611
Mark Grossed771342010-05-06 01:59:26 +0200612 if (count == sizeof(s32)) {
613 if (copy_from_user(&value, buf, sizeof(s32)))
614 return -EFAULT;
Andy Shevchenkod4f7ecf2013-09-11 17:02:38 +0300615 } else {
Rafael J. Wysocki0775a602011-05-27 00:05:23 +0200616 int ret;
617
Andy Shevchenkod4f7ecf2013-09-11 17:02:38 +0300618 ret = kstrtos32_from_user(buf, count, 16, &value);
619 if (ret)
620 return ret;
Rafael J. Wysocki0775a602011-05-27 00:05:23 +0200621 }
Mark Grossd82b3512008-02-04 22:30:08 -0800622
Jean Pihetcc749982011-08-25 15:35:12 +0200623 req = filp->private_data;
624 pm_qos_update_request(req, value);
Mark Grossed771342010-05-06 01:59:26 +0200625
626 return count;
Mark Grossd82b3512008-02-04 22:30:08 -0800627}
628
629
630static int __init pm_qos_power_init(void)
631{
632 int ret = 0;
Alex Fridd031e1d2012-01-29 20:39:25 +0100633 int i;
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600634 struct dentry *d;
Mark Grossd82b3512008-02-04 22:30:08 -0800635
Alex Fridd031e1d2012-01-29 20:39:25 +0100636 BUILD_BUG_ON(ARRAY_SIZE(pm_qos_array) != PM_QOS_NUM_CLASSES);
637
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600638 d = debugfs_create_dir("pm_qos", NULL);
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600639
Saharad24c2a42013-06-20 11:33:57 +0900640 for (i = PM_QOS_CPU_DMA_LATENCY; i < PM_QOS_NUM_CLASSES; i++) {
Nishanth Menonf5f4eda2014-12-05 11:19:08 -0600641 ret = register_pm_qos_misc(pm_qos_array[i], d);
Alex Fridd031e1d2012-01-29 20:39:25 +0100642 if (ret < 0) {
Joe Perches64ec72a2017-09-27 22:01:34 -0700643 pr_err("%s: %s setup failed\n",
644 __func__, pm_qos_array[i]->name);
Alex Fridd031e1d2012-01-29 20:39:25 +0100645 return ret;
646 }
Mark Grossd82b3512008-02-04 22:30:08 -0800647 }
Mark Grossd82b3512008-02-04 22:30:08 -0800648
649 return ret;
650}
651
652late_initcall(pm_qos_power_init);
Rafael J. Wysocki77751a42019-10-16 12:41:24 +0200653
654/* Definitions related to the frequency QoS below. */
655
656/**
657 * freq_constraints_init - Initialize frequency QoS constraints.
658 * @qos: Frequency QoS constraints to initialize.
659 */
660void freq_constraints_init(struct freq_constraints *qos)
661{
662 struct pm_qos_constraints *c;
663
664 c = &qos->min_freq;
665 plist_head_init(&c->list);
666 c->target_value = FREQ_QOS_MIN_DEFAULT_VALUE;
667 c->default_value = FREQ_QOS_MIN_DEFAULT_VALUE;
668 c->no_constraint_value = FREQ_QOS_MIN_DEFAULT_VALUE;
669 c->type = PM_QOS_MAX;
670 c->notifiers = &qos->min_freq_notifiers;
671 BLOCKING_INIT_NOTIFIER_HEAD(c->notifiers);
672
673 c = &qos->max_freq;
674 plist_head_init(&c->list);
675 c->target_value = FREQ_QOS_MAX_DEFAULT_VALUE;
676 c->default_value = FREQ_QOS_MAX_DEFAULT_VALUE;
677 c->no_constraint_value = FREQ_QOS_MAX_DEFAULT_VALUE;
678 c->type = PM_QOS_MIN;
679 c->notifiers = &qos->max_freq_notifiers;
680 BLOCKING_INIT_NOTIFIER_HEAD(c->notifiers);
681}
682
683/**
684 * freq_qos_read_value - Get frequency QoS constraint for a given list.
685 * @qos: Constraints to evaluate.
686 * @type: QoS request type.
687 */
688s32 freq_qos_read_value(struct freq_constraints *qos,
689 enum freq_qos_req_type type)
690{
691 s32 ret;
692
693 switch (type) {
694 case FREQ_QOS_MIN:
695 ret = IS_ERR_OR_NULL(qos) ?
696 FREQ_QOS_MIN_DEFAULT_VALUE :
697 pm_qos_read_value(&qos->min_freq);
698 break;
699 case FREQ_QOS_MAX:
700 ret = IS_ERR_OR_NULL(qos) ?
701 FREQ_QOS_MAX_DEFAULT_VALUE :
702 pm_qos_read_value(&qos->max_freq);
703 break;
704 default:
705 WARN_ON(1);
706 ret = 0;
707 }
708
709 return ret;
710}
711
712/**
713 * freq_qos_apply - Add/modify/remove frequency QoS request.
714 * @req: Constraint request to apply.
715 * @action: Action to perform (add/update/remove).
716 * @value: Value to assign to the QoS request.
Leonard Crestez36a80152019-11-26 17:17:13 +0200717 *
718 * This is only meant to be called from inside pm_qos, not drivers.
Rafael J. Wysocki77751a42019-10-16 12:41:24 +0200719 */
Leonard Crestez36a80152019-11-26 17:17:13 +0200720int freq_qos_apply(struct freq_qos_request *req,
Rafael J. Wysocki77751a42019-10-16 12:41:24 +0200721 enum pm_qos_req_action action, s32 value)
722{
723 int ret;
724
725 switch(req->type) {
726 case FREQ_QOS_MIN:
727 ret = pm_qos_update_target(&req->qos->min_freq, &req->pnode,
728 action, value);
729 break;
730 case FREQ_QOS_MAX:
731 ret = pm_qos_update_target(&req->qos->max_freq, &req->pnode,
732 action, value);
733 break;
734 default:
735 ret = -EINVAL;
736 }
737
738 return ret;
739}
740
741/**
742 * freq_qos_add_request - Insert new frequency QoS request into a given list.
743 * @qos: Constraints to update.
744 * @req: Preallocated request object.
745 * @type: Request type.
746 * @value: Request value.
747 *
748 * Insert a new entry into the @qos list of requests, recompute the effective
749 * QoS constraint value for that list and initialize the @req object. The
750 * caller needs to save that object for later use in updates and removal.
751 *
752 * Return 1 if the effective constraint value has changed, 0 if the effective
753 * constraint value has not changed, or a negative error code on failures.
754 */
755int freq_qos_add_request(struct freq_constraints *qos,
756 struct freq_qos_request *req,
757 enum freq_qos_req_type type, s32 value)
758{
759 int ret;
760
761 if (IS_ERR_OR_NULL(qos) || !req)
762 return -EINVAL;
763
764 if (WARN(freq_qos_request_active(req),
765 "%s() called for active request\n", __func__))
766 return -EINVAL;
767
768 req->qos = qos;
769 req->type = type;
770 ret = freq_qos_apply(req, PM_QOS_ADD_REQ, value);
771 if (ret < 0) {
772 req->qos = NULL;
773 req->type = 0;
774 }
775
776 return ret;
777}
778EXPORT_SYMBOL_GPL(freq_qos_add_request);
779
780/**
781 * freq_qos_update_request - Modify existing frequency QoS request.
782 * @req: Request to modify.
783 * @new_value: New request value.
784 *
785 * Update an existing frequency QoS request along with the effective constraint
786 * value for the list of requests it belongs to.
787 *
788 * Return 1 if the effective constraint value has changed, 0 if the effective
789 * constraint value has not changed, or a negative error code on failures.
790 */
791int freq_qos_update_request(struct freq_qos_request *req, s32 new_value)
792{
793 if (!req)
794 return -EINVAL;
795
796 if (WARN(!freq_qos_request_active(req),
797 "%s() called for unknown object\n", __func__))
798 return -EINVAL;
799
800 if (req->pnode.prio == new_value)
801 return 0;
802
803 return freq_qos_apply(req, PM_QOS_UPDATE_REQ, new_value);
804}
805EXPORT_SYMBOL_GPL(freq_qos_update_request);
806
807/**
808 * freq_qos_remove_request - Remove frequency QoS request from its list.
809 * @req: Request to remove.
810 *
811 * Remove the given frequency QoS request from the list of constraints it
812 * belongs to and recompute the effective constraint value for that list.
813 *
814 * Return 1 if the effective constraint value has changed, 0 if the effective
815 * constraint value has not changed, or a negative error code on failures.
816 */
817int freq_qos_remove_request(struct freq_qos_request *req)
818{
Rafael J. Wysocki05ff1ba2019-11-20 10:33:34 +0100819 int ret;
820
Rafael J. Wysocki77751a42019-10-16 12:41:24 +0200821 if (!req)
822 return -EINVAL;
823
824 if (WARN(!freq_qos_request_active(req),
825 "%s() called for unknown object\n", __func__))
826 return -EINVAL;
827
Rafael J. Wysocki05ff1ba2019-11-20 10:33:34 +0100828 ret = freq_qos_apply(req, PM_QOS_REMOVE_REQ, PM_QOS_DEFAULT_VALUE);
829 req->qos = NULL;
830 req->type = 0;
831
832 return ret;
Rafael J. Wysocki77751a42019-10-16 12:41:24 +0200833}
834EXPORT_SYMBOL_GPL(freq_qos_remove_request);
835
836/**
837 * freq_qos_add_notifier - Add frequency QoS change notifier.
838 * @qos: List of requests to add the notifier to.
839 * @type: Request type.
840 * @notifier: Notifier block to add.
841 */
842int freq_qos_add_notifier(struct freq_constraints *qos,
843 enum freq_qos_req_type type,
844 struct notifier_block *notifier)
845{
846 int ret;
847
848 if (IS_ERR_OR_NULL(qos) || !notifier)
849 return -EINVAL;
850
851 switch (type) {
852 case FREQ_QOS_MIN:
853 ret = blocking_notifier_chain_register(qos->min_freq.notifiers,
854 notifier);
855 break;
856 case FREQ_QOS_MAX:
857 ret = blocking_notifier_chain_register(qos->max_freq.notifiers,
858 notifier);
859 break;
860 default:
861 WARN_ON(1);
862 ret = -EINVAL;
863 }
864
865 return ret;
866}
867EXPORT_SYMBOL_GPL(freq_qos_add_notifier);
868
869/**
870 * freq_qos_remove_notifier - Remove frequency QoS change notifier.
871 * @qos: List of requests to remove the notifier from.
872 * @type: Request type.
873 * @notifier: Notifier block to remove.
874 */
875int freq_qos_remove_notifier(struct freq_constraints *qos,
876 enum freq_qos_req_type type,
877 struct notifier_block *notifier)
878{
879 int ret;
880
881 if (IS_ERR_OR_NULL(qos) || !notifier)
882 return -EINVAL;
883
884 switch (type) {
885 case FREQ_QOS_MIN:
886 ret = blocking_notifier_chain_unregister(qos->min_freq.notifiers,
887 notifier);
888 break;
889 case FREQ_QOS_MAX:
890 ret = blocking_notifier_chain_unregister(qos->max_freq.notifiers,
891 notifier);
892 break;
893 default:
894 WARN_ON(1);
895 ret = -EINVAL;
896 }
897
898 return ret;
899}
900EXPORT_SYMBOL_GPL(freq_qos_remove_notifier);