fota_http.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Espressif Systems (Shanghai) Co., Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_MGMT_FOTA_HTTP_H_
#define ZEPHYR_INCLUDE_MGMT_FOTA_HTTP_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <zephyr/dfu/mcuboot.h>
#include <zephyr/net/tls_credentials.h>

 
#ifdef __cplusplus
extern "C" {
#endif

struct fota_http_progress {
        size_t written;
        size_t total;
        int http_status;
};

typedef void (*fota_http_progress_cb_t)(const struct fota_http_progress *progress, void *user_data);

typedef void (*fota_http_done_cb_t)(int result, void *user_data);

struct fota_http_download_params {
        const char *url;
        const char *const *headers;
#if defined(CONFIG_FOTA_HTTP_SHA256_CHECK) || defined(__DOXYGEN__)
        const uint8_t *sha256;
#endif
#if defined(CONFIG_FOTA_HTTP_TLS) || defined(__DOXYGEN__)
        const sec_tag_t *sec_tags;
        size_t sec_tag_count;
        const char *tls_hostname;
#endif
        fota_http_progress_cb_t progress_cb;
        void *user_data;
        uint8_t image_index;
#if defined(CONFIG_FOTA_HTTP_RESUME) || defined(__DOXYGEN__)
        bool resume;
#endif
};

int fota_http_download(const struct fota_http_download_params *params);

int fota_http_download_async(const struct fota_http_download_params *params,
                             fota_http_done_cb_t done_cb);

int fota_http_cancel(void);

int fota_http_apply(uint8_t image_index, bool permanent);

int fota_http_confirm(uint8_t image_index);

bool fota_http_confirm_pending(void);

int fota_http_get_download_slot(uint8_t image_index);

int fota_http_get_image_header(uint8_t image_index, struct mcuboot_img_header *header);

size_t fota_http_nvm_bytes_written(void);

int fota_http_tls_add_ca(const void *cert, size_t len);

int fota_http_tls_add_client_cert(const void *cert, size_t cert_len, const void *key,
                                  size_t key_len);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_MGMT_FOTA_HTTP_H_ */