dfu_target.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef DFU_TARGET_H__
#define DFU_TARGET_H__
 
#include <zephyr/types.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum dfu_target_image_type {
        DFU_TARGET_IMAGE_TYPE_NONE = 0,
        DFU_TARGET_IMAGE_TYPE_MCUBOOT = 1,
        DFU_TARGET_IMAGE_TYPE_MODEM_DELTA = 2,
        DFU_TARGET_IMAGE_TYPE_FULL_MODEM = 4,
        DFU_TARGET_IMAGE_TYPE_SMP = 8,
        DFU_TARGET_IMAGE_TYPE_SUIT = 16,
        DFU_TARGET_IMAGE_TYPE_ANY_APPLICATION = DFU_TARGET_IMAGE_TYPE_MCUBOOT,
        DFU_TARGET_IMAGE_TYPE_ANY_MODEM =
                (DFU_TARGET_IMAGE_TYPE_MODEM_DELTA | DFU_TARGET_IMAGE_TYPE_FULL_MODEM),
        DFU_TARGET_IMAGE_TYPE_ANY =
                (DFU_TARGET_IMAGE_TYPE_MCUBOOT | DFU_TARGET_IMAGE_TYPE_MODEM_DELTA |
                 DFU_TARGET_IMAGE_TYPE_FULL_MODEM),
};
 
enum dfu_target_evt_id {
        DFU_TARGET_EVT_ERASE_PENDING,
        DFU_TARGET_EVT_TIMEOUT,
        DFU_TARGET_EVT_ERASE_DONE
};
 
typedef void (*dfu_target_callback_t)(enum dfu_target_evt_id evt_id);
 
struct dfu_target {
        int (*init)(size_t file_size, int img_num, dfu_target_callback_t cb);
        int (*offset_get)(size_t *offset);
        int (*write)(const void *const buf, size_t len);
        int (*done)(bool successful);
        int (*schedule_update)(int img_num);
        int (*reset)();
};
 
enum dfu_target_image_type dfu_target_img_type(const void *const buf, size_t len);
 
enum dfu_target_image_type dfu_target_smp_img_type_check(const void *const buf, size_t len);
 
int dfu_target_init(int img_type, int img_num, size_t file_size, dfu_target_callback_t cb);
 
int dfu_target_offset_get(size_t *offset);
 
int dfu_target_write(const void *const buf, size_t len);
 
int dfu_target_done(bool successful);
 
int dfu_target_reset(void);
 
int dfu_target_schedule_update(int img_num);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DFU_TARGET_H__ */