[nrf fromtree] modules: hal_nordic: move IronSide SE supporting code to hal_nordic

Move most of the code that is used to interface with IronSide SE on the
nRF54H20/nRF9280 from the soc/nordic directory to the hal_nordic
repository. The interface code is now provided by the new IronSide
support package. Build system code and glue code that makes use of
Zephyr APIs is now located in the modules/hal_nordic directory.

Update the directory path for IronSide SE interface code in
MAINTAINERS.yml to match the move from soc/nordic/ironside to
modules/hal_nordic/ironside.

Also included are some refactoring changes and cleanup to match the new
supporting code.

C code and Kconfigs have been renamed to *ironside_se* / *IRONSIDE_SE*
to match the supporting code changes. Users of these APIs in zephyr
have been updated to match.

Individual configurations for different "IronSide services" have been
removed as the API serialization for all of these is now provided in
a single C file / header file (ironside/se/api.h).

The ironside_boot_report_get() API has been removed. The boot report
structure can be accessed through the IRONSIDE_SE_BOOT_REPORT macro.

Most configs relating to UICR / PERIPHCONF have been moved under the
"IronSide SE" menu to make it clear that these are part of the
IronSide SE interface.

The macros that in uicr.h that were used to add entries to the
PERIPHCONF section have been removed. The supporting code now provides
PERIPHCONF_XYZ() macros that can be used to initialize structures that
go into this section, and the zephyr part now only contains a macro
UICR_PERIPHCONF_ENTRY() that is used to place an arbitrary structure
into the section. The gen_periphconf_entries.py script used to generate
PERIPHCONF entries based on devicetree has been updated to use the new
macro system.

IronSide SE integration code/configs is now guarded by HAS_IRONSIDE_SE.

Note that the UICR build system integration that relies on Sysbuild
remains under the soc/nordic directory for now, but will be moved to
the modules/hal_nordic directory once it is clear how the integration
will look there.

Signed-off-by: Jonathan Nilsen <[email protected]>
(cherry picked from commit ef587e1)

Author: jonathannilsen

MAINTAINERS.yml

@@ -6050,7 +6050,7 @@ nRF IronSide SE Platforms:
     - karstenkoenig
     - SebastianBoe
   files:
-    - soc/nordic/ironside/
+    - modules/hal_nordic/ironside/
     - soc/nordic/common/uicr/
   labels:
     - "platform: nRF IronSide SE"

drivers/clock_control/Kconfig.nrf

@@ -290,7 +290,7 @@ endif # CLOCK_CONTROL_NRF_HSFLL_LOCAL
 config CLOCK_CONTROL_NRF_IRON_HSFLL_LOCAL
 	bool "NRF IronSide HSFLL LOCAL driver support"
 	depends on DT_HAS_NORDIC_NRF_IRON_HSFLL_LOCAL_ENABLED
-	select NRF_IRONSIDE_DVFS_SERVICE
+	select IRONSIDE_SE_DVFS
 	select CLOCK_CONTROL_NRF2_COMMON
 	default y
 

drivers/clock_control/clock_control_nrf_iron_hsfll_local.c

@@ -14,31 +14,31 @@ LOG_MODULE_DECLARE(clock_control_nrf2, CONFIG_CLOCK_CONTROL_LOG_LEVEL);
 
 BUILD_ASSERT(DT_NUM_INST_STATUS_OKAY(DT_DRV_COMPAT) == 1, "multiple instances not supported");
 
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
-#include <nrf_ironside/dvfs.h>
+#ifdef CONFIG_IRONSIDE_SE_DVFS
+#include <ironside_zephyr/se/dvfs.h>
 
 #define HSFLL_FREQ_LOW    MHZ(64)
 #define HSFLL_FREQ_MEDLOW MHZ(128)
 #define HSFLL_FREQ_HIGH   MHZ(320)
 
-#define IRONSIDE_DVFS_TIMEOUT K_MSEC(CONFIG_CLOCK_CONTROL_NRF_IRON_HSFLL_LOCAL_DVFS_TIMEOUT_MS)
+#define IRONSIDE_SE_DVFS_TIMEOUT K_MSEC(CONFIG_CLOCK_CONTROL_NRF_IRON_HSFLL_LOCAL_DVFS_TIMEOUT_MS)
 
 /* Clock options sorted from lowest to highest frequency */
 static const struct clock_options {
 	uint32_t frequency;
-	enum ironside_dvfs_oppoint setting;
+	enum ironside_se_dvfs_oppoint setting;
 } clock_options[] = {
 	{
 		.frequency = HSFLL_FREQ_LOW,
-		.setting = IRONSIDE_DVFS_OPP_LOW,
+		.setting = IRONSIDE_SE_DVFS_OPP_LOW,
 	},
 	{
 		.frequency = HSFLL_FREQ_MEDLOW,
-		.setting = IRONSIDE_DVFS_OPP_MEDLOW,
+		.setting = IRONSIDE_SE_DVFS_OPP_MEDLOW,
 	},
 	{
 		.frequency = HSFLL_FREQ_HIGH,
-		.setting = IRONSIDE_DVFS_OPP_HIGH,
+		.setting = IRONSIDE_SE_DVFS_OPP_HIGH,
 	},
 };
 
