Merge branch 'fix/ble_delta_ota' into 'master'

Astha-cpu · Astha-cpu · commit 56c551b66dd2 · 2024-11-21T15:00:41.000+08:00
Added support for Delta OTA

Closes BLERP-1166

See merge request ae_group/esp-iot-solution!1104
diff --git a/components/bluetooth/ble_profiles/esp/ble_ota/CHANGELOG.md b/components/bluetooth/ble_profiles/esp/ble_ota/CHANGELOG.md
@@ -67,4 +67,9 @@
 ## v0.1.12 - 2024-02-19
 
 * BLE-OTA:
-  * Add support for ESP32C2 and ESP32C6.
+  * Add support for ESP32C2 and ESP32C6.
+
+## v0.1.13 - 2024-10-21
+
+* BLE-OTA:
+  * Add support for Delta OTA.
diff --git a/components/bluetooth/ble_profiles/esp/ble_ota/idf_component.yml b/components/bluetooth/ble_profiles/esp/ble_ota/idf_component.yml
@@ -1,4 +1,4 @@
-version: "0.1.12"
+version: "0.1.13"
 targets:
   - esp32
   - esp32c3
diff --git a/components/bluetooth/ble_profiles/esp/ble_ota/src/ble_ota.c b/components/bluetooth/ble_profiles/esp/ble_ota/src/ble_ota.c
@@ -7,6 +7,7 @@
 #include <string.h>
 #include "freertos/FreeRTOS.h"
 #include "esp_idf_version.h"
+#include "freertos/semphr.h"
 
 #include "esp_log.h"
 #include "ble_ota.h"
