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>
28 #include <asm/arch/hardware.h>
29 #include <asm/arch/at91_pmc.h>
30 #include <asm/arch/cpu.h>
36 * There's a lot more which can be done with clocks, including cpufreq
37 * integration, slow clock mode support (for system suspend), letting
38 * PLLB be used at other rates (on boards that don't need USB), etc.
41 #define clk_is_primary(x) ((x)->type & CLK_TYPE_PRIMARY)
42 #define clk_is_programmable(x) ((x)->type & CLK_TYPE_PROGRAMMABLE)
43 #define clk_is_peripheral(x) ((x)->type & CLK_TYPE_PERIPHERAL)
44 #define clk_is_sys(x) ((x)->type & CLK_TYPE_SYSTEM)
47 static LIST_HEAD(clocks);
48 static DEFINE_SPINLOCK(clk_lock);
50 static u32 at91_pllb_usb_init;
53 * Four primary clock sources: two crystal oscillators (32K, main), and
54 * two PLLs. PLLA usually runs the master clock; and PLLB must run at
55 * 48 MHz (unless no USB function clocks are needed). The main clock and
56 * both PLLs are turned off to run in "slow clock mode" (system suspend).
58 static struct clk clk32k = {
60 .rate_hz = AT91_SLOW_CLOCK,
61 .users = 1, /* always on */
63 .type = CLK_TYPE_PRIMARY,
65 static struct clk main_clk = {
67 .pmc_mask = AT91_PMC_MOSCS, /* in PMC_SR */
69 .type = CLK_TYPE_PRIMARY,
71 static struct clk plla = {
74 .pmc_mask = AT91_PMC_LOCKA, /* in PMC_SR */
76 .type = CLK_TYPE_PRIMARY | CLK_TYPE_PLL,
79 static void pllb_mode(struct clk *clk, int is_on)
84 is_on = AT91_PMC_LOCKB;
85 value = at91_pllb_usb_init;
89 // REVISIT: Add work-around for AT91RM9200 Errata #26 ?
90 at91_sys_write(AT91_CKGR_PLLBR, value);
94 } while ((at91_sys_read(AT91_PMC_SR) & AT91_PMC_LOCKB) != is_on);
97 static struct clk pllb = {
100 .pmc_mask = AT91_PMC_LOCKB, /* in PMC_SR */
103 .type = CLK_TYPE_PRIMARY | CLK_TYPE_PLL,
106 static void pmc_sys_mode(struct clk *clk, int is_on)
109 at91_sys_write(AT91_PMC_SCER, clk->pmc_mask);
111 at91_sys_write(AT91_PMC_SCDR, clk->pmc_mask);
114 static void pmc_uckr_mode(struct clk *clk, int is_on)
116 unsigned int uckr = at91_sys_read(AT91_CKGR_UCKR);
119 is_on = AT91_PMC_LOCKU;
120 at91_sys_write(AT91_CKGR_UCKR, uckr | clk->pmc_mask);
122 at91_sys_write(AT91_CKGR_UCKR, uckr & ~(clk->pmc_mask));
126 } while ((at91_sys_read(AT91_PMC_SR) & AT91_PMC_LOCKU) != is_on);
129 /* USB function clocks (PLLB must be 48 MHz) */
130 static struct clk udpck = {
133 .mode = pmc_sys_mode,
135 static struct clk utmi_clk = {
138 .pmc_mask = AT91_PMC_UPLLEN, /* in CKGR_UCKR */
139 .mode = pmc_uckr_mode,
140 .type = CLK_TYPE_PLL,
142 static struct clk uhpck = {
145 .mode = pmc_sys_mode,
150 * The master clock is divided from the CPU clock (by 1-4). It's used for
151 * memory, interfaces to on-chip peripherals, the AIC, and sometimes more
152 * (e.g baud rate generation). It's sourced from one of the primary clocks.
154 static struct clk mck = {
156 .pmc_mask = AT91_PMC_MCKRDY, /* in PMC_SR */
159 static void pmc_periph_mode(struct clk *clk, int is_on)
162 at91_sys_write(AT91_PMC_PCER, clk->pmc_mask);
164 at91_sys_write(AT91_PMC_PCDR, clk->pmc_mask);
167 static struct clk __init *at91_css_to_clk(unsigned long css)
170 case AT91_PMC_CSS_SLOW:
172 case AT91_PMC_CSS_MAIN:
174 case AT91_PMC_CSS_PLLA:
176 case AT91_PMC_CSS_PLLB:
184 * Associate a particular clock with a function (eg, "uart") and device.
185 * The drivers can then request the same 'function' with several different
186 * devices and not care about which clock name to use.
188 void __init at91_clock_associate(const char *id, struct device *dev, const char *func)
190 struct clk *clk = clk_get(NULL, id);
192 if (!dev || !clk || !IS_ERR(clk_get(dev, func)))
195 clk->function = func;
199 /* clocks cannot be de-registered no refcounting necessary */
200 struct clk *clk_get(struct device *dev, const char *id)
204 list_for_each_entry(clk, &clocks, node) {
205 if (strcmp(id, clk->name) == 0)
207 if (clk->function && (dev == clk->dev) && strcmp(id, clk->function) == 0)
211 return ERR_PTR(-ENOENT);
213 EXPORT_SYMBOL(clk_get);
215 void clk_put(struct clk *clk)
218 EXPORT_SYMBOL(clk_put);
220 static void __clk_enable(struct clk *clk)
223 __clk_enable(clk->parent);
224 if (clk->users++ == 0 && clk->mode)
228 int clk_enable(struct clk *clk)
232 spin_lock_irqsave(&clk_lock, flags);
234 spin_unlock_irqrestore(&clk_lock, flags);
237 EXPORT_SYMBOL(clk_enable);
239 static void __clk_disable(struct clk *clk)
241 BUG_ON(clk->users == 0);
242 if (--clk->users == 0 && clk->mode)
245 __clk_disable(clk->parent);
248 void clk_disable(struct clk *clk)
252 spin_lock_irqsave(&clk_lock, flags);
254 spin_unlock_irqrestore(&clk_lock, flags);
256 EXPORT_SYMBOL(clk_disable);
258 unsigned long clk_get_rate(struct clk *clk)
263 spin_lock_irqsave(&clk_lock, flags);
266 if (rate || !clk->parent)
270 spin_unlock_irqrestore(&clk_lock, flags);
273 EXPORT_SYMBOL(clk_get_rate);
275 /*------------------------------------------------------------------------*/
277 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
280 * For now, only the programmable clocks support reparenting (MCK could
281 * do this too, with care) or rate changing (the PLLs could do this too,
282 * ditto MCK but that's more for cpufreq). Drivers may reparent to get
283 * a better rate match; we don't.
286 long clk_round_rate(struct clk *clk, unsigned long rate)
290 unsigned long actual;
292 if (!clk_is_programmable(clk))
294 spin_lock_irqsave(&clk_lock, flags);
296 actual = clk->parent->rate_hz;
297 for (prescale = 0; prescale < 7; prescale++) {
298 if (actual && actual <= rate)
303 spin_unlock_irqrestore(&clk_lock, flags);
304 return (prescale < 7) ? actual : -ENOENT;
306 EXPORT_SYMBOL(clk_round_rate);
308 int clk_set_rate(struct clk *clk, unsigned long rate)
312 unsigned long actual;
314 if (!clk_is_programmable(clk))
318 spin_lock_irqsave(&clk_lock, flags);
320 actual = clk->parent->rate_hz;
321 for (prescale = 0; prescale < 7; prescale++) {
322 if (actual && actual <= rate) {
325 pckr = at91_sys_read(AT91_PMC_PCKR(clk->id));
326 pckr &= AT91_PMC_CSS_PLLB; /* clock selection */
327 pckr |= prescale << 2;
328 at91_sys_write(AT91_PMC_PCKR(clk->id), pckr);
329 clk->rate_hz = actual;
335 spin_unlock_irqrestore(&clk_lock, flags);
336 return (prescale < 7) ? actual : -ENOENT;
338 EXPORT_SYMBOL(clk_set_rate);
340 struct clk *clk_get_parent(struct clk *clk)
344 EXPORT_SYMBOL(clk_get_parent);
346 int clk_set_parent(struct clk *clk, struct clk *parent)
352 if (!clk_is_primary(parent) || !clk_is_programmable(clk))
354 spin_lock_irqsave(&clk_lock, flags);
356 clk->rate_hz = parent->rate_hz;
357 clk->parent = parent;
358 at91_sys_write(AT91_PMC_PCKR(clk->id), parent->id);
360 spin_unlock_irqrestore(&clk_lock, flags);
363 EXPORT_SYMBOL(clk_set_parent);
365 /* establish PCK0..PCK3 parentage and rate */
366 static void __init init_programmable_clock(struct clk *clk)
371 pckr = at91_sys_read(AT91_PMC_PCKR(clk->id));
372 parent = at91_css_to_clk(pckr & AT91_PMC_CSS);
373 clk->parent = parent;
374 clk->rate_hz = parent->rate_hz / (1 << ((pckr & AT91_PMC_PRES) >> 2));
377 #endif /* CONFIG_AT91_PROGRAMMABLE_CLOCKS */
379 /*------------------------------------------------------------------------*/
381 #ifdef CONFIG_DEBUG_FS
383 static int at91_clk_show(struct seq_file *s, void *unused)
385 u32 scsr, pcsr, uckr = 0, sr;
388 seq_printf(s, "SCSR = %8x\n", scsr = at91_sys_read(AT91_PMC_SCSR));
389 seq_printf(s, "PCSR = %8x\n", pcsr = at91_sys_read(AT91_PMC_PCSR));
390 seq_printf(s, "MOR = %8x\n", at91_sys_read(AT91_CKGR_MOR));
391 seq_printf(s, "MCFR = %8x\n", at91_sys_read(AT91_CKGR_MCFR));
392 seq_printf(s, "PLLA = %8x\n", at91_sys_read(AT91_CKGR_PLLAR));
393 if (!cpu_is_at91sam9rl())
394 seq_printf(s, "PLLB = %8x\n", at91_sys_read(AT91_CKGR_PLLBR));
395 if (cpu_is_at91cap9() || cpu_is_at91sam9rl())
396 seq_printf(s, "UCKR = %8x\n", uckr = at91_sys_read(AT91_CKGR_UCKR));
397 seq_printf(s, "MCKR = %8x\n", at91_sys_read(AT91_PMC_MCKR));
398 seq_printf(s, "SR = %8x\n", sr = at91_sys_read(AT91_PMC_SR));
402 list_for_each_entry(clk, &clocks, node) {
405 if (clk->mode == pmc_sys_mode)
406 state = (scsr & clk->pmc_mask) ? "on" : "off";
407 else if (clk->mode == pmc_periph_mode)
408 state = (pcsr & clk->pmc_mask) ? "on" : "off";
409 else if (clk->mode == pmc_uckr_mode)
410 state = (uckr & clk->pmc_mask) ? "on" : "off";
411 else if (clk->pmc_mask)
412 state = (sr & clk->pmc_mask) ? "on" : "off";
413 else if (clk == &clk32k || clk == &main_clk)
418 seq_printf(s, "%-10s users=%2d %-3s %9ld Hz %s\n",
419 clk->name, clk->users, state, clk_get_rate(clk),
420 clk->parent ? clk->parent->name : "");
425 static int at91_clk_open(struct inode *inode, struct file *file)
427 return single_open(file, at91_clk_show, NULL);
430 static const struct file_operations at91_clk_operations = {
431 .open = at91_clk_open,
434 .release = single_release,
437 static int __init at91_clk_debugfs_init(void)
439 /* /sys/kernel/debug/at91_clk */
440 (void) debugfs_create_file("at91_clk", S_IFREG | S_IRUGO, NULL, NULL, &at91_clk_operations);
444 postcore_initcall(at91_clk_debugfs_init);
448 /*------------------------------------------------------------------------*/
450 /* Register a new clock */
451 int __init clk_register(struct clk *clk)
453 if (clk_is_peripheral(clk)) {
455 clk->mode = pmc_periph_mode;
456 list_add_tail(&clk->node, &clocks);
458 else if (clk_is_sys(clk)) {
460 clk->mode = pmc_sys_mode;
462 list_add_tail(&clk->node, &clocks);
464 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
465 else if (clk_is_programmable(clk)) {
466 clk->mode = pmc_sys_mode;
467 init_programmable_clock(clk);
468 list_add_tail(&clk->node, &clocks);
476 /*------------------------------------------------------------------------*/
478 static u32 __init at91_pll_rate(struct clk *pll, u32 freq, u32 reg)
483 mul = (reg >> 16) & 0x7ff;
493 static u32 __init at91_usb_rate(struct clk *pll, u32 freq, u32 reg)
495 if (pll == &pllb && (reg & AT91_PMC_USB96M))
501 static unsigned __init at91_pll_calc(unsigned main_freq, unsigned out_freq)
503 unsigned i, div = 0, mul = 0, diff = 1 << 30;
504 unsigned ret = (out_freq > 155000000) ? 0xbe00 : 0x3e00;
506 /* PLL output max 240 MHz (or 180 MHz per errata) */
507 if (out_freq > 240000000)
510 for (i = 1; i < 256; i++) {
512 unsigned input, mul1;
515 * PLL input between 1MHz and 32MHz per spec, but lower
516 * frequences seem necessary in some cases so allow 100K.
517 * Warning: some newer products need 2MHz min.
519 input = main_freq / i;
520 if (cpu_is_at91sam9g20() && input < 2000000)
524 if (input > 32000000)
527 mul1 = out_freq / input;
528 if (cpu_is_at91sam9g20() && mul > 63)
535 diff1 = out_freq - input * mul1;
546 if (i == 256 && diff > (out_freq >> 5))
548 return ret | ((mul - 1) << 16) | div;
553 static struct clk *const standard_pmc_clocks[] __initdata = {
554 /* four primary clocks */
560 /* PLLB children (USB) */
568 int __init at91_clock_init(unsigned long main_clock)
570 unsigned tmp, freq, mckr;
574 * When the bootloader initialized the main oscillator correctly,
575 * there's no problem using the cycle counter. But if it didn't,
576 * or when using oscillator bypass mode, we must be told the speed
581 tmp = at91_sys_read(AT91_CKGR_MCFR);
582 } while (!(tmp & AT91_PMC_MAINRDY));
583 main_clock = (tmp & AT91_PMC_MAINF) * (AT91_SLOW_CLOCK / 16);
585 main_clk.rate_hz = main_clock;
587 /* report if PLLA is more than mildly overclocked */
588 plla.rate_hz = at91_pll_rate(&plla, main_clock, at91_sys_read(AT91_CKGR_PLLAR));
589 if ((!cpu_is_at91sam9g20() && plla.rate_hz > 209000000)
590 || (cpu_is_at91sam9g20() && plla.rate_hz > 800000000))
591 pr_info("Clocks: PLLA overclocked, %ld MHz\n", plla.rate_hz / 1000000);
594 * USB clock init: choose 48 MHz PLLB value,
595 * disable 48MHz clock during usb peripheral suspend.
597 * REVISIT: assumes MCK doesn't derive from PLLB!
599 at91_pllb_usb_init = at91_pll_calc(main_clock, 48000000 * 2) | AT91_PMC_USB96M;
600 pllb.rate_hz = at91_pll_rate(&pllb, main_clock, at91_pllb_usb_init);
601 if (cpu_is_at91rm9200()) {
602 uhpck.pmc_mask = AT91RM9200_PMC_UHP;
603 udpck.pmc_mask = AT91RM9200_PMC_UDP;
604 at91_sys_write(AT91_PMC_SCER, AT91RM9200_PMC_MCKUDP);
605 } else if (cpu_is_at91sam9260() || cpu_is_at91sam9261() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
606 uhpck.pmc_mask = AT91SAM926x_PMC_UHP;
607 udpck.pmc_mask = AT91SAM926x_PMC_UDP;
608 } else if (cpu_is_at91cap9()) {
609 uhpck.pmc_mask = AT91CAP9_PMC_UHP;
611 at91_sys_write(AT91_CKGR_PLLBR, 0);
613 udpck.rate_hz = at91_usb_rate(&pllb, pllb.rate_hz, at91_pllb_usb_init);
614 uhpck.rate_hz = at91_usb_rate(&pllb, pllb.rate_hz, at91_pllb_usb_init);
619 if (cpu_is_at91cap9() || cpu_is_at91sam9rl()) {
621 * multiplier is hard-wired to 40
622 * (obtain the USB High Speed 480 MHz when input is 12 MHz)
624 utmi_clk.rate_hz = 40 * utmi_clk.parent->rate_hz;
628 * MCK and CPU derive from one of those primary clocks.
629 * For now, assume this parentage won't change.
631 mckr = at91_sys_read(AT91_PMC_MCKR);
632 mck.parent = at91_css_to_clk(mckr & AT91_PMC_CSS);
633 freq = mck.parent->rate_hz;
634 freq /= (1 << ((mckr & AT91_PMC_PRES) >> 2)); /* prescale */
635 if (cpu_is_at91rm9200())
636 mck.rate_hz = freq / (1 + ((mckr & AT91_PMC_MDIV) >> 8)); /* mdiv */
637 else if (cpu_is_at91sam9g20()) {
638 mck.rate_hz = (mckr & AT91_PMC_MDIV) ?
639 freq / ((mckr & AT91_PMC_MDIV) >> 7) : freq; /* mdiv ; (x >> 7) = ((x >> 8) * 2) */
640 if (mckr & AT91_PMC_PDIV)
641 freq /= 2; /* processor clock division */
643 mck.rate_hz = freq / (1 << ((mckr & AT91_PMC_MDIV) >> 8)); /* mdiv */
645 /* Register the PMC's standard clocks */
646 for (i = 0; i < ARRAY_SIZE(standard_pmc_clocks); i++)
647 list_add_tail(&standard_pmc_clocks[i]->node, &clocks);
649 if (cpu_is_at91cap9() || cpu_is_at91sam9rl())
650 list_add_tail(&utmi_clk.node, &clocks);
652 /* MCK and CPU clock are "always on" */
655 printk("Clocks: CPU %u MHz, master %u MHz, main %u.%03u MHz\n",
656 freq / 1000000, (unsigned) mck.rate_hz / 1000000,
657 (unsigned) main_clock / 1000000,
658 ((unsigned) main_clock % 1000000) / 1000);
664 * Several unused clocks may be active. Turn them off.
666 static int __init at91_clock_reset(void)
668 unsigned long pcdr = 0;
669 unsigned long scdr = 0;
672 list_for_each_entry(clk, &clocks, node) {
676 if (clk->mode == pmc_periph_mode)
677 pcdr |= clk->pmc_mask;
679 if (clk->mode == pmc_sys_mode)
680 scdr |= clk->pmc_mask;
682 pr_debug("Clocks: disable unused %s\n", clk->name);
685 at91_sys_write(AT91_PMC_PCDR, pcdr);
686 at91_sys_write(AT91_PMC_SCDR, scdr);
690 late_initcall(at91_clock_reset);