fota_download.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef FOTA_DOWNLOAD_H_
#define FOTA_DOWNLOAD_H_
 
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <net/download_client.h>
#include <dfu/dfu_target.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum fota_download_evt_id {
        FOTA_DOWNLOAD_EVT_PROGRESS,
 
        FOTA_DOWNLOAD_EVT_FINISHED,
 
        FOTA_DOWNLOAD_EVT_ERASE_PENDING,
 
        FOTA_DOWNLOAD_EVT_ERASE_TIMEOUT,
 
        FOTA_DOWNLOAD_EVT_ERASE_DONE,
 
        FOTA_DOWNLOAD_EVT_ERROR,
 
        FOTA_DOWNLOAD_EVT_CANCELLED,
 
        FOTA_DOWNLOAD_EVT_RESUME_OFFSET,
};
 
enum fota_download_error_cause {
        FOTA_DOWNLOAD_ERROR_CAUSE_NO_ERROR,
        FOTA_DOWNLOAD_ERROR_CAUSE_CONNECT_FAILED,
        FOTA_DOWNLOAD_ERROR_CAUSE_DOWNLOAD_FAILED,
        FOTA_DOWNLOAD_ERROR_CAUSE_INVALID_UPDATE,
        FOTA_DOWNLOAD_ERROR_CAUSE_TYPE_MISMATCH,
        FOTA_DOWNLOAD_ERROR_CAUSE_INTERNAL,
};
 
struct fota_download_evt {
        enum fota_download_evt_id id;
 
        union {
                enum fota_download_error_cause cause;
                int progress;
                size_t resume_offset;
        };
};
 
typedef void (*fota_download_callback_t)(const struct fota_download_evt *evt);
 
int fota_download_init(fota_download_callback_t client_callback);
 
int fota_download(const char *host, const char *file, const int *sec_tag_list,
                  uint8_t sec_tag_count, uint8_t pdn_id, size_t fragment_size,
                  const enum dfu_target_image_type expected_type);
 
 
int fota_download_any(const char *host, const char *file, const int *sec_tag_list,
                      uint8_t sec_tag_count, uint8_t pdn_id, size_t fragment_size);
 
int fota_download_start(const char *host, const char *file, int sec_tag,
                        uint8_t pdn_id, size_t fragment_size);
 
int fota_download_start_with_image_type(const char *host, const char *file,
                        int sec_tag, uint8_t pdn_id, size_t fragment_size,
                        const enum dfu_target_image_type expected_type);
 
int fota_download_cancel(void);
 
int fota_download_target(void);
 
int fota_download_s0_active_get(bool *const s0_active);
 
int fota_download_b1_file_parse(char *s0_s1_files);
 
int fota_download_external_start(const char *host, const char *file,
                                 const enum dfu_target_image_type expected_type,
                                 const size_t image_size);
 
int fota_download_external_evt_handle(struct download_client_evt const *const evt);
 
#ifdef __cplusplus
}
#endif
 
#endif /* FOTA_DOWNLOAD_H_ */