Loading...
1/*
2 * devfreq: Generic Dynamic Voltage and Frequency Scaling (DVFS) Framework
3 * for Non-CPU Devices.
4 *
5 * Copyright (C) 2011 Samsung Electronics
6 * MyungJoo Ham <myungjoo.ham@samsung.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#include <linux/kernel.h>
14#include <linux/sched.h>
15#include <linux/errno.h>
16#include <linux/err.h>
17#include <linux/init.h>
18#include <linux/module.h>
19#include <linux/slab.h>
20#include <linux/stat.h>
21#include <linux/pm_opp.h>
22#include <linux/devfreq.h>
23#include <linux/workqueue.h>
24#include <linux/platform_device.h>
25#include <linux/list.h>
26#include <linux/printk.h>
27#include <linux/hrtimer.h>
28#include "governor.h"
29
30static struct class *devfreq_class;
31
32/*
33 * devfreq core provides delayed work based load monitoring helper
34 * functions. Governors can use these or can implement their own
35 * monitoring mechanism.
36 */
37static struct workqueue_struct *devfreq_wq;
38
39/* The list of all device-devfreq governors */
40static LIST_HEAD(devfreq_governor_list);
41/* The list of all device-devfreq */
42static LIST_HEAD(devfreq_list);
43static DEFINE_MUTEX(devfreq_list_lock);
44
45/**
46 * find_device_devfreq() - find devfreq struct using device pointer
47 * @dev: device pointer used to lookup device devfreq.
48 *
49 * Search the list of device devfreqs and return the matched device's
50 * devfreq info. devfreq_list_lock should be held by the caller.
51 */
52static struct devfreq *find_device_devfreq(struct device *dev)
53{
54 struct devfreq *tmp_devfreq;
55
56 if (IS_ERR_OR_NULL(dev)) {
57 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
58 return ERR_PTR(-EINVAL);
59 }
60 WARN(!mutex_is_locked(&devfreq_list_lock),
61 "devfreq_list_lock must be locked.");
62
63 list_for_each_entry(tmp_devfreq, &devfreq_list, node) {
64 if (tmp_devfreq->dev.parent == dev)
65 return tmp_devfreq;
66 }
67
68 return ERR_PTR(-ENODEV);
69}
70
71/**
72 * devfreq_get_freq_level() - Lookup freq_table for the frequency
73 * @devfreq: the devfreq instance
74 * @freq: the target frequency
75 */
76static int devfreq_get_freq_level(struct devfreq *devfreq, unsigned long freq)
77{
78 int lev;
79
80 for (lev = 0; lev < devfreq->profile->max_state; lev++)
81 if (freq == devfreq->profile->freq_table[lev])
82 return lev;
83
84 return -EINVAL;
85}
86
87/**
88 * devfreq_set_freq_table() - Initialize freq_table for the frequency
89 * @devfreq: the devfreq instance
90 */
91static void devfreq_set_freq_table(struct devfreq *devfreq)
92{
93 struct devfreq_dev_profile *profile = devfreq->profile;
94 struct dev_pm_opp *opp;
95 unsigned long freq;
96 int i, count;
97
98 /* Initialize the freq_table from OPP table */
99 count = dev_pm_opp_get_opp_count(devfreq->dev.parent);
100 if (count <= 0)
101 return;
102
103 profile->max_state = count;
104 profile->freq_table = devm_kcalloc(devfreq->dev.parent,
105 profile->max_state,
106 sizeof(*profile->freq_table),
107 GFP_KERNEL);
108 if (!profile->freq_table) {
109 profile->max_state = 0;
110 return;
111 }
112
113 rcu_read_lock();
114 for (i = 0, freq = 0; i < profile->max_state; i++, freq++) {
115 opp = dev_pm_opp_find_freq_ceil(devfreq->dev.parent, &freq);
116 if (IS_ERR(opp)) {
117 devm_kfree(devfreq->dev.parent, profile->freq_table);
118 profile->max_state = 0;
119 rcu_read_unlock();
120 return;
121 }
122 profile->freq_table[i] = freq;
123 }
124 rcu_read_unlock();
125}
126
127/**
128 * devfreq_update_status() - Update statistics of devfreq behavior
129 * @devfreq: the devfreq instance
130 * @freq: the update target frequency
131 */
132static int devfreq_update_status(struct devfreq *devfreq, unsigned long freq)
133{
134 int lev, prev_lev, ret = 0;
135 unsigned long cur_time;
136
137 cur_time = jiffies;
138
139 prev_lev = devfreq_get_freq_level(devfreq, devfreq->previous_freq);
140 if (prev_lev < 0) {
141 ret = prev_lev;
142 goto out;
143 }
144
145 devfreq->time_in_state[prev_lev] +=
146 cur_time - devfreq->last_stat_updated;
147
148 lev = devfreq_get_freq_level(devfreq, freq);
149 if (lev < 0) {
150 ret = lev;
151 goto out;
152 }
153
154 if (lev != prev_lev) {
155 devfreq->trans_table[(prev_lev *
156 devfreq->profile->max_state) + lev]++;
157 devfreq->total_trans++;
158 }
159
160out:
161 devfreq->last_stat_updated = cur_time;
162 return ret;
163}
164
165/**
166 * find_devfreq_governor() - find devfreq governor from name
167 * @name: name of the governor
168 *
169 * Search the list of devfreq governors and return the matched
170 * governor's pointer. devfreq_list_lock should be held by the caller.
171 */
172static struct devfreq_governor *find_devfreq_governor(const char *name)
173{
174 struct devfreq_governor *tmp_governor;
175
176 if (IS_ERR_OR_NULL(name)) {
177 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
178 return ERR_PTR(-EINVAL);
179 }
180 WARN(!mutex_is_locked(&devfreq_list_lock),
181 "devfreq_list_lock must be locked.");
182
183 list_for_each_entry(tmp_governor, &devfreq_governor_list, node) {
184 if (!strncmp(tmp_governor->name, name, DEVFREQ_NAME_LEN))
185 return tmp_governor;
186 }
187
188 return ERR_PTR(-ENODEV);
189}
190
191/* Load monitoring helper functions for governors use */
192
193/**
194 * update_devfreq() - Reevaluate the device and configure frequency.
195 * @devfreq: the devfreq instance.
196 *
197 * Note: Lock devfreq->lock before calling update_devfreq
198 * This function is exported for governors.
199 */
200int update_devfreq(struct devfreq *devfreq)
201{
202 unsigned long freq;
203 int err = 0;
204 u32 flags = 0;
205
206 if (!mutex_is_locked(&devfreq->lock)) {
207 WARN(true, "devfreq->lock must be locked by the caller.\n");
208 return -EINVAL;
209 }
210
211 if (!devfreq->governor)
212 return -EINVAL;
213
214 /* Reevaluate the proper frequency */
215 err = devfreq->governor->get_target_freq(devfreq, &freq);
216 if (err)
217 return err;
218
219 /*
220 * Adjust the frequency with user freq and QoS.
221 *
222 * List from the highest priority
223 * max_freq
224 * min_freq
225 */
226
227 if (devfreq->min_freq && freq < devfreq->min_freq) {
228 freq = devfreq->min_freq;
229 flags &= ~DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use GLB */
230 }
231 if (devfreq->max_freq && freq > devfreq->max_freq) {
232 freq = devfreq->max_freq;
233 flags |= DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use LUB */
234 }
235
236 err = devfreq->profile->target(devfreq->dev.parent, &freq, flags);
237 if (err)
238 return err;
239
240 if (devfreq->profile->freq_table)
241 if (devfreq_update_status(devfreq, freq))
242 dev_err(&devfreq->dev,
243 "Couldn't update frequency transition information.\n");
244
245 devfreq->previous_freq = freq;
246 return err;
247}
248EXPORT_SYMBOL(update_devfreq);
249
250/**
251 * devfreq_monitor() - Periodically poll devfreq objects.
252 * @work: the work struct used to run devfreq_monitor periodically.
253 *
254 */
255static void devfreq_monitor(struct work_struct *work)
256{
257 int err;
258 struct devfreq *devfreq = container_of(work,
259 struct devfreq, work.work);
260
261 mutex_lock(&devfreq->lock);
262 err = update_devfreq(devfreq);
263 if (err)
264 dev_err(&devfreq->dev, "dvfs failed with (%d) error\n", err);
265
266 queue_delayed_work(devfreq_wq, &devfreq->work,
267 msecs_to_jiffies(devfreq->profile->polling_ms));
268 mutex_unlock(&devfreq->lock);
269}
270
271/**
272 * devfreq_monitor_start() - Start load monitoring of devfreq instance
273 * @devfreq: the devfreq instance.
274 *
275 * Helper function for starting devfreq device load monitoing. By
276 * default delayed work based monitoring is supported. Function
277 * to be called from governor in response to DEVFREQ_GOV_START
278 * event when device is added to devfreq framework.
279 */
280void devfreq_monitor_start(struct devfreq *devfreq)
281{
282 INIT_DEFERRABLE_WORK(&devfreq->work, devfreq_monitor);
283 if (devfreq->profile->polling_ms)
284 queue_delayed_work(devfreq_wq, &devfreq->work,
285 msecs_to_jiffies(devfreq->profile->polling_ms));
286}
287EXPORT_SYMBOL(devfreq_monitor_start);
288
289/**
290 * devfreq_monitor_stop() - Stop load monitoring of a devfreq instance
291 * @devfreq: the devfreq instance.
292 *
293 * Helper function to stop devfreq device load monitoing. Function
294 * to be called from governor in response to DEVFREQ_GOV_STOP
295 * event when device is removed from devfreq framework.
296 */
297void devfreq_monitor_stop(struct devfreq *devfreq)
298{
299 cancel_delayed_work_sync(&devfreq->work);
300}
301EXPORT_SYMBOL(devfreq_monitor_stop);
302
303/**
304 * devfreq_monitor_suspend() - Suspend load monitoring of a devfreq instance
305 * @devfreq: the devfreq instance.
306 *
307 * Helper function to suspend devfreq device load monitoing. Function
308 * to be called from governor in response to DEVFREQ_GOV_SUSPEND
309 * event or when polling interval is set to zero.
310 *
311 * Note: Though this function is same as devfreq_monitor_stop(),
312 * intentionally kept separate to provide hooks for collecting
313 * transition statistics.
314 */
315void devfreq_monitor_suspend(struct devfreq *devfreq)
316{
317 mutex_lock(&devfreq->lock);
318 if (devfreq->stop_polling) {
319 mutex_unlock(&devfreq->lock);
320 return;
321 }
322
323 devfreq_update_status(devfreq, devfreq->previous_freq);
324 devfreq->stop_polling = true;
325 mutex_unlock(&devfreq->lock);
326 cancel_delayed_work_sync(&devfreq->work);
327}
328EXPORT_SYMBOL(devfreq_monitor_suspend);
329
330/**
331 * devfreq_monitor_resume() - Resume load monitoring of a devfreq instance
332 * @devfreq: the devfreq instance.
333 *
334 * Helper function to resume devfreq device load monitoing. Function
335 * to be called from governor in response to DEVFREQ_GOV_RESUME
336 * event or when polling interval is set to non-zero.
337 */
338void devfreq_monitor_resume(struct devfreq *devfreq)
339{
340 unsigned long freq;
341
342 mutex_lock(&devfreq->lock);
343 if (!devfreq->stop_polling)
344 goto out;
345
346 if (!delayed_work_pending(&devfreq->work) &&
347 devfreq->profile->polling_ms)
348 queue_delayed_work(devfreq_wq, &devfreq->work,
349 msecs_to_jiffies(devfreq->profile->polling_ms));
350
351 devfreq->last_stat_updated = jiffies;
352 devfreq->stop_polling = false;
353
354 if (devfreq->profile->get_cur_freq &&
355 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
356 devfreq->previous_freq = freq;
357
358out:
359 mutex_unlock(&devfreq->lock);
360}
361EXPORT_SYMBOL(devfreq_monitor_resume);
362
363/**
364 * devfreq_interval_update() - Update device devfreq monitoring interval
365 * @devfreq: the devfreq instance.
366 * @delay: new polling interval to be set.
367 *
368 * Helper function to set new load monitoring polling interval. Function
369 * to be called from governor in response to DEVFREQ_GOV_INTERVAL event.
370 */
371void devfreq_interval_update(struct devfreq *devfreq, unsigned int *delay)
372{
373 unsigned int cur_delay = devfreq->profile->polling_ms;
374 unsigned int new_delay = *delay;
375
376 mutex_lock(&devfreq->lock);
377 devfreq->profile->polling_ms = new_delay;
378
379 if (devfreq->stop_polling)
380 goto out;
381
382 /* if new delay is zero, stop polling */
383 if (!new_delay) {
384 mutex_unlock(&devfreq->lock);
385 cancel_delayed_work_sync(&devfreq->work);
386 return;
387 }
388
389 /* if current delay is zero, start polling with new delay */
390 if (!cur_delay) {
391 queue_delayed_work(devfreq_wq, &devfreq->work,
392 msecs_to_jiffies(devfreq->profile->polling_ms));
393 goto out;
394 }
395
396 /* if current delay is greater than new delay, restart polling */
397 if (cur_delay > new_delay) {
398 mutex_unlock(&devfreq->lock);
399 cancel_delayed_work_sync(&devfreq->work);
400 mutex_lock(&devfreq->lock);
401 if (!devfreq->stop_polling)
402 queue_delayed_work(devfreq_wq, &devfreq->work,
403 msecs_to_jiffies(devfreq->profile->polling_ms));
404 }
405out:
406 mutex_unlock(&devfreq->lock);
407}
408EXPORT_SYMBOL(devfreq_interval_update);
409
410/**
411 * devfreq_notifier_call() - Notify that the device frequency requirements
412 * has been changed out of devfreq framework.
413 * @nb: the notifier_block (supposed to be devfreq->nb)
414 * @type: not used
415 * @devp: not used
416 *
417 * Called by a notifier that uses devfreq->nb.
418 */
419static int devfreq_notifier_call(struct notifier_block *nb, unsigned long type,
420 void *devp)
421{
422 struct devfreq *devfreq = container_of(nb, struct devfreq, nb);
423 int ret;
424
425 mutex_lock(&devfreq->lock);
426 ret = update_devfreq(devfreq);
427 mutex_unlock(&devfreq->lock);
428
429 return ret;
430}
431
432/**
433 * _remove_devfreq() - Remove devfreq from the list and release its resources.
434 * @devfreq: the devfreq struct
435 */
436static void _remove_devfreq(struct devfreq *devfreq)
437{
438 mutex_lock(&devfreq_list_lock);
439 if (IS_ERR(find_device_devfreq(devfreq->dev.parent))) {
440 mutex_unlock(&devfreq_list_lock);
441 dev_warn(&devfreq->dev, "releasing devfreq which doesn't exist\n");
442 return;
443 }
444 list_del(&devfreq->node);
445 mutex_unlock(&devfreq_list_lock);
446
447 if (devfreq->governor)
448 devfreq->governor->event_handler(devfreq,
449 DEVFREQ_GOV_STOP, NULL);
450
451 if (devfreq->profile->exit)
452 devfreq->profile->exit(devfreq->dev.parent);
453
454 mutex_destroy(&devfreq->lock);
455 kfree(devfreq);
456}
457
458/**
459 * devfreq_dev_release() - Callback for struct device to release the device.
460 * @dev: the devfreq device
461 *
462 * This calls _remove_devfreq() if _remove_devfreq() is not called.
463 */
464static void devfreq_dev_release(struct device *dev)
465{
466 struct devfreq *devfreq = to_devfreq(dev);
467
468 _remove_devfreq(devfreq);
469}
470
471/**
472 * devfreq_add_device() - Add devfreq feature to the device
473 * @dev: the device to add devfreq feature.
474 * @profile: device-specific profile to run devfreq.
475 * @governor_name: name of the policy to choose frequency.
476 * @data: private data for the governor. The devfreq framework does not
477 * touch this value.
478 */
479struct devfreq *devfreq_add_device(struct device *dev,
480 struct devfreq_dev_profile *profile,
481 const char *governor_name,
482 void *data)
483{
484 struct devfreq *devfreq;
485 struct devfreq_governor *governor;
486 int err = 0;
487
488 if (!dev || !profile || !governor_name) {
489 dev_err(dev, "%s: Invalid parameters.\n", __func__);
490 return ERR_PTR(-EINVAL);
491 }
492
493 mutex_lock(&devfreq_list_lock);
494 devfreq = find_device_devfreq(dev);
495 mutex_unlock(&devfreq_list_lock);
496 if (!IS_ERR(devfreq)) {
497 dev_err(dev, "%s: Unable to create devfreq for the device. It already has one.\n", __func__);
498 err = -EINVAL;
499 goto err_out;
500 }
501
502 devfreq = kzalloc(sizeof(struct devfreq), GFP_KERNEL);
503 if (!devfreq) {
504 dev_err(dev, "%s: Unable to create devfreq for the device\n",
505 __func__);
506 err = -ENOMEM;
507 goto err_out;
508 }
509
510 mutex_init(&devfreq->lock);
511 mutex_lock(&devfreq->lock);
512 devfreq->dev.parent = dev;
513 devfreq->dev.class = devfreq_class;
514 devfreq->dev.release = devfreq_dev_release;
515 devfreq->profile = profile;
516 strncpy(devfreq->governor_name, governor_name, DEVFREQ_NAME_LEN);
517 devfreq->previous_freq = profile->initial_freq;
518 devfreq->data = data;
519 devfreq->nb.notifier_call = devfreq_notifier_call;
520
521 if (!devfreq->profile->max_state && !devfreq->profile->freq_table) {
522 mutex_unlock(&devfreq->lock);
523 devfreq_set_freq_table(devfreq);
524 mutex_lock(&devfreq->lock);
525 }
526
527 devfreq->trans_table = devm_kzalloc(dev, sizeof(unsigned int) *
528 devfreq->profile->max_state *
529 devfreq->profile->max_state,
530 GFP_KERNEL);
531 devfreq->time_in_state = devm_kzalloc(dev, sizeof(unsigned long) *
532 devfreq->profile->max_state,
533 GFP_KERNEL);
534 devfreq->last_stat_updated = jiffies;
535
536 dev_set_name(&devfreq->dev, "%s", dev_name(dev));
537 err = device_register(&devfreq->dev);
538 if (err) {
539 put_device(&devfreq->dev);
540 mutex_unlock(&devfreq->lock);
541 goto err_out;
542 }
543
544 mutex_unlock(&devfreq->lock);
545
546 mutex_lock(&devfreq_list_lock);
547 list_add(&devfreq->node, &devfreq_list);
548
549 governor = find_devfreq_governor(devfreq->governor_name);
550 if (!IS_ERR(governor))
551 devfreq->governor = governor;
552 if (devfreq->governor)
553 err = devfreq->governor->event_handler(devfreq,
554 DEVFREQ_GOV_START, NULL);
555 mutex_unlock(&devfreq_list_lock);
556 if (err) {
557 dev_err(dev, "%s: Unable to start governor for the device\n",
558 __func__);
559 goto err_init;
560 }
561
562 return devfreq;
563
564err_init:
565 list_del(&devfreq->node);
566 device_unregister(&devfreq->dev);
567 kfree(devfreq);
568err_out:
569 return ERR_PTR(err);
570}
571EXPORT_SYMBOL(devfreq_add_device);
572
573/**
574 * devfreq_remove_device() - Remove devfreq feature from a device.
575 * @devfreq: the devfreq instance to be removed
576 *
577 * The opposite of devfreq_add_device().
578 */
579int devfreq_remove_device(struct devfreq *devfreq)
580{
581 if (!devfreq)
582 return -EINVAL;
583
584 device_unregister(&devfreq->dev);
585 put_device(&devfreq->dev);
586
587 return 0;
588}
589EXPORT_SYMBOL(devfreq_remove_device);
590
591static int devm_devfreq_dev_match(struct device *dev, void *res, void *data)
592{
593 struct devfreq **r = res;
594
595 if (WARN_ON(!r || !*r))
596 return 0;
597
598 return *r == data;
599}
600
601static void devm_devfreq_dev_release(struct device *dev, void *res)
602{
603 devfreq_remove_device(*(struct devfreq **)res);
604}
605
606/**
607 * devm_devfreq_add_device() - Resource-managed devfreq_add_device()
608 * @dev: the device to add devfreq feature.
609 * @profile: device-specific profile to run devfreq.
610 * @governor_name: name of the policy to choose frequency.
611 * @data: private data for the governor. The devfreq framework does not
612 * touch this value.
613 *
614 * This function manages automatically the memory of devfreq device using device
615 * resource management and simplify the free operation for memory of devfreq
616 * device.
617 */
618struct devfreq *devm_devfreq_add_device(struct device *dev,
619 struct devfreq_dev_profile *profile,
620 const char *governor_name,
621 void *data)
622{
623 struct devfreq **ptr, *devfreq;
624
625 ptr = devres_alloc(devm_devfreq_dev_release, sizeof(*ptr), GFP_KERNEL);
626 if (!ptr)
627 return ERR_PTR(-ENOMEM);
628
629 devfreq = devfreq_add_device(dev, profile, governor_name, data);
630 if (IS_ERR(devfreq)) {
631 devres_free(ptr);
632 return ERR_PTR(-ENOMEM);
633 }
634
635 *ptr = devfreq;
636 devres_add(dev, ptr);
637
638 return devfreq;
639}
640EXPORT_SYMBOL(devm_devfreq_add_device);
641
642/**
643 * devm_devfreq_remove_device() - Resource-managed devfreq_remove_device()
644 * @dev: the device to add devfreq feature.
645 * @devfreq: the devfreq instance to be removed
646 */
647void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq)
648{
649 WARN_ON(devres_release(dev, devm_devfreq_dev_release,
650 devm_devfreq_dev_match, devfreq));
651}
652EXPORT_SYMBOL(devm_devfreq_remove_device);
653
654/**
655 * devfreq_suspend_device() - Suspend devfreq of a device.
656 * @devfreq: the devfreq instance to be suspended
657 *
658 * This function is intended to be called by the pm callbacks
659 * (e.g., runtime_suspend, suspend) of the device driver that
660 * holds the devfreq.
661 */
662int devfreq_suspend_device(struct devfreq *devfreq)
663{
664 if (!devfreq)
665 return -EINVAL;
666
667 if (!devfreq->governor)
668 return 0;
669
670 return devfreq->governor->event_handler(devfreq,
671 DEVFREQ_GOV_SUSPEND, NULL);
672}
673EXPORT_SYMBOL(devfreq_suspend_device);
674
675/**
676 * devfreq_resume_device() - Resume devfreq of a device.
677 * @devfreq: the devfreq instance to be resumed
678 *
679 * This function is intended to be called by the pm callbacks
680 * (e.g., runtime_resume, resume) of the device driver that
681 * holds the devfreq.
682 */
683int devfreq_resume_device(struct devfreq *devfreq)
684{
685 if (!devfreq)
686 return -EINVAL;
687
688 if (!devfreq->governor)
689 return 0;
690
691 return devfreq->governor->event_handler(devfreq,
692 DEVFREQ_GOV_RESUME, NULL);
693}
694EXPORT_SYMBOL(devfreq_resume_device);
695
696/**
697 * devfreq_add_governor() - Add devfreq governor
698 * @governor: the devfreq governor to be added
699 */
700int devfreq_add_governor(struct devfreq_governor *governor)
701{
702 struct devfreq_governor *g;
703 struct devfreq *devfreq;
704 int err = 0;
705
706 if (!governor) {
707 pr_err("%s: Invalid parameters.\n", __func__);
708 return -EINVAL;
709 }
710
711 mutex_lock(&devfreq_list_lock);
712 g = find_devfreq_governor(governor->name);
713 if (!IS_ERR(g)) {
714 pr_err("%s: governor %s already registered\n", __func__,
715 g->name);
716 err = -EINVAL;
717 goto err_out;
718 }
719
720 list_add(&governor->node, &devfreq_governor_list);
721
722 list_for_each_entry(devfreq, &devfreq_list, node) {
723 int ret = 0;
724 struct device *dev = devfreq->dev.parent;
725
726 if (!strncmp(devfreq->governor_name, governor->name,
727 DEVFREQ_NAME_LEN)) {
728 /* The following should never occur */
729 if (devfreq->governor) {
730 dev_warn(dev,
731 "%s: Governor %s already present\n",
732 __func__, devfreq->governor->name);
733 ret = devfreq->governor->event_handler(devfreq,
734 DEVFREQ_GOV_STOP, NULL);
735 if (ret) {
736 dev_warn(dev,
737 "%s: Governor %s stop = %d\n",
738 __func__,
739 devfreq->governor->name, ret);
740 }
741 /* Fall through */
742 }
743 devfreq->governor = governor;
744 ret = devfreq->governor->event_handler(devfreq,
745 DEVFREQ_GOV_START, NULL);
746 if (ret) {
747 dev_warn(dev, "%s: Governor %s start=%d\n",
748 __func__, devfreq->governor->name,
749 ret);
750 }
751 }
752 }
753
754err_out:
755 mutex_unlock(&devfreq_list_lock);
756
757 return err;
758}
759EXPORT_SYMBOL(devfreq_add_governor);
760
761/**
762 * devfreq_remove_device() - Remove devfreq feature from a device.
763 * @governor: the devfreq governor to be removed
764 */
765int devfreq_remove_governor(struct devfreq_governor *governor)
766{
767 struct devfreq_governor *g;
768 struct devfreq *devfreq;
769 int err = 0;
770
771 if (!governor) {
772 pr_err("%s: Invalid parameters.\n", __func__);
773 return -EINVAL;
774 }
775
776 mutex_lock(&devfreq_list_lock);
777 g = find_devfreq_governor(governor->name);
778 if (IS_ERR(g)) {
779 pr_err("%s: governor %s not registered\n", __func__,
780 governor->name);
781 err = PTR_ERR(g);
782 goto err_out;
783 }
784 list_for_each_entry(devfreq, &devfreq_list, node) {
785 int ret;
786 struct device *dev = devfreq->dev.parent;
787
788 if (!strncmp(devfreq->governor_name, governor->name,
789 DEVFREQ_NAME_LEN)) {
790 /* we should have a devfreq governor! */
791 if (!devfreq->governor) {
792 dev_warn(dev, "%s: Governor %s NOT present\n",
793 __func__, governor->name);
794 continue;
795 /* Fall through */
796 }
797 ret = devfreq->governor->event_handler(devfreq,
798 DEVFREQ_GOV_STOP, NULL);
799 if (ret) {
800 dev_warn(dev, "%s: Governor %s stop=%d\n",
801 __func__, devfreq->governor->name,
802 ret);
803 }
804 devfreq->governor = NULL;
805 }
806 }
807
808 list_del(&governor->node);
809err_out:
810 mutex_unlock(&devfreq_list_lock);
811
812 return err;
813}
814EXPORT_SYMBOL(devfreq_remove_governor);
815
816static ssize_t governor_show(struct device *dev,
817 struct device_attribute *attr, char *buf)
818{
819 if (!to_devfreq(dev)->governor)
820 return -EINVAL;
821
822 return sprintf(buf, "%s\n", to_devfreq(dev)->governor->name);
823}
824
825static ssize_t governor_store(struct device *dev, struct device_attribute *attr,
826 const char *buf, size_t count)
827{
828 struct devfreq *df = to_devfreq(dev);
829 int ret;
830 char str_governor[DEVFREQ_NAME_LEN + 1];
831 struct devfreq_governor *governor;
832
833 ret = sscanf(buf, "%" __stringify(DEVFREQ_NAME_LEN) "s", str_governor);
834 if (ret != 1)
835 return -EINVAL;
836
837 mutex_lock(&devfreq_list_lock);
838 governor = find_devfreq_governor(str_governor);
839 if (IS_ERR(governor)) {
840 ret = PTR_ERR(governor);
841 goto out;
842 }
843 if (df->governor == governor) {
844 ret = 0;
845 goto out;
846 }
847
848 if (df->governor) {
849 ret = df->governor->event_handler(df, DEVFREQ_GOV_STOP, NULL);
850 if (ret) {
851 dev_warn(dev, "%s: Governor %s not stopped(%d)\n",
852 __func__, df->governor->name, ret);
853 goto out;
854 }
855 }
856 df->governor = governor;
857 strncpy(df->governor_name, governor->name, DEVFREQ_NAME_LEN);
858 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
859 if (ret)
860 dev_warn(dev, "%s: Governor %s not started(%d)\n",
861 __func__, df->governor->name, ret);
862out:
863 mutex_unlock(&devfreq_list_lock);
864
865 if (!ret)
866 ret = count;
867 return ret;
868}
869static DEVICE_ATTR_RW(governor);
870
871static ssize_t available_governors_show(struct device *d,
872 struct device_attribute *attr,
873 char *buf)
874{
875 struct devfreq_governor *tmp_governor;
876 ssize_t count = 0;
877
878 mutex_lock(&devfreq_list_lock);
879 list_for_each_entry(tmp_governor, &devfreq_governor_list, node)
880 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
881 "%s ", tmp_governor->name);
882 mutex_unlock(&devfreq_list_lock);
883
884 /* Truncate the trailing space */
885 if (count)
886 count--;
887
888 count += sprintf(&buf[count], "\n");
889
890 return count;
891}
892static DEVICE_ATTR_RO(available_governors);
893
894static ssize_t cur_freq_show(struct device *dev, struct device_attribute *attr,
895 char *buf)
896{
897 unsigned long freq;
898 struct devfreq *devfreq = to_devfreq(dev);
899
900 if (devfreq->profile->get_cur_freq &&
901 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
902 return sprintf(buf, "%lu\n", freq);
903
904 return sprintf(buf, "%lu\n", devfreq->previous_freq);
905}
906static DEVICE_ATTR_RO(cur_freq);
907
908static ssize_t target_freq_show(struct device *dev,
909 struct device_attribute *attr, char *buf)
910{
911 return sprintf(buf, "%lu\n", to_devfreq(dev)->previous_freq);
912}
913static DEVICE_ATTR_RO(target_freq);
914
915static ssize_t polling_interval_show(struct device *dev,
916 struct device_attribute *attr, char *buf)
917{
918 return sprintf(buf, "%d\n", to_devfreq(dev)->profile->polling_ms);
919}
920
921static ssize_t polling_interval_store(struct device *dev,
922 struct device_attribute *attr,
923 const char *buf, size_t count)
924{
925 struct devfreq *df = to_devfreq(dev);
926 unsigned int value;
927 int ret;
928
929 if (!df->governor)
930 return -EINVAL;
931
932 ret = sscanf(buf, "%u", &value);
933 if (ret != 1)
934 return -EINVAL;
935
936 df->governor->event_handler(df, DEVFREQ_GOV_INTERVAL, &value);
937 ret = count;
938
939 return ret;
940}
941static DEVICE_ATTR_RW(polling_interval);
942
943static ssize_t min_freq_store(struct device *dev, struct device_attribute *attr,
944 const char *buf, size_t count)
945{
946 struct devfreq *df = to_devfreq(dev);
947 unsigned long value;
948 int ret;
949 unsigned long max;
950
951 ret = sscanf(buf, "%lu", &value);
952 if (ret != 1)
953 return -EINVAL;
954
955 mutex_lock(&df->lock);
956 max = df->max_freq;
957 if (value && max && value > max) {
958 ret = -EINVAL;
959 goto unlock;
960 }
961
962 df->min_freq = value;
963 update_devfreq(df);
964 ret = count;
965unlock:
966 mutex_unlock(&df->lock);
967 return ret;
968}
969
970static ssize_t max_freq_store(struct device *dev, struct device_attribute *attr,
971 const char *buf, size_t count)
972{
973 struct devfreq *df = to_devfreq(dev);
974 unsigned long value;
975 int ret;
976 unsigned long min;
977
978 ret = sscanf(buf, "%lu", &value);
979 if (ret != 1)
980 return -EINVAL;
981
982 mutex_lock(&df->lock);
983 min = df->min_freq;
984 if (value && min && value < min) {
985 ret = -EINVAL;
986 goto unlock;
987 }
988
989 df->max_freq = value;
990 update_devfreq(df);
991 ret = count;
992unlock:
993 mutex_unlock(&df->lock);
994 return ret;
995}
996
997#define show_one(name) \
998static ssize_t name##_show \
999(struct device *dev, struct device_attribute *attr, char *buf) \
1000{ \
1001 return sprintf(buf, "%lu\n", to_devfreq(dev)->name); \
1002}
1003show_one(min_freq);
1004show_one(max_freq);
1005
1006static DEVICE_ATTR_RW(min_freq);
1007static DEVICE_ATTR_RW(max_freq);
1008
1009static ssize_t available_frequencies_show(struct device *d,
1010 struct device_attribute *attr,
1011 char *buf)
1012{
1013 struct devfreq *df = to_devfreq(d);
1014 struct device *dev = df->dev.parent;
1015 struct dev_pm_opp *opp;
1016 ssize_t count = 0;
1017 unsigned long freq = 0;
1018
1019 rcu_read_lock();
1020 do {
1021 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
1022 if (IS_ERR(opp))
1023 break;
1024
1025 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1026 "%lu ", freq);
1027 freq++;
1028 } while (1);
1029 rcu_read_unlock();
1030
1031 /* Truncate the trailing space */
1032 if (count)
1033 count--;
1034
1035 count += sprintf(&buf[count], "\n");
1036
1037 return count;
1038}
1039static DEVICE_ATTR_RO(available_frequencies);
1040
1041static ssize_t trans_stat_show(struct device *dev,
1042 struct device_attribute *attr, char *buf)
1043{
1044 struct devfreq *devfreq = to_devfreq(dev);
1045 ssize_t len;
1046 int i, j;
1047 unsigned int max_state = devfreq->profile->max_state;
1048
1049 if (!devfreq->stop_polling &&
1050 devfreq_update_status(devfreq, devfreq->previous_freq))
1051 return 0;
1052 if (max_state == 0)
1053 return sprintf(buf, "Not Supported.\n");
1054
1055 len = sprintf(buf, " From : To\n");
1056 len += sprintf(buf + len, " :");
1057 for (i = 0; i < max_state; i++)
1058 len += sprintf(buf + len, "%10lu",
1059 devfreq->profile->freq_table[i]);
1060
1061 len += sprintf(buf + len, " time(ms)\n");
1062
1063 for (i = 0; i < max_state; i++) {
1064 if (devfreq->profile->freq_table[i]
1065 == devfreq->previous_freq) {
1066 len += sprintf(buf + len, "*");
1067 } else {
1068 len += sprintf(buf + len, " ");
1069 }
1070 len += sprintf(buf + len, "%10lu:",
1071 devfreq->profile->freq_table[i]);
1072 for (j = 0; j < max_state; j++)
1073 len += sprintf(buf + len, "%10u",
1074 devfreq->trans_table[(i * max_state) + j]);
1075 len += sprintf(buf + len, "%10u\n",
1076 jiffies_to_msecs(devfreq->time_in_state[i]));
1077 }
1078
1079 len += sprintf(buf + len, "Total transition : %u\n",
1080 devfreq->total_trans);
1081 return len;
1082}
1083static DEVICE_ATTR_RO(trans_stat);
1084
1085static struct attribute *devfreq_attrs[] = {
1086 &dev_attr_governor.attr,
1087 &dev_attr_available_governors.attr,
1088 &dev_attr_cur_freq.attr,
1089 &dev_attr_available_frequencies.attr,
1090 &dev_attr_target_freq.attr,
1091 &dev_attr_polling_interval.attr,
1092 &dev_attr_min_freq.attr,
1093 &dev_attr_max_freq.attr,
1094 &dev_attr_trans_stat.attr,
1095 NULL,
1096};
1097ATTRIBUTE_GROUPS(devfreq);
1098
1099static int __init devfreq_init(void)
1100{
1101 devfreq_class = class_create(THIS_MODULE, "devfreq");
1102 if (IS_ERR(devfreq_class)) {
1103 pr_err("%s: couldn't create class\n", __FILE__);
1104 return PTR_ERR(devfreq_class);
1105 }
1106
1107 devfreq_wq = create_freezable_workqueue("devfreq_wq");
1108 if (!devfreq_wq) {
1109 class_destroy(devfreq_class);
1110 pr_err("%s: couldn't create workqueue\n", __FILE__);
1111 return -ENOMEM;
1112 }
1113 devfreq_class->dev_groups = devfreq_groups;
1114
1115 return 0;
1116}
1117subsys_initcall(devfreq_init);
1118
1119static void __exit devfreq_exit(void)
1120{
1121 class_destroy(devfreq_class);
1122 destroy_workqueue(devfreq_wq);
1123}
1124module_exit(devfreq_exit);
1125
1126/*
1127 * The followings are helper functions for devfreq user device drivers with
1128 * OPP framework.
1129 */
1130
1131/**
1132 * devfreq_recommended_opp() - Helper function to get proper OPP for the
1133 * freq value given to target callback.
1134 * @dev: The devfreq user device. (parent of devfreq)
1135 * @freq: The frequency given to target function
1136 * @flags: Flags handed from devfreq framework.
1137 *
1138 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
1139 * protected pointer. The reason for the same is that the opp pointer which is
1140 * returned will remain valid for use with opp_get_{voltage, freq} only while
1141 * under the locked area. The pointer returned must be used prior to unlocking
1142 * with rcu_read_unlock() to maintain the integrity of the pointer.
1143 */
1144struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
1145 unsigned long *freq,
1146 u32 flags)
1147{
1148 struct dev_pm_opp *opp;
1149
1150 if (flags & DEVFREQ_FLAG_LEAST_UPPER_BOUND) {
1151 /* The freq is an upper bound. opp should be lower */
1152 opp = dev_pm_opp_find_freq_floor(dev, freq);
1153
1154 /* If not available, use the closest opp */
1155 if (opp == ERR_PTR(-ERANGE))
1156 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1157 } else {
1158 /* The freq is an lower bound. opp should be higher */
1159 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1160
1161 /* If not available, use the closest opp */
1162 if (opp == ERR_PTR(-ERANGE))
1163 opp = dev_pm_opp_find_freq_floor(dev, freq);
1164 }
1165
1166 return opp;
1167}
1168EXPORT_SYMBOL(devfreq_recommended_opp);
1169
1170/**
1171 * devfreq_register_opp_notifier() - Helper function to get devfreq notified
1172 * for any changes in the OPP availability
1173 * changes
1174 * @dev: The devfreq user device. (parent of devfreq)
1175 * @devfreq: The devfreq object.
1176 */
1177int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
1178{
1179 struct srcu_notifier_head *nh;
1180 int ret = 0;
1181
1182 rcu_read_lock();
1183 nh = dev_pm_opp_get_notifier(dev);
1184 if (IS_ERR(nh))
1185 ret = PTR_ERR(nh);
1186 rcu_read_unlock();
1187 if (!ret)
1188 ret = srcu_notifier_chain_register(nh, &devfreq->nb);
1189
1190 return ret;
1191}
1192EXPORT_SYMBOL(devfreq_register_opp_notifier);
1193
1194/**
1195 * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
1196 * notified for any changes in the OPP
1197 * availability changes anymore.
1198 * @dev: The devfreq user device. (parent of devfreq)
1199 * @devfreq: The devfreq object.
1200 *
1201 * At exit() callback of devfreq_dev_profile, this must be included if
1202 * devfreq_recommended_opp is used.
1203 */
1204int devfreq_unregister_opp_notifier(struct device *dev, struct devfreq *devfreq)
1205{
1206 struct srcu_notifier_head *nh;
1207 int ret = 0;
1208
1209 rcu_read_lock();
1210 nh = dev_pm_opp_get_notifier(dev);
1211 if (IS_ERR(nh))
1212 ret = PTR_ERR(nh);
1213 rcu_read_unlock();
1214 if (!ret)
1215 ret = srcu_notifier_chain_unregister(nh, &devfreq->nb);
1216
1217 return ret;
1218}
1219EXPORT_SYMBOL(devfreq_unregister_opp_notifier);
1220
1221static void devm_devfreq_opp_release(struct device *dev, void *res)
1222{
1223 devfreq_unregister_opp_notifier(dev, *(struct devfreq **)res);
1224}
1225
1226/**
1227 * devm_ devfreq_register_opp_notifier()
1228 * - Resource-managed devfreq_register_opp_notifier()
1229 * @dev: The devfreq user device. (parent of devfreq)
1230 * @devfreq: The devfreq object.
1231 */
1232int devm_devfreq_register_opp_notifier(struct device *dev,
1233 struct devfreq *devfreq)
1234{
1235 struct devfreq **ptr;
1236 int ret;
1237
1238 ptr = devres_alloc(devm_devfreq_opp_release, sizeof(*ptr), GFP_KERNEL);
1239 if (!ptr)
1240 return -ENOMEM;
1241
1242 ret = devfreq_register_opp_notifier(dev, devfreq);
1243 if (ret) {
1244 devres_free(ptr);
1245 return ret;
1246 }
1247
1248 *ptr = devfreq;
1249 devres_add(dev, ptr);
1250
1251 return 0;
1252}
1253EXPORT_SYMBOL(devm_devfreq_register_opp_notifier);
1254
1255/**
1256 * devm_devfreq_unregister_opp_notifier()
1257 * - Resource-managed devfreq_unregister_opp_notifier()
1258 * @dev: The devfreq user device. (parent of devfreq)
1259 * @devfreq: The devfreq object.
1260 */
1261void devm_devfreq_unregister_opp_notifier(struct device *dev,
1262 struct devfreq *devfreq)
1263{
1264 WARN_ON(devres_release(dev, devm_devfreq_opp_release,
1265 devm_devfreq_dev_match, devfreq));
1266}
1267EXPORT_SYMBOL(devm_devfreq_unregister_opp_notifier);
1268
1269MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1270MODULE_DESCRIPTION("devfreq class support");
1271MODULE_LICENSE("GPL");
1/*
2 * devfreq: Generic Dynamic Voltage and Frequency Scaling (DVFS) Framework
3 * for Non-CPU Devices.
4 *
5 * Copyright (C) 2011 Samsung Electronics
6 * MyungJoo Ham <myungjoo.ham@samsung.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#include <linux/kernel.h>
14#include <linux/sched.h>
15#include <linux/errno.h>
16#include <linux/err.h>
17#include <linux/init.h>
18#include <linux/module.h>
19#include <linux/slab.h>
20#include <linux/stat.h>
21#include <linux/opp.h>
22#include <linux/devfreq.h>
23#include <linux/workqueue.h>
24#include <linux/platform_device.h>
25#include <linux/list.h>
26#include <linux/printk.h>
27#include <linux/hrtimer.h>
28#include "governor.h"
29
30struct class *devfreq_class;
31
32/*
33 * devfreq_work periodically monitors every registered device.
34 * The minimum polling interval is one jiffy. The polling interval is
35 * determined by the minimum polling period among all polling devfreq
36 * devices. The resolution of polling interval is one jiffy.
37 */
38static bool polling;
39static struct workqueue_struct *devfreq_wq;
40static struct delayed_work devfreq_work;
41
42/* wait removing if this is to be removed */
43static struct devfreq *wait_remove_device;
44
45/* The list of all device-devfreq */
46static LIST_HEAD(devfreq_list);
47static DEFINE_MUTEX(devfreq_list_lock);
48
49/**
50 * find_device_devfreq() - find devfreq struct using device pointer
51 * @dev: device pointer used to lookup device devfreq.
52 *
53 * Search the list of device devfreqs and return the matched device's
54 * devfreq info. devfreq_list_lock should be held by the caller.
55 */
56static struct devfreq *find_device_devfreq(struct device *dev)
57{
58 struct devfreq *tmp_devfreq;
59
60 if (unlikely(IS_ERR_OR_NULL(dev))) {
61 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
62 return ERR_PTR(-EINVAL);
63 }
64 WARN(!mutex_is_locked(&devfreq_list_lock),
65 "devfreq_list_lock must be locked.");
66
67 list_for_each_entry(tmp_devfreq, &devfreq_list, node) {
68 if (tmp_devfreq->dev.parent == dev)
69 return tmp_devfreq;
70 }
71
72 return ERR_PTR(-ENODEV);
73}
74
75/**
76 * update_devfreq() - Reevaluate the device and configure frequency.
77 * @devfreq: the devfreq instance.
78 *
79 * Note: Lock devfreq->lock before calling update_devfreq
80 * This function is exported for governors.
81 */
82int update_devfreq(struct devfreq *devfreq)
83{
84 unsigned long freq;
85 int err = 0;
86 u32 flags = 0;
87
88 if (!mutex_is_locked(&devfreq->lock)) {
89 WARN(true, "devfreq->lock must be locked by the caller.\n");
90 return -EINVAL;
91 }
92
93 /* Reevaluate the proper frequency */
94 err = devfreq->governor->get_target_freq(devfreq, &freq);
95 if (err)
96 return err;
97
98 /*
99 * Adjust the freuqency with user freq and QoS.
100 *
101 * List from the highest proiority
102 * max_freq (probably called by thermal when it's too hot)
103 * min_freq
104 */
105
106 if (devfreq->min_freq && freq < devfreq->min_freq) {
107 freq = devfreq->min_freq;
108 flags &= ~DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use GLB */
109 }
110 if (devfreq->max_freq && freq > devfreq->max_freq) {
111 freq = devfreq->max_freq;
112 flags |= DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use LUB */
113 }
114
115 err = devfreq->profile->target(devfreq->dev.parent, &freq, flags);
116 if (err)
117 return err;
118
119 devfreq->previous_freq = freq;
120 return err;
121}
122
123/**
124 * devfreq_notifier_call() - Notify that the device frequency requirements
125 * has been changed out of devfreq framework.
126 * @nb the notifier_block (supposed to be devfreq->nb)
127 * @type not used
128 * @devp not used
129 *
130 * Called by a notifier that uses devfreq->nb.
131 */
132static int devfreq_notifier_call(struct notifier_block *nb, unsigned long type,
133 void *devp)
134{
135 struct devfreq *devfreq = container_of(nb, struct devfreq, nb);
136 int ret;
137
138 mutex_lock(&devfreq->lock);
139 ret = update_devfreq(devfreq);
140 mutex_unlock(&devfreq->lock);
141
142 return ret;
143}
144
145/**
146 * _remove_devfreq() - Remove devfreq from the device.
147 * @devfreq: the devfreq struct
148 * @skip: skip calling device_unregister().
149 *
150 * Note that the caller should lock devfreq->lock before calling
151 * this. _remove_devfreq() will unlock it and free devfreq
152 * internally. devfreq_list_lock should be locked by the caller
153 * as well (not relased at return)
154 *
155 * Lock usage:
156 * devfreq->lock: locked before call.
157 * unlocked at return (and freed)
158 * devfreq_list_lock: locked before call.
159 * kept locked at return.
160 * if devfreq is centrally polled.
161 *
162 * Freed memory:
163 * devfreq
164 */
165static void _remove_devfreq(struct devfreq *devfreq, bool skip)
166{
167 if (!mutex_is_locked(&devfreq->lock)) {
168 WARN(true, "devfreq->lock must be locked by the caller.\n");
169 return;
170 }
171 if (!devfreq->governor->no_central_polling &&
172 !mutex_is_locked(&devfreq_list_lock)) {
173 WARN(true, "devfreq_list_lock must be locked by the caller.\n");
174 return;
175 }
176
177 if (devfreq->being_removed)
178 return;
179
180 devfreq->being_removed = true;
181
182 if (devfreq->profile->exit)
183 devfreq->profile->exit(devfreq->dev.parent);
184
185 if (devfreq->governor->exit)
186 devfreq->governor->exit(devfreq);
187
188 if (!skip && get_device(&devfreq->dev)) {
189 device_unregister(&devfreq->dev);
190 put_device(&devfreq->dev);
191 }
192
193 if (!devfreq->governor->no_central_polling)
194 list_del(&devfreq->node);
195
196 mutex_unlock(&devfreq->lock);
197 mutex_destroy(&devfreq->lock);
198
199 kfree(devfreq);
200}
201
202/**
203 * devfreq_dev_release() - Callback for struct device to release the device.
204 * @dev: the devfreq device
205 *
206 * This calls _remove_devfreq() if _remove_devfreq() is not called.
207 * Note that devfreq_dev_release() could be called by _remove_devfreq() as
208 * well as by others unregistering the device.
209 */
210static void devfreq_dev_release(struct device *dev)
211{
212 struct devfreq *devfreq = to_devfreq(dev);
213 bool central_polling = !devfreq->governor->no_central_polling;
214
215 /*
216 * If devfreq_dev_release() was called by device_unregister() of
217 * _remove_devfreq(), we cannot mutex_lock(&devfreq->lock) and
218 * being_removed is already set. This also partially checks the case
219 * where devfreq_dev_release() is called from a thread other than
220 * the one called _remove_devfreq(); however, this case is
221 * dealt completely with another following being_removed check.
222 *
223 * Because being_removed is never being
224 * unset, we do not need to worry about race conditions on
225 * being_removed.
226 */
227 if (devfreq->being_removed)
228 return;
229
230 if (central_polling)
231 mutex_lock(&devfreq_list_lock);
232
233 mutex_lock(&devfreq->lock);
234
235 /*
236 * Check being_removed flag again for the case where
237 * devfreq_dev_release() was called in a thread other than the one
238 * possibly called _remove_devfreq().
239 */
240 if (devfreq->being_removed) {
241 mutex_unlock(&devfreq->lock);
242 goto out;
243 }
244
245 /* devfreq->lock is unlocked and removed in _removed_devfreq() */
246 _remove_devfreq(devfreq, true);
247
248out:
249 if (central_polling)
250 mutex_unlock(&devfreq_list_lock);
251}
252
253/**
254 * devfreq_monitor() - Periodically poll devfreq objects.
255 * @work: the work struct used to run devfreq_monitor periodically.
256 *
257 */
258static void devfreq_monitor(struct work_struct *work)
259{
260 static unsigned long last_polled_at;
261 struct devfreq *devfreq, *tmp;
262 int error;
263 unsigned long jiffies_passed;
264 unsigned long next_jiffies = ULONG_MAX, now = jiffies;
265 struct device *dev;
266
267 /* Initially last_polled_at = 0, polling every device at bootup */
268 jiffies_passed = now - last_polled_at;
269 last_polled_at = now;
270 if (jiffies_passed == 0)
271 jiffies_passed = 1;
272
273 mutex_lock(&devfreq_list_lock);
274 list_for_each_entry_safe(devfreq, tmp, &devfreq_list, node) {
275 mutex_lock(&devfreq->lock);
276 dev = devfreq->dev.parent;
277
278 /* Do not remove tmp for a while */
279 wait_remove_device = tmp;
280
281 if (devfreq->governor->no_central_polling ||
282 devfreq->next_polling == 0) {
283 mutex_unlock(&devfreq->lock);
284 continue;
285 }
286 mutex_unlock(&devfreq_list_lock);
287
288 /*
289 * Reduce more next_polling if devfreq_wq took an extra
290 * delay. (i.e., CPU has been idled.)
291 */
292 if (devfreq->next_polling <= jiffies_passed) {
293 error = update_devfreq(devfreq);
294
295 /* Remove a devfreq with an error. */
296 if (error && error != -EAGAIN) {
297
298 dev_err(dev, "Due to update_devfreq error(%d), devfreq(%s) is removed from the device\n",
299 error, devfreq->governor->name);
300
301 /*
302 * Unlock devfreq before locking the list
303 * in order to avoid deadlock with
304 * find_device_devfreq or others
305 */
306 mutex_unlock(&devfreq->lock);
307 mutex_lock(&devfreq_list_lock);
308 /* Check if devfreq is already removed */
309 if (IS_ERR(find_device_devfreq(dev)))
310 continue;
311 mutex_lock(&devfreq->lock);
312 /* This unlocks devfreq->lock and free it */
313 _remove_devfreq(devfreq, false);
314 continue;
315 }
316 devfreq->next_polling = devfreq->polling_jiffies;
317 } else {
318 devfreq->next_polling -= jiffies_passed;
319 }
320
321 if (devfreq->next_polling)
322 next_jiffies = (next_jiffies > devfreq->next_polling) ?
323 devfreq->next_polling : next_jiffies;
324
325 mutex_unlock(&devfreq->lock);
326 mutex_lock(&devfreq_list_lock);
327 }
328 wait_remove_device = NULL;
329 mutex_unlock(&devfreq_list_lock);
330
331 if (next_jiffies > 0 && next_jiffies < ULONG_MAX) {
332 polling = true;
333 queue_delayed_work(devfreq_wq, &devfreq_work, next_jiffies);
334 } else {
335 polling = false;
336 }
337}
338
339/**
340 * devfreq_add_device() - Add devfreq feature to the device
341 * @dev: the device to add devfreq feature.
342 * @profile: device-specific profile to run devfreq.
343 * @governor: the policy to choose frequency.
344 * @data: private data for the governor. The devfreq framework does not
345 * touch this value.
346 */
347struct devfreq *devfreq_add_device(struct device *dev,
348 struct devfreq_dev_profile *profile,
349 const struct devfreq_governor *governor,
350 void *data)
351{
352 struct devfreq *devfreq;
353 int err = 0;
354
355 if (!dev || !profile || !governor) {
356 dev_err(dev, "%s: Invalid parameters.\n", __func__);
357 return ERR_PTR(-EINVAL);
358 }
359
360
361 if (!governor->no_central_polling) {
362 mutex_lock(&devfreq_list_lock);
363 devfreq = find_device_devfreq(dev);
364 mutex_unlock(&devfreq_list_lock);
365 if (!IS_ERR(devfreq)) {
366 dev_err(dev, "%s: Unable to create devfreq for the device. It already has one.\n", __func__);
367 err = -EINVAL;
368 goto err_out;
369 }
370 }
371
372 devfreq = kzalloc(sizeof(struct devfreq), GFP_KERNEL);
373 if (!devfreq) {
374 dev_err(dev, "%s: Unable to create devfreq for the device\n",
375 __func__);
376 err = -ENOMEM;
377 goto err_out;
378 }
379
380 mutex_init(&devfreq->lock);
381 mutex_lock(&devfreq->lock);
382 devfreq->dev.parent = dev;
383 devfreq->dev.class = devfreq_class;
384 devfreq->dev.release = devfreq_dev_release;
385 devfreq->profile = profile;
386 devfreq->governor = governor;
387 devfreq->previous_freq = profile->initial_freq;
388 devfreq->data = data;
389 devfreq->next_polling = devfreq->polling_jiffies
390 = msecs_to_jiffies(devfreq->profile->polling_ms);
391 devfreq->nb.notifier_call = devfreq_notifier_call;
392
393 dev_set_name(&devfreq->dev, dev_name(dev));
394 err = device_register(&devfreq->dev);
395 if (err) {
396 put_device(&devfreq->dev);
397 goto err_dev;
398 }
399
400 if (governor->init)
401 err = governor->init(devfreq);
402 if (err)
403 goto err_init;
404
405 mutex_unlock(&devfreq->lock);
406
407 if (governor->no_central_polling)
408 goto out;
409
410 mutex_lock(&devfreq_list_lock);
411
412 list_add(&devfreq->node, &devfreq_list);
413
414 if (devfreq_wq && devfreq->next_polling && !polling) {
415 polling = true;
416 queue_delayed_work(devfreq_wq, &devfreq_work,
417 devfreq->next_polling);
418 }
419 mutex_unlock(&devfreq_list_lock);
420out:
421 return devfreq;
422
423err_init:
424 device_unregister(&devfreq->dev);
425err_dev:
426 mutex_unlock(&devfreq->lock);
427 kfree(devfreq);
428err_out:
429 return ERR_PTR(err);
430}
431
432/**
433 * devfreq_remove_device() - Remove devfreq feature from a device.
434 * @devfreq the devfreq instance to be removed
435 */
436int devfreq_remove_device(struct devfreq *devfreq)
437{
438 bool central_polling;
439
440 if (!devfreq)
441 return -EINVAL;
442
443 central_polling = !devfreq->governor->no_central_polling;
444
445 if (central_polling) {
446 mutex_lock(&devfreq_list_lock);
447 while (wait_remove_device == devfreq) {
448 mutex_unlock(&devfreq_list_lock);
449 schedule();
450 mutex_lock(&devfreq_list_lock);
451 }
452 }
453
454 mutex_lock(&devfreq->lock);
455 _remove_devfreq(devfreq, false); /* it unlocks devfreq->lock */
456
457 if (central_polling)
458 mutex_unlock(&devfreq_list_lock);
459
460 return 0;
461}
462
463static ssize_t show_governor(struct device *dev,
464 struct device_attribute *attr, char *buf)
465{
466 return sprintf(buf, "%s\n", to_devfreq(dev)->governor->name);
467}
468
469static ssize_t show_freq(struct device *dev,
470 struct device_attribute *attr, char *buf)
471{
472 return sprintf(buf, "%lu\n", to_devfreq(dev)->previous_freq);
473}
474
475static ssize_t show_polling_interval(struct device *dev,
476 struct device_attribute *attr, char *buf)
477{
478 return sprintf(buf, "%d\n", to_devfreq(dev)->profile->polling_ms);
479}
480
481static ssize_t store_polling_interval(struct device *dev,
482 struct device_attribute *attr,
483 const char *buf, size_t count)
484{
485 struct devfreq *df = to_devfreq(dev);
486 unsigned int value;
487 int ret;
488
489 ret = sscanf(buf, "%u", &value);
490 if (ret != 1)
491 goto out;
492
493 mutex_lock(&df->lock);
494 df->profile->polling_ms = value;
495 df->next_polling = df->polling_jiffies
496 = msecs_to_jiffies(value);
497 mutex_unlock(&df->lock);
498
499 ret = count;
500
501 if (df->governor->no_central_polling)
502 goto out;
503
504 mutex_lock(&devfreq_list_lock);
505 if (df->next_polling > 0 && !polling) {
506 polling = true;
507 queue_delayed_work(devfreq_wq, &devfreq_work,
508 df->next_polling);
509 }
510 mutex_unlock(&devfreq_list_lock);
511out:
512 return ret;
513}
514
515static ssize_t show_central_polling(struct device *dev,
516 struct device_attribute *attr, char *buf)
517{
518 return sprintf(buf, "%d\n",
519 !to_devfreq(dev)->governor->no_central_polling);
520}
521
522static ssize_t store_min_freq(struct device *dev, struct device_attribute *attr,
523 const char *buf, size_t count)
524{
525 struct devfreq *df = to_devfreq(dev);
526 unsigned long value;
527 int ret;
528 unsigned long max;
529
530 ret = sscanf(buf, "%lu", &value);
531 if (ret != 1)
532 goto out;
533
534 mutex_lock(&df->lock);
535 max = df->max_freq;
536 if (value && max && value > max) {
537 ret = -EINVAL;
538 goto unlock;
539 }
540
541 df->min_freq = value;
542 update_devfreq(df);
543 ret = count;
544unlock:
545 mutex_unlock(&df->lock);
546out:
547 return ret;
548}
549
550static ssize_t show_min_freq(struct device *dev, struct device_attribute *attr,
551 char *buf)
552{
553 return sprintf(buf, "%lu\n", to_devfreq(dev)->min_freq);
554}
555
556static ssize_t store_max_freq(struct device *dev, struct device_attribute *attr,
557 const char *buf, size_t count)
558{
559 struct devfreq *df = to_devfreq(dev);
560 unsigned long value;
561 int ret;
562 unsigned long min;
563
564 ret = sscanf(buf, "%lu", &value);
565 if (ret != 1)
566 goto out;
567
568 mutex_lock(&df->lock);
569 min = df->min_freq;
570 if (value && min && value < min) {
571 ret = -EINVAL;
572 goto unlock;
573 }
574
575 df->max_freq = value;
576 update_devfreq(df);
577 ret = count;
578unlock:
579 mutex_unlock(&df->lock);
580out:
581 return ret;
582}
583
584static ssize_t show_max_freq(struct device *dev, struct device_attribute *attr,
585 char *buf)
586{
587 return sprintf(buf, "%lu\n", to_devfreq(dev)->max_freq);
588}
589
590static struct device_attribute devfreq_attrs[] = {
591 __ATTR(governor, S_IRUGO, show_governor, NULL),
592 __ATTR(cur_freq, S_IRUGO, show_freq, NULL),
593 __ATTR(central_polling, S_IRUGO, show_central_polling, NULL),
594 __ATTR(polling_interval, S_IRUGO | S_IWUSR, show_polling_interval,
595 store_polling_interval),
596 __ATTR(min_freq, S_IRUGO | S_IWUSR, show_min_freq, store_min_freq),
597 __ATTR(max_freq, S_IRUGO | S_IWUSR, show_max_freq, store_max_freq),
598 { },
599};
600
601/**
602 * devfreq_start_polling() - Initialize data structure for devfreq framework and
603 * start polling registered devfreq devices.
604 */
605static int __init devfreq_start_polling(void)
606{
607 mutex_lock(&devfreq_list_lock);
608 polling = false;
609 devfreq_wq = create_freezable_workqueue("devfreq_wq");
610 INIT_DELAYED_WORK_DEFERRABLE(&devfreq_work, devfreq_monitor);
611 mutex_unlock(&devfreq_list_lock);
612
613 devfreq_monitor(&devfreq_work.work);
614 return 0;
615}
616late_initcall(devfreq_start_polling);
617
618static int __init devfreq_init(void)
619{
620 devfreq_class = class_create(THIS_MODULE, "devfreq");
621 if (IS_ERR(devfreq_class)) {
622 pr_err("%s: couldn't create class\n", __FILE__);
623 return PTR_ERR(devfreq_class);
624 }
625 devfreq_class->dev_attrs = devfreq_attrs;
626 return 0;
627}
628subsys_initcall(devfreq_init);
629
630static void __exit devfreq_exit(void)
631{
632 class_destroy(devfreq_class);
633}
634module_exit(devfreq_exit);
635
636/*
637 * The followings are helper functions for devfreq user device drivers with
638 * OPP framework.
639 */
640
641/**
642 * devfreq_recommended_opp() - Helper function to get proper OPP for the
643 * freq value given to target callback.
644 * @dev The devfreq user device. (parent of devfreq)
645 * @freq The frequency given to target function
646 * @flags Flags handed from devfreq framework.
647 *
648 */
649struct opp *devfreq_recommended_opp(struct device *dev, unsigned long *freq,
650 u32 flags)
651{
652 struct opp *opp;
653
654 if (flags & DEVFREQ_FLAG_LEAST_UPPER_BOUND) {
655 /* The freq is an upper bound. opp should be lower */
656 opp = opp_find_freq_floor(dev, freq);
657
658 /* If not available, use the closest opp */
659 if (opp == ERR_PTR(-ENODEV))
660 opp = opp_find_freq_ceil(dev, freq);
661 } else {
662 /* The freq is an lower bound. opp should be higher */
663 opp = opp_find_freq_ceil(dev, freq);
664
665 /* If not available, use the closest opp */
666 if (opp == ERR_PTR(-ENODEV))
667 opp = opp_find_freq_floor(dev, freq);
668 }
669
670 return opp;
671}
672
673/**
674 * devfreq_register_opp_notifier() - Helper function to get devfreq notified
675 * for any changes in the OPP availability
676 * changes
677 * @dev The devfreq user device. (parent of devfreq)
678 * @devfreq The devfreq object.
679 */
680int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
681{
682 struct srcu_notifier_head *nh = opp_get_notifier(dev);
683
684 if (IS_ERR(nh))
685 return PTR_ERR(nh);
686 return srcu_notifier_chain_register(nh, &devfreq->nb);
687}
688
689/**
690 * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
691 * notified for any changes in the OPP
692 * availability changes anymore.
693 * @dev The devfreq user device. (parent of devfreq)
694 * @devfreq The devfreq object.
695 *
696 * At exit() callback of devfreq_dev_profile, this must be included if
697 * devfreq_recommended_opp is used.
698 */
699int devfreq_unregister_opp_notifier(struct device *dev, struct devfreq *devfreq)
700{
701 struct srcu_notifier_head *nh = opp_get_notifier(dev);
702
703 if (IS_ERR(nh))
704 return PTR_ERR(nh);
705 return srcu_notifier_chain_unregister(nh, &devfreq->nb);
706}
707
708MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
709MODULE_DESCRIPTION("devfreq class support");
710MODULE_LICENSE("GPL");