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