Merge branch 'master' into feat/mqtt5-connect-properties

Author: ivmarkov

.github/workflows/ci-esp-idf-next.yml

@@ -26,6 +26,7 @@ jobs:
           - xtensa-esp32s3-espidf
         idf-version:
           - release/v6.0
+          - release/v6.1
           - master
     steps:
       - name: Setup | Checkout

CHANGELOG.md

@@ -8,6 +8,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Breaking
+- MQTT: `MqttProtocolVersion::V5` variant and [`Mqtt5ConnectionPropertyConfig`] struct exposing MQTT 5.0 CONNECT properties (session/will/message expiry intervals, receive/packet/topic-alias maxima, request-response/problem info, payload format indicator). Gated on `CONFIG_MQTT_PROTOCOL_5=y`. To negotiate MQTT 5 and set properties:
+  ```rust
+  MqttClientConfiguration {
+      protocol_version: Some(MqttProtocolVersion::V5),
+      mqtt5_connection_property: Some(Mqtt5ConnectionPropertyConfig {
+          session_expiry_interval: Some(60),
+          ..Default::default()
+      }),
+      ..Default::default()
+  }
+  ```
 - HTTP: Add `keep_alive: Option<KeepAlive>` and `so_linger: Option<Duration>` to server `Configuration`
 - New events need to be handled in the WiFi event loop:
   - `WifiEvent::StaNeighborRep` / `StaNeighborRepRef` (v5.3.0+)
@@ -27,19 +38,11 @@ remote_component = { name = "espressif/lan87xx", version = "1.*" }
 - WiFi: receiving any of the six new events listed above on ESP-IDF v5.3+ / v5.5+ no longer causes a panic (fixes #618)
 - WebSocket: `EspWebSocketClient::drop()` no longer panics when `esp_websocket_client_close` returns `ESP_FAIL` (e.g. after a network disconnection); errors are now logged instead of unwrapped
 - MQTT: MQTT 5.0 CONNECT properties can now be set on `EspMqttClient` without deadlocking on `MQTT_API_LOCK`; they are applied inside the library between `esp_mqtt_client_init` and `esp_mqtt_client_start` via the new [`MqttClientConfiguration::mqtt5_connection_property`] field.
+- BT: Fixed panic when an A2DP sink disconnects from the ESP while streaming audio.
+- Thread: `scan`, `energy_scan` and the IPv6 receive callbacks no longer pass the wrong context pointer to OpenThread (the closure box instead of the `ThreadDriverInner`), fixing a type-confusion crash when the callbacks fire.
+- Ethernet: `mod eth` is enabled again on ESP-IDF 6.0+ when SPI Ethernet PHYs are provided as managed components (`espressif/w5500`, `espressif/dm9051`, `espressif/ksz8851snl`), not only via the removed in-tree `CONFIG_ETH_SPI_ETHERNET_*` Kconfig options
 
 ### Added
-- MQTT: `MqttProtocolVersion::V5` variant and [`Mqtt5ConnectionPropertyConfig`] struct exposing MQTT 5.0 CONNECT properties (session/will/message expiry intervals, receive/packet/topic-alias maxima, request-response/problem info, payload format indicator). Gated on `CONFIG_MQTT_PROTOCOL_5=y`. To negotiate MQTT 5 and set properties:
-  ```rust
-  MqttClientConfiguration {
-      protocol_version: Some(MqttProtocolVersion::V5),
-      mqtt5_connection_property: Some(Mqtt5ConnectionPropertyConfig {
-          session_expiry_interval: Some(60),
-          ..Default::default()
-      }),
-      ..Default::default()
-  }
-  ```
 - Compatibility with ESP-IDF V6.0, and some pre-release 6.0.x.
 - Added support for the Generic Ethernet PHY driver: particularly useful on ESP-IDF 6.0+ as it is built-in.
 

src/bt/a2dp.rs

@@ -455,6 +455,9 @@ where
     }
 
     unsafe extern "C" fn source_data_handler(buf: *mut u8, len: i32) -> i32 {
+        if buf.is_null() || len <= 0 {
+            return 0; // nothing to read; matches the "bytes provided" contract
+        }
         let event = A2dpEvent::SourceData(core::slice::from_raw_parts_mut(buf, len as _));
         trace!("Got event {{ {:#?} }}", event);
 

src/eth.rs

@@ -14,7 +14,11 @@ use embedded_svc::eth::*;
     any(
         esp_idf_eth_spi_ethernet_dm9051,
         esp_idf_eth_spi_ethernet_w5500,
-        esp_idf_eth_spi_ethernet_ksz8851snl
+        esp_idf_eth_spi_ethernet_ksz8851snl,
+        // ESP-IDF 6.0+ managed components
+        esp_idf_comp_espressif__dm9051_enabled,
+        esp_idf_comp_espressif__w5500_enabled,
+        esp_idf_comp_espressif__ksz8851snl_enabled,
     )
 ))]
 use crate::hal::gpio;

