fix(esp_hosted_ng): Fix build for kernel 6.17

.gitlab-ci.yml

@@ -9,7 +9,7 @@ variables:
 
 check_version:
   stage: pre_check
-  image: ${CI_DOCKER_REGISTRY}/esp-env-v5.4:1
+  image: ${CI_DOCKER_REGISTRY}/esp-env-v5.5:3
   script:
     - export HOSTED_NG_PATH=$PWD/esp_hosted_ng
     - .gitlab/ci/check_hosted_ng_version.sh
@@ -20,7 +20,7 @@ check_version:
 
 build_fw_esp32_sdio:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32
   script:
@@ -33,7 +33,7 @@ build_fw_esp32_sdio:
 
 build_fw_esp32_spi:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32
   script:
@@ -46,7 +46,7 @@ build_fw_esp32_spi:
 
 build_fw_esp32s2_spi:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32s2
   script:
@@ -59,7 +59,7 @@ build_fw_esp32s2_spi:
 
 build_fw_esp32s3_spi:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32s3
   script:
@@ -72,7 +72,7 @@ build_fw_esp32s3_spi:
 
 build_fw_esp32c2_spi:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32c2
   script:
@@ -85,7 +85,7 @@ build_fw_esp32c2_spi:
 
 build_fw_esp32c3_spi:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32c3
   script:
@@ -98,7 +98,7 @@ build_fw_esp32c3_spi:
 
 build_fw_esp32c6_sdio:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32c6
   script:
@@ -111,9 +111,22 @@ build_fw_esp32c6_sdio:
 
 build_fw_esp32c6_spi:
   stage: build_firmware
-  image: $CI_DOCKER_REGISTRY/esp-env-v5.4:1
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
   variables:
     IDF_TARGET: esp32c6
+  script:
+    - .gitlab/ci/build_firmware.sh $IDF_TARGET
+  rules:
+    - changes:
+      - esp_hosted_ng/esp/esp_driver/network_adapter/**/*
+  tags:
+    - build_fw
+
+build_fw_esp32c5_spi:
+  stage: build_firmware
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
+  variables:
+    IDF_TARGET: esp32c5
   script:
     - .gitlab/ci/build_firmware.sh $IDF_TARGET spi
   rules:
@@ -122,6 +135,20 @@ build_fw_esp32c6_spi:
   tags:
     - build_fw
 
+build_fw_esp32c5_sdio:
+  stage: build_firmware
+  image: $CI_DOCKER_REGISTRY/esp-env-v5.5:3
+  allow_failure: true
+  variables:
+    IDF_TARGET: esp32c5
+  script:
+    - .gitlab/ci/build_firmware.sh $IDF_TARGET sdio
+  rules:
+    - changes:
+      - esp_hosted_ng/esp/esp_driver/network_adapter/**/*
+  tags:
+    - build_fw
+
 build_host_sdio_linux_6.8.0:
   stage: build_host
   script:
@@ -133,6 +160,17 @@ build_host_sdio_linux_6.8.0:
   tags:
     - hosted_runner_4
 
+build_host_sdio_linux_6.14.0:
+  stage: build_host
+  script:
+    - cd esp_hosted_ng/host
+    - make
+  rules:
+    - changes:
+      - esp_hosted_ng/host/**/*
+  tags:
+    - hosted_runner6
+
 build_host_sdio_linux_5.15.0:
   stage: build_host
   script:
@@ -205,4 +243,3 @@ deploy_master_github:
       - git remote remove github &>/dev/null || true
       - git remote add github git@github.com:espressif/esp-hosted.git
       - git push github "${CI_COMMIT_SHA}:refs/heads/${CI_COMMIT_REF_NAME}"
-

.gitlab/ci/build_firmware.sh

@@ -31,7 +31,11 @@ if [ "$2" = "spi" ]; then
 fi
 
 echo "Setting target as $TGT_NAME"
-idf.py set-target $TGT_NAME
+if [ "$TGT_NAME" = "esp32c5" ]; then
+    idf.py --preview set-target "$TGT_NAME"
+else
+    idf.py set-target "$TGT_NAME"
+fi
 idf.py build
 
 # Check if the build was successful

