1 /*
2  * drivers/cpufreq/spear-cpufreq.c
3  *
4  * CPU Frequency Scaling for SPEAr platform
5  *
6  * Copyright (C) 2012 ST Microelectronics
7  * Deepak Sikri <deepak.sikri@st.com>
8  *
9  * This file is licensed under the terms of the GNU General Public
10  * License version 2. This program is licensed "as is" without any
11  * warranty of any kind, whether express or implied.
12  */
13 
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 
16 #include <linux/clk.h>
17 #include <linux/cpufreq.h>
18 #include <linux/err.h>
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/of_device.h>
22 #include <linux/slab.h>
23 #include <linux/types.h>
24 
25 /* SPEAr CPUFreq driver data structure */
26 static struct {
27 	struct clk *clk;
28 	unsigned int transition_latency;
29 	struct cpufreq_frequency_table *freq_tbl;
30 	u32 cnt;
31 } spear_cpufreq;
32 
33 static unsigned int spear_cpufreq_get(unsigned int cpu)
34 {
35 	return clk_get_rate(spear_cpufreq.clk) / 1000;
36 }
37 
38 static struct clk *spear1340_cpu_get_possible_parent(unsigned long newfreq)
39 {
40 	struct clk *sys_pclk;
41 	int pclk;
42 	/*
43 	 * In SPEAr1340, cpu clk's parent sys clk can take input from
44 	 * following sources
45 	 */
46 	const char *sys_clk_src[] = {
47 		"sys_syn_clk",
48 		"pll1_clk",
49 		"pll2_clk",
50 		"pll3_clk",
51 	};
52 
53 	/*
54 	 * As sys clk can have multiple source with their own range
55 	 * limitation so we choose possible sources accordingly
56 	 */
57 	if (newfreq <= 300000000)
58 		pclk = 0; /* src is sys_syn_clk */
59 	else if (newfreq > 300000000 && newfreq <= 500000000)
60 		pclk = 3; /* src is pll3_clk */
61 	else if (newfreq == 600000000)
62 		pclk = 1; /* src is pll1_clk */
63 	else
64 		return ERR_PTR(-EINVAL);
65 
66 	/* Get parent to sys clock */
67 	sys_pclk = clk_get(NULL, sys_clk_src[pclk]);
68 	if (IS_ERR(sys_pclk))
69 		pr_err("Failed to get %s clock\n", sys_clk_src[pclk]);
70 
71 	return sys_pclk;
72 }
73 
74 /*
75  * In SPEAr1340, we cannot use newfreq directly because we need to actually
76  * access a source clock (clk) which might not be ancestor of cpu at present.
77  * Hence in SPEAr1340 we would operate on source clock directly before switching
78  * cpu clock to it.
79  */
80 static int spear1340_set_cpu_rate(struct clk *sys_pclk, unsigned long newfreq)
81 {
82 	struct clk *sys_clk;
83 	int ret = 0;
84 
85 	sys_clk = clk_get_parent(spear_cpufreq.clk);
86 	if (IS_ERR(sys_clk)) {
87 		pr_err("failed to get cpu's parent (sys) clock\n");
88 		return PTR_ERR(sys_clk);
89 	}
90 
91 	/* Set the rate of the source clock before changing the parent */
92 	ret = clk_set_rate(sys_pclk, newfreq);
93 	if (ret) {
94 		pr_err("Failed to set sys clk rate to %lu\n", newfreq);
95 		return ret;
96 	}
97 
98 	ret = clk_set_parent(sys_clk, sys_pclk);
99 	if (ret) {
100 		pr_err("Failed to set sys clk parent\n");
101 		return ret;
102 	}
103 
104 	return 0;
105 }
106 
107 static int spear_cpufreq_target(struct cpufreq_policy *policy,
108 		unsigned int index)
109 {
110 	long newfreq;
111 	struct clk *srcclk;
112 	int ret, mult = 1;
113 
114 	newfreq = spear_cpufreq.freq_tbl[index].frequency * 1000;
115 
116 	if (of_machine_is_compatible("st,spear1340")) {
117 		/*
118 		 * SPEAr1340 is special in the sense that due to the possibility
119 		 * of multiple clock sources for cpu clk's parent we can have
120 		 * different clock source for different frequency of cpu clk.
121 		 * Hence we need to choose one from amongst these possible clock
122 		 * sources.
123 		 */
124 		srcclk = spear1340_cpu_get_possible_parent(newfreq);
125 		if (IS_ERR(srcclk)) {
126 			pr_err("Failed to get src clk\n");
127 			return PTR_ERR(srcclk);
128 		}
129 
130 		/* SPEAr1340: src clk is always 2 * intended cpu clk */
131 		mult = 2;
132 	} else {
133 		/*
134 		 * src clock to be altered is ancestor of cpu clock. Hence we
135 		 * can directly work on cpu clk
136 		 */
137 		srcclk = spear_cpufreq.clk;
138 	}
139 
140 	newfreq = clk_round_rate(srcclk, newfreq * mult);
141 	if (newfreq < 0) {
142 		pr_err("clk_round_rate failed for cpu src clock\n");
143 		return newfreq;
144 	}
145 
146 	if (mult == 2)
147 		ret = spear1340_set_cpu_rate(srcclk, newfreq);
148 	else
149 		ret = clk_set_rate(spear_cpufreq.clk, newfreq);
150 
151 	if (ret)
152 		pr_err("CPU Freq: cpu clk_set_rate failed: %d\n", ret);
153 
154 	return ret;
155 }
156 
157 static int spear_cpufreq_init(struct cpufreq_policy *policy)
158 {
159 	return cpufreq_generic_init(policy, spear_cpufreq.freq_tbl,
160 			spear_cpufreq.transition_latency);
161 }
162 
163 static struct cpufreq_driver spear_cpufreq_driver = {
164 	.name		= "cpufreq-spear",
165 	.flags		= CPUFREQ_STICKY,
166 	.verify		= cpufreq_generic_frequency_table_verify,
167 	.target_index	= spear_cpufreq_target,
168 	.get		= spear_cpufreq_get,
169 	.init		= spear_cpufreq_init,
170 	.exit		= cpufreq_generic_exit,
171 	.attr		= cpufreq_generic_attr,
172 };
173 
174 static int spear_cpufreq_driver_init(void)
175 {
176 	struct device_node *np;
177 	const struct property *prop;
178 	struct cpufreq_frequency_table *freq_tbl;
179 	const __be32 *val;
180 	int cnt, i, ret;
181 
182 	np = of_cpu_device_node_get(0);
183 	if (!np) {
184 		pr_err("No cpu node found");
185 		return -ENODEV;
186 	}
187 
188 	if (of_property_read_u32(np, "clock-latency",
189 				&spear_cpufreq.transition_latency))
190 		spear_cpufreq.transition_latency = CPUFREQ_ETERNAL;
191 
192 	prop = of_find_property(np, "cpufreq_tbl", NULL);
193 	if (!prop || !prop->value) {
194 		pr_err("Invalid cpufreq_tbl");
195 		ret = -ENODEV;
196 		goto out_put_node;
197 	}
198 
199 	cnt = prop->length / sizeof(u32);
200 	val = prop->value;
201 
202 	freq_tbl = kmalloc(sizeof(*freq_tbl) * (cnt + 1), GFP_KERNEL);
203 	if (!freq_tbl) {
204 		ret = -ENOMEM;
205 		goto out_put_node;
206 	}
207 
208 	for (i = 0; i < cnt; i++) {
209 		freq_tbl[i].driver_data = i;
210 		freq_tbl[i].frequency = be32_to_cpup(val++);
211 	}
212 
213 	freq_tbl[i].driver_data = i;
214 	freq_tbl[i].frequency = CPUFREQ_TABLE_END;
215 
216 	spear_cpufreq.freq_tbl = freq_tbl;
217 
218 	of_node_put(np);
219 
220 	spear_cpufreq.clk = clk_get(NULL, "cpu_clk");
221 	if (IS_ERR(spear_cpufreq.clk)) {
222 		pr_err("Unable to get CPU clock\n");
223 		ret = PTR_ERR(spear_cpufreq.clk);
224 		goto out_put_mem;
225 	}
226 
227 	ret = cpufreq_register_driver(&spear_cpufreq_driver);
228 	if (!ret)
229 		return 0;
230 
231 	pr_err("failed register driver: %d\n", ret);
232 	clk_put(spear_cpufreq.clk);
233 
234 out_put_mem:
235 	kfree(freq_tbl);
236 	return ret;
237 
238 out_put_node:
239 	of_node_put(np);
240 	return ret;
241 }
242 late_initcall(spear_cpufreq_driver_init);
243 
244 MODULE_AUTHOR("Deepak Sikri <deepak.sikri@st.com>");
245 MODULE_DESCRIPTION("SPEAr CPUFreq driver");
246 MODULE_LICENSE("GPL");
247