mcuboot.h File Reference

MCUboot public API for MCUboot control of image boot process. More...

#include <stdbool.h>
#include <stddef.h>
#include <sys/types.h>
#include <zephyr/types.h>

Go to the source code of this file.

Data Structures
struct	mcuboot_img_sem_ver
	MCUboot image header representation for image version. More...
struct	mcuboot_img_header_v1
	Model for the MCUboot image header as of version 1. More...
struct	mcuboot_img_header
	Model for the MCUBoot image header. More...

Macros
#define	BOOT_SWAP_TYPE_NONE   1
	Attempt to boot the contents of slot 0.
#define	BOOT_SWAP_TYPE_TEST   2
	Swap to slot 1.
#define	BOOT_SWAP_TYPE_PERM   3
	Swap to slot 1, and permanently switch to booting its contents.
#define	BOOT_SWAP_TYPE_REVERT   4
	Swap back to alternate slot.
#define	BOOT_SWAP_TYPE_FAIL   5
	Swap failed because image to be run is not valid.
#define	BOOT_IMG_VER_STRLEN_MAX   25 /* 255.255.65535.4294967295\0 */
#define	SWAP_USING_OFFSET_SECTOR_UPDATE_BEGIN   1
	Sector at which firmware update should be placed by application in swap using offset mode.
#define	BOOT_UPGRADE_TEST   0
	Boot upgrade request modes.
#define	BOOT_UPGRADE_PERMANENT   1

Functions
int	boot_read_bank_header (uint8_t area_id, struct mcuboot_img_header *header, size_t header_size)
	Read the MCUboot image header information from an image bank.
uint8_t	boot_fetch_active_slot (void)
	Get the flash area id for the active image slot.
bool	boot_is_img_confirmed (void)
	Check if the currently running image is confirmed as OK.
int	boot_write_img_confirmed (void)
	Marks the currently running image as confirmed.
int	boot_write_img_confirmed_multi (int image_index)
	Marks the image with the given index in the primary slot as confirmed.
int	mcuboot_swap_type (void)
	Determines the action, if any, that mcuboot will take on the next reboot.
int	mcuboot_swap_type_multi (int image_index)
	Determines the action, if any, that mcuboot will take on the next reboot.
int	boot_request_upgrade (int permanent)
	Marks the image in slot 1 as pending.
int	boot_request_upgrade_multi (int image_index, int permanent)
	Marks the image with the given index in the secondary slot as pending.
int	boot_erase_img_bank (uint8_t area_id)
	Erase the image Bank.
ssize_t	boot_get_area_trailer_status_offset (uint8_t area_id)
	Get the offset of the status in the image bank.
ssize_t	boot_get_trailer_status_offset (size_t area_size)
	Get the offset of the status from an image bank size.
size_t	boot_get_image_start_offset (uint8_t area_id)
	Get the offset of the image header, this should be used in swap using offset mode to account for the secondary slot data starting in the first or second sector, depending upon the current state.

Detailed Description

MCUboot public API for MCUboot control of image boot process.

The header declares API functions that can be used to get information on and select application images for boot.