Merge branch 'nw_split_linux_wip5' into 'master'

fix(nw_split): Disable Network split for ESP32-C2 and ESP32-C3

See merge request app-frameworks/esp_hosted!577

Author: mantriyogesh

esp_hosted_fg/docs/Linux_based_host/UART_setup.md

@@ -2,10 +2,10 @@
 
 | Supported Chipsets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-S3 | ESP32-C6 | ESP32-C5 | ESP32-S2 |
 | ------------------ | :---: | :------: | :------: | :------: | :------: | :------: | :------: |
-| 4 line UART        | Y     | N        | Y        | Y        | N        | N        | Y        |
-| 2 line UART        | N     | Y        | N        | N        | Y        | Y        | N        |
+| 4 line UART        | T     | NT        | T        | T        | NT        | NT        | T        |
+| 2 line UART        | NT     | T        | NT        | NT        | T        | T        | NT        |
 
-Y - **Tested**, N - **Not Tested**
+T - **Tested**, NT - **Not Tested**
 
 In this section, ESP chipset provides a way to run Bluetooth/BLE over UART interface.
 Please connect ESP peripheral to Raspberry-Pi with jumper cables (preferably PCB) as mentioned below.
@@ -28,6 +28,12 @@ Raspberry-Pi pinout can be found [here!](https://pinout.xyz/pinout/uart)
 
 #### Four Line UART setup
 
+> [!NOTE]
+>
+> For UART protocol
+> - Host TX is to be connected to slave RX & vice versa.
+> - Host CTS is to be connected to slave RTS & vice versa.
+
 | Raspberry-Pi Pin Function | Raspberry-Pi Pin | ESP32 | ESP32-S3 | ESP32-C3 | ESP32 Pin Function |
 |:-------:|:--------:|:---------:|:--------:|:--------:|:--------:|
 | RX | 10 | IO5 | IO17 | IO5 | TX |
@@ -41,15 +47,21 @@ Sample SPI+UART setup image looks like:
 
 #### Two Line UART setup
 
+> [!NOTE]
+>
+> For UART protocol, Host TX is connected to slave RX & vice versa.
 
 | Raspberry-Pi Pin Function | Raspberry-Pi Pin | ESP32-C2 | ESP32-C5 | ESP32-C6 | ESP Function |
 |:-------:|:--------:|:---------:|:--------:|:--------:|:--------:|
-| TX | 8  | IO5  | IO5  | IO5  | TX |
-| RX | 10 | IO18 | IO23 | IO12 | RX |
-
-Note:
-- ESP32-C2 only
-	- Although, `HCI with UART` is supported on `ESP32-C2`, `Wi-Fi + Bluetooth` (together) when used with `SPI+UART` setup, Bluetooth on UART works fine but Wi-Fi on SPI faces low throughput problem. By the time this is rectified, please use 'SPI only' i.e. `HCI over SPI` and `Wi-Fi over SPI` transport combination. In `SPI only` setup, there is no such limitation.
+| RX | 10 | IO5  | IO5  | IO5  | TX |
+| TX | 8 | IO1 | IO23 | IO12 | RX |
+
+> [ !CAUTION ]
+> - ESP32-C2 only
+>	- ESP32-C2 has much less IRAM, without PSRAM support.
+>	- With `SPI+UART` mode, i.e. Wi-Fi on SPI & BLE over UART mode, Wi-Fi on SPI faces low throughput problem when uart is loaded.
+>	- With `SPI only` mode, i.e. Wi-Fi & BLE, both, running over SPI, both, Wi-Fi and Bluetooth work smooth.
+>	- Conclusion, For `ESP32-C2`, prefer using `SPI only` mode.
 
 
 ### 1.2 Raspberry-Pi Software Setup

esp_hosted_fg/esp/esp_driver/network_adapter/CMakeLists.txt

@@ -27,7 +27,18 @@ include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(network_adapter)
 idf_build_set_property(COMPILE_OPTIONS "-fdiagnostics-color=always" APPEND)
 
-
-idf_component_get_property(lwip lwip COMPONENT_LIB)
-target_compile_options(${lwip} PRIVATE "-I${PROJECT_DIR}/main")
-target_compile_definitions(${lwip} PRIVATE "-DESP_IDF_LWIP_HOOK_FILENAME=\"esp_hosted_lwip_src_port_hook.h\"")
+if(NOT CONFIG_IDF_TARGET_ESP32C2 AND NOT CONFIG_IDF_TARGET_ESP32C3)
+    idf_component_get_property(lwip lwip COMPONENT_LIB)
+    if(TARGET ${lwip})
+        # Use generator expressions to only apply to non-INTERFACE targets
+        get_target_property(lwip_type ${lwip} TYPE)
+        if(NOT lwip_type STREQUAL "INTERFACE_LIBRARY")
+            message(STATUS "********** Configuring LWIP for network split mode with custom hook **********")
+            target_include_directories(${lwip} PRIVATE "${PROJECT_DIR}/main")
+            target_compile_definitions(${lwip} PRIVATE "-DESP_IDF_LWIP_HOOK_FILENAME=\"esp_hosted_lwip_src_port_hook.h\"")
+        endif()
+    endif()
+else()
+    message(STATUS "********** Skipping LWIP for network split mode with custom hook **********")
+    # Do not reference esp_http_client for esp32c2 and esp32c3
+endif()

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

@@ -11,11 +11,17 @@ set(COMPONENT_SRCS
     "stats.c"
     "mempool_ll.c"
     "host_power_save.c"
-    "mqtt_example.c"
-    "http_req.c"
     "lwip_filter.c"
 )
 
+if(CONFIG_ESP_HOSTED_COPROCESSOR_EXAMPLE_MQTT)
+    list(APPEND COMPONENT_SRCS mqtt_example.c)
+endif()
+
+if(CONFIG_ESP_HOSTED_COPROCESSOR_EXAMPLE_HTTP_CLIENT)
+    list(APPEND COMPONENT_SRCS http_req.c)
+endif()
+
 set(COMPONENT_ADD_INCLUDEDIRS
     "."
     "${common_dir}/include"

esp_hosted_fg/esp/esp_driver/network_adapter/main/Kconfig.projbuild

@@ -480,6 +480,7 @@ menu "Example Configuration"
 	endmenu
 
 	config NETWORK_SPLIT_ENABLED
+		depends on !IDF_TARGET_ESP32C2 && !IDF_TARGET_ESP32C3
 		bool "Allow Network Split using packet port number"
 		default y
 		help
@@ -631,6 +632,7 @@ menu "Example Configuration"
 	endmenu
 
 	config ESP_HOSTED_CLI_ENABLED
+		depends on !IDF_TARGET_ESP32C2 && !IDF_TARGET_ESP32C3
 		bool "Start CLI at slave"
 		default y
 
@@ -738,6 +740,8 @@ menu "Example Configuration"
 
 
 	menu "Example to run"
+		depends on NETWORK_SPLIT_ENABLED
+
 		config ESP_HOSTED_COPROCESSOR_EXAMPLE_MQTT
 			bool "MQTT client example"
 			default y

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

@@ -7,6 +7,9 @@
    CONDITIONS OF ANY KIND, either express or implied.
 */
 #include <string.h>
+#include "sdkconfig.h"
+
+#ifdef CONFIG_ESP_HOSTED_COPROCESSOR_EXAMPLE_HTTP_CLIENT
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "esp_system.h"
@@ -17,9 +20,9 @@
 #include "lwip/sys.h"
 #include "lwip/netdb.h"
 #include "lwip/dns.h"
-#include "sdkconfig.h"
 
-#ifdef ESP_HOSTED_COPROCESSOR_EXAMPLE_HTTP_CLIENT
+
+
 extern volatile uint8_t station_connected;
 /* Constants that aren't configurable in menuconfig */
 #define WEB_SERVER CONFIG_HTTP_WEBSERVER

esp_hosted_fg/esp/esp_driver/network_adapter/main/idf_component.yml

@@ -1,11 +1,21 @@
 dependencies:
   cmd_system:
     path: ${IDF_PATH}/examples/system/console/advanced/components/cmd_system
+    rules:
+      - if: target not in ["esp32c2", "esp32c3"]
   espressif/iperf:
     version: "*"
+    rules:
+      - if: target not in ["esp32c2", "esp32c3"]
   espressif/iperf-cmd:
     version: "~0.1.1"
+    rules:
+      - if: target not in ["esp32c2", "esp32c3"]
   esp-qa/wifi-cmd:
     version: "~0.1.0"
+    rules:
+      - if: target not in ["esp32c2", "esp32c3"]
   esp-qa/ping-cmd:
     version: "~0.0.1"
+    rules:
+      - if: target not in ["esp32c2", "esp32c3"]

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

@@ -9,7 +9,7 @@
 #include "host_power_save.h"
 #include "lwip_filter.h"
 
-#ifdef CONFIG_NETWORK_SPLIT_ENABLED
+#if defined(CONFIG_NETWORK_SPLIT_ENABLED) && defined(CONFIG_LWIP_ENABLE)
 #include "lwip/opt.h"
 #include "lwip/err.h"
 #include "lwip/sys.h"
@@ -522,4 +522,4 @@ hosted_l2_bridge filter_and_route_packet(void *frame_data, uint16_t frame_length
 int configure_host_static_port_forwarding_rules(const char *ports_str_tcp_src, const char *ports_str_tcp_dst, const char *ports_str_udp_src, const char *ports_str_udp_dst) {
     return punch_hole_for_host_ports_from_config(ports_str_tcp_src, ports_str_tcp_dst, ports_str_udp_src, ports_str_udp_dst);
 }
-#endif
+#endif

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

@@ -11,11 +11,11 @@ typedef enum {
 	INVALID_BRIDGE,
 } hosted_l2_bridge;
 
-#ifdef CONFIG_NETWORK_SPLIT_ENABLED
+#if defined(CONFIG_NETWORK_SPLIT_ENABLED) && defined(CONFIG_LWIP_ENABLE)
 #include "esp_hosted_lwip_src_port_hook.h"
 
 hosted_l2_bridge filter_and_route_packet(void *frame_data, uint16_t frame_length);
 
 int configure_host_static_port_forwarding_rules(const char *ports_str_tcp_src, const char *ports_str_tcp_dst,
                                                 const char *ports_str_udp_src, const char *ports_str_udp_dst);
-#endif
+#endif

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

@@ -11,6 +11,10 @@
 #include <stdint.h>
 #include <stddef.h>
 #include <string.h>
+#include "sdkconfig.h"
+
+#ifdef CONFIG_ESP_HOSTED_COPROCESSOR_EXAMPLE_MQTT
+
 #include "esp_wifi.h"
 #include "esp_system.h"
 #include "nvs_flash.h"
@@ -23,15 +27,15 @@
 #include "freertos/semphr.h"
 #include "freertos/queue.h"
 
-#include "lwip/sockets.h"
-#include "lwip/dns.h"
-#include "lwip/netdb.h"
 
 #include "esp_log.h"
 #include "mqtt_client.h"
 #include "host_power_save.h"
 
-#ifdef CONFIG_ESP_HOSTED_COPROCESSOR_EXAMPLE_MQTT
+#include "lwip/sockets.h"
+#include "lwip/dns.h"
+#include "lwip/netdb.h"
+
 static const char *TAG = "mqtt_example";
 static esp_mqtt_client_handle_t client;
 static uint8_t client_started;

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

@@ -413,9 +413,7 @@ static void init_uart_c2_c6_c5(void)
 {
 	ESP_LOGD(TAG, "Set-up BLE for ESP32-C2/C6/C5");
 
-#if defined(CONFIG_IDF_TARGET_ESP32C2)
-	ESP_LOGI(TAG, "UART Pins: Tx:%u Rx:%u", BT_TX_PIN, BT_RX_PIN);
-#elif defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32C5)
+#if defined(CONFIG_IDF_TARGET_ESP32C2) || defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32C5)
 	//ESP_ERROR_CHECK( uart_set_pin(BLUETOOTH_UART, BT_TX_PIN,
 	//  BT_RX_PIN, BT_RTS_PIN, BT_CTS_PIN) );
 	ESP_LOGI(TAG, "UART Pins: Tx:%u Rx:%u", BT_TX_PIN, BT_RX_PIN);

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

@@ -89,14 +89,7 @@
     #define BT_RTS_PIN         19
     #define BT_CTS_PIN         23
 
-  #elif defined(CONFIG_IDF_TARGET_ESP32C2)
-
-      #define BT_TX_PIN         5
-      #define BT_RX_PIN         18
-      //#define BT_RTS_PIN        9
-      //#define BT_CTS_PIN        8
-
-  #elif defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32C5)
+  #elif defined(CONFIG_IDF_TARGET_ESP32C2) || defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32C5)
 
       #define BT_TX_PIN         CONFIG_BT_LE_HCI_UART_TX_PIN
       #define BT_RX_PIN         CONFIG_BT_LE_HCI_UART_RX_PIN

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

@@ -145,9 +145,7 @@ void vTimerCallback( TimerHandle_t xTimer )
 
 static void send_wifi_event_data_to_host(int event, void *event_data, int event_size)
 {
-#ifndef CONFIG_SLAVE_MANAGES_WIFI
-		send_event_data_to_host(event, event_data, event_size);
-#endif
+	send_event_data_to_host(event, event_data, event_size);
 }
 
 static bool wifi_is_provisioned(wifi_config_t *wifi_cfg)
@@ -407,15 +405,13 @@ static void station_event_handler(void *arg, esp_event_base_t event_base,
 		station_got_ip = 0;
 	#endif
 
-	#ifndef CONFIG_SLAVE_MANAGES_WIFI
-		wifi_event_sta_disconnected_t * disconnected_event =
-			(wifi_event_sta_disconnected_t *) event_data;
+	wifi_event_sta_disconnected_t * disconnected_event =
+		(wifi_event_sta_disconnected_t *) event_data;
 
-		send_wifi_event_data_to_host(CTRL_MSG_ID__Event_StationDisconnectFromAP,
-				disconnected_event, sizeof(wifi_event_sta_disconnected_t));
-		ESP_LOGI(TAG, "Station disconnected, reason[%u]",
-				disconnected_event->reason);
-	#endif
+	send_wifi_event_data_to_host(CTRL_MSG_ID__Event_StationDisconnectFromAP,
+			disconnected_event, sizeof(wifi_event_sta_disconnected_t));
+	ESP_LOGI(TAG, "Station disconnected, reason[%u]",
+			disconnected_event->reason);
 
 #ifdef CONFIG_NETWORK_SPLIT_ENABLED
 		send_dhcp_dns_info_to_host(0, 0);
@@ -464,13 +460,12 @@ static void station_event_handler(void *arg, esp_event_base_t event_base,
 		}
 		sta_connect_retry = 0;
 		prev_wifi_config_valid = true;
-		#ifndef CONFIG_SLAVE_MANAGES_WIFI
-			/* Event should not be triggered if event handler is
-			 * called as part of host triggered procedure like sta_disconnect etc
-			 **/
-			send_wifi_event_data_to_host(CTRL_MSG_ID__Event_StationConnectedToAP,
-					connected_event, sizeof(wifi_event_sta_connected_t));
-		#endif
+
+		/* Event should not be triggered if event handler is
+		 * called as part of host triggered procedure like sta_disconnect etc
+		 **/
+		send_wifi_event_data_to_host(CTRL_MSG_ID__Event_StationConnectedToAP,
+				connected_event, sizeof(wifi_event_sta_connected_t));
 
 		memcpy(&lkg_sta_connected_event, connected_event, sizeof(wifi_event_sta_connected_t));