boot: serial: "image list" enhanced, client can program correct mcuboot_sX.bin

* added CONFIG_MCUBOOT_SERIAL_MCUMGR_SIMPLE_IMAGE_INDEX (default "n")
  The "image update" can now specify simple index "-n <index>",
  where n=1+(image*2+slot) from "image list"

* added CONFIG_MCUBOOT_SERIAL_MCUMGR_VERSION_DECORATE (default "n")
  The "image list" can now provide more details about what each slot
  contains. This is appended to version string, to make it somehow
  compatible with existing mcumgr clients

* information for all slots always returned (e.g. 4 for b0/2-stage boot)
  version field can be: headerErased, headerInvalid, imageInvalid (hash)

* bootable=true for all slots that are valid

* flags.active=true for the active mcuboot slot

* hash provided, this is sha256_sum of hdr_size(0x200)+image_size, e.g.
  not including the signing chunk (0x200) located after image

* reject if trying to update the active mcuboot slot.
  note: current mcumgr (mynewt-newtmgr) is very poor to handle errors,
  just hangs without any timeout if something goes wrong

Example:
mcumgr --conntype serial --connstring /dev/ttymxc2,baud=1000000 image list
Images:
 image=0 slot=0
    version: 1.0.0.0 # app n=1 id=0xc dev=0 off=0x30000 size=0x68000 img_size=0x4c12c
    bootable: true
    flags:
    hash: 2d44911cef7a7ec2636ca329894d66d0a322a874a267e54794cb72f42c3d1052
 image=0 slot=1
    version: 0.0.0.0 # net n=2 id=0x10 dev=0 off=0x98000 size=0x68000 img_size=0x5668
    bootable: true
    flags:
    hash: bd7571d32c5fed6cc6aa8b5eb756ff2fc31750b999bb97de5a3572644bc2f35c
 image=1 slot=0
    version: 0.0.0.0 # boot0 n=3 id=0x2 dev=0 off=0x8000 size=0x10200 img_size=0xcf9c
    bootable: true
    flags: active
    hash: b7fe6803a2a9bb0d3e3ac4803098133e4a130688bd5749499d01aecb8c014341
 image=1 slot=1
    version: 0.0.0.0 # boot1 n=4 id=0x7 dev=0 off=0x1c000 size=0x10200 img_size=0xcf9c
    bootable: true
    flags:
    hash: fee1de2cb54d1cca52d74eab6cbf2d0605290df89df13cbe1fe9dc8db6617a7a

Author: Mads Bligaard Nielsen

boot/boot_serial/src/boot_serial.c

@@ -82,7 +82,11 @@ BOOT_LOG_MODULE_DECLARE(mcuboot);
 #define MCUBOOT_SERIAL_MAX_RECEIVE_SIZE 512
 #endif
 
+#ifndef CONFIG_MCUBOOT_SERIAL_MCUMGR_VERSION_DECORATE
 #define BOOT_SERIAL_OUT_MAX     (128 * BOOT_IMAGE_NUMBER)
+#else
+#define BOOT_SERIAL_OUT_MAX     (512 * BOOT_IMAGE_NUMBER)
+#endif
 
 #ifdef __ZEPHYR__
 /* base64 lib encodes data to null-terminated string */
@@ -205,14 +209,76 @@ bs_list_img_ver(char *dst, int maxlen, struct image_version *ver)
 }
 #endif /* !MCUBOOT_USE_SNPRINTF */
 
