samples: boards: nrf: system_off: Add nrf54h20dk support

Add support to nrf54h20dk/nrf54h20/cpuapp and cpurad in the sample.

Signed-off-by: Krzysztof Chruściński <[email protected]>

Author: nordic-krch

samples/boards/nordic/system_off/README.rst

@@ -25,7 +25,7 @@ RAM is configured to keep the containing section powered while in system-off mod
 Requirements
 ************
 
-This application uses nRF51 DK, nRF52 DK or nRF54L15 DK board for the demo.
+This application uses nRF51 DK, nRF52 DK, nRF54H20 DK or nRF54L15 DK board for the demo.
 
 Sample Output
 =============

samples/boards/nordic/system_off/remote/CMakeLists.txt

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(nrf_system_off_remote)
+
+target_sources(app PRIVATE src/main.c)

samples/boards/nordic/system_off/remote/prj.conf

@@ -0,0 +1,2 @@
+CONFIG_PM_DEVICE=y
+CONFIG_POWEROFF=y

samples/boards/nordic/system_off/remote/src/main.c

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/kernel.h>
+#include <zephyr/device.h>
+#include <zephyr/pm/device.h>
+#include <zephyr/sys/poweroff.h>
+#include <hal/nrf_memconf.h>
+
+int main(void)
+{
+	int rc;
+	const struct device *const cons = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
+
+	printf("%s system off demo. Ready for system off.\n", CONFIG_BOARD);
+
+	rc = pm_device_action_run(cons, PM_DEVICE_ACTION_SUSPEND);
+	if (rc < 0) {
+		printf("Could not suspend console (%d)\n", rc);
+		return 0;
+	}
+
+	/* Turn off retention of the local radio domain RAM. */
+	nrf_memconf_ramblock_ret_mask_enable_set(NRF_MEMCONF, 0, RAMBLOCK_RET_MASK, false);
+	nrf_memconf_ramblock_ret_mask_enable_set(NRF_MEMCONF, 1, RAMBLOCK_RET_MASK, false);
+
+	sys_poweroff();
+
+	return 0;
+}

samples/boards/nordic/system_off/src/main.c

@@ -16,6 +16,9 @@
 #include <zephyr/sys/poweroff.h>
 #include <zephyr/sys/util.h>
 #include <hal/nrf_gpio.h>
+#if CONFIG_SOC_NRF54H20_CPUAPP
+#include <hal/nrf_memconf.h>
+#endif
 
 #if IS_ENABLED(CONFIG_GRTC_WAKEUP_ENABLE)
 #include <zephyr/drivers/timer/nrf_grtc_timer.h>
@@ -114,6 +117,11 @@ int main(void)
 	}
 
 	if (do_poweroff) {
+#if CONFIG_SOC_NRF54H20_CPUAPP
+		/* Local RAM0 (TCM) is currently not used so retention can be disabled. */
+		nrf_memconf_ramblock_ret_mask_enable_set(NRF_MEMCONF, 0, RAMBLOCK_RET_MASK, false);
+		nrf_memconf_ramblock_ret_mask_enable_set(NRF_MEMCONF, 1, RAMBLOCK_RET_MASK, false);
+#endif
 		sys_poweroff();
 	} else {
 		k_sleep(K_FOREVER);

samples/boards/nordic/system_off/src/retained.c

@@ -16,12 +16,21 @@
 #include <zephyr/sys/crc.h>
 
 #if DT_NODE_HAS_STATUS_OKAY(DT_ALIAS(retainedmemdevice))
+#if CONFIG_SOC_NRF54H20_CPUAPP
+#include <hal/nrf_memconf.h>
+#else
+#endif
 const static struct device *retained_mem_device = DEVICE_DT_GET(DT_ALIAS(retainedmemdevice));
+#if CONFIG_SOC_NRF54H20_CPUAPP
+	/* Core is using global RAM memory which will be retained. Nothing to be done here. */
+	return 0;
+#else
 #else
 #error "retained_mem region not defined"
 #endif
 
 struct retained_data retained;
+#endif
 
 #define RETAINED_CRC_OFFSET offsetof(struct retained_data, crc)
 #define RETAINED_CHECKED_SIZE (RETAINED_CRC_OFFSET + sizeof(retained.crc))

samples/boards/nordic/system_off/sysbuild.cmake

@@ -0,0 +1,22 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+if("${SB_CONFIG_REMOTE_CORE_BOARD}" STREQUAL "")
+	message(FATAL_ERROR
+	"Target ${BOARD} not supported for this sample. "
+	"There is no remote board selected in Kconfig.sysbuild")
+endif()
+
+set(REMOTE_APP remote)
+
+ExternalZephyrProject_Add(
+	APPLICATION ${REMOTE_APP}
+	SOURCE_DIR  ${APP_DIR}/${REMOTE_APP}
+	BOARD       ${SB_CONFIG_BOARD}/${SB_CONFIG_SOC}/cpurad
+)
+
+# Add dependencies so that the remote sample will be built first
+# This is required because some primary cores need information from the
+# remote core's build, such as the output image's LMA
+add_dependencies(${DEFAULT_IMAGE} ${REMOTE_APP})
+sysbuild_add_dependencies(CONFIGURE ${DEFAULT_IMAGE} ${REMOTE_APP})