arch/arm/mach-omap2/pm34xx.c

   1 /*
   2  * OMAP3 Power Management Routines
   3  *
   4  * Copyright (C) 2006-2008 Nokia Corporation
   5  * Tony Lindgren <tony@atomide.com>
   6  * Jouni Hogander
   7  *
   8  * Copyright (C) 2007 Texas Instruments, Inc.
   9  * Rajendra Nayak <rnayak@ti.com>
  10  *
  11  * Copyright (C) 2005 Texas Instruments, Inc.
  12  * Richard Woodruff <r-woodruff2@ti.com>
  13  *
  14  * Based on pm.c for omap1
  15  *
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License version 2 as
  18  * published by the Free Software Foundation.
  19  */
  20
  21 #include <linux/pm.h>
  22 #include <linux/suspend.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/module.h>
  25 #include <linux/list.h>
  26 #include <linux/err.h>
  27 #include <linux/gpio.h>
  28 #include <linux/clk.h>
  29 #include <linux/delay.h>
  30 #include <linux/slab.h>
  31 #include <linux/console.h>
  32 #include <trace/events/power.h>
  33
  34 #include <asm/suspend.h>
  35
  36 #include <plat/sram.h>
  37 #include "clockdomain.h"
  38 #include "powerdomain.h"
  39 #include <plat/serial.h>
  40 #include <plat/sdrc.h>
  41 #include <plat/prcm.h>
  42 #include <plat/gpmc.h>
  43 #include <plat/dma.h>
  44
  45 #include "cm2xxx_3xxx.h"
  46 #include "cm-regbits-34xx.h"
  47 #include "prm-regbits-34xx.h"
  48
  49 #include "prm2xxx_3xxx.h"
  50 #include "pm.h"
  51 #include "sdrc.h"
  52 #include "control.h"
  53
  54 #ifdef CONFIG_SUSPEND
  55 static suspend_state_t suspend_state = PM_SUSPEND_ON;
  56 static inline bool is_suspending(void)
  57 {
  58         return (suspend_state != PM_SUSPEND_ON);
  59 }
  60 #else
  61 static inline bool is_suspending(void)
  62 {
  63         return false;
  64 }
  65 #endif
  66
  67 /* pm34xx errata defined in pm.h */
  68 u16 pm34xx_errata;
  69
  70 struct power_state {
  71         struct powerdomain *pwrdm;
  72         u32 next_state;
  73 #ifdef CONFIG_SUSPEND
  74         u32 saved_state;
  75 #endif
  76         struct list_head node;
  77 };
  78
  79 static LIST_HEAD(pwrst_list);
  80
  81 static int (*_omap_save_secure_sram)(u32 *addr);
  82 void (*omap3_do_wfi_sram)(void);
  83
  84 static struct powerdomain *mpu_pwrdm, *neon_pwrdm;
  85 static struct powerdomain *core_pwrdm, *per_pwrdm;
  86 static struct powerdomain *cam_pwrdm;
  87
  88 static inline void omap3_per_save_context(void)
  89 {
  90         omap_gpio_save_context();
  91 }
  92
  93 static inline void omap3_per_restore_context(void)
  94 {
  95         omap_gpio_restore_context();
  96 }
  97
  98 static void omap3_enable_io_chain(void)
  99 {
 100         int timeout = 0;
 101
 102         if (omap_rev() >= OMAP3430_REV_ES3_1) {
 103                 omap2_prm_set_mod_reg_bits(OMAP3430_EN_IO_CHAIN_MASK, WKUP_MOD,
 104                                      PM_WKEN);
 105                 /* Do a readback to assure write has been done */
 106                 omap2_prm_read_mod_reg(WKUP_MOD, PM_WKEN);
 107
 108                 while (!(omap2_prm_read_mod_reg(WKUP_MOD, PM_WKEN) &
 109                          OMAP3430_ST_IO_CHAIN_MASK)) {
 110                         timeout++;
 111                         if (timeout > 1000) {
 112                                 printk(KERN_ERR "Wake up daisy chain "
 113                                        "activation failed.\n");
 114                                 return;
 115                         }
 116                         omap2_prm_set_mod_reg_bits(OMAP3430_ST_IO_CHAIN_MASK,
 117                                              WKUP_MOD, PM_WKEN);
 118                 }
 119         }
 120 }
 121
 122 static void omap3_disable_io_chain(void)
 123 {
 124         if (omap_rev() >= OMAP3430_REV_ES3_1)
 125                 omap2_prm_clear_mod_reg_bits(OMAP3430_EN_IO_CHAIN_MASK, WKUP_MOD,
 126                                        PM_WKEN);
 127 }
 128
 129 static void omap3_core_save_context(void)
 130 {
 131         omap3_ctrl_save_padconf();
 132
 133         /*
 134          * Force write last pad into memory, as this can fail in some
 135          * cases according to errata 1.157, 1.185
 136          */
 137         omap_ctrl_writel(omap_ctrl_readl(OMAP343X_PADCONF_ETK_D14),
 138                 OMAP343X_CONTROL_MEM_WKUP + 0x2a0);
 139
 140         /* Save the Interrupt controller context */
 141         omap_intc_save_context();
 142         /* Save the GPMC context */
 143         omap3_gpmc_save_context();
 144         /* Save the system control module context, padconf already save above*/
 145         omap3_control_save_context();
 146         omap_dma_global_context_save();
 147 }
 148
 149 static void omap3_core_restore_context(void)
 150 {
 151         /* Restore the control module context, padconf restored by h/w */
 152         omap3_control_restore_context();
 153         /* Restore the GPMC context */
 154         omap3_gpmc_restore_context();
 155         /* Restore the interrupt controller context */
 156         omap_intc_restore_context();
 157         omap_dma_global_context_restore();
 158 }
 159
 160 /*
 161  * FIXME: This function should be called before entering off-mode after
 162  * OMAP3 secure services have been accessed. Currently it is only called
 163  * once during boot sequence, but this works as we are not using secure
 164  * services.
 165  */
 166 static void omap3_save_secure_ram_context(void)
 167 {
 168         u32 ret;
 169         int mpu_next_state = pwrdm_read_next_pwrst(mpu_pwrdm);
 170
 171         if (omap_type() != OMAP2_DEVICE_TYPE_GP) {
 172                 /*
 173                  * MPU next state must be set to POWER_ON temporarily,
 174                  * otherwise the WFI executed inside the ROM code
 175                  * will hang the system.
 176                  */
 177                 pwrdm_set_next_pwrst(mpu_pwrdm, PWRDM_POWER_ON);
 178                 ret = _omap_save_secure_sram((u32 *)
 179                                 __pa(omap3_secure_ram_storage));
 180                 pwrdm_set_next_pwrst(mpu_pwrdm, mpu_next_state);
 181                 /* Following is for error tracking, it should not happen */
 182                 if (ret) {
 183                         printk(KERN_ERR "save_secure_sram() returns %08x\n",
 184                                 ret);
 185                         while (1)
 186                                 ;
 187                 }
 188         }
 189 }
 190
 191 /*
 192  * PRCM Interrupt Handler Helper Function
 193  *
 194  * The purpose of this function is to clear any wake-up events latched
 195  * in the PRCM PM_WKST_x registers. It is possible that a wake-up event
 196  * may occur whilst attempting to clear a PM_WKST_x register and thus
 197  * set another bit in this register. A while loop is used to ensure
 198  * that any peripheral wake-up events occurring while attempting to
 199  * clear the PM_WKST_x are detected and cleared.
 200  */
 201 static int prcm_clear_mod_irqs(s16 module, u8 regs)
 202 {
 203         u32 wkst, fclk, iclk, clken;
 204         u16 wkst_off = (regs == 3) ? OMAP3430ES2_PM_WKST3 : PM_WKST1;
 205         u16 fclk_off = (regs == 3) ? OMAP3430ES2_CM_FCLKEN3 : CM_FCLKEN1;
 206         u16 iclk_off = (regs == 3) ? CM_ICLKEN3 : CM_ICLKEN1;
 207         u16 grpsel_off = (regs == 3) ?
 208                 OMAP3430ES2_PM_MPUGRPSEL3 : OMAP3430_PM_MPUGRPSEL;
 209         int c = 0;
 210
 211         wkst = omap2_prm_read_mod_reg(module, wkst_off);
 212         wkst &= omap2_prm_read_mod_reg(module, grpsel_off);
 213         if (wkst) {
 214                 iclk = omap2_cm_read_mod_reg(module, iclk_off);
 215                 fclk = omap2_cm_read_mod_reg(module, fclk_off);
 216                 while (wkst) {
 217                         clken = wkst;
 218                         omap2_cm_set_mod_reg_bits(clken, module, iclk_off);
 219                         /*
 220                          * For USBHOST, we don't know whether HOST1 or
 221                          * HOST2 woke us up, so enable both f-clocks
 222                          */
 223                         if (module == OMAP3430ES2_USBHOST_MOD)
 224                                 clken |= 1 << OMAP3430ES2_EN_USBHOST2_SHIFT;
 225                         omap2_cm_set_mod_reg_bits(clken, module, fclk_off);
 226                         omap2_prm_write_mod_reg(wkst, module, wkst_off);
 227                         wkst = omap2_prm_read_mod_reg(module, wkst_off);
 228                         c++;
 229                 }
 230                 omap2_cm_write_mod_reg(iclk, module, iclk_off);
 231                 omap2_cm_write_mod_reg(fclk, module, fclk_off);
 232         }
 233
 234         return c;
 235 }
 236
 237 static int _prcm_int_handle_wakeup(void)
 238 {
 239         int c;
 240
 241         c = prcm_clear_mod_irqs(WKUP_MOD, 1);
 242         c += prcm_clear_mod_irqs(CORE_MOD, 1);
 243         c += prcm_clear_mod_irqs(OMAP3430_PER_MOD, 1);
 244         if (omap_rev() > OMAP3430_REV_ES1_0) {
 245                 c += prcm_clear_mod_irqs(CORE_MOD, 3);
 246                 c += prcm_clear_mod_irqs(OMAP3430ES2_USBHOST_MOD, 1);
 247         }
 248
 249         return c;
 250 }
 251
 252 /*
 253  * PRCM Interrupt Handler
 254  *
 255  * The PRM_IRQSTATUS_MPU register indicates if there are any pending
 256  * interrupts from the PRCM for the MPU. These bits must be cleared in
 257  * order to clear the PRCM interrupt. The PRCM interrupt handler is
 258  * implemented to simply clear the PRM_IRQSTATUS_MPU in order to clear
 259  * the PRCM interrupt. Please note that bit 0 of the PRM_IRQSTATUS_MPU
 260  * register indicates that a wake-up event is pending for the MPU and
 261  * this bit can only be cleared if the all the wake-up events latched
 262  * in the various PM_WKST_x registers have been cleared. The interrupt
 263  * handler is implemented using a do-while loop so that if a wake-up
 264  * event occurred during the processing of the prcm interrupt handler
 265  * (setting a bit in the corresponding PM_WKST_x register and thus
 266  * preventing us from clearing bit 0 of the PRM_IRQSTATUS_MPU register)
 267  * this would be handled.
 268  */
 269 static irqreturn_t prcm_interrupt_handler (int irq, void *dev_id)
 270 {
 271         u32 irqenable_mpu, irqstatus_mpu;
 272         int c = 0;
 273
 274         irqenable_mpu = omap2_prm_read_mod_reg(OCP_MOD,
 275                                          OMAP3_PRM_IRQENABLE_MPU_OFFSET);
 276         irqstatus_mpu = omap2_prm_read_mod_reg(OCP_MOD,
 277                                          OMAP3_PRM_IRQSTATUS_MPU_OFFSET);
 278         irqstatus_mpu &= irqenable_mpu;
 279
 280         do {
 281                 if (irqstatus_mpu & (OMAP3430_WKUP_ST_MASK |
 282                                      OMAP3430_IO_ST_MASK)) {
 283                         c = _prcm_int_handle_wakeup();
 284
 285                         /*
 286                          * Is the MPU PRCM interrupt handler racing with the
 287                          * IVA2 PRCM interrupt handler ?
 288                          */
 289                         WARN(c == 0, "prcm: WARNING: PRCM indicated MPU wakeup "
 290                              "but no wakeup sources are marked\n");
 291                 } else {
 292                         /* XXX we need to expand our PRCM interrupt handler */
 293                         WARN(1, "prcm: WARNING: PRCM interrupt received, but "
 294                              "no code to handle it (%08x)\n", irqstatus_mpu);
 295                 }
 296
 297                 omap2_prm_write_mod_reg(irqstatus_mpu, OCP_MOD,
 298                                         OMAP3_PRM_IRQSTATUS_MPU_OFFSET);
 299
 300                 irqstatus_mpu = omap2_prm_read_mod_reg(OCP_MOD,
 301                                         OMAP3_PRM_IRQSTATUS_MPU_OFFSET);
 302                 irqstatus_mpu &= irqenable_mpu;
 303
 304         } while (irqstatus_mpu);
 305
 306         return IRQ_HANDLED;
 307 }
 308
 309 static void omap34xx_save_context(u32 *save)
 310 {
 311         u32 val;
 312
 313         /* Read Auxiliary Control Register */
 314         asm("mrc p15, 0, %0, c1, c0, 1" : "=r" (val));
 315         *save++ = 1;
 316         *save++ = val;
 317
 318         /* Read L2 AUX ctrl register */
 319         asm("mrc p15, 1, %0, c9, c0, 2" : "=r" (val));
 320         *save++ = 1;
 321         *save++ = val;
 322 }
 323
 324 static void omap34xx_do_sram_idle(unsigned long save_state)
 325 {
 326         omap34xx_cpu_suspend(save_state);
 327 }
 328
 329 void omap_sram_idle(void)
 330 {
 331         /* Variable to tell what needs to be saved and restored
 332          * in omap_sram_idle*/
 333         /* save_state = 0 => Nothing to save and restored */
 334         /* save_state = 1 => Only L1 and logic lost */
 335         /* save_state = 2 => Only L2 lost */
 336         /* save_state = 3 => L1, L2 and logic lost */
 337         int save_state = 0;
 338         int mpu_next_state = PWRDM_POWER_ON;
 339         int per_next_state = PWRDM_POWER_ON;
 340         int core_next_state = PWRDM_POWER_ON;
 341         int per_going_off;
 342         int core_prev_state, per_prev_state;
 343         u32 sdrc_pwr = 0;
 344
 345         pwrdm_clear_all_prev_pwrst(mpu_pwrdm);
 346         pwrdm_clear_all_prev_pwrst(neon_pwrdm);
 347         pwrdm_clear_all_prev_pwrst(core_pwrdm);
 348         pwrdm_clear_all_prev_pwrst(per_pwrdm);
 349
 350         mpu_next_state = pwrdm_read_next_pwrst(mpu_pwrdm);
 351         switch (mpu_next_state) {
 352         case PWRDM_POWER_ON:
 353         case PWRDM_POWER_RET:
 354                 /* No need to save context */
 355                 save_state = 0;
 356                 break;
 357         case PWRDM_POWER_OFF:
 358                 save_state = 3;
 359                 break;
 360         default:
 361                 /* Invalid state */
 362                 printk(KERN_ERR "Invalid mpu state in sram_idle\n");
 363                 return;
 364         }
 365         pwrdm_pre_transition();
 366
 367         /* NEON control */
 368         if (pwrdm_read_pwrst(neon_pwrdm) == PWRDM_POWER_ON)
 369                 pwrdm_set_next_pwrst(neon_pwrdm, mpu_next_state);
 370
 371         /* Enable IO-PAD and IO-CHAIN wakeups */
 372         per_next_state = pwrdm_read_next_pwrst(per_pwrdm);
 373         core_next_state = pwrdm_read_next_pwrst(core_pwrdm);
 374         if (omap3_has_io_wakeup() &&
 375             (per_next_state < PWRDM_POWER_ON ||
 376              core_next_state < PWRDM_POWER_ON)) {
 377                 omap2_prm_set_mod_reg_bits(OMAP3430_EN_IO_MASK, WKUP_MOD, PM_WKEN);
 378                 omap3_enable_io_chain();
 379         }
 380
 381         /* Block console output in case it is on one of the OMAP UARTs */
 382         if (!is_suspending())
 383                 if (per_next_state < PWRDM_POWER_ON ||
 384                     core_next_state < PWRDM_POWER_ON)
 385                         if (!console_trylock())
 386                                 goto console_still_active;
 387
 388         /* PER */
 389         if (per_next_state < PWRDM_POWER_ON) {
 390                 per_going_off = (per_next_state == PWRDM_POWER_OFF) ? 1 : 0;
 391                 omap_uart_prepare_idle(2);
 392                 omap_uart_prepare_idle(3);
 393                 omap2_gpio_prepare_for_idle(per_going_off);
 394                 if (per_next_state == PWRDM_POWER_OFF)
 395                                 omap3_per_save_context();
 396         }
 397
 398         /* CORE */
 399         if (core_next_state < PWRDM_POWER_ON) {
 400                 omap_uart_prepare_idle(0);
 401                 omap_uart_prepare_idle(1);
 402                 if (core_next_state == PWRDM_POWER_OFF) {
 403                         omap3_core_save_context();
 404                         omap3_cm_save_context();
 405                 }
 406         }
 407
 408         omap3_intc_prepare_idle();
 409
 410         /*
 411         * On EMU/HS devices ROM code restores a SRDC value
 412         * from scratchpad which has automatic self refresh on timeout
 413         * of AUTO_CNT = 1 enabled. This takes care of erratum ID i443.
 414         * Hence store/restore the SDRC_POWER register here.
 415         */
 416         if (omap_rev() >= OMAP3430_REV_ES3_0 &&
 417             omap_type() != OMAP2_DEVICE_TYPE_GP &&
 418             core_next_state == PWRDM_POWER_OFF)
 419                 sdrc_pwr = sdrc_read_reg(SDRC_POWER);
 420
 421         /*
 422          * omap3_arm_context is the location where some ARM context
 423          * get saved. The rest is placed on the stack, and restored
 424          * from there before resuming.
 425          */
 426         if (save_state)
 427                 omap34xx_save_context(omap3_arm_context);
 428         if (save_state == 1 || save_state == 3)
 429                 cpu_suspend(save_state, omap34xx_do_sram_idle);
 430         else
 431                 omap34xx_do_sram_idle(save_state);
 432
 433         /* Restore normal SDRC POWER settings */
 434         if (omap_rev() >= OMAP3430_REV_ES3_0 &&
 435             omap_type() != OMAP2_DEVICE_TYPE_GP &&
 436             core_next_state == PWRDM_POWER_OFF)
 437                 sdrc_write_reg(sdrc_pwr, SDRC_POWER);
 438
 439         /* CORE */
 440         if (core_next_state < PWRDM_POWER_ON) {
 441                 core_prev_state = pwrdm_read_prev_pwrst(core_pwrdm);
 442                 if (core_prev_state == PWRDM_POWER_OFF) {
 443                         omap3_core_restore_context();
 444                         omap3_cm_restore_context();
 445                         omap3_sram_restore_context();
 446                         omap2_sms_restore_context();
 447                 }
 448                 omap_uart_resume_idle(0);
 449                 omap_uart_resume_idle(1);
 450                 if (core_next_state == PWRDM_POWER_OFF)
 451                         omap2_prm_clear_mod_reg_bits(OMAP3430_AUTO_OFF_MASK,
 452                                                OMAP3430_GR_MOD,
 453                                                OMAP3_PRM_VOLTCTRL_OFFSET);
 454         }
 455         omap3_intc_resume_idle();
 456
 457         /* PER */
 458         if (per_next_state < PWRDM_POWER_ON) {
 459                 per_prev_state = pwrdm_read_prev_pwrst(per_pwrdm);
 460                 omap2_gpio_resume_after_idle();
 461                 if (per_prev_state == PWRDM_POWER_OFF)
 462                         omap3_per_restore_context();
 463                 omap_uart_resume_idle(2);
 464                 omap_uart_resume_idle(3);
 465         }
 466
 467         if (!is_suspending())
 468                 console_unlock();
 469
 470 console_still_active:
 471         /* Disable IO-PAD and IO-CHAIN wakeup */
 472         if (omap3_has_io_wakeup() &&
 473             (per_next_state < PWRDM_POWER_ON ||
 474              core_next_state < PWRDM_POWER_ON)) {
 475                 omap2_prm_clear_mod_reg_bits(OMAP3430_EN_IO_MASK, WKUP_MOD,
 476                                              PM_WKEN);
 477                 omap3_disable_io_chain();
 478         }
 479
 480         pwrdm_post_transition();
 481
 482         clkdm_allow_idle(mpu_pwrdm->pwrdm_clkdms[0]);
 483 }
 484
 485 int omap3_can_sleep(void)
 486 {
 487         if (!sleep_while_idle)
 488                 return 0;
 489         if (!omap_uart_can_sleep())
 490                 return 0;
 491         return 1;
 492 }
 493
 494 static void omap3_pm_idle(void)
 495 {
 496         local_irq_disable();
 497         local_fiq_disable();
 498
 499         if (!omap3_can_sleep())
 500                 goto out;
 501
 502         if (omap_irq_pending() || need_resched())
 503                 goto out;
 504
 505         trace_power_start(POWER_CSTATE, 1, smp_processor_id());
 506         trace_cpu_idle(1, smp_processor_id());
 507
 508         omap_sram_idle();
 509
 510         trace_power_end(smp_processor_id());
 511         trace_cpu_idle(PWR_EVENT_EXIT, smp_processor_id());
 512
 513 out:
 514         local_fiq_enable();
 515         local_irq_enable();
 516 }
 517
 518 #ifdef CONFIG_SUSPEND
 519 static int omap3_pm_suspend(void)
 520 {
 521         struct power_state *pwrst;
 522         int state, ret = 0;
 523
 524         if (wakeup_timer_seconds || wakeup_timer_milliseconds)
 525                 omap2_pm_wakeup_on_timer(wakeup_timer_seconds,
 526                                          wakeup_timer_milliseconds);
 527
 528         /* Read current next_pwrsts */
 529         list_for_each_entry(pwrst, &pwrst_list, node)
 530                 pwrst->saved_state = pwrdm_read_next_pwrst(pwrst->pwrdm);
 531         /* Set ones wanted by suspend */
 532         list_for_each_entry(pwrst, &pwrst_list, node) {
 533                 if (omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state))
 534                         goto restore;
 535                 if (pwrdm_clear_all_prev_pwrst(pwrst->pwrdm))
 536                         goto restore;
 537         }
 538
 539         omap_uart_prepare_suspend();
 540         omap3_intc_suspend();
 541
 542         omap_sram_idle();
 543
 544 restore:
 545         /* Restore next_pwrsts */
 546         list_for_each_entry(pwrst, &pwrst_list, node) {
 547                 state = pwrdm_read_prev_pwrst(pwrst->pwrdm);
 548                 if (state > pwrst->next_state) {
 549                         printk(KERN_INFO "Powerdomain (%s) didn't enter "
 550                                "target state %d\n",
 551                                pwrst->pwrdm->name, pwrst->next_state);
 552                         ret = -1;
 553                 }
 554                 omap_set_pwrdm_state(pwrst->pwrdm, pwrst->saved_state);
 555         }
 556         if (ret)
 557                 printk(KERN_ERR "Could not enter target state in pm_suspend\n");
 558         else
 559                 printk(KERN_INFO "Successfully put all powerdomains "
 560                        "to target state\n");
 561
 562         return ret;
 563 }
 564
 565 static int omap3_pm_enter(suspend_state_t unused)
 566 {
 567         int ret = 0;
 568
 569         switch (suspend_state) {
 570         case PM_SUSPEND_STANDBY:
 571         case PM_SUSPEND_MEM:
 572                 ret = omap3_pm_suspend();
 573                 break;
 574         default:
 575                 ret = -EINVAL;
 576         }
 577
 578         return ret;
 579 }
 580
 581 /* Hooks to enable / disable UART interrupts during suspend */
 582 static int omap3_pm_begin(suspend_state_t state)
 583 {
 584         disable_hlt();
 585         suspend_state = state;
 586         omap_uart_enable_irqs(0);
 587         return 0;
 588 }
 589
 590 static void omap3_pm_end(void)
 591 {
 592         suspend_state = PM_SUSPEND_ON;
 593         omap_uart_enable_irqs(1);
 594         enable_hlt();
 595         return;
 596 }
 597
 598 static const struct platform_suspend_ops omap_pm_ops = {
 599         .begin          = omap3_pm_begin,
 600         .end            = omap3_pm_end,
 601         .enter          = omap3_pm_enter,
 602         .valid          = suspend_valid_only_mem,
 603 };
 604 #endif /* CONFIG_SUSPEND */
 605
 606
 607 /**
 608  * omap3_iva_idle(): ensure IVA is in idle so it can be put into
 609  *                   retention
 610  *
 611  * In cases where IVA2 is activated by bootcode, it may prevent
 612  * full-chip retention or off-mode because it is not idle.  This
 613  * function forces the IVA2 into idle state so it can go
 614  * into retention/off and thus allow full-chip retention/off.
 615  *
 616  **/
 617 static void __init omap3_iva_idle(void)
 618 {
 619         /* ensure IVA2 clock is disabled */
 620         omap2_cm_write_mod_reg(0, OMAP3430_IVA2_MOD, CM_FCLKEN);
 621
 622         /* if no clock activity, nothing else to do */
 623         if (!(omap2_cm_read_mod_reg(OMAP3430_IVA2_MOD, OMAP3430_CM_CLKSTST) &
 624               OMAP3430_CLKACTIVITY_IVA2_MASK))
 625                 return;
 626
 627         /* Reset IVA2 */
 628         omap2_prm_write_mod_reg(OMAP3430_RST1_IVA2_MASK |
 629                           OMAP3430_RST2_IVA2_MASK |
 630                           OMAP3430_RST3_IVA2_MASK,
 631                           OMAP3430_IVA2_MOD, OMAP2_RM_RSTCTRL);
 632
 633         /* Enable IVA2 clock */
 634         omap2_cm_write_mod_reg(OMAP3430_CM_FCLKEN_IVA2_EN_IVA2_MASK,
 635                          OMAP3430_IVA2_MOD, CM_FCLKEN);
 636
 637         /* Set IVA2 boot mode to 'idle' */
 638         omap_ctrl_writel(OMAP3_IVA2_BOOTMOD_IDLE,
 639                          OMAP343X_CONTROL_IVA2_BOOTMOD);
 640
 641         /* Un-reset IVA2 */
 642         omap2_prm_write_mod_reg(0, OMAP3430_IVA2_MOD, OMAP2_RM_RSTCTRL);
 643
 644         /* Disable IVA2 clock */
 645         omap2_cm_write_mod_reg(0, OMAP3430_IVA2_MOD, CM_FCLKEN);
 646
 647         /* Reset IVA2 */
 648         omap2_prm_write_mod_reg(OMAP3430_RST1_IVA2_MASK |
 649                           OMAP3430_RST2_IVA2_MASK |
 650                           OMAP3430_RST3_IVA2_MASK,
 651                           OMAP3430_IVA2_MOD, OMAP2_RM_RSTCTRL);
 652 }
 653
 654 static void __init omap3_d2d_idle(void)
 655 {
 656         u16 mask, padconf;
 657
 658         /* In a stand alone OMAP3430 where there is not a stacked
 659          * modem for the D2D Idle Ack and D2D MStandby must be pulled
 660          * high. S CONTROL_PADCONF_SAD2D_IDLEACK and
 661          * CONTROL_PADCONF_SAD2D_MSTDBY to have a pull up. */
 662         mask = (1 << 4) | (1 << 3); /* pull-up, enabled */
 663         padconf = omap_ctrl_readw(OMAP3_PADCONF_SAD2D_MSTANDBY);
 664         padconf |= mask;
 665         omap_ctrl_writew(padconf, OMAP3_PADCONF_SAD2D_MSTANDBY);
 666
 667         padconf = omap_ctrl_readw(OMAP3_PADCONF_SAD2D_IDLEACK);
 668         padconf |= mask;
 669         omap_ctrl_writew(padconf, OMAP3_PADCONF_SAD2D_IDLEACK);
 670
 671         /* reset modem */
 672         omap2_prm_write_mod_reg(OMAP3430_RM_RSTCTRL_CORE_MODEM_SW_RSTPWRON_MASK |
 673                           OMAP3430_RM_RSTCTRL_CORE_MODEM_SW_RST_MASK,
 674                           CORE_MOD, OMAP2_RM_RSTCTRL);
 675         omap2_prm_write_mod_reg(0, CORE_MOD, OMAP2_RM_RSTCTRL);
 676 }
 677
 678 static void __init prcm_setup_regs(void)
 679 {
 680         u32 omap3630_en_uart4_mask = cpu_is_omap3630() ?
 681                                         OMAP3630_EN_UART4_MASK : 0;
 682         u32 omap3630_grpsel_uart4_mask = cpu_is_omap3630() ?
 683                                         OMAP3630_GRPSEL_UART4_MASK : 0;
 684
 685         /* XXX This should be handled by hwmod code or SCM init code */
 686         omap_ctrl_writel(OMAP3430_AUTOIDLE_MASK, OMAP2_CONTROL_SYSCONFIG);
 687
 688         /*
 689          * Enable control of expternal oscillator through
 690          * sys_clkreq. In the long run clock framework should
 691          * take care of this.
 692          */
 693         omap2_prm_rmw_mod_reg_bits(OMAP_AUTOEXTCLKMODE_MASK,
 694                              1 << OMAP_AUTOEXTCLKMODE_SHIFT,
 695                              OMAP3430_GR_MOD,
 696                              OMAP3_PRM_CLKSRC_CTRL_OFFSET);
 697
 698         /* setup wakup source */
 699         omap2_prm_write_mod_reg(OMAP3430_EN_IO_MASK | OMAP3430_EN_GPIO1_MASK |
 700                           OMAP3430_EN_GPT1_MASK | OMAP3430_EN_GPT12_MASK,
 701                           WKUP_MOD, PM_WKEN);
 702         /* No need to write EN_IO, that is always enabled */
 703         omap2_prm_write_mod_reg(OMAP3430_GRPSEL_GPIO1_MASK |
 704                           OMAP3430_GRPSEL_GPT1_MASK |
 705                           OMAP3430_GRPSEL_GPT12_MASK,
 706                           WKUP_MOD, OMAP3430_PM_MPUGRPSEL);
 707         /* For some reason IO doesn't generate wakeup event even if
 708          * it is selected to mpu wakeup goup */
 709         omap2_prm_write_mod_reg(OMAP3430_IO_EN_MASK | OMAP3430_WKUP_EN_MASK,
 710                           OCP_MOD, OMAP3_PRM_IRQENABLE_MPU_OFFSET);
 711
 712         /* Enable PM_WKEN to support DSS LPR */
 713         omap2_prm_write_mod_reg(OMAP3430_PM_WKEN_DSS_EN_DSS_MASK,
 714                                 OMAP3430_DSS_MOD, PM_WKEN);
 715
 716         /* Enable wakeups in PER */
 717         omap2_prm_write_mod_reg(omap3630_en_uart4_mask |
 718                           OMAP3430_EN_GPIO2_MASK | OMAP3430_EN_GPIO3_MASK |
 719                           OMAP3430_EN_GPIO4_MASK | OMAP3430_EN_GPIO5_MASK |
 720                           OMAP3430_EN_GPIO6_MASK | OMAP3430_EN_UART3_MASK |
 721                           OMAP3430_EN_MCBSP2_MASK | OMAP3430_EN_MCBSP3_MASK |
 722                           OMAP3430_EN_MCBSP4_MASK,
 723                           OMAP3430_PER_MOD, PM_WKEN);
 724         /* and allow them to wake up MPU */
 725         omap2_prm_write_mod_reg(omap3630_grpsel_uart4_mask |
 726                           OMAP3430_GRPSEL_GPIO2_MASK |
 727                           OMAP3430_GRPSEL_GPIO3_MASK |
 728                           OMAP3430_GRPSEL_GPIO4_MASK |
 729                           OMAP3430_GRPSEL_GPIO5_MASK |
 730                           OMAP3430_GRPSEL_GPIO6_MASK |
 731                           OMAP3430_GRPSEL_UART3_MASK |
 732                           OMAP3430_GRPSEL_MCBSP2_MASK |
 733                           OMAP3430_GRPSEL_MCBSP3_MASK |
 734                           OMAP3430_GRPSEL_MCBSP4_MASK,
 735                           OMAP3430_PER_MOD, OMAP3430_PM_MPUGRPSEL);
 736
 737         /* Don't attach IVA interrupts */
 738         omap2_prm_write_mod_reg(0, WKUP_MOD, OMAP3430_PM_IVAGRPSEL);
 739         omap2_prm_write_mod_reg(0, CORE_MOD, OMAP3430_PM_IVAGRPSEL1);
 740         omap2_prm_write_mod_reg(0, CORE_MOD, OMAP3430ES2_PM_IVAGRPSEL3);
 741         omap2_prm_write_mod_reg(0, OMAP3430_PER_MOD, OMAP3430_PM_IVAGRPSEL);
 742
 743         /* Clear any pending 'reset' flags */
 744         omap2_prm_write_mod_reg(0xffffffff, MPU_MOD, OMAP2_RM_RSTST);
 745         omap2_prm_write_mod_reg(0xffffffff, CORE_MOD, OMAP2_RM_RSTST);
 746         omap2_prm_write_mod_reg(0xffffffff, OMAP3430_PER_MOD, OMAP2_RM_RSTST);
 747         omap2_prm_write_mod_reg(0xffffffff, OMAP3430_EMU_MOD, OMAP2_RM_RSTST);
 748         omap2_prm_write_mod_reg(0xffffffff, OMAP3430_NEON_MOD, OMAP2_RM_RSTST);
 749         omap2_prm_write_mod_reg(0xffffffff, OMAP3430_DSS_MOD, OMAP2_RM_RSTST);
 750         omap2_prm_write_mod_reg(0xffffffff, OMAP3430ES2_USBHOST_MOD, OMAP2_RM_RSTST);
 751
 752         /* Clear any pending PRCM interrupts */
 753         omap2_prm_write_mod_reg(0, OCP_MOD, OMAP3_PRM_IRQSTATUS_MPU_OFFSET);
 754
 755         omap3_iva_idle();
 756         omap3_d2d_idle();
 757 }
 758
 759 void omap3_pm_off_mode_enable(int enable)
 760 {
 761         struct power_state *pwrst;
 762         u32 state;
 763
 764         if (enable)
 765                 state = PWRDM_POWER_OFF;
 766         else
 767                 state = PWRDM_POWER_RET;
 768
 769         list_for_each_entry(pwrst, &pwrst_list, node) {
 770                 if (IS_PM34XX_ERRATUM(PM_SDRC_WAKEUP_ERRATUM_i583) &&
 771                                 pwrst->pwrdm == core_pwrdm &&
 772                                 state == PWRDM_POWER_OFF) {
 773                         pwrst->next_state = PWRDM_POWER_RET;
 774                         pr_warn("%s: Core OFF disabled due to errata i583\n",
 775                                 __func__);
 776                 } else {
 777                         pwrst->next_state = state;
 778                 }
 779                 omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state);
 780         }
 781 }
 782
 783 int omap3_pm_get_suspend_state(struct powerdomain *pwrdm)
 784 {
 785         struct power_state *pwrst;
 786
 787         list_for_each_entry(pwrst, &pwrst_list, node) {
 788                 if (pwrst->pwrdm == pwrdm)
 789                         return pwrst->next_state;
 790         }
 791         return -EINVAL;
 792 }
 793
 794 int omap3_pm_set_suspend_state(struct powerdomain *pwrdm, int state)
 795 {
 796         struct power_state *pwrst;
 797
 798         list_for_each_entry(pwrst, &pwrst_list, node) {
 799                 if (pwrst->pwrdm == pwrdm) {
 800                         pwrst->next_state = state;
 801                         return 0;
 802                 }
 803         }
 804         return -EINVAL;
 805 }
 806
 807 static int __init pwrdms_setup(struct powerdomain *pwrdm, void *unused)
 808 {
 809         struct power_state *pwrst;
 810
 811         if (!pwrdm->pwrsts)
 812                 return 0;
 813
 814         pwrst = kmalloc(sizeof(struct power_state), GFP_ATOMIC);
 815         if (!pwrst)
 816                 return -ENOMEM;
 817         pwrst->pwrdm = pwrdm;
 818         pwrst->next_state = PWRDM_POWER_RET;
 819         list_add(&pwrst->node, &pwrst_list);
 820
 821         if (pwrdm_has_hdwr_sar(pwrdm))
 822                 pwrdm_enable_hdwr_sar(pwrdm);
 823
 824         return omap_set_pwrdm_state(pwrst->pwrdm, pwrst->next_state);
 825 }
 826
 827 /*
 828  * Enable hw supervised mode for all clockdomains if it's
 829  * supported. Initiate sleep transition for other clockdomains, if
 830  * they are not used
 831  */
 832 static int __init clkdms_setup(struct clockdomain *clkdm, void *unused)
 833 {
 834         if (clkdm->flags & CLKDM_CAN_ENABLE_AUTO)
 835                 clkdm_allow_idle(clkdm);
 836         else if (clkdm->flags & CLKDM_CAN_FORCE_SLEEP &&
 837                  atomic_read(&clkdm->usecount) == 0)
 838                 clkdm_sleep(clkdm);
 839         return 0;
 840 }
 841
 842 /*
 843  * Push functions to SRAM
 844  *
 845  * The minimum set of functions is pushed to SRAM for execution:
 846  * - omap3_do_wfi for erratum i581 WA,
 847  * - save_secure_ram_context for security extensions.
 848  */
 849 void omap_push_sram_idle(void)
 850 {
 851         omap3_do_wfi_sram = omap_sram_push(omap3_do_wfi, omap3_do_wfi_sz);
 852
 853         if (omap_type() != OMAP2_DEVICE_TYPE_GP)
 854                 _omap_save_secure_sram = omap_sram_push(save_secure_ram_context,
 855                                 save_secure_ram_context_sz);
 856 }
 857
 858 static void __init pm_errata_configure(void)
 859 {
 860         if (cpu_is_omap3630()) {
 861                 pm34xx_errata |= PM_RTA_ERRATUM_i608;
 862                 /* Enable the l2 cache toggling in sleep logic */
 863                 enable_omap3630_toggle_l2_on_restore();
 864                 if (omap_rev() < OMAP3630_REV_ES1_2)
 865                         pm34xx_errata |= PM_SDRC_WAKEUP_ERRATUM_i583;
 866         }
 867 }
 868
 869 static int __init omap3_pm_init(void)
 870 {
 871         struct power_state *pwrst, *tmp;
 872         struct clockdomain *neon_clkdm, *per_clkdm, *mpu_clkdm, *core_clkdm;
 873         int ret;
 874
 875         if (!cpu_is_omap34xx())
 876                 return -ENODEV;
 877
 878         pm_errata_configure();
 879
 880         /* XXX prcm_setup_regs needs to be before enabling hw
 881          * supervised mode for powerdomains */
 882         prcm_setup_regs();
 883
 884         ret = request_irq(INT_34XX_PRCM_MPU_IRQ,
 885                           (irq_handler_t)prcm_interrupt_handler,
 886                           IRQF_DISABLED, "prcm", NULL);
 887         if (ret) {
 888                 printk(KERN_ERR "request_irq failed to register for 0x%x\n",
 889                        INT_34XX_PRCM_MPU_IRQ);
 890                 goto err1;
 891         }
 892
 893         ret = pwrdm_for_each(pwrdms_setup, NULL);
 894         if (ret) {
 895                 printk(KERN_ERR "Failed to setup powerdomains\n");
 896                 goto err2;
 897         }
 898
 899         (void) clkdm_for_each(clkdms_setup, NULL);
 900
 901         mpu_pwrdm = pwrdm_lookup("mpu_pwrdm");
 902         if (mpu_pwrdm == NULL) {
 903                 printk(KERN_ERR "Failed to get mpu_pwrdm\n");
 904                 goto err2;
 905         }
 906
 907         neon_pwrdm = pwrdm_lookup("neon_pwrdm");
 908         per_pwrdm = pwrdm_lookup("per_pwrdm");
 909         core_pwrdm = pwrdm_lookup("core_pwrdm");
 910         cam_pwrdm = pwrdm_lookup("cam_pwrdm");
 911
 912         neon_clkdm = clkdm_lookup("neon_clkdm");
 913         mpu_clkdm = clkdm_lookup("mpu_clkdm");
 914         per_clkdm = clkdm_lookup("per_clkdm");
 915         core_clkdm = clkdm_lookup("core_clkdm");
 916
 917 #ifdef CONFIG_SUSPEND
 918         suspend_set_ops(&omap_pm_ops);
 919 #endif /* CONFIG_SUSPEND */
 920
 921         pm_idle = omap3_pm_idle;
 922         omap3_idle_init();
 923
 924         /*
 925          * RTA is disabled during initialization as per erratum i608
 926          * it is safer to disable RTA by the bootloader, but we would like
 927          * to be doubly sure here and prevent any mishaps.
 928          */
 929         if (IS_PM34XX_ERRATUM(PM_RTA_ERRATUM_i608))
 930                 omap3630_ctrl_disable_rta();
 931
 932         clkdm_add_wkdep(neon_clkdm, mpu_clkdm);
 933         if (omap_type() != OMAP2_DEVICE_TYPE_GP) {
 934                 omap3_secure_ram_storage =
 935                         kmalloc(0x803F, GFP_KERNEL);
 936                 if (!omap3_secure_ram_storage)
 937                         printk(KERN_ERR "Memory allocation failed when"
 938                                         "allocating for secure sram context\n");
 939
 940                 local_irq_disable();
 941                 local_fiq_disable();
 942
 943                 omap_dma_global_context_save();
 944                 omap3_save_secure_ram_context();
 945                 omap_dma_global_context_restore();
 946
 947                 local_irq_enable();
 948                 local_fiq_enable();
 949         }
 950
 951         omap3_save_scratchpad_contents();
 952 err1:
 953         return ret;
 954 err2:
 955         free_irq(INT_34XX_PRCM_MPU_IRQ, NULL);
 956         list_for_each_entry_safe(pwrst, tmp, &pwrst_list, node) {
 957                 list_del(&pwrst->node);
 958                 kfree(pwrst);
 959         }
 960         return ret;
 961 }
 962
 963 late_initcall(omap3_pm_init);