[nrf toup] nordic: Reorganize how gen_uicr.py is invoked

Reorganize how gen_uicr.py is invoked.

Instead of invoking it from one of the Zephyr images we invoke it from
a new special Zephyr image called uicr.

This uicr Zephyr image is flashed in the same way as normal Zephyr
images so special handling in the runner is no longer necessary.

gen_uicr.py has been modified to no longer create a seperate hex file
for periphconf as the runner infrastructure expects to only flash one
hex file.

Also, we simplify gen_uicr.py by moving parsing of Kconfig/DT from
gen_uicr.py to CMake.

Ref: NCSDK-NONE

Signed-off-by: Sebastian Bøe <[email protected]>

Author: SebastianBoe

scripts/west_commands/runners/nrf_common.py

@@ -433,26 +433,6 @@ def program_hex(self):
                             core='Application',
                         )
 
-            if self.build_conf.getboolean("CONFIG_NRF_HALTIUM_GENERATE_UICR"):
-                zephyr_build_dir = Path(self.cfg.build_dir) / 'zephyr'
-
-                self.op_program(
-                    str(zephyr_build_dir / 'uicr.hex'),
-                    'ERASE_NONE',
-                    None,
-                    defer=True,
-                    core='Application',
-                )
-
-                if self.build_conf.getboolean("CONFIG_NRF_HALTIUM_UICR_PERIPHCONF"):
-                    self.op_program(
-                        str(zephyr_build_dir / 'periphconf.hex'),
-                        'ERASE_NONE',
-                        None,
-                        defer=True,
-                        core='Application',
-                    )
-
             if not self.erase and regtool_generated_uicr:
                 self.exec_op('erase', core=core, kind='uicr')
         else:

soc/nordic/Kconfig.sysbuild

@@ -4,5 +4,6 @@
 config HAS_NORDIC_VPR_LAUNCHER_IMAGE
 	bool
 
+rsource "common/uicr/Kconfig.sysbuild"
 rsource "common/vpr/Kconfig.sysbuild"
 orsource "*/Kconfig.sysbuild"

soc/nordic/common/CMakeLists.txt

@@ -3,7 +3,7 @@
 
 add_subdirectory_ifdef(CONFIG_RISCV_CORE_NORDIC_VPR vpr)
 
-if(CONFIG_NRF_PERIPHCONF_SECTION OR CONFIG_NRF_HALTIUM_GENERATE_UICR)
+if(CONFIG_NRF_PERIPHCONF_SECTION)
   add_subdirectory(uicr)
 endif()
 

soc/nordic/common/uicr/CMakeLists.txt

@@ -4,33 +4,3 @@
 if(CONFIG_NRF_PERIPHCONF_SECTION)
   zephyr_linker_sources(SECTIONS uicr.ld)
 endif()
-
-if(CONFIG_NRF_HALTIUM_GENERATE_UICR)
-  if(CONFIG_NRF_PERIPHCONF_SECTION)
-    set(in_periphconf_elf_arg
-      --in-periphconf-elf $<TARGET_FILE:${ZEPHYR_LINK_STAGE_EXECUTABLE}>
-    )
-  endif()
-
-  if(CONFIG_NRF_HALTIUM_UICR_PERIPHCONF)
-    set(periphconf_hex_file ${PROJECT_BINARY_DIR}/periphconf.hex)
-    set(out_periphconf_hex_arg
-      --out-periphconf-hex ${periphconf_hex_file}
-    )
-    list(APPEND optional_byproducts ${periphconf_hex_file})
-  endif()
-
-  set(uicr_hex_file ${PROJECT_BINARY_DIR}/uicr.hex)
-  set_property(GLOBAL APPEND PROPERTY extra_post_build_commands
-    COMMAND ${CMAKE_COMMAND} -E env PYTHONPATH=${ZEPHYR_BASE}/scripts/dts/python-devicetree/src
-    ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_LIST_DIR}/gen_uicr.py
-    --in-config ${DOTCONFIG}
-    --in-edt-pickle ${EDT_PICKLE}
-    ${in_periphconf_elf_arg}
-    ${out_periphconf_hex_arg}
-    --out-uicr-hex ${uicr_hex_file}
-  )
-  set_property(GLOBAL APPEND PROPERTY extra_post_build_byproducts
-    ${uicr_hex_file} ${optional_byproducts}
-  )
-endif()

soc/nordic/common/uicr/Kconfig

@@ -1,29 +1,9 @@
 # Copyright (c) 2025 Nordic Semiconductor ASA
 # SPDX-License-Identifier: Apache-2.0
 
