fix(zigbee): Fix errors and warnings, swap parameters order

Author: P-R-O-C-H-Y

libraries/Zigbee/src/ZigbeeEP.cpp

@@ -376,8 +376,7 @@ void ZigbeeEP::zbReadTimeCluster(const esp_zb_zcl_attribute_t *attribute) {
 //     uint8_t max_data_size; /*!< The maximum size of OTA data */
 // } esp_zb_zcl_ota_upgrade_client_variable_t;
 
-void ZigbeeEP::addOTAClient(uint32_t file_version, uint16_t manufacturer, uint16_t image_type, uint32_t downloaded_file_ver, 
-  uint16_t hw_version, uint8_t max_data_size) {
+void ZigbeeEP::addOTAClient(uint32_t file_version, uint32_t downloaded_file_ver, uint16_t hw_version, uint16_t manufacturer, uint16_t image_type, uint8_t max_data_size) {
 
   esp_zb_ota_cluster_cfg_t ota_cluster_cfg = {};
   ota_cluster_cfg.ota_upgrade_file_version = file_version;//OTA_UPGRADE_RUNNING_FILE_VERSION;

libraries/Zigbee/src/ZigbeeEP.h

@@ -9,7 +9,7 @@
 
 /* Useful defines */
 #define ZB_CMD_TIMEOUT 10000  // 10 seconds
-#define OTA_UPGRADE_QUERY_INTERVAL (1 * 60) // 1 minutes
+#define OTA_UPGRADE_QUERY_INTERVAL (1 * 60) // 1 hour = 60 minutes
 
 #define ZB_ARRAY_LENTH(arr) (sizeof(arr) / sizeof(arr[0]))
 #define XYZ_TO_RGB(X, Y, Z, r, g, b)                                \
@@ -108,8 +108,7 @@ class ZigbeeEP {
     return _allow_multiple_binding;
   }
 
-  void addOTAClient(uint32_t file_version = 0x01010100, uint16_t manufacturer = 0x1001, uint16_t image_type = 0x1011, 
-    uint32_t downloaded_file_ver = 0x01010101, uint16_t hw_version = 0x0101, uint8_t max_data_size = 223);
+  void addOTAClient(uint32_t file_version, uint32_t downloaded_file_ver, uint16_t hw_version, uint16_t manufacturer, uint16_t image_type, uint8_t max_data_size = 223);
   void requestOTAUpdate();
 
   // findEndpoind may be implemented by EPs to find and bind devices

libraries/Zigbee/src/ZigbeeHandlers.cpp

@@ -5,6 +5,24 @@
 #if SOC_IEEE802154_SUPPORTED && CONFIG_ZB_ENABLED
 
 #include "esp_ota_ops.h"
+#if CONFIG_ZB_DELTA_OTA // Delta OTA, code is prepared for this feature but not enabled by default
+#include "esp_delta_ota_ops.h"
+#endif
+
+//OTA Upgrade defines and variables
+#define OTA_ELEMENT_HEADER_LEN              6       /* OTA element format header size include tag identifier and length field */
+
+/**
+ * @name Enumeration for the tag identifier denotes the type and format of the data within the element
+ * @anchor esp_ota_element_tag_id_t
+ */
+typedef enum esp_ota_element_tag_id_e {
+    UPGRADE_IMAGE                               = 0x0000,           /*!< Upgrade image */
+} esp_ota_element_tag_id_t;
+
+static const esp_partition_t *s_ota_partition = NULL;
+static esp_ota_handle_t s_ota_handle = 0;
+static bool s_tagid_received = false;
 
 // forward declaration of all implemented handlers
 static esp_err_t zb_attribute_set_handler(const esp_zb_zcl_set_attr_value_message_t *message);
@@ -219,21 +237,6 @@ static esp_err_t zb_window_covering_movement_resp_handler(const esp_zb_zcl_windo
   return ESP_OK;
 }
 
-//OTA Upgrade
-#define OTA_ELEMENT_HEADER_LEN              6       /* OTA element format header size include tag identifier and length field */
-
-/**
- * @name Enumeration for the tag identifier denotes the type and format of the data within the element
- * @anchor esp_ota_element_tag_id_t
- */
-typedef enum esp_ota_element_tag_id_e {
-    UPGRADE_IMAGE                               = 0x0000,           /*!< Upgrade image */
-} esp_ota_element_tag_id_t;
-
-static const esp_partition_t *s_ota_partition = NULL;
-static esp_ota_handle_t s_ota_handle = 0;
-static bool s_tagid_received = false;
-
 static esp_err_t esp_element_ota_data(uint32_t total_size, const void *payload, uint16_t payload_size, void **outbuf, uint16_t *outlen)
 {
   static uint16_t tagid = 0;
@@ -247,16 +250,17 @@ static esp_err_t esp_element_ota_data(uint32_t total_size, const void *payload,
         return ESP_ERR_INVALID_ARG;
     }
 
-    tagid  = *(const uint16_t *)payload;
-    length = *(const uint32_t *)(payload + sizeof(tagid));
+    const uint8_t *payload_ptr = (const uint8_t *)payload;
+    tagid  = *(const uint16_t *)payload_ptr;
+    length = *(const uint32_t *)(payload_ptr + sizeof(tagid));
     if ((length + OTA_ELEMENT_HEADER_LEN) != total_size) {
       log_e("Invalid element length [%ld/%ld]", length, total_size);
       return ESP_ERR_INVALID_ARG;
     }
 
     s_tagid_received = true;
 
-    data_buf = (void *)(payload + OTA_ELEMENT_HEADER_LEN);
+    data_buf = (void *)(payload_ptr + OTA_ELEMENT_HEADER_LEN);
     data_len = payload_size - OTA_ELEMENT_HEADER_LEN;
   } else {
     data_buf = (void *)payload;
@@ -279,98 +283,97 @@ static esp_err_t esp_element_ota_data(uint32_t total_size, const void *payload,
 
 static esp_err_t zb_ota_upgrade_status_handler(const esp_zb_zcl_ota_upgrade_value_message_t *message)
 {
-    static uint32_t total_size = 0;
-    static uint32_t offset = 0;
-    static int64_t start_time = 0;
-    esp_err_t ret = ESP_OK;
-
-    if (message->info.status == ESP_ZB_ZCL_STATUS_SUCCESS) {
-        switch (message->upgrade_status) {
-        case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_START:
-            log_i("Zigbee - OTA upgrade start");
-            start_time = esp_timer_get_time();
-            s_ota_partition = esp_ota_get_next_update_partition(NULL);
-            assert(s_ota_partition);
+  static uint32_t total_size = 0;
+  static uint32_t offset = 0;
+  [[maybe_unused]]
+  static int64_t start_time = 0;
+  esp_err_t ret = ESP_OK;
+
+  if (message->info.status == ESP_ZB_ZCL_STATUS_SUCCESS) {
+    switch (message->upgrade_status) {
+    case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_START:
+      log_i("Zigbee - OTA upgrade start");
+      start_time = esp_timer_get_time();
+      s_ota_partition = esp_ota_get_next_update_partition(NULL);
+      assert(s_ota_partition);
 #if CONFIG_ZB_DELTA_OTA
-            ret = esp_delta_ota_begin(s_ota_partition, 0, &s_ota_handle);
+      ret = esp_delta_ota_begin(s_ota_partition, 0, &s_ota_handle);
 #else
-            ret = esp_ota_begin(s_ota_partition, 0, &s_ota_handle);
+      ret = esp_ota_begin(s_ota_partition, 0, &s_ota_handle);
 #endif
-            if(ret != ESP_OK) {
-              log_e("Zigbee - Failed to begin OTA partition, status: %s", esp_err_to_name(ret));
-              return ret;
-            }
-            break;
-        case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_RECEIVE:
-            total_size = message->ota_header.image_size;
-            offset += message->payload_size;
-            log_i("Zigbee - OTA Client receives data: progress [%ld/%ld]", offset, total_size);
-            if (message->payload_size && message->payload) {
-                uint16_t payload_size = 0;
-                void    *payload = NULL;
-                ret = esp_element_ota_data(total_size, message->payload, message->payload_size, &payload, &payload_size);
-                if(ret != ESP_OK) {
-                  log_e("Zigbee - Failed to element OTA data, status: %s", esp_err_to_name(ret));
-                  return ret;
-                }
+      if(ret != ESP_OK) {
+        log_e("Zigbee - Failed to begin OTA partition, status: %s", esp_err_to_name(ret));
+        return ret;
+      }
+      break;
+    case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_RECEIVE:
+      total_size = message->ota_header.image_size;
+      offset += message->payload_size;
+      log_i("Zigbee - OTA Client receives data: progress [%ld/%ld]", offset, total_size);
+      if (message->payload_size && message->payload) {
+        uint16_t payload_size = 0;
+        void    *payload = NULL;
+        ret = esp_element_ota_data(total_size, message->payload, message->payload_size, &payload, &payload_size);
+        if(ret != ESP_OK) {
+          log_e("Zigbee - Failed to element OTA data, status: %s", esp_err_to_name(ret));
+          return ret;
+        }
 #if CONFIG_ZB_DELTA_OTA
-                ret = esp_delta_ota_write(s_ota_handle, payload, payload_size);
+        ret = esp_delta_ota_write(s_ota_handle, payload, payload_size);
 #else
-                ret = esp_ota_write(s_ota_handle, (const void *)payload, payload_size);
+        ret = esp_ota_write(s_ota_handle, (const void *)payload, payload_size);
 #endif
-                if(ret != ESP_OK) {
-                  log_e("Zigbee - Failed to write OTA data to partition, status: %s", esp_err_to_name(ret));
-                  return ret;
-                }
-            }
-            break;
-        case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_APPLY:
-            log_i("Zigbee - OTA upgrade apply");
-            break;
-        case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_CHECK:
-            ret = offset == total_size ? ESP_OK : ESP_FAIL;
-            offset = 0;
-            total_size = 0;
-            s_tagid_received = false;
-            log_i("Zigbee - OTA upgrade check status: %s", esp_err_to_name(ret));
-            break;
-        case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_FINISH:
-            log_i("Zigbee - OTA Finish");
-            log_i("Zigbee - OTA Information: version: 0x%lx, manufacturer code: 0x%x, image type: 0x%x, total size: %ld bytes, cost time: %lld ms,",
-                     message->ota_header.file_version, message->ota_header.manufacturer_code, message->ota_header.image_type,
-                     message->ota_header.image_size, (esp_timer_get_time() - start_time) / 1000);
+        if(ret != ESP_OK) {
+          log_e("Zigbee - Failed to write OTA data to partition, status: %s", esp_err_to_name(ret));
+          return ret;
+        }
+      }
+      break;
+    case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_APPLY:
+      log_i("Zigbee - OTA upgrade apply");
+      break;
+    case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_CHECK:
+      ret = offset == total_size ? ESP_OK : ESP_FAIL;
+      offset = 0;
+      total_size = 0;
+      s_tagid_received = false;
+      log_i("Zigbee - OTA upgrade check status: %s", esp_err_to_name(ret));
+      break;
+    case ESP_ZB_ZCL_OTA_UPGRADE_STATUS_FINISH:
+      log_i("Zigbee - OTA Finish");
+      log_i("Zigbee - OTA Information: version: 0x%lx, manufacturer code: 0x%x, image type: 0x%x, total size: %ld bytes, cost time: %lld ms,",
+                message->ota_header.file_version, message->ota_header.manufacturer_code, message->ota_header.image_type,
+                message->ota_header.image_size, (esp_timer_get_time() - start_time) / 1000);
 #if CONFIG_ZB_DELTA_OTA
-            ret = esp_delta_ota_end(s_ota_handle);
+      ret = esp_delta_ota_end(s_ota_handle);
 #else
-            ret = esp_ota_end(s_ota_handle);
+      ret = esp_ota_end(s_ota_handle);
 #endif
-            if(ret != ESP_OK) {
-              log_e("Zigbee - Failed to end OTA partition, status: %s", esp_err_to_name(ret));
-              return ret;
-            }
-            ret = esp_ota_set_boot_partition(s_ota_partition);
-            if(ret != ESP_OK) {
-              log_e("Zigbee - Failed to set OTA boot partition, status: %s", esp_err_to_name(ret));
-              return ret;
-            }
-            log_w("Zigbee - Prepare to restart system");
-            esp_restart();
-            break;
-        default:
-            log_i("Zigbee - OTA status: %d", message->upgrade_status);
-            break;
-        }
+      if(ret != ESP_OK) {
+        log_e("Zigbee - Failed to end OTA partition, status: %s", esp_err_to_name(ret));
+        return ret;
+      }
+      ret = esp_ota_set_boot_partition(s_ota_partition);
+      if(ret != ESP_OK) {
+        log_e("Zigbee - Failed to set OTA boot partition, status: %s", esp_err_to_name(ret));
+        return ret;
+      }
+      log_w("Zigbee - Prepare to restart system");
+      esp_restart();
+      break;
+    default:
+      log_i("Zigbee - OTA status: %d", message->upgrade_status);
+      break;
     }
-    return ret;
+  }
+  return ret;
 }
 
 static esp_err_t zb_ota_upgrade_query_image_resp_handler(const esp_zb_zcl_ota_upgrade_query_image_resp_message_t *message)
 {
   if (message->info.status == ESP_ZB_ZCL_STATUS_SUCCESS) {
     log_i("Zigbee - Queried OTA image from address: 0x%04hx, endpoint: %d", message->server_addr.u.short_addr, message->server_endpoint);
-    log_i("Zigbee - Image version: 0x%lx, manufacturer code: 0x%x, image size: %ld", message->file_version, message->manufacturer_code,
-              message->image_size);
-    //TODO: add more contidions to reject OTA image upgrade
+    log_i("Zigbee - Image version: 0x%lx, manufacturer code: 0x%x, image size: %ld", message->file_version, message->manufacturer_code, message->image_size);
     if(message->image_size == 0) {
       log_i("Zigbee - Rejecting OTA image upgrade, image size is 0");
       return ESP_FAIL;