advanced_fw_update.h

Go to the documentation of this file.

/*
 * Copyright 2017-2024 AVSystem <avsystem@avsystem.com>
 * AVSystem Anjay LwM2M SDK
 * All rights reserved.
 *
 * Licensed under the AVSystem-5-clause License.
 * See the attached LICENSE file for details.
 */
 
#ifndef ANJAY_INCLUDE_ANJAY_ADVANCED_FW_UPDATE_H
#define ANJAY_INCLUDE_ANJAY_ADVANCED_FW_UPDATE_H
 
#include <anjay/core.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ANJAY_ADVANCED_FW_UPDATE_OID 33629
 
typedef enum {
    ANJAY_ADVANCED_FW_UPDATE_STATE_IDLE = 0,
    ANJAY_ADVANCED_FW_UPDATE_STATE_DOWNLOADING,
    ANJAY_ADVANCED_FW_UPDATE_STATE_DOWNLOADED,
    ANJAY_ADVANCED_FW_UPDATE_STATE_UPDATING
} anjay_advanced_fw_update_state_t;
 
typedef enum {
    ANJAY_ADVANCED_FW_UPDATE_RESULT_INITIAL = 0,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_SUCCESS = 1,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_NOT_ENOUGH_SPACE = 2,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_OUT_OF_MEMORY = 3,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_CONNECTION_LOST = 4,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_INTEGRITY_FAILURE = 5,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_UNSUPPORTED_PACKAGE_TYPE = 6,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_INVALID_URI = 7,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_FAILED = 8,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_UNSUPPORTED_PROTOCOL = 9,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_UPDATE_CANCELLED = 10,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_DEFERRED = 11,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_CONFLICTING_STATE = 12,
    ANJAY_ADVANCED_FW_UPDATE_RESULT_DEPENDENCY_ERROR = 13,
} anjay_advanced_fw_update_result_t;
 
#define ANJAY_ADVANCED_FW_UPDATE_ERR_NOT_ENOUGH_SPACE \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_NOT_ENOUGH_SPACE)
#define ANJAY_ADVANCED_FW_UPDATE_ERR_OUT_OF_MEMORY \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_OUT_OF_MEMORY)
#define ANJAY_ADVANCED_FW_UPDATE_ERR_INTEGRITY_FAILURE \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_INTEGRITY_FAILURE)
#define ANJAY_ADVANCED_FW_UPDATE_ERR_UNSUPPORTED_PACKAGE_TYPE \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_UNSUPPORTED_PACKAGE_TYPE)
#define ANJAY_ADVANCED_FW_UPDATE_ERR_DEFERRED \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_DEFERRED)
#define ANJAY_ADVANCED_FW_UPDATE_ERR_CONFLICTING_STATE \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_CONFLICTING_STATE)
#define ANJAY_ADVANCED_FW_UPDATE_ERR_DEPENDENCY_ERROR \
    (-(int) ANJAY_ADVANCED_FW_UPDATE_RESULT_DEPENDENCY_ERROR)
typedef enum {
    ANJAY_ADVANCED_FW_UPDATE_SEVERITY_CRITICAL = 0,
    ANJAY_ADVANCED_FW_UPDATE_SEVERITY_MANDATORY,
    ANJAY_ADVANCED_FW_UPDATE_SEVERITY_OPTIONAL
} anjay_advanced_fw_update_severity_t;
 
typedef struct {
    bool prefer_same_socket_downloads;
#ifdef ANJAY_WITH_SEND
    bool use_lwm2m_send;
#endif // ANJAY_WITH_SEND
} anjay_advanced_fw_update_global_config_t;
 
typedef struct {
    anjay_advanced_fw_update_state_t state;
 
    anjay_advanced_fw_update_result_t result;
 
    anjay_advanced_fw_update_severity_t persisted_severity;
 
    avs_time_real_t persisted_last_state_change_time;
 
    avs_time_real_t persisted_update_deadline;
} anjay_advanced_fw_update_initial_state_t;
 
typedef int anjay_advanced_fw_update_stream_open_t(anjay_iid_t iid,
                                                   void *user_ptr);
typedef int anjay_advanced_fw_update_stream_write_t(anjay_iid_t iid,
                                                    void *user_ptr,
                                                    const void *data,
                                                    size_t length);
 
typedef int anjay_advanced_fw_update_stream_finish_t(anjay_iid_t iid,
                                                     void *user_ptr);
 
typedef void anjay_advanced_fw_update_reset_t(anjay_iid_t iid, void *user_ptr);
 
typedef const char *anjay_advanced_fw_update_get_pkg_name_t(anjay_iid_t iid,
                                                            void *user_ptr);
 