+#ifdef CONFIG_MCUBOOT_SERIAL_MCUMGR_VERSION_DECORATE
+static int flash_upload_id_from_image_slot(uint32_t image_index, uint32_t slot)
+{
+#ifdef CONFIG_MCUBOOT_SERIAL_MCUMGR_SIMPLE_IMAGE_INDEX
+    return 1 + image_index * 2 + slot;
+#elif defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
+    uint8_t i;
+    for (i = 1; i <= BOOT_IMAGE_NUMBER*2; i++) {
+        int r = flash_area_id_from_direct_image(i);
+        if (r == area_id) {
+            return i;
+        }
+    }
+    return -1;
+#else
+    (void)slot;
+    return img_num, 0;
+#endif
+}
+
+const char* flash_slot_name_from_image_slot(uint32_t image_index, uint32_t slot)
+{
+#ifdef CONFIG_MCUBOOT_SERIAL_MCUMGR_SIMPLE_IMAGE_INDEX
+    /* NRF mapping */
+    switch (flash_upload_id_from_image_slot(image_index, slot))
+    {
+        case 1: return "app";
+        case 2: return "net";
+        case 3: return "boot0";
+        case 4: return "boot1";
+    }
+#endif
+    return "unknown";
+}
+#endif /* #ifdef CONFIG_MCUBOOT_SERIAL_MCUMGR_VERSION_DECORATE */
+
+static int flash_area_id_from_upload_id(uint32_t upload_id)
+{
+#ifdef CONFIG_MCUBOOT_SERIAL_MCUMGR_SIMPLE_IMAGE_INDEX
+    if (upload_id >= 1) {
+        uint32_t image_index = (upload_id - 1) / 2;
+        uint32_t slot = (upload_id - 1) % 2;
+        return flash_area_id_from_multi_image_slot(image_index, slot);
+    }
+    return -1;
+#elif defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
+    return flash_area_id_from_multi_image_slot(upload_id, 0);
+#else
+    return flash_area_id_from_direct_image(upload_id);
+#endif
+}
+
+static bool flash_area_is_active_bootloader(const struct flash_area *fap)
+{
+    uint32_t mcuboot_xip_addr = (uint32_t)(&flash_area_is_active_bootloader);
+    if (mcuboot_xip_addr >= fap->fa_off && mcuboot_xip_addr < fap->fa_off + fap->fa_size) {
+        return true;
+    }
+    return false;
+}
+
 /*
  * List images.
  */
 static void
 bs_list(char *buf, int len)
 {
     struct image_header hdr;
-    uint8_t tmpbuf[64];
+    uint8_t tmpbuf[128];
+    uint8_t hash_sha256[32];
     uint32_t slot, area_id;
     const struct flash_area *fap;
     uint8_t image_index;
@@ -223,6 +289,7 @@ bs_list(char *buf, int len)
     image_index = 0;
     IMAGES_ITER(image_index) {
         for (slot = 0; slot < 2; slot++) {
+            const char* errorInfo = NULL;
             area_id = flash_area_id_from_multi_image_slot(image_index, slot);
             if (flash_area_open(area_id, &fap)) {
                 continue;
@@ -256,16 +323,19 @@ bs_list(char *buf, int len)
                     }
 #endif
                     FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, &hdr, fap, tmpbuf, sizeof(tmpbuf),
-                                    NULL, 0, NULL);
+                                    NULL, 0, &hash_sha256[0]);
+                    if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
+                        errorInfo = "imageInvalid";
+                    }
                 }
+            } else if (hdr.ih_magic == 0xFFFFFFFF) {
+                errorInfo = "headerErased";
+            } else {
+                errorInfo = "headerInvalid";
             }
 
             flash_area_close(fap);
 
-            if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
-                continue;
-            }
-
             zcbor_map_start_encode(cbor_state, 20);
 
 #if (BOOT_IMAGE_NUMBER > 1)
@@ -275,9 +345,30 @@ bs_list(char *buf, int len)
 
             zcbor_tstr_put_lit_cast(cbor_state, "slot");
             zcbor_uint32_put(cbor_state, slot);
