Commit 70ad2d44 authored by Jamie McCrae's avatar Jamie McCrae
Browse files

boot: bootutil: Fix serial recovery issues 



Fixes serial recovery issues in various MCUboot operating modes by
moving functions that are needed out from loader to a common file
and adapting them to work in these different modes

Note: This PR has been modified from the upstream commit due to
a merge failure from other changes that are not being brought into
Zephyr 3.7

Signed-off-by: default avatarJamie McCrae <jamie.mccrae@nordicsemi.no>
(cherry picked from commit e2c97da3)
parent 4e659a94

boot/bootutil/include/bootutil/bootutil.h

+1 −0
Original line number Diff line number Diff line
@@ -84,6 +84,7 @@ fih_ret boot_go_for_image_id(struct boot_rsp *rsp, uint32_t image_id); 
void boot_state_clear(struct boot_loader_state *state);

fih_ret context_boot_go(struct boot_loader_state *state, struct boot_rsp *rsp);

struct boot_loader_state *boot_get_loader_state(void);

void boot_fetch_slot_state_sizes(void);



#define SPLIT_GO_OK                 (0)

#define SPLIT_GO_NON_MATCHING       (-1)

boot/bootutil/src/bootutil_misc.c

+140 −0
Original line number Diff line number Diff line
@@ -43,11 +43,22 @@ 
#include "bootutil/enc_key.h"

#endif



#if defined(MCUBOOT_SWAP_USING_SCRATCH)

#include "swap_priv.h"

#endif



BOOT_LOG_MODULE_DECLARE(mcuboot);



/* Currently only used by imgmgr */

int boot_current_slot;



#if (!defined(MCUBOOT_DIRECT_XIP) && !defined(MCUBOOT_RAM_LOAD))

/* Used for holding static buffers in multiple functions to work around issues

 * in older versions of gcc (e.g. 4.8.4)

 */

static struct boot_sector_buffer sector_buffers;

#endif



/**

 * @brief Determine if the data at two memory addresses is equal

 *
@@ -547,3 +558,132 @@ boot_erase_region(const struct flash_area *fa, uint32_t off, uint32_t size, bool 
end:

    return rc;

}



#if (!defined(MCUBOOT_DIRECT_XIP) && !defined(MCUBOOT_RAM_LOAD))

int

boot_initialize_area(struct boot_loader_state *state, int flash_area)

{

    uint32_t num_sectors = BOOT_MAX_IMG_SECTORS;

    boot_sector_t *out_sectors;

    uint32_t *out_num_sectors;

    int rc;



    num_sectors = BOOT_MAX_IMG_SECTORS;



    if (flash_area == FLASH_AREA_IMAGE_PRIMARY(BOOT_CURR_IMG(state))) {

        out_sectors = BOOT_IMG(state, BOOT_PRIMARY_SLOT).sectors;

        out_num_sectors = &BOOT_IMG(state, BOOT_PRIMARY_SLOT).num_sectors;

#if BOOT_NUM_SLOTS > 1

    } else if (flash_area == FLASH_AREA_IMAGE_SECONDARY(BOOT_CURR_IMG(state))) {

        out_sectors = BOOT_IMG(state, BOOT_SECONDARY_SLOT).sectors;

        out_num_sectors = &BOOT_IMG(state, BOOT_SECONDARY_SLOT).num_sectors;

#if MCUBOOT_SWAP_USING_SCRATCH

    } else if (flash_area == FLASH_AREA_IMAGE_SCRATCH) {

        out_sectors = state->scratch.sectors;

        out_num_sectors = &state->scratch.num_sectors;

#endif

#endif

    } else {

        return BOOT_EFLASH;

    }



#ifdef MCUBOOT_USE_FLASH_AREA_GET_SECTORS

    rc = flash_area_get_sectors(flash_area, &num_sectors, out_sectors);

#else

    _Static_assert(sizeof(int) <= sizeof(uint32_t), "Fix needed");

    rc = flash_area_to_sectors(flash_area, (int *)&num_sectors, out_sectors);

#endif /* defined(MCUBOOT_USE_FLASH_AREA_GET_SECTORS) */

    if (rc != 0) {

        return rc;

    }

    *out_num_sectors = num_sectors;

    return 0;

}



static uint32_t

boot_write_sz(struct boot_loader_state *state)

