2 * devfreq: Generic Dynamic Voltage and Frequency Scaling (DVFS) Framework
5 * Copyright (C) 2011 Samsung Electronics
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.
13 #include <linux/kernel.h>
14 #include <linux/kmod.h>
15 #include <linux/sched.h>
16 #include <linux/errno.h>
17 #include <linux/err.h>
18 #include <linux/init.h>
19 #include <linux/export.h>
20 #include <linux/slab.h>
21 #include <linux/stat.h>
22 #include <linux/pm_opp.h>
23 #include <linux/devfreq.h>
24 #include <linux/workqueue.h>
25 #include <linux/platform_device.h>
26 #include <linux/list.h>
27 #include <linux/printk.h>
28 #include <linux/hrtimer.h>
32 static struct class *devfreq_class;
35 * devfreq core provides delayed work based load monitoring helper
36 * functions. Governors can use these or can implement their own
37 * monitoring mechanism.
39 static struct workqueue_struct *devfreq_wq;
41 /* The list of all device-devfreq governors */
42 static LIST_HEAD(devfreq_governor_list);
43 /* The list of all device-devfreq */
44 static LIST_HEAD(devfreq_list);
45 static DEFINE_MUTEX(devfreq_list_lock);
48 * find_device_devfreq() - find devfreq struct using device pointer
49 * @dev: device pointer used to lookup device devfreq.
51 * Search the list of device devfreqs and return the matched device's
52 * devfreq info. devfreq_list_lock should be held by the caller.
54 static struct devfreq *find_device_devfreq(struct device *dev)
56 struct devfreq *tmp_devfreq;
58 if (IS_ERR_OR_NULL(dev)) {
59 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
60 return ERR_PTR(-EINVAL);
62 WARN(!mutex_is_locked(&devfreq_list_lock),
63 "devfreq_list_lock must be locked.");
65 list_for_each_entry(tmp_devfreq, &devfreq_list, node) {
66 if (tmp_devfreq->dev.parent == dev)
70 return ERR_PTR(-ENODEV);
73 static unsigned long find_available_min_freq(struct devfreq *devfreq)
75 struct dev_pm_opp *opp;
76 unsigned long min_freq = 0;
78 opp = dev_pm_opp_find_freq_ceil(devfreq->dev.parent, &min_freq);
87 static unsigned long find_available_max_freq(struct devfreq *devfreq)
89 struct dev_pm_opp *opp;
90 unsigned long max_freq = ULONG_MAX;
92 opp = dev_pm_opp_find_freq_floor(devfreq->dev.parent, &max_freq);
102 * devfreq_get_freq_level() - Lookup freq_table for the frequency
103 * @devfreq: the devfreq instance
104 * @freq: the target frequency
106 static int devfreq_get_freq_level(struct devfreq *devfreq, unsigned long freq)
110 for (lev = 0; lev < devfreq->profile->max_state; lev++)
111 if (freq == devfreq->profile->freq_table[lev])
117 static int set_freq_table(struct devfreq *devfreq)
119 struct devfreq_dev_profile *profile = devfreq->profile;
120 struct dev_pm_opp *opp;
124 /* Initialize the freq_table from OPP table */
125 count = dev_pm_opp_get_opp_count(devfreq->dev.parent);
129 profile->max_state = count;
130 profile->freq_table = devm_kcalloc(devfreq->dev.parent,
132 sizeof(*profile->freq_table),
134 if (!profile->freq_table) {
135 profile->max_state = 0;
139 for (i = 0, freq = 0; i < profile->max_state; i++, freq++) {
140 opp = dev_pm_opp_find_freq_ceil(devfreq->dev.parent, &freq);
142 devm_kfree(devfreq->dev.parent, profile->freq_table);
143 profile->max_state = 0;
147 profile->freq_table[i] = freq;
154 * devfreq_update_status() - Update statistics of devfreq behavior
155 * @devfreq: the devfreq instance
156 * @freq: the update target frequency
158 int devfreq_update_status(struct devfreq *devfreq, unsigned long freq)
160 int lev, prev_lev, ret = 0;
161 unsigned long cur_time;
165 /* Immediately exit if previous_freq is not initialized yet. */
166 if (!devfreq->previous_freq)
169 prev_lev = devfreq_get_freq_level(devfreq, devfreq->previous_freq);
175 devfreq->time_in_state[prev_lev] +=
176 cur_time - devfreq->last_stat_updated;
178 lev = devfreq_get_freq_level(devfreq, freq);
184 if (lev != prev_lev) {
185 devfreq->trans_table[(prev_lev *
186 devfreq->profile->max_state) + lev]++;
187 devfreq->total_trans++;
191 devfreq->last_stat_updated = cur_time;
194 EXPORT_SYMBOL(devfreq_update_status);
197 * find_devfreq_governor() - find devfreq governor from name
198 * @name: name of the governor
200 * Search the list of devfreq governors and return the matched
201 * governor's pointer. devfreq_list_lock should be held by the caller.
203 static struct devfreq_governor *find_devfreq_governor(const char *name)
205 struct devfreq_governor *tmp_governor;
207 if (IS_ERR_OR_NULL(name)) {
208 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
209 return ERR_PTR(-EINVAL);
211 WARN(!mutex_is_locked(&devfreq_list_lock),
212 "devfreq_list_lock must be locked.");
214 list_for_each_entry(tmp_governor, &devfreq_governor_list, node) {
215 if (!strncmp(tmp_governor->name, name, DEVFREQ_NAME_LEN))
219 return ERR_PTR(-ENODEV);
223 * try_then_request_governor() - Try to find the governor and request the
224 * module if is not found.
225 * @name: name of the governor
227 * Search the list of devfreq governors and request the module and try again
228 * if is not found. This can happen when both drivers (the governor driver
229 * and the driver that call devfreq_add_device) are built as modules.
230 * devfreq_list_lock should be held by the caller. Returns the matched
231 * governor's pointer.
233 static struct devfreq_governor *try_then_request_governor(const char *name)
235 struct devfreq_governor *governor;
238 if (IS_ERR_OR_NULL(name)) {
239 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
240 return ERR_PTR(-EINVAL);
242 WARN(!mutex_is_locked(&devfreq_list_lock),
243 "devfreq_list_lock must be locked.");
245 governor = find_devfreq_governor(name);
246 if (IS_ERR(governor)) {
247 mutex_unlock(&devfreq_list_lock);
249 if (!strncmp(name, DEVFREQ_GOV_SIMPLE_ONDEMAND,
251 err = request_module("governor_%s", "simpleondemand");
253 err = request_module("governor_%s", name);
254 /* Restore previous state before return */
255 mutex_lock(&devfreq_list_lock);
259 governor = find_devfreq_governor(name);
265 static int devfreq_notify_transition(struct devfreq *devfreq,
266 struct devfreq_freqs *freqs, unsigned int state)
272 case DEVFREQ_PRECHANGE:
273 srcu_notifier_call_chain(&devfreq->transition_notifier_list,
274 DEVFREQ_PRECHANGE, freqs);
277 case DEVFREQ_POSTCHANGE:
278 srcu_notifier_call_chain(&devfreq->transition_notifier_list,
279 DEVFREQ_POSTCHANGE, freqs);
288 static int devfreq_set_target(struct devfreq *devfreq, unsigned long new_freq,
291 struct devfreq_freqs freqs;
292 unsigned long cur_freq;
295 if (devfreq->profile->get_cur_freq)
296 devfreq->profile->get_cur_freq(devfreq->dev.parent, &cur_freq);
298 cur_freq = devfreq->previous_freq;
300 freqs.old = cur_freq;
301 freqs.new = new_freq;
302 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_PRECHANGE);
304 err = devfreq->profile->target(devfreq->dev.parent, &new_freq, flags);
306 freqs.new = cur_freq;
307 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_POSTCHANGE);
311 freqs.new = new_freq;
312 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_POSTCHANGE);
314 if (devfreq_update_status(devfreq, new_freq))
315 dev_err(&devfreq->dev,
316 "Couldn't update frequency transition information.\n");
318 devfreq->previous_freq = new_freq;
320 if (devfreq->suspend_freq)
321 devfreq->resume_freq = cur_freq;
326 /* Load monitoring helper functions for governors use */
329 * update_devfreq() - Reevaluate the device and configure frequency.
330 * @devfreq: the devfreq instance.
332 * Note: Lock devfreq->lock before calling update_devfreq
333 * This function is exported for governors.
335 int update_devfreq(struct devfreq *devfreq)
337 unsigned long freq, min_freq, max_freq;
341 if (!mutex_is_locked(&devfreq->lock)) {
342 WARN(true, "devfreq->lock must be locked by the caller.\n");
346 if (!devfreq->governor)
349 /* Reevaluate the proper frequency */
350 err = devfreq->governor->get_target_freq(devfreq, &freq);
355 * Adjust the frequency with user freq, QoS and available freq.
357 * List from the highest priority
361 max_freq = min(devfreq->scaling_max_freq, devfreq->max_freq);
362 min_freq = max(devfreq->scaling_min_freq, devfreq->min_freq);
364 if (freq < min_freq) {
366 flags &= ~DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use GLB */
368 if (freq > max_freq) {
370 flags |= DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use LUB */
373 return devfreq_set_target(devfreq, freq, flags);
376 EXPORT_SYMBOL(update_devfreq);
379 * devfreq_monitor() - Periodically poll devfreq objects.
380 * @work: the work struct used to run devfreq_monitor periodically.
383 static void devfreq_monitor(struct work_struct *work)
386 struct devfreq *devfreq = container_of(work,
387 struct devfreq, work.work);
389 mutex_lock(&devfreq->lock);
390 err = update_devfreq(devfreq);
392 dev_err(&devfreq->dev, "dvfs failed with (%d) error\n", err);
394 queue_delayed_work(devfreq_wq, &devfreq->work,
395 msecs_to_jiffies(devfreq->profile->polling_ms));
396 mutex_unlock(&devfreq->lock);
400 * devfreq_monitor_start() - Start load monitoring of devfreq instance
401 * @devfreq: the devfreq instance.
403 * Helper function for starting devfreq device load monitoing. By
404 * default delayed work based monitoring is supported. Function
405 * to be called from governor in response to DEVFREQ_GOV_START
406 * event when device is added to devfreq framework.
408 void devfreq_monitor_start(struct devfreq *devfreq)
410 INIT_DEFERRABLE_WORK(&devfreq->work, devfreq_monitor);
411 if (devfreq->profile->polling_ms)
412 queue_delayed_work(devfreq_wq, &devfreq->work,
413 msecs_to_jiffies(devfreq->profile->polling_ms));
415 EXPORT_SYMBOL(devfreq_monitor_start);
418 * devfreq_monitor_stop() - Stop load monitoring of a devfreq instance
419 * @devfreq: the devfreq instance.
421 * Helper function to stop devfreq device load monitoing. Function
422 * to be called from governor in response to DEVFREQ_GOV_STOP
423 * event when device is removed from devfreq framework.
425 void devfreq_monitor_stop(struct devfreq *devfreq)
427 cancel_delayed_work_sync(&devfreq->work);
429 EXPORT_SYMBOL(devfreq_monitor_stop);
432 * devfreq_monitor_suspend() - Suspend load monitoring of a devfreq instance
433 * @devfreq: the devfreq instance.
435 * Helper function to suspend devfreq device load monitoing. Function
436 * to be called from governor in response to DEVFREQ_GOV_SUSPEND
437 * event or when polling interval is set to zero.
439 * Note: Though this function is same as devfreq_monitor_stop(),
440 * intentionally kept separate to provide hooks for collecting
441 * transition statistics.
443 void devfreq_monitor_suspend(struct devfreq *devfreq)
445 mutex_lock(&devfreq->lock);
446 if (devfreq->stop_polling) {
447 mutex_unlock(&devfreq->lock);
451 devfreq_update_status(devfreq, devfreq->previous_freq);
452 devfreq->stop_polling = true;
453 mutex_unlock(&devfreq->lock);
454 cancel_delayed_work_sync(&devfreq->work);
456 EXPORT_SYMBOL(devfreq_monitor_suspend);
459 * devfreq_monitor_resume() - Resume load monitoring of a devfreq instance
460 * @devfreq: the devfreq instance.
462 * Helper function to resume devfreq device load monitoing. Function
463 * to be called from governor in response to DEVFREQ_GOV_RESUME
464 * event or when polling interval is set to non-zero.
466 void devfreq_monitor_resume(struct devfreq *devfreq)
470 mutex_lock(&devfreq->lock);
471 if (!devfreq->stop_polling)
474 if (!delayed_work_pending(&devfreq->work) &&
475 devfreq->profile->polling_ms)
476 queue_delayed_work(devfreq_wq, &devfreq->work,
477 msecs_to_jiffies(devfreq->profile->polling_ms));
479 devfreq->last_stat_updated = jiffies;
480 devfreq->stop_polling = false;
482 if (devfreq->profile->get_cur_freq &&
483 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
484 devfreq->previous_freq = freq;
487 mutex_unlock(&devfreq->lock);
489 EXPORT_SYMBOL(devfreq_monitor_resume);
492 * devfreq_interval_update() - Update device devfreq monitoring interval
493 * @devfreq: the devfreq instance.
494 * @delay: new polling interval to be set.
496 * Helper function to set new load monitoring polling interval. Function
497 * to be called from governor in response to DEVFREQ_GOV_INTERVAL event.
499 void devfreq_interval_update(struct devfreq *devfreq, unsigned int *delay)
501 unsigned int cur_delay = devfreq->profile->polling_ms;
502 unsigned int new_delay = *delay;
504 mutex_lock(&devfreq->lock);
505 devfreq->profile->polling_ms = new_delay;
507 if (devfreq->stop_polling)
510 /* if new delay is zero, stop polling */
512 mutex_unlock(&devfreq->lock);
513 cancel_delayed_work_sync(&devfreq->work);
517 /* if current delay is zero, start polling with new delay */
519 queue_delayed_work(devfreq_wq, &devfreq->work,
520 msecs_to_jiffies(devfreq->profile->polling_ms));
524 /* if current delay is greater than new delay, restart polling */
525 if (cur_delay > new_delay) {
526 mutex_unlock(&devfreq->lock);
527 cancel_delayed_work_sync(&devfreq->work);
528 mutex_lock(&devfreq->lock);
529 if (!devfreq->stop_polling)
530 queue_delayed_work(devfreq_wq, &devfreq->work,
531 msecs_to_jiffies(devfreq->profile->polling_ms));
534 mutex_unlock(&devfreq->lock);
536 EXPORT_SYMBOL(devfreq_interval_update);
539 * devfreq_notifier_call() - Notify that the device frequency requirements
540 * has been changed out of devfreq framework.
541 * @nb: the notifier_block (supposed to be devfreq->nb)
545 * Called by a notifier that uses devfreq->nb.
547 static int devfreq_notifier_call(struct notifier_block *nb, unsigned long type,
550 struct devfreq *devfreq = container_of(nb, struct devfreq, nb);
553 mutex_lock(&devfreq->lock);
555 devfreq->scaling_min_freq = find_available_min_freq(devfreq);
556 if (!devfreq->scaling_min_freq) {
557 mutex_unlock(&devfreq->lock);
561 devfreq->scaling_max_freq = find_available_max_freq(devfreq);
562 if (!devfreq->scaling_max_freq) {
563 mutex_unlock(&devfreq->lock);
567 ret = update_devfreq(devfreq);
568 mutex_unlock(&devfreq->lock);
574 * devfreq_dev_release() - Callback for struct device to release the device.
575 * @dev: the devfreq device
577 * Remove devfreq from the list and release its resources.
579 static void devfreq_dev_release(struct device *dev)
581 struct devfreq *devfreq = to_devfreq(dev);
583 mutex_lock(&devfreq_list_lock);
584 if (IS_ERR(find_device_devfreq(devfreq->dev.parent))) {
585 mutex_unlock(&devfreq_list_lock);
586 dev_warn(&devfreq->dev, "releasing devfreq which doesn't exist\n");
589 list_del(&devfreq->node);
590 mutex_unlock(&devfreq_list_lock);
592 if (devfreq->profile->exit)
593 devfreq->profile->exit(devfreq->dev.parent);
595 mutex_destroy(&devfreq->lock);
600 * devfreq_add_device() - Add devfreq feature to the device
601 * @dev: the device to add devfreq feature.
602 * @profile: device-specific profile to run devfreq.
603 * @governor_name: name of the policy to choose frequency.
604 * @data: private data for the governor. The devfreq framework does not
607 struct devfreq *devfreq_add_device(struct device *dev,
608 struct devfreq_dev_profile *profile,
609 const char *governor_name,
612 struct devfreq *devfreq;
613 struct devfreq_governor *governor;
614 static atomic_t devfreq_no = ATOMIC_INIT(-1);
617 if (!dev || !profile || !governor_name) {
618 dev_err(dev, "%s: Invalid parameters.\n", __func__);
619 return ERR_PTR(-EINVAL);
622 mutex_lock(&devfreq_list_lock);
623 devfreq = find_device_devfreq(dev);
624 mutex_unlock(&devfreq_list_lock);
625 if (!IS_ERR(devfreq)) {
626 dev_err(dev, "%s: Unable to create devfreq for the device.\n",
632 devfreq = kzalloc(sizeof(struct devfreq), GFP_KERNEL);
638 mutex_init(&devfreq->lock);
639 mutex_lock(&devfreq->lock);
640 devfreq->dev.parent = dev;
641 devfreq->dev.class = devfreq_class;
642 devfreq->dev.release = devfreq_dev_release;
643 devfreq->profile = profile;
644 strncpy(devfreq->governor_name, governor_name, DEVFREQ_NAME_LEN);
645 devfreq->previous_freq = profile->initial_freq;
646 devfreq->last_status.current_frequency = profile->initial_freq;
647 devfreq->data = data;
648 devfreq->nb.notifier_call = devfreq_notifier_call;
650 if (!devfreq->profile->max_state && !devfreq->profile->freq_table) {
651 mutex_unlock(&devfreq->lock);
652 err = set_freq_table(devfreq);
655 mutex_lock(&devfreq->lock);
658 devfreq->scaling_min_freq = find_available_min_freq(devfreq);
659 if (!devfreq->scaling_min_freq) {
660 mutex_unlock(&devfreq->lock);
664 devfreq->min_freq = devfreq->scaling_min_freq;
666 devfreq->scaling_max_freq = find_available_max_freq(devfreq);
667 if (!devfreq->scaling_max_freq) {
668 mutex_unlock(&devfreq->lock);
672 devfreq->max_freq = devfreq->scaling_max_freq;
674 devfreq->suspend_freq = dev_pm_opp_get_suspend_opp_freq(dev);
675 atomic_set(&devfreq->suspend_count, 0);
677 dev_set_name(&devfreq->dev, "devfreq%d",
678 atomic_inc_return(&devfreq_no));
679 err = device_register(&devfreq->dev);
681 mutex_unlock(&devfreq->lock);
682 put_device(&devfreq->dev);
686 devfreq->trans_table =
687 devm_kzalloc(&devfreq->dev,
688 array3_size(sizeof(unsigned int),
689 devfreq->profile->max_state,
690 devfreq->profile->max_state),
692 devfreq->time_in_state = devm_kcalloc(&devfreq->dev,
693 devfreq->profile->max_state,
694 sizeof(unsigned long),
696 devfreq->last_stat_updated = jiffies;
698 srcu_init_notifier_head(&devfreq->transition_notifier_list);
700 mutex_unlock(&devfreq->lock);
702 mutex_lock(&devfreq_list_lock);
704 governor = try_then_request_governor(devfreq->governor_name);
705 if (IS_ERR(governor)) {
706 dev_err(dev, "%s: Unable to find governor for the device\n",
708 err = PTR_ERR(governor);
712 devfreq->governor = governor;
713 err = devfreq->governor->event_handler(devfreq, DEVFREQ_GOV_START,
716 dev_err(dev, "%s: Unable to start governor for the device\n",
721 list_add(&devfreq->node, &devfreq_list);
723 mutex_unlock(&devfreq_list_lock);
728 mutex_unlock(&devfreq_list_lock);
730 devfreq_remove_device(devfreq);
737 EXPORT_SYMBOL(devfreq_add_device);
740 * devfreq_remove_device() - Remove devfreq feature from a device.
741 * @devfreq: the devfreq instance to be removed
743 * The opposite of devfreq_add_device().
745 int devfreq_remove_device(struct devfreq *devfreq)
750 if (devfreq->governor)
751 devfreq->governor->event_handler(devfreq,
752 DEVFREQ_GOV_STOP, NULL);
753 device_unregister(&devfreq->dev);
757 EXPORT_SYMBOL(devfreq_remove_device);
759 static int devm_devfreq_dev_match(struct device *dev, void *res, void *data)
761 struct devfreq **r = res;
763 if (WARN_ON(!r || !*r))
769 static void devm_devfreq_dev_release(struct device *dev, void *res)
771 devfreq_remove_device(*(struct devfreq **)res);
775 * devm_devfreq_add_device() - Resource-managed devfreq_add_device()
776 * @dev: the device to add devfreq feature.
777 * @profile: device-specific profile to run devfreq.
778 * @governor_name: name of the policy to choose frequency.
779 * @data: private data for the governor. The devfreq framework does not
782 * This function manages automatically the memory of devfreq device using device
783 * resource management and simplify the free operation for memory of devfreq
786 struct devfreq *devm_devfreq_add_device(struct device *dev,
787 struct devfreq_dev_profile *profile,
788 const char *governor_name,
791 struct devfreq **ptr, *devfreq;
793 ptr = devres_alloc(devm_devfreq_dev_release, sizeof(*ptr), GFP_KERNEL);
795 return ERR_PTR(-ENOMEM);
797 devfreq = devfreq_add_device(dev, profile, governor_name, data);
798 if (IS_ERR(devfreq)) {
804 devres_add(dev, ptr);
808 EXPORT_SYMBOL(devm_devfreq_add_device);
812 * devfreq_get_devfreq_by_phandle - Get the devfreq device from devicetree
813 * @dev - instance to the given device
814 * @index - index into list of devfreq
816 * return the instance of devfreq device
818 struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
820 struct device_node *node;
821 struct devfreq *devfreq;
824 return ERR_PTR(-EINVAL);
827 return ERR_PTR(-EINVAL);
829 node = of_parse_phandle(dev->of_node, "devfreq", index);
831 return ERR_PTR(-ENODEV);
833 mutex_lock(&devfreq_list_lock);
834 list_for_each_entry(devfreq, &devfreq_list, node) {
835 if (devfreq->dev.parent
836 && devfreq->dev.parent->of_node == node) {
837 mutex_unlock(&devfreq_list_lock);
842 mutex_unlock(&devfreq_list_lock);
845 return ERR_PTR(-EPROBE_DEFER);
848 struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
850 return ERR_PTR(-ENODEV);
852 #endif /* CONFIG_OF */
853 EXPORT_SYMBOL_GPL(devfreq_get_devfreq_by_phandle);
856 * devm_devfreq_remove_device() - Resource-managed devfreq_remove_device()
857 * @dev: the device to add devfreq feature.
858 * @devfreq: the devfreq instance to be removed
860 void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq)
862 WARN_ON(devres_release(dev, devm_devfreq_dev_release,
863 devm_devfreq_dev_match, devfreq));
865 EXPORT_SYMBOL(devm_devfreq_remove_device);
868 * devfreq_suspend_device() - Suspend devfreq of a device.
869 * @devfreq: the devfreq instance to be suspended
871 * This function is intended to be called by the pm callbacks
872 * (e.g., runtime_suspend, suspend) of the device driver that
875 int devfreq_suspend_device(struct devfreq *devfreq)
882 if (atomic_inc_return(&devfreq->suspend_count) > 1)
885 if (devfreq->governor) {
886 ret = devfreq->governor->event_handler(devfreq,
887 DEVFREQ_GOV_SUSPEND, NULL);
892 if (devfreq->suspend_freq) {
893 ret = devfreq_set_target(devfreq, devfreq->suspend_freq, 0);
900 EXPORT_SYMBOL(devfreq_suspend_device);
903 * devfreq_resume_device() - Resume devfreq of a device.
904 * @devfreq: the devfreq instance to be resumed
906 * This function is intended to be called by the pm callbacks
907 * (e.g., runtime_resume, resume) of the device driver that
910 int devfreq_resume_device(struct devfreq *devfreq)
917 if (atomic_dec_return(&devfreq->suspend_count) >= 1)
920 if (devfreq->resume_freq) {
921 ret = devfreq_set_target(devfreq, devfreq->resume_freq, 0);
926 if (devfreq->governor) {
927 ret = devfreq->governor->event_handler(devfreq,
928 DEVFREQ_GOV_RESUME, NULL);
935 EXPORT_SYMBOL(devfreq_resume_device);
938 * devfreq_suspend() - Suspend devfreq governors and devices
940 * Called during system wide Suspend/Hibernate cycles for suspending governors
941 * and devices preserving the state for resume. On some platforms the devfreq
942 * device must have precise state (frequency) after resume in order to provide
943 * fully operating setup.
945 void devfreq_suspend(void)
947 struct devfreq *devfreq;
950 mutex_lock(&devfreq_list_lock);
951 list_for_each_entry(devfreq, &devfreq_list, node) {
952 ret = devfreq_suspend_device(devfreq);
954 dev_err(&devfreq->dev,
955 "failed to suspend devfreq device\n");
957 mutex_unlock(&devfreq_list_lock);
961 * devfreq_resume() - Resume devfreq governors and devices
963 * Called during system wide Suspend/Hibernate cycle for resuming governors and
964 * devices that are suspended with devfreq_suspend().
966 void devfreq_resume(void)
968 struct devfreq *devfreq;
971 mutex_lock(&devfreq_list_lock);
972 list_for_each_entry(devfreq, &devfreq_list, node) {
973 ret = devfreq_resume_device(devfreq);
975 dev_warn(&devfreq->dev,
976 "failed to resume devfreq device\n");
978 mutex_unlock(&devfreq_list_lock);
982 * devfreq_add_governor() - Add devfreq governor
983 * @governor: the devfreq governor to be added
985 int devfreq_add_governor(struct devfreq_governor *governor)
987 struct devfreq_governor *g;
988 struct devfreq *devfreq;
992 pr_err("%s: Invalid parameters.\n", __func__);
996 mutex_lock(&devfreq_list_lock);
997 g = find_devfreq_governor(governor->name);
999 pr_err("%s: governor %s already registered\n", __func__,
1005 list_add(&governor->node, &devfreq_governor_list);
1007 list_for_each_entry(devfreq, &devfreq_list, node) {
1009 struct device *dev = devfreq->dev.parent;
1011 if (!strncmp(devfreq->governor_name, governor->name,
1012 DEVFREQ_NAME_LEN)) {
1013 /* The following should never occur */
1014 if (devfreq->governor) {
1016 "%s: Governor %s already present\n",
1017 __func__, devfreq->governor->name);
1018 ret = devfreq->governor->event_handler(devfreq,
1019 DEVFREQ_GOV_STOP, NULL);
1022 "%s: Governor %s stop = %d\n",
1024 devfreq->governor->name, ret);
1028 devfreq->governor = governor;
1029 ret = devfreq->governor->event_handler(devfreq,
1030 DEVFREQ_GOV_START, NULL);
1032 dev_warn(dev, "%s: Governor %s start=%d\n",
1033 __func__, devfreq->governor->name,
1040 mutex_unlock(&devfreq_list_lock);
1044 EXPORT_SYMBOL(devfreq_add_governor);
1047 * devfreq_remove_governor() - Remove devfreq feature from a device.
1048 * @governor: the devfreq governor to be removed
1050 int devfreq_remove_governor(struct devfreq_governor *governor)
1052 struct devfreq_governor *g;
1053 struct devfreq *devfreq;
1057 pr_err("%s: Invalid parameters.\n", __func__);
1061 mutex_lock(&devfreq_list_lock);
1062 g = find_devfreq_governor(governor->name);
1064 pr_err("%s: governor %s not registered\n", __func__,
1069 list_for_each_entry(devfreq, &devfreq_list, node) {
1071 struct device *dev = devfreq->dev.parent;
1073 if (!strncmp(devfreq->governor_name, governor->name,
1074 DEVFREQ_NAME_LEN)) {
1075 /* we should have a devfreq governor! */
1076 if (!devfreq->governor) {
1077 dev_warn(dev, "%s: Governor %s NOT present\n",
1078 __func__, governor->name);
1082 ret = devfreq->governor->event_handler(devfreq,
1083 DEVFREQ_GOV_STOP, NULL);
1085 dev_warn(dev, "%s: Governor %s stop=%d\n",
1086 __func__, devfreq->governor->name,
1089 devfreq->governor = NULL;
1093 list_del(&governor->node);
1095 mutex_unlock(&devfreq_list_lock);
1099 EXPORT_SYMBOL(devfreq_remove_governor);
1101 static ssize_t governor_show(struct device *dev,
1102 struct device_attribute *attr, char *buf)
1104 if (!to_devfreq(dev)->governor)
1107 return sprintf(buf, "%s\n", to_devfreq(dev)->governor->name);
1110 static ssize_t governor_store(struct device *dev, struct device_attribute *attr,
1111 const char *buf, size_t count)
1113 struct devfreq *df = to_devfreq(dev);
1115 char str_governor[DEVFREQ_NAME_LEN + 1];
1116 struct devfreq_governor *governor;
1118 ret = sscanf(buf, "%" __stringify(DEVFREQ_NAME_LEN) "s", str_governor);
1122 mutex_lock(&devfreq_list_lock);
1123 governor = try_then_request_governor(str_governor);
1124 if (IS_ERR(governor)) {
1125 ret = PTR_ERR(governor);
1128 if (df->governor == governor) {
1131 } else if ((df->governor && df->governor->immutable) ||
1132 governor->immutable) {
1138 ret = df->governor->event_handler(df, DEVFREQ_GOV_STOP, NULL);
1140 dev_warn(dev, "%s: Governor %s not stopped(%d)\n",
1141 __func__, df->governor->name, ret);
1145 df->governor = governor;
1146 strncpy(df->governor_name, governor->name, DEVFREQ_NAME_LEN);
1147 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
1149 dev_warn(dev, "%s: Governor %s not started(%d)\n",
1150 __func__, df->governor->name, ret);
1152 mutex_unlock(&devfreq_list_lock);
1158 static DEVICE_ATTR_RW(governor);
1160 static ssize_t available_governors_show(struct device *d,
1161 struct device_attribute *attr,
1164 struct devfreq *df = to_devfreq(d);
1167 mutex_lock(&devfreq_list_lock);
1170 * The devfreq with immutable governor (e.g., passive) shows
1171 * only own governor.
1173 if (df->governor->immutable) {
1174 count = scnprintf(&buf[count], DEVFREQ_NAME_LEN,
1175 "%s ", df->governor_name);
1177 * The devfreq device shows the registered governor except for
1178 * immutable governors such as passive governor .
1181 struct devfreq_governor *governor;
1183 list_for_each_entry(governor, &devfreq_governor_list, node) {
1184 if (governor->immutable)
1186 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1187 "%s ", governor->name);
1191 mutex_unlock(&devfreq_list_lock);
1193 /* Truncate the trailing space */
1197 count += sprintf(&buf[count], "\n");
1201 static DEVICE_ATTR_RO(available_governors);
1203 static ssize_t cur_freq_show(struct device *dev, struct device_attribute *attr,
1207 struct devfreq *devfreq = to_devfreq(dev);
1209 if (devfreq->profile->get_cur_freq &&
1210 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
1211 return sprintf(buf, "%lu\n", freq);
1213 return sprintf(buf, "%lu\n", devfreq->previous_freq);
1215 static DEVICE_ATTR_RO(cur_freq);
1217 static ssize_t target_freq_show(struct device *dev,
1218 struct device_attribute *attr, char *buf)
1220 return sprintf(buf, "%lu\n", to_devfreq(dev)->previous_freq);
1222 static DEVICE_ATTR_RO(target_freq);
1224 static ssize_t polling_interval_show(struct device *dev,
1225 struct device_attribute *attr, char *buf)
1227 return sprintf(buf, "%d\n", to_devfreq(dev)->profile->polling_ms);
1230 static ssize_t polling_interval_store(struct device *dev,
1231 struct device_attribute *attr,
1232 const char *buf, size_t count)
1234 struct devfreq *df = to_devfreq(dev);
1241 ret = sscanf(buf, "%u", &value);
1245 df->governor->event_handler(df, DEVFREQ_GOV_INTERVAL, &value);
1250 static DEVICE_ATTR_RW(polling_interval);
1252 static ssize_t min_freq_store(struct device *dev, struct device_attribute *attr,
1253 const char *buf, size_t count)
1255 struct devfreq *df = to_devfreq(dev);
1256 unsigned long value;
1259 ret = sscanf(buf, "%lu", &value);
1263 mutex_lock(&df->lock);
1266 if (value > df->max_freq) {
1271 unsigned long *freq_table = df->profile->freq_table;
1273 /* Get minimum frequency according to sorting order */
1274 if (freq_table[0] < freq_table[df->profile->max_state - 1])
1275 value = freq_table[0];
1277 value = freq_table[df->profile->max_state - 1];
1280 df->min_freq = value;
1284 mutex_unlock(&df->lock);
1288 static ssize_t min_freq_show(struct device *dev, struct device_attribute *attr,
1291 struct devfreq *df = to_devfreq(dev);
1293 return sprintf(buf, "%lu\n", max(df->scaling_min_freq, df->min_freq));
1296 static ssize_t max_freq_store(struct device *dev, struct device_attribute *attr,
1297 const char *buf, size_t count)
1299 struct devfreq *df = to_devfreq(dev);
1300 unsigned long value;
1303 ret = sscanf(buf, "%lu", &value);
1307 mutex_lock(&df->lock);
1310 if (value < df->min_freq) {
1315 unsigned long *freq_table = df->profile->freq_table;
1317 /* Get maximum frequency according to sorting order */
1318 if (freq_table[0] < freq_table[df->profile->max_state - 1])
1319 value = freq_table[df->profile->max_state - 1];
1321 value = freq_table[0];
1324 df->max_freq = value;
1328 mutex_unlock(&df->lock);
1331 static DEVICE_ATTR_RW(min_freq);
1333 static ssize_t max_freq_show(struct device *dev, struct device_attribute *attr,
1336 struct devfreq *df = to_devfreq(dev);
1338 return sprintf(buf, "%lu\n", min(df->scaling_max_freq, df->max_freq));
1340 static DEVICE_ATTR_RW(max_freq);
1342 static ssize_t available_frequencies_show(struct device *d,
1343 struct device_attribute *attr,
1346 struct devfreq *df = to_devfreq(d);
1350 mutex_lock(&df->lock);
1352 for (i = 0; i < df->profile->max_state; i++)
1353 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1354 "%lu ", df->profile->freq_table[i]);
1356 mutex_unlock(&df->lock);
1357 /* Truncate the trailing space */
1361 count += sprintf(&buf[count], "\n");
1365 static DEVICE_ATTR_RO(available_frequencies);
1367 static ssize_t trans_stat_show(struct device *dev,
1368 struct device_attribute *attr, char *buf)
1370 struct devfreq *devfreq = to_devfreq(dev);
1373 unsigned int max_state = devfreq->profile->max_state;
1375 if (!devfreq->stop_polling &&
1376 devfreq_update_status(devfreq, devfreq->previous_freq))
1379 return sprintf(buf, "Not Supported.\n");
1381 len = sprintf(buf, " From : To\n");
1382 len += sprintf(buf + len, " :");
1383 for (i = 0; i < max_state; i++)
1384 len += sprintf(buf + len, "%10lu",
1385 devfreq->profile->freq_table[i]);
1387 len += sprintf(buf + len, " time(ms)\n");
1389 for (i = 0; i < max_state; i++) {
1390 if (devfreq->profile->freq_table[i]
1391 == devfreq->previous_freq) {
1392 len += sprintf(buf + len, "*");
1394 len += sprintf(buf + len, " ");
1396 len += sprintf(buf + len, "%10lu:",
1397 devfreq->profile->freq_table[i]);
1398 for (j = 0; j < max_state; j++)
1399 len += sprintf(buf + len, "%10u",
1400 devfreq->trans_table[(i * max_state) + j]);
1401 len += sprintf(buf + len, "%10u\n",
1402 jiffies_to_msecs(devfreq->time_in_state[i]));
1405 len += sprintf(buf + len, "Total transition : %u\n",
1406 devfreq->total_trans);
1409 static DEVICE_ATTR_RO(trans_stat);
1411 static struct attribute *devfreq_attrs[] = {
1412 &dev_attr_governor.attr,
1413 &dev_attr_available_governors.attr,
1414 &dev_attr_cur_freq.attr,
1415 &dev_attr_available_frequencies.attr,
1416 &dev_attr_target_freq.attr,
1417 &dev_attr_polling_interval.attr,
1418 &dev_attr_min_freq.attr,
1419 &dev_attr_max_freq.attr,
1420 &dev_attr_trans_stat.attr,
1423 ATTRIBUTE_GROUPS(devfreq);
1425 static int __init devfreq_init(void)
1427 devfreq_class = class_create(THIS_MODULE, "devfreq");
1428 if (IS_ERR(devfreq_class)) {
1429 pr_err("%s: couldn't create class\n", __FILE__);
1430 return PTR_ERR(devfreq_class);
1433 devfreq_wq = create_freezable_workqueue("devfreq_wq");
1435 class_destroy(devfreq_class);
1436 pr_err("%s: couldn't create workqueue\n", __FILE__);
1439 devfreq_class->dev_groups = devfreq_groups;
1443 subsys_initcall(devfreq_init);
1446 * The following are helper functions for devfreq user device drivers with
1451 * devfreq_recommended_opp() - Helper function to get proper OPP for the
1452 * freq value given to target callback.
1453 * @dev: The devfreq user device. (parent of devfreq)
1454 * @freq: The frequency given to target function
1455 * @flags: Flags handed from devfreq framework.
1457 * The callers are required to call dev_pm_opp_put() for the returned OPP after
1460 struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
1461 unsigned long *freq,
1464 struct dev_pm_opp *opp;
1466 if (flags & DEVFREQ_FLAG_LEAST_UPPER_BOUND) {
1467 /* The freq is an upper bound. opp should be lower */
1468 opp = dev_pm_opp_find_freq_floor(dev, freq);
1470 /* If not available, use the closest opp */
1471 if (opp == ERR_PTR(-ERANGE))
1472 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1474 /* The freq is an lower bound. opp should be higher */
1475 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1477 /* If not available, use the closest opp */
1478 if (opp == ERR_PTR(-ERANGE))
1479 opp = dev_pm_opp_find_freq_floor(dev, freq);
1484 EXPORT_SYMBOL(devfreq_recommended_opp);
1487 * devfreq_register_opp_notifier() - Helper function to get devfreq notified
1488 * for any changes in the OPP availability
1490 * @dev: The devfreq user device. (parent of devfreq)
1491 * @devfreq: The devfreq object.
1493 int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
1495 return dev_pm_opp_register_notifier(dev, &devfreq->nb);
1497 EXPORT_SYMBOL(devfreq_register_opp_notifier);
1500 * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
1501 * notified for any changes in the OPP
1502 * availability changes anymore.
1503 * @dev: The devfreq user device. (parent of devfreq)
1504 * @devfreq: The devfreq object.
1506 * At exit() callback of devfreq_dev_profile, this must be included if
1507 * devfreq_recommended_opp is used.
1509 int devfreq_unregister_opp_notifier(struct device *dev, struct devfreq *devfreq)
1511 return dev_pm_opp_unregister_notifier(dev, &devfreq->nb);
1513 EXPORT_SYMBOL(devfreq_unregister_opp_notifier);
1515 static void devm_devfreq_opp_release(struct device *dev, void *res)
1517 devfreq_unregister_opp_notifier(dev, *(struct devfreq **)res);
1521 * devm_ devfreq_register_opp_notifier()
1522 * - Resource-managed devfreq_register_opp_notifier()
1523 * @dev: The devfreq user device. (parent of devfreq)
1524 * @devfreq: The devfreq object.
1526 int devm_devfreq_register_opp_notifier(struct device *dev,
1527 struct devfreq *devfreq)
1529 struct devfreq **ptr;
1532 ptr = devres_alloc(devm_devfreq_opp_release, sizeof(*ptr), GFP_KERNEL);
1536 ret = devfreq_register_opp_notifier(dev, devfreq);
1543 devres_add(dev, ptr);
1547 EXPORT_SYMBOL(devm_devfreq_register_opp_notifier);
1550 * devm_devfreq_unregister_opp_notifier()
1551 * - Resource-managed devfreq_unregister_opp_notifier()
1552 * @dev: The devfreq user device. (parent of devfreq)
1553 * @devfreq: The devfreq object.
1555 void devm_devfreq_unregister_opp_notifier(struct device *dev,
1556 struct devfreq *devfreq)
1558 WARN_ON(devres_release(dev, devm_devfreq_opp_release,
1559 devm_devfreq_dev_match, devfreq));
1561 EXPORT_SYMBOL(devm_devfreq_unregister_opp_notifier);
1564 * devfreq_register_notifier() - Register a driver with devfreq
1565 * @devfreq: The devfreq object.
1566 * @nb: The notifier block to register.
1567 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1569 int devfreq_register_notifier(struct devfreq *devfreq,
1570 struct notifier_block *nb,
1579 case DEVFREQ_TRANSITION_NOTIFIER:
1580 ret = srcu_notifier_chain_register(
1581 &devfreq->transition_notifier_list, nb);
1589 EXPORT_SYMBOL(devfreq_register_notifier);
1592 * devfreq_unregister_notifier() - Unregister a driver with devfreq
1593 * @devfreq: The devfreq object.
1594 * @nb: The notifier block to be unregistered.
1595 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1597 int devfreq_unregister_notifier(struct devfreq *devfreq,
1598 struct notifier_block *nb,
1607 case DEVFREQ_TRANSITION_NOTIFIER:
1608 ret = srcu_notifier_chain_unregister(
1609 &devfreq->transition_notifier_list, nb);
1617 EXPORT_SYMBOL(devfreq_unregister_notifier);
1619 struct devfreq_notifier_devres {
1620 struct devfreq *devfreq;
1621 struct notifier_block *nb;
1625 static void devm_devfreq_notifier_release(struct device *dev, void *res)
1627 struct devfreq_notifier_devres *this = res;
1629 devfreq_unregister_notifier(this->devfreq, this->nb, this->list);
1633 * devm_devfreq_register_notifier()
1634 - Resource-managed devfreq_register_notifier()
1635 * @dev: The devfreq user device. (parent of devfreq)
1636 * @devfreq: The devfreq object.
1637 * @nb: The notifier block to be unregistered.
1638 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1640 int devm_devfreq_register_notifier(struct device *dev,
1641 struct devfreq *devfreq,
1642 struct notifier_block *nb,
1645 struct devfreq_notifier_devres *ptr;
1648 ptr = devres_alloc(devm_devfreq_notifier_release, sizeof(*ptr),
1653 ret = devfreq_register_notifier(devfreq, nb, list);
1659 ptr->devfreq = devfreq;
1662 devres_add(dev, ptr);
1666 EXPORT_SYMBOL(devm_devfreq_register_notifier);
1669 * devm_devfreq_unregister_notifier()
1670 - Resource-managed devfreq_unregister_notifier()
1671 * @dev: The devfreq user device. (parent of devfreq)
1672 * @devfreq: The devfreq object.
1673 * @nb: The notifier block to be unregistered.
1674 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1676 void devm_devfreq_unregister_notifier(struct device *dev,
1677 struct devfreq *devfreq,
1678 struct notifier_block *nb,
1681 WARN_ON(devres_release(dev, devm_devfreq_notifier_release,
1682 devm_devfreq_dev_match, devfreq));
1684 EXPORT_SYMBOL(devm_devfreq_unregister_notifier);