-            zcbor_tstr_put_lit_cast(cbor_state, "version");
+            if (!errorInfo) {
+                if (flash_area_is_active_bootloader(fap)) {
+                    zcbor_tstr_put_lit_cast(cbor_state, "active");
+                    zcbor_bool_put(cbor_state, true);
+                }
+                zcbor_tstr_put_lit_cast(cbor_state, "bootable");
+                zcbor_bool_put(cbor_state, true);
 
-            bs_list_img_ver((char *)tmpbuf, sizeof(tmpbuf), &hdr.ih_ver);
+                zcbor_tstr_put_lit_cast(cbor_state, "hash"); /* hashAreaSize=ih_hdr_size+ih_img_size) */
+                zcbor_tstr_encode_ptr(cbor_state, hash_sha256, sizeof(hash_sha256));
+
+                bs_list_img_ver((char *)tmpbuf, sizeof(tmpbuf), &hdr.ih_ver);
+            } else {
+                strncpy(tmpbuf, errorInfo, sizeof(tmpbuf));
+            }
+            zcbor_tstr_put_lit_cast(cbor_state, "version");
+#ifdef CONFIG_MCUBOOT_SERIAL_MCUMGR_VERSION_DECORATE
+            // append details for diagnostic
+            snprintf(tmpbuf+strlen(tmpbuf), sizeof(tmpbuf)-strlen(tmpbuf),
+                " # %s n=%d id=0x%x dev=%d off=0x%lx size=0x%x img_size=0x%x",
+                flash_slot_name_from_image_slot(image_index, slot),
+                flash_upload_id_from_image_slot(image_index, slot),
+                area_id, fap->fa_device_id, fap->fa_off, fap->fa_size, errorInfo ? 0 : hdr.ih_img_size);
+#endif
             zcbor_tstr_encode_ptr(cbor_state, tmpbuf, strlen((char *)tmpbuf));
             zcbor_map_end_encode(cbor_state, 20);
         }
@@ -414,16 +505,17 @@ bs_upload(char *buf, int len)
         goto out_invalid_data;
     }
 
-#if !defined(MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD)
-    rc = flash_area_open(flash_area_id_from_multi_image_slot(img_num, 0), &fap);
-#else
-    rc = flash_area_open(flash_area_id_from_direct_image(img_num), &fap);
-#endif
+    rc = flash_area_open(flash_area_id_from_upload_id(img_num), &fap);
     if (rc) {
         rc = MGMT_ERR_EINVAL;
         goto out;
     }
 
+    if (flash_area_is_active_bootloader(fap)) {
+        rc = MGMT_ERR_EINVAL;
+        goto out;
+    }
+
     if (img_chunk_off == 0) {
         /* Receiving chunk with 0 offset resets the upload state; this basically
          * means that upload has started from beginning.

boot/zephyr/Kconfig

@@ -67,6 +67,25 @@ config SINGLE_APPLICATION_SLOT
 	  uploading a new application overwrites the one that previously
 	  occupied the area.
 
+config MCUBOOT_SERIAL_MCUMGR_SIMPLE_IMAGE_INDEX
+	bool "mcumgr:image_upload assumes n=1+image*2+slot"
+	default n
+	help
+	  This option enables a simple mapping between
+	  image/slot listed by "mcumgr:image list" and
+	  the n argument used by "mcumgr:image upload"
+	  If unsure, leave at the default value.
+
+config MCUBOOT_SERIAL_MCUMGR_VERSION_DECORATE
+	bool "mcumgr:image_list appends info to version"
+	default n
+	help
+	  This option helps understand details about
+	  the different image/slots listed.
+	  Decided to append it to version property to
+	  make it visible with standard mcumgr clients.
+	  If unsure, leave at the default value.
+
 choice BOOT_SIGNATURE_TYPE
 	prompt "Signature type"
 	default BOOT_SIGNATURE_TYPE_RSA

boot/zephyr/include/sysflash/sysflash.h

@@ -23,18 +23,28 @@
 
 extern uint32_t _image_1_primary_slot_id[];
 
+#ifndef CONFIG_MCUBOOT_SERIAL_MCUMGR_SIMPLE_IMAGE_INDEX
+/* note: _image_1_primary_slot_id is the other/inactive mcuboot slot, generated by linker defs */
 #define FLASH_AREA_IMAGE_PRIMARY(x)            \
         ((x == 0) ?                            \
            PM_MCUBOOT_PRIMARY_ID :             \
          (x == 1) ?                            \
           (uint32_t)_image_1_primary_slot_id : \
            255 )
+#else
+#define FLASH_AREA_IMAGE_PRIMARY(x)            \
+        ((x == 0) ?                            \
+           PM_MCUBOOT_PRIMARY_ID :             \
+         (x == 1) ?                            \
+          PM_S0_ID : \
+           255 )
+#endif
 
 #define FLASH_AREA_IMAGE_SECONDARY(x) \
         ((x == 0) ?                   \
             PM_MCUBOOT_SECONDARY_ID:  \
         (x == 1) ?                    \
-           PM_MCUBOOT_SECONDARY_ID:   \
+           PM_S1_ID :  \
            255 )
 #else