arch: Allow to specify memory for S2RAM resume

If the area, dedicated for the interrupt stack is not available, allow
to specify a memory region that will be used as the stack for the S2RAM
resume logic.

Signed-off-by: Tomasz Chyrowicz <[email protected]>

Author: tomchy

arch/arm/core/cortex_m/reset.S

@@ -101,6 +101,17 @@ SECTION_SUBSEC_FUNC(TEXT,_reset_section,__start)
 #endif /* CONFIG_INIT_ARCH_HW_AT_BOOT */
 
 #if defined(CONFIG_PM_S2RAM)
+#if DT_NODE_EXISTS(DT_NODELABEL(pm_s2ram_stack)) &&\
+	DT_NODE_HAS_COMPAT(DT_NODELABEL(pm_s2ram_stack), zephyr_memory_region)
+    /* In certain scenarios, the interrupt stack is actually not safe to overwrite.
+     * For example, when MCUboot is used, the bootloader's "z_interrupt_stack" and the
+     * loaded image's "z_interrupt_stacks" are NOT at the same address, and writing to
+     * the former would corrupt unrelated data from the loaded image. To support such
+     * scenarios, if the Device Tree provides a specially named "zephyr,memory-region",
+     * use it as the stack to run arch_pm_s2ram_resume instead of the interrupt stack.
+     */
+    ldr r0, =DT_REG_ADDR(DT_NODELABEL(pm_s2ram_stack)) + DT_REG_SIZE(DT_NODELABEL(pm_s2ram_stack))
+#else
     /*
      * Temporarily set MSP to interrupt stack so that arch_pm_s2ram_resume can
      * use stack for calling pm_s2ram_mark_check_and_clear.
@@ -113,6 +124,7 @@ SECTION_SUBSEC_FUNC(TEXT,_reset_section,__start)
      * a short while, there is no change in behavior in either of the paths.
      */
     ldr r0, =z_interrupt_stacks + CONFIG_ISR_STACK_SIZE + MPU_GUARD_ALIGN_AND_SIZE
+#endif
     msr msp, r0
 
     bl arch_pm_s2ram_resume

subsys/pm/Kconfig

@@ -41,6 +41,11 @@ config PM_S2RAM
 	  When enabled on Cortex-M, and a 'zephyr,memory-region' compatible node with nodelabel
 	  'pm_s2ram' is defined in DT, _cpu_context symbol (located in arch/arm/core/cortex_m/pm_s2ram.c)
 	  is placed in linker section given by 'zephyr,memory-region' property of aforementioned node.
+	  Additionally on Cortex-M, if a 'zephyr,memory-region' compatible node with nodelabel
+	  'pm_s2ram_stack' is defined in DT, this region will be used as a temporary program stack
+	  for the S2RAM resume logic. The assembly reset handling code itself makes a single push of
+	  the return address, but the SoC-specific function (pm_s2ram_mark_check_and_clear) must be
+	  analyzed to determine the required stack size.
 
 config PM_S2RAM_CUSTOM_MARKING
 	bool "Use custom marking functions"