2 * Copyright 2011-2014 Freescale Semiconductor, Inc.
3 * Copyright 2011 Linaro Ltd.
5 * The code contained herein is licensed under the GNU General Public
6 * License. You may obtain a copy of the GNU General Public License
7 * Version 2 or later at the following locations:
9 * http://www.opensource.org/licenses/gpl-license.html
10 * http://www.gnu.org/copyleft/gpl.html
13 #include <linux/delay.h>
14 #include <linux/init.h>
16 #include <linux/irq.h>
17 #include <linux/genalloc.h>
18 #include <linux/irqchip/arm-gic.h>
19 #include <linux/mfd/syscon.h>
20 #include <linux/mfd/syscon/imx6q-iomuxc-gpr.h>
22 #include <linux/of_address.h>
23 #include <linux/of_platform.h>
24 #include <linux/regmap.h>
25 #include <linux/suspend.h>
26 #include <asm/cacheflush.h>
27 #include <asm/fncpy.h>
28 #include <asm/proc-fns.h>
29 #include <asm/suspend.h>
36 #define BM_CCR_WB_COUNT (0x7 << 16)
37 #define BM_CCR_RBC_BYPASS_COUNT (0x3f << 21)
38 #define BM_CCR_RBC_EN (0x1 << 27)
41 #define BP_CLPCR_LPM 0
42 #define BM_CLPCR_LPM (0x3 << 0)
43 #define BM_CLPCR_BYPASS_PMIC_READY (0x1 << 2)
44 #define BM_CLPCR_ARM_CLK_DIS_ON_LPM (0x1 << 5)
45 #define BM_CLPCR_SBYOS (0x1 << 6)
46 #define BM_CLPCR_DIS_REF_OSC (0x1 << 7)
47 #define BM_CLPCR_VSTBY (0x1 << 8)
48 #define BP_CLPCR_STBY_COUNT 9
49 #define BM_CLPCR_STBY_COUNT (0x3 << 9)
50 #define BM_CLPCR_COSC_PWRDOWN (0x1 << 11)
51 #define BM_CLPCR_WB_PER_AT_LPM (0x1 << 16)
52 #define BM_CLPCR_WB_CORE_AT_LPM (0x1 << 17)
53 #define BM_CLPCR_BYP_MMDC_CH0_LPM_HS (0x1 << 19)
54 #define BM_CLPCR_BYP_MMDC_CH1_LPM_HS (0x1 << 21)
55 #define BM_CLPCR_MASK_CORE0_WFI (0x1 << 22)
56 #define BM_CLPCR_MASK_CORE1_WFI (0x1 << 23)
57 #define BM_CLPCR_MASK_CORE2_WFI (0x1 << 24)
58 #define BM_CLPCR_MASK_CORE3_WFI (0x1 << 25)
59 #define BM_CLPCR_MASK_SCU_IDLE (0x1 << 26)
60 #define BM_CLPCR_MASK_L2CC_IDLE (0x1 << 27)
63 #define BM_CGPR_INT_MEM_CLK_LPM (0x1 << 17)
65 #define MX6Q_SUSPEND_OCRAM_SIZE 0x1000
66 #define MX6_MAX_MMDC_IO_NUM 33
68 static void __iomem *ccm_base;
69 static void __iomem *suspend_ocram_base;
70 static void (*imx6_suspend_in_ocram_fn)(void __iomem *ocram_vbase);
73 * suspend ocram space layout:
74 * ======================== high address ======================
82 * PM_INFO structure(imx6_cpu_pm_info)
83 * ======================== low address =======================
91 struct imx6_pm_socdata {
93 const char *mmdc_compat;
94 const char *src_compat;
95 const char *iomuxc_compat;
96 const char *gpc_compat;
97 const char *pl310_compat;
98 const u32 mmdc_io_num;
99 const u32 *mmdc_io_offset;
102 static const u32 imx6q_mmdc_io_offset[] __initconst = {
103 0x5ac, 0x5b4, 0x528, 0x520, /* DQM0 ~ DQM3 */
104 0x514, 0x510, 0x5bc, 0x5c4, /* DQM4 ~ DQM7 */
105 0x56c, 0x578, 0x588, 0x594, /* CAS, RAS, SDCLK_0, SDCLK_1 */
106 0x5a8, 0x5b0, 0x524, 0x51c, /* SDQS0 ~ SDQS3 */
107 0x518, 0x50c, 0x5b8, 0x5c0, /* SDQS4 ~ SDQS7 */
108 0x784, 0x788, 0x794, 0x79c, /* GPR_B0DS ~ GPR_B3DS */
109 0x7a0, 0x7a4, 0x7a8, 0x748, /* GPR_B4DS ~ GPR_B7DS */
110 0x59c, 0x5a0, 0x750, 0x774, /* SODT0, SODT1, MODE_CTL, MODE */
111 0x74c, /* GPR_ADDS */
114 static const u32 imx6dl_mmdc_io_offset[] __initconst = {
115 0x470, 0x474, 0x478, 0x47c, /* DQM0 ~ DQM3 */
116 0x480, 0x484, 0x488, 0x48c, /* DQM4 ~ DQM7 */
117 0x464, 0x490, 0x4ac, 0x4b0, /* CAS, RAS, SDCLK_0, SDCLK_1 */
118 0x4bc, 0x4c0, 0x4c4, 0x4c8, /* DRAM_SDQS0 ~ DRAM_SDQS3 */
119 0x4cc, 0x4d0, 0x4d4, 0x4d8, /* DRAM_SDQS4 ~ DRAM_SDQS7 */
120 0x764, 0x770, 0x778, 0x77c, /* GPR_B0DS ~ GPR_B3DS */
121 0x780, 0x784, 0x78c, 0x748, /* GPR_B4DS ~ GPR_B7DS */
122 0x4b4, 0x4b8, 0x750, 0x760, /* SODT0, SODT1, MODE_CTL, MODE */
123 0x74c, /* GPR_ADDS */
126 static const u32 imx6sl_mmdc_io_offset[] __initconst = {
127 0x30c, 0x310, 0x314, 0x318, /* DQM0 ~ DQM3 */
128 0x5c4, 0x5cc, 0x5d4, 0x5d8, /* GPR_B0DS ~ GPR_B3DS */
129 0x300, 0x31c, 0x338, 0x5ac, /* CAS, RAS, SDCLK_0, GPR_ADDS */
130 0x33c, 0x340, 0x5b0, 0x5c0, /* SODT0, SODT1, MODE_CTL, MODE */
131 0x330, 0x334, 0x320, /* SDCKE0, SDCKE1, RESET */
134 static const u32 imx6sx_mmdc_io_offset[] __initconst = {
135 0x2ec, 0x2f0, 0x2f4, 0x2f8, /* DQM0 ~ DQM3 */
136 0x60c, 0x610, 0x61c, 0x620, /* GPR_B0DS ~ GPR_B3DS */
137 0x300, 0x2fc, 0x32c, 0x5f4, /* CAS, RAS, SDCLK_0, GPR_ADDS */
138 0x310, 0x314, 0x5f8, 0x608, /* SODT0, SODT1, MODE_CTL, MODE */
139 0x330, 0x334, 0x338, 0x33c, /* SDQS0 ~ SDQS3 */
142 static const u32 imx6ul_mmdc_io_offset[] __initconst = {
143 0x244, 0x248, 0x24c, 0x250, /* DQM0, DQM1, RAS, CAS */
144 0x27c, 0x498, 0x4a4, 0x490, /* SDCLK0, GPR_B0DS-B1DS, GPR_ADDS */
145 0x280, 0x284, 0x260, 0x264, /* SDQS0~1, SODT0, SODT1 */
146 0x494, 0x4b0, /* MODE_CTL, MODE, */
149 static const struct imx6_pm_socdata imx6q_pm_data __initconst = {
150 .mmdc_compat = "fsl,imx6q-mmdc",
151 .src_compat = "fsl,imx6q-src",
152 .iomuxc_compat = "fsl,imx6q-iomuxc",
153 .gpc_compat = "fsl,imx6q-gpc",
154 .pl310_compat = "arm,pl310-cache",
155 .mmdc_io_num = ARRAY_SIZE(imx6q_mmdc_io_offset),
156 .mmdc_io_offset = imx6q_mmdc_io_offset,
159 static const struct imx6_pm_socdata imx6dl_pm_data __initconst = {
160 .mmdc_compat = "fsl,imx6q-mmdc",
161 .src_compat = "fsl,imx6q-src",
162 .iomuxc_compat = "fsl,imx6dl-iomuxc",
163 .gpc_compat = "fsl,imx6q-gpc",
164 .pl310_compat = "arm,pl310-cache",
165 .mmdc_io_num = ARRAY_SIZE(imx6dl_mmdc_io_offset),
166 .mmdc_io_offset = imx6dl_mmdc_io_offset,
169 static const struct imx6_pm_socdata imx6sl_pm_data __initconst = {
170 .mmdc_compat = "fsl,imx6sl-mmdc",
171 .src_compat = "fsl,imx6sl-src",
172 .iomuxc_compat = "fsl,imx6sl-iomuxc",
173 .gpc_compat = "fsl,imx6sl-gpc",
174 .pl310_compat = "arm,pl310-cache",
175 .mmdc_io_num = ARRAY_SIZE(imx6sl_mmdc_io_offset),
176 .mmdc_io_offset = imx6sl_mmdc_io_offset,
179 static const struct imx6_pm_socdata imx6sx_pm_data __initconst = {
180 .mmdc_compat = "fsl,imx6sx-mmdc",
181 .src_compat = "fsl,imx6sx-src",
182 .iomuxc_compat = "fsl,imx6sx-iomuxc",
183 .gpc_compat = "fsl,imx6sx-gpc",
184 .pl310_compat = "arm,pl310-cache",
185 .mmdc_io_num = ARRAY_SIZE(imx6sx_mmdc_io_offset),
186 .mmdc_io_offset = imx6sx_mmdc_io_offset,
189 static const struct imx6_pm_socdata imx6ul_pm_data __initconst = {
190 .mmdc_compat = "fsl,imx6ul-mmdc",
191 .src_compat = "fsl,imx6ul-src",
192 .iomuxc_compat = "fsl,imx6ul-iomuxc",
193 .gpc_compat = "fsl,imx6ul-gpc",
194 .pl310_compat = NULL,
195 .mmdc_io_num = ARRAY_SIZE(imx6ul_mmdc_io_offset),
196 .mmdc_io_offset = imx6ul_mmdc_io_offset,
200 * This structure is for passing necessary data for low level ocram
201 * suspend code(arch/arm/mach-imx/suspend-imx6.S), if this struct
202 * definition is changed, the offset definition in
203 * arch/arm/mach-imx/suspend-imx6.S must be also changed accordingly,
204 * otherwise, the suspend to ocram function will be broken!
206 struct imx6_cpu_pm_info {
207 phys_addr_t pbase; /* The physical address of pm_info. */
208 phys_addr_t resume_addr; /* The physical resume address for asm code */
210 u32 pm_info_size; /* Size of pm_info. */
211 struct imx6_pm_base mmdc_base;
212 struct imx6_pm_base src_base;
213 struct imx6_pm_base iomuxc_base;
214 struct imx6_pm_base ccm_base;
215 struct imx6_pm_base gpc_base;
216 struct imx6_pm_base l2_base;
217 u32 mmdc_io_num; /* Number of MMDC IOs which need saved/restored. */
218 u32 mmdc_io_val[MX6_MAX_MMDC_IO_NUM][2]; /* To save offset and value */
221 void imx6_set_int_mem_clk_lpm(bool enable)
223 u32 val = readl_relaxed(ccm_base + CGPR);
225 val &= ~BM_CGPR_INT_MEM_CLK_LPM;
227 val |= BM_CGPR_INT_MEM_CLK_LPM;
228 writel_relaxed(val, ccm_base + CGPR);
231 void imx6_enable_rbc(bool enable)
236 * need to mask all interrupts in GPC before
237 * operating RBC configurations
241 /* configure RBC enable bit */
242 val = readl_relaxed(ccm_base + CCR);
243 val &= ~BM_CCR_RBC_EN;
244 val |= enable ? BM_CCR_RBC_EN : 0;
245 writel_relaxed(val, ccm_base + CCR);
247 /* configure RBC count */
248 val = readl_relaxed(ccm_base + CCR);
249 val &= ~BM_CCR_RBC_BYPASS_COUNT;
250 val |= enable ? BM_CCR_RBC_BYPASS_COUNT : 0;
251 writel(val, ccm_base + CCR);
254 * need to delay at least 2 cycles of CKIL(32K)
255 * due to hardware design requirement, which is
256 * ~61us, here we use 65us for safe
260 /* restore GPC interrupt mask settings */
261 imx_gpc_restore_all();
264 static void imx6q_enable_wb(bool enable)
268 /* configure well bias enable bit */
269 val = readl_relaxed(ccm_base + CLPCR);
270 val &= ~BM_CLPCR_WB_PER_AT_LPM;
271 val |= enable ? BM_CLPCR_WB_PER_AT_LPM : 0;
272 writel_relaxed(val, ccm_base + CLPCR);
274 /* configure well bias count */
275 val = readl_relaxed(ccm_base + CCR);
276 val &= ~BM_CCR_WB_COUNT;
277 val |= enable ? BM_CCR_WB_COUNT : 0;
278 writel_relaxed(val, ccm_base + CCR);
281 int imx6_set_lpm(enum mxc_cpu_pwr_mode mode)
283 u32 val = readl_relaxed(ccm_base + CLPCR);
285 val &= ~BM_CLPCR_LPM;
290 val |= 0x1 << BP_CLPCR_LPM;
291 val |= BM_CLPCR_ARM_CLK_DIS_ON_LPM;
294 val |= 0x2 << BP_CLPCR_LPM;
295 val &= ~BM_CLPCR_VSTBY;
296 val &= ~BM_CLPCR_SBYOS;
298 val |= BM_CLPCR_BYPASS_PMIC_READY;
299 if (cpu_is_imx6sl() || cpu_is_imx6sx() || cpu_is_imx6ul() ||
301 val |= BM_CLPCR_BYP_MMDC_CH0_LPM_HS;
303 val |= BM_CLPCR_BYP_MMDC_CH1_LPM_HS;
305 case WAIT_UNCLOCKED_POWER_OFF:
306 val |= 0x1 << BP_CLPCR_LPM;
307 val &= ~BM_CLPCR_VSTBY;
308 val &= ~BM_CLPCR_SBYOS;
311 val |= 0x2 << BP_CLPCR_LPM;
312 val |= 0x3 << BP_CLPCR_STBY_COUNT;
313 val |= BM_CLPCR_VSTBY;
314 val |= BM_CLPCR_SBYOS;
315 if (cpu_is_imx6sl() || cpu_is_imx6sx())
316 val |= BM_CLPCR_BYPASS_PMIC_READY;
317 if (cpu_is_imx6sl() || cpu_is_imx6sx() || cpu_is_imx6ul() ||
319 val |= BM_CLPCR_BYP_MMDC_CH0_LPM_HS;
321 val |= BM_CLPCR_BYP_MMDC_CH1_LPM_HS;
328 * ERR007265: CCM: When improper low-power sequence is used,
329 * the SoC enters low power mode before the ARM core executes WFI.
331 * Software workaround:
332 * 1) Software should trigger IRQ #32 (IOMUX) to be always pending
333 * by setting IOMUX_GPR1_GINT.
334 * 2) Software should then unmask IRQ #32 in GPC before setting CCM
336 * 3) Software should mask IRQ #32 right after CCM Low-Power mode
337 * is set (set bits 0-1 of CCM_CLPCR).
339 * Note that IRQ #32 is GIC SPI #0.
341 imx_gpc_hwirq_unmask(0);
342 writel_relaxed(val, ccm_base + CLPCR);
343 imx_gpc_hwirq_mask(0);
348 static int imx6q_suspend_finish(unsigned long val)
350 if (!imx6_suspend_in_ocram_fn) {
354 * call low level suspend function in ocram,
355 * as we need to float DDR IO.
357 local_flush_tlb_all();
358 /* check if need to flush internal L2 cache */
359 if (!((struct imx6_cpu_pm_info *)
360 suspend_ocram_base)->l2_base.vbase)
362 imx6_suspend_in_ocram_fn(suspend_ocram_base);
368 static int imx6q_pm_enter(suspend_state_t state)
371 case PM_SUSPEND_STANDBY:
372 imx6_set_lpm(STOP_POWER_ON);
373 imx6_set_int_mem_clk_lpm(true);
374 imx_gpc_pre_suspend(false);
376 imx6sl_set_wait_clk(true);
380 imx6sl_set_wait_clk(false);
381 imx_gpc_post_resume();
382 imx6_set_lpm(WAIT_CLOCKED);
385 imx6_set_lpm(STOP_POWER_OFF);
386 imx6_set_int_mem_clk_lpm(false);
387 imx6q_enable_wb(true);
389 * For suspend into ocram, asm code already take care of
390 * RBC setting, so we do NOT need to do that here.
392 if (!imx6_suspend_in_ocram_fn)
393 imx6_enable_rbc(true);
394 imx_gpc_pre_suspend(true);
395 imx_anatop_pre_suspend();
397 cpu_suspend(0, imx6q_suspend_finish);
398 if (cpu_is_imx6q() || cpu_is_imx6dl())
400 imx_anatop_post_resume();
401 imx_gpc_post_resume();
402 imx6_enable_rbc(false);
403 imx6q_enable_wb(false);
404 imx6_set_int_mem_clk_lpm(true);
405 imx6_set_lpm(WAIT_CLOCKED);
414 static int imx6q_pm_valid(suspend_state_t state)
416 return (state == PM_SUSPEND_STANDBY || state == PM_SUSPEND_MEM);
419 static const struct platform_suspend_ops imx6q_pm_ops = {
420 .enter = imx6q_pm_enter,
421 .valid = imx6q_pm_valid,
424 static int __init imx6_pm_get_base(struct imx6_pm_base *base,
427 struct device_node *node;
431 node = of_find_compatible_node(NULL, NULL, compat);
437 ret = of_address_to_resource(node, 0, &res);
441 base->pbase = res.start;
442 base->vbase = ioremap(res.start, resource_size(&res));
452 static int __init imx6q_suspend_init(const struct imx6_pm_socdata *socdata)
454 phys_addr_t ocram_pbase;
455 struct device_node *node;
456 struct platform_device *pdev;
457 struct imx6_cpu_pm_info *pm_info;
458 struct gen_pool *ocram_pool;
459 unsigned long ocram_base;
461 const u32 *mmdc_offset_array;
463 suspend_set_ops(&imx6q_pm_ops);
466 pr_warn("%s: invalid argument!\n", __func__);
470 node = of_find_compatible_node(NULL, NULL, "mmio-sram");
472 pr_warn("%s: failed to find ocram node!\n", __func__);
476 pdev = of_find_device_by_node(node);
478 pr_warn("%s: failed to find ocram device!\n", __func__);
483 ocram_pool = gen_pool_get(&pdev->dev, NULL);
485 pr_warn("%s: ocram pool unavailable!\n", __func__);
490 ocram_base = gen_pool_alloc(ocram_pool, MX6Q_SUSPEND_OCRAM_SIZE);
492 pr_warn("%s: unable to alloc ocram!\n", __func__);
497 ocram_pbase = gen_pool_virt_to_phys(ocram_pool, ocram_base);
499 suspend_ocram_base = __arm_ioremap_exec(ocram_pbase,
500 MX6Q_SUSPEND_OCRAM_SIZE, false);
502 memset(suspend_ocram_base, 0, sizeof(*pm_info));
503 pm_info = suspend_ocram_base;
504 pm_info->pbase = ocram_pbase;
505 pm_info->resume_addr = __pa_symbol(v7_cpu_resume);
506 pm_info->pm_info_size = sizeof(*pm_info);
509 * ccm physical address is not used by asm code currently,
510 * so get ccm virtual address directly.
512 pm_info->ccm_base.vbase = ccm_base;
514 ret = imx6_pm_get_base(&pm_info->mmdc_base, socdata->mmdc_compat);
516 pr_warn("%s: failed to get mmdc base %d!\n", __func__, ret);
520 ret = imx6_pm_get_base(&pm_info->src_base, socdata->src_compat);
522 pr_warn("%s: failed to get src base %d!\n", __func__, ret);
526 ret = imx6_pm_get_base(&pm_info->iomuxc_base, socdata->iomuxc_compat);
528 pr_warn("%s: failed to get iomuxc base %d!\n", __func__, ret);
529 goto iomuxc_map_failed;
532 ret = imx6_pm_get_base(&pm_info->gpc_base, socdata->gpc_compat);
534 pr_warn("%s: failed to get gpc base %d!\n", __func__, ret);
538 if (socdata->pl310_compat) {
539 ret = imx6_pm_get_base(&pm_info->l2_base, socdata->pl310_compat);
541 pr_warn("%s: failed to get pl310-cache base %d!\n",
543 goto pl310_cache_map_failed;
547 pm_info->ddr_type = imx_mmdc_get_ddr_type();
548 pm_info->mmdc_io_num = socdata->mmdc_io_num;
549 mmdc_offset_array = socdata->mmdc_io_offset;
551 for (i = 0; i < pm_info->mmdc_io_num; i++) {
552 pm_info->mmdc_io_val[i][0] =
553 mmdc_offset_array[i];
554 pm_info->mmdc_io_val[i][1] =
555 readl_relaxed(pm_info->iomuxc_base.vbase +
556 mmdc_offset_array[i]);
559 imx6_suspend_in_ocram_fn = fncpy(
560 suspend_ocram_base + sizeof(*pm_info),
562 MX6Q_SUSPEND_OCRAM_SIZE - sizeof(*pm_info));
566 pl310_cache_map_failed:
567 iounmap(pm_info->gpc_base.vbase);
569 iounmap(pm_info->iomuxc_base.vbase);
571 iounmap(pm_info->src_base.vbase);
573 iounmap(pm_info->mmdc_base.vbase);
575 put_device(&pdev->dev);
582 static void __init imx6_pm_common_init(const struct imx6_pm_socdata
590 if (IS_ENABLED(CONFIG_SUSPEND)) {
591 ret = imx6q_suspend_init(socdata);
593 pr_warn("%s: No DDR LPM support with suspend %d!\n",
598 * This is for SW workaround step #1 of ERR007265, see comments
599 * in imx6_set_lpm for details of this errata.
600 * Force IOMUXC irq pending, so that the interrupt to GPC can be
601 * used to deassert dsm_request signal when the signal gets
602 * asserted unexpectedly.
604 gpr = syscon_regmap_lookup_by_compatible("fsl,imx6q-iomuxc-gpr");
606 regmap_update_bits(gpr, IOMUXC_GPR1, IMX6Q_GPR1_GINT,
610 static void imx6_pm_stby_poweroff(void)
613 imx6_set_lpm(STOP_POWER_OFF);
614 imx6q_suspend_finish(0);
618 pr_emerg("Unable to poweroff system\n");
621 static int imx6_pm_stby_poweroff_probe(void)
624 pr_warn("%s: pm_power_off already claimed %p %pf!\n",
625 __func__, pm_power_off, pm_power_off);
629 pm_power_off = imx6_pm_stby_poweroff;
633 void __init imx6_pm_ccm_init(const char *ccm_compat)
635 struct device_node *np;
638 np = of_find_compatible_node(NULL, NULL, ccm_compat);
639 ccm_base = of_iomap(np, 0);
643 * Initialize CCM_CLPCR_LPM into RUN mode to avoid ARM core
644 * clock being shut down unexpectedly by WAIT mode.
646 val = readl_relaxed(ccm_base + CLPCR);
647 val &= ~BM_CLPCR_LPM;
648 writel_relaxed(val, ccm_base + CLPCR);
650 if (of_property_read_bool(np, "fsl,pmic-stby-poweroff"))
651 imx6_pm_stby_poweroff_probe();
654 void __init imx6q_pm_init(void)
656 imx6_pm_common_init(&imx6q_pm_data);
659 void __init imx6dl_pm_init(void)
661 imx6_pm_common_init(&imx6dl_pm_data);
664 void __init imx6sl_pm_init(void)
666 imx6_pm_common_init(&imx6sl_pm_data);
669 void __init imx6sx_pm_init(void)
671 imx6_pm_common_init(&imx6sx_pm_data);
674 void __init imx6ul_pm_init(void)
676 imx6_pm_common_init(&imx6ul_pm_data);