fw_update.h

Go to the documentation of this file.

/*
 * Copyright 2023-2025 AVSystem <avsystem@avsystem.com>
 * AVSystem Anjay Lite LwM2M SDK
 * All rights reserved.
 *
 * Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
 * See the attached LICENSE file for details.
 */
 
#include <anj/init.h>
 
#ifndef ANJ_DM_FW_UPDATE_H
#    define ANJ_DM_FW_UPDATE_H
 
#    include <stddef.h>
#    include <stdint.h>
 
#    include <anj/core.h>
#    include <anj/dm/core.h>
 
#    ifdef __cplusplus
extern "C" {
#    endif
 
#    ifdef ANJ_WITH_DEFAULT_FOTA_OBJ
 
#        define ANJ_DM_FW_UPDATE_URI_MAX_LEN 255
 
/*
 * Numeric values of the Firmware Update Protocol Support resource. See LwM2M
 * specification for details.
 */
typedef enum {
    ANJ_DM_FW_UPDATE_STATE_IDLE = 0,
    ANJ_DM_FW_UPDATE_STATE_DOWNLOADING,
    ANJ_DM_FW_UPDATE_STATE_DOWNLOADED,
    ANJ_DM_FW_UPDATE_STATE_UPDATING
} anj_dm_fw_update_state_t;
 
typedef enum {
    ANJ_DM_FW_UPDATE_RESULT_INITIAL = 0,
    ANJ_DM_FW_UPDATE_RESULT_SUCCESS = 1,
    ANJ_DM_FW_UPDATE_RESULT_NOT_ENOUGH_SPACE = 2,
    ANJ_DM_FW_UPDATE_RESULT_OUT_OF_MEMORY = 3,
    ANJ_DM_FW_UPDATE_RESULT_CONNECTION_LOST = 4,
    ANJ_DM_FW_UPDATE_RESULT_INTEGRITY_FAILURE = 5,
    ANJ_DM_FW_UPDATE_RESULT_UNSUPPORTED_PACKAGE_TYPE = 6,
    ANJ_DM_FW_UPDATE_RESULT_INVALID_URI = 7,
    ANJ_DM_FW_UPDATE_RESULT_FAILED = 8,
    ANJ_DM_FW_UPDATE_RESULT_UNSUPPORTED_PROTOCOL = 9,
} anj_dm_fw_update_result_t;
 
typedef anj_dm_fw_update_result_t
anj_dm_fw_update_package_write_start_t(void *user_ptr);
 
typedef anj_dm_fw_update_result_t anj_dm_fw_update_package_write_t(
        void *user_ptr, const void *data, size_t data_size);
 
typedef anj_dm_fw_update_result_t
anj_dm_fw_update_package_write_finish_t(void *user_ptr);
 
typedef anj_dm_fw_update_result_t anj_dm_fw_update_uri_write_t(void *user_ptr,
                                                               const char *uri);
 
typedef int anj_dm_fw_update_update_start_t(void *user_ptr);
 
typedef const char *anj_dm_fw_update_get_name_t(void *user_ptr);
 
typedef const char *anj_dm_fw_update_get_version_t(void *user_ptr);
 
typedef void anj_dm_fw_update_reset_t(void *user_ptr);
 
typedef struct {
    anj_dm_fw_update_package_write_start_t *package_write_start_handler;
 
    anj_dm_fw_update_package_write_t *package_write_handler;
 
    anj_dm_fw_update_package_write_finish_t *package_write_finish_handler;
 
    anj_dm_fw_update_uri_write_t *uri_write_handler;
 
    anj_dm_fw_update_update_start_t *update_start_handler;
 
    anj_dm_fw_update_get_name_t *get_name;
 
    anj_dm_fw_update_get_version_t *get_version;
 
    anj_dm_fw_update_reset_t *reset_handler;
} anj_dm_fw_update_handlers_t;
 
/*
 * Representation of a FW Update Object that holds values of its resources and
 * its internal state.
 */
typedef struct {
    /* /5/0/3 State Resouce value holder */
    int8_t state;
    /* /5/0/5 Result Resource value holder */
    int8_t result;
    /* Set of user provided callback handlers */
    anj_dm_fw_update_handlers_t *user_handlers;
    /* Opaque user pointer passed back with each call of @ref user_handlers
     * callbacks. Can be used to e.g. determine the the context or distiguish FW
     * Update Object entities in a multiple LwM2M Clients system */
    void *user_ptr;
#        if defined(ANJ_FOTA_WITH_PULL_METHOD)
    /* /5/0/1 Package URI Resource value holder */
    char uri[ANJ_DM_FW_UPDATE_URI_MAX_LEN + 1];
#        endif // defined (ANJ_FOTA_WITH_PULL_METHOD)
#        if defined(ANJ_FOTA_WITH_PUSH_METHOD)
    bool write_start_called;
#        endif // defined (ANJ_FOTA_WITH_PUSH_METHOD)
} anj_dm_fw_update_repr_t;
 
/*
 * Complex structure of a whole FW Update Object entity context that holds the
 * object and its instance that are linked to Static Data Model as well as the
 * object representation.
 *
 * User is expected to instantiate a structure of this type, initialize
 * only the @ref repr field and not modify it directly throughout the LwM2M
 * Client life.
 */
typedef struct {
    anj_dm_obj_t obj;
    anj_dm_obj_inst_t inst;
    anj_dm_fw_update_repr_t repr;
} anj_dm_fw_update_entity_ctx_t;
 
int anj_dm_fw_update_object_install(anj_t *anj,
                                    anj_dm_fw_update_entity_ctx_t *entity_ctx,
                                    anj_dm_fw_update_handlers_t *handlers,
                                    void *user_ptr);
 
void anj_dm_fw_update_object_set_update_result(
        anj_t *anj,
        anj_dm_fw_update_entity_ctx_t *entity_ctx,
        anj_dm_fw_update_result_t result);
 
int anj_dm_fw_update_object_set_download_result(
        anj_t *anj,
        anj_dm_fw_update_entity_ctx_t *entity_ctx,
        anj_dm_fw_update_result_t result);
 
#    endif // ANJ_WITH_DEFAULT_FOTA_OBJ
 
#    ifdef __cplusplus
}
#    endif
 
#endif // ANJ_DM_FW_UPDATE_H