arch/arm/mach-omap2/powerdomain.c

   1 /*
   2  * OMAP powerdomain control
   3  *
   4  * Copyright (C) 2007-2008, 2011 Texas Instruments, Inc.
   5  * Copyright (C) 2007-2011 Nokia Corporation
   6  *
   7  * Written by Paul Walmsley
   8  * Added OMAP4 specific support by Abhijit Pagare <abhijitpagare@ti.com>
   9  * State counting code by Tero Kristo <tero.kristo@nokia.com>
  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/types.h>
  19 #include <linux/list.h>
  20 #include <linux/errno.h>
  21 #include <linux/string.h>
  22 #include <trace/events/power.h>
  23
  24 #include "cm2xxx_3xxx.h"
  25 #include "prcm44xx.h"
  26 #include "cm44xx.h"
  27 #include "prm2xxx_3xxx.h"
  28 #include "prm44xx.h"
  29
  30 #include <asm/cpu.h>
  31
  32 #include "powerdomain.h"
  33 #include "clockdomain.h"
  34
  35 #include "soc.h"
  36 #include "pm.h"
  37
  38 #define PWRDM_TRACE_STATES_FLAG (1<<31)
  39
  40 enum {
  41         PWRDM_STATE_NOW = 0,
  42         PWRDM_STATE_PREV,
  43 };
  44
  45
  46 /* pwrdm_list contains all registered struct powerdomains */
  47 static LIST_HEAD(pwrdm_list);
  48
  49 static struct pwrdm_ops *arch_pwrdm;
  50
  51 /* Private functions */
  52
  53 static struct powerdomain *_pwrdm_lookup(const char *name)
  54 {
  55         struct powerdomain *pwrdm, *temp_pwrdm;
  56
  57         pwrdm = NULL;
  58
  59         list_for_each_entry(temp_pwrdm, &pwrdm_list, node) {
  60                 if (!strcmp(name, temp_pwrdm->name)) {
  61                         pwrdm = temp_pwrdm;
  62                         break;
  63                 }
  64         }
  65
  66         return pwrdm;
  67 }
  68
  69 /**
  70  * _pwrdm_register - register a powerdomain
  71  * @pwrdm: struct powerdomain * to register
  72  *
  73  * Adds a powerdomain to the internal powerdomain list.  Returns
  74  * -EINVAL if given a null pointer, -EEXIST if a powerdomain is
  75  * already registered by the provided name, or 0 upon success.
  76  */
  77 static int _pwrdm_register(struct powerdomain *pwrdm)
  78 {
  79         int i;
  80         struct voltagedomain *voltdm;
  81
  82         if (!pwrdm || !pwrdm->name)
  83                 return -EINVAL;
  84
  85         if (cpu_is_omap44xx() &&
  86             pwrdm->prcm_partition == OMAP4430_INVALID_PRCM_PARTITION) {
  87                 pr_err("powerdomain: %s: missing OMAP4 PRCM partition ID\n",
  88                        pwrdm->name);
  89                 return -EINVAL;
  90         }
  91
  92         if (_pwrdm_lookup(pwrdm->name))
  93                 return -EEXIST;
  94
  95         voltdm = voltdm_lookup(pwrdm->voltdm.name);
  96         if (!voltdm) {
  97                 pr_err("powerdomain: %s: voltagedomain %s does not exist\n",
  98                        pwrdm->name, pwrdm->voltdm.name);
  99                 return -EINVAL;
 100         }
 101         pwrdm->voltdm.ptr = voltdm;
 102         INIT_LIST_HEAD(&pwrdm->voltdm_node);
 103         voltdm_add_pwrdm(voltdm, pwrdm);
 104
 105         list_add(&pwrdm->node, &pwrdm_list);
 106
 107         /* Initialize the powerdomain's state counter */
 108         for (i = 0; i < PWRDM_MAX_PWRSTS; i++)
 109                 pwrdm->state_counter[i] = 0;
 110
 111         pwrdm->ret_logic_off_counter = 0;
 112         for (i = 0; i < pwrdm->banks; i++)
 113                 pwrdm->ret_mem_off_counter[i] = 0;
 114
 115         pwrdm_wait_transition(pwrdm);
 116         pwrdm->state = pwrdm_read_pwrst(pwrdm);
 117         pwrdm->state_counter[pwrdm->state] = 1;
 118
 119         pr_debug("powerdomain: registered %s\n", pwrdm->name);
 120
 121         return 0;
 122 }
 123
 124 static void _update_logic_membank_counters(struct powerdomain *pwrdm)
 125 {
 126         int i;
 127         u8 prev_logic_pwrst, prev_mem_pwrst;
 128
 129         prev_logic_pwrst = pwrdm_read_prev_logic_pwrst(pwrdm);
 130         if ((pwrdm->pwrsts_logic_ret == PWRSTS_OFF_RET) &&
 131             (prev_logic_pwrst == PWRDM_POWER_OFF))
 132                 pwrdm->ret_logic_off_counter++;
 133
 134         for (i = 0; i < pwrdm->banks; i++) {
 135                 prev_mem_pwrst = pwrdm_read_prev_mem_pwrst(pwrdm, i);
 136
 137                 if ((pwrdm->pwrsts_mem_ret[i] == PWRSTS_OFF_RET) &&
 138                     (prev_mem_pwrst == PWRDM_POWER_OFF))
 139                         pwrdm->ret_mem_off_counter[i]++;
 140         }
 141 }
 142
 143 static int _pwrdm_state_switch(struct powerdomain *pwrdm, int flag)
 144 {
 145
 146         int prev, state, trace_state = 0;
 147
 148         if (pwrdm == NULL)
 149                 return -EINVAL;
 150
 151         state = pwrdm_read_pwrst(pwrdm);
 152
 153         switch (flag) {
 154         case PWRDM_STATE_NOW:
 155                 prev = pwrdm->state;
 156                 break;
 157         case PWRDM_STATE_PREV:
 158                 prev = pwrdm_read_prev_pwrst(pwrdm);
 159                 if (pwrdm->state != prev)
 160                         pwrdm->state_counter[prev]++;
 161                 if (prev == PWRDM_POWER_RET)
 162                         _update_logic_membank_counters(pwrdm);
 163                 /*
 164                  * If the power domain did not hit the desired state,
 165                  * generate a trace event with both the desired and hit states
 166                  */
 167                 if (state != prev) {
 168                         trace_state = (PWRDM_TRACE_STATES_FLAG |
 169                                        ((state & OMAP_POWERSTATE_MASK) << 8) |
 170                                        ((prev & OMAP_POWERSTATE_MASK) << 0));
 171                         trace_power_domain_target(pwrdm->name, trace_state,
 172                                                   smp_processor_id());
 173                 }
 174                 break;
 175         default:
 176                 return -EINVAL;
 177         }
 178
 179         if (state != prev)
 180                 pwrdm->state_counter[state]++;
 181
 182         pm_dbg_update_time(pwrdm, prev);
 183
 184         pwrdm->state = state;
 185
 186         return 0;
 187 }
 188
 189 static int _pwrdm_pre_transition_cb(struct powerdomain *pwrdm, void *unused)
 190 {
 191         pwrdm_clear_all_prev_pwrst(pwrdm);
 192         _pwrdm_state_switch(pwrdm, PWRDM_STATE_NOW);
 193         return 0;
 194 }
 195
 196 static int _pwrdm_post_transition_cb(struct powerdomain *pwrdm, void *unused)
 197 {
 198         _pwrdm_state_switch(pwrdm, PWRDM_STATE_PREV);
 199         return 0;
 200 }
 201
 202 /* Public functions */
 203
 204 /**
 205  * pwrdm_register_platform_funcs - register powerdomain implementation fns
 206  * @po: func pointers for arch specific implementations
 207  *
 208  * Register the list of function pointers used to implement the
 209  * powerdomain functions on different OMAP SoCs.  Should be called
 210  * before any other pwrdm_register*() function.  Returns -EINVAL if
 211  * @po is null, -EEXIST if platform functions have already been
 212  * registered, or 0 upon success.
 213  */
 214 int pwrdm_register_platform_funcs(struct pwrdm_ops *po)
 215 {
 216         if (!po)
 217                 return -EINVAL;
 218
 219         if (arch_pwrdm)
 220                 return -EEXIST;
 221
 222         arch_pwrdm = po;
 223
 224         return 0;
 225 }
 226
 227 /**
 228  * pwrdm_register_pwrdms - register SoC powerdomains
 229  * @ps: pointer to an array of struct powerdomain to register
 230  *
 231  * Register the powerdomains available on a particular OMAP SoC.  Must
 232  * be called after pwrdm_register_platform_funcs().  May be called
 233  * multiple times.  Returns -EACCES if called before
 234  * pwrdm_register_platform_funcs(); -EINVAL if the argument @ps is
 235  * null; or 0 upon success.
 236  */
 237 int pwrdm_register_pwrdms(struct powerdomain **ps)
 238 {
 239         struct powerdomain **p = NULL;
 240
 241         if (!arch_pwrdm)
 242                 return -EEXIST;
 243
 244         if (!ps)
 245                 return -EINVAL;
 246
 247         for (p = ps; *p; p++)
 248                 _pwrdm_register(*p);
 249
 250         return 0;
 251 }
 252
 253 /**
 254  * pwrdm_complete_init - set up the powerdomain layer
 255  *
 256  * Do whatever is necessary to initialize registered powerdomains and
 257  * powerdomain code.  Currently, this programs the next power state
 258  * for each powerdomain to ON.  This prevents powerdomains from
 259  * unexpectedly losing context or entering high wakeup latency modes
 260  * with non-power-management-enabled kernels.  Must be called after
 261  * pwrdm_register_pwrdms().  Returns -EACCES if called before
 262  * pwrdm_register_pwrdms(), or 0 upon success.
 263  */
 264 int pwrdm_complete_init(void)
 265 {
 266         struct powerdomain *temp_p;
 267
 268         if (list_empty(&pwrdm_list))
 269                 return -EACCES;
 270
 271         list_for_each_entry(temp_p, &pwrdm_list, node)
 272                 pwrdm_set_next_pwrst(temp_p, PWRDM_POWER_ON);
 273
 274         return 0;
 275 }
 276
 277 /**
 278  * pwrdm_lookup - look up a powerdomain by name, return a pointer
 279  * @name: name of powerdomain
 280  *
 281  * Find a registered powerdomain by its name @name.  Returns a pointer
 282  * to the struct powerdomain if found, or NULL otherwise.
 283  */
 284 struct powerdomain *pwrdm_lookup(const char *name)
 285 {
 286         struct powerdomain *pwrdm;
 287
 288         if (!name)
 289                 return NULL;
 290
 291         pwrdm = _pwrdm_lookup(name);
 292
 293         return pwrdm;
 294 }
 295
 296 /**
 297  * pwrdm_for_each - call function on each registered clockdomain
 298  * @fn: callback function *
 299  *
 300  * Call the supplied function @fn for each registered powerdomain.
 301  * The callback function @fn can return anything but 0 to bail out
 302  * early from the iterator.  Returns the last return value of the
 303  * callback function, which should be 0 for success or anything else
 304  * to indicate failure; or -EINVAL if the function pointer is null.
 305  */
 306 int pwrdm_for_each(int (*fn)(struct powerdomain *pwrdm, void *user),
 307                    void *user)
 308 {
 309         struct powerdomain *temp_pwrdm;
 310         int ret = 0;
 311
 312         if (!fn)
 313                 return -EINVAL;
 314
 315         list_for_each_entry(temp_pwrdm, &pwrdm_list, node) {
 316                 ret = (*fn)(temp_pwrdm, user);
 317                 if (ret)
 318                         break;
 319         }
 320
 321         return ret;
 322 }
 323
 324 /**
 325  * pwrdm_add_clkdm - add a clockdomain to a powerdomain
 326  * @pwrdm: struct powerdomain * to add the clockdomain to
 327  * @clkdm: struct clockdomain * to associate with a powerdomain
 328  *
 329  * Associate the clockdomain @clkdm with a powerdomain @pwrdm.  This
 330  * enables the use of pwrdm_for_each_clkdm().  Returns -EINVAL if
 331  * presented with invalid pointers; -ENOMEM if memory could not be allocated;
 332  * or 0 upon success.
 333  */
 334 int pwrdm_add_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm)
 335 {
 336         int i;
 337         int ret = -EINVAL;
 338
 339         if (!pwrdm || !clkdm)
 340                 return -EINVAL;
 341
 342         pr_debug("powerdomain: %s: associating clockdomain %s\n",
 343                  pwrdm->name, clkdm->name);
 344
 345         for (i = 0; i < PWRDM_MAX_CLKDMS; i++) {
 346                 if (!pwrdm->pwrdm_clkdms[i])
 347                         break;
 348 #ifdef DEBUG
 349                 if (pwrdm->pwrdm_clkdms[i] == clkdm) {
 350                         ret = -EINVAL;
 351                         goto pac_exit;
 352                 }
 353 #endif
 354         }
 355
 356         if (i == PWRDM_MAX_CLKDMS) {
 357                 pr_debug("powerdomain: %s: increase PWRDM_MAX_CLKDMS for clkdm %s\n",
 358                          pwrdm->name, clkdm->name);
 359                 WARN_ON(1);
 360                 ret = -ENOMEM;
 361                 goto pac_exit;
 362         }
 363
 364         pwrdm->pwrdm_clkdms[i] = clkdm;
 365
 366         ret = 0;
 367
 368 pac_exit:
 369         return ret;
 370 }
 371
 372 /**
 373  * pwrdm_del_clkdm - remove a clockdomain from a powerdomain
 374  * @pwrdm: struct powerdomain * to add the clockdomain to
 375  * @clkdm: struct clockdomain * to associate with a powerdomain
 376  *
 377  * Dissociate the clockdomain @clkdm from the powerdomain
 378  * @pwrdm. Returns -EINVAL if presented with invalid pointers; -ENOENT
 379  * if @clkdm was not associated with the powerdomain, or 0 upon
 380  * success.
 381  */
 382 int pwrdm_del_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm)
 383 {
 384         int ret = -EINVAL;
 385         int i;
 386
 387         if (!pwrdm || !clkdm)
 388                 return -EINVAL;
 389
 390         pr_debug("powerdomain: %s: dissociating clockdomain %s\n",
 391                  pwrdm->name, clkdm->name);
 392
 393         for (i = 0; i < PWRDM_MAX_CLKDMS; i++)
 394                 if (pwrdm->pwrdm_clkdms[i] == clkdm)
 395                         break;
 396
 397         if (i == PWRDM_MAX_CLKDMS) {
 398                 pr_debug("powerdomain: %s: clkdm %s not associated?!\n",
 399                          pwrdm->name, clkdm->name);
 400                 ret = -ENOENT;
 401                 goto pdc_exit;
 402         }
 403
 404         pwrdm->pwrdm_clkdms[i] = NULL;
 405
 406         ret = 0;
 407
 408 pdc_exit:
 409         return ret;
 410 }
 411
 412 /**
 413  * pwrdm_for_each_clkdm - call function on each clkdm in a pwrdm
 414  * @pwrdm: struct powerdomain * to iterate over
 415  * @fn: callback function *
 416  *
 417  * Call the supplied function @fn for each clockdomain in the powerdomain
 418  * @pwrdm.  The callback function can return anything but 0 to bail
 419  * out early from the iterator.  Returns -EINVAL if presented with
 420  * invalid pointers; or passes along the last return value of the
 421  * callback function, which should be 0 for success or anything else
 422  * to indicate failure.
 423  */
 424 int pwrdm_for_each_clkdm(struct powerdomain *pwrdm,
 425                          int (*fn)(struct powerdomain *pwrdm,
 426                                    struct clockdomain *clkdm))
 427 {
 428         int ret = 0;
 429         int i;
 430
 431         if (!fn)
 432                 return -EINVAL;
 433
 434         for (i = 0; i < PWRDM_MAX_CLKDMS && !ret; i++)
 435                 ret = (*fn)(pwrdm, pwrdm->pwrdm_clkdms[i]);
 436
 437         return ret;
 438 }
 439
 440 /**
 441  * pwrdm_get_voltdm - return a ptr to the voltdm that this pwrdm resides in
 442  * @pwrdm: struct powerdomain *
 443  *
 444  * Return a pointer to the struct voltageomain that the specified powerdomain
 445  * @pwrdm exists in.
 446  */
 447 struct voltagedomain *pwrdm_get_voltdm(struct powerdomain *pwrdm)
 448 {
 449         return pwrdm->voltdm.ptr;
 450 }
 451
 452 /**
 453  * pwrdm_get_mem_bank_count - get number of memory banks in this powerdomain
 454  * @pwrdm: struct powerdomain *
 455  *
 456  * Return the number of controllable memory banks in powerdomain @pwrdm,
 457  * starting with 1.  Returns -EINVAL if the powerdomain pointer is null.
 458  */
 459 int pwrdm_get_mem_bank_count(struct powerdomain *pwrdm)
 460 {
 461         if (!pwrdm)
 462                 return -EINVAL;
 463
 464         return pwrdm->banks;
 465 }
 466
 467 /**
 468  * pwrdm_set_next_pwrst - set next powerdomain power state
 469  * @pwrdm: struct powerdomain * to set
 470  * @pwrst: one of the PWRDM_POWER_* macros
 471  *
 472  * Set the powerdomain @pwrdm's next power state to @pwrst.  The powerdomain
 473  * may not enter this state immediately if the preconditions for this state
 474  * have not been satisfied.  Returns -EINVAL if the powerdomain pointer is
 475  * null or if the power state is invalid for the powerdomin, or returns 0
 476  * upon success.
 477  */
 478 int pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst)
 479 {
 480         int ret = -EINVAL;
 481
 482         if (!pwrdm)
 483                 return -EINVAL;
 484
 485         if (!(pwrdm->pwrsts & (1 << pwrst)))
 486                 return -EINVAL;
 487
 488         pr_debug("powerdomain: %s: setting next powerstate to %0x\n",
 489                  pwrdm->name, pwrst);
 490
 491         if (arch_pwrdm && arch_pwrdm->pwrdm_set_next_pwrst) {
 492                 /* Trace the pwrdm desired target state */
 493                 trace_power_domain_target(pwrdm->name, pwrst,
 494                                           smp_processor_id());
 495                 /* Program the pwrdm desired target state */
 496                 ret = arch_pwrdm->pwrdm_set_next_pwrst(pwrdm, pwrst);
 497         }
 498
 499         return ret;
 500 }
 501
 502 /**
 503  * pwrdm_read_next_pwrst - get next powerdomain power state
 504  * @pwrdm: struct powerdomain * to get power state
 505  *
 506  * Return the powerdomain @pwrdm's next power state.  Returns -EINVAL
 507  * if the powerdomain pointer is null or returns the next power state
 508  * upon success.
 509  */
 510 int pwrdm_read_next_pwrst(struct powerdomain *pwrdm)
 511 {
 512         int ret = -EINVAL;
 513
 514         if (!pwrdm)
 515                 return -EINVAL;
 516
 517         if (arch_pwrdm && arch_pwrdm->pwrdm_read_next_pwrst)
 518                 ret = arch_pwrdm->pwrdm_read_next_pwrst(pwrdm);
 519
 520         return ret;
 521 }
 522
 523 /**
 524  * pwrdm_read_pwrst - get current powerdomain power state
 525  * @pwrdm: struct powerdomain * to get power state
 526  *
 527  * Return the powerdomain @pwrdm's current power state. Returns -EINVAL
 528  * if the powerdomain pointer is null or returns the current power state
 529  * upon success. Note that if the power domain only supports the ON state
 530  * then just return ON as the current state.
 531  */
 532 int pwrdm_read_pwrst(struct powerdomain *pwrdm)
 533 {
 534         int ret = -EINVAL;
 535
 536         if (!pwrdm)
 537                 return -EINVAL;
 538
 539         if (pwrdm->pwrsts == PWRSTS_ON)
 540                 return PWRDM_POWER_ON;
 541
 542         if (arch_pwrdm && arch_pwrdm->pwrdm_read_pwrst)
 543                 ret = arch_pwrdm->pwrdm_read_pwrst(pwrdm);
 544
 545         return ret;
 546 }
 547
 548 /**
 549  * pwrdm_read_prev_pwrst - get previous powerdomain power state
 550  * @pwrdm: struct powerdomain * to get previous power state
 551  *
 552  * Return the powerdomain @pwrdm's previous power state.  Returns -EINVAL
 553  * if the powerdomain pointer is null or returns the previous power state
 554  * upon success.
 555  */
 556 int pwrdm_read_prev_pwrst(struct powerdomain *pwrdm)
 557 {
 558         int ret = -EINVAL;
 559
 560         if (!pwrdm)
 561                 return -EINVAL;
 562
 563         if (arch_pwrdm && arch_pwrdm->pwrdm_read_prev_pwrst)
 564                 ret = arch_pwrdm->pwrdm_read_prev_pwrst(pwrdm);
 565
 566         return ret;
 567 }
 568
 569 /**
 570  * pwrdm_set_logic_retst - set powerdomain logic power state upon retention
 571  * @pwrdm: struct powerdomain * to set
 572  * @pwrst: one of the PWRDM_POWER_* macros
 573  *
 574  * Set the next power state @pwrst that the logic portion of the
 575  * powerdomain @pwrdm will enter when the powerdomain enters retention.
 576  * This will be either RETENTION or OFF, if supported.  Returns
 577  * -EINVAL if the powerdomain pointer is null or the target power
 578  * state is not not supported, or returns 0 upon success.
 579  */
 580 int pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst)
 581 {
 582         int ret = -EINVAL;
 583
 584         if (!pwrdm)
 585                 return -EINVAL;
 586
 587         if (!(pwrdm->pwrsts_logic_ret & (1 << pwrst)))
 588                 return -EINVAL;
 589
 590         pr_debug("powerdomain: %s: setting next logic powerstate to %0x\n",
 591                  pwrdm->name, pwrst);
 592
 593         if (arch_pwrdm && arch_pwrdm->pwrdm_set_logic_retst)
 594                 ret = arch_pwrdm->pwrdm_set_logic_retst(pwrdm, pwrst);
 595
 596         return ret;
 597 }
 598
 599 /**
 600  * pwrdm_set_mem_onst - set memory power state while powerdomain ON
 601  * @pwrdm: struct powerdomain * to set
 602  * @bank: memory bank number to set (0-3)
 603  * @pwrst: one of the PWRDM_POWER_* macros
 604  *
 605  * Set the next power state @pwrst that memory bank @bank of the
 606  * powerdomain @pwrdm will enter when the powerdomain enters the ON
 607  * state.  @bank will be a number from 0 to 3, and represents different
 608  * types of memory, depending on the powerdomain.  Returns -EINVAL if
 609  * the powerdomain pointer is null or the target power state is not
 610  * not supported for this memory bank, -EEXIST if the target memory
 611  * bank does not exist or is not controllable, or returns 0 upon
 612  * success.
 613  */
 614 int pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank, u8 pwrst)
 615 {
 616         int ret = -EINVAL;
 617
 618         if (!pwrdm)
 619                 return -EINVAL;
 620
 621         if (pwrdm->banks < (bank + 1))
 622                 return -EEXIST;
 623
 624         if (!(pwrdm->pwrsts_mem_on[bank] & (1 << pwrst)))
 625                 return -EINVAL;
 626
 627         pr_debug("powerdomain: %s: setting next memory powerstate for bank %0x while pwrdm-ON to %0x\n",
 628                  pwrdm->name, bank, pwrst);
 629
 630         if (arch_pwrdm && arch_pwrdm->pwrdm_set_mem_onst)
 631                 ret = arch_pwrdm->pwrdm_set_mem_onst(pwrdm, bank, pwrst);
 632
 633         return ret;
 634 }
 635
 636 /**
 637  * pwrdm_set_mem_retst - set memory power state while powerdomain in RET
 638  * @pwrdm: struct powerdomain * to set
 639  * @bank: memory bank number to set (0-3)
 640  * @pwrst: one of the PWRDM_POWER_* macros
 641  *
 642  * Set the next power state @pwrst that memory bank @bank of the
 643  * powerdomain @pwrdm will enter when the powerdomain enters the
 644  * RETENTION state.  Bank will be a number from 0 to 3, and represents
 645  * different types of memory, depending on the powerdomain.  @pwrst
 646  * will be either RETENTION or OFF, if supported.  Returns -EINVAL if
 647  * the powerdomain pointer is null or the target power state is not
 648  * not supported for this memory bank, -EEXIST if the target memory
 649  * bank does not exist or is not controllable, or returns 0 upon
 650  * success.
 651  */
 652 int pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank, u8 pwrst)
 653 {
 654         int ret = -EINVAL;
 655
 656         if (!pwrdm)
 657                 return -EINVAL;
 658
 659         if (pwrdm->banks < (bank + 1))
 660                 return -EEXIST;
 661
 662         if (!(pwrdm->pwrsts_mem_ret[bank] & (1 << pwrst)))
 663                 return -EINVAL;
 664
 665         pr_debug("powerdomain: %s: setting next memory powerstate for bank %0x while pwrdm-RET to %0x\n",
 666                  pwrdm->name, bank, pwrst);
 667
 668         if (arch_pwrdm && arch_pwrdm->pwrdm_set_mem_retst)
 669                 ret = arch_pwrdm->pwrdm_set_mem_retst(pwrdm, bank, pwrst);
 670
 671         return ret;
 672 }
 673
 674 /**
 675  * pwrdm_read_logic_pwrst - get current powerdomain logic retention power state
 676  * @pwrdm: struct powerdomain * to get current logic retention power state
 677  *
 678  * Return the power state that the logic portion of powerdomain @pwrdm
 679  * will enter when the powerdomain enters retention.  Returns -EINVAL
 680  * if the powerdomain pointer is null or returns the logic retention
 681  * power state upon success.
 682  */
 683 int pwrdm_read_logic_pwrst(struct powerdomain *pwrdm)
 684 {
 685         int ret = -EINVAL;
 686
 687         if (!pwrdm)
 688                 return -EINVAL;
 689
 690         if (arch_pwrdm && arch_pwrdm->pwrdm_read_logic_pwrst)
 691                 ret = arch_pwrdm->pwrdm_read_logic_pwrst(pwrdm);
 692
 693         return ret;
 694 }
 695
 696 /**
 697  * pwrdm_read_prev_logic_pwrst - get previous powerdomain logic power state
 698  * @pwrdm: struct powerdomain * to get previous logic power state
 699  *
 700  * Return the powerdomain @pwrdm's previous logic power state.  Returns
 701  * -EINVAL if the powerdomain pointer is null or returns the previous
 702  * logic power state upon success.
 703  */
 704 int pwrdm_read_prev_logic_pwrst(struct powerdomain *pwrdm)
 705 {
 706         int ret = -EINVAL;
 707
 708         if (!pwrdm)
 709                 return -EINVAL;
 710
 711         if (arch_pwrdm && arch_pwrdm->pwrdm_read_prev_logic_pwrst)
 712                 ret = arch_pwrdm->pwrdm_read_prev_logic_pwrst(pwrdm);
 713
 714         return ret;
 715 }
 716
 717 /**
 718  * pwrdm_read_logic_retst - get next powerdomain logic power state
 719  * @pwrdm: struct powerdomain * to get next logic power state
 720  *
 721  * Return the powerdomain pwrdm's logic power state.  Returns -EINVAL
 722  * if the powerdomain pointer is null or returns the next logic
 723  * power state upon success.
 724  */
 725 int pwrdm_read_logic_retst(struct powerdomain *pwrdm)
 726 {
 727         int ret = -EINVAL;
 728
 729         if (!pwrdm)
 730                 return -EINVAL;
 731
 732         if (arch_pwrdm && arch_pwrdm->pwrdm_read_logic_retst)
 733                 ret = arch_pwrdm->pwrdm_read_logic_retst(pwrdm);
 734
 735         return ret;
 736 }
 737
 738 /**
 739  * pwrdm_read_mem_pwrst - get current memory bank power state
 740  * @pwrdm: struct powerdomain * to get current memory bank power state
 741  * @bank: memory bank number (0-3)
 742  *
 743  * Return the powerdomain @pwrdm's current memory power state for bank
 744  * @bank.  Returns -EINVAL if the powerdomain pointer is null, -EEXIST if
 745  * the target memory bank does not exist or is not controllable, or
 746  * returns the current memory power state upon success.
 747  */
 748 int pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank)
 749 {
 750         int ret = -EINVAL;
 751
 752         if (!pwrdm)
 753                 return ret;
 754
 755         if (pwrdm->banks < (bank + 1))
 756                 return ret;
 757
 758         if (pwrdm->flags & PWRDM_HAS_MPU_QUIRK)
 759                 bank = 1;
 760
 761         if (arch_pwrdm && arch_pwrdm->pwrdm_read_mem_pwrst)
 762                 ret = arch_pwrdm->pwrdm_read_mem_pwrst(pwrdm, bank);
 763
 764         return ret;
 765 }
 766
 767 /**
 768  * pwrdm_read_prev_mem_pwrst - get previous memory bank power state
 769  * @pwrdm: struct powerdomain * to get previous memory bank power state
 770  * @bank: memory bank number (0-3)
 771  *
 772  * Return the powerdomain @pwrdm's previous memory power state for
 773  * bank @bank.  Returns -EINVAL if the powerdomain pointer is null,
 774  * -EEXIST if the target memory bank does not exist or is not
 775  * controllable, or returns the previous memory power state upon
 776  * success.
 777  */
 778 int pwrdm_read_prev_mem_pwrst(struct powerdomain *pwrdm, u8 bank)
 779 {
 780         int ret = -EINVAL;
 781
 782         if (!pwrdm)
 783                 return ret;
 784
 785         if (pwrdm->banks < (bank + 1))
 786                 return ret;
 787
 788         if (pwrdm->flags & PWRDM_HAS_MPU_QUIRK)
 789                 bank = 1;
 790
 791         if (arch_pwrdm && arch_pwrdm->pwrdm_read_prev_mem_pwrst)
 792                 ret = arch_pwrdm->pwrdm_read_prev_mem_pwrst(pwrdm, bank);
 793
 794         return ret;
 795 }
 796
 797 /**
 798  * pwrdm_read_mem_retst - get next memory bank power state
 799  * @pwrdm: struct powerdomain * to get mext memory bank power state
 800  * @bank: memory bank number (0-3)
 801  *
 802  * Return the powerdomain pwrdm's next memory power state for bank
 803  * x.  Returns -EINVAL if the powerdomain pointer is null, -EEXIST if
 804  * the target memory bank does not exist or is not controllable, or
 805  * returns the next memory power state upon success.
 806  */
 807 int pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank)
 808 {
 809         int ret = -EINVAL;
 810
 811         if (!pwrdm)
 812                 return ret;
 813
 814         if (pwrdm->banks < (bank + 1))
 815                 return ret;
 816
 817         if (arch_pwrdm && arch_pwrdm->pwrdm_read_mem_retst)
 818                 ret = arch_pwrdm->pwrdm_read_mem_retst(pwrdm, bank);
 819
 820         return ret;
 821 }
 822
 823 /**
 824  * pwrdm_clear_all_prev_pwrst - clear previous powerstate register for a pwrdm
 825  * @pwrdm: struct powerdomain * to clear
 826  *
 827  * Clear the powerdomain's previous power state register @pwrdm.
 828  * Clears the entire register, including logic and memory bank
 829  * previous power states.  Returns -EINVAL if the powerdomain pointer
 830  * is null, or returns 0 upon success.
 831  */
 832 int pwrdm_clear_all_prev_pwrst(struct powerdomain *pwrdm)
 833 {
 834         int ret = -EINVAL;
 835
 836         if (!pwrdm)
 837                 return ret;
 838
 839         /*
 840          * XXX should get the powerdomain's current state here;
 841          * warn & fail if it is not ON.
 842          */
 843
 844         pr_debug("powerdomain: %s: clearing previous power state reg\n",
 845                  pwrdm->name);
 846
 847         if (arch_pwrdm && arch_pwrdm->pwrdm_clear_all_prev_pwrst)
 848                 ret = arch_pwrdm->pwrdm_clear_all_prev_pwrst(pwrdm);
 849
 850         return ret;
 851 }
 852
 853 /**
 854  * pwrdm_enable_hdwr_sar - enable automatic hardware SAR for a pwrdm
 855  * @pwrdm: struct powerdomain *
 856  *
 857  * Enable automatic context save-and-restore upon power state change
 858  * for some devices in the powerdomain @pwrdm.  Warning: this only
 859  * affects a subset of devices in a powerdomain; check the TRM
 860  * closely.  Returns -EINVAL if the powerdomain pointer is null or if
 861  * the powerdomain does not support automatic save-and-restore, or
 862  * returns 0 upon success.
 863  */
 864 int pwrdm_enable_hdwr_sar(struct powerdomain *pwrdm)
 865 {
 866         int ret = -EINVAL;
 867
 868         if (!pwrdm)
 869                 return ret;
 870
 871         if (!(pwrdm->flags & PWRDM_HAS_HDWR_SAR))
 872                 return ret;
 873
 874         pr_debug("powerdomain: %s: setting SAVEANDRESTORE bit\n", pwrdm->name);
 875
 876         if (arch_pwrdm && arch_pwrdm->pwrdm_enable_hdwr_sar)
 877                 ret = arch_pwrdm->pwrdm_enable_hdwr_sar(pwrdm);
 878
 879         return ret;
 880 }
 881
 882 /**
 883  * pwrdm_disable_hdwr_sar - disable automatic hardware SAR for a pwrdm
 884  * @pwrdm: struct powerdomain *
 885  *
 886  * Disable automatic context save-and-restore upon power state change
 887  * for some devices in the powerdomain @pwrdm.  Warning: this only
 888  * affects a subset of devices in a powerdomain; check the TRM
 889  * closely.  Returns -EINVAL if the powerdomain pointer is null or if
 890  * the powerdomain does not support automatic save-and-restore, or
 891  * returns 0 upon success.
 892  */
 893 int pwrdm_disable_hdwr_sar(struct powerdomain *pwrdm)
 894 {
 895         int ret = -EINVAL;
 896
 897         if (!pwrdm)
 898                 return ret;
 899
 900         if (!(pwrdm->flags & PWRDM_HAS_HDWR_SAR))
 901                 return ret;
 902
 903         pr_debug("powerdomain: %s: clearing SAVEANDRESTORE bit\n", pwrdm->name);
 904
 905         if (arch_pwrdm && arch_pwrdm->pwrdm_disable_hdwr_sar)
 906                 ret = arch_pwrdm->pwrdm_disable_hdwr_sar(pwrdm);
 907
 908         return ret;
 909 }
 910
 911 /**
 912  * pwrdm_has_hdwr_sar - test whether powerdomain supports hardware SAR
 913  * @pwrdm: struct powerdomain *
 914  *
 915  * Returns 1 if powerdomain @pwrdm supports hardware save-and-restore
 916  * for some devices, or 0 if it does not.
 917  */
 918 bool pwrdm_has_hdwr_sar(struct powerdomain *pwrdm)
 919 {
 920         return (pwrdm && pwrdm->flags & PWRDM_HAS_HDWR_SAR) ? 1 : 0;
 921 }
 922
 923 /**
 924  * pwrdm_set_lowpwrstchange - Request a low power state change
 925  * @pwrdm: struct powerdomain *
 926  *
 927  * Allows a powerdomain to transtion to a lower power sleep state
 928  * from an existing sleep state without waking up the powerdomain.
 929  * Returns -EINVAL if the powerdomain pointer is null or if the
 930  * powerdomain does not support LOWPOWERSTATECHANGE, or returns 0
 931  * upon success.
 932  */
 933 int pwrdm_set_lowpwrstchange(struct powerdomain *pwrdm)
 934 {
 935         int ret = -EINVAL;
 936
 937         if (!pwrdm)
 938                 return -EINVAL;
 939
 940         if (!(pwrdm->flags & PWRDM_HAS_LOWPOWERSTATECHANGE))
 941                 return -EINVAL;
 942
 943         pr_debug("powerdomain: %s: setting LOWPOWERSTATECHANGE bit\n",
 944                  pwrdm->name);
 945
 946         if (arch_pwrdm && arch_pwrdm->pwrdm_set_lowpwrstchange)
 947                 ret = arch_pwrdm->pwrdm_set_lowpwrstchange(pwrdm);
 948
 949         return ret;
 950 }
 951
 952 /**
 953  * pwrdm_wait_transition - wait for powerdomain power transition to finish
 954  * @pwrdm: struct powerdomain * to wait for
 955  *
 956  * If the powerdomain @pwrdm is in the process of a state transition,
 957  * spin until it completes the power transition, or until an iteration
 958  * bailout value is reached. Returns -EINVAL if the powerdomain
 959  * pointer is null, -EAGAIN if the bailout value was reached, or
 960  * returns 0 upon success.
 961  */
 962 int pwrdm_wait_transition(struct powerdomain *pwrdm)
 963 {
 964         int ret = -EINVAL;
 965
 966         if (!pwrdm)
 967                 return -EINVAL;
 968
 969         if (arch_pwrdm && arch_pwrdm->pwrdm_wait_transition)
 970                 ret = arch_pwrdm->pwrdm_wait_transition(pwrdm);
 971
 972         return ret;
 973 }
 974
 975 int pwrdm_state_switch(struct powerdomain *pwrdm)
 976 {
 977         int ret;
 978
 979         ret = pwrdm_wait_transition(pwrdm);
 980         if (!ret)
 981                 ret = _pwrdm_state_switch(pwrdm, PWRDM_STATE_NOW);
 982
 983         return ret;
 984 }
 985
 986 int pwrdm_pre_transition(struct powerdomain *pwrdm)
 987 {
 988         if (pwrdm)
 989                 _pwrdm_pre_transition_cb(pwrdm, NULL);
 990         else
 991                 pwrdm_for_each(_pwrdm_pre_transition_cb, NULL);
 992
 993         return 0;
 994 }
 995
 996 int pwrdm_post_transition(struct powerdomain *pwrdm)
 997 {
 998         if (pwrdm)
 999                 _pwrdm_post_transition_cb(pwrdm, NULL);
1000         else
1001                 pwrdm_for_each(_pwrdm_post_transition_cb, NULL);
1002
1003         return 0;
1004 }
1005
1006 /**
1007  * pwrdm_get_context_loss_count - get powerdomain's context loss count
1008  * @pwrdm: struct powerdomain * to wait for
1009  *
1010  * Context loss count is the sum of powerdomain off-mode counter, the
1011  * logic off counter and the per-bank memory off counter.  Returns negative
1012  * (and WARNs) upon error, otherwise, returns the context loss count.
1013  */
1014 int pwrdm_get_context_loss_count(struct powerdomain *pwrdm)
1015 {
1016         int i, count;
1017
1018         if (!pwrdm) {
1019                 WARN(1, "powerdomain: %s: pwrdm is null\n", __func__);
1020                 return -ENODEV;
1021         }
1022
1023         count = pwrdm->state_counter[PWRDM_POWER_OFF];
1024         count += pwrdm->ret_logic_off_counter;
1025
1026         for (i = 0; i < pwrdm->banks; i++)
1027                 count += pwrdm->ret_mem_off_counter[i];
1028
1029         /*
1030          * Context loss count has to be a non-negative value. Clear the sign
1031          * bit to get a value range from 0 to INT_MAX.
1032          */
1033         count &= INT_MAX;
1034
1035         pr_debug("powerdomain: %s: context loss count = %d\n",
1036                  pwrdm->name, count);
1037
1038         return count;
1039 }
1040
1041 /**
1042  * pwrdm_can_ever_lose_context - can this powerdomain ever lose context?
1043  * @pwrdm: struct powerdomain *
1044  *
1045  * Given a struct powerdomain * @pwrdm, returns 1 if the powerdomain
1046  * can lose either memory or logic context or if @pwrdm is invalid, or
1047  * returns 0 otherwise.  This function is not concerned with how the
1048  * powerdomain registers are programmed (i.e., to go off or not); it's
1049  * concerned with whether it's ever possible for this powerdomain to
1050  * go off while some other part of the chip is active.  This function
1051  * assumes that every powerdomain can go to either ON or INACTIVE.
1052  */
1053 bool pwrdm_can_ever_lose_context(struct powerdomain *pwrdm)
1054 {
1055         int i;
1056
1057         if (IS_ERR_OR_NULL(pwrdm)) {
1058                 pr_debug("powerdomain: %s: invalid powerdomain pointer\n",
1059                          __func__);
1060                 return 1;
1061         }
1062
1063         if (pwrdm->pwrsts & PWRSTS_OFF)
1064                 return 1;
1065
1066         if (pwrdm->pwrsts & PWRSTS_RET) {
1067                 if (pwrdm->pwrsts_logic_ret & PWRSTS_OFF)
1068                         return 1;
1069
1070                 for (i = 0; i < pwrdm->banks; i++)
1071                         if (pwrdm->pwrsts_mem_ret[i] & PWRSTS_OFF)
1072                                 return 1;
1073         }
1074
1075         for (i = 0; i < pwrdm->banks; i++)
1076                 if (pwrdm->pwrsts_mem_on[i] & PWRSTS_OFF)
1077                         return 1;
1078
1079         return 0;
1080 }