1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Ingenic SoC CGU driver
5 * Copyright (c) 2013-2015 Imagination Technologies
6 * Author: Paul Burton <paul.burton@mips.com>
9 #include <linux/bitops.h>
10 #include <linux/clk.h>
11 #include <linux/clk-provider.h>
12 #include <linux/clkdev.h>
13 #include <linux/delay.h>
15 #include <linux/math64.h>
17 #include <linux/of_address.h>
18 #include <linux/slab.h>
19 #include <linux/spinlock.h>
22 #define MHZ (1000 * 1000)
25 * ingenic_cgu_gate_get() - get the value of clock gate register bit
26 * @cgu: reference to the CGU whose registers should be read
27 * @info: info struct describing the gate bit
29 * Retrieves the state of the clock gate bit described by info. The
30 * caller must hold cgu->lock.
32 * Return: true if the gate bit is set, else false.
35 ingenic_cgu_gate_get(struct ingenic_cgu *cgu,
36 const struct ingenic_cgu_gate_info *info)
38 return !!(readl(cgu->base + info->reg) & BIT(info->bit))
39 ^ info->clear_to_gate;
43 * ingenic_cgu_gate_set() - set the value of clock gate register bit
44 * @cgu: reference to the CGU whose registers should be modified
45 * @info: info struct describing the gate bit
46 * @val: non-zero to gate a clock, otherwise zero
48 * Sets the given gate bit in order to gate or ungate a clock.
50 * The caller must hold cgu->lock.
53 ingenic_cgu_gate_set(struct ingenic_cgu *cgu,
54 const struct ingenic_cgu_gate_info *info, bool val)
56 u32 clkgr = readl(cgu->base + info->reg);
58 if (val ^ info->clear_to_gate)
59 clkgr |= BIT(info->bit);
61 clkgr &= ~BIT(info->bit);
63 writel(clkgr, cgu->base + info->reg);
71 ingenic_pll_recalc_rate(struct clk_hw *hw, unsigned long parent_rate)
73 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
74 struct ingenic_cgu *cgu = ingenic_clk->cgu;
75 const struct ingenic_cgu_clk_info *clk_info;
76 const struct ingenic_cgu_pll_info *pll_info;
77 unsigned m, n, od_enc, od;
81 clk_info = &cgu->clock_info[ingenic_clk->idx];
82 BUG_ON(clk_info->type != CGU_CLK_PLL);
83 pll_info = &clk_info->pll;
85 ctl = readl(cgu->base + pll_info->reg);
87 m = (ctl >> pll_info->m_shift) & GENMASK(pll_info->m_bits - 1, 0);
88 m += pll_info->m_offset;
89 n = (ctl >> pll_info->n_shift) & GENMASK(pll_info->n_bits - 1, 0);
90 n += pll_info->n_offset;
91 od_enc = ctl >> pll_info->od_shift;
92 od_enc &= GENMASK(pll_info->od_bits - 1, 0);
94 ctl = readl(cgu->base + pll_info->bypass_reg);
96 bypass = !pll_info->no_bypass_bit &&
97 !!(ctl & BIT(pll_info->bypass_bit));
102 for (od = 0; od < pll_info->od_max; od++) {
103 if (pll_info->od_encoding[od] == od_enc)
106 BUG_ON(od == pll_info->od_max);
109 return div_u64((u64)parent_rate * m * pll_info->rate_multiplier,
114 ingenic_pll_calc(const struct ingenic_cgu_clk_info *clk_info,
115 unsigned long rate, unsigned long parent_rate,
116 unsigned *pm, unsigned *pn, unsigned *pod)
118 const struct ingenic_cgu_pll_info *pll_info;
121 pll_info = &clk_info->pll;
125 * The frequency after the input divider must be between 10 and 50 MHz.
126 * The highest divider yields the best resolution.
128 n = parent_rate / (10 * MHZ);
129 n = min_t(unsigned, n, 1 << clk_info->pll.n_bits);
130 n = max_t(unsigned, n, pll_info->n_offset);
132 m = (rate / MHZ) * od * n / (parent_rate / MHZ);
133 m = min_t(unsigned, m, 1 << clk_info->pll.m_bits);
134 m = max_t(unsigned, m, pll_info->m_offset);
143 return div_u64((u64)parent_rate * m * pll_info->rate_multiplier,
147 static inline const struct ingenic_cgu_clk_info *to_clk_info(
148 struct ingenic_clk *ingenic_clk)
150 struct ingenic_cgu *cgu = ingenic_clk->cgu;
151 const struct ingenic_cgu_clk_info *clk_info;
153 clk_info = &cgu->clock_info[ingenic_clk->idx];
154 BUG_ON(clk_info->type != CGU_CLK_PLL);
160 ingenic_pll_round_rate(struct clk_hw *hw, unsigned long req_rate,
161 unsigned long *prate)
163 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
164 const struct ingenic_cgu_clk_info *clk_info = to_clk_info(ingenic_clk);
166 return ingenic_pll_calc(clk_info, req_rate, *prate, NULL, NULL, NULL);
170 ingenic_pll_set_rate(struct clk_hw *hw, unsigned long req_rate,
171 unsigned long parent_rate)
173 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
174 struct ingenic_cgu *cgu = ingenic_clk->cgu;
175 const struct ingenic_cgu_clk_info *clk_info = to_clk_info(ingenic_clk);
176 const struct ingenic_cgu_pll_info *pll_info = &clk_info->pll;
177 unsigned long rate, flags;
178 unsigned int m, n, od;
181 rate = ingenic_pll_calc(clk_info, req_rate, parent_rate,
183 if (rate != req_rate)
184 pr_info("ingenic-cgu: request '%s' rate %luHz, actual %luHz\n",
185 clk_info->name, req_rate, rate);
187 spin_lock_irqsave(&cgu->lock, flags);
188 ctl = readl(cgu->base + pll_info->reg);
190 ctl &= ~(GENMASK(pll_info->m_bits - 1, 0) << pll_info->m_shift);
191 ctl |= (m - pll_info->m_offset) << pll_info->m_shift;
193 ctl &= ~(GENMASK(pll_info->n_bits - 1, 0) << pll_info->n_shift);
194 ctl |= (n - pll_info->n_offset) << pll_info->n_shift;
196 ctl &= ~(GENMASK(pll_info->od_bits - 1, 0) << pll_info->od_shift);
197 ctl |= pll_info->od_encoding[od - 1] << pll_info->od_shift;
199 writel(ctl, cgu->base + pll_info->reg);
200 spin_unlock_irqrestore(&cgu->lock, flags);
205 static int ingenic_pll_enable(struct clk_hw *hw)
207 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
208 struct ingenic_cgu *cgu = ingenic_clk->cgu;
209 const struct ingenic_cgu_clk_info *clk_info = to_clk_info(ingenic_clk);
210 const struct ingenic_cgu_pll_info *pll_info = &clk_info->pll;
211 const unsigned int timeout = 100;
216 spin_lock_irqsave(&cgu->lock, flags);
217 ctl = readl(cgu->base + pll_info->bypass_reg);
219 ctl &= ~BIT(pll_info->bypass_bit);
221 writel(ctl, cgu->base + pll_info->bypass_reg);
223 ctl = readl(cgu->base + pll_info->reg);
225 ctl |= BIT(pll_info->enable_bit);
227 writel(ctl, cgu->base + pll_info->reg);
229 /* wait for the PLL to stabilise */
230 for (i = 0; i < timeout; i++) {
231 ctl = readl(cgu->base + pll_info->reg);
232 if (ctl & BIT(pll_info->stable_bit))
237 spin_unlock_irqrestore(&cgu->lock, flags);
245 static void ingenic_pll_disable(struct clk_hw *hw)
247 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
248 struct ingenic_cgu *cgu = ingenic_clk->cgu;
249 const struct ingenic_cgu_clk_info *clk_info = to_clk_info(ingenic_clk);
250 const struct ingenic_cgu_pll_info *pll_info = &clk_info->pll;
254 spin_lock_irqsave(&cgu->lock, flags);
255 ctl = readl(cgu->base + pll_info->reg);
257 ctl &= ~BIT(pll_info->enable_bit);
259 writel(ctl, cgu->base + pll_info->reg);
260 spin_unlock_irqrestore(&cgu->lock, flags);
263 static int ingenic_pll_is_enabled(struct clk_hw *hw)
265 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
266 struct ingenic_cgu *cgu = ingenic_clk->cgu;
267 const struct ingenic_cgu_clk_info *clk_info = to_clk_info(ingenic_clk);
268 const struct ingenic_cgu_pll_info *pll_info = &clk_info->pll;
271 ctl = readl(cgu->base + pll_info->reg);
273 return !!(ctl & BIT(pll_info->enable_bit));
276 static const struct clk_ops ingenic_pll_ops = {
277 .recalc_rate = ingenic_pll_recalc_rate,
278 .round_rate = ingenic_pll_round_rate,
279 .set_rate = ingenic_pll_set_rate,
281 .enable = ingenic_pll_enable,
282 .disable = ingenic_pll_disable,
283 .is_enabled = ingenic_pll_is_enabled,
287 * Operations for all non-PLL clocks
290 static u8 ingenic_clk_get_parent(struct clk_hw *hw)
292 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
293 struct ingenic_cgu *cgu = ingenic_clk->cgu;
294 const struct ingenic_cgu_clk_info *clk_info;
296 u8 i, hw_idx, idx = 0;
298 clk_info = &cgu->clock_info[ingenic_clk->idx];
300 if (clk_info->type & CGU_CLK_MUX) {
301 reg = readl(cgu->base + clk_info->mux.reg);
302 hw_idx = (reg >> clk_info->mux.shift) &
303 GENMASK(clk_info->mux.bits - 1, 0);
306 * Convert the hardware index to the parent index by skipping
307 * over any -1's in the parents array.
309 for (i = 0; i < hw_idx; i++) {
310 if (clk_info->parents[i] != -1)
318 static int ingenic_clk_set_parent(struct clk_hw *hw, u8 idx)
320 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
321 struct ingenic_cgu *cgu = ingenic_clk->cgu;
322 const struct ingenic_cgu_clk_info *clk_info;
324 u8 curr_idx, hw_idx, num_poss;
327 clk_info = &cgu->clock_info[ingenic_clk->idx];
329 if (clk_info->type & CGU_CLK_MUX) {
331 * Convert the parent index to the hardware index by adding
332 * 1 for any -1 in the parents array preceding the given
333 * index. That is, we want the index of idx'th entry in
334 * clk_info->parents which does not equal -1.
336 hw_idx = curr_idx = 0;
337 num_poss = 1 << clk_info->mux.bits;
338 for (; hw_idx < num_poss; hw_idx++) {
339 if (clk_info->parents[hw_idx] == -1)
346 /* idx should always be a valid parent */
347 BUG_ON(curr_idx != idx);
349 mask = GENMASK(clk_info->mux.bits - 1, 0);
350 mask <<= clk_info->mux.shift;
352 spin_lock_irqsave(&cgu->lock, flags);
354 /* write the register */
355 reg = readl(cgu->base + clk_info->mux.reg);
357 reg |= hw_idx << clk_info->mux.shift;
358 writel(reg, cgu->base + clk_info->mux.reg);
360 spin_unlock_irqrestore(&cgu->lock, flags);
364 return idx ? -EINVAL : 0;
368 ingenic_clk_recalc_rate(struct clk_hw *hw, unsigned long parent_rate)
370 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
371 struct ingenic_cgu *cgu = ingenic_clk->cgu;
372 const struct ingenic_cgu_clk_info *clk_info;
373 unsigned long rate = parent_rate;
376 clk_info = &cgu->clock_info[ingenic_clk->idx];
378 if (clk_info->type & CGU_CLK_DIV) {
379 div_reg = readl(cgu->base + clk_info->div.reg);
380 div = (div_reg >> clk_info->div.shift) &
381 GENMASK(clk_info->div.bits - 1, 0);
383 if (clk_info->div.div_table)
384 div = clk_info->div.div_table[div];
386 div = (div + 1) * clk_info->div.div;
389 } else if (clk_info->type & CGU_CLK_FIXDIV) {
390 rate /= clk_info->fixdiv.div;
397 ingenic_clk_calc_hw_div(const struct ingenic_cgu_clk_info *clk_info,
402 for (i = 0; i < (1 << clk_info->div.bits)
403 && clk_info->div.div_table[i]; i++) {
404 if (clk_info->div.div_table[i] >= div)
412 ingenic_clk_calc_div(const struct ingenic_cgu_clk_info *clk_info,
413 unsigned long parent_rate, unsigned long req_rate)
415 unsigned int div, hw_div;
417 /* calculate the divide */
418 div = DIV_ROUND_UP(parent_rate, req_rate);
420 if (clk_info->div.div_table) {
421 hw_div = ingenic_clk_calc_hw_div(clk_info, div);
423 return clk_info->div.div_table[hw_div];
426 /* Impose hardware constraints */
427 div = min_t(unsigned, div, 1 << clk_info->div.bits);
428 div = max_t(unsigned, div, 1);
431 * If the divider value itself must be divided before being written to
432 * the divider register, we must ensure we don't have any bits set that
433 * would be lost as a result of doing so.
435 div /= clk_info->div.div;
436 div *= clk_info->div.div;
442 ingenic_clk_round_rate(struct clk_hw *hw, unsigned long req_rate,
443 unsigned long *parent_rate)
445 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
446 struct ingenic_cgu *cgu = ingenic_clk->cgu;
447 const struct ingenic_cgu_clk_info *clk_info;
448 unsigned int div = 1;
450 clk_info = &cgu->clock_info[ingenic_clk->idx];
452 if (clk_info->type & CGU_CLK_DIV)
453 div = ingenic_clk_calc_div(clk_info, *parent_rate, req_rate);
454 else if (clk_info->type & CGU_CLK_FIXDIV)
455 div = clk_info->fixdiv.div;
457 return DIV_ROUND_UP(*parent_rate, div);
461 ingenic_clk_set_rate(struct clk_hw *hw, unsigned long req_rate,
462 unsigned long parent_rate)
464 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
465 struct ingenic_cgu *cgu = ingenic_clk->cgu;
466 const struct ingenic_cgu_clk_info *clk_info;
467 const unsigned timeout = 100;
468 unsigned long rate, flags;
469 unsigned int hw_div, div, i;
473 clk_info = &cgu->clock_info[ingenic_clk->idx];
475 if (clk_info->type & CGU_CLK_DIV) {
476 div = ingenic_clk_calc_div(clk_info, parent_rate, req_rate);
477 rate = DIV_ROUND_UP(parent_rate, div);
479 if (rate != req_rate)
482 if (clk_info->div.div_table)
483 hw_div = ingenic_clk_calc_hw_div(clk_info, div);
485 hw_div = ((div / clk_info->div.div) - 1);
487 spin_lock_irqsave(&cgu->lock, flags);
488 reg = readl(cgu->base + clk_info->div.reg);
490 /* update the divide */
491 mask = GENMASK(clk_info->div.bits - 1, 0);
492 reg &= ~(mask << clk_info->div.shift);
493 reg |= hw_div << clk_info->div.shift;
495 /* clear the stop bit */
496 if (clk_info->div.stop_bit != -1)
497 reg &= ~BIT(clk_info->div.stop_bit);
499 /* set the change enable bit */
500 if (clk_info->div.ce_bit != -1)
501 reg |= BIT(clk_info->div.ce_bit);
503 /* update the hardware */
504 writel(reg, cgu->base + clk_info->div.reg);
506 /* wait for the change to take effect */
507 if (clk_info->div.busy_bit != -1) {
508 for (i = 0; i < timeout; i++) {
509 reg = readl(cgu->base + clk_info->div.reg);
510 if (!(reg & BIT(clk_info->div.busy_bit)))
518 spin_unlock_irqrestore(&cgu->lock, flags);
525 static int ingenic_clk_enable(struct clk_hw *hw)
527 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
528 struct ingenic_cgu *cgu = ingenic_clk->cgu;
529 const struct ingenic_cgu_clk_info *clk_info;
532 clk_info = &cgu->clock_info[ingenic_clk->idx];
534 if (clk_info->type & CGU_CLK_GATE) {
535 /* ungate the clock */
536 spin_lock_irqsave(&cgu->lock, flags);
537 ingenic_cgu_gate_set(cgu, &clk_info->gate, false);
538 spin_unlock_irqrestore(&cgu->lock, flags);
540 if (clk_info->gate.delay_us)
541 udelay(clk_info->gate.delay_us);
547 static void ingenic_clk_disable(struct clk_hw *hw)
549 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
550 struct ingenic_cgu *cgu = ingenic_clk->cgu;
551 const struct ingenic_cgu_clk_info *clk_info;
554 clk_info = &cgu->clock_info[ingenic_clk->idx];
556 if (clk_info->type & CGU_CLK_GATE) {
558 spin_lock_irqsave(&cgu->lock, flags);
559 ingenic_cgu_gate_set(cgu, &clk_info->gate, true);
560 spin_unlock_irqrestore(&cgu->lock, flags);
564 static int ingenic_clk_is_enabled(struct clk_hw *hw)
566 struct ingenic_clk *ingenic_clk = to_ingenic_clk(hw);
567 struct ingenic_cgu *cgu = ingenic_clk->cgu;
568 const struct ingenic_cgu_clk_info *clk_info;
571 clk_info = &cgu->clock_info[ingenic_clk->idx];
573 if (clk_info->type & CGU_CLK_GATE)
574 enabled = !ingenic_cgu_gate_get(cgu, &clk_info->gate);
579 static const struct clk_ops ingenic_clk_ops = {
580 .get_parent = ingenic_clk_get_parent,
581 .set_parent = ingenic_clk_set_parent,
583 .recalc_rate = ingenic_clk_recalc_rate,
584 .round_rate = ingenic_clk_round_rate,
585 .set_rate = ingenic_clk_set_rate,
587 .enable = ingenic_clk_enable,
588 .disable = ingenic_clk_disable,
589 .is_enabled = ingenic_clk_is_enabled,
596 static int ingenic_register_clock(struct ingenic_cgu *cgu, unsigned idx)
598 const struct ingenic_cgu_clk_info *clk_info = &cgu->clock_info[idx];
599 struct clk_init_data clk_init;
600 struct ingenic_clk *ingenic_clk = NULL;
601 struct clk *clk, *parent;
602 const char *parent_names[4];
603 unsigned caps, i, num_possible;
606 BUILD_BUG_ON(ARRAY_SIZE(clk_info->parents) > ARRAY_SIZE(parent_names));
608 if (clk_info->type == CGU_CLK_EXT) {
609 clk = of_clk_get_by_name(cgu->np, clk_info->name);
611 pr_err("%s: no external clock '%s' provided\n",
612 __func__, clk_info->name);
616 err = clk_register_clkdev(clk, clk_info->name, NULL);
621 cgu->clocks.clks[idx] = clk;
625 if (!clk_info->type) {
626 pr_err("%s: no clock type specified for '%s'\n", __func__,
631 ingenic_clk = kzalloc(sizeof(*ingenic_clk), GFP_KERNEL);
637 ingenic_clk->hw.init = &clk_init;
638 ingenic_clk->cgu = cgu;
639 ingenic_clk->idx = idx;
641 clk_init.name = clk_info->name;
643 clk_init.parent_names = parent_names;
645 caps = clk_info->type;
647 if (caps & (CGU_CLK_MUX | CGU_CLK_CUSTOM)) {
648 clk_init.num_parents = 0;
650 if (caps & CGU_CLK_MUX)
651 num_possible = 1 << clk_info->mux.bits;
653 num_possible = ARRAY_SIZE(clk_info->parents);
655 for (i = 0; i < num_possible; i++) {
656 if (clk_info->parents[i] == -1)
659 parent = cgu->clocks.clks[clk_info->parents[i]];
660 parent_names[clk_init.num_parents] =
661 __clk_get_name(parent);
662 clk_init.num_parents++;
665 BUG_ON(!clk_init.num_parents);
666 BUG_ON(clk_init.num_parents > ARRAY_SIZE(parent_names));
668 BUG_ON(clk_info->parents[0] == -1);
669 clk_init.num_parents = 1;
670 parent = cgu->clocks.clks[clk_info->parents[0]];
671 parent_names[0] = __clk_get_name(parent);
674 if (caps & CGU_CLK_CUSTOM) {
675 clk_init.ops = clk_info->custom.clk_ops;
677 caps &= ~CGU_CLK_CUSTOM;
680 pr_err("%s: custom clock may not be combined with type 0x%x\n",
684 } else if (caps & CGU_CLK_PLL) {
685 clk_init.ops = &ingenic_pll_ops;
686 clk_init.flags |= CLK_SET_RATE_GATE;
688 caps &= ~CGU_CLK_PLL;
691 pr_err("%s: PLL may not be combined with type 0x%x\n",
696 clk_init.ops = &ingenic_clk_ops;
699 /* nothing to do for gates or fixed dividers */
700 caps &= ~(CGU_CLK_GATE | CGU_CLK_FIXDIV);
702 if (caps & CGU_CLK_MUX) {
703 if (!(caps & CGU_CLK_MUX_GLITCHFREE))
704 clk_init.flags |= CLK_SET_PARENT_GATE;
706 caps &= ~(CGU_CLK_MUX | CGU_CLK_MUX_GLITCHFREE);
709 if (caps & CGU_CLK_DIV) {
710 caps &= ~CGU_CLK_DIV;
712 /* pass rate changes to the parent clock */
713 clk_init.flags |= CLK_SET_RATE_PARENT;
717 pr_err("%s: unknown clock type 0x%x\n", __func__, caps);
721 clk = clk_register(NULL, &ingenic_clk->hw);
723 pr_err("%s: failed to register clock '%s'\n", __func__,
729 err = clk_register_clkdev(clk, clk_info->name, NULL);
733 cgu->clocks.clks[idx] = clk;
741 ingenic_cgu_new(const struct ingenic_cgu_clk_info *clock_info,
742 unsigned num_clocks, struct device_node *np)
744 struct ingenic_cgu *cgu;
746 cgu = kzalloc(sizeof(*cgu), GFP_KERNEL);
750 cgu->base = of_iomap(np, 0);
752 pr_err("%s: failed to map CGU registers\n", __func__);
757 cgu->clock_info = clock_info;
758 cgu->clocks.clk_num = num_clocks;
760 spin_lock_init(&cgu->lock);
770 int ingenic_cgu_register_clocks(struct ingenic_cgu *cgu)
775 cgu->clocks.clks = kcalloc(cgu->clocks.clk_num, sizeof(struct clk *),
777 if (!cgu->clocks.clks) {
782 for (i = 0; i < cgu->clocks.clk_num; i++) {
783 err = ingenic_register_clock(cgu, i);
785 goto err_out_unregister;
788 err = of_clk_add_provider(cgu->np, of_clk_src_onecell_get,
791 goto err_out_unregister;
796 for (i = 0; i < cgu->clocks.clk_num; i++) {
797 if (!cgu->clocks.clks[i])
799 if (cgu->clock_info[i].type & CGU_CLK_EXT)
800 clk_put(cgu->clocks.clks[i]);
802 clk_unregister(cgu->clocks.clks[i]);
804 kfree(cgu->clocks.clks);