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)
47 * Chips have some kind of clocks : group them by functionality
49 #define cpu_has_utmi() ( cpu_is_at91cap9() \
50 || cpu_is_at91sam9rl())
52 #define cpu_has_800M_plla() (cpu_is_at91sam9g20())
54 #define cpu_has_pllb() (!cpu_is_at91sam9rl())
56 #define cpu_has_upll() (0)
58 /* USB host HS & FS */
59 #define cpu_has_uhp() (!cpu_is_at91sam9rl())
61 /* USB device FS only */
62 #define cpu_has_udpfs() (!cpu_is_at91sam9rl())
65 static LIST_HEAD(clocks);
66 static DEFINE_SPINLOCK(clk_lock);
68 static u32 at91_pllb_usb_init;
71 * Four primary clock sources: two crystal oscillators (32K, main), and
72 * two PLLs. PLLA usually runs the master clock; and PLLB must run at
73 * 48 MHz (unless no USB function clocks are needed). The main clock and
74 * both PLLs are turned off to run in "slow clock mode" (system suspend).
76 static struct clk clk32k = {
78 .rate_hz = AT91_SLOW_CLOCK,
79 .users = 1, /* always on */
81 .type = CLK_TYPE_PRIMARY,
83 static struct clk main_clk = {
85 .pmc_mask = AT91_PMC_MOSCS, /* in PMC_SR */
87 .type = CLK_TYPE_PRIMARY,
89 static struct clk plla = {
92 .pmc_mask = AT91_PMC_LOCKA, /* in PMC_SR */
94 .type = CLK_TYPE_PRIMARY | CLK_TYPE_PLL,
97 static void pllb_mode(struct clk *clk, int is_on)
102 is_on = AT91_PMC_LOCKB;
103 value = at91_pllb_usb_init;
107 // REVISIT: Add work-around for AT91RM9200 Errata #26 ?
108 at91_sys_write(AT91_CKGR_PLLBR, value);
112 } while ((at91_sys_read(AT91_PMC_SR) & AT91_PMC_LOCKB) != is_on);
115 static struct clk pllb = {
118 .pmc_mask = AT91_PMC_LOCKB, /* in PMC_SR */
121 .type = CLK_TYPE_PRIMARY | CLK_TYPE_PLL,
124 static void pmc_sys_mode(struct clk *clk, int is_on)
127 at91_sys_write(AT91_PMC_SCER, clk->pmc_mask);
129 at91_sys_write(AT91_PMC_SCDR, clk->pmc_mask);
132 static void pmc_uckr_mode(struct clk *clk, int is_on)
134 unsigned int uckr = at91_sys_read(AT91_CKGR_UCKR);
137 is_on = AT91_PMC_LOCKU;
138 at91_sys_write(AT91_CKGR_UCKR, uckr | clk->pmc_mask);
140 at91_sys_write(AT91_CKGR_UCKR, uckr & ~(clk->pmc_mask));
144 } while ((at91_sys_read(AT91_PMC_SR) & AT91_PMC_LOCKU) != is_on);
147 /* USB function clocks (PLLB must be 48 MHz) */
148 static struct clk udpck = {
151 .mode = pmc_sys_mode,
153 static struct clk utmi_clk = {
156 .pmc_mask = AT91_PMC_UPLLEN, /* in CKGR_UCKR */
157 .mode = pmc_uckr_mode,
158 .type = CLK_TYPE_PLL,
160 static struct clk uhpck = {
162 /*.parent = ... we choose parent at runtime */
163 .mode = pmc_sys_mode,
168 * The master clock is divided from the CPU clock (by 1-4). It's used for
169 * memory, interfaces to on-chip peripherals, the AIC, and sometimes more
170 * (e.g baud rate generation). It's sourced from one of the primary clocks.
172 static struct clk mck = {
174 .pmc_mask = AT91_PMC_MCKRDY, /* in PMC_SR */
177 static void pmc_periph_mode(struct clk *clk, int is_on)
180 at91_sys_write(AT91_PMC_PCER, clk->pmc_mask);
182 at91_sys_write(AT91_PMC_PCDR, clk->pmc_mask);
185 static struct clk __init *at91_css_to_clk(unsigned long css)
188 case AT91_PMC_CSS_SLOW:
190 case AT91_PMC_CSS_MAIN:
192 case AT91_PMC_CSS_PLLA:
194 case AT91_PMC_CSS_PLLB:
196 /* CSS_PLLB == CSS_UPLL */
198 else if (cpu_has_pllb())
206 * Associate a particular clock with a function (eg, "uart") and device.
207 * The drivers can then request the same 'function' with several different
208 * devices and not care about which clock name to use.
210 void __init at91_clock_associate(const char *id, struct device *dev, const char *func)
212 struct clk *clk = clk_get(NULL, id);
214 if (!dev || !clk || !IS_ERR(clk_get(dev, func)))
217 clk->function = func;
221 /* clocks cannot be de-registered no refcounting necessary */
222 struct clk *clk_get(struct device *dev, const char *id)
226 list_for_each_entry(clk, &clocks, node) {
227 if (strcmp(id, clk->name) == 0)
229 if (clk->function && (dev == clk->dev) && strcmp(id, clk->function) == 0)
233 return ERR_PTR(-ENOENT);
235 EXPORT_SYMBOL(clk_get);
237 void clk_put(struct clk *clk)
240 EXPORT_SYMBOL(clk_put);
242 static void __clk_enable(struct clk *clk)
245 __clk_enable(clk->parent);
246 if (clk->users++ == 0 && clk->mode)
250 int clk_enable(struct clk *clk)
254 spin_lock_irqsave(&clk_lock, flags);
256 spin_unlock_irqrestore(&clk_lock, flags);
259 EXPORT_SYMBOL(clk_enable);
261 static void __clk_disable(struct clk *clk)
263 BUG_ON(clk->users == 0);
264 if (--clk->users == 0 && clk->mode)
267 __clk_disable(clk->parent);
270 void clk_disable(struct clk *clk)
274 spin_lock_irqsave(&clk_lock, flags);
276 spin_unlock_irqrestore(&clk_lock, flags);
278 EXPORT_SYMBOL(clk_disable);
280 unsigned long clk_get_rate(struct clk *clk)
285 spin_lock_irqsave(&clk_lock, flags);
288 if (rate || !clk->parent)
292 spin_unlock_irqrestore(&clk_lock, flags);
295 EXPORT_SYMBOL(clk_get_rate);
297 /*------------------------------------------------------------------------*/
299 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
302 * For now, only the programmable clocks support reparenting (MCK could
303 * do this too, with care) or rate changing (the PLLs could do this too,
304 * ditto MCK but that's more for cpufreq). Drivers may reparent to get
305 * a better rate match; we don't.
308 long clk_round_rate(struct clk *clk, unsigned long rate)
312 unsigned long actual;
314 if (!clk_is_programmable(clk))
316 spin_lock_irqsave(&clk_lock, flags);
318 actual = clk->parent->rate_hz;
319 for (prescale = 0; prescale < 7; prescale++) {
320 if (actual && actual <= rate)
325 spin_unlock_irqrestore(&clk_lock, flags);
326 return (prescale < 7) ? actual : -ENOENT;
328 EXPORT_SYMBOL(clk_round_rate);
330 int clk_set_rate(struct clk *clk, unsigned long rate)
334 unsigned long actual;
336 if (!clk_is_programmable(clk))
340 spin_lock_irqsave(&clk_lock, flags);
342 actual = clk->parent->rate_hz;
343 for (prescale = 0; prescale < 7; prescale++) {
344 if (actual && actual <= rate) {
347 pckr = at91_sys_read(AT91_PMC_PCKR(clk->id));
348 pckr &= AT91_PMC_CSS; /* clock selection */
349 pckr |= prescale << 2;
350 at91_sys_write(AT91_PMC_PCKR(clk->id), pckr);
351 clk->rate_hz = actual;
357 spin_unlock_irqrestore(&clk_lock, flags);
358 return (prescale < 7) ? actual : -ENOENT;
360 EXPORT_SYMBOL(clk_set_rate);
362 struct clk *clk_get_parent(struct clk *clk)
366 EXPORT_SYMBOL(clk_get_parent);
368 int clk_set_parent(struct clk *clk, struct clk *parent)
374 if (!clk_is_primary(parent) || !clk_is_programmable(clk))
376 spin_lock_irqsave(&clk_lock, flags);
378 clk->rate_hz = parent->rate_hz;
379 clk->parent = parent;
380 at91_sys_write(AT91_PMC_PCKR(clk->id), parent->id);
382 spin_unlock_irqrestore(&clk_lock, flags);
385 EXPORT_SYMBOL(clk_set_parent);
387 /* establish PCK0..PCKN parentage and rate */
388 static void __init init_programmable_clock(struct clk *clk)
393 pckr = at91_sys_read(AT91_PMC_PCKR(clk->id));
394 parent = at91_css_to_clk(pckr & AT91_PMC_CSS);
395 clk->parent = parent;
396 clk->rate_hz = parent->rate_hz / (1 << ((pckr & AT91_PMC_PRES) >> 2));
399 #endif /* CONFIG_AT91_PROGRAMMABLE_CLOCKS */
401 /*------------------------------------------------------------------------*/
403 #ifdef CONFIG_DEBUG_FS
405 static int at91_clk_show(struct seq_file *s, void *unused)
407 u32 scsr, pcsr, uckr = 0, sr;
410 seq_printf(s, "SCSR = %8x\n", scsr = at91_sys_read(AT91_PMC_SCSR));
411 seq_printf(s, "PCSR = %8x\n", pcsr = at91_sys_read(AT91_PMC_PCSR));
412 seq_printf(s, "MOR = %8x\n", at91_sys_read(AT91_CKGR_MOR));
413 seq_printf(s, "MCFR = %8x\n", at91_sys_read(AT91_CKGR_MCFR));
414 seq_printf(s, "PLLA = %8x\n", at91_sys_read(AT91_CKGR_PLLAR));
416 seq_printf(s, "PLLB = %8x\n", at91_sys_read(AT91_CKGR_PLLBR));
418 seq_printf(s, "UCKR = %8x\n", uckr = at91_sys_read(AT91_CKGR_UCKR));
419 seq_printf(s, "MCKR = %8x\n", at91_sys_read(AT91_PMC_MCKR));
421 seq_printf(s, "USB = %8x\n", at91_sys_read(AT91_PMC_USB));
422 seq_printf(s, "SR = %8x\n", sr = at91_sys_read(AT91_PMC_SR));
426 list_for_each_entry(clk, &clocks, node) {
429 if (clk->mode == pmc_sys_mode)
430 state = (scsr & clk->pmc_mask) ? "on" : "off";
431 else if (clk->mode == pmc_periph_mode)
432 state = (pcsr & clk->pmc_mask) ? "on" : "off";
433 else if (clk->mode == pmc_uckr_mode)
434 state = (uckr & clk->pmc_mask) ? "on" : "off";
435 else if (clk->pmc_mask)
436 state = (sr & clk->pmc_mask) ? "on" : "off";
437 else if (clk == &clk32k || clk == &main_clk)
442 seq_printf(s, "%-10s users=%2d %-3s %9ld Hz %s\n",
443 clk->name, clk->users, state, clk_get_rate(clk),
444 clk->parent ? clk->parent->name : "");
449 static int at91_clk_open(struct inode *inode, struct file *file)
451 return single_open(file, at91_clk_show, NULL);
454 static const struct file_operations at91_clk_operations = {
455 .open = at91_clk_open,
458 .release = single_release,
461 static int __init at91_clk_debugfs_init(void)
463 /* /sys/kernel/debug/at91_clk */
464 (void) debugfs_create_file("at91_clk", S_IFREG | S_IRUGO, NULL, NULL, &at91_clk_operations);
468 postcore_initcall(at91_clk_debugfs_init);
472 /*------------------------------------------------------------------------*/
474 /* Register a new clock */
475 int __init clk_register(struct clk *clk)
477 if (clk_is_peripheral(clk)) {
479 clk->mode = pmc_periph_mode;
480 list_add_tail(&clk->node, &clocks);
482 else if (clk_is_sys(clk)) {
484 clk->mode = pmc_sys_mode;
486 list_add_tail(&clk->node, &clocks);
488 #ifdef CONFIG_AT91_PROGRAMMABLE_CLOCKS
489 else if (clk_is_programmable(clk)) {
490 clk->mode = pmc_sys_mode;
491 init_programmable_clock(clk);
492 list_add_tail(&clk->node, &clocks);
500 /*------------------------------------------------------------------------*/
502 static u32 __init at91_pll_rate(struct clk *pll, u32 freq, u32 reg)
507 mul = (reg >> 16) & 0x7ff;
517 static u32 __init at91_usb_rate(struct clk *pll, u32 freq, u32 reg)
519 if (pll == &pllb && (reg & AT91_PMC_USB96M))
525 static unsigned __init at91_pll_calc(unsigned main_freq, unsigned out_freq)
527 unsigned i, div = 0, mul = 0, diff = 1 << 30;
528 unsigned ret = (out_freq > 155000000) ? 0xbe00 : 0x3e00;
530 /* PLL output max 240 MHz (or 180 MHz per errata) */
531 if (out_freq > 240000000)
534 for (i = 1; i < 256; i++) {
536 unsigned input, mul1;
539 * PLL input between 1MHz and 32MHz per spec, but lower
540 * frequences seem necessary in some cases so allow 100K.
541 * Warning: some newer products need 2MHz min.
543 input = main_freq / i;
544 if (cpu_is_at91sam9g20() && input < 2000000)
548 if (input > 32000000)
551 mul1 = out_freq / input;
552 if (cpu_is_at91sam9g20() && mul > 63)
559 diff1 = out_freq - input * mul1;
570 if (i == 256 && diff > (out_freq >> 5))
572 return ret | ((mul - 1) << 16) | div;
577 static struct clk *const standard_pmc_clocks[] __initdata = {
578 /* four primary clocks */
587 /* PLLB generated USB full speed clock init */
588 static void __init at91_pllb_usbfs_clock_init(unsigned long main_clock)
591 * USB clock init: choose 48 MHz PLLB value,
592 * disable 48MHz clock during usb peripheral suspend.
594 * REVISIT: assumes MCK doesn't derive from PLLB!
596 uhpck.parent = &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);
616 /* UPLL generated USB full speed clock init */
617 static void __init at91_upll_usbfs_clock_init(unsigned long main_clock)
620 * USB clock init: choose 480 MHz from UPLL,
622 unsigned int usbr = AT91_PMC_USBS_UPLL;
624 /* Setup divider by 10 to reach 48 MHz */
625 usbr |= ((10 - 1) << 8) & AT91_PMC_OHCIUSBDIV;
627 at91_sys_write(AT91_PMC_USB, usbr);
629 /* Now set uhpck values */
630 uhpck.parent = &utmi_clk;
631 uhpck.pmc_mask = AT91SAM926x_PMC_UHP;
632 uhpck.rate_hz = utmi_clk.parent->rate_hz;
633 uhpck.rate_hz /= 1 + ((at91_sys_read(AT91_PMC_USB) & AT91_PMC_OHCIUSBDIV) >> 8);
636 int __init at91_clock_init(unsigned long main_clock)
638 unsigned tmp, freq, mckr;
642 * When the bootloader initialized the main oscillator correctly,
643 * there's no problem using the cycle counter. But if it didn't,
644 * or when using oscillator bypass mode, we must be told the speed
649 tmp = at91_sys_read(AT91_CKGR_MCFR);
650 } while (!(tmp & AT91_PMC_MAINRDY));
651 main_clock = (tmp & AT91_PMC_MAINF) * (AT91_SLOW_CLOCK / 16);
653 main_clk.rate_hz = main_clock;
655 /* report if PLLA is more than mildly overclocked */
656 plla.rate_hz = at91_pll_rate(&plla, main_clock, at91_sys_read(AT91_CKGR_PLLAR));
657 if ((!cpu_has_800M_plla() && plla.rate_hz > 209000000)
658 || (cpu_has_800M_plla() && plla.rate_hz > 800000000))
659 pr_info("Clocks: PLLA overclocked, %ld MHz\n", plla.rate_hz / 1000000);
662 if (cpu_has_upll() && !cpu_has_pllb()) {
663 /* setup UTMI clock as the fourth primary clock
664 * (instead of pllb) */
665 utmi_clk.type |= CLK_TYPE_PRIMARY;
675 * multiplier is hard-wired to 40
676 * (obtain the USB High Speed 480 MHz when input is 12 MHz)
678 utmi_clk.rate_hz = 40 * utmi_clk.parent->rate_hz;
684 at91_pllb_usbfs_clock_init(main_clock);
686 /* assumes that we choose UPLL for USB and not PLLA */
687 at91_upll_usbfs_clock_init(main_clock);
690 * MCK and CPU derive from one of those primary clocks.
691 * For now, assume this parentage won't change.
693 mckr = at91_sys_read(AT91_PMC_MCKR);
694 mck.parent = at91_css_to_clk(mckr & AT91_PMC_CSS);
695 freq = mck.parent->rate_hz;
696 freq /= (1 << ((mckr & AT91_PMC_PRES) >> 2)); /* prescale */
697 if (cpu_is_at91rm9200()) {
698 mck.rate_hz = freq / (1 + ((mckr & AT91_PMC_MDIV) >> 8)); /* mdiv */
699 } else if (cpu_is_at91sam9g20()) {
700 mck.rate_hz = (mckr & AT91_PMC_MDIV) ?
701 freq / ((mckr & AT91_PMC_MDIV) >> 7) : freq; /* mdiv ; (x >> 7) = ((x >> 8) * 2) */
702 if (mckr & AT91_PMC_PDIV)
703 freq /= 2; /* processor clock division */
705 mck.rate_hz = freq / (1 << ((mckr & AT91_PMC_MDIV) >> 8)); /* mdiv */
708 /* Register the PMC's standard clocks */
709 for (i = 0; i < ARRAY_SIZE(standard_pmc_clocks); i++)
710 list_add_tail(&standard_pmc_clocks[i]->node, &clocks);
713 list_add_tail(&pllb.node, &clocks);
716 list_add_tail(&uhpck.node, &clocks);
719 list_add_tail(&udpck.node, &clocks);
722 list_add_tail(&utmi_clk.node, &clocks);
724 /* MCK and CPU clock are "always on" */
727 printk("Clocks: CPU %u MHz, master %u MHz, main %u.%03u MHz\n",
728 freq / 1000000, (unsigned) mck.rate_hz / 1000000,
729 (unsigned) main_clock / 1000000,
730 ((unsigned) main_clock % 1000000) / 1000);
736 * Several unused clocks may be active. Turn them off.
738 static int __init at91_clock_reset(void)
740 unsigned long pcdr = 0;
741 unsigned long scdr = 0;
744 list_for_each_entry(clk, &clocks, node) {
748 if (clk->mode == pmc_periph_mode)
749 pcdr |= clk->pmc_mask;
751 if (clk->mode == pmc_sys_mode)
752 scdr |= clk->pmc_mask;
754 pr_debug("Clocks: disable unused %s\n", clk->name);
757 at91_sys_write(AT91_PMC_PCDR, pcdr);
758 at91_sys_write(AT91_PMC_SCDR, scdr);
762 late_initcall(at91_clock_reset);