1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries
7 * Based on sam9x60.c on Linux.
10 #include <clk-uclass.h>
12 #include <dt-bindings/clk/at91.h>
13 #include <linux/clk-provider.h>
18 * Clock identifiers to be used in conjunction with macros like
21 * @ID_MD_SLCK: TD slow clock identifier
22 * @ID_TD_SLCK: MD slow clock identifier
23 * @ID_MAIN_XTAL: Main Xtal clock identifier
24 * @ID_MAIN_RC: Main RC clock identifier
25 * @ID_MAIN_RC_OSC: Main RC Oscillator clock identifier
26 * @ID_MAIN_OSC: Main Oscillator clock identifier
27 * @ID_MAINCK: MAINCK clock identifier
28 * @ID_PLL_U_FRAC: UPLL fractional clock identifier
29 * @ID_PLL_U_DIV: UPLL divider clock identifier
30 * @ID_PLL_A_FRAC: APLL fractional clock identifier
31 * @ID_PLL_A_DIV: APLL divider clock identifier
33 * @ID_MCK_DIV: MCK DIV clock identifier
35 * @ID_UTMI: UTMI clock identifier
37 * @ID_PROG0: Programmable 0 clock identifier
38 * @ID_PROG1: Programmable 1 clock identifier
40 * @ID_PCK0: PCK0 system clock identifier
41 * @ID_PCK1: PCK1 system clock identifier
42 * @ID_DDR: DDR system clock identifier
43 * @ID_QSPI: QSPI system clock identifier
45 * @ID_MCK_PRES: MCK PRES clock identifier
47 * Note: if changing the values of this enums please sync them with
85 * PLL type identifiers
86 * @PLL_TYPE_FRAC: fractional PLL identifier
87 * @PLL_TYPE_DIV: divider PLL identifier
94 /* Clock names used as parents for multiple clocks. */
95 static const char *clk_names[] = {
96 [ID_MAIN_RC_OSC] = "main_rc_osc",
97 [ID_MAIN_OSC] = "main_osc",
98 [ID_MAINCK] = "mainck",
99 [ID_PLL_U_DIV] = "upll_divpmcck",
100 [ID_PLL_A_DIV] = "plla_divpmcck",
101 [ID_MCK_PRES] = "mck_pres",
102 [ID_MCK_DIV] = "mck_div",
103 [ID_USBCK] = "usbck",
106 /* Fractional PLL output range. */
107 static const struct clk_range plla_outputs[] = {
108 { .min = 2343750, .max = 1200000000 },
111 static const struct clk_range upll_outputs[] = {
112 { .min = 300000000, .max = 500000000 },
115 /* PLL characteristics. */
116 static const struct clk_pll_characteristics apll_characteristics = {
117 .input = { .min = 12000000, .max = 48000000 },
118 .num_output = ARRAY_SIZE(plla_outputs),
119 .output = plla_outputs,
122 static const struct clk_pll_characteristics upll_characteristics = {
123 .input = { .min = 12000000, .max = 48000000 },
124 .num_output = ARRAY_SIZE(upll_outputs),
125 .output = upll_outputs,
129 /* Layout for fractional PLLs. */
130 static const struct clk_pll_layout pll_layout_frac = {
131 .mul_mask = GENMASK(31, 24),
132 .frac_mask = GENMASK(21, 0),
137 /* Layout for DIV PLLs. */
138 static const struct clk_pll_layout pll_layout_div = {
139 .div_mask = GENMASK(7, 0),
140 .endiv_mask = BIT(29),
145 /* MCK characteristics. */
146 static const struct clk_master_characteristics mck_characteristics = {
147 .output = { .min = 140000000, .max = 200000000 },
148 .divisors = { 1, 2, 4, 3 },
153 static const struct clk_master_layout mck_layout = {
159 /* Programmable clock layout. */
160 static const struct clk_programmable_layout programmable_layout = {
168 /* Peripheral clock layout. */
169 static const struct clk_pcr_layout pcr_layout = {
172 .gckcss_mask = GENMASK(12, 8),
173 .pid_mask = GENMASK(6, 0),
176 /* USB clock layout */
177 static const struct clk_usbck_layout usbck_layout = {
179 .usbs_mask = GENMASK(1, 0),
180 .usbdiv_mask = GENMASK(11, 8),
184 * PLL clocks description
189 * @f: true if clock is fixed and not changeable by driver
190 * @id: clock id corresponding to PLL driver
191 * @cid: clock id corresponding to clock subsystem
193 static const struct {
196 const struct clk_pll_layout *l;
197 const struct clk_pll_characteristics *c;
206 .l = &pll_layout_frac,
207 .c = &apll_characteristics,
211 .cid = ID_PLL_A_FRAC,
215 .n = "plla_divpmcck",
217 .l = &pll_layout_div,
218 .c = &apll_characteristics,
228 .l = &pll_layout_frac,
229 .c = &upll_characteristics,
233 .cid = ID_PLL_U_FRAC,
237 .n = "upll_divpmcck",
239 .l = &pll_layout_div,
240 .c = &upll_characteristics,
249 * Programmable clock description
251 * @cid: clock id corresponding to clock subsystem
253 static const struct {
257 { .n = "prog0", .cid = ID_PROG0, },
258 { .n = "prog1", .cid = ID_PROG1, },
261 /* Mux table for programmable clocks. */
262 static u32 sam9x60_prog_mux_table[] = { 0, 1, 2, 3, 4, 5, };
265 * System clock description
267 * @p: parent clock name
268 * @id: clock id corresponding to system clock driver
269 * @cid: clock id corresponding to clock subsystem
271 static const struct {
276 } sam9x60_systemck[] = {
277 { .n = "ddrck", .p = "mck_div", .id = 2, .cid = ID_DDR, },
278 { .n = "uhpck", .p = "usbck", .id = 6, .cid = ID_UHPCK },
279 { .n = "pck0", .p = "prog0", .id = 8, .cid = ID_PCK0, },
280 { .n = "pck1", .p = "prog1", .id = 9, .cid = ID_PCK1, },
281 { .n = "qspick", .p = "mck_div", .id = 19, .cid = ID_QSPI, },
285 * Peripheral clock description
289 static const struct {
292 } sam9x60_periphck[] = {
293 { .n = "pioA_clk", .id = 2, },
294 { .n = "pioB_clk", .id = 3, },
295 { .n = "pioC_clk", .id = 4, },
296 { .n = "flex0_clk", .id = 5, },
297 { .n = "flex1_clk", .id = 6, },
298 { .n = "flex2_clk", .id = 7, },
299 { .n = "flex3_clk", .id = 8, },
300 { .n = "flex6_clk", .id = 9, },
301 { .n = "flex7_clk", .id = 10, },
302 { .n = "flex8_clk", .id = 11, },
303 { .n = "sdmmc0_clk", .id = 12, },
304 { .n = "flex4_clk", .id = 13, },
305 { .n = "flex5_clk", .id = 14, },
306 { .n = "flex9_clk", .id = 15, },
307 { .n = "flex10_clk", .id = 16, },
308 { .n = "tcb0_clk", .id = 17, },
309 { .n = "pwm_clk", .id = 18, },
310 { .n = "adc_clk", .id = 19, },
311 { .n = "dma0_clk", .id = 20, },
312 { .n = "matrix_clk", .id = 21, },
313 { .n = "uhphs_clk", .id = 22, },
314 { .n = "udphs_clk", .id = 23, },
315 { .n = "macb0_clk", .id = 24, },
316 { .n = "lcd_clk", .id = 25, },
317 { .n = "sdmmc1_clk", .id = 26, },
318 { .n = "macb1_clk", .id = 27, },
319 { .n = "ssc_clk", .id = 28, },
320 { .n = "can0_clk", .id = 29, },
321 { .n = "can1_clk", .id = 30, },
322 { .n = "flex11_clk", .id = 32, },
323 { .n = "flex12_clk", .id = 33, },
324 { .n = "i2s_clk", .id = 34, },
325 { .n = "qspi_clk", .id = 35, },
326 { .n = "gfx2d_clk", .id = 36, },
327 { .n = "pit64b_clk", .id = 37, },
328 { .n = "trng_clk", .id = 38, },
329 { .n = "aes_clk", .id = 39, },
330 { .n = "tdes_clk", .id = 40, },
331 { .n = "sha_clk", .id = 41, },
332 { .n = "classd_clk", .id = 42, },
333 { .n = "isi_clk", .id = 43, },
334 { .n = "pioD_clk", .id = 44, },
335 { .n = "tcb1_clk", .id = 45, },
336 { .n = "dbgu_clk", .id = 47, },
337 { .n = "mpddr_clk", .id = 49, },
341 * Generic clock description
343 * @ep: extra parents parents names
344 * @ep_mux_table: extra parents mux table
345 * @ep_clk_mux_table: extra parents clock mux table (for CCF)
346 * @r: clock output range
347 * @ep_count: extra parents count
350 static const struct {
355 { .n = "flex0_gclk", .id = 5, },
356 { .n = "flex1_gclk", .id = 6, },
357 { .n = "flex2_gclk", .id = 7, },
358 { .n = "flex3_gclk", .id = 8, },
359 { .n = "flex6_gclk", .id = 9, },
360 { .n = "flex7_gclk", .id = 10, },
361 { .n = "flex8_gclk", .id = 11, },
362 { .n = "sdmmc0_gclk", .id = 12, .r = { .min = 0, .max = 105000000 }, },
363 { .n = "flex4_gclk", .id = 13, },
364 { .n = "flex5_gclk", .id = 14, },
365 { .n = "flex9_gclk", .id = 15, },
366 { .n = "flex10_gclk", .id = 16, },
367 { .n = "tcb0_gclk", .id = 17, },
368 { .n = "adc_gclk", .id = 19, },
369 { .n = "lcd_gclk", .id = 25, .r = { .min = 0, .max = 140000000 }, },
370 { .n = "sdmmc1_gclk", .id = 26, .r = { .min = 0, .max = 105000000 }, },
371 { .n = "flex11_gclk", .id = 32, },
372 { .n = "flex12_gclk", .id = 33, },
373 { .n = "i2s_gclk", .id = 34, .r = { .min = 0, .max = 105000000 }, },
374 { .n = "pit64b_gclk", .id = 37, },
375 { .n = "classd_gclk", .id = 42, .r = { .min = 0, .max = 100000000 }, },
376 { .n = "tcb1_gclk", .id = 45, },
377 { .n = "dbgu_gclk", .id = 47, },
381 * Clock setup description
382 * @cid: clock id corresponding to clock subsystem
383 * @pid: parent clock id corresponding to clock subsystem
385 * @prate: parent rate
387 static const struct pmc_clk_setup sam9x60_clk_setup[] = {
389 .cid = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_FRAC),
394 .cid = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_DIV),
399 .cid = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_USBCK),
400 .pid = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_DIV),
405 #define prepare_mux_table(_allocs, _index, _dst, _src, _num, _label) \
408 (_dst) = kzalloc(sizeof(*(_dst)) * (_num), GFP_KERNEL); \
413 (_allocs)[(_index)++] = (_dst); \
414 for (_i = 0; _i < (_num); _i++) \
415 (_dst)[_i] = (_src)[_i]; \
418 static int sam9x60_clk_probe(struct udevice *dev)
420 void __iomem *base = (void *)devfdt_get_addr_ptr(dev);
421 unsigned int *clkmuxallocs[64], *muxallocs[64];
423 unsigned int cm[10], m[10], *tmpclkmux, *tmpmux;
425 int ret, muxallocindex = 0, clkmuxallocindex = 0, i;
426 static const struct clk_range r = { 0, 0 };
431 memset(muxallocs, 0, sizeof(muxallocs));
432 memset(clkmuxallocs, 0, sizeof(clkmuxallocs));
434 ret = clk_get_by_index(dev, 0, &clk);
438 ret = clk_get_by_id(clk.id, &c);
442 clk_names[ID_TD_SLCK] = kmemdup(clk_hw_get_name(c),
443 strlen(clk_hw_get_name(c)) + 1,
445 if (!clk_names[ID_TD_SLCK])
448 ret = clk_get_by_index(dev, 1, &clk);
452 ret = clk_get_by_id(clk.id, &c);
456 clk_names[ID_MD_SLCK] = kmemdup(clk_hw_get_name(c),
457 strlen(clk_hw_get_name(c)) + 1,
459 if (!clk_names[ID_MD_SLCK])
462 ret = clk_get_by_index(dev, 2, &clk);
466 clk_names[ID_MAIN_XTAL] = kmemdup(clk_hw_get_name(&clk),
467 strlen(clk_hw_get_name(&clk)) + 1,
469 if (!clk_names[ID_MAIN_XTAL])
472 ret = clk_get_by_index(dev, 3, &clk);
476 clk_names[ID_MAIN_RC] = kmemdup(clk_hw_get_name(&clk),
477 strlen(clk_hw_get_name(&clk)) + 1,
482 /* Register main rc oscillator. */
483 c = at91_clk_main_rc(base, clk_names[ID_MAIN_RC_OSC],
484 clk_names[ID_MAIN_RC]);
489 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAIN_RC_OSC), c);
491 /* Register main oscillator. */
492 c = at91_clk_main_osc(base, clk_names[ID_MAIN_OSC],
493 clk_names[ID_MAIN_XTAL], false);
498 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAIN_OSC), c);
500 /* Register mainck. */
501 p[0] = clk_names[ID_MAIN_RC_OSC];
502 p[1] = clk_names[ID_MAIN_OSC];
503 cm[0] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAIN_RC_OSC);
504 cm[1] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAIN_OSC);
505 prepare_mux_table(clkmuxallocs, clkmuxallocindex, tmpclkmux, cm, 2,
507 c = at91_clk_sam9x5_main(base, clk_names[ID_MAINCK], p,
508 2, tmpclkmux, PMC_TYPE_CORE);
513 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAINCK), c);
515 /* Register PLL fracs clocks. */
516 for (i = 0; i < ARRAY_SIZE(sam9x60_plls); i++) {
517 if (sam9x60_plls[i].t != PLL_TYPE_FRAC)
520 c = sam9x60_clk_register_frac_pll(base, sam9x60_plls[i].n,
530 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, sam9x60_plls[i].cid), c);
533 /* Register PLL div clocks. */
534 for (i = 0; i < ARRAY_SIZE(sam9x60_plls); i++) {
535 if (sam9x60_plls[i].t != PLL_TYPE_DIV)
538 c = sam9x60_clk_register_div_pll(base, sam9x60_plls[i].n,
548 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, sam9x60_plls[i].cid), c);
551 /* Register MCK pres clock. */
552 p[0] = clk_names[ID_MD_SLCK];
553 p[1] = clk_names[ID_MAINCK];
554 p[2] = clk_names[ID_PLL_A_DIV];
555 p[3] = clk_names[ID_PLL_U_DIV];
556 cm[0] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MD_SLCK);
557 cm[1] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAINCK);
558 cm[2] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_A_DIV);
559 cm[3] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_DIV);
560 prepare_mux_table(clkmuxallocs, clkmuxallocindex, tmpclkmux, cm, 4,
562 c = at91_clk_register_master_pres(base, clk_names[ID_MCK_PRES], p, 4,
563 &mck_layout, &mck_characteristics,
569 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MCK_PRES), c);
571 /* Register MCK div clock. */
572 c = at91_clk_register_master_div(base, clk_names[ID_MCK_DIV],
573 clk_names[ID_MCK_PRES],
574 &mck_layout, &mck_characteristics);
579 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MCK_DIV), c);
581 /* Register usbck. */
582 p[0] = clk_names[ID_PLL_A_DIV];
583 p[1] = clk_names[ID_PLL_U_DIV];
584 p[2] = clk_names[ID_MAIN_XTAL];
588 cm[0] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_A_DIV);
589 cm[1] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_DIV);
590 cm[2] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAIN_XTAL);
591 prepare_mux_table(clkmuxallocs, clkmuxallocindex, tmpclkmux, cm,
593 prepare_mux_table(muxallocs, muxallocindex, tmpmux, m, 3, fail);
594 c = sam9x60_clk_register_usb(base, clk_names[ID_USBCK], p, 3,
595 &usbck_layout, tmpclkmux, tmpmux,
601 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_USBCK), c);
603 /* Register programmable clocks. */
604 p[0] = clk_names[ID_MD_SLCK];
605 p[1] = clk_names[ID_TD_SLCK];
606 p[2] = clk_names[ID_MAINCK];
607 p[3] = clk_names[ID_MCK_DIV];
608 p[4] = clk_names[ID_PLL_A_DIV];
609 p[5] = clk_names[ID_PLL_U_DIV];
610 cm[0] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MD_SLCK);
611 cm[1] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_TD_SLCK);
612 cm[2] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAINCK);
613 cm[3] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MCK_DIV);
614 cm[4] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_A_DIV);
615 cm[5] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_DIV);
616 for (i = 0; i < ARRAY_SIZE(sam9x60_prog); i++) {
617 prepare_mux_table(clkmuxallocs, clkmuxallocindex, tmpclkmux, cm,
620 c = at91_clk_register_programmable(base, sam9x60_prog[i].n, p,
621 10, i, &programmable_layout,
623 sam9x60_prog_mux_table);
628 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_CORE, sam9x60_prog[i].cid), c);
632 for (i = 0; i < ARRAY_SIZE(sam9x60_systemck); i++) {
633 c = at91_clk_register_system(base, sam9x60_systemck[i].n,
634 sam9x60_systemck[i].p,
635 sam9x60_systemck[i].id);
640 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_SYSTEM, sam9x60_systemck[i].cid),
644 /* Peripheral clocks. */
645 for (i = 0; i < ARRAY_SIZE(sam9x60_periphck); i++) {
646 c = at91_clk_register_sam9x5_peripheral(base, &pcr_layout,
647 sam9x60_periphck[i].n,
648 clk_names[ID_MCK_DIV],
649 sam9x60_periphck[i].id,
655 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_PERIPHERAL,
656 sam9x60_periphck[i].id), c);
659 /* Generic clocks. */
660 p[0] = clk_names[ID_MD_SLCK];
661 p[1] = clk_names[ID_TD_SLCK];
662 p[2] = clk_names[ID_MAINCK];
663 p[3] = clk_names[ID_MCK_DIV];
664 p[4] = clk_names[ID_PLL_A_DIV];
665 p[5] = clk_names[ID_PLL_U_DIV];
672 cm[0] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MD_SLCK);
673 cm[1] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_TD_SLCK);
674 cm[2] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MAINCK);
675 cm[3] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_MCK_DIV);
676 cm[4] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_A_DIV);
677 cm[5] = AT91_TO_CLK_ID(PMC_TYPE_CORE, ID_PLL_U_DIV);
678 for (i = 0; i < ARRAY_SIZE(sam9x60_gck); i++) {
679 prepare_mux_table(clkmuxallocs, clkmuxallocindex, tmpclkmux, cm,
681 prepare_mux_table(muxallocs, muxallocindex, tmpmux, m,
684 c = at91_clk_register_generic(base, &pcr_layout,
685 sam9x60_gck[i].n, p, tmpclkmux,
686 tmpmux, 6, sam9x60_gck[i].id,
692 clk_dm(AT91_TO_CLK_ID(PMC_TYPE_GCK, sam9x60_gck[i].id), c);
696 ret = at91_clk_setup(sam9x60_clk_setup, ARRAY_SIZE(sam9x60_clk_setup));
703 for (i = 0; i < ARRAY_SIZE(muxallocs); i++)
706 for (i = 0; i < ARRAY_SIZE(clkmuxallocs); i++)
707 kfree(clkmuxallocs[i]);
712 static const struct udevice_id sam9x60_clk_ids[] = {
713 { .compatible = "microchip,sam9x60-pmc" },
717 U_BOOT_DRIVER(at91_sam9x60_pmc) = {
718 .name = "at91-sam9x60-pmc",
720 .of_match = sam9x60_clk_ids,
721 .ops = &at91_clk_ops,
722 .probe = sam9x60_clk_probe,
723 .flags = DM_FLAG_PRE_RELOC,