2 * linux/arch/arm/mach-at91/clock.c
4 * Copyright (C) 2005 David Brownell
5 * Copyright (C) 2005 Ivan Kokshaysky
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
13 #include <linux/module.h>
14 #include <linux/kernel.h>
15 #include <linux/init.h>
17 #include <linux/debugfs.h>
18 #include <linux/seq_file.h>
19 #include <linux/list.h>
20 #include <linux/errno.h>
21 #include <linux/err.h>
22 #include <linux/spinlock.h>
23 #include <linux/delay.h>
24 #include <linux/clk.h>
27 #include <mach/hardware.h>
28 #include <mach/at91_pmc.h>
35 * There's a lot more which can be done with clocks, including cpufreq
36 * integration, slow clock mode support (for system suspend), letting
37 * PLLB be used at other rates (on boards that don't need USB), etc.
40 #define clk_is_primary(x) ((x)->type & CLK_TYPE_PRIMARY)
41 #define clk_is_programmable(x) ((x)->type & CLK_TYPE_PROGRAMMABLE)
42 #define clk_is_peripheral(x) ((x)->type & CLK_TYPE_PERIPHERAL)
43 #define clk_is_sys(x) ((x)->type & CLK_TYPE_SYSTEM)
46 static LIST_HEAD(clocks
);
47 static DEFINE_SPINLOCK(clk_lock
);
49 static u32 at91_pllb_usb_init
;
52 * Four primary clock sources: two crystal oscillators (32K, main), and
53 * two PLLs. PLLA usually runs the master clock; and PLLB must run at
54 * 48 MHz (unless no USB function clocks are needed). The main clock and
55 * both PLLs are turned off to run in "slow clock mode" (system suspend).
57 static struct clk clk32k
= {
59 .rate_hz
= AT91_SLOW_CLOCK
,
60 .users
= 1, /* always on */
62 .type
= CLK_TYPE_PRIMARY
,
64 static struct clk main_clk
= {
66 .pmc_mask
= AT91_PMC_MOSCS
, /* in PMC_SR */
68 .type
= CLK_TYPE_PRIMARY
,
70 static struct clk plla
= {
73 .pmc_mask
= AT91_PMC_LOCKA
, /* in PMC_SR */
75 .type
= CLK_TYPE_PRIMARY
| CLK_TYPE_PLL
,
78 static void pllb_mode(struct clk
*clk
, int is_on
)
83 is_on
= AT91_PMC_LOCKB
;
84 value
= at91_pllb_usb_init
;
88 // REVISIT: Add work-around for AT91RM9200 Errata #26 ?
89 at91_sys_write(AT91_CKGR_PLLBR
, value
);
93 } while ((at91_sys_read(AT91_PMC_SR
) & AT91_PMC_LOCKB
) != is_on
);
96 static struct clk pllb
= {
99 .pmc_mask
= AT91_PMC_LOCKB
, /* in PMC_SR */
102 .type
= CLK_TYPE_PRIMARY
| CLK_TYPE_PLL
,
105 static void pmc_sys_mode(struct clk
*clk
, int is_on
)
108 at91_sys_write(AT91_PMC_SCER
, clk
->pmc_mask
);
110 at91_sys_write(AT91_PMC_SCDR
, clk
->pmc_mask
);
113 static void pmc_uckr_mode(struct clk
*clk
, int is_on
)
115 unsigned int uckr
= at91_sys_read(AT91_CKGR_UCKR
);
118 is_on
= AT91_PMC_LOCKU
;
119 at91_sys_write(AT91_CKGR_UCKR
, uckr
| clk
->pmc_mask
);
121 at91_sys_write(AT91_CKGR_UCKR
, uckr
& ~(clk
->pmc_mask
));
125 } while ((at91_sys_read(AT91_PMC_SR
) & AT91_PMC_LOCKU
) != is_on
);
128 /* USB function clocks (PLLB must be 48 MHz) */
129 static struct clk udpck
= {
132 .mode
= pmc_sys_mode
,
134 static struct clk utmi_clk
= {
137 .pmc_mask
= AT91_PMC_UPLLEN
, /* in CKGR_UCKR */
138 .mode
= pmc_uckr_mode
,
139 .type
= CLK_TYPE_PLL
,
141 static struct clk uhpck
= {
144 .mode
= pmc_sys_mode
,
149 * The master clock is divided from the CPU clock (by 1-4). It's used for
150 * memory, interfaces to on-chip peripherals, the AIC, and sometimes more
151 * (e.g baud rate generation). It's sourced from one of the primary clocks.
153 static struct clk mck
= {
155 .pmc_mask
= AT91_PMC_MCKRDY
, /* in PMC_SR */
158 static void pmc_periph_mode(struct clk
*clk
, int is_on
)
161 at91_sys_write(AT91_PMC_PCER
, clk
->pmc_mask
);
163 at91_sys_write(AT91_PMC_PCDR
, clk
->pmc_mask
);
166 static struct clk __init
*at91_css_to_clk(unsigned long css
)
169 case AT91_PMC_CSS_SLOW
:
171 case AT91_PMC_CSS_MAIN
:
173 case AT91_PMC_CSS_PLLA
:
175 case AT91_PMC_CSS_PLLB
:
183 * Associate a particular clock with a function (eg, "uart") and device.
184 * The drivers can then request the same 'function' with several different
185 * devices and not care about which clock name to use.
187 void __init
at91_clock_associate(const char *id
, struct device
*dev
, const char *func
)
189 struct clk
*clk
= clk_get(NULL
, id
);
191 if (!dev
|| !clk
|| !IS_ERR(clk_get(dev
, func
)))
194 clk
->function
= func
;
198 /* clocks cannot be de-registered no refcounting necessary */
199 struct clk
*clk_get(struct device
*dev
, const char *id
)
203 list_for_each_entry(clk
, &clocks
, node
) {
204 if (strcmp(id
, clk
->name
) == 0)
206 if (clk
->function
&& (dev
== clk
->dev
) && strcmp(id
, clk
->function
) == 0)
210 return ERR_PTR(-ENOENT
);
212 EXPORT_SYMBOL(clk_get
);
214 void clk_put(struct clk
*clk
)
217 EXPORT_SYMBOL(clk_put
);
219 static void __clk_enable(struct clk
*clk
)
222 __clk_enable(clk
->parent
);
223 if (clk
->users
++ == 0 && clk
->mode
)
227 int clk_enable(struct clk
*clk
)
231 spin_lock_irqsave(&clk_lock
, flags
);
233 spin_unlock_irqrestore(&clk_lock
, flags
);
236 EXPORT_SYMBOL(clk_enable
);
238 static void __clk_disable(struct clk
*clk
)
240 BUG_ON(clk
->users
== 0);
241 if (--clk
->users
== 0 && clk
->mode
)
244 __clk_disable(clk
->parent
);
247 void clk_disable(struct clk
*clk
)
251 spin_lock_irqsave(&clk_lock
, flags
);
253 spin_unlock_irqrestore(&clk_lock
, flags
);
255 EXPORT_SYMBOL(clk_disable
);
257 unsigned long clk_get_rate(struct clk
*clk
)
262 spin_lock_irqsave(&clk_lock
, flags
);
265 if (rate
|| !clk
->parent
)
269 spin_unlock_irqrestore(&clk_lock
, flags
);
272 EXPORT_SYMBOL(clk_get_rate
);
274 /*------------------------------------------------------------------------*/
276 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
279 * For now, only the programmable clocks support reparenting (MCK could
280 * do this too, with care) or rate changing (the PLLs could do this too,
281 * ditto MCK but that's more for cpufreq). Drivers may reparent to get
282 * a better rate match; we don't.
285 long clk_round_rate(struct clk
*clk
, unsigned long rate
)
289 unsigned long actual
;
291 if (!clk_is_programmable(clk
))
293 spin_lock_irqsave(&clk_lock
, flags
);
295 actual
= clk
->parent
->rate_hz
;
296 for (prescale
= 0; prescale
< 7; prescale
++) {
297 if (actual
&& actual
<= rate
)
302 spin_unlock_irqrestore(&clk_lock
, flags
);
303 return (prescale
< 7) ? actual
: -ENOENT
;
305 EXPORT_SYMBOL(clk_round_rate
);
307 int clk_set_rate(struct clk
*clk
, unsigned long rate
)
311 unsigned long actual
;
313 if (!clk_is_programmable(clk
))
317 spin_lock_irqsave(&clk_lock
, flags
);
319 actual
= clk
->parent
->rate_hz
;
320 for (prescale
= 0; prescale
< 7; prescale
++) {
321 if (actual
&& actual
<= rate
) {
324 pckr
= at91_sys_read(AT91_PMC_PCKR(clk
->id
));
325 pckr
&= AT91_PMC_CSS_PLLB
; /* clock selection */
326 pckr
|= prescale
<< 2;
327 at91_sys_write(AT91_PMC_PCKR(clk
->id
), pckr
);
328 clk
->rate_hz
= actual
;
334 spin_unlock_irqrestore(&clk_lock
, flags
);
335 return (prescale
< 7) ? actual
: -ENOENT
;
337 EXPORT_SYMBOL(clk_set_rate
);
339 struct clk
*clk_get_parent(struct clk
*clk
)
343 EXPORT_SYMBOL(clk_get_parent
);
345 int clk_set_parent(struct clk
*clk
, struct clk
*parent
)
351 if (!clk_is_primary(parent
) || !clk_is_programmable(clk
))
353 spin_lock_irqsave(&clk_lock
, flags
);
355 clk
->rate_hz
= parent
->rate_hz
;
356 clk
->parent
= parent
;
357 at91_sys_write(AT91_PMC_PCKR(clk
->id
), parent
->id
);
359 spin_unlock_irqrestore(&clk_lock
, flags
);
362 EXPORT_SYMBOL(clk_set_parent
);
364 /* establish PCK0..PCK3 parentage and rate */
365 static void __init
init_programmable_clock(struct clk
*clk
)
370 pckr
= at91_sys_read(AT91_PMC_PCKR(clk
->id
));
371 parent
= at91_css_to_clk(pckr
& AT91_PMC_CSS
);
372 clk
->parent
= parent
;
373 clk
->rate_hz
= parent
->rate_hz
/ (1 << ((pckr
& AT91_PMC_PRES
) >> 2));
376 #endif /* CONFIG_AT91_PROGRAMMABLE_CLOCKS */
378 /*------------------------------------------------------------------------*/
380 #ifdef CONFIG_DEBUG_FS
382 static int at91_clk_show(struct seq_file
*s
, void *unused
)
384 u32 scsr
, pcsr
, uckr
= 0, sr
;
387 seq_printf(s
, "SCSR = %8x\n", scsr
= at91_sys_read(AT91_PMC_SCSR
));
388 seq_printf(s
, "PCSR = %8x\n", pcsr
= at91_sys_read(AT91_PMC_PCSR
));
389 seq_printf(s
, "MOR = %8x\n", at91_sys_read(AT91_CKGR_MOR
));
390 seq_printf(s
, "MCFR = %8x\n", at91_sys_read(AT91_CKGR_MCFR
));
391 seq_printf(s
, "PLLA = %8x\n", at91_sys_read(AT91_CKGR_PLLAR
));
392 if (!cpu_is_at91sam9rl())
393 seq_printf(s
, "PLLB = %8x\n", at91_sys_read(AT91_CKGR_PLLBR
));
394 if (cpu_is_at91cap9() || cpu_is_at91sam9rl())
395 seq_printf(s
, "UCKR = %8x\n", uckr
= at91_sys_read(AT91_CKGR_UCKR
));
396 seq_printf(s
, "MCKR = %8x\n", at91_sys_read(AT91_PMC_MCKR
));
397 seq_printf(s
, "SR = %8x\n", sr
= at91_sys_read(AT91_PMC_SR
));
401 list_for_each_entry(clk
, &clocks
, node
) {
404 if (clk
->mode
== pmc_sys_mode
)
405 state
= (scsr
& clk
->pmc_mask
) ? "on" : "off";
406 else if (clk
->mode
== pmc_periph_mode
)
407 state
= (pcsr
& clk
->pmc_mask
) ? "on" : "off";
408 else if (clk
->mode
== pmc_uckr_mode
)
409 state
= (uckr
& clk
->pmc_mask
) ? "on" : "off";
410 else if (clk
->pmc_mask
)
411 state
= (sr
& clk
->pmc_mask
) ? "on" : "off";
412 else if (clk
== &clk32k
|| clk
== &main_clk
)
417 seq_printf(s
, "%-10s users=%2d %-3s %9ld Hz %s\n",
418 clk
->name
, clk
->users
, state
, clk_get_rate(clk
),
419 clk
->parent
? clk
->parent
->name
: "");
424 static int at91_clk_open(struct inode
*inode
, struct file
*file
)
426 return single_open(file
, at91_clk_show
, NULL
);
429 static const struct file_operations at91_clk_operations
= {
430 .open
= at91_clk_open
,
433 .release
= single_release
,
436 static int __init
at91_clk_debugfs_init(void)
438 /* /sys/kernel/debug/at91_clk */
439 (void) debugfs_create_file("at91_clk", S_IFREG
| S_IRUGO
, NULL
, NULL
, &at91_clk_operations
);
443 postcore_initcall(at91_clk_debugfs_init
);
447 /*------------------------------------------------------------------------*/
449 /* Register a new clock */
450 int __init
clk_register(struct clk
*clk
)
452 if (clk_is_peripheral(clk
)) {
454 clk
->mode
= pmc_periph_mode
;
455 list_add_tail(&clk
->node
, &clocks
);
457 else if (clk_is_sys(clk
)) {
459 clk
->mode
= pmc_sys_mode
;
461 list_add_tail(&clk
->node
, &clocks
);
463 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
464 else if (clk_is_programmable(clk
)) {
465 clk
->mode
= pmc_sys_mode
;
466 init_programmable_clock(clk
);
467 list_add_tail(&clk
->node
, &clocks
);
475 /*------------------------------------------------------------------------*/
477 static u32 __init
at91_pll_rate(struct clk
*pll
, u32 freq
, u32 reg
)
482 mul
= (reg
>> 16) & 0x7ff;
492 static u32 __init
at91_usb_rate(struct clk
*pll
, u32 freq
, u32 reg
)
494 if (pll
== &pllb
&& (reg
& AT91_PMC_USB96M
))
500 static unsigned __init
at91_pll_calc(unsigned main_freq
, unsigned out_freq
)
502 unsigned i
, div
= 0, mul
= 0, diff
= 1 << 30;
503 unsigned ret
= (out_freq
> 155000000) ? 0xbe00 : 0x3e00;
505 /* PLL output max 240 MHz (or 180 MHz per errata) */
506 if (out_freq
> 240000000)
509 for (i
= 1; i
< 256; i
++) {
511 unsigned input
, mul1
;
514 * PLL input between 1MHz and 32MHz per spec, but lower
515 * frequences seem necessary in some cases so allow 100K.
516 * Warning: some newer products need 2MHz min.
518 input
= main_freq
/ i
;
519 if (cpu_is_at91sam9g20() && input
< 2000000)
523 if (input
> 32000000)
526 mul1
= out_freq
/ input
;
527 if (cpu_is_at91sam9g20() && mul
> 63)
534 diff1
= out_freq
- input
* mul1
;
545 if (i
== 256 && diff
> (out_freq
>> 5))
547 return ret
| ((mul
- 1) << 16) | div
;
552 static struct clk
*const standard_pmc_clocks
[] __initdata
= {
553 /* four primary clocks */
559 /* PLLB children (USB) */
567 int __init
at91_clock_init(unsigned long main_clock
)
569 unsigned tmp
, freq
, mckr
;
573 * When the bootloader initialized the main oscillator correctly,
574 * there's no problem using the cycle counter. But if it didn't,
575 * or when using oscillator bypass mode, we must be told the speed
580 tmp
= at91_sys_read(AT91_CKGR_MCFR
);
581 } while (!(tmp
& AT91_PMC_MAINRDY
));
582 main_clock
= (tmp
& AT91_PMC_MAINF
) * (AT91_SLOW_CLOCK
/ 16);
584 main_clk
.rate_hz
= main_clock
;
586 /* report if PLLA is more than mildly overclocked */
587 plla
.rate_hz
= at91_pll_rate(&plla
, main_clock
, at91_sys_read(AT91_CKGR_PLLAR
));
588 if ((!cpu_is_at91sam9g20() && plla
.rate_hz
> 209000000)
589 || (cpu_is_at91sam9g20() && plla
.rate_hz
> 800000000))
590 pr_info("Clocks: PLLA overclocked, %ld MHz\n", plla
.rate_hz
/ 1000000);
593 * USB clock init: choose 48 MHz PLLB value,
594 * disable 48MHz clock during usb peripheral suspend.
596 * REVISIT: assumes MCK doesn't derive from PLLB!
598 at91_pllb_usb_init
= at91_pll_calc(main_clock
, 48000000 * 2) | AT91_PMC_USB96M
;
599 pllb
.rate_hz
= at91_pll_rate(&pllb
, main_clock
, at91_pllb_usb_init
);
600 if (cpu_is_at91rm9200()) {
601 uhpck
.pmc_mask
= AT91RM9200_PMC_UHP
;
602 udpck
.pmc_mask
= AT91RM9200_PMC_UDP
;
603 at91_sys_write(AT91_PMC_SCER
, AT91RM9200_PMC_MCKUDP
);
604 } else if (cpu_is_at91sam9260() || cpu_is_at91sam9261() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
605 uhpck
.pmc_mask
= AT91SAM926x_PMC_UHP
;
606 udpck
.pmc_mask
= AT91SAM926x_PMC_UDP
;
607 } else if (cpu_is_at91cap9()) {
608 uhpck
.pmc_mask
= AT91CAP9_PMC_UHP
;
610 at91_sys_write(AT91_CKGR_PLLBR
, 0);
612 udpck
.rate_hz
= at91_usb_rate(&pllb
, pllb
.rate_hz
, at91_pllb_usb_init
);
613 uhpck
.rate_hz
= at91_usb_rate(&pllb
, pllb
.rate_hz
, at91_pllb_usb_init
);
618 if (cpu_is_at91cap9() || cpu_is_at91sam9rl()) {
620 * multiplier is hard-wired to 40
621 * (obtain the USB High Speed 480 MHz when input is 12 MHz)
623 utmi_clk
.rate_hz
= 40 * utmi_clk
.parent
->rate_hz
;
627 * MCK and CPU derive from one of those primary clocks.
628 * For now, assume this parentage won't change.
630 mckr
= at91_sys_read(AT91_PMC_MCKR
);
631 mck
.parent
= at91_css_to_clk(mckr
& AT91_PMC_CSS
);
632 freq
= mck
.parent
->rate_hz
;
633 freq
/= (1 << ((mckr
& AT91_PMC_PRES
) >> 2)); /* prescale */
634 if (cpu_is_at91rm9200())
635 mck
.rate_hz
= freq
/ (1 + ((mckr
& AT91_PMC_MDIV
) >> 8)); /* mdiv */
636 else if (cpu_is_at91sam9g20()) {
637 mck
.rate_hz
= (mckr
& AT91_PMC_MDIV
) ?
638 freq
/ ((mckr
& AT91_PMC_MDIV
) >> 7) : freq
; /* mdiv ; (x >> 7) = ((x >> 8) * 2) */
639 if (mckr
& AT91_PMC_PDIV
)
640 freq
/= 2; /* processor clock division */
642 mck
.rate_hz
= freq
/ (1 << ((mckr
& AT91_PMC_MDIV
) >> 8)); /* mdiv */
644 /* Register the PMC's standard clocks */
645 for (i
= 0; i
< ARRAY_SIZE(standard_pmc_clocks
); i
++)
646 list_add_tail(&standard_pmc_clocks
[i
]->node
, &clocks
);
648 if (cpu_is_at91cap9() || cpu_is_at91sam9rl())
649 list_add_tail(&utmi_clk
.node
, &clocks
);
651 /* MCK and CPU clock are "always on" */
654 printk("Clocks: CPU %u MHz, master %u MHz, main %u.%03u MHz\n",
655 freq
/ 1000000, (unsigned) mck
.rate_hz
/ 1000000,
656 (unsigned) main_clock
/ 1000000,
657 ((unsigned) main_clock
% 1000000) / 1000);
663 * Several unused clocks may be active. Turn them off.
665 static int __init
at91_clock_reset(void)
667 unsigned long pcdr
= 0;
668 unsigned long scdr
= 0;
671 list_for_each_entry(clk
, &clocks
, node
) {
675 if (clk
->mode
== pmc_periph_mode
)
676 pcdr
|= clk
->pmc_mask
;
678 if (clk
->mode
== pmc_sys_mode
)
679 scdr
|= clk
->pmc_mask
;
681 pr_debug("Clocks: disable unused %s\n", clk
->name
);
684 at91_sys_write(AT91_PMC_PCDR
, pcdr
);
685 at91_sys_write(AT91_PMC_SCDR
, scdr
);
689 late_initcall(at91_clock_reset
);