Commit dc1b9f05 authored by Dominik Ermel's avatar Dominik Ermel Committed by David Brown
Browse files

boot/ports: Provide getter function for flash area object access 



The commit provides set of getter functions that allow to
access fields of flash_area and flash_sectors objects.
Usage of these function, instead of direct field access, allows
to keep common code intact when internal, system specific,
implementation changes.
The commit contains the implementation of getters for following
ports: cpress, mbed, mynewt, zephyr.

Signed-off-by: default avatarDominik Ermel <dominik.ermel@nordicsemi.no>
parent d3f36092

boot/cypress/cy_flash_pal/include/flash_map_backend/flash_map_backend.h

+30 −0
Original line number Diff line number Diff line
@@ -92,6 +92,26 @@ struct flash_area { 
    uint32_t fa_size;

};



static inline uint8_t flash_area_get_id(const struct flash_area *fa)

{

    return fa->fa_id;

}



static inline uint8_t flash_area_get_device_id(const struct flash_area *fa)

{

    return fa->fa_device_id;

}



static inline uint32_t flash_area_get_off(const struct flash_area *fa)

{

    return fa->fa_off;

}



static inline uint32_t flash_area_get_size(const struct flash_area *fa)

{

    return fa->fa_size;

}



/**

 * @brief Structure describing a sector within a flash area.

 *
@@ -111,6 +131,16 @@ struct flash_sector { 
    uint32_t fs_size;

};



static inline uint32_t flash_sector_get_off(const struct flash_sector *fs)

{

    return fs->fs_off;

}



static inline uint32_t flash_sector_get_size(const struct flash_sector *fs)

{

    return fs->fs_size;

}



struct flash_map_entry {

    uint32_t magic;

    struct flash_area area;

boot/mbed/include/flash_map_backend/flash_map_backend.h

+30 −0
Original line number Diff line number Diff line
@@ -75,6 +75,26 @@ struct flash_area { 
    uint32_t fa_size;

};



static inline uint8_t flash_area_get_id(const struct flash_area *fa)

{

    return fa->fa_id;

}



static inline uint8_t flash_area_get_device_id(const struct flash_area *fa)

{

    return fa->fa_device_id;

}



static inline uint32_t flash_area_get_off(const struct flash_area *fa)

{

    return fa->fa_off;

}



static inline uint32_t flash_area_get_size(const struct flash_area *fa)

{

    return fa->fa_size;

}



/**

 * @brief Structure describing a sector within a flash area.

 *
@@ -94,6 +114,16 @@ struct flash_sector { 
    uint32_t fs_size;

};



static inline uint32_t flash_sector_get_off(const struct flash_sector *fs)

{

    return fs->fs_off;

}



static inline uint32_t flash_sector_get_size(const struct flash_sector *fs)

{

    return fs->fs_size;

}



/*

 * Start using flash area.

 */

boot/mynewt/flash_map_backend/include/flash_map_backend/flash_map_backend.h

+21 −0
Original line number Diff line number Diff line
@@ -8,6 +8,7 @@ 
#define __FLASH_MAP_BACKEND_H__



#include <sysflash/sysflash.h>

#include <flash_map/flash_map.h>

#include <mcuboot_config/mcuboot_config.h>



#if (MCUBOOT_IMAGE_NUMBER == 1)
@@ -39,4 +40,24 @@ 
int flash_area_id_from_multi_image_slot(int image_index, int slot);

int flash_area_id_to_multi_image_slot(int image_index, int area_id);



static inline uint8_t flash_area_get_id(const struct flash_area *fa)

{

    return fa->fa_id;

}



static inline uint8_t flash_area_get_device_id(const struct flash_area *fa)

{

    return fa->fa_device_id;

}



static inline uint32_t flash_area_get_off(const struct flash_area *fa)

{

    return fa->fa_off;

}



static inline uint32_t flash_area_get_size(const struct flash_area *fa)

{

    return fa->fa_size;

}



#endif /* __FLASH_MAP_BACKEND_H__ */

boot/zephyr/flash_map_extended.c

+6 −0
Original line number Diff line number Diff line
@@ -109,6 +109,12 @@ int flash_area_sector_from_off(off_t off, struct flash_sector *sector) 
    return rc;

}



uint8_t flash_area_get_device_id(const struct flash_area *fa)

{

	(void)fa;

	return FLASH_DEVICE_ID;

}



#define ERASED_VAL 0xff

__weak uint8_t flash_area_erased_val(const struct flash_area *fap)

{

boot/zephyr/include/flash_map_backend/flash_map_backend.h

+27 −0
Original line number Diff line number Diff line
@@ -76,12 +76,39 @@ int flash_area_id_to_multi_image_slot(int image_index, int area_id); 
 */

int flash_area_sector_from_off(off_t off, struct flash_sector *sector);



static inline uint32_t flash_area_get_off(const struct flash_area *fa)

{

	return (uint32_t)fa->fa_off;

}



static inline uint32_t flash_area_get_size(const struct flash_area *fa)

{

	return (uint32_t)fa->fa_size;

}



static inline uint8_t flash_area_get_id(const struct flash_area *fa)

{

	return fa->fa_id;

}



uint8_t flash_area_get_device_id(const struct flash_area *fa);



/*

 * Returns the value expected to be read when accessing any erased

 * flash byte.

 */

uint8_t flash_area_erased_val(const struct flash_area *fap);



static inline uint32_t flash_sector_get_off(const struct flash_sector *fs)

{

	return fs->fs_off;

}



static inline uint32_t flash_sector_get_size(const struct flash_sector *fs)

{

	return fs->fs_size;

}



#ifdef __cplusplus

}

#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE