dfu_target_full_modem.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef DFU_TARGET_FULL_MODEM_H__
#define DFU_TARGET_FULL_MODEM_H__
 
#include <stddef.h>
#include <sys/types.h>
#include <zephyr/device.h>
#include <dfu/dfu_target.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct dfu_target_fmfu_fdev {
        /* Flash device to use for storing the modem firmware. */
        const struct device *dev;
 
        /* Offset within the device to store the modem firmware. */
        off_t offset;
 
        /* Number of bytes to set aside in the device for storing the modem
         * firmware. Set this to '0' to use all available flash (starting from
         * `offset`.
         */
        size_t size;
};
 
struct dfu_target_full_modem_params {
        /* Buffer for writes to `fmfu_dev`. */
        uint8_t *buf;
 
        /* Length of `buf` */
        size_t len;
 
        /* Flash device for storing the modem firmware.
         * Ignored if CONFIG_DFU_TARGET_FULL_MODEM_USE_EXT_PARTITION is enabled.
         */
        struct dfu_target_fmfu_fdev *dev;
};
 
int dfu_target_full_modem_cfg(const struct dfu_target_full_modem_params *params);
 
int dfu_target_full_modem_fdev_get(struct dfu_target_fmfu_fdev * const fdev);
 
bool dfu_target_full_modem_identify(const void *const buf);
 
int dfu_target_full_modem_init(size_t file_size, int img_num,
                               dfu_target_callback_t callback);
 
int dfu_target_full_modem_offset_get(size_t *offset);
 
int dfu_target_full_modem_write(const void *const buf, size_t len);
 
int dfu_target_full_modem_done(bool successful);
 
int dfu_target_full_modem_schedule_update(int img_num);
 
int dfu_target_full_modem_reset(void);
 
#endif /* DFU_TARGET_FULL_MODEM_H__ */