[nrf noup] zephyr: Keep boot preference after reboot

Add a possibility to keep the boot preference value between device
resets.

Ref: NCSDK-35479

Signed-off-by: Tomasz Chyrowicz <[email protected]>

Author: tomchy

boot/bootutil/zephyr/CMakeLists.txt

@@ -17,8 +17,11 @@ zephyr_library_sources(
   ../src/bootutil_public.c
     )
 if(CONFIG_NRF_MCUBOOT_BOOT_REQUEST)
-  zephyr_library_sources_ifdef(CONFIG_NRF_MCUBOOT_BOOT_REQUEST_IMPL_RETENTION
-    src/boot_request_retention.c
+  zephyr_library_sources(
+    src/boot_request.c
+  )
+  zephyr_library_sources_ifdef(CONFIG_NRF_MCUBOOT_BOOT_REQUEST_IMPL_FLASH
+    src/boot_request_flash.c
   )
 endif()
 

boot/bootutil/zephyr/src/boot_request_retention.c renamed to boot/bootutil/zephyr/src/boot_request.c

@@ -6,18 +6,17 @@
 #include <bootutil/boot_request.h>
 
 #include "bootutil/bootutil_log.h"
-#include <zephyr/retention/retention.h>
 
 /** Special value of image number, indicating a request to the bootloader. */
 #define BOOT_REQUEST_IMG_BOOTLOADER 0xFF
 
 /** Additional memory used by the retention subsystem (2B - prefix, 4B - CRC).*/
 #define BOOT_REQUEST_ENTRY_METADATA_SIZE (2 + 4)
 
-BOOT_LOG_MODULE_REGISTER(bootloader_request);
+/** Number of images supported by the bootloader requests. */
+#define BOOT_REQUEST_IMG_NUM 2
 
-static const struct device *bootloader_request_dev =
-	DEVICE_DT_GET(DT_CHOSEN(nrf_bootloader_request));
+BOOT_LOG_MODULE_REGISTER(bootloader_request);
 
 enum boot_request_type {
 	/** Invalid request. */
@@ -143,16 +142,26 @@ static int boot_request_entry_find(enum boot_request_type type, boot_request_img
 
 int boot_request_init(void)
 {
-	if (!device_is_ready(bootloader_request_dev)) {
-		return -EIO;
-	}
-
-	return 0;
+	return boot_request_mem_init();
 }
 
 int boot_request_clear(void)
 {
-	return retention_clear(bootloader_request_dev);
+#ifdef CONFIG_NRF_MCUBOOT_BOOT_REQUEST_PREFERENCE_KEEP
+	size_t nv_indexes[BOOT_REQUEST_IMG_NUM];
+	uint8_t image;
+
+	for (image = 0; image < BOOT_REQUEST_IMG_NUM; image++) {
+		if (boot_request_entry_find(BOOT_REQUEST_IMG_PREFERENCE, image,
+					    &nv_indexes[image]) != 0) {
+			return -EINVAL;
+		}
+	}
+
+	return boot_request_mem_selective_erase(nv_indexes, BOOT_REQUEST_IMG_NUM);
+#else
+	return boot_request_mem_selective_erase(NULL, 0);
+#endif
 }
 
 int boot_request_confirm_slot(uint8_t image, enum boot_slot slot)
@@ -161,6 +170,14 @@ int boot_request_confirm_slot(uint8_t image, enum boot_slot slot)
 	size_t req_entry;
 	int ret;
 
+#ifdef CONFIG_NRF_MCUBOOT_BOOT_REQUEST_PREFERENCE_KEEP
+	if (!boot_request_updateable()) {
+		BOOT_LOG_ERR("Unable to confirm slot - area not updateable.");
+		/* Cannot update area if it is corrupted. */
+		return -EIO;
+	}
+#endif
+
 	ret = boot_request_entry_find(BOOT_REQUEST_IMG_CONFIRM, image, &req_entry);
 	if (ret != 0) {
 		return ret;
@@ -177,8 +194,7 @@ int boot_request_confirm_slot(uint8_t image, enum boot_slot slot)
 		return -EINVAL;
 	}
 
-	return retention_write(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			       sizeof(value));
+	return boot_request_mem_write(req_entry * sizeof(value), &value);
 }
 
 bool boot_request_check_confirmed_slot(uint8_t image, enum boot_slot slot)
@@ -192,8 +208,7 @@ bool boot_request_check_confirmed_slot(uint8_t image, enum boot_slot slot)
 		return false;
 	}
 
-	ret = retention_read(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			     sizeof(value));
+	ret = boot_request_mem_read(req_entry * sizeof(uint8_t), &value);
 	if (ret != 0) {
 		return false;
 	}
@@ -216,6 +231,14 @@ int boot_request_set_preferred_slot(uint8_t image, enum boot_slot slot)
 	size_t req_entry;
 	int ret;
 
+#ifdef CONFIG_NRF_MCUBOOT_BOOT_REQUEST_PREFERENCE_KEEP
+	if (!boot_request_updateable()) {
+		BOOT_LOG_ERR("Unable to select slot - area not updateable.");
+		/* Cannot update area if it is corrupted. */
+		return -EIO;
+	}
+#endif
+
 	ret = boot_request_entry_find(BOOT_REQUEST_IMG_PREFERENCE, image, &req_entry);
 	if (ret != 0) {
 		return ret;
@@ -232,8 +255,7 @@ int boot_request_set_preferred_slot(uint8_t image, enum boot_slot slot)
 		return -EINVAL;
 	}
 
-	return retention_write(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			       sizeof(value));
+	return boot_request_mem_write(req_entry * sizeof(value), &value);
 }
 
 enum boot_slot boot_request_get_preferred_slot(uint8_t image)
