1 // SPDX-License-Identifier: GPL-2.0-only
3 * TI CDCE706 programmable 3-PLL clock synthesizer driver
5 * Copyright (c) 2014 Cadence Design Systems Inc.
7 * Reference: https://www.ti.com/lit/ds/symlink/cdce706.pdf
10 #include <linux/clk.h>
11 #include <linux/clk-provider.h>
12 #include <linux/delay.h>
13 #include <linux/i2c.h>
14 #include <linux/interrupt.h>
15 #include <linux/mod_devicetable.h>
16 #include <linux/module.h>
18 #include <linux/rational.h>
19 #include <linux/regmap.h>
20 #include <linux/slab.h>
22 #define CDCE706_CLKIN_CLOCK 10
23 #define CDCE706_CLKIN_SOURCE 11
24 #define CDCE706_PLL_M_LOW(pll) (1 + 3 * (pll))
25 #define CDCE706_PLL_N_LOW(pll) (2 + 3 * (pll))
26 #define CDCE706_PLL_HI(pll) (3 + 3 * (pll))
27 #define CDCE706_PLL_MUX 3
28 #define CDCE706_PLL_FVCO 6
29 #define CDCE706_DIVIDER(div) (13 + (div))
30 #define CDCE706_CLKOUT(out) (19 + (out))
32 #define CDCE706_CLKIN_CLOCK_MASK 0x10
33 #define CDCE706_CLKIN_SOURCE_SHIFT 6
34 #define CDCE706_CLKIN_SOURCE_MASK 0xc0
35 #define CDCE706_CLKIN_SOURCE_LVCMOS 0x40
37 #define CDCE706_PLL_MUX_MASK(pll) (0x80 >> (pll))
38 #define CDCE706_PLL_LOW_M_MASK 0xff
39 #define CDCE706_PLL_LOW_N_MASK 0xff
40 #define CDCE706_PLL_HI_M_MASK 0x1
41 #define CDCE706_PLL_HI_N_MASK 0x1e
42 #define CDCE706_PLL_HI_N_SHIFT 1
43 #define CDCE706_PLL_M_MAX 0x1ff
44 #define CDCE706_PLL_N_MAX 0xfff
45 #define CDCE706_PLL_FVCO_MASK(pll) (0x80 >> (pll))
46 #define CDCE706_PLL_FREQ_MIN 80000000
47 #define CDCE706_PLL_FREQ_MAX 300000000
48 #define CDCE706_PLL_FREQ_HI 180000000
50 #define CDCE706_DIVIDER_PLL(div) (9 + (div) - ((div) > 2) - ((div) > 4))
51 #define CDCE706_DIVIDER_PLL_SHIFT(div) ((div) < 2 ? 5 : 3 * ((div) & 1))
52 #define CDCE706_DIVIDER_PLL_MASK(div) (0x7 << CDCE706_DIVIDER_PLL_SHIFT(div))
53 #define CDCE706_DIVIDER_DIVIDER_MASK 0x7f
54 #define CDCE706_DIVIDER_DIVIDER_MAX 0x7f
56 #define CDCE706_CLKOUT_DIVIDER_MASK 0x7
57 #define CDCE706_CLKOUT_ENABLE_MASK 0x8
59 static const struct regmap_config cdce706_regmap_config
= {
62 .val_format_endian
= REGMAP_ENDIAN_NATIVE
,
65 #define to_hw_data(phw) (container_of((phw), struct cdce706_hw_data, hw))
67 struct cdce706_hw_data
{
68 struct cdce706_dev_data
*dev_data
;
77 struct cdce706_dev_data
{
78 struct i2c_client
*client
;
79 struct regmap
*regmap
;
80 struct clk
*clkin_clk
[2];
81 const char *clkin_name
[2];
82 struct cdce706_hw_data clkin
[1];
83 struct cdce706_hw_data pll
[3];
84 struct cdce706_hw_data divider
[6];
85 struct cdce706_hw_data clkout
[6];
88 static const char * const cdce706_source_name
[] = {
92 static const char * const cdce706_clkin_name
[] = {
96 static const char * const cdce706_pll_name
[] = {
97 "pll1", "pll2", "pll3",
100 static const char * const cdce706_divider_parent_name
[] = {
101 "clk_in", "pll1", "pll2", "pll2", "pll3",
104 static const char *cdce706_divider_name
[] = {
105 "p0", "p1", "p2", "p3", "p4", "p5",
108 static const char * const cdce706_clkout_name
[] = {
109 "clk_out0", "clk_out1", "clk_out2", "clk_out3", "clk_out4", "clk_out5",
112 static int cdce706_reg_read(struct cdce706_dev_data
*dev_data
, unsigned reg
,
115 int rc
= regmap_read(dev_data
->regmap
, reg
| 0x80, val
);
118 dev_err(&dev_data
->client
->dev
, "error reading reg %u", reg
);
122 static int cdce706_reg_write(struct cdce706_dev_data
*dev_data
, unsigned reg
,
125 int rc
= regmap_write(dev_data
->regmap
, reg
| 0x80, val
);
128 dev_err(&dev_data
->client
->dev
, "error writing reg %u", reg
);
132 static int cdce706_reg_update(struct cdce706_dev_data
*dev_data
, unsigned reg
,
133 unsigned mask
, unsigned val
)
135 int rc
= regmap_update_bits(dev_data
->regmap
, reg
| 0x80, mask
, val
);
138 dev_err(&dev_data
->client
->dev
, "error updating reg %u", reg
);
142 static int cdce706_clkin_set_parent(struct clk_hw
*hw
, u8 index
)
144 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
150 static u8
cdce706_clkin_get_parent(struct clk_hw
*hw
)
152 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
157 static const struct clk_ops cdce706_clkin_ops
= {
158 .set_parent
= cdce706_clkin_set_parent
,
159 .get_parent
= cdce706_clkin_get_parent
,
162 static unsigned long cdce706_pll_recalc_rate(struct clk_hw
*hw
,
163 unsigned long parent_rate
)
165 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
167 dev_dbg(&hwd
->dev_data
->client
->dev
,
168 "%s, pll: %d, mux: %d, mul: %u, div: %u\n",
169 __func__
, hwd
->idx
, hwd
->mux
, hwd
->mul
, hwd
->div
);
172 if (hwd
->div
&& hwd
->mul
) {
173 u64 res
= (u64
)parent_rate
* hwd
->mul
;
175 do_div(res
, hwd
->div
);
180 return parent_rate
/ hwd
->div
;
185 static long cdce706_pll_round_rate(struct clk_hw
*hw
, unsigned long rate
,
186 unsigned long *parent_rate
)
188 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
189 unsigned long mul
, div
;
192 dev_dbg(&hwd
->dev_data
->client
->dev
,
193 "%s, rate: %lu, parent_rate: %lu\n",
194 __func__
, rate
, *parent_rate
);
196 rational_best_approximation(rate
, *parent_rate
,
197 CDCE706_PLL_N_MAX
, CDCE706_PLL_M_MAX
,
202 dev_dbg(&hwd
->dev_data
->client
->dev
,
203 "%s, pll: %d, mul: %lu, div: %lu\n",
204 __func__
, hwd
->idx
, mul
, div
);
206 res
= (u64
)*parent_rate
* hwd
->mul
;
207 do_div(res
, hwd
->div
);
211 static int cdce706_pll_set_rate(struct clk_hw
*hw
, unsigned long rate
,
212 unsigned long parent_rate
)
214 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
215 unsigned long mul
= hwd
->mul
, div
= hwd
->div
;
218 dev_dbg(&hwd
->dev_data
->client
->dev
,
219 "%s, pll: %d, mul: %lu, div: %lu\n",
220 __func__
, hwd
->idx
, mul
, div
);
222 err
= cdce706_reg_update(hwd
->dev_data
,
223 CDCE706_PLL_HI(hwd
->idx
),
224 CDCE706_PLL_HI_M_MASK
| CDCE706_PLL_HI_N_MASK
,
225 ((div
>> 8) & CDCE706_PLL_HI_M_MASK
) |
226 ((mul
>> (8 - CDCE706_PLL_HI_N_SHIFT
)) &
227 CDCE706_PLL_HI_N_MASK
));
231 err
= cdce706_reg_write(hwd
->dev_data
,
232 CDCE706_PLL_M_LOW(hwd
->idx
),
233 div
& CDCE706_PLL_LOW_M_MASK
);
237 err
= cdce706_reg_write(hwd
->dev_data
,
238 CDCE706_PLL_N_LOW(hwd
->idx
),
239 mul
& CDCE706_PLL_LOW_N_MASK
);
243 err
= cdce706_reg_update(hwd
->dev_data
,
245 CDCE706_PLL_FVCO_MASK(hwd
->idx
),
246 rate
> CDCE706_PLL_FREQ_HI
?
247 CDCE706_PLL_FVCO_MASK(hwd
->idx
) : 0);
251 static const struct clk_ops cdce706_pll_ops
= {
252 .recalc_rate
= cdce706_pll_recalc_rate
,
253 .round_rate
= cdce706_pll_round_rate
,
254 .set_rate
= cdce706_pll_set_rate
,
257 static int cdce706_divider_set_parent(struct clk_hw
*hw
, u8 index
)
259 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
261 if (hwd
->parent
== index
)
264 return cdce706_reg_update(hwd
->dev_data
,
265 CDCE706_DIVIDER_PLL(hwd
->idx
),
266 CDCE706_DIVIDER_PLL_MASK(hwd
->idx
),
267 index
<< CDCE706_DIVIDER_PLL_SHIFT(hwd
->idx
));
270 static u8
cdce706_divider_get_parent(struct clk_hw
*hw
)
272 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
277 static unsigned long cdce706_divider_recalc_rate(struct clk_hw
*hw
,
278 unsigned long parent_rate
)
280 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
282 dev_dbg(&hwd
->dev_data
->client
->dev
,
283 "%s, divider: %d, div: %u\n",
284 __func__
, hwd
->idx
, hwd
->div
);
286 return parent_rate
/ hwd
->div
;
290 static long cdce706_divider_round_rate(struct clk_hw
*hw
, unsigned long rate
,
291 unsigned long *parent_rate
)
293 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
294 struct cdce706_dev_data
*cdce
= hwd
->dev_data
;
295 unsigned long mul
, div
;
297 dev_dbg(&hwd
->dev_data
->client
->dev
,
298 "%s, rate: %lu, parent_rate: %lu\n",
299 __func__
, rate
, *parent_rate
);
301 rational_best_approximation(rate
, *parent_rate
,
302 1, CDCE706_DIVIDER_DIVIDER_MAX
,
305 div
= CDCE706_DIVIDER_DIVIDER_MAX
;
307 if (clk_hw_get_flags(hw
) & CLK_SET_RATE_PARENT
) {
308 unsigned long best_diff
= rate
;
309 unsigned long best_div
= 0;
310 struct clk
*gp_clk
= cdce
->clkin_clk
[cdce
->clkin
[0].parent
];
311 unsigned long gp_rate
= gp_clk
? clk_get_rate(gp_clk
) : 0;
313 for (div
= CDCE706_PLL_FREQ_MIN
/ rate
; best_diff
&&
314 div
<= CDCE706_PLL_FREQ_MAX
/ rate
; ++div
) {
317 unsigned long div_rate
;
320 if (rate
* div
< CDCE706_PLL_FREQ_MIN
)
323 rational_best_approximation(rate
* div
, gp_rate
,
327 div_rate64
= (u64
)gp_rate
* n
;
328 do_div(div_rate64
, m
);
329 do_div(div_rate64
, div
);
330 div_rate
= div_rate64
;
331 diff
= max(div_rate
, rate
) - min(div_rate
, rate
);
333 if (diff
< best_diff
) {
336 dev_dbg(&hwd
->dev_data
->client
->dev
,
337 "%s, %lu * %lu / %lu / %lu = %lu\n",
338 __func__
, gp_rate
, n
, m
, div
, div_rate
);
344 dev_dbg(&hwd
->dev_data
->client
->dev
,
345 "%s, altering parent rate: %lu -> %lu\n",
346 __func__
, *parent_rate
, rate
* div
);
347 *parent_rate
= rate
* div
;
351 dev_dbg(&hwd
->dev_data
->client
->dev
,
352 "%s, divider: %d, div: %lu\n",
353 __func__
, hwd
->idx
, div
);
355 return *parent_rate
/ div
;
358 static int cdce706_divider_set_rate(struct clk_hw
*hw
, unsigned long rate
,
359 unsigned long parent_rate
)
361 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
363 dev_dbg(&hwd
->dev_data
->client
->dev
,
364 "%s, divider: %d, div: %u\n",
365 __func__
, hwd
->idx
, hwd
->div
);
367 return cdce706_reg_update(hwd
->dev_data
,
368 CDCE706_DIVIDER(hwd
->idx
),
369 CDCE706_DIVIDER_DIVIDER_MASK
,
373 static const struct clk_ops cdce706_divider_ops
= {
374 .set_parent
= cdce706_divider_set_parent
,
375 .get_parent
= cdce706_divider_get_parent
,
376 .recalc_rate
= cdce706_divider_recalc_rate
,
377 .round_rate
= cdce706_divider_round_rate
,
378 .set_rate
= cdce706_divider_set_rate
,
381 static int cdce706_clkout_prepare(struct clk_hw
*hw
)
383 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
385 return cdce706_reg_update(hwd
->dev_data
, CDCE706_CLKOUT(hwd
->idx
),
386 CDCE706_CLKOUT_ENABLE_MASK
,
387 CDCE706_CLKOUT_ENABLE_MASK
);
390 static void cdce706_clkout_unprepare(struct clk_hw
*hw
)
392 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
394 cdce706_reg_update(hwd
->dev_data
, CDCE706_CLKOUT(hwd
->idx
),
395 CDCE706_CLKOUT_ENABLE_MASK
, 0);
398 static int cdce706_clkout_set_parent(struct clk_hw
*hw
, u8 index
)
400 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
402 if (hwd
->parent
== index
)
405 return cdce706_reg_update(hwd
->dev_data
,
406 CDCE706_CLKOUT(hwd
->idx
),
407 CDCE706_CLKOUT_ENABLE_MASK
, index
);
410 static u8
cdce706_clkout_get_parent(struct clk_hw
*hw
)
412 struct cdce706_hw_data
*hwd
= to_hw_data(hw
);
417 static unsigned long cdce706_clkout_recalc_rate(struct clk_hw
*hw
,
418 unsigned long parent_rate
)
423 static long cdce706_clkout_round_rate(struct clk_hw
*hw
, unsigned long rate
,
424 unsigned long *parent_rate
)
430 static int cdce706_clkout_set_rate(struct clk_hw
*hw
, unsigned long rate
,
431 unsigned long parent_rate
)
436 static const struct clk_ops cdce706_clkout_ops
= {
437 .prepare
= cdce706_clkout_prepare
,
438 .unprepare
= cdce706_clkout_unprepare
,
439 .set_parent
= cdce706_clkout_set_parent
,
440 .get_parent
= cdce706_clkout_get_parent
,
441 .recalc_rate
= cdce706_clkout_recalc_rate
,
442 .round_rate
= cdce706_clkout_round_rate
,
443 .set_rate
= cdce706_clkout_set_rate
,
446 static int cdce706_register_hw(struct cdce706_dev_data
*cdce
,
447 struct cdce706_hw_data
*hw
, unsigned num_hw
,
448 const char * const *clk_names
,
449 struct clk_init_data
*init
)
454 for (i
= 0; i
< num_hw
; ++i
, ++hw
) {
455 init
->name
= clk_names
[i
];
459 ret
= devm_clk_hw_register(&cdce
->client
->dev
,
462 dev_err(&cdce
->client
->dev
, "Failed to register %s\n",
470 static int cdce706_register_clkin(struct cdce706_dev_data
*cdce
)
472 struct clk_init_data init
= {
473 .ops
= &cdce706_clkin_ops
,
474 .parent_names
= cdce
->clkin_name
,
475 .num_parents
= ARRAY_SIZE(cdce
->clkin_name
),
479 unsigned clock
, source
;
481 for (i
= 0; i
< ARRAY_SIZE(cdce
->clkin_name
); ++i
) {
482 struct clk
*parent
= devm_clk_get(&cdce
->client
->dev
,
483 cdce706_source_name
[i
]);
485 if (IS_ERR(parent
)) {
486 cdce
->clkin_name
[i
] = cdce706_source_name
[i
];
488 cdce
->clkin_name
[i
] = __clk_get_name(parent
);
489 cdce
->clkin_clk
[i
] = parent
;
493 ret
= cdce706_reg_read(cdce
, CDCE706_CLKIN_SOURCE
, &source
);
496 if ((source
& CDCE706_CLKIN_SOURCE_MASK
) ==
497 CDCE706_CLKIN_SOURCE_LVCMOS
) {
498 ret
= cdce706_reg_read(cdce
, CDCE706_CLKIN_CLOCK
, &clock
);
501 cdce
->clkin
[0].parent
= !!(clock
& CDCE706_CLKIN_CLOCK_MASK
);
504 ret
= cdce706_register_hw(cdce
, cdce
->clkin
,
505 ARRAY_SIZE(cdce
->clkin
),
506 cdce706_clkin_name
, &init
);
510 static int cdce706_register_plls(struct cdce706_dev_data
*cdce
)
512 struct clk_init_data init
= {
513 .ops
= &cdce706_pll_ops
,
514 .parent_names
= cdce706_clkin_name
,
515 .num_parents
= ARRAY_SIZE(cdce706_clkin_name
),
521 ret
= cdce706_reg_read(cdce
, CDCE706_PLL_MUX
, &mux
);
525 for (i
= 0; i
< ARRAY_SIZE(cdce
->pll
); ++i
) {
528 ret
= cdce706_reg_read(cdce
, CDCE706_PLL_M_LOW(i
), &m
);
531 ret
= cdce706_reg_read(cdce
, CDCE706_PLL_N_LOW(i
), &n
);
534 ret
= cdce706_reg_read(cdce
, CDCE706_PLL_HI(i
), &v
);
537 cdce
->pll
[i
].div
= m
| ((v
& CDCE706_PLL_HI_M_MASK
) << 8);
538 cdce
->pll
[i
].mul
= n
| ((v
& CDCE706_PLL_HI_N_MASK
) <<
539 (8 - CDCE706_PLL_HI_N_SHIFT
));
540 cdce
->pll
[i
].mux
= mux
& CDCE706_PLL_MUX_MASK(i
);
541 dev_dbg(&cdce
->client
->dev
,
542 "%s: i: %u, div: %u, mul: %u, mux: %d\n", __func__
, i
,
543 cdce
->pll
[i
].div
, cdce
->pll
[i
].mul
, cdce
->pll
[i
].mux
);
546 ret
= cdce706_register_hw(cdce
, cdce
->pll
,
547 ARRAY_SIZE(cdce
->pll
),
548 cdce706_pll_name
, &init
);
552 static int cdce706_register_dividers(struct cdce706_dev_data
*cdce
)
554 struct clk_init_data init
= {
555 .ops
= &cdce706_divider_ops
,
556 .parent_names
= cdce706_divider_parent_name
,
557 .num_parents
= ARRAY_SIZE(cdce706_divider_parent_name
),
558 .flags
= CLK_SET_RATE_PARENT
,
563 for (i
= 0; i
< ARRAY_SIZE(cdce
->divider
); ++i
) {
566 ret
= cdce706_reg_read(cdce
, CDCE706_DIVIDER_PLL(i
), &val
);
569 cdce
->divider
[i
].parent
=
570 (val
& CDCE706_DIVIDER_PLL_MASK(i
)) >>
571 CDCE706_DIVIDER_PLL_SHIFT(i
);
573 ret
= cdce706_reg_read(cdce
, CDCE706_DIVIDER(i
), &val
);
576 cdce
->divider
[i
].div
= val
& CDCE706_DIVIDER_DIVIDER_MASK
;
577 dev_dbg(&cdce
->client
->dev
,
578 "%s: i: %u, parent: %u, div: %u\n", __func__
, i
,
579 cdce
->divider
[i
].parent
, cdce
->divider
[i
].div
);
582 ret
= cdce706_register_hw(cdce
, cdce
->divider
,
583 ARRAY_SIZE(cdce
->divider
),
584 cdce706_divider_name
, &init
);
588 static int cdce706_register_clkouts(struct cdce706_dev_data
*cdce
)
590 struct clk_init_data init
= {
591 .ops
= &cdce706_clkout_ops
,
592 .parent_names
= cdce706_divider_name
,
593 .num_parents
= ARRAY_SIZE(cdce706_divider_name
),
594 .flags
= CLK_SET_RATE_PARENT
,
599 for (i
= 0; i
< ARRAY_SIZE(cdce
->clkout
); ++i
) {
602 ret
= cdce706_reg_read(cdce
, CDCE706_CLKOUT(i
), &val
);
605 cdce
->clkout
[i
].parent
= val
& CDCE706_CLKOUT_DIVIDER_MASK
;
606 dev_dbg(&cdce
->client
->dev
,
607 "%s: i: %u, parent: %u\n", __func__
, i
,
608 cdce
->clkout
[i
].parent
);
611 return cdce706_register_hw(cdce
, cdce
->clkout
,
612 ARRAY_SIZE(cdce
->clkout
),
613 cdce706_clkout_name
, &init
);
616 static struct clk_hw
*
617 of_clk_cdce_get(struct of_phandle_args
*clkspec
, void *data
)
619 struct cdce706_dev_data
*cdce
= data
;
620 unsigned int idx
= clkspec
->args
[0];
622 if (idx
>= ARRAY_SIZE(cdce
->clkout
)) {
623 pr_err("%s: invalid index %u\n", __func__
, idx
);
624 return ERR_PTR(-EINVAL
);
627 return &cdce
->clkout
[idx
].hw
;
630 static int cdce706_probe(struct i2c_client
*client
,
631 const struct i2c_device_id
*id
)
633 struct i2c_adapter
*adapter
= client
->adapter
;
634 struct cdce706_dev_data
*cdce
;
637 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
))
640 cdce
= devm_kzalloc(&client
->dev
, sizeof(*cdce
), GFP_KERNEL
);
644 cdce
->client
= client
;
645 cdce
->regmap
= devm_regmap_init_i2c(client
, &cdce706_regmap_config
);
646 if (IS_ERR(cdce
->regmap
)) {
647 dev_err(&client
->dev
, "Failed to initialize regmap\n");
651 i2c_set_clientdata(client
, cdce
);
653 ret
= cdce706_register_clkin(cdce
);
656 ret
= cdce706_register_plls(cdce
);
659 ret
= cdce706_register_dividers(cdce
);
662 ret
= cdce706_register_clkouts(cdce
);
665 return of_clk_add_hw_provider(client
->dev
.of_node
, of_clk_cdce_get
,
669 static int cdce706_remove(struct i2c_client
*client
)
671 of_clk_del_provider(client
->dev
.of_node
);
677 static const struct of_device_id cdce706_dt_match
[] = {
678 { .compatible
= "ti,cdce706" },
681 MODULE_DEVICE_TABLE(of
, cdce706_dt_match
);
684 static const struct i2c_device_id cdce706_id
[] = {
688 MODULE_DEVICE_TABLE(i2c
, cdce706_id
);
690 static struct i2c_driver cdce706_i2c_driver
= {
693 .of_match_table
= of_match_ptr(cdce706_dt_match
),
695 .probe
= cdce706_probe
,
696 .remove
= cdce706_remove
,
697 .id_table
= cdce706_id
,
699 module_i2c_driver(cdce706_i2c_driver
);
701 MODULE_AUTHOR("Max Filippov <jcmvbkbc@gmail.com>");
702 MODULE_DESCRIPTION("TI CDCE 706 clock synthesizer driver");
703 MODULE_LICENSE("GPL");