arch/arm/mach-davinci/clock.c

   1 /*
   2  * Clock and PLL control for DaVinci devices
   3  *
   4  * Copyright (C) 2006-2007 Texas Instruments.
   5  * Copyright (C) 2008-2009 Deep Root Systems, LLC
   6  *
   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.
  11  */
  12
  13 #include <linux/module.h>
  14 #include <linux/kernel.h>
  15 #include <linux/init.h>
  16 #include <linux/errno.h>
  17 #include <linux/clk.h>
  18 #include <linux/err.h>
  19 #include <linux/mutex.h>
  20 #include <linux/io.h>
  21 #include <linux/delay.h>
  22
  23 #include <mach/hardware.h>
  24
  25 #include <mach/clock.h>
  26 #include <mach/psc.h>
  27 #include <mach/cputype.h>
  28 #include "clock.h"
  29
  30 static LIST_HEAD(clocks);
  31 static DEFINE_MUTEX(clocks_mutex);
  32 static DEFINE_SPINLOCK(clockfw_lock);
  33
  34 static unsigned psc_domain(struct clk *clk)
  35 {
  36         return (clk->flags & PSC_DSP)
  37                 ? DAVINCI_GPSC_DSPDOMAIN
  38                 : DAVINCI_GPSC_ARMDOMAIN;
  39 }
  40
  41 static void __clk_enable(struct clk *clk)
  42 {
  43         if (clk->parent)
  44                 __clk_enable(clk->parent);
  45         if (clk->usecount++ == 0 && (clk->flags & CLK_PSC))
  46                 davinci_psc_config(psc_domain(clk), clk->gpsc, clk->lpsc,
  47                                 PSC_STATE_ENABLE);
  48 }
  49
  50 static void __clk_disable(struct clk *clk)
  51 {
  52         if (WARN_ON(clk->usecount == 0))
  53                 return;
  54         if (--clk->usecount == 0 && !(clk->flags & CLK_PLL) &&
  55             (clk->flags & CLK_PSC))
  56                 davinci_psc_config(psc_domain(clk), clk->gpsc, clk->lpsc,
  57                                 (clk->flags & PSC_SWRSTDISABLE) ?
  58                                 PSC_STATE_SWRSTDISABLE : PSC_STATE_DISABLE);
  59         if (clk->parent)
  60                 __clk_disable(clk->parent);
  61 }
  62
  63 int clk_enable(struct clk *clk)
  64 {
  65         unsigned long flags;
  66
  67         if (clk == NULL || IS_ERR(clk))
  68                 return -EINVAL;
  69
  70         spin_lock_irqsave(&clockfw_lock, flags);
  71         __clk_enable(clk);
  72         spin_unlock_irqrestore(&clockfw_lock, flags);
  73
  74         return 0;
  75 }
  76 EXPORT_SYMBOL(clk_enable);
  77
  78 void clk_disable(struct clk *clk)
  79 {
  80         unsigned long flags;
  81
  82         if (clk == NULL || IS_ERR(clk))
  83                 return;
  84
  85         spin_lock_irqsave(&clockfw_lock, flags);
  86         __clk_disable(clk);
  87         spin_unlock_irqrestore(&clockfw_lock, flags);
  88 }
  89 EXPORT_SYMBOL(clk_disable);
  90
  91 unsigned long clk_get_rate(struct clk *clk)
  92 {
  93         if (clk == NULL || IS_ERR(clk))
  94                 return -EINVAL;
  95
  96         return clk->rate;
  97 }
  98 EXPORT_SYMBOL(clk_get_rate);
  99
 100 long clk_round_rate(struct clk *clk, unsigned long rate)
 101 {
 102         if (clk == NULL || IS_ERR(clk))
 103                 return -EINVAL;
 104
 105         if (clk->round_rate)
 106                 return clk->round_rate(clk, rate);
 107
 108         return clk->rate;
 109 }
 110 EXPORT_SYMBOL(clk_round_rate);
 111
 112 /* Propagate rate to children */
 113 static void propagate_rate(struct clk *root)
 114 {
 115         struct clk *clk;
 116
 117         list_for_each_entry(clk, &root->children, childnode) {
 118                 if (clk->recalc)
 119                         clk->rate = clk->recalc(clk);
 120                 propagate_rate(clk);
 121         }
 122 }
 123
 124 int clk_set_rate(struct clk *clk, unsigned long rate)
 125 {
 126         unsigned long flags;
 127         int ret = -EINVAL;
 128
 129         if (clk == NULL || IS_ERR(clk))
 130                 return ret;
 131
 132         if (clk->set_rate)
 133                 ret = clk->set_rate(clk, rate);
 134
 135         spin_lock_irqsave(&clockfw_lock, flags);
 136         if (ret == 0) {
 137                 if (clk->recalc)
 138                         clk->rate = clk->recalc(clk);
 139                 propagate_rate(clk);
 140         }
 141         spin_unlock_irqrestore(&clockfw_lock, flags);
 142
 143         return ret;
 144 }
 145 EXPORT_SYMBOL(clk_set_rate);
 146
 147 int clk_set_parent(struct clk *clk, struct clk *parent)
 148 {
 149         unsigned long flags;
 150
 151         if (clk == NULL || IS_ERR(clk))
 152                 return -EINVAL;
 153
 154         /* Cannot change parent on enabled clock */
 155         if (WARN_ON(clk->usecount))
 156                 return -EINVAL;
 157
 158         mutex_lock(&clocks_mutex);
 159         clk->parent = parent;
 160         list_del_init(&clk->childnode);
 161         list_add(&clk->childnode, &clk->parent->children);
 162         mutex_unlock(&clocks_mutex);
 163
 164         spin_lock_irqsave(&clockfw_lock, flags);
 165         if (clk->recalc)
 166                 clk->rate = clk->recalc(clk);
 167         propagate_rate(clk);
 168         spin_unlock_irqrestore(&clockfw_lock, flags);
 169
 170         return 0;
 171 }
 172 EXPORT_SYMBOL(clk_set_parent);
 173
 174 int clk_register(struct clk *clk)
 175 {
 176         if (clk == NULL || IS_ERR(clk))
 177                 return -EINVAL;
 178
 179         if (WARN(clk->parent && !clk->parent->rate,
 180                         "CLK: %s parent %s has no rate!\n",
 181                         clk->name, clk->parent->name))
 182                 return -EINVAL;
 183
 184         INIT_LIST_HEAD(&clk->children);
 185
 186         mutex_lock(&clocks_mutex);
 187         list_add_tail(&clk->node, &clocks);
 188         if (clk->parent)
 189                 list_add_tail(&clk->childnode, &clk->parent->children);
 190         mutex_unlock(&clocks_mutex);
 191
 192         /* If rate is already set, use it */
 193         if (clk->rate)
 194                 return 0;
 195
 196         /* Else, see if there is a way to calculate it */
 197         if (clk->recalc)
 198                 clk->rate = clk->recalc(clk);
 199
 200         /* Otherwise, default to parent rate */
 201         else if (clk->parent)
 202                 clk->rate = clk->parent->rate;
 203
 204         return 0;
 205 }
 206 EXPORT_SYMBOL(clk_register);
 207
 208 void clk_unregister(struct clk *clk)
 209 {
 210         if (clk == NULL || IS_ERR(clk))
 211                 return;
 212
 213         mutex_lock(&clocks_mutex);
 214         list_del(&clk->node);
 215         list_del(&clk->childnode);
 216         mutex_unlock(&clocks_mutex);
 217 }
 218 EXPORT_SYMBOL(clk_unregister);
 219
 220 #ifdef CONFIG_DAVINCI_RESET_CLOCKS
 221 /*
 222  * Disable any unused clocks left on by the bootloader
 223  */
 224 static int __init clk_disable_unused(void)
 225 {
 226         struct clk *ck;
 227
 228         spin_lock_irq(&clockfw_lock);
 229         list_for_each_entry(ck, &clocks, node) {
 230                 if (ck->usecount > 0)
 231                         continue;
 232                 if (!(ck->flags & CLK_PSC))
 233                         continue;
 234
 235                 /* ignore if in Disabled or SwRstDisable states */
 236                 if (!davinci_psc_is_clk_active(ck->gpsc, ck->lpsc))
 237                         continue;
 238
 239                 pr_debug("Clocks: disable unused %s\n", ck->name);
 240
 241                 davinci_psc_config(psc_domain(ck), ck->gpsc, ck->lpsc,
 242                                 (ck->flags & PSC_SWRSTDISABLE) ?
 243                                 PSC_STATE_SWRSTDISABLE : PSC_STATE_DISABLE);
 244         }
 245         spin_unlock_irq(&clockfw_lock);
 246
 247         return 0;
 248 }
 249 late_initcall(clk_disable_unused);
 250 #endif
 251
 252 static unsigned long clk_sysclk_recalc(struct clk *clk)
 253 {
 254         u32 v, plldiv;
 255         struct pll_data *pll;
 256         unsigned long rate = clk->rate;
 257
 258         /* If this is the PLL base clock, no more calculations needed */
 259         if (clk->pll_data)
 260                 return rate;
 261
 262         if (WARN_ON(!clk->parent))
 263                 return rate;
 264
 265         rate = clk->parent->rate;
 266
 267         /* Otherwise, the parent must be a PLL */
 268         if (WARN_ON(!clk->parent->pll_data))
 269                 return rate;
 270
 271         pll = clk->parent->pll_data;
 272
 273         /* If pre-PLL, source clock is before the multiplier and divider(s) */
 274         if (clk->flags & PRE_PLL)
 275                 rate = pll->input_rate;
 276
 277         if (!clk->div_reg)
 278                 return rate;
 279
 280         v = __raw_readl(pll->base + clk->div_reg);
 281         if (v & PLLDIV_EN) {
 282                 plldiv = (v & pll->div_ratio_mask) + 1;
 283                 if (plldiv)
 284                         rate /= plldiv;
 285         }
 286
 287         return rate;
 288 }
 289
 290 int davinci_set_sysclk_rate(struct clk *clk, unsigned long rate)
 291 {
 292         unsigned v;
 293         struct pll_data *pll;
 294         unsigned long input;
 295         unsigned ratio = 0;
 296
 297         /* If this is the PLL base clock, wrong function to call */
 298         if (clk->pll_data)
 299                 return -EINVAL;
 300
 301         /* There must be a parent... */
 302         if (WARN_ON(!clk->parent))
 303                 return -EINVAL;
 304
 305         /* ... the parent must be a PLL... */
 306         if (WARN_ON(!clk->parent->pll_data))
 307                 return -EINVAL;
 308
 309         /* ... and this clock must have a divider. */
 310         if (WARN_ON(!clk->div_reg))
 311                 return -EINVAL;
 312
 313         pll = clk->parent->pll_data;
 314
 315         input = clk->parent->rate;
 316
 317         /* If pre-PLL, source clock is before the multiplier and divider(s) */
 318         if (clk->flags & PRE_PLL)
 319                 input = pll->input_rate;
 320
 321         if (input > rate) {
 322                 /*
 323                  * Can afford to provide an output little higher than requested
 324                  * only if maximum rate supported by hardware on this sysclk
 325                  * is known.
 326                  */
 327                 if (clk->maxrate) {
 328                         ratio = DIV_ROUND_CLOSEST(input, rate);
 329                         if (input / ratio > clk->maxrate)
 330                                 ratio = 0;
 331                 }
 332
 333                 if (ratio == 0)
 334                         ratio = DIV_ROUND_UP(input, rate);
 335
 336                 ratio--;
 337         }
 338
 339         if (ratio > PLLDIV_RATIO_MASK)
 340                 return -EINVAL;
 341
 342         do {
 343                 v = __raw_readl(pll->base + PLLSTAT);
 344         } while (v & PLLSTAT_GOSTAT);
 345
 346         v = __raw_readl(pll->base + clk->div_reg);
 347         v &= ~PLLDIV_RATIO_MASK;
 348         v |= ratio | PLLDIV_EN;
 349         __raw_writel(v, pll->base + clk->div_reg);
 350
 351         v = __raw_readl(pll->base + PLLCMD);
 352         v |= PLLCMD_GOSET;
 353         __raw_writel(v, pll->base + PLLCMD);
 354
 355         do {
 356                 v = __raw_readl(pll->base + PLLSTAT);
 357         } while (v & PLLSTAT_GOSTAT);
 358
 359         return 0;
 360 }
 361 EXPORT_SYMBOL(davinci_set_sysclk_rate);
 362
 363 static unsigned long clk_leafclk_recalc(struct clk *clk)
 364 {
 365         if (WARN_ON(!clk->parent))
 366                 return clk->rate;
 367
 368         return clk->parent->rate;
 369 }
 370
 371 static unsigned long clk_pllclk_recalc(struct clk *clk)
 372 {
 373         u32 ctrl, mult = 1, prediv = 1, postdiv = 1;
 374         u8 bypass;
 375         struct pll_data *pll = clk->pll_data;
 376         unsigned long rate = clk->rate;
 377
 378         ctrl = __raw_readl(pll->base + PLLCTL);
 379         rate = pll->input_rate = clk->parent->rate;
 380
 381         if (ctrl & PLLCTL_PLLEN) {
 382                 bypass = 0;
 383                 mult = __raw_readl(pll->base + PLLM);
 384                 if (cpu_is_davinci_dm365())
 385                         mult = 2 * (mult & PLLM_PLLM_MASK);
 386                 else
 387                         mult = (mult & PLLM_PLLM_MASK) + 1;
 388         } else
 389                 bypass = 1;
 390
 391         if (pll->flags & PLL_HAS_PREDIV) {
 392                 prediv = __raw_readl(pll->base + PREDIV);
 393                 if (prediv & PLLDIV_EN)
 394                         prediv = (prediv & pll->div_ratio_mask) + 1;
 395                 else
 396                         prediv = 1;
 397         }
 398
 399         /* pre-divider is fixed, but (some?) chips won't report that */
 400         if (cpu_is_davinci_dm355() && pll->num == 1)
 401                 prediv = 8;
 402
 403         if (pll->flags & PLL_HAS_POSTDIV) {
 404                 postdiv = __raw_readl(pll->base + POSTDIV);
 405                 if (postdiv & PLLDIV_EN)
 406                         postdiv = (postdiv & pll->div_ratio_mask) + 1;
 407                 else
 408                         postdiv = 1;
 409         }
 410
 411         if (!bypass) {
 412                 rate /= prediv;
 413                 rate *= mult;
 414                 rate /= postdiv;
 415         }
 416
 417         pr_debug("PLL%d: input = %lu MHz [ ",
 418                  pll->num, clk->parent->rate / 1000000);
 419         if (bypass)
 420                 pr_debug("bypass ");
 421         if (prediv > 1)
 422                 pr_debug("/ %d ", prediv);
 423         if (mult > 1)
 424                 pr_debug("* %d ", mult);
 425         if (postdiv > 1)
 426                 pr_debug("/ %d ", postdiv);
 427         pr_debug("] --> %lu MHz output.\n", rate / 1000000);
 428
 429         return rate;
 430 }
 431
 432 /**
 433  * davinci_set_pllrate - set the output rate of a given PLL.
 434  *
 435  * Note: Currently tested to work with OMAP-L138 only.
 436  *
 437  * @pll: pll whose rate needs to be changed.
 438  * @prediv: The pre divider value. Passing 0 disables the pre-divider.
 439  * @pllm: The multiplier value. Passing 0 leads to multiply-by-one.
 440  * @postdiv: The post divider value. Passing 0 disables the post-divider.
 441  */
 442 int davinci_set_pllrate(struct pll_data *pll, unsigned int prediv,
 443                                         unsigned int mult, unsigned int postdiv)
 444 {
 445         u32 ctrl;
 446         unsigned int locktime;
 447         unsigned long flags;
 448
 449         if (pll->base == NULL)
 450                 return -EINVAL;
 451
 452         /*
 453          *  PLL lock time required per OMAP-L138 datasheet is
 454          * (2000 * prediv)/sqrt(pllm) OSCIN cycles. We approximate sqrt(pllm)
 455          * as 4 and OSCIN cycle as 25 MHz.
 456          */
 457         if (prediv) {
 458                 locktime = ((2000 * prediv) / 100);
 459                 prediv = (prediv - 1) | PLLDIV_EN;
 460         } else {
 461                 locktime = PLL_LOCK_TIME;
 462         }
 463         if (postdiv)
 464                 postdiv = (postdiv - 1) | PLLDIV_EN;
 465         if (mult)
 466                 mult = mult - 1;
 467
 468         /* Protect against simultaneous calls to PLL setting seqeunce */
 469         spin_lock_irqsave(&clockfw_lock, flags);
 470
 471         ctrl = __raw_readl(pll->base + PLLCTL);
 472
 473         /* Switch the PLL to bypass mode */
 474         ctrl &= ~(PLLCTL_PLLENSRC | PLLCTL_PLLEN);
 475         __raw_writel(ctrl, pll->base + PLLCTL);
 476
 477         udelay(PLL_BYPASS_TIME);
 478
 479         /* Reset and enable PLL */
 480         ctrl &= ~(PLLCTL_PLLRST | PLLCTL_PLLDIS);
 481         __raw_writel(ctrl, pll->base + PLLCTL);
 482
 483         if (pll->flags & PLL_HAS_PREDIV)
 484                 __raw_writel(prediv, pll->base + PREDIV);
 485
 486         __raw_writel(mult, pll->base + PLLM);
 487
 488         if (pll->flags & PLL_HAS_POSTDIV)
 489                 __raw_writel(postdiv, pll->base + POSTDIV);
 490
 491         udelay(PLL_RESET_TIME);
 492
 493         /* Bring PLL out of reset */
 494         ctrl |= PLLCTL_PLLRST;
 495         __raw_writel(ctrl, pll->base + PLLCTL);
 496
 497         udelay(locktime);
 498
 499         /* Remove PLL from bypass mode */
 500         ctrl |= PLLCTL_PLLEN;
 501         __raw_writel(ctrl, pll->base + PLLCTL);
 502
 503         spin_unlock_irqrestore(&clockfw_lock, flags);
 504
 505         return 0;
 506 }
 507 EXPORT_SYMBOL(davinci_set_pllrate);
 508
 509 int __init davinci_clk_init(struct clk_lookup *clocks)
 510   {
 511         struct clk_lookup *c;
 512         struct clk *clk;
 513         size_t num_clocks = 0;
 514
 515         for (c = clocks; c->clk; c++) {
 516                 clk = c->clk;
 517
 518                 if (!clk->recalc) {
 519
 520                         /* Check if clock is a PLL */
 521                         if (clk->pll_data)
 522                                 clk->recalc = clk_pllclk_recalc;
 523
 524                         /* Else, if it is a PLL-derived clock */
 525                         else if (clk->flags & CLK_PLL)
 526                                 clk->recalc = clk_sysclk_recalc;
 527
 528                         /* Otherwise, it is a leaf clock (PSC clock) */
 529                         else if (clk->parent)
 530                                 clk->recalc = clk_leafclk_recalc;
 531                 }
 532
 533                 if (clk->pll_data) {
 534                         struct pll_data *pll = clk->pll_data;
 535
 536                         if (!pll->div_ratio_mask)
 537                                 pll->div_ratio_mask = PLLDIV_RATIO_MASK;
 538
 539                         if (pll->phys_base && !pll->base) {
 540                                 pll->base = ioremap(pll->phys_base, SZ_4K);
 541                                 WARN_ON(!pll->base);
 542                         }
 543                 }
 544
 545                 if (clk->recalc)
 546                         clk->rate = clk->recalc(clk);
 547
 548                 if (clk->lpsc)
 549                         clk->flags |= CLK_PSC;
 550
 551                 clk_register(clk);
 552                 num_clocks++;
 553
 554                 /* Turn on clocks that Linux doesn't otherwise manage */
 555                 if (clk->flags & ALWAYS_ENABLED)
 556                         clk_enable(clk);
 557         }
 558
 559         clkdev_add_table(clocks, num_clocks);
 560
 561         return 0;
 562 }
 563
 564 #ifdef CONFIG_DEBUG_FS
 565
 566 #include <linux/debugfs.h>
 567 #include <linux/seq_file.h>
 568
 569 #define CLKNAME_MAX     10              /* longest clock name */
 570 #define NEST_DELTA      2
 571 #define NEST_MAX        4
 572
 573 static void
 574 dump_clock(struct seq_file *s, unsigned nest, struct clk *parent)
 575 {
 576         char            *state;
 577         char            buf[CLKNAME_MAX + NEST_DELTA * NEST_MAX];
 578         struct clk      *clk;
 579         unsigned        i;
 580
 581         if (parent->flags & CLK_PLL)
 582                 state = "pll";
 583         else if (parent->flags & CLK_PSC)
 584                 state = "psc";
 585         else
 586                 state = "";
 587
 588         /* <nest spaces> name <pad to end> */
 589         memset(buf, ' ', sizeof(buf) - 1);
 590         buf[sizeof(buf) - 1] = 0;
 591         i = strlen(parent->name);
 592         memcpy(buf + nest, parent->name,
 593                         min(i, (unsigned)(sizeof(buf) - 1 - nest)));
 594
 595         seq_printf(s, "%s users=%2d %-3s %9ld Hz\n",
 596                    buf, parent->usecount, state, clk_get_rate(parent));
 597         /* REVISIT show device associations too */
 598
 599         /* cost is now small, but not linear... */
 600         list_for_each_entry(clk, &parent->children, childnode) {
 601                 dump_clock(s, nest + NEST_DELTA, clk);
 602         }
 603 }
 604
 605 static int davinci_ck_show(struct seq_file *m, void *v)
 606 {
 607         struct clk *clk;
 608
 609         /*
 610          * Show clock tree; We trust nonzero usecounts equate to PSC enables...
 611          */
 612         mutex_lock(&clocks_mutex);
 613         list_for_each_entry(clk, &clocks, node)
 614                 if (!clk->parent)
 615                         dump_clock(m, 0, clk);
 616         mutex_unlock(&clocks_mutex);
 617
 618         return 0;
 619 }
 620
 621 static int davinci_ck_open(struct inode *inode, struct file *file)
 622 {
 623         return single_open(file, davinci_ck_show, NULL);
 624 }
 625
 626 static const struct file_operations davinci_ck_operations = {
 627         .open           = davinci_ck_open,
 628         .read           = seq_read,
 629         .llseek         = seq_lseek,
 630         .release        = single_release,
 631 };
 632
 633 static int __init davinci_clk_debugfs_init(void)
 634 {
 635         debugfs_create_file("davinci_clocks", S_IFREG | S_IRUGO, NULL, NULL,
 636                                                 &davinci_ck_operations);
 637         return 0;
 638
 639 }
 640 device_initcall(davinci_clk_debugfs_init);
 641 #endif /* CONFIG_DEBUG_FS */