xf_ota_client.h

浏览该文件的文档.

 
#ifndef __XF_OTA_CLIENT_H__
#define __XF_OTA_CLIENT_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_ota_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_ota_init(void);
 
xf_err_t xf_ota_deinit(void);
 
xf_err_t xf_ota_get_running_partition(xf_ota_partition_t *p_part_hdl);
 
xf_err_t xf_ota_get_next_update_partition(
    xf_ota_partition_t *p_start_part_hdl, xf_ota_partition_t *p_next_part_hdl);
 
xf_err_t xf_ota_get_partition_info(
    const xf_ota_partition_t *p_part_hdl, xf_ota_partition_info_t *p_info);
 
size_t xf_ota_get_platform_app_desc_size(void);
 
xf_err_t xf_ota_get_platform_app_desc_block(
    xf_ota_partition_t *p_part_hdl, void *p_desc_out, size_t buff_size);
 
size_t xf_ota_get_platform_app_digest_size(void);
 
xf_err_t xf_ota_get_platform_app_digest_block(
    xf_ota_partition_t *p_part_hdl, void *p_digest_out, size_t buff_size);
 
xf_err_t xf_ota_start(
    xf_ota_partition_t *p_part_hdl,
    uint32_t package_len, bool sequential_write, xf_ota_t *p_hdl);
 
xf_err_t xf_ota_abort(xf_ota_t *p_hdl);
 
xf_err_t xf_ota_end(xf_ota_t *p_hdl);
 
xf_err_t xf_ota_upgrade(xf_ota_partition_t *p_part_hdl, bool reboot);
 
xf_err_t xf_ota_write(xf_ota_t *p_hdl, const void *src, size_t size);
 
xf_err_t xf_ota_write_to(
    xf_ota_t *p_hdl, size_t dst_offset, const void *src, size_t size);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XF_OTA_CLIENT_H__ */