xref: /OK3568_Linux_fs/kernel/drivers/clk/sunxi-ng/ccu_nkmp.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2016 Maxime Ripard
4*4882a593Smuzhiyun  * Maxime Ripard <maxime.ripard@free-electrons.com>
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/clk-provider.h>
8*4882a593Smuzhiyun #include <linux/io.h>
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include "ccu_gate.h"
11*4882a593Smuzhiyun #include "ccu_nkmp.h"
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun struct _ccu_nkmp {
14*4882a593Smuzhiyun 	unsigned long	n, min_n, max_n;
15*4882a593Smuzhiyun 	unsigned long	k, min_k, max_k;
16*4882a593Smuzhiyun 	unsigned long	m, min_m, max_m;
17*4882a593Smuzhiyun 	unsigned long	p, min_p, max_p;
18*4882a593Smuzhiyun };
19*4882a593Smuzhiyun 
ccu_nkmp_calc_rate(unsigned long parent,unsigned long n,unsigned long k,unsigned long m,unsigned long p)20*4882a593Smuzhiyun static unsigned long ccu_nkmp_calc_rate(unsigned long parent,
21*4882a593Smuzhiyun 					unsigned long n, unsigned long k,
22*4882a593Smuzhiyun 					unsigned long m, unsigned long p)
23*4882a593Smuzhiyun {
24*4882a593Smuzhiyun 	u64 rate = parent;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	rate *= n * k;
27*4882a593Smuzhiyun 	do_div(rate, m * p);
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	return rate;
30*4882a593Smuzhiyun }
31*4882a593Smuzhiyun 
ccu_nkmp_find_best(unsigned long parent,unsigned long rate,struct _ccu_nkmp * nkmp)32*4882a593Smuzhiyun static void ccu_nkmp_find_best(unsigned long parent, unsigned long rate,
33*4882a593Smuzhiyun 			       struct _ccu_nkmp *nkmp)
34*4882a593Smuzhiyun {
35*4882a593Smuzhiyun 	unsigned long best_rate = 0;
36*4882a593Smuzhiyun 	unsigned long best_n = 0, best_k = 0, best_m = 0, best_p = 0;
37*4882a593Smuzhiyun 	unsigned long _n, _k, _m, _p;
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun 	for (_k = nkmp->min_k; _k <= nkmp->max_k; _k++) {
40*4882a593Smuzhiyun 		for (_n = nkmp->min_n; _n <= nkmp->max_n; _n++) {
41*4882a593Smuzhiyun 			for (_m = nkmp->min_m; _m <= nkmp->max_m; _m++) {
42*4882a593Smuzhiyun 				for (_p = nkmp->min_p; _p <= nkmp->max_p; _p <<= 1) {
43*4882a593Smuzhiyun 					unsigned long tmp_rate;
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 					tmp_rate = ccu_nkmp_calc_rate(parent,
46*4882a593Smuzhiyun 								      _n, _k,
47*4882a593Smuzhiyun 								      _m, _p);
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 					if (tmp_rate > rate)
50*4882a593Smuzhiyun 						continue;
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 					if ((rate - tmp_rate) < (rate - best_rate)) {
53*4882a593Smuzhiyun 						best_rate = tmp_rate;
54*4882a593Smuzhiyun 						best_n = _n;
55*4882a593Smuzhiyun 						best_k = _k;
56*4882a593Smuzhiyun 						best_m = _m;
57*4882a593Smuzhiyun 						best_p = _p;
58*4882a593Smuzhiyun 					}
59*4882a593Smuzhiyun 				}
60*4882a593Smuzhiyun 			}
61*4882a593Smuzhiyun 		}
62*4882a593Smuzhiyun 	}
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	nkmp->n = best_n;
65*4882a593Smuzhiyun 	nkmp->k = best_k;
66*4882a593Smuzhiyun 	nkmp->m = best_m;
67*4882a593Smuzhiyun 	nkmp->p = best_p;
68*4882a593Smuzhiyun }
69*4882a593Smuzhiyun 
ccu_nkmp_disable(struct clk_hw * hw)70*4882a593Smuzhiyun static void ccu_nkmp_disable(struct clk_hw *hw)
71*4882a593Smuzhiyun {
72*4882a593Smuzhiyun 	struct ccu_nkmp *nkmp = hw_to_ccu_nkmp(hw);
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	return ccu_gate_helper_disable(&nkmp->common, nkmp->enable);
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun 
ccu_nkmp_enable(struct clk_hw * hw)77*4882a593Smuzhiyun static int ccu_nkmp_enable(struct clk_hw *hw)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun 	struct ccu_nkmp *nkmp = hw_to_ccu_nkmp(hw);
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	return ccu_gate_helper_enable(&nkmp->common, nkmp->enable);
82*4882a593Smuzhiyun }
83*4882a593Smuzhiyun 
ccu_nkmp_is_enabled(struct clk_hw * hw)84*4882a593Smuzhiyun static int ccu_nkmp_is_enabled(struct clk_hw *hw)
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	struct ccu_nkmp *nkmp = hw_to_ccu_nkmp(hw);
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 	return ccu_gate_helper_is_enabled(&nkmp->common, nkmp->enable);
89*4882a593Smuzhiyun }
90*4882a593Smuzhiyun 
ccu_nkmp_recalc_rate(struct clk_hw * hw,unsigned long parent_rate)91*4882a593Smuzhiyun static unsigned long ccu_nkmp_recalc_rate(struct clk_hw *hw,
92*4882a593Smuzhiyun 					unsigned long parent_rate)
93*4882a593Smuzhiyun {
94*4882a593Smuzhiyun 	struct ccu_nkmp *nkmp = hw_to_ccu_nkmp(hw);
95*4882a593Smuzhiyun 	unsigned long n, m, k, p, rate;
96*4882a593Smuzhiyun 	u32 reg;
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	reg = readl(nkmp->common.base + nkmp->common.reg);
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	n = reg >> nkmp->n.shift;
101*4882a593Smuzhiyun 	n &= (1 << nkmp->n.width) - 1;
102*4882a593Smuzhiyun 	n += nkmp->n.offset;
103*4882a593Smuzhiyun 	if (!n)
104*4882a593Smuzhiyun 		n++;
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	k = reg >> nkmp->k.shift;
107*4882a593Smuzhiyun 	k &= (1 << nkmp->k.width) - 1;
108*4882a593Smuzhiyun 	k += nkmp->k.offset;
109*4882a593Smuzhiyun 	if (!k)
110*4882a593Smuzhiyun 		k++;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	m = reg >> nkmp->m.shift;
113*4882a593Smuzhiyun 	m &= (1 << nkmp->m.width) - 1;
114*4882a593Smuzhiyun 	m += nkmp->m.offset;
115*4882a593Smuzhiyun 	if (!m)
116*4882a593Smuzhiyun 		m++;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	p = reg >> nkmp->p.shift;
119*4882a593Smuzhiyun 	p &= (1 << nkmp->p.width) - 1;
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	rate = ccu_nkmp_calc_rate(parent_rate, n, k, m, 1 << p);
122*4882a593Smuzhiyun 	if (nkmp->common.features & CCU_FEATURE_FIXED_POSTDIV)
123*4882a593Smuzhiyun 		rate /= nkmp->fixed_post_div;
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	return rate;
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun 
ccu_nkmp_round_rate(struct clk_hw * hw,unsigned long rate,unsigned long * parent_rate)128*4882a593Smuzhiyun static long ccu_nkmp_round_rate(struct clk_hw *hw, unsigned long rate,
129*4882a593Smuzhiyun 			      unsigned long *parent_rate)
130*4882a593Smuzhiyun {
131*4882a593Smuzhiyun 	struct ccu_nkmp *nkmp = hw_to_ccu_nkmp(hw);
132*4882a593Smuzhiyun 	struct _ccu_nkmp _nkmp;
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 	if (nkmp->common.features & CCU_FEATURE_FIXED_POSTDIV)
135*4882a593Smuzhiyun 		rate *= nkmp->fixed_post_div;
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	if (nkmp->max_rate && rate > nkmp->max_rate) {
138*4882a593Smuzhiyun 		rate = nkmp->max_rate;
139*4882a593Smuzhiyun 		if (nkmp->common.features & CCU_FEATURE_FIXED_POSTDIV)
140*4882a593Smuzhiyun 			rate /= nkmp->fixed_post_div;
141*4882a593Smuzhiyun 		return rate;
142*4882a593Smuzhiyun 	}
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun 	_nkmp.min_n = nkmp->n.min ?: 1;
145*4882a593Smuzhiyun 	_nkmp.max_n = nkmp->n.max ?: 1 << nkmp->n.width;
146*4882a593Smuzhiyun 	_nkmp.min_k = nkmp->k.min ?: 1;
147*4882a593Smuzhiyun 	_nkmp.max_k = nkmp->k.max ?: 1 << nkmp->k.width;
148*4882a593Smuzhiyun 	_nkmp.min_m = 1;
149*4882a593Smuzhiyun 	_nkmp.max_m = nkmp->m.max ?: 1 << nkmp->m.width;
150*4882a593Smuzhiyun 	_nkmp.min_p = 1;
151*4882a593Smuzhiyun 	_nkmp.max_p = nkmp->p.max ?: 1 << ((1 << nkmp->p.width) - 1);
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	ccu_nkmp_find_best(*parent_rate, rate, &_nkmp);
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 	rate = ccu_nkmp_calc_rate(*parent_rate, _nkmp.n, _nkmp.k,
156*4882a593Smuzhiyun 				  _nkmp.m, _nkmp.p);
157*4882a593Smuzhiyun 	if (nkmp->common.features & CCU_FEATURE_FIXED_POSTDIV)
158*4882a593Smuzhiyun 		rate = rate / nkmp->fixed_post_div;
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun 	return rate;
161*4882a593Smuzhiyun }
162*4882a593Smuzhiyun 
ccu_nkmp_set_rate(struct clk_hw * hw,unsigned long rate,unsigned long parent_rate)163*4882a593Smuzhiyun static int ccu_nkmp_set_rate(struct clk_hw *hw, unsigned long rate,
164*4882a593Smuzhiyun 			   unsigned long parent_rate)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun 	struct ccu_nkmp *nkmp = hw_to_ccu_nkmp(hw);
167*4882a593Smuzhiyun 	u32 n_mask = 0, k_mask = 0, m_mask = 0, p_mask = 0;
168*4882a593Smuzhiyun 	struct _ccu_nkmp _nkmp;
169*4882a593Smuzhiyun 	unsigned long flags;
170*4882a593Smuzhiyun 	u32 reg;
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 	if (nkmp->common.features & CCU_FEATURE_FIXED_POSTDIV)
173*4882a593Smuzhiyun 		rate = rate * nkmp->fixed_post_div;
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	_nkmp.min_n = nkmp->n.min ?: 1;
176*4882a593Smuzhiyun 	_nkmp.max_n = nkmp->n.max ?: 1 << nkmp->n.width;
177*4882a593Smuzhiyun 	_nkmp.min_k = nkmp->k.min ?: 1;
178*4882a593Smuzhiyun 	_nkmp.max_k = nkmp->k.max ?: 1 << nkmp->k.width;
179*4882a593Smuzhiyun 	_nkmp.min_m = 1;
180*4882a593Smuzhiyun 	_nkmp.max_m = nkmp->m.max ?: 1 << nkmp->m.width;
181*4882a593Smuzhiyun 	_nkmp.min_p = 1;
182*4882a593Smuzhiyun 	_nkmp.max_p = nkmp->p.max ?: 1 << ((1 << nkmp->p.width) - 1);
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun 	ccu_nkmp_find_best(parent_rate, rate, &_nkmp);
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	/*
187*4882a593Smuzhiyun 	 * If width is 0, GENMASK() macro may not generate expected mask (0)
188*4882a593Smuzhiyun 	 * as it falls under undefined behaviour by C standard due to shifts
189*4882a593Smuzhiyun 	 * which are equal or greater than width of left operand. This can
190*4882a593Smuzhiyun 	 * be easily avoided by explicitly checking if width is 0.
191*4882a593Smuzhiyun 	 */
192*4882a593Smuzhiyun 	if (nkmp->n.width)
193*4882a593Smuzhiyun 		n_mask = GENMASK(nkmp->n.width + nkmp->n.shift - 1,
194*4882a593Smuzhiyun 				 nkmp->n.shift);
195*4882a593Smuzhiyun 	if (nkmp->k.width)
196*4882a593Smuzhiyun 		k_mask = GENMASK(nkmp->k.width + nkmp->k.shift - 1,
197*4882a593Smuzhiyun 				 nkmp->k.shift);
198*4882a593Smuzhiyun 	if (nkmp->m.width)
199*4882a593Smuzhiyun 		m_mask = GENMASK(nkmp->m.width + nkmp->m.shift - 1,
200*4882a593Smuzhiyun 				 nkmp->m.shift);
201*4882a593Smuzhiyun 	if (nkmp->p.width)
202*4882a593Smuzhiyun 		p_mask = GENMASK(nkmp->p.width + nkmp->p.shift - 1,
203*4882a593Smuzhiyun 				 nkmp->p.shift);
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun 	spin_lock_irqsave(nkmp->common.lock, flags);
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun 	reg = readl(nkmp->common.base + nkmp->common.reg);
208*4882a593Smuzhiyun 	reg &= ~(n_mask | k_mask | m_mask | p_mask);
209*4882a593Smuzhiyun 
210*4882a593Smuzhiyun 	reg |= ((_nkmp.n - nkmp->n.offset) << nkmp->n.shift) & n_mask;
211*4882a593Smuzhiyun 	reg |= ((_nkmp.k - nkmp->k.offset) << nkmp->k.shift) & k_mask;
212*4882a593Smuzhiyun 	reg |= ((_nkmp.m - nkmp->m.offset) << nkmp->m.shift) & m_mask;
213*4882a593Smuzhiyun 	reg |= (ilog2(_nkmp.p) << nkmp->p.shift) & p_mask;
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun 	writel(reg, nkmp->common.base + nkmp->common.reg);
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun 	spin_unlock_irqrestore(nkmp->common.lock, flags);
218*4882a593Smuzhiyun 
219*4882a593Smuzhiyun 	ccu_helper_wait_for_lock(&nkmp->common, nkmp->lock);
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun 	return 0;
222*4882a593Smuzhiyun }
223*4882a593Smuzhiyun 
224*4882a593Smuzhiyun const struct clk_ops ccu_nkmp_ops = {
225*4882a593Smuzhiyun 	.disable	= ccu_nkmp_disable,
226*4882a593Smuzhiyun 	.enable		= ccu_nkmp_enable,
227*4882a593Smuzhiyun 	.is_enabled	= ccu_nkmp_is_enabled,
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun 	.recalc_rate	= ccu_nkmp_recalc_rate,
230*4882a593Smuzhiyun 	.round_rate	= ccu_nkmp_round_rate,
231*4882a593Smuzhiyun 	.set_rate	= ccu_nkmp_set_rate,
232*4882a593Smuzhiyun };
233