PM / Sleep: Add user space interface for manipulating wakeup sources, v3
[linux-2.6.git] / kernel / power / qos.c
1 /*
2  * This module exposes the interface to kernel space for specifying
3  * QoS dependencies.  It provides infrastructure for registration of:
4  *
5  * Dependents on a QoS value : register requests
6  * Watchers of QoS value : get notified when target QoS value changes
7  *
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.
10  *
11  * There are 3 basic classes of QoS parameter: latency, timeout, throughput
12  * each have defined units:
13  * latency: usec
14  * timeout: usec <-- currently not used.
15  * throughput: kbs (kilo byte / sec)
16  *
17  * There are lists of pm_qos_objects each one wrapping requests, notifiers
18  *
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.
26  *
27  * Mark Gross <mgross@linux.intel.com>
28  */
29
30 /*#define DEBUG*/
31
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>
37 #include <linux/fs.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
45 #include <linux/uaccess.h>
46 #include <linux/export.h>
47
48 /*
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
52  */
53 struct pm_qos_object {
54         struct pm_qos_constraints *constraints;
55         struct miscdevice pm_qos_power_miscdev;
56         char *name;
57 };
58
59 static DEFINE_SPINLOCK(pm_qos_lock);
60
61 static struct pm_qos_object null_pm_qos;
62
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,
68         .type = PM_QOS_MIN,
69         .notifiers = &cpu_dma_lat_notifier,
70 };
71 static struct pm_qos_object cpu_dma_pm_qos = {
72         .constraints = &cpu_dma_constraints,
73         .name = "cpu_dma_latency",
74 };
75
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,
81         .type = PM_QOS_MIN,
82         .notifiers = &network_lat_notifier,
83 };
84 static struct pm_qos_object network_lat_pm_qos = {
85         .constraints = &network_lat_constraints,
86         .name = "network_latency",
87 };
88
89
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,
95         .type = PM_QOS_MAX,
96         .notifiers = &network_throughput_notifier,
97 };
98 static struct pm_qos_object network_throughput_pm_qos = {
99         .constraints = &network_tput_constraints,
100         .name = "network_throughput",
101 };
102
103
104 static BLOCKING_NOTIFIER_HEAD(min_online_cpus_notifier);
105 static struct pm_qos_constraints min_online_cpus_constraints = {
106         .list = PLIST_HEAD_INIT(min_online_cpus_constraints.list),
107         .target_value = PM_QOS_MIN_ONLINE_CPUS_DEFAULT_VALUE,
108         .default_value = PM_QOS_MIN_ONLINE_CPUS_DEFAULT_VALUE,
109         .type = PM_QOS_MAX,
110         .notifiers = &min_online_cpus_notifier,
111 };
112 static struct pm_qos_object min_online_cpus_pm_qos = {
113         .constraints = &min_online_cpus_constraints,
114         .name = "min_online_cpus",
115 };
116
117
118 static BLOCKING_NOTIFIER_HEAD(max_online_cpus_notifier);
119 static struct pm_qos_constraints max_online_cpus_constraints = {
120         .list = PLIST_HEAD_INIT(max_online_cpus_constraints.list),
121         .target_value = PM_QOS_MAX_ONLINE_CPUS_DEFAULT_VALUE,
122         .default_value = PM_QOS_MAX_ONLINE_CPUS_DEFAULT_VALUE,
123         .type = PM_QOS_MIN,
124         .notifiers = &max_online_cpus_notifier,
125 };
126 static struct pm_qos_object max_online_cpus_pm_qos = {
127         .constraints = &max_online_cpus_constraints,
128         .name = "max_online_cpus",
129
130 };
131
132
133 static BLOCKING_NOTIFIER_HEAD(cpu_freq_min_notifier);
134 static struct pm_qos_constraints cpu_freq_min_constraints = {
135         .list = PLIST_HEAD_INIT(cpu_freq_min_constraints.list),
136         .target_value = PM_QOS_CPU_FREQ_MIN_DEFAULT_VALUE,
137         .default_value = PM_QOS_CPU_FREQ_MIN_DEFAULT_VALUE,
138         .type = PM_QOS_MAX,
139         .notifiers = &cpu_freq_min_notifier,
140 };
141 static struct pm_qos_object cpu_freq_min_pm_qos = {
142         .constraints = &cpu_freq_min_constraints,
143         .name = "cpu_freq_min",
144 };
145
146
147 static BLOCKING_NOTIFIER_HEAD(cpu_freq_max_notifier);
148 static struct pm_qos_constraints cpu_freq_max_constraints = {
149         .list = PLIST_HEAD_INIT(cpu_freq_max_constraints.list),
150         .target_value = PM_QOS_CPU_FREQ_MAX_DEFAULT_VALUE,
151         .default_value = PM_QOS_CPU_FREQ_MAX_DEFAULT_VALUE,
152         .type = PM_QOS_MIN,
153         .notifiers = &cpu_freq_max_notifier,
154 };
155 static struct pm_qos_object cpu_freq_max_pm_qos = {
156         .constraints = &cpu_freq_max_constraints,
157         .name = "cpu_freq_max",
158 };
159
160
161 static struct pm_qos_object *pm_qos_array[] = {
162         &null_pm_qos,
163         &cpu_dma_pm_qos,
164         &network_lat_pm_qos,
165         &network_throughput_pm_qos,
166         &min_online_cpus_pm_qos,
167         &max_online_cpus_pm_qos,
168         &cpu_freq_min_pm_qos,
169         &cpu_freq_max_pm_qos
170 };
171
172 static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
173                 size_t count, loff_t *f_pos);
174 static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
175                 size_t count, loff_t *f_pos);
176 static int pm_qos_power_open(struct inode *inode, struct file *filp);
177 static int pm_qos_power_release(struct inode *inode, struct file *filp);
178
179 static const struct file_operations pm_qos_power_fops = {
180         .write = pm_qos_power_write,
181         .read = pm_qos_power_read,
182         .open = pm_qos_power_open,
183         .release = pm_qos_power_release,
184         .llseek = noop_llseek,
185 };
186
187 /* unlocked internal variant */
188 static inline int pm_qos_get_value(struct pm_qos_constraints *c)
189 {
190         if (plist_head_empty(&c->list))
191                 return c->default_value;
192
193         switch (c->type) {
194         case PM_QOS_MIN:
195                 return plist_first(&c->list)->prio;
196
197         case PM_QOS_MAX:
198                 return plist_last(&c->list)->prio;
199
200         default:
201                 /* runtime check for not using enum */
202                 BUG();
203         }
204 }
205
206 s32 pm_qos_read_value(struct pm_qos_constraints *c)
207 {
208         return c->target_value;
209 }
210
211 static inline void pm_qos_set_value(struct pm_qos_constraints *c, s32 value)
212 {
213         c->target_value = value;
214 }
215
216 /**
217  * pm_qos_update_target - manages the constraints list and calls the notifiers
218  *  if needed
219  * @c: constraints data struct
220  * @node: request to add to the list, to update or to remove
221  * @action: action to take on the constraints list
222  * @value: value of the request to add or update
223  *
224  * This function returns 1 if the aggregated constraint value has changed, 0
225  *  otherwise.
226  */
227 int pm_qos_update_target(struct pm_qos_constraints *c, struct plist_node *node,
228                          enum pm_qos_req_action action, int value)
229 {
230         unsigned long flags;
231         int prev_value, curr_value, new_value;
232
233         spin_lock_irqsave(&pm_qos_lock, flags);
234         prev_value = pm_qos_get_value(c);
235         if (value == PM_QOS_DEFAULT_VALUE)
236                 new_value = c->default_value;
237         else
238                 new_value = value;
239
240         switch (action) {
241         case PM_QOS_REMOVE_REQ:
242                 plist_del(node, &c->list);
243                 break;
244         case PM_QOS_UPDATE_REQ:
245                 /*
246                  * to change the list, we atomically remove, reinit
247                  * with new value and add, then see if the extremal
248                  * changed
249                  */
250                 plist_del(node, &c->list);
251         case PM_QOS_ADD_REQ:
252                 plist_node_init(node, new_value);
253                 plist_add(node, &c->list);
254                 break;
255         default:
256                 /* no action */
257                 ;
258         }
259
260         curr_value = pm_qos_get_value(c);
261         pm_qos_set_value(c, curr_value);
262
263         spin_unlock_irqrestore(&pm_qos_lock, flags);
264
265         if (prev_value != curr_value) {
266                 blocking_notifier_call_chain(c->notifiers,
267                                              (unsigned long)curr_value,
268                                              NULL);
269                 return 1;
270         } else {
271                 return 0;
272         }
273 }
274
275 /**
276  * pm_qos_request - returns current system wide qos expectation
277  * @pm_qos_class: identification of which qos value is requested
278  *
279  * This function returns the current target value.
280  */
281 int pm_qos_request(int pm_qos_class)
282 {
283         return pm_qos_read_value(pm_qos_array[pm_qos_class]->constraints);
284 }
285 EXPORT_SYMBOL_GPL(pm_qos_request);
286
287 int pm_qos_request_active(struct pm_qos_request *req)
288 {
289         return req->pm_qos_class != 0;
290 }
291 EXPORT_SYMBOL_GPL(pm_qos_request_active);
292
293 /**
294  * pm_qos_work_fn - the timeout handler of pm_qos_update_request_timeout
295  * @work: work struct for the delayed work (timeout)
296  *
297  * This cancels the timeout request by falling back to the default at timeout.
298  */
299 static void pm_qos_work_fn(struct work_struct *work)
300 {
301         struct pm_qos_request *req = container_of(to_delayed_work(work),
302                                                   struct pm_qos_request,
303                                                   work);
304
305         pm_qos_update_request(req, PM_QOS_DEFAULT_VALUE);
306 }
307
308 /**
309  * pm_qos_add_request - inserts new qos request into the list
310  * @req: pointer to a preallocated handle
311  * @pm_qos_class: identifies which list of qos request to use
312  * @value: defines the qos request
313  *
314  * This function inserts a new entry in the pm_qos_class list of requested qos
315  * performance characteristics.  It recomputes the aggregate QoS expectations
316  * for the pm_qos_class of parameters and initializes the pm_qos_request
317  * handle.  Caller needs to save this handle for later use in updates and
318  * removal.
319  */
320
321 void pm_qos_add_request(struct pm_qos_request *req,
322                         int pm_qos_class, s32 value)
323 {
324         if (!req) /*guard against callers passing in null */
325                 return;
326
327         if (pm_qos_request_active(req)) {
328                 WARN(1, KERN_ERR "pm_qos_add_request() called for already added request\n");
329                 return;
330         }
331         req->pm_qos_class = pm_qos_class;
332         INIT_DELAYED_WORK(&req->work, pm_qos_work_fn);
333         pm_qos_update_target(pm_qos_array[pm_qos_class]->constraints,
334                              &req->node, PM_QOS_ADD_REQ, value);
335 }
336 EXPORT_SYMBOL_GPL(pm_qos_add_request);
337
338 /**
339  * pm_qos_update_request - modifies an existing qos request
340  * @req : handle to list element holding a pm_qos request to use
341  * @value: defines the qos request
342  *
343  * Updates an existing qos request for the pm_qos_class of parameters along
344  * with updating the target pm_qos_class value.
345  *
346  * Attempts are made to make this code callable on hot code paths.
347  */
348 void pm_qos_update_request(struct pm_qos_request *req,
349                            s32 new_value)
350 {
351         if (!req) /*guard against callers passing in null */
352                 return;
353
354         if (!pm_qos_request_active(req)) {
355                 WARN(1, KERN_ERR "pm_qos_update_request() called for unknown object\n");
356                 return;
357         }
358
359         if (delayed_work_pending(&req->work))
360                 cancel_delayed_work_sync(&req->work);
361
362         if (new_value != req->node.prio)
363                 pm_qos_update_target(
364                         pm_qos_array[req->pm_qos_class]->constraints,
365                         &req->node, PM_QOS_UPDATE_REQ, new_value);
366 }
367 EXPORT_SYMBOL_GPL(pm_qos_update_request);
368
369 /**
370  * pm_qos_update_request_timeout - modifies an existing qos request temporarily.
371  * @req : handle to list element holding a pm_qos request to use
372  * @new_value: defines the temporal qos request
373  * @timeout_us: the effective duration of this qos request in usecs.
374  *
375  * After timeout_us, this qos request is cancelled automatically.
376  */
377 void pm_qos_update_request_timeout(struct pm_qos_request *req, s32 new_value,
378                                    unsigned long timeout_us)
379 {
380         if (!req)
381                 return;
382         if (WARN(!pm_qos_request_active(req),
383                  "%s called for unknown object.", __func__))
384                 return;
385
386         if (delayed_work_pending(&req->work))
387                 cancel_delayed_work_sync(&req->work);
388
389         if (new_value != req->node.prio)
390                 pm_qos_update_target(
391                         pm_qos_array[req->pm_qos_class]->constraints,
392                         &req->node, PM_QOS_UPDATE_REQ, new_value);
393
394         schedule_delayed_work(&req->work, usecs_to_jiffies(timeout_us));
395 }
396
397 /**
398  * pm_qos_remove_request - modifies an existing qos request
399  * @req: handle to request list element
400  *
401  * Will remove pm qos request from the list of constraints and
402  * recompute the current target value for the pm_qos_class.  Call this
403  * on slow code paths.
404  */
405 void pm_qos_remove_request(struct pm_qos_request *req)
406 {
407         if (!req) /*guard against callers passing in null */
408                 return;
409                 /* silent return to keep pcm code cleaner */
410
411         if (!pm_qos_request_active(req)) {
412                 WARN(1, KERN_ERR "pm_qos_remove_request() called for unknown object\n");
413                 return;
414         }
415
416         if (delayed_work_pending(&req->work))
417                 cancel_delayed_work_sync(&req->work);
418
419         pm_qos_update_target(pm_qos_array[req->pm_qos_class]->constraints,
420                              &req->node, PM_QOS_REMOVE_REQ,
421                              PM_QOS_DEFAULT_VALUE);
422         memset(req, 0, sizeof(*req));
423 }
424 EXPORT_SYMBOL_GPL(pm_qos_remove_request);
425
426 /**
427  * pm_qos_add_notifier - sets notification entry for changes to target value
428  * @pm_qos_class: identifies which qos target changes should be notified.
429  * @notifier: notifier block managed by caller.
430  *
431  * will register the notifier into a notification chain that gets called
432  * upon changes to the pm_qos_class target value.
433  */
434 int pm_qos_add_notifier(int pm_qos_class, struct notifier_block *notifier)
435 {
436         int retval;
437
438         retval = blocking_notifier_chain_register(
439                         pm_qos_array[pm_qos_class]->constraints->notifiers,
440                         notifier);
441
442         return retval;
443 }
444 EXPORT_SYMBOL_GPL(pm_qos_add_notifier);
445
446 /**
447  * pm_qos_remove_notifier - deletes notification entry from chain.
448  * @pm_qos_class: identifies which qos target changes are notified.
449  * @notifier: notifier block to be removed.
450  *
451  * will remove the notifier from the notification chain that gets called
452  * upon changes to the pm_qos_class target value.
453  */
454 int pm_qos_remove_notifier(int pm_qos_class, struct notifier_block *notifier)
455 {
456         int retval;
457
458         retval = blocking_notifier_chain_unregister(
459                         pm_qos_array[pm_qos_class]->constraints->notifiers,
460                         notifier);
461
462         return retval;
463 }
464 EXPORT_SYMBOL_GPL(pm_qos_remove_notifier);
465
466 /* User space interface to PM QoS classes via misc devices */
467 static int register_pm_qos_misc(struct pm_qos_object *qos)
468 {
469         qos->pm_qos_power_miscdev.minor = MISC_DYNAMIC_MINOR;
470         qos->pm_qos_power_miscdev.name = qos->name;
471         qos->pm_qos_power_miscdev.fops = &pm_qos_power_fops;
472
473         return misc_register(&qos->pm_qos_power_miscdev);
474 }
475
476 static int find_pm_qos_object_by_minor(int minor)
477 {
478         int pm_qos_class;
479
480         for (pm_qos_class = 0;
481                 pm_qos_class < PM_QOS_NUM_CLASSES; pm_qos_class++) {
482                 if (minor ==
483                         pm_qos_array[pm_qos_class]->pm_qos_power_miscdev.minor)
484                         return pm_qos_class;
485         }
486         return -1;
487 }
488
489 static int pm_qos_power_open(struct inode *inode, struct file *filp)
490 {
491         long pm_qos_class;
492
493         pm_qos_class = find_pm_qos_object_by_minor(iminor(inode));
494         if (pm_qos_class >= 0) {
495                 struct pm_qos_request *req = kzalloc(sizeof(*req), GFP_KERNEL);
496                 if (!req)
497                         return -ENOMEM;
498
499                 pm_qos_add_request(req, pm_qos_class, PM_QOS_DEFAULT_VALUE);
500                 filp->private_data = req;
501
502                 return 0;
503         }
504         return -EPERM;
505 }
506
507 static int pm_qos_power_release(struct inode *inode, struct file *filp)
508 {
509         struct pm_qos_request *req;
510
511         req = filp->private_data;
512         pm_qos_remove_request(req);
513         kfree(req);
514
515         return 0;
516 }
517
518
519 static ssize_t pm_qos_power_read(struct file *filp, char __user *buf,
520                 size_t count, loff_t *f_pos)
521 {
522         s32 value;
523         unsigned long flags;
524         struct pm_qos_request *req = filp->private_data;
525
526         if (!req)
527                 return -EINVAL;
528         if (!pm_qos_request_active(req))
529                 return -EINVAL;
530
531         spin_lock_irqsave(&pm_qos_lock, flags);
532         value = pm_qos_get_value(pm_qos_array[req->pm_qos_class]->constraints);
533         spin_unlock_irqrestore(&pm_qos_lock, flags);
534
535         return simple_read_from_buffer(buf, count, f_pos, &value, sizeof(s32));
536 }
537
538 static ssize_t pm_qos_power_write(struct file *filp, const char __user *buf,
539                 size_t count, loff_t *f_pos)
540 {
541         s32 value;
542         struct pm_qos_request *req;
543
544         if (count == sizeof(s32)) {
545                 if (copy_from_user(&value, buf, sizeof(s32)))
546                         return -EFAULT;
547         } else if (count <= 11) { /* ASCII perhaps? */
548                 char ascii_value[11];
549                 unsigned long int ulval;
550                 int ret;
551
552                 if (copy_from_user(ascii_value, buf, count))
553                         return -EFAULT;
554
555                 if (count > 10) {
556                         if (ascii_value[10] == '\n')
557                                 ascii_value[10] = '\0';
558                         else
559                                 return -EINVAL;
560                 } else {
561                         ascii_value[count] = '\0';
562                 }
563                 ret = strict_strtoul(ascii_value, 16, &ulval);
564                 if (ret) {
565                         pr_debug("%s, 0x%lx, 0x%x\n", ascii_value, ulval, ret);
566                         return -EINVAL;
567                 }
568                 value = (s32)lower_32_bits(ulval);
569         } else {
570                 return -EINVAL;
571         }
572
573         req = filp->private_data;
574         pm_qos_update_request(req, value);
575
576         return count;
577 }
578
579
580 static int __init pm_qos_power_init(void)
581 {
582         int ret = 0;
583         int i;
584
585         BUILD_BUG_ON(ARRAY_SIZE(pm_qos_array) != PM_QOS_NUM_CLASSES);
586
587         for (i = 1; i < PM_QOS_NUM_CLASSES; i++) {
588                 ret = register_pm_qos_misc(pm_qos_array[i]);
589                 if (ret < 0) {
590                         printk(KERN_ERR "pm_qos_param: %s setup failed\n",
591                                pm_qos_array[i]->name);
592                         return ret;
593                 }
594         }
595
596         return ret;
597 }
598
599 late_initcall(pm_qos_power_init);