2 * rcar_gen2 Core CPG Clocks
4 * Copyright (C) 2013 Ideas On Board SPRL
6 * Contact: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
13 #include <linux/clk-provider.h>
14 #include <linux/clkdev.h>
15 #include <linux/clk/shmobile.h>
16 #include <linux/init.h>
17 #include <linux/kernel.h>
18 #include <linux/math64.h>
20 #include <linux/of_address.h>
21 #include <linux/spinlock.h>
23 struct rcar_gen2_cpg
{
24 struct clk_onecell_data data
;
29 #define CPG_FRQCRB 0x00000004
30 #define CPG_FRQCRB_KICK BIT(31)
31 #define CPG_SDCKCR 0x00000074
32 #define CPG_PLL0CR 0x000000d8
33 #define CPG_FRQCRC 0x000000e0
34 #define CPG_FRQCRC_ZFC_MASK (0x1f << 8)
35 #define CPG_FRQCRC_ZFC_SHIFT 8
36 #define CPG_ADSPCKCR 0x0000025c
37 #define CPG_RCANCKCR 0x00000270
39 /* -----------------------------------------------------------------------------
42 * Traits of this clock:
43 * prepare - clk_prepare only ensures that parents are prepared
44 * enable - clk_enable only ensures that parents are enabled
45 * rate - rate is adjustable. clk->rate = parent->rate * mult / 32
46 * parent - fixed parent. No clk_set_parent support
52 void __iomem
*kick_reg
;
55 #define to_z_clk(_hw) container_of(_hw, struct cpg_z_clk, hw)
57 static unsigned long cpg_z_clk_recalc_rate(struct clk_hw
*hw
,
58 unsigned long parent_rate
)
60 struct cpg_z_clk
*zclk
= to_z_clk(hw
);
64 val
= (clk_readl(zclk
->reg
) & CPG_FRQCRC_ZFC_MASK
)
65 >> CPG_FRQCRC_ZFC_SHIFT
;
68 return div_u64((u64
)parent_rate
* mult
, 32);
71 static long cpg_z_clk_round_rate(struct clk_hw
*hw
, unsigned long rate
,
72 unsigned long *parent_rate
)
74 unsigned long prate
= *parent_rate
;
80 mult
= div_u64((u64
)rate
* 32, prate
);
81 mult
= clamp(mult
, 1U, 32U);
83 return *parent_rate
/ 32 * mult
;
86 static int cpg_z_clk_set_rate(struct clk_hw
*hw
, unsigned long rate
,
87 unsigned long parent_rate
)
89 struct cpg_z_clk
*zclk
= to_z_clk(hw
);
94 mult
= div_u64((u64
)rate
* 32, parent_rate
);
95 mult
= clamp(mult
, 1U, 32U);
97 if (clk_readl(zclk
->kick_reg
) & CPG_FRQCRB_KICK
)
100 val
= clk_readl(zclk
->reg
);
101 val
&= ~CPG_FRQCRC_ZFC_MASK
;
102 val
|= (32 - mult
) << CPG_FRQCRC_ZFC_SHIFT
;
103 clk_writel(val
, zclk
->reg
);
106 * Set KICK bit in FRQCRB to update hardware setting and wait for
107 * clock change completion.
109 kick
= clk_readl(zclk
->kick_reg
);
110 kick
|= CPG_FRQCRB_KICK
;
111 clk_writel(kick
, zclk
->kick_reg
);
114 * Note: There is no HW information about the worst case latency.
116 * Using experimental measurements, it seems that no more than
117 * ~10 iterations are needed, independently of the CPU rate.
118 * Since this value might be dependant of external xtal rate, pll1
119 * rate or even the other emulation clocks rate, use 1000 as a
120 * "super" safe value.
122 for (i
= 1000; i
; i
--) {
123 if (!(clk_readl(zclk
->kick_reg
) & CPG_FRQCRB_KICK
))
132 static const struct clk_ops cpg_z_clk_ops
= {
133 .recalc_rate
= cpg_z_clk_recalc_rate
,
134 .round_rate
= cpg_z_clk_round_rate
,
135 .set_rate
= cpg_z_clk_set_rate
,
138 static struct clk
* __init
cpg_z_clk_register(struct rcar_gen2_cpg
*cpg
)
140 static const char *parent_name
= "pll0";
141 struct clk_init_data init
;
142 struct cpg_z_clk
*zclk
;
145 zclk
= kzalloc(sizeof(*zclk
), GFP_KERNEL
);
147 return ERR_PTR(-ENOMEM
);
150 init
.ops
= &cpg_z_clk_ops
;
152 init
.parent_names
= &parent_name
;
153 init
.num_parents
= 1;
155 zclk
->reg
= cpg
->reg
+ CPG_FRQCRC
;
156 zclk
->kick_reg
= cpg
->reg
+ CPG_FRQCRB
;
157 zclk
->hw
.init
= &init
;
159 clk
= clk_register(NULL
, &zclk
->hw
);
166 static struct clk
* __init
cpg_rcan_clk_register(struct rcar_gen2_cpg
*cpg
,
167 struct device_node
*np
)
169 const char *parent_name
= of_clk_get_parent_name(np
, 1);
170 struct clk_fixed_factor
*fixed
;
171 struct clk_gate
*gate
;
174 fixed
= kzalloc(sizeof(*fixed
), GFP_KERNEL
);
176 return ERR_PTR(-ENOMEM
);
181 gate
= kzalloc(sizeof(*gate
), GFP_KERNEL
);
184 return ERR_PTR(-ENOMEM
);
187 gate
->reg
= cpg
->reg
+ CPG_RCANCKCR
;
189 gate
->flags
= CLK_GATE_SET_TO_DISABLE
;
190 gate
->lock
= &cpg
->lock
;
192 clk
= clk_register_composite(NULL
, "rcan", &parent_name
, 1, NULL
, NULL
,
193 &fixed
->hw
, &clk_fixed_factor_ops
,
194 &gate
->hw
, &clk_gate_ops
, 0);
204 static const struct clk_div_table cpg_adsp_div_table
[] = {
205 { 1, 3 }, { 2, 4 }, { 3, 6 }, { 4, 8 },
206 { 5, 12 }, { 6, 16 }, { 7, 18 }, { 8, 24 },
207 { 10, 36 }, { 11, 48 }, { 0, 0 },
210 static struct clk
* __init
cpg_adsp_clk_register(struct rcar_gen2_cpg
*cpg
)
212 const char *parent_name
= "pll1";
213 struct clk_divider
*div
;
214 struct clk_gate
*gate
;
217 div
= kzalloc(sizeof(*div
), GFP_KERNEL
);
219 return ERR_PTR(-ENOMEM
);
221 div
->reg
= cpg
->reg
+ CPG_ADSPCKCR
;
223 div
->table
= cpg_adsp_div_table
;
224 div
->lock
= &cpg
->lock
;
226 gate
= kzalloc(sizeof(*gate
), GFP_KERNEL
);
229 return ERR_PTR(-ENOMEM
);
232 gate
->reg
= cpg
->reg
+ CPG_ADSPCKCR
;
234 gate
->flags
= CLK_GATE_SET_TO_DISABLE
;
235 gate
->lock
= &cpg
->lock
;
237 clk
= clk_register_composite(NULL
, "adsp", &parent_name
, 1, NULL
, NULL
,
238 &div
->hw
, &clk_divider_ops
,
239 &gate
->hw
, &clk_gate_ops
, 0);
248 /* -----------------------------------------------------------------------------
253 * MD EXTAL PLL0 PLL1 PLL3
254 * 14 13 19 (MHz) *1 *1
255 *---------------------------------------------------
256 * 0 0 0 15 x 1 x172/2 x208/2 x106
257 * 0 0 1 15 x 1 x172/2 x208/2 x88
258 * 0 1 0 20 x 1 x130/2 x156/2 x80
259 * 0 1 1 20 x 1 x130/2 x156/2 x66
260 * 1 0 0 26 / 2 x200/2 x240/2 x122
261 * 1 0 1 26 / 2 x200/2 x240/2 x102
262 * 1 1 0 30 / 2 x172/2 x208/2 x106
263 * 1 1 1 30 / 2 x172/2 x208/2 x88
265 * *1 : Table 7.6 indicates VCO ouput (PLLx = VCO/2)
267 #define CPG_PLL_CONFIG_INDEX(md) ((((md) & BIT(14)) >> 12) | \
268 (((md) & BIT(13)) >> 12) | \
269 (((md) & BIT(19)) >> 19))
270 struct cpg_pll_config
{
271 unsigned int extal_div
;
272 unsigned int pll1_mult
;
273 unsigned int pll3_mult
;
276 static const struct cpg_pll_config cpg_pll_configs
[8] __initconst
= {
277 { 1, 208, 106 }, { 1, 208, 88 }, { 1, 156, 80 }, { 1, 156, 66 },
278 { 2, 240, 122 }, { 2, 240, 102 }, { 2, 208, 106 }, { 2, 208, 88 },
282 static const struct clk_div_table cpg_sdh_div_table
[] = {
283 { 0, 2 }, { 1, 3 }, { 2, 4 }, { 3, 6 },
284 { 4, 8 }, { 5, 12 }, { 6, 16 }, { 7, 18 },
285 { 8, 24 }, { 10, 36 }, { 11, 48 }, { 0, 0 },
288 static const struct clk_div_table cpg_sd01_div_table
[] = {
290 { 5, 12 }, { 6, 16 }, { 7, 18 }, { 8, 24 },
291 { 10, 36 }, { 11, 48 }, { 12, 10 }, { 0, 0 },
294 /* -----------------------------------------------------------------------------
298 static u32 cpg_mode __initdata
;
300 static struct clk
* __init
301 rcar_gen2_cpg_register_clock(struct device_node
*np
, struct rcar_gen2_cpg
*cpg
,
302 const struct cpg_pll_config
*config
,
305 const struct clk_div_table
*table
= NULL
;
306 const char *parent_name
;
308 unsigned int mult
= 1;
309 unsigned int div
= 1;
311 if (!strcmp(name
, "main")) {
312 parent_name
= of_clk_get_parent_name(np
, 0);
313 div
= config
->extal_div
;
314 } else if (!strcmp(name
, "pll0")) {
315 /* PLL0 is a configurable multiplier clock. Register it as a
316 * fixed factor clock for now as there's no generic multiplier
317 * clock implementation and we currently have no need to change
318 * the multiplier value.
320 u32 value
= clk_readl(cpg
->reg
+ CPG_PLL0CR
);
321 parent_name
= "main";
322 mult
= ((value
>> 24) & ((1 << 7) - 1)) + 1;
323 } else if (!strcmp(name
, "pll1")) {
324 parent_name
= "main";
325 mult
= config
->pll1_mult
/ 2;
326 } else if (!strcmp(name
, "pll3")) {
327 parent_name
= "main";
328 mult
= config
->pll3_mult
;
329 } else if (!strcmp(name
, "lb")) {
330 parent_name
= "pll1";
331 div
= cpg_mode
& BIT(18) ? 36 : 24;
332 } else if (!strcmp(name
, "qspi")) {
333 parent_name
= "pll1_div2";
334 div
= (cpg_mode
& (BIT(3) | BIT(2) | BIT(1))) == BIT(2)
336 } else if (!strcmp(name
, "sdh")) {
337 parent_name
= "pll1";
338 table
= cpg_sdh_div_table
;
340 } else if (!strcmp(name
, "sd0")) {
341 parent_name
= "pll1";
342 table
= cpg_sd01_div_table
;
344 } else if (!strcmp(name
, "sd1")) {
345 parent_name
= "pll1";
346 table
= cpg_sd01_div_table
;
348 } else if (!strcmp(name
, "z")) {
349 return cpg_z_clk_register(cpg
);
350 } else if (!strcmp(name
, "rcan")) {
351 return cpg_rcan_clk_register(cpg
, np
);
352 } else if (!strcmp(name
, "adsp")) {
353 return cpg_adsp_clk_register(cpg
);
355 return ERR_PTR(-EINVAL
);
359 return clk_register_fixed_factor(NULL
, name
, parent_name
, 0,
362 return clk_register_divider_table(NULL
, name
, parent_name
, 0,
363 cpg
->reg
+ CPG_SDCKCR
, shift
,
364 4, 0, table
, &cpg
->lock
);
367 static void __init
rcar_gen2_cpg_clocks_init(struct device_node
*np
)
369 const struct cpg_pll_config
*config
;
370 struct rcar_gen2_cpg
*cpg
;
375 num_clks
= of_property_count_strings(np
, "clock-output-names");
377 pr_err("%s: failed to count clocks\n", __func__
);
381 cpg
= kzalloc(sizeof(*cpg
), GFP_KERNEL
);
382 clks
= kzalloc(num_clks
* sizeof(*clks
), GFP_KERNEL
);
383 if (cpg
== NULL
|| clks
== NULL
) {
384 /* We're leaking memory on purpose, there's no point in cleaning
385 * up as the system won't boot anyway.
387 pr_err("%s: failed to allocate cpg\n", __func__
);
391 spin_lock_init(&cpg
->lock
);
393 cpg
->data
.clks
= clks
;
394 cpg
->data
.clk_num
= num_clks
;
396 cpg
->reg
= of_iomap(np
, 0);
397 if (WARN_ON(cpg
->reg
== NULL
))
400 config
= &cpg_pll_configs
[CPG_PLL_CONFIG_INDEX(cpg_mode
)];
402 for (i
= 0; i
< num_clks
; ++i
) {
406 of_property_read_string_index(np
, "clock-output-names", i
,
409 clk
= rcar_gen2_cpg_register_clock(np
, cpg
, config
, name
);
411 pr_err("%s: failed to register %s %s clock (%ld)\n",
412 __func__
, np
->name
, name
, PTR_ERR(clk
));
414 cpg
->data
.clks
[i
] = clk
;
417 of_clk_add_provider(np
, of_clk_src_onecell_get
, &cpg
->data
);
419 CLK_OF_DECLARE(rcar_gen2_cpg_clks
, "renesas,rcar-gen2-cpg-clocks",
420 rcar_gen2_cpg_clocks_init
);
422 void __init
rcar_gen2_clocks_init(u32 mode
)