2 * This module exposes the interface to kernel space for specifying
3 * QoS dependencies. It provides infrastructure for registration of:
5 * Dependents on a QoS value : register requests
6 * Watchers of QoS value : get notified when target QoS value changes
8 * This QoS design is best effort based. Dependents register their QoS needs.
9 * Watchers register to keep track of the current QoS needs of the system.
11 * There are 3 basic classes of QoS parameter: latency, timeout, throughput
12 * each have defined units:
14 * timeout: usec <-- currently not used.
15 * throughput: kbs (kilo byte / sec)
17 * There are lists of pm_qos_objects each one wrapping requests, notifiers
19 * User mode requests on a QOS parameter register themselves to the
20 * subsystem by opening the device node /dev/... and writing there request to
21 * the node. As long as the process holds a file handle open to the node the
22 * client continues to be accounted for. Upon file release the usermode
23 * request is removed and a new qos target is computed. This way when the
24 * request that the application has is cleaned up when closes the file
25 * pointer or exits the pm_qos_object will get an opportunity to clean up.
27 * Mark Gross <mgross@linux.intel.com>
32 #include <linux/pm_qos.h>
33 #include <linux/sched.h>
34 #include <linux/spinlock.h>
35 #include <linux/slab.h>
36 #include <linux/time.h>
38 #include <linux/device.h>
39 #include <linux/miscdevice.h>
40 #include <linux/string.h>
41 #include <linux/platform_device.h>
42 #include <linux/init.h>
43 #include <linux/kernel.h>
44 #include <linux/debugfs.h>
45 #include <linux/seq_file.h>
47 #include <linux/uaccess.h>
48 #include <linux/export.h>
49 #include <trace/events/power.h>
52 * locking rule: all changes to constraints or notifiers lists
53 * or pm_qos_object list and pm_qos_objects need to happen with pm_qos_lock
54 * held, taken with _irqsave. One lock to rule them all
56 struct pm_qos_object {
57 struct pm_qos_constraints *constraints;
58 struct miscdevice pm_qos_power_miscdev;
62 static DEFINE_SPINLOCK(pm_qos_lock);
64 static struct pm_qos_object null_pm_qos;
66 static BLOCKING_NOTIFIER_HEAD(cpu_dma_lat_notifier);
67 static struct pm_qos_constraints cpu_dma_constraints = {
68 .list = PLIST_HEAD_INIT(cpu_dma_constraints.list),
69 .target_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
70 .default_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
71 .no_constraint_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
73 .notifiers = &cpu_dma_lat_notifier,
75 static struct pm_qos_object cpu_dma_pm_qos = {
76 .constraints = &cpu_dma_constraints,
77 .name = "cpu_dma_latency",
80 static BLOCKING_NOTIFIER_HEAD(network_lat_notifier);
81 static struct pm_qos_constraints network_lat_constraints = {
82 .list = PLIST_HEAD_INIT(network_lat_constraints.list),
83 .target_value = PM_QOS_NETWORK_LAT_DEFAULT_VALUE,
84 .default_value = PM_QOS_NETWORK_LAT_DEFAULT_VALUE,
85 .no_constraint_value = PM_QOS_NETWORK_LAT_DEFAULT_VALUE,
87 .notifiers = &network_lat_notifier,
89 static struct pm_qos_object network_lat_pm_qos = {
90 .constraints = &network_lat_constraints,
91 .name = "network_latency",
95 static BLOCKING_NOTIFIER_HEAD(network_throughput_notifier);
96 static struct pm_qos_constraints network_tput_constraints = {
97 .list = PLIST_HEAD_INIT(network_tput_constraints.list),
98 .target_value = PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE,
99 .default_value = PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE,
100 .no_constraint_value = PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE,
102 .notifiers = &network_throughput_notifier,
104 static struct pm_qos_object network_throughput_pm_qos = {
105 .constraints = &network_tput_constraints,
106 .name = "network_throughput",
110 static BLOCKING_NOTIFIER_HEAD(memory_bandwidth_notifier);
111 static struct pm_qos_constraints memory_bw_constraints = {
112 .list = PLIST_HEAD_INIT(memory_bw_constraints.list),
113 .target_value = PM_QOS_MEMORY_BANDWIDTH_DEFAULT_VALUE,
114 .default_value = PM_QOS_MEMORY_BANDWIDTH_DEFAULT_VALUE,
115 .no_constraint_value = PM_QOS_MEMORY_BANDWIDTH_DEFAULT_VALUE,
117 .notifiers = &memory_bandwidth_notifier,
119 static struct pm_qos_object memory_bandwidth_pm_qos = {
120 .constraints = &memory_bw_constraints,
121 .name = "memory_bandwidth",
125 static struct pm_qos_object *pm_qos_array[] = {
129 &network_throughput_pm_qos,
130 &memory_bandwidth_pm_qos,
133 static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
134 size_t count, loff_t *f_pos);
135 static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
136 size_t count, loff_t *f_pos);
137 static int pm_qos_power_open(struct inode *inode, struct file *filp);
138 static int pm_qos_power_release(struct inode *inode, struct file *filp);
140 static const struct file_operations pm_qos_power_fops = {
141 .write = pm_qos_power_write,
142 .read = pm_qos_power_read,
143 .open = pm_qos_power_open,
144 .release = pm_qos_power_release,
145 .llseek = noop_llseek,
148 /* unlocked internal variant */
149 static inline int pm_qos_get_value(struct pm_qos_constraints *c)
151 struct plist_node *node;
154 if (plist_head_empty(&c->list))
155 return c->no_constraint_value;
159 return plist_first(&c->list)->prio;
162 return plist_last(&c->list)->prio;
165 plist_for_each(node, &c->list)
166 total_value += node->prio;
171 /* runtime check for not using enum */
173 return PM_QOS_DEFAULT_VALUE;
177 s32 pm_qos_read_value(struct pm_qos_constraints *c)
179 return c->target_value;
182 static inline void pm_qos_set_value(struct pm_qos_constraints *c, s32 value)
184 c->target_value = value;
187 static inline int pm_qos_get_value(struct pm_qos_constraints *c);
188 static int pm_qos_dbg_show_requests(struct seq_file *s, void *unused)
190 struct pm_qos_object *qos = (struct pm_qos_object *)s->private;
191 struct pm_qos_constraints *c;
192 struct pm_qos_request *req;
198 if (IS_ERR_OR_NULL(qos)) {
199 pr_err("%s: bad qos param!\n", __func__);
202 c = qos->constraints;
203 if (IS_ERR_OR_NULL(c)) {
204 pr_err("%s: Bad constraints on qos?\n", __func__);
208 /* Lock to ensure we have a snapshot */
209 spin_lock_irqsave(&pm_qos_lock, flags);
210 if (plist_head_empty(&c->list)) {
211 seq_puts(s, "Empty!\n");
229 plist_for_each_entry(req, &c->list, node) {
230 char *state = "Default";
232 if ((req->node).prio != c->default_value) {
237 seq_printf(s, "%d: %d: %s\n", tot_reqs,
238 (req->node).prio, state);
241 seq_printf(s, "Type=%s, Value=%d, Requests: active=%d / total=%d\n",
242 type, pm_qos_get_value(c), active_reqs, tot_reqs);
245 spin_unlock_irqrestore(&pm_qos_lock, flags);
249 static int pm_qos_dbg_open(struct inode *inode, struct file *file)
251 return single_open(file, pm_qos_dbg_show_requests,
255 static const struct file_operations pm_qos_debug_fops = {
256 .open = pm_qos_dbg_open,
259 .release = single_release,
263 * pm_qos_update_target - manages the constraints list and calls the notifiers
265 * @c: constraints data struct
266 * @node: request to add to the list, to update or to remove
267 * @action: action to take on the constraints list
268 * @value: value of the request to add or update
270 * This function returns 1 if the aggregated constraint value has changed, 0
273 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
274 enum pm_qos_req_action action, int value)
277 int prev_value, curr_value, new_value;
280 spin_lock_irqsave(&pm_qos_lock, flags);
281 prev_value = pm_qos_get_value(c);
282 if (value == PM_QOS_DEFAULT_VALUE)
283 new_value = c->default_value;
288 case PM_QOS_REMOVE_REQ:
289 plist_del(node, &c->list);
291 case PM_QOS_UPDATE_REQ:
293 * to change the list, we atomically remove, reinit
294 * with new value and add, then see if the extremal
297 plist_del(node, &c->list);
299 plist_node_init(node, new_value);
300 plist_add(node, &c->list);
307 curr_value = pm_qos_get_value(c);
308 pm_qos_set_value(c, curr_value);
310 spin_unlock_irqrestore(&pm_qos_lock, flags);
312 trace_pm_qos_update_target(action, prev_value, curr_value);
313 if (prev_value != curr_value) {
316 blocking_notifier_call_chain(c->notifiers,
317 (unsigned long)curr_value,
326 * pm_qos_flags_remove_req - Remove device PM QoS flags request.
327 * @pqf: Device PM QoS flags set to remove the request from.
328 * @req: Request to remove from the set.
330 static void pm_qos_flags_remove_req(struct pm_qos_flags *pqf,
331 struct pm_qos_flags_request *req)
335 list_del(&req->node);
336 list_for_each_entry(req, &pqf->list, node)
339 pqf->effective_flags = val;
343 * pm_qos_update_flags - Update a set of PM QoS flags.
344 * @pqf: Set of flags to update.
345 * @req: Request to add to the set, to modify, or to remove from the set.
346 * @action: Action to take on the set.
347 * @val: Value of the request to add or modify.
349 * Update the given set of PM QoS flags and call notifiers if the aggregate
350 * value has changed. Returns 1 if the aggregate constraint value has changed,
353 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
354 struct pm_qos_flags_request *req,
355 enum pm_qos_req_action action, s32 val)
357 unsigned long irqflags;
358 s32 prev_value, curr_value;
360 spin_lock_irqsave(&pm_qos_lock, irqflags);
362 prev_value = list_empty(&pqf->list) ? 0 : pqf->effective_flags;
365 case PM_QOS_REMOVE_REQ:
366 pm_qos_flags_remove_req(pqf, req);
368 case PM_QOS_UPDATE_REQ:
369 pm_qos_flags_remove_req(pqf, req);
372 INIT_LIST_HEAD(&req->node);
373 list_add_tail(&req->node, &pqf->list);
374 pqf->effective_flags |= val;
381 curr_value = list_empty(&pqf->list) ? 0 : pqf->effective_flags;
383 spin_unlock_irqrestore(&pm_qos_lock, irqflags);
385 trace_pm_qos_update_flags(action, prev_value, curr_value);
386 return prev_value != curr_value;
390 * pm_qos_request - returns current system wide qos expectation
391 * @pm_qos_class: identification of which qos value is requested
393 * This function returns the current target value.
395 int pm_qos_request(int pm_qos_class)
397 return pm_qos_read_value(pm_qos_array[pm_qos_class]->constraints);
399 EXPORT_SYMBOL_GPL(pm_qos_request);
401 int pm_qos_request_active(struct pm_qos_request *req)
403 return req->pm_qos_class != 0;
405 EXPORT_SYMBOL_GPL(pm_qos_request_active);
407 static void __pm_qos_update_request(struct pm_qos_request *req,
410 trace_pm_qos_update_request(req->pm_qos_class, new_value);
412 if (new_value != req->node.prio)
413 pm_qos_update_target(
414 pm_qos_array[req->pm_qos_class]->constraints,
415 &req->node, PM_QOS_UPDATE_REQ, new_value);
419 * pm_qos_work_fn - the timeout handler of pm_qos_update_request_timeout
420 * @work: work struct for the delayed work (timeout)
422 * This cancels the timeout request by falling back to the default at timeout.
424 static void pm_qos_work_fn(struct work_struct *work)
426 struct pm_qos_request *req = container_of(to_delayed_work(work),
427 struct pm_qos_request,
430 __pm_qos_update_request(req, PM_QOS_DEFAULT_VALUE);
434 * pm_qos_add_request - inserts new qos request into the list
435 * @req: pointer to a preallocated handle
436 * @pm_qos_class: identifies which list of qos request to use
437 * @value: defines the qos request
439 * This function inserts a new entry in the pm_qos_class list of requested qos
440 * performance characteristics. It recomputes the aggregate QoS expectations
441 * for the pm_qos_class of parameters and initializes the pm_qos_request
442 * handle. Caller needs to save this handle for later use in updates and
446 void pm_qos_add_request(struct pm_qos_request *req,
447 int pm_qos_class, s32 value)
449 if (!req) /*guard against callers passing in null */
452 if (pm_qos_request_active(req)) {
453 WARN(1, KERN_ERR "pm_qos_add_request() called for already added request\n");
456 req->pm_qos_class = pm_qos_class;
457 INIT_DELAYED_WORK(&req->work, pm_qos_work_fn);
458 trace_pm_qos_add_request(pm_qos_class, value);
459 pm_qos_update_target(pm_qos_array[pm_qos_class]->constraints,
460 &req->node, PM_QOS_ADD_REQ, value);
462 EXPORT_SYMBOL_GPL(pm_qos_add_request);
465 * pm_qos_update_request - modifies an existing qos request
466 * @req : handle to list element holding a pm_qos request to use
467 * @value: defines the qos request
469 * Updates an existing qos request for the pm_qos_class of parameters along
470 * with updating the target pm_qos_class value.
472 * Attempts are made to make this code callable on hot code paths.
474 void pm_qos_update_request(struct pm_qos_request *req,
477 if (!req) /*guard against callers passing in null */
480 if (!pm_qos_request_active(req)) {
481 WARN(1, KERN_ERR "pm_qos_update_request() called for unknown object\n");
486 * This function may be called very early during boot, for example,
487 * from of_clk_init(), where irq needs to stay disabled.
488 * cancel_delayed_work_sync() assumes that irq is enabled on
489 * invocation and re-enables it on return. Avoid calling it until
490 * workqueue is initialized.
493 cancel_delayed_work_sync(&req->work);
495 __pm_qos_update_request(req, new_value);
497 EXPORT_SYMBOL_GPL(pm_qos_update_request);
500 * pm_qos_update_request_timeout - modifies an existing qos request temporarily.
501 * @req : handle to list element holding a pm_qos request to use
502 * @new_value: defines the temporal qos request
503 * @timeout_us: the effective duration of this qos request in usecs.
505 * After timeout_us, this qos request is cancelled automatically.
507 void pm_qos_update_request_timeout(struct pm_qos_request *req, s32 new_value,
508 unsigned long timeout_us)
512 if (WARN(!pm_qos_request_active(req),
513 "%s called for unknown object.", __func__))
516 cancel_delayed_work_sync(&req->work);
518 trace_pm_qos_update_request_timeout(req->pm_qos_class,
519 new_value, timeout_us);
520 if (new_value != req->node.prio)
521 pm_qos_update_target(
522 pm_qos_array[req->pm_qos_class]->constraints,
523 &req->node, PM_QOS_UPDATE_REQ, new_value);
525 schedule_delayed_work(&req->work, usecs_to_jiffies(timeout_us));
529 * pm_qos_remove_request - modifies an existing qos request
530 * @req: handle to request list element
532 * Will remove pm qos request from the list of constraints and
533 * recompute the current target value for the pm_qos_class. Call this
534 * on slow code paths.
536 void pm_qos_remove_request(struct pm_qos_request *req)
538 if (!req) /*guard against callers passing in null */
540 /* silent return to keep pcm code cleaner */
542 if (!pm_qos_request_active(req)) {
543 WARN(1, KERN_ERR "pm_qos_remove_request() called for unknown object\n");
547 cancel_delayed_work_sync(&req->work);
549 trace_pm_qos_remove_request(req->pm_qos_class, PM_QOS_DEFAULT_VALUE);
550 pm_qos_update_target(pm_qos_array[req->pm_qos_class]->constraints,
551 &req->node, PM_QOS_REMOVE_REQ,
552 PM_QOS_DEFAULT_VALUE);
553 memset(req, 0, sizeof(*req));
555 EXPORT_SYMBOL_GPL(pm_qos_remove_request);
558 * pm_qos_add_notifier - sets notification entry for changes to target value
559 * @pm_qos_class: identifies which qos target changes should be notified.
560 * @notifier: notifier block managed by caller.
562 * will register the notifier into a notification chain that gets called
563 * upon changes to the pm_qos_class target value.
565 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier)
569 retval = blocking_notifier_chain_register(
570 pm_qos_array[pm_qos_class]->constraints->notifiers,
575 EXPORT_SYMBOL_GPL(pm_qos_add_notifier);
578 * pm_qos_remove_notifier - deletes notification entry from chain.
579 * @pm_qos_class: identifies which qos target changes are notified.
580 * @notifier: notifier block to be removed.
582 * will remove the notifier from the notification chain that gets called
583 * upon changes to the pm_qos_class target value.
585 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier)
589 retval = blocking_notifier_chain_unregister(
590 pm_qos_array[pm_qos_class]->constraints->notifiers,
595 EXPORT_SYMBOL_GPL(pm_qos_remove_notifier);
597 /* User space interface to PM QoS classes via misc devices */
598 static int register_pm_qos_misc(struct pm_qos_object *qos, struct dentry *d)
600 qos->pm_qos_power_miscdev.minor = MISC_DYNAMIC_MINOR;
601 qos->pm_qos_power_miscdev.name = qos->name;
602 qos->pm_qos_power_miscdev.fops = &pm_qos_power_fops;
605 (void)debugfs_create_file(qos->name, S_IRUGO, d,
606 (void *)qos, &pm_qos_debug_fops);
609 return misc_register(&qos->pm_qos_power_miscdev);
612 static int find_pm_qos_object_by_minor(int minor)
616 for (pm_qos_class = PM_QOS_CPU_DMA_LATENCY;
617 pm_qos_class < PM_QOS_NUM_CLASSES; pm_qos_class++) {
619 pm_qos_array[pm_qos_class]->pm_qos_power_miscdev.minor)
625 static int pm_qos_power_open(struct inode *inode, struct file *filp)
629 pm_qos_class = find_pm_qos_object_by_minor(iminor(inode));
630 if (pm_qos_class >= PM_QOS_CPU_DMA_LATENCY) {
631 struct pm_qos_request *req = kzalloc(sizeof(*req), GFP_KERNEL);
635 pm_qos_add_request(req, pm_qos_class, PM_QOS_DEFAULT_VALUE);
636 filp->private_data = req;
643 static int pm_qos_power_release(struct inode *inode, struct file *filp)
645 struct pm_qos_request *req;
647 req = filp->private_data;
648 pm_qos_remove_request(req);
655 static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
656 size_t count, loff_t *f_pos)
660 struct pm_qos_request *req = filp->private_data;
664 if (!pm_qos_request_active(req))
667 spin_lock_irqsave(&pm_qos_lock, flags);
668 value = pm_qos_get_value(pm_qos_array[req->pm_qos_class]->constraints);
669 spin_unlock_irqrestore(&pm_qos_lock, flags);
671 return simple_read_from_buffer(buf, count, f_pos, &value, sizeof(s32));
674 static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
675 size_t count, loff_t *f_pos)
678 struct pm_qos_request *req;
680 if (count == sizeof(s32)) {
681 if (copy_from_user(&value, buf, sizeof(s32)))
686 ret = kstrtos32_from_user(buf, count, 16, &value);
691 req = filp->private_data;
692 pm_qos_update_request(req, value);
698 static int __init pm_qos_power_init(void)
704 BUILD_BUG_ON(ARRAY_SIZE(pm_qos_array) != PM_QOS_NUM_CLASSES);
706 d = debugfs_create_dir("pm_qos", NULL);
707 if (IS_ERR_OR_NULL(d))
710 for (i = PM_QOS_CPU_DMA_LATENCY; i < PM_QOS_NUM_CLASSES; i++) {
711 ret = register_pm_qos_misc(pm_qos_array[i], d);
713 printk(KERN_ERR "pm_qos_param: %s setup failed\n",
714 pm_qos_array[i]->name);
722 late_initcall(pm_qos_power_init);