1 // SPDX-License-Identifier: GPL-2.0+
3 * CPU frequency scaling support for Armada 37xx platform.
5 * Copyright (C) 2017 Marvell
7 * Gregory CLEMENT <gregory.clement@free-electrons.com>
10 #include <linux/clk.h>
11 #include <linux/cpu.h>
12 #include <linux/cpufreq.h>
13 #include <linux/err.h>
14 #include <linux/interrupt.h>
16 #include <linux/mfd/syscon.h>
17 #include <linux/module.h>
18 #include <linux/of_address.h>
19 #include <linux/of_device.h>
20 #include <linux/of_irq.h>
21 #include <linux/platform_device.h>
22 #include <linux/pm_opp.h>
23 #include <linux/regmap.h>
24 #include <linux/slab.h>
26 #include "cpufreq-dt.h"
28 /* Clk register set */
29 #define ARMADA_37XX_CLK_TBG_SEL 0
30 #define ARMADA_37XX_CLK_TBG_SEL_CPU_OFF 22
32 /* Power management in North Bridge register set */
33 #define ARMADA_37XX_NB_L0L1 0x18
34 #define ARMADA_37XX_NB_L2L3 0x1C
35 #define ARMADA_37XX_NB_TBG_DIV_OFF 13
36 #define ARMADA_37XX_NB_TBG_DIV_MASK 0x7
37 #define ARMADA_37XX_NB_CLK_SEL_OFF 11
38 #define ARMADA_37XX_NB_CLK_SEL_MASK 0x1
39 #define ARMADA_37XX_NB_CLK_SEL_TBG 0x1
40 #define ARMADA_37XX_NB_TBG_SEL_OFF 9
41 #define ARMADA_37XX_NB_TBG_SEL_MASK 0x3
42 #define ARMADA_37XX_NB_VDD_SEL_OFF 6
43 #define ARMADA_37XX_NB_VDD_SEL_MASK 0x3
44 #define ARMADA_37XX_NB_CONFIG_SHIFT 16
45 #define ARMADA_37XX_NB_DYN_MOD 0x24
46 #define ARMADA_37XX_NB_CLK_SEL_EN BIT(26)
47 #define ARMADA_37XX_NB_TBG_EN BIT(28)
48 #define ARMADA_37XX_NB_DIV_EN BIT(29)
49 #define ARMADA_37XX_NB_VDD_EN BIT(30)
50 #define ARMADA_37XX_NB_DFS_EN BIT(31)
51 #define ARMADA_37XX_NB_CPU_LOAD 0x30
52 #define ARMADA_37XX_NB_CPU_LOAD_MASK 0x3
53 #define ARMADA_37XX_DVFS_LOAD_0 0
54 #define ARMADA_37XX_DVFS_LOAD_1 1
55 #define ARMADA_37XX_DVFS_LOAD_2 2
56 #define ARMADA_37XX_DVFS_LOAD_3 3
58 /* AVS register set */
59 #define ARMADA_37XX_AVS_CTL0 0x0
60 #define ARMADA_37XX_AVS_ENABLE BIT(30)
61 #define ARMADA_37XX_AVS_HIGH_VDD_LIMIT 16
62 #define ARMADA_37XX_AVS_LOW_VDD_LIMIT 22
63 #define ARMADA_37XX_AVS_VDD_MASK 0x3F
64 #define ARMADA_37XX_AVS_CTL2 0x8
65 #define ARMADA_37XX_AVS_LOW_VDD_EN BIT(6)
66 #define ARMADA_37XX_AVS_VSET(x) (0x1C + 4 * (x))
69 * On Armada 37xx the Power management manages 4 level of CPU load,
70 * each level can be associated with a CPU clock source, a CPU
71 * divider, a VDD level, etc...
73 #define LOAD_LEVEL_NR 4
75 #define MIN_VOLT_MV 1000
76 #define MIN_VOLT_MV_FOR_L1_1000MHZ 1108
77 #define MIN_VOLT_MV_FOR_L1_1200MHZ 1155
79 /* AVS value for the corresponding voltage (in mV) */
80 static int avs_map[] = {
81 747, 758, 770, 782, 793, 805, 817, 828, 840, 852, 863, 875, 887, 898,
82 910, 922, 933, 945, 957, 968, 980, 992, 1003, 1015, 1027, 1038, 1050,
83 1062, 1073, 1085, 1097, 1108, 1120, 1132, 1143, 1155, 1167, 1178, 1190,
84 1202, 1213, 1225, 1237, 1248, 1260, 1272, 1283, 1295, 1307, 1318, 1330,
88 struct armada37xx_cpufreq_state {
89 struct platform_device *pdev;
90 struct device *cpu_dev;
91 struct regmap *regmap;
98 static struct armada37xx_cpufreq_state *armada37xx_cpufreq_state;
100 struct armada_37xx_dvfs {
102 u8 divider[LOAD_LEVEL_NR];
103 u32 avs[LOAD_LEVEL_NR];
106 static struct armada_37xx_dvfs armada_37xx_dvfs[] = {
108 * The cpufreq scaling for 1.2 GHz variant of the SOC is currently
109 * unstable because we do not know how to configure it properly.
111 /* {.cpu_freq_max = 1200*1000*1000, .divider = {1, 2, 4, 6} }, */
112 {.cpu_freq_max = 1000*1000*1000, .divider = {1, 2, 4, 5} },
113 {.cpu_freq_max = 800*1000*1000, .divider = {1, 2, 3, 4} },
114 {.cpu_freq_max = 600*1000*1000, .divider = {2, 4, 5, 6} },
117 static struct armada_37xx_dvfs *armada_37xx_cpu_freq_info_get(u32 freq)
121 for (i = 0; i < ARRAY_SIZE(armada_37xx_dvfs); i++) {
122 if (freq == armada_37xx_dvfs[i].cpu_freq_max)
123 return &armada_37xx_dvfs[i];
126 pr_err("Unsupported CPU frequency %d MHz\n", freq/1000000);
131 * Setup the four level managed by the hardware. Once the four level
132 * will be configured then the DVFS will be enabled.
134 static void __init armada37xx_cpufreq_dvfs_setup(struct regmap *base,
135 struct regmap *clk_base, u8 *divider)
140 /* Determine to which TBG clock is CPU connected */
141 regmap_read(clk_base, ARMADA_37XX_CLK_TBG_SEL, &cpu_tbg_sel);
142 cpu_tbg_sel >>= ARMADA_37XX_CLK_TBG_SEL_CPU_OFF;
143 cpu_tbg_sel &= ARMADA_37XX_NB_TBG_SEL_MASK;
145 for (load_lvl = 0; load_lvl < LOAD_LEVEL_NR; load_lvl++) {
146 unsigned int reg, mask, val, offset = 0;
148 if (load_lvl <= ARMADA_37XX_DVFS_LOAD_1)
149 reg = ARMADA_37XX_NB_L0L1;
151 reg = ARMADA_37XX_NB_L2L3;
153 if (load_lvl == ARMADA_37XX_DVFS_LOAD_0 ||
154 load_lvl == ARMADA_37XX_DVFS_LOAD_2)
155 offset += ARMADA_37XX_NB_CONFIG_SHIFT;
157 /* Set cpu clock source, for all the level we use TBG */
158 val = ARMADA_37XX_NB_CLK_SEL_TBG << ARMADA_37XX_NB_CLK_SEL_OFF;
159 mask = (ARMADA_37XX_NB_CLK_SEL_MASK
160 << ARMADA_37XX_NB_CLK_SEL_OFF);
162 /* Set TBG index, for all levels we use the same TBG */
163 val = cpu_tbg_sel << ARMADA_37XX_NB_TBG_SEL_OFF;
164 mask = (ARMADA_37XX_NB_TBG_SEL_MASK
165 << ARMADA_37XX_NB_TBG_SEL_OFF);
168 * Set cpu divider based on the pre-computed array in
169 * order to have balanced step.
171 val |= divider[load_lvl] << ARMADA_37XX_NB_TBG_DIV_OFF;
172 mask |= (ARMADA_37XX_NB_TBG_DIV_MASK
173 << ARMADA_37XX_NB_TBG_DIV_OFF);
175 /* Set VDD divider which is actually the load level. */
176 val |= load_lvl << ARMADA_37XX_NB_VDD_SEL_OFF;
177 mask |= (ARMADA_37XX_NB_VDD_SEL_MASK
178 << ARMADA_37XX_NB_VDD_SEL_OFF);
183 regmap_update_bits(base, reg, mask, val);
188 * Find out the armada 37x supported AVS value whose voltage value is
189 * the round-up closest to the target voltage value.
191 static u32 armada_37xx_avs_val_match(int target_vm)
195 /* Find out the round-up closest supported voltage value */
196 for (avs = 0; avs < ARRAY_SIZE(avs_map); avs++)
197 if (avs_map[avs] >= target_vm)
201 * If all supported voltages are smaller than target one,
202 * choose the largest supported voltage
204 if (avs == ARRAY_SIZE(avs_map))
205 avs = ARRAY_SIZE(avs_map) - 1;
211 * For Armada 37xx soc, L0(VSET0) VDD AVS value is set to SVC revision
212 * value or a default value when SVC is not supported.
213 * - L0 can be read out from the register of AVS_CTRL_0 and L0 voltage
214 * can be got from the mapping table of avs_map.
215 * - L1 voltage should be about 100mv smaller than L0 voltage
216 * - L2 & L3 voltage should be about 150mv smaller than L0 voltage.
217 * This function calculates L1 & L2 & L3 AVS values dynamically based
218 * on L0 voltage and fill all AVS values to the AVS value table.
219 * When base CPU frequency is 1000 or 1200 MHz then there is additional
220 * minimal avs value for load L1.
222 static void __init armada37xx_cpufreq_avs_configure(struct regmap *base,
223 struct armada_37xx_dvfs *dvfs)
225 unsigned int target_vm;
232 /* Get L0 VDD min value */
233 regmap_read(base, ARMADA_37XX_AVS_CTL0, &l0_vdd_min);
234 l0_vdd_min = (l0_vdd_min >> ARMADA_37XX_AVS_LOW_VDD_LIMIT) &
235 ARMADA_37XX_AVS_VDD_MASK;
236 if (l0_vdd_min >= ARRAY_SIZE(avs_map)) {
237 pr_err("L0 VDD MIN %d is not correct.\n", l0_vdd_min);
240 dvfs->avs[0] = l0_vdd_min;
242 if (avs_map[l0_vdd_min] <= MIN_VOLT_MV) {
244 * If L0 voltage is smaller than 1000mv, then all VDD sets
247 u32 avs_min = armada_37xx_avs_val_match(MIN_VOLT_MV);
249 for (load_level = 1; load_level < LOAD_LEVEL_NR; load_level++)
250 dvfs->avs[load_level] = avs_min;
253 * Set the avs values for load L0 and L1 when base CPU frequency
254 * is 1000/1200 MHz to its typical initial values according to
255 * the Armada 3700 Hardware Specifications.
257 if (dvfs->cpu_freq_max >= 1000*1000*1000) {
258 if (dvfs->cpu_freq_max >= 1200*1000*1000)
259 avs_min = armada_37xx_avs_val_match(MIN_VOLT_MV_FOR_L1_1200MHZ);
261 avs_min = armada_37xx_avs_val_match(MIN_VOLT_MV_FOR_L1_1000MHZ);
262 dvfs->avs[0] = dvfs->avs[1] = avs_min;
269 * L1 voltage is equal to L0 voltage - 100mv and it must be
273 target_vm = avs_map[l0_vdd_min] - 100;
274 target_vm = target_vm > MIN_VOLT_MV ? target_vm : MIN_VOLT_MV;
275 dvfs->avs[1] = armada_37xx_avs_val_match(target_vm);
278 * L2 & L3 voltage is equal to L0 voltage - 150mv and it must
279 * be larger than 1000mv
281 target_vm = avs_map[l0_vdd_min] - 150;
282 target_vm = target_vm > MIN_VOLT_MV ? target_vm : MIN_VOLT_MV;
283 dvfs->avs[2] = dvfs->avs[3] = armada_37xx_avs_val_match(target_vm);
286 * Fix the avs value for load L1 when base CPU frequency is 1000/1200 MHz,
287 * otherwise the CPU gets stuck when switching from load L1 to load L0.
288 * Also ensure that avs value for load L1 is not higher than for L0.
290 if (dvfs->cpu_freq_max >= 1000*1000*1000) {
293 if (dvfs->cpu_freq_max >= 1200*1000*1000)
294 avs_min_l1 = armada_37xx_avs_val_match(MIN_VOLT_MV_FOR_L1_1200MHZ);
296 avs_min_l1 = armada_37xx_avs_val_match(MIN_VOLT_MV_FOR_L1_1000MHZ);
298 if (avs_min_l1 > dvfs->avs[0])
299 avs_min_l1 = dvfs->avs[0];
301 if (dvfs->avs[1] < avs_min_l1)
302 dvfs->avs[1] = avs_min_l1;
306 static void __init armada37xx_cpufreq_avs_setup(struct regmap *base,
307 struct armada_37xx_dvfs *dvfs)
309 unsigned int avs_val = 0;
315 /* Disable AVS before the configuration */
316 regmap_update_bits(base, ARMADA_37XX_AVS_CTL0,
317 ARMADA_37XX_AVS_ENABLE, 0);
320 /* Enable low voltage mode */
321 regmap_update_bits(base, ARMADA_37XX_AVS_CTL2,
322 ARMADA_37XX_AVS_LOW_VDD_EN,
323 ARMADA_37XX_AVS_LOW_VDD_EN);
326 for (load_level = 1; load_level < LOAD_LEVEL_NR; load_level++) {
327 avs_val = dvfs->avs[load_level];
328 regmap_update_bits(base, ARMADA_37XX_AVS_VSET(load_level-1),
329 ARMADA_37XX_AVS_VDD_MASK << ARMADA_37XX_AVS_HIGH_VDD_LIMIT |
330 ARMADA_37XX_AVS_VDD_MASK << ARMADA_37XX_AVS_LOW_VDD_LIMIT,
331 avs_val << ARMADA_37XX_AVS_HIGH_VDD_LIMIT |
332 avs_val << ARMADA_37XX_AVS_LOW_VDD_LIMIT);
335 /* Enable AVS after the configuration */
336 regmap_update_bits(base, ARMADA_37XX_AVS_CTL0,
337 ARMADA_37XX_AVS_ENABLE,
338 ARMADA_37XX_AVS_ENABLE);
342 static void armada37xx_cpufreq_disable_dvfs(struct regmap *base)
344 unsigned int reg = ARMADA_37XX_NB_DYN_MOD,
345 mask = ARMADA_37XX_NB_DFS_EN;
347 regmap_update_bits(base, reg, mask, 0);
350 static void __init armada37xx_cpufreq_enable_dvfs(struct regmap *base)
352 unsigned int val, reg = ARMADA_37XX_NB_CPU_LOAD,
353 mask = ARMADA_37XX_NB_CPU_LOAD_MASK;
355 /* Start with the highest load (0) */
356 val = ARMADA_37XX_DVFS_LOAD_0;
357 regmap_update_bits(base, reg, mask, val);
359 /* Now enable DVFS for the CPUs */
360 reg = ARMADA_37XX_NB_DYN_MOD;
361 mask = ARMADA_37XX_NB_CLK_SEL_EN | ARMADA_37XX_NB_TBG_EN |
362 ARMADA_37XX_NB_DIV_EN | ARMADA_37XX_NB_VDD_EN |
363 ARMADA_37XX_NB_DFS_EN;
365 regmap_update_bits(base, reg, mask, mask);
368 static int armada37xx_cpufreq_suspend(struct cpufreq_policy *policy)
370 struct armada37xx_cpufreq_state *state = armada37xx_cpufreq_state;
372 regmap_read(state->regmap, ARMADA_37XX_NB_L0L1, &state->nb_l0l1);
373 regmap_read(state->regmap, ARMADA_37XX_NB_L2L3, &state->nb_l2l3);
374 regmap_read(state->regmap, ARMADA_37XX_NB_CPU_LOAD,
375 &state->nb_cpu_load);
376 regmap_read(state->regmap, ARMADA_37XX_NB_DYN_MOD, &state->nb_dyn_mod);
381 static int armada37xx_cpufreq_resume(struct cpufreq_policy *policy)
383 struct armada37xx_cpufreq_state *state = armada37xx_cpufreq_state;
385 /* Ensure DVFS is disabled otherwise the following registers are RO */
386 armada37xx_cpufreq_disable_dvfs(state->regmap);
388 regmap_write(state->regmap, ARMADA_37XX_NB_L0L1, state->nb_l0l1);
389 regmap_write(state->regmap, ARMADA_37XX_NB_L2L3, state->nb_l2l3);
390 regmap_write(state->regmap, ARMADA_37XX_NB_CPU_LOAD,
394 * NB_DYN_MOD register is the one that actually enable back DVFS if it
395 * was enabled before the suspend operation. This must be done last
396 * otherwise other registers are not writable.
398 regmap_write(state->regmap, ARMADA_37XX_NB_DYN_MOD, state->nb_dyn_mod);
403 static int __init armada37xx_cpufreq_driver_init(void)
405 struct cpufreq_dt_platform_data pdata;
406 struct armada_37xx_dvfs *dvfs;
407 struct platform_device *pdev;
409 unsigned int base_frequency;
410 struct regmap *nb_clk_base, *nb_pm_base, *avs_base;
411 struct device *cpu_dev;
413 struct clk *clk, *parent;
416 syscon_regmap_lookup_by_compatible("marvell,armada-3700-periph-clock-nb");
417 if (IS_ERR(nb_clk_base))
421 syscon_regmap_lookup_by_compatible("marvell,armada-3700-nb-pm");
423 if (IS_ERR(nb_pm_base))
427 syscon_regmap_lookup_by_compatible("marvell,armada-3700-avs");
429 /* if AVS is not present don't use it but still try to setup dvfs */
430 if (IS_ERR(avs_base)) {
431 pr_info("Syscon failed for Adapting Voltage Scaling: skip it\n");
434 /* Before doing any configuration on the DVFS first, disable it */
435 armada37xx_cpufreq_disable_dvfs(nb_pm_base);
438 * On CPU 0 register the operating points supported (which are
439 * the nominal CPU frequency and full integer divisions of
442 cpu_dev = get_cpu_device(0);
444 dev_err(cpu_dev, "Cannot get CPU\n");
448 clk = clk_get(cpu_dev, 0);
450 dev_err(cpu_dev, "Cannot get clock for CPU0\n");
454 parent = clk_get_parent(clk);
455 if (IS_ERR(parent)) {
456 dev_err(cpu_dev, "Cannot get parent clock for CPU0\n");
458 return PTR_ERR(parent);
461 /* Get parent CPU frequency */
462 base_frequency = clk_get_rate(parent);
464 if (!base_frequency) {
465 dev_err(cpu_dev, "Failed to get parent clock rate for CPU\n");
470 dvfs = armada_37xx_cpu_freq_info_get(base_frequency);
476 armada37xx_cpufreq_state = kmalloc(sizeof(*armada37xx_cpufreq_state),
478 if (!armada37xx_cpufreq_state) {
483 armada37xx_cpufreq_state->regmap = nb_pm_base;
485 armada37xx_cpufreq_avs_configure(avs_base, dvfs);
486 armada37xx_cpufreq_avs_setup(avs_base, dvfs);
488 armada37xx_cpufreq_dvfs_setup(nb_pm_base, nb_clk_base, dvfs->divider);
491 for (load_lvl = ARMADA_37XX_DVFS_LOAD_0; load_lvl < LOAD_LEVEL_NR;
493 unsigned long u_volt = avs_map[dvfs->avs[load_lvl]] * 1000;
494 freq = base_frequency / dvfs->divider[load_lvl];
495 ret = dev_pm_opp_add(cpu_dev, freq, u_volt);
502 /* Now that everything is setup, enable the DVFS at hardware level */
503 armada37xx_cpufreq_enable_dvfs(nb_pm_base);
505 memset(&pdata, 0, sizeof(pdata));
506 pdata.suspend = armada37xx_cpufreq_suspend;
507 pdata.resume = armada37xx_cpufreq_resume;
509 pdev = platform_device_register_data(NULL, "cpufreq-dt", -1, &pdata,
511 ret = PTR_ERR_OR_ZERO(pdev);
515 armada37xx_cpufreq_state->cpu_dev = cpu_dev;
516 armada37xx_cpufreq_state->pdev = pdev;
517 platform_set_drvdata(pdev, dvfs);
521 armada37xx_cpufreq_disable_dvfs(nb_pm_base);
523 /* clean-up the already added opp before leaving */
524 while (load_lvl-- > ARMADA_37XX_DVFS_LOAD_0) {
525 freq = base_frequency / dvfs->divider[load_lvl];
526 dev_pm_opp_remove(cpu_dev, freq);
529 kfree(armada37xx_cpufreq_state);
533 /* late_initcall, to guarantee the driver is loaded after A37xx clock driver */
534 late_initcall(armada37xx_cpufreq_driver_init);
536 static void __exit armada37xx_cpufreq_driver_exit(void)
538 struct platform_device *pdev = armada37xx_cpufreq_state->pdev;
539 struct armada_37xx_dvfs *dvfs = platform_get_drvdata(pdev);
543 platform_device_unregister(pdev);
545 armada37xx_cpufreq_disable_dvfs(armada37xx_cpufreq_state->regmap);
547 for (load_lvl = ARMADA_37XX_DVFS_LOAD_0; load_lvl < LOAD_LEVEL_NR; load_lvl++) {
548 freq = dvfs->cpu_freq_max / dvfs->divider[load_lvl];
549 dev_pm_opp_remove(armada37xx_cpufreq_state->cpu_dev, freq);
552 kfree(armada37xx_cpufreq_state);
554 module_exit(armada37xx_cpufreq_driver_exit);
556 static const struct of_device_id __maybe_unused armada37xx_cpufreq_of_match[] = {
557 { .compatible = "marvell,armada-3700-nb-pm" },
560 MODULE_DEVICE_TABLE(of, armada37xx_cpufreq_of_match);
562 MODULE_AUTHOR("Gregory CLEMENT <gregory.clement@free-electrons.com>");
563 MODULE_DESCRIPTION("Armada 37xx cpufreq driver");
564 MODULE_LICENSE("GPL");