1 // SPDX-License-Identifier: GPL-2.0
3 * Xilinx 'Clocking Wizard' driver
5 * Copyright (C) 2013 - 2014 Xilinx
7 * Sören Brinkmann <soren.brinkmann@xilinx.com>
10 #include <linux/platform_device.h>
11 #include <linux/clk.h>
12 #include <linux/clk-provider.h>
13 #include <linux/slab.h>
16 #include <linux/module.h>
17 #include <linux/err.h>
18 #include <linux/iopoll.h>
20 #define WZRD_NUM_OUTPUTS 7
21 #define WZRD_ACLK_MAX_FREQ 250000000UL
23 #define WZRD_CLK_CFG_REG(n) (0x200 + 4 * (n))
25 #define WZRD_CLKOUT0_FRAC_EN BIT(18)
26 #define WZRD_CLKFBOUT_FRAC_EN BIT(26)
28 #define WZRD_CLKFBOUT_MULT_SHIFT 8
29 #define WZRD_CLKFBOUT_MULT_MASK (0xff << WZRD_CLKFBOUT_MULT_SHIFT)
30 #define WZRD_CLKFBOUT_FRAC_SHIFT 16
31 #define WZRD_CLKFBOUT_FRAC_MASK (0x3ff << WZRD_CLKFBOUT_FRAC_SHIFT)
32 #define WZRD_DIVCLK_DIVIDE_SHIFT 0
33 #define WZRD_DIVCLK_DIVIDE_MASK (0xff << WZRD_DIVCLK_DIVIDE_SHIFT)
34 #define WZRD_CLKOUT_DIVIDE_SHIFT 0
35 #define WZRD_CLKOUT_DIVIDE_WIDTH 8
36 #define WZRD_CLKOUT_DIVIDE_MASK (0xff << WZRD_DIVCLK_DIVIDE_SHIFT)
37 #define WZRD_CLKOUT_FRAC_SHIFT 8
38 #define WZRD_CLKOUT_FRAC_MASK 0x3ff
40 #define WZRD_DR_MAX_INT_DIV_VALUE 255
41 #define WZRD_DR_STATUS_REG_OFFSET 0x04
42 #define WZRD_DR_LOCK_BIT_MASK 0x00000001
43 #define WZRD_DR_INIT_REG_OFFSET 0x25C
44 #define WZRD_DR_DIV_TO_PHASE_OFFSET 4
45 #define WZRD_DR_BEGIN_DYNA_RECONF 0x03
47 #define WZRD_USEC_POLL 10
48 #define WZRD_TIMEOUT_POLL 1000
49 /* Get the mask from width */
50 #define div_mask(width) ((1 << (width)) - 1)
52 /* Extract divider instance from clock hardware instance */
53 #define to_clk_wzrd_divider(_hw) container_of(_hw, struct clk_wzrd_divider, hw)
55 enum clk_wzrd_int_clks {
63 * struct clk_wzrd - Clock wizard private data structure
65 * @clk_data: Clock data
68 * @clk_in1: Handle to input clock 'clk_in1'
69 * @axi_clk: Handle to input clock 's_axi_aclk'
70 * @clks_internal: Internal clocks
71 * @clkout: Output clocks
72 * @speed_grade: Speed grade of the device
73 * @suspended: Flag indicating power state of the device
76 struct clk_onecell_data clk_data;
77 struct notifier_block nb;
81 struct clk *clks_internal[wzrd_clk_int_max];
82 struct clk *clkout[WZRD_NUM_OUTPUTS];
83 unsigned int speed_grade;
88 * struct clk_wzrd_divider - clock divider specific to clk_wzrd
90 * @hw: handle between common and hardware-specific interfaces
91 * @base: base address of register containing the divider
92 * @offset: offset address of register containing the divider
93 * @shift: shift to the divider bit field
94 * @width: width of the divider bit field
95 * @flags: clk_wzrd divider flags
96 * @table: array of value/divider pairs, last entry should have div = 0
97 * @lock: register lock
99 struct clk_wzrd_divider {
106 const struct clk_div_table *table;
107 spinlock_t *lock; /* divider lock */
110 #define to_clk_wzrd(_nb) container_of(_nb, struct clk_wzrd, nb)
112 /* maximum frequencies for input/output clocks per speed grade */
113 static const unsigned long clk_wzrd_max_freq[] = {
119 /* spin lock variable for clk_wzrd */
120 static DEFINE_SPINLOCK(clkwzrd_lock);
122 static unsigned long clk_wzrd_recalc_rate(struct clk_hw *hw,
123 unsigned long parent_rate)
125 struct clk_wzrd_divider *divider = to_clk_wzrd_divider(hw);
126 void __iomem *div_addr = divider->base + divider->offset;
129 val = readl(div_addr) >> divider->shift;
130 val &= div_mask(divider->width);
132 return divider_recalc_rate(hw, parent_rate, val, divider->table,
133 divider->flags, divider->width);
136 static int clk_wzrd_dynamic_reconfig(struct clk_hw *hw, unsigned long rate,
137 unsigned long parent_rate)
141 unsigned long flags = 0;
142 struct clk_wzrd_divider *divider = to_clk_wzrd_divider(hw);
143 void __iomem *div_addr = divider->base + divider->offset;
146 spin_lock_irqsave(divider->lock, flags);
148 __acquire(divider->lock);
150 value = DIV_ROUND_CLOSEST(parent_rate, rate);
152 /* Cap the value to max */
153 min_t(u32, value, WZRD_DR_MAX_INT_DIV_VALUE);
155 /* Set divisor and clear phase offset */
156 writel(value, div_addr);
157 writel(0x00, div_addr + WZRD_DR_DIV_TO_PHASE_OFFSET);
159 /* Check status register */
160 err = readl_poll_timeout(divider->base + WZRD_DR_STATUS_REG_OFFSET,
161 value, value & WZRD_DR_LOCK_BIT_MASK,
162 WZRD_USEC_POLL, WZRD_TIMEOUT_POLL);
166 /* Initiate reconfiguration */
167 writel(WZRD_DR_BEGIN_DYNA_RECONF,
168 divider->base + WZRD_DR_INIT_REG_OFFSET);
170 /* Check status register */
171 err = readl_poll_timeout(divider->base + WZRD_DR_STATUS_REG_OFFSET,
172 value, value & WZRD_DR_LOCK_BIT_MASK,
173 WZRD_USEC_POLL, WZRD_TIMEOUT_POLL);
176 spin_unlock_irqrestore(divider->lock, flags);
178 __release(divider->lock);
182 static long clk_wzrd_round_rate(struct clk_hw *hw, unsigned long rate,
183 unsigned long *prate)
188 * since we don't change parent rate we just round rate to closest
191 div = DIV_ROUND_CLOSEST(*prate, rate);
196 static const struct clk_ops clk_wzrd_clk_divider_ops = {
197 .round_rate = clk_wzrd_round_rate,
198 .set_rate = clk_wzrd_dynamic_reconfig,
199 .recalc_rate = clk_wzrd_recalc_rate,
202 static unsigned long clk_wzrd_recalc_ratef(struct clk_hw *hw,
203 unsigned long parent_rate)
207 struct clk_wzrd_divider *divider = to_clk_wzrd_divider(hw);
208 void __iomem *div_addr = divider->base + divider->offset;
210 val = readl(div_addr);
211 div = val & div_mask(divider->width);
212 frac = (val >> WZRD_CLKOUT_FRAC_SHIFT) & WZRD_CLKOUT_FRAC_MASK;
214 return mult_frac(parent_rate, 1000, (div * 1000) + frac);
217 static int clk_wzrd_dynamic_reconfig_f(struct clk_hw *hw, unsigned long rate,
218 unsigned long parent_rate)
222 unsigned long rate_div, f, clockout0_div;
223 struct clk_wzrd_divider *divider = to_clk_wzrd_divider(hw);
224 void __iomem *div_addr = divider->base + divider->offset;
226 rate_div = ((parent_rate * 1000) / rate);
227 clockout0_div = rate_div / 1000;
229 pre = DIV_ROUND_CLOSEST((parent_rate * 1000), rate);
230 f = (u32)(pre - (clockout0_div * 1000));
231 f = f & WZRD_CLKOUT_FRAC_MASK;
232 f = f << WZRD_CLKOUT_DIVIDE_WIDTH;
234 value = (f | (clockout0_div & WZRD_CLKOUT_DIVIDE_MASK));
236 /* Set divisor and clear phase offset */
237 writel(value, div_addr);
238 writel(0x0, div_addr + WZRD_DR_DIV_TO_PHASE_OFFSET);
240 /* Check status register */
241 err = readl_poll_timeout(divider->base + WZRD_DR_STATUS_REG_OFFSET, value,
242 value & WZRD_DR_LOCK_BIT_MASK,
243 WZRD_USEC_POLL, WZRD_TIMEOUT_POLL);
247 /* Initiate reconfiguration */
248 writel(WZRD_DR_BEGIN_DYNA_RECONF,
249 divider->base + WZRD_DR_INIT_REG_OFFSET);
251 /* Check status register */
252 return readl_poll_timeout(divider->base + WZRD_DR_STATUS_REG_OFFSET, value,
253 value & WZRD_DR_LOCK_BIT_MASK,
254 WZRD_USEC_POLL, WZRD_TIMEOUT_POLL);
257 static long clk_wzrd_round_rate_f(struct clk_hw *hw, unsigned long rate,
258 unsigned long *prate)
263 static const struct clk_ops clk_wzrd_clk_divider_ops_f = {
264 .round_rate = clk_wzrd_round_rate_f,
265 .set_rate = clk_wzrd_dynamic_reconfig_f,
266 .recalc_rate = clk_wzrd_recalc_ratef,
269 static struct clk *clk_wzrd_register_divf(struct device *dev,
271 const char *parent_name,
273 void __iomem *base, u16 offset,
275 u8 clk_divider_flags,
276 const struct clk_div_table *table,
279 struct clk_wzrd_divider *div;
281 struct clk_init_data init;
284 div = devm_kzalloc(dev, sizeof(*div), GFP_KERNEL);
286 return ERR_PTR(-ENOMEM);
290 init.ops = &clk_wzrd_clk_divider_ops_f;
293 init.parent_names = &parent_name;
294 init.num_parents = 1;
297 div->offset = offset;
300 div->flags = clk_divider_flags;
302 div->hw.init = &init;
306 ret = devm_clk_hw_register(dev, hw);
313 static struct clk *clk_wzrd_register_divider(struct device *dev,
315 const char *parent_name,
317 void __iomem *base, u16 offset,
319 u8 clk_divider_flags,
320 const struct clk_div_table *table,
323 struct clk_wzrd_divider *div;
325 struct clk_init_data init;
328 div = devm_kzalloc(dev, sizeof(*div), GFP_KERNEL);
330 return ERR_PTR(-ENOMEM);
333 init.ops = &clk_wzrd_clk_divider_ops;
335 init.parent_names = &parent_name;
336 init.num_parents = 1;
339 div->offset = offset;
342 div->flags = clk_divider_flags;
344 div->hw.init = &init;
348 ret = devm_clk_hw_register(dev, hw);
355 static int clk_wzrd_clk_notifier(struct notifier_block *nb, unsigned long event,
359 struct clk_notifier_data *ndata = data;
360 struct clk_wzrd *clk_wzrd = to_clk_wzrd(nb);
362 if (clk_wzrd->suspended)
365 if (ndata->clk == clk_wzrd->clk_in1)
366 max = clk_wzrd_max_freq[clk_wzrd->speed_grade - 1];
367 else if (ndata->clk == clk_wzrd->axi_clk)
368 max = WZRD_ACLK_MAX_FREQ;
370 return NOTIFY_DONE; /* should never happen */
373 case PRE_RATE_CHANGE:
374 if (ndata->new_rate > max)
377 case POST_RATE_CHANGE:
378 case ABORT_RATE_CHANGE:
384 static int __maybe_unused clk_wzrd_suspend(struct device *dev)
386 struct clk_wzrd *clk_wzrd = dev_get_drvdata(dev);
388 clk_disable_unprepare(clk_wzrd->axi_clk);
389 clk_wzrd->suspended = true;
394 static int __maybe_unused clk_wzrd_resume(struct device *dev)
397 struct clk_wzrd *clk_wzrd = dev_get_drvdata(dev);
399 ret = clk_prepare_enable(clk_wzrd->axi_clk);
401 dev_err(dev, "unable to enable s_axi_aclk\n");
405 clk_wzrd->suspended = false;
410 static SIMPLE_DEV_PM_OPS(clk_wzrd_dev_pm_ops, clk_wzrd_suspend,
413 static int clk_wzrd_probe(struct platform_device *pdev)
416 u32 reg, reg_f, mult;
418 const char *clk_name;
419 void __iomem *ctrl_reg;
420 struct clk_wzrd *clk_wzrd;
421 struct device_node *np = pdev->dev.of_node;
423 unsigned long flags = 0;
425 clk_wzrd = devm_kzalloc(&pdev->dev, sizeof(*clk_wzrd), GFP_KERNEL);
428 platform_set_drvdata(pdev, clk_wzrd);
430 clk_wzrd->base = devm_platform_ioremap_resource(pdev, 0);
431 if (IS_ERR(clk_wzrd->base))
432 return PTR_ERR(clk_wzrd->base);
434 ret = of_property_read_u32(np, "xlnx,speed-grade", &clk_wzrd->speed_grade);
436 if (clk_wzrd->speed_grade < 1 || clk_wzrd->speed_grade > 3) {
437 dev_warn(&pdev->dev, "invalid speed grade '%d'\n",
438 clk_wzrd->speed_grade);
439 clk_wzrd->speed_grade = 0;
443 clk_wzrd->clk_in1 = devm_clk_get(&pdev->dev, "clk_in1");
444 if (IS_ERR(clk_wzrd->clk_in1)) {
445 if (clk_wzrd->clk_in1 != ERR_PTR(-EPROBE_DEFER))
446 dev_err(&pdev->dev, "clk_in1 not found\n");
447 return PTR_ERR(clk_wzrd->clk_in1);
450 clk_wzrd->axi_clk = devm_clk_get(&pdev->dev, "s_axi_aclk");
451 if (IS_ERR(clk_wzrd->axi_clk)) {
452 if (clk_wzrd->axi_clk != ERR_PTR(-EPROBE_DEFER))
453 dev_err(&pdev->dev, "s_axi_aclk not found\n");
454 return PTR_ERR(clk_wzrd->axi_clk);
456 ret = clk_prepare_enable(clk_wzrd->axi_clk);
458 dev_err(&pdev->dev, "enabling s_axi_aclk failed\n");
461 rate = clk_get_rate(clk_wzrd->axi_clk);
462 if (rate > WZRD_ACLK_MAX_FREQ) {
463 dev_err(&pdev->dev, "s_axi_aclk frequency (%lu) too high\n",
466 goto err_disable_clk;
469 reg = readl(clk_wzrd->base + WZRD_CLK_CFG_REG(0));
470 reg_f = reg & WZRD_CLKFBOUT_FRAC_MASK;
471 reg_f = reg_f >> WZRD_CLKFBOUT_FRAC_SHIFT;
473 reg = reg & WZRD_CLKFBOUT_MULT_MASK;
474 reg = reg >> WZRD_CLKFBOUT_MULT_SHIFT;
475 mult = (reg * 1000) + reg_f;
476 clk_name = kasprintf(GFP_KERNEL, "%s_mul", dev_name(&pdev->dev));
479 goto err_disable_clk;
482 ret = of_property_read_u32(np, "nr-outputs", &nr_outputs);
483 if (ret || nr_outputs > WZRD_NUM_OUTPUTS) {
485 goto err_disable_clk;
488 flags = CLK_SET_RATE_PARENT;
490 clk_wzrd->clks_internal[wzrd_clk_mul] = clk_register_fixed_factor
491 (&pdev->dev, clk_name,
492 __clk_get_name(clk_wzrd->clk_in1),
494 if (IS_ERR(clk_wzrd->clks_internal[wzrd_clk_mul])) {
495 dev_err(&pdev->dev, "unable to register fixed-factor clock\n");
496 ret = PTR_ERR(clk_wzrd->clks_internal[wzrd_clk_mul]);
497 goto err_disable_clk;
500 clk_name = kasprintf(GFP_KERNEL, "%s_mul_div", dev_name(&pdev->dev));
506 ctrl_reg = clk_wzrd->base + WZRD_CLK_CFG_REG(0);
508 clk_wzrd->clks_internal[wzrd_clk_mul_div] = clk_register_divider
509 (&pdev->dev, clk_name,
510 __clk_get_name(clk_wzrd->clks_internal[wzrd_clk_mul]),
511 flags, ctrl_reg, 0, 8, CLK_DIVIDER_ONE_BASED |
512 CLK_DIVIDER_ALLOW_ZERO, &clkwzrd_lock);
513 if (IS_ERR(clk_wzrd->clks_internal[wzrd_clk_mul_div])) {
514 dev_err(&pdev->dev, "unable to register divider clock\n");
515 ret = PTR_ERR(clk_wzrd->clks_internal[wzrd_clk_mul_div]);
519 /* register div per output */
520 for (i = nr_outputs - 1; i >= 0 ; i--) {
521 const char *clkout_name;
523 clkout_name = kasprintf(GFP_KERNEL, "%s_out%d", dev_name(&pdev->dev), i);
530 clk_wzrd->clkout[i] = clk_wzrd_register_divf
531 (&pdev->dev, clkout_name,
533 clk_wzrd->base, (WZRD_CLK_CFG_REG(2) + i * 12),
534 WZRD_CLKOUT_DIVIDE_SHIFT,
535 WZRD_CLKOUT_DIVIDE_WIDTH,
536 CLK_DIVIDER_ONE_BASED | CLK_DIVIDER_ALLOW_ZERO,
537 NULL, &clkwzrd_lock);
539 clk_wzrd->clkout[i] = clk_wzrd_register_divider
540 (&pdev->dev, clkout_name,
542 clk_wzrd->base, (WZRD_CLK_CFG_REG(2) + i * 12),
543 WZRD_CLKOUT_DIVIDE_SHIFT,
544 WZRD_CLKOUT_DIVIDE_WIDTH,
545 CLK_DIVIDER_ONE_BASED | CLK_DIVIDER_ALLOW_ZERO,
546 NULL, &clkwzrd_lock);
547 if (IS_ERR(clk_wzrd->clkout[i])) {
550 for (j = i + 1; j < nr_outputs; j++)
551 clk_unregister(clk_wzrd->clkout[j]);
553 "unable to register divider clock\n");
554 ret = PTR_ERR(clk_wzrd->clkout[i]);
555 goto err_rm_int_clks;
561 clk_wzrd->clk_data.clks = clk_wzrd->clkout;
562 clk_wzrd->clk_data.clk_num = ARRAY_SIZE(clk_wzrd->clkout);
563 of_clk_add_provider(np, of_clk_src_onecell_get, &clk_wzrd->clk_data);
565 if (clk_wzrd->speed_grade) {
566 clk_wzrd->nb.notifier_call = clk_wzrd_clk_notifier;
568 ret = clk_notifier_register(clk_wzrd->clk_in1,
572 "unable to register clock notifier\n");
574 ret = clk_notifier_register(clk_wzrd->axi_clk, &clk_wzrd->nb);
577 "unable to register clock notifier\n");
583 clk_unregister(clk_wzrd->clks_internal[1]);
586 clk_unregister(clk_wzrd->clks_internal[0]);
588 clk_disable_unprepare(clk_wzrd->axi_clk);
593 static int clk_wzrd_remove(struct platform_device *pdev)
596 struct clk_wzrd *clk_wzrd = platform_get_drvdata(pdev);
598 of_clk_del_provider(pdev->dev.of_node);
600 for (i = 0; i < WZRD_NUM_OUTPUTS; i++)
601 clk_unregister(clk_wzrd->clkout[i]);
602 for (i = 0; i < wzrd_clk_int_max; i++)
603 clk_unregister(clk_wzrd->clks_internal[i]);
605 if (clk_wzrd->speed_grade) {
606 clk_notifier_unregister(clk_wzrd->axi_clk, &clk_wzrd->nb);
607 clk_notifier_unregister(clk_wzrd->clk_in1, &clk_wzrd->nb);
610 clk_disable_unprepare(clk_wzrd->axi_clk);
615 static const struct of_device_id clk_wzrd_ids[] = {
616 { .compatible = "xlnx,clocking-wizard" },
619 MODULE_DEVICE_TABLE(of, clk_wzrd_ids);
621 static struct platform_driver clk_wzrd_driver = {
623 .name = "clk-wizard",
624 .of_match_table = clk_wzrd_ids,
625 .pm = &clk_wzrd_dev_pm_ops,
627 .probe = clk_wzrd_probe,
628 .remove = clk_wzrd_remove,
630 module_platform_driver(clk_wzrd_driver);
632 MODULE_LICENSE("GPL");
633 MODULE_AUTHOR("Soeren Brinkmann <soren.brinkmann@xilinx.com");
634 MODULE_DESCRIPTION("Driver for the Xilinx Clocking Wizard IP core");