[nrf noup] mcuboot: Use dedicated type for slot numbers

nrf-squash! [nrf noup] bootloader: Add bootloader requests

Change bootloader request module, so it uses the new, dedicated type to
point to the specific slot.

Ref: NCSDK-35199

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

Author: tomchy

boot/bootutil/include/bootutil/boot_request.h

@@ -13,6 +13,7 @@ extern "C" {
 
 #include <stdint.h>
 #include <stdbool.h>
+#include <bootutil/bootutil_public.h>
 
 /** Special value, indicating that there is no preferred slot. */
 #define BOOT_REQUEST_NO_PREFERRED_SLOT UINT32_MAX
@@ -25,7 +26,7 @@ extern "C" {
  *
  * @return 0 if requested, negative error code otherwise.
  */
-int boot_request_confirm_slot(uint8_t image, uint32_t slot);
+int boot_request_confirm_slot(uint8_t image, enum boot_slot slot);
 
 /**
  * @brief Request a bootloader to boot the specified slot of an image.
@@ -35,7 +36,7 @@ int boot_request_confirm_slot(uint8_t image, uint32_t slot);
  *
  * @return 0 if requested, negative error code otherwise.
  */
-int boot_request_set_preferred_slot(uint8_t image, uint32_t slot);
+int boot_request_set_preferred_slot(uint8_t image, enum boot_slot slot);
 
 /**
  * @brief Request a bootloader to boot recovery image.
@@ -59,16 +60,16 @@ int boot_request_enter_firmware_loader(void);
  *
  * @return true if requested, false otherwise.
  */
-bool boot_request_check_confirmed_slot(uint8_t image, uint32_t slot);
+bool boot_request_check_confirmed_slot(uint8_t image, enum boot_slot slot);
 
 /**
  * @brief Find if there is a request to boot certain slot of the specified image.
  *
  * @param[in] image  Image number.
  *
- * @return slot number if requested, BOOT_REQUEST_NO_PREFERRED_SLOT otherwise.
+ * @return slot number if requested, BOOT_SLOT_NONE otherwise.
  */
-uint32_t boot_request_get_preferred_slot(uint8_t image);
+enum boot_slot boot_request_get_preferred_slot(uint8_t image);
 
 /**
  * @brief Check if there is a request to boot recovery image.

boot/bootutil/src/bootutil_public.c

@@ -511,7 +511,7 @@ boot_write_copy_done(const struct flash_area *fap)
 #ifdef SEND_BOOT_REQUEST
 static int
 send_boot_request(uint8_t magic, uint8_t image_ok, bool confirm, int image_id,
-                  uint32_t slot_id)
+                  enum boot_slot slot_id)
 {
     int rc = BOOT_EBADIMAGE;
 

boot/bootutil/zephyr/src/boot_request_retention.c

@@ -155,7 +155,7 @@ int boot_request_clear(void)
 	return retention_clear(bootloader_request_dev);
 }
 
-int boot_request_confirm_slot(uint8_t image, uint32_t slot)
+int boot_request_confirm_slot(uint8_t image, enum boot_slot slot)
 {
 	uint8_t value = BOOT_REQUEST_SLOT_INVALID;
 	size_t req_entry;
@@ -167,10 +167,10 @@ int boot_request_confirm_slot(uint8_t image, uint32_t slot)
 	}
 
 	switch (slot) {
-	case 0:
+	case BOOT_SLOT_PRIMARY:
 		value = BOOT_REQUEST_SLOT_PRIMARY;
 		break;
-	case 1:
+	case BOOT_SLOT_SECONDARY:
 		value = BOOT_REQUEST_SLOT_SECONDARY;
 		break;
 	default:
@@ -181,7 +181,7 @@ int boot_request_confirm_slot(uint8_t image, uint32_t slot)
 			       sizeof(value));
 }
 
-bool boot_request_check_confirmed_slot(uint8_t image, uint32_t slot)
+bool boot_request_check_confirmed_slot(uint8_t image, enum boot_slot slot)
 {
 	uint8_t value = BOOT_REQUEST_SLOT_INVALID;
 	size_t req_entry;
@@ -200,17 +200,17 @@ bool boot_request_check_confirmed_slot(uint8_t image, uint32_t slot)
 
 	switch (value) {
 	case BOOT_REQUEST_SLOT_PRIMARY:
-		return (slot == 0);
+		return (slot == BOOT_SLOT_PRIMARY);
 	case BOOT_REQUEST_SLOT_SECONDARY:
-		return (slot == 1);
+		return (slot == BOOT_SLOT_SECONDARY);
 	default:
 		break;
 	}
 
 	return false;
 }
 
-int boot_request_set_preferred_slot(uint8_t image, uint32_t slot)
+int boot_request_set_preferred_slot(uint8_t image, enum boot_slot slot)
 {
 	uint8_t value = BOOT_REQUEST_SLOT_INVALID;
 	size_t req_entry;
@@ -222,10 +222,10 @@ int boot_request_set_preferred_slot(uint8_t image, uint32_t slot)
 	}
 
 	switch (slot) {
-	case 0:
+	case BOOT_SLOT_PRIMARY:
 		value = BOOT_REQUEST_SLOT_PRIMARY;
 		break;
-	case 1:
+	case BOOT_SLOT_SECONDARY:
 		value = BOOT_REQUEST_SLOT_SECONDARY;
 		break;
 	default:
@@ -237,33 +237,33 @@ int boot_request_set_preferred_slot(uint8_t image, uint32_t slot)
 }
 
 #ifdef CONFIG_FIND_NEXT_SLOT_HOOKS
-uint32_t boot_request_get_preferred_slot(uint8_t image)
+enum boot_slot boot_request_get_preferred_slot(uint8_t image)
 {
 	uint8_t value = BOOT_REQUEST_SLOT_INVALID;
 	size_t req_entry;
 	int ret;
 
 	ret = boot_request_entry_find(BOOT_REQUEST_IMG_PREFERENCE, image, &req_entry);
 	if (ret != 0) {
-		return BOOT_REQUEST_NO_PREFERRED_SLOT;
+		return BOOT_SLOT_NONE;
 	}
 
 	ret = retention_read(bootloader_request_dev, req_entry * sizeof(value), (void *)&value,
 			     sizeof(value));
 	if (ret != 0) {
-		return BOOT_REQUEST_NO_PREFERRED_SLOT;
+		return BOOT_SLOT_NONE;
 	}
 
 	switch (value) {
 	case BOOT_REQUEST_SLOT_PRIMARY:
-		return 0;
+		return BOOT_SLOT_PRIMARY;
 	case BOOT_REQUEST_SLOT_SECONDARY:
-		return 1;
+		return BOOT_SLOT_SECONDARY;
 	default:
 		break;
 	}
 
-	return BOOT_REQUEST_NO_PREFERRED_SLOT;
+	return BOOT_SLOT_NONE;
 }
 #endif /* CONFIG_FIND_NEXT_SLOT_HOOKS */
 

boot/zephyr/main.c

@@ -616,7 +616,7 @@ static int boot_prevalidate(void)
 {
 #ifdef CONFIG_NRF_MCUBOOT_BOOT_REQUEST
     uint8_t image_index;
-    uint32_t slot;
+    enum boot_slot slot;
     uint32_t area_id;
     const struct flash_area *fap;
     int rc = boot_request_init();
@@ -626,7 +626,7 @@ static int boot_prevalidate(void)
     }
 
     for (image_index = 0; image_index < BOOT_IMAGE_NUMBER; ++image_index) {
-        for (slot = 0; slot < BOOT_REQUEST_NUM_SLOTS; slot++) {
+        for (slot = BOOT_SLOT_PRIMARY; slot < BOOT_SLOT_COUNT; slot++) {
             if (boot_request_check_confirmed_slot(image_index, slot)) {
                 BOOT_LOG_DBG("Confirm image: %d slot: %d due to bootloader request.",
                     image_index, slot);