[ARM] Convert asm/io.h to linux/io.h
[linux-2.6-block.git] / arch / arm / plat-omap / clock.c
CommitLineData
1da177e4 1/*
b9158556 2 * linux/arch/arm/plat-omap/clock.c
1da177e4 3 *
137b3ee2 4 * Copyright (C) 2004 - 2008 Nokia corporation
1da177e4
LT
5 * Written by Tuukka Tikkanen <tuukka.tikkanen@elektrobit.com>
6 *
1a8bfa1e
TL
7 * Modified for omap shared clock framework by Tony Lindgren <tony@atomide.com>
8 *
1da177e4
LT
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.
12 */
1da177e4 13#include <linux/kernel.h>
1a8bfa1e
TL
14#include <linux/init.h>
15#include <linux/module.h>
1da177e4
LT
16#include <linux/list.h>
17#include <linux/errno.h>
18#include <linux/err.h>
4e57b681 19#include <linux/string.h>
f8ce2547 20#include <linux/clk.h>
00431707 21#include <linux/mutex.h>
b824efae 22#include <linux/platform_device.h>
b851cb28 23#include <linux/cpufreq.h>
137b3ee2 24#include <linux/debugfs.h>
fced80c7 25#include <linux/io.h>
1da177e4 26
a09e64fb 27#include <mach/clock.h>
1da177e4 28
7df3450e 29static LIST_HEAD(clocks);
00431707 30static DEFINE_MUTEX(clocks_mutex);
7df3450e 31static DEFINE_SPINLOCK(clockfw_lock);
1da177e4 32
1a8bfa1e 33static struct clk_functions *arch_clock;
1da177e4 34
1a8bfa1e 35/*-------------------------------------------------------------------------
f07adc59 36 * Standard clock functions defined in include/linux/clk.h
1a8bfa1e 37 *-------------------------------------------------------------------------*/
1da177e4 38
b824efae
TL
39/*
40 * Returns a clock. Note that we first try to use device id on the bus
41 * and clock name. If this fails, we try to use clock name only.
42 */
1a8bfa1e 43struct clk * clk_get(struct device *dev, const char *id)
1da177e4
LT
44{
45 struct clk *p, *clk = ERR_PTR(-ENOENT);
b824efae
TL
46 int idno;
47
48 if (dev == NULL || dev->bus != &platform_bus_type)
49 idno = -1;
50 else
51 idno = to_platform_device(dev)->id;
1da177e4 52
00431707 53 mutex_lock(&clocks_mutex);
b824efae
TL
54
55 list_for_each_entry(p, &clocks, node) {
56 if (p->id == idno &&
57 strcmp(id, p->name) == 0 && try_module_get(p->owner)) {
58 clk = p;
67d4d835 59 goto found;
b824efae
TL
60 }
61 }
62
1da177e4
LT
63 list_for_each_entry(p, &clocks, node) {
64 if (strcmp(id, p->name) == 0 && try_module_get(p->owner)) {
65 clk = p;
66 break;
67 }
68 }
b824efae 69
67d4d835 70found:
00431707 71 mutex_unlock(&clocks_mutex);
1da177e4
LT
72
73 return clk;
74}
75EXPORT_SYMBOL(clk_get);
76
1da177e4
LT
77int clk_enable(struct clk *clk)
78{
79 unsigned long flags;
1a8bfa1e 80 int ret = 0;
1da177e4 81
b824efae
TL
82 if (clk == NULL || IS_ERR(clk))
83 return -EINVAL;
84
1da177e4 85 spin_lock_irqsave(&clockfw_lock, flags);
f07adc59 86 if (arch_clock->clk_enable)
1a8bfa1e 87 ret = arch_clock->clk_enable(clk);
1da177e4 88 spin_unlock_irqrestore(&clockfw_lock, flags);
1a8bfa1e 89
1da177e4
LT
90 return ret;
91}
92EXPORT_SYMBOL(clk_enable);
93
1da177e4
LT
94void clk_disable(struct clk *clk)
95{
96 unsigned long flags;
97
b824efae
TL
98 if (clk == NULL || IS_ERR(clk))
99 return;
100
1da177e4 101 spin_lock_irqsave(&clockfw_lock, flags);
7cf95774
TL
102 if (clk->usecount == 0) {
103 printk(KERN_ERR "Trying disable clock %s with 0 usecount\n",
104 clk->name);
105 WARN_ON(1);
106 goto out;
107 }
108
f07adc59 109 if (arch_clock->clk_disable)
1a8bfa1e 110 arch_clock->clk_disable(clk);
7cf95774
TL
111
112out:
1da177e4
LT
113 spin_unlock_irqrestore(&clockfw_lock, flags);
114}
115EXPORT_SYMBOL(clk_disable);
116
1da177e4
LT
117int clk_get_usecount(struct clk *clk)
118{
1a8bfa1e
TL
119 unsigned long flags;
120 int ret = 0;
1da177e4 121
b824efae
TL
122 if (clk == NULL || IS_ERR(clk))
123 return 0;
124
1a8bfa1e
TL
125 spin_lock_irqsave(&clockfw_lock, flags);
126 ret = clk->usecount;
127 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4 128
1a8bfa1e 129 return ret;
1da177e4 130}
1a8bfa1e 131EXPORT_SYMBOL(clk_get_usecount);
1da177e4 132
1a8bfa1e 133unsigned long clk_get_rate(struct clk *clk)
1da177e4 134{
1a8bfa1e
TL
135 unsigned long flags;
136 unsigned long ret = 0;
1da177e4 137
b824efae
TL
138 if (clk == NULL || IS_ERR(clk))
139 return 0;
140
1a8bfa1e
TL
141 spin_lock_irqsave(&clockfw_lock, flags);
142 ret = clk->rate;
143 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4 144
1a8bfa1e 145 return ret;
1da177e4 146}
1a8bfa1e 147EXPORT_SYMBOL(clk_get_rate);
1da177e4 148
1a8bfa1e 149void clk_put(struct clk *clk)
bb13b5fd 150{
1a8bfa1e
TL
151 if (clk && !IS_ERR(clk))
152 module_put(clk->owner);
bb13b5fd 153}
1a8bfa1e 154EXPORT_SYMBOL(clk_put);
bb13b5fd 155
1a8bfa1e 156/*-------------------------------------------------------------------------
f07adc59 157 * Optional clock functions defined in include/linux/clk.h
1a8bfa1e 158 *-------------------------------------------------------------------------*/
bb13b5fd 159
1da177e4
LT
160long clk_round_rate(struct clk *clk, unsigned long rate)
161{
1a8bfa1e
TL
162 unsigned long flags;
163 long ret = 0;
1da177e4 164
b824efae
TL
165 if (clk == NULL || IS_ERR(clk))
166 return ret;
167
1a8bfa1e
TL
168 spin_lock_irqsave(&clockfw_lock, flags);
169 if (arch_clock->clk_round_rate)
170 ret = arch_clock->clk_round_rate(clk, rate);
171 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4 172
1a8bfa1e 173 return ret;
1da177e4
LT
174}
175EXPORT_SYMBOL(clk_round_rate);
176
1a8bfa1e 177int clk_set_rate(struct clk *clk, unsigned long rate)
1da177e4 178{
1a8bfa1e 179 unsigned long flags;
b824efae
TL
180 int ret = -EINVAL;
181
182 if (clk == NULL || IS_ERR(clk))
183 return ret;
bb13b5fd 184
1a8bfa1e
TL
185 spin_lock_irqsave(&clockfw_lock, flags);
186 if (arch_clock->clk_set_rate)
187 ret = arch_clock->clk_set_rate(clk, rate);
188 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4 189
1a8bfa1e 190 return ret;
1da177e4 191}
1a8bfa1e 192EXPORT_SYMBOL(clk_set_rate);
1da177e4 193
1a8bfa1e 194int clk_set_parent(struct clk *clk, struct clk *parent)
1da177e4 195{
1a8bfa1e 196 unsigned long flags;
b824efae
TL
197 int ret = -EINVAL;
198
199 if (clk == NULL || IS_ERR(clk) || parent == NULL || IS_ERR(parent))
200 return ret;
1da177e4 201
1a8bfa1e
TL
202 spin_lock_irqsave(&clockfw_lock, flags);
203 if (arch_clock->clk_set_parent)
204 ret = arch_clock->clk_set_parent(clk, parent);
205 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4 206
1a8bfa1e 207 return ret;
1da177e4 208}
1a8bfa1e 209EXPORT_SYMBOL(clk_set_parent);
1da177e4 210
1a8bfa1e 211struct clk *clk_get_parent(struct clk *clk)
1da177e4 212{
1a8bfa1e
TL
213 unsigned long flags;
214 struct clk * ret = NULL;
1da177e4 215
b824efae
TL
216 if (clk == NULL || IS_ERR(clk))
217 return ret;
218
1a8bfa1e
TL
219 spin_lock_irqsave(&clockfw_lock, flags);
220 if (arch_clock->clk_get_parent)
221 ret = arch_clock->clk_get_parent(clk);
222 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4
LT
223
224 return ret;
225}
1a8bfa1e 226EXPORT_SYMBOL(clk_get_parent);
1da177e4 227
1a8bfa1e
TL
228/*-------------------------------------------------------------------------
229 * OMAP specific clock functions shared between omap1 and omap2
230 *-------------------------------------------------------------------------*/
1da177e4 231
1a8bfa1e 232unsigned int __initdata mpurate;
1da177e4 233
1a8bfa1e
TL
234/*
235 * By default we use the rate set by the bootloader.
236 * You can override this with mpurate= cmdline option.
237 */
238static int __init omap_clk_setup(char *str)
1da177e4 239{
1a8bfa1e 240 get_option(&str, &mpurate);
1da177e4 241
1a8bfa1e
TL
242 if (!mpurate)
243 return 1;
1da177e4 244
1a8bfa1e
TL
245 if (mpurate < 1000)
246 mpurate *= 1000000;
1da177e4 247
1a8bfa1e 248 return 1;
1da177e4 249}
1a8bfa1e 250__setup("mpurate=", omap_clk_setup);
1da177e4 251
1a8bfa1e
TL
252/* Used for clocks that always have same value as the parent clock */
253void followparent_recalc(struct clk *clk)
1da177e4 254{
b824efae
TL
255 if (clk == NULL || IS_ERR(clk))
256 return;
257
1a8bfa1e 258 clk->rate = clk->parent->rate;
b1465bf7
ID
259 if (unlikely(clk->flags & RATE_PROPAGATES))
260 propagate_rate(clk);
1da177e4
LT
261}
262
1a8bfa1e
TL
263/* Propagate rate to children */
264void propagate_rate(struct clk * tclk)
1da177e4 265{
1a8bfa1e 266 struct clk *clkp;
1da177e4 267
b824efae
TL
268 if (tclk == NULL || IS_ERR(tclk))
269 return;
270
1a8bfa1e
TL
271 list_for_each_entry(clkp, &clocks, node) {
272 if (likely(clkp->parent != tclk))
273 continue;
274 if (likely((u32)clkp->recalc))
275 clkp->recalc(clkp);
276 }
1da177e4
LT
277}
278
6b8858a9
PW
279/**
280 * recalculate_root_clocks - recalculate and propagate all root clocks
281 *
282 * Recalculates all root clocks (clocks with no parent), which if the
283 * clock's .recalc is set correctly, should also propagate their rates.
284 * Called at init.
285 */
286void recalculate_root_clocks(void)
287{
288 struct clk *clkp;
289
290 list_for_each_entry(clkp, &clocks, node) {
291 if (unlikely(!clkp->parent) && likely((u32)clkp->recalc))
292 clkp->recalc(clkp);
293 }
294}
295
1da177e4
LT
296int clk_register(struct clk *clk)
297{
b824efae
TL
298 if (clk == NULL || IS_ERR(clk))
299 return -EINVAL;
300
00431707 301 mutex_lock(&clocks_mutex);
1da177e4
LT
302 list_add(&clk->node, &clocks);
303 if (clk->init)
304 clk->init(clk);
00431707 305 mutex_unlock(&clocks_mutex);
1a8bfa1e 306
1da177e4
LT
307 return 0;
308}
309EXPORT_SYMBOL(clk_register);
310
311void clk_unregister(struct clk *clk)
312{
b824efae
TL
313 if (clk == NULL || IS_ERR(clk))
314 return;
315
00431707 316 mutex_lock(&clocks_mutex);
1da177e4 317 list_del(&clk->node);
00431707 318 mutex_unlock(&clocks_mutex);
1da177e4
LT
319}
320EXPORT_SYMBOL(clk_unregister);
321
1a8bfa1e 322void clk_deny_idle(struct clk *clk)
bb13b5fd 323{
1a8bfa1e
TL
324 unsigned long flags;
325
b824efae
TL
326 if (clk == NULL || IS_ERR(clk))
327 return;
328
1a8bfa1e
TL
329 spin_lock_irqsave(&clockfw_lock, flags);
330 if (arch_clock->clk_deny_idle)
331 arch_clock->clk_deny_idle(clk);
332 spin_unlock_irqrestore(&clockfw_lock, flags);
bb13b5fd 333}
1a8bfa1e 334EXPORT_SYMBOL(clk_deny_idle);
1da177e4 335
1a8bfa1e 336void clk_allow_idle(struct clk *clk)
1da177e4 337{
1a8bfa1e 338 unsigned long flags;
1da177e4 339
b824efae
TL
340 if (clk == NULL || IS_ERR(clk))
341 return;
342
1a8bfa1e
TL
343 spin_lock_irqsave(&clockfw_lock, flags);
344 if (arch_clock->clk_allow_idle)
345 arch_clock->clk_allow_idle(clk);
346 spin_unlock_irqrestore(&clockfw_lock, flags);
1da177e4 347}
1a8bfa1e 348EXPORT_SYMBOL(clk_allow_idle);
bb13b5fd 349
6b8858a9
PW
350void clk_enable_init_clocks(void)
351{
352 struct clk *clkp;
353
354 list_for_each_entry(clkp, &clocks, node) {
355 if (clkp->flags & ENABLE_ON_INIT)
356 clk_enable(clkp);
357 }
358}
359EXPORT_SYMBOL(clk_enable_init_clocks);
360
361#ifdef CONFIG_CPU_FREQ
362void clk_init_cpufreq_table(struct cpufreq_frequency_table **table)
363{
364 unsigned long flags;
365
366 spin_lock_irqsave(&clockfw_lock, flags);
367 if (arch_clock->clk_init_cpufreq_table)
368 arch_clock->clk_init_cpufreq_table(table);
369 spin_unlock_irqrestore(&clockfw_lock, flags);
370}
371EXPORT_SYMBOL(clk_init_cpufreq_table);
372#endif
373
1a8bfa1e 374/*-------------------------------------------------------------------------*/
bb13b5fd 375
90afd5cb
TL
376#ifdef CONFIG_OMAP_RESET_CLOCKS
377/*
378 * Disable any unused clocks left on by the bootloader
379 */
380static int __init clk_disable_unused(void)
381{
382 struct clk *ck;
383 unsigned long flags;
384
385 list_for_each_entry(ck, &clocks, node) {
386 if (ck->usecount > 0 || (ck->flags & ALWAYS_ENABLED) ||
387 ck->enable_reg == 0)
388 continue;
389
390 spin_lock_irqsave(&clockfw_lock, flags);
391 if (arch_clock->clk_disable_unused)
392 arch_clock->clk_disable_unused(ck);
393 spin_unlock_irqrestore(&clockfw_lock, flags);
394 }
395
396 return 0;
397}
398late_initcall(clk_disable_unused);
399#endif
400
1a8bfa1e 401int __init clk_init(struct clk_functions * custom_clocks)
bb13b5fd 402{
1a8bfa1e
TL
403 if (!custom_clocks) {
404 printk(KERN_ERR "No custom clock functions registered\n");
405 BUG();
bb13b5fd
TL
406 }
407
1a8bfa1e
TL
408 arch_clock = custom_clocks;
409
bb13b5fd
TL
410 return 0;
411}
6b8858a9 412
137b3ee2
HD
413#if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS)
414/*
415 * debugfs support to trace clock tree hierarchy and attributes
416 */
417static struct dentry *clk_debugfs_root;
418
419static int clk_debugfs_register_one(struct clk *c)
420{
421 int err;
422 struct dentry *d, *child;
423 struct clk *pa = c->parent;
424 char s[255];
425 char *p = s;
426
427 p += sprintf(p, "%s", c->name);
428 if (c->id != 0)
429 sprintf(p, ":%d", c->id);
430 d = debugfs_create_dir(s, pa ? pa->dent : clk_debugfs_root);
431 if (IS_ERR(d))
432 return PTR_ERR(d);
433 c->dent = d;
434
435 d = debugfs_create_u8("usecount", S_IRUGO, c->dent, (u8 *)&c->usecount);
436 if (IS_ERR(d)) {
437 err = PTR_ERR(d);
438 goto err_out;
439 }
440 d = debugfs_create_u32("rate", S_IRUGO, c->dent, (u32 *)&c->rate);
441 if (IS_ERR(d)) {
442 err = PTR_ERR(d);
443 goto err_out;
444 }
445 d = debugfs_create_x32("flags", S_IRUGO, c->dent, (u32 *)&c->flags);
446 if (IS_ERR(d)) {
447 err = PTR_ERR(d);
448 goto err_out;
449 }
450 return 0;
451
452err_out:
453 d = c->dent;
454 list_for_each_entry(child, &d->d_subdirs, d_u.d_child)
455 debugfs_remove(child);
456 debugfs_remove(c->dent);
457 return err;
458}
459
460static int clk_debugfs_register(struct clk *c)
461{
462 int err;
463 struct clk *pa = c->parent;
464
465 if (pa && !pa->dent) {
466 err = clk_debugfs_register(pa);
467 if (err)
468 return err;
469 }
470
471 if (!c->dent) {
472 err = clk_debugfs_register_one(c);
473 if (err)
474 return err;
475 }
476 return 0;
477}
478
479static int __init clk_debugfs_init(void)
480{
481 struct clk *c;
482 struct dentry *d;
483 int err;
484
485 d = debugfs_create_dir("clock", NULL);
486 if (IS_ERR(d))
487 return PTR_ERR(d);
488 clk_debugfs_root = d;
489
490 list_for_each_entry(c, &clocks, node) {
491 err = clk_debugfs_register(c);
492 if (err)
493 goto err_out;
494 }
495 return 0;
496err_out:
497 debugfs_remove(clk_debugfs_root); /* REVISIT: Cleanup correctly */
498 return err;
499}
500late_initcall(clk_debugfs_init);
501
502#endif /* defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS) */