[nrf fromlist] drivers: firmware: add IRONside boot report

Upstream PR #: 90569

The boot report is used to pass information from IRONside to a CPU
being booted.

Integrate the boot report to the update service sample.

Signed-off-by: Håkon Amundsen <[email protected]>

Author: hakonfam

boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20_cpuapp_iron.dts

@@ -22,6 +22,8 @@
 	status = "okay";
 };
 
+ironside_se_boot_report: &cpuapp_ironside_se_boot_report {};
+
 boot_partition: &cpuapp_boot_partition {
 	label = "mcuboot";
 };

drivers/firmware/nrf_ironside/CMakeLists.txt

@@ -5,5 +5,6 @@ zephyr_library()
 
 zephyr_library_sources_ifdef(CONFIG_NRF_IRONSIDE_CALL call.c)
 
+zephyr_library_sources_ifdef(CONFIG_NRF_IRONSIDE_BOOT_REPORT boot_report.c)
 zephyr_library_sources_ifdef(CONFIG_NRF_IRONSIDE_CPUCONF_SERVICE cpuconf.c)
 zephyr_library_sources_ifdef(CONFIG_NRF_IRONSIDE_UPDATE_SERVICE update.c)

drivers/firmware/nrf_ironside/Kconfig

@@ -43,4 +43,11 @@ config NRF_IRONSIDE_UPDATE_SERVICE
 	help
 	  Service used to update the IRONside SE firmware.
 
+config NRF_IRONSIDE_BOOT_REPORT
+	bool "IRONside boot report"
+	depends on $(dt_nodelabel_exists,ironside_se_boot_report)
+	select NRF_IRONSIDE
+	help
+	  Support for parsing the Boot Report populated by Nordic IRONside firmware.
+
 endmenu

drivers/firmware/nrf_ironside/boot_report.c

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <errno.h>
+#include <zephyr/devicetree.h>
+#include <zephyr/drivers/firmware/nrf_ironside/boot_report.h>
+
+#define IRONSIDE_SE_BOOT_REPORT_ADDR DT_REG_ADDR(DT_NODELABEL(ironside_se_boot_report))
+
+int ironside_boot_report_get(const struct ironside_boot_report **report)
+{
+	const struct ironside_boot_report *tmp_report = (void *)IRONSIDE_SE_BOOT_REPORT_ADDR;
+
+	if (tmp_report->magic != IRONSIDE_BOOT_REPORT_MAGIC) {
+		return -EINVAL;
+	}
+
+	*report = tmp_report;
+
+	return 0;
+}

include/zephyr/drivers/firmware/nrf_ironside/boot_report.h

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_BOOT_REPORT_H_
+#define ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_BOOT_REPORT_H_
+
+#include <stdint.h>
+#include <stddef.h>
+
+/** Constant used to check if an Nordic IRONside SE boot report has been written. */
+#define IRONSIDE_BOOT_REPORT_MAGIC                     (0x4d69546fUL)
+/** Length of the local domain context buffer in bytes. */
+#define IRONSIDE_BOOT_REPORT_LOCAL_DOMAIN_CONTEXT_SIZE (16UL)
+/** Length of the random data buffer in bytes. */
+#define IRONSIDE_BOOT_REPORT_RANDOM_DATA_SIZE          (32UL)
+
+/** @brief IRONside version structure. */
+struct ironside_version {
+	/** Wrapping sequence number ranging from 1-126, incremented for each release. */
+	uint8_t seqnum;
+	/** Path version. */
+	uint8_t patch;
+	/** Minor version. */
+	uint8_t minor;
+	/** Major version. */
+	uint8_t major;
+	/** Human readable extraversion string. */
+	char extraversion[12];
+};
+
+/** @brief UICR error description contained in the boot report. */
+struct ironside_boot_report_uicr_error {
+	/** The type of error. A value of 0 indicates no error */
+	uint32_t error_type;
+	/** Error descriptions specific to each type of UICR error */
+	union {
+		/** RFU */
+		struct {
+			uint32_t rfu[4];
+		} rfu;
+	} description;
+};
+
+/** @brief IRONside boot report. */
+struct ironside_boot_report {
+	/** Magic value used to identify valid boot report */
+	uint32_t magic;
+	/** Firmware version of IRONside SE. */
+	struct ironside_version ironside_se_version;
+	/** Firmware version of IRONside SE recovery firmware. */
+	struct ironside_version ironside_se_recovery_version;
+	/** Copy of SICR.UROT.UPDATE.STATUS.*/
+	uint32_t ironside_update_status;
+	/** See @ref ironside_boot_report_uicr_error */
+	struct ironside_boot_report_uicr_error uicr_error_description;
+	/** Data passed from booting local domain to local domain being booted */
+	uint8_t local_domain_context[IRONSIDE_BOOT_REPORT_LOCAL_DOMAIN_CONTEXT_SIZE];
+	/** CSPRNG data */
+	uint8_t random_data[IRONSIDE_BOOT_REPORT_RANDOM_DATA_SIZE];
+	/** Reserved for Future Use */
+	uint32_t rfu[64];
+};
+
+/**
+ * @brief Get a pointer to the IRONside boot report.
+ *
+ * @param[out] report Will be set to point to the IRONside boot report.
+ *
+ * @retval 0 if successful.
+ * @retval -EFAULT if the magic field in the report is incorrect.
+ * @retval -EINVAL if @p report is NULL.
+ */
+int ironside_boot_report_get(const struct ironside_boot_report **report);
+
+#endif /* ZEPHYR_INCLUDE_ZEPHYR_DRIVERS_FIRMWARE_NRF_IRONSIDE_BOOT_REPORT_H_ */

samples/boards/nordic/nrf_ironside/update/prj.conf

@@ -1,3 +1,4 @@
 CONFIG_LOG=y
 
 CONFIG_NRF_IRONSIDE_UPDATE_SERVICE=y
+CONFIG_NRF_IRONSIDE_BOOT_REPORT=y

samples/boards/nordic/nrf_ironside/update/src/main.c

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include <zephyr/drivers/firmware/nrf_ironside/boot_report.h>
 #include <zephyr/drivers/firmware/nrf_ironside/update.h>
 #include <zephyr/logging/log.h>
 
@@ -13,6 +14,18 @@ int main(void)
 {
 	int err;
 	const struct ironside_update_blob *update = (void *)CONFIG_UPDATE_BLOB_ADDRESS;
+	const struct ironside_boot_report *report;
+
+	err = ironside_boot_report_get(&report);
+	LOG_INF("ironside_boot_report_get err:  %d", err);
+	LOG_INF("version: %d.%d.%d-%s+%d", report->ironside_se_version.major,
+		report->ironside_se_version.minor, report->ironside_se_version.patch,
+		report->ironside_se_version.extraversion, report->ironside_se_version.seqnum);
+	LOG_INF("recovery version: %d.%d.%d-%s+%d", report->ironside_se_version.major,
+		report->ironside_se_version.minor, report->ironside_se_version.patch,
+		report->ironside_se_version.extraversion, report->ironside_se_version.seqnum);
+	LOG_INF("update status:  0x%x", report->ironside_update_status);
+	LOG_HEXDUMP_INF((void *)report->random_data, sizeof(report->random_data), "random data");
 
 	err = ironside_update(update);
 	LOG_INF("IRONside update retval: 0x%x", err);