README.md

@@ -1,133 +1,114 @@
 # ESP-Hosted
 
-ESP-Hosted is an open source solution that provides a way to use Espressif SoCs and modules as a communication co-processor. This solution provides wireless connectivity (Wi-Fi and BT/BLE) to the host microprocessor or microcontroller, allowing it to communicate with other devices.
+**ESP-Hosted** is an open-source solution that enables Espressif SoCs/modules (like ESP32) to act as **wireless communication co-processors** for external host systems.
 
-Following is the high level block diagram for ESP-Hosted. Detailed block diagram is available in subsequent sections. 
+It allows **host devices** (Linux-based systems or microcontrollers, MCUs) to add Wi-Fi and Bluetooth/BLE capabilities via **standard interfaces** like SPI, SDIO, or UART.
 
-![alt text](basic_block_diagram.jpg "Basic Block Diagram")
 
+### 🔑 Key Features
 
+* **Flexible Connectivity**: Wi-Fi + Bluetooth/BLE
+* **Broad Host Support**: Works with Linux and MCU-based systems
+* **Multiple Interfaces**: SPI, SDIO, UART
+* **Shared Networking**: ESP and host can share the same IP address
+* **Power Efficient**: Low power modes for battery-powered use cases
 
-## 1. ESP-Hosted Flavours
+### 📦 High-Level Architecture
 
-The ESP-Hosted solution is available in two flavours as mentioned below. The differentiation factor here is the type of network interface presented to host and the way Wi-Fi on ESP SoC/module is configured/controlled. Both the flavours have their respective host and firmware software.
+<img src="basic_block_diagram.jpg" alt="Basic Block Diagram" width="600"/>
 
+---
 
-### 1.1 ESP-Hosted-NG
+## 🧩 ESP-Hosted Variants
 
-This is the Next-Generation ESP-Hosted solution specifically designed for hosts that run Linux operating system. This flavour of the solution takes a standard approach while providing a network interface to the host. This allows usage of standard Wi-Fi applications such as wpa_supplicant to be used with ESP SoCs/modules.
+ESP-Hosted is available in three main variants:
 
-This solution offers following:
+### 🔹 [ESP-Hosted-NG (Next Gen)](esp_hosted_ng/README.md)
 
-* 802.11 network interface which is a standard Wi-Fi interface on Linux host
-* Configuration of Wi-Fi is supported through standard cfg80211 interface of Linux
-* A standard HCI interface
+Best for **Linux hosts** needing standard Wi-Fi and Bluetooth integration:
 
-This flavour is available in [esp_hosted_ng](esp_hosted_ng)
+* Acts as a native 802.11 wireless device
+* Configurable via `cfg80211` / `wpa_supplicant`
+* Supports `NetworkManager`
+* Bluetooth via standard HCI interface
 
-Please proceed with the [detailed documentation](esp_hosted_ng/README.md) for setup and usage instructions.
+---
 
+### 🔹 [ESP-Hosted-FG (First Gen)](esp_hosted_fg/README.md)
 
+Designed for **Linux hosts**, with custom lightweight RPC-based control:
 
-### 1.2 ESP-Hosted-FG
+* Ethernet 802.3 interface
+* Wi-Fi configuration via protobuf-based RPC
+* Fully customizable APIs
+* Bluetooth via standard HCI
+* Python or C integration
+* ESP maintains network when the host is powered off
 
-This is a first generation ESP-Hosted solution. This is a flavour, which provides a standard 802.3 (Ethernet) network interface to the host. Thought process behind this solution is to keep the host software simple while providing suite of connectivity features.
+---
 
-In order to achieve this, the host is presented with following:
+### 🔹 [ESP-Hosted-MCU](https://github.com/espressif/esp-hosted-mcu)
 
-* A standard 802.3 network interface which essentially is an Ethernet interface
-* A light weight control interface to configure Wi-Fi on ESP board
-* A standard HCI interface
+Optimized for **resource-constrained MCUs**:
 
