arch/arm/mach-omap2/clock.c

   1 /*
   2  *  linux/arch/arm/mach-omap2/clock.c
   3  *
   4  *  Copyright (C) 2005-2008 Texas Instruments, Inc.
   5  *  Copyright (C) 2004-2010 Nokia Corporation
   6  *
   7  *  Contacts:
   8  *  Richard Woodruff <r-woodruff2@ti.com>
   9  *  Paul Walmsley
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  */
  15 #undef DEBUG
  16
  17 #include <linux/kernel.h>
  18 #include <linux/list.h>
  19 #include <linux/errno.h>
  20 #include <linux/err.h>
  21 #include <linux/delay.h>
  22 #include <linux/clk.h>
  23 #include <linux/io.h>
  24 #include <linux/bitops.h>
  25
  26 #include <asm/cpu.h>
  27
  28 #include <plat/clock.h>
  29 #include <plat/prcm.h>
  30
  31 #include <trace/events/power.h>
  32
  33 #include "soc.h"
  34 #include "clockdomain.h"
  35 #include "clock.h"
  36 #include "cm2xxx_3xxx.h"
  37 #include "cm-regbits-24xx.h"
  38 #include "cm-regbits-34xx.h"
  39
  40 u16 cpu_mask;
  41
  42 /*
  43  * clkdm_control: if true, then when a clock is enabled in the
  44  * hardware, its clockdomain will first be enabled; and when a clock
  45  * is disabled in the hardware, its clockdomain will be disabled
  46  * afterwards.
  47  */
  48 static bool clkdm_control = true;
  49
  50 /*
  51  * OMAP2+ specific clock functions
  52  */
  53
  54 /* Private functions */
  55
  56 /**
  57  * _omap2_module_wait_ready - wait for an OMAP module to leave IDLE
  58  * @clk: struct clk * belonging to the module
  59  *
  60  * If the necessary clocks for the OMAP hardware IP block that
  61  * corresponds to clock @clk are enabled, then wait for the module to
  62  * indicate readiness (i.e., to leave IDLE).  This code does not
  63  * belong in the clock code and will be moved in the medium term to
  64  * module-dependent code.  No return value.
  65  */
  66 static void _omap2_module_wait_ready(struct clk *clk)
  67 {
  68         void __iomem *companion_reg, *idlest_reg;
  69         u8 other_bit, idlest_bit, idlest_val;
  70
  71         /* Not all modules have multiple clocks that their IDLEST depends on */
  72         if (clk->ops->find_companion) {
  73                 clk->ops->find_companion(clk, &companion_reg, &other_bit);
  74                 if (!(__raw_readl(companion_reg) & (1 << other_bit)))
  75                         return;
  76         }
  77
  78         clk->ops->find_idlest(clk, &idlest_reg, &idlest_bit, &idlest_val);
  79
  80         omap2_cm_wait_idlest(idlest_reg, (1 << idlest_bit), idlest_val,
  81                              clk->name);
  82 }
  83
  84 /* Public functions */
  85
  86 /**
  87  * omap2_init_clk_clkdm - look up a clockdomain name, store pointer in clk
  88  * @clk: OMAP clock struct ptr to use
  89  *
  90  * Convert a clockdomain name stored in a struct clk 'clk' into a
  91  * clockdomain pointer, and save it into the struct clk.  Intended to be
  92  * called during clk_register().  No return value.
  93  */
  94 void omap2_init_clk_clkdm(struct clk *clk)
  95 {
  96         struct clockdomain *clkdm;
  97
  98         if (!clk->clkdm_name)
  99                 return;
 100
 101         clkdm = clkdm_lookup(clk->clkdm_name);
 102         if (clkdm) {
 103                 pr_debug("clock: associated clk %s to clkdm %s\n",
 104                          clk->name, clk->clkdm_name);
 105                 clk->clkdm = clkdm;
 106         } else {
 107                 pr_debug("clock: could not associate clk %s to clkdm %s\n",
 108                          clk->name, clk->clkdm_name);
 109         }
 110 }
 111
 112 /**
 113  * omap2_clk_disable_clkdm_control - disable clkdm control on clk enable/disable
 114  *
 115  * Prevent the OMAP clock code from calling into the clockdomain code
 116  * when a hardware clock in that clockdomain is enabled or disabled.
 117  * Intended to be called at init time from omap*_clk_init().  No
 118  * return value.
 119  */
 120 void __init omap2_clk_disable_clkdm_control(void)
 121 {
 122         clkdm_control = false;
 123 }
 124
 125 /**
 126  * omap2_clk_dflt_find_companion - find companion clock to @clk
 127  * @clk: struct clk * to find the companion clock of
 128  * @other_reg: void __iomem ** to return the companion clock CM_*CLKEN va in
 129  * @other_bit: u8 ** to return the companion clock bit shift in
 130  *
 131  * Note: We don't need special code here for INVERT_ENABLE for the
 132  * time being since INVERT_ENABLE only applies to clocks enabled by
 133  * CM_CLKEN_PLL
 134  *
 135  * Convert CM_ICLKEN* <-> CM_FCLKEN*.  This conversion assumes it's
 136  * just a matter of XORing the bits.
 137  *
 138  * Some clocks don't have companion clocks.  For example, modules with
 139  * only an interface clock (such as MAILBOXES) don't have a companion
 140  * clock.  Right now, this code relies on the hardware exporting a bit
 141  * in the correct companion register that indicates that the
 142  * nonexistent 'companion clock' is active.  Future patches will
 143  * associate this type of code with per-module data structures to
 144  * avoid this issue, and remove the casts.  No return value.
 145  */
 146 void omap2_clk_dflt_find_companion(struct clk *clk, void __iomem **other_reg,
 147                                    u8 *other_bit)
 148 {
 149         u32 r;
 150
 151         /*
 152          * Convert CM_ICLKEN* <-> CM_FCLKEN*.  This conversion assumes
 153          * it's just a matter of XORing the bits.
 154          */
 155         r = ((__force u32)clk->enable_reg ^ (CM_FCLKEN ^ CM_ICLKEN));
 156
 157         *other_reg = (__force void __iomem *)r;
 158         *other_bit = clk->enable_bit;
 159 }
 160
 161 /**
 162  * omap2_clk_dflt_find_idlest - find CM_IDLEST reg va, bit shift for @clk
 163  * @clk: struct clk * to find IDLEST info for
 164  * @idlest_reg: void __iomem ** to return the CM_IDLEST va in
 165  * @idlest_bit: u8 * to return the CM_IDLEST bit shift in
 166  * @idlest_val: u8 * to return the idle status indicator
 167  *
 168  * Return the CM_IDLEST register address and bit shift corresponding
 169  * to the module that "owns" this clock.  This default code assumes
 170  * that the CM_IDLEST bit shift is the CM_*CLKEN bit shift, and that
 171  * the IDLEST register address ID corresponds to the CM_*CLKEN
 172  * register address ID (e.g., that CM_FCLKEN2 corresponds to
 173  * CM_IDLEST2).  This is not true for all modules.  No return value.
 174  */
 175 void omap2_clk_dflt_find_idlest(struct clk *clk, void __iomem **idlest_reg,
 176                                 u8 *idlest_bit, u8 *idlest_val)
 177 {
 178         u32 r;
 179
 180         r = (((__force u32)clk->enable_reg & ~0xf0) | 0x20);
 181         *idlest_reg = (__force void __iomem *)r;
 182         *idlest_bit = clk->enable_bit;
 183
 184         /*
 185          * 24xx uses 0 to indicate not ready, and 1 to indicate ready.
 186          * 34xx reverses this, just to keep us on our toes
 187          * AM35xx uses both, depending on the module.
 188          */
 189         if (cpu_is_omap24xx())
 190                 *idlest_val = OMAP24XX_CM_IDLEST_VAL;
 191         else if (cpu_is_omap34xx())
 192                 *idlest_val = OMAP34XX_CM_IDLEST_VAL;
 193         else
 194                 BUG();
 195
 196 }
 197
 198 int omap2_dflt_clk_enable(struct clk *clk)
 199 {
 200         u32 v;
 201
 202         if (unlikely(clk->enable_reg == NULL)) {
 203                 pr_err("clock.c: Enable for %s without enable code\n",
 204                        clk->name);
 205                 return 0; /* REVISIT: -EINVAL */
 206         }
 207
 208         v = __raw_readl(clk->enable_reg);
 209         if (clk->flags & INVERT_ENABLE)
 210                 v &= ~(1 << clk->enable_bit);
 211         else
 212                 v |= (1 << clk->enable_bit);
 213         __raw_writel(v, clk->enable_reg);
 214         v = __raw_readl(clk->enable_reg); /* OCP barrier */
 215
 216         if (clk->ops->find_idlest)
 217                 _omap2_module_wait_ready(clk);
 218
 219         return 0;
 220 }
 221
 222 void omap2_dflt_clk_disable(struct clk *clk)
 223 {
 224         u32 v;
 225
 226         if (!clk->enable_reg) {
 227                 /*
 228                  * 'Independent' here refers to a clock which is not
 229                  * controlled by its parent.
 230                  */
 231                 pr_err("clock: clk_disable called on independent clock %s which has no enable_reg\n", clk->name);
 232                 return;
 233         }
 234
 235         v = __raw_readl(clk->enable_reg);
 236         if (clk->flags & INVERT_ENABLE)
 237                 v |= (1 << clk->enable_bit);
 238         else
 239                 v &= ~(1 << clk->enable_bit);
 240         __raw_writel(v, clk->enable_reg);
 241         /* No OCP barrier needed here since it is a disable operation */
 242 }
 243
 244 const struct clkops clkops_omap2_dflt_wait = {
 245         .enable         = omap2_dflt_clk_enable,
 246         .disable        = omap2_dflt_clk_disable,
 247         .find_companion = omap2_clk_dflt_find_companion,
 248         .find_idlest    = omap2_clk_dflt_find_idlest,
 249 };
 250
 251 const struct clkops clkops_omap2_dflt = {
 252         .enable         = omap2_dflt_clk_enable,
 253         .disable        = omap2_dflt_clk_disable,
 254 };
 255
 256 /**
 257  * omap2_clk_disable - disable a clock, if the system is not using it
 258  * @clk: struct clk * to disable
 259  *
 260  * Decrements the usecount on struct clk @clk.  If there are no users
 261  * left, call the clkops-specific clock disable function to disable it
 262  * in hardware.  If the clock is part of a clockdomain (which they all
 263  * should be), request that the clockdomain be disabled.  (It too has
 264  * a usecount, and so will not be disabled in the hardware until it no
 265  * longer has any users.)  If the clock has a parent clock (most of
 266  * them do), then call ourselves, recursing on the parent clock.  This
 267  * can cause an entire branch of the clock tree to be powered off by
 268  * simply disabling one clock.  Intended to be called with the clockfw_lock
 269  * spinlock held.  No return value.
 270  */
 271 void omap2_clk_disable(struct clk *clk)
 272 {
 273         if (clk->usecount == 0) {
 274                 WARN(1, "clock: %s: omap2_clk_disable() called, but usecount already 0?", clk->name);
 275                 return;
 276         }
 277
 278         pr_debug("clock: %s: decrementing usecount\n", clk->name);
 279
 280         clk->usecount--;
 281
 282         if (clk->usecount > 0)
 283                 return;
 284
 285         pr_debug("clock: %s: disabling in hardware\n", clk->name);
 286
 287         if (clk->ops && clk->ops->disable) {
 288                 trace_clock_disable(clk->name, 0, smp_processor_id());
 289                 clk->ops->disable(clk);
 290         }
 291
 292         if (clkdm_control && clk->clkdm)
 293                 clkdm_clk_disable(clk->clkdm, clk);
 294
 295         if (clk->parent)
 296                 omap2_clk_disable(clk->parent);
 297 }
 298
 299 /**
 300  * omap2_clk_enable - request that the system enable a clock
 301  * @clk: struct clk * to enable
 302  *
 303  * Increments the usecount on struct clk @clk.  If there were no users
 304  * previously, then recurse up the clock tree, enabling all of the
 305  * clock's parents and all of the parent clockdomains, and finally,
 306  * enabling @clk's clockdomain, and @clk itself.  Intended to be
 307  * called with the clockfw_lock spinlock held.  Returns 0 upon success
 308  * or a negative error code upon failure.
 309  */
 310 int omap2_clk_enable(struct clk *clk)
 311 {
 312         int ret;
 313
 314         pr_debug("clock: %s: incrementing usecount\n", clk->name);
 315
 316         clk->usecount++;
 317
 318         if (clk->usecount > 1)
 319                 return 0;
 320
 321         pr_debug("clock: %s: enabling in hardware\n", clk->name);
 322
 323         if (clk->parent) {
 324                 ret = omap2_clk_enable(clk->parent);
 325                 if (ret) {
 326                         WARN(1, "clock: %s: could not enable parent %s: %d\n",
 327                              clk->name, clk->parent->name, ret);
 328                         goto oce_err1;
 329                 }
 330         }
 331
 332         if (clkdm_control && clk->clkdm) {
 333                 ret = clkdm_clk_enable(clk->clkdm, clk);
 334                 if (ret) {
 335                         WARN(1, "clock: %s: could not enable clockdomain %s: %d\n",
 336                              clk->name, clk->clkdm->name, ret);
 337                         goto oce_err2;
 338                 }
 339         }
 340
 341         if (clk->ops && clk->ops->enable) {
 342                 trace_clock_enable(clk->name, 1, smp_processor_id());
 343                 ret = clk->ops->enable(clk);
 344                 if (ret) {
 345                         WARN(1, "clock: %s: could not enable: %d\n",
 346                              clk->name, ret);
 347                         goto oce_err3;
 348                 }
 349         }
 350
 351         return 0;
 352
 353 oce_err3:
 354         if (clkdm_control && clk->clkdm)
 355                 clkdm_clk_disable(clk->clkdm, clk);
 356 oce_err2:
 357         if (clk->parent)
 358                 omap2_clk_disable(clk->parent);
 359 oce_err1:
 360         clk->usecount--;
 361
 362         return ret;
 363 }
 364
 365 /* Given a clock and a rate apply a clock specific rounding function */
 366 long omap2_clk_round_rate(struct clk *clk, unsigned long rate)
 367 {
 368         if (clk->round_rate)
 369                 return clk->round_rate(clk, rate);
 370
 371         return clk->rate;
 372 }
 373
 374 /* Set the clock rate for a clock source */
 375 int omap2_clk_set_rate(struct clk *clk, unsigned long rate)
 376 {
 377         int ret = -EINVAL;
 378
 379         pr_debug("clock: set_rate for clock %s to rate %ld\n", clk->name, rate);
 380
 381         /* dpll_ck, core_ck, virt_prcm_set; plus all clksel clocks */
 382         if (clk->set_rate) {
 383                 trace_clock_set_rate(clk->name, rate, smp_processor_id());
 384                 ret = clk->set_rate(clk, rate);
 385         }
 386
 387         return ret;
 388 }
 389
 390 int omap2_clk_set_parent(struct clk *clk, struct clk *new_parent)
 391 {
 392         if (!clk->clksel)
 393                 return -EINVAL;
 394
 395         if (clk->parent == new_parent)
 396                 return 0;
 397
 398         return omap2_clksel_set_parent(clk, new_parent);
 399 }
 400
 401 /*
 402  * OMAP2+ clock reset and init functions
 403  */
 404
 405 #ifdef CONFIG_OMAP_RESET_CLOCKS
 406 void omap2_clk_disable_unused(struct clk *clk)
 407 {
 408         u32 regval32, v;
 409
 410         v = (clk->flags & INVERT_ENABLE) ? (1 << clk->enable_bit) : 0;
 411
 412         regval32 = __raw_readl(clk->enable_reg);
 413         if ((regval32 & (1 << clk->enable_bit)) == v)
 414                 return;
 415
 416         pr_debug("Disabling unused clock \"%s\"\n", clk->name);
 417         if (cpu_is_omap34xx()) {
 418                 omap2_clk_enable(clk);
 419                 omap2_clk_disable(clk);
 420         } else {
 421                 clk->ops->disable(clk);
 422         }
 423         if (clk->clkdm != NULL)
 424                 pwrdm_state_switch(clk->clkdm->pwrdm.ptr);
 425 }
 426 #endif
 427
 428 /**
 429  * omap2_clk_switch_mpurate_at_boot - switch ARM MPU rate by boot-time argument
 430  * @mpurate_ck_name: clk name of the clock to change rate
 431  *
 432  * Change the ARM MPU clock rate to the rate specified on the command
 433  * line, if one was specified.  @mpurate_ck_name should be
 434  * "virt_prcm_set" on OMAP2xxx and "dpll1_ck" on OMAP34xx/OMAP36xx.
 435  * XXX Does not handle voltage scaling - on OMAP2xxx this is currently
 436  * handled by the virt_prcm_set clock, but this should be handled by
 437  * the OPP layer.  XXX This is intended to be handled by the OPP layer
 438  * code in the near future and should be removed from the clock code.
 439  * Returns -EINVAL if 'mpurate' is zero or if clk_set_rate() rejects
 440  * the rate, -ENOENT if the struct clk referred to by @mpurate_ck_name
 441  * cannot be found, or 0 upon success.
 442  */
 443 int __init omap2_clk_switch_mpurate_at_boot(const char *mpurate_ck_name)
 444 {
 445         struct clk *mpurate_ck;
 446         int r;
 447
 448         if (!mpurate)
 449                 return -EINVAL;
 450
 451         mpurate_ck = clk_get(NULL, mpurate_ck_name);
 452         if (WARN(IS_ERR(mpurate_ck), "Failed to get %s.\n", mpurate_ck_name))
 453                 return -ENOENT;
 454
 455         r = clk_set_rate(mpurate_ck, mpurate);
 456         if (IS_ERR_VALUE(r)) {
 457                 WARN(1, "clock: %s: unable to set MPU rate to %d: %d\n",
 458                      mpurate_ck->name, mpurate, r);
 459                 clk_put(mpurate_ck);
 460                 return -EINVAL;
 461         }
 462
 463         calibrate_delay();
 464         recalculate_root_clocks();
 465
 466         clk_put(mpurate_ck);
 467
 468         return 0;
 469 }
 470
 471 /**
 472  * omap2_clk_print_new_rates - print summary of current clock tree rates
 473  * @hfclkin_ck_name: clk name for the off-chip HF oscillator
 474  * @core_ck_name: clk name for the on-chip CORE_CLK
 475  * @mpu_ck_name: clk name for the ARM MPU clock
 476  *
 477  * Prints a short message to the console with the HFCLKIN oscillator
 478  * rate, the rate of the CORE clock, and the rate of the ARM MPU clock.
 479  * Called by the boot-time MPU rate switching code.   XXX This is intended
 480  * to be handled by the OPP layer code in the near future and should be
 481  * removed from the clock code.  No return value.
 482  */
 483 void __init omap2_clk_print_new_rates(const char *hfclkin_ck_name,
 484                                       const char *core_ck_name,
 485                                       const char *mpu_ck_name)
 486 {
 487         struct clk *hfclkin_ck, *core_ck, *mpu_ck;
 488         unsigned long hfclkin_rate;
 489
 490         mpu_ck = clk_get(NULL, mpu_ck_name);
 491         if (WARN(IS_ERR(mpu_ck), "clock: failed to get %s.\n", mpu_ck_name))
 492                 return;
 493
 494         core_ck = clk_get(NULL, core_ck_name);
 495         if (WARN(IS_ERR(core_ck), "clock: failed to get %s.\n", core_ck_name))
 496                 return;
 497
 498         hfclkin_ck = clk_get(NULL, hfclkin_ck_name);
 499         if (WARN(IS_ERR(hfclkin_ck), "Failed to get %s.\n", hfclkin_ck_name))
 500                 return;
 501
 502         hfclkin_rate = clk_get_rate(hfclkin_ck);
 503
 504         pr_info("Switched to new clocking rate (Crystal/Core/MPU): %ld.%01ld/%ld/%ld MHz\n",
 505                 (hfclkin_rate / 1000000), ((hfclkin_rate / 100000) % 10),
 506                 (clk_get_rate(core_ck) / 1000000),
 507                 (clk_get_rate(mpu_ck) / 1000000));
 508 }
 509
 510 /* Common data */
 511
 512 struct clk_functions omap2_clk_functions = {
 513         .clk_enable             = omap2_clk_enable,
 514         .clk_disable            = omap2_clk_disable,
 515         .clk_round_rate         = omap2_clk_round_rate,
 516         .clk_set_rate           = omap2_clk_set_rate,
 517         .clk_set_parent         = omap2_clk_set_parent,
 518         .clk_disable_unused     = omap2_clk_disable_unused,
 519 };
 520