sysbuild: Add matter_factory_data image and configuration

Adds a image which is used by matter and contains the factory
settings for the device

Signed-off-by: Jamie McCrae <[email protected]>

Author: nordicjm

applications/matter_factory_data/CMakeLists.txt

@@ -0,0 +1,53 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+cmake_minimum_required(VERSION 3.20.0)
+
+# Do not apply shield or snippets for the factory data partition and use an empty file for the
+# board defconfig file
+set(BOARD_DEFCONFIG ${CMAKE_CURRENT_SOURCE_DIR}/prj.conf)
+set(CACHED_SHIELD "" CACHE STRING "" FORCE)
+set(CACHED_SNIPPET "" CACHE STRING "" FORCE)
+
+find_package(Zephyr
+  COMPONENTS zephyr_default:kconfig
+  REQUIRED HINTS $ENV{ZEPHYR_BASE}
+)
+
+project(matter_factory_data)
+
+# Manually include board configuration to enable automatic runners.yaml generation
+include(${BOARD_DIR}/board.cmake OPTIONAL)
+
+# Create the runners_yaml_props_target that flash system expects
+add_custom_target(runners_yaml_props_target)
+
+# Override the runners.yaml path to use CMAKE_CURRENT_BINARY_DIR/zephyr instead of
+# PROJECT_BINARY_DIR, this ensures runners.yaml is generated at <build>/softdevice/zephyr where
+# west expects it
+set(PROJECT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/zephyr)
+
+# Import Kconfig and DTS from the application then generate the factory data hex file which will
+# be flashed when west flash is invoked. Unlike PM, it will not be merged with the application
+# into a new hex file
+set(app_dir ${CMAKE_CURRENT_BINARY_DIR}/../${CONFIG_APPLICATION_NAME})
+import_kconfig(CONFIG_ ${app_dir}/zephyr/.config)
+zephyr_dt_import(EDT_PICKLE_FILE ${app_dir}/zephyr/edt.pickle TARGET devicetree_target)
+set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS
+  ${app_dir}/zephyr/.config
+  ${app_dir}/zephyr/edt.pickle
+)
+set(CHIP_ROOT ${ZEPHYR_CONNECTEDHOMEIP_MODULE_DIR})
+include(/tmp/bb/modules/lib/matter/config/nrfconnect/chip-module/generate_factory_data.cmake)
+nrfconnect_generate_factory_data()
+
+# Set hex_file property to point to factory data output file in this directory
+set_target_properties(runners_yaml_props_target PROPERTIES
+  hex_file "${CMAKE_CURRENT_BINARY_DIR}/factory_data.hex"
+)
+
+# Include flash support to automatically generate runners.yaml
+include(${ZEPHYR_BASE}/cmake/flash/CMakeLists.txt)

applications/matter_factory_data/Kconfig

@@ -0,0 +1,18 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+config APPLICATION_NAME
+	string "Application name (informative only, do not change)"
+
+config PARTITION_MANAGER_ENABLED
+	bool "Partition manager is enabled (informative only, do not change)"
+
+config BUILD_OUTPUT_BIN
+	bool "Build a binary in BIN format (informative only, do not change)"
+
+config BUILD_OUTPUT_HEX
+	bool "Build a binary in HEX format (informative only, do not change)"
+	default y

applications/matter_factory_data/prj.conf

@@ -0,0 +1 @@
+# Nothing here

sysbuild/CMakeLists.txt

@@ -1054,5 +1054,6 @@ include(${CMAKE_CURRENT_LIST_DIR}/radio_loader.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/secureboot.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/mcuboot.cmake)
 include(${CMAKE_CURRENT_LIST_DIR}/firmware_loader_radio.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/matter_factory_data.cmake)
 
 store_ncs_vars()

sysbuild/Kconfig.matter

@@ -14,14 +14,14 @@ config MATTER_FACTORY_DATA_GENERATE
 	  Generate Matter factory data set and the HEX file for the sample during the building
 	  process.
 
-config MATTER_FACTORY_DATA_MERGE_WITH_FIRMWARE
-	bool "Merge generated factory data with merged.hex output"
-	depends on MATTER_FACTORY_DATA_GENERATE
-	default y
-	help
-	  Enables merging the generated factory data with the merged.hex output build file. As a
-	  result, the merged.hex build output file, which is used when flashing the firmware using
-	  the west tool, includes the factory data as well.
+#config MATTER_FACTORY_DATA_MERGE_WITH_FIRMWARE
+#	bool "Merge generated factory data with merged.hex output"
+#	depends on MATTER_FACTORY_DATA_GENERATE
+#	default y
+#	help
+#	  Enables merging the generated factory data with the merged.hex output build file. As a
+#	  result, the merged.hex build output file, which is used when flashing the firmware using
+#	  the west tool, includes the factory data as well.
 
 config MATTER_OTA
 	bool "Matter OTA Software Update"

sysbuild/matter_factory_data.cmake

@@ -0,0 +1,17 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+if(SB_CONFIG_ZEPHYR_CONNECTEDHOMEIP_MODULE AND SB_CONFIG_MATTER AND
+  SB_CONFIG_MATTER_FACTORY_DATA_GENERATE AND NOT SB_CONFIG_PARTITION_MANAGER
+)
+  ExternalZephyrProject_Add(
+    APPLICATION matter_factory_data
+    SOURCE_DIR ${ZEPHYR_NRF_MODULE_DIR}/applications/matter_factory_data
+  )
+
+  set_config_string(matter_factory_data CONFIG_APPLICATION_NAME ${DEFAULT_IMAGE})
+  sysbuild_add_dependencies(CONFIGURE matter_factory_data ${DEFAULT_IMAGE})
+endif()