Merge branch 'release_0.0.5' into 'master'

FG: Bump release number to 0.0.5

See merge request app-frameworks/esp_hosted!258

Author: mantriyogesh

esp_hosted_fg/README.md

@@ -88,16 +88,19 @@ The below table explains which feature is supported on which transport interface
 | ESP32-S3 | SDIO | NA | NA | NA |
 | ESP32-S3 | SPI | Yes | Yes | BLE 5.0 |
 | ESP32-S3 | UART | No | No | BLE 5.0 |
-| ESP32-C2 | SDIO | NA | NA | NA |
-| ESP32-C2 | SPI | Yes | Yes | ComingSoon |
-| ESP32-C2 | UART | No | No | BLE 5.0 |
+| ESP32-C2\* | SDIO | NA | NA | NA |
+| ESP32-C2\* | SPI | Yes | Yes | ComingSoon |
+| ESP32-C2\* | UART | No | No | BLE 5.0 |
 
 Note:
-* BT stands for Bluetooth BR/EDR and BLE stands for Bluetooth Low Energy specifications.
-* ESP-Hosted-FG related BR/EDR 4.2 and BLE 4.2 functionalities are tested with bluez 5.43+. Whereas, BLE 5.0 functionalities are tested with bluez 5.45+.
-* We suggest the latest stable bluez version to be used. Any other Bluetooth stack instead of bluez also could be used.
-* bluez 5.45 on-wards BLE 5.0 HCI commands are supported.
-* BLE 5.0 has backward compatibility of BLE 4.2.
+- BT stands for Bluetooth BR/EDR and BLE stands for Bluetooth Low Energy specifications.
+- ESP-Hosted-FG related BR/EDR 4.2 and BLE 4.2 functionalities are tested with bluez 5.43+. Whereas, BLE 5.0 functionalities are tested with bluez 5.45+.
+- We suggest the latest stable bluez version to be used. Any other Bluetooth stack instead of bluez also could be used.
+- bluez 5.45 on-wards BLE 5.0 HCI commands are supported.
+- BLE 5.0 has backward compatibility of BLE 4.2.
+- \* ESP32-C2 is added as beta stage (only for ESP32-C2)
+	- You may experience low throughput & intermittent SPI detection issue on ESP32-C2. It would evolve and get stable with time.
+
 
 ##### 1.5.2 MCU Host
 The below table explains which feature is supported on which transport interface for MCU based host.
@@ -116,9 +119,9 @@ The below table explains which feature is supported on which transport interface
 | ESP32-S3 | SDIO | NA | NA | NA |
 | ESP32-S3 | SPI | Yes | Yes | BLE 5.0\* |
 | ESP32-S3 | UART | No | No | BLE 5.0\*\* |
-| ESP32-C2 | SDIO | NA | NA | NA |
-| ESP32-C2 | SPI | Yes | Yes | ComingSoon |
-| ESP32-C2 | UART | No | No | BLE 5.0\*\* |
+| ESP32-C2\*\*\* | SDIO | NA | NA | NA |
+| ESP32-C2\*\*\* | SPI | Yes | Yes | ComingSoon |
+| ESP32-C2\*\*\* | UART | No | No | BLE 5.0\*\* |
 
 Note: BT stands for Bluetooth BR/EDR and BLE stands for Bluetooth Low Energy specifications.
 
@@ -138,6 +141,9 @@ Note: BT stands for Bluetooth BR/EDR and BLE stands for Bluetooth Low Energy spe
 > With the help of this UART interface, BT/BLE stack can directly interact with BT controller present on ESP bypassing host driver and firmware
 > ESP Hosted host driver and a firmware plays no role in this communication
 
+\*\*\* ESP32-C2 is added as beta stage (only for ESP32-C2)
+> You may experience low throughput & intermittent SPI detection issue on ESP32-C2. It would evolve and get stable with time.
+
 * Linux hosts support OTA update (Over The Air ESP firmware update) in C and python. MCU hosts can refer to the same for their development. For detailed documentation, please read
 [ota_update.md](docs/Linux_based_host/ota_update.md).
 
