bugfix(sta_connect): Fix applying new sta config

- apply new incoming sta config immediately if not connected
- suppress disconnect event from old config
- tested with these conditions:
  - not using NVRAM to save station config
  - using NVRAM to save station config
- test results: new sta config is applied and connected without prior
  disconnection (unless already connected)
- bugfix: IRAM limitation for UART applies only to ESP32
- workaround: bug in `esp_wifi_get_protocol()` causing memory corruption
- updated CI pipeline to build mqtt/tcp example from Registry Component

Author: SohKamYung-Espressif

.gitlab/ci/regression_pipeline_jobs.yml

@@ -70,17 +70,18 @@ regression_build_idf_v5.5_iperf:
 regression_build_idf_master_mqtt_tcp:
   variables:
     EXAMPLE_CI_FILE: "sdkconfig.ci.p4_wifi"
+    IDF_REGISTRY_COMPONENT: "espressif/mqtt"
+    IDF_REGISTRY_COMPONENT_EXAMPLE: "tcp"
   tags:
     - build
   rules:
     - !reference [.staging_branch_rules, rules]
-  extends: .build_template
+  extends: .build_template_mqtt_tcp_component
   image: espressif/idf:latest
   parallel:
     matrix:
       - IDF_TARGET: ["esp32p4", "esp32h2"]
         IDF_SLAVE_TARGET: ["esp32", "esp32c2", "esp32c3", "esp32s3" ]
-        IDF_EXAMPLE_PATH: ["examples/protocols/mqtt/tcp"]
 
 regression_build_idf_master_iperf:
   tags:

.gitlab/ci/sanity_pipeline_jobs.yml

@@ -15,18 +15,20 @@ premerge_check:
 ###
 
 ### protocols/mqtt/tcp example
+### for master, mqtt/tcp example is now in Component Registry
 sanity_build_idf_master_mqtt_tcp:
   variables:
     EXAMPLE_CI_FILE: "sdkconfig.ci.p4_wifi"
+    IDF_REGISTRY_COMPONENT: "espressif/mqtt"
+    IDF_REGISTRY_COMPONENT_EXAMPLE: "tcp"
   rules:
     - !reference [.default_rules, rules]
-  extends: .build_template
+  extends: .build_template_mqtt_tcp_component
   image: espressif/idf:latest
   parallel:
     matrix:
       - IDF_TARGET: ["esp32p4"]
         IDF_SLAVE_TARGET: ["esp32c6", "esp32c5"]
-        IDF_EXAMPLE_PATH: ["examples/protocols/mqtt/tcp"]
 
 ### wifi/iperf example
 sanity_build_idf_v5.5_iperf:

.gitlab/ci/templates.yml

@@ -77,6 +77,70 @@
         idf-build-apps build -p . -vv --target ${IDF_TARGET}
       fi
 
