mcuboot.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Nordic Semiconductor ASA
 * Copyright (c) 2016 Linaro Limited
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DFU_MCUBOOT_H_
#define ZEPHYR_INCLUDE_DFU_MCUBOOT_H_
 
#include <stdbool.h>
#include <stddef.h>
 
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef BOOT_SWAP_TYPE_NONE
#if BOOT_SWAP_TYPE_NONE != 1 /*ensure the same definition in MCUboot */
#error "definition incompatible"
#endif
#else
#define BOOT_SWAP_TYPE_NONE     1
#endif
 
#ifdef BOOT_SWAP_TYPE_TEST
#if BOOT_SWAP_TYPE_TEST != 2  /*ensure the same definition in MCUboot */
#error "definition incompatible"
#endif
#else
#define BOOT_SWAP_TYPE_TEST     2
#endif
 
#ifdef BOOT_SWAP_TYPE_PERM
#if BOOT_SWAP_TYPE_PERM != 3  /*ensure the same definition in MCUboot */
#error "definition incompatible"
#endif
#else
#define BOOT_SWAP_TYPE_PERM     3
#endif
 
#ifdef BOOT_SWAP_TYPE_REVERT
#if BOOT_SWAP_TYPE_REVERT != 4  /*ensure the same definition in MCUboot */
#error "definition incompatible"
#endif
#else
#define BOOT_SWAP_TYPE_REVERT   4
#endif
 
#ifdef BOOT_SWAP_TYPE_FAIL
#if BOOT_SWAP_TYPE_FAIL != 5  /*ensure the same definition in MCUboot */
#error "definition incompatible"
#endif
#else
#define BOOT_SWAP_TYPE_FAIL     5
#endif
 
#define BOOT_IMG_VER_STRLEN_MAX 25  /* 255.255.65535.4294967295\0 */
 
/* Trailer: */
#define BOOT_MAX_ALIGN          8
#ifndef BOOT_MAGIC_SZ
#define BOOT_MAGIC_SZ           16
#endif
 
#define BOOT_TRAILER_IMG_STATUS_OFFS(bank_area) ((bank_area)->fa_size -\
                                                  BOOT_MAGIC_SZ -\
                                                  BOOT_MAX_ALIGN * 2)
struct mcuboot_img_sem_ver {
        uint8_t major;
        uint8_t minor;
        uint16_t revision;
        uint32_t build_num;
};
 
struct mcuboot_img_header_v1 {
        uint32_t image_size;
        struct mcuboot_img_sem_ver sem_ver;
};
 
struct mcuboot_img_header {
        uint32_t mcuboot_version;
        union {
                struct mcuboot_img_header_v1 v1;
        } h;
};
 
int boot_read_bank_header(uint8_t area_id,
                          struct mcuboot_img_header *header,
                          size_t header_size);
 
bool boot_is_img_confirmed(void);
 
int boot_write_img_confirmed(void);
 
int boot_write_img_confirmed_multi(int image_index);
 
int mcuboot_swap_type(void);
 
int mcuboot_swap_type_multi(int image_index);
 
 
#define BOOT_UPGRADE_TEST       0
#define BOOT_UPGRADE_PERMANENT  1
 
int boot_request_upgrade(int permanent);
 
int boot_request_upgrade_multi(int image_index, int permanent);
 
int boot_erase_img_bank(uint8_t area_id);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* ZEPHYR_INCLUDE_DFU_MCUBOOT_H_ */