Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * System Control and Power Interface (SCPI) based CPUFreq Interface driver
4 *
5 * Copyright (C) 2015 ARM Ltd.
6 * Sudeep Holla <sudeep.holla@arm.com>
7 */
8
9#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10
11#include <linux/clk.h>
12#include <linux/cpu.h>
13#include <linux/cpufreq.h>
14#include <linux/cpumask.h>
15#include <linux/export.h>
16#include <linux/module.h>
17#include <linux/platform_device.h>
18#include <linux/pm_opp.h>
19#include <linux/scpi_protocol.h>
20#include <linux/slab.h>
21#include <linux/types.h>
22
23struct scpi_data {
24 struct clk *clk;
25 struct device *cpu_dev;
26};
27
28static struct scpi_ops *scpi_ops;
29
30static unsigned int scpi_cpufreq_get_rate(unsigned int cpu)
31{
32 struct cpufreq_policy *policy = cpufreq_cpu_get_raw(cpu);
33 struct scpi_data *priv = policy->driver_data;
34 unsigned long rate = clk_get_rate(priv->clk);
35
36 return rate / 1000;
37}
38
39static int
40scpi_cpufreq_set_target(struct cpufreq_policy *policy, unsigned int index)
41{
42 u64 rate = policy->freq_table[index].frequency * 1000;
43 struct scpi_data *priv = policy->driver_data;
44 int ret;
45
46 ret = clk_set_rate(priv->clk, rate);
47
48 if (ret)
49 return ret;
50
51 if (clk_get_rate(priv->clk) != rate)
52 return -EIO;
53
54 return 0;
55}
56
57static int
58scpi_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
59{
60 int cpu, domain, tdomain;
61 struct device *tcpu_dev;
62
63 domain = scpi_ops->device_domain_id(cpu_dev);
64 if (domain < 0)
65 return domain;
66
67 for_each_possible_cpu(cpu) {
68 if (cpu == cpu_dev->id)
69 continue;
70
71 tcpu_dev = get_cpu_device(cpu);
72 if (!tcpu_dev)
73 continue;
74
75 tdomain = scpi_ops->device_domain_id(tcpu_dev);
76 if (tdomain == domain)
77 cpumask_set_cpu(cpu, cpumask);
78 }
79
80 return 0;
81}
82
83static int scpi_cpufreq_init(struct cpufreq_policy *policy)
84{
85 int ret;
86 unsigned int latency;
87 struct device *cpu_dev;
88 struct scpi_data *priv;
89 struct cpufreq_frequency_table *freq_table;
90
91 cpu_dev = get_cpu_device(policy->cpu);
92 if (!cpu_dev) {
93 pr_err("failed to get cpu%d device\n", policy->cpu);
94 return -ENODEV;
95 }
96
97 ret = scpi_ops->add_opps_to_device(cpu_dev);
98 if (ret) {
99 dev_warn(cpu_dev, "failed to add opps to the device\n");
100 return ret;
101 }
102
103 ret = scpi_get_sharing_cpus(cpu_dev, policy->cpus);
104 if (ret) {
105 dev_warn(cpu_dev, "failed to get sharing cpumask\n");
106 return ret;
107 }
108
109 ret = dev_pm_opp_set_sharing_cpus(cpu_dev, policy->cpus);
110 if (ret) {
111 dev_err(cpu_dev, "%s: failed to mark OPPs as shared: %d\n",
112 __func__, ret);
113 return ret;
114 }
115
116 ret = dev_pm_opp_get_opp_count(cpu_dev);
117 if (ret <= 0) {
118 dev_dbg(cpu_dev, "OPP table is not ready, deferring probe\n");
119 ret = -EPROBE_DEFER;
120 goto out_free_opp;
121 }
122
123 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
124 if (!priv) {
125 ret = -ENOMEM;
126 goto out_free_opp;
127 }
128
129 ret = dev_pm_opp_init_cpufreq_table(cpu_dev, &freq_table);
130 if (ret) {
131 dev_err(cpu_dev, "failed to init cpufreq table: %d\n", ret);
132 goto out_free_priv;
133 }
134
135 priv->cpu_dev = cpu_dev;
136 priv->clk = clk_get(cpu_dev, NULL);
137 if (IS_ERR(priv->clk)) {
138 dev_err(cpu_dev, "%s: Failed to get clk for cpu: %d\n",
139 __func__, cpu_dev->id);
140 ret = PTR_ERR(priv->clk);
141 goto out_free_cpufreq_table;
142 }
143
144 policy->driver_data = priv;
145 policy->freq_table = freq_table;
146
147 /* scpi allows DVFS request for any domain from any CPU */
148 policy->dvfs_possible_from_any_cpu = true;
149
150 latency = scpi_ops->get_transition_latency(cpu_dev);
151 if (!latency)
152 latency = CPUFREQ_ETERNAL;
153
154 policy->cpuinfo.transition_latency = latency;
155
156 policy->fast_switch_possible = false;
157
158 return 0;
159
160out_free_cpufreq_table:
161 dev_pm_opp_free_cpufreq_table(cpu_dev, &freq_table);
162out_free_priv:
163 kfree(priv);
164out_free_opp:
165 dev_pm_opp_remove_all_dynamic(cpu_dev);
166
167 return ret;
168}
169
170static int scpi_cpufreq_exit(struct cpufreq_policy *policy)
171{
172 struct scpi_data *priv = policy->driver_data;
173
174 clk_put(priv->clk);
175 dev_pm_opp_free_cpufreq_table(priv->cpu_dev, &policy->freq_table);
176 dev_pm_opp_remove_all_dynamic(priv->cpu_dev);
177 kfree(priv);
178
179 return 0;
180}
181
182static struct cpufreq_driver scpi_cpufreq_driver = {
183 .name = "scpi-cpufreq",
184 .flags = CPUFREQ_HAVE_GOVERNOR_PER_POLICY |
185 CPUFREQ_NEED_INITIAL_FREQ_CHECK |
186 CPUFREQ_IS_COOLING_DEV,
187 .verify = cpufreq_generic_frequency_table_verify,
188 .attr = cpufreq_generic_attr,
189 .get = scpi_cpufreq_get_rate,
190 .init = scpi_cpufreq_init,
191 .exit = scpi_cpufreq_exit,
192 .target_index = scpi_cpufreq_set_target,
193 .register_em = cpufreq_register_em_with_opp,
194};
195
196static int scpi_cpufreq_probe(struct platform_device *pdev)
197{
198 int ret;
199
200 scpi_ops = get_scpi_ops();
201 if (!scpi_ops)
202 return -EIO;
203
204 ret = cpufreq_register_driver(&scpi_cpufreq_driver);
205 if (ret)
206 dev_err(&pdev->dev, "%s: registering cpufreq failed, err: %d\n",
207 __func__, ret);
208 return ret;
209}
210
211static void scpi_cpufreq_remove(struct platform_device *pdev)
212{
213 cpufreq_unregister_driver(&scpi_cpufreq_driver);
214 scpi_ops = NULL;
215}
216
217static struct platform_driver scpi_cpufreq_platdrv = {
218 .driver = {
219 .name = "scpi-cpufreq",
220 },
221 .probe = scpi_cpufreq_probe,
222 .remove_new = scpi_cpufreq_remove,
223};
224module_platform_driver(scpi_cpufreq_platdrv);
225
226MODULE_ALIAS("platform:scpi-cpufreq");
227MODULE_AUTHOR("Sudeep Holla <sudeep.holla@arm.com>");
228MODULE_DESCRIPTION("ARM SCPI CPUFreq interface driver");
229MODULE_LICENSE("GPL v2");
1/*
2 * System Control and Power Interface (SCPI) based CPUFreq Interface driver
3 *
4 * Copyright (C) 2015 ARM Ltd.
5 * Sudeep Holla <sudeep.holla@arm.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 *
11 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
12 * kind, whether express or implied; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 */
16
17#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18
19#include <linux/clk.h>
20#include <linux/cpu.h>
21#include <linux/cpufreq.h>
22#include <linux/cpumask.h>
23#include <linux/export.h>
24#include <linux/module.h>
25#include <linux/of_platform.h>
26#include <linux/pm_opp.h>
27#include <linux/scpi_protocol.h>
28#include <linux/slab.h>
29#include <linux/types.h>
30
31struct scpi_data {
32 struct clk *clk;
33 struct device *cpu_dev;
34};
35
36static struct scpi_ops *scpi_ops;
37
38static unsigned int scpi_cpufreq_get_rate(unsigned int cpu)
39{
40 struct cpufreq_policy *policy = cpufreq_cpu_get_raw(cpu);
41 struct scpi_data *priv = policy->driver_data;
42 unsigned long rate = clk_get_rate(priv->clk);
43
44 return rate / 1000;
45}
46
47static int
48scpi_cpufreq_set_target(struct cpufreq_policy *policy, unsigned int index)
49{
50 unsigned long freq = policy->freq_table[index].frequency;
51 struct scpi_data *priv = policy->driver_data;
52 u64 rate = freq * 1000;
53 int ret;
54
55 ret = clk_set_rate(priv->clk, rate);
56
57 if (ret)
58 return ret;
59
60 if (clk_get_rate(priv->clk) != rate)
61 return -EIO;
62
63 arch_set_freq_scale(policy->related_cpus, freq,
64 policy->cpuinfo.max_freq);
65
66 return 0;
67}
68
69static int
70scpi_get_sharing_cpus(struct device *cpu_dev, struct cpumask *cpumask)
71{
72 int cpu, domain, tdomain;
73 struct device *tcpu_dev;
74
75 domain = scpi_ops->device_domain_id(cpu_dev);
76 if (domain < 0)
77 return domain;
78
79 for_each_possible_cpu(cpu) {
80 if (cpu == cpu_dev->id)
81 continue;
82
83 tcpu_dev = get_cpu_device(cpu);
84 if (!tcpu_dev)
85 continue;
86
87 tdomain = scpi_ops->device_domain_id(tcpu_dev);
88 if (tdomain == domain)
89 cpumask_set_cpu(cpu, cpumask);
90 }
91
92 return 0;
93}
94
95static int scpi_cpufreq_init(struct cpufreq_policy *policy)
96{
97 int ret;
98 unsigned int latency;
99 struct device *cpu_dev;
100 struct scpi_data *priv;
101 struct cpufreq_frequency_table *freq_table;
102
103 cpu_dev = get_cpu_device(policy->cpu);
104 if (!cpu_dev) {
105 pr_err("failed to get cpu%d device\n", policy->cpu);
106 return -ENODEV;
107 }
108
109 ret = scpi_ops->add_opps_to_device(cpu_dev);
110 if (ret) {
111 dev_warn(cpu_dev, "failed to add opps to the device\n");
112 return ret;
113 }
114
115 ret = scpi_get_sharing_cpus(cpu_dev, policy->cpus);
116 if (ret) {
117 dev_warn(cpu_dev, "failed to get sharing cpumask\n");
118 return ret;
119 }
120
121 ret = dev_pm_opp_set_sharing_cpus(cpu_dev, policy->cpus);
122 if (ret) {
123 dev_err(cpu_dev, "%s: failed to mark OPPs as shared: %d\n",
124 __func__, ret);
125 return ret;
126 }
127
128 ret = dev_pm_opp_get_opp_count(cpu_dev);
129 if (ret <= 0) {
130 dev_dbg(cpu_dev, "OPP table is not ready, deferring probe\n");
131 ret = -EPROBE_DEFER;
132 goto out_free_opp;
133 }
134
135 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
136 if (!priv) {
137 ret = -ENOMEM;
138 goto out_free_opp;
139 }
140
141 ret = dev_pm_opp_init_cpufreq_table(cpu_dev, &freq_table);
142 if (ret) {
143 dev_err(cpu_dev, "failed to init cpufreq table: %d\n", ret);
144 goto out_free_priv;
145 }
146
147 priv->cpu_dev = cpu_dev;
148 priv->clk = clk_get(cpu_dev, NULL);
149 if (IS_ERR(priv->clk)) {
150 dev_err(cpu_dev, "%s: Failed to get clk for cpu: %d\n",
151 __func__, cpu_dev->id);
152 ret = PTR_ERR(priv->clk);
153 goto out_free_cpufreq_table;
154 }
155
156 policy->driver_data = priv;
157 policy->freq_table = freq_table;
158
159 /* scpi allows DVFS request for any domain from any CPU */
160 policy->dvfs_possible_from_any_cpu = true;
161
162 latency = scpi_ops->get_transition_latency(cpu_dev);
163 if (!latency)
164 latency = CPUFREQ_ETERNAL;
165
166 policy->cpuinfo.transition_latency = latency;
167
168 policy->fast_switch_possible = false;
169
170 dev_pm_opp_of_register_em(cpu_dev, policy->cpus);
171
172 return 0;
173
174out_free_cpufreq_table:
175 dev_pm_opp_free_cpufreq_table(cpu_dev, &freq_table);
176out_free_priv:
177 kfree(priv);
178out_free_opp:
179 dev_pm_opp_remove_all_dynamic(cpu_dev);
180
181 return ret;
182}
183
184static int scpi_cpufreq_exit(struct cpufreq_policy *policy)
185{
186 struct scpi_data *priv = policy->driver_data;
187
188 clk_put(priv->clk);
189 dev_pm_opp_free_cpufreq_table(priv->cpu_dev, &policy->freq_table);
190 dev_pm_opp_remove_all_dynamic(priv->cpu_dev);
191 kfree(priv);
192
193 return 0;
194}
195
196static struct cpufreq_driver scpi_cpufreq_driver = {
197 .name = "scpi-cpufreq",
198 .flags = CPUFREQ_STICKY | CPUFREQ_HAVE_GOVERNOR_PER_POLICY |
199 CPUFREQ_NEED_INITIAL_FREQ_CHECK |
200 CPUFREQ_IS_COOLING_DEV,
201 .verify = cpufreq_generic_frequency_table_verify,
202 .attr = cpufreq_generic_attr,
203 .get = scpi_cpufreq_get_rate,
204 .init = scpi_cpufreq_init,
205 .exit = scpi_cpufreq_exit,
206 .target_index = scpi_cpufreq_set_target,
207};
208
209static int scpi_cpufreq_probe(struct platform_device *pdev)
210{
211 int ret;
212
213 scpi_ops = get_scpi_ops();
214 if (!scpi_ops)
215 return -EIO;
216
217 ret = cpufreq_register_driver(&scpi_cpufreq_driver);
218 if (ret)
219 dev_err(&pdev->dev, "%s: registering cpufreq failed, err: %d\n",
220 __func__, ret);
221 return ret;
222}
223
224static int scpi_cpufreq_remove(struct platform_device *pdev)
225{
226 cpufreq_unregister_driver(&scpi_cpufreq_driver);
227 scpi_ops = NULL;
228 return 0;
229}
230
231static struct platform_driver scpi_cpufreq_platdrv = {
232 .driver = {
233 .name = "scpi-cpufreq",
234 },
235 .probe = scpi_cpufreq_probe,
236 .remove = scpi_cpufreq_remove,
237};
238module_platform_driver(scpi_cpufreq_platdrv);
239
240MODULE_AUTHOR("Sudeep Holla <sudeep.holla@arm.com>");
241MODULE_DESCRIPTION("ARM SCPI CPUFreq interface driver");
242MODULE_LICENSE("GPL v2");