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/export.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 <linux/of.h>
29#include "governor.h"
30
31static struct class *devfreq_class;
32
33/*
34 * devfreq core provides delayed work based load monitoring helper
35 * functions. Governors can use these or can implement their own
36 * monitoring mechanism.
37 */
38static struct workqueue_struct *devfreq_wq;
39
40/* The list of all device-devfreq governors */
41static LIST_HEAD(devfreq_governor_list);
42/* The list of all device-devfreq */
43static LIST_HEAD(devfreq_list);
44static DEFINE_MUTEX(devfreq_list_lock);
45
46/**
47 * find_device_devfreq() - find devfreq struct using device pointer
48 * @dev: device pointer used to lookup device devfreq.
49 *
50 * Search the list of device devfreqs and return the matched device's
51 * devfreq info. devfreq_list_lock should be held by the caller.
52 */
53static struct devfreq *find_device_devfreq(struct device *dev)
54{
55 struct devfreq *tmp_devfreq;
56
57 if (IS_ERR_OR_NULL(dev)) {
58 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
59 return ERR_PTR(-EINVAL);
60 }
61 WARN(!mutex_is_locked(&devfreq_list_lock),
62 "devfreq_list_lock must be locked.");
63
64 list_for_each_entry(tmp_devfreq, &devfreq_list, node) {
65 if (tmp_devfreq->dev.parent == dev)
66 return tmp_devfreq;
67 }
68
69 return ERR_PTR(-ENODEV);
70}
71
72/**
73 * devfreq_get_freq_level() - Lookup freq_table for the frequency
74 * @devfreq: the devfreq instance
75 * @freq: the target frequency
76 */
77static int devfreq_get_freq_level(struct devfreq *devfreq, unsigned long freq)
78{
79 int lev;
80
81 for (lev = 0; lev < devfreq->profile->max_state; lev++)
82 if (freq == devfreq->profile->freq_table[lev])
83 return lev;
84
85 return -EINVAL;
86}
87
88/**
89 * devfreq_set_freq_table() - Initialize freq_table for the frequency
90 * @devfreq: the devfreq instance
91 */
92static void devfreq_set_freq_table(struct devfreq *devfreq)
93{
94 struct devfreq_dev_profile *profile = devfreq->profile;
95 struct dev_pm_opp *opp;
96 unsigned long freq;
97 int i, count;
98
99 /* Initialize the freq_table from OPP table */
100 count = dev_pm_opp_get_opp_count(devfreq->dev.parent);
101 if (count <= 0)
102 return;
103
104 profile->max_state = count;
105 profile->freq_table = devm_kcalloc(devfreq->dev.parent,
106 profile->max_state,
107 sizeof(*profile->freq_table),
108 GFP_KERNEL);
109 if (!profile->freq_table) {
110 profile->max_state = 0;
111 return;
112 }
113
114 rcu_read_lock();
115 for (i = 0, freq = 0; i < profile->max_state; i++, freq++) {
116 opp = dev_pm_opp_find_freq_ceil(devfreq->dev.parent, &freq);
117 if (IS_ERR(opp)) {
118 devm_kfree(devfreq->dev.parent, profile->freq_table);
119 profile->max_state = 0;
120 rcu_read_unlock();
121 return;
122 }
123 profile->freq_table[i] = freq;
124 }
125 rcu_read_unlock();
126}
127
128/**
129 * devfreq_update_status() - Update statistics of devfreq behavior
130 * @devfreq: the devfreq instance
131 * @freq: the update target frequency
132 */
133int devfreq_update_status(struct devfreq *devfreq, unsigned long freq)
134{
135 int lev, prev_lev, ret = 0;
136 unsigned long cur_time;
137
138 cur_time = jiffies;
139
140 /* Immediately exit if previous_freq is not initialized yet. */
141 if (!devfreq->previous_freq)
142 goto out;
143
144 prev_lev = devfreq_get_freq_level(devfreq, devfreq->previous_freq);
145 if (prev_lev < 0) {
146 ret = prev_lev;
147 goto out;
148 }
149
150 devfreq->time_in_state[prev_lev] +=
151 cur_time - devfreq->last_stat_updated;
152
153 lev = devfreq_get_freq_level(devfreq, freq);
154 if (lev < 0) {
155 ret = lev;
156 goto out;
157 }
158
159 if (lev != prev_lev) {
160 devfreq->trans_table[(prev_lev *
161 devfreq->profile->max_state) + lev]++;
162 devfreq->total_trans++;
163 }
164
165out:
166 devfreq->last_stat_updated = cur_time;
167 return ret;
168}
169EXPORT_SYMBOL(devfreq_update_status);
170
171/**
172 * find_devfreq_governor() - find devfreq governor from name
173 * @name: name of the governor
174 *
175 * Search the list of devfreq governors and return the matched
176 * governor's pointer. devfreq_list_lock should be held by the caller.
177 */
178static struct devfreq_governor *find_devfreq_governor(const char *name)
179{
180 struct devfreq_governor *tmp_governor;
181
182 if (IS_ERR_OR_NULL(name)) {
183 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
184 return ERR_PTR(-EINVAL);
185 }
186 WARN(!mutex_is_locked(&devfreq_list_lock),
187 "devfreq_list_lock must be locked.");
188
189 list_for_each_entry(tmp_governor, &devfreq_governor_list, node) {
190 if (!strncmp(tmp_governor->name, name, DEVFREQ_NAME_LEN))
191 return tmp_governor;
192 }
193
194 return ERR_PTR(-ENODEV);
195}
196
197static int devfreq_notify_transition(struct devfreq *devfreq,
198 struct devfreq_freqs *freqs, unsigned int state)
199{
200 if (!devfreq)
201 return -EINVAL;
202
203 switch (state) {
204 case DEVFREQ_PRECHANGE:
205 srcu_notifier_call_chain(&devfreq->transition_notifier_list,
206 DEVFREQ_PRECHANGE, freqs);
207 break;
208
209 case DEVFREQ_POSTCHANGE:
210 srcu_notifier_call_chain(&devfreq->transition_notifier_list,
211 DEVFREQ_POSTCHANGE, freqs);
212 break;
213 default:
214 return -EINVAL;
215 }
216
217 return 0;
218}
219
220/* Load monitoring helper functions for governors use */
221
222/**
223 * update_devfreq() - Reevaluate the device and configure frequency.
224 * @devfreq: the devfreq instance.
225 *
226 * Note: Lock devfreq->lock before calling update_devfreq
227 * This function is exported for governors.
228 */
229int update_devfreq(struct devfreq *devfreq)
230{
231 struct devfreq_freqs freqs;
232 unsigned long freq, cur_freq;
233 int err = 0;
234 u32 flags = 0;
235
236 if (!mutex_is_locked(&devfreq->lock)) {
237 WARN(true, "devfreq->lock must be locked by the caller.\n");
238 return -EINVAL;
239 }
240
241 if (!devfreq->governor)
242 return -EINVAL;
243
244 /* Reevaluate the proper frequency */
245 err = devfreq->governor->get_target_freq(devfreq, &freq);
246 if (err)
247 return err;
248
249 /*
250 * Adjust the frequency with user freq and QoS.
251 *
252 * List from the highest priority
253 * max_freq
254 * min_freq
255 */
256
257 if (devfreq->min_freq && freq < devfreq->min_freq) {
258 freq = devfreq->min_freq;
259 flags &= ~DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use GLB */
260 }
261 if (devfreq->max_freq && freq > devfreq->max_freq) {
262 freq = devfreq->max_freq;
263 flags |= DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use LUB */
264 }
265
266 if (devfreq->profile->get_cur_freq)
267 devfreq->profile->get_cur_freq(devfreq->dev.parent, &cur_freq);
268 else
269 cur_freq = devfreq->previous_freq;
270
271 freqs.old = cur_freq;
272 freqs.new = freq;
273 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_PRECHANGE);
274
275 err = devfreq->profile->target(devfreq->dev.parent, &freq, flags);
276 if (err) {
277 freqs.new = cur_freq;
278 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_POSTCHANGE);
279 return err;
280 }
281
282 freqs.new = freq;
283 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_POSTCHANGE);
284
285 if (devfreq->profile->freq_table)
286 if (devfreq_update_status(devfreq, freq))
287 dev_err(&devfreq->dev,
288 "Couldn't update frequency transition information.\n");
289
290 devfreq->previous_freq = freq;
291 return err;
292}
293EXPORT_SYMBOL(update_devfreq);
294
295/**
296 * devfreq_monitor() - Periodically poll devfreq objects.
297 * @work: the work struct used to run devfreq_monitor periodically.
298 *
299 */
300static void devfreq_monitor(struct work_struct *work)
301{
302 int err;
303 struct devfreq *devfreq = container_of(work,
304 struct devfreq, work.work);
305
306 mutex_lock(&devfreq->lock);
307 err = update_devfreq(devfreq);
308 if (err)
309 dev_err(&devfreq->dev, "dvfs failed with (%d) error\n", err);
310
311 queue_delayed_work(devfreq_wq, &devfreq->work,
312 msecs_to_jiffies(devfreq->profile->polling_ms));
313 mutex_unlock(&devfreq->lock);
314}
315
316/**
317 * devfreq_monitor_start() - Start load monitoring of devfreq instance
318 * @devfreq: the devfreq instance.
319 *
320 * Helper function for starting devfreq device load monitoing. By
321 * default delayed work based monitoring is supported. Function
322 * to be called from governor in response to DEVFREQ_GOV_START
323 * event when device is added to devfreq framework.
324 */
325void devfreq_monitor_start(struct devfreq *devfreq)
326{
327 INIT_DEFERRABLE_WORK(&devfreq->work, devfreq_monitor);
328 if (devfreq->profile->polling_ms)
329 queue_delayed_work(devfreq_wq, &devfreq->work,
330 msecs_to_jiffies(devfreq->profile->polling_ms));
331}
332EXPORT_SYMBOL(devfreq_monitor_start);
333
334/**
335 * devfreq_monitor_stop() - Stop load monitoring of a devfreq instance
336 * @devfreq: the devfreq instance.
337 *
338 * Helper function to stop devfreq device load monitoing. Function
339 * to be called from governor in response to DEVFREQ_GOV_STOP
340 * event when device is removed from devfreq framework.
341 */
342void devfreq_monitor_stop(struct devfreq *devfreq)
343{
344 cancel_delayed_work_sync(&devfreq->work);
345}
346EXPORT_SYMBOL(devfreq_monitor_stop);
347
348/**
349 * devfreq_monitor_suspend() - Suspend load monitoring of a devfreq instance
350 * @devfreq: the devfreq instance.
351 *
352 * Helper function to suspend devfreq device load monitoing. Function
353 * to be called from governor in response to DEVFREQ_GOV_SUSPEND
354 * event or when polling interval is set to zero.
355 *
356 * Note: Though this function is same as devfreq_monitor_stop(),
357 * intentionally kept separate to provide hooks for collecting
358 * transition statistics.
359 */
360void devfreq_monitor_suspend(struct devfreq *devfreq)
361{
362 mutex_lock(&devfreq->lock);
363 if (devfreq->stop_polling) {
364 mutex_unlock(&devfreq->lock);
365 return;
366 }
367
368 devfreq_update_status(devfreq, devfreq->previous_freq);
369 devfreq->stop_polling = true;
370 mutex_unlock(&devfreq->lock);
371 cancel_delayed_work_sync(&devfreq->work);
372}
373EXPORT_SYMBOL(devfreq_monitor_suspend);
374
375/**
376 * devfreq_monitor_resume() - Resume load monitoring of a devfreq instance
377 * @devfreq: the devfreq instance.
378 *
379 * Helper function to resume devfreq device load monitoing. Function
380 * to be called from governor in response to DEVFREQ_GOV_RESUME
381 * event or when polling interval is set to non-zero.
382 */
383void devfreq_monitor_resume(struct devfreq *devfreq)
384{
385 unsigned long freq;
386
387 mutex_lock(&devfreq->lock);
388 if (!devfreq->stop_polling)
389 goto out;
390
391 if (!delayed_work_pending(&devfreq->work) &&
392 devfreq->profile->polling_ms)
393 queue_delayed_work(devfreq_wq, &devfreq->work,
394 msecs_to_jiffies(devfreq->profile->polling_ms));
395
396 devfreq->last_stat_updated = jiffies;
397 devfreq->stop_polling = false;
398
399 if (devfreq->profile->get_cur_freq &&
400 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
401 devfreq->previous_freq = freq;
402
403out:
404 mutex_unlock(&devfreq->lock);
405}
406EXPORT_SYMBOL(devfreq_monitor_resume);
407
408/**
409 * devfreq_interval_update() - Update device devfreq monitoring interval
410 * @devfreq: the devfreq instance.
411 * @delay: new polling interval to be set.
412 *
413 * Helper function to set new load monitoring polling interval. Function
414 * to be called from governor in response to DEVFREQ_GOV_INTERVAL event.
415 */
416void devfreq_interval_update(struct devfreq *devfreq, unsigned int *delay)
417{
418 unsigned int cur_delay = devfreq->profile->polling_ms;
419 unsigned int new_delay = *delay;
420
421 mutex_lock(&devfreq->lock);
422 devfreq->profile->polling_ms = new_delay;
423
424 if (devfreq->stop_polling)
425 goto out;
426
427 /* if new delay is zero, stop polling */
428 if (!new_delay) {
429 mutex_unlock(&devfreq->lock);
430 cancel_delayed_work_sync(&devfreq->work);
431 return;
432 }
433
434 /* if current delay is zero, start polling with new delay */
435 if (!cur_delay) {
436 queue_delayed_work(devfreq_wq, &devfreq->work,
437 msecs_to_jiffies(devfreq->profile->polling_ms));
438 goto out;
439 }
440
441 /* if current delay is greater than new delay, restart polling */
442 if (cur_delay > new_delay) {
443 mutex_unlock(&devfreq->lock);
444 cancel_delayed_work_sync(&devfreq->work);
445 mutex_lock(&devfreq->lock);
446 if (!devfreq->stop_polling)
447 queue_delayed_work(devfreq_wq, &devfreq->work,
448 msecs_to_jiffies(devfreq->profile->polling_ms));
449 }
450out:
451 mutex_unlock(&devfreq->lock);
452}
453EXPORT_SYMBOL(devfreq_interval_update);
454
455/**
456 * devfreq_notifier_call() - Notify that the device frequency requirements
457 * has been changed out of devfreq framework.
458 * @nb: the notifier_block (supposed to be devfreq->nb)
459 * @type: not used
460 * @devp: not used
461 *
462 * Called by a notifier that uses devfreq->nb.
463 */
464static int devfreq_notifier_call(struct notifier_block *nb, unsigned long type,
465 void *devp)
466{
467 struct devfreq *devfreq = container_of(nb, struct devfreq, nb);
468 int ret;
469
470 mutex_lock(&devfreq->lock);
471 ret = update_devfreq(devfreq);
472 mutex_unlock(&devfreq->lock);
473
474 return ret;
475}
476
477/**
478 * _remove_devfreq() - Remove devfreq from the list and release its resources.
479 * @devfreq: the devfreq struct
480 */
481static void _remove_devfreq(struct devfreq *devfreq)
482{
483 mutex_lock(&devfreq_list_lock);
484 if (IS_ERR(find_device_devfreq(devfreq->dev.parent))) {
485 mutex_unlock(&devfreq_list_lock);
486 dev_warn(&devfreq->dev, "releasing devfreq which doesn't exist\n");
487 return;
488 }
489 list_del(&devfreq->node);
490 mutex_unlock(&devfreq_list_lock);
491
492 if (devfreq->governor)
493 devfreq->governor->event_handler(devfreq,
494 DEVFREQ_GOV_STOP, NULL);
495
496 if (devfreq->profile->exit)
497 devfreq->profile->exit(devfreq->dev.parent);
498
499 mutex_destroy(&devfreq->lock);
500 kfree(devfreq);
501}
502
503/**
504 * devfreq_dev_release() - Callback for struct device to release the device.
505 * @dev: the devfreq device
506 *
507 * This calls _remove_devfreq() if _remove_devfreq() is not called.
508 */
509static void devfreq_dev_release(struct device *dev)
510{
511 struct devfreq *devfreq = to_devfreq(dev);
512
513 _remove_devfreq(devfreq);
514}
515
516/**
517 * devfreq_add_device() - Add devfreq feature to the device
518 * @dev: the device to add devfreq feature.
519 * @profile: device-specific profile to run devfreq.
520 * @governor_name: name of the policy to choose frequency.
521 * @data: private data for the governor. The devfreq framework does not
522 * touch this value.
523 */
524struct devfreq *devfreq_add_device(struct device *dev,
525 struct devfreq_dev_profile *profile,
526 const char *governor_name,
527 void *data)
528{
529 struct devfreq *devfreq;
530 struct devfreq_governor *governor;
531 int err = 0;
532
533 if (!dev || !profile || !governor_name) {
534 dev_err(dev, "%s: Invalid parameters.\n", __func__);
535 return ERR_PTR(-EINVAL);
536 }
537
538 mutex_lock(&devfreq_list_lock);
539 devfreq = find_device_devfreq(dev);
540 mutex_unlock(&devfreq_list_lock);
541 if (!IS_ERR(devfreq)) {
542 dev_err(dev, "%s: Unable to create devfreq for the device. It already has one.\n", __func__);
543 err = -EINVAL;
544 goto err_out;
545 }
546
547 devfreq = kzalloc(sizeof(struct devfreq), GFP_KERNEL);
548 if (!devfreq) {
549 dev_err(dev, "%s: Unable to create devfreq for the device\n",
550 __func__);
551 err = -ENOMEM;
552 goto err_out;
553 }
554
555 mutex_init(&devfreq->lock);
556 mutex_lock(&devfreq->lock);
557 devfreq->dev.parent = dev;
558 devfreq->dev.class = devfreq_class;
559 devfreq->dev.release = devfreq_dev_release;
560 devfreq->profile = profile;
561 strncpy(devfreq->governor_name, governor_name, DEVFREQ_NAME_LEN);
562 devfreq->previous_freq = profile->initial_freq;
563 devfreq->last_status.current_frequency = profile->initial_freq;
564 devfreq->data = data;
565 devfreq->nb.notifier_call = devfreq_notifier_call;
566
567 if (!devfreq->profile->max_state && !devfreq->profile->freq_table) {
568 mutex_unlock(&devfreq->lock);
569 devfreq_set_freq_table(devfreq);
570 mutex_lock(&devfreq->lock);
571 }
572
573 dev_set_name(&devfreq->dev, "%s", dev_name(dev));
574 err = device_register(&devfreq->dev);
575 if (err) {
576 mutex_unlock(&devfreq->lock);
577 goto err_out;
578 }
579
580 devfreq->trans_table = devm_kzalloc(&devfreq->dev, sizeof(unsigned int) *
581 devfreq->profile->max_state *
582 devfreq->profile->max_state,
583 GFP_KERNEL);
584 devfreq->time_in_state = devm_kzalloc(&devfreq->dev, sizeof(unsigned long) *
585 devfreq->profile->max_state,
586 GFP_KERNEL);
587 devfreq->last_stat_updated = jiffies;
588
589 srcu_init_notifier_head(&devfreq->transition_notifier_list);
590
591 mutex_unlock(&devfreq->lock);
592
593 mutex_lock(&devfreq_list_lock);
594 list_add(&devfreq->node, &devfreq_list);
595
596 governor = find_devfreq_governor(devfreq->governor_name);
597 if (IS_ERR(governor)) {
598 dev_err(dev, "%s: Unable to find governor for the device\n",
599 __func__);
600 err = PTR_ERR(governor);
601 goto err_init;
602 }
603
604 devfreq->governor = governor;
605 err = devfreq->governor->event_handler(devfreq, DEVFREQ_GOV_START,
606 NULL);
607 if (err) {
608 dev_err(dev, "%s: Unable to start governor for the device\n",
609 __func__);
610 goto err_init;
611 }
612 mutex_unlock(&devfreq_list_lock);
613
614 return devfreq;
615
616err_init:
617 list_del(&devfreq->node);
618 mutex_unlock(&devfreq_list_lock);
619
620 device_unregister(&devfreq->dev);
621err_out:
622 return ERR_PTR(err);
623}
624EXPORT_SYMBOL(devfreq_add_device);
625
626/**
627 * devfreq_remove_device() - Remove devfreq feature from a device.
628 * @devfreq: the devfreq instance to be removed
629 *
630 * The opposite of devfreq_add_device().
631 */
632int devfreq_remove_device(struct devfreq *devfreq)
633{
634 if (!devfreq)
635 return -EINVAL;
636
637 device_unregister(&devfreq->dev);
638
639 return 0;
640}
641EXPORT_SYMBOL(devfreq_remove_device);
642
643static int devm_devfreq_dev_match(struct device *dev, void *res, void *data)
644{
645 struct devfreq **r = res;
646
647 if (WARN_ON(!r || !*r))
648 return 0;
649
650 return *r == data;
651}
652
653static void devm_devfreq_dev_release(struct device *dev, void *res)
654{
655 devfreq_remove_device(*(struct devfreq **)res);
656}
657
658/**
659 * devm_devfreq_add_device() - Resource-managed devfreq_add_device()
660 * @dev: the device to add devfreq feature.
661 * @profile: device-specific profile to run devfreq.
662 * @governor_name: name of the policy to choose frequency.
663 * @data: private data for the governor. The devfreq framework does not
664 * touch this value.
665 *
666 * This function manages automatically the memory of devfreq device using device
667 * resource management and simplify the free operation for memory of devfreq
668 * device.
669 */
670struct devfreq *devm_devfreq_add_device(struct device *dev,
671 struct devfreq_dev_profile *profile,
672 const char *governor_name,
673 void *data)
674{
675 struct devfreq **ptr, *devfreq;
676
677 ptr = devres_alloc(devm_devfreq_dev_release, sizeof(*ptr), GFP_KERNEL);
678 if (!ptr)
679 return ERR_PTR(-ENOMEM);
680
681 devfreq = devfreq_add_device(dev, profile, governor_name, data);
682 if (IS_ERR(devfreq)) {
683 devres_free(ptr);
684 return ERR_PTR(-ENOMEM);
685 }
686
687 *ptr = devfreq;
688 devres_add(dev, ptr);
689
690 return devfreq;
691}
692EXPORT_SYMBOL(devm_devfreq_add_device);
693
694#ifdef CONFIG_OF
695/*
696 * devfreq_get_devfreq_by_phandle - Get the devfreq device from devicetree
697 * @dev - instance to the given device
698 * @index - index into list of devfreq
699 *
700 * return the instance of devfreq device
701 */
702struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
703{
704 struct device_node *node;
705 struct devfreq *devfreq;
706
707 if (!dev)
708 return ERR_PTR(-EINVAL);
709
710 if (!dev->of_node)
711 return ERR_PTR(-EINVAL);
712
713 node = of_parse_phandle(dev->of_node, "devfreq", index);
714 if (!node)
715 return ERR_PTR(-ENODEV);
716
717 mutex_lock(&devfreq_list_lock);
718 list_for_each_entry(devfreq, &devfreq_list, node) {
719 if (devfreq->dev.parent
720 && devfreq->dev.parent->of_node == node) {
721 mutex_unlock(&devfreq_list_lock);
722 of_node_put(node);
723 return devfreq;
724 }
725 }
726 mutex_unlock(&devfreq_list_lock);
727 of_node_put(node);
728
729 return ERR_PTR(-EPROBE_DEFER);
730}
731#else
732struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
733{
734 return ERR_PTR(-ENODEV);
735}
736#endif /* CONFIG_OF */
737EXPORT_SYMBOL_GPL(devfreq_get_devfreq_by_phandle);
738
739/**
740 * devm_devfreq_remove_device() - Resource-managed devfreq_remove_device()
741 * @dev: the device to add devfreq feature.
742 * @devfreq: the devfreq instance to be removed
743 */
744void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq)
745{
746 WARN_ON(devres_release(dev, devm_devfreq_dev_release,
747 devm_devfreq_dev_match, devfreq));
748}
749EXPORT_SYMBOL(devm_devfreq_remove_device);
750
751/**
752 * devfreq_suspend_device() - Suspend devfreq of a device.
753 * @devfreq: the devfreq instance to be suspended
754 *
755 * This function is intended to be called by the pm callbacks
756 * (e.g., runtime_suspend, suspend) of the device driver that
757 * holds the devfreq.
758 */
759int devfreq_suspend_device(struct devfreq *devfreq)
760{
761 if (!devfreq)
762 return -EINVAL;
763
764 if (!devfreq->governor)
765 return 0;
766
767 return devfreq->governor->event_handler(devfreq,
768 DEVFREQ_GOV_SUSPEND, NULL);
769}
770EXPORT_SYMBOL(devfreq_suspend_device);
771
772/**
773 * devfreq_resume_device() - Resume devfreq of a device.
774 * @devfreq: the devfreq instance to be resumed
775 *
776 * This function is intended to be called by the pm callbacks
777 * (e.g., runtime_resume, resume) of the device driver that
778 * holds the devfreq.
779 */
780int devfreq_resume_device(struct devfreq *devfreq)
781{
782 if (!devfreq)
783 return -EINVAL;
784
785 if (!devfreq->governor)
786 return 0;
787
788 return devfreq->governor->event_handler(devfreq,
789 DEVFREQ_GOV_RESUME, NULL);
790}
791EXPORT_SYMBOL(devfreq_resume_device);
792
793/**
794 * devfreq_add_governor() - Add devfreq governor
795 * @governor: the devfreq governor to be added
796 */
797int devfreq_add_governor(struct devfreq_governor *governor)
798{
799 struct devfreq_governor *g;
800 struct devfreq *devfreq;
801 int err = 0;
802
803 if (!governor) {
804 pr_err("%s: Invalid parameters.\n", __func__);
805 return -EINVAL;
806 }
807
808 mutex_lock(&devfreq_list_lock);
809 g = find_devfreq_governor(governor->name);
810 if (!IS_ERR(g)) {
811 pr_err("%s: governor %s already registered\n", __func__,
812 g->name);
813 err = -EINVAL;
814 goto err_out;
815 }
816
817 list_add(&governor->node, &devfreq_governor_list);
818
819 list_for_each_entry(devfreq, &devfreq_list, node) {
820 int ret = 0;
821 struct device *dev = devfreq->dev.parent;
822
823 if (!strncmp(devfreq->governor_name, governor->name,
824 DEVFREQ_NAME_LEN)) {
825 /* The following should never occur */
826 if (devfreq->governor) {
827 dev_warn(dev,
828 "%s: Governor %s already present\n",
829 __func__, devfreq->governor->name);
830 ret = devfreq->governor->event_handler(devfreq,
831 DEVFREQ_GOV_STOP, NULL);
832 if (ret) {
833 dev_warn(dev,
834 "%s: Governor %s stop = %d\n",
835 __func__,
836 devfreq->governor->name, ret);
837 }
838 /* Fall through */
839 }
840 devfreq->governor = governor;
841 ret = devfreq->governor->event_handler(devfreq,
842 DEVFREQ_GOV_START, NULL);
843 if (ret) {
844 dev_warn(dev, "%s: Governor %s start=%d\n",
845 __func__, devfreq->governor->name,
846 ret);
847 }
848 }
849 }
850
851err_out:
852 mutex_unlock(&devfreq_list_lock);
853
854 return err;
855}
856EXPORT_SYMBOL(devfreq_add_governor);
857
858/**
859 * devfreq_remove_governor() - Remove devfreq feature from a device.
860 * @governor: the devfreq governor to be removed
861 */
862int devfreq_remove_governor(struct devfreq_governor *governor)
863{
864 struct devfreq_governor *g;
865 struct devfreq *devfreq;
866 int err = 0;
867
868 if (!governor) {
869 pr_err("%s: Invalid parameters.\n", __func__);
870 return -EINVAL;
871 }
872
873 mutex_lock(&devfreq_list_lock);
874 g = find_devfreq_governor(governor->name);
875 if (IS_ERR(g)) {
876 pr_err("%s: governor %s not registered\n", __func__,
877 governor->name);
878 err = PTR_ERR(g);
879 goto err_out;
880 }
881 list_for_each_entry(devfreq, &devfreq_list, node) {
882 int ret;
883 struct device *dev = devfreq->dev.parent;
884
885 if (!strncmp(devfreq->governor_name, governor->name,
886 DEVFREQ_NAME_LEN)) {
887 /* we should have a devfreq governor! */
888 if (!devfreq->governor) {
889 dev_warn(dev, "%s: Governor %s NOT present\n",
890 __func__, governor->name);
891 continue;
892 /* Fall through */
893 }
894 ret = devfreq->governor->event_handler(devfreq,
895 DEVFREQ_GOV_STOP, NULL);
896 if (ret) {
897 dev_warn(dev, "%s: Governor %s stop=%d\n",
898 __func__, devfreq->governor->name,
899 ret);
900 }
901 devfreq->governor = NULL;
902 }
903 }
904
905 list_del(&governor->node);
906err_out:
907 mutex_unlock(&devfreq_list_lock);
908
909 return err;
910}
911EXPORT_SYMBOL(devfreq_remove_governor);
912
913static ssize_t governor_show(struct device *dev,
914 struct device_attribute *attr, char *buf)
915{
916 if (!to_devfreq(dev)->governor)
917 return -EINVAL;
918
919 return sprintf(buf, "%s\n", to_devfreq(dev)->governor->name);
920}
921
922static ssize_t governor_store(struct device *dev, struct device_attribute *attr,
923 const char *buf, size_t count)
924{
925 struct devfreq *df = to_devfreq(dev);
926 int ret;
927 char str_governor[DEVFREQ_NAME_LEN + 1];
928 struct devfreq_governor *governor;
929
930 ret = sscanf(buf, "%" __stringify(DEVFREQ_NAME_LEN) "s", str_governor);
931 if (ret != 1)
932 return -EINVAL;
933
934 mutex_lock(&devfreq_list_lock);
935 governor = find_devfreq_governor(str_governor);
936 if (IS_ERR(governor)) {
937 ret = PTR_ERR(governor);
938 goto out;
939 }
940 if (df->governor == governor) {
941 ret = 0;
942 goto out;
943 } else if (df->governor->immutable || governor->immutable) {
944 ret = -EINVAL;
945 goto out;
946 }
947
948 if (df->governor) {
949 ret = df->governor->event_handler(df, DEVFREQ_GOV_STOP, NULL);
950 if (ret) {
951 dev_warn(dev, "%s: Governor %s not stopped(%d)\n",
952 __func__, df->governor->name, ret);
953 goto out;
954 }
955 }
956 df->governor = governor;
957 strncpy(df->governor_name, governor->name, DEVFREQ_NAME_LEN);
958 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
959 if (ret)
960 dev_warn(dev, "%s: Governor %s not started(%d)\n",
961 __func__, df->governor->name, ret);
962out:
963 mutex_unlock(&devfreq_list_lock);
964
965 if (!ret)
966 ret = count;
967 return ret;
968}
969static DEVICE_ATTR_RW(governor);
970
971static ssize_t available_governors_show(struct device *d,
972 struct device_attribute *attr,
973 char *buf)
974{
975 struct devfreq *df = to_devfreq(d);
976 ssize_t count = 0;
977
978 mutex_lock(&devfreq_list_lock);
979
980 /*
981 * The devfreq with immutable governor (e.g., passive) shows
982 * only own governor.
983 */
984 if (df->governor->immutable) {
985 count = scnprintf(&buf[count], DEVFREQ_NAME_LEN,
986 "%s ", df->governor_name);
987 /*
988 * The devfreq device shows the registered governor except for
989 * immutable governors such as passive governor .
990 */
991 } else {
992 struct devfreq_governor *governor;
993
994 list_for_each_entry(governor, &devfreq_governor_list, node) {
995 if (governor->immutable)
996 continue;
997 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
998 "%s ", governor->name);
999 }
1000 }
1001
1002 mutex_unlock(&devfreq_list_lock);
1003
1004 /* Truncate the trailing space */
1005 if (count)
1006 count--;
1007
1008 count += sprintf(&buf[count], "\n");
1009
1010 return count;
1011}
1012static DEVICE_ATTR_RO(available_governors);
1013
1014static ssize_t cur_freq_show(struct device *dev, struct device_attribute *attr,
1015 char *buf)
1016{
1017 unsigned long freq;
1018 struct devfreq *devfreq = to_devfreq(dev);
1019
1020 if (devfreq->profile->get_cur_freq &&
1021 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
1022 return sprintf(buf, "%lu\n", freq);
1023
1024 return sprintf(buf, "%lu\n", devfreq->previous_freq);
1025}
1026static DEVICE_ATTR_RO(cur_freq);
1027
1028static ssize_t target_freq_show(struct device *dev,
1029 struct device_attribute *attr, char *buf)
1030{
1031 return sprintf(buf, "%lu\n", to_devfreq(dev)->previous_freq);
1032}
1033static DEVICE_ATTR_RO(target_freq);
1034
1035static ssize_t polling_interval_show(struct device *dev,
1036 struct device_attribute *attr, char *buf)
1037{
1038 return sprintf(buf, "%d\n", to_devfreq(dev)->profile->polling_ms);
1039}
1040
1041static ssize_t polling_interval_store(struct device *dev,
1042 struct device_attribute *attr,
1043 const char *buf, size_t count)
1044{
1045 struct devfreq *df = to_devfreq(dev);
1046 unsigned int value;
1047 int ret;
1048
1049 if (!df->governor)
1050 return -EINVAL;
1051
1052 ret = sscanf(buf, "%u", &value);
1053 if (ret != 1)
1054 return -EINVAL;
1055
1056 df->governor->event_handler(df, DEVFREQ_GOV_INTERVAL, &value);
1057 ret = count;
1058
1059 return ret;
1060}
1061static DEVICE_ATTR_RW(polling_interval);
1062
1063static ssize_t min_freq_store(struct device *dev, struct device_attribute *attr,
1064 const char *buf, size_t count)
1065{
1066 struct devfreq *df = to_devfreq(dev);
1067 unsigned long value;
1068 int ret;
1069 unsigned long max;
1070
1071 ret = sscanf(buf, "%lu", &value);
1072 if (ret != 1)
1073 return -EINVAL;
1074
1075 mutex_lock(&df->lock);
1076 max = df->max_freq;
1077 if (value && max && value > max) {
1078 ret = -EINVAL;
1079 goto unlock;
1080 }
1081
1082 df->min_freq = value;
1083 update_devfreq(df);
1084 ret = count;
1085unlock:
1086 mutex_unlock(&df->lock);
1087 return ret;
1088}
1089
1090static ssize_t max_freq_store(struct device *dev, struct device_attribute *attr,
1091 const char *buf, size_t count)
1092{
1093 struct devfreq *df = to_devfreq(dev);
1094 unsigned long value;
1095 int ret;
1096 unsigned long min;
1097
1098 ret = sscanf(buf, "%lu", &value);
1099 if (ret != 1)
1100 return -EINVAL;
1101
1102 mutex_lock(&df->lock);
1103 min = df->min_freq;
1104 if (value && min && value < min) {
1105 ret = -EINVAL;
1106 goto unlock;
1107 }
1108
1109 df->max_freq = value;
1110 update_devfreq(df);
1111 ret = count;
1112unlock:
1113 mutex_unlock(&df->lock);
1114 return ret;
1115}
1116
1117#define show_one(name) \
1118static ssize_t name##_show \
1119(struct device *dev, struct device_attribute *attr, char *buf) \
1120{ \
1121 return sprintf(buf, "%lu\n", to_devfreq(dev)->name); \
1122}
1123show_one(min_freq);
1124show_one(max_freq);
1125
1126static DEVICE_ATTR_RW(min_freq);
1127static DEVICE_ATTR_RW(max_freq);
1128
1129static ssize_t available_frequencies_show(struct device *d,
1130 struct device_attribute *attr,
1131 char *buf)
1132{
1133 struct devfreq *df = to_devfreq(d);
1134 struct device *dev = df->dev.parent;
1135 struct dev_pm_opp *opp;
1136 ssize_t count = 0;
1137 unsigned long freq = 0;
1138
1139 rcu_read_lock();
1140 do {
1141 opp = dev_pm_opp_find_freq_ceil(dev, &freq);
1142 if (IS_ERR(opp))
1143 break;
1144
1145 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1146 "%lu ", freq);
1147 freq++;
1148 } while (1);
1149 rcu_read_unlock();
1150
1151 /* Truncate the trailing space */
1152 if (count)
1153 count--;
1154
1155 count += sprintf(&buf[count], "\n");
1156
1157 return count;
1158}
1159static DEVICE_ATTR_RO(available_frequencies);
1160
1161static ssize_t trans_stat_show(struct device *dev,
1162 struct device_attribute *attr, char *buf)
1163{
1164 struct devfreq *devfreq = to_devfreq(dev);
1165 ssize_t len;
1166 int i, j;
1167 unsigned int max_state = devfreq->profile->max_state;
1168
1169 if (!devfreq->stop_polling &&
1170 devfreq_update_status(devfreq, devfreq->previous_freq))
1171 return 0;
1172 if (max_state == 0)
1173 return sprintf(buf, "Not Supported.\n");
1174
1175 len = sprintf(buf, " From : To\n");
1176 len += sprintf(buf + len, " :");
1177 for (i = 0; i < max_state; i++)
1178 len += sprintf(buf + len, "%10lu",
1179 devfreq->profile->freq_table[i]);
1180
1181 len += sprintf(buf + len, " time(ms)\n");
1182
1183 for (i = 0; i < max_state; i++) {
1184 if (devfreq->profile->freq_table[i]
1185 == devfreq->previous_freq) {
1186 len += sprintf(buf + len, "*");
1187 } else {
1188 len += sprintf(buf + len, " ");
1189 }
1190 len += sprintf(buf + len, "%10lu:",
1191 devfreq->profile->freq_table[i]);
1192 for (j = 0; j < max_state; j++)
1193 len += sprintf(buf + len, "%10u",
1194 devfreq->trans_table[(i * max_state) + j]);
1195 len += sprintf(buf + len, "%10u\n",
1196 jiffies_to_msecs(devfreq->time_in_state[i]));
1197 }
1198
1199 len += sprintf(buf + len, "Total transition : %u\n",
1200 devfreq->total_trans);
1201 return len;
1202}
1203static DEVICE_ATTR_RO(trans_stat);
1204
1205static struct attribute *devfreq_attrs[] = {
1206 &dev_attr_governor.attr,
1207 &dev_attr_available_governors.attr,
1208 &dev_attr_cur_freq.attr,
1209 &dev_attr_available_frequencies.attr,
1210 &dev_attr_target_freq.attr,
1211 &dev_attr_polling_interval.attr,
1212 &dev_attr_min_freq.attr,
1213 &dev_attr_max_freq.attr,
1214 &dev_attr_trans_stat.attr,
1215 NULL,
1216};
1217ATTRIBUTE_GROUPS(devfreq);
1218
1219static int __init devfreq_init(void)
1220{
1221 devfreq_class = class_create(THIS_MODULE, "devfreq");
1222 if (IS_ERR(devfreq_class)) {
1223 pr_err("%s: couldn't create class\n", __FILE__);
1224 return PTR_ERR(devfreq_class);
1225 }
1226
1227 devfreq_wq = create_freezable_workqueue("devfreq_wq");
1228 if (!devfreq_wq) {
1229 class_destroy(devfreq_class);
1230 pr_err("%s: couldn't create workqueue\n", __FILE__);
1231 return -ENOMEM;
1232 }
1233 devfreq_class->dev_groups = devfreq_groups;
1234
1235 return 0;
1236}
1237subsys_initcall(devfreq_init);
1238
1239/*
1240 * The followings are helper functions for devfreq user device drivers with
1241 * OPP framework.
1242 */
1243
1244/**
1245 * devfreq_recommended_opp() - Helper function to get proper OPP for the
1246 * freq value given to target callback.
1247 * @dev: The devfreq user device. (parent of devfreq)
1248 * @freq: The frequency given to target function
1249 * @flags: Flags handed from devfreq framework.
1250 *
1251 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
1252 * protected pointer. The reason for the same is that the opp pointer which is
1253 * returned will remain valid for use with opp_get_{voltage, freq} only while
1254 * under the locked area. The pointer returned must be used prior to unlocking
1255 * with rcu_read_unlock() to maintain the integrity of the pointer.
1256 */
1257struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
1258 unsigned long *freq,
1259 u32 flags)
1260{
1261 struct dev_pm_opp *opp;
1262
1263 if (flags & DEVFREQ_FLAG_LEAST_UPPER_BOUND) {
1264 /* The freq is an upper bound. opp should be lower */
1265 opp = dev_pm_opp_find_freq_floor(dev, freq);
1266
1267 /* If not available, use the closest opp */
1268 if (opp == ERR_PTR(-ERANGE))
1269 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1270 } else {
1271 /* The freq is an lower bound. opp should be higher */
1272 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1273
1274 /* If not available, use the closest opp */
1275 if (opp == ERR_PTR(-ERANGE))
1276 opp = dev_pm_opp_find_freq_floor(dev, freq);
1277 }
1278
1279 return opp;
1280}
1281EXPORT_SYMBOL(devfreq_recommended_opp);
1282
1283/**
1284 * devfreq_register_opp_notifier() - Helper function to get devfreq notified
1285 * for any changes in the OPP availability
1286 * changes
1287 * @dev: The devfreq user device. (parent of devfreq)
1288 * @devfreq: The devfreq object.
1289 */
1290int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
1291{
1292 struct srcu_notifier_head *nh;
1293 int ret = 0;
1294
1295 rcu_read_lock();
1296 nh = dev_pm_opp_get_notifier(dev);
1297 if (IS_ERR(nh))
1298 ret = PTR_ERR(nh);
1299 rcu_read_unlock();
1300 if (!ret)
1301 ret = srcu_notifier_chain_register(nh, &devfreq->nb);
1302
1303 return ret;
1304}
1305EXPORT_SYMBOL(devfreq_register_opp_notifier);
1306
1307/**
1308 * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
1309 * notified for any changes in the OPP
1310 * availability changes anymore.
1311 * @dev: The devfreq user device. (parent of devfreq)
1312 * @devfreq: The devfreq object.
1313 *
1314 * At exit() callback of devfreq_dev_profile, this must be included if
1315 * devfreq_recommended_opp is used.
1316 */
1317int devfreq_unregister_opp_notifier(struct device *dev, struct devfreq *devfreq)
1318{
1319 struct srcu_notifier_head *nh;
1320 int ret = 0;
1321
1322 rcu_read_lock();
1323 nh = dev_pm_opp_get_notifier(dev);
1324 if (IS_ERR(nh))
1325 ret = PTR_ERR(nh);
1326 rcu_read_unlock();
1327 if (!ret)
1328 ret = srcu_notifier_chain_unregister(nh, &devfreq->nb);
1329
1330 return ret;
1331}
1332EXPORT_SYMBOL(devfreq_unregister_opp_notifier);
1333
1334static void devm_devfreq_opp_release(struct device *dev, void *res)
1335{
1336 devfreq_unregister_opp_notifier(dev, *(struct devfreq **)res);
1337}
1338
1339/**
1340 * devm_ devfreq_register_opp_notifier()
1341 * - Resource-managed devfreq_register_opp_notifier()
1342 * @dev: The devfreq user device. (parent of devfreq)
1343 * @devfreq: The devfreq object.
1344 */
1345int devm_devfreq_register_opp_notifier(struct device *dev,
1346 struct devfreq *devfreq)
1347{
1348 struct devfreq **ptr;
1349 int ret;
1350
1351 ptr = devres_alloc(devm_devfreq_opp_release, sizeof(*ptr), GFP_KERNEL);
1352 if (!ptr)
1353 return -ENOMEM;
1354
1355 ret = devfreq_register_opp_notifier(dev, devfreq);
1356 if (ret) {
1357 devres_free(ptr);
1358 return ret;
1359 }
1360
1361 *ptr = devfreq;
1362 devres_add(dev, ptr);
1363
1364 return 0;
1365}
1366EXPORT_SYMBOL(devm_devfreq_register_opp_notifier);
1367
1368/**
1369 * devm_devfreq_unregister_opp_notifier()
1370 * - Resource-managed devfreq_unregister_opp_notifier()
1371 * @dev: The devfreq user device. (parent of devfreq)
1372 * @devfreq: The devfreq object.
1373 */
1374void devm_devfreq_unregister_opp_notifier(struct device *dev,
1375 struct devfreq *devfreq)
1376{
1377 WARN_ON(devres_release(dev, devm_devfreq_opp_release,
1378 devm_devfreq_dev_match, devfreq));
1379}
1380EXPORT_SYMBOL(devm_devfreq_unregister_opp_notifier);
1381
1382/**
1383 * devfreq_register_notifier() - Register a driver with devfreq
1384 * @devfreq: The devfreq object.
1385 * @nb: The notifier block to register.
1386 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1387 */
1388int devfreq_register_notifier(struct devfreq *devfreq,
1389 struct notifier_block *nb,
1390 unsigned int list)
1391{
1392 int ret = 0;
1393
1394 if (!devfreq)
1395 return -EINVAL;
1396
1397 switch (list) {
1398 case DEVFREQ_TRANSITION_NOTIFIER:
1399 ret = srcu_notifier_chain_register(
1400 &devfreq->transition_notifier_list, nb);
1401 break;
1402 default:
1403 ret = -EINVAL;
1404 }
1405
1406 return ret;
1407}
1408EXPORT_SYMBOL(devfreq_register_notifier);
1409
1410/*
1411 * devfreq_unregister_notifier() - Unregister a driver with devfreq
1412 * @devfreq: The devfreq object.
1413 * @nb: The notifier block to be unregistered.
1414 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1415 */
1416int devfreq_unregister_notifier(struct devfreq *devfreq,
1417 struct notifier_block *nb,
1418 unsigned int list)
1419{
1420 int ret = 0;
1421
1422 if (!devfreq)
1423 return -EINVAL;
1424
1425 switch (list) {
1426 case DEVFREQ_TRANSITION_NOTIFIER:
1427 ret = srcu_notifier_chain_unregister(
1428 &devfreq->transition_notifier_list, nb);
1429 break;
1430 default:
1431 ret = -EINVAL;
1432 }
1433
1434 return ret;
1435}
1436EXPORT_SYMBOL(devfreq_unregister_notifier);
1437
1438struct devfreq_notifier_devres {
1439 struct devfreq *devfreq;
1440 struct notifier_block *nb;
1441 unsigned int list;
1442};
1443
1444static void devm_devfreq_notifier_release(struct device *dev, void *res)
1445{
1446 struct devfreq_notifier_devres *this = res;
1447
1448 devfreq_unregister_notifier(this->devfreq, this->nb, this->list);
1449}
1450
1451/**
1452 * devm_devfreq_register_notifier()
1453 - Resource-managed devfreq_register_notifier()
1454 * @dev: The devfreq user device. (parent of devfreq)
1455 * @devfreq: The devfreq object.
1456 * @nb: The notifier block to be unregistered.
1457 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1458 */
1459int devm_devfreq_register_notifier(struct device *dev,
1460 struct devfreq *devfreq,
1461 struct notifier_block *nb,
1462 unsigned int list)
1463{
1464 struct devfreq_notifier_devres *ptr;
1465 int ret;
1466
1467 ptr = devres_alloc(devm_devfreq_notifier_release, sizeof(*ptr),
1468 GFP_KERNEL);
1469 if (!ptr)
1470 return -ENOMEM;
1471
1472 ret = devfreq_register_notifier(devfreq, nb, list);
1473 if (ret) {
1474 devres_free(ptr);
1475 return ret;
1476 }
1477
1478 ptr->devfreq = devfreq;
1479 ptr->nb = nb;
1480 ptr->list = list;
1481 devres_add(dev, ptr);
1482
1483 return 0;
1484}
1485EXPORT_SYMBOL(devm_devfreq_register_notifier);
1486
1487/**
1488 * devm_devfreq_unregister_notifier()
1489 - Resource-managed devfreq_unregister_notifier()
1490 * @dev: The devfreq user device. (parent of devfreq)
1491 * @devfreq: The devfreq object.
1492 * @nb: The notifier block to be unregistered.
1493 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1494 */
1495void devm_devfreq_unregister_notifier(struct device *dev,
1496 struct devfreq *devfreq,
1497 struct notifier_block *nb,
1498 unsigned int list)
1499{
1500 WARN_ON(devres_release(dev, devm_devfreq_notifier_release,
1501 devm_devfreq_dev_match, devfreq));
1502}
1503EXPORT_SYMBOL(devm_devfreq_unregister_notifier);