{

    uint32_t elem_sz;

#if MCUBOOT_SWAP_USING_SCRATCH

    uint32_t align;

#endif



    /* Figure out what size to write update status update as.  The size depends

     * on what the minimum write size is for scratch area, active image slot.

     * We need to use the bigger of those 2 values.

     */

    elem_sz = flash_area_align(BOOT_IMG_AREA(state, BOOT_PRIMARY_SLOT));

#if MCUBOOT_SWAP_USING_SCRATCH

    align = flash_area_align(BOOT_SCRATCH_AREA(state));

    if (align > elem_sz) {

        elem_sz = align;

    }

#endif



    return elem_sz;

}



int

boot_read_sectors(struct boot_loader_state *state, struct boot_sector_buffer *sectors)

{

    uint8_t image_index;

    int rc;



    if (sectors == NULL) {

        sectors = &sector_buffers;

    }



    image_index = BOOT_CURR_IMG(state);



    BOOT_IMG(state, BOOT_PRIMARY_SLOT).sectors =

        sectors->primary[image_index];

#if BOOT_NUM_SLOTS > 1

    BOOT_IMG(state, BOOT_SECONDARY_SLOT).sectors =

        sectors->secondary[image_index];

#if MCUBOOT_SWAP_USING_SCRATCH

    state->scratch.sectors = sectors->scratch;

#endif

#endif



    rc = boot_initialize_area(state, FLASH_AREA_IMAGE_PRIMARY(image_index));

    if (rc != 0) {

        return BOOT_EFLASH;

    }



#if BOOT_NUM_SLOTS > 1

    rc = boot_initialize_area(state, FLASH_AREA_IMAGE_SECONDARY(image_index));

    if (rc != 0) {

        /* We need to differentiate from the primary image issue */

        return BOOT_EFLASH_SEC;

    }



#if MCUBOOT_SWAP_USING_SCRATCH

    rc = boot_initialize_area(state, FLASH_AREA_IMAGE_SCRATCH);

    if (rc != 0) {

        return BOOT_EFLASH;

    }

#endif

#endif



    BOOT_WRITE_SZ(state) = boot_write_sz(state);



    return 0;

}

#endif



/**

 * Clears the boot state, so that previous operations have no effect on new

 * ones.

 *

 * @param state                 The state that should be cleared. If the value

 *                              is NULL, the default bootloader state will be

 *                              cleared.

 */

void boot_state_clear(struct boot_loader_state *state)

{

    if (state != NULL) {

        memset(state, 0, sizeof(struct boot_loader_state));

    } else {

        memset(boot_get_loader_state(), 0, sizeof(struct boot_loader_state));

    }

}

boot/bootutil/src/bootutil_priv.h

+6 −0
Original line number Diff line number Diff line
@@ -84,6 +84,12 @@ struct flash_area; 
#define BOOT_STATUS_OP_MOVE     1

#define BOOT_STATUS_OP_SWAP     2



#if (BOOT_IMAGE_NUMBER > 1)

#define IMAGES_ITER(x) for ((x) = 0; (x) < BOOT_IMAGE_NUMBER; ++(x))

#else

#define IMAGES_ITER(x)

#endif



/*

 * Maintain state of copy progress.

 */

boot/bootutil/src/loader.c

+0 −130
Original line number Diff line number Diff line
@@ -63,13 +63,6 @@ 
BOOT_LOG_MODULE_DECLARE(mcuboot);



static struct boot_loader_state boot_data;

static struct boot_sector_buffer sector_buffers;



#if (BOOT_IMAGE_NUMBER > 1)

#define IMAGES_ITER(x) for ((x) = 0; (x) < BOOT_IMAGE_NUMBER; ++(x))

#else

#define IMAGES_ITER(x)

#endif