typedef const char *anjay_advanced_fw_update_get_pkg_version_t(anjay_iid_t iid,
                                                               void *user_ptr);
 
typedef const char *
anjay_advanced_fw_update_get_current_version_t(anjay_iid_t iid, void *user_ptr);
 
typedef int anjay_advanced_fw_update_perform_upgrade_t(
        anjay_iid_t iid,
        void *user_ptr,
        const anjay_iid_t *requested_supplemental_iids,
        size_t requested_supplemental_iids_count);
 
typedef int anjay_advanced_fw_update_get_security_config_t(
        anjay_iid_t iid,
        void *user_ptr,
        anjay_security_config_t *out_security_info,
        const char *download_uri);
 
typedef avs_coap_udp_tx_params_t anjay_advanced_fw_update_get_coap_tx_params_t(
        anjay_iid_t iid, void *user_ptr, const char *download_uri);
 
typedef avs_time_duration_t anjay_advanced_fw_update_get_tcp_request_timeout_t(
        anjay_iid_t iid, void *user_ptr, const char *download_uri);
 
typedef struct {
    anjay_advanced_fw_update_stream_open_t *stream_open;
    anjay_advanced_fw_update_stream_write_t *stream_write;
    anjay_advanced_fw_update_stream_finish_t *stream_finish;
 
    anjay_advanced_fw_update_reset_t *reset;
 
    anjay_advanced_fw_update_get_pkg_name_t *get_pkg_name;
    anjay_advanced_fw_update_get_pkg_version_t *get_pkg_version;
    anjay_advanced_fw_update_get_current_version_t *get_current_version;
 
    anjay_advanced_fw_update_perform_upgrade_t *perform_upgrade;
 
    anjay_advanced_fw_update_get_security_config_t *get_security_config;
 
    anjay_advanced_fw_update_get_coap_tx_params_t *get_coap_tx_params;
 
    anjay_advanced_fw_update_get_tcp_request_timeout_t *get_tcp_request_timeout;
} anjay_advanced_fw_update_handlers_t;
 
int anjay_advanced_fw_update_install(
        anjay_t *anjay, const anjay_advanced_fw_update_global_config_t *config);
 
int anjay_advanced_fw_update_instance_add(
        anjay_t *anjay,
        anjay_iid_t iid,
        const char *component_name,
        const anjay_advanced_fw_update_handlers_t *handlers,
        void *user_arg,
        const anjay_advanced_fw_update_initial_state_t *initial_state);
 
int anjay_advanced_fw_update_set_state_and_result(
        anjay_t *anjay,
        anjay_iid_t iid,
        anjay_advanced_fw_update_state_t state,
        anjay_advanced_fw_update_result_t result);
 
int anjay_advanced_fw_update_get_state(
        anjay_t *anjay,
        anjay_iid_t iid,
        anjay_advanced_fw_update_state_t *out_state);
 
int anjay_advanced_fw_update_get_result(
        anjay_t *anjay_locked,
        anjay_iid_t iid,
        anjay_advanced_fw_update_result_t *out_result);
 
int anjay_advanced_fw_update_set_linked_instances(
        anjay_t *anjay,
        anjay_iid_t iid,
        const anjay_iid_t *target_iids,
        size_t target_iids_count);
 
int anjay_advanced_fw_update_get_linked_instances(
        anjay_t *anjay,
        anjay_iid_t iid,
        const anjay_iid_t **out_target_iids,
        size_t *out_target_iids_count);
 
int anjay_advanced_fw_update_set_conflicting_instances(
        anjay_t *anjay,
        anjay_iid_t iid,
        const anjay_iid_t *target_iids,
        size_t target_iids_count);
 
int anjay_advanced_fw_update_get_conflicting_instances(
        anjay_t *anjay,
        anjay_iid_t iid,
        const anjay_iid_t **out_target_iids,
        size_t *out_target_iids_count);
 
avs_time_real_t anjay_advanced_fw_update_get_deadline(anjay_t *anjay,
                                                      anjay_iid_t iid);
 
anjay_advanced_fw_update_severity_t
anjay_advanced_fw_update_get_severity(anjay_t *anjay, anjay_iid_t iid);
 
avs_time_real_t
anjay_advanced_fw_update_get_last_state_change_time(anjay_t *anjay,
                                                    anjay_iid_t iid);
 
#ifdef ANJAY_WITH_DOWNLOADER
void anjay_advanced_fw_update_pull_suspend(anjay_t *anjay);
 
int anjay_advanced_fw_update_pull_reconnect(anjay_t *anjay);
#endif // ANJAY_WITH_DOWNLOADER
 
#ifdef __cplusplus
}
#endif
 
#endif /* ANJAY_INCLUDE_ANJAY_ADVANCED_FW_UPDATE_H */