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         u32 mpu_state = cx->mpu_state, core_state = cx->core_state;
  93         int idle_time;
  94
  95         /* Used to keep track of the total time in idle */
  96         getnstimeofday(&ts_preidle);
  97
  98         local_irq_disable();
  99
 100         pwrdm_set_next_pwrst(mpu_pd, mpu_state);
 101         pwrdm_set_next_pwrst(core_pd, core_state);
 102
 103         if (omap_irq_pending() || need_resched())
 104                 goto return_sleep_time;
 105
 106         /* Deny idle for C1 */
 107         if (index == 0) {
 108                 clkdm_deny_idle(mpu_pd->pwrdm_clkdms[0]);
 109                 clkdm_deny_idle(core_pd->pwrdm_clkdms[0]);
 110         }
 111
 112         /*
 113          * Call idle CPU PM enter notifier chain so that
 114          * VFP context is saved.
 115          */
 116         if (mpu_state == PWRDM_POWER_OFF)
 117                 cpu_pm_enter();
 118
 119         /* Execute ARM wfi */
 120         omap_sram_idle();
 121
 122         /*
 123          * Call idle CPU PM enter notifier chain to restore
 124          * VFP context.
 125          */
 126         if (pwrdm_read_prev_pwrst(mpu_pd) == PWRDM_POWER_OFF)
 127                 cpu_pm_exit();
 128
 129         /* Re-allow idle for C1 */
 130         if (index == 0) {
 131                 clkdm_allow_idle(mpu_pd->pwrdm_clkdms[0]);
 132                 clkdm_allow_idle(core_pd->pwrdm_clkdms[0]);
 133         }
 134
 135 return_sleep_time:
 136         getnstimeofday(&ts_postidle);
 137         ts_idle = timespec_sub(ts_postidle, ts_preidle);
 138
 139         local_irq_enable();
 140
 141         idle_time = ts_idle.tv_nsec / NSEC_PER_USEC + ts_idle.tv_sec * \
 142                                                                 USEC_PER_SEC;
 143
 144         /* Update cpuidle counters */
 145         dev->last_residency = idle_time;
 146
 147         return index;
 148 }
 149
 150 /**
 151  * next_valid_state - Find next valid C-state
 152  * @dev: cpuidle device
 153  * @drv: cpuidle driver
 154  * @index: Index of currently selected c-state
 155  *
 156  * If the state corresponding to index is valid, index is returned back
 157  * to the caller. Else, this function searches for a lower c-state which is
 158  * still valid (as defined in omap3_power_states[]) and returns its index.
 159  *
 160  * A state is valid if the 'valid' field is enabled and
 161  * if it satisfies the enable_off_mode condition.
 162  */
 163 static int next_valid_state(struct cpuidle_device *dev,
 164                         struct cpuidle_driver *drv,
 165                                 int index)
 166 {
 167         struct cpuidle_state_usage *curr_usage = &dev->states_usage[index];
 168         struct cpuidle_state *curr = &drv->states[index];
 169         struct omap3_idle_statedata *cx = cpuidle_get_statedata(curr_usage);
 170         u32 mpu_deepest_state = PWRDM_POWER_RET;
 171         u32 core_deepest_state = PWRDM_POWER_RET;
 172         int next_index = -1;
 173
 174         if (enable_off_mode) {
 175                 mpu_deepest_state = PWRDM_POWER_OFF;
 176                 /*
 177                  * Erratum i583: valable for ES rev < Es1.2 on 3630.
 178                  * CORE OFF mode is not supported in a stable form, restrict
 179                  * instead the CORE state to RET.
 180                  */
 181                 if (!IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583))
 182                         core_deepest_state = PWRDM_POWER_OFF;
 183         }
 184
 185         if (!omap_uart_can_sleep())
 186                 core_deepest_state = PWRDM_POWER_RET;
 187
 188         /* Check if current state is valid */
 189         if ((cx->valid) &&
 190             (cx->mpu_state >= mpu_deepest_state) &&
 191             (cx->core_state >= core_deepest_state)) {
 192                 return index;
 193         } else {
 194                 int idx = OMAP3_NUM_STATES - 1;
 195
 196                 /* Reach the current state starting at highest C-state */
 197                 for (; idx >= 0; idx--) {
 198                         if (&drv->states[idx] == curr) {
 199                                 next_index = idx;
 200                                 break;
 201                         }
 202                 }
 203
 204                 /* Should never hit this condition */
 205                 WARN_ON(next_index == -1);
 206
 207                 /*
 208                  * Drop to next valid state.
 209                  * Start search from the next (lower) state.
 210                  */
 211                 idx--;
 212                 for (; idx >= 0; idx--) {
 213                         cx = cpuidle_get_statedata(&dev->states_usage[idx]);
 214                         if ((cx->valid) &&
 215                             (cx->mpu_state >= mpu_deepest_state) &&
 216                             (cx->core_state >= core_deepest_state)) {
 217                                 next_index = idx;
 218                                 break;
 219                         }
 220                 }
 221                 /*
 222                  * C1 is always valid.
 223                  * So, no need to check for 'next_index == -1' outside
 224                  * this loop.
 225                  */
 226         }
 227
 228         return next_index;
 229 }
 230
 231 /**
 232  * omap3_enter_idle_bm - Checks for any bus activity
 233  * @dev: cpuidle device
 234  * @drv: cpuidle driver
 235  * @index: array index of target state to be programmed
 236  *
 237  * This function checks for any pending activity and then programs
 238  * the device to the specified or a safer state.
 239  */
 240 static int omap3_enter_idle_bm(struct cpuidle_device *dev,
 241                                struct cpuidle_driver *drv,
 242                                int index)
 243 {
 244         int new_state_idx;
 245         u32 core_next_state, per_next_state = 0, per_saved_state = 0;
 246         struct omap3_idle_statedata *cx;
 247         int ret;
 248
 249         /*
 250          * Use only C1 if CAM is active.
 251          * CAM does not have wakeup capability in OMAP3.
 252          */
 253         if (pwrdm_read_pwrst(cam_pd) == PWRDM_POWER_ON)
 254                 new_state_idx = drv->safe_state_index;
 255         else
 256                 new_state_idx = next_valid_state(dev, drv, index);
 257
 258         /*
 259          * FIXME: we currently manage device-specific idle states
 260          *        for PER and CORE in combination with CPU-specific
 261          *        idle states.  This is wrong, and device-specific
 262          *        idle management needs to be separated out into
 263          *        its own code.
 264          */
 265
 266         /* Program PER state */
 267         cx = cpuidle_get_statedata(&dev->states_usage[new_state_idx]);
 268         core_next_state = cx->core_state;
 269         per_next_state = per_saved_state = pwrdm_read_next_pwrst(per_pd);
 270         if (new_state_idx == 0) {
 271                 /* In C1 do not allow PER state lower than CORE state */
 272                 if (per_next_state < core_next_state)
 273                         per_next_state = core_next_state;
 274         } else {
 275                 /*
 276                  * Prevent PER OFF if CORE is not in RETention or OFF as this
 277                  * would disable PER wakeups completely.
 278                  */
 279                 if ((per_next_state == PWRDM_POWER_OFF) &&
 280                     (core_next_state > PWRDM_POWER_RET))
 281                         per_next_state = PWRDM_POWER_RET;
 282         }
 283
 284         /* Are we changing PER target state? */
 285         if (per_next_state != per_saved_state)
 286                 pwrdm_set_next_pwrst(per_pd, per_next_state);
 287
 288         ret = omap3_enter_idle(dev, drv, new_state_idx);
 289
 290         /* Restore original PER state if it was modified */
 291         if (per_next_state != per_saved_state)
 292                 pwrdm_set_next_pwrst(per_pd, per_saved_state);
 293
 294         return ret;
 295 }
 296
 297 DEFINE_PER_CPU(struct cpuidle_device, omap3_idle_dev);
 298
 299 void omap3_pm_init_cpuidle(struct cpuidle_params *cpuidle_board_params)
 300 {
 301         int i;
 302
 303         if (!cpuidle_board_params)
 304                 return;
 305
 306         for (i = 0; i < OMAP3_NUM_STATES; i++) {
 307                 cpuidle_params_table[i].valid = cpuidle_board_params[i].valid;
 308                 cpuidle_params_table[i].exit_latency =
 309                         cpuidle_board_params[i].exit_latency;
 310                 cpuidle_params_table[i].target_residency =
 311                         cpuidle_board_params[i].target_residency;
 312         }
 313         return;
 314 }
 315
 316 struct cpuidle_driver omap3_idle_driver = {
 317         .name =         "omap3_idle",
 318         .owner =        THIS_MODULE,
 319 };
 320
 321 /* Helper to fill the C-state common data*/
 322 static inline void _fill_cstate(struct cpuidle_driver *drv,
 323                                         int idx, const char *descr)
 324 {
 325         struct cpuidle_state *state = &drv->states[idx];
 326
 327         state->exit_latency     = cpuidle_params_table[idx].exit_latency;
 328         state->target_residency = cpuidle_params_table[idx].target_residency;
 329         state->flags            = CPUIDLE_FLAG_TIME_VALID;
 330         state->enter            = omap3_enter_idle_bm;
 331         sprintf(state->name, "C%d", idx + 1);
 332         strncpy(state->desc, descr, CPUIDLE_DESC_LEN);
 333
 334 }
 335
 336 /* Helper to register the driver_data */
 337 static inline struct omap3_idle_statedata *_fill_cstate_usage(
 338                                         struct cpuidle_device *dev,
 339                                         int idx)
 340 {
 341         struct omap3_idle_statedata *cx = &omap3_idle_data[idx];
 342         struct cpuidle_state_usage *state_usage = &dev->states_usage[idx];
 343
 344         cx->valid               = cpuidle_params_table[idx].valid;
 345         cpuidle_set_statedata(state_usage, cx);
 346
 347         return cx;
 348 }
 349
 350 /**
 351  * omap3_idle_init - Init routine for OMAP3 idle
 352  *
 353  * Registers the OMAP3 specific cpuidle driver to the cpuidle
 354  * framework with the valid set of states.
 355  */
 356 int __init omap3_idle_init(void)
 357 {
 358         struct cpuidle_device *dev;
 359         struct cpuidle_driver *drv = &omap3_idle_driver;
 360         struct omap3_idle_statedata *cx;
 361
 362         mpu_pd = pwrdm_lookup("mpu_pwrdm");
 363         core_pd = pwrdm_lookup("core_pwrdm");
 364         per_pd = pwrdm_lookup("per_pwrdm");
 365         cam_pd = pwrdm_lookup("cam_pwrdm");
 366
 367
 368         drv->safe_state_index = -1;
 369         dev = &per_cpu(omap3_idle_dev, smp_processor_id());
 370
 371         /* C1 . MPU WFI + Core active */
 372         _fill_cstate(drv, 0, "MPU ON + CORE ON");
 373         (&drv->states[0])->enter = omap3_enter_idle;
 374         drv->safe_state_index = 0;
 375         cx = _fill_cstate_usage(dev, 0);
 376         cx->valid = 1;  /* C1 is always valid */
 377         cx->mpu_state = PWRDM_POWER_ON;
 378         cx->core_state = PWRDM_POWER_ON;
 379
 380         /* C2 . MPU WFI + Core inactive */
 381         _fill_cstate(drv, 1, "MPU ON + CORE ON");
 382         cx = _fill_cstate_usage(dev, 1);
 383         cx->mpu_state = PWRDM_POWER_ON;
 384         cx->core_state = PWRDM_POWER_ON;
 385
 386         /* C3 . MPU CSWR + Core inactive */
 387         _fill_cstate(drv, 2, "MPU RET + CORE ON");
 388         cx = _fill_cstate_usage(dev, 2);
 389         cx->mpu_state = PWRDM_POWER_RET;
 390         cx->core_state = PWRDM_POWER_ON;
 391
 392         /* C4 . MPU OFF + Core inactive */
 393         _fill_cstate(drv, 3, "MPU OFF + CORE ON");
 394         cx = _fill_cstate_usage(dev, 3);
 395         cx->mpu_state = PWRDM_POWER_OFF;
 396         cx->core_state = PWRDM_POWER_ON;
 397
 398         /* C5 . MPU RET + Core RET */
 399         _fill_cstate(drv, 4, "MPU RET + CORE RET");
 400         cx = _fill_cstate_usage(dev, 4);
 401         cx->mpu_state = PWRDM_POWER_RET;
 402         cx->core_state = PWRDM_POWER_RET;
 403
 404         /* C6 . MPU OFF + Core RET */
 405         _fill_cstate(drv, 5, "MPU OFF + CORE RET");
 406         cx = _fill_cstate_usage(dev, 5);
 407         cx->mpu_state = PWRDM_POWER_OFF;
 408         cx->core_state = PWRDM_POWER_RET;
 409
 410         /* C7 . MPU OFF + Core OFF */
 411         _fill_cstate(drv, 6, "MPU OFF + CORE OFF");
 412         cx = _fill_cstate_usage(dev, 6);
 413         /*
 414          * Erratum i583: implementation for ES rev < Es1.2 on 3630. We cannot
 415          * enable OFF mode in a stable form for previous revisions.
 416          * We disable C7 state as a result.
 417          */
 418         if (IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583)) {
 419                 cx->valid = 0;
 420                 pr_warn("%s: core off state C7 disabled due to i583\n",
 421                         __func__);
 422         }
 423         cx->mpu_state = PWRDM_POWER_OFF;
 424         cx->core_state = PWRDM_POWER_OFF;
 425
 426         drv->state_count = OMAP3_NUM_STATES;
 427         cpuidle_register_driver(&omap3_idle_driver);
 428
 429         dev->state_count = OMAP3_NUM_STATES;
 430         if (cpuidle_register_device(dev)) {
 431                 printk(KERN_ERR "%s: CPUidle register device failed\n",
 432                        __func__);
 433                 return -EIO;
 434         }
 435
 436         return 0;
 437 }
 438 #else
 439 int __init omap3_idle_init(void)
 440 {
 441         return 0;
 442 }
 443 #endif /* CONFIG_CPU_IDLE */