/*

 * This macro allows some control on the allocation of local variables.
@@ -271,46 +264,6 @@ boot_version_cmp(const struct image_version *ver1, 
}

#endif



#if (!defined(MCUBOOT_DIRECT_XIP) && !defined(MCUBOOT_RAM_LOAD))

static int

boot_initialize_area(struct boot_loader_state *state, int flash_area)

{

    uint32_t num_sectors = BOOT_MAX_IMG_SECTORS;

    boot_sector_t *out_sectors;

    uint32_t *out_num_sectors;

    int rc;



    num_sectors = BOOT_MAX_IMG_SECTORS;



    if (flash_area == FLASH_AREA_IMAGE_PRIMARY(BOOT_CURR_IMG(state))) {

        out_sectors = BOOT_IMG(state, BOOT_PRIMARY_SLOT).sectors;

        out_num_sectors = &BOOT_IMG(state, BOOT_PRIMARY_SLOT).num_sectors;

    } else if (flash_area == FLASH_AREA_IMAGE_SECONDARY(BOOT_CURR_IMG(state))) {

        out_sectors = BOOT_IMG(state, BOOT_SECONDARY_SLOT).sectors;

        out_num_sectors = &BOOT_IMG(state, BOOT_SECONDARY_SLOT).num_sectors;

#if MCUBOOT_SWAP_USING_SCRATCH

    } else if (flash_area == FLASH_AREA_IMAGE_SCRATCH) {

        out_sectors = state->scratch.sectors;

        out_num_sectors = &state->scratch.num_sectors;

#endif

    } else {

        return BOOT_EFLASH;

    }



#ifdef MCUBOOT_USE_FLASH_AREA_GET_SECTORS

    rc = flash_area_get_sectors(flash_area, &num_sectors, out_sectors);

#else

    _Static_assert(sizeof(int) <= sizeof(uint32_t), "Fix needed");

    rc = flash_area_to_sectors(flash_area, (int *)&num_sectors, out_sectors);

#endif /* defined(MCUBOOT_USE_FLASH_AREA_GET_SECTORS) */

    if (rc != 0) {

        return rc;

    }

    *out_num_sectors = num_sectors;

    return 0;

}

#endif



#if (BOOT_IMAGE_NUMBER > 1)



static int
@@ -603,72 +556,6 @@ done: 
#endif /* !MCUBOOT_OVERWRITE_ONLY */



#if !defined(MCUBOOT_RAM_LOAD)

static uint32_t

boot_write_sz(struct boot_loader_state *state)

{

    uint32_t elem_sz;

#if MCUBOOT_SWAP_USING_SCRATCH

    uint32_t align;

#endif



    /* Figure out what size to write update status update as.  The size depends

     * on what the minimum write size is for scratch area, active image slot.

     * We need to use the bigger of those 2 values.

     */

    elem_sz = flash_area_align(BOOT_IMG_AREA(state, BOOT_PRIMARY_SLOT));

#if MCUBOOT_SWAP_USING_SCRATCH

    align = flash_area_align(BOOT_SCRATCH_AREA(state));

    if (align > elem_sz) {

        elem_sz = align;

    }

#endif



    return elem_sz;

}



int

boot_read_sectors(struct boot_loader_state *state, struct boot_sector_buffer *sectors)

{

    uint8_t image_index;

    int rc;



    if (sectors == NULL) {

        sectors = &sector_buffers;

    }



    image_index = BOOT_CURR_IMG(state);



    BOOT_IMG(state, BOOT_PRIMARY_SLOT).sectors =

        sectors->primary[image_index];

    BOOT_IMG(state, BOOT_SECONDARY_SLOT).sectors =

        sectors->secondary[image_index];

#if MCUBOOT_SWAP_USING_SCRATCH

    state->scratch.sectors = sectors->scratch;

#endif



    rc = boot_initialize_area(state, FLASH_AREA_IMAGE_PRIMARY(image_index));

    if (rc != 0) {

        return BOOT_EFLASH;

    }



    rc = boot_initialize_area(state, FLASH_AREA_IMAGE_SECONDARY(image_index));

    if (rc != 0) {

        /* We need to differentiate from the primary image issue */

        return BOOT_EFLASH_SEC;

    }



#if MCUBOOT_SWAP_USING_SCRATCH

    rc = boot_initialize_area(state, FLASH_AREA_IMAGE_SCRATCH);

    if (rc != 0) {

        return BOOT_EFLASH;

    }

#endif



    BOOT_WRITE_SZ(state) = boot_write_sz(state);



    return 0;

}



void

boot_status_reset(struct boot_status *bs)

{
@@ -3272,23 +3159,6 @@ boot_go_for_image_id(struct boot_rsp *rsp, uint32_t image_id) 
    FIH_RET(fih_rc);

}



