18c2ecf20Sopenharmony_ci/*
28c2ecf20Sopenharmony_ci * Copyright (C) 2013 Broadcom Corporation
38c2ecf20Sopenharmony_ci * Copyright 2013 Linaro Limited
48c2ecf20Sopenharmony_ci *
58c2ecf20Sopenharmony_ci * This program is free software; you can redistribute it and/or
68c2ecf20Sopenharmony_ci * modify it under the terms of the GNU General Public License as
78c2ecf20Sopenharmony_ci * published by the Free Software Foundation version 2.
88c2ecf20Sopenharmony_ci *
98c2ecf20Sopenharmony_ci * This program is distributed "as is" WITHOUT ANY WARRANTY of any
108c2ecf20Sopenharmony_ci * kind, whether express or implied; without even the implied warranty
118c2ecf20Sopenharmony_ci * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
128c2ecf20Sopenharmony_ci * GNU General Public License for more details.
138c2ecf20Sopenharmony_ci */
148c2ecf20Sopenharmony_ci
158c2ecf20Sopenharmony_ci#include <linux/io.h>
168c2ecf20Sopenharmony_ci#include <linux/of_address.h>
178c2ecf20Sopenharmony_ci
188c2ecf20Sopenharmony_ci#include "clk-kona.h"
198c2ecf20Sopenharmony_ci
208c2ecf20Sopenharmony_ci/* These are used when a selector or trigger is found to be unneeded */
218c2ecf20Sopenharmony_ci#define selector_clear_exists(sel)	((sel)->width = 0)
228c2ecf20Sopenharmony_ci#define trigger_clear_exists(trig)	FLAG_CLEAR(trig, TRIG, EXISTS)
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ci/* Validity checking */
258c2ecf20Sopenharmony_ci
268c2ecf20Sopenharmony_cistatic bool ccu_data_offsets_valid(struct ccu_data *ccu)
278c2ecf20Sopenharmony_ci{
288c2ecf20Sopenharmony_ci	struct ccu_policy *ccu_policy = &ccu->policy;
298c2ecf20Sopenharmony_ci	u32 limit;
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ci	limit = ccu->range - sizeof(u32);
328c2ecf20Sopenharmony_ci	limit = round_down(limit, sizeof(u32));
338c2ecf20Sopenharmony_ci	if (ccu_policy_exists(ccu_policy)) {
348c2ecf20Sopenharmony_ci		if (ccu_policy->enable.offset > limit) {
358c2ecf20Sopenharmony_ci			pr_err("%s: bad policy enable offset for %s "
368c2ecf20Sopenharmony_ci					"(%u > %u)\n", __func__,
378c2ecf20Sopenharmony_ci				ccu->name, ccu_policy->enable.offset, limit);
388c2ecf20Sopenharmony_ci			return false;
398c2ecf20Sopenharmony_ci		}
408c2ecf20Sopenharmony_ci		if (ccu_policy->control.offset > limit) {
418c2ecf20Sopenharmony_ci			pr_err("%s: bad policy control offset for %s "
428c2ecf20Sopenharmony_ci					"(%u > %u)\n", __func__,
438c2ecf20Sopenharmony_ci				ccu->name, ccu_policy->control.offset, limit);
448c2ecf20Sopenharmony_ci			return false;
458c2ecf20Sopenharmony_ci		}
468c2ecf20Sopenharmony_ci	}
478c2ecf20Sopenharmony_ci
488c2ecf20Sopenharmony_ci	return true;
498c2ecf20Sopenharmony_ci}
508c2ecf20Sopenharmony_ci
518c2ecf20Sopenharmony_cistatic bool clk_requires_trigger(struct kona_clk *bcm_clk)
528c2ecf20Sopenharmony_ci{
538c2ecf20Sopenharmony_ci	struct peri_clk_data *peri = bcm_clk->u.peri;
548c2ecf20Sopenharmony_ci	struct bcm_clk_sel *sel;
558c2ecf20Sopenharmony_ci	struct bcm_clk_div *div;
568c2ecf20Sopenharmony_ci
578c2ecf20Sopenharmony_ci	if (bcm_clk->type != bcm_clk_peri)
588c2ecf20Sopenharmony_ci		return false;
598c2ecf20Sopenharmony_ci
608c2ecf20Sopenharmony_ci	sel = &peri->sel;
618c2ecf20Sopenharmony_ci	if (sel->parent_count && selector_exists(sel))
628c2ecf20Sopenharmony_ci		return true;
638c2ecf20Sopenharmony_ci
648c2ecf20Sopenharmony_ci	div = &peri->div;
658c2ecf20Sopenharmony_ci	if (!divider_exists(div))
668c2ecf20Sopenharmony_ci		return false;
678c2ecf20Sopenharmony_ci
688c2ecf20Sopenharmony_ci	/* Fixed dividers don't need triggers */
698c2ecf20Sopenharmony_ci	if (!divider_is_fixed(div))
708c2ecf20Sopenharmony_ci		return true;
718c2ecf20Sopenharmony_ci
728c2ecf20Sopenharmony_ci	div = &peri->pre_div;
738c2ecf20Sopenharmony_ci
748c2ecf20Sopenharmony_ci	return divider_exists(div) && !divider_is_fixed(div);
758c2ecf20Sopenharmony_ci}
768c2ecf20Sopenharmony_ci
778c2ecf20Sopenharmony_cistatic bool peri_clk_data_offsets_valid(struct kona_clk *bcm_clk)
788c2ecf20Sopenharmony_ci{
798c2ecf20Sopenharmony_ci	struct peri_clk_data *peri;
808c2ecf20Sopenharmony_ci	struct bcm_clk_policy *policy;
818c2ecf20Sopenharmony_ci	struct bcm_clk_gate *gate;
828c2ecf20Sopenharmony_ci	struct bcm_clk_hyst *hyst;
838c2ecf20Sopenharmony_ci	struct bcm_clk_div *div;
848c2ecf20Sopenharmony_ci	struct bcm_clk_sel *sel;
858c2ecf20Sopenharmony_ci	struct bcm_clk_trig *trig;
868c2ecf20Sopenharmony_ci	const char *name;
878c2ecf20Sopenharmony_ci	u32 range;
888c2ecf20Sopenharmony_ci	u32 limit;
898c2ecf20Sopenharmony_ci
908c2ecf20Sopenharmony_ci	BUG_ON(bcm_clk->type != bcm_clk_peri);
918c2ecf20Sopenharmony_ci	peri = bcm_clk->u.peri;
928c2ecf20Sopenharmony_ci	name = bcm_clk->init_data.name;
938c2ecf20Sopenharmony_ci	range = bcm_clk->ccu->range;
948c2ecf20Sopenharmony_ci
958c2ecf20Sopenharmony_ci	limit = range - sizeof(u32);
968c2ecf20Sopenharmony_ci	limit = round_down(limit, sizeof(u32));
978c2ecf20Sopenharmony_ci
988c2ecf20Sopenharmony_ci	policy = &peri->policy;
998c2ecf20Sopenharmony_ci	if (policy_exists(policy)) {
1008c2ecf20Sopenharmony_ci		if (policy->offset > limit) {
1018c2ecf20Sopenharmony_ci			pr_err("%s: bad policy offset for %s (%u > %u)\n",
1028c2ecf20Sopenharmony_ci				__func__, name, policy->offset, limit);
1038c2ecf20Sopenharmony_ci			return false;
1048c2ecf20Sopenharmony_ci		}
1058c2ecf20Sopenharmony_ci	}
1068c2ecf20Sopenharmony_ci
1078c2ecf20Sopenharmony_ci	gate = &peri->gate;
1088c2ecf20Sopenharmony_ci	hyst = &peri->hyst;
1098c2ecf20Sopenharmony_ci	if (gate_exists(gate)) {
1108c2ecf20Sopenharmony_ci		if (gate->offset > limit) {
1118c2ecf20Sopenharmony_ci			pr_err("%s: bad gate offset for %s (%u > %u)\n",
1128c2ecf20Sopenharmony_ci				__func__, name, gate->offset, limit);
1138c2ecf20Sopenharmony_ci			return false;
1148c2ecf20Sopenharmony_ci		}
1158c2ecf20Sopenharmony_ci
1168c2ecf20Sopenharmony_ci		if (hyst_exists(hyst)) {
1178c2ecf20Sopenharmony_ci			if (hyst->offset > limit) {
1188c2ecf20Sopenharmony_ci				pr_err("%s: bad hysteresis offset for %s "
1198c2ecf20Sopenharmony_ci					"(%u > %u)\n", __func__,
1208c2ecf20Sopenharmony_ci					name, hyst->offset, limit);
1218c2ecf20Sopenharmony_ci				return false;
1228c2ecf20Sopenharmony_ci			}
1238c2ecf20Sopenharmony_ci		}
1248c2ecf20Sopenharmony_ci	} else if (hyst_exists(hyst)) {
1258c2ecf20Sopenharmony_ci		pr_err("%s: hysteresis but no gate for %s\n", __func__, name);
1268c2ecf20Sopenharmony_ci		return false;
1278c2ecf20Sopenharmony_ci	}
1288c2ecf20Sopenharmony_ci
1298c2ecf20Sopenharmony_ci	div = &peri->div;
1308c2ecf20Sopenharmony_ci	if (divider_exists(div)) {
1318c2ecf20Sopenharmony_ci		if (div->u.s.offset > limit) {
1328c2ecf20Sopenharmony_ci			pr_err("%s: bad divider offset for %s (%u > %u)\n",
1338c2ecf20Sopenharmony_ci				__func__, name, div->u.s.offset, limit);
1348c2ecf20Sopenharmony_ci			return false;
1358c2ecf20Sopenharmony_ci		}
1368c2ecf20Sopenharmony_ci	}
1378c2ecf20Sopenharmony_ci
1388c2ecf20Sopenharmony_ci	div = &peri->pre_div;
1398c2ecf20Sopenharmony_ci	if (divider_exists(div)) {
1408c2ecf20Sopenharmony_ci		if (div->u.s.offset > limit) {
1418c2ecf20Sopenharmony_ci			pr_err("%s: bad pre-divider offset for %s "
1428c2ecf20Sopenharmony_ci					"(%u > %u)\n",
1438c2ecf20Sopenharmony_ci				__func__, name, div->u.s.offset, limit);
1448c2ecf20Sopenharmony_ci			return false;
1458c2ecf20Sopenharmony_ci		}
1468c2ecf20Sopenharmony_ci	}
1478c2ecf20Sopenharmony_ci
1488c2ecf20Sopenharmony_ci	sel = &peri->sel;
1498c2ecf20Sopenharmony_ci	if (selector_exists(sel)) {
1508c2ecf20Sopenharmony_ci		if (sel->offset > limit) {
1518c2ecf20Sopenharmony_ci			pr_err("%s: bad selector offset for %s (%u > %u)\n",
1528c2ecf20Sopenharmony_ci				__func__, name, sel->offset, limit);
1538c2ecf20Sopenharmony_ci			return false;
1548c2ecf20Sopenharmony_ci		}
1558c2ecf20Sopenharmony_ci	}
1568c2ecf20Sopenharmony_ci
1578c2ecf20Sopenharmony_ci	trig = &peri->trig;
1588c2ecf20Sopenharmony_ci	if (trigger_exists(trig)) {
1598c2ecf20Sopenharmony_ci		if (trig->offset > limit) {
1608c2ecf20Sopenharmony_ci			pr_err("%s: bad trigger offset for %s (%u > %u)\n",
1618c2ecf20Sopenharmony_ci				__func__, name, trig->offset, limit);
1628c2ecf20Sopenharmony_ci			return false;
1638c2ecf20Sopenharmony_ci		}
1648c2ecf20Sopenharmony_ci	}
1658c2ecf20Sopenharmony_ci
1668c2ecf20Sopenharmony_ci	trig = &peri->pre_trig;
1678c2ecf20Sopenharmony_ci	if (trigger_exists(trig)) {
1688c2ecf20Sopenharmony_ci		if (trig->offset > limit) {
1698c2ecf20Sopenharmony_ci			pr_err("%s: bad pre-trigger offset for %s (%u > %u)\n",
1708c2ecf20Sopenharmony_ci				__func__, name, trig->offset, limit);
1718c2ecf20Sopenharmony_ci			return false;
1728c2ecf20Sopenharmony_ci		}
1738c2ecf20Sopenharmony_ci	}
1748c2ecf20Sopenharmony_ci
1758c2ecf20Sopenharmony_ci	return true;
1768c2ecf20Sopenharmony_ci}
1778c2ecf20Sopenharmony_ci
1788c2ecf20Sopenharmony_ci/* A bit position must be less than the number of bits in a 32-bit register. */
1798c2ecf20Sopenharmony_cistatic bool bit_posn_valid(u32 bit_posn, const char *field_name,
1808c2ecf20Sopenharmony_ci			const char *clock_name)
1818c2ecf20Sopenharmony_ci{
1828c2ecf20Sopenharmony_ci	u32 limit = BITS_PER_BYTE * sizeof(u32) - 1;
1838c2ecf20Sopenharmony_ci
1848c2ecf20Sopenharmony_ci	if (bit_posn > limit) {
1858c2ecf20Sopenharmony_ci		pr_err("%s: bad %s bit for %s (%u > %u)\n", __func__,
1868c2ecf20Sopenharmony_ci			field_name, clock_name, bit_posn, limit);
1878c2ecf20Sopenharmony_ci		return false;
1888c2ecf20Sopenharmony_ci	}
1898c2ecf20Sopenharmony_ci	return true;
1908c2ecf20Sopenharmony_ci}
1918c2ecf20Sopenharmony_ci
1928c2ecf20Sopenharmony_ci/*
1938c2ecf20Sopenharmony_ci * A bitfield must be at least 1 bit wide.  Both the low-order and
1948c2ecf20Sopenharmony_ci * high-order bits must lie within a 32-bit register.  We require
1958c2ecf20Sopenharmony_ci * fields to be less than 32 bits wide, mainly because we use
1968c2ecf20Sopenharmony_ci * shifting to produce field masks, and shifting a full word width
1978c2ecf20Sopenharmony_ci * is not well-defined by the C standard.
1988c2ecf20Sopenharmony_ci */
1998c2ecf20Sopenharmony_cistatic bool bitfield_valid(u32 shift, u32 width, const char *field_name,
2008c2ecf20Sopenharmony_ci			const char *clock_name)
2018c2ecf20Sopenharmony_ci{
2028c2ecf20Sopenharmony_ci	u32 limit = BITS_PER_BYTE * sizeof(u32);
2038c2ecf20Sopenharmony_ci
2048c2ecf20Sopenharmony_ci	if (!width) {
2058c2ecf20Sopenharmony_ci		pr_err("%s: bad %s field width 0 for %s\n", __func__,
2068c2ecf20Sopenharmony_ci			field_name, clock_name);
2078c2ecf20Sopenharmony_ci		return false;
2088c2ecf20Sopenharmony_ci	}
2098c2ecf20Sopenharmony_ci	if (shift + width > limit) {
2108c2ecf20Sopenharmony_ci		pr_err("%s: bad %s for %s (%u + %u > %u)\n", __func__,
2118c2ecf20Sopenharmony_ci			field_name, clock_name, shift, width, limit);
2128c2ecf20Sopenharmony_ci		return false;
2138c2ecf20Sopenharmony_ci	}
2148c2ecf20Sopenharmony_ci	return true;
2158c2ecf20Sopenharmony_ci}
2168c2ecf20Sopenharmony_ci
2178c2ecf20Sopenharmony_cistatic bool
2188c2ecf20Sopenharmony_ciccu_policy_valid(struct ccu_policy *ccu_policy, const char *ccu_name)
2198c2ecf20Sopenharmony_ci{
2208c2ecf20Sopenharmony_ci	struct bcm_lvm_en *enable = &ccu_policy->enable;
2218c2ecf20Sopenharmony_ci	struct bcm_policy_ctl *control;
2228c2ecf20Sopenharmony_ci
2238c2ecf20Sopenharmony_ci	if (!bit_posn_valid(enable->bit, "policy enable", ccu_name))
2248c2ecf20Sopenharmony_ci		return false;
2258c2ecf20Sopenharmony_ci
2268c2ecf20Sopenharmony_ci	control = &ccu_policy->control;
2278c2ecf20Sopenharmony_ci	if (!bit_posn_valid(control->go_bit, "policy control GO", ccu_name))
2288c2ecf20Sopenharmony_ci		return false;
2298c2ecf20Sopenharmony_ci
2308c2ecf20Sopenharmony_ci	if (!bit_posn_valid(control->atl_bit, "policy control ATL", ccu_name))
2318c2ecf20Sopenharmony_ci		return false;
2328c2ecf20Sopenharmony_ci
2338c2ecf20Sopenharmony_ci	if (!bit_posn_valid(control->ac_bit, "policy control AC", ccu_name))
2348c2ecf20Sopenharmony_ci		return false;
2358c2ecf20Sopenharmony_ci
2368c2ecf20Sopenharmony_ci	return true;
2378c2ecf20Sopenharmony_ci}
2388c2ecf20Sopenharmony_ci
2398c2ecf20Sopenharmony_cistatic bool policy_valid(struct bcm_clk_policy *policy, const char *clock_name)
2408c2ecf20Sopenharmony_ci{
2418c2ecf20Sopenharmony_ci	if (!bit_posn_valid(policy->bit, "policy", clock_name))
2428c2ecf20Sopenharmony_ci		return false;
2438c2ecf20Sopenharmony_ci
2448c2ecf20Sopenharmony_ci	return true;
2458c2ecf20Sopenharmony_ci}
2468c2ecf20Sopenharmony_ci
2478c2ecf20Sopenharmony_ci/*
2488c2ecf20Sopenharmony_ci * All gates, if defined, have a status bit, and for hardware-only
2498c2ecf20Sopenharmony_ci * gates, that's it.  Gates that can be software controlled also
2508c2ecf20Sopenharmony_ci * have an enable bit.  And a gate that can be hardware or software
2518c2ecf20Sopenharmony_ci * controlled will have a hardware/software select bit.
2528c2ecf20Sopenharmony_ci */
2538c2ecf20Sopenharmony_cistatic bool gate_valid(struct bcm_clk_gate *gate, const char *field_name,
2548c2ecf20Sopenharmony_ci			const char *clock_name)
2558c2ecf20Sopenharmony_ci{
2568c2ecf20Sopenharmony_ci	if (!bit_posn_valid(gate->status_bit, "gate status", clock_name))
2578c2ecf20Sopenharmony_ci		return false;
2588c2ecf20Sopenharmony_ci
2598c2ecf20Sopenharmony_ci	if (gate_is_sw_controllable(gate)) {
2608c2ecf20Sopenharmony_ci		if (!bit_posn_valid(gate->en_bit, "gate enable", clock_name))
2618c2ecf20Sopenharmony_ci			return false;
2628c2ecf20Sopenharmony_ci
2638c2ecf20Sopenharmony_ci		if (gate_is_hw_controllable(gate)) {
2648c2ecf20Sopenharmony_ci			if (!bit_posn_valid(gate->hw_sw_sel_bit,
2658c2ecf20Sopenharmony_ci						"gate hw/sw select",
2668c2ecf20Sopenharmony_ci						clock_name))
2678c2ecf20Sopenharmony_ci				return false;
2688c2ecf20Sopenharmony_ci		}
2698c2ecf20Sopenharmony_ci	} else {
2708c2ecf20Sopenharmony_ci		BUG_ON(!gate_is_hw_controllable(gate));
2718c2ecf20Sopenharmony_ci	}
2728c2ecf20Sopenharmony_ci
2738c2ecf20Sopenharmony_ci	return true;
2748c2ecf20Sopenharmony_ci}
2758c2ecf20Sopenharmony_ci
2768c2ecf20Sopenharmony_cistatic bool hyst_valid(struct bcm_clk_hyst *hyst, const char *clock_name)
2778c2ecf20Sopenharmony_ci{
2788c2ecf20Sopenharmony_ci	if (!bit_posn_valid(hyst->en_bit, "hysteresis enable", clock_name))
2798c2ecf20Sopenharmony_ci		return false;
2808c2ecf20Sopenharmony_ci
2818c2ecf20Sopenharmony_ci	if (!bit_posn_valid(hyst->val_bit, "hysteresis value", clock_name))
2828c2ecf20Sopenharmony_ci		return false;
2838c2ecf20Sopenharmony_ci
2848c2ecf20Sopenharmony_ci	return true;
2858c2ecf20Sopenharmony_ci}
2868c2ecf20Sopenharmony_ci
2878c2ecf20Sopenharmony_ci/*
2888c2ecf20Sopenharmony_ci * A selector bitfield must be valid.  Its parent_sel array must
2898c2ecf20Sopenharmony_ci * also be reasonable for the field.
2908c2ecf20Sopenharmony_ci */
2918c2ecf20Sopenharmony_cistatic bool sel_valid(struct bcm_clk_sel *sel, const char *field_name,
2928c2ecf20Sopenharmony_ci			const char *clock_name)
2938c2ecf20Sopenharmony_ci{
2948c2ecf20Sopenharmony_ci	if (!bitfield_valid(sel->shift, sel->width, field_name, clock_name))
2958c2ecf20Sopenharmony_ci		return false;
2968c2ecf20Sopenharmony_ci
2978c2ecf20Sopenharmony_ci	if (sel->parent_count) {
2988c2ecf20Sopenharmony_ci		u32 max_sel;
2998c2ecf20Sopenharmony_ci		u32 limit;
3008c2ecf20Sopenharmony_ci
3018c2ecf20Sopenharmony_ci		/*
3028c2ecf20Sopenharmony_ci		 * Make sure the selector field can hold all the
3038c2ecf20Sopenharmony_ci		 * selector values we expect to be able to use.  A
3048c2ecf20Sopenharmony_ci		 * clock only needs to have a selector defined if it
3058c2ecf20Sopenharmony_ci		 * has more than one parent.  And in that case the
3068c2ecf20Sopenharmony_ci		 * highest selector value will be in the last entry
3078c2ecf20Sopenharmony_ci		 * in the array.
3088c2ecf20Sopenharmony_ci		 */
3098c2ecf20Sopenharmony_ci		max_sel = sel->parent_sel[sel->parent_count - 1];
3108c2ecf20Sopenharmony_ci		limit = (1 << sel->width) - 1;
3118c2ecf20Sopenharmony_ci		if (max_sel > limit) {
3128c2ecf20Sopenharmony_ci			pr_err("%s: bad selector for %s "
3138c2ecf20Sopenharmony_ci					"(%u needs > %u bits)\n",
3148c2ecf20Sopenharmony_ci				__func__, clock_name, max_sel,
3158c2ecf20Sopenharmony_ci				sel->width);
3168c2ecf20Sopenharmony_ci			return false;
3178c2ecf20Sopenharmony_ci		}
3188c2ecf20Sopenharmony_ci	} else {
3198c2ecf20Sopenharmony_ci		pr_warn("%s: ignoring selector for %s (no parents)\n",
3208c2ecf20Sopenharmony_ci			__func__, clock_name);
3218c2ecf20Sopenharmony_ci		selector_clear_exists(sel);
3228c2ecf20Sopenharmony_ci		kfree(sel->parent_sel);
3238c2ecf20Sopenharmony_ci		sel->parent_sel = NULL;
3248c2ecf20Sopenharmony_ci	}
3258c2ecf20Sopenharmony_ci
3268c2ecf20Sopenharmony_ci	return true;
3278c2ecf20Sopenharmony_ci}
3288c2ecf20Sopenharmony_ci
3298c2ecf20Sopenharmony_ci/*
3308c2ecf20Sopenharmony_ci * A fixed divider just needs to be non-zero.  A variable divider
3318c2ecf20Sopenharmony_ci * has to have a valid divider bitfield, and if it has a fraction,
3328c2ecf20Sopenharmony_ci * the width of the fraction must not be no more than the width of
3338c2ecf20Sopenharmony_ci * the divider as a whole.
3348c2ecf20Sopenharmony_ci */
3358c2ecf20Sopenharmony_cistatic bool div_valid(struct bcm_clk_div *div, const char *field_name,
3368c2ecf20Sopenharmony_ci			const char *clock_name)
3378c2ecf20Sopenharmony_ci{
3388c2ecf20Sopenharmony_ci	if (divider_is_fixed(div)) {
3398c2ecf20Sopenharmony_ci		/* Any fixed divider value but 0 is OK */
3408c2ecf20Sopenharmony_ci		if (div->u.fixed == 0) {
3418c2ecf20Sopenharmony_ci			pr_err("%s: bad %s fixed value 0 for %s\n", __func__,
3428c2ecf20Sopenharmony_ci				field_name, clock_name);
3438c2ecf20Sopenharmony_ci			return false;
3448c2ecf20Sopenharmony_ci		}
3458c2ecf20Sopenharmony_ci		return true;
3468c2ecf20Sopenharmony_ci	}
3478c2ecf20Sopenharmony_ci	if (!bitfield_valid(div->u.s.shift, div->u.s.width,
3488c2ecf20Sopenharmony_ci				field_name, clock_name))
3498c2ecf20Sopenharmony_ci		return false;
3508c2ecf20Sopenharmony_ci
3518c2ecf20Sopenharmony_ci	if (divider_has_fraction(div))
3528c2ecf20Sopenharmony_ci		if (div->u.s.frac_width > div->u.s.width) {
3538c2ecf20Sopenharmony_ci			pr_warn("%s: bad %s fraction width for %s (%u > %u)\n",
3548c2ecf20Sopenharmony_ci				__func__, field_name, clock_name,
3558c2ecf20Sopenharmony_ci				div->u.s.frac_width, div->u.s.width);
3568c2ecf20Sopenharmony_ci			return false;
3578c2ecf20Sopenharmony_ci		}
3588c2ecf20Sopenharmony_ci
3598c2ecf20Sopenharmony_ci	return true;
3608c2ecf20Sopenharmony_ci}
3618c2ecf20Sopenharmony_ci
3628c2ecf20Sopenharmony_ci/*
3638c2ecf20Sopenharmony_ci * If a clock has two dividers, the combined number of fractional
3648c2ecf20Sopenharmony_ci * bits must be representable in a 32-bit unsigned value.  This
3658c2ecf20Sopenharmony_ci * is because we scale up a dividend using both dividers before
3668c2ecf20Sopenharmony_ci * dividing to improve accuracy, and we need to avoid overflow.
3678c2ecf20Sopenharmony_ci */
3688c2ecf20Sopenharmony_cistatic bool kona_dividers_valid(struct kona_clk *bcm_clk)
3698c2ecf20Sopenharmony_ci{
3708c2ecf20Sopenharmony_ci	struct peri_clk_data *peri = bcm_clk->u.peri;
3718c2ecf20Sopenharmony_ci	struct bcm_clk_div *div;
3728c2ecf20Sopenharmony_ci	struct bcm_clk_div *pre_div;
3738c2ecf20Sopenharmony_ci	u32 limit;
3748c2ecf20Sopenharmony_ci
3758c2ecf20Sopenharmony_ci	BUG_ON(bcm_clk->type != bcm_clk_peri);
3768c2ecf20Sopenharmony_ci
3778c2ecf20Sopenharmony_ci	if (!divider_exists(&peri->div) || !divider_exists(&peri->pre_div))
3788c2ecf20Sopenharmony_ci		return true;
3798c2ecf20Sopenharmony_ci
3808c2ecf20Sopenharmony_ci	div = &peri->div;
3818c2ecf20Sopenharmony_ci	pre_div = &peri->pre_div;
3828c2ecf20Sopenharmony_ci	if (divider_is_fixed(div) || divider_is_fixed(pre_div))
3838c2ecf20Sopenharmony_ci		return true;
3848c2ecf20Sopenharmony_ci
3858c2ecf20Sopenharmony_ci	limit = BITS_PER_BYTE * sizeof(u32);
3868c2ecf20Sopenharmony_ci
3878c2ecf20Sopenharmony_ci	return div->u.s.frac_width + pre_div->u.s.frac_width <= limit;
3888c2ecf20Sopenharmony_ci}
3898c2ecf20Sopenharmony_ci
3908c2ecf20Sopenharmony_ci
3918c2ecf20Sopenharmony_ci/* A trigger just needs to represent a valid bit position */
3928c2ecf20Sopenharmony_cistatic bool trig_valid(struct bcm_clk_trig *trig, const char *field_name,
3938c2ecf20Sopenharmony_ci			const char *clock_name)
3948c2ecf20Sopenharmony_ci{
3958c2ecf20Sopenharmony_ci	return bit_posn_valid(trig->bit, field_name, clock_name);
3968c2ecf20Sopenharmony_ci}
3978c2ecf20Sopenharmony_ci
3988c2ecf20Sopenharmony_ci/* Determine whether the set of peripheral clock registers are valid. */
3998c2ecf20Sopenharmony_cistatic bool
4008c2ecf20Sopenharmony_ciperi_clk_data_valid(struct kona_clk *bcm_clk)
4018c2ecf20Sopenharmony_ci{
4028c2ecf20Sopenharmony_ci	struct peri_clk_data *peri;
4038c2ecf20Sopenharmony_ci	struct bcm_clk_policy *policy;
4048c2ecf20Sopenharmony_ci	struct bcm_clk_gate *gate;
4058c2ecf20Sopenharmony_ci	struct bcm_clk_hyst *hyst;
4068c2ecf20Sopenharmony_ci	struct bcm_clk_sel *sel;
4078c2ecf20Sopenharmony_ci	struct bcm_clk_div *div;
4088c2ecf20Sopenharmony_ci	struct bcm_clk_div *pre_div;
4098c2ecf20Sopenharmony_ci	struct bcm_clk_trig *trig;
4108c2ecf20Sopenharmony_ci	const char *name;
4118c2ecf20Sopenharmony_ci
4128c2ecf20Sopenharmony_ci	BUG_ON(bcm_clk->type != bcm_clk_peri);
4138c2ecf20Sopenharmony_ci
4148c2ecf20Sopenharmony_ci	/*
4158c2ecf20Sopenharmony_ci	 * First validate register offsets.  This is the only place
4168c2ecf20Sopenharmony_ci	 * where we need something from the ccu, so we do these
4178c2ecf20Sopenharmony_ci	 * together.
4188c2ecf20Sopenharmony_ci	 */
4198c2ecf20Sopenharmony_ci	if (!peri_clk_data_offsets_valid(bcm_clk))
4208c2ecf20Sopenharmony_ci		return false;
4218c2ecf20Sopenharmony_ci
4228c2ecf20Sopenharmony_ci	peri = bcm_clk->u.peri;
4238c2ecf20Sopenharmony_ci	name = bcm_clk->init_data.name;
4248c2ecf20Sopenharmony_ci
4258c2ecf20Sopenharmony_ci	policy = &peri->policy;
4268c2ecf20Sopenharmony_ci	if (policy_exists(policy) && !policy_valid(policy, name))
4278c2ecf20Sopenharmony_ci		return false;
4288c2ecf20Sopenharmony_ci
4298c2ecf20Sopenharmony_ci	gate = &peri->gate;
4308c2ecf20Sopenharmony_ci	if (gate_exists(gate) && !gate_valid(gate, "gate", name))
4318c2ecf20Sopenharmony_ci		return false;
4328c2ecf20Sopenharmony_ci
4338c2ecf20Sopenharmony_ci	hyst = &peri->hyst;
4348c2ecf20Sopenharmony_ci	if (hyst_exists(hyst) && !hyst_valid(hyst, name))
4358c2ecf20Sopenharmony_ci		return false;
4368c2ecf20Sopenharmony_ci
4378c2ecf20Sopenharmony_ci	sel = &peri->sel;
4388c2ecf20Sopenharmony_ci	if (selector_exists(sel)) {
4398c2ecf20Sopenharmony_ci		if (!sel_valid(sel, "selector", name))
4408c2ecf20Sopenharmony_ci			return false;
4418c2ecf20Sopenharmony_ci
4428c2ecf20Sopenharmony_ci	} else if (sel->parent_count > 1) {
4438c2ecf20Sopenharmony_ci		pr_err("%s: multiple parents but no selector for %s\n",
4448c2ecf20Sopenharmony_ci			__func__, name);
4458c2ecf20Sopenharmony_ci
4468c2ecf20Sopenharmony_ci		return false;
4478c2ecf20Sopenharmony_ci	}
4488c2ecf20Sopenharmony_ci
4498c2ecf20Sopenharmony_ci	div = &peri->div;
4508c2ecf20Sopenharmony_ci	pre_div = &peri->pre_div;
4518c2ecf20Sopenharmony_ci	if (divider_exists(div)) {
4528c2ecf20Sopenharmony_ci		if (!div_valid(div, "divider", name))
4538c2ecf20Sopenharmony_ci			return false;
4548c2ecf20Sopenharmony_ci
4558c2ecf20Sopenharmony_ci		if (divider_exists(pre_div))
4568c2ecf20Sopenharmony_ci			if (!div_valid(pre_div, "pre-divider", name))
4578c2ecf20Sopenharmony_ci				return false;
4588c2ecf20Sopenharmony_ci	} else if (divider_exists(pre_div)) {
4598c2ecf20Sopenharmony_ci		pr_err("%s: pre-divider but no divider for %s\n", __func__,
4608c2ecf20Sopenharmony_ci			name);
4618c2ecf20Sopenharmony_ci		return false;
4628c2ecf20Sopenharmony_ci	}
4638c2ecf20Sopenharmony_ci
4648c2ecf20Sopenharmony_ci	trig = &peri->trig;
4658c2ecf20Sopenharmony_ci	if (trigger_exists(trig)) {
4668c2ecf20Sopenharmony_ci		if (!trig_valid(trig, "trigger", name))
4678c2ecf20Sopenharmony_ci			return false;
4688c2ecf20Sopenharmony_ci
4698c2ecf20Sopenharmony_ci		if (trigger_exists(&peri->pre_trig)) {
4708c2ecf20Sopenharmony_ci			if (!trig_valid(trig, "pre-trigger", name)) {
4718c2ecf20Sopenharmony_ci				return false;
4728c2ecf20Sopenharmony_ci			}
4738c2ecf20Sopenharmony_ci		}
4748c2ecf20Sopenharmony_ci		if (!clk_requires_trigger(bcm_clk)) {
4758c2ecf20Sopenharmony_ci			pr_warn("%s: ignoring trigger for %s (not needed)\n",
4768c2ecf20Sopenharmony_ci				__func__, name);
4778c2ecf20Sopenharmony_ci			trigger_clear_exists(trig);
4788c2ecf20Sopenharmony_ci		}
4798c2ecf20Sopenharmony_ci	} else if (trigger_exists(&peri->pre_trig)) {
4808c2ecf20Sopenharmony_ci		pr_err("%s: pre-trigger but no trigger for %s\n", __func__,
4818c2ecf20Sopenharmony_ci			name);
4828c2ecf20Sopenharmony_ci		return false;
4838c2ecf20Sopenharmony_ci	} else if (clk_requires_trigger(bcm_clk)) {
4848c2ecf20Sopenharmony_ci		pr_err("%s: required trigger missing for %s\n", __func__,
4858c2ecf20Sopenharmony_ci			name);
4868c2ecf20Sopenharmony_ci		return false;
4878c2ecf20Sopenharmony_ci	}
4888c2ecf20Sopenharmony_ci
4898c2ecf20Sopenharmony_ci	return kona_dividers_valid(bcm_clk);
4908c2ecf20Sopenharmony_ci}
4918c2ecf20Sopenharmony_ci
4928c2ecf20Sopenharmony_cistatic bool kona_clk_valid(struct kona_clk *bcm_clk)
4938c2ecf20Sopenharmony_ci{
4948c2ecf20Sopenharmony_ci	switch (bcm_clk->type) {
4958c2ecf20Sopenharmony_ci	case bcm_clk_peri:
4968c2ecf20Sopenharmony_ci		if (!peri_clk_data_valid(bcm_clk))
4978c2ecf20Sopenharmony_ci			return false;
4988c2ecf20Sopenharmony_ci		break;
4998c2ecf20Sopenharmony_ci	default:
5008c2ecf20Sopenharmony_ci		pr_err("%s: unrecognized clock type (%d)\n", __func__,
5018c2ecf20Sopenharmony_ci			(int)bcm_clk->type);
5028c2ecf20Sopenharmony_ci		return false;
5038c2ecf20Sopenharmony_ci	}
5048c2ecf20Sopenharmony_ci	return true;
5058c2ecf20Sopenharmony_ci}
5068c2ecf20Sopenharmony_ci
5078c2ecf20Sopenharmony_ci/*
5088c2ecf20Sopenharmony_ci * Scan an array of parent clock names to determine whether there
5098c2ecf20Sopenharmony_ci * are any entries containing BAD_CLK_NAME.  Such entries are
5108c2ecf20Sopenharmony_ci * placeholders for non-supported clocks.  Keep track of the
5118c2ecf20Sopenharmony_ci * position of each clock name in the original array.
5128c2ecf20Sopenharmony_ci *
5138c2ecf20Sopenharmony_ci * Allocates an array of pointers to to hold the names of all
5148c2ecf20Sopenharmony_ci * non-null entries in the original array, and returns a pointer to
5158c2ecf20Sopenharmony_ci * that array in *names.  This will be used for registering the
5168c2ecf20Sopenharmony_ci * clock with the common clock code.  On successful return,
5178c2ecf20Sopenharmony_ci * *count indicates how many entries are in that names array.
5188c2ecf20Sopenharmony_ci *
5198c2ecf20Sopenharmony_ci * If there is more than one entry in the resulting names array,
5208c2ecf20Sopenharmony_ci * another array is allocated to record the parent selector value
5218c2ecf20Sopenharmony_ci * for each (defined) parent clock.  This is the value that
5228c2ecf20Sopenharmony_ci * represents this parent clock in the clock's source selector
5238c2ecf20Sopenharmony_ci * register.  The position of the clock in the original parent array
5248c2ecf20Sopenharmony_ci * defines that selector value.  The number of entries in this array
5258c2ecf20Sopenharmony_ci * is the same as the number of entries in the parent names array.
5268c2ecf20Sopenharmony_ci *
5278c2ecf20Sopenharmony_ci * The array of selector values is returned.  If the clock has no
5288c2ecf20Sopenharmony_ci * parents, no selector is required and a null pointer is returned.
5298c2ecf20Sopenharmony_ci *
5308c2ecf20Sopenharmony_ci * Returns a null pointer if the clock names array supplied was
5318c2ecf20Sopenharmony_ci * null.  (This is not an error.)
5328c2ecf20Sopenharmony_ci *
5338c2ecf20Sopenharmony_ci * Returns a pointer-coded error if an error occurs.
5348c2ecf20Sopenharmony_ci */
5358c2ecf20Sopenharmony_cistatic u32 *parent_process(const char *clocks[],
5368c2ecf20Sopenharmony_ci			u32 *count, const char ***names)
5378c2ecf20Sopenharmony_ci{
5388c2ecf20Sopenharmony_ci	static const char **parent_names;
5398c2ecf20Sopenharmony_ci	static u32 *parent_sel;
5408c2ecf20Sopenharmony_ci	const char **clock;
5418c2ecf20Sopenharmony_ci	u32 parent_count;
5428c2ecf20Sopenharmony_ci	u32 bad_count = 0;
5438c2ecf20Sopenharmony_ci	u32 orig_count;
5448c2ecf20Sopenharmony_ci	u32 i;
5458c2ecf20Sopenharmony_ci	u32 j;
5468c2ecf20Sopenharmony_ci
5478c2ecf20Sopenharmony_ci	*count = 0;	/* In case of early return */
5488c2ecf20Sopenharmony_ci	*names = NULL;
5498c2ecf20Sopenharmony_ci	if (!clocks)
5508c2ecf20Sopenharmony_ci		return NULL;
5518c2ecf20Sopenharmony_ci
5528c2ecf20Sopenharmony_ci	/*
5538c2ecf20Sopenharmony_ci	 * Count the number of names in the null-terminated array,
5548c2ecf20Sopenharmony_ci	 * and find out how many of those are actually clock names.
5558c2ecf20Sopenharmony_ci	 */
5568c2ecf20Sopenharmony_ci	for (clock = clocks; *clock; clock++)
5578c2ecf20Sopenharmony_ci		if (*clock == BAD_CLK_NAME)
5588c2ecf20Sopenharmony_ci			bad_count++;
5598c2ecf20Sopenharmony_ci	orig_count = (u32)(clock - clocks);
5608c2ecf20Sopenharmony_ci	parent_count = orig_count - bad_count;
5618c2ecf20Sopenharmony_ci
5628c2ecf20Sopenharmony_ci	/* If all clocks are unsupported, we treat it as no clock */
5638c2ecf20Sopenharmony_ci	if (!parent_count)
5648c2ecf20Sopenharmony_ci		return NULL;
5658c2ecf20Sopenharmony_ci
5668c2ecf20Sopenharmony_ci	/* Avoid exceeding our parent clock limit */
5678c2ecf20Sopenharmony_ci	if (parent_count > PARENT_COUNT_MAX) {
5688c2ecf20Sopenharmony_ci		pr_err("%s: too many parents (%u > %u)\n", __func__,
5698c2ecf20Sopenharmony_ci			parent_count, PARENT_COUNT_MAX);
5708c2ecf20Sopenharmony_ci		return ERR_PTR(-EINVAL);
5718c2ecf20Sopenharmony_ci	}
5728c2ecf20Sopenharmony_ci
5738c2ecf20Sopenharmony_ci	/*
5748c2ecf20Sopenharmony_ci	 * There is one parent name for each defined parent clock.
5758c2ecf20Sopenharmony_ci	 * We also maintain an array containing the selector value
5768c2ecf20Sopenharmony_ci	 * for each defined clock.  If there's only one clock, the
5778c2ecf20Sopenharmony_ci	 * selector is not required, but we allocate space for the
5788c2ecf20Sopenharmony_ci	 * array anyway to keep things simple.
5798c2ecf20Sopenharmony_ci	 */
5808c2ecf20Sopenharmony_ci	parent_names = kmalloc_array(parent_count, sizeof(*parent_names),
5818c2ecf20Sopenharmony_ci			       GFP_KERNEL);
5828c2ecf20Sopenharmony_ci	if (!parent_names)
5838c2ecf20Sopenharmony_ci		return ERR_PTR(-ENOMEM);
5848c2ecf20Sopenharmony_ci
5858c2ecf20Sopenharmony_ci	/* There is at least one parent, so allocate a selector array */
5868c2ecf20Sopenharmony_ci	parent_sel = kmalloc_array(parent_count, sizeof(*parent_sel),
5878c2ecf20Sopenharmony_ci				   GFP_KERNEL);
5888c2ecf20Sopenharmony_ci	if (!parent_sel) {
5898c2ecf20Sopenharmony_ci		kfree(parent_names);
5908c2ecf20Sopenharmony_ci
5918c2ecf20Sopenharmony_ci		return ERR_PTR(-ENOMEM);
5928c2ecf20Sopenharmony_ci	}
5938c2ecf20Sopenharmony_ci
5948c2ecf20Sopenharmony_ci	/* Now fill in the parent names and selector arrays */
5958c2ecf20Sopenharmony_ci	for (i = 0, j = 0; i < orig_count; i++) {
5968c2ecf20Sopenharmony_ci		if (clocks[i] != BAD_CLK_NAME) {
5978c2ecf20Sopenharmony_ci			parent_names[j] = clocks[i];
5988c2ecf20Sopenharmony_ci			parent_sel[j] = i;
5998c2ecf20Sopenharmony_ci			j++;
6008c2ecf20Sopenharmony_ci		}
6018c2ecf20Sopenharmony_ci	}
6028c2ecf20Sopenharmony_ci	*names = parent_names;
6038c2ecf20Sopenharmony_ci	*count = parent_count;
6048c2ecf20Sopenharmony_ci
6058c2ecf20Sopenharmony_ci	return parent_sel;
6068c2ecf20Sopenharmony_ci}
6078c2ecf20Sopenharmony_ci
6088c2ecf20Sopenharmony_cistatic int
6098c2ecf20Sopenharmony_ciclk_sel_setup(const char **clocks, struct bcm_clk_sel *sel,
6108c2ecf20Sopenharmony_ci		struct clk_init_data *init_data)
6118c2ecf20Sopenharmony_ci{
6128c2ecf20Sopenharmony_ci	const char **parent_names = NULL;
6138c2ecf20Sopenharmony_ci	u32 parent_count = 0;
6148c2ecf20Sopenharmony_ci	u32 *parent_sel;
6158c2ecf20Sopenharmony_ci
6168c2ecf20Sopenharmony_ci	/*
6178c2ecf20Sopenharmony_ci	 * If a peripheral clock has multiple parents, the value
6188c2ecf20Sopenharmony_ci	 * used by the hardware to select that parent is represented
6198c2ecf20Sopenharmony_ci	 * by the parent clock's position in the "clocks" list.  Some
6208c2ecf20Sopenharmony_ci	 * values don't have defined or supported clocks; these will
6218c2ecf20Sopenharmony_ci	 * have BAD_CLK_NAME entries in the parents[] array.  The
6228c2ecf20Sopenharmony_ci	 * list is terminated by a NULL entry.
6238c2ecf20Sopenharmony_ci	 *
6248c2ecf20Sopenharmony_ci	 * We need to supply (only) the names of defined parent
6258c2ecf20Sopenharmony_ci	 * clocks when registering a clock though, so we use an
6268c2ecf20Sopenharmony_ci	 * array of parent selector values to map between the
6278c2ecf20Sopenharmony_ci	 * indexes the common clock code uses and the selector
6288c2ecf20Sopenharmony_ci	 * values we need.
6298c2ecf20Sopenharmony_ci	 */
6308c2ecf20Sopenharmony_ci	parent_sel = parent_process(clocks, &parent_count, &parent_names);
6318c2ecf20Sopenharmony_ci	if (IS_ERR(parent_sel)) {
6328c2ecf20Sopenharmony_ci		int ret = PTR_ERR(parent_sel);
6338c2ecf20Sopenharmony_ci
6348c2ecf20Sopenharmony_ci		pr_err("%s: error processing parent clocks for %s (%d)\n",
6358c2ecf20Sopenharmony_ci			__func__, init_data->name, ret);
6368c2ecf20Sopenharmony_ci
6378c2ecf20Sopenharmony_ci		return ret;
6388c2ecf20Sopenharmony_ci	}
6398c2ecf20Sopenharmony_ci
6408c2ecf20Sopenharmony_ci	init_data->parent_names = parent_names;
6418c2ecf20Sopenharmony_ci	init_data->num_parents = parent_count;
6428c2ecf20Sopenharmony_ci
6438c2ecf20Sopenharmony_ci	sel->parent_count = parent_count;
6448c2ecf20Sopenharmony_ci	sel->parent_sel = parent_sel;
6458c2ecf20Sopenharmony_ci
6468c2ecf20Sopenharmony_ci	return 0;
6478c2ecf20Sopenharmony_ci}
6488c2ecf20Sopenharmony_ci
6498c2ecf20Sopenharmony_cistatic void clk_sel_teardown(struct bcm_clk_sel *sel,
6508c2ecf20Sopenharmony_ci		struct clk_init_data *init_data)
6518c2ecf20Sopenharmony_ci{
6528c2ecf20Sopenharmony_ci	kfree(sel->parent_sel);
6538c2ecf20Sopenharmony_ci	sel->parent_sel = NULL;
6548c2ecf20Sopenharmony_ci	sel->parent_count = 0;
6558c2ecf20Sopenharmony_ci
6568c2ecf20Sopenharmony_ci	init_data->num_parents = 0;
6578c2ecf20Sopenharmony_ci	kfree(init_data->parent_names);
6588c2ecf20Sopenharmony_ci	init_data->parent_names = NULL;
6598c2ecf20Sopenharmony_ci}
6608c2ecf20Sopenharmony_ci
6618c2ecf20Sopenharmony_cistatic void peri_clk_teardown(struct peri_clk_data *data,
6628c2ecf20Sopenharmony_ci				struct clk_init_data *init_data)
6638c2ecf20Sopenharmony_ci{
6648c2ecf20Sopenharmony_ci	clk_sel_teardown(&data->sel, init_data);
6658c2ecf20Sopenharmony_ci}
6668c2ecf20Sopenharmony_ci
6678c2ecf20Sopenharmony_ci/*
6688c2ecf20Sopenharmony_ci * Caller is responsible for freeing the parent_names[] and
6698c2ecf20Sopenharmony_ci * parent_sel[] arrays in the peripheral clock's "data" structure
6708c2ecf20Sopenharmony_ci * that can be assigned if the clock has one or more parent clocks
6718c2ecf20Sopenharmony_ci * associated with it.
6728c2ecf20Sopenharmony_ci */
6738c2ecf20Sopenharmony_cistatic int
6748c2ecf20Sopenharmony_ciperi_clk_setup(struct peri_clk_data *data, struct clk_init_data *init_data)
6758c2ecf20Sopenharmony_ci{
6768c2ecf20Sopenharmony_ci	init_data->flags = CLK_IGNORE_UNUSED;
6778c2ecf20Sopenharmony_ci
6788c2ecf20Sopenharmony_ci	return clk_sel_setup(data->clocks, &data->sel, init_data);
6798c2ecf20Sopenharmony_ci}
6808c2ecf20Sopenharmony_ci
6818c2ecf20Sopenharmony_cistatic void bcm_clk_teardown(struct kona_clk *bcm_clk)
6828c2ecf20Sopenharmony_ci{
6838c2ecf20Sopenharmony_ci	switch (bcm_clk->type) {
6848c2ecf20Sopenharmony_ci	case bcm_clk_peri:
6858c2ecf20Sopenharmony_ci		peri_clk_teardown(bcm_clk->u.data, &bcm_clk->init_data);
6868c2ecf20Sopenharmony_ci		break;
6878c2ecf20Sopenharmony_ci	default:
6888c2ecf20Sopenharmony_ci		break;
6898c2ecf20Sopenharmony_ci	}
6908c2ecf20Sopenharmony_ci	bcm_clk->u.data = NULL;
6918c2ecf20Sopenharmony_ci	bcm_clk->type = bcm_clk_none;
6928c2ecf20Sopenharmony_ci}
6938c2ecf20Sopenharmony_ci
6948c2ecf20Sopenharmony_cistatic void kona_clk_teardown(struct clk_hw *hw)
6958c2ecf20Sopenharmony_ci{
6968c2ecf20Sopenharmony_ci	struct kona_clk *bcm_clk;
6978c2ecf20Sopenharmony_ci
6988c2ecf20Sopenharmony_ci	if (!hw)
6998c2ecf20Sopenharmony_ci		return;
7008c2ecf20Sopenharmony_ci
7018c2ecf20Sopenharmony_ci	clk_hw_unregister(hw);
7028c2ecf20Sopenharmony_ci
7038c2ecf20Sopenharmony_ci	bcm_clk = to_kona_clk(hw);
7048c2ecf20Sopenharmony_ci	bcm_clk_teardown(bcm_clk);
7058c2ecf20Sopenharmony_ci}
7068c2ecf20Sopenharmony_ci
7078c2ecf20Sopenharmony_cistatic int kona_clk_setup(struct kona_clk *bcm_clk)
7088c2ecf20Sopenharmony_ci{
7098c2ecf20Sopenharmony_ci	int ret;
7108c2ecf20Sopenharmony_ci	struct clk_init_data *init_data = &bcm_clk->init_data;
7118c2ecf20Sopenharmony_ci
7128c2ecf20Sopenharmony_ci	switch (bcm_clk->type) {
7138c2ecf20Sopenharmony_ci	case bcm_clk_peri:
7148c2ecf20Sopenharmony_ci		ret = peri_clk_setup(bcm_clk->u.data, init_data);
7158c2ecf20Sopenharmony_ci		if (ret)
7168c2ecf20Sopenharmony_ci			return ret;
7178c2ecf20Sopenharmony_ci		break;
7188c2ecf20Sopenharmony_ci	default:
7198c2ecf20Sopenharmony_ci		pr_err("%s: clock type %d invalid for %s\n", __func__,
7208c2ecf20Sopenharmony_ci			(int)bcm_clk->type, init_data->name);
7218c2ecf20Sopenharmony_ci		return -EINVAL;
7228c2ecf20Sopenharmony_ci	}
7238c2ecf20Sopenharmony_ci
7248c2ecf20Sopenharmony_ci	/* Make sure everything makes sense before we set it up */
7258c2ecf20Sopenharmony_ci	if (!kona_clk_valid(bcm_clk)) {
7268c2ecf20Sopenharmony_ci		pr_err("%s: clock data invalid for %s\n", __func__,
7278c2ecf20Sopenharmony_ci			init_data->name);
7288c2ecf20Sopenharmony_ci		ret = -EINVAL;
7298c2ecf20Sopenharmony_ci		goto out_teardown;
7308c2ecf20Sopenharmony_ci	}
7318c2ecf20Sopenharmony_ci
7328c2ecf20Sopenharmony_ci	bcm_clk->hw.init = init_data;
7338c2ecf20Sopenharmony_ci	ret = clk_hw_register(NULL, &bcm_clk->hw);
7348c2ecf20Sopenharmony_ci	if (ret) {
7358c2ecf20Sopenharmony_ci		pr_err("%s: error registering clock %s (%d)\n", __func__,
7368c2ecf20Sopenharmony_ci			init_data->name, ret);
7378c2ecf20Sopenharmony_ci		goto out_teardown;
7388c2ecf20Sopenharmony_ci	}
7398c2ecf20Sopenharmony_ci
7408c2ecf20Sopenharmony_ci	return 0;
7418c2ecf20Sopenharmony_ciout_teardown:
7428c2ecf20Sopenharmony_ci	bcm_clk_teardown(bcm_clk);
7438c2ecf20Sopenharmony_ci
7448c2ecf20Sopenharmony_ci	return ret;
7458c2ecf20Sopenharmony_ci}
7468c2ecf20Sopenharmony_ci
7478c2ecf20Sopenharmony_cistatic void ccu_clks_teardown(struct ccu_data *ccu)
7488c2ecf20Sopenharmony_ci{
7498c2ecf20Sopenharmony_ci	u32 i;
7508c2ecf20Sopenharmony_ci
7518c2ecf20Sopenharmony_ci	for (i = 0; i < ccu->clk_num; i++)
7528c2ecf20Sopenharmony_ci		kona_clk_teardown(&ccu->kona_clks[i].hw);
7538c2ecf20Sopenharmony_ci}
7548c2ecf20Sopenharmony_ci
7558c2ecf20Sopenharmony_cistatic void kona_ccu_teardown(struct ccu_data *ccu)
7568c2ecf20Sopenharmony_ci{
7578c2ecf20Sopenharmony_ci	if (!ccu->base)
7588c2ecf20Sopenharmony_ci		return;
7598c2ecf20Sopenharmony_ci
7608c2ecf20Sopenharmony_ci	of_clk_del_provider(ccu->node);	/* safe if never added */
7618c2ecf20Sopenharmony_ci	ccu_clks_teardown(ccu);
7628c2ecf20Sopenharmony_ci	of_node_put(ccu->node);
7638c2ecf20Sopenharmony_ci	ccu->node = NULL;
7648c2ecf20Sopenharmony_ci	iounmap(ccu->base);
7658c2ecf20Sopenharmony_ci	ccu->base = NULL;
7668c2ecf20Sopenharmony_ci}
7678c2ecf20Sopenharmony_ci
7688c2ecf20Sopenharmony_cistatic bool ccu_data_valid(struct ccu_data *ccu)
7698c2ecf20Sopenharmony_ci{
7708c2ecf20Sopenharmony_ci	struct ccu_policy *ccu_policy;
7718c2ecf20Sopenharmony_ci
7728c2ecf20Sopenharmony_ci	if (!ccu_data_offsets_valid(ccu))
7738c2ecf20Sopenharmony_ci		return false;
7748c2ecf20Sopenharmony_ci
7758c2ecf20Sopenharmony_ci	ccu_policy = &ccu->policy;
7768c2ecf20Sopenharmony_ci	if (ccu_policy_exists(ccu_policy))
7778c2ecf20Sopenharmony_ci		if (!ccu_policy_valid(ccu_policy, ccu->name))
7788c2ecf20Sopenharmony_ci			return false;
7798c2ecf20Sopenharmony_ci
7808c2ecf20Sopenharmony_ci	return true;
7818c2ecf20Sopenharmony_ci}
7828c2ecf20Sopenharmony_ci
7838c2ecf20Sopenharmony_cistatic struct clk_hw *
7848c2ecf20Sopenharmony_ciof_clk_kona_onecell_get(struct of_phandle_args *clkspec, void *data)
7858c2ecf20Sopenharmony_ci{
7868c2ecf20Sopenharmony_ci	struct ccu_data *ccu = data;
7878c2ecf20Sopenharmony_ci	unsigned int idx = clkspec->args[0];
7888c2ecf20Sopenharmony_ci
7898c2ecf20Sopenharmony_ci	if (idx >= ccu->clk_num) {
7908c2ecf20Sopenharmony_ci		pr_err("%s: invalid index %u\n", __func__, idx);
7918c2ecf20Sopenharmony_ci		return ERR_PTR(-EINVAL);
7928c2ecf20Sopenharmony_ci	}
7938c2ecf20Sopenharmony_ci
7948c2ecf20Sopenharmony_ci	return &ccu->kona_clks[idx].hw;
7958c2ecf20Sopenharmony_ci}
7968c2ecf20Sopenharmony_ci
7978c2ecf20Sopenharmony_ci/*
7988c2ecf20Sopenharmony_ci * Set up a CCU.  Call the provided ccu_clks_setup callback to
7998c2ecf20Sopenharmony_ci * initialize the array of clocks provided by the CCU.
8008c2ecf20Sopenharmony_ci */
8018c2ecf20Sopenharmony_civoid __init kona_dt_ccu_setup(struct ccu_data *ccu,
8028c2ecf20Sopenharmony_ci			struct device_node *node)
8038c2ecf20Sopenharmony_ci{
8048c2ecf20Sopenharmony_ci	struct resource res = { 0 };
8058c2ecf20Sopenharmony_ci	resource_size_t range;
8068c2ecf20Sopenharmony_ci	unsigned int i;
8078c2ecf20Sopenharmony_ci	int ret;
8088c2ecf20Sopenharmony_ci
8098c2ecf20Sopenharmony_ci	ret = of_address_to_resource(node, 0, &res);
8108c2ecf20Sopenharmony_ci	if (ret) {
8118c2ecf20Sopenharmony_ci		pr_err("%s: no valid CCU registers found for %pOFn\n", __func__,
8128c2ecf20Sopenharmony_ci			node);
8138c2ecf20Sopenharmony_ci		goto out_err;
8148c2ecf20Sopenharmony_ci	}
8158c2ecf20Sopenharmony_ci
8168c2ecf20Sopenharmony_ci	range = resource_size(&res);
8178c2ecf20Sopenharmony_ci	if (range > (resource_size_t)U32_MAX) {
8188c2ecf20Sopenharmony_ci		pr_err("%s: address range too large for %pOFn\n", __func__,
8198c2ecf20Sopenharmony_ci			node);
8208c2ecf20Sopenharmony_ci		goto out_err;
8218c2ecf20Sopenharmony_ci	}
8228c2ecf20Sopenharmony_ci
8238c2ecf20Sopenharmony_ci	ccu->range = (u32)range;
8248c2ecf20Sopenharmony_ci
8258c2ecf20Sopenharmony_ci	if (!ccu_data_valid(ccu)) {
8268c2ecf20Sopenharmony_ci		pr_err("%s: ccu data not valid for %pOFn\n", __func__, node);
8278c2ecf20Sopenharmony_ci		goto out_err;
8288c2ecf20Sopenharmony_ci	}
8298c2ecf20Sopenharmony_ci
8308c2ecf20Sopenharmony_ci	ccu->base = ioremap(res.start, ccu->range);
8318c2ecf20Sopenharmony_ci	if (!ccu->base) {
8328c2ecf20Sopenharmony_ci		pr_err("%s: unable to map CCU registers for %pOFn\n", __func__,
8338c2ecf20Sopenharmony_ci			node);
8348c2ecf20Sopenharmony_ci		goto out_err;
8358c2ecf20Sopenharmony_ci	}
8368c2ecf20Sopenharmony_ci	ccu->node = of_node_get(node);
8378c2ecf20Sopenharmony_ci
8388c2ecf20Sopenharmony_ci	/*
8398c2ecf20Sopenharmony_ci	 * Set up each defined kona clock and save the result in
8408c2ecf20Sopenharmony_ci	 * the clock framework clock array (in ccu->data).  Then
8418c2ecf20Sopenharmony_ci	 * register as a provider for these clocks.
8428c2ecf20Sopenharmony_ci	 */
8438c2ecf20Sopenharmony_ci	for (i = 0; i < ccu->clk_num; i++) {
8448c2ecf20Sopenharmony_ci		if (!ccu->kona_clks[i].ccu)
8458c2ecf20Sopenharmony_ci			continue;
8468c2ecf20Sopenharmony_ci		kona_clk_setup(&ccu->kona_clks[i]);
8478c2ecf20Sopenharmony_ci	}
8488c2ecf20Sopenharmony_ci
8498c2ecf20Sopenharmony_ci	ret = of_clk_add_hw_provider(node, of_clk_kona_onecell_get, ccu);
8508c2ecf20Sopenharmony_ci	if (ret) {
8518c2ecf20Sopenharmony_ci		pr_err("%s: error adding ccu %pOFn as provider (%d)\n", __func__,
8528c2ecf20Sopenharmony_ci				node, ret);
8538c2ecf20Sopenharmony_ci		goto out_err;
8548c2ecf20Sopenharmony_ci	}
8558c2ecf20Sopenharmony_ci
8568c2ecf20Sopenharmony_ci	if (!kona_ccu_init(ccu))
8578c2ecf20Sopenharmony_ci		pr_err("Broadcom %pOFn initialization had errors\n", node);
8588c2ecf20Sopenharmony_ci
8598c2ecf20Sopenharmony_ci	return;
8608c2ecf20Sopenharmony_ciout_err:
8618c2ecf20Sopenharmony_ci	kona_ccu_teardown(ccu);
8628c2ecf20Sopenharmony_ci	pr_err("Broadcom %pOFn setup aborted\n", node);
8638c2ecf20Sopenharmony_ci}
864