net: lwm2m: Register callback for firmware update cancel

Allow to register a callback function which is called when a firmware
update is canceled by the cancel command.

Signed-off-by: Marc Lasch <[email protected]>

Author: mlasch

include/zephyr/net/lwm2m.h

@@ -446,6 +446,42 @@ void lwm2m_firmware_set_write_cb_inst(uint16_t obj_inst_id, lwm2m_engine_set_dat
  */
 lwm2m_engine_set_data_cb_t lwm2m_firmware_get_write_cb_inst(uint16_t obj_inst_id);
 
+/**
+ * @brief Set callback for firmware update cancel.
+ *
+ * LwM2M clients use this function to register a callback to perform actions
+ * on firmware update cancel.
+ *
+ * @param[in] cb A callback function perform actions on firmware update cancel.
+ */
+void lwm2m_firmware_set_cancel_cb(lwm2m_engine_user_cb_t cb);
+
+/**
+ * @brief Get a callback for firmware update cancel.
+ *
+ * @return A registered callback function perform actions on firmware update cancel.
+ */
+lwm2m_engine_user_cb_t lwm2m_firmware_get_cancel_cb(void);
+
+/**
+ * @brief Set data callback for firmware update cancel.
+ *
+ * LwM2M clients use this function to register a callback to perform actions
+ * on firmware update cancel.
+ *
+ * @param[in] obj_inst_id Object instance ID
+ * @param[in] cb A callback function perform actions on firmware update cancel.
+ */
+void lwm2m_firmware_set_cancel_cb_inst(uint16_t obj_inst_id, lwm2m_engine_user_cb_t cb);
+
+/**
+ * @brief Get the callback for firmware update cancel.
+ *
+ * @param[in] obj_inst_id Object instance ID
+ * @return A registered callback function perform actions on firmware update cancel.
+ */
+lwm2m_engine_user_cb_t lwm2m_firmware_get_cancel_cb_inst(uint16_t obj_inst_id);
+
 #if defined(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_SUPPORT)
 /**
  * @brief Set data callback to handle firmware update execute events.

samples/net/lwm2m_client/src/firmware_update.c

@@ -48,12 +48,21 @@ static int firmware_block_received_cb(uint16_t obj_inst_id,
 	return 0;
 }
 
+static int firmware_cancel_cb(const uint16_t obj_inst_id)
+{
+	LOG_INF("FIRMWARE: Update canceled");
+	return 0;
+}
+
 void init_firmware_update(void)
 {
 	/* setup data buffer for block-wise transfer */
 	lwm2m_register_pre_write_callback(&LWM2M_OBJ(5, 0, 0), firmware_get_buf);
 	lwm2m_firmware_set_write_cb(firmware_block_received_cb);
 
+	/* register cancel callback */
+	lwm2m_firmware_set_cancel_cb(firmware_cancel_cb);
+
 	if (IS_ENABLED(CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_SUPPORT)) {
 		lwm2m_create_res_inst(&LWM2M_OBJ(5, 0, 8, 0));
 		lwm2m_set_res_buf(&LWM2M_OBJ(5, 0, 8, 0), &supported_protocol[0],

subsys/net/lib/lwm2m/lwm2m_obj_firmware.c

@@ -79,6 +79,7 @@ static struct lwm2m_engine_res_inst res_inst[MAX_INSTANCE_COUNT][RESOURCE_INSTAN
 
 static lwm2m_engine_set_data_cb_t write_cb[MAX_INSTANCE_COUNT];
 static lwm2m_engine_execute_cb_t update_cb[MAX_INSTANCE_COUNT];
+static lwm2m_engine_user_cb_t cancel_cb[MAX_INSTANCE_COUNT];
 
 #ifdef CONFIG_LWM2M_FIRMWARE_UPDATE_PULL_SUPPORT
 extern int lwm2m_firmware_start_transfer(uint16_t obj_inst_id, char *package_uri);
@@ -234,7 +235,8 @@ static int package_write_cb(uint16_t obj_inst_id, uint16_t res_id,
 {
 	uint8_t state;
 	int ret = 0;
-	lwm2m_engine_set_data_cb_t callback;
+	lwm2m_engine_set_data_cb_t write_callback;
+	lwm2m_engine_user_cb_t cancel_callback;
 
 	state = lwm2m_firmware_get_update_state_inst(obj_inst_id);
 	if (state == STATE_IDLE) {
@@ -246,6 +248,10 @@ static int package_write_cb(uint16_t obj_inst_id, uint16_t res_id,
 		if (data_len == 0U || (data_len == 1U && data[0] == '\0')) {
 			/* reset to state idle and result default */
 			lwm2m_firmware_set_update_result_inst(obj_inst_id, RESULT_DEFAULT);
+			cancel_callback = lwm2m_firmware_get_cancel_cb_inst(obj_inst_id);
+			if (cancel_callback) {
+				ret = cancel_callback(obj_inst_id);
+			}
 			LOG_DBG("Update canceled by writing %d bytes", data_len);
 			return 0;
 		}
@@ -256,10 +262,10 @@ static int package_write_cb(uint16_t obj_inst_id, uint16_t res_id,
 		return -EPERM;
 	}
 
-	callback = lwm2m_firmware_get_write_cb_inst(obj_inst_id);
-	if (callback) {
-		ret = callback(obj_inst_id, res_id, res_inst_id,
-			       data, data_len, last_block, total_size);
+	write_callback = lwm2m_firmware_get_write_cb_inst(obj_inst_id);
+	if (write_callback) {
+		ret = write_callback(obj_inst_id, res_id, res_inst_id, data, data_len, last_block,
+				     total_size);
 	}
 
 	if (ret >= 0) {
@@ -331,6 +337,16 @@ lwm2m_engine_execute_cb_t lwm2m_firmware_get_update_cb(void)
 	return lwm2m_firmware_get_update_cb_inst(0);
 }
 
+void lwm2m_firmware_set_cancel_cb(lwm2m_engine_user_cb_t cb)
+{
+	lwm2m_firmware_set_cancel_cb_inst(0, cb);
+}
+
+lwm2m_engine_user_cb_t lwm2m_firmware_get_cancel_cb(void)
+{
+	return lwm2m_firmware_get_cancel_cb_inst(0);
+}
+
 void lwm2m_firmware_set_write_cb_inst(uint16_t obj_inst_id, lwm2m_engine_set_data_cb_t cb)
 {
 	write_cb[obj_inst_id] = cb;
@@ -351,6 +367,16 @@ lwm2m_engine_execute_cb_t lwm2m_firmware_get_update_cb_inst(uint16_t obj_inst_id
 	return update_cb[obj_inst_id];
 }
 
+void lwm2m_firmware_set_cancel_cb_inst(uint16_t obj_inst_id, lwm2m_engine_user_cb_t cb)
+{
+	cancel_cb[obj_inst_id] = cb;
+}
+
+lwm2m_engine_user_cb_t lwm2m_firmware_get_cancel_cb_inst(uint16_t obj_inst_id)
+{
+	return cancel_cb[obj_inst_id];
+}
+
 static int firmware_update_cb(uint16_t obj_inst_id,
 			      uint8_t *args, uint16_t args_len)
 {