arch/arm/mach-omap2/cpuidle34xx.c

   1 /*
   2  * linux/arch/arm/mach-omap2/cpuidle34xx.c
   3  *
   4  * OMAP3 CPU IDLE Routines
   5  *
   6  * Copyright (C) 2008 Texas Instruments, Inc.
   7  * Rajendra Nayak <rnayak@ti.com>
   8  *
   9  * Copyright (C) 2007 Texas Instruments, Inc.
  10  * Karthik Dasu <karthik-dp@ti.com>
  11  *
  12  * Copyright (C) 2006 Nokia Corporation
  13  * Tony Lindgren <tony@atomide.com>
  14  *
  15  * Copyright (C) 2005 Texas Instruments, Inc.
  16  * Richard Woodruff <r-woodruff2@ti.com>
  17  *
  18  * Based on pm.c for omap2
  19  *
  20  * This program is free software; you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License version 2 as
  22  * published by the Free Software Foundation.
  23  */
  24
  25 #include <linux/sched.h>
  26 #include <linux/cpuidle.h>
  27
  28 #include <plat/prcm.h>
  29 #include <plat/irqs.h>
  30 #include "powerdomain.h"
  31 #include "clockdomain.h"
  32 #include <plat/serial.h>
  33
  34 #include "pm.h"
  35 #include "control.h"
  36
  37 #ifdef CONFIG_CPU_IDLE
  38
  39 /*
  40  * The latencies/thresholds for various C states have
  41  * to be configured from the respective board files.
  42  * These are some default values (which might not provide
  43  * the best power savings) used on boards which do not
  44  * pass these details from the board file.
  45  */
  46 static struct cpuidle_params cpuidle_params_table[] = {
  47         /* C1 */
  48         {2 + 2, 5, 1},
  49         /* C2 */
  50         {10 + 10, 30, 1},
  51         /* C3 */
  52         {50 + 50, 300, 1},
  53         /* C4 */
  54         {1500 + 1800, 4000, 1},
  55         /* C5 */
  56         {2500 + 7500, 12000, 1},
  57         /* C6 */
  58         {3000 + 8500, 15000, 1},
  59         /* C7 */
  60         {10000 + 30000, 300000, 1},
  61 };
  62 #define OMAP3_NUM_STATES ARRAY_SIZE(cpuidle_params_table)
  63
  64 /* Mach specific information to be recorded in the C-state driver_data */
  65 struct omap3_idle_statedata {
  66         u32 mpu_state;
  67         u32 core_state;
  68         u8 valid;
  69 };
  70 struct omap3_idle_statedata omap3_idle_data[OMAP3_NUM_STATES];
  71
  72 struct powerdomain *mpu_pd, *core_pd, *per_pd, *cam_pd;
  73
  74 static int _cpuidle_allow_idle(struct powerdomain *pwrdm,
  75                                 struct clockdomain *clkdm)
  76 {
  77         clkdm_allow_idle(clkdm);
  78         return 0;
  79 }
  80
  81 static int _cpuidle_deny_idle(struct powerdomain *pwrdm,
  82                                 struct clockdomain *clkdm)
  83 {
  84         clkdm_deny_idle(clkdm);
  85         return 0;
  86 }
  87
  88 /**
  89  * omap3_enter_idle - Programs OMAP3 to enter the specified state
  90  * @dev: cpuidle device
  91  * @index: the index of state to be entered
  92  *
  93  * Called from the CPUidle framework to program the device to the
  94  * specified target state selected by the governor.
  95  */
  96 static int omap3_enter_idle(struct cpuidle_device *dev,
  97                                 int index)
  98 {
  99         struct omap3_idle_statedata *cx =
 100                         cpuidle_get_statedata(&dev->states_usage[index]);
 101         struct timespec ts_preidle, ts_postidle, ts_idle;
 102         u32 mpu_state = cx->mpu_state, core_state = cx->core_state;
 103         int idle_time;
 104
 105         /* Used to keep track of the total time in idle */
 106         getnstimeofday(&ts_preidle);
 107
 108         local_irq_disable();
 109         local_fiq_disable();
 110
 111         pwrdm_set_next_pwrst(mpu_pd, mpu_state);
 112         pwrdm_set_next_pwrst(core_pd, core_state);
 113
 114         if (omap_irq_pending() || need_resched())
 115                 goto return_sleep_time;
 116
 117         /* Deny idle for C1 */
 118         if (index == 0) {
 119                 pwrdm_for_each_clkdm(mpu_pd, _cpuidle_deny_idle);
 120                 pwrdm_for_each_clkdm(core_pd, _cpuidle_deny_idle);
 121         }
 122
 123         /* Execute ARM wfi */
 124         omap_sram_idle();
 125
 126         /* Re-allow idle for C1 */
 127         if (index == 0) {
 128                 pwrdm_for_each_clkdm(mpu_pd, _cpuidle_allow_idle);
 129                 pwrdm_for_each_clkdm(core_pd, _cpuidle_allow_idle);
 130         }
 131
 132 return_sleep_time:
 133         getnstimeofday(&ts_postidle);
 134         ts_idle = timespec_sub(ts_postidle, ts_preidle);
 135
 136         local_irq_enable();
 137         local_fiq_enable();
 138
 139         idle_time = ts_idle.tv_nsec / NSEC_PER_USEC + ts_idle.tv_sec * \
 140                                                                 USEC_PER_SEC;
 141
 142         /* Update cpuidle counters */
 143         dev->last_residency = idle_time;
 144
 145         return index;
 146 }
 147
 148 /**
 149  * next_valid_state - Find next valid C-state
 150  * @dev: cpuidle device
 151  * @index: Index of currently selected c-state
 152  *
 153  * If the state corresponding to index is valid, index is returned back
 154  * to the caller. Else, this function searches for a lower c-state which is
 155  * still valid (as defined in omap3_power_states[]) and returns its index.
 156  *
 157  * A state is valid if the 'valid' field is enabled and
 158  * if it satisfies the enable_off_mode condition.
 159  */
 160 static int next_valid_state(struct cpuidle_device *dev,
 161                                 int index)
 162 {
 163         struct cpuidle_state_usage *curr_usage = &dev->states_usage[index];
 164         struct cpuidle_state *curr = &dev->states[index];
 165         struct omap3_idle_statedata *cx = cpuidle_get_statedata(curr_usage);
 166         u32 mpu_deepest_state = PWRDM_POWER_RET;
 167         u32 core_deepest_state = PWRDM_POWER_RET;
 168         int next_index = -1;
 169
 170         if (enable_off_mode) {
 171                 mpu_deepest_state = PWRDM_POWER_OFF;
 172                 /*
 173                  * Erratum i583: valable for ES rev < Es1.2 on 3630.
 174                  * CORE OFF mode is not supported in a stable form, restrict
 175                  * instead the CORE state to RET.
 176                  */
 177                 if (!IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583))
 178                         core_deepest_state = PWRDM_POWER_OFF;
 179         }
 180
 181         /* Check if current state is valid */
 182         if ((cx->valid) &&
 183             (cx->mpu_state >= mpu_deepest_state) &&
 184             (cx->core_state >= core_deepest_state)) {
 185                 return index;
 186         } else {
 187                 int idx = OMAP3_NUM_STATES - 1;
 188
 189                 /* Reach the current state starting at highest C-state */
 190                 for (; idx >= 0; idx--) {
 191                         if (&dev->states[idx] == curr) {
 192                                 next_index = idx;
 193                                 break;
 194                         }
 195                 }
 196
 197                 /* Should never hit this condition */
 198                 WARN_ON(next_index == -1);
 199
 200                 /*
 201                  * Drop to next valid state.
 202                  * Start search from the next (lower) state.
 203                  */
 204                 idx--;
 205                 for (; idx >= 0; idx--) {
 206                         cx = cpuidle_get_statedata(&dev->states_usage[idx]);
 207                         if ((cx->valid) &&
 208                             (cx->mpu_state >= mpu_deepest_state) &&
 209                             (cx->core_state >= core_deepest_state)) {
 210                                 next_index = idx;
 211                                 break;
 212                         }
 213                 }
 214                 /*
 215                  * C1 is always valid.
 216                  * So, no need to check for 'next_index == -1' outside
 217                  * this loop.
 218                  */
 219         }
 220
 221         return next_index;
 222 }
 223
 224 /**
 225  * omap3_enter_idle_bm - Checks for any bus activity
 226  * @dev: cpuidle device
 227  * @index: array index of target state to be programmed
 228  *
 229  * This function checks for any pending activity and then programs
 230  * the device to the specified or a safer state.
 231  */
 232 static int omap3_enter_idle_bm(struct cpuidle_device *dev,
 233                                int index)
 234 {
 235         int new_state_idx;
 236         u32 core_next_state, per_next_state = 0, per_saved_state = 0, cam_state;
 237         struct omap3_idle_statedata *cx;
 238         int ret;
 239
 240         if (!omap3_can_sleep()) {
 241                 new_state_idx = dev->safe_state_index;
 242                 goto select_state;
 243         }
 244
 245         /*
 246          * Prevent idle completely if CAM is active.
 247          * CAM does not have wakeup capability in OMAP3.
 248          */
 249         cam_state = pwrdm_read_pwrst(cam_pd);
 250         if (cam_state == PWRDM_POWER_ON) {
 251                 new_state_idx = dev->safe_state_index;
 252                 goto select_state;
 253         }
 254
 255         /*
 256          * FIXME: we currently manage device-specific idle states
 257          *        for PER and CORE in combination with CPU-specific
 258          *        idle states.  This is wrong, and device-specific
 259          *        idle management needs to be separated out into
 260          *        its own code.
 261          */
 262
 263         /*
 264          * Prevent PER off if CORE is not in retention or off as this
 265          * would disable PER wakeups completely.
 266          */
 267         cx = cpuidle_get_statedata(&dev->states_usage[index]);
 268         core_next_state = cx->core_state;
 269         per_next_state = per_saved_state = pwrdm_read_next_pwrst(per_pd);
 270         if ((per_next_state == PWRDM_POWER_OFF) &&
 271             (core_next_state > PWRDM_POWER_RET))
 272                 per_next_state = PWRDM_POWER_RET;
 273
 274         /* Are we changing PER target state? */
 275         if (per_next_state != per_saved_state)
 276                 pwrdm_set_next_pwrst(per_pd, per_next_state);
 277
 278         new_state_idx = next_valid_state(dev, index);
 279
 280 select_state:
 281         ret = omap3_enter_idle(dev, new_state_idx);
 282
 283         /* Restore original PER state if it was modified */
 284         if (per_next_state != per_saved_state)
 285                 pwrdm_set_next_pwrst(per_pd, per_saved_state);
 286
 287         return ret;
 288 }
 289
 290 DEFINE_PER_CPU(struct cpuidle_device, omap3_idle_dev);
 291
 292 void omap3_pm_init_cpuidle(struct cpuidle_params *cpuidle_board_params)
 293 {
 294         int i;
 295
 296         if (!cpuidle_board_params)
 297                 return;
 298
 299         for (i = 0; i < OMAP3_NUM_STATES; i++) {
 300                 cpuidle_params_table[i].valid = cpuidle_board_params[i].valid;
 301                 cpuidle_params_table[i].exit_latency =
 302                         cpuidle_board_params[i].exit_latency;
 303                 cpuidle_params_table[i].target_residency =
 304                         cpuidle_board_params[i].target_residency;
 305         }
 306         return;
 307 }
 308
 309 struct cpuidle_driver omap3_idle_driver = {
 310         .name =         "omap3_idle",
 311         .owner =        THIS_MODULE,
 312 };
 313
 314 /* Helper to fill the C-state common data and register the driver_data */
 315 static inline struct omap3_idle_statedata *_fill_cstate(
 316                                         struct cpuidle_device *dev,
 317                                         int idx, const char *descr)
 318 {
 319         struct omap3_idle_statedata *cx = &omap3_idle_data[idx];
 320         struct cpuidle_state *state = &dev->states[idx];
 321         struct cpuidle_state_usage *state_usage = &dev->states_usage[idx];
 322
 323         state->exit_latency     = cpuidle_params_table[idx].exit_latency;
 324         state->target_residency = cpuidle_params_table[idx].target_residency;
 325         state->flags            = CPUIDLE_FLAG_TIME_VALID;
 326         state->enter            = omap3_enter_idle_bm;
 327         cx->valid               = cpuidle_params_table[idx].valid;
 328         sprintf(state->name, "C%d", idx + 1);
 329         strncpy(state->desc, descr, CPUIDLE_DESC_LEN);
 330         cpuidle_set_statedata(state_usage, cx);
 331
 332         return cx;
 333 }
 334
 335 /**
 336  * omap3_idle_init - Init routine for OMAP3 idle
 337  *
 338  * Registers the OMAP3 specific cpuidle driver to the cpuidle
 339  * framework with the valid set of states.
 340  */
 341 int __init omap3_idle_init(void)
 342 {
 343         struct cpuidle_device *dev;
 344         struct omap3_idle_statedata *cx;
 345
 346         mpu_pd = pwrdm_lookup("mpu_pwrdm");
 347         core_pd = pwrdm_lookup("core_pwrdm");
 348         per_pd = pwrdm_lookup("per_pwrdm");
 349         cam_pd = pwrdm_lookup("cam_pwrdm");
 350
 351         cpuidle_register_driver(&omap3_idle_driver);
 352         dev = &per_cpu(omap3_idle_dev, smp_processor_id());
 353         dev->safe_state_index = -1;
 354
 355         /* C1 . MPU WFI + Core active */
 356         cx = _fill_cstate(dev, 0, "MPU ON + CORE ON");
 357         (&dev->states[0])->enter = omap3_enter_idle;
 358         dev->safe_state_index = 0;
 359         cx->valid = 1;  /* C1 is always valid */
 360         cx->mpu_state = PWRDM_POWER_ON;
 361         cx->core_state = PWRDM_POWER_ON;
 362
 363         /* C2 . MPU WFI + Core inactive */
 364         cx = _fill_cstate(dev, 1, "MPU ON + CORE ON");
 365         cx->mpu_state = PWRDM_POWER_ON;
 366         cx->core_state = PWRDM_POWER_ON;
 367
 368         /* C3 . MPU CSWR + Core inactive */
 369         cx = _fill_cstate(dev, 2, "MPU RET + CORE ON");
 370         cx->mpu_state = PWRDM_POWER_RET;
 371         cx->core_state = PWRDM_POWER_ON;
 372
 373         /* C4 . MPU OFF + Core inactive */
 374         cx = _fill_cstate(dev, 3, "MPU OFF + CORE ON");
 375         cx->mpu_state = PWRDM_POWER_OFF;
 376         cx->core_state = PWRDM_POWER_ON;
 377
 378         /* C5 . MPU RET + Core RET */
 379         cx = _fill_cstate(dev, 4, "MPU RET + CORE RET");
 380         cx->mpu_state = PWRDM_POWER_RET;
 381         cx->core_state = PWRDM_POWER_RET;
 382
 383         /* C6 . MPU OFF + Core RET */
 384         cx = _fill_cstate(dev, 5, "MPU OFF + CORE RET");
 385         cx->mpu_state = PWRDM_POWER_OFF;
 386         cx->core_state = PWRDM_POWER_RET;
 387
 388         /* C7 . MPU OFF + Core OFF */
 389         cx = _fill_cstate(dev, 6, "MPU OFF + CORE OFF");
 390         /*
 391          * Erratum i583: implementation for ES rev < Es1.2 on 3630. We cannot
 392          * enable OFF mode in a stable form for previous revisions.
 393          * We disable C7 state as a result.
 394          */
 395         if (IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583)) {
 396                 cx->valid = 0;
 397                 pr_warn("%s: core off state C7 disabled due to i583\n",
 398                         __func__);
 399         }
 400         cx->mpu_state = PWRDM_POWER_OFF;
 401         cx->core_state = PWRDM_POWER_OFF;
 402
 403         dev->state_count = OMAP3_NUM_STATES;
 404         if (cpuidle_register_device(dev)) {
 405                 printk(KERN_ERR "%s: CPUidle register device failed\n",
 406                        __func__);
 407                 return -EIO;
 408         }
 409
 410         return 0;
 411 }
 412 #else
 413 int __init omap3_idle_init(void)
 414 {
 415         return 0;
 416 }
 417 #endif /* CONFIG_CPU_IDLE */