2 * Nomadik clock implementation
3 * Copyright (C) 2013 ST-Ericsson AB
4 * License terms: GNU General Public License (GPL) version 2
5 * Author: Linus Walleij <linus.walleij@linaro.org>
8 #define pr_fmt(fmt) "Nomadik SRC clocks: " fmt
10 #include <linux/bitops.h>
11 #include <linux/slab.h>
12 #include <linux/err.h>
14 #include <linux/clk-provider.h>
16 #include <linux/of_address.h>
17 #include <linux/debugfs.h>
18 #include <linux/seq_file.h>
19 #include <linux/spinlock.h>
20 #include <linux/reboot.h>
23 * The Nomadik clock tree is described in the STN8815A12 DB V4.2
24 * reference manual for the chip, page 94 ff.
25 * Clock IDs are in the STn8815 Reference Manual table 3, page 27.
29 #define SRC_CR_T0_ENSEL BIT(15)
30 #define SRC_CR_T1_ENSEL BIT(17)
31 #define SRC_CR_T2_ENSEL BIT(19)
32 #define SRC_CR_T3_ENSEL BIT(21)
33 #define SRC_CR_T4_ENSEL BIT(23)
34 #define SRC_CR_T5_ENSEL BIT(25)
35 #define SRC_CR_T6_ENSEL BIT(27)
36 #define SRC_CR_T7_ENSEL BIT(29)
37 #define SRC_XTALCR 0x0CU
38 #define SRC_XTALCR_XTALTIMEN BIT(20)
39 #define SRC_XTALCR_SXTALDIS BIT(19)
40 #define SRC_XTALCR_MXTALSTAT BIT(2)
41 #define SRC_XTALCR_MXTALEN BIT(1)
42 #define SRC_XTALCR_MXTALOVER BIT(0)
43 #define SRC_PLLCR 0x10U
44 #define SRC_PLLCR_PLLTIMEN BIT(29)
45 #define SRC_PLLCR_PLL2EN BIT(28)
46 #define SRC_PLLCR_PLL1STAT BIT(2)
47 #define SRC_PLLCR_PLL1EN BIT(1)
48 #define SRC_PLLCR_PLL1OVER BIT(0)
49 #define SRC_PLLFR 0x14U
50 #define SRC_PCKEN0 0x24U
51 #define SRC_PCKDIS0 0x28U
52 #define SRC_PCKENSR0 0x2CU
53 #define SRC_PCKSR0 0x30U
54 #define SRC_PCKEN1 0x34U
55 #define SRC_PCKDIS1 0x38U
56 #define SRC_PCKENSR1 0x3CU
57 #define SRC_PCKSR1 0x40U
59 /* Lock protecting the SRC_CR register */
60 static DEFINE_SPINLOCK(src_lock
);
61 /* Base address of the SRC */
62 static void __iomem
*src_base
;
64 static int nomadik_clk_reboot_handler(struct notifier_block
*this,
70 /* The main chrystal need to be enabled for reboot to work */
71 val
= readl(src_base
+ SRC_XTALCR
);
72 val
&= ~SRC_XTALCR_MXTALOVER
;
73 val
|= SRC_XTALCR_MXTALEN
;
74 pr_crit("force-enabling MXTALO\n");
75 writel(val
, src_base
+ SRC_XTALCR
);
79 static struct notifier_block nomadik_clk_reboot_notifier
= {
80 .notifier_call
= nomadik_clk_reboot_handler
,
83 static const struct of_device_id nomadik_src_match
[] __initconst
= {
84 { .compatible
= "stericsson,nomadik-src" },
88 static void __init
nomadik_src_init(void)
90 struct device_node
*np
;
93 np
= of_find_matching_node(NULL
, nomadik_src_match
);
95 pr_crit("no matching node for SRC, aborting clock init\n");
98 src_base
= of_iomap(np
, 0);
100 pr_err("%s: must have src parent node with REGS (%s)\n",
105 /* Set all timers to use the 2.4 MHz TIMCLK */
106 val
= readl(src_base
+ SRC_CR
);
107 val
|= SRC_CR_T0_ENSEL
;
108 val
|= SRC_CR_T1_ENSEL
;
109 val
|= SRC_CR_T2_ENSEL
;
110 val
|= SRC_CR_T3_ENSEL
;
111 val
|= SRC_CR_T4_ENSEL
;
112 val
|= SRC_CR_T5_ENSEL
;
113 val
|= SRC_CR_T6_ENSEL
;
114 val
|= SRC_CR_T7_ENSEL
;
115 writel(val
, src_base
+ SRC_CR
);
117 val
= readl(src_base
+ SRC_XTALCR
);
118 pr_info("SXTALO is %s\n",
119 (val
& SRC_XTALCR_SXTALDIS
) ? "disabled" : "enabled");
120 pr_info("MXTAL is %s\n",
121 (val
& SRC_XTALCR_MXTALSTAT
) ? "enabled" : "disabled");
122 if (of_property_read_bool(np
, "disable-sxtalo")) {
123 /* The machine uses an external oscillator circuit */
124 val
|= SRC_XTALCR_SXTALDIS
;
125 pr_info("disabling SXTALO\n");
127 if (of_property_read_bool(np
, "disable-mxtalo")) {
128 /* Disable this too: also run by external oscillator */
129 val
|= SRC_XTALCR_MXTALOVER
;
130 val
&= ~SRC_XTALCR_MXTALEN
;
131 pr_info("disabling MXTALO\n");
133 writel(val
, src_base
+ SRC_XTALCR
);
134 register_reboot_notifier(&nomadik_clk_reboot_notifier
);
138 * struct clk_pll1 - Nomadik PLL1 clock
139 * @hw: corresponding clock hardware entry
140 * @id: PLL instance: 1 or 2
148 * struct clk_src - Nomadik src clock
149 * @hw: corresponding clock hardware entry
151 * @group1: true if the clock is in group1, else it is in group0
152 * @clkbit: bit 0...31 corresponding to the clock in each clock register
161 #define to_pll(_hw) container_of(_hw, struct clk_pll, hw)
162 #define to_src(_hw) container_of(_hw, struct clk_src, hw)
164 static int pll_clk_enable(struct clk_hw
*hw
)
166 struct clk_pll
*pll
= to_pll(hw
);
169 spin_lock(&src_lock
);
170 val
= readl(src_base
+ SRC_PLLCR
);
172 if (val
& SRC_PLLCR_PLL1OVER
) {
173 val
|= SRC_PLLCR_PLL1EN
;
174 writel(val
, src_base
+ SRC_PLLCR
);
176 } else if (pll
->id
== 2) {
177 val
|= SRC_PLLCR_PLL2EN
;
178 writel(val
, src_base
+ SRC_PLLCR
);
180 spin_unlock(&src_lock
);
184 static void pll_clk_disable(struct clk_hw
*hw
)
186 struct clk_pll
*pll
= to_pll(hw
);
189 spin_lock(&src_lock
);
190 val
= readl(src_base
+ SRC_PLLCR
);
192 if (val
& SRC_PLLCR_PLL1OVER
) {
193 val
&= ~SRC_PLLCR_PLL1EN
;
194 writel(val
, src_base
+ SRC_PLLCR
);
196 } else if (pll
->id
== 2) {
197 val
&= ~SRC_PLLCR_PLL2EN
;
198 writel(val
, src_base
+ SRC_PLLCR
);
200 spin_unlock(&src_lock
);
203 static int pll_clk_is_enabled(struct clk_hw
*hw
)
205 struct clk_pll
*pll
= to_pll(hw
);
208 val
= readl(src_base
+ SRC_PLLCR
);
210 if (val
& SRC_PLLCR_PLL1OVER
)
211 return !!(val
& SRC_PLLCR_PLL1EN
);
212 } else if (pll
->id
== 2) {
213 return !!(val
& SRC_PLLCR_PLL2EN
);
218 static unsigned long pll_clk_recalc_rate(struct clk_hw
*hw
,
219 unsigned long parent_rate
)
221 struct clk_pll
*pll
= to_pll(hw
);
224 val
= readl(src_base
+ SRC_PLLFR
);
230 mul
= (val
>> 8) & 0x3FU
;
233 return (parent_rate
* mul
) >> div
;
239 mul
= (val
>> 24) & 0x3FU
;
241 return (parent_rate
* mul
);
249 static const struct clk_ops pll_clk_ops
= {
250 .enable
= pll_clk_enable
,
251 .disable
= pll_clk_disable
,
252 .is_enabled
= pll_clk_is_enabled
,
253 .recalc_rate
= pll_clk_recalc_rate
,
256 static struct clk_hw
* __init
257 pll_clk_register(struct device
*dev
, const char *name
,
258 const char *parent_name
, u32 id
)
262 struct clk_init_data init
;
264 if (id
!= 1 && id
!= 2) {
265 pr_err("%s: the Nomadik has only PLL 1 & 2\n", __func__
);
266 return ERR_PTR(-EINVAL
);
269 pll
= kzalloc(sizeof(*pll
), GFP_KERNEL
);
271 pr_err("%s: could not allocate PLL clk\n", __func__
);
272 return ERR_PTR(-ENOMEM
);
276 init
.ops
= &pll_clk_ops
;
277 init
.parent_names
= (parent_name
? &parent_name
: NULL
);
278 init
.num_parents
= (parent_name
? 1 : 0);
279 pll
->hw
.init
= &init
;
282 pr_debug("register PLL1 clock \"%s\"\n", name
);
284 ret
= clk_hw_register(dev
, &pll
->hw
);
294 * The Nomadik SRC clocks are gated, but not in the sense that
295 * you read-modify-write a register. Instead there are separate
296 * clock enable and clock disable registers. Writing a '1' bit in
297 * the enable register for a certain clock ungates that clock without
298 * affecting the other clocks. The disable register works the opposite
302 static int src_clk_enable(struct clk_hw
*hw
)
304 struct clk_src
*sclk
= to_src(hw
);
305 u32 enreg
= sclk
->group1
? SRC_PCKEN1
: SRC_PCKEN0
;
306 u32 sreg
= sclk
->group1
? SRC_PCKSR1
: SRC_PCKSR0
;
308 writel(sclk
->clkbit
, src_base
+ enreg
);
309 /* spin until enabled */
310 while (!(readl(src_base
+ sreg
) & sclk
->clkbit
))
315 static void src_clk_disable(struct clk_hw
*hw
)
317 struct clk_src
*sclk
= to_src(hw
);
318 u32 disreg
= sclk
->group1
? SRC_PCKDIS1
: SRC_PCKDIS0
;
319 u32 sreg
= sclk
->group1
? SRC_PCKSR1
: SRC_PCKSR0
;
321 writel(sclk
->clkbit
, src_base
+ disreg
);
322 /* spin until disabled */
323 while (readl(src_base
+ sreg
) & sclk
->clkbit
)
327 static int src_clk_is_enabled(struct clk_hw
*hw
)
329 struct clk_src
*sclk
= to_src(hw
);
330 u32 sreg
= sclk
->group1
? SRC_PCKSR1
: SRC_PCKSR0
;
331 u32 val
= readl(src_base
+ sreg
);
333 return !!(val
& sclk
->clkbit
);
337 src_clk_recalc_rate(struct clk_hw
*hw
,
338 unsigned long parent_rate
)
343 static const struct clk_ops src_clk_ops
= {
344 .enable
= src_clk_enable
,
345 .disable
= src_clk_disable
,
346 .is_enabled
= src_clk_is_enabled
,
347 .recalc_rate
= src_clk_recalc_rate
,
350 static struct clk_hw
* __init
351 src_clk_register(struct device
*dev
, const char *name
,
352 const char *parent_name
, u8 id
)
355 struct clk_src
*sclk
;
356 struct clk_init_data init
;
358 sclk
= kzalloc(sizeof(*sclk
), GFP_KERNEL
);
360 pr_err("could not allocate SRC clock %s\n",
362 return ERR_PTR(-ENOMEM
);
365 init
.ops
= &src_clk_ops
;
366 /* Do not force-disable the static SDRAM controller */
368 init
.flags
= CLK_IGNORE_UNUSED
;
371 init
.parent_names
= (parent_name
? &parent_name
: NULL
);
372 init
.num_parents
= (parent_name
? 1 : 0);
373 sclk
->hw
.init
= &init
;
375 sclk
->group1
= (id
> 31);
376 sclk
->clkbit
= BIT(id
& 0x1f);
378 pr_debug("register clock \"%s\" ID: %d group: %d bits: %08x\n",
379 name
, id
, sclk
->group1
, sclk
->clkbit
);
381 ret
= clk_hw_register(dev
, &sclk
->hw
);
390 #ifdef CONFIG_DEBUG_FS
392 static u32 src_pcksr0_boot
;
393 static u32 src_pcksr1_boot
;
395 static const char * const src_clk_names
[] = {
462 static int nomadik_src_clk_show(struct seq_file
*s
, void *what
)
465 u32 src_pcksr0
= readl(src_base
+ SRC_PCKSR0
);
466 u32 src_pcksr1
= readl(src_base
+ SRC_PCKSR1
);
467 u32 src_pckensr0
= readl(src_base
+ SRC_PCKENSR0
);
468 u32 src_pckensr1
= readl(src_base
+ SRC_PCKENSR1
);
470 seq_printf(s
, "Clock: Boot: Now: Request: ASKED:\n");
471 for (i
= 0; i
< ARRAY_SIZE(src_clk_names
); i
++) {
472 u32 pcksrb
= (i
< 0x20) ? src_pcksr0_boot
: src_pcksr1_boot
;
473 u32 pcksr
= (i
< 0x20) ? src_pcksr0
: src_pcksr1
;
474 u32 pckreq
= (i
< 0x20) ? src_pckensr0
: src_pckensr1
;
475 u32 mask
= BIT(i
& 0x1f);
477 seq_printf(s
, "%s %s %s %s\n",
479 (pcksrb
& mask
) ? "on " : "off",
480 (pcksr
& mask
) ? "on " : "off",
481 (pckreq
& mask
) ? "on " : "off");
486 static int nomadik_src_clk_open(struct inode
*inode
, struct file
*file
)
488 return single_open(file
, nomadik_src_clk_show
, NULL
);
491 static const struct file_operations nomadik_src_clk_debugfs_ops
= {
492 .open
= nomadik_src_clk_open
,
495 .release
= single_release
,
498 static int __init
nomadik_src_clk_init_debugfs(void)
500 /* Vital for multiplatform */
503 src_pcksr0_boot
= readl(src_base
+ SRC_PCKSR0
);
504 src_pcksr1_boot
= readl(src_base
+ SRC_PCKSR1
);
505 debugfs_create_file("nomadik-src-clk", S_IFREG
| S_IRUGO
,
506 NULL
, NULL
, &nomadik_src_clk_debugfs_ops
);
509 device_initcall(nomadik_src_clk_init_debugfs
);
513 static void __init
of_nomadik_pll_setup(struct device_node
*np
)
516 const char *clk_name
= np
->name
;
517 const char *parent_name
;
523 if (of_property_read_u32(np
, "pll-id", &pll_id
)) {
524 pr_err("%s: PLL \"%s\" missing pll-id property\n",
528 parent_name
= of_clk_get_parent_name(np
, 0);
529 hw
= pll_clk_register(NULL
, clk_name
, parent_name
, pll_id
);
531 of_clk_add_hw_provider(np
, of_clk_hw_simple_get
, hw
);
533 CLK_OF_DECLARE(nomadik_pll_clk
,
534 "st,nomadik-pll-clock", of_nomadik_pll_setup
);
536 static void __init
of_nomadik_hclk_setup(struct device_node
*np
)
539 const char *clk_name
= np
->name
;
540 const char *parent_name
;
545 parent_name
= of_clk_get_parent_name(np
, 0);
547 * The HCLK divides PLL1 with 1 (passthru), 2, 3 or 4.
549 hw
= clk_hw_register_divider(NULL
, clk_name
, parent_name
,
550 0, src_base
+ SRC_CR
,
552 CLK_DIVIDER_ONE_BASED
| CLK_DIVIDER_ALLOW_ZERO
,
555 of_clk_add_hw_provider(np
, of_clk_hw_simple_get
, hw
);
557 CLK_OF_DECLARE(nomadik_hclk_clk
,
558 "st,nomadik-hclk-clock", of_nomadik_hclk_setup
);
560 static void __init
of_nomadik_src_clk_setup(struct device_node
*np
)
563 const char *clk_name
= np
->name
;
564 const char *parent_name
;
570 if (of_property_read_u32(np
, "clock-id", &clk_id
)) {
571 pr_err("%s: SRC clock \"%s\" missing clock-id property\n",
575 parent_name
= of_clk_get_parent_name(np
, 0);
576 hw
= src_clk_register(NULL
, clk_name
, parent_name
, clk_id
);
578 of_clk_add_hw_provider(np
, of_clk_hw_simple_get
, hw
);
580 CLK_OF_DECLARE(nomadik_src_clk
,
581 "st,nomadik-src-clock", of_nomadik_src_clk_setup
);