xref: /OK3568_Linux_fs/kernel/drivers/clk/bcm/clk-kona-setup.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2013 Broadcom Corporation
3*4882a593Smuzhiyun  * Copyright 2013 Linaro Limited
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * This program is free software; you can redistribute it and/or
6*4882a593Smuzhiyun  * modify it under the terms of the GNU General Public License as
7*4882a593Smuzhiyun  * published by the Free Software Foundation version 2.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
10*4882a593Smuzhiyun  * kind, whether express or implied; without even the implied warranty
11*4882a593Smuzhiyun  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12*4882a593Smuzhiyun  * GNU General Public License for more details.
13*4882a593Smuzhiyun  */
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #include <linux/io.h>
16*4882a593Smuzhiyun #include <linux/of_address.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include "clk-kona.h"
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /* These are used when a selector or trigger is found to be unneeded */
21*4882a593Smuzhiyun #define selector_clear_exists(sel)	((sel)->width = 0)
22*4882a593Smuzhiyun #define trigger_clear_exists(trig)	FLAG_CLEAR(trig, TRIG, EXISTS)
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun /* Validity checking */
25*4882a593Smuzhiyun 
ccu_data_offsets_valid(struct ccu_data * ccu)26*4882a593Smuzhiyun static bool ccu_data_offsets_valid(struct ccu_data *ccu)
27*4882a593Smuzhiyun {
28*4882a593Smuzhiyun 	struct ccu_policy *ccu_policy = &ccu->policy;
29*4882a593Smuzhiyun 	u32 limit;
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun 	limit = ccu->range - sizeof(u32);
32*4882a593Smuzhiyun 	limit = round_down(limit, sizeof(u32));
33*4882a593Smuzhiyun 	if (ccu_policy_exists(ccu_policy)) {
34*4882a593Smuzhiyun 		if (ccu_policy->enable.offset > limit) {
35*4882a593Smuzhiyun 			pr_err("%s: bad policy enable offset for %s "
36*4882a593Smuzhiyun 					"(%u > %u)\n", __func__,
37*4882a593Smuzhiyun 				ccu->name, ccu_policy->enable.offset, limit);
38*4882a593Smuzhiyun 			return false;
39*4882a593Smuzhiyun 		}
40*4882a593Smuzhiyun 		if (ccu_policy->control.offset > limit) {
41*4882a593Smuzhiyun 			pr_err("%s: bad policy control offset for %s "
42*4882a593Smuzhiyun 					"(%u > %u)\n", __func__,
43*4882a593Smuzhiyun 				ccu->name, ccu_policy->control.offset, limit);
44*4882a593Smuzhiyun 			return false;
45*4882a593Smuzhiyun 		}
46*4882a593Smuzhiyun 	}
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun 	return true;
49*4882a593Smuzhiyun }
50*4882a593Smuzhiyun 
clk_requires_trigger(struct kona_clk * bcm_clk)51*4882a593Smuzhiyun static bool clk_requires_trigger(struct kona_clk *bcm_clk)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun 	struct peri_clk_data *peri = bcm_clk->u.peri;
54*4882a593Smuzhiyun 	struct bcm_clk_sel *sel;
55*4882a593Smuzhiyun 	struct bcm_clk_div *div;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	if (bcm_clk->type != bcm_clk_peri)
58*4882a593Smuzhiyun 		return false;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	sel = &peri->sel;
61*4882a593Smuzhiyun 	if (sel->parent_count && selector_exists(sel))
62*4882a593Smuzhiyun 		return true;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	div = &peri->div;
65*4882a593Smuzhiyun 	if (!divider_exists(div))
66*4882a593Smuzhiyun 		return false;
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	/* Fixed dividers don't need triggers */
69*4882a593Smuzhiyun 	if (!divider_is_fixed(div))
70*4882a593Smuzhiyun 		return true;
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	div = &peri->pre_div;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	return divider_exists(div) && !divider_is_fixed(div);
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun 
peri_clk_data_offsets_valid(struct kona_clk * bcm_clk)77*4882a593Smuzhiyun static bool peri_clk_data_offsets_valid(struct kona_clk *bcm_clk)
78*4882a593Smuzhiyun {
79*4882a593Smuzhiyun 	struct peri_clk_data *peri;
80*4882a593Smuzhiyun 	struct bcm_clk_policy *policy;
81*4882a593Smuzhiyun 	struct bcm_clk_gate *gate;
82*4882a593Smuzhiyun 	struct bcm_clk_hyst *hyst;
83*4882a593Smuzhiyun 	struct bcm_clk_div *div;
84*4882a593Smuzhiyun 	struct bcm_clk_sel *sel;
85*4882a593Smuzhiyun 	struct bcm_clk_trig *trig;
86*4882a593Smuzhiyun 	const char *name;
87*4882a593Smuzhiyun 	u32 range;
88*4882a593Smuzhiyun 	u32 limit;
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	BUG_ON(bcm_clk->type != bcm_clk_peri);
91*4882a593Smuzhiyun 	peri = bcm_clk->u.peri;
92*4882a593Smuzhiyun 	name = bcm_clk->init_data.name;
93*4882a593Smuzhiyun 	range = bcm_clk->ccu->range;
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	limit = range - sizeof(u32);
96*4882a593Smuzhiyun 	limit = round_down(limit, sizeof(u32));
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	policy = &peri->policy;
99*4882a593Smuzhiyun 	if (policy_exists(policy)) {
100*4882a593Smuzhiyun 		if (policy->offset > limit) {
101*4882a593Smuzhiyun 			pr_err("%s: bad policy offset for %s (%u > %u)\n",
102*4882a593Smuzhiyun 				__func__, name, policy->offset, limit);
103*4882a593Smuzhiyun 			return false;
104*4882a593Smuzhiyun 		}
105*4882a593Smuzhiyun 	}
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	gate = &peri->gate;
108*4882a593Smuzhiyun 	hyst = &peri->hyst;
109*4882a593Smuzhiyun 	if (gate_exists(gate)) {
110*4882a593Smuzhiyun 		if (gate->offset > limit) {
111*4882a593Smuzhiyun 			pr_err("%s: bad gate offset for %s (%u > %u)\n",
112*4882a593Smuzhiyun 				__func__, name, gate->offset, limit);
113*4882a593Smuzhiyun 			return false;
114*4882a593Smuzhiyun 		}
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 		if (hyst_exists(hyst)) {
117*4882a593Smuzhiyun 			if (hyst->offset > limit) {
118*4882a593Smuzhiyun 				pr_err("%s: bad hysteresis offset for %s "
119*4882a593Smuzhiyun 					"(%u > %u)\n", __func__,
120*4882a593Smuzhiyun 					name, hyst->offset, limit);
121*4882a593Smuzhiyun 				return false;
122*4882a593Smuzhiyun 			}
123*4882a593Smuzhiyun 		}
124*4882a593Smuzhiyun 	} else if (hyst_exists(hyst)) {
125*4882a593Smuzhiyun 		pr_err("%s: hysteresis but no gate for %s\n", __func__, name);
126*4882a593Smuzhiyun 		return false;
127*4882a593Smuzhiyun 	}
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	div = &peri->div;
130*4882a593Smuzhiyun 	if (divider_exists(div)) {
131*4882a593Smuzhiyun 		if (div->u.s.offset > limit) {
132*4882a593Smuzhiyun 			pr_err("%s: bad divider offset for %s (%u > %u)\n",
133*4882a593Smuzhiyun 				__func__, name, div->u.s.offset, limit);
134*4882a593Smuzhiyun 			return false;
135*4882a593Smuzhiyun 		}
136*4882a593Smuzhiyun 	}
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	div = &peri->pre_div;
139*4882a593Smuzhiyun 	if (divider_exists(div)) {
140*4882a593Smuzhiyun 		if (div->u.s.offset > limit) {
141*4882a593Smuzhiyun 			pr_err("%s: bad pre-divider offset for %s "
142*4882a593Smuzhiyun 					"(%u > %u)\n",
143*4882a593Smuzhiyun 				__func__, name, div->u.s.offset, limit);
144*4882a593Smuzhiyun 			return false;
145*4882a593Smuzhiyun 		}
146*4882a593Smuzhiyun 	}
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 	sel = &peri->sel;
149*4882a593Smuzhiyun 	if (selector_exists(sel)) {
150*4882a593Smuzhiyun 		if (sel->offset > limit) {
151*4882a593Smuzhiyun 			pr_err("%s: bad selector offset for %s (%u > %u)\n",
152*4882a593Smuzhiyun 				__func__, name, sel->offset, limit);
153*4882a593Smuzhiyun 			return false;
154*4882a593Smuzhiyun 		}
155*4882a593Smuzhiyun 	}
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun 	trig = &peri->trig;
158*4882a593Smuzhiyun 	if (trigger_exists(trig)) {
159*4882a593Smuzhiyun 		if (trig->offset > limit) {
160*4882a593Smuzhiyun 			pr_err("%s: bad trigger offset for %s (%u > %u)\n",
161*4882a593Smuzhiyun 				__func__, name, trig->offset, limit);
162*4882a593Smuzhiyun 			return false;
163*4882a593Smuzhiyun 		}
164*4882a593Smuzhiyun 	}
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 	trig = &peri->pre_trig;
167*4882a593Smuzhiyun 	if (trigger_exists(trig)) {
168*4882a593Smuzhiyun 		if (trig->offset > limit) {
169*4882a593Smuzhiyun 			pr_err("%s: bad pre-trigger offset for %s (%u > %u)\n",
170*4882a593Smuzhiyun 				__func__, name, trig->offset, limit);
171*4882a593Smuzhiyun 			return false;
172*4882a593Smuzhiyun 		}
173*4882a593Smuzhiyun 	}
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	return true;
176*4882a593Smuzhiyun }
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun /* A bit position must be less than the number of bits in a 32-bit register. */
bit_posn_valid(u32 bit_posn,const char * field_name,const char * clock_name)179*4882a593Smuzhiyun static bool bit_posn_valid(u32 bit_posn, const char *field_name,
180*4882a593Smuzhiyun 			const char *clock_name)
181*4882a593Smuzhiyun {
182*4882a593Smuzhiyun 	u32 limit = BITS_PER_BYTE * sizeof(u32) - 1;
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun 	if (bit_posn > limit) {
185*4882a593Smuzhiyun 		pr_err("%s: bad %s bit for %s (%u > %u)\n", __func__,
186*4882a593Smuzhiyun 			field_name, clock_name, bit_posn, limit);
187*4882a593Smuzhiyun 		return false;
188*4882a593Smuzhiyun 	}
189*4882a593Smuzhiyun 	return true;
190*4882a593Smuzhiyun }
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun /*
193*4882a593Smuzhiyun  * A bitfield must be at least 1 bit wide.  Both the low-order and
194*4882a593Smuzhiyun  * high-order bits must lie within a 32-bit register.  We require
195*4882a593Smuzhiyun  * fields to be less than 32 bits wide, mainly because we use
196*4882a593Smuzhiyun  * shifting to produce field masks, and shifting a full word width
197*4882a593Smuzhiyun  * is not well-defined by the C standard.
198*4882a593Smuzhiyun  */
bitfield_valid(u32 shift,u32 width,const char * field_name,const char * clock_name)199*4882a593Smuzhiyun static bool bitfield_valid(u32 shift, u32 width, const char *field_name,
200*4882a593Smuzhiyun 			const char *clock_name)
201*4882a593Smuzhiyun {
202*4882a593Smuzhiyun 	u32 limit = BITS_PER_BYTE * sizeof(u32);
203*4882a593Smuzhiyun 
204*4882a593Smuzhiyun 	if (!width) {
205*4882a593Smuzhiyun 		pr_err("%s: bad %s field width 0 for %s\n", __func__,
206*4882a593Smuzhiyun 			field_name, clock_name);
207*4882a593Smuzhiyun 		return false;
208*4882a593Smuzhiyun 	}
209*4882a593Smuzhiyun 	if (shift + width > limit) {
210*4882a593Smuzhiyun 		pr_err("%s: bad %s for %s (%u + %u > %u)\n", __func__,
211*4882a593Smuzhiyun 			field_name, clock_name, shift, width, limit);
212*4882a593Smuzhiyun 		return false;
213*4882a593Smuzhiyun 	}
214*4882a593Smuzhiyun 	return true;
215*4882a593Smuzhiyun }
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun static bool
ccu_policy_valid(struct ccu_policy * ccu_policy,const char * ccu_name)218*4882a593Smuzhiyun ccu_policy_valid(struct ccu_policy *ccu_policy, const char *ccu_name)
219*4882a593Smuzhiyun {
220*4882a593Smuzhiyun 	struct bcm_lvm_en *enable = &ccu_policy->enable;
221*4882a593Smuzhiyun 	struct bcm_policy_ctl *control;
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 	if (!bit_posn_valid(enable->bit, "policy enable", ccu_name))
224*4882a593Smuzhiyun 		return false;
225*4882a593Smuzhiyun 
226*4882a593Smuzhiyun 	control = &ccu_policy->control;
227*4882a593Smuzhiyun 	if (!bit_posn_valid(control->go_bit, "policy control GO", ccu_name))
228*4882a593Smuzhiyun 		return false;
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun 	if (!bit_posn_valid(control->atl_bit, "policy control ATL", ccu_name))
231*4882a593Smuzhiyun 		return false;
232*4882a593Smuzhiyun 
233*4882a593Smuzhiyun 	if (!bit_posn_valid(control->ac_bit, "policy control AC", ccu_name))
234*4882a593Smuzhiyun 		return false;
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 	return true;
237*4882a593Smuzhiyun }
238*4882a593Smuzhiyun 
policy_valid(struct bcm_clk_policy * policy,const char * clock_name)239*4882a593Smuzhiyun static bool policy_valid(struct bcm_clk_policy *policy, const char *clock_name)
240*4882a593Smuzhiyun {
241*4882a593Smuzhiyun 	if (!bit_posn_valid(policy->bit, "policy", clock_name))
242*4882a593Smuzhiyun 		return false;
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun 	return true;
245*4882a593Smuzhiyun }
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun /*
248*4882a593Smuzhiyun  * All gates, if defined, have a status bit, and for hardware-only
249*4882a593Smuzhiyun  * gates, that's it.  Gates that can be software controlled also
250*4882a593Smuzhiyun  * have an enable bit.  And a gate that can be hardware or software
251*4882a593Smuzhiyun  * controlled will have a hardware/software select bit.
252*4882a593Smuzhiyun  */
gate_valid(struct bcm_clk_gate * gate,const char * field_name,const char * clock_name)253*4882a593Smuzhiyun static bool gate_valid(struct bcm_clk_gate *gate, const char *field_name,
254*4882a593Smuzhiyun 			const char *clock_name)
255*4882a593Smuzhiyun {
256*4882a593Smuzhiyun 	if (!bit_posn_valid(gate->status_bit, "gate status", clock_name))
257*4882a593Smuzhiyun 		return false;
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun 	if (gate_is_sw_controllable(gate)) {
260*4882a593Smuzhiyun 		if (!bit_posn_valid(gate->en_bit, "gate enable", clock_name))
261*4882a593Smuzhiyun 			return false;
262*4882a593Smuzhiyun 
263*4882a593Smuzhiyun 		if (gate_is_hw_controllable(gate)) {
264*4882a593Smuzhiyun 			if (!bit_posn_valid(gate->hw_sw_sel_bit,
265*4882a593Smuzhiyun 						"gate hw/sw select",
266*4882a593Smuzhiyun 						clock_name))
267*4882a593Smuzhiyun 				return false;
268*4882a593Smuzhiyun 		}
269*4882a593Smuzhiyun 	} else {
270*4882a593Smuzhiyun 		BUG_ON(!gate_is_hw_controllable(gate));
271*4882a593Smuzhiyun 	}
272*4882a593Smuzhiyun 
273*4882a593Smuzhiyun 	return true;
274*4882a593Smuzhiyun }
275*4882a593Smuzhiyun 
hyst_valid(struct bcm_clk_hyst * hyst,const char * clock_name)276*4882a593Smuzhiyun static bool hyst_valid(struct bcm_clk_hyst *hyst, const char *clock_name)
277*4882a593Smuzhiyun {
278*4882a593Smuzhiyun 	if (!bit_posn_valid(hyst->en_bit, "hysteresis enable", clock_name))
279*4882a593Smuzhiyun 		return false;
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun 	if (!bit_posn_valid(hyst->val_bit, "hysteresis value", clock_name))
282*4882a593Smuzhiyun 		return false;
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun 	return true;
285*4882a593Smuzhiyun }
286*4882a593Smuzhiyun 
287*4882a593Smuzhiyun /*
288*4882a593Smuzhiyun  * A selector bitfield must be valid.  Its parent_sel array must
289*4882a593Smuzhiyun  * also be reasonable for the field.
290*4882a593Smuzhiyun  */
sel_valid(struct bcm_clk_sel * sel,const char * field_name,const char * clock_name)291*4882a593Smuzhiyun static bool sel_valid(struct bcm_clk_sel *sel, const char *field_name,
292*4882a593Smuzhiyun 			const char *clock_name)
293*4882a593Smuzhiyun {
294*4882a593Smuzhiyun 	if (!bitfield_valid(sel->shift, sel->width, field_name, clock_name))
295*4882a593Smuzhiyun 		return false;
296*4882a593Smuzhiyun 
297*4882a593Smuzhiyun 	if (sel->parent_count) {
298*4882a593Smuzhiyun 		u32 max_sel;
299*4882a593Smuzhiyun 		u32 limit;
300*4882a593Smuzhiyun 
301*4882a593Smuzhiyun 		/*
302*4882a593Smuzhiyun 		 * Make sure the selector field can hold all the
303*4882a593Smuzhiyun 		 * selector values we expect to be able to use.  A
304*4882a593Smuzhiyun 		 * clock only needs to have a selector defined if it
305*4882a593Smuzhiyun 		 * has more than one parent.  And in that case the
306*4882a593Smuzhiyun 		 * highest selector value will be in the last entry
307*4882a593Smuzhiyun 		 * in the array.
308*4882a593Smuzhiyun 		 */
309*4882a593Smuzhiyun 		max_sel = sel->parent_sel[sel->parent_count - 1];
310*4882a593Smuzhiyun 		limit = (1 << sel->width) - 1;
311*4882a593Smuzhiyun 		if (max_sel > limit) {
312*4882a593Smuzhiyun 			pr_err("%s: bad selector for %s "
313*4882a593Smuzhiyun 					"(%u needs > %u bits)\n",
314*4882a593Smuzhiyun 				__func__, clock_name, max_sel,
315*4882a593Smuzhiyun 				sel->width);
316*4882a593Smuzhiyun 			return false;
317*4882a593Smuzhiyun 		}
318*4882a593Smuzhiyun 	} else {
319*4882a593Smuzhiyun 		pr_warn("%s: ignoring selector for %s (no parents)\n",
320*4882a593Smuzhiyun 			__func__, clock_name);
321*4882a593Smuzhiyun 		selector_clear_exists(sel);
322*4882a593Smuzhiyun 		kfree(sel->parent_sel);
323*4882a593Smuzhiyun 		sel->parent_sel = NULL;
324*4882a593Smuzhiyun 	}
325*4882a593Smuzhiyun 
326*4882a593Smuzhiyun 	return true;
327*4882a593Smuzhiyun }
328*4882a593Smuzhiyun 
329*4882a593Smuzhiyun /*
330*4882a593Smuzhiyun  * A fixed divider just needs to be non-zero.  A variable divider
331*4882a593Smuzhiyun  * has to have a valid divider bitfield, and if it has a fraction,
332*4882a593Smuzhiyun  * the width of the fraction must not be no more than the width of
333*4882a593Smuzhiyun  * the divider as a whole.
334*4882a593Smuzhiyun  */
div_valid(struct bcm_clk_div * div,const char * field_name,const char * clock_name)335*4882a593Smuzhiyun static bool div_valid(struct bcm_clk_div *div, const char *field_name,
336*4882a593Smuzhiyun 			const char *clock_name)
337*4882a593Smuzhiyun {
338*4882a593Smuzhiyun 	if (divider_is_fixed(div)) {
339*4882a593Smuzhiyun 		/* Any fixed divider value but 0 is OK */
340*4882a593Smuzhiyun 		if (div->u.fixed == 0) {
341*4882a593Smuzhiyun 			pr_err("%s: bad %s fixed value 0 for %s\n", __func__,
342*4882a593Smuzhiyun 				field_name, clock_name);
343*4882a593Smuzhiyun 			return false;
344*4882a593Smuzhiyun 		}
345*4882a593Smuzhiyun 		return true;
346*4882a593Smuzhiyun 	}
347*4882a593Smuzhiyun 	if (!bitfield_valid(div->u.s.shift, div->u.s.width,
348*4882a593Smuzhiyun 				field_name, clock_name))
349*4882a593Smuzhiyun 		return false;
350*4882a593Smuzhiyun 
351*4882a593Smuzhiyun 	if (divider_has_fraction(div))
352*4882a593Smuzhiyun 		if (div->u.s.frac_width > div->u.s.width) {
353*4882a593Smuzhiyun 			pr_warn("%s: bad %s fraction width for %s (%u > %u)\n",
354*4882a593Smuzhiyun 				__func__, field_name, clock_name,
355*4882a593Smuzhiyun 				div->u.s.frac_width, div->u.s.width);
356*4882a593Smuzhiyun 			return false;
357*4882a593Smuzhiyun 		}
358*4882a593Smuzhiyun 
359*4882a593Smuzhiyun 	return true;
360*4882a593Smuzhiyun }
361*4882a593Smuzhiyun 
362*4882a593Smuzhiyun /*
363*4882a593Smuzhiyun  * If a clock has two dividers, the combined number of fractional
364*4882a593Smuzhiyun  * bits must be representable in a 32-bit unsigned value.  This
365*4882a593Smuzhiyun  * is because we scale up a dividend using both dividers before
366*4882a593Smuzhiyun  * dividing to improve accuracy, and we need to avoid overflow.
367*4882a593Smuzhiyun  */
kona_dividers_valid(struct kona_clk * bcm_clk)368*4882a593Smuzhiyun static bool kona_dividers_valid(struct kona_clk *bcm_clk)
369*4882a593Smuzhiyun {
370*4882a593Smuzhiyun 	struct peri_clk_data *peri = bcm_clk->u.peri;
371*4882a593Smuzhiyun 	struct bcm_clk_div *div;
372*4882a593Smuzhiyun 	struct bcm_clk_div *pre_div;
373*4882a593Smuzhiyun 	u32 limit;
374*4882a593Smuzhiyun 
375*4882a593Smuzhiyun 	BUG_ON(bcm_clk->type != bcm_clk_peri);
376*4882a593Smuzhiyun 
377*4882a593Smuzhiyun 	if (!divider_exists(&peri->div) || !divider_exists(&peri->pre_div))
378*4882a593Smuzhiyun 		return true;
379*4882a593Smuzhiyun 
380*4882a593Smuzhiyun 	div = &peri->div;
381*4882a593Smuzhiyun 	pre_div = &peri->pre_div;
382*4882a593Smuzhiyun 	if (divider_is_fixed(div) || divider_is_fixed(pre_div))
383*4882a593Smuzhiyun 		return true;
384*4882a593Smuzhiyun 
385*4882a593Smuzhiyun 	limit = BITS_PER_BYTE * sizeof(u32);
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun 	return div->u.s.frac_width + pre_div->u.s.frac_width <= limit;
388*4882a593Smuzhiyun }
389*4882a593Smuzhiyun 
390*4882a593Smuzhiyun 
391*4882a593Smuzhiyun /* A trigger just needs to represent a valid bit position */
trig_valid(struct bcm_clk_trig * trig,const char * field_name,const char * clock_name)392*4882a593Smuzhiyun static bool trig_valid(struct bcm_clk_trig *trig, const char *field_name,
393*4882a593Smuzhiyun 			const char *clock_name)
394*4882a593Smuzhiyun {
395*4882a593Smuzhiyun 	return bit_posn_valid(trig->bit, field_name, clock_name);
396*4882a593Smuzhiyun }
397*4882a593Smuzhiyun 
398*4882a593Smuzhiyun /* Determine whether the set of peripheral clock registers are valid. */
399*4882a593Smuzhiyun static bool
peri_clk_data_valid(struct kona_clk * bcm_clk)400*4882a593Smuzhiyun peri_clk_data_valid(struct kona_clk *bcm_clk)
401*4882a593Smuzhiyun {
402*4882a593Smuzhiyun 	struct peri_clk_data *peri;
403*4882a593Smuzhiyun 	struct bcm_clk_policy *policy;
404*4882a593Smuzhiyun 	struct bcm_clk_gate *gate;
405*4882a593Smuzhiyun 	struct bcm_clk_hyst *hyst;
406*4882a593Smuzhiyun 	struct bcm_clk_sel *sel;
407*4882a593Smuzhiyun 	struct bcm_clk_div *div;
408*4882a593Smuzhiyun 	struct bcm_clk_div *pre_div;
409*4882a593Smuzhiyun 	struct bcm_clk_trig *trig;
410*4882a593Smuzhiyun 	const char *name;
411*4882a593Smuzhiyun 
412*4882a593Smuzhiyun 	BUG_ON(bcm_clk->type != bcm_clk_peri);
413*4882a593Smuzhiyun 
414*4882a593Smuzhiyun 	/*
415*4882a593Smuzhiyun 	 * First validate register offsets.  This is the only place
416*4882a593Smuzhiyun 	 * where we need something from the ccu, so we do these
417*4882a593Smuzhiyun 	 * together.
418*4882a593Smuzhiyun 	 */
419*4882a593Smuzhiyun 	if (!peri_clk_data_offsets_valid(bcm_clk))
420*4882a593Smuzhiyun 		return false;
421*4882a593Smuzhiyun 
422*4882a593Smuzhiyun 	peri = bcm_clk->u.peri;
423*4882a593Smuzhiyun 	name = bcm_clk->init_data.name;
424*4882a593Smuzhiyun 
425*4882a593Smuzhiyun 	policy = &peri->policy;
426*4882a593Smuzhiyun 	if (policy_exists(policy) && !policy_valid(policy, name))
427*4882a593Smuzhiyun 		return false;
428*4882a593Smuzhiyun 
429*4882a593Smuzhiyun 	gate = &peri->gate;
430*4882a593Smuzhiyun 	if (gate_exists(gate) && !gate_valid(gate, "gate", name))
431*4882a593Smuzhiyun 		return false;
432*4882a593Smuzhiyun 
433*4882a593Smuzhiyun 	hyst = &peri->hyst;
434*4882a593Smuzhiyun 	if (hyst_exists(hyst) && !hyst_valid(hyst, name))
435*4882a593Smuzhiyun 		return false;
436*4882a593Smuzhiyun 
437*4882a593Smuzhiyun 	sel = &peri->sel;
438*4882a593Smuzhiyun 	if (selector_exists(sel)) {
439*4882a593Smuzhiyun 		if (!sel_valid(sel, "selector", name))
440*4882a593Smuzhiyun 			return false;
441*4882a593Smuzhiyun 
442*4882a593Smuzhiyun 	} else if (sel->parent_count > 1) {
443*4882a593Smuzhiyun 		pr_err("%s: multiple parents but no selector for %s\n",
444*4882a593Smuzhiyun 			__func__, name);
445*4882a593Smuzhiyun 
446*4882a593Smuzhiyun 		return false;
447*4882a593Smuzhiyun 	}
448*4882a593Smuzhiyun 
449*4882a593Smuzhiyun 	div = &peri->div;
450*4882a593Smuzhiyun 	pre_div = &peri->pre_div;
451*4882a593Smuzhiyun 	if (divider_exists(div)) {
452*4882a593Smuzhiyun 		if (!div_valid(div, "divider", name))
453*4882a593Smuzhiyun 			return false;
454*4882a593Smuzhiyun 
455*4882a593Smuzhiyun 		if (divider_exists(pre_div))
456*4882a593Smuzhiyun 			if (!div_valid(pre_div, "pre-divider", name))
457*4882a593Smuzhiyun 				return false;
458*4882a593Smuzhiyun 	} else if (divider_exists(pre_div)) {
459*4882a593Smuzhiyun 		pr_err("%s: pre-divider but no divider for %s\n", __func__,
460*4882a593Smuzhiyun 			name);
461*4882a593Smuzhiyun 		return false;
462*4882a593Smuzhiyun 	}
463*4882a593Smuzhiyun 
464*4882a593Smuzhiyun 	trig = &peri->trig;
465*4882a593Smuzhiyun 	if (trigger_exists(trig)) {
466*4882a593Smuzhiyun 		if (!trig_valid(trig, "trigger", name))
467*4882a593Smuzhiyun 			return false;
468*4882a593Smuzhiyun 
469*4882a593Smuzhiyun 		if (trigger_exists(&peri->pre_trig)) {
470*4882a593Smuzhiyun 			if (!trig_valid(trig, "pre-trigger", name)) {
471*4882a593Smuzhiyun 				return false;
472*4882a593Smuzhiyun 			}
473*4882a593Smuzhiyun 		}
474*4882a593Smuzhiyun 		if (!clk_requires_trigger(bcm_clk)) {
475*4882a593Smuzhiyun 			pr_warn("%s: ignoring trigger for %s (not needed)\n",
476*4882a593Smuzhiyun 				__func__, name);
477*4882a593Smuzhiyun 			trigger_clear_exists(trig);
478*4882a593Smuzhiyun 		}
479*4882a593Smuzhiyun 	} else if (trigger_exists(&peri->pre_trig)) {
480*4882a593Smuzhiyun 		pr_err("%s: pre-trigger but no trigger for %s\n", __func__,
481*4882a593Smuzhiyun 			name);
482*4882a593Smuzhiyun 		return false;
483*4882a593Smuzhiyun 	} else if (clk_requires_trigger(bcm_clk)) {
484*4882a593Smuzhiyun 		pr_err("%s: required trigger missing for %s\n", __func__,
485*4882a593Smuzhiyun 			name);
486*4882a593Smuzhiyun 		return false;
487*4882a593Smuzhiyun 	}
488*4882a593Smuzhiyun 
489*4882a593Smuzhiyun 	return kona_dividers_valid(bcm_clk);
490*4882a593Smuzhiyun }
491*4882a593Smuzhiyun 
kona_clk_valid(struct kona_clk * bcm_clk)492*4882a593Smuzhiyun static bool kona_clk_valid(struct kona_clk *bcm_clk)
493*4882a593Smuzhiyun {
494*4882a593Smuzhiyun 	switch (bcm_clk->type) {
495*4882a593Smuzhiyun 	case bcm_clk_peri:
496*4882a593Smuzhiyun 		if (!peri_clk_data_valid(bcm_clk))
497*4882a593Smuzhiyun 			return false;
498*4882a593Smuzhiyun 		break;
499*4882a593Smuzhiyun 	default:
500*4882a593Smuzhiyun 		pr_err("%s: unrecognized clock type (%d)\n", __func__,
501*4882a593Smuzhiyun 			(int)bcm_clk->type);
502*4882a593Smuzhiyun 		return false;
503*4882a593Smuzhiyun 	}
504*4882a593Smuzhiyun 	return true;
505*4882a593Smuzhiyun }
506*4882a593Smuzhiyun 
507*4882a593Smuzhiyun /*
508*4882a593Smuzhiyun  * Scan an array of parent clock names to determine whether there
509*4882a593Smuzhiyun  * are any entries containing BAD_CLK_NAME.  Such entries are
510*4882a593Smuzhiyun  * placeholders for non-supported clocks.  Keep track of the
511*4882a593Smuzhiyun  * position of each clock name in the original array.
512*4882a593Smuzhiyun  *
513*4882a593Smuzhiyun  * Allocates an array of pointers to to hold the names of all
514*4882a593Smuzhiyun  * non-null entries in the original array, and returns a pointer to
515*4882a593Smuzhiyun  * that array in *names.  This will be used for registering the
516*4882a593Smuzhiyun  * clock with the common clock code.  On successful return,
517*4882a593Smuzhiyun  * *count indicates how many entries are in that names array.
518*4882a593Smuzhiyun  *
519*4882a593Smuzhiyun  * If there is more than one entry in the resulting names array,
520*4882a593Smuzhiyun  * another array is allocated to record the parent selector value
521*4882a593Smuzhiyun  * for each (defined) parent clock.  This is the value that
522*4882a593Smuzhiyun  * represents this parent clock in the clock's source selector
523*4882a593Smuzhiyun  * register.  The position of the clock in the original parent array
524*4882a593Smuzhiyun  * defines that selector value.  The number of entries in this array
525*4882a593Smuzhiyun  * is the same as the number of entries in the parent names array.
526*4882a593Smuzhiyun  *
527*4882a593Smuzhiyun  * The array of selector values is returned.  If the clock has no
528*4882a593Smuzhiyun  * parents, no selector is required and a null pointer is returned.
529*4882a593Smuzhiyun  *
530*4882a593Smuzhiyun  * Returns a null pointer if the clock names array supplied was
531*4882a593Smuzhiyun  * null.  (This is not an error.)
532*4882a593Smuzhiyun  *
533*4882a593Smuzhiyun  * Returns a pointer-coded error if an error occurs.
534*4882a593Smuzhiyun  */
parent_process(const char * clocks[],u32 * count,const char *** names)535*4882a593Smuzhiyun static u32 *parent_process(const char *clocks[],
536*4882a593Smuzhiyun 			u32 *count, const char ***names)
537*4882a593Smuzhiyun {
538*4882a593Smuzhiyun 	static const char **parent_names;
539*4882a593Smuzhiyun 	static u32 *parent_sel;
540*4882a593Smuzhiyun 	const char **clock;
541*4882a593Smuzhiyun 	u32 parent_count;
542*4882a593Smuzhiyun 	u32 bad_count = 0;
543*4882a593Smuzhiyun 	u32 orig_count;
544*4882a593Smuzhiyun 	u32 i;
545*4882a593Smuzhiyun 	u32 j;
546*4882a593Smuzhiyun 
547*4882a593Smuzhiyun 	*count = 0;	/* In case of early return */
548*4882a593Smuzhiyun 	*names = NULL;
549*4882a593Smuzhiyun 	if (!clocks)
550*4882a593Smuzhiyun 		return NULL;
551*4882a593Smuzhiyun 
552*4882a593Smuzhiyun 	/*
553*4882a593Smuzhiyun 	 * Count the number of names in the null-terminated array,
554*4882a593Smuzhiyun 	 * and find out how many of those are actually clock names.
555*4882a593Smuzhiyun 	 */
556*4882a593Smuzhiyun 	for (clock = clocks; *clock; clock++)
557*4882a593Smuzhiyun 		if (*clock == BAD_CLK_NAME)
558*4882a593Smuzhiyun 			bad_count++;
559*4882a593Smuzhiyun 	orig_count = (u32)(clock - clocks);
560*4882a593Smuzhiyun 	parent_count = orig_count - bad_count;
561*4882a593Smuzhiyun 
562*4882a593Smuzhiyun 	/* If all clocks are unsupported, we treat it as no clock */
563*4882a593Smuzhiyun 	if (!parent_count)
564*4882a593Smuzhiyun 		return NULL;
565*4882a593Smuzhiyun 
566*4882a593Smuzhiyun 	/* Avoid exceeding our parent clock limit */
567*4882a593Smuzhiyun 	if (parent_count > PARENT_COUNT_MAX) {
568*4882a593Smuzhiyun 		pr_err("%s: too many parents (%u > %u)\n", __func__,
569*4882a593Smuzhiyun 			parent_count, PARENT_COUNT_MAX);
570*4882a593Smuzhiyun 		return ERR_PTR(-EINVAL);
571*4882a593Smuzhiyun 	}
572*4882a593Smuzhiyun 
573*4882a593Smuzhiyun 	/*
574*4882a593Smuzhiyun 	 * There is one parent name for each defined parent clock.
575*4882a593Smuzhiyun 	 * We also maintain an array containing the selector value
576*4882a593Smuzhiyun 	 * for each defined clock.  If there's only one clock, the
577*4882a593Smuzhiyun 	 * selector is not required, but we allocate space for the
578*4882a593Smuzhiyun 	 * array anyway to keep things simple.
579*4882a593Smuzhiyun 	 */
580*4882a593Smuzhiyun 	parent_names = kmalloc_array(parent_count, sizeof(*parent_names),
581*4882a593Smuzhiyun 			       GFP_KERNEL);
582*4882a593Smuzhiyun 	if (!parent_names)
583*4882a593Smuzhiyun 		return ERR_PTR(-ENOMEM);
584*4882a593Smuzhiyun 
585*4882a593Smuzhiyun 	/* There is at least one parent, so allocate a selector array */
586*4882a593Smuzhiyun 	parent_sel = kmalloc_array(parent_count, sizeof(*parent_sel),
587*4882a593Smuzhiyun 				   GFP_KERNEL);
588*4882a593Smuzhiyun 	if (!parent_sel) {
589*4882a593Smuzhiyun 		kfree(parent_names);
590*4882a593Smuzhiyun 
591*4882a593Smuzhiyun 		return ERR_PTR(-ENOMEM);
592*4882a593Smuzhiyun 	}
593*4882a593Smuzhiyun 
594*4882a593Smuzhiyun 	/* Now fill in the parent names and selector arrays */
595*4882a593Smuzhiyun 	for (i = 0, j = 0; i < orig_count; i++) {
596*4882a593Smuzhiyun 		if (clocks[i] != BAD_CLK_NAME) {
597*4882a593Smuzhiyun 			parent_names[j] = clocks[i];
598*4882a593Smuzhiyun 			parent_sel[j] = i;
599*4882a593Smuzhiyun 			j++;
600*4882a593Smuzhiyun 		}
601*4882a593Smuzhiyun 	}
602*4882a593Smuzhiyun 	*names = parent_names;
603*4882a593Smuzhiyun 	*count = parent_count;
604*4882a593Smuzhiyun 
605*4882a593Smuzhiyun 	return parent_sel;
606*4882a593Smuzhiyun }
607*4882a593Smuzhiyun 
608*4882a593Smuzhiyun static int
clk_sel_setup(const char ** clocks,struct bcm_clk_sel * sel,struct clk_init_data * init_data)609*4882a593Smuzhiyun clk_sel_setup(const char **clocks, struct bcm_clk_sel *sel,
610*4882a593Smuzhiyun 		struct clk_init_data *init_data)
611*4882a593Smuzhiyun {
612*4882a593Smuzhiyun 	const char **parent_names = NULL;
613*4882a593Smuzhiyun 	u32 parent_count = 0;
614*4882a593Smuzhiyun 	u32 *parent_sel;
615*4882a593Smuzhiyun 
616*4882a593Smuzhiyun 	/*
617*4882a593Smuzhiyun 	 * If a peripheral clock has multiple parents, the value
618*4882a593Smuzhiyun 	 * used by the hardware to select that parent is represented
619*4882a593Smuzhiyun 	 * by the parent clock's position in the "clocks" list.  Some
620*4882a593Smuzhiyun 	 * values don't have defined or supported clocks; these will
621*4882a593Smuzhiyun 	 * have BAD_CLK_NAME entries in the parents[] array.  The
622*4882a593Smuzhiyun 	 * list is terminated by a NULL entry.
623*4882a593Smuzhiyun 	 *
624*4882a593Smuzhiyun 	 * We need to supply (only) the names of defined parent
625*4882a593Smuzhiyun 	 * clocks when registering a clock though, so we use an
626*4882a593Smuzhiyun 	 * array of parent selector values to map between the
627*4882a593Smuzhiyun 	 * indexes the common clock code uses and the selector
628*4882a593Smuzhiyun 	 * values we need.
629*4882a593Smuzhiyun 	 */
630*4882a593Smuzhiyun 	parent_sel = parent_process(clocks, &parent_count, &parent_names);
631*4882a593Smuzhiyun 	if (IS_ERR(parent_sel)) {
632*4882a593Smuzhiyun 		int ret = PTR_ERR(parent_sel);
633*4882a593Smuzhiyun 
634*4882a593Smuzhiyun 		pr_err("%s: error processing parent clocks for %s (%d)\n",
635*4882a593Smuzhiyun 			__func__, init_data->name, ret);
636*4882a593Smuzhiyun 
637*4882a593Smuzhiyun 		return ret;
638*4882a593Smuzhiyun 	}
639*4882a593Smuzhiyun 
640*4882a593Smuzhiyun 	init_data->parent_names = parent_names;
641*4882a593Smuzhiyun 	init_data->num_parents = parent_count;
642*4882a593Smuzhiyun 
643*4882a593Smuzhiyun 	sel->parent_count = parent_count;
644*4882a593Smuzhiyun 	sel->parent_sel = parent_sel;
645*4882a593Smuzhiyun 
646*4882a593Smuzhiyun 	return 0;
647*4882a593Smuzhiyun }
648*4882a593Smuzhiyun 
clk_sel_teardown(struct bcm_clk_sel * sel,struct clk_init_data * init_data)649*4882a593Smuzhiyun static void clk_sel_teardown(struct bcm_clk_sel *sel,
650*4882a593Smuzhiyun 		struct clk_init_data *init_data)
651*4882a593Smuzhiyun {
652*4882a593Smuzhiyun 	kfree(sel->parent_sel);
653*4882a593Smuzhiyun 	sel->parent_sel = NULL;
654*4882a593Smuzhiyun 	sel->parent_count = 0;
655*4882a593Smuzhiyun 
656*4882a593Smuzhiyun 	init_data->num_parents = 0;
657*4882a593Smuzhiyun 	kfree(init_data->parent_names);
658*4882a593Smuzhiyun 	init_data->parent_names = NULL;
659*4882a593Smuzhiyun }
660*4882a593Smuzhiyun 
peri_clk_teardown(struct peri_clk_data * data,struct clk_init_data * init_data)661*4882a593Smuzhiyun static void peri_clk_teardown(struct peri_clk_data *data,
662*4882a593Smuzhiyun 				struct clk_init_data *init_data)
663*4882a593Smuzhiyun {
664*4882a593Smuzhiyun 	clk_sel_teardown(&data->sel, init_data);
665*4882a593Smuzhiyun }
666*4882a593Smuzhiyun 
667*4882a593Smuzhiyun /*
668*4882a593Smuzhiyun  * Caller is responsible for freeing the parent_names[] and
669*4882a593Smuzhiyun  * parent_sel[] arrays in the peripheral clock's "data" structure
670*4882a593Smuzhiyun  * that can be assigned if the clock has one or more parent clocks
671*4882a593Smuzhiyun  * associated with it.
672*4882a593Smuzhiyun  */
673*4882a593Smuzhiyun static int
peri_clk_setup(struct peri_clk_data * data,struct clk_init_data * init_data)674*4882a593Smuzhiyun peri_clk_setup(struct peri_clk_data *data, struct clk_init_data *init_data)
675*4882a593Smuzhiyun {
676*4882a593Smuzhiyun 	init_data->flags = CLK_IGNORE_UNUSED;
677*4882a593Smuzhiyun 
678*4882a593Smuzhiyun 	return clk_sel_setup(data->clocks, &data->sel, init_data);
679*4882a593Smuzhiyun }
680*4882a593Smuzhiyun 
bcm_clk_teardown(struct kona_clk * bcm_clk)681*4882a593Smuzhiyun static void bcm_clk_teardown(struct kona_clk *bcm_clk)
682*4882a593Smuzhiyun {
683*4882a593Smuzhiyun 	switch (bcm_clk->type) {
684*4882a593Smuzhiyun 	case bcm_clk_peri:
685*4882a593Smuzhiyun 		peri_clk_teardown(bcm_clk->u.data, &bcm_clk->init_data);
686*4882a593Smuzhiyun 		break;
687*4882a593Smuzhiyun 	default:
688*4882a593Smuzhiyun 		break;
689*4882a593Smuzhiyun 	}
690*4882a593Smuzhiyun 	bcm_clk->u.data = NULL;
691*4882a593Smuzhiyun 	bcm_clk->type = bcm_clk_none;
692*4882a593Smuzhiyun }
693*4882a593Smuzhiyun 
kona_clk_teardown(struct clk_hw * hw)694*4882a593Smuzhiyun static void kona_clk_teardown(struct clk_hw *hw)
695*4882a593Smuzhiyun {
696*4882a593Smuzhiyun 	struct kona_clk *bcm_clk;
697*4882a593Smuzhiyun 
698*4882a593Smuzhiyun 	if (!hw)
699*4882a593Smuzhiyun 		return;
700*4882a593Smuzhiyun 
701*4882a593Smuzhiyun 	clk_hw_unregister(hw);
702*4882a593Smuzhiyun 
703*4882a593Smuzhiyun 	bcm_clk = to_kona_clk(hw);
704*4882a593Smuzhiyun 	bcm_clk_teardown(bcm_clk);
705*4882a593Smuzhiyun }
706*4882a593Smuzhiyun 
kona_clk_setup(struct kona_clk * bcm_clk)707*4882a593Smuzhiyun static int kona_clk_setup(struct kona_clk *bcm_clk)
708*4882a593Smuzhiyun {
709*4882a593Smuzhiyun 	int ret;
710*4882a593Smuzhiyun 	struct clk_init_data *init_data = &bcm_clk->init_data;
711*4882a593Smuzhiyun 
712*4882a593Smuzhiyun 	switch (bcm_clk->type) {
713*4882a593Smuzhiyun 	case bcm_clk_peri:
714*4882a593Smuzhiyun 		ret = peri_clk_setup(bcm_clk->u.data, init_data);
715*4882a593Smuzhiyun 		if (ret)
716*4882a593Smuzhiyun 			return ret;
717*4882a593Smuzhiyun 		break;
718*4882a593Smuzhiyun 	default:
719*4882a593Smuzhiyun 		pr_err("%s: clock type %d invalid for %s\n", __func__,
720*4882a593Smuzhiyun 			(int)bcm_clk->type, init_data->name);
721*4882a593Smuzhiyun 		return -EINVAL;
722*4882a593Smuzhiyun 	}
723*4882a593Smuzhiyun 
724*4882a593Smuzhiyun 	/* Make sure everything makes sense before we set it up */
725*4882a593Smuzhiyun 	if (!kona_clk_valid(bcm_clk)) {
726*4882a593Smuzhiyun 		pr_err("%s: clock data invalid for %s\n", __func__,
727*4882a593Smuzhiyun 			init_data->name);
728*4882a593Smuzhiyun 		ret = -EINVAL;
729*4882a593Smuzhiyun 		goto out_teardown;
730*4882a593Smuzhiyun 	}
731*4882a593Smuzhiyun 
732*4882a593Smuzhiyun 	bcm_clk->hw.init = init_data;
733*4882a593Smuzhiyun 	ret = clk_hw_register(NULL, &bcm_clk->hw);
734*4882a593Smuzhiyun 	if (ret) {
735*4882a593Smuzhiyun 		pr_err("%s: error registering clock %s (%d)\n", __func__,
736*4882a593Smuzhiyun 			init_data->name, ret);
737*4882a593Smuzhiyun 		goto out_teardown;
738*4882a593Smuzhiyun 	}
739*4882a593Smuzhiyun 
740*4882a593Smuzhiyun 	return 0;
741*4882a593Smuzhiyun out_teardown:
742*4882a593Smuzhiyun 	bcm_clk_teardown(bcm_clk);
743*4882a593Smuzhiyun 
744*4882a593Smuzhiyun 	return ret;
745*4882a593Smuzhiyun }
746*4882a593Smuzhiyun 
ccu_clks_teardown(struct ccu_data * ccu)747*4882a593Smuzhiyun static void ccu_clks_teardown(struct ccu_data *ccu)
748*4882a593Smuzhiyun {
749*4882a593Smuzhiyun 	u32 i;
750*4882a593Smuzhiyun 
751*4882a593Smuzhiyun 	for (i = 0; i < ccu->clk_num; i++)
752*4882a593Smuzhiyun 		kona_clk_teardown(&ccu->kona_clks[i].hw);
753*4882a593Smuzhiyun }
754*4882a593Smuzhiyun 
kona_ccu_teardown(struct ccu_data * ccu)755*4882a593Smuzhiyun static void kona_ccu_teardown(struct ccu_data *ccu)
756*4882a593Smuzhiyun {
757*4882a593Smuzhiyun 	if (!ccu->base)
758*4882a593Smuzhiyun 		return;
759*4882a593Smuzhiyun 
760*4882a593Smuzhiyun 	of_clk_del_provider(ccu->node);	/* safe if never added */
761*4882a593Smuzhiyun 	ccu_clks_teardown(ccu);
762*4882a593Smuzhiyun 	of_node_put(ccu->node);
763*4882a593Smuzhiyun 	ccu->node = NULL;
764*4882a593Smuzhiyun 	iounmap(ccu->base);
765*4882a593Smuzhiyun 	ccu->base = NULL;
766*4882a593Smuzhiyun }
767*4882a593Smuzhiyun 
ccu_data_valid(struct ccu_data * ccu)768*4882a593Smuzhiyun static bool ccu_data_valid(struct ccu_data *ccu)
769*4882a593Smuzhiyun {
770*4882a593Smuzhiyun 	struct ccu_policy *ccu_policy;
771*4882a593Smuzhiyun 
772*4882a593Smuzhiyun 	if (!ccu_data_offsets_valid(ccu))
773*4882a593Smuzhiyun 		return false;
774*4882a593Smuzhiyun 
775*4882a593Smuzhiyun 	ccu_policy = &ccu->policy;
776*4882a593Smuzhiyun 	if (ccu_policy_exists(ccu_policy))
777*4882a593Smuzhiyun 		if (!ccu_policy_valid(ccu_policy, ccu->name))
778*4882a593Smuzhiyun 			return false;
779*4882a593Smuzhiyun 
780*4882a593Smuzhiyun 	return true;
781*4882a593Smuzhiyun }
782*4882a593Smuzhiyun 
783*4882a593Smuzhiyun static struct clk_hw *
of_clk_kona_onecell_get(struct of_phandle_args * clkspec,void * data)784*4882a593Smuzhiyun of_clk_kona_onecell_get(struct of_phandle_args *clkspec, void *data)
785*4882a593Smuzhiyun {
786*4882a593Smuzhiyun 	struct ccu_data *ccu = data;
787*4882a593Smuzhiyun 	unsigned int idx = clkspec->args[0];
788*4882a593Smuzhiyun 
789*4882a593Smuzhiyun 	if (idx >= ccu->clk_num) {
790*4882a593Smuzhiyun 		pr_err("%s: invalid index %u\n", __func__, idx);
791*4882a593Smuzhiyun 		return ERR_PTR(-EINVAL);
792*4882a593Smuzhiyun 	}
793*4882a593Smuzhiyun 
794*4882a593Smuzhiyun 	return &ccu->kona_clks[idx].hw;
795*4882a593Smuzhiyun }
796*4882a593Smuzhiyun 
797*4882a593Smuzhiyun /*
798*4882a593Smuzhiyun  * Set up a CCU.  Call the provided ccu_clks_setup callback to
799*4882a593Smuzhiyun  * initialize the array of clocks provided by the CCU.
800*4882a593Smuzhiyun  */
kona_dt_ccu_setup(struct ccu_data * ccu,struct device_node * node)801*4882a593Smuzhiyun void __init kona_dt_ccu_setup(struct ccu_data *ccu,
802*4882a593Smuzhiyun 			struct device_node *node)
803*4882a593Smuzhiyun {
804*4882a593Smuzhiyun 	struct resource res = { 0 };
805*4882a593Smuzhiyun 	resource_size_t range;
806*4882a593Smuzhiyun 	unsigned int i;
807*4882a593Smuzhiyun 	int ret;
808*4882a593Smuzhiyun 
809*4882a593Smuzhiyun 	ret = of_address_to_resource(node, 0, &res);
810*4882a593Smuzhiyun 	if (ret) {
811*4882a593Smuzhiyun 		pr_err("%s: no valid CCU registers found for %pOFn\n", __func__,
812*4882a593Smuzhiyun 			node);
813*4882a593Smuzhiyun 		goto out_err;
814*4882a593Smuzhiyun 	}
815*4882a593Smuzhiyun 
816*4882a593Smuzhiyun 	range = resource_size(&res);
817*4882a593Smuzhiyun 	if (range > (resource_size_t)U32_MAX) {
818*4882a593Smuzhiyun 		pr_err("%s: address range too large for %pOFn\n", __func__,
819*4882a593Smuzhiyun 			node);
820*4882a593Smuzhiyun 		goto out_err;
821*4882a593Smuzhiyun 	}
822*4882a593Smuzhiyun 
823*4882a593Smuzhiyun 	ccu->range = (u32)range;
824*4882a593Smuzhiyun 
825*4882a593Smuzhiyun 	if (!ccu_data_valid(ccu)) {
826*4882a593Smuzhiyun 		pr_err("%s: ccu data not valid for %pOFn\n", __func__, node);
827*4882a593Smuzhiyun 		goto out_err;
828*4882a593Smuzhiyun 	}
829*4882a593Smuzhiyun 
830*4882a593Smuzhiyun 	ccu->base = ioremap(res.start, ccu->range);
831*4882a593Smuzhiyun 	if (!ccu->base) {
832*4882a593Smuzhiyun 		pr_err("%s: unable to map CCU registers for %pOFn\n", __func__,
833*4882a593Smuzhiyun 			node);
834*4882a593Smuzhiyun 		goto out_err;
835*4882a593Smuzhiyun 	}
836*4882a593Smuzhiyun 	ccu->node = of_node_get(node);
837*4882a593Smuzhiyun 
838*4882a593Smuzhiyun 	/*
839*4882a593Smuzhiyun 	 * Set up each defined kona clock and save the result in
840*4882a593Smuzhiyun 	 * the clock framework clock array (in ccu->data).  Then
841*4882a593Smuzhiyun 	 * register as a provider for these clocks.
842*4882a593Smuzhiyun 	 */
843*4882a593Smuzhiyun 	for (i = 0; i < ccu->clk_num; i++) {
844*4882a593Smuzhiyun 		if (!ccu->kona_clks[i].ccu)
845*4882a593Smuzhiyun 			continue;
846*4882a593Smuzhiyun 		kona_clk_setup(&ccu->kona_clks[i]);
847*4882a593Smuzhiyun 	}
848*4882a593Smuzhiyun 
849*4882a593Smuzhiyun 	ret = of_clk_add_hw_provider(node, of_clk_kona_onecell_get, ccu);
850*4882a593Smuzhiyun 	if (ret) {
851*4882a593Smuzhiyun 		pr_err("%s: error adding ccu %pOFn as provider (%d)\n", __func__,
852*4882a593Smuzhiyun 				node, ret);
853*4882a593Smuzhiyun 		goto out_err;
854*4882a593Smuzhiyun 	}
855*4882a593Smuzhiyun 
856*4882a593Smuzhiyun 	if (!kona_ccu_init(ccu))
857*4882a593Smuzhiyun 		pr_err("Broadcom %pOFn initialization had errors\n", node);
858*4882a593Smuzhiyun 
859*4882a593Smuzhiyun 	return;
860*4882a593Smuzhiyun out_err:
861*4882a593Smuzhiyun 	kona_ccu_teardown(ccu);
862*4882a593Smuzhiyun 	pr_err("Broadcom %pOFn setup aborted\n", node);
863*4882a593Smuzhiyun }
864