MCUBoot active slot and version over SMP

[tdfilip]

Hello,

I work on a board with nRF9160 and nRF52840.
I can perform firmware update of both application and mcuboot for nRF52840 (using serial recovery mode) from the nRF9160 over SMP.

My question is:
How nRF9160 can get information from nRF52840 in serial recovery mode over SMP about the active mcuboot slot, so we know which build (S0/S1) we should use for the next mcuboot update. Also, how the nRF9160 can get the currently used mcuboot image version from nRF52840 in serial recovery mode.

[Sigurd]

Hi!

Mabye you can use this lib, https://github.com/nrfconnect/sdk-nrf/tree/main/subsys/net/lib/mcumgr_smp_client , and use the cmd_read_image_list() function.

[tdfilip]

Hello,

The following function is used to get images data in file boot_serial.c in function bs_list to send it as response to cmd_read_image_list request:

Fullscreen

1

2

3

4

5

6

7

8

static inline uint32_t __flash_area_ids_for_slot(int img, int slot)

{

static const int all_slots[] = {

ALL_AVAILABLE_SLOTS

MCUBOOT_S0_S1_SLOTS

};

return all_slots[img * 2 + slot];

};

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

static inline uint32_t __flash_area_ids_for_slot(int img, int slot)
{
    static const int all_slots[] = {
	ALL_AVAILABLE_SLOTS
	MCUBOOT_S0_S1_SLOTS
    };
    return all_slots[img * 2 + slot];
};

If I understand it correctly, it gives data of the following images:
Image 0, slot 0: PM_MCUBOOT_PRIMARY_ID (application image in primary slot)
Image 0, slot 1: PM_MCUBOOT_SECONDARY_ID (mcuboot or application image in secondary slot)
Image 1, slot 0: PM_S1_ID (if S0 is used) / PM_S0_ID (if S1 is used)
Image 1, slot 1: PM_MCUBOOT_SECONDARY_ID (mcuboot or application image in secondary slot)

Based on these images, I do not have the information about the active mcuboot image (its version) and the active mcuboot slot. Correct me if my understanding is incorrect.

Also, why is PM_MCUBOOT_SECONDARY_ID sent twice - as image 0 slot 1 and image 1 slot 1?

[Sigurd]

Maybe dfu_target_smp_image_list_get() would be better:

https://github.com/nrfconnect/sdk-nrf/blob/v2.9.0/subsys/dfu/dfu_target/src/dfu_target_smp.c#L296

Snippet that shows how to read version info:

Fullscreen

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

struct mcumgr_image_state image_list = {0};

struct mcumgr_image_data *list;

size_t ver_len;

int ret = dfu_target_smp_image_list_get(&image_list);

if (ret) {

LOG_WRN("Failed to read SMP image list, error: %d", ret);

return -ENODATA;

}

/* Set the return value in case no active image is found */

ret = -ENODEV;

list = image_list.image_list;

for (int i = 0; i < image_list.image_list_length; ++i, ++list) {

LOG_DBG("%s Image(%d) slot(%d)",

list->flags.active ? "Primary" : "Secondary",

list->img_num,

list->slot_num);

LOG_DBG(" Version: %s", list->version);

LOG_DBG(" Bootable(%d) Pending(%d) Confirmed(%d)",

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

	struct mcumgr_image_state image_list = {0};
	struct mcumgr_image_data *list;
	size_t ver_len;
	int ret = dfu_target_smp_image_list_get(&image_list);

	if (ret) {
		LOG_WRN("Failed to read SMP image list, error: %d", ret);
		return -ENODATA;
	}

	/* Set the return value in case no active image is found */
	ret  = -ENODEV;

	list = image_list.image_list;
	for (int i = 0; i < image_list.image_list_length; ++i, ++list) {
		LOG_DBG("%s Image(%d) slot(%d)",
			list->flags.active ? "Primary" : "Secondary",
			list->img_num,
			list->slot_num);
		LOG_DBG("  Version: %s", list->version);
		LOG_DBG("  Bootable(%d) Pending(%d) Confirmed(%d)",
			list->flags.bootable, list->flags.pending, list->flags.confirmed);

		if (list->flags.active) {
			ver_len = strlen(list->version);
			if (ver_len >= sizeof(smp_ver)) {
				return -ENOBUFS;
			}
			memcpy(smp_ver, list->version, ver_len + 1);
			ret = 0;
		}
	}

	return ret;

[tdfilip]

The dfu_target_smp_image_list_get() is the function that I use on the nRF9160 side to read image list from the nRF52840 when it is in mcuboot. The problem is with bs_list function that is used to handle the request sent using dfu_target_smp_image_list_get().

So my question remains the same as in my previous post.

To be more precise, I don't have a problem reading current application image and its version. The problem is with reading the current mcuboot version and the active mcuboot slot.

[tdfilip]

The following change in bs_list function in boot_serial.c file makes it possible to read over SMP both mcuboot images in S0 and S1 and the application image:

From this:

Fullscreen

1

area_id = flash_area_id_from_multi_image_slot(image_index, slot);

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

area_id = flash_area_id_from_multi_image_slot(image_index, slot);

To this:

Fullscreen

1

2

3

4

5

6

7

8

9

if(image_index == 1)

{

if(slot == 0) area_id = PM_S0_ID;

else area_id = PM_S1_ID;

}

else

{

area_id = flash_area_id_from_multi_image_slot(image_index, slot);

}

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

            if(image_index == 1)
            {
                if(slot == 0) area_id = PM_S0_ID;
                else          area_id = PM_S1_ID;
            }
            else 
            {
                area_id = flash_area_id_from_multi_image_slot(image_index, slot);
            }

With this change, the bs_list will respond to request sent from nRF91 using dfu_target_smp_image_list_get() with the following images:

Image 0, slot 0: PM_MCUBOOT_PRIMARY_ID
Image 0, slot 1: PM_MCUBOOT_SECONDARY_ID
Image 1, slot 0: PM_S0_ID
Image 1, slot 1: PM_S1_ID

which solves both issues I mentioned before.

I'd like to ask if that change can possibly break anything for me? Or maybe that's what bs_list should respond with in the first place?

Regards,
Filip