xref: /openbmc/linux/drivers/clk/mediatek/clk-pllfh.c (revision b181f7029bd71238ac2754ce7052dffd69432085)
1d7964de8SJohnson Wang // SPDX-License-Identifier: GPL-2.0-only
2d7964de8SJohnson Wang /*
3d7964de8SJohnson Wang  * Copyright (c) 2022 MediaTek Inc.
4d7964de8SJohnson Wang  * Author: Edward-JW Yang <edward-jw.yang@mediatek.com>
5d7964de8SJohnson Wang  */
6d7964de8SJohnson Wang 
7d7964de8SJohnson Wang #include <linux/of.h>
8d7964de8SJohnson Wang #include <linux/of_address.h>
9d7964de8SJohnson Wang #include <linux/io.h>
10d7964de8SJohnson Wang #include <linux/slab.h>
11d7964de8SJohnson Wang #include <linux/clkdev.h>
12d7964de8SJohnson Wang #include <linux/delay.h>
13d7964de8SJohnson Wang 
14d7964de8SJohnson Wang #include "clk-mtk.h"
15d7964de8SJohnson Wang #include "clk-pllfh.h"
16d7964de8SJohnson Wang #include "clk-fhctl.h"
17d7964de8SJohnson Wang 
18d7964de8SJohnson Wang static DEFINE_SPINLOCK(pllfh_lock);
19d7964de8SJohnson Wang 
to_mtk_fh(struct clk_hw * hw)20d7964de8SJohnson Wang inline struct mtk_fh *to_mtk_fh(struct clk_hw *hw)
21d7964de8SJohnson Wang {
22d7964de8SJohnson Wang 	struct mtk_clk_pll *pll = to_mtk_clk_pll(hw);
23d7964de8SJohnson Wang 
24d7964de8SJohnson Wang 	return container_of(pll, struct mtk_fh, clk_pll);
25d7964de8SJohnson Wang }
26d7964de8SJohnson Wang 
mtk_fhctl_set_rate(struct clk_hw * hw,unsigned long rate,unsigned long parent_rate)27d7964de8SJohnson Wang static int mtk_fhctl_set_rate(struct clk_hw *hw, unsigned long rate,
28d7964de8SJohnson Wang 			      unsigned long parent_rate)
29d7964de8SJohnson Wang {
30d7964de8SJohnson Wang 	struct mtk_clk_pll *pll = to_mtk_clk_pll(hw);
31d7964de8SJohnson Wang 	struct mtk_fh *fh = to_mtk_fh(hw);
32d7964de8SJohnson Wang 	u32 pcw = 0;
33d7964de8SJohnson Wang 	u32 postdiv;
34d7964de8SJohnson Wang 
35d7964de8SJohnson Wang 	mtk_pll_calc_values(pll, &pcw, &postdiv, rate, parent_rate);
36d7964de8SJohnson Wang 
37d7964de8SJohnson Wang 	return fh->ops->hopping(fh, pcw, postdiv);
38d7964de8SJohnson Wang }
39d7964de8SJohnson Wang 
40d7964de8SJohnson Wang static const struct clk_ops mtk_pllfh_ops = {
41d7964de8SJohnson Wang 	.is_prepared	= mtk_pll_is_prepared,
42d7964de8SJohnson Wang 	.prepare	= mtk_pll_prepare,
43d7964de8SJohnson Wang 	.unprepare	= mtk_pll_unprepare,
44d7964de8SJohnson Wang 	.recalc_rate	= mtk_pll_recalc_rate,
45d7964de8SJohnson Wang 	.round_rate	= mtk_pll_round_rate,
46d7964de8SJohnson Wang 	.set_rate	= mtk_fhctl_set_rate,
47d7964de8SJohnson Wang };
48d7964de8SJohnson Wang 
get_pllfh_by_id(struct mtk_pllfh_data * pllfhs,int num_fhs,int pll_id)49d7964de8SJohnson Wang static struct mtk_pllfh_data *get_pllfh_by_id(struct mtk_pllfh_data *pllfhs,
50d7964de8SJohnson Wang 					      int num_fhs, int pll_id)
51d7964de8SJohnson Wang {
52d7964de8SJohnson Wang 	int i;
53d7964de8SJohnson Wang 
54d7964de8SJohnson Wang 	for (i = 0; i < num_fhs; i++)
55d7964de8SJohnson Wang 		if (pllfhs[i].data.pll_id == pll_id)
56d7964de8SJohnson Wang 			return &pllfhs[i];
57d7964de8SJohnson Wang 
58d7964de8SJohnson Wang 	return NULL;
59d7964de8SJohnson Wang }
60d7964de8SJohnson Wang 
fhctl_parse_dt(const u8 * compatible_node,struct mtk_pllfh_data * pllfhs,int num_fhs)61d7964de8SJohnson Wang void fhctl_parse_dt(const u8 *compatible_node, struct mtk_pllfh_data *pllfhs,
62d7964de8SJohnson Wang 		    int num_fhs)
63d7964de8SJohnson Wang {
64d7964de8SJohnson Wang 	void __iomem *base;
65d7964de8SJohnson Wang 	struct device_node *node;
66d7964de8SJohnson Wang 	u32 num_clocks, pll_id, ssc_rate;
67d7964de8SJohnson Wang 	int offset, i;
68d7964de8SJohnson Wang 
69d7964de8SJohnson Wang 	node = of_find_compatible_node(NULL, NULL, compatible_node);
70d7964de8SJohnson Wang 	if (!node) {
71*888b03fcSNícolas F. R. A. Prado 		pr_warn("cannot find \"%s\"\n", compatible_node);
72d7964de8SJohnson Wang 		return;
73d7964de8SJohnson Wang 	}
74d7964de8SJohnson Wang 
75d7964de8SJohnson Wang 	base = of_iomap(node, 0);
76d7964de8SJohnson Wang 	if (!base) {
77d7964de8SJohnson Wang 		pr_err("%s(): ioremap failed\n", __func__);
78f1d97a37SYang Yingliang 		goto out_node_put;
79d7964de8SJohnson Wang 	}
80d7964de8SJohnson Wang 
81d7964de8SJohnson Wang 	num_clocks = of_clk_get_parent_count(node);
82d7964de8SJohnson Wang 	if (!num_clocks) {
83d7964de8SJohnson Wang 		pr_err("%s(): failed to get clocks property\n", __func__);
84f1d97a37SYang Yingliang 		goto err;
85d7964de8SJohnson Wang 	}
86d7964de8SJohnson Wang 
87d7964de8SJohnson Wang 	for (i = 0; i < num_clocks; i++) {
88d7964de8SJohnson Wang 		struct mtk_pllfh_data *pllfh;
89d7964de8SJohnson Wang 
90d7964de8SJohnson Wang 		offset = i * 2;
91d7964de8SJohnson Wang 
92d7964de8SJohnson Wang 		of_property_read_u32_index(node, "clocks", offset + 1, &pll_id);
93d7964de8SJohnson Wang 		of_property_read_u32_index(node,
94d7964de8SJohnson Wang 					   "mediatek,hopping-ssc-percent",
95d7964de8SJohnson Wang 					   i, &ssc_rate);
96d7964de8SJohnson Wang 
97d7964de8SJohnson Wang 		pllfh = get_pllfh_by_id(pllfhs, num_fhs, pll_id);
98d7964de8SJohnson Wang 		if (!pllfh)
99d7964de8SJohnson Wang 			continue;
100d7964de8SJohnson Wang 
101d7964de8SJohnson Wang 		pllfh->state.fh_enable = 1;
102d7964de8SJohnson Wang 		pllfh->state.ssc_rate = ssc_rate;
103d7964de8SJohnson Wang 		pllfh->state.base = base;
104d7964de8SJohnson Wang 	}
105f1d97a37SYang Yingliang 
106f1d97a37SYang Yingliang out_node_put:
107f1d97a37SYang Yingliang 	of_node_put(node);
108f1d97a37SYang Yingliang 	return;
109f1d97a37SYang Yingliang err:
110f1d97a37SYang Yingliang 	iounmap(base);
111f1d97a37SYang Yingliang 	goto out_node_put;
112d7964de8SJohnson Wang }
11336dff04cSAngeloGioacchino Del Regno EXPORT_SYMBOL_GPL(fhctl_parse_dt);
114d7964de8SJohnson Wang 
pllfh_init(struct mtk_fh * fh,struct mtk_pllfh_data * pllfh_data)1158da312d6SAngeloGioacchino Del Regno static int pllfh_init(struct mtk_fh *fh, struct mtk_pllfh_data *pllfh_data)
116d7964de8SJohnson Wang {
117d7964de8SJohnson Wang 	struct fh_pll_regs *regs = &fh->regs;
118d7964de8SJohnson Wang 	const struct fhctl_offset *offset;
119d7964de8SJohnson Wang 	void __iomem *base = pllfh_data->state.base;
120d7964de8SJohnson Wang 	void __iomem *fhx_base = base + pllfh_data->data.fhx_offset;
121d7964de8SJohnson Wang 
1228da312d6SAngeloGioacchino Del Regno 	offset = fhctl_get_offset_table(pllfh_data->data.fh_ver);
1238da312d6SAngeloGioacchino Del Regno 	if (IS_ERR(offset))
1248da312d6SAngeloGioacchino Del Regno 		return PTR_ERR(offset);
125d7964de8SJohnson Wang 
126d7964de8SJohnson Wang 	regs->reg_hp_en = base + offset->offset_hp_en;
127d7964de8SJohnson Wang 	regs->reg_clk_con = base + offset->offset_clk_con;
128d7964de8SJohnson Wang 	regs->reg_rst_con = base + offset->offset_rst_con;
129d7964de8SJohnson Wang 	regs->reg_slope0 = base + offset->offset_slope0;
130d7964de8SJohnson Wang 	regs->reg_slope1 = base + offset->offset_slope1;
131d7964de8SJohnson Wang 
132d7964de8SJohnson Wang 	regs->reg_cfg = fhx_base + offset->offset_cfg;
133d7964de8SJohnson Wang 	regs->reg_updnlmt = fhx_base + offset->offset_updnlmt;
134d7964de8SJohnson Wang 	regs->reg_dds = fhx_base + offset->offset_dds;
135d7964de8SJohnson Wang 	regs->reg_dvfs = fhx_base + offset->offset_dvfs;
136d7964de8SJohnson Wang 	regs->reg_mon = fhx_base + offset->offset_mon;
137d7964de8SJohnson Wang 
138d7964de8SJohnson Wang 	fh->pllfh_data = pllfh_data;
139d7964de8SJohnson Wang 	fh->lock = &pllfh_lock;
140d7964de8SJohnson Wang 
141d7964de8SJohnson Wang 	fh->ops = fhctl_get_ops();
1428da312d6SAngeloGioacchino Del Regno 
1438da312d6SAngeloGioacchino Del Regno 	return 0;
144d7964de8SJohnson Wang }
145d7964de8SJohnson Wang 
fhctl_is_supported_and_enabled(const struct mtk_pllfh_data * pllfh)146d7964de8SJohnson Wang static bool fhctl_is_supported_and_enabled(const struct mtk_pllfh_data *pllfh)
147d7964de8SJohnson Wang {
148d7964de8SJohnson Wang 	return pllfh && (pllfh->state.fh_enable == 1);
149d7964de8SJohnson Wang }
150d7964de8SJohnson Wang 
151d7964de8SJohnson Wang static struct clk_hw *
mtk_clk_register_pllfh(const struct mtk_pll_data * pll_data,struct mtk_pllfh_data * pllfh_data,void __iomem * base)152d7964de8SJohnson Wang mtk_clk_register_pllfh(const struct mtk_pll_data *pll_data,
153d7964de8SJohnson Wang 		       struct mtk_pllfh_data *pllfh_data, void __iomem *base)
154d7964de8SJohnson Wang {
155d7964de8SJohnson Wang 	struct clk_hw *hw;
156d7964de8SJohnson Wang 	struct mtk_fh *fh;
1578da312d6SAngeloGioacchino Del Regno 	int ret;
158d7964de8SJohnson Wang 
159d7964de8SJohnson Wang 	fh = kzalloc(sizeof(*fh), GFP_KERNEL);
160d7964de8SJohnson Wang 	if (!fh)
161d7964de8SJohnson Wang 		return ERR_PTR(-ENOMEM);
162d7964de8SJohnson Wang 
1638da312d6SAngeloGioacchino Del Regno 	ret = pllfh_init(fh, pllfh_data);
1648da312d6SAngeloGioacchino Del Regno 	if (ret) {
1658da312d6SAngeloGioacchino Del Regno 		hw = ERR_PTR(ret);
1668da312d6SAngeloGioacchino Del Regno 		goto out;
1678da312d6SAngeloGioacchino Del Regno 	}
168d7964de8SJohnson Wang 
169d7964de8SJohnson Wang 	hw = mtk_clk_register_pll_ops(&fh->clk_pll, pll_data, base,
170d7964de8SJohnson Wang 				      &mtk_pllfh_ops);
171d7964de8SJohnson Wang 
172d7964de8SJohnson Wang 	if (IS_ERR(hw))
1738da312d6SAngeloGioacchino Del Regno 		goto out;
1748da312d6SAngeloGioacchino Del Regno 
175d7964de8SJohnson Wang 	fhctl_hw_init(fh);
176d7964de8SJohnson Wang 
1778da312d6SAngeloGioacchino Del Regno out:
1788da312d6SAngeloGioacchino Del Regno 	if (IS_ERR(hw))
1798da312d6SAngeloGioacchino Del Regno 		kfree(fh);
1808da312d6SAngeloGioacchino Del Regno 
181d7964de8SJohnson Wang 	return hw;
182d7964de8SJohnson Wang }
183d7964de8SJohnson Wang 
mtk_clk_unregister_pllfh(struct clk_hw * hw)184d7964de8SJohnson Wang static void mtk_clk_unregister_pllfh(struct clk_hw *hw)
185d7964de8SJohnson Wang {
186d7964de8SJohnson Wang 	struct mtk_fh *fh;
187d7964de8SJohnson Wang 
188d7964de8SJohnson Wang 	if (!hw)
189d7964de8SJohnson Wang 		return;
190d7964de8SJohnson Wang 
191d7964de8SJohnson Wang 	fh = to_mtk_fh(hw);
192d7964de8SJohnson Wang 
193d7964de8SJohnson Wang 	clk_hw_unregister(hw);
194d7964de8SJohnson Wang 	kfree(fh);
195d7964de8SJohnson Wang }
196d7964de8SJohnson Wang 
mtk_clk_register_pllfhs(struct device_node * node,const struct mtk_pll_data * plls,int num_plls,struct mtk_pllfh_data * pllfhs,int num_fhs,struct clk_hw_onecell_data * clk_data)197d7964de8SJohnson Wang int mtk_clk_register_pllfhs(struct device_node *node,
198d7964de8SJohnson Wang 			    const struct mtk_pll_data *plls, int num_plls,
199d7964de8SJohnson Wang 			    struct mtk_pllfh_data *pllfhs, int num_fhs,
200d7964de8SJohnson Wang 			    struct clk_hw_onecell_data *clk_data)
201d7964de8SJohnson Wang {
202d7964de8SJohnson Wang 	void __iomem *base;
203d7964de8SJohnson Wang 	int i;
204d7964de8SJohnson Wang 	struct clk_hw *hw;
205d7964de8SJohnson Wang 
206d7964de8SJohnson Wang 	base = of_iomap(node, 0);
207d7964de8SJohnson Wang 	if (!base) {
208d7964de8SJohnson Wang 		pr_err("%s(): ioremap failed\n", __func__);
209d7964de8SJohnson Wang 		return -EINVAL;
210d7964de8SJohnson Wang 	}
211d7964de8SJohnson Wang 
212d7964de8SJohnson Wang 	for (i = 0; i < num_plls; i++) {
213d7964de8SJohnson Wang 		const struct mtk_pll_data *pll = &plls[i];
214d7964de8SJohnson Wang 		struct mtk_pllfh_data *pllfh;
215d7964de8SJohnson Wang 		bool use_fhctl;
216d7964de8SJohnson Wang 
217d7964de8SJohnson Wang 		pllfh = get_pllfh_by_id(pllfhs, num_fhs, pll->id);
218d7964de8SJohnson Wang 		use_fhctl = fhctl_is_supported_and_enabled(pllfh);
219d7964de8SJohnson Wang 
220d7964de8SJohnson Wang 		if (use_fhctl)
221d7964de8SJohnson Wang 			hw = mtk_clk_register_pllfh(pll, pllfh, base);
222d7964de8SJohnson Wang 		else
223d7964de8SJohnson Wang 			hw = mtk_clk_register_pll(pll, base);
224d7964de8SJohnson Wang 
225d7964de8SJohnson Wang 		if (IS_ERR(hw)) {
226d7964de8SJohnson Wang 			pr_err("Failed to register %s clk %s: %ld\n",
227d7964de8SJohnson Wang 			       use_fhctl ? "fhpll" : "pll", pll->name,
228d7964de8SJohnson Wang 			       PTR_ERR(hw));
229d7964de8SJohnson Wang 			goto err;
230d7964de8SJohnson Wang 		}
231d7964de8SJohnson Wang 
232d7964de8SJohnson Wang 		clk_data->hws[pll->id] = hw;
233d7964de8SJohnson Wang 	}
234d7964de8SJohnson Wang 
235d7964de8SJohnson Wang 	return 0;
236d7964de8SJohnson Wang 
237d7964de8SJohnson Wang err:
238d7964de8SJohnson Wang 	while (--i >= 0) {
239d7964de8SJohnson Wang 		const struct mtk_pll_data *pll = &plls[i];
240d7964de8SJohnson Wang 		struct mtk_pllfh_data *pllfh;
241d7964de8SJohnson Wang 		bool use_fhctl;
242d7964de8SJohnson Wang 
243d7964de8SJohnson Wang 		pllfh = get_pllfh_by_id(pllfhs, num_fhs, pll->id);
244d7964de8SJohnson Wang 		use_fhctl = fhctl_is_supported_and_enabled(pllfh);
245d7964de8SJohnson Wang 
246d7964de8SJohnson Wang 		if (use_fhctl)
247d7964de8SJohnson Wang 			mtk_clk_unregister_pllfh(clk_data->hws[pll->id]);
248d7964de8SJohnson Wang 		else
249d7964de8SJohnson Wang 			mtk_clk_unregister_pll(clk_data->hws[pll->id]);
250d7964de8SJohnson Wang 
251d7964de8SJohnson Wang 		clk_data->hws[pll->id] = ERR_PTR(-ENOENT);
252d7964de8SJohnson Wang 	}
253d7964de8SJohnson Wang 
254d7964de8SJohnson Wang 	iounmap(base);
255d7964de8SJohnson Wang 
256d7964de8SJohnson Wang 	return PTR_ERR(hw);
257d7964de8SJohnson Wang }
25836dff04cSAngeloGioacchino Del Regno EXPORT_SYMBOL_GPL(mtk_clk_register_pllfhs);
259d7964de8SJohnson Wang 
mtk_clk_unregister_pllfhs(const struct mtk_pll_data * plls,int num_plls,struct mtk_pllfh_data * pllfhs,int num_fhs,struct clk_hw_onecell_data * clk_data)260d7964de8SJohnson Wang void mtk_clk_unregister_pllfhs(const struct mtk_pll_data *plls, int num_plls,
261d7964de8SJohnson Wang 			       struct mtk_pllfh_data *pllfhs, int num_fhs,
262d7964de8SJohnson Wang 			       struct clk_hw_onecell_data *clk_data)
263d7964de8SJohnson Wang {
264d7964de8SJohnson Wang 	void __iomem *base = NULL, *fhctl_base = NULL;
265d7964de8SJohnson Wang 	int i;
266d7964de8SJohnson Wang 
267d7964de8SJohnson Wang 	if (!clk_data)
268d7964de8SJohnson Wang 		return;
269d7964de8SJohnson Wang 
270d7964de8SJohnson Wang 	for (i = num_plls; i > 0; i--) {
271d7964de8SJohnson Wang 		const struct mtk_pll_data *pll = &plls[i - 1];
272d7964de8SJohnson Wang 		struct mtk_pllfh_data *pllfh;
273d7964de8SJohnson Wang 		bool use_fhctl;
274d7964de8SJohnson Wang 
275d7964de8SJohnson Wang 		if (IS_ERR_OR_NULL(clk_data->hws[pll->id]))
276d7964de8SJohnson Wang 			continue;
277d7964de8SJohnson Wang 
278d7964de8SJohnson Wang 		pllfh = get_pllfh_by_id(pllfhs, num_fhs, pll->id);
279d7964de8SJohnson Wang 		use_fhctl = fhctl_is_supported_and_enabled(pllfh);
280d7964de8SJohnson Wang 
281d7964de8SJohnson Wang 		if (use_fhctl) {
282d7964de8SJohnson Wang 			fhctl_base = pllfh->state.base;
283d7964de8SJohnson Wang 			mtk_clk_unregister_pllfh(clk_data->hws[pll->id]);
284d7964de8SJohnson Wang 		} else {
285d7964de8SJohnson Wang 			base = mtk_clk_pll_get_base(clk_data->hws[pll->id],
286d7964de8SJohnson Wang 						    pll);
287d7964de8SJohnson Wang 			mtk_clk_unregister_pll(clk_data->hws[pll->id]);
288d7964de8SJohnson Wang 		}
289d7964de8SJohnson Wang 
290d7964de8SJohnson Wang 		clk_data->hws[pll->id] = ERR_PTR(-ENOENT);
291d7964de8SJohnson Wang 	}
292d7964de8SJohnson Wang 
293d7964de8SJohnson Wang 	if (fhctl_base)
294d7964de8SJohnson Wang 		iounmap(fhctl_base);
295d7964de8SJohnson Wang 
296d7964de8SJohnson Wang 	iounmap(base);
297d7964de8SJohnson Wang }
29836dff04cSAngeloGioacchino Del Regno EXPORT_SYMBOL_GPL(mtk_clk_unregister_pllfhs);
299