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>
26 #include <asm/semaphore.h>
28 #include <asm/mach-types.h>
30 #include <asm/hardware.h>
31 #include <asm/arch/at91_pmc.h>
32 #include <asm/arch/cpu.h>
38 * There's a lot more which can be done with clocks, including cpufreq
39 * integration, slow clock mode support (for system suspend), letting
40 * PLLB be used at other rates (on boards that don't need USB), etc.
43 #define clk_is_primary(x) ((x)->type & CLK_TYPE_PRIMARY)
44 #define clk_is_programmable(x) ((x)->type & CLK_TYPE_PROGRAMMABLE)
45 #define clk_is_peripheral(x) ((x)->type & CLK_TYPE_PERIPHERAL)
46 #define clk_is_sys(x) ((x)->type & CLK_TYPE_SYSTEM)
49 static LIST_HEAD(clocks);
50 static DEFINE_SPINLOCK(clk_lock);
52 static u32 at91_pllb_usb_init;
55 * Four primary clock sources: two crystal oscillators (32K, main), and
56 * two PLLs. PLLA usually runs the master clock; and PLLB must run at
57 * 48 MHz (unless no USB function clocks are needed). The main clock and
58 * both PLLs are turned off to run in "slow clock mode" (system suspend).
60 static struct clk clk32k = {
62 .rate_hz = AT91_SLOW_CLOCK,
63 .users = 1, /* always on */
65 .type = CLK_TYPE_PRIMARY,
67 static struct clk main_clk = {
69 .pmc_mask = AT91_PMC_MOSCS, /* in PMC_SR */
71 .type = CLK_TYPE_PRIMARY,
73 static struct clk plla = {
76 .pmc_mask = AT91_PMC_LOCKA, /* in PMC_SR */
78 .type = CLK_TYPE_PRIMARY | CLK_TYPE_PLL,
81 static void pllb_mode(struct clk *clk, int is_on)
86 is_on = AT91_PMC_LOCKB;
87 value = at91_pllb_usb_init;
91 // REVISIT: Add work-around for AT91RM9200 Errata #26 ?
92 at91_sys_write(AT91_CKGR_PLLBR, value);
96 } while ((at91_sys_read(AT91_PMC_SR) & AT91_PMC_LOCKB) != is_on);
99 static struct clk pllb = {
102 .pmc_mask = AT91_PMC_LOCKB, /* in PMC_SR */
105 .type = CLK_TYPE_PRIMARY | CLK_TYPE_PLL,
108 static void pmc_sys_mode(struct clk *clk, int is_on)
111 at91_sys_write(AT91_PMC_SCER, clk->pmc_mask);
113 at91_sys_write(AT91_PMC_SCDR, clk->pmc_mask);
116 /* USB function clocks (PLLB must be 48 MHz) */
117 static struct clk udpck = {
120 .mode = pmc_sys_mode,
122 static struct clk uhpck = {
125 .mode = pmc_sys_mode,
130 * The master clock is divided from the CPU clock (by 1-4). It's used for
131 * memory, interfaces to on-chip peripherals, the AIC, and sometimes more
132 * (e.g baud rate generation). It's sourced from one of the primary clocks.
134 static struct clk mck = {
136 .pmc_mask = AT91_PMC_MCKRDY, /* in PMC_SR */
139 static void pmc_periph_mode(struct clk *clk, int is_on)
142 at91_sys_write(AT91_PMC_PCER, clk->pmc_mask);
144 at91_sys_write(AT91_PMC_PCDR, clk->pmc_mask);
147 static struct clk __init *at91_css_to_clk(unsigned long css)
150 case AT91_PMC_CSS_SLOW:
152 case AT91_PMC_CSS_MAIN:
154 case AT91_PMC_CSS_PLLA:
156 case AT91_PMC_CSS_PLLB:
164 * Associate a particular clock with a function (eg, "uart") and device.
165 * The drivers can then request the same 'function' with several different
166 * devices and not care about which clock name to use.
168 void __init at91_clock_associate(const char *id, struct device *dev, const char *func)
170 struct clk *clk = clk_get(NULL, id);
172 if (!dev || !clk || !IS_ERR(clk_get(dev, func)))
175 clk->function = func;
179 /* clocks cannot be de-registered no refcounting necessary */
180 struct clk *clk_get(struct device *dev, const char *id)
184 list_for_each_entry(clk, &clocks, node) {
185 if (strcmp(id, clk->name) == 0)
187 if (clk->function && (dev == clk->dev) && strcmp(id, clk->function) == 0)
191 return ERR_PTR(-ENOENT);
193 EXPORT_SYMBOL(clk_get);
195 void clk_put(struct clk *clk)
198 EXPORT_SYMBOL(clk_put);
200 static void __clk_enable(struct clk *clk)
203 __clk_enable(clk->parent);
204 if (clk->users++ == 0 && clk->mode)
208 int clk_enable(struct clk *clk)
212 spin_lock_irqsave(&clk_lock, flags);
214 spin_unlock_irqrestore(&clk_lock, flags);
217 EXPORT_SYMBOL(clk_enable);
219 static void __clk_disable(struct clk *clk)
221 BUG_ON(clk->users == 0);
222 if (--clk->users == 0 && clk->mode)
225 __clk_disable(clk->parent);
228 void clk_disable(struct clk *clk)
232 spin_lock_irqsave(&clk_lock, flags);
234 spin_unlock_irqrestore(&clk_lock, flags);
236 EXPORT_SYMBOL(clk_disable);
238 unsigned long clk_get_rate(struct clk *clk)
243 spin_lock_irqsave(&clk_lock, flags);
246 if (rate || !clk->parent)
250 spin_unlock_irqrestore(&clk_lock, flags);
253 EXPORT_SYMBOL(clk_get_rate);
255 /*------------------------------------------------------------------------*/
257 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
260 * For now, only the programmable clocks support reparenting (MCK could
261 * do this too, with care) or rate changing (the PLLs could do this too,
262 * ditto MCK but that's more for cpufreq). Drivers may reparent to get
263 * a better rate match; we don't.
266 long clk_round_rate(struct clk *clk, unsigned long rate)
270 unsigned long actual;
272 if (!clk_is_programmable(clk))
274 spin_lock_irqsave(&clk_lock, flags);
276 actual = clk->parent->rate_hz;
277 for (prescale = 0; prescale < 7; prescale++) {
278 if (actual && actual <= rate)
283 spin_unlock_irqrestore(&clk_lock, flags);
284 return (prescale < 7) ? actual : -ENOENT;
286 EXPORT_SYMBOL(clk_round_rate);
288 int clk_set_rate(struct clk *clk, unsigned long rate)
292 unsigned long actual;
294 if (!clk_is_programmable(clk))
298 spin_lock_irqsave(&clk_lock, flags);
300 actual = clk->parent->rate_hz;
301 for (prescale = 0; prescale < 7; prescale++) {
302 if (actual && actual <= rate) {
305 pckr = at91_sys_read(AT91_PMC_PCKR(clk->id));
306 pckr &= AT91_PMC_CSS_PLLB; /* clock selection */
307 pckr |= prescale << 2;
308 at91_sys_write(AT91_PMC_PCKR(clk->id), pckr);
309 clk->rate_hz = actual;
315 spin_unlock_irqrestore(&clk_lock, flags);
316 return (prescale < 7) ? actual : -ENOENT;
318 EXPORT_SYMBOL(clk_set_rate);
320 struct clk *clk_get_parent(struct clk *clk)
324 EXPORT_SYMBOL(clk_get_parent);
326 int clk_set_parent(struct clk *clk, struct clk *parent)
332 if (!clk_is_primary(parent) || !clk_is_programmable(clk))
334 spin_lock_irqsave(&clk_lock, flags);
336 clk->rate_hz = parent->rate_hz;
337 clk->parent = parent;
338 at91_sys_write(AT91_PMC_PCKR(clk->id), parent->id);
340 spin_unlock_irqrestore(&clk_lock, flags);
343 EXPORT_SYMBOL(clk_set_parent);
345 /* establish PCK0..PCK3 parentage and rate */
346 static void init_programmable_clock(struct clk *clk)
351 pckr = at91_sys_read(AT91_PMC_PCKR(clk->id));
352 parent = at91_css_to_clk(pckr & AT91_PMC_CSS);
353 clk->parent = parent;
354 clk->rate_hz = parent->rate_hz / (1 << ((pckr >> 2) & 3));
357 #endif /* CONFIG_AT91_PROGRAMMABLE_CLOCKS */
359 /*------------------------------------------------------------------------*/
361 #ifdef CONFIG_DEBUG_FS
363 static int at91_clk_show(struct seq_file *s, void *unused)
369 seq_printf(s, "SCSR = %8x\n", scsr = at91_sys_read(AT91_PMC_SCSR));
370 seq_printf(s, "PCSR = %8x\n", pcsr = at91_sys_read(AT91_PMC_PCSR));
372 seq_printf(s, "MOR = %8x\n", at91_sys_read(AT91_CKGR_MOR));
373 seq_printf(s, "MCFR = %8x\n", at91_sys_read(AT91_CKGR_MCFR));
374 seq_printf(s, "PLLA = %8x\n", at91_sys_read(AT91_CKGR_PLLAR));
375 seq_printf(s, "PLLB = %8x\n", at91_sys_read(AT91_CKGR_PLLBR));
377 seq_printf(s, "MCKR = %8x\n", at91_sys_read(AT91_PMC_MCKR));
378 for (i = 0; i < 4; i++)
379 seq_printf(s, "PCK%d = %8x\n", i, at91_sys_read(AT91_PMC_PCKR(i)));
380 seq_printf(s, "SR = %8x\n", sr = at91_sys_read(AT91_PMC_SR));
384 list_for_each_entry(clk, &clocks, node) {
387 if (clk->mode == pmc_sys_mode)
388 state = (scsr & clk->pmc_mask) ? "on" : "off";
389 else if (clk->mode == pmc_periph_mode)
390 state = (pcsr & clk->pmc_mask) ? "on" : "off";
391 else if (clk->pmc_mask)
392 state = (sr & clk->pmc_mask) ? "on" : "off";
393 else if (clk == &clk32k || clk == &main_clk)
398 seq_printf(s, "%-10s users=%2d %-3s %9ld Hz %s\n",
399 clk->name, clk->users, state, clk_get_rate(clk),
400 clk->parent ? clk->parent->name : "");
405 static int at91_clk_open(struct inode *inode, struct file *file)
407 return single_open(file, at91_clk_show, NULL);
410 static struct file_operations at91_clk_operations = {
411 .open = at91_clk_open,
414 .release = single_release,
417 static int __init at91_clk_debugfs_init(void)
419 /* /sys/kernel/debug/at91_clk */
420 (void) debugfs_create_file("at91_clk", S_IFREG | S_IRUGO, NULL, NULL, &at91_clk_operations);
424 postcore_initcall(at91_clk_debugfs_init);
428 /*------------------------------------------------------------------------*/
430 /* Register a new clock */
431 int __init clk_register(struct clk *clk)
433 if (clk_is_peripheral(clk)) {
435 clk->mode = pmc_periph_mode;
436 list_add_tail(&clk->node, &clocks);
438 else if (clk_is_sys(clk)) {
440 clk->mode = pmc_sys_mode;
442 list_add_tail(&clk->node, &clocks);
444 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
445 else if (clk_is_programmable(clk)) {
446 clk->mode = pmc_sys_mode;
447 init_programmable_clock(clk);
448 list_add_tail(&clk->node, &clocks);
456 /*------------------------------------------------------------------------*/
458 static u32 __init at91_pll_rate(struct clk *pll, u32 freq, u32 reg)
463 mul = (reg >> 16) & 0x7ff;
473 static u32 __init at91_usb_rate(struct clk *pll, u32 freq, u32 reg)
475 if (pll == &pllb && (reg & AT91_PMC_USB96M))
481 static unsigned __init at91_pll_calc(unsigned main_freq, unsigned out_freq)
483 unsigned i, div = 0, mul = 0, diff = 1 << 30;
484 unsigned ret = (out_freq > 155000000) ? 0xbe00 : 0x3e00;
486 /* PLL output max 240 MHz (or 180 MHz per errata) */
487 if (out_freq > 240000000)
490 for (i = 1; i < 256; i++) {
492 unsigned input, mul1;
495 * PLL input between 1MHz and 32MHz per spec, but lower
496 * frequences seem necessary in some cases so allow 100K.
498 input = main_freq / i;
501 if (input > 32000000)
504 mul1 = out_freq / input;
510 diff1 = out_freq - input * mul1;
521 if (i == 256 && diff > (out_freq >> 5))
523 return ret | ((mul - 1) << 16) | div;
529 * Several unused clocks may be active. Turn them off.
531 static void __init at91_periphclk_reset(void)
536 reg = at91_sys_read(AT91_PMC_PCSR);
538 list_for_each_entry(clk, &clocks, node) {
539 if (clk->mode != pmc_periph_mode)
543 reg &= ~clk->pmc_mask;
546 at91_sys_write(AT91_PMC_PCDR, reg);
549 static struct clk *const standard_pmc_clocks[] __initdata = {
550 /* four primary clocks */
556 /* PLLB children (USB) */
564 int __init at91_clock_init(unsigned long main_clock)
566 unsigned tmp, freq, mckr;
570 * When the bootloader initialized the main oscillator correctly,
571 * there's no problem using the cycle counter. But if it didn't,
572 * or when using oscillator bypass mode, we must be told the speed
577 tmp = at91_sys_read(AT91_CKGR_MCFR);
578 } while (!(tmp & AT91_PMC_MAINRDY));
579 main_clock = (tmp & AT91_PMC_MAINF) * (AT91_SLOW_CLOCK / 16);
581 main_clk.rate_hz = main_clock;
583 /* report if PLLA is more than mildly overclocked */
584 plla.rate_hz = at91_pll_rate(&plla, main_clock, at91_sys_read(AT91_CKGR_PLLAR));
585 if (plla.rate_hz > 209000000)
586 pr_info("Clocks: PLLA overclocked, %ld MHz\n", plla.rate_hz / 1000000);
589 * USB clock init: choose 48 MHz PLLB value, turn all clocks off,
590 * disable 48MHz clock during usb peripheral suspend.
592 * REVISIT: assumes MCK doesn't derive from PLLB!
594 at91_pllb_usb_init = at91_pll_calc(main_clock, 48000000 * 2) | AT91_PMC_USB96M;
595 pllb.rate_hz = at91_pll_rate(&pllb, main_clock, at91_pllb_usb_init);
596 if (cpu_is_at91rm9200()) {
597 uhpck.pmc_mask = AT91RM9200_PMC_UHP;
598 udpck.pmc_mask = AT91RM9200_PMC_UDP;
599 at91_sys_write(AT91_PMC_SCDR, AT91RM9200_PMC_UHP | AT91RM9200_PMC_UDP);
600 at91_sys_write(AT91_PMC_SCER, AT91RM9200_PMC_MCKUDP);
601 } else if (cpu_is_at91sam9260() || cpu_is_at91sam9263()) {
602 uhpck.pmc_mask = AT91SAM926x_PMC_UHP;
603 udpck.pmc_mask = AT91SAM926x_PMC_UDP;
604 at91_sys_write(AT91_PMC_SCDR, AT91SAM926x_PMC_UHP | AT91SAM926x_PMC_UDP);
605 } else if (cpu_is_at91sam9261()) {
606 uhpck.pmc_mask = (AT91SAM926x_PMC_UHP | AT91_PMC_HCK0);
607 udpck.pmc_mask = AT91SAM926x_PMC_UDP;
608 at91_sys_write(AT91_PMC_SCDR, AT91SAM926x_PMC_UHP | AT91_PMC_HCK0 | AT91SAM926x_PMC_UDP);
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);
616 * MCK and CPU derive from one of those primary clocks.
617 * For now, assume this parentage won't change.
619 mckr = at91_sys_read(AT91_PMC_MCKR);
620 mck.parent = at91_css_to_clk(mckr & AT91_PMC_CSS);
621 freq = mck.parent->rate_hz;
622 freq /= (1 << ((mckr >> 2) & 3)); /* prescale */
623 mck.rate_hz = freq / (1 + ((mckr >> 8) & 3)); /* mdiv */
625 /* Register the PMC's standard clocks */
626 for (i = 0; i < ARRAY_SIZE(standard_pmc_clocks); i++)
627 list_add_tail(&standard_pmc_clocks[i]->node, &clocks);
629 /* MCK and CPU clock are "always on" */
632 printk("Clocks: CPU %u MHz, master %u MHz, main %u.%03u MHz\n",
633 freq / 1000000, (unsigned) mck.rate_hz / 1000000,
634 (unsigned) main_clock / 1000000,
635 ((unsigned) main_clock % 1000000) / 1000);
637 /* disable all programmable clocks */
638 at91_sys_write(AT91_PMC_SCDR, AT91_PMC_PCK0 | AT91_PMC_PCK1 | AT91_PMC_PCK2 | AT91_PMC_PCK3);
640 /* disable all other unused peripheral clocks */
641 at91_periphclk_reset();