ARM: OMAP5 / DRA7: PM: Provide a dummy startup function for CPU hotplug
[linux-block.git] / arch / arm / mach-omap2 / omap-mpuss-lowpower.c
CommitLineData
b2b9762f
SS
1/*
2 * OMAP MPUSS low power code
3 *
4 * Copyright (C) 2011 Texas Instruments, Inc.
5 * Santosh Shilimkar <santosh.shilimkar@ti.com>
6 *
7 * OMAP4430 MPUSS mainly consists of dual Cortex-A9 with per-CPU
8 * Local timer and Watchdog, GIC, SCU, PL310 L2 cache controller,
9 * CPU0 and CPU1 LPRM modules.
10 * CPU0, CPU1 and MPUSS each have there own power domain and
11 * hence multiple low power combinations of MPUSS are possible.
12 *
13 * The CPU0 and CPU1 can't support Closed switch Retention (CSWR)
14 * because the mode is not supported by hw constraints of dormant
15 * mode. While waking up from the dormant mode, a reset signal
16 * to the Cortex-A9 processor must be asserted by the external
17 * power controller.
18 *
19 * With architectural inputs and hardware recommendations, only
20 * below modes are supported from power gain vs latency point of view.
21 *
22 * CPU0 CPU1 MPUSS
23 * ----------------------------------------------
24 * ON ON ON
25 * ON(Inactive) OFF ON(Inactive)
26 * OFF OFF CSWR
3ba2a739
SS
27 * OFF OFF OSWR
28 * OFF OFF OFF(Device OFF *TBD)
b2b9762f
SS
29 * ----------------------------------------------
30 *
31 * Note: CPU0 is the master core and it is the last CPU to go down
32 * and first to wake-up when MPUSS low power states are excercised
33 *
34 *
35 * This program is free software; you can redistribute it and/or modify
36 * it under the terms of the GNU General Public License version 2 as
37 * published by the Free Software Foundation.
38 */
39
40#include <linux/kernel.h>
41#include <linux/io.h>
42#include <linux/errno.h>
43#include <linux/linkage.h>
44#include <linux/smp.h>
45
46#include <asm/cacheflush.h>
47#include <asm/tlbflush.h>
48#include <asm/smp_scu.h>
b2b9762f
SS
49#include <asm/pgalloc.h>
50#include <asm/suspend.h>
5e94c6e3 51#include <asm/hardware/cache-l2x0.h>
b2b9762f 52
e4c060db 53#include "soc.h"
b2b9762f 54#include "common.h"
c49f34bc 55#include "omap44xx.h"
b2b9762f
SS
56#include "omap4-sar-layout.h"
57#include "pm.h"
3ba2a739 58#include "prcm_mpu44xx.h"
a89726d3 59#include "prcm_mpu54xx.h"
3ba2a739
SS
60#include "prminst44xx.h"
61#include "prcm44xx.h"
62#include "prm44xx.h"
63#include "prm-regbits-44xx.h"
b2b9762f
SS
64
65#ifdef CONFIG_SMP
66
67struct omap4_cpu_pm_info {
68 struct powerdomain *pwrdm;
69 void __iomem *scu_sar_addr;
70 void __iomem *wkup_sar_addr;
5e94c6e3 71 void __iomem *l2x0_sar_addr;
b2b9762f
SS
72};
73
9f192cf7
SS
74/**
75 * struct cpu_pm_ops - CPU pm operations
76 * @finish_suspend: CPU suspend finisher function pointer
77 * @resume: CPU resume function pointer
78 * @scu_prepare: CPU Snoop Control program function pointer
e97c4eb3 79 * @hotplug_restart: CPU restart function pointer
9f192cf7
SS
80 *
81 * Structure holds functions pointer for CPU low power operations like
82 * suspend, resume and scu programming.
83 */
84struct cpu_pm_ops {
85 int (*finish_suspend)(unsigned long cpu_state);
86 void (*resume)(void);
87 void (*scu_prepare)(unsigned int cpu_id, unsigned int cpu_state);
e97c4eb3 88 void (*hotplug_restart)(void);
9f192cf7
SS
89};
90
b2b9762f 91static DEFINE_PER_CPU(struct omap4_cpu_pm_info, omap4_pm_info);
e44f9a77 92static struct powerdomain *mpuss_pd;
5e94c6e3 93static void __iomem *sar_base;
a89726d3 94static u32 cpu_context_offset;
b2b9762f 95
9f192cf7
SS
96static int default_finish_suspend(unsigned long cpu_state)
97{
98 omap_do_wfi();
99 return 0;
100}
101
102static void dummy_cpu_resume(void)
103{}
104
105static void dummy_scu_prepare(unsigned int cpu_id, unsigned int cpu_state)
106{}
107
108struct cpu_pm_ops omap_pm_ops = {
109 .finish_suspend = default_finish_suspend,
110 .resume = dummy_cpu_resume,
111 .scu_prepare = dummy_scu_prepare,
e97c4eb3 112 .hotplug_restart = dummy_cpu_resume,
9f192cf7
SS
113};
114
b2b9762f
SS
115/*
116 * Program the wakeup routine address for the CPU0 and CPU1
117 * used for OFF or DORMANT wakeup.
118 */
119static inline void set_cpu_wakeup_addr(unsigned int cpu_id, u32 addr)
120{
121 struct omap4_cpu_pm_info *pm_info = &per_cpu(omap4_pm_info, cpu_id);
122
325f29da
RN
123 if (pm_info->wkup_sar_addr)
124 writel_relaxed(addr, pm_info->wkup_sar_addr);
b2b9762f
SS
125}
126
b2b9762f
SS
127/*
128 * Store the SCU power status value to scratchpad memory
129 */
130static void scu_pwrst_prepare(unsigned int cpu_id, unsigned int cpu_state)
131{
132 struct omap4_cpu_pm_info *pm_info = &per_cpu(omap4_pm_info, cpu_id);
133 u32 scu_pwr_st;
134
135 switch (cpu_state) {
136 case PWRDM_POWER_RET:
137 scu_pwr_st = SCU_PM_DORMANT;
138 break;
139 case PWRDM_POWER_OFF:
140 scu_pwr_st = SCU_PM_POWEROFF;
141 break;
142 case PWRDM_POWER_ON:
143 case PWRDM_POWER_INACTIVE:
144 default:
145 scu_pwr_st = SCU_PM_NORMAL;
146 break;
147 }
148
325f29da
RN
149 if (pm_info->scu_sar_addr)
150 writel_relaxed(scu_pwr_st, pm_info->scu_sar_addr);
b2b9762f
SS
151}
152
3ba2a739
SS
153/* Helper functions for MPUSS OSWR */
154static inline void mpuss_clear_prev_logic_pwrst(void)
155{
156 u32 reg;
157
158 reg = omap4_prminst_read_inst_reg(OMAP4430_PRM_PARTITION,
159 OMAP4430_PRM_MPU_INST, OMAP4_RM_MPU_MPU_CONTEXT_OFFSET);
160 omap4_prminst_write_inst_reg(reg, OMAP4430_PRM_PARTITION,
161 OMAP4430_PRM_MPU_INST, OMAP4_RM_MPU_MPU_CONTEXT_OFFSET);
162}
163
164static inline void cpu_clear_prev_logic_pwrst(unsigned int cpu_id)
165{
166 u32 reg;
167
168 if (cpu_id) {
169 reg = omap4_prcm_mpu_read_inst_reg(OMAP4430_PRCM_MPU_CPU1_INST,
a89726d3 170 cpu_context_offset);
3ba2a739 171 omap4_prcm_mpu_write_inst_reg(reg, OMAP4430_PRCM_MPU_CPU1_INST,
a89726d3 172 cpu_context_offset);
3ba2a739
SS
173 } else {
174 reg = omap4_prcm_mpu_read_inst_reg(OMAP4430_PRCM_MPU_CPU0_INST,
a89726d3 175 cpu_context_offset);
3ba2a739 176 omap4_prcm_mpu_write_inst_reg(reg, OMAP4430_PRCM_MPU_CPU0_INST,
a89726d3 177 cpu_context_offset);
3ba2a739
SS
178 }
179}
180
5e94c6e3
SS
181/*
182 * Store the CPU cluster state for L2X0 low power operations.
183 */
184static void l2x0_pwrst_prepare(unsigned int cpu_id, unsigned int save_state)
185{
186 struct omap4_cpu_pm_info *pm_info = &per_cpu(omap4_pm_info, cpu_id);
187
325f29da
RN
188 if (pm_info->l2x0_sar_addr)
189 writel_relaxed(save_state, pm_info->l2x0_sar_addr);
5e94c6e3
SS
190}
191
192/*
193 * Save the L2X0 AUXCTRL and POR value to SAR memory. Its used to
194 * in every restore MPUSS OFF path.
195 */
196#ifdef CONFIG_CACHE_L2X0
7a09b28e 197static void __init save_l2x0_context(void)
5e94c6e3 198{
325f29da
RN
199 void __iomem *l2x0_base = omap4_get_l2cache_base();
200
201 if (l2x0_base && sar_base) {
202 writel_relaxed(l2x0_saved_regs.aux_ctrl,
203 sar_base + L2X0_AUXCTRL_OFFSET);
204 writel_relaxed(l2x0_saved_regs.prefetch_ctrl,
205 sar_base + L2X0_PREFETCH_CTRL_OFFSET);
206 }
5e94c6e3
SS
207}
208#else
7a09b28e 209static void __init save_l2x0_context(void)
5e94c6e3
SS
210{}
211#endif
212
b2b9762f
SS
213/**
214 * omap4_enter_lowpower: OMAP4 MPUSS Low Power Entry Function
215 * The purpose of this function is to manage low power programming
216 * of OMAP4 MPUSS subsystem
217 * @cpu : CPU ID
218 * @power_state: Low power state.
e44f9a77
SS
219 *
220 * MPUSS states for the context save:
221 * save_state =
222 * 0 - Nothing lost and no need to save: MPUSS INACTIVE
223 * 1 - CPUx L1 and logic lost: MPUSS CSWR
224 * 2 - CPUx L1 and logic lost + GIC lost: MPUSS OSWR
225 * 3 - CPUx L1 and logic lost + GIC + L2 lost: DEVICE OFF
b2b9762f
SS
226 */
227int omap4_enter_lowpower(unsigned int cpu, unsigned int power_state)
228{
32d174ed 229 struct omap4_cpu_pm_info *pm_info = &per_cpu(omap4_pm_info, cpu);
b2b9762f
SS
230 unsigned int save_state = 0;
231 unsigned int wakeup_cpu;
232
233 if (omap_rev() == OMAP4430_REV_ES1_0)
234 return -ENXIO;
235
236 switch (power_state) {
237 case PWRDM_POWER_ON:
238 case PWRDM_POWER_INACTIVE:
239 save_state = 0;
240 break;
241 case PWRDM_POWER_OFF:
242 save_state = 1;
243 break;
244 case PWRDM_POWER_RET:
245 default:
246 /*
247 * CPUx CSWR is invalid hardware state. Also CPUx OSWR
248 * doesn't make much scense, since logic is lost and $L1
249 * needs to be cleaned because of coherency. This makes
250 * CPUx OSWR equivalent to CPUX OFF and hence not supported
251 */
252 WARN_ON(1);
253 return -ENXIO;
254 }
255
e0555489 256 pwrdm_pre_transition(NULL);
49404dd0 257
3ba2a739
SS
258 /*
259 * Check MPUSS next state and save interrupt controller if needed.
260 * In MPUSS OSWR or device OFF, interrupt controller contest is lost.
261 */
262 mpuss_clear_prev_logic_pwrst();
3ba2a739
SS
263 if ((pwrdm_read_next_pwrst(mpuss_pd) == PWRDM_POWER_RET) &&
264 (pwrdm_read_logic_retst(mpuss_pd) == PWRDM_POWER_OFF))
265 save_state = 2;
266
3ba2a739 267 cpu_clear_prev_logic_pwrst(cpu);
32d174ed 268 pwrdm_set_next_pwrst(pm_info->pwrdm, power_state);
9f192cf7
SS
269 set_cpu_wakeup_addr(cpu, virt_to_phys(omap_pm_ops.resume));
270 omap_pm_ops.scu_prepare(cpu, power_state);
5e94c6e3 271 l2x0_pwrst_prepare(cpu, save_state);
b2b9762f
SS
272
273 /*
274 * Call low level function with targeted low power state.
275 */
72433eba 276 if (save_state)
9f192cf7 277 cpu_suspend(save_state, omap_pm_ops.finish_suspend);
72433eba 278 else
9f192cf7 279 omap_pm_ops.finish_suspend(save_state);
b2b9762f 280
74ed7bdc
SG
281 if (IS_PM44XX_ERRATUM(PM_OMAP4_ROM_SMP_BOOT_ERRATUM_GICD) && cpu)
282 gic_dist_enable();
283
b2b9762f
SS
284 /*
285 * Restore the CPUx power state to ON otherwise CPUx
286 * power domain can transitions to programmed low power
287 * state while doing WFI outside the low powe code. On
288 * secure devices, CPUx does WFI which can result in
289 * domain transition
290 */
291 wakeup_cpu = smp_processor_id();
32d174ed 292 pwrdm_set_next_pwrst(pm_info->pwrdm, PWRDM_POWER_ON);
b2b9762f 293
e0555489 294 pwrdm_post_transition(NULL);
49404dd0 295
b2b9762f
SS
296 return 0;
297}
298
b5b4f288
SS
299/**
300 * omap4_hotplug_cpu: OMAP4 CPU hotplug entry
301 * @cpu : CPU ID
302 * @power_state: CPU low power state.
303 */
8bd26e3a 304int omap4_hotplug_cpu(unsigned int cpu, unsigned int power_state)
b5b4f288 305{
ff999b8a 306 struct omap4_cpu_pm_info *pm_info = &per_cpu(omap4_pm_info, cpu);
32d174ed 307 unsigned int cpu_state = 0;
b5b4f288
SS
308
309 if (omap_rev() == OMAP4430_REV_ES1_0)
310 return -ENXIO;
311
312 if (power_state == PWRDM_POWER_OFF)
313 cpu_state = 1;
314
32d174ed
PW
315 pwrdm_clear_all_prev_pwrst(pm_info->pwrdm);
316 pwrdm_set_next_pwrst(pm_info->pwrdm, power_state);
e97c4eb3 317 set_cpu_wakeup_addr(cpu, virt_to_phys(omap_pm_ops.hotplug_restart));
9f192cf7 318 omap_pm_ops.scu_prepare(cpu, power_state);
b5b4f288
SS
319
320 /*
260db902 321 * CPU never retuns back if targeted power state is OFF mode.
b5b4f288 322 * CPU ONLINE follows normal CPU ONLINE ptah via
baf4b7d3 323 * omap4_secondary_startup().
b5b4f288 324 */
9f192cf7 325 omap_pm_ops.finish_suspend(cpu_state);
b5b4f288 326
32d174ed 327 pwrdm_set_next_pwrst(pm_info->pwrdm, PWRDM_POWER_ON);
b5b4f288
SS
328 return 0;
329}
330
331
6d846c46
SS
332/*
333 * Enable Mercury Fast HG retention mode by default.
334 */
335static void enable_mercury_retention_mode(void)
336{
337 u32 reg;
338
339 reg = omap4_prcm_mpu_read_inst_reg(OMAP54XX_PRCM_MPU_DEVICE_INST,
340 OMAP54XX_PRCM_MPU_PRM_PSCON_COUNT_OFFSET);
341 /* Enable HG_EN, HG_RAMPUP = fast mode */
342 reg |= BIT(24) | BIT(25);
343 omap4_prcm_mpu_write_inst_reg(reg, OMAP54XX_PRCM_MPU_DEVICE_INST,
344 OMAP54XX_PRCM_MPU_PRM_PSCON_COUNT_OFFSET);
345}
346
b2b9762f
SS
347/*
348 * Initialise OMAP4 MPUSS
349 */
350int __init omap4_mpuss_init(void)
351{
352 struct omap4_cpu_pm_info *pm_info;
b2b9762f
SS
353
354 if (omap_rev() == OMAP4430_REV_ES1_0) {
355 WARN(1, "Power Management not supported on OMAP4430 ES1.0\n");
356 return -ENODEV;
357 }
358
325f29da
RN
359 if (cpu_is_omap44xx())
360 sar_base = omap4_get_sar_ram_base();
5e94c6e3 361
b2b9762f
SS
362 /* Initilaise per CPU PM information */
363 pm_info = &per_cpu(omap4_pm_info, 0x0);
325f29da
RN
364 if (sar_base) {
365 pm_info->scu_sar_addr = sar_base + SCU_OFFSET0;
366 pm_info->wkup_sar_addr = sar_base +
367 CPU0_WAKEUP_NS_PA_ADDR_OFFSET;
368 pm_info->l2x0_sar_addr = sar_base + L2X0_SAVE_OFFSET0;
369 }
b2b9762f
SS
370 pm_info->pwrdm = pwrdm_lookup("cpu0_pwrdm");
371 if (!pm_info->pwrdm) {
372 pr_err("Lookup failed for CPU0 pwrdm\n");
373 return -ENODEV;
374 }
375
376 /* Clear CPU previous power domain state */
377 pwrdm_clear_all_prev_pwrst(pm_info->pwrdm);
3ba2a739 378 cpu_clear_prev_logic_pwrst(0);
b2b9762f
SS
379
380 /* Initialise CPU0 power domain state to ON */
381 pwrdm_set_next_pwrst(pm_info->pwrdm, PWRDM_POWER_ON);
382
383 pm_info = &per_cpu(omap4_pm_info, 0x1);
325f29da
RN
384 if (sar_base) {
385 pm_info->scu_sar_addr = sar_base + SCU_OFFSET1;
386 pm_info->wkup_sar_addr = sar_base +
387 CPU1_WAKEUP_NS_PA_ADDR_OFFSET;
388 pm_info->l2x0_sar_addr = sar_base + L2X0_SAVE_OFFSET1;
389 }
ff999b8a 390
b2b9762f
SS
391 pm_info->pwrdm = pwrdm_lookup("cpu1_pwrdm");
392 if (!pm_info->pwrdm) {
393 pr_err("Lookup failed for CPU1 pwrdm\n");
394 return -ENODEV;
395 }
396
397 /* Clear CPU previous power domain state */
398 pwrdm_clear_all_prev_pwrst(pm_info->pwrdm);
3ba2a739 399 cpu_clear_prev_logic_pwrst(1);
b2b9762f
SS
400
401 /* Initialise CPU1 power domain state to ON */
402 pwrdm_set_next_pwrst(pm_info->pwrdm, PWRDM_POWER_ON);
403
e44f9a77
SS
404 mpuss_pd = pwrdm_lookup("mpu_pwrdm");
405 if (!mpuss_pd) {
406 pr_err("Failed to lookup MPUSS power domain\n");
407 return -ENODEV;
408 }
409 pwrdm_clear_all_prev_pwrst(mpuss_pd);
3ba2a739 410 mpuss_clear_prev_logic_pwrst();
e44f9a77 411
325f29da
RN
412 if (sar_base) {
413 /* Save device type on scratchpad for low level code to use */
414 writel_relaxed((omap_type() != OMAP2_DEVICE_TYPE_GP) ? 1 : 0,
415 sar_base + OMAP_TYPE_OFFSET);
416 save_l2x0_context();
417 }
5e94c6e3 418
9f192cf7
SS
419 if (cpu_is_omap44xx()) {
420 omap_pm_ops.finish_suspend = omap4_finish_suspend;
421 omap_pm_ops.resume = omap4_cpu_resume;
422 omap_pm_ops.scu_prepare = scu_pwrst_prepare;
e97c4eb3 423 omap_pm_ops.hotplug_restart = omap4_secondary_startup;
a89726d3
SS
424 cpu_context_offset = OMAP4_RM_CPU0_CPU0_CONTEXT_OFFSET;
425 } else if (soc_is_omap54xx() || soc_is_dra7xx()) {
426 cpu_context_offset = OMAP54XX_RM_CPU0_CPU0_CONTEXT_OFFSET;
6d846c46 427 enable_mercury_retention_mode();
9f192cf7
SS
428 }
429
e97c4eb3
SS
430 if (cpu_is_omap446x())
431 omap_pm_ops.hotplug_restart = omap4460_secondary_startup;
432
b2b9762f
SS
433 return 0;
434}
435
436#endif