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                 /* pandora hack */
 182                 if (enable_off_mode < 2)
 183                         core_deepest_state = PWRDM_POWER_RET;
 184         }
 185
 186         if (!omap_uart_can_sleep())
 187                 core_deepest_state = PWRDM_POWER_RET;
 188
 189         /* Check if current state is valid */
 190         if ((cx->valid) &&
 191             (cx->mpu_state >= mpu_deepest_state) &&
 192             (cx->core_state >= core_deepest_state)) {
 193                 return index;
 194         } else {
 195                 int idx = OMAP3_NUM_STATES - 1;
 196
 197                 /* Reach the current state starting at highest C-state */
 198                 for (; idx >= 0; idx--) {
 199                         if (&drv->states[idx] == curr) {
 200                                 next_index = idx;
 201                                 break;
 202                         }
 203                 }
 204
 205                 /* Should never hit this condition */
 206                 WARN_ON(next_index == -1);
 207
 208                 /*
 209                  * Drop to next valid state.
 210                  * Start search from the next (lower) state.
 211                  */
 212                 idx--;
 213                 for (; idx >= 0; idx--) {
 214                         cx = cpuidle_get_statedata(&dev->states_usage[idx]);
 215                         if ((cx->valid) &&
 216                             (cx->mpu_state >= mpu_deepest_state) &&
 217                             (cx->core_state >= core_deepest_state)) {
 218                                 next_index = idx;
 219                                 break;
 220                         }
 221                 }
 222                 /*
 223                  * C1 is always valid.
 224                  * So, no need to check for 'next_index == -1' outside
 225                  * this loop.
 226                  */
 227         }
 228
 229         return next_index;
 230 }
 231
 232 /**
 233  * omap3_enter_idle_bm - Checks for any bus activity
 234  * @dev: cpuidle device
 235  * @drv: cpuidle driver
 236  * @index: array index of target state to be programmed
 237  *
 238  * This function checks for any pending activity and then programs
 239  * the device to the specified or a safer state.
 240  */
 241 static int omap3_enter_idle_bm(struct cpuidle_device *dev,
 242                                struct cpuidle_driver *drv,
 243                                int index)
 244 {
 245         int new_state_idx;
 246         u32 core_next_state, per_next_state = 0, per_saved_state = 0;
 247         struct omap3_idle_statedata *cx;
 248         int ret;
 249
 250         /*
 251          * Use only C1 if CAM is active.
 252          * CAM does not have wakeup capability in OMAP3.
 253          */
 254         if (pwrdm_read_pwrst(cam_pd) == PWRDM_POWER_ON)
 255                 new_state_idx = drv->safe_state_index;
 256         else
 257                 new_state_idx = next_valid_state(dev, drv, index);
 258
 259         /*
 260          * FIXME: we currently manage device-specific idle states
 261          *        for PER and CORE in combination with CPU-specific
 262          *        idle states.  This is wrong, and device-specific
 263          *        idle management needs to be separated out into
 264          *        its own code.
 265          */
 266
 267         /* Program PER state */
 268         cx = cpuidle_get_statedata(&dev->states_usage[new_state_idx]);
 269         core_next_state = cx->core_state;
 270         per_next_state = per_saved_state = pwrdm_read_next_pwrst(per_pd);
 271         if (new_state_idx == 0) {
 272                 /* In C1 do not allow PER state lower than CORE state */
 273                 if (per_next_state < core_next_state)
 274                         per_next_state = core_next_state;
 275         } else {
 276                 /*
 277                  * Prevent PER OFF if CORE is not in RETention or OFF as this
 278                  * would disable PER wakeups completely.
 279                  */
 280                 if ((per_next_state == PWRDM_POWER_OFF) &&
 281                     (core_next_state > PWRDM_POWER_RET))
 282                         per_next_state = PWRDM_POWER_RET;
 283         }
 284
 285         /* Are we changing PER target state? */
 286         if (per_next_state != per_saved_state)
 287                 pwrdm_set_next_pwrst(per_pd, per_next_state);
 288
 289         ret = omap3_enter_idle(dev, drv, new_state_idx);
 290
 291         /* Restore original PER state if it was modified */
 292         if (per_next_state != per_saved_state)
 293                 pwrdm_set_next_pwrst(per_pd, per_saved_state);
 294
 295         return ret;
 296 }
 297
 298 DEFINE_PER_CPU(struct cpuidle_device, omap3_idle_dev);
 299
 300 void omap3_pm_init_cpuidle(struct cpuidle_params *cpuidle_board_params)
 301 {
 302         int i;
 303
 304         if (!cpuidle_board_params)
 305                 return;
 306
 307         for (i = 0; i < OMAP3_NUM_STATES; i++) {
 308                 cpuidle_params_table[i].valid = cpuidle_board_params[i].valid;
 309                 cpuidle_params_table[i].exit_latency =
 310                         cpuidle_board_params[i].exit_latency;
 311                 cpuidle_params_table[i].target_residency =
 312                         cpuidle_board_params[i].target_residency;
 313         }
 314         return;
 315 }
 316
 317 struct cpuidle_driver omap3_idle_driver = {
 318         .name =         "omap3_idle",
 319         .owner =        THIS_MODULE,
 320 };
 321
 322 /* Helper to fill the C-state common data*/
 323 static inline void _fill_cstate(struct cpuidle_driver *drv,
 324                                         int idx, const char *descr)
 325 {
 326         struct cpuidle_state *state = &drv->states[idx];
 327
 328         state->exit_latency     = cpuidle_params_table[idx].exit_latency;
 329         state->target_residency = cpuidle_params_table[idx].target_residency;
 330         state->flags            = CPUIDLE_FLAG_TIME_VALID;
 331         state->enter            = omap3_enter_idle_bm;
 332         sprintf(state->name, "C%d", idx + 1);
 333         strncpy(state->desc, descr, CPUIDLE_DESC_LEN);
 334
 335 }
 336
 337 /* Helper to register the driver_data */
 338 static inline struct omap3_idle_statedata *_fill_cstate_usage(
 339                                         struct cpuidle_device *dev,
 340                                         int idx)
 341 {
 342         struct omap3_idle_statedata *cx = &omap3_idle_data[idx];
 343         struct cpuidle_state_usage *state_usage = &dev->states_usage[idx];
 344
 345         cx->valid               = cpuidle_params_table[idx].valid;
 346         cpuidle_set_statedata(state_usage, cx);
 347
 348         return cx;
 349 }
 350
 351 /**
 352  * omap3_idle_init - Init routine for OMAP3 idle
 353  *
 354  * Registers the OMAP3 specific cpuidle driver to the cpuidle
 355  * framework with the valid set of states.
 356  */
 357 int __init omap3_idle_init(void)
 358 {
 359         struct cpuidle_device *dev;
 360         struct cpuidle_driver *drv = &omap3_idle_driver;
 361         struct omap3_idle_statedata *cx;
 362
 363         mpu_pd = pwrdm_lookup("mpu_pwrdm");
 364         core_pd = pwrdm_lookup("core_pwrdm");
 365         per_pd = pwrdm_lookup("per_pwrdm");
 366         cam_pd = pwrdm_lookup("cam_pwrdm");
 367
 368
 369         drv->safe_state_index = -1;
 370         dev = &per_cpu(omap3_idle_dev, smp_processor_id());
 371
 372         /* C1 . MPU WFI + Core active */
 373         _fill_cstate(drv, 0, "MPU ON + CORE ON");
 374         (&drv->states[0])->enter = omap3_enter_idle;
 375         drv->safe_state_index = 0;
 376         cx = _fill_cstate_usage(dev, 0);
 377         cx->valid = 1;  /* C1 is always valid */
 378         cx->mpu_state = PWRDM_POWER_ON;
 379         cx->core_state = PWRDM_POWER_ON;
 380
 381         /* C2 . MPU WFI + Core inactive */
 382         _fill_cstate(drv, 1, "MPU ON + CORE ON");
 383         cx = _fill_cstate_usage(dev, 1);
 384         cx->mpu_state = PWRDM_POWER_ON;
 385         cx->core_state = PWRDM_POWER_ON;
 386
 387         /* C3 . MPU CSWR + Core inactive */
 388         _fill_cstate(drv, 2, "MPU RET + CORE ON");
 389         cx = _fill_cstate_usage(dev, 2);
 390         cx->mpu_state = PWRDM_POWER_RET;
 391         cx->core_state = PWRDM_POWER_ON;
 392
 393         /* C4 . MPU OFF + Core inactive */
 394         _fill_cstate(drv, 3, "MPU OFF + CORE ON");
 395         cx = _fill_cstate_usage(dev, 3);
 396         cx->mpu_state = PWRDM_POWER_OFF;
 397         cx->core_state = PWRDM_POWER_ON;
 398
 399         /* C5 . MPU RET + Core RET */
 400         _fill_cstate(drv, 4, "MPU RET + CORE RET");
 401         cx = _fill_cstate_usage(dev, 4);
 402         cx->mpu_state = PWRDM_POWER_RET;
 403         cx->core_state = PWRDM_POWER_RET;
 404
 405         /* C6 . MPU OFF + Core RET */
 406         _fill_cstate(drv, 5, "MPU OFF + CORE RET");
 407         cx = _fill_cstate_usage(dev, 5);
 408         cx->mpu_state = PWRDM_POWER_OFF;
 409         cx->core_state = PWRDM_POWER_RET;
 410
 411         /* C7 . MPU OFF + Core OFF */
 412         _fill_cstate(drv, 6, "MPU OFF + CORE OFF");
 413         cx = _fill_cstate_usage(dev, 6);
 414         /*
 415          * Erratum i583: implementation for ES rev < Es1.2 on 3630. We cannot
 416          * enable OFF mode in a stable form for previous revisions.
 417          * We disable C7 state as a result.
 418          */
 419         if (IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583)) {
 420                 cx->valid = 0;
 421                 pr_warn("%s: core off state C7 disabled due to i583\n",
 422                         __func__);
 423         }
 424         cx->mpu_state = PWRDM_POWER_OFF;
 425         cx->core_state = PWRDM_POWER_OFF;
 426
 427         drv->state_count = OMAP3_NUM_STATES;
 428         cpuidle_register_driver(&omap3_idle_driver);
 429
 430         dev->state_count = OMAP3_NUM_STATES;
 431         if (cpuidle_register_device(dev)) {
 432                 printk(KERN_ERR "%s: CPUidle register device failed\n",
 433                        __func__);
 434                 return -EIO;
 435         }
 436
 437         return 0;
 438 }
 439 #else
 440 int __init omap3_idle_init(void)
 441 {
 442         return 0;
 443 }
 444 #endif /* CONFIG_CPU_IDLE */