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>
45 #include <linux/uaccess.h>
46 #include <linux/export.h>
49 * locking rule: all changes to constraints or notifiers lists
50 * or pm_qos_object list and pm_qos_objects need to happen with pm_qos_lock
51 * held, taken with _irqsave. One lock to rule them all
53 struct pm_qos_object {
54 struct pm_qos_constraints *constraints;
55 struct miscdevice pm_qos_power_miscdev;
59 static DEFINE_SPINLOCK(pm_qos_lock);
61 static struct pm_qos_object null_pm_qos;
63 static BLOCKING_NOTIFIER_HEAD(cpu_dma_lat_notifier);
64 static struct pm_qos_constraints cpu_dma_constraints = {
65 .list = PLIST_HEAD_INIT(cpu_dma_constraints.list),
66 .target_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
67 .default_value = PM_QOS_CPU_DMA_LAT_DEFAULT_VALUE,
69 .notifiers = &cpu_dma_lat_notifier,
71 static struct pm_qos_object cpu_dma_pm_qos = {
72 .constraints = &cpu_dma_constraints,
73 .name = "cpu_dma_latency",
76 static BLOCKING_NOTIFIER_HEAD(network_lat_notifier);
77 static struct pm_qos_constraints network_lat_constraints = {
78 .list = PLIST_HEAD_INIT(network_lat_constraints.list),
79 .target_value = PM_QOS_NETWORK_LAT_DEFAULT_VALUE,
80 .default_value = PM_QOS_NETWORK_LAT_DEFAULT_VALUE,
82 .notifiers = &network_lat_notifier,
84 static struct pm_qos_object network_lat_pm_qos = {
85 .constraints = &network_lat_constraints,
86 .name = "network_latency",
90 static BLOCKING_NOTIFIER_HEAD(network_throughput_notifier);
91 static struct pm_qos_constraints network_tput_constraints = {
92 .list = PLIST_HEAD_INIT(network_tput_constraints.list),
93 .target_value = PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE,
94 .default_value = PM_QOS_NETWORK_THROUGHPUT_DEFAULT_VALUE,
96 .notifiers = &network_throughput_notifier,
98 static struct pm_qos_object network_throughput_pm_qos = {
99 .constraints = &network_tput_constraints,
100 .name = "network_throughput",
104 static struct pm_qos_object *pm_qos_array[] = {
108 &network_throughput_pm_qos
111 static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
112 size_t count, loff_t *f_pos);
113 static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
114 size_t count, loff_t *f_pos);
115 static int pm_qos_power_open(struct inode *inode, struct file *filp);
116 static int pm_qos_power_release(struct inode *inode, struct file *filp);
118 static const struct file_operations pm_qos_power_fops = {
119 .write = pm_qos_power_write,
120 .read = pm_qos_power_read,
121 .open = pm_qos_power_open,
122 .release = pm_qos_power_release,
123 .llseek = noop_llseek,
126 /* unlocked internal variant */
127 static inline int pm_qos_get_value(struct pm_qos_constraints *c)
129 if (plist_head_empty(&c->list))
130 return c->default_value;
134 return plist_first(&c->list)->prio;
137 return plist_last(&c->list)->prio;
140 /* runtime check for not using enum */
142 return PM_QOS_DEFAULT_VALUE;
146 s32 pm_qos_read_value(struct pm_qos_constraints *c)
148 return c->target_value;
151 static inline void pm_qos_set_value(struct pm_qos_constraints *c, s32 value)
153 c->target_value = value;
157 * pm_qos_update_target - manages the constraints list and calls the notifiers
159 * @c: constraints data struct
160 * @node: request to add to the list, to update or to remove
161 * @action: action to take on the constraints list
162 * @value: value of the request to add or update
164 * This function returns 1 if the aggregated constraint value has changed, 0
167 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
168 enum pm_qos_req_action action, int value)
171 int prev_value, curr_value, new_value;
173 spin_lock_irqsave(&pm_qos_lock, flags);
174 prev_value = pm_qos_get_value(c);
175 if (value == PM_QOS_DEFAULT_VALUE)
176 new_value = c->default_value;
181 case PM_QOS_REMOVE_REQ:
182 plist_del(node, &c->list);
184 case PM_QOS_UPDATE_REQ:
186 * to change the list, we atomically remove, reinit
187 * with new value and add, then see if the extremal
190 plist_del(node, &c->list);
192 plist_node_init(node, new_value);
193 plist_add(node, &c->list);
200 curr_value = pm_qos_get_value(c);
201 pm_qos_set_value(c, curr_value);
203 spin_unlock_irqrestore(&pm_qos_lock, flags);
205 if (prev_value != curr_value) {
206 blocking_notifier_call_chain(c->notifiers,
207 (unsigned long)curr_value,
216 * pm_qos_flags_remove_req - Remove device PM QoS flags request.
217 * @pqf: Device PM QoS flags set to remove the request from.
218 * @req: Request to remove from the set.
220 static void pm_qos_flags_remove_req(struct pm_qos_flags *pqf,
221 struct pm_qos_flags_request *req)
225 list_del(&req->node);
226 list_for_each_entry(req, &pqf->list, node)
229 pqf->effective_flags = val;
233 * pm_qos_update_flags - Update a set of PM QoS flags.
234 * @pqf: Set of flags to update.
235 * @req: Request to add to the set, to modify, or to remove from the set.
236 * @action: Action to take on the set.
237 * @val: Value of the request to add or modify.
239 * Update the given set of PM QoS flags and call notifiers if the aggregate
240 * value has changed. Returns 1 if the aggregate constraint value has changed,
243 bool pm_qos_update_flags(struct pm_qos_flags *pqf,
244 struct pm_qos_flags_request *req,
245 enum pm_qos_req_action action, s32 val)
247 unsigned long irqflags;
248 s32 prev_value, curr_value;
250 spin_lock_irqsave(&pm_qos_lock, irqflags);
252 prev_value = list_empty(&pqf->list) ? 0 : pqf->effective_flags;
255 case PM_QOS_REMOVE_REQ:
256 pm_qos_flags_remove_req(pqf, req);
258 case PM_QOS_UPDATE_REQ:
259 pm_qos_flags_remove_req(pqf, req);
262 INIT_LIST_HEAD(&req->node);
263 list_add_tail(&req->node, &pqf->list);
264 pqf->effective_flags |= val;
271 curr_value = list_empty(&pqf->list) ? 0 : pqf->effective_flags;
273 spin_unlock_irqrestore(&pm_qos_lock, irqflags);
275 return prev_value != curr_value;
279 * pm_qos_request - returns current system wide qos expectation
280 * @pm_qos_class: identification of which qos value is requested
282 * This function returns the current target value.
284 int pm_qos_request(int pm_qos_class)
286 return pm_qos_read_value(pm_qos_array[pm_qos_class]->constraints);
288 EXPORT_SYMBOL_GPL(pm_qos_request);
290 int pm_qos_request_active(struct pm_qos_request *req)
292 return req->pm_qos_class != 0;
294 EXPORT_SYMBOL_GPL(pm_qos_request_active);
296 static void __pm_qos_update_request(struct pm_qos_request *req,
299 if (new_value != req->node.prio)
300 pm_qos_update_target(
301 pm_qos_array[req->pm_qos_class]->constraints,
302 &req->node, PM_QOS_UPDATE_REQ, new_value);
306 * pm_qos_work_fn - the timeout handler of pm_qos_update_request_timeout
307 * @work: work struct for the delayed work (timeout)
309 * This cancels the timeout request by falling back to the default at timeout.
311 static void pm_qos_work_fn(struct work_struct *work)
313 struct pm_qos_request *req = container_of(to_delayed_work(work),
314 struct pm_qos_request,
317 __pm_qos_update_request(req, PM_QOS_DEFAULT_VALUE);
321 * pm_qos_add_request - inserts new qos request into the list
322 * @req: pointer to a preallocated handle
323 * @pm_qos_class: identifies which list of qos request to use
324 * @value: defines the qos request
326 * This function inserts a new entry in the pm_qos_class list of requested qos
327 * performance characteristics. It recomputes the aggregate QoS expectations
328 * for the pm_qos_class of parameters and initializes the pm_qos_request
329 * handle. Caller needs to save this handle for later use in updates and
333 void pm_qos_add_request(struct pm_qos_request *req,
334 int pm_qos_class, s32 value)
336 if (!req) /*guard against callers passing in null */
339 if (pm_qos_request_active(req)) {
340 WARN(1, KERN_ERR "pm_qos_add_request() called for already added request\n");
343 req->pm_qos_class = pm_qos_class;
344 INIT_DELAYED_WORK(&req->work, pm_qos_work_fn);
345 pm_qos_update_target(pm_qos_array[pm_qos_class]->constraints,
346 &req->node, PM_QOS_ADD_REQ, value);
348 EXPORT_SYMBOL_GPL(pm_qos_add_request);
351 * pm_qos_update_request - modifies an existing qos request
352 * @req : handle to list element holding a pm_qos request to use
353 * @value: defines the qos request
355 * Updates an existing qos request for the pm_qos_class of parameters along
356 * with updating the target pm_qos_class value.
358 * Attempts are made to make this code callable on hot code paths.
360 void pm_qos_update_request(struct pm_qos_request *req,
363 if (!req) /*guard against callers passing in null */
366 if (!pm_qos_request_active(req)) {
367 WARN(1, KERN_ERR "pm_qos_update_request() called for unknown object\n");
371 cancel_delayed_work_sync(&req->work);
373 if (new_value != req->node.prio)
374 pm_qos_update_target(
375 pm_qos_array[req->pm_qos_class]->constraints,
376 &req->node, PM_QOS_UPDATE_REQ, new_value);
378 __pm_qos_update_request(req, new_value);
380 EXPORT_SYMBOL_GPL(pm_qos_update_request);
383 * pm_qos_update_request_timeout - modifies an existing qos request temporarily.
384 * @req : handle to list element holding a pm_qos request to use
385 * @new_value: defines the temporal qos request
386 * @timeout_us: the effective duration of this qos request in usecs.
388 * After timeout_us, this qos request is cancelled automatically.
390 void pm_qos_update_request_timeout(struct pm_qos_request *req, s32 new_value,
391 unsigned long timeout_us)
395 if (WARN(!pm_qos_request_active(req),
396 "%s called for unknown object.", __func__))
399 cancel_delayed_work_sync(&req->work);
401 if (new_value != req->node.prio)
402 pm_qos_update_target(
403 pm_qos_array[req->pm_qos_class]->constraints,
404 &req->node, PM_QOS_UPDATE_REQ, new_value);
406 schedule_delayed_work(&req->work, usecs_to_jiffies(timeout_us));
410 * pm_qos_remove_request - modifies an existing qos request
411 * @req: handle to request list element
413 * Will remove pm qos request from the list of constraints and
414 * recompute the current target value for the pm_qos_class. Call this
415 * on slow code paths.
417 void pm_qos_remove_request(struct pm_qos_request *req)
419 if (!req) /*guard against callers passing in null */
421 /* silent return to keep pcm code cleaner */
423 if (!pm_qos_request_active(req)) {
424 WARN(1, KERN_ERR "pm_qos_remove_request() called for unknown object\n");
428 cancel_delayed_work_sync(&req->work);
430 pm_qos_update_target(pm_qos_array[req->pm_qos_class]->constraints,
431 &req->node, PM_QOS_REMOVE_REQ,
432 PM_QOS_DEFAULT_VALUE);
433 memset(req, 0, sizeof(*req));
435 EXPORT_SYMBOL_GPL(pm_qos_remove_request);
438 * pm_qos_add_notifier - sets notification entry for changes to target value
439 * @pm_qos_class: identifies which qos target changes should be notified.
440 * @notifier: notifier block managed by caller.
442 * will register the notifier into a notification chain that gets called
443 * upon changes to the pm_qos_class target value.
445 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier)
449 retval = blocking_notifier_chain_register(
450 pm_qos_array[pm_qos_class]->constraints->notifiers,
455 EXPORT_SYMBOL_GPL(pm_qos_add_notifier);
458 * pm_qos_remove_notifier - deletes notification entry from chain.
459 * @pm_qos_class: identifies which qos target changes are notified.
460 * @notifier: notifier block to be removed.
462 * will remove the notifier from the notification chain that gets called
463 * upon changes to the pm_qos_class target value.
465 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier)
469 retval = blocking_notifier_chain_unregister(
470 pm_qos_array[pm_qos_class]->constraints->notifiers,
475 EXPORT_SYMBOL_GPL(pm_qos_remove_notifier);
477 /* User space interface to PM QoS classes via misc devices */
478 static int register_pm_qos_misc(struct pm_qos_object *qos)
480 qos->pm_qos_power_miscdev.minor = MISC_DYNAMIC_MINOR;
481 qos->pm_qos_power_miscdev.name = qos->name;
482 qos->pm_qos_power_miscdev.fops = &pm_qos_power_fops;
484 return misc_register(&qos->pm_qos_power_miscdev);
487 static int find_pm_qos_object_by_minor(int minor)
491 for (pm_qos_class = 0;
492 pm_qos_class < PM_QOS_NUM_CLASSES; pm_qos_class++) {
494 pm_qos_array[pm_qos_class]->pm_qos_power_miscdev.minor)
500 static int pm_qos_power_open(struct inode *inode, struct file *filp)
504 pm_qos_class = find_pm_qos_object_by_minor(iminor(inode));
505 if (pm_qos_class >= 0) {
506 struct pm_qos_request *req = kzalloc(sizeof(*req), GFP_KERNEL);
510 pm_qos_add_request(req, pm_qos_class, PM_QOS_DEFAULT_VALUE);
511 filp->private_data = req;
518 static int pm_qos_power_release(struct inode *inode, struct file *filp)
520 struct pm_qos_request *req;
522 req = filp->private_data;
523 pm_qos_remove_request(req);
530 static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
531 size_t count, loff_t *f_pos)
535 struct pm_qos_request *req = filp->private_data;
539 if (!pm_qos_request_active(req))
542 spin_lock_irqsave(&pm_qos_lock, flags);
543 value = pm_qos_get_value(pm_qos_array[req->pm_qos_class]->constraints);
544 spin_unlock_irqrestore(&pm_qos_lock, flags);
546 return simple_read_from_buffer(buf, count, f_pos, &value, sizeof(s32));
549 static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
550 size_t count, loff_t *f_pos)
553 struct pm_qos_request *req;
555 if (count == sizeof(s32)) {
556 if (copy_from_user(&value, buf, sizeof(s32)))
558 } else if (count <= 11) { /* ASCII perhaps? */
559 char ascii_value[11];
560 unsigned long int ulval;
563 if (copy_from_user(ascii_value, buf, count))
567 if (ascii_value[10] == '\n')
568 ascii_value[10] = '\0';
572 ascii_value[count] = '\0';
574 ret = kstrtoul(ascii_value, 16, &ulval);
576 pr_debug("%s, 0x%lx, 0x%x\n", ascii_value, ulval, ret);
579 value = (s32)lower_32_bits(ulval);
584 req = filp->private_data;
585 pm_qos_update_request(req, value);
591 static int __init pm_qos_power_init(void)
596 BUILD_BUG_ON(ARRAY_SIZE(pm_qos_array) != PM_QOS_NUM_CLASSES);
598 for (i = 1; i < PM_QOS_NUM_CLASSES; i++) {
599 ret = register_pm_qos_misc(pm_qos_array[i]);
601 printk(KERN_ERR "pm_qos_param: %s setup failed\n",
602 pm_qos_array[i]->name);
610 late_initcall(pm_qos_power_init);