1 // SPDX-License-Identifier: GPL-2.0
3 // Copyright (c) 2011-2014 Samsung Electronics Co., Ltd.
4 // http://www.samsung.com
6 // EXYNOS - Suspend support
8 // Based on arch/arm/mach-s3c2410/pm.c
9 // Copyright (c) 2006 Simtec Electronics
10 // Ben Dooks <ben@simtec.co.uk>
12 #include <linux/init.h>
13 #include <linux/suspend.h>
14 #include <linux/syscore_ops.h>
15 #include <linux/cpu_pm.h>
17 #include <linux/irq.h>
18 #include <linux/irqchip.h>
19 #include <linux/irqdomain.h>
20 #include <linux/of_address.h>
21 #include <linux/err.h>
22 #include <linux/regulator/machine.h>
23 #include <linux/soc/samsung/exynos-pmu.h>
24 #include <linux/soc/samsung/exynos-regs-pmu.h>
26 #include <asm/cacheflush.h>
27 #include <asm/hardware/cache-l2x0.h>
28 #include <asm/firmware.h>
30 #include <asm/smp_scu.h>
31 #include <asm/suspend.h>
33 #include <plat/pm-common.h>
37 #define REG_TABLE_END (-1U)
39 #define EXYNOS5420_CPU_STATE 0x28
42 * struct exynos_wkup_irq - PMU IRQ to mask mapping
43 * @hwirq: Hardware IRQ signal of the PMU
44 * @mask: Mask in PMU wake-up mask register
46 struct exynos_wkup_irq {
51 struct exynos_pm_data {
52 const struct exynos_wkup_irq *wkup_irq;
53 unsigned int wake_disable_mask;
55 void (*pm_prepare)(void);
56 void (*pm_resume_prepare)(void);
57 void (*pm_resume)(void);
58 int (*pm_suspend)(void);
59 int (*cpu_suspend)(unsigned long);
62 static const struct exynos_pm_data *pm_data __ro_after_init;
64 static int exynos5420_cpu_state;
65 static unsigned int exynos_pmu_spare3;
71 static u32 exynos_irqwake_intmask = 0xffffffff;
73 static const struct exynos_wkup_irq exynos3250_wkup_irq[] = {
74 { 73, BIT(1) }, /* RTC alarm */
75 { 74, BIT(2) }, /* RTC tick */
79 static const struct exynos_wkup_irq exynos4_wkup_irq[] = {
80 { 44, BIT(1) }, /* RTC alarm */
81 { 45, BIT(2) }, /* RTC tick */
85 static const struct exynos_wkup_irq exynos5250_wkup_irq[] = {
86 { 43, BIT(1) }, /* RTC alarm */
87 { 44, BIT(2) }, /* RTC tick */
91 static int exynos_irq_set_wake(struct irq_data *data, unsigned int state)
93 const struct exynos_wkup_irq *wkup_irq;
95 if (!pm_data->wkup_irq)
97 wkup_irq = pm_data->wkup_irq;
99 while (wkup_irq->mask) {
100 if (wkup_irq->hwirq == data->hwirq) {
102 exynos_irqwake_intmask |= wkup_irq->mask;
104 exynos_irqwake_intmask &= ~wkup_irq->mask;
113 static struct irq_chip exynos_pmu_chip = {
115 .irq_eoi = irq_chip_eoi_parent,
116 .irq_mask = irq_chip_mask_parent,
117 .irq_unmask = irq_chip_unmask_parent,
118 .irq_retrigger = irq_chip_retrigger_hierarchy,
119 .irq_set_wake = exynos_irq_set_wake,
121 .irq_set_affinity = irq_chip_set_affinity_parent,
125 static int exynos_pmu_domain_translate(struct irq_domain *d,
126 struct irq_fwspec *fwspec,
127 unsigned long *hwirq,
130 if (is_of_node(fwspec->fwnode)) {
131 if (fwspec->param_count != 3)
134 /* No PPI should point to this domain */
135 if (fwspec->param[0] != 0)
138 *hwirq = fwspec->param[1];
139 *type = fwspec->param[2];
146 static int exynos_pmu_domain_alloc(struct irq_domain *domain,
148 unsigned int nr_irqs, void *data)
150 struct irq_fwspec *fwspec = data;
151 struct irq_fwspec parent_fwspec;
152 irq_hw_number_t hwirq;
155 if (fwspec->param_count != 3)
156 return -EINVAL; /* Not GIC compliant */
157 if (fwspec->param[0] != 0)
158 return -EINVAL; /* No PPI should point to this domain */
160 hwirq = fwspec->param[1];
162 for (i = 0; i < nr_irqs; i++)
163 irq_domain_set_hwirq_and_chip(domain, virq + i, hwirq + i,
164 &exynos_pmu_chip, NULL);
166 parent_fwspec = *fwspec;
167 parent_fwspec.fwnode = domain->parent->fwnode;
168 return irq_domain_alloc_irqs_parent(domain, virq, nr_irqs,
172 static const struct irq_domain_ops exynos_pmu_domain_ops = {
173 .translate = exynos_pmu_domain_translate,
174 .alloc = exynos_pmu_domain_alloc,
175 .free = irq_domain_free_irqs_common,
178 static int __init exynos_pmu_irq_init(struct device_node *node,
179 struct device_node *parent)
181 struct irq_domain *parent_domain, *domain;
184 pr_err("%pOF: no parent, giving up\n", node);
188 parent_domain = irq_find_host(parent);
189 if (!parent_domain) {
190 pr_err("%pOF: unable to obtain parent domain\n", node);
194 pmu_base_addr = of_iomap(node, 0);
196 if (!pmu_base_addr) {
197 pr_err("%pOF: failed to find exynos pmu register\n", node);
201 domain = irq_domain_add_hierarchy(parent_domain, 0, 0,
202 node, &exynos_pmu_domain_ops,
205 iounmap(pmu_base_addr);
206 pmu_base_addr = NULL;
211 * Clear the OF_POPULATED flag set in of_irq_init so that
212 * later the Exynos PMU platform device won't be skipped.
214 of_node_clear_flag(node, OF_POPULATED);
219 #define EXYNOS_PMU_IRQ(symbol, name) IRQCHIP_DECLARE(symbol, name, exynos_pmu_irq_init)
221 EXYNOS_PMU_IRQ(exynos3250_pmu_irq, "samsung,exynos3250-pmu");
222 EXYNOS_PMU_IRQ(exynos4210_pmu_irq, "samsung,exynos4210-pmu");
223 EXYNOS_PMU_IRQ(exynos4412_pmu_irq, "samsung,exynos4412-pmu");
224 EXYNOS_PMU_IRQ(exynos5250_pmu_irq, "samsung,exynos5250-pmu");
225 EXYNOS_PMU_IRQ(exynos5420_pmu_irq, "samsung,exynos5420-pmu");
227 static int exynos_cpu_do_idle(void)
229 /* issue the standby signal into the pm unit. */
232 pr_info("Failed to suspend the system\n");
233 return 1; /* Aborting suspend */
235 static void exynos_flush_cache_all(void)
241 static int exynos_cpu_suspend(unsigned long arg)
243 exynos_flush_cache_all();
244 return exynos_cpu_do_idle();
247 static int exynos3250_cpu_suspend(unsigned long arg)
250 return exynos_cpu_do_idle();
253 static int exynos5420_cpu_suspend(unsigned long arg)
255 /* MCPM works with HW CPU identifiers */
256 unsigned int mpidr = read_cpuid_mpidr();
257 unsigned int cluster = MPIDR_AFFINITY_LEVEL(mpidr, 1);
258 unsigned int cpu = MPIDR_AFFINITY_LEVEL(mpidr, 0);
260 writel_relaxed(0x0, sysram_base_addr + EXYNOS5420_CPU_STATE);
262 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM)) {
263 mcpm_set_entry_vector(cpu, cluster, exynos_cpu_resume);
267 pr_info("Failed to suspend the system\n");
269 /* return value != 0 means failure */
273 static void exynos_pm_set_wakeup_mask(void)
275 /* Set wake-up mask registers */
276 pmu_raw_writel(exynos_get_eint_wake_mask(), EXYNOS_EINT_WAKEUP_MASK);
277 pmu_raw_writel(exynos_irqwake_intmask & ~(1 << 31), S5P_WAKEUP_MASK);
280 static void exynos_pm_enter_sleep_mode(void)
282 /* Set value of power down register for sleep mode */
283 exynos_sys_powerdown_conf(SYS_SLEEP);
284 pmu_raw_writel(EXYNOS_SLEEP_MAGIC, S5P_INFORM1);
287 static void exynos_pm_prepare(void)
289 exynos_set_delayed_reset_assertion(false);
291 /* Set wake-up mask registers */
292 exynos_pm_set_wakeup_mask();
294 exynos_pm_enter_sleep_mode();
296 /* ensure at least INFORM0 has the resume address */
297 pmu_raw_writel(__pa_symbol(exynos_cpu_resume), S5P_INFORM0);
300 static void exynos3250_pm_prepare(void)
304 /* Set wake-up mask registers */
305 exynos_pm_set_wakeup_mask();
307 tmp = pmu_raw_readl(EXYNOS3_ARM_L2_OPTION);
308 tmp &= ~EXYNOS5_OPTION_USE_RETENTION;
309 pmu_raw_writel(tmp, EXYNOS3_ARM_L2_OPTION);
311 exynos_pm_enter_sleep_mode();
313 /* ensure at least INFORM0 has the resume address */
314 pmu_raw_writel(__pa_symbol(exynos_cpu_resume), S5P_INFORM0);
317 static void exynos5420_pm_prepare(void)
321 /* Set wake-up mask registers */
322 exynos_pm_set_wakeup_mask();
324 exynos_pmu_spare3 = pmu_raw_readl(S5P_PMU_SPARE3);
326 * The cpu state needs to be saved and restored so that the
327 * secondary CPUs will enter low power start. Though the U-Boot
328 * is setting the cpu state with low power flag, the kernel
329 * needs to restore it back in case, the primary cpu fails to
330 * suspend for any reason.
332 exynos5420_cpu_state = readl_relaxed(sysram_base_addr +
333 EXYNOS5420_CPU_STATE);
335 exynos_pm_enter_sleep_mode();
337 /* ensure at least INFORM0 has the resume address */
338 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM))
339 pmu_raw_writel(__pa_symbol(mcpm_entry_point), S5P_INFORM0);
341 tmp = pmu_raw_readl(EXYNOS_L2_OPTION(0));
342 tmp &= ~EXYNOS_L2_USE_RETENTION;
343 pmu_raw_writel(tmp, EXYNOS_L2_OPTION(0));
345 tmp = pmu_raw_readl(EXYNOS5420_SFR_AXI_CGDIS1);
346 tmp |= EXYNOS5420_UFS;
347 pmu_raw_writel(tmp, EXYNOS5420_SFR_AXI_CGDIS1);
349 tmp = pmu_raw_readl(EXYNOS5420_ARM_COMMON_OPTION);
350 tmp &= ~EXYNOS5420_L2RSTDISABLE_VALUE;
351 pmu_raw_writel(tmp, EXYNOS5420_ARM_COMMON_OPTION);
353 tmp = pmu_raw_readl(EXYNOS5420_FSYS2_OPTION);
354 tmp |= EXYNOS5420_EMULATION;
355 pmu_raw_writel(tmp, EXYNOS5420_FSYS2_OPTION);
357 tmp = pmu_raw_readl(EXYNOS5420_PSGEN_OPTION);
358 tmp |= EXYNOS5420_EMULATION;
359 pmu_raw_writel(tmp, EXYNOS5420_PSGEN_OPTION);
363 static int exynos_pm_suspend(void)
365 exynos_pm_central_suspend();
367 /* Setting SEQ_OPTION register */
368 pmu_raw_writel(S5P_USE_STANDBY_WFI0 | S5P_USE_STANDBY_WFE0,
369 S5P_CENTRAL_SEQ_OPTION);
371 if (read_cpuid_part() == ARM_CPU_PART_CORTEX_A9)
372 exynos_cpu_save_register();
377 static int exynos5420_pm_suspend(void)
381 exynos_pm_central_suspend();
383 /* Setting SEQ_OPTION register */
385 this_cluster = MPIDR_AFFINITY_LEVEL(read_cpuid_mpidr(), 1);
387 pmu_raw_writel(EXYNOS5420_ARM_USE_STANDBY_WFI0,
388 S5P_CENTRAL_SEQ_OPTION);
390 pmu_raw_writel(EXYNOS5420_KFC_USE_STANDBY_WFI0,
391 S5P_CENTRAL_SEQ_OPTION);
395 static void exynos_pm_resume(void)
397 u32 cpuid = read_cpuid_part();
399 if (exynos_pm_central_resume())
402 if (cpuid == ARM_CPU_PART_CORTEX_A9)
405 if (call_firmware_op(resume) == -ENOSYS
406 && cpuid == ARM_CPU_PART_CORTEX_A9)
407 exynos_cpu_restore_register();
411 /* Clear SLEEP mode set in INFORM1 */
412 pmu_raw_writel(0x0, S5P_INFORM1);
413 exynos_set_delayed_reset_assertion(true);
416 static void exynos3250_pm_resume(void)
418 u32 cpuid = read_cpuid_part();
420 if (exynos_pm_central_resume())
423 pmu_raw_writel(S5P_USE_STANDBY_WFI_ALL, S5P_CENTRAL_SEQ_OPTION);
425 if (call_firmware_op(resume) == -ENOSYS
426 && cpuid == ARM_CPU_PART_CORTEX_A9)
427 exynos_cpu_restore_register();
431 /* Clear SLEEP mode set in INFORM1 */
432 pmu_raw_writel(0x0, S5P_INFORM1);
435 static void exynos5420_prepare_pm_resume(void)
437 unsigned int mpidr, cluster;
439 mpidr = read_cpuid_mpidr();
440 cluster = MPIDR_AFFINITY_LEVEL(mpidr, 1);
442 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM))
443 WARN_ON(mcpm_cpu_powered_up());
445 if (IS_ENABLED(CONFIG_HW_PERF_EVENTS) && cluster != 0) {
447 * When system is resumed on the LITTLE/KFC core (cluster 1),
448 * the DSCR is not properly updated until the power is turned
449 * on also for the cluster 0. Enable it for a while to
450 * propagate the SPNIDEN and SPIDEN signals from Secure JTAG
451 * block and avoid undefined instruction issue on CP14 reset.
453 pmu_raw_writel(S5P_CORE_LOCAL_PWR_EN,
454 EXYNOS_COMMON_CONFIGURATION(0));
456 EXYNOS_COMMON_CONFIGURATION(0));
460 static void exynos5420_pm_resume(void)
464 /* Restore the CPU0 low power state register */
465 tmp = pmu_raw_readl(EXYNOS5_ARM_CORE0_SYS_PWR_REG);
466 pmu_raw_writel(tmp | S5P_CORE_LOCAL_PWR_EN,
467 EXYNOS5_ARM_CORE0_SYS_PWR_REG);
469 /* Restore the sysram cpu state register */
470 writel_relaxed(exynos5420_cpu_state,
471 sysram_base_addr + EXYNOS5420_CPU_STATE);
473 pmu_raw_writel(EXYNOS5420_USE_STANDBY_WFI_ALL,
474 S5P_CENTRAL_SEQ_OPTION);
476 if (exynos_pm_central_resume())
479 pmu_raw_writel(exynos_pmu_spare3, S5P_PMU_SPARE3);
483 tmp = pmu_raw_readl(EXYNOS5420_SFR_AXI_CGDIS1);
484 tmp &= ~EXYNOS5420_UFS;
485 pmu_raw_writel(tmp, EXYNOS5420_SFR_AXI_CGDIS1);
487 tmp = pmu_raw_readl(EXYNOS5420_FSYS2_OPTION);
488 tmp &= ~EXYNOS5420_EMULATION;
489 pmu_raw_writel(tmp, EXYNOS5420_FSYS2_OPTION);
491 tmp = pmu_raw_readl(EXYNOS5420_PSGEN_OPTION);
492 tmp &= ~EXYNOS5420_EMULATION;
493 pmu_raw_writel(tmp, EXYNOS5420_PSGEN_OPTION);
495 /* Clear SLEEP mode set in INFORM1 */
496 pmu_raw_writel(0x0, S5P_INFORM1);
503 static int exynos_suspend_enter(suspend_state_t state)
509 S3C_PMDBG("%s: suspending the system...\n", __func__);
511 S3C_PMDBG("%s: wakeup masks: %08x,%08x\n", __func__,
512 exynos_irqwake_intmask, exynos_get_eint_wake_mask());
514 if (exynos_irqwake_intmask == -1U
515 && exynos_get_eint_wake_mask() == -1U) {
516 pr_err("%s: No wake-up sources!\n", __func__);
517 pr_err("%s: Aborting sleep\n", __func__);
522 if (pm_data->pm_prepare)
523 pm_data->pm_prepare();
525 s3c_pm_check_store();
527 ret = call_firmware_op(suspend);
529 ret = cpu_suspend(0, pm_data->cpu_suspend);
533 if (pm_data->pm_resume_prepare)
534 pm_data->pm_resume_prepare();
535 s3c_pm_restore_uarts();
537 S3C_PMDBG("%s: wakeup stat: %08x\n", __func__,
538 pmu_raw_readl(S5P_WAKEUP_STAT));
540 s3c_pm_check_restore();
542 S3C_PMDBG("%s: resuming the system...\n", __func__);
547 static int exynos_suspend_prepare(void)
552 * REVISIT: It would be better if struct platform_suspend_ops
553 * .prepare handler get the suspend_state_t as a parameter to
554 * avoid hard-coding the suspend to mem state. It's safe to do
555 * it now only because the suspend_valid_only_mem function is
556 * used as the .valid callback used to check if a given state
557 * is supported by the platform anyways.
559 ret = regulator_suspend_prepare(PM_SUSPEND_MEM);
561 pr_err("Failed to prepare regulators for suspend (%d)\n", ret);
565 s3c_pm_check_prepare();
570 static void exynos_suspend_finish(void)
574 s3c_pm_check_cleanup();
576 ret = regulator_suspend_finish();
578 pr_warn("Failed to resume regulators from suspend (%d)\n", ret);
581 static const struct platform_suspend_ops exynos_suspend_ops = {
582 .enter = exynos_suspend_enter,
583 .prepare = exynos_suspend_prepare,
584 .finish = exynos_suspend_finish,
585 .valid = suspend_valid_only_mem,
588 static const struct exynos_pm_data exynos3250_pm_data = {
589 .wkup_irq = exynos3250_wkup_irq,
590 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
591 .pm_suspend = exynos_pm_suspend,
592 .pm_resume = exynos3250_pm_resume,
593 .pm_prepare = exynos3250_pm_prepare,
594 .cpu_suspend = exynos3250_cpu_suspend,
597 static const struct exynos_pm_data exynos4_pm_data = {
598 .wkup_irq = exynos4_wkup_irq,
599 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
600 .pm_suspend = exynos_pm_suspend,
601 .pm_resume = exynos_pm_resume,
602 .pm_prepare = exynos_pm_prepare,
603 .cpu_suspend = exynos_cpu_suspend,
606 static const struct exynos_pm_data exynos5250_pm_data = {
607 .wkup_irq = exynos5250_wkup_irq,
608 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
609 .pm_suspend = exynos_pm_suspend,
610 .pm_resume = exynos_pm_resume,
611 .pm_prepare = exynos_pm_prepare,
612 .cpu_suspend = exynos_cpu_suspend,
615 static const struct exynos_pm_data exynos5420_pm_data = {
616 .wkup_irq = exynos5250_wkup_irq,
617 .wake_disable_mask = (0x7F << 7) | (0x1F << 1),
618 .pm_resume_prepare = exynos5420_prepare_pm_resume,
619 .pm_resume = exynos5420_pm_resume,
620 .pm_suspend = exynos5420_pm_suspend,
621 .pm_prepare = exynos5420_pm_prepare,
622 .cpu_suspend = exynos5420_cpu_suspend,
625 static const struct of_device_id exynos_pmu_of_device_ids[] __initconst = {
627 .compatible = "samsung,exynos3250-pmu",
628 .data = &exynos3250_pm_data,
630 .compatible = "samsung,exynos4210-pmu",
631 .data = &exynos4_pm_data,
633 .compatible = "samsung,exynos4412-pmu",
634 .data = &exynos4_pm_data,
636 .compatible = "samsung,exynos5250-pmu",
637 .data = &exynos5250_pm_data,
639 .compatible = "samsung,exynos5420-pmu",
640 .data = &exynos5420_pm_data,
645 static struct syscore_ops exynos_pm_syscore_ops;
647 void __init exynos_pm_init(void)
649 const struct of_device_id *match;
650 struct device_node *np;
653 np = of_find_matching_node_and_match(NULL, exynos_pmu_of_device_ids, &match);
655 pr_err("Failed to find PMU node\n");
659 if (WARN_ON(!of_find_property(np, "interrupt-controller", NULL))) {
660 pr_warn("Outdated DT detected, suspend/resume will NOT work\n");
666 pm_data = (const struct exynos_pm_data *) match->data;
668 /* All wakeup disable */
669 tmp = pmu_raw_readl(S5P_WAKEUP_MASK);
670 tmp |= pm_data->wake_disable_mask;
671 pmu_raw_writel(tmp, S5P_WAKEUP_MASK);
673 exynos_pm_syscore_ops.suspend = pm_data->pm_suspend;
674 exynos_pm_syscore_ops.resume = pm_data->pm_resume;
676 register_syscore_ops(&exynos_pm_syscore_ops);
677 suspend_set_ops(&exynos_suspend_ops);