-Although this flavour supports Linux host, the nature of this solution makes it ideal to be used with MCU hosts which do not have complex communication interfaces such as Ethernet, Wi-Fi, BT/BLE etc.
+* Minimal memory footprint
+* Wi-Fi configuration via protobuf-based RPC
+* Power-efficient operation
+* Ready port of ESP and STM32 as host
+* Bluetooth via standard HCI
+* ESP stays connected even when the host is in deep sleep or powered off
 
-This flavour is available in [esp_hosted_fg](esp_hosted_fg)
 
-Please proceed with the [detailed documentation](esp_hosted_fg/README.md) for setup and usage instructions.
+---
 
+## 📊 Variant Comparison
 
-## 2. ESP-Hosted-FG vs ESP-Hosted-NG
+| Feature                    |           ESP-Hosted-NG          |  ESP-Hosted-FG  |  ESP-Hosted-MCU  |
+| :-------------------------------- | :------------------------------: | :-------------: | :--------------: |
+| **Target Host**            |               Linux              |      Linux      |        MCU       |
+| **Wi-Fi Configuration**    |            `cfg80211`            |  RPC (protobuf) | RPC (protobuf) |
+| **Network Interface**      |           802.11 Wi-Fi           |  802.3 Ethernet |  802.3 Ethernet  |
+| **Same IP for ESP & Host** |                 ❌                |        ✅        |         ✅        |
+| **Power Management**       |                 ✅                |    :hourglass: Planned  |         ✅        |
+| **Wi-Fi Modes**            |              STA, AP             | STA, AP, STA+AP |  STA, AP, STA+AP |
+| **Bus Interfaces**         |   SPI, SDIO, UART (and combos)   |       Same      |       Same       |
+| **Wi-Fi Security**         |       WPA, WPA2, WPA3, Open      |       Same      |       Same       |
+| **Standards**              | 802.11 b/g/n/ax, BLE 4.2/5.0/5.3 |       Same      |       Same       |
+| **Supported ESP Chips**    |     ESP32, C2/C3/C5/C6, S2/S3    |       Same      |       Same       |
 
-Now that we offer two flavours of this solution, it could cause a little confusion. This section will try to explains similarities and differences in both the flavours and help you make a choice.
+---
 
-### 2.1 Similarities
+## 🤔 Choosing the Right Variant
 
-- Both the flavours share the same aim, to conveniently use ESP's Wi-Fi and Bluetooth/BLE capabilities from host
-- Both the flavours aim to support same set of ESP SoCs/modules and same set of transports like SPI/SDIO/UART for connectivity needs
+| Use Case                                                         | Recommended Variant |
+| ---------------------------------------------------------------- | ------------------- |
+| Standard Linux Wi-Fi config (`NetworkManager`, `wpa_supplicant`) | **ESP-Hosted-NG**   |
+| Linux with custom/proprietary control over Wi-Fi                 | **ESP-Hosted-FG**   |
+| Embedded Linux platforms (e.g. Raspberry Pi, BeagleBone)         | **NG** or **FG**    |
+| Minimal resource devices (low RAM/CPU MCUs)                      | **ESP-Hosted-MCU**  |
+| Custom networking or duplicate stack (same IP on host & ESP)     | **FG** or **MCU**   |
+| IoT use cases requiring both BLE and Wi-Fi                       | **Any**             |
+| Need for protocol customization / Deep Packet Inspection         | **FG** or **MCU**   |
+| Classic Bluetooth support                                        | **All Variants**    |
 
-### 2.2 Key Differences
+---
 
-- ESP-Hosted-FG supports both Linux and MCU hosts. ESP-Hosted-NG supports only Linux host.
-- ESP-Hosted-FG exposes 802.3 network interface (Ethernet) to the host. Where as, ESP-Hosted-NG exposes 802.11 interface (Wi-Fi).
-- ESP-Hosted-FG uses custom control path to configure Wi-Fi as opposed to ESP-Hosted-NG which uses standard nl80211/cfg80211 configuration.
+## 📚 Documentation & Resources
 
+### ESP-Hosted-NG
 
