1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * arch/arm/mach-ep93xx/clock.c
4 * Clock control for Cirrus EP93xx chips.
6 * Copyright (C) 2006 Lennert Buytenhek <buytenh@wantstofly.org>
9 #define pr_fmt(fmt) "ep93xx " KBUILD_MODNAME ": " fmt
11 #include <linux/kernel.h>
12 #include <linux/clk.h>
13 #include <linux/err.h>
14 #include <linux/module.h>
15 #include <linux/string.h>
17 #include <linux/spinlock.h>
18 #include <linux/clkdev.h>
19 #include <linux/clk-provider.h>
20 #include <linux/soc/cirrus/ep93xx.h>
24 #include <asm/div64.h>
28 static DEFINE_SPINLOCK(clk_lock);
30 static char fclk_divisors[] = { 1, 2, 4, 8, 16, 1, 1, 1 };
31 static char hclk_divisors[] = { 1, 2, 4, 5, 6, 8, 16, 32 };
32 static char pclk_divisors[] = { 1, 2, 4, 8 };
34 static char adc_divisors[] = { 16, 4 };
35 static char sclk_divisors[] = { 2, 4 };
36 static char lrclk_divisors[] = { 32, 64, 128 };
38 static const char * const mux_parents[] = {
45 * PLL rate = 14.7456 MHz * (X1FBD + 1) * (X2FBD + 1) / (X2IPD + 1) / 2^PS
47 static unsigned long calc_pll_rate(unsigned long long rate, u32 config_word)
51 rate *= ((config_word >> 11) & 0x1f) + 1; /* X1FBD */
52 rate *= ((config_word >> 5) & 0x3f) + 1; /* X2FBD */
53 do_div(rate, (config_word & 0x1f) + 1); /* X2IPD */
54 for (i = 0; i < ((config_word >> 16) & 3); i++) /* PS */
57 return (unsigned long)rate;
72 #define to_clk_psc(_hw) container_of(_hw, struct clk_psc, hw)
74 static int ep93xx_clk_is_enabled(struct clk_hw *hw)
76 struct clk_psc *psc = to_clk_psc(hw);
77 u32 val = readl(psc->reg);
79 return (val & BIT(psc->bit_idx)) ? 1 : 0;
82 static int ep93xx_clk_enable(struct clk_hw *hw)
84 struct clk_psc *psc = to_clk_psc(hw);
85 unsigned long flags = 0;
89 spin_lock_irqsave(psc->lock, flags);
91 val = __raw_readl(psc->reg);
92 val |= BIT(psc->bit_idx);
94 ep93xx_syscon_swlocked_write(val, psc->reg);
97 spin_unlock_irqrestore(psc->lock, flags);
102 static void ep93xx_clk_disable(struct clk_hw *hw)
104 struct clk_psc *psc = to_clk_psc(hw);
105 unsigned long flags = 0;
109 spin_lock_irqsave(psc->lock, flags);
111 val = __raw_readl(psc->reg);
112 val &= ~BIT(psc->bit_idx);
114 ep93xx_syscon_swlocked_write(val, psc->reg);
117 spin_unlock_irqrestore(psc->lock, flags);
120 static const struct clk_ops clk_ep93xx_gate_ops = {
121 .enable = ep93xx_clk_enable,
122 .disable = ep93xx_clk_disable,
123 .is_enabled = ep93xx_clk_is_enabled,
126 static struct clk_hw *ep93xx_clk_register_gate(const char *name,
127 const char *parent_name,
131 struct clk_init_data init;
135 psc = kzalloc(sizeof(*psc), GFP_KERNEL);
137 return ERR_PTR(-ENOMEM);
140 init.ops = &clk_ep93xx_gate_ops;
141 init.flags = CLK_SET_RATE_PARENT;
142 init.parent_names = (parent_name ? &parent_name : NULL);
143 init.num_parents = (parent_name ? 1 : 0);
146 psc->bit_idx = bit_idx;
147 psc->hw.init = &init;
148 psc->lock = &clk_lock;
150 clk = clk_register(NULL, &psc->hw);
153 return ERR_CAST(clk);
159 static u8 ep93xx_mux_get_parent(struct clk_hw *hw)
161 struct clk_psc *psc = to_clk_psc(hw);
162 u32 val = __raw_readl(psc->reg);
164 if (!(val & EP93XX_SYSCON_CLKDIV_ESEL))
167 if (!(val & EP93XX_SYSCON_CLKDIV_PSEL))
173 static int ep93xx_mux_set_parent_lock(struct clk_hw *hw, u8 index)
175 struct clk_psc *psc = to_clk_psc(hw);
176 unsigned long flags = 0;
179 if (index >= ARRAY_SIZE(mux_parents))
183 spin_lock_irqsave(psc->lock, flags);
185 val = __raw_readl(psc->reg);
186 val &= ~(EP93XX_SYSCON_CLKDIV_ESEL | EP93XX_SYSCON_CLKDIV_PSEL);
190 val |= EP93XX_SYSCON_CLKDIV_ESEL;
191 val |= (index - 1) ? EP93XX_SYSCON_CLKDIV_PSEL : 0;
194 ep93xx_syscon_swlocked_write(val, psc->reg);
197 spin_unlock_irqrestore(psc->lock, flags);
202 static bool is_best(unsigned long rate, unsigned long now,
205 return abs(rate - now) < abs(rate - best);
208 static int ep93xx_mux_determine_rate(struct clk_hw *hw,
209 struct clk_rate_request *req)
211 unsigned long rate = req->rate;
212 struct clk *best_parent = NULL;
213 unsigned long __parent_rate;
214 unsigned long best_rate = 0, actual_rate, mclk_rate;
215 unsigned long best_parent_rate;
216 int __div = 0, __pdiv = 0;
220 * Try the two pll's and the external clock
221 * Because the valid predividers are 2, 2.5 and 3, we multiply
222 * all the clocks by 2 to avoid floating point math.
224 * This is based on the algorithm in the ep93xx raster guide:
225 * http://be-a-maverick.com/en/pubs/appNote/AN269REV1.pdf
228 for (i = 0; i < ARRAY_SIZE(mux_parents); i++) {
229 struct clk *parent = clk_get_sys(mux_parents[i], NULL);
231 __parent_rate = clk_get_rate(parent);
232 mclk_rate = __parent_rate * 2;
234 /* Try each predivider value */
235 for (__pdiv = 4; __pdiv <= 6; __pdiv++) {
236 __div = mclk_rate / (rate * __pdiv);
237 if (__div < 2 || __div > 127)
240 actual_rate = mclk_rate / (__pdiv * __div);
241 if (is_best(rate, actual_rate, best_rate)) {
242 best_rate = actual_rate;
243 best_parent_rate = __parent_rate;
244 best_parent = parent;
252 req->best_parent_rate = best_parent_rate;
253 req->best_parent_hw = __clk_get_hw(best_parent);
254 req->rate = best_rate;
259 static unsigned long ep93xx_ddiv_recalc_rate(struct clk_hw *hw,
260 unsigned long parent_rate)
262 struct clk_psc *psc = to_clk_psc(hw);
263 unsigned long rate = 0;
264 u32 val = __raw_readl(psc->reg);
265 int __pdiv = ((val >> EP93XX_SYSCON_CLKDIV_PDIV_SHIFT) & 0x03);
266 int __div = val & 0x7f;
269 rate = (parent_rate * 2) / ((__pdiv + 3) * __div);
274 static int ep93xx_ddiv_set_rate(struct clk_hw *hw, unsigned long rate,
275 unsigned long parent_rate)
277 struct clk_psc *psc = to_clk_psc(hw);
278 int pdiv = 0, div = 0;
279 unsigned long best_rate = 0, actual_rate, mclk_rate;
280 int __div = 0, __pdiv = 0;
283 mclk_rate = parent_rate * 2;
285 for (__pdiv = 4; __pdiv <= 6; __pdiv++) {
286 __div = mclk_rate / (rate * __pdiv);
287 if (__div < 2 || __div > 127)
290 actual_rate = mclk_rate / (__pdiv * __div);
291 if (is_best(rate, actual_rate, best_rate)) {
294 best_rate = actual_rate;
301 val = __raw_readl(psc->reg);
303 /* Clear old dividers */
306 /* Set the new pdiv and div bits for the new clock rate */
307 val |= (pdiv << EP93XX_SYSCON_CLKDIV_PDIV_SHIFT) | div;
308 ep93xx_syscon_swlocked_write(val, psc->reg);
313 static const struct clk_ops clk_ddiv_ops = {
314 .enable = ep93xx_clk_enable,
315 .disable = ep93xx_clk_disable,
316 .is_enabled = ep93xx_clk_is_enabled,
317 .get_parent = ep93xx_mux_get_parent,
318 .set_parent = ep93xx_mux_set_parent_lock,
319 .determine_rate = ep93xx_mux_determine_rate,
320 .recalc_rate = ep93xx_ddiv_recalc_rate,
321 .set_rate = ep93xx_ddiv_set_rate,
324 static struct clk_hw *clk_hw_register_ddiv(const char *name,
328 struct clk_init_data init;
332 psc = kzalloc(sizeof(*psc), GFP_KERNEL);
334 return ERR_PTR(-ENOMEM);
337 init.ops = &clk_ddiv_ops;
339 init.parent_names = mux_parents;
340 init.num_parents = ARRAY_SIZE(mux_parents);
343 psc->bit_idx = bit_idx;
344 psc->lock = &clk_lock;
345 psc->hw.init = &init;
347 clk = clk_register(NULL, &psc->hw);
350 return ERR_CAST(clk);
355 static unsigned long ep93xx_div_recalc_rate(struct clk_hw *hw,
356 unsigned long parent_rate)
358 struct clk_psc *psc = to_clk_psc(hw);
359 u32 val = __raw_readl(psc->reg);
360 u8 index = (val & psc->mask) >> psc->shift;
362 if (index > psc->num_div)
365 return DIV_ROUND_UP_ULL(parent_rate, psc->div[index]);
368 static long ep93xx_div_round_rate(struct clk_hw *hw, unsigned long rate,
369 unsigned long *parent_rate)
371 struct clk_psc *psc = to_clk_psc(hw);
372 unsigned long best = 0, now, maxdiv;
375 maxdiv = psc->div[psc->num_div - 1];
377 for (i = 0; i < psc->num_div; i++) {
378 if ((rate * psc->div[i]) == *parent_rate)
379 return DIV_ROUND_UP_ULL((u64)*parent_rate, psc->div[i]);
381 now = DIV_ROUND_UP_ULL((u64)*parent_rate, psc->div[i]);
383 if (is_best(rate, now, best))
388 best = DIV_ROUND_UP_ULL(*parent_rate, maxdiv);
393 static int ep93xx_div_set_rate(struct clk_hw *hw, unsigned long rate,
394 unsigned long parent_rate)
396 struct clk_psc *psc = to_clk_psc(hw);
397 u32 val = __raw_readl(psc->reg) & ~psc->mask;
400 for (i = 0; i < psc->num_div; i++)
401 if (rate == parent_rate / psc->div[i]) {
402 val |= i << psc->shift;
406 if (i == psc->num_div)
409 ep93xx_syscon_swlocked_write(val, psc->reg);
414 static const struct clk_ops ep93xx_div_ops = {
415 .enable = ep93xx_clk_enable,
416 .disable = ep93xx_clk_disable,
417 .is_enabled = ep93xx_clk_is_enabled,
418 .recalc_rate = ep93xx_div_recalc_rate,
419 .round_rate = ep93xx_div_round_rate,
420 .set_rate = ep93xx_div_set_rate,
423 static struct clk_hw *clk_hw_register_div(const char *name,
424 const char *parent_name,
432 struct clk_init_data init;
436 psc = kzalloc(sizeof(*psc), GFP_KERNEL);
438 return ERR_PTR(-ENOMEM);
441 init.ops = &ep93xx_div_ops;
443 init.parent_names = (parent_name ? &parent_name : NULL);
444 init.num_parents = 1;
447 psc->bit_idx = enable_bit;
448 psc->mask = GENMASK(shift + width - 1, shift);
450 psc->div = clk_divisors;
451 psc->num_div = num_div;
452 psc->lock = &clk_lock;
453 psc->hw.init = &init;
455 clk = clk_register(NULL, &psc->hw);
458 return ERR_CAST(clk);
469 static struct ep93xx_gate ep93xx_uarts[] = {
470 {EP93XX_SYSCON_DEVCFG_U1EN, "apb:uart1", NULL},
471 {EP93XX_SYSCON_DEVCFG_U2EN, "apb:uart2", NULL},
472 {EP93XX_SYSCON_DEVCFG_U3EN, "apb:uart3", NULL},
475 static void __init ep93xx_uart_clock_init(void)
480 unsigned int clk_uart_div;
482 value = __raw_readl(EP93XX_SYSCON_PWRCNT);
483 if (value & EP93XX_SYSCON_PWRCNT_UARTBAUD)
488 hw = clk_hw_register_fixed_factor(NULL, "uart", "xtali", 0, 1, clk_uart_div);
490 /* parenting uart gate clocks to uart clock */
491 for (i = 0; i < ARRAY_SIZE(ep93xx_uarts); i++) {
492 hw = ep93xx_clk_register_gate(ep93xx_uarts[i].dev_id,
494 EP93XX_SYSCON_DEVCFG,
495 ep93xx_uarts[i].bit);
497 clk_hw_register_clkdev(hw, NULL, ep93xx_uarts[i].dev_id);
501 static struct ep93xx_gate ep93xx_dmas[] = {
502 {EP93XX_SYSCON_PWRCNT_DMA_M2P0, NULL, "m2p0"},
503 {EP93XX_SYSCON_PWRCNT_DMA_M2P1, NULL, "m2p1"},
504 {EP93XX_SYSCON_PWRCNT_DMA_M2P2, NULL, "m2p2"},
505 {EP93XX_SYSCON_PWRCNT_DMA_M2P3, NULL, "m2p3"},
506 {EP93XX_SYSCON_PWRCNT_DMA_M2P4, NULL, "m2p4"},
507 {EP93XX_SYSCON_PWRCNT_DMA_M2P5, NULL, "m2p5"},
508 {EP93XX_SYSCON_PWRCNT_DMA_M2P6, NULL, "m2p6"},
509 {EP93XX_SYSCON_PWRCNT_DMA_M2P7, NULL, "m2p7"},
510 {EP93XX_SYSCON_PWRCNT_DMA_M2P8, NULL, "m2p8"},
511 {EP93XX_SYSCON_PWRCNT_DMA_M2P9, NULL, "m2p9"},
512 {EP93XX_SYSCON_PWRCNT_DMA_M2M0, NULL, "m2m0"},
513 {EP93XX_SYSCON_PWRCNT_DMA_M2M1, NULL, "m2m1"},
516 static void __init ep93xx_dma_clock_init(void)
522 for (i = 0; i < ARRAY_SIZE(ep93xx_dmas); i++) {
523 hw = clk_hw_register_gate(NULL, ep93xx_dmas[i].con_id,
525 EP93XX_SYSCON_PWRCNT,
530 ret = clk_hw_register_clkdev(hw, ep93xx_dmas[i].con_id, NULL);
532 pr_err("%s: failed to register lookup %s\n",
533 __func__, ep93xx_dmas[i].con_id);
537 static int __init ep93xx_clock_init(void)
541 unsigned long clk_pll1_rate;
542 unsigned long clk_f_rate;
543 unsigned long clk_h_rate;
544 unsigned long clk_p_rate;
545 unsigned long clk_pll2_rate;
546 unsigned int clk_f_div;
547 unsigned int clk_h_div;
548 unsigned int clk_p_div;
549 unsigned int clk_usb_div;
550 unsigned long clk_spi_div;
552 hw = clk_hw_register_fixed_rate(NULL, "xtali", NULL, 0, EP93XX_EXT_CLK_RATE);
553 clk_hw_register_clkdev(hw, NULL, "xtali");
555 /* Determine the bootloader configured pll1 rate */
556 value = __raw_readl(EP93XX_SYSCON_CLKSET1);
557 if (!(value & EP93XX_SYSCON_CLKSET1_NBYP1))
558 clk_pll1_rate = EP93XX_EXT_CLK_RATE;
560 clk_pll1_rate = calc_pll_rate(EP93XX_EXT_CLK_RATE, value);
562 hw = clk_hw_register_fixed_rate(NULL, "pll1", "xtali", 0, clk_pll1_rate);
563 clk_hw_register_clkdev(hw, NULL, "pll1");
565 /* Initialize the pll1 derived clocks */
566 clk_f_div = fclk_divisors[(value >> 25) & 0x7];
567 clk_h_div = hclk_divisors[(value >> 20) & 0x7];
568 clk_p_div = pclk_divisors[(value >> 18) & 0x3];
570 hw = clk_hw_register_fixed_factor(NULL, "fclk", "pll1", 0, 1, clk_f_div);
571 clk_f_rate = clk_get_rate(hw->clk);
572 hw = clk_hw_register_fixed_factor(NULL, "hclk", "pll1", 0, 1, clk_h_div);
573 clk_h_rate = clk_get_rate(hw->clk);
574 hw = clk_hw_register_fixed_factor(NULL, "pclk", "hclk", 0, 1, clk_p_div);
575 clk_p_rate = clk_get_rate(hw->clk);
577 clk_hw_register_clkdev(hw, "apb_pclk", NULL);
579 ep93xx_dma_clock_init();
581 /* Determine the bootloader configured pll2 rate */
582 value = __raw_readl(EP93XX_SYSCON_CLKSET2);
583 if (!(value & EP93XX_SYSCON_CLKSET2_NBYP2))
584 clk_pll2_rate = EP93XX_EXT_CLK_RATE;
585 else if (value & EP93XX_SYSCON_CLKSET2_PLL2_EN)
586 clk_pll2_rate = calc_pll_rate(EP93XX_EXT_CLK_RATE, value);
590 hw = clk_hw_register_fixed_rate(NULL, "pll2", "xtali", 0, clk_pll2_rate);
591 clk_hw_register_clkdev(hw, NULL, "pll2");
593 /* Initialize the pll2 derived clocks */
595 * These four bits set the divide ratio between the PLL2
596 * output and the USB clock.
606 * 1001 - Divide by 10
607 * 1010 - Divide by 11
608 * 1011 - Divide by 12
609 * 1100 - Divide by 13
610 * 1101 - Divide by 14
611 * 1110 - Divide by 15
613 * On power-on-reset these bits are reset to 0000b.
615 clk_usb_div = (((value >> 28) & 0xf) + 1);
616 hw = clk_hw_register_fixed_factor(NULL, "usb_clk", "pll2", 0, 1, clk_usb_div);
617 hw = clk_hw_register_gate(NULL, "ohci-platform",
619 EP93XX_SYSCON_PWRCNT,
620 EP93XX_SYSCON_PWRCNT_USH_EN,
623 clk_hw_register_clkdev(hw, NULL, "ohci-platform");
626 * EP93xx SSP clock rate was doubled in version E2. For more information
628 * http://www.cirrus.com/en/pubs/appNote/AN273REV4.pdf
631 if (ep93xx_chip_revision() < EP93XX_CHIP_REV_E2)
633 hw = clk_hw_register_fixed_factor(NULL, "ep93xx-spi.0", "xtali", 0, 1, clk_spi_div);
634 clk_hw_register_clkdev(hw, NULL, "ep93xx-spi.0");
637 hw = clk_hw_register_fixed_factor(NULL, "pwm_clk", "xtali", 0, 1, 1);
638 clk_hw_register_clkdev(hw, "pwm_clk", NULL);
640 pr_info("PLL1 running at %ld MHz, PLL2 at %ld MHz\n",
641 clk_pll1_rate / 1000000, clk_pll2_rate / 1000000);
642 pr_info("FCLK %ld MHz, HCLK %ld MHz, PCLK %ld MHz\n",
643 clk_f_rate / 1000000, clk_h_rate / 1000000,
644 clk_p_rate / 1000000);
646 ep93xx_uart_clock_init();
648 /* touchscreen/adc clock */
649 hw = clk_hw_register_div("ep93xx-adc",
651 EP93XX_SYSCON_KEYTCHCLKDIV,
652 EP93XX_SYSCON_KEYTCHCLKDIV_TSEN,
653 EP93XX_SYSCON_KEYTCHCLKDIV_ADIV,
656 ARRAY_SIZE(adc_divisors));
658 clk_hw_register_clkdev(hw, NULL, "ep93xx-adc");
661 hw = clk_hw_register_div("ep93xx-keypad",
663 EP93XX_SYSCON_KEYTCHCLKDIV,
664 EP93XX_SYSCON_KEYTCHCLKDIV_KEN,
665 EP93XX_SYSCON_KEYTCHCLKDIV_KDIV,
668 ARRAY_SIZE(adc_divisors));
670 clk_hw_register_clkdev(hw, NULL, "ep93xx-keypad");
672 /* On reset PDIV and VDIV is set to zero, while PDIV zero
673 * means clock disable, VDIV shouldn't be zero.
674 * So i set both dividers to minimum.
676 /* ENA - Enable CLK divider. */
677 /* PDIV - 00 - Disable clock */
678 /* VDIV - at least 2 */
679 /* Check and enable video clk registers */
680 value = __raw_readl(EP93XX_SYSCON_VIDCLKDIV);
681 value |= (1 << EP93XX_SYSCON_CLKDIV_PDIV_SHIFT) | 2;
682 ep93xx_syscon_swlocked_write(value, EP93XX_SYSCON_VIDCLKDIV);
684 /* check and enable i2s clk registers */
685 value = __raw_readl(EP93XX_SYSCON_I2SCLKDIV);
686 value |= (1 << EP93XX_SYSCON_CLKDIV_PDIV_SHIFT) | 2;
687 ep93xx_syscon_swlocked_write(value, EP93XX_SYSCON_I2SCLKDIV);
690 hw = clk_hw_register_ddiv("ep93xx-fb",
691 EP93XX_SYSCON_VIDCLKDIV,
692 EP93XX_SYSCON_CLKDIV_ENABLE);
694 clk_hw_register_clkdev(hw, NULL, "ep93xx-fb");
697 hw = clk_hw_register_ddiv("mclk",
698 EP93XX_SYSCON_I2SCLKDIV,
699 EP93XX_SYSCON_CLKDIV_ENABLE);
701 clk_hw_register_clkdev(hw, "mclk", "ep93xx-i2s");
704 #define EP93XX_I2SCLKDIV_SDIV_SHIFT 16
705 #define EP93XX_I2SCLKDIV_SDIV_WIDTH 1
706 hw = clk_hw_register_div("sclk",
708 EP93XX_SYSCON_I2SCLKDIV,
709 EP93XX_SYSCON_I2SCLKDIV_SENA,
710 EP93XX_I2SCLKDIV_SDIV_SHIFT,
711 EP93XX_I2SCLKDIV_SDIV_WIDTH,
713 ARRAY_SIZE(sclk_divisors));
715 clk_hw_register_clkdev(hw, "sclk", "ep93xx-i2s");
718 #define EP93XX_I2SCLKDIV_LRDIV32_SHIFT 17
719 #define EP93XX_I2SCLKDIV_LRDIV32_WIDTH 3
720 hw = clk_hw_register_div("lrclk",
722 EP93XX_SYSCON_I2SCLKDIV,
723 EP93XX_SYSCON_I2SCLKDIV_SENA,
724 EP93XX_I2SCLKDIV_LRDIV32_SHIFT,
725 EP93XX_I2SCLKDIV_LRDIV32_WIDTH,
727 ARRAY_SIZE(lrclk_divisors));
729 clk_hw_register_clkdev(hw, "lrclk", "ep93xx-i2s");
733 postcore_initcall(ep93xx_clock_init);