suit: Cleanup on DFU partitions

Cleanup on DFU and DFU cache partitions as part of
SUIT initialization

Signed-off-by: Sylwester Konczyk <[email protected]>

Author: SylwesterKonczyk

subsys/suit/envelope_info/include/suit_envelope_info.h

@@ -33,6 +33,13 @@ suit_plat_err_t suit_dfu_partition_envelope_info_get(const uint8_t **address, si
  */
 suit_plat_err_t suit_dfu_partition_device_info_get(struct suit_nvm_device_info *device_info);
 
+/**
+ * @brief Chcecks if dfu partition is empty.
+ *
+ * @return true if empty, false otherwise
+ */
+bool suit_dfu_partition_is_empty(void);
+
 #ifdef __cplusplus
 }
 #endif

subsys/suit/envelope_info/src/suit_envelope_info.c

@@ -48,15 +48,15 @@ suit_plat_err_t suit_dfu_partition_envelope_info_get(const uint8_t **address, si
 	uintptr_t mapped_address = 0;
 
 	if (!suit_memory_nvm_address_to_global_address(&device_offset, &mapped_address)) {
-		LOG_ERR("Cannot obtain memory-mapped DFU Partition address");
+		LOG_ERR("Cannot obtain memory-mapped DFU partition address");
 		return SUIT_PLAT_ERR_IO;
 	}
 
 	const uint8_t *envelope_address = (uint8_t *)mapped_address;
 	size_t envelope_size = DFU_PARTITION_SIZE;
 
 	if (*((uint32_t *)envelope_address) == EMPTY_STORAGE_VALUE) {
-		LOG_DBG("DFU Partition empty");
+		LOG_DBG("DFU partition empty");
 		return SUIT_PLAT_ERR_NOT_FOUND;
 	}
 
@@ -108,3 +108,26 @@ suit_plat_err_t suit_dfu_partition_device_info_get(struct suit_nvm_device_info *
 
 	return SUIT_PLAT_SUCCESS;
 }
+
+bool suit_dfu_partition_is_empty(void)
+{
+	struct nvm_address device_offset = {
+		.fdev = DFU_PARTITION_DEVICE,
+		.offset = DFU_PARTITION_OFFSET,
+	};
+
+	uintptr_t mapped_address = 0;
+
+	if (!suit_memory_nvm_address_to_global_address(&device_offset, &mapped_address)) {
+		LOG_ERR("Cannot obtain memory-mapped DFU partition address");
+		return false;
+	}
+
+	for (size_t i = 0; i < DFU_PARTITION_SIZE / sizeof(uint32_t); i++) {
+		if (*(((uint32_t *)mapped_address) + i) != EMPTY_STORAGE_VALUE) {
+			return false;
+		}
+	}
+
+	return true;
+}

subsys/suit/orchestrator_app/Kconfig

@@ -14,4 +14,9 @@ config SUIT_ORCHESTRATOR_APP_CANDIDATE_PROCESSING
 	bool "Enable processing of the candidate envelope by the SUIT application orchestrator"
 	depends on SUIT_ENVELOPE_INFO
 
+config SUIT_CLEANUP_ON_INIT
+	bool "Performs cleanup on DFU and DFU cache partitions as part of initialization"
+	depends on SUIT_ORCHESTRATOR_APP_CANDIDATE_PROCESSING
+	default y
+
 endif # SUIT_ORCHESTRATOR_APP

subsys/suit/orchestrator_app/src/suit_orchestrator_app.c

@@ -34,6 +34,12 @@ LOG_MODULE_REGISTER(suit_dfu, CONFIG_SUIT_LOG_LEVEL);
 
 static int dfu_partition_erase(void)
 {
+
+	if (suit_dfu_partition_is_empty()) {
+		LOG_DBG("DFU partition is arleady erased");
+		return 0;
+	}
+
 	struct suit_nvm_device_info device_info;
 	int err = suit_dfu_partition_device_info_get(&device_info);
 
@@ -45,6 +51,7 @@ static int dfu_partition_erase(void)
 		return -ENODEV;
 	}
 
+	LOG_DBG("Erasing DFU partition");
 	int rc = flash_erase(device_info.fdev, device_info.partition_offset,
 			     device_info.partition_size);
 	if (rc < 0) {
@@ -61,8 +68,6 @@ int suit_dfu_initialize(void)
 	LOG_DBG("Enter");
 
 	struct suit_nvm_device_info device_info;
-	const uint8_t *uc_env_addr = NULL;
-	size_t uc_env_size = 0;
 	int err = suit_dfu_partition_device_info_get(&device_info);
 
 	if (err != SUIT_PLAT_SUCCESS) {
@@ -73,6 +78,13 @@ int suit_dfu_initialize(void)
 	LOG_INF("DFU partition detected, addr: %p, size %d bytes",
 		(void *)device_info.mapped_address, device_info.partition_size);
 
+#if CONFIG_SUIT_CLEANUP_ON_INIT
+	suit_dfu_cleanup();
+
+#else /* CONFIG_SUIT_CLEANUP_ON_INIT */
+	const uint8_t *uc_env_addr = NULL;
+	size_t uc_env_size = 0;
+
 	err = suit_dfu_partition_envelope_info_get(&uc_env_addr, &uc_env_size);
 	if (err == SUIT_PLAT_SUCCESS) {
 		LOG_INF("Update candidate envelope detected, addr: %p, size %d bytes",
@@ -83,6 +95,8 @@ int suit_dfu_initialize(void)
 	suit_dfu_cache_validate_content();
 #endif /* CONFIG_SUIT_CACHE_RW */
 
+#endif /* CONFIG_SUIT_CLEANUP_ON_INIT */
+
 #if CONFIG_SUIT_STREAM_IPC_PROVIDER
 	suit_ipc_streamer_provider_init();
 #endif