Merge branch 'ex/transport_config_b4_init' into 'main'

fix(transport_config): Add host example to showcase transport config before esp_hosted_init()

See merge request app-frameworks/esp_hosted_mcu!114

Author: mantriyogesh

CMakeLists.txt

@@ -106,7 +106,9 @@ if(CONFIG_ESP_HOSTED_ENABLED)
 	list(APPEND srcs
 		"${host_dir}/port/esp/freertos/src/port_esp_hosted_host_init.c"
 		"${host_dir}/port/esp/freertos/src/port_esp_hosted_host_os.c"
-		"${host_dir}/port/esp/freertos/src/port_esp_hosted_host_ota.c")
+		"${host_dir}/port/esp/freertos/src/port_esp_hosted_host_ota.c"
+		"${host_dir}/port/esp/freertos/src/port_esp_hosted_host_transport_defaults.c"
+	)
 
 	if(CONFIG_ESP_HOSTED_SDIO_HOST_INTERFACE)
 		list(APPEND srcs "${host_dir}/port/esp/freertos/src/port_esp_hosted_host_sdio.c")

examples/host_transport_config/CMakeLists.txt

@@ -0,0 +1,8 @@
+# The following lines of boilerplate have to be in your project's CMakeLists
+# in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+# "Trim" the build. Include the minimal set of components, main, and anything it depends on.
+idf_build_set_property(MINIMAL_BUILD ON)
+project(transport_config)

examples/host_transport_config/README.md

@@ -0,0 +1,103 @@
+# ESP-Hosted Transport Configuration Example
+
+Demonstrates how to configure ESP-Hosted transport interfaces (SDIO, SPI, UART) before initialization.
+
+## Supported Transports
+
+| Transport | Speed | Pins | Use Case |
+|-----------|-------|------|----------|
+| **SDIO 1-bit** | High | 5 pins | Good performance, fewer pins |
+| **SDIO 4-bit** | Highest | 7 pins | Best performance |
+| **SPI Full-Duplex** | Medium | 6 pins | Standard interface |
+| **SPI HD Dual** | Medium | 4 pins | Fewer pins needed |
+| **SPI HD Quad** | Medium | 6 pins | Better throughput |
+| **UART** | Low | 3 pins | Simple connection |
+
+## Pin Connections
+
+### SDIO 1-bit
+| Host <-> Slave (5 pins) | CLK | CMD | DAT0 | DAT1 (interrupt) | RESET |
+|---|---|---|---|---|---|
+
+### SDIO 4-bit (Default)
+| Host <-> Slave (7 pins) | CLK | CMD | DAT0 | DAT1 | DAT2 | DAT3 | RESET |
+|---|---|---|---|---|---|---|---|
+
+### SPI Full-Duplex
+| Host <-> Slave (6 pins) | MOSI | MISO | SCLK | CS | HANDSHAKE | DATA_READY |
+|---|---|---|---|---|---|---|
+
+### SPI Half-Duplex Dual
+| Host <-> Slave (4 pins) | CLK | CS | D0 | D1 (+ DATA_READY) |
+|---|---|---|---|---|
+
+### SPI Half-Duplex Quad
+| Host <-> Slave (6 pins) | CLK | CS | D0 | D1 | D2 | D3 (+ DATA_READY) |
+|---|---|---|---|---|---|---|
+
+### UART
+| Host <-> Slave (3 pins) | TX | RX | RESET |
+|---|---|---|---|
+
+## What This Example Shows
+
+- Get default transport configuration
+- Customize parameters (clock, pins, buffers)
+- Apply configuration before `esp_hosted_init()`
+
+## Key Code Pattern
+
+```c
+// 1. Get default config
+struct esp_hosted_sdio_config config = INIT_DEFAULT_HOST_SDIO_CONFIG();
+
+// 2. Customize settings
+config.clock_freq_khz = 25000;
+config.bus_width = 4;
+
+// 3. Apply config
+esp_hosted_sdio_set_config(&config);
+
+// 4. Initialize ESP-Hosted
+esp_hosted_init();
+```
+
+## Customization
+
+> [!TIP]
+>
+> This example was added to showcase (Option 2: Programmatic Configuration) discussed below.
+> (Option 1: Using menuconfig) is anyway available for any host example.
+
+### Pin Configuration Options
+
+**Option 1: Using menuconfig**
+
+First select your transport:
+```bash
+idf.py menuconfig
+# (Top) → Component config → ESP-Hosted config → Transport layer
+```
+
+Then configure pins:
+- **SDIO**: `(Top) → Component config → ESP-Hosted config → Hosted SDIO Configuration`
+- **SPI Full-Duplex**: `(Top) → Component config → ESP-Hosted config → SPI Configuration`
+- **SPI Half-Duplex**: `(Top) → Component config → ESP-Hosted config → SPI Half-duplex Configuration`
+- **UART**: `(Top) → Component config → ESP-Hosted config → UART Configuration`
+
+**Option 2: Programmatic Configuration**
+Edit the configuration functions in `main.c` for users who prefer code-based configuration or have limitations with menuconfig:
+
+```c
+// Example: Custom SPI pin assignment
+spi_config.pin_mosi.pin = YOUR_MOSI_PIN;
+spi_config.pin_miso.pin = YOUR_MISO_PIN;
+spi_config.pin_sclk.pin = YOUR_SCLK_PIN;
+spi_config.pin_cs.pin = YOUR_CS_PIN;
+```
+
+### Other Customizations
+- **Clock speeds**: Adjust for stability vs performance
+- **Buffer sizes**: Tune for your throughput needs
+- **Data lines**: Configure GPIOs to match your connections
+- **Transport config**: Any other transport specific config

examples/host_transport_config/main/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "transport_config_main.c"
+                    PRIV_REQUIRES esp_wifi console nvs_flash
+                    INCLUDE_DIRS ".")

examples/host_transport_config/main/idf_component.yml

@@ -0,0 +1,9 @@
+dependencies:
+  espressif/esp_wifi_remote:
+    version: "*"
+    rules:
+      - if: "target in [esp32p4, esp32h2]"
+  espressif/esp_hosted:
+    version: "*"
+    rules:
+      - if: "target in [esp32p4, esp32h2]"