[nrf fromlist] soc: nordic: Add UICR.RECOVERY.PERIPHCONF configuration support

Add support for configuring the UICR.RECOVERY.PERIPHCONF field.

Upstream PR #: 91826
Signed-off-by: Sebastian Bøe <[email protected]>

Author: SebastianBoe

boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20-memory_map.dtsi

@@ -166,5 +166,9 @@
 		periphconf_partition: partition@1ae000 {
 			reg = <0x1ae000 DT_SIZE_K(8)>;
 		};
+
+		periphconf_recovery_partition: partition@1b0000 {
+			reg = <0x1b0000 DT_SIZE_K(8)>;
+		};
 	};
 };

scripts/west_commands/runners/nrf_common.py

@@ -404,6 +404,15 @@ def program_hex(self):
                         core='Application',
                     )
 
+                if self.build_conf.getboolean("CONFIG_NRF_HALTIUM_UICR_RECOVERY_PERIPHCONF"):
+                    self.op_program(
+                        str(zephyr_build_dir / 'periphconf_recovery.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/common/uicr/CMakeLists.txt

@@ -20,6 +20,15 @@ if(CONFIG_NRF_HALTIUM_GENERATE_UICR)
     list(APPEND optional_byproducts ${periphconf_hex_file})
   endif()
 
+  set(out_periphconf_recovery_hex_arg)
+  if(CONFIG_NRF_HALTIUM_UICR_RECOVERY_PERIPHCONF)
+    set(periphconf_recovery_hex_file ${PROJECT_BINARY_DIR}/periphconf_recovery.hex)
+    set(out_periphconf_recovery_hex_arg
+      --out-periphconf-recovery-hex ${periphconf_recovery_hex_file}
+    )
+    list(APPEND optional_byproducts ${periphconf_recovery_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
@@ -28,6 +37,7 @@ if(CONFIG_NRF_HALTIUM_GENERATE_UICR)
     --in-edt-pickle ${EDT_PICKLE}
     ${in_periphconf_elf_arg}
     ${out_periphconf_hex_arg}
+    ${out_periphconf_recovery_hex_arg}
     --out-uicr-hex ${uicr_hex_file}
   )
   set_property(GLOBAL APPEND PROPERTY extra_post_build_byproducts

soc/nordic/common/uicr/Kconfig

@@ -60,6 +60,14 @@ config NRF_HALTIUM_UICR_RECOVERY_SIZE4KB
 	help
 	  Size of the recovery firmware partition in 4KB blocks.
 
+config NRF_HALTIUM_UICR_RECOVERY_PERIPHCONF
+	bool "Recovery firmware global domain peripheral configuration"
+	help
+	  Generates a blob containing static global domain peripheral initialization
+	  values extracted from recovery firmware build artifacts, and configures
+	  UICR.RECOVERY.PERIPHCONF to point at the blob. The initialization values
+	  are then loaded ahead of the recovery firmware boot.
+
 endif # NRF_HALTIUM_UICR_RECOVERY
 
 endif

soc/nordic/common/uicr/gen_uicr.py

@@ -25,6 +25,9 @@
 UICR_NODELABEL = "uicr"
 # Nodelabel of the PERIPHCONF devicetree node, used to extract its location from the devicetree.
 PERIPHCONF_NODELABEL = "periphconf_partition"
+# Nodelabel of the PERIPHCONF_RECOVERY devicetree node, used to extract its location
+# from the devicetree.
+PERIPHCONF_RECOVERY_NODELABEL = "periphconf_recovery_partition"
 
 # Common values for representing enabled/disabled in the UICR format.
 ENABLED_VALUE = 0xFFFF_FFFF
@@ -67,13 +70,23 @@ class Protectedmem(c.LittleEndianStructure):
     ]
 
 
+class Periphconf(c.LittleEndianStructure):
+    _pack_ = 1
+    _fields_ = [
+        ("ENABLE", c.c_uint32),
+        ("ADDRESS", c.c_uint32),
+        ("MAXCOUNT", c.c_uint32),
+    ]
+
+
 class Recovery(c.LittleEndianStructure):
     _pack_ = 1
     _fields_ = [
         ("ENABLE", c.c_uint32),
         ("PROCESSOR", c.c_uint32),
         ("INITSVTOR", c.c_uint32),
         ("SIZE4KB", c.c_uint32),
+        ("PERIPHCONF", Periphconf),
     ]
 
 
@@ -87,15 +100,6 @@ class Its(c.LittleEndianStructure):
     ]
 
 
-class Periphconf(c.LittleEndianStructure):
-    _pack_ = 1
-    _fields_ = [
-        ("ENABLE", c.c_uint32),
-        ("ADDRESS", c.c_uint32),
-        ("MAXCOUNT", c.c_uint32),
-    ]
-
-
 class Mpcconf(c.LittleEndianStructure):
     _pack_ = 1
     _fields_ = [
@@ -115,11 +119,13 @@ class Uicr(c.LittleEndianStructure):
         ("APPROTECT", Approtect),
         ("ERASEPROTECT", c.c_uint32),
         ("PROTECTEDMEM", Protectedmem),
-        ("RECOVERY", Recovery),
+        ("RESERVED2", c.c_uint32 * 4),
         ("ITS", Its),
-        ("RESERVED2", c.c_uint32 * 7),
+        ("RESERVED3", c.c_uint32 * 7),
         ("PERIPHCONF", Periphconf),
         ("MPCCONF", Mpcconf),
+        ("RESERVED4", c.c_uint32),
+        ("RECOVERY", Recovery),
     ]
 
 
@@ -169,6 +175,12 @@ def main() -> None:
         type=argparse.FileType("w", encoding="utf-8"),
         help="Path to write the generated PERIPHCONF HEX file to",
     )
+    parser.add_argument(
+        "--out-periphconf-recovery-hex",
+        default=None,
+        type=argparse.FileType("w", encoding="utf-8"),
+        help="Path to write the generated PERIPHCONF_RECOVERY HEX file to",
+    )
     args = parser.parse_args()
 
     try:
@@ -196,6 +208,36 @@ def main() -> None:
         padding_len = periphconf_size - len(periphconf_combined)
         periphconf_final = periphconf_combined + bytes([0xFF for _ in range(padding_len)])
 
+        # Handle recovery periphconf partition if enabled
+        periphconf_recovery_address = None
+        periphconf_recovery_size = None
+        periphconf_recovery_final = None
+
+        if kconfig.get("CONFIG_NRF_HALTIUM_UICR_RECOVERY_PERIPHCONF") == "y":
+            try:
+                periphconf_recovery_partition = edt.label2node[PERIPHCONF_RECOVERY_NODELABEL]
+            except LookupError as e:
+                raise ScriptError(
+                    "Failed to find a PERIPHCONF_RECOVERY partition in the devicetree. "
+                    f"Expected a DT node with label '{PERIPHCONF_RECOVERY_NODELABEL}'. "
+                    "This is required when "
+                    "CONFIG_NRF_HALTIUM_UICR_RECOVERY_PERIPHCONF is enabled."
+                ) from e
+
+            flash_base_address_recovery = periphconf_recovery_partition.flash_controller.regs[
+                0
+            ].addr
+            periphconf_recovery_address = (
+                flash_base_address_recovery + periphconf_recovery_partition.regs[0].addr
+            )
+            periphconf_recovery_size = periphconf_recovery_partition.regs[0].size
+
+            # Create a copy of the periphconf data for recovery at different location
+            padding_len_recovery = periphconf_recovery_size - len(periphconf_combined)
+            periphconf_recovery_final = periphconf_combined + bytes(
+                [0xFF for _ in range(padding_len_recovery)]
+            )
+
         if kconfig.get("CONFIG_NRF_HALTIUM_UICR_PERIPHCONF") == "y":
             uicr.PERIPHCONF.ENABLE = ENABLED_VALUE
             uicr.PERIPHCONF.ADDRESS = periphconf_address
@@ -222,6 +264,11 @@ def main() -> None:
             size4kb = int(kconfig.get("CONFIG_NRF_HALTIUM_UICR_RECOVERY_SIZE4KB"), 0)
             uicr.RECOVERY.SIZE4KB = size4kb
 
+            if kconfig.get("CONFIG_NRF_HALTIUM_UICR_RECOVERY_PERIPHCONF") == "y":
+                uicr.RECOVERY.PERIPHCONF.ENABLE = ENABLED_VALUE
+                uicr.RECOVERY.PERIPHCONF.ADDRESS = periphconf_recovery_address
+                uicr.RECOVERY.PERIPHCONF.MAXCOUNT = math.floor(periphconf_recovery_size / 8)
+
         try:
             uicr_node = edt.label2node[UICR_NODELABEL]
         except LookupError as e:
@@ -240,6 +287,13 @@ def main() -> None:
             periphconf_hex.frombytes(periphconf_final, offset=periphconf_address)
             periphconf_hex.write_hex_file(args.out_periphconf_hex)
 
+        if args.out_periphconf_recovery_hex is not None and periphconf_recovery_final is not None:
+            periphconf_recovery_hex = IntelHex()
+            periphconf_recovery_hex.frombytes(
+                periphconf_recovery_final, offset=periphconf_recovery_address
+            )
+            periphconf_recovery_hex.write_hex_file(args.out_periphconf_recovery_hex)
+
     except ScriptError as e:
         print(f"Error: {e!s}")
         sys.exit(1)
@@ -268,8 +322,8 @@ def extract_and_combine_periphconfs(elf_files: list[argparse.FileType]) -> bytes
             unique_values = {e.value for e in entries}
             if len(unique_values) > 1:
                 raise ScriptError(
-                    f"PERIPHCONF has conflicting values for register 0x{regptr:09_x}: "
-                    + ", ".join([f"0x{val:09_x}" for val in unique_values])
+                    f"PERIPHCONF has conflicting values for register "
+                    f"0x{regptr:09_x}: " + ", ".join([f"0x{val:09_x}" for val in unique_values])
                 )
         deduplicated_periphconf.append(entries[0])