lwm2m_client_utils.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef LWM2M_CLIENT_UTILS_H__
#define LWM2M_CLIENT_UTILS_H__
 
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/net/lwm2m.h>
#include <modem/lte_lc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(CONFIG_LWM2M_CLIENT_UTILS_SECURITY_OBJ_SUPPORT)
typedef int (*modem_mode_cb_t)(enum lte_lc_func_mode new_mode, void *user_data);
 
struct modem_mode_change {
        modem_mode_cb_t cb;
        void *user_data;
};
 
int lwm2m_init_security(struct lwm2m_ctx *ctx, char *endpoint, struct modem_mode_change *mmode);
 
int lwm2m_security_set_psk(uint16_t sec_obj_inst, const void *psk, int psk_len, bool psk_is_hex,
                           const char *psk_id);
 
int lwm2m_security_set_certificate(uint16_t sec_obj_inst, const void *cert, int cert_len,
                                   const void *private_key, int key_len, const void *ca_chain,
                                   int ca_len);
bool lwm2m_security_needs_bootstrap(void);
 
#endif
 
#if defined(CONFIG_LWM2M_CLIENT_UTILS_DEVICE_OBJ_SUPPORT)
int lwm2m_device_reboot_cb(uint16_t obj_inst_id, uint8_t *args, uint16_t args_len);
#endif
 
enum lwm2m_fota_event_id {
        LWM2M_FOTA_DOWNLOAD_START,
        LWM2M_FOTA_DOWNLOAD_FINISHED,
        LWM2M_FOTA_UPDATE_IMAGE_REQ,
        LWM2M_FOTA_UPDATE_MODEM_RECONNECT_REQ,
        LWM2M_FOTA_UPDATE_ERROR
};
 
struct lwm2m_fota_download_start {
        uint16_t obj_inst_id;
};
 
struct lwm2m_fota_download_finished {
        uint16_t obj_inst_id;
        int dfu_type;
};
 
struct lwm2m_fota_update_request {
        uint16_t obj_inst_id;
        int dfu_type;
};
 
struct lwm2m_fota_reconnect {
        uint16_t obj_inst_id;
};
 
struct lwm2m_fota_update_failure {
        uint16_t obj_inst_id;
        uint8_t update_failure;
};
 
struct lwm2m_fota_event {
        enum lwm2m_fota_event_id id;
        union {
                struct lwm2m_fota_download_start download_start;
                struct lwm2m_fota_download_finished download_ready;
                struct lwm2m_fota_update_request update_req;
                struct lwm2m_fota_reconnect reconnect_req;
                struct lwm2m_fota_update_failure failure;
        };
};
 
typedef int (*lwm2m_firmware_event_cb_t)(struct lwm2m_fota_event *event);
 
void *firmware_read_cb(uint16_t obj_inst_id, size_t *data_len);
 
int lwm2m_init_firmware_cb(lwm2m_firmware_event_cb_t cb);
 
int lwm2m_init_image(void);
 
#define LWM2M_OBJECT_CELLULAR_CONNECTIVITY_ID 10
 
enum lwm2m_rai_mode {
        LWM2M_RAI_MODE_DISABLED = 0,
        LWM2M_RAI_MODE_ENABLED  = 1
};
 
int lwm2m_rai_req(enum lwm2m_rai_mode mode);
 
int lwm2m_utils_enable_conneval(enum lte_lc_energy_estimate min_energy_estimate,
                                uint64_t maximum_delay_s, uint64_t poll_period_ms);
 
void lwm2m_utils_disable_conneval(void);
 
int lwm2m_utils_conneval(struct lwm2m_ctx *client, enum lwm2m_rd_client_event *client_event);
 
void lwm2m_utils_connection_manage(struct lwm2m_ctx *client,
                                      enum lwm2m_rd_client_event *client_event);
 
void lwm2m_utils_rai_event_cb(struct lwm2m_ctx *client,
                                      enum lwm2m_rd_client_event *client_event);
 
/* Advanced firmare object support */
uint8_t lwm2m_adv_firmware_get_update_state(uint16_t obj_inst_id);
void lwm2m_adv_firmware_set_update_state(uint16_t obj_inst_id, uint8_t state);
uint8_t lwm2m_adv_firmware_get_update_result(uint16_t obj_inst_id);
void lwm2m_adv_firmware_set_update_result(uint16_t obj_inst_id, uint8_t result);
void lwm2m_adv_firmware_set_write_cb(uint16_t obj_inst_id, lwm2m_engine_set_data_cb_t cb);
lwm2m_engine_set_data_cb_t lwm2m_adv_firmware_get_write_cb(uint16_t obj_inst_id);
void lwm2m_adv_firmware_set_update_cb(uint16_t obj_inst_id, lwm2m_engine_execute_cb_t cb);
lwm2m_engine_execute_cb_t lwm2m_adv_firmware_get_update_cb(uint16_t obj_inst_id);
int lwm2m_adv_firmware_create_inst(const char *component,
                                   lwm2m_engine_set_data_cb_t write_callback,
                                   lwm2m_engine_execute_cb_t update_callback);
 
#define LWM2M_OBJECT_ADV_FIRMWARE_ID 33629
#define RESULT_ADV_FOTA_CANCELLED 10
#define RESULT_ADV_FOTA_DEFERRED 11
#define RESULT_ADV_CONFLICT_STATE 12
#define RESULT_ADV_DEPENDENCY_ERR 13
 
/* Reboot execute possible argument's */
#define REBOOT_SOURCE_DEVICE_OBJ 0
#define REBOOT_SOURCE_FOTA_OBJ 1
 
/* Firmware resource IDs */
#define LWM2M_FOTA_PACKAGE_ID 0
#define LWM2M_FOTA_PACKAGE_URI_ID 1
#define LWM2M_FOTA_UPDATE_ID 2
#define LWM2M_FOTA_STATE_ID 3
#define LWM2M_FOTA_UPDATE_RESULT_ID 5
#define LWM2M_FOTA_PACKAGE_NAME_ID 6
#define LWM2M_FOTA_PACKAGE_VERSION_ID 7
#define LWM2M_FOTA_UPDATE_PROTO_SUPPORT_ID 8
#define LWM2M_FOTA_UPDATE_DELIV_METHOD_ID 9
/* LwM2M v1.2 extension which are common for advanced fota */
#define LWM2M_FOTA_CANCEL_ID 10
#define LWM2M_FOTA_SEVERITY_ID 11
#define LWM2M_FOTA_LAST_STATE_CHANGE_TIME_ID 12
#define LWM2M_FOTA_MAXIMUM_DEFERRED_PERIOD_ID 13
/* Unique resources for advanced fota */
#define LWM2M_ADV_FOTA_COMPONENT_NAME_ID 14
#define LWM2M_ADV_FOTA_CURRENT_VERSION_ID 15
#define LWM2M_ADV_FOTA_LINKED_INSTANCES_ID 16
#define LWM2M_ADV_FOTA_CONFLICTING_INSTANCES_ID 17
 
/********** DEPRECATED FUNCTIONS *************/
__deprecated static inline int lwm2m_init_firmware(void) {return lwm2m_init_firmware_cb(NULL); }
__deprecated static inline int lwm2m_init_device(void) {return 0; }
__deprecated static inline int lwm2m_init_cellular_connectivity_object(void) {return 0; }
__deprecated static inline int lwm2m_init_connmon(void) {return 0; }
__deprecated static inline int lwm2m_init_location(void) {return 0; }
 
#ifdef __cplusplus
}
#endif
 
#endif /* LWM2M_CLIENT_UTILS_H__ */