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
  29 #include <plat/prcm.h>
  30 #include <plat/irqs.h>
  31 #include "powerdomain.h"
  32 #include "clockdomain.h"
  33 #include <plat/serial.h>
  34
  35 #include "pm.h"
  36 #include "control.h"
  37
  38 #ifdef CONFIG_CPU_IDLE
  39
  40 /*
  41  * The latencies/thresholds for various C states have
  42  * to be configured from the respective board files.
  43  * These are some default values (which might not provide
  44  * the best power savings) used on boards which do not
  45  * pass these details from the board file.
  46  */
  47 static struct cpuidle_params cpuidle_params_table[] = {
  48         /* C1 */
  49         {2 + 2, 5, 1},
  50         /* C2 */
  51         {10 + 10, 30, 1},
  52         /* C3 */
  53         {50 + 50, 300, 1},
  54         /* C4 */
  55         {1500 + 1800, 4000, 1},
  56         /* C5 */
  57         {2500 + 7500, 12000, 1},
  58         /* C6 */
  59         {3000 + 8500, 15000, 1},
  60         /* C7 */
  61         {10000 + 30000, 300000, 1},
  62 };
  63 #define OMAP3_NUM_STATES ARRAY_SIZE(cpuidle_params_table)
  64
  65 /* Mach specific information to be recorded in the C-state driver_data */
  66 struct omap3_idle_statedata {
  67         u32 mpu_state;
  68         u32 core_state;
  69         u8 valid;
  70 };
  71 struct omap3_idle_statedata omap3_idle_data[OMAP3_NUM_STATES];
  72
  73 struct powerdomain *mpu_pd, *core_pd, *per_pd, *cam_pd;
  74
  75 static int _cpuidle_allow_idle(struct powerdomain *pwrdm,
  76                                 struct clockdomain *clkdm)
  77 {
  78         clkdm_allow_idle(clkdm);
  79         return 0;
  80 }
  81
  82 static int _cpuidle_deny_idle(struct powerdomain *pwrdm,
  83                                 struct clockdomain *clkdm)
  84 {
  85         clkdm_deny_idle(clkdm);
  86         return 0;
  87 }
  88
  89 /**
  90  * omap3_enter_idle - Programs OMAP3 to enter the specified state
  91  * @dev: cpuidle device
  92  * @drv: cpuidle driver
  93  * @index: the index of state to be entered
  94  *
  95  * Called from the CPUidle framework to program the device to the
  96  * specified target state selected by the governor.
  97  */
  98 static int omap3_enter_idle(struct cpuidle_device *dev,
  99                                 struct cpuidle_driver *drv,
 100                                 int index)
 101 {
 102         struct omap3_idle_statedata *cx =
 103                         cpuidle_get_statedata(&dev->states_usage[index]);
 104         struct timespec ts_preidle, ts_postidle, ts_idle;
 105         u32 mpu_state = cx->mpu_state, core_state = cx->core_state;
 106         int idle_time;
 107
 108         /* Used to keep track of the total time in idle */
 109         getnstimeofday(&ts_preidle);
 110
 111         local_irq_disable();
 112         local_fiq_disable();
 113
 114         pwrdm_set_next_pwrst(mpu_pd, mpu_state);
 115         pwrdm_set_next_pwrst(core_pd, core_state);
 116
 117         if (omap_irq_pending() || need_resched())
 118                 goto return_sleep_time;
 119
 120         /* Deny idle for C1 */
 121         if (index == 0) {
 122                 pwrdm_for_each_clkdm(mpu_pd, _cpuidle_deny_idle);
 123                 pwrdm_for_each_clkdm(core_pd, _cpuidle_deny_idle);
 124         }
 125
 126         /* Execute ARM wfi */
 127         omap_sram_idle();
 128
 129         /* Re-allow idle for C1 */
 130         if (index == 0) {
 131                 pwrdm_for_each_clkdm(mpu_pd, _cpuidle_allow_idle);
 132                 pwrdm_for_each_clkdm(core_pd, _cpuidle_allow_idle);
 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         local_fiq_enable();
 141
 142         idle_time = ts_idle.tv_nsec / NSEC_PER_USEC + ts_idle.tv_sec * \
 143                                                                 USEC_PER_SEC;
 144
 145         /* Update cpuidle counters */
 146         dev->last_residency = idle_time;
 147
 148         return index;
 149 }
 150
 151 /**
 152  * next_valid_state - Find next valid C-state
 153  * @dev: cpuidle device
 154  * @drv: cpuidle driver
 155  * @index: Index of currently selected c-state
 156  *
 157  * If the state corresponding to index is valid, index is returned back
 158  * to the caller. Else, this function searches for a lower c-state which is
 159  * still valid (as defined in omap3_power_states[]) and returns its index.
 160  *
 161  * A state is valid if the 'valid' field is enabled and
 162  * if it satisfies the enable_off_mode condition.
 163  */
 164 static int next_valid_state(struct cpuidle_device *dev,
 165                         struct cpuidle_driver *drv,
 166                                 int index)
 167 {
 168         struct cpuidle_state_usage *curr_usage = &dev->states_usage[index];
 169         struct cpuidle_state *curr = &drv->states[index];
 170         struct omap3_idle_statedata *cx = cpuidle_get_statedata(curr_usage);
 171         u32 mpu_deepest_state = PWRDM_POWER_RET;
 172         u32 core_deepest_state = PWRDM_POWER_RET;
 173         int next_index = -1;
 174
 175         if (enable_off_mode) {
 176                 mpu_deepest_state = PWRDM_POWER_OFF;
 177                 /*
 178                  * Erratum i583: valable for ES rev < Es1.2 on 3630.
 179                  * CORE OFF mode is not supported in a stable form, restrict
 180                  * instead the CORE state to RET.
 181                  */
 182                 if (!IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583))
 183                         core_deepest_state = PWRDM_POWER_OFF;
 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, cam_state;
 247         struct omap3_idle_statedata *cx;
 248         int ret;
 249
 250         /*
 251          * Prevent idle completely if CAM is active.
 252          * CAM does not have wakeup capability in OMAP3.
 253          */
 254         cam_state = pwrdm_read_pwrst(cam_pd);
 255         if (cam_state == PWRDM_POWER_ON) {
 256                 new_state_idx = drv->safe_state_index;
 257                 goto select_state;
 258         }
 259
 260         /*
 261          * FIXME: we currently manage device-specific idle states
 262          *        for PER and CORE in combination with CPU-specific
 263          *        idle states.  This is wrong, and device-specific
 264          *        idle management needs to be separated out into
 265          *        its own code.
 266          */
 267
 268         /*
 269          * Prevent PER off if CORE is not in retention or off as this
 270          * would disable PER wakeups completely.
 271          */
 272         cx = cpuidle_get_statedata(&dev->states_usage[index]);
 273         core_next_state = cx->core_state;
 274         per_next_state = per_saved_state = pwrdm_read_next_pwrst(per_pd);
 275         if ((per_next_state == PWRDM_POWER_OFF) &&
 276             (core_next_state > PWRDM_POWER_RET))
 277                 per_next_state = PWRDM_POWER_RET;
 278
 279         /* Are we changing PER target state? */
 280         if (per_next_state != per_saved_state)
 281                 pwrdm_set_next_pwrst(per_pd, per_next_state);
 282
 283         new_state_idx = next_valid_state(dev, drv, index);
 284
 285 select_state:
 286         ret = omap3_enter_idle(dev, drv, new_state_idx);
 287
 288         /* Restore original PER state if it was modified */
 289         if (per_next_state != per_saved_state)
 290                 pwrdm_set_next_pwrst(per_pd, per_saved_state);
 291
 292         return ret;
 293 }
 294
 295 DEFINE_PER_CPU(struct cpuidle_device, omap3_idle_dev);
 296
 297 void omap3_pm_init_cpuidle(struct cpuidle_params *cpuidle_board_params)
 298 {
 299         int i;
 300
 301         if (!cpuidle_board_params)
 302                 return;
 303
 304         for (i = 0; i < OMAP3_NUM_STATES; i++) {
 305                 cpuidle_params_table[i].valid = cpuidle_board_params[i].valid;
 306                 cpuidle_params_table[i].exit_latency =
 307                         cpuidle_board_params[i].exit_latency;
 308                 cpuidle_params_table[i].target_residency =
 309                         cpuidle_board_params[i].target_residency;
 310         }
 311         return;
 312 }
 313
 314 struct cpuidle_driver omap3_idle_driver = {
 315         .name =         "omap3_idle",
 316         .owner =        THIS_MODULE,
 317 };
 318
 319 /* Helper to fill the C-state common data*/
 320 static inline void _fill_cstate(struct cpuidle_driver *drv,
 321                                         int idx, const char *descr)
 322 {
 323         struct cpuidle_state *state = &drv->states[idx];
 324
 325         state->exit_latency     = cpuidle_params_table[idx].exit_latency;
 326         state->target_residency = cpuidle_params_table[idx].target_residency;
 327         state->flags            = CPUIDLE_FLAG_TIME_VALID;
 328         state->enter            = omap3_enter_idle_bm;
 329         sprintf(state->name, "C%d", idx + 1);
 330         strncpy(state->desc, descr, CPUIDLE_DESC_LEN);
 331
 332 }
 333
 334 /* Helper to register the driver_data */
 335 static inline struct omap3_idle_statedata *_fill_cstate_usage(
 336                                         struct cpuidle_device *dev,
 337                                         int idx)
 338 {
 339         struct omap3_idle_statedata *cx = &omap3_idle_data[idx];
 340         struct cpuidle_state_usage *state_usage = &dev->states_usage[idx];
 341
 342         cx->valid               = cpuidle_params_table[idx].valid;
 343         cpuidle_set_statedata(state_usage, cx);
 344
 345         return cx;
 346 }
 347
 348 /**
 349  * omap3_idle_init - Init routine for OMAP3 idle
 350  *
 351  * Registers the OMAP3 specific cpuidle driver to the cpuidle
 352  * framework with the valid set of states.
 353  */
 354 int __init omap3_idle_init(void)
 355 {
 356         struct cpuidle_device *dev;
 357         struct cpuidle_driver *drv = &omap3_idle_driver;
 358         struct omap3_idle_statedata *cx;
 359
 360         mpu_pd = pwrdm_lookup("mpu_pwrdm");
 361         core_pd = pwrdm_lookup("core_pwrdm");
 362         per_pd = pwrdm_lookup("per_pwrdm");
 363         cam_pd = pwrdm_lookup("cam_pwrdm");
 364
 365
 366         drv->safe_state_index = -1;
 367         dev = &per_cpu(omap3_idle_dev, smp_processor_id());
 368
 369         /* C1 . MPU WFI + Core active */
 370         _fill_cstate(drv, 0, "MPU ON + CORE ON");
 371         (&drv->states[0])->enter = omap3_enter_idle;
 372         drv->safe_state_index = 0;
 373         cx = _fill_cstate_usage(dev, 0);
 374         cx->valid = 1;  /* C1 is always valid */
 375         cx->mpu_state = PWRDM_POWER_ON;
 376         cx->core_state = PWRDM_POWER_ON;
 377
 378         /* C2 . MPU WFI + Core inactive */
 379         _fill_cstate(drv, 1, "MPU ON + CORE ON");
 380         cx = _fill_cstate_usage(dev, 1);
 381         cx->mpu_state = PWRDM_POWER_ON;
 382         cx->core_state = PWRDM_POWER_ON;
 383
 384         /* C3 . MPU CSWR + Core inactive */
 385         _fill_cstate(drv, 2, "MPU RET + CORE ON");
 386         cx = _fill_cstate_usage(dev, 2);
 387         cx->mpu_state = PWRDM_POWER_RET;
 388         cx->core_state = PWRDM_POWER_ON;
 389
 390         /* C4 . MPU OFF + Core inactive */
 391         _fill_cstate(drv, 3, "MPU OFF + CORE ON");
 392         cx = _fill_cstate_usage(dev, 3);
 393         cx->mpu_state = PWRDM_POWER_OFF;
 394         cx->core_state = PWRDM_POWER_ON;
 395
 396         /* C5 . MPU RET + Core RET */
 397         _fill_cstate(drv, 4, "MPU RET + CORE RET");
 398         cx = _fill_cstate_usage(dev, 4);
 399         cx->mpu_state = PWRDM_POWER_RET;
 400         cx->core_state = PWRDM_POWER_RET;
 401
 402         /* C6 . MPU OFF + Core RET */
 403         _fill_cstate(drv, 5, "MPU OFF + CORE RET");
 404         cx = _fill_cstate_usage(dev, 5);
 405         cx->mpu_state = PWRDM_POWER_OFF;
 406         cx->core_state = PWRDM_POWER_RET;
 407
 408         /* C7 . MPU OFF + Core OFF */
 409         _fill_cstate(drv, 6, "MPU OFF + CORE OFF");
 410         cx = _fill_cstate_usage(dev, 6);
 411         /*
 412          * Erratum i583: implementation for ES rev < Es1.2 on 3630. We cannot
 413          * enable OFF mode in a stable form for previous revisions.
 414          * We disable C7 state as a result.
 415          */
 416         if (IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583)) {
 417                 cx->valid = 0;
 418                 pr_warn("%s: core off state C7 disabled due to i583\n",
 419                         __func__);
 420         }
 421         cx->mpu_state = PWRDM_POWER_OFF;
 422         cx->core_state = PWRDM_POWER_OFF;
 423
 424         drv->state_count = OMAP3_NUM_STATES;
 425         cpuidle_register_driver(&omap3_idle_driver);
 426
 427         dev->state_count = OMAP3_NUM_STATES;
 428         if (cpuidle_register_device(dev)) {
 429                 printk(KERN_ERR "%s: CPUidle register device failed\n",
 430                        __func__);
 431                 return -EIO;
 432         }
 433
 434         return 0;
 435 }
 436 #else
 437 int __init omap3_idle_init(void)
 438 {
 439         return 0;
 440 }
 441 #endif /* CONFIG_CPU_IDLE */