soc: nordic: uicr: 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.

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

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

Author: SebastianBoe

scripts/ci/check_compliance.py

@@ -1250,6 +1250,7 @@ def check_no_undef_outside_kconfig(self, kconf):
         "FOO_LOG_LEVEL",
         "FOO_SETTING_1",
         "FOO_SETTING_2",
+        "GEN_UICR_GENERATE_PERIPHCONF", # Used in specialized build tool, not part of main Kconfig
         "HEAP_MEM_POOL_ADD_SIZE_", # Used as an option matching prefix
         "HUGETLBFS",          # Linux, in boards/xtensa/intel_adsp_cavs25/doc
         "IAR_BUFFERED_WRITE",

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,9 +3,7 @@
 
 add_subdirectory_ifdef(CONFIG_RISCV_CORE_NORDIC_VPR vpr)
 
-if(CONFIG_NRF_PERIPHCONF_SECTION OR CONFIG_NRF_HALTIUM_GENERATE_UICR)
-  add_subdirectory(uicr)
-endif()
+add_subdirectory(uicr)
 
 # Let SystemInit() be called in place of soc_reset_hook() by default.
 zephyr_linker_symbol(SYMBOL soc_reset_hook EXPR "@SystemInit@")

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,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_SERIES_NRF54HX
+	default y
+	help
+	  Generate UICR HEX file.

soc/nordic/common/uicr/gen_uicr.py

@@ -7,11 +7,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 +21,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 +132,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",
@@ -165,71 +144,103 @@ def main() -> None:
             "by ascending address and cleared of duplicate entries."
         ),
     )
+    parser.add_argument(
+        "--out-merged-hex",
+        required=True,
+        type=argparse.FileType("w", encoding="utf-8"),
+        help="Path to write the merged UICR+PERIPHCONF HEX file to",
+    )
     parser.add_argument(
         "--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 UICR-only HEX file to",
     )
     parser.add_argument(
         "--out-periphconf-hex",
-        default=None,
         type=argparse.FileType("w", encoding="utf-8"),
-        help="Path to write the generated PERIPHCONF HEX file to",
+        help="Path to write the PERIPHCONF-only HEX file to",
+    )
+    parser.add_argument(
+        "--periphconf-address",
+        default=None,
+        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()
 
     try:
+        # Validate argument dependencies
+        if args.out_periphconf_hex:
+            if args.periphconf_address is None:
+                raise ScriptError(
+                    "--periphconf-address is required when --out-periphconf-hex is used"
+                )
+            if args.periphconf_size is None:
+                raise ScriptError("--periphconf-size is required when --out-periphconf-hex is used")
+
         init_values = DISABLED_VALUE.to_bytes(4, "little") * (c.sizeof(Uicr) // 4)
         uicr = Uicr.from_buffer_copy(init_values)
 
         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)
+        # Process periphconf data first and configure UICR completely before creating hex objects
+        periphconf_hex = IntelHex()
 
-        edt = pickle.load(args.in_edt_pickle)
+        if args.out_periphconf_hex:
+            periphconf_combined = extract_and_combine_periphconfs(args.in_periphconf_elfs)
 
-        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
+            padding_len = args.periphconf_size - len(periphconf_combined)
+            periphconf_final = periphconf_combined + bytes([0xFF for _ in range(padding_len)])
 
-        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
+            # Add periphconf data to periphconf hex object
+            periphconf_hex.frombytes(periphconf_final, offset=args.periphconf_address)
 
-        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)])
-
-        if kconfig.get("CONFIG_NRF_HALTIUM_UICR_PERIPHCONF") == "y":
+            # Configure UICR with periphconf settings
             uicr.PERIPHCONF.ENABLE = ENABLED_VALUE
-            uicr.PERIPHCONF.ADDRESS = periphconf_address
-            uicr.PERIPHCONF.MAXCOUNT = math.floor(periphconf_size / 8)
+            uicr.PERIPHCONF.ADDRESS = args.periphconf_address
+
+            # MAXCOUNT is given in number of 8-byte peripheral
+            # configuration entries and periphconf_size is given in
+            # bytes. When setting MAXCOUNT based on the
+            # periphconf_size we must first assert that
+            # periphconf_size has not been misconfigured.
+            if args.periphconf_size % 8 != 0:
+                raise ScriptError(
+                    f"args.periphconf_size was {args.periphconf_size}, but must be divisible by 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.MAXCOUNT = args.periphconf_size // 8
 
+        # Create UICR hex object with final UICR data
         uicr_hex = IntelHex()
-        uicr_hex.frombytes(bytes(uicr), offset=uicr_node.regs[0].addr)
+        uicr_hex.frombytes(bytes(uicr), offset=args.uicr_address)
 
-        uicr_hex.write_hex_file(args.out_uicr_hex)
+        # Create merged hex by combining UICR and periphconf hex objects
+        merged_hex = IntelHex()
+        merged_hex.fromdict(uicr_hex.todict())
 
-        if args.out_periphconf_hex is not None:
-            periphconf_hex = IntelHex()
-            periphconf_hex.frombytes(periphconf_final, offset=periphconf_address)
+        if args.out_periphconf_hex:
             periphconf_hex.write_hex_file(args.out_periphconf_hex)
 
+            merged_hex.fromdict(periphconf_hex.todict())
+
+        merged_hex.write_hex_file(args.out_merged_hex)
+        uicr_hex.write_hex_file(args.out_uicr_hex)
+
     except ScriptError as e:
         print(f"Error: {e!s}")
         sys.exit(1)
@@ -270,16 +281,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()