1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2015 Linaro Ltd.
4 * Author: Pi-Cheng Chen <pi-cheng.chen@linaro.org>
9 #include <linux/cpufreq.h>
10 #include <linux/cpumask.h>
11 #include <linux/minmax.h>
12 #include <linux/module.h>
14 #include <linux/of_platform.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_opp.h>
17 #include <linux/regulator/consumer.h>
19 struct mtk_cpufreq_platform_data {
25 bool ccifreq_supported;
29 * The struct mtk_cpu_dvfs_info holds necessary information for doing CPU DVFS
30 * on each CPU power/clock domain of Mediatek SoCs. Each CPU cluster in
31 * Mediatek SoCs has two voltage inputs, Vproc and Vsram. In some cases the two
32 * voltage inputs need to be controlled under a hardware limitation:
33 * 100mV < Vsram - Vproc < 200mV
35 * When scaling the clock frequency of a CPU clock domain, the clock source
36 * needs to be switched to another stable PLL clock temporarily until
37 * the original PLL becomes stable at target frequency.
39 struct mtk_cpu_dvfs_info {
41 struct device *cpu_dev;
42 struct device *cci_dev;
43 struct regulator *proc_reg;
44 struct regulator *sram_reg;
46 struct clk *inter_clk;
47 struct list_head list_head;
48 int intermediate_voltage;
49 bool need_voltage_tracking;
52 /* Avoid race condition for regulators between notify and policy */
53 struct mutex reg_lock;
54 struct notifier_block opp_nb;
56 unsigned long current_freq;
57 const struct mtk_cpufreq_platform_data *soc_data;
62 static struct platform_device *cpufreq_pdev;
64 static LIST_HEAD(dvfs_info_list);
66 static struct mtk_cpu_dvfs_info *mtk_cpu_dvfs_info_lookup(int cpu)
68 struct mtk_cpu_dvfs_info *info;
70 list_for_each_entry(info, &dvfs_info_list, list_head) {
71 if (cpumask_test_cpu(cpu, &info->cpus))
78 static int mtk_cpufreq_voltage_tracking(struct mtk_cpu_dvfs_info *info,
81 const struct mtk_cpufreq_platform_data *soc_data = info->soc_data;
82 struct regulator *proc_reg = info->proc_reg;
83 struct regulator *sram_reg = info->sram_reg;
84 int pre_vproc, pre_vsram, new_vsram, vsram, vproc, ret;
85 int retry = info->vtrack_max;
87 pre_vproc = regulator_get_voltage(proc_reg);
89 dev_err(info->cpu_dev,
90 "invalid Vproc value: %d\n", pre_vproc);
94 pre_vsram = regulator_get_voltage(sram_reg);
96 dev_err(info->cpu_dev, "invalid Vsram value: %d\n", pre_vsram);
100 new_vsram = clamp(new_vproc + soc_data->min_volt_shift,
101 soc_data->sram_min_volt, soc_data->sram_max_volt);
104 if (pre_vproc <= new_vproc) {
105 vsram = clamp(pre_vproc + soc_data->max_volt_shift,
106 soc_data->sram_min_volt, new_vsram);
107 ret = regulator_set_voltage(sram_reg, vsram,
108 soc_data->sram_max_volt);
113 if (vsram == soc_data->sram_max_volt ||
114 new_vsram == soc_data->sram_min_volt)
117 vproc = vsram - soc_data->min_volt_shift;
119 ret = regulator_set_voltage(proc_reg, vproc,
120 soc_data->proc_max_volt);
122 regulator_set_voltage(sram_reg, pre_vsram,
123 soc_data->sram_max_volt);
126 } else if (pre_vproc > new_vproc) {
127 vproc = max(new_vproc,
128 pre_vsram - soc_data->max_volt_shift);
129 ret = regulator_set_voltage(proc_reg, vproc,
130 soc_data->proc_max_volt);
134 if (vproc == new_vproc)
137 vsram = max(new_vsram,
138 vproc + soc_data->min_volt_shift);
140 ret = regulator_set_voltage(sram_reg, vsram,
141 soc_data->sram_max_volt);
143 regulator_set_voltage(proc_reg, pre_vproc,
144 soc_data->proc_max_volt);
153 dev_err(info->cpu_dev,
154 "over loop count, failed to set voltage\n");
157 } while (vproc != new_vproc || vsram != new_vsram);
162 static int mtk_cpufreq_set_voltage(struct mtk_cpu_dvfs_info *info, int vproc)
164 const struct mtk_cpufreq_platform_data *soc_data = info->soc_data;
167 if (info->need_voltage_tracking)
168 ret = mtk_cpufreq_voltage_tracking(info, vproc);
170 ret = regulator_set_voltage(info->proc_reg, vproc,
171 soc_data->proc_max_volt);
173 info->pre_vproc = vproc;
178 static bool is_ccifreq_ready(struct mtk_cpu_dvfs_info *info)
180 struct device_link *sup_link;
182 if (info->ccifreq_bound)
185 sup_link = device_link_add(info->cpu_dev, info->cci_dev,
186 DL_FLAG_AUTOREMOVE_CONSUMER);
188 dev_err(info->cpu_dev, "cpu%d: sup_link is NULL\n", info->opp_cpu);
192 if (sup_link->supplier->links.status != DL_DEV_DRIVER_BOUND)
195 info->ccifreq_bound = true;
200 static int mtk_cpufreq_set_target(struct cpufreq_policy *policy,
203 struct cpufreq_frequency_table *freq_table = policy->freq_table;
204 struct clk *cpu_clk = policy->clk;
205 struct clk *armpll = clk_get_parent(cpu_clk);
206 struct mtk_cpu_dvfs_info *info = policy->driver_data;
207 struct device *cpu_dev = info->cpu_dev;
208 struct dev_pm_opp *opp;
209 long freq_hz, pre_freq_hz;
210 int vproc, pre_vproc, inter_vproc, target_vproc, ret;
212 inter_vproc = info->intermediate_voltage;
214 pre_freq_hz = clk_get_rate(cpu_clk);
216 mutex_lock(&info->reg_lock);
218 if (unlikely(info->pre_vproc <= 0))
219 pre_vproc = regulator_get_voltage(info->proc_reg);
221 pre_vproc = info->pre_vproc;
224 dev_err(cpu_dev, "invalid Vproc value: %d\n", pre_vproc);
229 freq_hz = freq_table[index].frequency * 1000;
231 opp = dev_pm_opp_find_freq_ceil(cpu_dev, &freq_hz);
233 dev_err(cpu_dev, "cpu%d: failed to find OPP for %ld\n",
234 policy->cpu, freq_hz);
238 vproc = dev_pm_opp_get_voltage(opp);
242 * If MediaTek cci is supported but is not ready, we will use the value
243 * of max(target cpu voltage, booting voltage) to prevent high freqeuncy
246 if (info->soc_data->ccifreq_supported && !is_ccifreq_ready(info))
247 vproc = max(vproc, info->vproc_on_boot);
250 * If the new voltage or the intermediate voltage is higher than the
251 * current voltage, scale up voltage first.
253 target_vproc = max(inter_vproc, vproc);
254 if (pre_vproc <= target_vproc) {
255 ret = mtk_cpufreq_set_voltage(info, target_vproc);
258 "cpu%d: failed to scale up voltage!\n", policy->cpu);
259 mtk_cpufreq_set_voltage(info, pre_vproc);
264 /* Reparent the CPU clock to intermediate clock. */
265 ret = clk_set_parent(cpu_clk, info->inter_clk);
268 "cpu%d: failed to re-parent cpu clock!\n", policy->cpu);
269 mtk_cpufreq_set_voltage(info, pre_vproc);
273 /* Set the original PLL to target rate. */
274 ret = clk_set_rate(armpll, freq_hz);
277 "cpu%d: failed to scale cpu clock rate!\n", policy->cpu);
278 clk_set_parent(cpu_clk, armpll);
279 mtk_cpufreq_set_voltage(info, pre_vproc);
283 /* Set parent of CPU clock back to the original PLL. */
284 ret = clk_set_parent(cpu_clk, armpll);
287 "cpu%d: failed to re-parent cpu clock!\n", policy->cpu);
288 mtk_cpufreq_set_voltage(info, inter_vproc);
293 * If the new voltage is lower than the intermediate voltage or the
294 * original voltage, scale down to the new voltage.
296 if (vproc < inter_vproc || vproc < pre_vproc) {
297 ret = mtk_cpufreq_set_voltage(info, vproc);
300 "cpu%d: failed to scale down voltage!\n", policy->cpu);
301 clk_set_parent(cpu_clk, info->inter_clk);
302 clk_set_rate(armpll, pre_freq_hz);
303 clk_set_parent(cpu_clk, armpll);
308 info->current_freq = freq_hz;
311 mutex_unlock(&info->reg_lock);
316 static int mtk_cpufreq_opp_notifier(struct notifier_block *nb,
317 unsigned long event, void *data)
319 struct dev_pm_opp *opp = data;
320 struct dev_pm_opp *new_opp;
321 struct mtk_cpu_dvfs_info *info;
322 unsigned long freq, volt;
323 struct cpufreq_policy *policy;
326 info = container_of(nb, struct mtk_cpu_dvfs_info, opp_nb);
328 if (event == OPP_EVENT_ADJUST_VOLTAGE) {
329 freq = dev_pm_opp_get_freq(opp);
331 mutex_lock(&info->reg_lock);
332 if (info->current_freq == freq) {
333 volt = dev_pm_opp_get_voltage(opp);
334 ret = mtk_cpufreq_set_voltage(info, volt);
336 dev_err(info->cpu_dev,
337 "failed to scale voltage: %d\n", ret);
339 mutex_unlock(&info->reg_lock);
340 } else if (event == OPP_EVENT_DISABLE) {
341 freq = dev_pm_opp_get_freq(opp);
343 /* case of current opp item is disabled */
344 if (info->current_freq == freq) {
346 new_opp = dev_pm_opp_find_freq_ceil(info->cpu_dev,
348 if (IS_ERR(new_opp)) {
349 dev_err(info->cpu_dev,
350 "all opp items are disabled\n");
351 ret = PTR_ERR(new_opp);
352 return notifier_from_errno(ret);
355 dev_pm_opp_put(new_opp);
356 policy = cpufreq_cpu_get(info->opp_cpu);
358 cpufreq_driver_target(policy, freq / 1000,
360 cpufreq_cpu_put(policy);
365 return notifier_from_errno(ret);
368 static struct device *of_get_cci(struct device *cpu_dev)
370 struct device_node *np;
371 struct platform_device *pdev;
373 np = of_parse_phandle(cpu_dev->of_node, "mediatek,cci", 0);
375 return ERR_PTR(-ENODEV);
377 pdev = of_find_device_by_node(np);
380 return ERR_PTR(-ENODEV);
385 static int mtk_cpu_dvfs_info_init(struct mtk_cpu_dvfs_info *info, int cpu)
387 struct device *cpu_dev;
388 struct dev_pm_opp *opp;
392 cpu_dev = get_cpu_device(cpu);
394 dev_err(cpu_dev, "failed to get cpu%d device\n", cpu);
397 info->cpu_dev = cpu_dev;
399 info->ccifreq_bound = false;
400 if (info->soc_data->ccifreq_supported) {
401 info->cci_dev = of_get_cci(info->cpu_dev);
402 if (IS_ERR(info->cci_dev)) {
403 ret = PTR_ERR(info->cci_dev);
404 dev_err(cpu_dev, "cpu%d: failed to get cci device\n", cpu);
409 info->cpu_clk = clk_get(cpu_dev, "cpu");
410 if (IS_ERR(info->cpu_clk)) {
411 ret = PTR_ERR(info->cpu_clk);
412 return dev_err_probe(cpu_dev, ret,
413 "cpu%d: failed to get cpu clk\n", cpu);
416 info->inter_clk = clk_get(cpu_dev, "intermediate");
417 if (IS_ERR(info->inter_clk)) {
418 ret = PTR_ERR(info->inter_clk);
419 dev_err_probe(cpu_dev, ret,
420 "cpu%d: failed to get intermediate clk\n", cpu);
421 goto out_free_mux_clock;
424 info->proc_reg = regulator_get_optional(cpu_dev, "proc");
425 if (IS_ERR(info->proc_reg)) {
426 ret = PTR_ERR(info->proc_reg);
427 dev_err_probe(cpu_dev, ret,
428 "cpu%d: failed to get proc regulator\n", cpu);
429 goto out_free_inter_clock;
432 ret = regulator_enable(info->proc_reg);
434 dev_warn(cpu_dev, "cpu%d: failed to enable vproc\n", cpu);
435 goto out_free_proc_reg;
438 /* Both presence and absence of sram regulator are valid cases. */
439 info->sram_reg = regulator_get_optional(cpu_dev, "sram");
440 if (IS_ERR(info->sram_reg)) {
441 ret = PTR_ERR(info->sram_reg);
442 if (ret == -EPROBE_DEFER)
443 goto out_disable_proc_reg;
445 info->sram_reg = NULL;
447 ret = regulator_enable(info->sram_reg);
449 dev_warn(cpu_dev, "cpu%d: failed to enable vsram\n", cpu);
450 goto out_free_sram_reg;
454 /* Get OPP-sharing information from "operating-points-v2" bindings */
455 ret = dev_pm_opp_of_get_sharing_cpus(cpu_dev, &info->cpus);
458 "cpu%d: failed to get OPP-sharing information\n", cpu);
459 goto out_disable_sram_reg;
462 ret = dev_pm_opp_of_cpumask_add_table(&info->cpus);
464 dev_warn(cpu_dev, "cpu%d: no OPP table\n", cpu);
465 goto out_disable_sram_reg;
468 ret = clk_prepare_enable(info->cpu_clk);
470 goto out_free_opp_table;
472 ret = clk_prepare_enable(info->inter_clk);
474 goto out_disable_mux_clock;
476 if (info->soc_data->ccifreq_supported) {
477 info->vproc_on_boot = regulator_get_voltage(info->proc_reg);
478 if (info->vproc_on_boot < 0) {
479 ret = info->vproc_on_boot;
480 dev_err(info->cpu_dev,
481 "invalid Vproc value: %d\n", info->vproc_on_boot);
482 goto out_disable_inter_clock;
486 /* Search a safe voltage for intermediate frequency. */
487 rate = clk_get_rate(info->inter_clk);
488 opp = dev_pm_opp_find_freq_ceil(cpu_dev, &rate);
490 dev_err(cpu_dev, "cpu%d: failed to get intermediate opp\n", cpu);
492 goto out_disable_inter_clock;
494 info->intermediate_voltage = dev_pm_opp_get_voltage(opp);
497 mutex_init(&info->reg_lock);
498 info->current_freq = clk_get_rate(info->cpu_clk);
501 info->opp_nb.notifier_call = mtk_cpufreq_opp_notifier;
502 ret = dev_pm_opp_register_notifier(cpu_dev, &info->opp_nb);
504 dev_err(cpu_dev, "cpu%d: failed to register opp notifier\n", cpu);
505 goto out_disable_inter_clock;
509 * If SRAM regulator is present, software "voltage tracking" is needed
510 * for this CPU power domain.
512 info->need_voltage_tracking = (info->sram_reg != NULL);
515 * We assume min voltage is 0 and tracking target voltage using
516 * min_volt_shift for each iteration.
517 * The vtrack_max is 3 times of expeted iteration count.
519 info->vtrack_max = 3 * DIV_ROUND_UP(max(info->soc_data->sram_max_volt,
520 info->soc_data->proc_max_volt),
521 info->soc_data->min_volt_shift);
525 out_disable_inter_clock:
526 clk_disable_unprepare(info->inter_clk);
528 out_disable_mux_clock:
529 clk_disable_unprepare(info->cpu_clk);
532 dev_pm_opp_of_cpumask_remove_table(&info->cpus);
534 out_disable_sram_reg:
536 regulator_disable(info->sram_reg);
540 regulator_put(info->sram_reg);
542 out_disable_proc_reg:
543 regulator_disable(info->proc_reg);
546 regulator_put(info->proc_reg);
548 out_free_inter_clock:
549 clk_put(info->inter_clk);
552 clk_put(info->cpu_clk);
557 static void mtk_cpu_dvfs_info_release(struct mtk_cpu_dvfs_info *info)
559 regulator_disable(info->proc_reg);
560 regulator_put(info->proc_reg);
561 if (info->sram_reg) {
562 regulator_disable(info->sram_reg);
563 regulator_put(info->sram_reg);
565 clk_disable_unprepare(info->cpu_clk);
566 clk_put(info->cpu_clk);
567 clk_disable_unprepare(info->inter_clk);
568 clk_put(info->inter_clk);
569 dev_pm_opp_of_cpumask_remove_table(&info->cpus);
570 dev_pm_opp_unregister_notifier(info->cpu_dev, &info->opp_nb);
573 static int mtk_cpufreq_init(struct cpufreq_policy *policy)
575 struct mtk_cpu_dvfs_info *info;
576 struct cpufreq_frequency_table *freq_table;
579 info = mtk_cpu_dvfs_info_lookup(policy->cpu);
581 pr_err("dvfs info for cpu%d is not initialized.\n",
586 ret = dev_pm_opp_init_cpufreq_table(info->cpu_dev, &freq_table);
588 dev_err(info->cpu_dev,
589 "failed to init cpufreq table for cpu%d: %d\n",
594 cpumask_copy(policy->cpus, &info->cpus);
595 policy->freq_table = freq_table;
596 policy->driver_data = info;
597 policy->clk = info->cpu_clk;
602 static int mtk_cpufreq_exit(struct cpufreq_policy *policy)
604 struct mtk_cpu_dvfs_info *info = policy->driver_data;
606 dev_pm_opp_free_cpufreq_table(info->cpu_dev, &policy->freq_table);
611 static struct cpufreq_driver mtk_cpufreq_driver = {
612 .flags = CPUFREQ_NEED_INITIAL_FREQ_CHECK |
613 CPUFREQ_HAVE_GOVERNOR_PER_POLICY |
614 CPUFREQ_IS_COOLING_DEV,
615 .verify = cpufreq_generic_frequency_table_verify,
616 .target_index = mtk_cpufreq_set_target,
617 .get = cpufreq_generic_get,
618 .init = mtk_cpufreq_init,
619 .exit = mtk_cpufreq_exit,
620 .register_em = cpufreq_register_em_with_opp,
621 .name = "mtk-cpufreq",
622 .attr = cpufreq_generic_attr,
625 static int mtk_cpufreq_probe(struct platform_device *pdev)
627 const struct mtk_cpufreq_platform_data *data;
628 struct mtk_cpu_dvfs_info *info, *tmp;
631 data = dev_get_platdata(&pdev->dev);
634 "failed to get mtk cpufreq platform data\n");
638 for_each_possible_cpu(cpu) {
639 info = mtk_cpu_dvfs_info_lookup(cpu);
643 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
646 goto release_dvfs_info_list;
649 info->soc_data = data;
650 ret = mtk_cpu_dvfs_info_init(info, cpu);
653 "failed to initialize dvfs info for cpu%d\n",
655 goto release_dvfs_info_list;
658 list_add(&info->list_head, &dvfs_info_list);
661 ret = cpufreq_register_driver(&mtk_cpufreq_driver);
663 dev_err(&pdev->dev, "failed to register mtk cpufreq driver\n");
664 goto release_dvfs_info_list;
669 release_dvfs_info_list:
670 list_for_each_entry_safe(info, tmp, &dvfs_info_list, list_head) {
671 mtk_cpu_dvfs_info_release(info);
672 list_del(&info->list_head);
678 static struct platform_driver mtk_cpufreq_platdrv = {
680 .name = "mtk-cpufreq",
682 .probe = mtk_cpufreq_probe,
685 static const struct mtk_cpufreq_platform_data mt2701_platform_data = {
686 .min_volt_shift = 100000,
687 .max_volt_shift = 200000,
688 .proc_max_volt = 1150000,
690 .sram_max_volt = 1150000,
691 .ccifreq_supported = false,
694 static const struct mtk_cpufreq_platform_data mt7622_platform_data = {
695 .min_volt_shift = 100000,
696 .max_volt_shift = 200000,
697 .proc_max_volt = 1350000,
699 .sram_max_volt = 1350000,
700 .ccifreq_supported = false,
703 static const struct mtk_cpufreq_platform_data mt7623_platform_data = {
704 .min_volt_shift = 100000,
705 .max_volt_shift = 200000,
706 .proc_max_volt = 1300000,
707 .ccifreq_supported = false,
710 static const struct mtk_cpufreq_platform_data mt8183_platform_data = {
711 .min_volt_shift = 100000,
712 .max_volt_shift = 200000,
713 .proc_max_volt = 1150000,
715 .sram_max_volt = 1150000,
716 .ccifreq_supported = true,
719 static const struct mtk_cpufreq_platform_data mt8186_platform_data = {
720 .min_volt_shift = 100000,
721 .max_volt_shift = 250000,
722 .proc_max_volt = 1118750,
723 .sram_min_volt = 850000,
724 .sram_max_volt = 1118750,
725 .ccifreq_supported = true,
728 static const struct mtk_cpufreq_platform_data mt8516_platform_data = {
729 .min_volt_shift = 100000,
730 .max_volt_shift = 200000,
731 .proc_max_volt = 1310000,
733 .sram_max_volt = 1310000,
734 .ccifreq_supported = false,
737 /* List of machines supported by this driver */
738 static const struct of_device_id mtk_cpufreq_machines[] __initconst = {
739 { .compatible = "mediatek,mt2701", .data = &mt2701_platform_data },
740 { .compatible = "mediatek,mt2712", .data = &mt2701_platform_data },
741 { .compatible = "mediatek,mt7622", .data = &mt7622_platform_data },
742 { .compatible = "mediatek,mt7623", .data = &mt7623_platform_data },
743 { .compatible = "mediatek,mt8167", .data = &mt8516_platform_data },
744 { .compatible = "mediatek,mt817x", .data = &mt2701_platform_data },
745 { .compatible = "mediatek,mt8173", .data = &mt2701_platform_data },
746 { .compatible = "mediatek,mt8176", .data = &mt2701_platform_data },
747 { .compatible = "mediatek,mt8183", .data = &mt8183_platform_data },
748 { .compatible = "mediatek,mt8186", .data = &mt8186_platform_data },
749 { .compatible = "mediatek,mt8365", .data = &mt2701_platform_data },
750 { .compatible = "mediatek,mt8516", .data = &mt8516_platform_data },
753 MODULE_DEVICE_TABLE(of, mtk_cpufreq_machines);
755 static int __init mtk_cpufreq_driver_init(void)
757 struct device_node *np;
758 const struct of_device_id *match;
759 const struct mtk_cpufreq_platform_data *data;
762 np = of_find_node_by_path("/");
766 match = of_match_node(mtk_cpufreq_machines, np);
769 pr_debug("Machine is not compatible with mtk-cpufreq\n");
774 err = platform_driver_register(&mtk_cpufreq_platdrv);
779 * Since there's no place to hold device registration code and no
780 * device tree based way to match cpufreq driver yet, both the driver
781 * and the device registration codes are put here to handle defer
784 cpufreq_pdev = platform_device_register_data(NULL, "mtk-cpufreq", -1,
785 data, sizeof(*data));
786 if (IS_ERR(cpufreq_pdev)) {
787 pr_err("failed to register mtk-cpufreq platform device\n");
788 platform_driver_unregister(&mtk_cpufreq_platdrv);
789 return PTR_ERR(cpufreq_pdev);
794 module_init(mtk_cpufreq_driver_init)
796 static void __exit mtk_cpufreq_driver_exit(void)
798 platform_device_unregister(cpufreq_pdev);
799 platform_driver_unregister(&mtk_cpufreq_platdrv);
801 module_exit(mtk_cpufreq_driver_exit)
803 MODULE_DESCRIPTION("MediaTek CPUFreq driver");
804 MODULE_AUTHOR("Pi-Cheng Chen <pi-cheng.chen@linaro.org>");
805 MODULE_LICENSE("GPL v2");