-Following table summarizes this entire discussion.
+* 📄 [Documentation](https://github.com/espressif/esp-hosted/blob/master/esp_hosted_ng/README.md)
+* 🐞 [Issues](https://github.com/espressif/esp-hosted/issues)
+* 📈 [Throughput Benchmarks](https://github.com/espressif/esp-hosted/blob/master/esp_hosted_ng/README.md#5-throughput-performance)
 
-<table>
-  <tr>
-    <th>Features</th>
-    <th>ESP-Hosted</br>First</br>Generation </th>
-    <th>ESP-Hosted</br>Next</br>Generation </th>
-  </tr>
-  <tr>
-    <td>Supported platforms</td>
-    <td>MCU &amp; Linux host</td>
-    <td>Linux only host</td>
-  </tr>
-  <tr>
-    <td>Wi-Fi Configuration mechanism</td>
-    <td>Custom control interface</td>
-    <td>nl80211 / cfg80211</td>
-  </tr>
-  <tr>
-    <td>Network Interface available</td>
-    <td>802.3 Ethernet Interface</td>
-    <td>802.11 Wi-Fi interface</td>
-  </tr>
-  <tr>
-    <td>Recommended Host Type</td>
-    <td><span style="font-weight:bold">MCU Host</span></td>
-    <td><span style="font-weight:bold">Linux Host</span></td>
-  </tr>
-  <tr>
-    <td>Wi-Fi features</td>
-    <td colspan="2" style="text-align:center">802.11 b/g/n</td>
-  </tr>
-  <tr>
-    <td>Transport Layer</td>
-    <td colspan="2"  style="text-align:center">SDIO, SPI, UART</td>
-  </tr>
-  <tr>
-    <td>Usable transport combinations</td>
-    <td colspan="2"  style="text-align:center">SPI only, SPI+UART, SDIO only, SDIO+UART</td>
-  </tr>
-  <tr>
-    <td>Wi-Fi Mode</td>
-    <td>Station, <span style="font-weight:bold">SoftAP</span></td>
-    <td>Station, SoftAP</td>
-  </tr>
-  <tr>
-    <td>Wi-Fi Security Protocols</td>
-    <td colspan="2"  style="text-align:center">Open / WPA / WPA2 / WPA3</td>
-  </tr>
-  <tr>
-    <td>Bluetooth features</td>
-    <td colspan="2"  style="text-align:center">BLE 4.2, BLE 5.0, BLE 5.3</td>
-  </tr>
-  <tr>
-    <td>Chipsets supported</td>
-    <td>ESP32, <span>ESP32-C2/C3/C5/C6/S2/S3</span></td>
-    <td>ESP32, <span>ESP32-C2/C3/C5/C6/S2/S3</span></td>
-  </tr>
-</table>
-
-- **Iperf Throughput**
-  - [ESP-Hosted-FG](esp_hosted_fg/README.md#5-throughput-performance)
-  - [ESP-Hosted-NG](esp_hosted_ng/README.md#4-throughput-performance)
-
-## 3. Our Recommendation
-
-* If you are using MCU host, you do not have choice but to use ESP-Hosted-FG
-* If you are using Linux host, we recommend ESP-Hosted-NG since it takes a standard approach which makes it compatible with widely used user space applications/services such as wpa_supplicant, Network Manager etc.
+### ESP-Hosted-FG
 
+* 📄 [Documentation](https://github.com/espressif/esp-hosted/blob/master/esp_hosted_fg/README.md)
+* 🐞 [Issues](https://github.com/espressif/esp-hosted/issues)
+* 📈 [Throughput Benchmarks](https://github.com/espressif/esp-hosted/blob/master/esp_hosted_fg/README.md#5-throughput-performance)
+
+### ESP-Hosted-MCU
+
+* 📄 [Documentation](https://github.com/espressif/esp-hosted-mcu/blob/main/README.md)
+* 🐞 [Issues](https://github.com/espressif/esp-hosted-mcu/issues)
+* 📈 [Throughput Benchmarks](https://github.com/espressif/esp-hosted-mcu/tree/main?tab=readme-ov-file#hosted-transports-table)