@@ -57,17 +57,17 @@ static void hsfll_update_timeout_handler(struct k_timer *timer)
 static void hsfll_work_handler(struct k_work *work)
 {
 	struct hsfll_dev_data *dev_data = CONTAINER_OF(work, struct hsfll_dev_data, clk_cfg.work);
-	enum ironside_dvfs_oppoint required_setting;
+	enum ironside_se_dvfs_oppoint required_setting;
 	uint8_t to_activate_idx;
 	int rc;
 
 	to_activate_idx = clock_config_update_begin(work);
 	required_setting = clock_options[to_activate_idx].setting;
 
-	k_timer_start(&dev_data->timer, IRONSIDE_DVFS_TIMEOUT, K_NO_WAIT);
+	k_timer_start(&dev_data->timer, IRONSIDE_SE_DVFS_TIMEOUT, K_NO_WAIT);
 
 	/* Request the DVFS service to change the OPP point. */
-	rc = ironside_dvfs_change_oppoint(required_setting);
+	rc = ironside_se_dvfs_change_oppoint(required_setting);
 	k_timer_stop(&dev_data->timer);
 	clock_config_update_end(&dev_data->clk_cfg, rc);
 }
@@ -123,12 +123,12 @@ static struct onoff_manager *hsfll_find_mgr_by_spec(const struct device *dev,
 	idx = hsfll_resolve_spec_to_idx(spec);
 	return idx < 0 ? NULL : hsfll_get_mgr_by_idx(dev, idx);
 }