/**

 * Clears the boot state, so that previous operations have no effect on new

 * ones.

 *

 * @param state                 The state that should be cleared. If the value

 *                              is NULL, the default bootloader state will be

 *                              cleared.

 */

void boot_state_clear(struct boot_loader_state *state)

{

    if (state != NULL) {

        memset(state, 0, sizeof(struct boot_loader_state));

    } else {

        memset(&boot_data, 0, sizeof(struct boot_loader_state));

    }

}



int

boot_open_all_flash_areas(struct boot_loader_state *state)

{

boot/zephyr/single_loader.c

+29 −12
Original line number Diff line number Diff line
@@ -16,14 +16,13 @@ 


BOOT_LOG_MODULE_DECLARE(mcuboot);



/* Variables passed outside of unit via poiters. */

static const struct flash_area *_fa_p;

/* Variables passed outside of unit via pointers. */

static struct image_header _hdr = { 0 };

static struct boot_loader_state boot_data;

static struct boot_loader_state state;



struct boot_loader_state *boot_get_loader_state(void)

{

    return &boot_data;

    return &state;

}



#if defined(MCUBOOT_VALIDATE_PRIMARY_SLOT) || defined(MCUBOOT_VALIDATE_PRIMARY_SLOT_ONCE)
@@ -97,6 +96,23 @@ boot_image_validate_once(const struct flash_area *fa_p, 
}

#endif



int

boot_open_all_flash_areas(struct boot_loader_state *state)

{

    int rc;



    rc = flash_area_open(FLASH_AREA_IMAGE_PRIMARY(0), &BOOT_IMG_AREA(state, BOOT_PRIMARY_SLOT));

    assert(rc == 0);



    return rc;

}



void

boot_close_all_flash_areas(struct boot_loader_state *state)

{

    flash_area_close(BOOT_IMG_AREA(state, BOOT_PRIMARY_SLOT));

}



/**

 * Gather information on image and prepare for booting.

 *
@@ -110,20 +126,21 @@ boot_go(struct boot_rsp *rsp) 
    int rc = -1;

    FIH_DECLARE(fih_rc, FIH_FAILURE);



    rc = flash_area_open(FLASH_AREA_IMAGE_PRIMARY(0), &_fa_p);

    assert(rc == 0);

    BOOT_LOG_DBG("boot_go: Single loader");



    rc = boot_open_all_flash_areas(&state);



    rc = boot_image_load_header(_fa_p, &_hdr);

    rc = boot_image_load_header(BOOT_IMG_AREA(&state, BOOT_PRIMARY_SLOT), &_hdr);

    if (rc != 0)

        goto out;



#ifdef MCUBOOT_VALIDATE_PRIMARY_SLOT

    FIH_CALL(boot_image_validate, fih_rc, _fa_p, &_hdr);

    FIH_CALL(boot_image_validate, fih_rc, BOOT_IMG_AREA(&state, BOOT_PRIMARY_SLOT), &_hdr);

    if (FIH_NOT_EQ(fih_rc, FIH_SUCCESS)) {

        goto out;

    }

#elif defined(MCUBOOT_VALIDATE_PRIMARY_SLOT_ONCE)

    FIH_CALL(boot_image_validate_once, fih_rc, _fa_p, &_hdr);

    FIH_CALL(boot_image_validate_once, fih_rc, BOOT_IMG_AREA(&state, BOOT_PRIMARY_SLOT), &_hdr);

    if (FIH_NOT_EQ(fih_rc, FIH_SUCCESS)) {

        goto out;

    }
@@ -131,12 +148,12 @@ boot_go(struct boot_rsp *rsp) 
    fih_rc = FIH_SUCCESS;

#endif /* MCUBOOT_VALIDATE_PRIMARY_SLOT */



    rsp->br_flash_dev_id = flash_area_get_device_id(_fa_p);

    rsp->br_image_off = flash_area_get_off(_fa_p);

    rsp->br_flash_dev_id = flash_area_get_device_id(BOOT_IMG_AREA(&state, BOOT_PRIMARY_SLOT));

    rsp->br_image_off = flash_area_get_off(BOOT_IMG_AREA(&state, BOOT_PRIMARY_SLOT));

    rsp->br_hdr = &_hdr;



out:

    flash_area_close(_fa_p);

    boot_close_all_flash_areas(&state);



    FIH_RET(fih_rc);

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE