xref: /openbmc/linux/drivers/clk/sprd/pll.c (revision 2209fda3)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Spreadtrum pll clock driver
4 //
5 // Copyright (C) 2015~2017 Spreadtrum, Inc.
6 // Author: Chunyan Zhang <chunyan.zhang@spreadtrum.com>
7 
8 #include <linux/delay.h>
9 #include <linux/err.h>
10 #include <linux/regmap.h>
11 #include <linux/slab.h>
12 
13 #include "pll.h"
14 
15 #define CLK_PLL_1M	1000000
16 #define CLK_PLL_10M	(CLK_PLL_1M * 10)
17 
18 #define pindex(pll, member)		\
19 	(pll->factors[member].shift / (8 * sizeof(pll->regs_num)))
20 
21 #define pshift(pll, member)		\
22 	(pll->factors[member].shift % (8 * sizeof(pll->regs_num)))
23 
24 #define pwidth(pll, member)		\
25 	pll->factors[member].width
26 
27 #define pmask(pll, member)					\
28 	((pwidth(pll, member)) ?				\
29 	GENMASK(pwidth(pll, member) + pshift(pll, member) - 1,	\
30 	pshift(pll, member)) : 0)
31 
32 #define pinternal(pll, cfg, member)	\
33 	(cfg[pindex(pll, member)] & pmask(pll, member))
34 
35 #define pinternal_val(pll, cfg, member)	\
36 	(pinternal(pll, cfg, member) >> pshift(pll, member))
37 
38 static inline unsigned int
39 sprd_pll_read(const struct sprd_pll *pll, u8 index)
40 {
41 	const struct sprd_clk_common *common = &pll->common;
42 	unsigned int val = 0;
43 
44 	if (WARN_ON(index >= pll->regs_num))
45 		return 0;
46 
47 	regmap_read(common->regmap, common->reg + index * 4, &val);
48 
49 	return val;
50 }
51 
52 static inline void
53 sprd_pll_write(const struct sprd_pll *pll, u8 index,
54 				  u32 msk, u32 val)
55 {
56 	const struct sprd_clk_common *common = &pll->common;
57 	unsigned int offset, reg;
58 	int ret = 0;
59 
60 	if (WARN_ON(index >= pll->regs_num))
61 		return;
62 
63 	offset = common->reg + index * 4;
64 	ret = regmap_read(common->regmap, offset, &reg);
65 	if (!ret)
66 		regmap_write(common->regmap, offset, (reg & ~msk) | val);
67 }
68 
69 static unsigned long pll_get_refin(const struct sprd_pll *pll)
70 {
71 	u32 shift, mask, index, refin_id = 3;
72 	const unsigned long refin[4] = { 2, 4, 13, 26 };
73 
74 	if (pwidth(pll, PLL_REFIN)) {
75 		index = pindex(pll, PLL_REFIN);
76 		shift = pshift(pll, PLL_REFIN);
77 		mask = pmask(pll, PLL_REFIN);
78 		refin_id = (sprd_pll_read(pll, index) & mask) >> shift;
79 		if (refin_id > 3)
80 			refin_id = 3;
81 	}
82 
83 	return refin[refin_id];
84 }
85 
86 static u32 pll_get_ibias(u64 rate, const u64 *table)
87 {
88 	u32 i, num = table[0];
89 
90 	for (i = 1; i < num + 1; i++)
91 		if (rate <= table[i])
92 			break;
93 
94 	return (i == num + 1) ? num : i;
95 }
96 
97 static unsigned long _sprd_pll_recalc_rate(const struct sprd_pll *pll,
98 					   unsigned long parent_rate)
99 {
100 	u32 *cfg;
101 	u32 i, mask, regs_num = pll->regs_num;
102 	unsigned long rate, nint, kint = 0;
103 	u64 refin;
104 	u16 k1, k2;
105 
106 	cfg = kcalloc(regs_num, sizeof(*cfg), GFP_KERNEL);
107 	if (!cfg)
108 		return -ENOMEM;
109 
110 	for (i = 0; i < regs_num; i++)
111 		cfg[i] = sprd_pll_read(pll, i);
112 
113 	refin = pll_get_refin(pll);
114 
115 	if (pinternal(pll, cfg, PLL_PREDIV))
116 		refin = refin * 2;
117 
118 	if (pwidth(pll, PLL_POSTDIV) &&
119 	    ((pll->fflag == 1 && pinternal(pll, cfg, PLL_POSTDIV)) ||
120 	     (!pll->fflag && !pinternal(pll, cfg, PLL_POSTDIV))))
121 		refin = refin / 2;
122 
123 	if (!pinternal(pll, cfg, PLL_DIV_S)) {
124 		rate = refin * pinternal_val(pll, cfg, PLL_N) * CLK_PLL_10M;
125 	} else {
126 		nint = pinternal_val(pll, cfg, PLL_NINT);
127 		if (pinternal(pll, cfg, PLL_SDM_EN))
128 			kint = pinternal_val(pll, cfg, PLL_KINT);
129 
130 		mask = pmask(pll, PLL_KINT);
131 
132 		k1 = pll->k1;
133 		k2 = pll->k2;
134 		rate = DIV_ROUND_CLOSEST_ULL(refin * kint * k1,
135 					 ((mask >> __ffs(mask)) + 1)) *
136 					 k2 + refin * nint * CLK_PLL_1M;
137 	}
138 
139 	return rate;
140 }
141 
142 #define SPRD_PLL_WRITE_CHECK(pll, i, mask, val)		\
143 	(((sprd_pll_read(pll, i) & mask) == val) ? 0 : (-EFAULT))
144 
145 static int _sprd_pll_set_rate(const struct sprd_pll *pll,
146 			      unsigned long rate,
147 			      unsigned long parent_rate)
148 {
149 	struct reg_cfg *cfg;
150 	int ret = 0;
151 	u32 mask, shift, width, ibias_val, index;
152 	u32 regs_num = pll->regs_num, i = 0;
153 	unsigned long kint, nint;
154 	u64 tmp, refin, fvco = rate;
155 
156 	cfg = kcalloc(regs_num, sizeof(*cfg), GFP_KERNEL);
157 	if (!cfg)
158 		return -ENOMEM;
159 
160 	refin = pll_get_refin(pll);
161 
162 	mask = pmask(pll, PLL_PREDIV);
163 	index = pindex(pll, PLL_PREDIV);
164 	width = pwidth(pll, PLL_PREDIV);
165 	if (width && (sprd_pll_read(pll, index) & mask))
166 		refin = refin * 2;
167 
168 	mask = pmask(pll, PLL_POSTDIV);
169 	index = pindex(pll, PLL_POSTDIV);
170 	width = pwidth(pll, PLL_POSTDIV);
171 	cfg[index].msk = mask;
172 	if (width && ((pll->fflag == 1 && fvco <= pll->fvco) ||
173 		      (pll->fflag == 0 && fvco > pll->fvco)))
174 		cfg[index].val |= mask;
175 
176 	if (width && fvco <= pll->fvco)
177 		fvco = fvco * 2;
178 
179 	mask = pmask(pll, PLL_DIV_S);
180 	index = pindex(pll, PLL_DIV_S);
181 	cfg[index].val |= mask;
182 	cfg[index].msk |= mask;
183 
184 	mask = pmask(pll, PLL_SDM_EN);
185 	index = pindex(pll, PLL_SDM_EN);
186 	cfg[index].val |= mask;
187 	cfg[index].msk |= mask;
188 
189 	nint = do_div(fvco, refin * CLK_PLL_1M);
190 	mask = pmask(pll, PLL_NINT);
191 	index = pindex(pll, PLL_NINT);
192 	shift = pshift(pll, PLL_NINT);
193 	cfg[index].val |= (nint << shift) & mask;
194 	cfg[index].msk |= mask;
195 
196 	mask = pmask(pll, PLL_KINT);
197 	index = pindex(pll, PLL_KINT);
198 	width = pwidth(pll, PLL_KINT);
199 	shift = pshift(pll, PLL_KINT);
200 	tmp = fvco - refin * nint * CLK_PLL_1M;
201 	tmp = do_div(tmp, 10000) * ((mask >> shift) + 1);
202 	kint = DIV_ROUND_CLOSEST_ULL(tmp, refin * 100);
203 	cfg[index].val |= (kint << shift) & mask;
204 	cfg[index].msk |= mask;
205 
206 	ibias_val = pll_get_ibias(fvco, pll->itable);
207 
208 	mask = pmask(pll, PLL_IBIAS);
209 	index = pindex(pll, PLL_IBIAS);
210 	shift = pshift(pll, PLL_IBIAS);
211 	cfg[index].val |= ibias_val << shift & mask;
212 	cfg[index].msk |= mask;
213 
214 	for (i = 0; i < regs_num; i++) {
215 		if (cfg[i].msk) {
216 			sprd_pll_write(pll, i, cfg[i].msk, cfg[i].val);
217 			ret |= SPRD_PLL_WRITE_CHECK(pll, i, cfg[i].msk,
218 						   cfg[i].val);
219 		}
220 	}
221 
222 	if (!ret)
223 		udelay(pll->udelay);
224 
225 	return ret;
226 }
227 
228 static unsigned long sprd_pll_recalc_rate(struct clk_hw *hw,
229 					  unsigned long parent_rate)
230 {
231 	struct sprd_pll *pll = hw_to_sprd_pll(hw);
232 
233 	return _sprd_pll_recalc_rate(pll, parent_rate);
234 }
235 
236 static int sprd_pll_set_rate(struct clk_hw *hw,
237 			     unsigned long rate,
238 			     unsigned long parent_rate)
239 {
240 	struct sprd_pll *pll = hw_to_sprd_pll(hw);
241 
242 	return _sprd_pll_set_rate(pll, rate, parent_rate);
243 }
244 
245 static int sprd_pll_clk_prepare(struct clk_hw *hw)
246 {
247 	struct sprd_pll *pll = hw_to_sprd_pll(hw);
248 
249 	udelay(pll->udelay);
250 
251 	return 0;
252 }
253 
254 static long sprd_pll_round_rate(struct clk_hw *hw, unsigned long rate,
255 				unsigned long *prate)
256 {
257 	return rate;
258 }
259 
260 const struct clk_ops sprd_pll_ops = {
261 	.prepare = sprd_pll_clk_prepare,
262 	.recalc_rate = sprd_pll_recalc_rate,
263 	.round_rate = sprd_pll_round_rate,
264 	.set_rate = sprd_pll_set_rate,
265 };
266 EXPORT_SYMBOL_GPL(sprd_pll_ops);
267