2 * Copyright 2013 Emilio López
4 * Emilio López <emilio@elopez.com.ar>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include <linux/clk-provider.h>
18 #include <linux/clkdev.h>
20 #include <linux/of_address.h>
22 #include "clk-factors.h"
24 static DEFINE_SPINLOCK(clk_lock);
27 * sun4i_osc_clk_setup() - Setup function for gatable oscillator
30 #define SUNXI_OSC24M_GATE 0
32 static void __init sun4i_osc_clk_setup(struct device_node *node)
35 struct clk_fixed_rate *fixed;
36 struct clk_gate *gate;
37 const char *clk_name = node->name;
40 /* allocate fixed-rate and gate clock structs */
41 fixed = kzalloc(sizeof(struct clk_fixed_rate), GFP_KERNEL);
44 gate = kzalloc(sizeof(struct clk_gate), GFP_KERNEL);
50 if (of_property_read_u32(node, "clock-frequency", &rate))
53 /* set up gate and fixed rate properties */
54 gate->reg = of_iomap(node, 0);
55 gate->bit_idx = SUNXI_OSC24M_GATE;
56 gate->lock = &clk_lock;
57 fixed->fixed_rate = rate;
59 clk = clk_register_composite(NULL, clk_name,
62 &fixed->hw, &clk_fixed_rate_ops,
63 &gate->hw, &clk_gate_ops,
67 of_clk_add_provider(node, of_clk_src_simple_get, clk);
68 clk_register_clkdev(clk, clk_name, NULL);
71 CLK_OF_DECLARE(sun4i_osc, "allwinner,sun4i-osc-clk", sun4i_osc_clk_setup);
76 * sun4i_get_pll1_factors() - calculates n, k, m, p factors for PLL1
77 * PLL1 rate is calculated as follows
78 * rate = (parent_rate * n * (k + 1) >> p) / (m + 1);
79 * parent_rate is always 24Mhz
82 static void sun4i_get_pll1_factors(u32 *freq, u32 parent_rate,
83 u8 *n, u8 *k, u8 *m, u8 *p)
87 /* Normalize value to a 6M multiple */
88 div = *freq / 6000000;
89 *freq = 6000000 * div;
91 /* we were called to round the frequency, we can now return */
95 /* m is always zero for pll1 */
98 /* k is 1 only on these cases */
99 if (*freq >= 768000000 || *freq == 42000000 || *freq == 54000000)
104 /* p will be 3 for divs under 10 */
108 /* p will be 2 for divs between 10 - 20 and odd divs under 32 */
109 else if (div < 20 || (div < 32 && (div & 1)))
112 /* p will be 1 for even divs under 32, divs under 40 and odd pairs
113 * of divs between 40-62 */
114 else if (div < 40 || (div < 64 && (div & 2)))
117 /* any other entries have p = 0 */
121 /* calculate a suitable n based on k and p */
128 * sun6i_a31_get_pll1_factors() - calculates n, k and m factors for PLL1
129 * PLL1 rate is calculated as follows
130 * rate = parent_rate * (n + 1) * (k + 1) / (m + 1);
131 * parent_rate should always be 24MHz
133 static void sun6i_a31_get_pll1_factors(u32 *freq, u32 parent_rate,
134 u8 *n, u8 *k, u8 *m, u8 *p)
137 * We can operate only on MHz, this will make our life easier
140 u32 freq_mhz = *freq / 1000000;
141 u32 parent_freq_mhz = parent_rate / 1000000;
144 * Round down the frequency to the closest multiple of either
147 u32 round_freq_6 = round_down(freq_mhz, 6);
148 u32 round_freq_16 = round_down(freq_mhz, 16);
150 if (round_freq_6 > round_freq_16)
151 freq_mhz = round_freq_6;
153 freq_mhz = round_freq_16;
155 *freq = freq_mhz * 1000000;
158 * If the factors pointer are null, we were just called to
159 * round down the frequency.
165 /* If the frequency is a multiple of 32 MHz, k is always 3 */
166 if (!(freq_mhz % 32))
168 /* If the frequency is a multiple of 9 MHz, k is always 2 */
169 else if (!(freq_mhz % 9))
171 /* If the frequency is a multiple of 8 MHz, k is always 1 */
172 else if (!(freq_mhz % 8))
174 /* Otherwise, we don't use the k factor */
179 * If the frequency is a multiple of 2 but not a multiple of
180 * 3, m is 3. This is the first time we use 6 here, yet we
181 * will use it on several other places.
182 * We use this number because it's the lowest frequency we can
183 * generate (with n = 0, k = 0, m = 3), so every other frequency
184 * somehow relates to this frequency.
186 if ((freq_mhz % 6) == 2 || (freq_mhz % 6) == 4)
189 * If the frequency is a multiple of 6MHz, but the factor is
192 else if ((freq_mhz / 6) & 1)
194 /* Otherwise, we end up with m = 1 */
198 /* Calculate n thanks to the above factors we already got */
199 *n = freq_mhz * (*m + 1) / ((*k + 1) * parent_freq_mhz) - 1;
202 * If n end up being outbound, and that we can still decrease
205 if ((*n + 1) > 31 && (*m + 1) > 1) {
206 *n = (*n + 1) / 2 - 1;
207 *m = (*m + 1) / 2 - 1;
212 * sun4i_get_apb1_factors() - calculates m, p factors for APB1
213 * APB1 rate is calculated as follows
214 * rate = (parent_rate >> p) / (m + 1);
217 static void sun4i_get_apb1_factors(u32 *freq, u32 parent_rate,
218 u8 *n, u8 *k, u8 *m, u8 *p)
222 if (parent_rate < *freq)
225 parent_rate = (parent_rate + (*freq - 1)) / *freq;
228 if (parent_rate > 32)
231 if (parent_rate <= 4)
233 else if (parent_rate <= 8)
235 else if (parent_rate <= 16)
240 calcm = (parent_rate >> calcp) - 1;
242 *freq = (parent_rate >> calcp) / (calcm + 1);
244 /* we were called to round the frequency, we can now return */
255 * sunxi_factors_clk_setup() - Setup function for factor clocks
258 struct factors_data {
259 struct clk_factors_config *table;
260 void (*getter) (u32 *rate, u32 parent_rate, u8 *n, u8 *k, u8 *m, u8 *p);
263 static struct clk_factors_config sun4i_pll1_config = {
274 static struct clk_factors_config sun6i_a31_pll1_config = {
283 static struct clk_factors_config sun4i_apb1_config = {
290 static const struct factors_data sun4i_pll1_data __initconst = {
291 .table = &sun4i_pll1_config,
292 .getter = sun4i_get_pll1_factors,
295 static const struct factors_data sun6i_a31_pll1_data __initconst = {
296 .table = &sun6i_a31_pll1_config,
297 .getter = sun6i_a31_get_pll1_factors,
300 static const struct factors_data sun4i_apb1_data __initconst = {
301 .table = &sun4i_apb1_config,
302 .getter = sun4i_get_apb1_factors,
305 static void __init sunxi_factors_clk_setup(struct device_node *node,
306 struct factors_data *data)
309 const char *clk_name = node->name;
313 reg = of_iomap(node, 0);
315 parent = of_clk_get_parent_name(node, 0);
317 clk = clk_register_factors(NULL, clk_name, parent, 0, reg,
318 data->table, data->getter, &clk_lock);
321 of_clk_add_provider(node, of_clk_src_simple_get, clk);
322 clk_register_clkdev(clk, clk_name, NULL);
329 * sunxi_mux_clk_setup() - Setup function for muxes
332 #define SUNXI_MUX_GATE_WIDTH 2
338 static const struct mux_data sun4i_cpu_mux_data __initconst = {
342 static const struct mux_data sun6i_a31_ahb1_mux_data __initconst = {
346 static const struct mux_data sun4i_apb1_mux_data __initconst = {
350 static void __init sunxi_mux_clk_setup(struct device_node *node,
351 struct mux_data *data)
354 const char *clk_name = node->name;
355 const char *parents[5];
359 reg = of_iomap(node, 0);
361 while (i < 5 && (parents[i] = of_clk_get_parent_name(node, i)) != NULL)
364 clk = clk_register_mux(NULL, clk_name, parents, i,
365 CLK_SET_RATE_NO_REPARENT, reg,
366 data->shift, SUNXI_MUX_GATE_WIDTH,
370 of_clk_add_provider(node, of_clk_src_simple_get, clk);
371 clk_register_clkdev(clk, clk_name, NULL);
378 * sunxi_divider_clk_setup() - Setup function for simple divider clocks
387 static const struct div_data sun4i_axi_data __initconst = {
393 static const struct div_data sun4i_ahb_data __initconst = {
399 static const struct div_data sun4i_apb0_data __initconst = {
405 static const struct div_data sun6i_a31_apb2_div_data __initconst = {
411 static void __init sunxi_divider_clk_setup(struct device_node *node,
412 struct div_data *data)
415 const char *clk_name = node->name;
416 const char *clk_parent;
419 reg = of_iomap(node, 0);
421 clk_parent = of_clk_get_parent_name(node, 0);
423 clk = clk_register_divider(NULL, clk_name, clk_parent, 0,
424 reg, data->shift, data->width,
425 data->pow ? CLK_DIVIDER_POWER_OF_TWO : 0,
428 of_clk_add_provider(node, of_clk_src_simple_get, clk);
429 clk_register_clkdev(clk, clk_name, NULL);
436 * sunxi_gates_clk_setup() - Setup function for leaf gates on clocks
439 #define SUNXI_GATES_MAX_SIZE 64
442 DECLARE_BITMAP(mask, SUNXI_GATES_MAX_SIZE);
445 static const struct gates_data sun4i_axi_gates_data __initconst = {
449 static const struct gates_data sun4i_ahb_gates_data __initconst = {
450 .mask = {0x7F77FFF, 0x14FB3F},
453 static const struct gates_data sun5i_a10s_ahb_gates_data __initconst = {
454 .mask = {0x147667e7, 0x185915},
457 static const struct gates_data sun5i_a13_ahb_gates_data __initconst = {
458 .mask = {0x107067e7, 0x185111},
461 static const struct gates_data sun6i_a31_ahb1_gates_data __initconst = {
462 .mask = {0xEDFE7F62, 0x794F931},
465 static const struct gates_data sun7i_a20_ahb_gates_data __initconst = {
466 .mask = { 0x12f77fff, 0x16ff3f },
469 static const struct gates_data sun4i_apb0_gates_data __initconst = {
473 static const struct gates_data sun5i_a10s_apb0_gates_data __initconst = {
477 static const struct gates_data sun5i_a13_apb0_gates_data __initconst = {
481 static const struct gates_data sun7i_a20_apb0_gates_data __initconst = {
485 static const struct gates_data sun4i_apb1_gates_data __initconst = {
489 static const struct gates_data sun5i_a10s_apb1_gates_data __initconst = {
493 static const struct gates_data sun5i_a13_apb1_gates_data __initconst = {
497 static const struct gates_data sun6i_a31_apb1_gates_data __initconst = {
501 static const struct gates_data sun6i_a31_apb2_gates_data __initconst = {
505 static const struct gates_data sun7i_a20_apb1_gates_data __initconst = {
506 .mask = { 0xff80ff },
509 static void __init sunxi_gates_clk_setup(struct device_node *node,
510 struct gates_data *data)
512 struct clk_onecell_data *clk_data;
513 const char *clk_parent;
514 const char *clk_name;
521 reg = of_iomap(node, 0);
523 clk_parent = of_clk_get_parent_name(node, 0);
525 /* Worst-case size approximation and memory allocation */
526 qty = find_last_bit(data->mask, SUNXI_GATES_MAX_SIZE);
527 clk_data = kmalloc(sizeof(struct clk_onecell_data), GFP_KERNEL);
530 clk_data->clks = kzalloc((qty+1) * sizeof(struct clk *), GFP_KERNEL);
531 if (!clk_data->clks) {
536 for_each_set_bit(i, data->mask, SUNXI_GATES_MAX_SIZE) {
537 of_property_read_string_index(node, "clock-output-names",
540 /* No driver claims this clock, but it should remain gated */
541 ignore = !strcmp("ahb_sdram", clk_name) ? CLK_IGNORE_UNUSED : 0;
543 clk_data->clks[i] = clk_register_gate(NULL, clk_name,
545 reg + 4 * (i/32), i % 32,
547 WARN_ON(IS_ERR(clk_data->clks[i]));
552 /* Adjust to the real max */
553 clk_data->clk_num = i;
555 of_clk_add_provider(node, of_clk_src_onecell_get, clk_data);
558 /* Matches for factors clocks */
559 static const struct of_device_id clk_factors_match[] __initconst = {
560 {.compatible = "allwinner,sun4i-pll1-clk", .data = &sun4i_pll1_data,},
561 {.compatible = "allwinner,sun6i-a31-pll1-clk", .data = &sun6i_a31_pll1_data,},
562 {.compatible = "allwinner,sun4i-apb1-clk", .data = &sun4i_apb1_data,},
566 /* Matches for divider clocks */
567 static const struct of_device_id clk_div_match[] __initconst = {
568 {.compatible = "allwinner,sun4i-axi-clk", .data = &sun4i_axi_data,},
569 {.compatible = "allwinner,sun4i-ahb-clk", .data = &sun4i_ahb_data,},
570 {.compatible = "allwinner,sun4i-apb0-clk", .data = &sun4i_apb0_data,},
571 {.compatible = "allwinner,sun6i-a31-apb2-div-clk", .data = &sun6i_a31_apb2_div_data,},
575 /* Matches for mux clocks */
576 static const struct of_device_id clk_mux_match[] __initconst = {
577 {.compatible = "allwinner,sun4i-cpu-clk", .data = &sun4i_cpu_mux_data,},
578 {.compatible = "allwinner,sun4i-apb1-mux-clk", .data = &sun4i_apb1_mux_data,},
579 {.compatible = "allwinner,sun6i-a31-ahb1-mux-clk", .data = &sun6i_a31_ahb1_mux_data,},
583 /* Matches for gate clocks */
584 static const struct of_device_id clk_gates_match[] __initconst = {
585 {.compatible = "allwinner,sun4i-axi-gates-clk", .data = &sun4i_axi_gates_data,},
586 {.compatible = "allwinner,sun4i-ahb-gates-clk", .data = &sun4i_ahb_gates_data,},
587 {.compatible = "allwinner,sun5i-a10s-ahb-gates-clk", .data = &sun5i_a10s_ahb_gates_data,},
588 {.compatible = "allwinner,sun5i-a13-ahb-gates-clk", .data = &sun5i_a13_ahb_gates_data,},
589 {.compatible = "allwinner,sun6i-a31-ahb1-gates-clk", .data = &sun6i_a31_ahb1_gates_data,},
590 {.compatible = "allwinner,sun7i-a20-ahb-gates-clk", .data = &sun7i_a20_ahb_gates_data,},
591 {.compatible = "allwinner,sun4i-apb0-gates-clk", .data = &sun4i_apb0_gates_data,},
592 {.compatible = "allwinner,sun5i-a10s-apb0-gates-clk", .data = &sun5i_a10s_apb0_gates_data,},
593 {.compatible = "allwinner,sun5i-a13-apb0-gates-clk", .data = &sun5i_a13_apb0_gates_data,},
594 {.compatible = "allwinner,sun7i-a20-apb0-gates-clk", .data = &sun7i_a20_apb0_gates_data,},
595 {.compatible = "allwinner,sun4i-apb1-gates-clk", .data = &sun4i_apb1_gates_data,},
596 {.compatible = "allwinner,sun5i-a10s-apb1-gates-clk", .data = &sun5i_a10s_apb1_gates_data,},
597 {.compatible = "allwinner,sun5i-a13-apb1-gates-clk", .data = &sun5i_a13_apb1_gates_data,},
598 {.compatible = "allwinner,sun6i-a31-apb1-gates-clk", .data = &sun6i_a31_apb1_gates_data,},
599 {.compatible = "allwinner,sun7i-a20-apb1-gates-clk", .data = &sun7i_a20_apb1_gates_data,},
600 {.compatible = "allwinner,sun6i-a31-apb2-gates-clk", .data = &sun6i_a31_apb2_gates_data,},
604 static void __init of_sunxi_table_clock_setup(const struct of_device_id *clk_match,
607 struct device_node *np;
608 const struct div_data *data;
609 const struct of_device_id *match;
610 void (*setup_function)(struct device_node *, const void *) = function;
612 for_each_matching_node(np, clk_match) {
613 match = of_match_node(clk_match, np);
615 setup_function(np, data);
619 static void __init sunxi_init_clocks(struct device_node *np)
621 /* Register factor clocks */
622 of_sunxi_table_clock_setup(clk_factors_match, sunxi_factors_clk_setup);
624 /* Register divider clocks */
625 of_sunxi_table_clock_setup(clk_div_match, sunxi_divider_clk_setup);
627 /* Register mux clocks */
628 of_sunxi_table_clock_setup(clk_mux_match, sunxi_mux_clk_setup);
630 /* Register gate clocks */
631 of_sunxi_table_clock_setup(clk_gates_match, sunxi_gates_clk_setup);
633 CLK_OF_DECLARE(sun4i_a10_clk_init, "allwinner,sun4i-a10", sunxi_init_clocks);
634 CLK_OF_DECLARE(sun5i_a10s_clk_init, "allwinner,sun5i-a10s", sunxi_init_clocks);
635 CLK_OF_DECLARE(sun5i_a13_clk_init, "allwinner,sun5i-a13", sunxi_init_clocks);
636 CLK_OF_DECLARE(sun6i_a31_clk_init, "allwinner,sun6i-a31", sunxi_init_clocks);
637 CLK_OF_DECLARE(sun7i_a20_clk_init, "allwinner,sun7i-a20", sunxi_init_clocks);