1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2018, The Linux Foundation. All rights reserved.
6 #include <linux/bitfield.h>
7 #include <linux/cpufreq.h>
8 #include <linux/init.h>
9 #include <linux/interconnect.h>
10 #include <linux/interrupt.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/of_address.h>
14 #include <linux/of_platform.h>
15 #include <linux/pm_opp.h>
16 #include <linux/slab.h>
17 #include <linux/spinlock.h>
19 #define LUT_MAX_ENTRIES 40U
20 #define LUT_SRC GENMASK(31, 30)
21 #define LUT_L_VAL GENMASK(7, 0)
22 #define LUT_CORE_COUNT GENMASK(18, 16)
23 #define LUT_VOLT GENMASK(11, 0)
25 #define LUT_TURBO_IND 1
27 #define GT_IRQ_STATUS BIT(2)
29 #define HZ_PER_KHZ 1000
31 struct qcom_cpufreq_soc_data {
42 struct qcom_cpufreq_data {
45 const struct qcom_cpufreq_soc_data *soc_data;
48 * Mutex to synchronize between de-init sequence and re-starting LMh
51 struct mutex throttle_lock;
54 struct delayed_work throttle_work;
55 struct cpufreq_policy *policy;
58 static unsigned long cpu_hw_rate, xo_rate;
59 static bool icc_scaling_enabled;
61 static int qcom_cpufreq_set_bw(struct cpufreq_policy *policy,
62 unsigned long freq_khz)
64 unsigned long freq_hz = freq_khz * 1000;
65 struct dev_pm_opp *opp;
69 dev = get_cpu_device(policy->cpu);
73 opp = dev_pm_opp_find_freq_exact(dev, freq_hz, true);
77 ret = dev_pm_opp_set_opp(dev, opp);
82 static int qcom_cpufreq_update_opp(struct device *cpu_dev,
83 unsigned long freq_khz,
86 unsigned long freq_hz = freq_khz * 1000;
89 /* Skip voltage update if the opp table is not available */
90 if (!icc_scaling_enabled)
91 return dev_pm_opp_add(cpu_dev, freq_hz, volt);
93 ret = dev_pm_opp_adjust_voltage(cpu_dev, freq_hz, volt, volt, volt);
95 dev_err(cpu_dev, "Voltage update failed freq=%ld\n", freq_khz);
99 return dev_pm_opp_enable(cpu_dev, freq_hz);
102 static int qcom_cpufreq_hw_target_index(struct cpufreq_policy *policy,
105 struct qcom_cpufreq_data *data = policy->driver_data;
106 const struct qcom_cpufreq_soc_data *soc_data = data->soc_data;
107 unsigned long freq = policy->freq_table[index].frequency;
109 writel_relaxed(index, data->base + soc_data->reg_perf_state);
111 if (icc_scaling_enabled)
112 qcom_cpufreq_set_bw(policy, freq);
117 static unsigned int qcom_cpufreq_hw_get(unsigned int cpu)
119 struct qcom_cpufreq_data *data;
120 const struct qcom_cpufreq_soc_data *soc_data;
121 struct cpufreq_policy *policy;
124 policy = cpufreq_cpu_get_raw(cpu);
128 data = policy->driver_data;
129 soc_data = data->soc_data;
131 index = readl_relaxed(data->base + soc_data->reg_perf_state);
132 index = min(index, LUT_MAX_ENTRIES - 1);
134 return policy->freq_table[index].frequency;
137 static unsigned int qcom_cpufreq_hw_fast_switch(struct cpufreq_policy *policy,
138 unsigned int target_freq)
140 struct qcom_cpufreq_data *data = policy->driver_data;
141 const struct qcom_cpufreq_soc_data *soc_data = data->soc_data;
144 index = policy->cached_resolved_idx;
145 writel_relaxed(index, data->base + soc_data->reg_perf_state);
147 return policy->freq_table[index].frequency;
150 static int qcom_cpufreq_hw_read_lut(struct device *cpu_dev,
151 struct cpufreq_policy *policy)
153 u32 data, src, lval, i, core_count, prev_freq = 0, freq;
155 struct cpufreq_frequency_table *table;
156 struct dev_pm_opp *opp;
159 struct qcom_cpufreq_data *drv_data = policy->driver_data;
160 const struct qcom_cpufreq_soc_data *soc_data = drv_data->soc_data;
162 table = kcalloc(LUT_MAX_ENTRIES + 1, sizeof(*table), GFP_KERNEL);
166 ret = dev_pm_opp_of_add_table(cpu_dev);
168 /* Disable all opps and cross-validate against LUT later */
169 icc_scaling_enabled = true;
170 for (rate = 0; ; rate++) {
171 opp = dev_pm_opp_find_freq_ceil(cpu_dev, &rate);
176 dev_pm_opp_disable(cpu_dev, rate);
178 } else if (ret != -ENODEV) {
179 dev_err(cpu_dev, "Invalid opp table in device tree\n");
183 policy->fast_switch_possible = true;
184 icc_scaling_enabled = false;
187 for (i = 0; i < LUT_MAX_ENTRIES; i++) {
188 data = readl_relaxed(drv_data->base + soc_data->reg_freq_lut +
189 i * soc_data->lut_row_size);
190 src = FIELD_GET(LUT_SRC, data);
191 lval = FIELD_GET(LUT_L_VAL, data);
192 core_count = FIELD_GET(LUT_CORE_COUNT, data);
194 data = readl_relaxed(drv_data->base + soc_data->reg_volt_lut +
195 i * soc_data->lut_row_size);
196 volt = FIELD_GET(LUT_VOLT, data) * 1000;
199 freq = xo_rate * lval / 1000;
201 freq = cpu_hw_rate / 1000;
203 if (freq != prev_freq && core_count != LUT_TURBO_IND) {
204 if (!qcom_cpufreq_update_opp(cpu_dev, freq, volt)) {
205 table[i].frequency = freq;
206 dev_dbg(cpu_dev, "index=%d freq=%d, core_count %d\n", i,
209 dev_warn(cpu_dev, "failed to update OPP for freq=%d\n", freq);
210 table[i].frequency = CPUFREQ_ENTRY_INVALID;
213 } else if (core_count == LUT_TURBO_IND) {
214 table[i].frequency = CPUFREQ_ENTRY_INVALID;
218 * Two of the same frequencies with the same core counts means
221 if (i > 0 && prev_freq == freq) {
222 struct cpufreq_frequency_table *prev = &table[i - 1];
225 * Only treat the last frequency that might be a boost
226 * as the boost frequency
228 if (prev->frequency == CPUFREQ_ENTRY_INVALID) {
229 if (!qcom_cpufreq_update_opp(cpu_dev, prev_freq, volt)) {
230 prev->frequency = prev_freq;
231 prev->flags = CPUFREQ_BOOST_FREQ;
233 dev_warn(cpu_dev, "failed to update OPP for freq=%d\n",
244 table[i].frequency = CPUFREQ_TABLE_END;
245 policy->freq_table = table;
246 dev_pm_opp_set_sharing_cpus(cpu_dev, policy->cpus);
251 static void qcom_get_related_cpus(int index, struct cpumask *m)
253 struct device_node *cpu_np;
254 struct of_phandle_args args;
257 for_each_possible_cpu(cpu) {
258 cpu_np = of_cpu_device_node_get(cpu);
262 ret = of_parse_phandle_with_args(cpu_np, "qcom,freq-domain",
263 "#freq-domain-cells", 0,
269 if (index == args.args[0])
270 cpumask_set_cpu(cpu, m);
274 static unsigned long qcom_lmh_get_throttle_freq(struct qcom_cpufreq_data *data)
278 if (data->soc_data->reg_current_vote)
279 lval = readl_relaxed(data->base + data->soc_data->reg_current_vote) & 0x3ff;
281 lval = readl_relaxed(data->base + data->soc_data->reg_domain_state) & 0xff;
283 return lval * xo_rate;
286 static void qcom_lmh_dcvs_notify(struct qcom_cpufreq_data *data)
288 unsigned long max_capacity, capacity, freq_hz, throttled_freq;
289 struct cpufreq_policy *policy = data->policy;
290 int cpu = cpumask_first(policy->related_cpus);
291 struct device *dev = get_cpu_device(cpu);
292 struct dev_pm_opp *opp;
295 * Get the h/w throttled frequency, normalize it using the
296 * registered opp table and use it to calculate thermal pressure.
298 freq_hz = qcom_lmh_get_throttle_freq(data);
300 opp = dev_pm_opp_find_freq_floor(dev, &freq_hz);
301 if (IS_ERR(opp) && PTR_ERR(opp) == -ERANGE)
302 dev_pm_opp_find_freq_ceil(dev, &freq_hz);
304 throttled_freq = freq_hz / HZ_PER_KHZ;
306 /* Update thermal pressure */
308 max_capacity = arch_scale_cpu_capacity(cpu);
309 capacity = mult_frac(max_capacity, throttled_freq, policy->cpuinfo.max_freq);
311 /* Don't pass boost capacity to scheduler */
312 if (capacity > max_capacity)
313 capacity = max_capacity;
315 arch_set_thermal_pressure(policy->related_cpus,
316 max_capacity - capacity);
319 * In the unlikely case policy is unregistered do not enable
320 * polling or h/w interrupt
322 mutex_lock(&data->throttle_lock);
323 if (data->cancel_throttle)
327 * If h/w throttled frequency is higher than what cpufreq has requested
328 * for, then stop polling and switch back to interrupt mechanism.
330 if (throttled_freq >= qcom_cpufreq_hw_get(cpu))
331 enable_irq(data->throttle_irq);
333 mod_delayed_work(system_highpri_wq, &data->throttle_work,
334 msecs_to_jiffies(10));
337 mutex_unlock(&data->throttle_lock);
340 static void qcom_lmh_dcvs_poll(struct work_struct *work)
342 struct qcom_cpufreq_data *data;
344 data = container_of(work, struct qcom_cpufreq_data, throttle_work.work);
345 qcom_lmh_dcvs_notify(data);
348 static irqreturn_t qcom_lmh_dcvs_handle_irq(int irq, void *data)
350 struct qcom_cpufreq_data *c_data = data;
352 /* Disable interrupt and enable polling */
353 disable_irq_nosync(c_data->throttle_irq);
354 schedule_delayed_work(&c_data->throttle_work, 0);
356 if (c_data->soc_data->reg_intr_clr)
357 writel_relaxed(GT_IRQ_STATUS,
358 c_data->base + c_data->soc_data->reg_intr_clr);
363 static const struct qcom_cpufreq_soc_data qcom_soc_data = {
365 .reg_freq_lut = 0x110,
366 .reg_volt_lut = 0x114,
367 .reg_current_vote = 0x704,
368 .reg_perf_state = 0x920,
372 static const struct qcom_cpufreq_soc_data epss_soc_data = {
374 .reg_domain_state = 0x20,
375 .reg_freq_lut = 0x100,
376 .reg_volt_lut = 0x200,
377 .reg_intr_clr = 0x308,
378 .reg_perf_state = 0x320,
382 static const struct of_device_id qcom_cpufreq_hw_match[] = {
383 { .compatible = "qcom,cpufreq-hw", .data = &qcom_soc_data },
384 { .compatible = "qcom,cpufreq-epss", .data = &epss_soc_data },
387 MODULE_DEVICE_TABLE(of, qcom_cpufreq_hw_match);
389 static int qcom_cpufreq_hw_lmh_init(struct cpufreq_policy *policy, int index)
391 struct qcom_cpufreq_data *data = policy->driver_data;
392 struct platform_device *pdev = cpufreq_get_driver_data();
397 * Look for LMh interrupt. If no interrupt line is specified /
398 * if there is an error, allow cpufreq to be enabled as usual.
400 data->throttle_irq = platform_get_irq(pdev, index);
401 if (data->throttle_irq <= 0)
402 return data->throttle_irq == -EPROBE_DEFER ? -EPROBE_DEFER : 0;
404 data->cancel_throttle = false;
405 data->policy = policy;
407 mutex_init(&data->throttle_lock);
408 INIT_DEFERRABLE_WORK(&data->throttle_work, qcom_lmh_dcvs_poll);
410 snprintf(irq_name, sizeof(irq_name), "dcvsh-irq-%u", policy->cpu);
411 ret = request_threaded_irq(data->throttle_irq, NULL, qcom_lmh_dcvs_handle_irq,
412 IRQF_ONESHOT, irq_name, data);
414 dev_err(&pdev->dev, "Error registering %s: %d\n", irq_name, ret);
421 static void qcom_cpufreq_hw_lmh_exit(struct qcom_cpufreq_data *data)
423 if (data->throttle_irq <= 0)
426 mutex_lock(&data->throttle_lock);
427 data->cancel_throttle = true;
428 mutex_unlock(&data->throttle_lock);
430 cancel_delayed_work_sync(&data->throttle_work);
431 free_irq(data->throttle_irq, data);
434 static int qcom_cpufreq_hw_cpu_init(struct cpufreq_policy *policy)
436 struct platform_device *pdev = cpufreq_get_driver_data();
437 struct device *dev = &pdev->dev;
438 struct of_phandle_args args;
439 struct device_node *cpu_np;
440 struct device *cpu_dev;
441 struct resource *res;
443 struct qcom_cpufreq_data *data;
446 cpu_dev = get_cpu_device(policy->cpu);
448 pr_err("%s: failed to get cpu%d device\n", __func__,
453 cpu_np = of_cpu_device_node_get(policy->cpu);
457 ret = of_parse_phandle_with_args(cpu_np, "qcom,freq-domain",
458 "#freq-domain-cells", 0, &args);
463 index = args.args[0];
465 res = platform_get_resource(pdev, IORESOURCE_MEM, index);
467 dev_err(dev, "failed to get mem resource %d\n", index);
471 if (!request_mem_region(res->start, resource_size(res), res->name)) {
472 dev_err(dev, "failed to request resource %pR\n", res);
476 base = ioremap(res->start, resource_size(res));
478 dev_err(dev, "failed to map resource %pR\n", res);
483 data = kzalloc(sizeof(*data), GFP_KERNEL);
489 data->soc_data = of_device_get_match_data(&pdev->dev);
493 /* HW should be in enabled state to proceed */
494 if (!(readl_relaxed(base + data->soc_data->reg_enable) & 0x1)) {
495 dev_err(dev, "Domain-%d cpufreq hardware not enabled\n", index);
500 qcom_get_related_cpus(index, policy->cpus);
501 if (!cpumask_weight(policy->cpus)) {
502 dev_err(dev, "Domain-%d failed to get related CPUs\n", index);
507 policy->driver_data = data;
508 policy->dvfs_possible_from_any_cpu = true;
510 ret = qcom_cpufreq_hw_read_lut(cpu_dev, policy);
512 dev_err(dev, "Domain-%d failed to read LUT\n", index);
516 ret = dev_pm_opp_get_opp_count(cpu_dev);
518 dev_err(cpu_dev, "Failed to add OPPs\n");
523 if (policy_has_boost_freq(policy)) {
524 ret = cpufreq_enable_boost_support();
526 dev_warn(cpu_dev, "failed to enable boost: %d\n", ret);
529 ret = qcom_cpufreq_hw_lmh_init(policy, index);
539 release_mem_region(res->start, resource_size(res));
543 static int qcom_cpufreq_hw_cpu_exit(struct cpufreq_policy *policy)
545 struct device *cpu_dev = get_cpu_device(policy->cpu);
546 struct qcom_cpufreq_data *data = policy->driver_data;
547 struct resource *res = data->res;
548 void __iomem *base = data->base;
550 dev_pm_opp_remove_all_dynamic(cpu_dev);
551 dev_pm_opp_of_cpumask_remove_table(policy->related_cpus);
552 qcom_cpufreq_hw_lmh_exit(data);
553 kfree(policy->freq_table);
556 release_mem_region(res->start, resource_size(res));
561 static struct freq_attr *qcom_cpufreq_hw_attr[] = {
562 &cpufreq_freq_attr_scaling_available_freqs,
563 &cpufreq_freq_attr_scaling_boost_freqs,
567 static struct cpufreq_driver cpufreq_qcom_hw_driver = {
568 .flags = CPUFREQ_NEED_INITIAL_FREQ_CHECK |
569 CPUFREQ_HAVE_GOVERNOR_PER_POLICY |
570 CPUFREQ_IS_COOLING_DEV,
571 .verify = cpufreq_generic_frequency_table_verify,
572 .target_index = qcom_cpufreq_hw_target_index,
573 .get = qcom_cpufreq_hw_get,
574 .init = qcom_cpufreq_hw_cpu_init,
575 .exit = qcom_cpufreq_hw_cpu_exit,
576 .register_em = cpufreq_register_em_with_opp,
577 .fast_switch = qcom_cpufreq_hw_fast_switch,
578 .name = "qcom-cpufreq-hw",
579 .attr = qcom_cpufreq_hw_attr,
582 static int qcom_cpufreq_hw_driver_probe(struct platform_device *pdev)
584 struct device *cpu_dev;
588 clk = clk_get(&pdev->dev, "xo");
592 xo_rate = clk_get_rate(clk);
595 clk = clk_get(&pdev->dev, "alternate");
599 cpu_hw_rate = clk_get_rate(clk) / CLK_HW_DIV;
602 cpufreq_qcom_hw_driver.driver_data = pdev;
604 /* Check for optional interconnect paths on CPU0 */
605 cpu_dev = get_cpu_device(0);
607 return -EPROBE_DEFER;
609 ret = dev_pm_opp_of_find_icc_paths(cpu_dev, NULL);
613 ret = cpufreq_register_driver(&cpufreq_qcom_hw_driver);
615 dev_err(&pdev->dev, "CPUFreq HW driver failed to register\n");
617 dev_dbg(&pdev->dev, "QCOM CPUFreq HW driver initialized\n");
622 static int qcom_cpufreq_hw_driver_remove(struct platform_device *pdev)
624 return cpufreq_unregister_driver(&cpufreq_qcom_hw_driver);
627 static struct platform_driver qcom_cpufreq_hw_driver = {
628 .probe = qcom_cpufreq_hw_driver_probe,
629 .remove = qcom_cpufreq_hw_driver_remove,
631 .name = "qcom-cpufreq-hw",
632 .of_match_table = qcom_cpufreq_hw_match,
636 static int __init qcom_cpufreq_hw_init(void)
638 return platform_driver_register(&qcom_cpufreq_hw_driver);
640 postcore_initcall(qcom_cpufreq_hw_init);
642 static void __exit qcom_cpufreq_hw_exit(void)
644 platform_driver_unregister(&qcom_cpufreq_hw_driver);
646 module_exit(qcom_cpufreq_hw_exit);
648 MODULE_DESCRIPTION("QCOM CPUFREQ HW Driver");
649 MODULE_LICENSE("GPL v2");