@@ -268,8 +274,8 @@ Below document explains the APIs provided for MCU based ESP-Hosted-FG solution
 * [API's for MCU based host](docs/MCU_based_host/mcu_api.md)
 
 # 5. Throughput performance
-* Wi-Fi Performance in shielded environment
-Following performance numbers are taken on Linux based ESP-Hosted-FG solution.
-These numbers are tested with older release, [Release 0.3](https://github.com/espressif/esp-hosted/releases/tag/release%2Fv0.3)
+* Station & Soft-AP both the Wi-Fi modes support both, 20 MHz & 40 MHz bandwidth
+* Throughput performace is measured with iperf inside the RF shielded box
+* Following are ESP-Hosted-FG iperf throughput numbers for Wi-Fi (station mode - 20MHz), considering common use-case
 
 ![alt text](docs/esp_hosted_performance.png "ESP Hosted performance matrix")

esp_hosted_fg/docs/Linux_based_host/Getting_started.md

@@ -126,7 +126,8 @@ $ cd host/linux/host_control/python_support/
 
 ## 3. Bluetooth/BLE Connectivity
 
-* Ensure that bluez is installed on Raspberry Pi and it is downloaded in source format as well.
+* Ensure that BlueZ and related dependency softwares (mentioned [earlier](Linux_based_readme.md#12-host-setup)) are installed on the host
+* BlueZ is example Bluetooth stack used, as it is generally available in Linux. Any other Bluetooth stack can also be used.
 * In following test, Android device was used as a BT/BLE test device. For BLE testing, [nRF connect for mobile APP](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp&hl=en_IN) was used.
 * Ensure that `hci0` interface is visible. To check that, run `hciconfig`.
 ```

esp_hosted_fg/docs/Linux_based_host/Linux_based_readme.md

@@ -203,17 +203,8 @@ This section identifies Raspberry-Pi specific setup requirements.
 ### 2.2 ESP-IDF Setup
 :warning:`Note: ESP-IDF is needed to compile ESP-Hosted firmware source. Skip this step if you are planning to use pre-built release binaries.`  
 
-ESP-IDF release version to be used for ESP peripherals are
-
-| ESP peripheral | ESP-IDF release |
-|:----:|:----:|
-| ESP32 | [release v4.0](https://github.com/espressif/esp-idf/tree/release/v4.0) |
-| ESP32-S2 | [release v4.2](https://github.com/espressif/esp-idf/tree/release/v4.2) |
-| ESP32-C2 | [release v5.0](https://github.com/espressif/esp-idf/tree/release/v5.0) |
-| ESP32-C3 | [release v4.4](https://github.com/espressif/esp-idf/tree/release/v4.4) |
-| ESP32-S3 | [release v4.4](https://github.com/espressif/esp-idf/tree/release/v4.4) |
-
-Clone appropriate ESP-IDF version as per your ESP peripheral. The control path between Linux host and ESP peripheral is based on `protobuf`. For that, corresponding stack layer, `protocomm` from ESP-IDF is used.
+- Clone the ESP-IDF [release/v5.0](https://github.com/espressif/esp-idf/tree/release/v5.0) and git checkout to `release/v5.0` branch.
+- The control path between MCU host and ESP peripheral is based on `protobuf`. For that, corresponding stack layer, `protocomm` from ESP-IDF is used. It will be already present in ESP-IDF, no extra setup required for that.
 
 ### 2.3 ESP-Hosted Code Repository
 Clone esp-hosted repository on Linux host.

esp_hosted_fg/docs/MCU_based_host/MCU_based_readme.md

@@ -127,17 +127,8 @@ Setup image is here.
 ## 2.1 ESP-IDF requirement
 :warning:`Note: ESP-IDF is needed to compile ESP-Hosted firmware source. Skip this step if you are planning to use pre-built release binaries.`
 
-ESP-IDF release version to be used for ESP peripherals are
-
-| ESP peripheral | ESP-IDF release |
-|:----:|:----:|
-| ESP32 | [release v4.0](https://github.com/espressif/esp-idf/tree/release/v4.0) |
-| ESP32-S2 | [release v4.2](https://github.com/espressif/esp-idf/tree/release/v4.2) |
-| ESP32-C2 | [release v5.0](https://github.com/espressif/esp-idf/tree/release/v5.0) |
-| ESP32-C3 | [release v4.4](https://github.com/espressif/esp-idf/tree/release/v4.4) |
-| ESP32-S3 | [release v4.4](https://github.com/espressif/esp-idf/tree/release/v4.4) |
-
-Clone appropriate ESP-IDF version as per your ESP peripheral. The control path between MCU host and ESP peripheral is based on `protobuf`. For that, corresponding stack layer, `protocomm` from ESP-IDF is used.
+- Clone the ESP-IDF [release/v5.0](https://github.com/espressif/esp-idf/tree/release/v5.0)  and checkout to `release/v5.0` branch.
+- The control path between MCU host and ESP peripheral is based on `protobuf`. For that, corresponding stack layer, `protocomm` from ESP-IDF is used. It will be already present in ESP-IDF, no extra setup required for that.
 
 ### 2.2 Setup
 #### 2.2.1 Using pre-built binary

esp_hosted_fg/docs/esp_hosted_performance.png

@@ -2,10 +2,13 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)
 
-set(PROJECT_VERSION "0.4")
+set(PROJECT_VERSION_MAJOR_1 "0")
+set(PROJECT_VERSION_MAJOR_2 "0")
+set(PROJECT_VERSION_MINOR "5")
 message(*************************************************************************************)
-message("                    Building ESP-Hosted Firmware version :: ${PROJECT_VERSION}             ")
+message("                    Building ESP-Hosted-FG Firmware version :: ${PROJECT_VERSION_MAJOR_1}.${PROJECT_VERSION_MAJOR_2}.${PROJECT_VERSION_MINOR} ")
 message(*************************************************************************************)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(network_adapter)
+idf_build_set_property(COMPILE_OPTIONS "-fdiagnostics-color=always" APPEND)

esp_hosted_fg/esp/esp_driver/network_adapter/CMakeLists.txt

@@ -9,8 +9,10 @@ endif()
 
 
 register_component()
-set(PROJECT_VERSION "-DPROJECT_VERSION=0.4")
-target_compile_definitions(${COMPONENT_LIB} PRIVATE ${PROJECT_VERSION})
+set(PROJECT_VERSION_MAJOR_1 "-DPROJECT_VERSION_MAJOR_1=0")
+set(PROJECT_VERSION_MAJOR_2 "-DPROJECT_VERSION_MAJOR_2=0")
+set(PROJECT_VERSION_MINOR "-DPROJECT_VERSION_MINOR=5")
+target_compile_definitions(${COMPONENT_LIB} PRIVATE ${PROJECT_VERSION_MAJOR_1} ${PROJECT_VERSION_MAJOR_2} ${PROJECT_VERSION_MINOR})
 
 # Add directory of protocomm_priv.h to include paths
 idf_component_get_property(protocomm_dir protocomm COMPONENT_DIR)

esp_hosted_fg/esp/esp_driver/network_adapter/main/CMakeLists.txt

@@ -104,11 +104,20 @@ uint8_t ap_mac[MAC_LEN] = {0};
 static void print_firmware_version()
 {
 	ESP_LOGI(TAG, "*********************************************************************");
-	ESP_LOGI(TAG, "                ESP-Hosted Firmware version :: %.1f                        ", PROJECT_VERSION);
+	ESP_LOGI(TAG, "                ESP-Hosted-FG Firmware version :: %d.%d.%d                        ",
+			PROJECT_VERSION_MAJOR_1, PROJECT_VERSION_MAJOR_2, PROJECT_VERSION_MINOR);
 #if CONFIG_ESP_SPI_HOST_INTERFACE
-	ESP_LOGI(TAG, "                Transport used :: SPI                           ");
+  #if BLUETOOTH_UART
+	ESP_LOGI(TAG, "                Transport used :: SPI + UART                    ");
+  #else
+	ESP_LOGI(TAG, "                Transport used :: SPI only                      ");
+  #endif
 #else
-	ESP_LOGI(TAG, "                Transport used :: SDIO                          ");
+  #if BLUETOOTH_UART
+	ESP_LOGI(TAG, "                Transport used :: SDIO + UART                   ");
+  #else
+	ESP_LOGI(TAG, "                Transport used :: SDIO only                     ");
+  #endif
 #endif
 	ESP_LOGI(TAG, "*********************************************************************");
 }

esp_hosted_fg/esp/esp_driver/network_adapter/main/app_main.c

@@ -17,7 +17,9 @@
 #include <unistd.h>
 #include "esp_log.h"
 
+#if TEST_RAW_TP
 static const char TAG[] = "stats";
+#endif
 
 #ifdef CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS
 /* These functions are only for debugging purpose
@@ -274,15 +276,3 @@ void debug_set_wifi_logging(void) {
 #endif /* CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE*/
 
 }
-
-void debug_log_firmware_version(void)
-{
-	ESP_LOGI(TAG, "*********************************************************************");
-	ESP_LOGI(TAG, "                ESP-Hosted Firmware version :: %.1f                        ", PROJECT_VERSION);
-#if CONFIG_ESP_SPI_HOST_INTERFACE
-	ESP_LOGI(TAG, "                Transport used :: SPI                           ");
-#else
-	ESP_LOGI(TAG, "                Transport used :: SDIO                          ");
-#endif
-	ESP_LOGI(TAG, "*********************************************************************");
-}

esp_hosted_fg/esp/esp_driver/network_adapter/main/stats.c

@@ -89,7 +89,6 @@ void debug_update_raw_tp_rx_count(uint16_t len);
 #endif
 
 
-void debug_log_firmware_version(void);
 void create_debugging_tasks(void);
 uint8_t debug_get_raw_tp_conf(void);
 void debug_set_wifi_logging(void);

esp_hosted_fg/esp/esp_driver/network_adapter/main/stats.h

@@ -1,6 +1,7 @@
 ## Bluetooth/BLE Setup and Test Procedure
 
-* Ensure that bluez is installed on Raspberry Pi and it is downloaded in source format as well.
+* Ensure that BlueZ and related dependency softwares (listed in setup document earlier) are installed on the host
+* BlueZ is example Bluetooth stack used, as it is generally available in Linux. Any other Bluetooth stack can also be used.
 * In following test, Android device was used as a BT/BLE test device. For BLE testing, [nRF connect for mobile APP](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp&hl=en_IN) was used.
 * Ensure that `hci0` interface is visible. To check that, run `hciconfig`.
 ```