src/lib.rs

@@ -48,13 +48,18 @@ pub mod espnow;
     esp_idf_comp_esp_event_enabled,
 ))]
 #[cfg(any(
+    // On-chip EMAC (ESP32); RMII PHYs such as lan87xx are used only with EMAC
     all(esp32, esp_idf_eth_use_esp32_emac),
     any(
         esp_idf_eth_spi_ethernet_dm9051,
         esp_idf_eth_spi_ethernet_w5500,
-        esp_idf_eth_spi_ethernet_ksz8851snl
+        esp_idf_eth_spi_ethernet_ksz8851snl,
+        // ESP-IDF 6.0+ ships SPI Ethernet PHYs as managed components
+        esp_idf_comp_espressif__dm9051_enabled,
+        esp_idf_comp_espressif__w5500_enabled,
+        esp_idf_comp_espressif__ksz8851snl_enabled,
     ),
-    esp_idf_eth_use_openeth
+    esp_idf_eth_use_openeth,
 ))]
 pub mod eth;
 #[cfg(all(feature = "alloc", esp_idf_comp_esp_event_enabled))]

src/thread.rs

@@ -488,22 +488,28 @@ impl<'d> ThreadDriver<'d, Host> {
         }
 
         #[allow(clippy::type_complexity)]
-        let mut callback: Box<Box<dyn FnMut(Option<ActiveScanResult>) + Send + 'static>> =
+        let callback: Box<Box<dyn FnMut(Option<ActiveScanResult>) + Send + 'static>> =
             Box::new(Box::new(callback));
 
-        ot_esp!(unsafe {
+        // Store callback where on_active_scan_result can get to it
+        inner.scan_cb = Some(callback);
+
+        match ot_esp!(unsafe {
             otLinkActiveScan(
                 esp_openthread_get_instance(),
                 0xffff_ffffu32, // All channels
                 200,            // ms scan per channel
                 Some(Self::on_active_scan_result),
-                callback.as_mut() as *mut _ as *mut c_void,
+                &mut *inner as *mut ThreadDriverInner as *mut c_void,
             )
-        })?;
-
-        inner.scan_cb = Some(callback);
-
-        Ok(())
+        }) {
+            Ok(()) => Ok(()),
+            Err(err) => {
+                // Clean up inner if we fail to start the scan
+                inner.scan_cb = None;
+                Err(err)
+            }
+        }
     }
 
     /// Check if an active scan is in progress
@@ -528,22 +534,28 @@ impl<'d> ThreadDriver<'d, Host> {
         }
 
         #[allow(clippy::type_complexity)]
-        let mut callback: Box<Box<dyn FnMut(Option<EnergyScanResult>) + Send + 'static>> =
+        let callback: Box<Box<dyn FnMut(Option<EnergyScanResult>) + Send + 'static>> =
             Box::new(Box::new(callback));
 
-        ot_esp!(unsafe {
+        // Store callback where on_energy_scan_result can get to it
+        inner.energy_cb = Some(callback);
+
+        match ot_esp!(unsafe {
             otLinkEnergyScan(
                 esp_openthread_get_instance(),
                 0xffff_ffffu32, // All channels
                 200,            // ms scan per channel
                 Some(Self::on_energy_scan_result),
-                callback.as_mut() as *mut _ as *mut c_void,
+                &mut *inner as *mut ThreadDriverInner as *mut c_void,
             )
-        })?;
-
-        inner.energy_cb = Some(callback);
-
-        Ok(())
+        }) {
+            Ok(()) => Ok(()),
+            Err(err) => {
+                // Clean up inner if we fail to start the scan
+                inner.energy_cb = None;
+                Err(err)
+            }
+        }
     }
 
     /// Check if an energy scan is in progress
@@ -632,23 +644,22 @@ impl<'d> ThreadDriver<'d, Host> {
                 Box::new(Box::new(callback));
 
             #[allow(clippy::type_complexity)]
-            let mut callback: Box<Box<dyn FnMut(Ipv6Incoming) + Send + 'static>> =
+            let callback: Box<Box<dyn FnMut(Ipv6Incoming) + Send + 'static>> =
                 unsafe { core::mem::transmute(callback) };
 
-            let callback_ptr = callback.as_mut() as *mut _ as *mut c_void;
-
+            // Stick the callback where Self::on_address/Self::on_packet can get to it
             inner.ipv6_cb = Some(callback);
 
             unsafe {
                 otIp6SetAddressCallback(
                     esp_openthread_get_instance(),
                     Some(Self::on_address),
-                    callback_ptr,
+                    &mut *inner as *mut ThreadDriverInner as *mut c_void,
                 );
                 otIp6SetReceiveCallback(
                     esp_openthread_get_instance(),
                     Some(Self::on_packet),
-                    callback_ptr,
+                    &mut *inner as *mut ThreadDriverInner as *mut c_void,
                 );
                 otIp6SetReceiveFilterEnabled(esp_openthread_get_instance(), true);