-config NRF_HALTIUM_GENERATE_UICR
-	bool "Generate UICR file"
-	depends on SOC_NRF54H20_CPUAPP
-	default y
-	help
-	  Generate UICR HEX file.
-
-if NRF_HALTIUM_GENERATE_UICR
-
-config NRF_HALTIUM_UICR_PERIPHCONF
-	bool "Initialize global domain peripherals"
-	default y
-	help
-	  Generates a blob containing static global domain peripheral initialization
-	  values extracted from the build artifacts, and configures UICR.PERIPHCONF
-	  to point at the blob. The initialization values are then loaded ahead of
-	  ahead of the application boot.
-
-endif
-
 config NRF_PERIPHCONF_SECTION
 	bool "Populate global peripheral initialization section"
-	default y if SOC_NRF54H20_CPUAPP
+	default y if SOC_NRF54H20_CPUAPP || SOC_NRF54H20_CPURAD
 	depends on LINKER_DEVNULL_SUPPORT
 	imply LINKER_DEVNULL_MEMORY
 	help

soc/nordic/common/uicr/Kconfig.sysbuild

@@ -0,0 +1,7 @@
+config NRF_HALTIUM_GENERATE_UICR
+	bool "Generate UICR file"
+	depends on SOC_SERIES_NRF54HX
+	default y
+	help
+	  Generate UICR HEX file.
+

soc/nordic/common/uicr/gen_uicr.py

@@ -8,10 +8,7 @@
 import argparse
 import ctypes as c
 import math
-import pickle
-import re
 import sys
-from collections import defaultdict
 from itertools import groupby
 
 from elftools.elf.elffile import ELFFile
@@ -25,11 +22,6 @@
 # Must match the name used in the linker script.
 PERIPHCONF_SECTION = "uicr_periphconf_entry"
 
-# Expected nodelabel of the UICR devicetree node, used to extract its location from the devicetree.
-UICR_NODELABEL = "uicr"
-# Nodelabel of the PERIPHCONF devicetree node, used to extract its location from the devicetree.
-PERIPHCONF_NODELABEL = "periphconf_partition"
-
 # Common values for representing enabled/disabled in the UICR format.
 ENABLED_VALUE = 0xFFFF_FFFF
 DISABLED_VALUE = 0xBD23_28A8
@@ -141,18 +133,6 @@ def main() -> None:
             "peripherals, and to protect the device in various ways."
         ),
     )
-    parser.add_argument(
-        "--in-config",
-        required=True,
-        type=argparse.FileType("r"),
-        help="Path to the .config file from the application build",
-    )
-    parser.add_argument(
-        "--in-edt-pickle",
-        required=True,
-        type=argparse.FileType("rb"),
-        help="Path to the edt.pickle file from the application build",
-    )
     parser.add_argument(
         "--in-periphconf-elf",
         dest="in_periphconf_elfs",
@@ -169,13 +149,25 @@ def main() -> None:
         "--out-uicr-hex",
         required=True,
         type=argparse.FileType("w", encoding="utf-8"),
-        help="Path to write the generated UICR HEX file to",
+        help="Path to write the generated merged UICR+PERIPHCONF HEX file to (typically zephyr.hex)",
     )
     parser.add_argument(
-        "--out-periphconf-hex",
+        "--periphconf-address",
         default=None,
-        type=argparse.FileType("w", encoding="utf-8"),
-        help="Path to write the generated PERIPHCONF HEX file to",
+        type=lambda s: int(s, 0),
+        help="Absolute flash address of the PERIPHCONF partition (decimal or 0x-prefixed hex)",
+    )
+    parser.add_argument(
+        "--periphconf-size",
+        default=None,
+        type=lambda s: int(s, 0),
+        help="Size in bytes of the PERIPHCONF partition (decimal or 0x-prefixed hex)",
+    )
+    parser.add_argument(
+        "--uicr-address",
+        required=True,
+        type=lambda s: int(s, 0),
+        help="Absolute flash address of the UICR region (decimal or 0x-prefixed hex)",
     )
     args = parser.parse_args()
 
@@ -186,49 +178,27 @@ def main() -> None:
         uicr.VERSION.MAJOR = UICR_FORMAT_VERSION_MAJOR
         uicr.VERSION.MINOR = UICR_FORMAT_VERSION_MINOR
 
-        kconfig_str = args.in_config.read()
-        kconfig = parse_kconfig(kconfig_str)
-
-        edt = pickle.load(args.in_edt_pickle)
+        # Create a single hex object that will contain both UICR and periphconf data
+        merged_hex = IntelHex()
 
