arch/arm/plat-omap/clock.c

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