Pileus Git - ~andy/linux/blob - arch/arm/mach-omap2/clockdomain.c

   1 /*
   2  * OMAP2/3/4 clockdomain framework functions
   3  *
   4  * Copyright (C) 2008-2011 Texas Instruments, Inc.
   5  * Copyright (C) 2008-2011 Nokia Corporation
   6  *
   7  * Written by Paul Walmsley and Jouni Högander
   8  * Added OMAP4 specific support by Abhijit Pagare <abhijitpagare@ti.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  */
  14 #undef DEBUG
  15
  16 #include <linux/kernel.h>
  17 #include <linux/device.h>
  18 #include <linux/list.h>
  19 #include <linux/errno.h>
  20 #include <linux/string.h>
  21 #include <linux/delay.h>
  22 #include <linux/clk.h>
  23 #include <linux/limits.h>
  24 #include <linux/err.h>
  25 #include <linux/clk-provider.h>
  26
  27 #include <linux/io.h>
  28
  29 #include <linux/bitops.h>
  30
  31 #include "soc.h"
  32 #include "clock.h"
  33 #include "clockdomain.h"
  34
  35 /* clkdm_list contains all registered struct clockdomains */
  36 static LIST_HEAD(clkdm_list);
  37
  38 /* array of clockdomain deps to be added/removed when clkdm in hwsup mode */
  39 static struct clkdm_autodep *autodeps;
  40
  41 static struct clkdm_ops *arch_clkdm;
  42
  43 /* Private functions */
  44
  45 static struct clockdomain *_clkdm_lookup(const char *name)
  46 {
  47         struct clockdomain *clkdm, *temp_clkdm;
  48
  49         if (!name)
  50                 return NULL;
  51
  52         clkdm = NULL;
  53
  54         list_for_each_entry(temp_clkdm, &clkdm_list, node) {
  55                 if (!strcmp(name, temp_clkdm->name)) {
  56                         clkdm = temp_clkdm;
  57                         break;
  58                 }
  59         }
  60
  61         return clkdm;
  62 }
  63
  64 /**
  65  * _clkdm_register - register a clockdomain
  66  * @clkdm: struct clockdomain * to register
  67  *
  68  * Adds a clockdomain to the internal clockdomain list.
  69  * Returns -EINVAL if given a null pointer, -EEXIST if a clockdomain is
  70  * already registered by the provided name, or 0 upon success.
  71  */
  72 static int _clkdm_register(struct clockdomain *clkdm)
  73 {
  74         struct powerdomain *pwrdm;
  75
  76         if (!clkdm || !clkdm->name)
  77                 return -EINVAL;
  78
  79         pwrdm = pwrdm_lookup(clkdm->pwrdm.name);
  80         if (!pwrdm) {
  81                 pr_err("clockdomain: %s: powerdomain %s does not exist\n",
  82                         clkdm->name, clkdm->pwrdm.name);
  83                 return -EINVAL;
  84         }
  85         clkdm->pwrdm.ptr = pwrdm;
  86
  87         /* Verify that the clockdomain is not already registered */
  88         if (_clkdm_lookup(clkdm->name))
  89                 return -EEXIST;
  90
  91         list_add(&clkdm->node, &clkdm_list);
  92
  93         pwrdm_add_clkdm(pwrdm, clkdm);
  94
  95         spin_lock_init(&clkdm->lock);
  96
  97         pr_debug("clockdomain: registered %s\n", clkdm->name);
  98
  99         return 0;
 100 }
 101
 102 /* _clkdm_deps_lookup - look up the specified clockdomain in a clkdm list */
 103 static struct clkdm_dep *_clkdm_deps_lookup(struct clockdomain *clkdm,
 104                                             struct clkdm_dep *deps)
 105 {
 106         struct clkdm_dep *cd;
 107
 108         if (!clkdm || !deps)
 109                 return ERR_PTR(-EINVAL);
 110
 111         for (cd = deps; cd->clkdm_name; cd++) {
 112                 if (!cd->clkdm && cd->clkdm_name)
 113                         cd->clkdm = _clkdm_lookup(cd->clkdm_name);
 114
 115                 if (cd->clkdm == clkdm)
 116                         break;
 117         }
 118
 119         if (!cd->clkdm_name)
 120                 return ERR_PTR(-ENOENT);
 121
 122         return cd;
 123 }
 124
 125 /*
 126  * _autodep_lookup - resolve autodep clkdm names to clkdm pointers; store
 127  * @autodep: struct clkdm_autodep * to resolve
 128  *
 129  * Resolve autodep clockdomain names to clockdomain pointers via
 130  * clkdm_lookup() and store the pointers in the autodep structure.  An
 131  * "autodep" is a clockdomain sleep/wakeup dependency that is
 132  * automatically added and removed whenever clocks in the associated
 133  * clockdomain are enabled or disabled (respectively) when the
 134  * clockdomain is in hardware-supervised mode.  Meant to be called
 135  * once at clockdomain layer initialization, since these should remain
 136  * fixed for a particular architecture.  No return value.
 137  *
 138  * XXX autodeps are deprecated and should be removed at the earliest
 139  * opportunity
 140  */
 141 static void _autodep_lookup(struct clkdm_autodep *autodep)
 142 {
 143         struct clockdomain *clkdm;
 144
 145         if (!autodep)
 146                 return;
 147
 148         clkdm = clkdm_lookup(autodep->clkdm.name);
 149         if (!clkdm) {
 150                 pr_err("clockdomain: autodeps: clockdomain %s does not exist\n",
 151                          autodep->clkdm.name);
 152                 clkdm = ERR_PTR(-ENOENT);
 153         }
 154         autodep->clkdm.ptr = clkdm;
 155 }
 156
 157 /*
 158  * _clkdm_add_autodeps - add auto sleepdeps/wkdeps to clkdm upon clock enable
 159  * @clkdm: struct clockdomain *
 160  *
 161  * Add the "autodep" sleep & wakeup dependencies to clockdomain 'clkdm'
 162  * in hardware-supervised mode.  Meant to be called from clock framework
 163  * when a clock inside clockdomain 'clkdm' is enabled.  No return value.
 164  *
 165  * XXX autodeps are deprecated and should be removed at the earliest
 166  * opportunity
 167  */
 168 void _clkdm_add_autodeps(struct clockdomain *clkdm)
 169 {
 170         struct clkdm_autodep *autodep;
 171
 172         if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS)
 173                 return;
 174
 175         for (autodep = autodeps; autodep->clkdm.ptr; autodep++) {
 176                 if (IS_ERR(autodep->clkdm.ptr))
 177                         continue;
 178
 179                 pr_debug("clockdomain: %s: adding %s sleepdep/wkdep\n",
 180                          clkdm->name, autodep->clkdm.ptr->name);
 181
 182                 clkdm_add_sleepdep(clkdm, autodep->clkdm.ptr);
 183                 clkdm_add_wkdep(clkdm, autodep->clkdm.ptr);
 184         }
 185 }
 186
 187 /*
 188  * _clkdm_add_autodeps - remove auto sleepdeps/wkdeps from clkdm
 189  * @clkdm: struct clockdomain *
 190  *
 191  * Remove the "autodep" sleep & wakeup dependencies from clockdomain 'clkdm'
 192  * in hardware-supervised mode.  Meant to be called from clock framework
 193  * when a clock inside clockdomain 'clkdm' is disabled.  No return value.
 194  *
 195  * XXX autodeps are deprecated and should be removed at the earliest
 196  * opportunity
 197  */
 198 void _clkdm_del_autodeps(struct clockdomain *clkdm)
 199 {
 200         struct clkdm_autodep *autodep;
 201
 202         if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS)
 203                 return;
 204
 205         for (autodep = autodeps; autodep->clkdm.ptr; autodep++) {
 206                 if (IS_ERR(autodep->clkdm.ptr))
 207                         continue;
 208
 209                 pr_debug("clockdomain: %s: removing %s sleepdep/wkdep\n",
 210                          clkdm->name, autodep->clkdm.ptr->name);
 211
 212                 clkdm_del_sleepdep(clkdm, autodep->clkdm.ptr);
 213                 clkdm_del_wkdep(clkdm, autodep->clkdm.ptr);
 214         }
 215 }
 216
 217 /**
 218  * _resolve_clkdm_deps() - resolve clkdm_names in @clkdm_deps to clkdms
 219  * @clkdm: clockdomain that we are resolving dependencies for
 220  * @clkdm_deps: ptr to array of struct clkdm_deps to resolve
 221  *
 222  * Iterates through @clkdm_deps, looking up the struct clockdomain named by
 223  * clkdm_name and storing the clockdomain pointer in the struct clkdm_dep.
 224  * No return value.
 225  */
 226 static void _resolve_clkdm_deps(struct clockdomain *clkdm,
 227                                 struct clkdm_dep *clkdm_deps)
 228 {
 229         struct clkdm_dep *cd;
 230
 231         for (cd = clkdm_deps; cd && cd->clkdm_name; cd++) {
 232                 if (cd->clkdm)
 233                         continue;
 234                 cd->clkdm = _clkdm_lookup(cd->clkdm_name);
 235
 236                 WARN(!cd->clkdm, "clockdomain: %s: could not find clkdm %s while resolving dependencies - should never happen",
 237                      clkdm->name, cd->clkdm_name);
 238         }
 239 }
 240
 241 /* Public functions */
 242
 243 /**
 244  * clkdm_register_platform_funcs - register clockdomain implementation fns
 245  * @co: func pointers for arch specific implementations
 246  *
 247  * Register the list of function pointers used to implement the
 248  * clockdomain functions on different OMAP SoCs.  Should be called
 249  * before any other clkdm_register*() function.  Returns -EINVAL if
 250  * @co is null, -EEXIST if platform functions have already been
 251  * registered, or 0 upon success.
 252  */
 253 int clkdm_register_platform_funcs(struct clkdm_ops *co)
 254 {
 255         if (!co)
 256                 return -EINVAL;
 257
 258         if (arch_clkdm)
 259                 return -EEXIST;
 260
 261         arch_clkdm = co;
 262
 263         return 0;
 264 };
 265
 266 /**
 267  * clkdm_register_clkdms - register SoC clockdomains
 268  * @cs: pointer to an array of struct clockdomain to register
 269  *
 270  * Register the clockdomains available on a particular OMAP SoC.  Must
 271  * be called after clkdm_register_platform_funcs().  May be called
 272  * multiple times.  Returns -EACCES if called before
 273  * clkdm_register_platform_funcs(); -EINVAL if the argument @cs is
 274  * null; or 0 upon success.
 275  */
 276 int clkdm_register_clkdms(struct clockdomain **cs)
 277 {
 278         struct clockdomain **c = NULL;
 279
 280         if (!arch_clkdm)
 281                 return -EACCES;
 282
 283         if (!cs)
 284                 return -EINVAL;
 285
 286         for (c = cs; *c; c++)
 287                 _clkdm_register(*c);
 288
 289         return 0;
 290 }
 291
 292 /**
 293  * clkdm_register_autodeps - register autodeps (if required)
 294  * @ia: pointer to a static array of struct clkdm_autodep to register
 295  *
 296  * Register clockdomain "automatic dependencies."  These are
 297  * clockdomain wakeup and sleep dependencies that are automatically
 298  * added whenever the first clock inside a clockdomain is enabled, and
 299  * removed whenever the last clock inside a clockdomain is disabled.
 300  * These are currently only used on OMAP3 devices, and are deprecated,
 301  * since they waste energy.  However, until the OMAP2/3 IP block
 302  * enable/disable sequence can be converted to match the OMAP4
 303  * sequence, they are needed.
 304  *
 305  * Must be called only after all of the SoC clockdomains are
 306  * registered, since the function will resolve autodep clockdomain
 307  * names into clockdomain pointers.
 308  *
 309  * The struct clkdm_autodep @ia array must be static, as this function
 310  * does not copy the array elements.
 311  *
 312  * Returns -EACCES if called before any clockdomains have been
 313  * registered, -EINVAL if called with a null @ia argument, -EEXIST if
 314  * autodeps have already been registered, or 0 upon success.
 315  */
 316 int clkdm_register_autodeps(struct clkdm_autodep *ia)
 317 {
 318         struct clkdm_autodep *a = NULL;
 319
 320         if (list_empty(&clkdm_list))
 321                 return -EACCES;
 322
 323         if (!ia)
 324                 return -EINVAL;
 325
 326         if (autodeps)
 327                 return -EEXIST;
 328
 329         autodeps = ia;
 330         for (a = autodeps; a->clkdm.ptr; a++)
 331                 _autodep_lookup(a);
 332
 333         return 0;
 334 }
 335
 336 /**
 337  * clkdm_complete_init - set up the clockdomain layer
 338  *
 339  * Put all clockdomains into software-supervised mode; PM code should
 340  * later enable hardware-supervised mode as appropriate.  Must be
 341  * called after clkdm_register_clkdms().  Returns -EACCES if called
 342  * before clkdm_register_clkdms(), or 0 upon success.
 343  */
 344 int clkdm_complete_init(void)
 345 {
 346         struct clockdomain *clkdm;
 347
 348         if (list_empty(&clkdm_list))
 349                 return -EACCES;
 350
 351         list_for_each_entry(clkdm, &clkdm_list, node) {
 352                 if (clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)
 353                         clkdm_wakeup(clkdm);
 354                 else if (clkdm->flags & CLKDM_CAN_DISABLE_AUTO)
 355                         clkdm_deny_idle(clkdm);
 356
 357                 _resolve_clkdm_deps(clkdm, clkdm->wkdep_srcs);
 358                 clkdm_clear_all_wkdeps(clkdm);
 359
 360                 _resolve_clkdm_deps(clkdm, clkdm->sleepdep_srcs);
 361                 clkdm_clear_all_sleepdeps(clkdm);
 362         }
 363
 364         return 0;
 365 }
 366
 367 /**
 368  * clkdm_lookup - look up a clockdomain by name, return a pointer
 369  * @name: name of clockdomain
 370  *
 371  * Find a registered clockdomain by its name @name.  Returns a pointer
 372  * to the struct clockdomain if found, or NULL otherwise.
 373  */
 374 struct clockdomain *clkdm_lookup(const char *name)
 375 {
 376         struct clockdomain *clkdm, *temp_clkdm;
 377
 378         if (!name)
 379                 return NULL;
 380
 381         clkdm = NULL;
 382
 383         list_for_each_entry(temp_clkdm, &clkdm_list, node) {
 384                 if (!strcmp(name, temp_clkdm->name)) {
 385                         clkdm = temp_clkdm;
 386                         break;
 387                 }
 388         }
 389
 390         return clkdm;
 391 }
 392
 393 /**
 394  * clkdm_for_each - call function on each registered clockdomain
 395  * @fn: callback function *
 396  *
 397  * Call the supplied function @fn for each registered clockdomain.
 398  * The callback function @fn can return anything but 0 to bail
 399  * out early from the iterator.  The callback function is called with
 400  * the clkdm_mutex held, so no clockdomain structure manipulation
 401  * functions should be called from the callback, although hardware
 402  * clockdomain control functions are fine.  Returns the last return
 403  * value of the callback function, which should be 0 for success or
 404  * anything else to indicate failure; or -EINVAL if the function pointer
 405  * is null.
 406  */
 407 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
 408                         void *user)
 409 {
 410         struct clockdomain *clkdm;
 411         int ret = 0;
 412
 413         if (!fn)
 414                 return -EINVAL;
 415
 416         list_for_each_entry(clkdm, &clkdm_list, node) {
 417                 ret = (*fn)(clkdm, user);
 418                 if (ret)
 419                         break;
 420         }
 421
 422         return ret;
 423 }
 424
 425
 426 /**
 427  * clkdm_get_pwrdm - return a ptr to the pwrdm that this clkdm resides in
 428  * @clkdm: struct clockdomain *
 429  *
 430  * Return a pointer to the struct powerdomain that the specified clockdomain
 431  * @clkdm exists in, or returns NULL if @clkdm is NULL.
 432  */
 433 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm)
 434 {
 435         if (!clkdm)
 436                 return NULL;
 437
 438         return clkdm->pwrdm.ptr;
 439 }
 440
 441
 442 /* Hardware clockdomain control */
 443
 444 /**
 445  * clkdm_add_wkdep - add a wakeup dependency from clkdm2 to clkdm1
 446  * @clkdm1: wake this struct clockdomain * up (dependent)
 447  * @clkdm2: when this struct clockdomain * wakes up (source)
 448  *
 449  * When the clockdomain represented by @clkdm2 wakes up, wake up
 450  * @clkdm1. Implemented in hardware on the OMAP, this feature is
 451  * designed to reduce wakeup latency of the dependent clockdomain @clkdm1.
 452  * Returns -EINVAL if presented with invalid clockdomain pointers,
 453  * -ENOENT if @clkdm2 cannot wake up clkdm1 in hardware, or 0 upon
 454  * success.
 455  */
 456 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
 457 {
 458         struct clkdm_dep *cd;
 459         int ret = 0;
 460
 461         if (!clkdm1 || !clkdm2)
 462                 return -EINVAL;
 463
 464         cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
 465         if (IS_ERR(cd))
 466                 ret = PTR_ERR(cd);
 467
 468         if (!arch_clkdm || !arch_clkdm->clkdm_add_wkdep)
 469                 ret = -EINVAL;
 470
 471         if (ret) {
 472                 pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n",
 473                          clkdm1->name, clkdm2->name);
 474                 return ret;
 475         }
 476
 477         if (atomic_inc_return(&cd->wkdep_usecount) == 1) {
 478                 pr_debug("clockdomain: hardware will wake up %s when %s wakes up\n",
 479                          clkdm1->name, clkdm2->name);
 480
 481                 ret = arch_clkdm->clkdm_add_wkdep(clkdm1, clkdm2);
 482         }
 483
 484         return ret;
 485 }
 486
 487 /**
 488  * clkdm_del_wkdep - remove a wakeup dependency from clkdm2 to clkdm1
 489  * @clkdm1: wake this struct clockdomain * up (dependent)
 490  * @clkdm2: when this struct clockdomain * wakes up (source)
 491  *
 492  * Remove a wakeup dependency causing @clkdm1 to wake up when @clkdm2
 493  * wakes up.  Returns -EINVAL if presented with invalid clockdomain
 494  * pointers, -ENOENT if @clkdm2 cannot wake up clkdm1 in hardware, or
 495  * 0 upon success.
 496  */
 497 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
 498 {
 499         struct clkdm_dep *cd;
 500         int ret = 0;
 501
 502         if (!clkdm1 || !clkdm2)
 503                 return -EINVAL;
 504
 505         cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
 506         if (IS_ERR(cd))
 507                 ret = PTR_ERR(cd);
 508
 509         if (!arch_clkdm || !arch_clkdm->clkdm_del_wkdep)
 510                 ret = -EINVAL;
 511
 512         if (ret) {
 513                 pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n",
 514                          clkdm1->name, clkdm2->name);
 515                 return ret;
 516         }
 517
 518         if (atomic_dec_return(&cd->wkdep_usecount) == 0) {
 519                 pr_debug("clockdomain: hardware will no longer wake up %s after %s wakes up\n",
 520                          clkdm1->name, clkdm2->name);
 521
 522                 ret = arch_clkdm->clkdm_del_wkdep(clkdm1, clkdm2);
 523         }
 524
 525         return ret;
 526 }
 527
 528 /**
 529  * clkdm_read_wkdep - read wakeup dependency state from clkdm2 to clkdm1
 530  * @clkdm1: wake this struct clockdomain * up (dependent)
 531  * @clkdm2: when this struct clockdomain * wakes up (source)
 532  *
 533  * Return 1 if a hardware wakeup dependency exists wherein @clkdm1 will be
 534  * awoken when @clkdm2 wakes up; 0 if dependency is not set; -EINVAL
 535  * if either clockdomain pointer is invalid; or -ENOENT if the hardware
 536  * is incapable.
 537  *
 538  * REVISIT: Currently this function only represents software-controllable
 539  * wakeup dependencies.  Wakeup dependencies fixed in hardware are not
 540  * yet handled here.
 541  */
 542 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
 543 {
 544         struct clkdm_dep *cd;
 545         int ret = 0;
 546
 547         if (!clkdm1 || !clkdm2)
 548                 return -EINVAL;
 549
 550         cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
 551         if (IS_ERR(cd))
 552                 ret = PTR_ERR(cd);
 553
 554         if (!arch_clkdm || !arch_clkdm->clkdm_read_wkdep)
 555                 ret = -EINVAL;
 556
 557         if (ret) {
 558                 pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n",
 559                          clkdm1->name, clkdm2->name);
 560                 return ret;
 561         }
 562
 563         /* XXX It's faster to return the atomic wkdep_usecount */
 564         return arch_clkdm->clkdm_read_wkdep(clkdm1, clkdm2);
 565 }
 566
 567 /**
 568  * clkdm_clear_all_wkdeps - remove all wakeup dependencies from target clkdm
 569  * @clkdm: struct clockdomain * to remove all wakeup dependencies from
 570  *
 571  * Remove all inter-clockdomain wakeup dependencies that could cause
 572  * @clkdm to wake.  Intended to be used during boot to initialize the
 573  * PRCM to a known state, after all clockdomains are put into swsup idle
 574  * and woken up.  Returns -EINVAL if @clkdm pointer is invalid, or
 575  * 0 upon success.
 576  */
 577 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm)
 578 {
 579         if (!clkdm)
 580                 return -EINVAL;
 581
 582         if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_wkdeps)
 583                 return -EINVAL;
 584
 585         return arch_clkdm->clkdm_clear_all_wkdeps(clkdm);
 586 }
 587
 588 /**
 589  * clkdm_add_sleepdep - add a sleep dependency from clkdm2 to clkdm1
 590  * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
 591  * @clkdm2: when this struct clockdomain * is active (source)
 592  *
 593  * Prevent @clkdm1 from automatically going inactive (and then to
 594  * retention or off) if @clkdm2 is active.  Returns -EINVAL if
 595  * presented with invalid clockdomain pointers or called on a machine
 596  * that does not support software-configurable hardware sleep
 597  * dependencies, -ENOENT if the specified dependency cannot be set in
 598  * hardware, or 0 upon success.
 599  */
 600 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
 601 {
 602         struct clkdm_dep *cd;
 603         int ret = 0;
 604
 605         if (!clkdm1 || !clkdm2)
 606                 return -EINVAL;
 607
 608         cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
 609         if (IS_ERR(cd))
 610                 ret = PTR_ERR(cd);
 611
 612         if (!arch_clkdm || !arch_clkdm->clkdm_add_sleepdep)
 613                 ret = -EINVAL;
 614
 615         if (ret) {
 616                 pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n",
 617                          clkdm1->name, clkdm2->name);
 618                 return ret;
 619         }
 620
 621         if (atomic_inc_return(&cd->sleepdep_usecount) == 1) {
 622                 pr_debug("clockdomain: will prevent %s from sleeping if %s is active\n",
 623                          clkdm1->name, clkdm2->name);
 624
 625                 ret = arch_clkdm->clkdm_add_sleepdep(clkdm1, clkdm2);
 626         }
 627
 628         return ret;
 629 }
 630
 631 /**
 632  * clkdm_del_sleepdep - remove a sleep dependency from clkdm2 to clkdm1
 633  * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
 634  * @clkdm2: when this struct clockdomain * is active (source)
 635  *
 636  * Allow @clkdm1 to automatically go inactive (and then to retention or
 637  * off), independent of the activity state of @clkdm2.  Returns -EINVAL
 638  * if presented with invalid clockdomain pointers or called on a machine
 639  * that does not support software-configurable hardware sleep dependencies,
 640  * -ENOENT if the specified dependency cannot be cleared in hardware, or
 641  * 0 upon success.
 642  */
 643 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
 644 {
 645         struct clkdm_dep *cd;
 646         int ret = 0;
 647
 648         if (!clkdm1 || !clkdm2)
 649                 return -EINVAL;
 650
 651         cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
 652         if (IS_ERR(cd))
 653                 ret = PTR_ERR(cd);
 654
 655         if (!arch_clkdm || !arch_clkdm->clkdm_del_sleepdep)
 656                 ret = -EINVAL;
 657
 658         if (ret) {
 659                 pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n",
 660                          clkdm1->name, clkdm2->name);
 661                 return ret;
 662         }
 663
 664         if (atomic_dec_return(&cd->sleepdep_usecount) == 0) {
 665                 pr_debug("clockdomain: will no longer prevent %s from sleeping if %s is active\n",
 666                          clkdm1->name, clkdm2->name);
 667
 668                 ret = arch_clkdm->clkdm_del_sleepdep(clkdm1, clkdm2);
 669         }
 670
 671         return ret;
 672 }
 673
 674 /**
 675  * clkdm_read_sleepdep - read sleep dependency state from clkdm2 to clkdm1
 676  * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
 677  * @clkdm2: when this struct clockdomain * is active (source)
 678  *
 679  * Return 1 if a hardware sleep dependency exists wherein @clkdm1 will
 680  * not be allowed to automatically go inactive if @clkdm2 is active;
 681  * 0 if @clkdm1's automatic power state inactivity transition is independent
 682  * of @clkdm2's; -EINVAL if either clockdomain pointer is invalid or called
 683  * on a machine that does not support software-configurable hardware sleep
 684  * dependencies; or -ENOENT if the hardware is incapable.
 685  *
 686  * REVISIT: Currently this function only represents software-controllable
 687  * sleep dependencies.  Sleep dependencies fixed in hardware are not
 688  * yet handled here.
 689  */
 690 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
 691 {
 692         struct clkdm_dep *cd;
 693         int ret = 0;
 694
 695         if (!clkdm1 || !clkdm2)
 696                 return -EINVAL;
 697
 698         cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
 699         if (IS_ERR(cd))
 700                 ret = PTR_ERR(cd);
 701
 702         if (!arch_clkdm || !arch_clkdm->clkdm_read_sleepdep)
 703                 ret = -EINVAL;
 704
 705         if (ret) {
 706                 pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n",
 707                          clkdm1->name, clkdm2->name);
 708                 return ret;
 709         }
 710
 711         /* XXX It's faster to return the atomic sleepdep_usecount */
 712         return arch_clkdm->clkdm_read_sleepdep(clkdm1, clkdm2);
 713 }
 714
 715 /**
 716  * clkdm_clear_all_sleepdeps - remove all sleep dependencies from target clkdm
 717  * @clkdm: struct clockdomain * to remove all sleep dependencies from
 718  *
 719  * Remove all inter-clockdomain sleep dependencies that could prevent
 720  * @clkdm from idling.  Intended to be used during boot to initialize the
 721  * PRCM to a known state, after all clockdomains are put into swsup idle
 722  * and woken up.  Returns -EINVAL if @clkdm pointer is invalid, or
 723  * 0 upon success.
 724  */
 725 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm)
 726 {
 727         if (!clkdm)
 728                 return -EINVAL;
 729
 730         if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_sleepdeps)
 731                 return -EINVAL;
 732
 733         return arch_clkdm->clkdm_clear_all_sleepdeps(clkdm);
 734 }
 735
 736 /**
 737  * clkdm_sleep - force clockdomain sleep transition
 738  * @clkdm: struct clockdomain *
 739  *
 740  * Instruct the CM to force a sleep transition on the specified
 741  * clockdomain @clkdm.  Returns -EINVAL if @clkdm is NULL or if
 742  * clockdomain does not support software-initiated sleep; 0 upon
 743  * success.
 744  */
 745 int clkdm_sleep(struct clockdomain *clkdm)
 746 {
 747         int ret;
 748         unsigned long flags;
 749
 750         if (!clkdm)
 751                 return -EINVAL;
 752
 753         if (!(clkdm->flags & CLKDM_CAN_FORCE_SLEEP)) {
 754                 pr_debug("clockdomain: %s does not support forcing sleep via software\n",
 755                          clkdm->name);
 756                 return -EINVAL;
 757         }
 758
 759         if (!arch_clkdm || !arch_clkdm->clkdm_sleep)
 760                 return -EINVAL;
 761
 762         pr_debug("clockdomain: forcing sleep on %s\n", clkdm->name);
 763
 764         spin_lock_irqsave(&clkdm->lock, flags);
 765         clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
 766         ret = arch_clkdm->clkdm_sleep(clkdm);
 767         spin_unlock_irqrestore(&clkdm->lock, flags);
 768         return ret;
 769 }
 770
 771 /**
 772  * clkdm_wakeup - force clockdomain wakeup transition
 773  * @clkdm: struct clockdomain *
 774  *
 775  * Instruct the CM to force a wakeup transition on the specified
 776  * clockdomain @clkdm.  Returns -EINVAL if @clkdm is NULL or if the
 777  * clockdomain does not support software-controlled wakeup; 0 upon
 778  * success.
 779  */
 780 int clkdm_wakeup(struct clockdomain *clkdm)
 781 {
 782         int ret;
 783         unsigned long flags;
 784
 785         if (!clkdm)
 786                 return -EINVAL;
 787
 788         if (!(clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)) {
 789                 pr_debug("clockdomain: %s does not support forcing wakeup via software\n",
 790                          clkdm->name);
 791                 return -EINVAL;
 792         }
 793
 794         if (!arch_clkdm || !arch_clkdm->clkdm_wakeup)
 795                 return -EINVAL;
 796
 797         pr_debug("clockdomain: forcing wakeup on %s\n", clkdm->name);
 798
 799         spin_lock_irqsave(&clkdm->lock, flags);
 800         clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
 801         ret = arch_clkdm->clkdm_wakeup(clkdm);
 802         ret |= pwrdm_state_switch(clkdm->pwrdm.ptr);
 803         spin_unlock_irqrestore(&clkdm->lock, flags);
 804         return ret;
 805 }
 806
 807 /**
 808  * clkdm_allow_idle - enable hwsup idle transitions for clkdm
 809  * @clkdm: struct clockdomain *
 810  *
 811  * Allow the hardware to automatically switch the clockdomain @clkdm into
 812  * active or idle states, as needed by downstream clocks.  If the
 813  * clockdomain has any downstream clocks enabled in the clock
 814  * framework, wkdep/sleepdep autodependencies are added; this is so
 815  * device drivers can read and write to the device.  No return value.
 816  */
 817 void clkdm_allow_idle(struct clockdomain *clkdm)
 818 {
 819         unsigned long flags;
 820
 821         if (!clkdm)
 822                 return;
 823
 824         if (!(clkdm->flags & CLKDM_CAN_ENABLE_AUTO)) {
 825                 pr_debug("clock: %s: automatic idle transitions cannot be enabled\n",
 826                          clkdm->name);
 827                 return;
 828         }
 829
 830         if (!arch_clkdm || !arch_clkdm->clkdm_allow_idle)
 831                 return;
 832
 833         pr_debug("clockdomain: enabling automatic idle transitions for %s\n",
 834                  clkdm->name);
 835
 836         spin_lock_irqsave(&clkdm->lock, flags);
 837         clkdm->_flags |= _CLKDM_FLAG_HWSUP_ENABLED;
 838         arch_clkdm->clkdm_allow_idle(clkdm);
 839         pwrdm_state_switch(clkdm->pwrdm.ptr);
 840         spin_unlock_irqrestore(&clkdm->lock, flags);
 841 }
 842
 843 /**
 844  * clkdm_deny_idle - disable hwsup idle transitions for clkdm
 845  * @clkdm: struct clockdomain *
 846  *
 847  * Prevent the hardware from automatically switching the clockdomain
 848  * @clkdm into inactive or idle states.  If the clockdomain has
 849  * downstream clocks enabled in the clock framework, wkdep/sleepdep
 850  * autodependencies are removed.  No return value.
 851  */
 852 void clkdm_deny_idle(struct clockdomain *clkdm)
 853 {
 854         unsigned long flags;
 855
 856         if (!clkdm)
 857                 return;
 858
 859         if (!(clkdm->flags & CLKDM_CAN_DISABLE_AUTO)) {
 860                 pr_debug("clockdomain: %s: automatic idle transitions cannot be disabled\n",
 861                          clkdm->name);
 862                 return;
 863         }
 864
 865         if (!arch_clkdm || !arch_clkdm->clkdm_deny_idle)
 866                 return;
 867
 868         pr_debug("clockdomain: disabling automatic idle transitions for %s\n",
 869                  clkdm->name);
 870
 871         spin_lock_irqsave(&clkdm->lock, flags);
 872         clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
 873         arch_clkdm->clkdm_deny_idle(clkdm);
 874         pwrdm_state_switch(clkdm->pwrdm.ptr);
 875         spin_unlock_irqrestore(&clkdm->lock, flags);
 876 }
 877
 878 /**
 879  * clkdm_in_hwsup - is clockdomain @clkdm have hardware-supervised idle enabled?
 880  * @clkdm: struct clockdomain *
 881  *
 882  * Returns true if clockdomain @clkdm currently has
 883  * hardware-supervised idle enabled, or false if it does not or if
 884  * @clkdm is NULL.  It is only valid to call this function after
 885  * clkdm_init() has been called.  This function does not actually read
 886  * bits from the hardware; it instead tests an in-memory flag that is
 887  * changed whenever the clockdomain code changes the auto-idle mode.
 888  */
 889 bool clkdm_in_hwsup(struct clockdomain *clkdm)
 890 {
 891         bool ret;
 892         unsigned long flags;
 893
 894         if (!clkdm)
 895                 return false;
 896
 897         spin_lock_irqsave(&clkdm->lock, flags);
 898         ret = (clkdm->_flags & _CLKDM_FLAG_HWSUP_ENABLED) ? true : false;
 899         spin_unlock_irqrestore(&clkdm->lock, flags);
 900
 901         return ret;
 902 }
 903
 904 /**
 905  * clkdm_missing_idle_reporting - can @clkdm enter autoidle even if in use?
 906  * @clkdm: struct clockdomain *
 907  *
 908  * Returns true if clockdomain @clkdm has the
 909  * CLKDM_MISSING_IDLE_REPORTING flag set, or false if not or @clkdm is
 910  * null.  More information is available in the documentation for the
 911  * CLKDM_MISSING_IDLE_REPORTING macro.
 912  */
 913 bool clkdm_missing_idle_reporting(struct clockdomain *clkdm)
 914 {
 915         if (!clkdm)
 916                 return false;
 917
 918         return (clkdm->flags & CLKDM_MISSING_IDLE_REPORTING) ? true : false;
 919 }
 920
 921 /* Clockdomain-to-clock/hwmod framework interface code */
 922
 923 static int _clkdm_clk_hwmod_enable(struct clockdomain *clkdm)
 924 {
 925         unsigned long flags;
 926
 927         if (!clkdm || !arch_clkdm || !arch_clkdm->clkdm_clk_enable)
 928                 return -EINVAL;
 929
 930         spin_lock_irqsave(&clkdm->lock, flags);
 931
 932         /*
 933          * For arch's with no autodeps, clkcm_clk_enable
 934          * should be called for every clock instance or hwmod that is
 935          * enabled, so the clkdm can be force woken up.
 936          */
 937         if ((atomic_inc_return(&clkdm->usecount) > 1) && autodeps) {
 938                 spin_unlock_irqrestore(&clkdm->lock, flags);
 939                 return 0;
 940         }
 941
 942         arch_clkdm->clkdm_clk_enable(clkdm);
 943         pwrdm_state_switch(clkdm->pwrdm.ptr);
 944         spin_unlock_irqrestore(&clkdm->lock, flags);
 945
 946         pr_debug("clockdomain: %s: enabled\n", clkdm->name);
 947
 948         return 0;
 949 }
 950
 951 /**
 952  * clkdm_clk_enable - add an enabled downstream clock to this clkdm
 953  * @clkdm: struct clockdomain *
 954  * @clk: struct clk * of the enabled downstream clock
 955  *
 956  * Increment the usecount of the clockdomain @clkdm and ensure that it
 957  * is awake before @clk is enabled.  Intended to be called by
 958  * clk_enable() code.  If the clockdomain is in software-supervised
 959  * idle mode, force the clockdomain to wake.  If the clockdomain is in
 960  * hardware-supervised idle mode, add clkdm-pwrdm autodependencies, to
 961  * ensure that devices in the clockdomain can be read from/written to
 962  * by on-chip processors.  Returns -EINVAL if passed null pointers;
 963  * returns 0 upon success or if the clockdomain is in hwsup idle mode.
 964  */
 965 int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk)
 966 {
 967         /*
 968          * XXX Rewrite this code to maintain a list of enabled
 969          * downstream clocks for debugging purposes?
 970          */
 971
 972         if (!clk)
 973                 return -EINVAL;
 974
 975         return _clkdm_clk_hwmod_enable(clkdm);
 976 }
 977
 978 /**
 979  * clkdm_clk_disable - remove an enabled downstream clock from this clkdm
 980  * @clkdm: struct clockdomain *
 981  * @clk: struct clk * of the disabled downstream clock
 982  *
 983  * Decrement the usecount of this clockdomain @clkdm when @clk is
 984  * disabled.  Intended to be called by clk_disable() code.  If the
 985  * clockdomain usecount goes to 0, put the clockdomain to sleep
 986  * (software-supervised mode) or remove the clkdm autodependencies
 987  * (hardware-supervised mode).  Returns -EINVAL if passed null
 988  * pointers; -ERANGE if the @clkdm usecount underflows; or returns 0
 989  * upon success or if the clockdomain is in hwsup idle mode.
 990  */
 991 int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk)
 992 {
 993         unsigned long flags;
 994
 995         if (!clkdm || !clk || !arch_clkdm || !arch_clkdm->clkdm_clk_disable)
 996                 return -EINVAL;
 997
 998         spin_lock_irqsave(&clkdm->lock, flags);
 999
1000         /* corner case: disabling unused clocks */
1001         if ((__clk_get_enable_count(clk) == 0) &&
1002             (atomic_read(&clkdm->usecount) == 0))
1003                 goto ccd_exit;
1004
1005         if (atomic_read(&clkdm->usecount) == 0) {
1006                 spin_unlock_irqrestore(&clkdm->lock, flags);
1007                 WARN_ON(1); /* underflow */
1008                 return -ERANGE;
1009         }
1010
1011         if (atomic_dec_return(&clkdm->usecount) > 0) {
1012                 spin_unlock_irqrestore(&clkdm->lock, flags);
1013                 return 0;
1014         }
1015
1016         arch_clkdm->clkdm_clk_disable(clkdm);
1017         pwrdm_state_switch(clkdm->pwrdm.ptr);
1018
1019         pr_debug("clockdomain: %s: disabled\n", clkdm->name);
1020
1021 ccd_exit:
1022         spin_unlock_irqrestore(&clkdm->lock, flags);
1023
1024         return 0;
1025 }
1026
1027 /**
1028  * clkdm_hwmod_enable - add an enabled downstream hwmod to this clkdm
1029  * @clkdm: struct clockdomain *
1030  * @oh: struct omap_hwmod * of the enabled downstream hwmod
1031  *
1032  * Increment the usecount of the clockdomain @clkdm and ensure that it
1033  * is awake before @oh is enabled. Intended to be called by
1034  * module_enable() code.
1035  * If the clockdomain is in software-supervised idle mode, force the
1036  * clockdomain to wake.  If the clockdomain is in hardware-supervised idle
1037  * mode, add clkdm-pwrdm autodependencies, to ensure that devices in the
1038  * clockdomain can be read from/written to by on-chip processors.
1039  * Returns -EINVAL if passed null pointers;
1040  * returns 0 upon success or if the clockdomain is in hwsup idle mode.
1041  */
1042 int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh)
1043 {
1044         /* The clkdm attribute does not exist yet prior OMAP4 */
1045         if (cpu_is_omap24xx() || cpu_is_omap34xx())
1046                 return 0;
1047
1048         /*
1049          * XXX Rewrite this code to maintain a list of enabled
1050          * downstream hwmods for debugging purposes?
1051          */
1052
1053         if (!oh)
1054                 return -EINVAL;
1055
1056         return _clkdm_clk_hwmod_enable(clkdm);
1057 }
1058
1059 /**
1060  * clkdm_hwmod_disable - remove an enabled downstream hwmod from this clkdm
1061  * @clkdm: struct clockdomain *
1062  * @oh: struct omap_hwmod * of the disabled downstream hwmod
1063  *
1064  * Decrement the usecount of this clockdomain @clkdm when @oh is
1065  * disabled. Intended to be called by module_disable() code.
1066  * If the clockdomain usecount goes to 0, put the clockdomain to sleep
1067  * (software-supervised mode) or remove the clkdm autodependencies
1068  * (hardware-supervised mode).
1069  * Returns -EINVAL if passed null pointers; -ERANGE if the @clkdm usecount
1070  * underflows; or returns 0 upon success or if the clockdomain is in hwsup
1071  * idle mode.
1072  */
1073 int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh)
1074 {
1075         unsigned long flags;
1076
1077         /* The clkdm attribute does not exist yet prior OMAP4 */
1078         if (cpu_is_omap24xx() || cpu_is_omap34xx())
1079                 return 0;
1080
1081         /*
1082          * XXX Rewrite this code to maintain a list of enabled
1083          * downstream hwmods for debugging purposes?
1084          */
1085
1086         if (!clkdm || !oh || !arch_clkdm || !arch_clkdm->clkdm_clk_disable)
1087                 return -EINVAL;
1088
1089         spin_lock_irqsave(&clkdm->lock, flags);
1090
1091         if (atomic_read(&clkdm->usecount) == 0) {
1092                 spin_unlock_irqrestore(&clkdm->lock, flags);
1093                 WARN_ON(1); /* underflow */
1094                 return -ERANGE;
1095         }
1096
1097         if (atomic_dec_return(&clkdm->usecount) > 0) {
1098                 spin_unlock_irqrestore(&clkdm->lock, flags);
1099                 return 0;
1100         }
1101
1102         arch_clkdm->clkdm_clk_disable(clkdm);
1103         pwrdm_state_switch(clkdm->pwrdm.ptr);
1104         spin_unlock_irqrestore(&clkdm->lock, flags);
1105
1106         pr_debug("clockdomain: %s: disabled\n", clkdm->name);
1107
1108         return 0;
1109 }
1110