2 * Copyright (c) 2011-2014 Samsung Electronics Co., Ltd.
3 * http://www.samsung.com
5 * EXYNOS - Suspend support
7 * Based on arch/arm/mach-s3c2410/pm.c
8 * Copyright (c) 2006 Simtec Electronics
9 * Ben Dooks <ben@simtec.co.uk>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
16 #include <linux/init.h>
17 #include <linux/suspend.h>
18 #include <linux/syscore_ops.h>
19 #include <linux/cpu_pm.h>
21 #include <linux/irq.h>
22 #include <linux/irqchip.h>
23 #include <linux/irqdomain.h>
24 #include <linux/of_address.h>
25 #include <linux/err.h>
26 #include <linux/regulator/machine.h>
27 #include <linux/soc/samsung/exynos-pmu.h>
28 #include <linux/soc/samsung/exynos-regs-pmu.h>
30 #include <asm/cacheflush.h>
31 #include <asm/hardware/cache-l2x0.h>
32 #include <asm/firmware.h>
34 #include <asm/smp_scu.h>
35 #include <asm/suspend.h>
39 #include <plat/pm-common.h>
43 #define REG_TABLE_END (-1U)
45 #define EXYNOS5420_CPU_STATE 0x28
48 * struct exynos_wkup_irq - PMU IRQ to mask mapping
49 * @hwirq: Hardware IRQ signal of the PMU
50 * @mask: Mask in PMU wake-up mask register
52 struct exynos_wkup_irq {
57 struct exynos_pm_data {
58 const struct exynos_wkup_irq *wkup_irq;
59 unsigned int wake_disable_mask;
61 void (*pm_prepare)(void);
62 void (*pm_resume_prepare)(void);
63 void (*pm_resume)(void);
64 int (*pm_suspend)(void);
65 int (*cpu_suspend)(unsigned long);
68 static const struct exynos_pm_data *pm_data __ro_after_init;
70 static int exynos5420_cpu_state;
71 static unsigned int exynos_pmu_spare3;
77 static u32 exynos_irqwake_intmask = 0xffffffff;
79 static const struct exynos_wkup_irq exynos3250_wkup_irq[] = {
80 { 73, BIT(1) }, /* RTC alarm */
81 { 74, BIT(2) }, /* RTC tick */
85 static const struct exynos_wkup_irq exynos4_wkup_irq[] = {
86 { 44, BIT(1) }, /* RTC alarm */
87 { 45, BIT(2) }, /* RTC tick */
91 static const struct exynos_wkup_irq exynos5250_wkup_irq[] = {
92 { 43, BIT(1) }, /* RTC alarm */
93 { 44, BIT(2) }, /* RTC tick */
97 static int exynos_irq_set_wake(struct irq_data *data, unsigned int state)
99 const struct exynos_wkup_irq *wkup_irq;
101 if (!pm_data->wkup_irq)
103 wkup_irq = pm_data->wkup_irq;
105 while (wkup_irq->mask) {
106 if (wkup_irq->hwirq == data->hwirq) {
108 exynos_irqwake_intmask |= wkup_irq->mask;
110 exynos_irqwake_intmask &= ~wkup_irq->mask;
119 static struct irq_chip exynos_pmu_chip = {
121 .irq_eoi = irq_chip_eoi_parent,
122 .irq_mask = irq_chip_mask_parent,
123 .irq_unmask = irq_chip_unmask_parent,
124 .irq_retrigger = irq_chip_retrigger_hierarchy,
125 .irq_set_wake = exynos_irq_set_wake,
127 .irq_set_affinity = irq_chip_set_affinity_parent,
131 static int exynos_pmu_domain_translate(struct irq_domain *d,
132 struct irq_fwspec *fwspec,
133 unsigned long *hwirq,
136 if (is_of_node(fwspec->fwnode)) {
137 if (fwspec->param_count != 3)
140 /* No PPI should point to this domain */
141 if (fwspec->param[0] != 0)
144 *hwirq = fwspec->param[1];
145 *type = fwspec->param[2];
152 static int exynos_pmu_domain_alloc(struct irq_domain *domain,
154 unsigned int nr_irqs, void *data)
156 struct irq_fwspec *fwspec = data;
157 struct irq_fwspec parent_fwspec;
158 irq_hw_number_t hwirq;
161 if (fwspec->param_count != 3)
162 return -EINVAL; /* Not GIC compliant */
163 if (fwspec->param[0] != 0)
164 return -EINVAL; /* No PPI should point to this domain */
166 hwirq = fwspec->param[1];
168 for (i = 0; i < nr_irqs; i++)
169 irq_domain_set_hwirq_and_chip(domain, virq + i, hwirq + i,
170 &exynos_pmu_chip, NULL);
172 parent_fwspec = *fwspec;
173 parent_fwspec.fwnode = domain->parent->fwnode;
174 return irq_domain_alloc_irqs_parent(domain, virq, nr_irqs,
178 static const struct irq_domain_ops exynos_pmu_domain_ops = {
179 .translate = exynos_pmu_domain_translate,
180 .alloc = exynos_pmu_domain_alloc,
181 .free = irq_domain_free_irqs_common,
184 static int __init exynos_pmu_irq_init(struct device_node *node,
185 struct device_node *parent)
187 struct irq_domain *parent_domain, *domain;
190 pr_err("%s: no parent, giving up\n", node->full_name);
194 parent_domain = irq_find_host(parent);
195 if (!parent_domain) {
196 pr_err("%s: unable to obtain parent domain\n", node->full_name);
200 pmu_base_addr = of_iomap(node, 0);
202 if (!pmu_base_addr) {
203 pr_err("%s: failed to find exynos pmu register\n",
208 domain = irq_domain_add_hierarchy(parent_domain, 0, 0,
209 node, &exynos_pmu_domain_ops,
212 iounmap(pmu_base_addr);
217 * Clear the OF_POPULATED flag set in of_irq_init so that
218 * later the Exynos PMU platform device won't be skipped.
220 of_node_clear_flag(node, OF_POPULATED);
225 #define EXYNOS_PMU_IRQ(symbol, name) IRQCHIP_DECLARE(symbol, name, exynos_pmu_irq_init)
227 EXYNOS_PMU_IRQ(exynos3250_pmu_irq, "samsung,exynos3250-pmu");
228 EXYNOS_PMU_IRQ(exynos4210_pmu_irq, "samsung,exynos4210-pmu");
229 EXYNOS_PMU_IRQ(exynos4212_pmu_irq, "samsung,exynos4212-pmu");
230 EXYNOS_PMU_IRQ(exynos4412_pmu_irq, "samsung,exynos4412-pmu");
231 EXYNOS_PMU_IRQ(exynos5250_pmu_irq, "samsung,exynos5250-pmu");
232 EXYNOS_PMU_IRQ(exynos5420_pmu_irq, "samsung,exynos5420-pmu");
234 static int exynos_cpu_do_idle(void)
236 /* issue the standby signal into the pm unit. */
239 pr_info("Failed to suspend the system\n");
240 return 1; /* Aborting suspend */
242 static void exynos_flush_cache_all(void)
248 static int exynos_cpu_suspend(unsigned long arg)
250 exynos_flush_cache_all();
251 return exynos_cpu_do_idle();
254 static int exynos3250_cpu_suspend(unsigned long arg)
257 return exynos_cpu_do_idle();
260 static int exynos5420_cpu_suspend(unsigned long arg)
262 /* MCPM works with HW CPU identifiers */
263 unsigned int mpidr = read_cpuid_mpidr();
264 unsigned int cluster = MPIDR_AFFINITY_LEVEL(mpidr, 1);
265 unsigned int cpu = MPIDR_AFFINITY_LEVEL(mpidr, 0);
267 writel_relaxed(0x0, sysram_base_addr + EXYNOS5420_CPU_STATE);
269 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM)) {
270 mcpm_set_entry_vector(cpu, cluster, exynos_cpu_resume);
274 pr_info("Failed to suspend the system\n");
276 /* return value != 0 means failure */
280 static void exynos_pm_set_wakeup_mask(void)
282 /* Set wake-up mask registers */
283 pmu_raw_writel(exynos_get_eint_wake_mask(), S5P_EINT_WAKEUP_MASK);
284 pmu_raw_writel(exynos_irqwake_intmask & ~(1 << 31), S5P_WAKEUP_MASK);
287 static void exynos_pm_enter_sleep_mode(void)
289 /* Set value of power down register for sleep mode */
290 exynos_sys_powerdown_conf(SYS_SLEEP);
291 pmu_raw_writel(EXYNOS_SLEEP_MAGIC, S5P_INFORM1);
294 static void exynos_pm_prepare(void)
296 exynos_set_delayed_reset_assertion(false);
298 /* Set wake-up mask registers */
299 exynos_pm_set_wakeup_mask();
301 exynos_pm_enter_sleep_mode();
303 /* ensure at least INFORM0 has the resume address */
304 pmu_raw_writel(__pa_symbol(exynos_cpu_resume), S5P_INFORM0);
307 static void exynos3250_pm_prepare(void)
311 /* Set wake-up mask registers */
312 exynos_pm_set_wakeup_mask();
314 tmp = pmu_raw_readl(EXYNOS3_ARM_L2_OPTION);
315 tmp &= ~EXYNOS5_OPTION_USE_RETENTION;
316 pmu_raw_writel(tmp, EXYNOS3_ARM_L2_OPTION);
318 exynos_pm_enter_sleep_mode();
320 /* ensure at least INFORM0 has the resume address */
321 pmu_raw_writel(__pa_symbol(exynos_cpu_resume), S5P_INFORM0);
324 static void exynos5420_pm_prepare(void)
328 /* Set wake-up mask registers */
329 exynos_pm_set_wakeup_mask();
331 exynos_pmu_spare3 = pmu_raw_readl(S5P_PMU_SPARE3);
333 * The cpu state needs to be saved and restored so that the
334 * secondary CPUs will enter low power start. Though the U-Boot
335 * is setting the cpu state with low power flag, the kernel
336 * needs to restore it back in case, the primary cpu fails to
337 * suspend for any reason.
339 exynos5420_cpu_state = readl_relaxed(sysram_base_addr +
340 EXYNOS5420_CPU_STATE);
342 exynos_pm_enter_sleep_mode();
344 /* ensure at least INFORM0 has the resume address */
345 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM))
346 pmu_raw_writel(__pa_symbol(mcpm_entry_point), S5P_INFORM0);
348 tmp = pmu_raw_readl(EXYNOS_L2_OPTION(0));
349 tmp &= ~EXYNOS_L2_USE_RETENTION;
350 pmu_raw_writel(tmp, EXYNOS_L2_OPTION(0));
352 tmp = pmu_raw_readl(EXYNOS5420_SFR_AXI_CGDIS1);
353 tmp |= EXYNOS5420_UFS;
354 pmu_raw_writel(tmp, EXYNOS5420_SFR_AXI_CGDIS1);
356 tmp = pmu_raw_readl(EXYNOS5420_ARM_COMMON_OPTION);
357 tmp &= ~EXYNOS5420_L2RSTDISABLE_VALUE;
358 pmu_raw_writel(tmp, EXYNOS5420_ARM_COMMON_OPTION);
360 tmp = pmu_raw_readl(EXYNOS5420_FSYS2_OPTION);
361 tmp |= EXYNOS5420_EMULATION;
362 pmu_raw_writel(tmp, EXYNOS5420_FSYS2_OPTION);
364 tmp = pmu_raw_readl(EXYNOS5420_PSGEN_OPTION);
365 tmp |= EXYNOS5420_EMULATION;
366 pmu_raw_writel(tmp, EXYNOS5420_PSGEN_OPTION);
370 static int exynos_pm_suspend(void)
372 exynos_pm_central_suspend();
374 /* Setting SEQ_OPTION register */
375 pmu_raw_writel(S5P_USE_STANDBY_WFI0 | S5P_USE_STANDBY_WFE0,
376 S5P_CENTRAL_SEQ_OPTION);
378 if (read_cpuid_part() == ARM_CPU_PART_CORTEX_A9)
379 exynos_cpu_save_register();
384 static int exynos5420_pm_suspend(void)
388 exynos_pm_central_suspend();
390 /* Setting SEQ_OPTION register */
392 this_cluster = MPIDR_AFFINITY_LEVEL(read_cpuid_mpidr(), 1);
394 pmu_raw_writel(EXYNOS5420_ARM_USE_STANDBY_WFI0,
395 S5P_CENTRAL_SEQ_OPTION);
397 pmu_raw_writel(EXYNOS5420_KFC_USE_STANDBY_WFI0,
398 S5P_CENTRAL_SEQ_OPTION);
402 static void exynos_pm_resume(void)
404 u32 cpuid = read_cpuid_part();
406 if (exynos_pm_central_resume())
409 if (cpuid == ARM_CPU_PART_CORTEX_A9)
410 scu_enable(S5P_VA_SCU);
412 if (call_firmware_op(resume) == -ENOSYS
413 && cpuid == ARM_CPU_PART_CORTEX_A9)
414 exynos_cpu_restore_register();
418 /* Clear SLEEP mode set in INFORM1 */
419 pmu_raw_writel(0x0, S5P_INFORM1);
420 exynos_set_delayed_reset_assertion(true);
423 static void exynos3250_pm_resume(void)
425 u32 cpuid = read_cpuid_part();
427 if (exynos_pm_central_resume())
430 pmu_raw_writel(S5P_USE_STANDBY_WFI_ALL, S5P_CENTRAL_SEQ_OPTION);
432 if (call_firmware_op(resume) == -ENOSYS
433 && cpuid == ARM_CPU_PART_CORTEX_A9)
434 exynos_cpu_restore_register();
438 /* Clear SLEEP mode set in INFORM1 */
439 pmu_raw_writel(0x0, S5P_INFORM1);
442 static void exynos5420_prepare_pm_resume(void)
444 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM))
445 WARN_ON(mcpm_cpu_powered_up());
448 static void exynos5420_pm_resume(void)
452 /* Restore the CPU0 low power state register */
453 tmp = pmu_raw_readl(EXYNOS5_ARM_CORE0_SYS_PWR_REG);
454 pmu_raw_writel(tmp | S5P_CORE_LOCAL_PWR_EN,
455 EXYNOS5_ARM_CORE0_SYS_PWR_REG);
457 /* Restore the sysram cpu state register */
458 writel_relaxed(exynos5420_cpu_state,
459 sysram_base_addr + EXYNOS5420_CPU_STATE);
461 pmu_raw_writel(EXYNOS5420_USE_STANDBY_WFI_ALL,
462 S5P_CENTRAL_SEQ_OPTION);
464 if (exynos_pm_central_resume())
467 pmu_raw_writel(exynos_pmu_spare3, S5P_PMU_SPARE3);
471 tmp = pmu_raw_readl(EXYNOS5420_SFR_AXI_CGDIS1);
472 tmp &= ~EXYNOS5420_UFS;
473 pmu_raw_writel(tmp, EXYNOS5420_SFR_AXI_CGDIS1);
475 tmp = pmu_raw_readl(EXYNOS5420_FSYS2_OPTION);
476 tmp &= ~EXYNOS5420_EMULATION;
477 pmu_raw_writel(tmp, EXYNOS5420_FSYS2_OPTION);
479 tmp = pmu_raw_readl(EXYNOS5420_PSGEN_OPTION);
480 tmp &= ~EXYNOS5420_EMULATION;
481 pmu_raw_writel(tmp, EXYNOS5420_PSGEN_OPTION);
483 /* Clear SLEEP mode set in INFORM1 */
484 pmu_raw_writel(0x0, S5P_INFORM1);
491 static int exynos_suspend_enter(suspend_state_t state)
497 S3C_PMDBG("%s: suspending the system...\n", __func__);
499 S3C_PMDBG("%s: wakeup masks: %08x,%08x\n", __func__,
500 exynos_irqwake_intmask, exynos_get_eint_wake_mask());
502 if (exynos_irqwake_intmask == -1U
503 && exynos_get_eint_wake_mask() == -1U) {
504 pr_err("%s: No wake-up sources!\n", __func__);
505 pr_err("%s: Aborting sleep\n", __func__);
510 if (pm_data->pm_prepare)
511 pm_data->pm_prepare();
513 s3c_pm_check_store();
515 ret = call_firmware_op(suspend);
517 ret = cpu_suspend(0, pm_data->cpu_suspend);
521 if (pm_data->pm_resume_prepare)
522 pm_data->pm_resume_prepare();
523 s3c_pm_restore_uarts();
525 S3C_PMDBG("%s: wakeup stat: %08x\n", __func__,
526 pmu_raw_readl(S5P_WAKEUP_STAT));
528 s3c_pm_check_restore();
530 S3C_PMDBG("%s: resuming the system...\n", __func__);
535 static int exynos_suspend_prepare(void)
540 * REVISIT: It would be better if struct platform_suspend_ops
541 * .prepare handler get the suspend_state_t as a parameter to
542 * avoid hard-coding the suspend to mem state. It's safe to do
543 * it now only because the suspend_valid_only_mem function is
544 * used as the .valid callback used to check if a given state
545 * is supported by the platform anyways.
547 ret = regulator_suspend_prepare(PM_SUSPEND_MEM);
549 pr_err("Failed to prepare regulators for suspend (%d)\n", ret);
553 s3c_pm_check_prepare();
558 static void exynos_suspend_finish(void)
562 s3c_pm_check_cleanup();
564 ret = regulator_suspend_finish();
566 pr_warn("Failed to resume regulators from suspend (%d)\n", ret);
569 static const struct platform_suspend_ops exynos_suspend_ops = {
570 .enter = exynos_suspend_enter,
571 .prepare = exynos_suspend_prepare,
572 .finish = exynos_suspend_finish,
573 .valid = suspend_valid_only_mem,
576 static const struct exynos_pm_data exynos3250_pm_data = {
577 .wkup_irq = exynos3250_wkup_irq,
578 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
579 .pm_suspend = exynos_pm_suspend,
580 .pm_resume = exynos3250_pm_resume,
581 .pm_prepare = exynos3250_pm_prepare,
582 .cpu_suspend = exynos3250_cpu_suspend,
585 static const struct exynos_pm_data exynos4_pm_data = {
586 .wkup_irq = exynos4_wkup_irq,
587 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
588 .pm_suspend = exynos_pm_suspend,
589 .pm_resume = exynos_pm_resume,
590 .pm_prepare = exynos_pm_prepare,
591 .cpu_suspend = exynos_cpu_suspend,
594 static const struct exynos_pm_data exynos5250_pm_data = {
595 .wkup_irq = exynos5250_wkup_irq,
596 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
597 .pm_suspend = exynos_pm_suspend,
598 .pm_resume = exynos_pm_resume,
599 .pm_prepare = exynos_pm_prepare,
600 .cpu_suspend = exynos_cpu_suspend,
603 static const struct exynos_pm_data exynos5420_pm_data = {
604 .wkup_irq = exynos5250_wkup_irq,
605 .wake_disable_mask = (0x7F << 7) | (0x1F << 1),
606 .pm_resume_prepare = exynos5420_prepare_pm_resume,
607 .pm_resume = exynos5420_pm_resume,
608 .pm_suspend = exynos5420_pm_suspend,
609 .pm_prepare = exynos5420_pm_prepare,
610 .cpu_suspend = exynos5420_cpu_suspend,
613 static const struct of_device_id exynos_pmu_of_device_ids[] __initconst = {
615 .compatible = "samsung,exynos3250-pmu",
616 .data = &exynos3250_pm_data,
618 .compatible = "samsung,exynos4210-pmu",
619 .data = &exynos4_pm_data,
621 .compatible = "samsung,exynos4212-pmu",
622 .data = &exynos4_pm_data,
624 .compatible = "samsung,exynos4412-pmu",
625 .data = &exynos4_pm_data,
627 .compatible = "samsung,exynos5250-pmu",
628 .data = &exynos5250_pm_data,
630 .compatible = "samsung,exynos5420-pmu",
631 .data = &exynos5420_pm_data,
636 static struct syscore_ops exynos_pm_syscore_ops;
638 void __init exynos_pm_init(void)
640 const struct of_device_id *match;
641 struct device_node *np;
644 np = of_find_matching_node_and_match(NULL, exynos_pmu_of_device_ids, &match);
646 pr_err("Failed to find PMU node\n");
650 if (WARN_ON(!of_find_property(np, "interrupt-controller", NULL))) {
651 pr_warn("Outdated DT detected, suspend/resume will NOT work\n");
655 pm_data = (const struct exynos_pm_data *) match->data;
657 /* All wakeup disable */
658 tmp = pmu_raw_readl(S5P_WAKEUP_MASK);
659 tmp |= pm_data->wake_disable_mask;
660 pmu_raw_writel(tmp, S5P_WAKEUP_MASK);
662 exynos_pm_syscore_ops.suspend = pm_data->pm_suspend;
663 exynos_pm_syscore_ops.resume = pm_data->pm_resume;
665 register_syscore_ops(&exynos_pm_syscore_ops);
666 suspend_set_ops(&exynos_suspend_ops);