1 // SPDX-License-Identifier: GPL-2.0-only
3 * devfreq: Generic Dynamic Voltage and Frequency Scaling (DVFS) Framework
6 * Copyright (C) 2011 Samsung Electronics
7 * MyungJoo Ham <myungjoo.ham@samsung.com>
10 #include <linux/kernel.h>
11 #include <linux/kmod.h>
12 #include <linux/sched.h>
13 #include <linux/errno.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/export.h>
17 #include <linux/slab.h>
18 #include <linux/stat.h>
19 #include <linux/pm_opp.h>
20 #include <linux/devfreq.h>
21 #include <linux/workqueue.h>
22 #include <linux/platform_device.h>
23 #include <linux/list.h>
24 #include <linux/printk.h>
25 #include <linux/hrtimer.h>
29 #define CREATE_TRACE_POINTS
30 #include <trace/events/devfreq.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;
163 lockdep_assert_held(&devfreq->lock);
166 /* Immediately exit if previous_freq is not initialized yet. */
167 if (!devfreq->previous_freq)
170 prev_lev = devfreq_get_freq_level(devfreq, devfreq->previous_freq);
176 devfreq->time_in_state[prev_lev] +=
177 cur_time - devfreq->last_stat_updated;
179 lev = devfreq_get_freq_level(devfreq, freq);
185 if (lev != prev_lev) {
186 devfreq->trans_table[(prev_lev *
187 devfreq->profile->max_state) + lev]++;
188 devfreq->total_trans++;
192 devfreq->last_stat_updated = cur_time;
195 EXPORT_SYMBOL(devfreq_update_status);
198 * find_devfreq_governor() - find devfreq governor from name
199 * @name: name of the governor
201 * Search the list of devfreq governors and return the matched
202 * governor's pointer. devfreq_list_lock should be held by the caller.
204 static struct devfreq_governor *find_devfreq_governor(const char *name)
206 struct devfreq_governor *tmp_governor;
208 if (IS_ERR_OR_NULL(name)) {
209 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
210 return ERR_PTR(-EINVAL);
212 WARN(!mutex_is_locked(&devfreq_list_lock),
213 "devfreq_list_lock must be locked.");
215 list_for_each_entry(tmp_governor, &devfreq_governor_list, node) {
216 if (!strncmp(tmp_governor->name, name, DEVFREQ_NAME_LEN))
220 return ERR_PTR(-ENODEV);
224 * try_then_request_governor() - Try to find the governor and request the
225 * module if is not found.
226 * @name: name of the governor
228 * Search the list of devfreq governors and request the module and try again
229 * if is not found. This can happen when both drivers (the governor driver
230 * and the driver that call devfreq_add_device) are built as modules.
231 * devfreq_list_lock should be held by the caller. Returns the matched
232 * governor's pointer or an error pointer.
234 static struct devfreq_governor *try_then_request_governor(const char *name)
236 struct devfreq_governor *governor;
239 if (IS_ERR_OR_NULL(name)) {
240 pr_err("DEVFREQ: %s: Invalid parameters\n", __func__);
241 return ERR_PTR(-EINVAL);
243 WARN(!mutex_is_locked(&devfreq_list_lock),
244 "devfreq_list_lock must be locked.");
246 governor = find_devfreq_governor(name);
247 if (IS_ERR(governor)) {
248 mutex_unlock(&devfreq_list_lock);
250 if (!strncmp(name, DEVFREQ_GOV_SIMPLE_ONDEMAND,
252 err = request_module("governor_%s", "simpleondemand");
254 err = request_module("governor_%s", name);
255 /* Restore previous state before return */
256 mutex_lock(&devfreq_list_lock);
258 return (err < 0) ? ERR_PTR(err) : ERR_PTR(-EINVAL);
260 governor = find_devfreq_governor(name);
266 static int devfreq_notify_transition(struct devfreq *devfreq,
267 struct devfreq_freqs *freqs, unsigned int state)
273 case DEVFREQ_PRECHANGE:
274 srcu_notifier_call_chain(&devfreq->transition_notifier_list,
275 DEVFREQ_PRECHANGE, freqs);
278 case DEVFREQ_POSTCHANGE:
279 srcu_notifier_call_chain(&devfreq->transition_notifier_list,
280 DEVFREQ_POSTCHANGE, freqs);
289 static int devfreq_set_target(struct devfreq *devfreq, unsigned long new_freq,
292 struct devfreq_freqs freqs;
293 unsigned long cur_freq;
296 if (devfreq->profile->get_cur_freq)
297 devfreq->profile->get_cur_freq(devfreq->dev.parent, &cur_freq);
299 cur_freq = devfreq->previous_freq;
301 freqs.old = cur_freq;
302 freqs.new = new_freq;
303 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_PRECHANGE);
305 err = devfreq->profile->target(devfreq->dev.parent, &new_freq, flags);
307 freqs.new = cur_freq;
308 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_POSTCHANGE);
312 freqs.new = new_freq;
313 devfreq_notify_transition(devfreq, &freqs, DEVFREQ_POSTCHANGE);
315 if (devfreq_update_status(devfreq, new_freq))
316 dev_err(&devfreq->dev,
317 "Couldn't update frequency transition information.\n");
319 devfreq->previous_freq = new_freq;
321 if (devfreq->suspend_freq)
322 devfreq->resume_freq = new_freq;
327 /* Load monitoring helper functions for governors use */
330 * update_devfreq() - Reevaluate the device and configure frequency.
331 * @devfreq: the devfreq instance.
333 * Note: Lock devfreq->lock before calling update_devfreq
334 * This function is exported for governors.
336 int update_devfreq(struct devfreq *devfreq)
338 unsigned long freq, min_freq, max_freq;
342 if (!mutex_is_locked(&devfreq->lock)) {
343 WARN(true, "devfreq->lock must be locked by the caller.\n");
347 if (!devfreq->governor)
350 /* Reevaluate the proper frequency */
351 err = devfreq->governor->get_target_freq(devfreq, &freq);
356 * Adjust the frequency with user freq, QoS and available freq.
358 * List from the highest priority
362 max_freq = min(devfreq->scaling_max_freq, devfreq->max_freq);
363 min_freq = max(devfreq->scaling_min_freq, devfreq->min_freq);
365 if (freq < min_freq) {
367 flags &= ~DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use GLB */
369 if (freq > max_freq) {
371 flags |= DEVFREQ_FLAG_LEAST_UPPER_BOUND; /* Use LUB */
374 return devfreq_set_target(devfreq, freq, flags);
377 EXPORT_SYMBOL(update_devfreq);
380 * devfreq_monitor() - Periodically poll devfreq objects.
381 * @work: the work struct used to run devfreq_monitor periodically.
384 static void devfreq_monitor(struct work_struct *work)
387 struct devfreq *devfreq = container_of(work,
388 struct devfreq, work.work);
390 mutex_lock(&devfreq->lock);
391 err = update_devfreq(devfreq);
393 dev_err(&devfreq->dev, "dvfs failed with (%d) error\n", err);
395 queue_delayed_work(devfreq_wq, &devfreq->work,
396 msecs_to_jiffies(devfreq->profile->polling_ms));
397 mutex_unlock(&devfreq->lock);
399 trace_devfreq_monitor(devfreq);
403 * devfreq_monitor_start() - Start load monitoring of devfreq instance
404 * @devfreq: the devfreq instance.
406 * Helper function for starting devfreq device load monitoring. By
407 * default delayed work based monitoring is supported. Function
408 * to be called from governor in response to DEVFREQ_GOV_START
409 * event when device is added to devfreq framework.
411 void devfreq_monitor_start(struct devfreq *devfreq)
413 INIT_DEFERRABLE_WORK(&devfreq->work, devfreq_monitor);
414 if (devfreq->profile->polling_ms)
415 queue_delayed_work(devfreq_wq, &devfreq->work,
416 msecs_to_jiffies(devfreq->profile->polling_ms));
418 EXPORT_SYMBOL(devfreq_monitor_start);
421 * devfreq_monitor_stop() - Stop load monitoring of a devfreq instance
422 * @devfreq: the devfreq instance.
424 * Helper function to stop devfreq device load monitoring. Function
425 * to be called from governor in response to DEVFREQ_GOV_STOP
426 * event when device is removed from devfreq framework.
428 void devfreq_monitor_stop(struct devfreq *devfreq)
430 cancel_delayed_work_sync(&devfreq->work);
432 EXPORT_SYMBOL(devfreq_monitor_stop);
435 * devfreq_monitor_suspend() - Suspend load monitoring of a devfreq instance
436 * @devfreq: the devfreq instance.
438 * Helper function to suspend devfreq device load monitoring. Function
439 * to be called from governor in response to DEVFREQ_GOV_SUSPEND
440 * event or when polling interval is set to zero.
442 * Note: Though this function is same as devfreq_monitor_stop(),
443 * intentionally kept separate to provide hooks for collecting
444 * transition statistics.
446 void devfreq_monitor_suspend(struct devfreq *devfreq)
448 mutex_lock(&devfreq->lock);
449 if (devfreq->stop_polling) {
450 mutex_unlock(&devfreq->lock);
454 devfreq_update_status(devfreq, devfreq->previous_freq);
455 devfreq->stop_polling = true;
456 mutex_unlock(&devfreq->lock);
457 cancel_delayed_work_sync(&devfreq->work);
459 EXPORT_SYMBOL(devfreq_monitor_suspend);
462 * devfreq_monitor_resume() - Resume load monitoring of a devfreq instance
463 * @devfreq: the devfreq instance.
465 * Helper function to resume devfreq device load monitoring. Function
466 * to be called from governor in response to DEVFREQ_GOV_RESUME
467 * event or when polling interval is set to non-zero.
469 void devfreq_monitor_resume(struct devfreq *devfreq)
473 mutex_lock(&devfreq->lock);
474 if (!devfreq->stop_polling)
477 if (!delayed_work_pending(&devfreq->work) &&
478 devfreq->profile->polling_ms)
479 queue_delayed_work(devfreq_wq, &devfreq->work,
480 msecs_to_jiffies(devfreq->profile->polling_ms));
482 devfreq->last_stat_updated = jiffies;
483 devfreq->stop_polling = false;
485 if (devfreq->profile->get_cur_freq &&
486 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
487 devfreq->previous_freq = freq;
490 mutex_unlock(&devfreq->lock);
492 EXPORT_SYMBOL(devfreq_monitor_resume);
495 * devfreq_interval_update() - Update device devfreq monitoring interval
496 * @devfreq: the devfreq instance.
497 * @delay: new polling interval to be set.
499 * Helper function to set new load monitoring polling interval. Function
500 * to be called from governor in response to DEVFREQ_GOV_INTERVAL event.
502 void devfreq_interval_update(struct devfreq *devfreq, unsigned int *delay)
504 unsigned int cur_delay = devfreq->profile->polling_ms;
505 unsigned int new_delay = *delay;
507 mutex_lock(&devfreq->lock);
508 devfreq->profile->polling_ms = new_delay;
510 if (devfreq->stop_polling)
513 /* if new delay is zero, stop polling */
515 mutex_unlock(&devfreq->lock);
516 cancel_delayed_work_sync(&devfreq->work);
520 /* if current delay is zero, start polling with new delay */
522 queue_delayed_work(devfreq_wq, &devfreq->work,
523 msecs_to_jiffies(devfreq->profile->polling_ms));
527 /* if current delay is greater than new delay, restart polling */
528 if (cur_delay > new_delay) {
529 mutex_unlock(&devfreq->lock);
530 cancel_delayed_work_sync(&devfreq->work);
531 mutex_lock(&devfreq->lock);
532 if (!devfreq->stop_polling)
533 queue_delayed_work(devfreq_wq, &devfreq->work,
534 msecs_to_jiffies(devfreq->profile->polling_ms));
537 mutex_unlock(&devfreq->lock);
539 EXPORT_SYMBOL(devfreq_interval_update);
542 * devfreq_notifier_call() - Notify that the device frequency requirements
543 * has been changed out of devfreq framework.
544 * @nb: the notifier_block (supposed to be devfreq->nb)
548 * Called by a notifier that uses devfreq->nb.
550 static int devfreq_notifier_call(struct notifier_block *nb, unsigned long type,
553 struct devfreq *devfreq = container_of(nb, struct devfreq, nb);
556 mutex_lock(&devfreq->lock);
558 devfreq->scaling_min_freq = find_available_min_freq(devfreq);
559 if (!devfreq->scaling_min_freq)
562 devfreq->scaling_max_freq = find_available_max_freq(devfreq);
563 if (!devfreq->scaling_max_freq) {
564 devfreq->scaling_max_freq = ULONG_MAX;
568 err = update_devfreq(devfreq);
571 mutex_unlock(&devfreq->lock);
573 dev_err(devfreq->dev.parent,
574 "failed to update frequency from OPP notifier (%d)\n",
581 * devfreq_dev_release() - Callback for struct device to release the device.
582 * @dev: the devfreq device
584 * Remove devfreq from the list and release its resources.
586 static void devfreq_dev_release(struct device *dev)
588 struct devfreq *devfreq = to_devfreq(dev);
590 mutex_lock(&devfreq_list_lock);
591 list_del(&devfreq->node);
592 mutex_unlock(&devfreq_list_lock);
594 if (devfreq->profile->exit)
595 devfreq->profile->exit(devfreq->dev.parent);
597 mutex_destroy(&devfreq->lock);
602 * devfreq_add_device() - Add devfreq feature to the device
603 * @dev: the device to add devfreq feature.
604 * @profile: device-specific profile to run devfreq.
605 * @governor_name: name of the policy to choose frequency.
606 * @data: private data for the governor. The devfreq framework does not
609 struct devfreq *devfreq_add_device(struct device *dev,
610 struct devfreq_dev_profile *profile,
611 const char *governor_name,
614 struct devfreq *devfreq;
615 struct devfreq_governor *governor;
618 if (!dev || !profile || !governor_name) {
619 dev_err(dev, "%s: Invalid parameters.\n", __func__);
620 return ERR_PTR(-EINVAL);
623 mutex_lock(&devfreq_list_lock);
624 devfreq = find_device_devfreq(dev);
625 mutex_unlock(&devfreq_list_lock);
626 if (!IS_ERR(devfreq)) {
627 dev_err(dev, "%s: Unable to create devfreq for the device.\n",
633 devfreq = kzalloc(sizeof(struct devfreq), GFP_KERNEL);
639 mutex_init(&devfreq->lock);
640 mutex_lock(&devfreq->lock);
641 devfreq->dev.parent = dev;
642 devfreq->dev.class = devfreq_class;
643 devfreq->dev.release = devfreq_dev_release;
644 INIT_LIST_HEAD(&devfreq->node);
645 devfreq->profile = profile;
646 strncpy(devfreq->governor_name, governor_name, DEVFREQ_NAME_LEN);
647 devfreq->previous_freq = profile->initial_freq;
648 devfreq->last_status.current_frequency = profile->initial_freq;
649 devfreq->data = data;
650 devfreq->nb.notifier_call = devfreq_notifier_call;
652 if (!devfreq->profile->max_state && !devfreq->profile->freq_table) {
653 mutex_unlock(&devfreq->lock);
654 err = set_freq_table(devfreq);
657 mutex_lock(&devfreq->lock);
660 devfreq->scaling_min_freq = find_available_min_freq(devfreq);
661 if (!devfreq->scaling_min_freq) {
662 mutex_unlock(&devfreq->lock);
666 devfreq->min_freq = devfreq->scaling_min_freq;
668 devfreq->scaling_max_freq = find_available_max_freq(devfreq);
669 if (!devfreq->scaling_max_freq) {
670 mutex_unlock(&devfreq->lock);
674 devfreq->max_freq = devfreq->scaling_max_freq;
676 devfreq->suspend_freq = dev_pm_opp_get_suspend_opp_freq(dev);
677 atomic_set(&devfreq->suspend_count, 0);
679 dev_set_name(&devfreq->dev, "%s", dev_name(dev));
680 err = device_register(&devfreq->dev);
682 mutex_unlock(&devfreq->lock);
683 put_device(&devfreq->dev);
687 devfreq->trans_table = devm_kzalloc(&devfreq->dev,
688 array3_size(sizeof(unsigned int),
689 devfreq->profile->max_state,
690 devfreq->profile->max_state),
692 if (!devfreq->trans_table) {
693 mutex_unlock(&devfreq->lock);
698 devfreq->time_in_state = devm_kcalloc(&devfreq->dev,
699 devfreq->profile->max_state,
700 sizeof(unsigned long),
702 if (!devfreq->time_in_state) {
703 mutex_unlock(&devfreq->lock);
708 devfreq->last_stat_updated = jiffies;
710 srcu_init_notifier_head(&devfreq->transition_notifier_list);
712 mutex_unlock(&devfreq->lock);
714 mutex_lock(&devfreq_list_lock);
716 governor = try_then_request_governor(devfreq->governor_name);
717 if (IS_ERR(governor)) {
718 dev_err(dev, "%s: Unable to find governor for the device\n",
720 err = PTR_ERR(governor);
724 devfreq->governor = governor;
725 err = devfreq->governor->event_handler(devfreq, DEVFREQ_GOV_START,
728 dev_err(dev, "%s: Unable to start governor for the device\n",
733 list_add(&devfreq->node, &devfreq_list);
735 mutex_unlock(&devfreq_list_lock);
740 mutex_unlock(&devfreq_list_lock);
742 devfreq_remove_device(devfreq);
749 EXPORT_SYMBOL(devfreq_add_device);
752 * devfreq_remove_device() - Remove devfreq feature from a device.
753 * @devfreq: the devfreq instance to be removed
755 * The opposite of devfreq_add_device().
757 int devfreq_remove_device(struct devfreq *devfreq)
762 if (devfreq->governor)
763 devfreq->governor->event_handler(devfreq,
764 DEVFREQ_GOV_STOP, NULL);
765 device_unregister(&devfreq->dev);
769 EXPORT_SYMBOL(devfreq_remove_device);
771 static int devm_devfreq_dev_match(struct device *dev, void *res, void *data)
773 struct devfreq **r = res;
775 if (WARN_ON(!r || !*r))
781 static void devm_devfreq_dev_release(struct device *dev, void *res)
783 devfreq_remove_device(*(struct devfreq **)res);
787 * devm_devfreq_add_device() - Resource-managed devfreq_add_device()
788 * @dev: the device to add devfreq feature.
789 * @profile: device-specific profile to run devfreq.
790 * @governor_name: name of the policy to choose frequency.
791 * @data: private data for the governor. The devfreq framework does not
794 * This function manages automatically the memory of devfreq device using device
795 * resource management and simplify the free operation for memory of devfreq
798 struct devfreq *devm_devfreq_add_device(struct device *dev,
799 struct devfreq_dev_profile *profile,
800 const char *governor_name,
803 struct devfreq **ptr, *devfreq;
805 ptr = devres_alloc(devm_devfreq_dev_release, sizeof(*ptr), GFP_KERNEL);
807 return ERR_PTR(-ENOMEM);
809 devfreq = devfreq_add_device(dev, profile, governor_name, data);
810 if (IS_ERR(devfreq)) {
816 devres_add(dev, ptr);
820 EXPORT_SYMBOL(devm_devfreq_add_device);
824 * devfreq_get_devfreq_by_phandle - Get the devfreq device from devicetree
825 * @dev - instance to the given device
826 * @index - index into list of devfreq
828 * return the instance of devfreq device
830 struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
832 struct device_node *node;
833 struct devfreq *devfreq;
836 return ERR_PTR(-EINVAL);
839 return ERR_PTR(-EINVAL);
841 node = of_parse_phandle(dev->of_node, "devfreq", index);
843 return ERR_PTR(-ENODEV);
845 mutex_lock(&devfreq_list_lock);
846 list_for_each_entry(devfreq, &devfreq_list, node) {
847 if (devfreq->dev.parent
848 && devfreq->dev.parent->of_node == node) {
849 mutex_unlock(&devfreq_list_lock);
854 mutex_unlock(&devfreq_list_lock);
857 return ERR_PTR(-EPROBE_DEFER);
860 struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
862 return ERR_PTR(-ENODEV);
864 #endif /* CONFIG_OF */
865 EXPORT_SYMBOL_GPL(devfreq_get_devfreq_by_phandle);
868 * devm_devfreq_remove_device() - Resource-managed devfreq_remove_device()
869 * @dev: the device from which to remove devfreq feature.
870 * @devfreq: the devfreq instance to be removed
872 void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq)
874 WARN_ON(devres_release(dev, devm_devfreq_dev_release,
875 devm_devfreq_dev_match, devfreq));
877 EXPORT_SYMBOL(devm_devfreq_remove_device);
880 * devfreq_suspend_device() - Suspend devfreq of a device.
881 * @devfreq: the devfreq instance to be suspended
883 * This function is intended to be called by the pm callbacks
884 * (e.g., runtime_suspend, suspend) of the device driver that
887 int devfreq_suspend_device(struct devfreq *devfreq)
894 if (atomic_inc_return(&devfreq->suspend_count) > 1)
897 if (devfreq->governor) {
898 ret = devfreq->governor->event_handler(devfreq,
899 DEVFREQ_GOV_SUSPEND, NULL);
904 if (devfreq->suspend_freq) {
905 mutex_lock(&devfreq->lock);
906 ret = devfreq_set_target(devfreq, devfreq->suspend_freq, 0);
907 mutex_unlock(&devfreq->lock);
914 EXPORT_SYMBOL(devfreq_suspend_device);
917 * devfreq_resume_device() - Resume devfreq of a device.
918 * @devfreq: the devfreq instance to be resumed
920 * This function is intended to be called by the pm callbacks
921 * (e.g., runtime_resume, resume) of the device driver that
924 int devfreq_resume_device(struct devfreq *devfreq)
931 if (atomic_dec_return(&devfreq->suspend_count) >= 1)
934 if (devfreq->resume_freq) {
935 mutex_lock(&devfreq->lock);
936 ret = devfreq_set_target(devfreq, devfreq->resume_freq, 0);
937 mutex_unlock(&devfreq->lock);
942 if (devfreq->governor) {
943 ret = devfreq->governor->event_handler(devfreq,
944 DEVFREQ_GOV_RESUME, NULL);
951 EXPORT_SYMBOL(devfreq_resume_device);
954 * devfreq_suspend() - Suspend devfreq governors and devices
956 * Called during system wide Suspend/Hibernate cycles for suspending governors
957 * and devices preserving the state for resume. On some platforms the devfreq
958 * device must have precise state (frequency) after resume in order to provide
959 * fully operating setup.
961 void devfreq_suspend(void)
963 struct devfreq *devfreq;
966 mutex_lock(&devfreq_list_lock);
967 list_for_each_entry(devfreq, &devfreq_list, node) {
968 ret = devfreq_suspend_device(devfreq);
970 dev_err(&devfreq->dev,
971 "failed to suspend devfreq device\n");
973 mutex_unlock(&devfreq_list_lock);
977 * devfreq_resume() - Resume devfreq governors and devices
979 * Called during system wide Suspend/Hibernate cycle for resuming governors and
980 * devices that are suspended with devfreq_suspend().
982 void devfreq_resume(void)
984 struct devfreq *devfreq;
987 mutex_lock(&devfreq_list_lock);
988 list_for_each_entry(devfreq, &devfreq_list, node) {
989 ret = devfreq_resume_device(devfreq);
991 dev_warn(&devfreq->dev,
992 "failed to resume devfreq device\n");
994 mutex_unlock(&devfreq_list_lock);
998 * devfreq_add_governor() - Add devfreq governor
999 * @governor: the devfreq governor to be added
1001 int devfreq_add_governor(struct devfreq_governor *governor)
1003 struct devfreq_governor *g;
1004 struct devfreq *devfreq;
1008 pr_err("%s: Invalid parameters.\n", __func__);
1012 mutex_lock(&devfreq_list_lock);
1013 g = find_devfreq_governor(governor->name);
1015 pr_err("%s: governor %s already registered\n", __func__,
1021 list_add(&governor->node, &devfreq_governor_list);
1023 list_for_each_entry(devfreq, &devfreq_list, node) {
1025 struct device *dev = devfreq->dev.parent;
1027 if (!strncmp(devfreq->governor_name, governor->name,
1028 DEVFREQ_NAME_LEN)) {
1029 /* The following should never occur */
1030 if (devfreq->governor) {
1032 "%s: Governor %s already present\n",
1033 __func__, devfreq->governor->name);
1034 ret = devfreq->governor->event_handler(devfreq,
1035 DEVFREQ_GOV_STOP, NULL);
1038 "%s: Governor %s stop = %d\n",
1040 devfreq->governor->name, ret);
1044 devfreq->governor = governor;
1045 ret = devfreq->governor->event_handler(devfreq,
1046 DEVFREQ_GOV_START, NULL);
1048 dev_warn(dev, "%s: Governor %s start=%d\n",
1049 __func__, devfreq->governor->name,
1056 mutex_unlock(&devfreq_list_lock);
1060 EXPORT_SYMBOL(devfreq_add_governor);
1063 * devfreq_remove_governor() - Remove devfreq feature from a device.
1064 * @governor: the devfreq governor to be removed
1066 int devfreq_remove_governor(struct devfreq_governor *governor)
1068 struct devfreq_governor *g;
1069 struct devfreq *devfreq;
1073 pr_err("%s: Invalid parameters.\n", __func__);
1077 mutex_lock(&devfreq_list_lock);
1078 g = find_devfreq_governor(governor->name);
1080 pr_err("%s: governor %s not registered\n", __func__,
1085 list_for_each_entry(devfreq, &devfreq_list, node) {
1087 struct device *dev = devfreq->dev.parent;
1089 if (!strncmp(devfreq->governor_name, governor->name,
1090 DEVFREQ_NAME_LEN)) {
1091 /* we should have a devfreq governor! */
1092 if (!devfreq->governor) {
1093 dev_warn(dev, "%s: Governor %s NOT present\n",
1094 __func__, governor->name);
1098 ret = devfreq->governor->event_handler(devfreq,
1099 DEVFREQ_GOV_STOP, NULL);
1101 dev_warn(dev, "%s: Governor %s stop=%d\n",
1102 __func__, devfreq->governor->name,
1105 devfreq->governor = NULL;
1109 list_del(&governor->node);
1111 mutex_unlock(&devfreq_list_lock);
1115 EXPORT_SYMBOL(devfreq_remove_governor);
1117 static ssize_t name_show(struct device *dev,
1118 struct device_attribute *attr, char *buf)
1120 struct devfreq *devfreq = to_devfreq(dev);
1121 return sprintf(buf, "%s\n", dev_name(devfreq->dev.parent));
1123 static DEVICE_ATTR_RO(name);
1125 static ssize_t governor_show(struct device *dev,
1126 struct device_attribute *attr, char *buf)
1128 if (!to_devfreq(dev)->governor)
1131 return sprintf(buf, "%s\n", to_devfreq(dev)->governor->name);
1134 static ssize_t governor_store(struct device *dev, struct device_attribute *attr,
1135 const char *buf, size_t count)
1137 struct devfreq *df = to_devfreq(dev);
1139 char str_governor[DEVFREQ_NAME_LEN + 1];
1140 const struct devfreq_governor *governor, *prev_governor;
1142 ret = sscanf(buf, "%" __stringify(DEVFREQ_NAME_LEN) "s", str_governor);
1146 mutex_lock(&devfreq_list_lock);
1147 governor = try_then_request_governor(str_governor);
1148 if (IS_ERR(governor)) {
1149 ret = PTR_ERR(governor);
1152 if (df->governor == governor) {
1155 } else if ((df->governor && df->governor->immutable) ||
1156 governor->immutable) {
1162 ret = df->governor->event_handler(df, DEVFREQ_GOV_STOP, NULL);
1164 dev_warn(dev, "%s: Governor %s not stopped(%d)\n",
1165 __func__, df->governor->name, ret);
1169 prev_governor = df->governor;
1170 df->governor = governor;
1171 strncpy(df->governor_name, governor->name, DEVFREQ_NAME_LEN);
1172 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
1174 dev_warn(dev, "%s: Governor %s not started(%d)\n",
1175 __func__, df->governor->name, ret);
1176 df->governor = prev_governor;
1177 strncpy(df->governor_name, prev_governor->name,
1179 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
1182 "%s: reverting to Governor %s failed (%d)\n",
1183 __func__, df->governor_name, ret);
1184 df->governor = NULL;
1188 mutex_unlock(&devfreq_list_lock);
1194 static DEVICE_ATTR_RW(governor);
1196 static ssize_t available_governors_show(struct device *d,
1197 struct device_attribute *attr,
1200 struct devfreq *df = to_devfreq(d);
1203 mutex_lock(&devfreq_list_lock);
1206 * The devfreq with immutable governor (e.g., passive) shows
1207 * only own governor.
1209 if (df->governor && df->governor->immutable) {
1210 count = scnprintf(&buf[count], DEVFREQ_NAME_LEN,
1211 "%s ", df->governor_name);
1213 * The devfreq device shows the registered governor except for
1214 * immutable governors such as passive governor .
1217 struct devfreq_governor *governor;
1219 list_for_each_entry(governor, &devfreq_governor_list, node) {
1220 if (governor->immutable)
1222 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1223 "%s ", governor->name);
1227 mutex_unlock(&devfreq_list_lock);
1229 /* Truncate the trailing space */
1233 count += sprintf(&buf[count], "\n");
1237 static DEVICE_ATTR_RO(available_governors);
1239 static ssize_t cur_freq_show(struct device *dev, struct device_attribute *attr,
1243 struct devfreq *devfreq = to_devfreq(dev);
1245 if (devfreq->profile->get_cur_freq &&
1246 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
1247 return sprintf(buf, "%lu\n", freq);
1249 return sprintf(buf, "%lu\n", devfreq->previous_freq);
1251 static DEVICE_ATTR_RO(cur_freq);
1253 static ssize_t target_freq_show(struct device *dev,
1254 struct device_attribute *attr, char *buf)
1256 return sprintf(buf, "%lu\n", to_devfreq(dev)->previous_freq);
1258 static DEVICE_ATTR_RO(target_freq);
1260 static ssize_t polling_interval_show(struct device *dev,
1261 struct device_attribute *attr, char *buf)
1263 return sprintf(buf, "%d\n", to_devfreq(dev)->profile->polling_ms);
1266 static ssize_t polling_interval_store(struct device *dev,
1267 struct device_attribute *attr,
1268 const char *buf, size_t count)
1270 struct devfreq *df = to_devfreq(dev);
1277 ret = sscanf(buf, "%u", &value);
1281 df->governor->event_handler(df, DEVFREQ_GOV_INTERVAL, &value);
1286 static DEVICE_ATTR_RW(polling_interval);
1288 static ssize_t min_freq_store(struct device *dev, struct device_attribute *attr,
1289 const char *buf, size_t count)
1291 struct devfreq *df = to_devfreq(dev);
1292 unsigned long value;
1295 ret = sscanf(buf, "%lu", &value);
1299 mutex_lock(&df->lock);
1302 if (value > df->max_freq) {
1307 unsigned long *freq_table = df->profile->freq_table;
1309 /* Get minimum frequency according to sorting order */
1310 if (freq_table[0] < freq_table[df->profile->max_state - 1])
1311 value = freq_table[0];
1313 value = freq_table[df->profile->max_state - 1];
1316 df->min_freq = value;
1320 mutex_unlock(&df->lock);
1324 static ssize_t min_freq_show(struct device *dev, struct device_attribute *attr,
1327 struct devfreq *df = to_devfreq(dev);
1329 return sprintf(buf, "%lu\n", max(df->scaling_min_freq, df->min_freq));
1332 static ssize_t max_freq_store(struct device *dev, struct device_attribute *attr,
1333 const char *buf, size_t count)
1335 struct devfreq *df = to_devfreq(dev);
1336 unsigned long value;
1339 ret = sscanf(buf, "%lu", &value);
1343 mutex_lock(&df->lock);
1346 if (value < df->min_freq) {
1351 unsigned long *freq_table = df->profile->freq_table;
1353 /* Get maximum frequency according to sorting order */
1354 if (freq_table[0] < freq_table[df->profile->max_state - 1])
1355 value = freq_table[df->profile->max_state - 1];
1357 value = freq_table[0];
1360 df->max_freq = value;
1364 mutex_unlock(&df->lock);
1367 static DEVICE_ATTR_RW(min_freq);
1369 static ssize_t max_freq_show(struct device *dev, struct device_attribute *attr,
1372 struct devfreq *df = to_devfreq(dev);
1374 return sprintf(buf, "%lu\n", min(df->scaling_max_freq, df->max_freq));
1376 static DEVICE_ATTR_RW(max_freq);
1378 static ssize_t available_frequencies_show(struct device *d,
1379 struct device_attribute *attr,
1382 struct devfreq *df = to_devfreq(d);
1386 mutex_lock(&df->lock);
1388 for (i = 0; i < df->profile->max_state; i++)
1389 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1390 "%lu ", df->profile->freq_table[i]);
1392 mutex_unlock(&df->lock);
1393 /* Truncate the trailing space */
1397 count += sprintf(&buf[count], "\n");
1401 static DEVICE_ATTR_RO(available_frequencies);
1403 static ssize_t trans_stat_show(struct device *dev,
1404 struct device_attribute *attr, char *buf)
1406 struct devfreq *devfreq = to_devfreq(dev);
1409 unsigned int max_state = devfreq->profile->max_state;
1412 return sprintf(buf, "Not Supported.\n");
1414 mutex_lock(&devfreq->lock);
1415 if (!devfreq->stop_polling &&
1416 devfreq_update_status(devfreq, devfreq->previous_freq)) {
1417 mutex_unlock(&devfreq->lock);
1420 mutex_unlock(&devfreq->lock);
1422 len = sprintf(buf, " From : To\n");
1423 len += sprintf(buf + len, " :");
1424 for (i = 0; i < max_state; i++)
1425 len += sprintf(buf + len, "%10lu",
1426 devfreq->profile->freq_table[i]);
1428 len += sprintf(buf + len, " time(ms)\n");
1430 for (i = 0; i < max_state; i++) {
1431 if (devfreq->profile->freq_table[i]
1432 == devfreq->previous_freq) {
1433 len += sprintf(buf + len, "*");
1435 len += sprintf(buf + len, " ");
1437 len += sprintf(buf + len, "%10lu:",
1438 devfreq->profile->freq_table[i]);
1439 for (j = 0; j < max_state; j++)
1440 len += sprintf(buf + len, "%10u",
1441 devfreq->trans_table[(i * max_state) + j]);
1442 len += sprintf(buf + len, "%10u\n",
1443 jiffies_to_msecs(devfreq->time_in_state[i]));
1446 len += sprintf(buf + len, "Total transition : %u\n",
1447 devfreq->total_trans);
1450 static DEVICE_ATTR_RO(trans_stat);
1452 static struct attribute *devfreq_attrs[] = {
1453 &dev_attr_name.attr,
1454 &dev_attr_governor.attr,
1455 &dev_attr_available_governors.attr,
1456 &dev_attr_cur_freq.attr,
1457 &dev_attr_available_frequencies.attr,
1458 &dev_attr_target_freq.attr,
1459 &dev_attr_polling_interval.attr,
1460 &dev_attr_min_freq.attr,
1461 &dev_attr_max_freq.attr,
1462 &dev_attr_trans_stat.attr,
1465 ATTRIBUTE_GROUPS(devfreq);
1467 static int __init devfreq_init(void)
1469 devfreq_class = class_create(THIS_MODULE, "devfreq");
1470 if (IS_ERR(devfreq_class)) {
1471 pr_err("%s: couldn't create class\n", __FILE__);
1472 return PTR_ERR(devfreq_class);
1475 devfreq_wq = create_freezable_workqueue("devfreq_wq");
1477 class_destroy(devfreq_class);
1478 pr_err("%s: couldn't create workqueue\n", __FILE__);
1481 devfreq_class->dev_groups = devfreq_groups;
1485 subsys_initcall(devfreq_init);
1488 * The following are helper functions for devfreq user device drivers with
1493 * devfreq_recommended_opp() - Helper function to get proper OPP for the
1494 * freq value given to target callback.
1495 * @dev: The devfreq user device. (parent of devfreq)
1496 * @freq: The frequency given to target function
1497 * @flags: Flags handed from devfreq framework.
1499 * The callers are required to call dev_pm_opp_put() for the returned OPP after
1502 struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
1503 unsigned long *freq,
1506 struct dev_pm_opp *opp;
1508 if (flags & DEVFREQ_FLAG_LEAST_UPPER_BOUND) {
1509 /* The freq is an upper bound. opp should be lower */
1510 opp = dev_pm_opp_find_freq_floor(dev, freq);
1512 /* If not available, use the closest opp */
1513 if (opp == ERR_PTR(-ERANGE))
1514 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1516 /* The freq is an lower bound. opp should be higher */
1517 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1519 /* If not available, use the closest opp */
1520 if (opp == ERR_PTR(-ERANGE))
1521 opp = dev_pm_opp_find_freq_floor(dev, freq);
1526 EXPORT_SYMBOL(devfreq_recommended_opp);
1529 * devfreq_register_opp_notifier() - Helper function to get devfreq notified
1530 * for any changes in the OPP availability
1532 * @dev: The devfreq user device. (parent of devfreq)
1533 * @devfreq: The devfreq object.
1535 int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
1537 return dev_pm_opp_register_notifier(dev, &devfreq->nb);
1539 EXPORT_SYMBOL(devfreq_register_opp_notifier);
1542 * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
1543 * notified for any changes in the OPP
1544 * availability changes anymore.
1545 * @dev: The devfreq user device. (parent of devfreq)
1546 * @devfreq: The devfreq object.
1548 * At exit() callback of devfreq_dev_profile, this must be included if
1549 * devfreq_recommended_opp is used.
1551 int devfreq_unregister_opp_notifier(struct device *dev, struct devfreq *devfreq)
1553 return dev_pm_opp_unregister_notifier(dev, &devfreq->nb);
1555 EXPORT_SYMBOL(devfreq_unregister_opp_notifier);
1557 static void devm_devfreq_opp_release(struct device *dev, void *res)
1559 devfreq_unregister_opp_notifier(dev, *(struct devfreq **)res);
1563 * devm_devfreq_register_opp_notifier() - Resource-managed
1564 * devfreq_register_opp_notifier()
1565 * @dev: The devfreq user device. (parent of devfreq)
1566 * @devfreq: The devfreq object.
1568 int devm_devfreq_register_opp_notifier(struct device *dev,
1569 struct devfreq *devfreq)
1571 struct devfreq **ptr;
1574 ptr = devres_alloc(devm_devfreq_opp_release, sizeof(*ptr), GFP_KERNEL);
1578 ret = devfreq_register_opp_notifier(dev, devfreq);
1585 devres_add(dev, ptr);
1589 EXPORT_SYMBOL(devm_devfreq_register_opp_notifier);
1592 * devm_devfreq_unregister_opp_notifier() - Resource-managed
1593 * devfreq_unregister_opp_notifier()
1594 * @dev: The devfreq user device. (parent of devfreq)
1595 * @devfreq: The devfreq object.
1597 void devm_devfreq_unregister_opp_notifier(struct device *dev,
1598 struct devfreq *devfreq)
1600 WARN_ON(devres_release(dev, devm_devfreq_opp_release,
1601 devm_devfreq_dev_match, devfreq));
1603 EXPORT_SYMBOL(devm_devfreq_unregister_opp_notifier);
1606 * devfreq_register_notifier() - Register a driver with devfreq
1607 * @devfreq: The devfreq object.
1608 * @nb: The notifier block to register.
1609 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1611 int devfreq_register_notifier(struct devfreq *devfreq,
1612 struct notifier_block *nb,
1621 case DEVFREQ_TRANSITION_NOTIFIER:
1622 ret = srcu_notifier_chain_register(
1623 &devfreq->transition_notifier_list, nb);
1631 EXPORT_SYMBOL(devfreq_register_notifier);
1634 * devfreq_unregister_notifier() - Unregister a driver with devfreq
1635 * @devfreq: The devfreq object.
1636 * @nb: The notifier block to be unregistered.
1637 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1639 int devfreq_unregister_notifier(struct devfreq *devfreq,
1640 struct notifier_block *nb,
1649 case DEVFREQ_TRANSITION_NOTIFIER:
1650 ret = srcu_notifier_chain_unregister(
1651 &devfreq->transition_notifier_list, nb);
1659 EXPORT_SYMBOL(devfreq_unregister_notifier);
1661 struct devfreq_notifier_devres {
1662 struct devfreq *devfreq;
1663 struct notifier_block *nb;
1667 static void devm_devfreq_notifier_release(struct device *dev, void *res)
1669 struct devfreq_notifier_devres *this = res;
1671 devfreq_unregister_notifier(this->devfreq, this->nb, this->list);
1675 * devm_devfreq_register_notifier()
1676 - Resource-managed devfreq_register_notifier()
1677 * @dev: The devfreq user device. (parent of devfreq)
1678 * @devfreq: The devfreq object.
1679 * @nb: The notifier block to be unregistered.
1680 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1682 int devm_devfreq_register_notifier(struct device *dev,
1683 struct devfreq *devfreq,
1684 struct notifier_block *nb,
1687 struct devfreq_notifier_devres *ptr;
1690 ptr = devres_alloc(devm_devfreq_notifier_release, sizeof(*ptr),
1695 ret = devfreq_register_notifier(devfreq, nb, list);
1701 ptr->devfreq = devfreq;
1704 devres_add(dev, ptr);
1708 EXPORT_SYMBOL(devm_devfreq_register_notifier);
1711 * devm_devfreq_unregister_notifier()
1712 - Resource-managed devfreq_unregister_notifier()
1713 * @dev: The devfreq user device. (parent of devfreq)
1714 * @devfreq: The devfreq object.
1715 * @nb: The notifier block to be unregistered.
1716 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1718 void devm_devfreq_unregister_notifier(struct device *dev,
1719 struct devfreq *devfreq,
1720 struct notifier_block *nb,
1723 WARN_ON(devres_release(dev, devm_devfreq_notifier_release,
1724 devm_devfreq_dev_match, devfreq));
1726 EXPORT_SYMBOL(devm_devfreq_unregister_notifier);