@@ -700,8 +701,14 @@ void esp_ble_ota_process_recv_data(esp_ble_ota_char_t ota_char, uint8_t *val, ui
         // Stop BLE OTA Process
         else if ((val[0] == 0x02) && (val[1] == 0x00)) {
             if (start_ota) {
+                extern SemaphoreHandle_t notify_sem;
+                xSemaphoreTake(notify_sem, portMAX_DELAY);
+
                 start_ota = false;
                 esp_ble_ota_set_fw_length(0);
+
+                xSemaphoreGive(notify_sem);
+
                 ESP_LOGI(TAG, "recv ota stop cmd");
                 esp_ble_ota_send_ack_data(BLE_OTA_CMD_ACK, BLE_OTA_CMD_SUCCESS, BLE_OTA_STOP_CMD);
 
diff --git a/components/bluetooth/ble_profiles/esp/ble_ota/src/nimble_ota.c b/components/bluetooth/ble_profiles/esp/ble_ota/src/nimble_ota.c
@@ -16,6 +16,7 @@
 #include "services/gatt/ble_svc_gatt.h"
 #include "host/ble_uuid.h"
 #include "ble_ota.h"
+#include "freertos/semphr.h"
 #if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
 #include "esp_nimble_hci.h"
 #endif
@@ -375,8 +376,14 @@ ble_ota_start_write_chr(struct os_mbuf *om)
             ESP_LOGI(TAG, "Decryption end failed");
         }
 #endif
+        extern SemaphoreHandle_t notify_sem;
+        xSemaphoreTake(notify_sem, portMAX_DELAY);
+
         start_ota = false;
         ota_total_len = 0;
+
+        xSemaphoreGive(notify_sem);
+
         ESP_LOGD(TAG, "recv ota stop cmd");
         cmd_ack[2] = 0x02;
         cmd_ack[3] = 0x00;
diff --git a/examples/bluetooth/ble_ota/README.md b/examples/bluetooth/ble_ota/README.md
@@ -64,7 +64,7 @@ ACK_Status:
 
 ### 4.1 OTA update ESP32-H2
 
-To construct the BLE OTA demo for the ESP32-H2 device, ensure you're using ESP-IDF version 5.0 or later. Currently, the ESP32-H2 doesn't support NimBLE OTA updates, so omit the instructions in section 5. Maintain the default configuration for the Bluetooth framework, where `Bluedroid - Dual-mode` is selected. To ensure compatibility with the sample app mentioned in section 3, deactivate BLE 5.0 features by navigating to:
+To construct the BLE OTA demo for the ESP32-H2 device, ensure you're using ESP-IDF version 5.0 or later. If `Bluedroid - Dual-mode` is selected, to ensure compatibility with the sample app mentioned in section 3, deactivate BLE 5.0 features by navigating to:
 
 1. `Component config` > `Bluetooth` > `Bluedroid Options` and deselect `Enable BLE 5.0 features`.
 2. `Component config` > `Bluetooth` > `Controller Options` and deselect `Enable BLE 5 feature`.
@@ -77,9 +77,11 @@ To construct the BLE OTA demo for the ESP32-H2 device, ensure you're using ESP-I
 
 - Component config → Bluetooth → Bluetooth → Host → NimBLE - BLE only
 
-Note: For maximum throughput, set maximum MTU using
+- Note: For maximum throughput, set maximum MTU using
 
-- Component config → Bluetooth → NimBLE Options → Preferred MTU size in octets as 517
+  - Component config → Bluetooth → NimBLE Options → Preferred MTU size in octets as 517
+
+Ensure the image that is being transferred over BLE, should have the same FLASHSIZE ( 4MB ) as the one that is set by the ble_ota example. i.e. ensure **ESPTOOLPY_FLASHSIZE_4MB** is set.
 
 ### 5.1 OTA with Protocomm
 
@@ -99,6 +101,54 @@ Note: For maximum throughput, set maximum MTU using
 
 `idf.py menuconfig`
 
-- If using ESP32S3 set Component config → Bluetooth → Bluetooth → NimBLE Options → NimBLE Host task stack size as 8192 
+- If using ESP32S3 set Component config → Bluetooth → Bluetooth → NimBLE Options → NimBLE Host task stack size as 8192
 - Example Configuration → Type of OTA → Use Pre-Encrypted OTA
 - Component config → OTA Manager → Type of OTA → Enable pre encrypted OTA
+
+## 6. Delta OTA
+
+### 6.1  NimBLE OTA
+
+`idf.py menuconfig`
+
+- Component config → Bluetooth → Bluetooth → Host → NimBLE - BLE only
+
+> **_NOTE:_** For maximum throughput, set maximum MTU using
+
+- Component config → Bluetooth → NimBLE Options → Preferred MTU size in octets as 517
+
+- Example Configuration → Type of OTA → Use Delta OTA
+
+- if using ESP32H2, ESP32C6
+    1. Component config → Bluetooth → Bluetooth → NimBLE Options → deselect `Enable BLE 5 feature`
+    2. Example Configuration → deselect `Enable Extended Adv`
+
+### 6.2 Bluedroid
+
+`idf.py menuconfig`
+
+- Component config → Bluetooth → Bluetooth → Host → Bluedroid - Dual-mode
+- Component config → Bluetooth → Bluetooth → Bluedroid Options → deselect `Enable BLE 5.0 feature`
+- Component config → Bluetooth → Bluetooth → Bluedroid Options → deselect `Enable BLE 4.2 feature`
+- Example Configuration → Type of OTA → Use Delta OTA
+
+### Creating Patch
+
+Now we will consider this firmware as the base firmware which we will flash into the device. We need a new firmware to which we want to upgrade to. You can try b
+ilding the `hello_world` example present in ESP-IDF.
+We need to create a patch file for this new firmware.
+
+Install required packages:
+```
+pip install -r tools/requirements.txt
+```
+
+To create a patch file, use the [python tool](./tools/esp_delta_ota_patch_gen.py)
+```
+python esp_delta_ota_patch_gen.py --chip <target> --base_binary <base_binary> --new_binary <new_binary> --patch_file_name <patch_file_name>
+```
+
+This will generate the patch file for the new binary which needs to be hosted on the OTA update server.
+
+> **_NOTE:_** Make sure that the firmware present in the device is used as `base_binary` while creating the patch file. For this purpose, user should keep backup
+of the firmware running in the device as it is required for creating the patch file.
diff --git a/examples/bluetooth/ble_ota/main/Kconfig.projbuild b/examples/bluetooth/ble_ota/main/Kconfig.projbuild
@@ -57,6 +57,11 @@ menu "Example Configuration"
             depends on BT_NIMBLE_ENABLED
             help
                 This enables transferring pre-encrypted file via OTA
+
+        config EXAMPLE_USE_DELTA_OTA
+            bool "Use Delta OTA"
+            help
+                This enables transferring patch file via Delta OTA
     endchoice
 
     config EXAMPLE_EXTENDED_ADV
diff --git a/examples/bluetooth/ble_ota/main/app_main.c b/examples/bluetooth/ble_ota/main/app_main.c
diff --git a/examples/bluetooth/ble_ota/main/idf_component.yml b/examples/bluetooth/ble_ota/main/idf_component.yml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "0.1.12"`
	`1`	`+version: "0.1.13"`
`2`	`2`	`targets:`
`3`	`3`	`- esp32`
`4`	`4`	`- esp32c3`