+# build mqtt/tcp example from espressif/mqtt Registry Component
+.build_template_mqtt_tcp_component:
+  stage: build
+  tags:
+    - build
+  artifacts:
+    paths:
+      - "artifacts_*/"
+    when: always
+    expire_in: 4 days
+  script:
+    - export IDF_PYTHON_CHECK_CONSTRAINTS=yes
+    - ${IDF_PATH}/install.sh --enable-ci
+    - source ${IDF_PATH}/export.sh
+    # Need to rename the cloned "esp_hosted_mcu" directory since the injected component name is "esp_hosted"
+    - cd .. && rm -rf esp_hosted && mv esp_hosted_mcu esp_hosted && cd esp_hosted
+    - export OVERRIDE_PATH=`pwd`
+    # get the example from Component Registry
+    - echo "Checking out example ${IDF_REGISTRY_COMPONENT}:${IDF_REGISTRY_COMPONENT_EXAMPLE}"
+    - cd ..
+    - idf.py create-project-from-example "${IDF_REGISTRY_COMPONENT}:${IDF_REGISTRY_COMPONENT_EXAMPLE}"
+    - cd "${IDF_REGISTRY_COMPONENT_EXAMPLE}"
+    # Override esp_hosted component in example's deps with the one from the current repository
+    - mkdir components
+    - ln -sf ${OVERRIDE_PATH} components/esp_hosted
+    # Add slave target configuration if specified
+    - |
+      if [ ! -z "${IDF_SLAVE_TARGET}" ]; then
+        echo "CONFIG_SLAVE_IDF_TARGET_${IDF_SLAVE_TARGET^^}=y" >> sdkconfig.defaults
+        echo "Added slave target CONFIG_SLAVE_IDF_TARGET_${IDF_SLAVE_TARGET^^}=y to sdkconfig.defaults"
+      fi
+    # EXAMPLE_CI_FILE: use sdkconfig CI file in example directory
+    - |
+      if [ ! -z "${SDKCONFIG_CI_FILE}" ]; then
+        cp ${OVERRIDE_PATH}/${SDKCONFIG_CI_FILE} ./sdkconfig.ci.custom
+        echo "Using custom sdkconfig: ${SDKCONFIG_CI_FILE}"
+        SDKCONFIG_PATTERN="sdkconfig.ci.custom"
+      elif [ ! -z "${EXAMPLE_CI_FILE}" ]; then
+        echo "Using CI sdkconfig file in example: ${EXAMPLE_CI_FILE}"
+        SDKCONFIG_PATTERN="./${EXAMPLE_CI_FILE}"
+      else
+        SDKCONFIG_PATTERN="sdkconfig.ci*"
+      fi
+    - echo "SDKCONFIG_PATTERN is ${SDKCONFIG_PATTERN}"
+    # Build with IDF pedantic flags and IDF build apps script
+    - export PEDANTIC_FLAGS="-DIDF_CI_BUILD -Werror -Werror=deprecated-declarations -Werror=unused-variable -Werror=unused-but-set-variable -Werror=unused-function"
+    - export EXTRA_CFLAGS="${PEDANTIC_FLAGS} -Wstrict-prototypes"
+    - export EXTRA_CXXFLAGS="${PEDANTIC_FLAGS}"
+    # use --config-file to override default IDF config file
+    # use --enable-preview-targets to build for all targets
+    # use --override-sdkconfig-items to override (possibly incorrect) build target that may be in provided config file
+    - idf-build-apps find -p . --enable-preview-targets --config-file "${OVERRIDE_PATH}/.idf_build_apps.toml" --config ${SDKCONFIG_PATTERN} --override-sdkconfig-items=CONFIG_IDF_TARGET=${IDF_TARGET} -vv --target ${IDF_TARGET}
+    - idf-build-apps build -p . --enable-preview-targets --config-file "${OVERRIDE_PATH}/.idf_build_apps.toml" --config ${SDKCONFIG_PATTERN} --override-sdkconfig-items=CONFIG_IDF_TARGET=${IDF_TARGET} -vv --target ${IDF_TARGET}
+    # Copy config files back to project directory for artifacts
+    - mkdir -p ${OVERRIDE_PATH}/artifacts_${IDF_TARGET}_${IDF_SLAVE_TARGET}
+    - cp sdkconfig* ${OVERRIDE_PATH}/artifacts_${IDF_TARGET}_${IDF_SLAVE_TARGET}/ 2>/dev/null || echo "No sdkconfig files found"
+    - cp main/idf_component.yml ${OVERRIDE_PATH}/artifacts_${IDF_TARGET}_${IDF_SLAVE_TARGET}/ 2>/dev/null || echo "No component file found"
+    # Clean up the component symlink
+    - unlink components/esp_hosted
+    - echo "Cleaned up esp_hosted component symlink"
+    # Rename back, since post scripts expect the original name
+    - cd ${OVERRIDE_PATH} && cd .. && mv esp_hosted esp_hosted_mcu
+
+
 .build_template:
   stage: build
   tags:

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 2.7.0
+
+### Bug Fixes
+Restructured the ESP-Hosted-MCU commits
+
+## 2.6.6
+
+### Bug Fixes
+
+- Fixed sta connection to remove extra disconnected event if incoming station config is different from current station config
+- IRAM size limitation when using UART transport only applies to ESP32, not to all SOCs.
+- workaround a bug in `esp_wifi_get_protocol()` that can cause memory corruption. See this [ESP-IDF Issue](https://github.com/espressif/esp-idf/issues/17502).
+- updated CI pipelines to build mqtt/tcp example from Registry Component on master branch
+
 ## 2.6.5
 
 ### Features
@@ -8,7 +22,9 @@
 
 ## 2.6.4
 
-- Fix the esp_wifi_deinit() call from host
+### Bug Fixes
+
+- Fix the `esp_wifi_deinit()` call from host
 
 ## 2.6.3
 

slave/main/slave_control.c

@@ -58,6 +58,7 @@
 
 static wifi_config_t new_wifi_config = {0};
 static bool new_config_recvd = false;
+static bool suppress_disconnect = false; // true when we want to suppress the disconnect event
 static wifi_event_sta_connected_t lkg_sta_connected_event = {0};
 
 enum {
@@ -656,10 +657,10 @@ static void event_handler_wifi(void* arg, esp_event_base_t event_base,
 				int ret = esp_wifi_set_config(WIFI_IF_STA, &new_wifi_config);
 				if (ret) {
 					ESP_LOGE(TAG, "Error[0x%x] while setting the wifi config", ret);
-				} else {
-					new_config_recvd = 0;
 				}
 				esp_wifi_disconnect();
+				// suppress the disconnect event since we force disconnect here
+				suppress_disconnect = true;
 				return;
 			}
 			station_connecting = false;
@@ -669,22 +670,31 @@ static void event_handler_wifi(void* arg, esp_event_base_t event_base,
 			esp_wifi_internal_reg_rxcb(WIFI_IF_STA, (wifi_rxcb_t) wlan_sta_rx_callback);
 			station_connected = true;
 		} else if (event_id == WIFI_EVENT_STA_DISCONNECTED) {
-			station_connected = false;
+			ESP_LOGI(TAG, "Sta mode disconnect");
 			if (new_config_recvd) {
 				ESP_LOGI(TAG, "New wifi config still unapplied, applying it");
 				/* Still not applied new config, so apply it */
 				int ret = esp_wifi_set_config(WIFI_IF_STA, &new_wifi_config);
 				if (ret) {
 					ESP_LOGE(TAG, "Error[0x%x] while setting the wifi config", ret);
 				} else {
-					new_config_recvd = 0;
+					new_config_recvd = false;
 				}
+				station_connecting = true;
+				esp_wifi_connect();
 			}
+			station_connected = false;
 			esp_wifi_internal_reg_rxcb(WIFI_IF_STA, NULL);
-			ESP_LOGI(TAG, "Sta mode disconnect");
 			station_connecting = false;
-			send_event_data_to_host(RPC_ID__Event_StaDisconnected,
-				event_data, sizeof(wifi_event_sta_disconnected_t));
+			if (!suppress_disconnect) {
+				send_event_data_to_host(RPC_ID__Event_StaDisconnected,
+					event_data, sizeof(wifi_event_sta_disconnected_t));
+				wifi_event_sta_disconnected_t *ptr = (wifi_event_sta_disconnected_t *)event_data;
+				ESP_LOGI(TAG, "disconnect due to reason: %d", ptr->reason);
+			} else {
+				ESP_LOGI(TAG, "suppressing disconnect event due to new config");
+				suppress_disconnect = false;
+			}
 #if CONFIG_SOC_WIFI_HE_SUPPORT
 		} else if (event_id == WIFI_EVENT_ITWT_SETUP) {
 			ESP_LOGI(TAG, "Itwt Setup");
@@ -1238,7 +1248,7 @@ static esp_err_t req_wifi_connect(Rpc *req, Rpc *resp, void *priv_data)
 
 	if (new_config_recvd || !station_connected) {
 		ESP_LOGI(TAG, "************ connect ****************");
-		//station_connecting = true;
+		station_connecting = true;
 		ret = esp_wifi_connect();
 		if (ret != ESP_OK) {
 			ESP_LOGE(TAG, "Failed to connect to WiFi: %d", ret);
@@ -1286,7 +1296,7 @@ static bool wifi_is_provisioned(wifi_config_t *wifi_cfg)
 		ESP_LOGI(TAG, "Wifi provisioned");
 		return true;
 	}
-	ESP_LOGI(TAG, "Wifi not provisioned, Fallback to example config");
+	ESP_LOGI(TAG, "Wifi not provisioned");
 
 	return false;
 }
@@ -1342,16 +1352,26 @@ esp_err_t esp_hosted_set_sta_config(wifi_interface_t iface, wifi_config_t *cfg)
 			ESP_LOGW(TAG, "not provisioned and failed to set wifi config");
 		} else {
 			ESP_LOGI(TAG, "Provisioned new Wi-Fi config");
-			new_config_recvd = true;
-			station_connecting = false;
+			new_config_recvd = false;
+			return ESP_OK;
 		}
 	}
 
 	if (!is_wifi_config_equal(cfg, &current_config)) {
-		new_config_recvd = true;
-		station_connecting = false;
-		ESP_LOGI(TAG, "Setting new WiFi config SSID: %s", cfg->sta.ssid);
-		memcpy(&new_wifi_config, cfg, sizeof(wifi_config_t));
+		if (station_connecting) {
+			ESP_LOGI(TAG, "Caching new WiFi config SSID: %s", cfg->sta.ssid);
+			memcpy(&new_wifi_config, cfg, sizeof(wifi_config_t));
+			new_config_recvd = true;
+		} else {
+			if (esp_wifi_set_config(WIFI_IF_STA, cfg) != ESP_OK) {
+				ESP_LOGW(TAG, "already provisioned but failed to set wifi config: copying to cache instead");
+				memcpy(&new_wifi_config, cfg, sizeof(wifi_config_t));
+				new_config_recvd = true;
+			} else {
+				ESP_LOGI(TAG, "Setting new WiFi config SSID: %s", cfg->sta.ssid);
+				new_config_recvd = false;
+			}
+		}
 	} else {
 		ESP_LOGI(TAG, "WiFi config unchanged, keeping current connection");
 		new_config_recvd = false;
@@ -1804,8 +1824,12 @@ static esp_err_t req_wifi_get_protocol(Rpc *req, Rpc *resp, void *priv_data)
 			RpcReqWifiGetProtocol, req_wifi_get_protocol,
 			rpc__resp__wifi_get_protocol__init);
 
-	uint8_t protocol_bitmap = 0;
-	RPC_RET_FAIL_IF(esp_wifi_get_protocol(req_payload->ifx, &protocol_bitmap));
+	/** due to a bug in some ESP-IDF releases, esp_wifi_get_protocol() treats
+	 * the incoming pointer as a uint16_t *, corrupting the next byte
+	 * see https://github.com/espressif/esp-idf/issues/17502
+	 */
+	uint32_t protocol_bitmap = 0; // for safety
+	RPC_RET_FAIL_IF(esp_wifi_get_protocol(req_payload->ifx, (uint8_t *)&protocol_bitmap));
 
 	resp_payload->protocol_bitmap = protocol_bitmap;
 	return ESP_OK;

slave/main/uart_slave_api.c

@@ -41,12 +41,12 @@
 
 #if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)) && (ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(6, 0, 0))
 /**
- * For ESP-IDF v5.5, Building with UART Transport can fail due to
+ * For ESP-IDF v5.5, Building ESP32 with UART Transport can fail due to
  * lack of IRAM space.
  * To reduce IRAM usage, `CONFIG_RINGBUF_PLACE_FUNCTIONS_INTO_FLASH=y`
  * should be enabled
  */
-#if !CONFIG_RINGBUF_PLACE_FUNCTIONS_INTO_FLASH
+#if CONFIG_IDF_TARGET_ESP32 && !CONFIG_RINGBUF_PLACE_FUNCTIONS_INTO_FLASH
 #error Building for UART transport can fail due to lack of IRAM space
 #error To free up IRAM, enable Component config --> ESP Ringbuf ---> Place non-ISR ringbuf functions into flash
 #error or uncomment CONFIG_RINGBUF_PLACE_FUNCTIONS_INTO_FLASH=y in sdkconfig.defaults.esp32 and regenerate sdkconfig