-        try:
-            periphconf_partition = edt.label2node[PERIPHCONF_NODELABEL]
-        except LookupError as e:
-            raise ScriptError(
-                "Failed to find a PERIPHCONF partition in the devicetree. "
-                f"Expected a DT node with label '{PERIPHCONF_NODELABEL}'."
-            ) from e
+        if args.in_periphconf_elfs:  # Check if periphconf data is provided
+            periphconf_combined = extract_and_combine_periphconfs(args.in_periphconf_elfs)
 
-        flash_base_address = periphconf_partition.flash_controller.regs[0].addr
-        periphconf_address = flash_base_address + periphconf_partition.regs[0].addr
-        periphconf_size = periphconf_partition.regs[0].size
+            padding_len = args.periphconf_size - len(periphconf_combined)
+            periphconf_final = periphconf_combined + bytes([0xFF for _ in range(padding_len)])
 
-        periphconf_combined = extract_and_combine_periphconfs(args.in_periphconf_elfs)
-        padding_len = periphconf_size - len(periphconf_combined)
-        periphconf_final = periphconf_combined + bytes([0xFF for _ in range(padding_len)])
+            # Add periphconf data to the merged hex
+            merged_hex.frombytes(periphconf_final, offset=args.periphconf_address)
 
-        if kconfig.get("CONFIG_NRF_HALTIUM_UICR_PERIPHCONF") == "y":
             uicr.PERIPHCONF.ENABLE = ENABLED_VALUE
-            uicr.PERIPHCONF.ADDRESS = periphconf_address
-            uicr.PERIPHCONF.MAXCOUNT = math.floor(periphconf_size / 8)
-
-        try:
-            uicr_node = edt.label2node[UICR_NODELABEL]
-        except LookupError as e:
-            raise ScriptError(
-                "Failed to find UICR node in the devicetree. "
-                f"Expected a DT node with label '{UICR_NODELABEL}'."
-            ) from e
+            uicr.PERIPHCONF.ADDRESS = args.periphconf_address
+            uicr.PERIPHCONF.MAXCOUNT = math.floor(args.periphconf_size / 8)
 
-        uicr_hex = IntelHex()
-        uicr_hex.frombytes(bytes(uicr), offset=uicr_node.regs[0].addr)
+        # Add UICR data to the merged hex
+        merged_hex.frombytes(bytes(uicr), offset=args.uicr_address)
 
-        uicr_hex.write_hex_file(args.out_uicr_hex)
-
-        if args.out_periphconf_hex is not None:
-            periphconf_hex = IntelHex()
-            periphconf_hex.frombytes(periphconf_final, offset=periphconf_address)
-            periphconf_hex.write_hex_file(args.out_periphconf_hex)
+        # Write the merged hex file containing both UICR and periphconf data
+        merged_hex.write_hex_file(args.out_uicr_hex)
 
     except ScriptError as e:
         print(f"Error: {e!s}")
@@ -270,16 +240,5 @@ def extract_and_combine_periphconfs(elf_files: list[argparse.FileType]) -> bytes
     return bytes(final_periphconf)
 
 
-def parse_kconfig(content: str) -> dict[str, str | None]:
-    result = defaultdict(None)
-    match_iter = re.finditer(
-        r"^(?P<config>(SB_)?CONFIG_[^=\s]+)=(?P<value>[^\s#])+$", content, re.MULTILINE
-    )
-    for match in match_iter:
-        result[match["config"]] = match["value"]
-
-    return result
-
-
 if __name__ == "__main__":
     main()

soc/nordic/common/uicr/gen_uicr/CMakeLists.txt

