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>
35 #define REG_TABLE_END (-1U)
37 #define EXYNOS5420_CPU_STATE 0x28
40 * struct exynos_wkup_irq - PMU IRQ to mask mapping
41 * @hwirq: Hardware IRQ signal of the PMU
42 * @mask: Mask in PMU wake-up mask register
44 struct exynos_wkup_irq {
49 struct exynos_pm_data {
50 const struct exynos_wkup_irq *wkup_irq;
51 unsigned int wake_disable_mask;
53 void (*pm_prepare)(void);
54 void (*pm_resume_prepare)(void);
55 void (*pm_resume)(void);
56 int (*pm_suspend)(void);
57 int (*cpu_suspend)(unsigned long);
60 /* Used only on Exynos542x/5800 */
61 struct exynos_pm_state {
63 unsigned int pmu_spare3;
64 void __iomem *sysram_base;
67 static const struct exynos_pm_data *pm_data __ro_after_init;
68 static struct exynos_pm_state pm_state;
74 static u32 exynos_irqwake_intmask = 0xffffffff;
76 static const struct exynos_wkup_irq exynos3250_wkup_irq[] = {
77 { 73, BIT(1) }, /* RTC alarm */
78 { 74, BIT(2) }, /* RTC tick */
82 static const struct exynos_wkup_irq exynos4_wkup_irq[] = {
83 { 44, BIT(1) }, /* RTC alarm */
84 { 45, BIT(2) }, /* RTC tick */
88 static const struct exynos_wkup_irq exynos5250_wkup_irq[] = {
89 { 43, BIT(1) }, /* RTC alarm */
90 { 44, BIT(2) }, /* RTC tick */
94 static u32 exynos_read_eint_wakeup_mask(void)
96 return pmu_raw_readl(EXYNOS_EINT_WAKEUP_MASK);
99 static int exynos_irq_set_wake(struct irq_data *data, unsigned int state)
101 const struct exynos_wkup_irq *wkup_irq;
103 if (!pm_data->wkup_irq)
105 wkup_irq = pm_data->wkup_irq;
107 while (wkup_irq->mask) {
108 if (wkup_irq->hwirq == data->hwirq) {
110 exynos_irqwake_intmask |= wkup_irq->mask;
112 exynos_irqwake_intmask &= ~wkup_irq->mask;
121 static struct irq_chip exynos_pmu_chip = {
123 .irq_eoi = irq_chip_eoi_parent,
124 .irq_mask = irq_chip_mask_parent,
125 .irq_unmask = irq_chip_unmask_parent,
126 .irq_retrigger = irq_chip_retrigger_hierarchy,
127 .irq_set_wake = exynos_irq_set_wake,
129 .irq_set_affinity = irq_chip_set_affinity_parent,
133 static int exynos_pmu_domain_translate(struct irq_domain *d,
134 struct irq_fwspec *fwspec,
135 unsigned long *hwirq,
138 if (is_of_node(fwspec->fwnode)) {
139 if (fwspec->param_count != 3)
142 /* No PPI should point to this domain */
143 if (fwspec->param[0] != 0)
146 *hwirq = fwspec->param[1];
147 *type = fwspec->param[2];
154 static int exynos_pmu_domain_alloc(struct irq_domain *domain,
156 unsigned int nr_irqs, void *data)
158 struct irq_fwspec *fwspec = data;
159 struct irq_fwspec parent_fwspec;
160 irq_hw_number_t hwirq;
163 if (fwspec->param_count != 3)
164 return -EINVAL; /* Not GIC compliant */
165 if (fwspec->param[0] != 0)
166 return -EINVAL; /* No PPI should point to this domain */
168 hwirq = fwspec->param[1];
170 for (i = 0; i < nr_irqs; i++)
171 irq_domain_set_hwirq_and_chip(domain, virq + i, hwirq + i,
172 &exynos_pmu_chip, NULL);
174 parent_fwspec = *fwspec;
175 parent_fwspec.fwnode = domain->parent->fwnode;
176 return irq_domain_alloc_irqs_parent(domain, virq, nr_irqs,
180 static const struct irq_domain_ops exynos_pmu_domain_ops = {
181 .translate = exynos_pmu_domain_translate,
182 .alloc = exynos_pmu_domain_alloc,
183 .free = irq_domain_free_irqs_common,
186 static int __init exynos_pmu_irq_init(struct device_node *node,
187 struct device_node *parent)
189 struct irq_domain *parent_domain, *domain;
192 pr_err("%pOF: no parent, giving up\n", node);
196 parent_domain = irq_find_host(parent);
197 if (!parent_domain) {
198 pr_err("%pOF: unable to obtain parent domain\n", node);
202 pmu_base_addr = of_iomap(node, 0);
204 if (!pmu_base_addr) {
205 pr_err("%pOF: failed to find exynos pmu register\n", node);
209 domain = irq_domain_add_hierarchy(parent_domain, 0, 0,
210 node, &exynos_pmu_domain_ops,
213 iounmap(pmu_base_addr);
214 pmu_base_addr = NULL;
219 * Clear the OF_POPULATED flag set in of_irq_init so that
220 * later the Exynos PMU platform device won't be skipped.
222 of_node_clear_flag(node, OF_POPULATED);
227 #define EXYNOS_PMU_IRQ(symbol, name) IRQCHIP_DECLARE(symbol, name, exynos_pmu_irq_init)
229 EXYNOS_PMU_IRQ(exynos3250_pmu_irq, "samsung,exynos3250-pmu");
230 EXYNOS_PMU_IRQ(exynos4210_pmu_irq, "samsung,exynos4210-pmu");
231 EXYNOS_PMU_IRQ(exynos4412_pmu_irq, "samsung,exynos4412-pmu");
232 EXYNOS_PMU_IRQ(exynos5250_pmu_irq, "samsung,exynos5250-pmu");
233 EXYNOS_PMU_IRQ(exynos5420_pmu_irq, "samsung,exynos5420-pmu");
235 static int exynos_cpu_do_idle(void)
237 /* issue the standby signal into the pm unit. */
240 pr_info("Failed to suspend the system\n");
241 return 1; /* Aborting suspend */
243 static void exynos_flush_cache_all(void)
249 static int exynos_cpu_suspend(unsigned long arg)
251 exynos_flush_cache_all();
252 return exynos_cpu_do_idle();
255 static int exynos3250_cpu_suspend(unsigned long arg)
258 return exynos_cpu_do_idle();
261 static int exynos5420_cpu_suspend(unsigned long arg)
263 /* MCPM works with HW CPU identifiers */
264 unsigned int mpidr = read_cpuid_mpidr();
265 unsigned int cluster = MPIDR_AFFINITY_LEVEL(mpidr, 1);
266 unsigned int cpu = MPIDR_AFFINITY_LEVEL(mpidr, 0);
268 writel_relaxed(0x0, pm_state.sysram_base + EXYNOS5420_CPU_STATE);
270 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM)) {
271 mcpm_set_entry_vector(cpu, cluster, exynos_cpu_resume);
275 pr_info("Failed to suspend the system\n");
277 /* return value != 0 means failure */
281 static void exynos_pm_set_wakeup_mask(void)
284 * Set wake-up mask registers
285 * EXYNOS_EINT_WAKEUP_MASK is set by pinctrl driver in late suspend.
287 pmu_raw_writel(exynos_irqwake_intmask & ~(1 << 31), S5P_WAKEUP_MASK);
290 static void exynos_pm_enter_sleep_mode(void)
292 /* Set value of power down register for sleep mode */
293 exynos_sys_powerdown_conf(SYS_SLEEP);
294 pmu_raw_writel(EXYNOS_SLEEP_MAGIC, S5P_INFORM1);
297 static void exynos_pm_prepare(void)
299 exynos_set_delayed_reset_assertion(false);
301 /* Set wake-up mask registers */
302 exynos_pm_set_wakeup_mask();
304 exynos_pm_enter_sleep_mode();
306 /* ensure at least INFORM0 has the resume address */
307 pmu_raw_writel(__pa_symbol(exynos_cpu_resume), S5P_INFORM0);
310 static void exynos3250_pm_prepare(void)
314 /* Set wake-up mask registers */
315 exynos_pm_set_wakeup_mask();
317 tmp = pmu_raw_readl(EXYNOS3_ARM_L2_OPTION);
318 tmp &= ~EXYNOS5_OPTION_USE_RETENTION;
319 pmu_raw_writel(tmp, EXYNOS3_ARM_L2_OPTION);
321 exynos_pm_enter_sleep_mode();
323 /* ensure at least INFORM0 has the resume address */
324 pmu_raw_writel(__pa_symbol(exynos_cpu_resume), S5P_INFORM0);
327 static void exynos5420_pm_prepare(void)
331 /* Set wake-up mask registers */
332 exynos_pm_set_wakeup_mask();
334 pm_state.pmu_spare3 = pmu_raw_readl(S5P_PMU_SPARE3);
336 * The cpu state needs to be saved and restored so that the
337 * secondary CPUs will enter low power start. Though the U-Boot
338 * is setting the cpu state with low power flag, the kernel
339 * needs to restore it back in case, the primary cpu fails to
340 * suspend for any reason.
342 pm_state.cpu_state = readl_relaxed(pm_state.sysram_base +
343 EXYNOS5420_CPU_STATE);
345 exynos_pm_enter_sleep_mode();
347 /* ensure at least INFORM0 has the resume address */
348 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM))
349 pmu_raw_writel(__pa_symbol(mcpm_entry_point), S5P_INFORM0);
351 tmp = pmu_raw_readl(EXYNOS_L2_OPTION(0));
352 tmp &= ~EXYNOS_L2_USE_RETENTION;
353 pmu_raw_writel(tmp, EXYNOS_L2_OPTION(0));
355 tmp = pmu_raw_readl(EXYNOS5420_SFR_AXI_CGDIS1);
356 tmp |= EXYNOS5420_UFS;
357 pmu_raw_writel(tmp, EXYNOS5420_SFR_AXI_CGDIS1);
359 tmp = pmu_raw_readl(EXYNOS5420_ARM_COMMON_OPTION);
360 tmp &= ~EXYNOS5420_L2RSTDISABLE_VALUE;
361 pmu_raw_writel(tmp, EXYNOS5420_ARM_COMMON_OPTION);
363 tmp = pmu_raw_readl(EXYNOS5420_FSYS2_OPTION);
364 tmp |= EXYNOS5420_EMULATION;
365 pmu_raw_writel(tmp, EXYNOS5420_FSYS2_OPTION);
367 tmp = pmu_raw_readl(EXYNOS5420_PSGEN_OPTION);
368 tmp |= EXYNOS5420_EMULATION;
369 pmu_raw_writel(tmp, EXYNOS5420_PSGEN_OPTION);
373 static int exynos_pm_suspend(void)
375 exynos_pm_central_suspend();
377 /* Setting SEQ_OPTION register */
378 pmu_raw_writel(S5P_USE_STANDBY_WFI0 | S5P_USE_STANDBY_WFE0,
379 S5P_CENTRAL_SEQ_OPTION);
381 if (read_cpuid_part() == ARM_CPU_PART_CORTEX_A9)
382 exynos_cpu_save_register();
387 static int exynos5420_pm_suspend(void)
391 exynos_pm_central_suspend();
393 /* Setting SEQ_OPTION register */
395 this_cluster = MPIDR_AFFINITY_LEVEL(read_cpuid_mpidr(), 1);
397 pmu_raw_writel(EXYNOS5420_ARM_USE_STANDBY_WFI0,
398 S5P_CENTRAL_SEQ_OPTION);
400 pmu_raw_writel(EXYNOS5420_KFC_USE_STANDBY_WFI0,
401 S5P_CENTRAL_SEQ_OPTION);
405 static void exynos_pm_resume(void)
407 u32 cpuid = read_cpuid_part();
409 if (exynos_pm_central_resume())
412 if (cpuid == ARM_CPU_PART_CORTEX_A9)
415 if (call_firmware_op(resume) == -ENOSYS
416 && cpuid == ARM_CPU_PART_CORTEX_A9)
417 exynos_cpu_restore_register();
421 /* Clear SLEEP mode set in INFORM1 */
422 pmu_raw_writel(0x0, S5P_INFORM1);
423 exynos_set_delayed_reset_assertion(true);
426 static void exynos3250_pm_resume(void)
428 u32 cpuid = read_cpuid_part();
430 if (exynos_pm_central_resume())
433 pmu_raw_writel(S5P_USE_STANDBY_WFI_ALL, S5P_CENTRAL_SEQ_OPTION);
435 if (call_firmware_op(resume) == -ENOSYS
436 && cpuid == ARM_CPU_PART_CORTEX_A9)
437 exynos_cpu_restore_register();
441 /* Clear SLEEP mode set in INFORM1 */
442 pmu_raw_writel(0x0, S5P_INFORM1);
445 static void exynos5420_prepare_pm_resume(void)
447 if (IS_ENABLED(CONFIG_EXYNOS5420_MCPM))
448 WARN_ON(mcpm_cpu_powered_up());
451 static void exynos5420_pm_resume(void)
455 /* Restore the CPU0 low power state register */
456 tmp = pmu_raw_readl(EXYNOS5_ARM_CORE0_SYS_PWR_REG);
457 pmu_raw_writel(tmp | S5P_CORE_LOCAL_PWR_EN,
458 EXYNOS5_ARM_CORE0_SYS_PWR_REG);
460 /* Restore the sysram cpu state register */
461 writel_relaxed(pm_state.cpu_state,
462 pm_state.sysram_base + EXYNOS5420_CPU_STATE);
464 pmu_raw_writel(EXYNOS5420_USE_STANDBY_WFI_ALL,
465 S5P_CENTRAL_SEQ_OPTION);
467 if (exynos_pm_central_resume())
470 pmu_raw_writel(pm_state.pmu_spare3, S5P_PMU_SPARE3);
474 tmp = pmu_raw_readl(EXYNOS5420_SFR_AXI_CGDIS1);
475 tmp &= ~EXYNOS5420_UFS;
476 pmu_raw_writel(tmp, EXYNOS5420_SFR_AXI_CGDIS1);
478 tmp = pmu_raw_readl(EXYNOS5420_FSYS2_OPTION);
479 tmp &= ~EXYNOS5420_EMULATION;
480 pmu_raw_writel(tmp, EXYNOS5420_FSYS2_OPTION);
482 tmp = pmu_raw_readl(EXYNOS5420_PSGEN_OPTION);
483 tmp &= ~EXYNOS5420_EMULATION;
484 pmu_raw_writel(tmp, EXYNOS5420_PSGEN_OPTION);
486 /* Clear SLEEP mode set in INFORM1 */
487 pmu_raw_writel(0x0, S5P_INFORM1);
494 static int exynos_suspend_enter(suspend_state_t state)
496 u32 eint_wakeup_mask = exynos_read_eint_wakeup_mask();
499 pr_debug("%s: suspending the system...\n", __func__);
501 pr_debug("%s: wakeup masks: %08x,%08x\n", __func__,
502 exynos_irqwake_intmask, eint_wakeup_mask);
504 if (exynos_irqwake_intmask == -1U
505 && eint_wakeup_mask == EXYNOS_EINT_WAKEUP_MASK_DISABLED) {
506 pr_err("%s: No wake-up sources!\n", __func__);
507 pr_err("%s: Aborting sleep\n", __func__);
511 if (pm_data->pm_prepare)
512 pm_data->pm_prepare();
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();
524 pr_debug("%s: wakeup stat: %08x\n", __func__,
525 pmu_raw_readl(S5P_WAKEUP_STAT));
527 pr_debug("%s: resuming the system...\n", __func__);
532 static int exynos_suspend_prepare(void)
537 * REVISIT: It would be better if struct platform_suspend_ops
538 * .prepare handler get the suspend_state_t as a parameter to
539 * avoid hard-coding the suspend to mem state. It's safe to do
540 * it now only because the suspend_valid_only_mem function is
541 * used as the .valid callback used to check if a given state
542 * is supported by the platform anyways.
544 ret = regulator_suspend_prepare(PM_SUSPEND_MEM);
546 pr_err("Failed to prepare regulators for suspend (%d)\n", ret);
553 static void exynos_suspend_finish(void)
557 ret = regulator_suspend_finish();
559 pr_warn("Failed to resume regulators from suspend (%d)\n", ret);
562 static const struct platform_suspend_ops exynos_suspend_ops = {
563 .enter = exynos_suspend_enter,
564 .prepare = exynos_suspend_prepare,
565 .finish = exynos_suspend_finish,
566 .valid = suspend_valid_only_mem,
569 static const struct exynos_pm_data exynos3250_pm_data = {
570 .wkup_irq = exynos3250_wkup_irq,
571 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
572 .pm_suspend = exynos_pm_suspend,
573 .pm_resume = exynos3250_pm_resume,
574 .pm_prepare = exynos3250_pm_prepare,
575 .cpu_suspend = exynos3250_cpu_suspend,
578 static const struct exynos_pm_data exynos4_pm_data = {
579 .wkup_irq = exynos4_wkup_irq,
580 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
581 .pm_suspend = exynos_pm_suspend,
582 .pm_resume = exynos_pm_resume,
583 .pm_prepare = exynos_pm_prepare,
584 .cpu_suspend = exynos_cpu_suspend,
587 static const struct exynos_pm_data exynos5250_pm_data = {
588 .wkup_irq = exynos5250_wkup_irq,
589 .wake_disable_mask = ((0xFF << 8) | (0x1F << 1)),
590 .pm_suspend = exynos_pm_suspend,
591 .pm_resume = exynos_pm_resume,
592 .pm_prepare = exynos_pm_prepare,
593 .cpu_suspend = exynos_cpu_suspend,
596 static const struct exynos_pm_data exynos5420_pm_data = {
597 .wkup_irq = exynos5250_wkup_irq,
598 .wake_disable_mask = (0x7F << 7) | (0x1F << 1),
599 .pm_resume_prepare = exynos5420_prepare_pm_resume,
600 .pm_resume = exynos5420_pm_resume,
601 .pm_suspend = exynos5420_pm_suspend,
602 .pm_prepare = exynos5420_pm_prepare,
603 .cpu_suspend = exynos5420_cpu_suspend,
606 static const struct of_device_id exynos_pmu_of_device_ids[] __initconst = {
608 .compatible = "samsung,exynos3250-pmu",
609 .data = &exynos3250_pm_data,
611 .compatible = "samsung,exynos4210-pmu",
612 .data = &exynos4_pm_data,
614 .compatible = "samsung,exynos4412-pmu",
615 .data = &exynos4_pm_data,
617 .compatible = "samsung,exynos5250-pmu",
618 .data = &exynos5250_pm_data,
620 .compatible = "samsung,exynos5420-pmu",
621 .data = &exynos5420_pm_data,
626 static struct syscore_ops exynos_pm_syscore_ops;
628 void __init exynos_pm_init(void)
630 const struct of_device_id *match;
631 struct device_node *np;
634 np = of_find_matching_node_and_match(NULL, exynos_pmu_of_device_ids, &match);
636 pr_err("Failed to find PMU node\n");
640 if (WARN_ON(!of_find_property(np, "interrupt-controller", NULL))) {
641 pr_warn("Outdated DT detected, suspend/resume will NOT work\n");
645 pm_data = (const struct exynos_pm_data *) match->data;
647 /* All wakeup disable */
648 tmp = pmu_raw_readl(S5P_WAKEUP_MASK);
649 tmp |= pm_data->wake_disable_mask;
650 pmu_raw_writel(tmp, S5P_WAKEUP_MASK);
652 exynos_pm_syscore_ops.suspend = pm_data->pm_suspend;
653 exynos_pm_syscore_ops.resume = pm_data->pm_resume;
655 register_syscore_ops(&exynos_pm_syscore_ops);
656 suspend_set_ops(&exynos_suspend_ops);
659 * Applicable as of now only to Exynos542x. If booted under secure
660 * firmware, the non-secure region of sysram should be used.
662 if (exynos_secure_firmware_available())
663 pm_state.sysram_base = sysram_ns_base_addr;
665 pm_state.sysram_base = sysram_base_addr;