-#endif /* CONFIG_NRF_IRONSIDE_DVFS_SERVICE */
+#endif /* CONFIG_IRONSIDE_SE_DVFS */
 
 static int api_request_hsfll(const struct device *dev, const struct nrf_clock_spec *spec,
 			     struct onoff_client *cli)
 {
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
+#ifdef CONFIG_IRONSIDE_SE_DVFS
 	struct onoff_manager *mgr = hsfll_find_mgr_by_spec(dev, spec);
 
 	if (mgr) {
@@ -143,7 +143,7 @@ static int api_request_hsfll(const struct device *dev, const struct nrf_clock_sp
 
 static int api_release_hsfll(const struct device *dev, const struct nrf_clock_spec *spec)
 {
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
+#ifdef CONFIG_IRONSIDE_SE_DVFS
 	struct onoff_manager *mgr = hsfll_find_mgr_by_spec(dev, spec);
 
 	if (mgr) {
@@ -159,7 +159,7 @@ static int api_release_hsfll(const struct device *dev, const struct nrf_clock_sp
 static int api_cancel_or_release_hsfll(const struct device *dev, const struct nrf_clock_spec *spec,
 				       struct onoff_client *cli)
 {
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
+#ifdef CONFIG_IRONSIDE_SE_DVFS
 	struct onoff_manager *mgr = hsfll_find_mgr_by_spec(dev, spec);
 
 	if (mgr) {
@@ -175,7 +175,7 @@ static int api_cancel_or_release_hsfll(const struct device *dev, const struct nr
 static int api_resolve_hsfll(const struct device *dev, const struct nrf_clock_spec *req_spec,
 			     struct nrf_clock_spec *res_spec)
 {
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
+#ifdef CONFIG_IRONSIDE_SE_DVFS
 	int idx;
 
 	idx = hsfll_resolve_spec_to_idx(req_spec);
@@ -192,7 +192,7 @@ static int api_resolve_hsfll(const struct device *dev, const struct nrf_clock_sp
 
 static int hsfll_init(const struct device *dev)
 {
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
+#ifdef CONFIG_IRONSIDE_SE_DVFS
 	struct hsfll_dev_data *dev_data = dev->data;
 	int rc;
 
@@ -220,14 +220,14 @@ static DEVICE_API(nrf_clock_control, hsfll_drv_api) = {
 	.resolve = api_resolve_hsfll,
 };
 
-#ifdef CONFIG_NRF_IRONSIDE_DVFS_SERVICE
+#ifdef CONFIG_IRONSIDE_SE_DVFS
 static struct hsfll_dev_data hsfll_data;
 #endif
 
 #ifdef CONFIG_CLOCK_CONTROL_NRF_IRON_HSFLL_LOCAL_REQ_LOW_FREQ
 static int dvfs_low_init(void)
 {
-	static const k_timeout_t timeout = IRONSIDE_DVFS_TIMEOUT;
+	static const k_timeout_t timeout = IRONSIDE_SE_DVFS_TIMEOUT;
 	static const struct device *hsfll_dev = DEVICE_DT_GET(DT_CLOCKS_CTLR(DT_NODELABEL(cpu)));
 	static const struct nrf_clock_spec clk_spec = {.frequency = HSFLL_FREQ_LOW};
 
@@ -238,7 +238,7 @@ SYS_INIT(dvfs_low_init, APPLICATION, 0);
 #endif
 
 DEVICE_DT_INST_DEFINE(0, hsfll_init, NULL,
-		      COND_CODE_1(CONFIG_NRF_IRONSIDE_DVFS_SERVICE,
+		      COND_CODE_1(CONFIG_IRONSIDE_SE_DVFS,
 				  (&hsfll_data),
 				  (NULL)), NULL, PRE_KERNEL_1,
 				   CONFIG_CLOCK_CONTROL_INIT_PRIORITY, &hsfll_drv_api);

drivers/debug/Kconfig.nrf

@@ -117,7 +117,7 @@ menuconfig DEBUG_CORESIGHT_NRF
 	default y
 	depends on DT_HAS_NORDIC_CORESIGHT_NRF_ENABLED
 	select PINCTRL
-	select NRF_IRONSIDE_TDD_SERVICE
+	select IRONSIDE_SE_CALL
 	help
 	  Support CoreSight peripherals in Test and Debug Domain for ARM
 	  CoreSight System Trace Macrocell (STM) trace support.

drivers/debug/debug_coresight_nrf.c

@@ -9,8 +9,8 @@
 #include <zephyr/drivers/pinctrl.h>
 #include <zephyr/sys/util.h>
 #include <zephyr/sys/sys_io.h>
-#include <nrf_ironside/tdd.h>
-#include <uicr/uicr.h>
+#include <ironside/se/api.h>
+#include <ironside_zephyr/se/uicr_periphconf.h>
 
 #undef ETR_MODE_MODE_CIRCULARBUF
 
@@ -262,7 +262,7 @@ static int coresight_nrf_init(const struct device *dev)
 	return 0;
 }
 
-#define DEBUG_CORESIGHT_NRF_INIT_PRIORITY UTIL_INC(CONFIG_NRF_IRONSIDE_CALL_INIT_PRIORITY)
+#define DEBUG_CORESIGHT_NRF_INIT_PRIORITY UTIL_INC(CONFIG_IRONSIDE_SE_CALL_INIT_PRIORITY)
 
 #define CORESIGHT_NRF_INST(inst)                                                                   \
 	COND_CODE_1(DT_INST_PINCTRL_HAS_IDX(inst, 0),                                      \

drivers/debug/debug_nrf_etr.c

@@ -792,7 +792,7 @@ int etr_process_init(void)
 	return 0;
 }
 
-#define NRF_ETR_INIT_PRIORITY UTIL_INC(UTIL_INC(CONFIG_NRF_IRONSIDE_CALL_INIT_PRIORITY))
+#define NRF_ETR_INIT_PRIORITY UTIL_INC(UTIL_INC(CONFIG_IRONSIDE_SE_CALL_INIT_PRIORITY))
 
 SYS_INIT(etr_process_init, POST_KERNEL, NRF_ETR_INIT_PRIORITY);
 

modules/hal_nordic/CMakeLists.txt

@@ -5,6 +5,7 @@ if (CONFIG_NRF_802154_RADIO_DRIVER OR CONFIG_NRF_802154_SERIALIZATION)
   add_subdirectory(nrf_802154)
 endif (CONFIG_NRF_802154_RADIO_DRIVER OR CONFIG_NRF_802154_SERIALIZATION)
 
+add_subdirectory_ifdef(CONFIG_HAS_IRONSIDE_SE ironside/se)
 add_subdirectory_ifdef(CONFIG_HAS_NRFX nrfx)
 add_subdirectory_ifdef(CONFIG_HAS_NRFS nrfs)
 

modules/hal_nordic/Kconfig

@@ -258,6 +258,7 @@ endif # NRF_802154_RADIO_DRIVER || NRF_802154_SERIALIZATION
 
 endmenu # HAS_NORDIC_DRIVERS
 
+rsource "ironside/se/Kconfig"
 rsource "nrfs/Kconfig"
 rsource "nrfx/Kconfig"
 rsource "Kconfig.nrf_regtool"

soc/nordic/common/uicr/CMakeLists.txt …es/hal_nordic/ironside/se/CMakeLists.txtsoc/nordic/common/uicr/CMakeLists.txt renamed to modules/hal_nordic/ironside/se/CMakeLists.txt soc/nordic/common/uicr/CMakeLists.txt renamed to modules/hal_nordic/ironside/se/CMakeLists.txt

@@ -1,6 +1,26 @@
 # Copyright (c) 2025 Nordic Semiconductor ASA
 # SPDX-License-Identifier: Apache-2.0
 
+# The IronSide source directory can be overridden by setting
+# IRONSIDE_SUPPORT_DIR before invoking the build system.
+zephyr_get(IRONSIDE_SUPPORT_DIR SYSBUILD GLOBAL)
+if(NOT DEFINED IRONSIDE_SUPPORT_DIR)
+  set(IRONSIDE_SUPPORT_DIR
+    ${ZEPHYR_CURRENT_MODULE_DIR}/ironside CACHE PATH "IronSide Support Directory"
+  )
+endif()
+
+zephyr_include_directories(include)
+zephyr_include_directories(${IRONSIDE_SUPPORT_DIR}/se/include)
+
+zephyr_library()
+zephyr_library_property(ALLOW_EMPTY TRUE)
+zephyr_library_sources_ifdef(CONFIG_IRONSIDE_SE_CALL
+  ${IRONSIDE_SUPPORT_DIR}/se/src/ironside_se_api.c
+  call.c
+)
+zephyr_library_sources_ifdef(CONFIG_IRONSIDE_SE_DVFS dvfs.c)
+
 if(CONFIG_NRF_PERIPHCONF_SECTION)
   zephyr_linker_sources(SECTIONS uicr.ld)
 endif()
@@ -10,7 +30,7 @@ if(CONFIG_NRF_PERIPHCONF_GENERATE_ENTRIES)
   execute_process(
     COMMAND
       ${CMAKE_COMMAND} -E env ZEPHYR_BASE=${ZEPHYR_BASE}
-      ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_LIST_DIR}/gen_periphconf_entries.py
+      ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_LIST_DIR}/scripts/gen_periphconf_entries.py
       --soc ${CONFIG_SOC}
       --in-edt-pickle ${EDT_PICKLE}
       --out-periphconf-source ${periphconf_entries_c_file}

modules/hal_nordic/ironside/se/Kconfig

@@ -0,0 +1,66 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+config HAS_IRONSIDE_SE
+	bool
+
+menu "IronSide SE"
+	depends on HAS_IRONSIDE_SE
+
+config IRONSIDE_SE_CALL
+	bool "IronSide calls"
+	default y
+	depends on DT_HAS_NORDIC_IRONSIDE_CALL_ENABLED
+	depends on MULTITHREADING
+	select EVENTS
+	select MBOX
+	help
+	  Support for IronSide call APIs.
+
+if IRONSIDE_SE_CALL
+
+config IRONSIDE_SE_CALL_INIT_PRIORITY
+	int "IronSide calls' driver initialization priority"
+	default 41
+	help
+	  Initialization priority of the IronSide call protocol driver.
+	  It must be below MBOX_INIT_PRIORITY, but higher than the priority of any feature
+	  that depends on IRONSIDE_SE_CALL.
+
+endif # IRONSIDE_SE_CALL
+
+config IRONSIDE_SE_DVFS
+	bool "DVFS support"
+	depends on SOC_NRF54H20_CPUAPP
+	depends on IRONSIDE_SE_CALL
+	help
+	  Support for changing the DVFS operating point.
+
+if IRONSIDE_SE_DVFS
+
+config IRONSIDE_SE_DVFS_ABB_STATUSANA_CHECK_MAX_ATTEMPTS
+	int "ABB analog status check maximum attempts"
+	range 0 255
+	default 50
+	help
+	  Maximum attempts with 10us intervals before busy status will be reported.
+
+endif # IRONSIDE_SE_DVFS
+
+menuconfig NRF_PERIPHCONF_SECTION
+	bool "Global peripheral initialization section"
+	depends on LINKER_DEVNULL_SUPPORT
+	imply LINKER_DEVNULL_MEMORY
+	help
+	  Include static global domain peripheral initialization values from the
+	  build in a dedicated section in the devnull region.
+
+config NRF_PERIPHCONF_GENERATE_ENTRIES
+	bool "Generate PERIPHCONF entries source file"
+	default y
+	depends on NRF_PERIPHCONF_SECTION
+	help
+	  Generate a C file containing PERIPHCONF entries based on the
+	  device configuration in the devicetree.
+
+endmenu # IronSide SE