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