@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The code in this CMakeLists.txt constructs the arguments for gen_uicr.py
+# and creates a flashable zephyr.hex file containing UICR data (no C code compiled)
+#
+
+cmake_minimum_required(VERSION 3.20.0)
+
+# Instead of adding all of Zephyr we add just the subset that is
+# required to generate uicr.hex.
+#
+# The generation of uicr.hex is configured by this image, so we
+# include modules from zephyr_default up until kconfig.
+
+find_package(Zephyr
+  COMPONENTS zephyr_default:kconfig
+  REQUIRED HINTS $ENV{ZEPHYR_BASE}
+  )
+
+project(uicr)
+
+# Use CMAKE_VERBOSE_MAKEFILE to silence an unused-variable warning.
+if(CMAKE_VERBOSE_MAKEFILE)
+endif()
+
+set(periphconf_args)
+set(periphconf_elfs)
+set(zephyr_hex_file ${APPLICATION_BINARY_DIR}/zephyr/zephyr.hex)
+
+# Compute UICR absolute address from this image's devicetree
+dt_nodelabel(uicr_path NODELABEL "uicr")
+
+if(NOT DEFINED uicr_path)
+  message(FATAL_ERROR "uicr node not found in devicetree")
+endif()
+
+dt_reg_addr(UICR_ADDRESS PATH ${uicr_path})
+
+if(NOT DEFINED UICR_ADDRESS)
+  message(FATAL_ERROR "Failed to read UICR address from DT")
+endif()
+
+if(CONFIG_UICR_SAMPLE_GENERATE_PERIPHCONF)
+  # gen_uicr.py parses all zephyr.elf files. To find these files (which
+  # have not been built yet) we scan sibling build directories for
+  # zephyr.dts
+  get_filename_component(SYSBUILD_DIR ${APPLICATION_BINARY_DIR} DIRECTORY)
+  file(GLOB _siblings LIST_DIRECTORIES true "${SYSBUILD_DIR}/*")
+  foreach(_dir ${_siblings})
+    get_filename_component(_name ${_dir} NAME)
+    if(_name STREQUAL "uicr")
+      # This image is an exception to the rule. It has a zephyr.dts, but
+      # no zephyr.elf
+      continue()
+    endif()
+
+    if(EXISTS ${_dir}/zephyr/zephyr.dts)
+      list(APPEND periphconf_elfs ${_dir}/zephyr/zephyr.elf)
+    endif()
+  endforeach()
+
+  # Compute PERIPHCONF absolute address and size from this image's devicetree
+  dt_nodelabel(periph_path NODELABEL "periphconf_partition")
+  if(NOT DEFINED periph_path)
+    message(FATAL_ERROR "periphconf_partition not found in devicetree")
+  endif()
+
+  dt_reg_addr(PERIPHCONF_OFFSET PATH ${periph_path})
+  dt_reg_size(PERIPHCONF_SIZE PATH ${periph_path})
+
+  if(NOT DEFINED PERIPHCONF_OFFSET OR NOT DEFINED PERIPHCONF_SIZE)
+    message(FATAL_ERROR "Failed to read periphconf addresses from DT")
+  endif()
+
+  # Calculate absolute periphconf address
+  math(EXPR PERIPHCONF_ADDRESS "${CONFIG_FLASH_BASE_ADDRESS} + ${PERIPHCONF_OFFSET}" OUTPUT_FORMAT HEXADECIMAL)
+
+  # Set up periphconf arguments for gen_uicr.py
+  list(APPEND periphconf_args --periphconf-address ${PERIPHCONF_ADDRESS})
+  list(APPEND periphconf_args --periphconf-size ${PERIPHCONF_SIZE})
+
+  foreach(elf ${periphconf_elfs})
+    list(APPEND periphconf_args --in-periphconf-elf ${elf})
+  endforeach()
+endif(CONFIG_UICR_SAMPLE_GENERATE_PERIPHCONF)
+
+# Generate zephyr.hex file
+add_custom_command(
+  OUTPUT ${zephyr_hex_file}
+  COMMAND ${CMAKE_COMMAND} -E env PYTHONPATH=${ZEPHYR_BASE}/scripts/dts/python-devicetree/src
+          ${PYTHON_EXECUTABLE} ${ZEPHYR_BASE}/soc/nordic/common/uicr/gen_uicr.py
+          --uicr-address ${UICR_ADDRESS}
+          --out-uicr-hex ${zephyr_hex_file}
+          ${periphconf_args}
+  DEPENDS ${periphconf_elfs}
+  WORKING_DIRECTORY ${APPLICATION_BINARY_DIR}
+  COMMENT "Using gen_uicr.py to generate ${zephyr_hex_file} from ${periphconf_elfs}"
+)
+
+# Add zephyr subdirectory to handle flash configuration with correct paths
+add_subdirectory(zephyr)
+
+add_custom_target(gen_uicr ALL DEPENDS ${zephyr_hex_file})

soc/nordic/common/uicr/gen_uicr/Kconfig

@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: Apache-2.0
+
+source "Kconfig.zephyr"
+
+menu "UICR generator options"
+
+config UICR_SAMPLE_GENERATE_PERIPHCONF
+	bool "Generate PERIPHCONF hex alongside UICR"
+	default y
+	help
+	  When enabled, the UICR generator will emit periphconf.hex in addition to uicr.hex.
+
+endmenu