2 * linux/arch/arm/plat-omap/clock.c
4 * Copyright (C) 2004 - 2008 Nokia corporation
5 * Written by Tuukka Tikkanen <tuukka.tikkanen@elektrobit.com>
7 * Modified for omap shared clock framework by Tony Lindgren <tony@atomide.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 #include <linux/kernel.h>
14 #include <linux/init.h>
15 #include <linux/module.h>
16 #include <linux/list.h>
17 #include <linux/errno.h>
18 #include <linux/err.h>
19 #include <linux/string.h>
20 #include <linux/clk.h>
21 #include <linux/mutex.h>
22 #include <linux/platform_device.h>
23 #include <linux/cpufreq.h>
24 #include <linux/debugfs.h>
27 #include <plat/clock.h>
29 static LIST_HEAD(clocks);
30 static DEFINE_MUTEX(clocks_mutex);
31 static DEFINE_SPINLOCK(clockfw_lock);
33 static struct clk_functions *arch_clock;
35 /*-------------------------------------------------------------------------
36 * Standard clock functions defined in include/linux/clk.h
37 *-------------------------------------------------------------------------*/
39 int clk_enable(struct clk *clk)
44 if (clk == NULL || IS_ERR(clk))
47 spin_lock_irqsave(&clockfw_lock, flags);
48 if (arch_clock->clk_enable)
49 ret = arch_clock->clk_enable(clk);
50 spin_unlock_irqrestore(&clockfw_lock, flags);
54 EXPORT_SYMBOL(clk_enable);
56 void clk_disable(struct clk *clk)
60 if (clk == NULL || IS_ERR(clk))
63 spin_lock_irqsave(&clockfw_lock, flags);
64 if (clk->usecount == 0) {
65 printk(KERN_ERR "Trying disable clock %s with 0 usecount\n",
71 if (arch_clock->clk_disable)
72 arch_clock->clk_disable(clk);
75 spin_unlock_irqrestore(&clockfw_lock, flags);
77 EXPORT_SYMBOL(clk_disable);
79 unsigned long clk_get_rate(struct clk *clk)
82 unsigned long ret = 0;
84 if (clk == NULL || IS_ERR(clk))
87 spin_lock_irqsave(&clockfw_lock, flags);
89 spin_unlock_irqrestore(&clockfw_lock, flags);
93 EXPORT_SYMBOL(clk_get_rate);
95 /*-------------------------------------------------------------------------
96 * Optional clock functions defined in include/linux/clk.h
97 *-------------------------------------------------------------------------*/
99 long clk_round_rate(struct clk *clk, unsigned long rate)
104 if (clk == NULL || IS_ERR(clk))
107 spin_lock_irqsave(&clockfw_lock, flags);
108 if (arch_clock->clk_round_rate)
109 ret = arch_clock->clk_round_rate(clk, rate);
110 spin_unlock_irqrestore(&clockfw_lock, flags);
114 EXPORT_SYMBOL(clk_round_rate);
116 int clk_set_rate(struct clk *clk, unsigned long rate)
121 if (clk == NULL || IS_ERR(clk))
124 spin_lock_irqsave(&clockfw_lock, flags);
125 if (arch_clock->clk_set_rate)
126 ret = arch_clock->clk_set_rate(clk, rate);
129 clk->rate = clk->recalc(clk);
132 spin_unlock_irqrestore(&clockfw_lock, flags);
136 EXPORT_SYMBOL(clk_set_rate);
138 int clk_set_parent(struct clk *clk, struct clk *parent)
143 if (cpu_is_omap44xx())
144 /* OMAP4 clk framework not supported yet */
146 if (clk == NULL || IS_ERR(clk) || parent == NULL || IS_ERR(parent))
149 spin_lock_irqsave(&clockfw_lock, flags);
150 if (clk->usecount == 0) {
151 if (arch_clock->clk_set_parent)
152 ret = arch_clock->clk_set_parent(clk, parent);
155 clk->rate = clk->recalc(clk);
160 spin_unlock_irqrestore(&clockfw_lock, flags);
164 EXPORT_SYMBOL(clk_set_parent);
166 struct clk *clk_get_parent(struct clk *clk)
170 EXPORT_SYMBOL(clk_get_parent);
172 /*-------------------------------------------------------------------------
173 * OMAP specific clock functions shared between omap1 and omap2
174 *-------------------------------------------------------------------------*/
176 int __initdata mpurate;
179 * By default we use the rate set by the bootloader.
180 * You can override this with mpurate= cmdline option.
182 static int __init omap_clk_setup(char *str)
184 get_option(&str, &mpurate);
194 __setup("mpurate=", omap_clk_setup);
196 /* Used for clocks that always have same value as the parent clock */
197 unsigned long followparent_recalc(struct clk *clk)
199 return clk->parent->rate;
203 * Used for clocks that have the same value as the parent clock,
204 * divided by some factor
206 unsigned long omap_fixed_divisor_recalc(struct clk *clk)
208 WARN_ON(!clk->fixed_div);
210 return clk->parent->rate / clk->fixed_div;
213 void clk_reparent(struct clk *child, struct clk *parent)
215 list_del_init(&child->sibling);
217 list_add(&child->sibling, &parent->children);
218 child->parent = parent;
220 /* now do the debugfs renaming to reattach the child
221 to the proper parent */
224 /* Propagate rate to children */
225 void propagate_rate(struct clk * tclk)
229 list_for_each_entry(clkp, &tclk->children, sibling) {
231 clkp->rate = clkp->recalc(clkp);
232 propagate_rate(clkp);
236 static LIST_HEAD(root_clks);
239 * recalculate_root_clocks - recalculate and propagate all root clocks
241 * Recalculates all root clocks (clocks with no parent), which if the
242 * clock's .recalc is set correctly, should also propagate their rates.
245 void recalculate_root_clocks(void)
249 list_for_each_entry(clkp, &root_clks, sibling) {
251 clkp->rate = clkp->recalc(clkp);
252 propagate_rate(clkp);
257 * clk_preinit - initialize any fields in the struct clk before clk init
258 * @clk: struct clk * to initialize
260 * Initialize any struct clk fields needed before normal clk initialization
261 * can run. No return value.
263 void clk_preinit(struct clk *clk)
265 INIT_LIST_HEAD(&clk->children);
268 int clk_register(struct clk *clk)
270 if (clk == NULL || IS_ERR(clk))
274 * trap out already registered clocks
276 if (clk->node.next || clk->node.prev)
279 mutex_lock(&clocks_mutex);
281 list_add(&clk->sibling, &clk->parent->children);
283 list_add(&clk->sibling, &root_clks);
285 list_add(&clk->node, &clocks);
288 mutex_unlock(&clocks_mutex);
292 EXPORT_SYMBOL(clk_register);
294 void clk_unregister(struct clk *clk)
296 if (clk == NULL || IS_ERR(clk))
299 mutex_lock(&clocks_mutex);
300 list_del(&clk->sibling);
301 list_del(&clk->node);
302 mutex_unlock(&clocks_mutex);
304 EXPORT_SYMBOL(clk_unregister);
306 void clk_enable_init_clocks(void)
310 list_for_each_entry(clkp, &clocks, node) {
311 if (clkp->flags & ENABLE_ON_INIT)
317 * omap_clk_get_by_name - locate OMAP struct clk by its name
318 * @name: name of the struct clk to locate
320 * Locate an OMAP struct clk by its name. Assumes that struct clk
321 * names are unique. Returns NULL if not found or a pointer to the
322 * struct clk if found.
324 struct clk *omap_clk_get_by_name(const char *name)
327 struct clk *ret = NULL;
329 mutex_lock(&clocks_mutex);
331 list_for_each_entry(c, &clocks, node) {
332 if (!strcmp(c->name, name)) {
338 mutex_unlock(&clocks_mutex);
346 static int clkll_enable_null(struct clk *clk)
351 static void clkll_disable_null(struct clk *clk)
355 const struct clkops clkops_null = {
356 .enable = clkll_enable_null,
357 .disable = clkll_disable_null,
360 #ifdef CONFIG_CPU_FREQ
361 void clk_init_cpufreq_table(struct cpufreq_frequency_table **table)
365 spin_lock_irqsave(&clockfw_lock, flags);
366 if (arch_clock->clk_init_cpufreq_table)
367 arch_clock->clk_init_cpufreq_table(table);
368 spin_unlock_irqrestore(&clockfw_lock, flags);
371 void clk_exit_cpufreq_table(struct cpufreq_frequency_table **table)
375 spin_lock_irqsave(&clockfw_lock, flags);
376 if (arch_clock->clk_exit_cpufreq_table)
377 arch_clock->clk_exit_cpufreq_table(table);
378 spin_unlock_irqrestore(&clockfw_lock, flags);
382 /*-------------------------------------------------------------------------*/
384 #ifdef CONFIG_OMAP_RESET_CLOCKS
386 * Disable any unused clocks left on by the bootloader
388 static int __init clk_disable_unused(void)
393 list_for_each_entry(ck, &clocks, node) {
394 if (ck->ops == &clkops_null)
397 if (ck->usecount > 0 || ck->enable_reg == 0)
400 spin_lock_irqsave(&clockfw_lock, flags);
401 if (arch_clock->clk_disable_unused)
402 arch_clock->clk_disable_unused(ck);
403 spin_unlock_irqrestore(&clockfw_lock, flags);
408 late_initcall(clk_disable_unused);
411 int __init clk_init(struct clk_functions * custom_clocks)
413 if (!custom_clocks) {
414 printk(KERN_ERR "No custom clock functions registered\n");
418 arch_clock = custom_clocks;
423 #if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
425 * debugfs support to trace clock tree hierarchy and attributes
427 static struct dentry *clk_debugfs_root;
429 static int clk_debugfs_register_one(struct clk *c)
432 struct dentry *d, *child, *child_tmp;
433 struct clk *pa = c->parent;
437 p += sprintf(p, "%s", c->name);
438 d = debugfs_create_dir(s, pa ? pa->dent : clk_debugfs_root);
443 d = debugfs_create_u8("usecount", S_IRUGO, c->dent, (u8 *)&c->usecount);
448 d = debugfs_create_u32("rate", S_IRUGO, c->dent, (u32 *)&c->rate);
453 d = debugfs_create_x32("flags", S_IRUGO, c->dent, (u32 *)&c->flags);
462 list_for_each_entry_safe(child, child_tmp, &d->d_subdirs, d_u.d_child)
463 debugfs_remove(child);
464 debugfs_remove(c->dent);
468 static int clk_debugfs_register(struct clk *c)
471 struct clk *pa = c->parent;
473 if (pa && !pa->dent) {
474 err = clk_debugfs_register(pa);
480 err = clk_debugfs_register_one(c);
487 static int __init clk_debugfs_init(void)
493 d = debugfs_create_dir("clock", NULL);
496 clk_debugfs_root = d;
498 list_for_each_entry(c, &clocks, node) {
499 err = clk_debugfs_register(c);
505 debugfs_remove_recursive(clk_debugfs_root);
508 late_initcall(clk_debugfs_init);
510 #endif /* defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS) */