@@ -247,8 +269,7 @@ enum boot_slot boot_request_get_preferred_slot(uint8_t image)
 		return BOOT_SLOT_NONE;
 	}
 
-	ret = retention_read(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			     sizeof(value));
+	ret = boot_request_mem_read(req_entry * sizeof(uint8_t), &value);
 	if (ret != 0) {
 		return BOOT_SLOT_NONE;
 	}
@@ -271,14 +292,21 @@ int boot_request_enter_recovery(void)
 	size_t req_entry;
 	int ret;
 
+#ifdef CONFIG_NRF_MCUBOOT_BOOT_REQUEST_PREFERENCE_KEEP
+	if (!boot_request_updateable()) {
+		BOOT_LOG_ERR("Unable to enter recovery - area not updateable.");
+		/* Cannot update area if it is corrupted. */
+		return -EIO;
+	}
+#endif
+
 	ret = boot_request_entry_find(BOOT_REQUEST_BOOT_MODE, BOOT_REQUEST_IMG_BOOTLOADER,
 				      &req_entry);
 	if (ret != 0) {
 		return ret;
 	}
 
-	return retention_write(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			       sizeof(value));
+	return boot_request_mem_write(req_entry * sizeof(value), &value);
 }
 
 #ifdef CONFIG_NRF_BOOT_SERIAL_BOOT_REQ
@@ -294,8 +322,7 @@ bool boot_request_detect_recovery(void)
 		return false;
 	}
 
-	ret = retention_read(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			     sizeof(value));
+	ret = boot_request_mem_read(req_entry * sizeof(uint8_t), &value);
 	if ((ret == 0) && (value == BOOT_REQUEST_MODE_RECOVERY)) {
 		return true;
 	}
@@ -310,14 +337,21 @@ int boot_request_enter_firmware_loader(void)
 	size_t req_entry;
 	int ret;
 
+#ifdef CONFIG_NRF_MCUBOOT_BOOT_REQUEST_PREFERENCE_KEEP
+	if (!boot_request_updateable()) {
+		BOOT_LOG_ERR("Unable to enter FW loader - area not updateable.");
+		/* Cannot update area if it is corrupted. */
+		return -EIO;
+	}
+#endif
+
 	ret = boot_request_entry_find(BOOT_REQUEST_BOOT_MODE, BOOT_REQUEST_IMG_BOOTLOADER,
 				      &req_entry);
 	if (ret != 0) {
 		return ret;
 	}
 
-	return retention_write(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			       sizeof(value));
+	return boot_request_mem_write(req_entry * sizeof(value), &value);
 }
 
 #ifdef CONFIG_NRF_BOOT_FIRMWARE_LOADER_BOOT_REQ
@@ -333,8 +367,7 @@ bool boot_request_detect_firmware_loader(void)
 		return false;
 	}
 
-	ret = retention_read(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
-			     sizeof(value));
+	ret = boot_request_mem_read(req_entry * sizeof(uint8_t), &value);
 	if ((ret == 0) && (value == BOOT_REQUEST_MODE_FIRMWARE_LOADER)) {
 		return true;
 	}