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 = cur_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) {
560 mutex_unlock(&devfreq->lock);
564 devfreq->scaling_max_freq = find_available_max_freq(devfreq);
565 if (!devfreq->scaling_max_freq) {
566 mutex_unlock(&devfreq->lock);
570 ret = update_devfreq(devfreq);
571 mutex_unlock(&devfreq->lock);
577 * devfreq_dev_release() - Callback for struct device to release the device.
578 * @dev: the devfreq device
580 * Remove devfreq from the list and release its resources.
582 static void devfreq_dev_release(struct device *dev)
584 struct devfreq *devfreq = to_devfreq(dev);
586 mutex_lock(&devfreq_list_lock);
587 if (IS_ERR(find_device_devfreq(devfreq->dev.parent))) {
588 mutex_unlock(&devfreq_list_lock);
589 dev_warn(&devfreq->dev, "releasing devfreq which doesn't exist\n");
592 list_del(&devfreq->node);
593 mutex_unlock(&devfreq_list_lock);
595 if (devfreq->profile->exit)
596 devfreq->profile->exit(devfreq->dev.parent);
598 mutex_destroy(&devfreq->lock);
603 * devfreq_add_device() - Add devfreq feature to the device
604 * @dev: the device to add devfreq feature.
605 * @profile: device-specific profile to run devfreq.
606 * @governor_name: name of the policy to choose frequency.
607 * @data: private data for the governor. The devfreq framework does not
610 struct devfreq *devfreq_add_device(struct device *dev,
611 struct devfreq_dev_profile *profile,
612 const char *governor_name,
615 struct devfreq *devfreq;
616 struct devfreq_governor *governor;
617 static atomic_t devfreq_no = ATOMIC_INIT(-1);
620 if (!dev || !profile || !governor_name) {
621 dev_err(dev, "%s: Invalid parameters.\n", __func__);
622 return ERR_PTR(-EINVAL);
625 mutex_lock(&devfreq_list_lock);
626 devfreq = find_device_devfreq(dev);
627 mutex_unlock(&devfreq_list_lock);
628 if (!IS_ERR(devfreq)) {
629 dev_err(dev, "%s: devfreq device already exists!\n",
635 devfreq = kzalloc(sizeof(struct devfreq), GFP_KERNEL);
641 mutex_init(&devfreq->lock);
642 mutex_lock(&devfreq->lock);
643 devfreq->dev.parent = dev;
644 devfreq->dev.class = devfreq_class;
645 devfreq->dev.release = devfreq_dev_release;
646 devfreq->profile = profile;
647 strncpy(devfreq->governor_name, governor_name, DEVFREQ_NAME_LEN);
648 devfreq->previous_freq = profile->initial_freq;
649 devfreq->last_status.current_frequency = profile->initial_freq;
650 devfreq->data = data;
651 devfreq->nb.notifier_call = devfreq_notifier_call;
653 if (!devfreq->profile->max_state && !devfreq->profile->freq_table) {
654 mutex_unlock(&devfreq->lock);
655 err = set_freq_table(devfreq);
658 mutex_lock(&devfreq->lock);
661 devfreq->scaling_min_freq = find_available_min_freq(devfreq);
662 if (!devfreq->scaling_min_freq) {
663 mutex_unlock(&devfreq->lock);
667 devfreq->min_freq = devfreq->scaling_min_freq;
669 devfreq->scaling_max_freq = find_available_max_freq(devfreq);
670 if (!devfreq->scaling_max_freq) {
671 mutex_unlock(&devfreq->lock);
675 devfreq->max_freq = devfreq->scaling_max_freq;
677 devfreq->suspend_freq = dev_pm_opp_get_suspend_opp_freq(dev);
678 atomic_set(&devfreq->suspend_count, 0);
680 dev_set_name(&devfreq->dev, "devfreq%d",
681 atomic_inc_return(&devfreq_no));
682 err = device_register(&devfreq->dev);
684 mutex_unlock(&devfreq->lock);
685 put_device(&devfreq->dev);
689 devfreq->trans_table = devm_kzalloc(&devfreq->dev,
690 array3_size(sizeof(unsigned int),
691 devfreq->profile->max_state,
692 devfreq->profile->max_state),
694 if (!devfreq->trans_table) {
695 mutex_unlock(&devfreq->lock);
700 devfreq->time_in_state = devm_kcalloc(&devfreq->dev,
701 devfreq->profile->max_state,
702 sizeof(unsigned long),
704 if (!devfreq->time_in_state) {
705 mutex_unlock(&devfreq->lock);
710 devfreq->last_stat_updated = jiffies;
712 srcu_init_notifier_head(&devfreq->transition_notifier_list);
714 mutex_unlock(&devfreq->lock);
716 mutex_lock(&devfreq_list_lock);
718 governor = try_then_request_governor(devfreq->governor_name);
719 if (IS_ERR(governor)) {
720 dev_err(dev, "%s: Unable to find governor for the device\n",
722 err = PTR_ERR(governor);
726 devfreq->governor = governor;
727 err = devfreq->governor->event_handler(devfreq, DEVFREQ_GOV_START,
730 dev_err(dev, "%s: Unable to start governor for the device\n",
735 list_add(&devfreq->node, &devfreq_list);
737 mutex_unlock(&devfreq_list_lock);
742 mutex_unlock(&devfreq_list_lock);
744 devfreq_remove_device(devfreq);
751 EXPORT_SYMBOL(devfreq_add_device);
754 * devfreq_remove_device() - Remove devfreq feature from a device.
755 * @devfreq: the devfreq instance to be removed
757 * The opposite of devfreq_add_device().
759 int devfreq_remove_device(struct devfreq *devfreq)
764 if (devfreq->governor)
765 devfreq->governor->event_handler(devfreq,
766 DEVFREQ_GOV_STOP, NULL);
767 device_unregister(&devfreq->dev);
771 EXPORT_SYMBOL(devfreq_remove_device);
773 static int devm_devfreq_dev_match(struct device *dev, void *res, void *data)
775 struct devfreq **r = res;
777 if (WARN_ON(!r || !*r))
783 static void devm_devfreq_dev_release(struct device *dev, void *res)
785 devfreq_remove_device(*(struct devfreq **)res);
789 * devm_devfreq_add_device() - Resource-managed devfreq_add_device()
790 * @dev: the device to add devfreq feature.
791 * @profile: device-specific profile to run devfreq.
792 * @governor_name: name of the policy to choose frequency.
793 * @data: private data for the governor. The devfreq framework does not
796 * This function manages automatically the memory of devfreq device using device
797 * resource management and simplify the free operation for memory of devfreq
800 struct devfreq *devm_devfreq_add_device(struct device *dev,
801 struct devfreq_dev_profile *profile,
802 const char *governor_name,
805 struct devfreq **ptr, *devfreq;
807 ptr = devres_alloc(devm_devfreq_dev_release, sizeof(*ptr), GFP_KERNEL);
809 return ERR_PTR(-ENOMEM);
811 devfreq = devfreq_add_device(dev, profile, governor_name, data);
812 if (IS_ERR(devfreq)) {
818 devres_add(dev, ptr);
822 EXPORT_SYMBOL(devm_devfreq_add_device);
826 * devfreq_get_devfreq_by_phandle - Get the devfreq device from devicetree
827 * @dev - instance to the given device
828 * @index - index into list of devfreq
830 * return the instance of devfreq device
832 struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
834 struct device_node *node;
835 struct devfreq *devfreq;
838 return ERR_PTR(-EINVAL);
841 return ERR_PTR(-EINVAL);
843 node = of_parse_phandle(dev->of_node, "devfreq", index);
845 return ERR_PTR(-ENODEV);
847 mutex_lock(&devfreq_list_lock);
848 list_for_each_entry(devfreq, &devfreq_list, node) {
849 if (devfreq->dev.parent
850 && devfreq->dev.parent->of_node == node) {
851 mutex_unlock(&devfreq_list_lock);
856 mutex_unlock(&devfreq_list_lock);
859 return ERR_PTR(-EPROBE_DEFER);
862 struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index)
864 return ERR_PTR(-ENODEV);
866 #endif /* CONFIG_OF */
867 EXPORT_SYMBOL_GPL(devfreq_get_devfreq_by_phandle);
870 * devm_devfreq_remove_device() - Resource-managed devfreq_remove_device()
871 * @dev: the device from which to remove devfreq feature.
872 * @devfreq: the devfreq instance to be removed
874 void devm_devfreq_remove_device(struct device *dev, struct devfreq *devfreq)
876 WARN_ON(devres_release(dev, devm_devfreq_dev_release,
877 devm_devfreq_dev_match, devfreq));
879 EXPORT_SYMBOL(devm_devfreq_remove_device);
882 * devfreq_suspend_device() - Suspend devfreq of a device.
883 * @devfreq: the devfreq instance to be suspended
885 * This function is intended to be called by the pm callbacks
886 * (e.g., runtime_suspend, suspend) of the device driver that
889 int devfreq_suspend_device(struct devfreq *devfreq)
896 if (atomic_inc_return(&devfreq->suspend_count) > 1)
899 if (devfreq->governor) {
900 ret = devfreq->governor->event_handler(devfreq,
901 DEVFREQ_GOV_SUSPEND, NULL);
906 if (devfreq->suspend_freq) {
907 ret = devfreq_set_target(devfreq, devfreq->suspend_freq, 0);
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 ret = devfreq_set_target(devfreq, devfreq->resume_freq, 0);
940 if (devfreq->governor) {
941 ret = devfreq->governor->event_handler(devfreq,
942 DEVFREQ_GOV_RESUME, NULL);
949 EXPORT_SYMBOL(devfreq_resume_device);
952 * devfreq_suspend() - Suspend devfreq governors and devices
954 * Called during system wide Suspend/Hibernate cycles for suspending governors
955 * and devices preserving the state for resume. On some platforms the devfreq
956 * device must have precise state (frequency) after resume in order to provide
957 * fully operating setup.
959 void devfreq_suspend(void)
961 struct devfreq *devfreq;
964 mutex_lock(&devfreq_list_lock);
965 list_for_each_entry(devfreq, &devfreq_list, node) {
966 ret = devfreq_suspend_device(devfreq);
968 dev_err(&devfreq->dev,
969 "failed to suspend devfreq device\n");
971 mutex_unlock(&devfreq_list_lock);
975 * devfreq_resume() - Resume devfreq governors and devices
977 * Called during system wide Suspend/Hibernate cycle for resuming governors and
978 * devices that are suspended with devfreq_suspend().
980 void devfreq_resume(void)
982 struct devfreq *devfreq;
985 mutex_lock(&devfreq_list_lock);
986 list_for_each_entry(devfreq, &devfreq_list, node) {
987 ret = devfreq_resume_device(devfreq);
989 dev_warn(&devfreq->dev,
990 "failed to resume devfreq device\n");
992 mutex_unlock(&devfreq_list_lock);
996 * devfreq_add_governor() - Add devfreq governor
997 * @governor: the devfreq governor to be added
999 int devfreq_add_governor(struct devfreq_governor *governor)
1001 struct devfreq_governor *g;
1002 struct devfreq *devfreq;
1006 pr_err("%s: Invalid parameters.\n", __func__);
1010 mutex_lock(&devfreq_list_lock);
1011 g = find_devfreq_governor(governor->name);
1013 pr_err("%s: governor %s already registered\n", __func__,
1019 list_add(&governor->node, &devfreq_governor_list);
1021 list_for_each_entry(devfreq, &devfreq_list, node) {
1023 struct device *dev = devfreq->dev.parent;
1025 if (!strncmp(devfreq->governor_name, governor->name,
1026 DEVFREQ_NAME_LEN)) {
1027 /* The following should never occur */
1028 if (devfreq->governor) {
1030 "%s: Governor %s already present\n",
1031 __func__, devfreq->governor->name);
1032 ret = devfreq->governor->event_handler(devfreq,
1033 DEVFREQ_GOV_STOP, NULL);
1036 "%s: Governor %s stop = %d\n",
1038 devfreq->governor->name, ret);
1042 devfreq->governor = governor;
1043 ret = devfreq->governor->event_handler(devfreq,
1044 DEVFREQ_GOV_START, NULL);
1046 dev_warn(dev, "%s: Governor %s start=%d\n",
1047 __func__, devfreq->governor->name,
1054 mutex_unlock(&devfreq_list_lock);
1058 EXPORT_SYMBOL(devfreq_add_governor);
1061 * devfreq_remove_governor() - Remove devfreq feature from a device.
1062 * @governor: the devfreq governor to be removed
1064 int devfreq_remove_governor(struct devfreq_governor *governor)
1066 struct devfreq_governor *g;
1067 struct devfreq *devfreq;
1071 pr_err("%s: Invalid parameters.\n", __func__);
1075 mutex_lock(&devfreq_list_lock);
1076 g = find_devfreq_governor(governor->name);
1078 pr_err("%s: governor %s not registered\n", __func__,
1083 list_for_each_entry(devfreq, &devfreq_list, node) {
1085 struct device *dev = devfreq->dev.parent;
1087 if (!strncmp(devfreq->governor_name, governor->name,
1088 DEVFREQ_NAME_LEN)) {
1089 /* we should have a devfreq governor! */
1090 if (!devfreq->governor) {
1091 dev_warn(dev, "%s: Governor %s NOT present\n",
1092 __func__, governor->name);
1096 ret = devfreq->governor->event_handler(devfreq,
1097 DEVFREQ_GOV_STOP, NULL);
1099 dev_warn(dev, "%s: Governor %s stop=%d\n",
1100 __func__, devfreq->governor->name,
1103 devfreq->governor = NULL;
1107 list_del(&governor->node);
1109 mutex_unlock(&devfreq_list_lock);
1113 EXPORT_SYMBOL(devfreq_remove_governor);
1115 static ssize_t governor_show(struct device *dev,
1116 struct device_attribute *attr, char *buf)
1118 if (!to_devfreq(dev)->governor)
1121 return sprintf(buf, "%s\n", to_devfreq(dev)->governor->name);
1124 static ssize_t governor_store(struct device *dev, struct device_attribute *attr,
1125 const char *buf, size_t count)
1127 struct devfreq *df = to_devfreq(dev);
1129 char str_governor[DEVFREQ_NAME_LEN + 1];
1130 const struct devfreq_governor *governor, *prev_governor;
1132 ret = sscanf(buf, "%" __stringify(DEVFREQ_NAME_LEN) "s", str_governor);
1136 mutex_lock(&devfreq_list_lock);
1137 governor = try_then_request_governor(str_governor);
1138 if (IS_ERR(governor)) {
1139 ret = PTR_ERR(governor);
1142 if (df->governor == governor) {
1145 } else if ((df->governor && df->governor->immutable) ||
1146 governor->immutable) {
1152 ret = df->governor->event_handler(df, DEVFREQ_GOV_STOP, NULL);
1154 dev_warn(dev, "%s: Governor %s not stopped(%d)\n",
1155 __func__, df->governor->name, ret);
1159 prev_governor = df->governor;
1160 df->governor = governor;
1161 strncpy(df->governor_name, governor->name, DEVFREQ_NAME_LEN);
1162 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
1164 dev_warn(dev, "%s: Governor %s not started(%d)\n",
1165 __func__, df->governor->name, ret);
1166 df->governor = prev_governor;
1167 strncpy(df->governor_name, prev_governor->name,
1169 ret = df->governor->event_handler(df, DEVFREQ_GOV_START, NULL);
1172 "%s: reverting to Governor %s failed (%d)\n",
1173 __func__, df->governor_name, ret);
1174 df->governor = NULL;
1178 mutex_unlock(&devfreq_list_lock);
1184 static DEVICE_ATTR_RW(governor);
1186 static ssize_t available_governors_show(struct device *d,
1187 struct device_attribute *attr,
1190 struct devfreq *df = to_devfreq(d);
1193 mutex_lock(&devfreq_list_lock);
1196 * The devfreq with immutable governor (e.g., passive) shows
1197 * only own governor.
1199 if (df->governor && df->governor->immutable) {
1200 count = scnprintf(&buf[count], DEVFREQ_NAME_LEN,
1201 "%s ", df->governor_name);
1203 * The devfreq device shows the registered governor except for
1204 * immutable governors such as passive governor .
1207 struct devfreq_governor *governor;
1209 list_for_each_entry(governor, &devfreq_governor_list, node) {
1210 if (governor->immutable)
1212 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1213 "%s ", governor->name);
1217 mutex_unlock(&devfreq_list_lock);
1219 /* Truncate the trailing space */
1223 count += sprintf(&buf[count], "\n");
1227 static DEVICE_ATTR_RO(available_governors);
1229 static ssize_t cur_freq_show(struct device *dev, struct device_attribute *attr,
1233 struct devfreq *devfreq = to_devfreq(dev);
1235 if (devfreq->profile->get_cur_freq &&
1236 !devfreq->profile->get_cur_freq(devfreq->dev.parent, &freq))
1237 return sprintf(buf, "%lu\n", freq);
1239 return sprintf(buf, "%lu\n", devfreq->previous_freq);
1241 static DEVICE_ATTR_RO(cur_freq);
1243 static ssize_t target_freq_show(struct device *dev,
1244 struct device_attribute *attr, char *buf)
1246 return sprintf(buf, "%lu\n", to_devfreq(dev)->previous_freq);
1248 static DEVICE_ATTR_RO(target_freq);
1250 static ssize_t polling_interval_show(struct device *dev,
1251 struct device_attribute *attr, char *buf)
1253 return sprintf(buf, "%d\n", to_devfreq(dev)->profile->polling_ms);
1256 static ssize_t polling_interval_store(struct device *dev,
1257 struct device_attribute *attr,
1258 const char *buf, size_t count)
1260 struct devfreq *df = to_devfreq(dev);
1267 ret = sscanf(buf, "%u", &value);
1271 df->governor->event_handler(df, DEVFREQ_GOV_INTERVAL, &value);
1276 static DEVICE_ATTR_RW(polling_interval);
1278 static ssize_t min_freq_store(struct device *dev, struct device_attribute *attr,
1279 const char *buf, size_t count)
1281 struct devfreq *df = to_devfreq(dev);
1282 unsigned long value;
1285 ret = sscanf(buf, "%lu", &value);
1289 mutex_lock(&df->lock);
1292 if (value > df->max_freq) {
1297 unsigned long *freq_table = df->profile->freq_table;
1299 /* Get minimum frequency according to sorting order */
1300 if (freq_table[0] < freq_table[df->profile->max_state - 1])
1301 value = freq_table[0];
1303 value = freq_table[df->profile->max_state - 1];
1306 df->min_freq = value;
1310 mutex_unlock(&df->lock);
1314 static ssize_t min_freq_show(struct device *dev, struct device_attribute *attr,
1317 struct devfreq *df = to_devfreq(dev);
1319 return sprintf(buf, "%lu\n", max(df->scaling_min_freq, df->min_freq));
1322 static ssize_t max_freq_store(struct device *dev, struct device_attribute *attr,
1323 const char *buf, size_t count)
1325 struct devfreq *df = to_devfreq(dev);
1326 unsigned long value;
1329 ret = sscanf(buf, "%lu", &value);
1333 mutex_lock(&df->lock);
1336 if (value < df->min_freq) {
1341 unsigned long *freq_table = df->profile->freq_table;
1343 /* Get maximum frequency according to sorting order */
1344 if (freq_table[0] < freq_table[df->profile->max_state - 1])
1345 value = freq_table[df->profile->max_state - 1];
1347 value = freq_table[0];
1350 df->max_freq = value;
1354 mutex_unlock(&df->lock);
1357 static DEVICE_ATTR_RW(min_freq);
1359 static ssize_t max_freq_show(struct device *dev, struct device_attribute *attr,
1362 struct devfreq *df = to_devfreq(dev);
1364 return sprintf(buf, "%lu\n", min(df->scaling_max_freq, df->max_freq));
1366 static DEVICE_ATTR_RW(max_freq);
1368 static ssize_t available_frequencies_show(struct device *d,
1369 struct device_attribute *attr,
1372 struct devfreq *df = to_devfreq(d);
1376 mutex_lock(&df->lock);
1378 for (i = 0; i < df->profile->max_state; i++)
1379 count += scnprintf(&buf[count], (PAGE_SIZE - count - 2),
1380 "%lu ", df->profile->freq_table[i]);
1382 mutex_unlock(&df->lock);
1383 /* Truncate the trailing space */
1387 count += sprintf(&buf[count], "\n");
1391 static DEVICE_ATTR_RO(available_frequencies);
1393 static ssize_t trans_stat_show(struct device *dev,
1394 struct device_attribute *attr, char *buf)
1396 struct devfreq *devfreq = to_devfreq(dev);
1399 unsigned int max_state = devfreq->profile->max_state;
1402 return sprintf(buf, "Not Supported.\n");
1404 mutex_lock(&devfreq->lock);
1405 if (!devfreq->stop_polling &&
1406 devfreq_update_status(devfreq, devfreq->previous_freq)) {
1407 mutex_unlock(&devfreq->lock);
1410 mutex_unlock(&devfreq->lock);
1412 len = sprintf(buf, " From : To\n");
1413 len += sprintf(buf + len, " :");
1414 for (i = 0; i < max_state; i++)
1415 len += sprintf(buf + len, "%10lu",
1416 devfreq->profile->freq_table[i]);
1418 len += sprintf(buf + len, " time(ms)\n");
1420 for (i = 0; i < max_state; i++) {
1421 if (devfreq->profile->freq_table[i]
1422 == devfreq->previous_freq) {
1423 len += sprintf(buf + len, "*");
1425 len += sprintf(buf + len, " ");
1427 len += sprintf(buf + len, "%10lu:",
1428 devfreq->profile->freq_table[i]);
1429 for (j = 0; j < max_state; j++)
1430 len += sprintf(buf + len, "%10u",
1431 devfreq->trans_table[(i * max_state) + j]);
1432 len += sprintf(buf + len, "%10u\n",
1433 jiffies_to_msecs(devfreq->time_in_state[i]));
1436 len += sprintf(buf + len, "Total transition : %u\n",
1437 devfreq->total_trans);
1440 static DEVICE_ATTR_RO(trans_stat);
1442 static struct attribute *devfreq_attrs[] = {
1443 &dev_attr_governor.attr,
1444 &dev_attr_available_governors.attr,
1445 &dev_attr_cur_freq.attr,
1446 &dev_attr_available_frequencies.attr,
1447 &dev_attr_target_freq.attr,
1448 &dev_attr_polling_interval.attr,
1449 &dev_attr_min_freq.attr,
1450 &dev_attr_max_freq.attr,
1451 &dev_attr_trans_stat.attr,
1454 ATTRIBUTE_GROUPS(devfreq);
1456 static int __init devfreq_init(void)
1458 devfreq_class = class_create(THIS_MODULE, "devfreq");
1459 if (IS_ERR(devfreq_class)) {
1460 pr_err("%s: couldn't create class\n", __FILE__);
1461 return PTR_ERR(devfreq_class);
1464 devfreq_wq = create_freezable_workqueue("devfreq_wq");
1466 class_destroy(devfreq_class);
1467 pr_err("%s: couldn't create workqueue\n", __FILE__);
1470 devfreq_class->dev_groups = devfreq_groups;
1474 subsys_initcall(devfreq_init);
1477 * The following are helper functions for devfreq user device drivers with
1482 * devfreq_recommended_opp() - Helper function to get proper OPP for the
1483 * freq value given to target callback.
1484 * @dev: The devfreq user device. (parent of devfreq)
1485 * @freq: The frequency given to target function
1486 * @flags: Flags handed from devfreq framework.
1488 * The callers are required to call dev_pm_opp_put() for the returned OPP after
1491 struct dev_pm_opp *devfreq_recommended_opp(struct device *dev,
1492 unsigned long *freq,
1495 struct dev_pm_opp *opp;
1497 if (flags & DEVFREQ_FLAG_LEAST_UPPER_BOUND) {
1498 /* The freq is an upper bound. opp should be lower */
1499 opp = dev_pm_opp_find_freq_floor(dev, freq);
1501 /* If not available, use the closest opp */
1502 if (opp == ERR_PTR(-ERANGE))
1503 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1505 /* The freq is an lower bound. opp should be higher */
1506 opp = dev_pm_opp_find_freq_ceil(dev, freq);
1508 /* If not available, use the closest opp */
1509 if (opp == ERR_PTR(-ERANGE))
1510 opp = dev_pm_opp_find_freq_floor(dev, freq);
1515 EXPORT_SYMBOL(devfreq_recommended_opp);
1518 * devfreq_register_opp_notifier() - Helper function to get devfreq notified
1519 * for any changes in the OPP availability
1521 * @dev: The devfreq user device. (parent of devfreq)
1522 * @devfreq: The devfreq object.
1524 int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
1526 return dev_pm_opp_register_notifier(dev, &devfreq->nb);
1528 EXPORT_SYMBOL(devfreq_register_opp_notifier);
1531 * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
1532 * notified for any changes in the OPP
1533 * availability changes anymore.
1534 * @dev: The devfreq user device. (parent of devfreq)
1535 * @devfreq: The devfreq object.
1537 * At exit() callback of devfreq_dev_profile, this must be included if
1538 * devfreq_recommended_opp is used.
1540 int devfreq_unregister_opp_notifier(struct device *dev, struct devfreq *devfreq)
1542 return dev_pm_opp_unregister_notifier(dev, &devfreq->nb);
1544 EXPORT_SYMBOL(devfreq_unregister_opp_notifier);
1546 static void devm_devfreq_opp_release(struct device *dev, void *res)
1548 devfreq_unregister_opp_notifier(dev, *(struct devfreq **)res);
1552 * devm_devfreq_register_opp_notifier() - Resource-managed
1553 * devfreq_register_opp_notifier()
1554 * @dev: The devfreq user device. (parent of devfreq)
1555 * @devfreq: The devfreq object.
1557 int devm_devfreq_register_opp_notifier(struct device *dev,
1558 struct devfreq *devfreq)
1560 struct devfreq **ptr;
1563 ptr = devres_alloc(devm_devfreq_opp_release, sizeof(*ptr), GFP_KERNEL);
1567 ret = devfreq_register_opp_notifier(dev, devfreq);
1574 devres_add(dev, ptr);
1578 EXPORT_SYMBOL(devm_devfreq_register_opp_notifier);
1581 * devm_devfreq_unregister_opp_notifier() - Resource-managed
1582 * devfreq_unregister_opp_notifier()
1583 * @dev: The devfreq user device. (parent of devfreq)
1584 * @devfreq: The devfreq object.
1586 void devm_devfreq_unregister_opp_notifier(struct device *dev,
1587 struct devfreq *devfreq)
1589 WARN_ON(devres_release(dev, devm_devfreq_opp_release,
1590 devm_devfreq_dev_match, devfreq));
1592 EXPORT_SYMBOL(devm_devfreq_unregister_opp_notifier);
1595 * devfreq_register_notifier() - Register a driver with devfreq
1596 * @devfreq: The devfreq object.
1597 * @nb: The notifier block to register.
1598 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1600 int devfreq_register_notifier(struct devfreq *devfreq,
1601 struct notifier_block *nb,
1610 case DEVFREQ_TRANSITION_NOTIFIER:
1611 ret = srcu_notifier_chain_register(
1612 &devfreq->transition_notifier_list, nb);
1620 EXPORT_SYMBOL(devfreq_register_notifier);
1623 * devfreq_unregister_notifier() - Unregister a driver with devfreq
1624 * @devfreq: The devfreq object.
1625 * @nb: The notifier block to be unregistered.
1626 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1628 int devfreq_unregister_notifier(struct devfreq *devfreq,
1629 struct notifier_block *nb,
1638 case DEVFREQ_TRANSITION_NOTIFIER:
1639 ret = srcu_notifier_chain_unregister(
1640 &devfreq->transition_notifier_list, nb);
1648 EXPORT_SYMBOL(devfreq_unregister_notifier);
1650 struct devfreq_notifier_devres {
1651 struct devfreq *devfreq;
1652 struct notifier_block *nb;
1656 static void devm_devfreq_notifier_release(struct device *dev, void *res)
1658 struct devfreq_notifier_devres *this = res;
1660 devfreq_unregister_notifier(this->devfreq, this->nb, this->list);
1664 * devm_devfreq_register_notifier()
1665 - Resource-managed devfreq_register_notifier()
1666 * @dev: The devfreq user device. (parent of devfreq)
1667 * @devfreq: The devfreq object.
1668 * @nb: The notifier block to be unregistered.
1669 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1671 int devm_devfreq_register_notifier(struct device *dev,
1672 struct devfreq *devfreq,
1673 struct notifier_block *nb,
1676 struct devfreq_notifier_devres *ptr;
1679 ptr = devres_alloc(devm_devfreq_notifier_release, sizeof(*ptr),
1684 ret = devfreq_register_notifier(devfreq, nb, list);
1690 ptr->devfreq = devfreq;
1693 devres_add(dev, ptr);
1697 EXPORT_SYMBOL(devm_devfreq_register_notifier);
1700 * devm_devfreq_unregister_notifier()
1701 - Resource-managed devfreq_unregister_notifier()
1702 * @dev: The devfreq user device. (parent of devfreq)
1703 * @devfreq: The devfreq object.
1704 * @nb: The notifier block to be unregistered.
1705 * @list: DEVFREQ_TRANSITION_NOTIFIER.
1707 void devm_devfreq_unregister_notifier(struct device *dev,
1708 struct devfreq *devfreq,
1709 struct notifier_block *nb,
1712 WARN_ON(devres_release(dev, devm_devfreq_notifier_release,
1713 devm_devfreq_dev_match, devfreq));
1715 EXPORT_SYMBOL(devm_devfreq_unregister_notifier);