Merge pull request #106 from stm32-rs/not-only-ref

Implement smoltcp::Device for owned EthernetDMA

Author: datdenkikniet

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## [0.8.2](https://github.com/stm32-rs/stm32-eth/tree/v0.8.2)
+* Implement `smoltcp::phy::Device` for non-borrowed `EthernetDMA` ([#106])
+
+[#106]: https://github.com/stm32-rs/stm32-eth/pull/106
+
 ## [0.8.1](https://github.com/stm32-rs/stm32-eth/tree/v0.8.1)
 * Fixed bug in `smoltcp::phy::Device` implementation that caused panics on RX errors ([#102])
 

Cargo.toml

@@ -4,7 +4,7 @@ name = "stm32-eth"
 description = "Embedded Rust Ethernet driver for the STM32 MCU series"
 license = "Apache-2.0"
 authors = ["Astro <astro@spaceboyz.net>", "Johannes Draaijer <jcdra1@gmail.com>"]
-version = "0.8.1"
+version = "0.8.2"
 keywords = ["ethernet", "eth", "stm32", "stm32f4", "stm32f7"]
 repository = "https://github.com/stm32-rs/stm32-eth"
 documentation = "https://docs.rs/stm32-eth/"

examples/ip.rs

@@ -66,7 +66,7 @@ fn main() -> ! {
     let ethernet_addr = EthernetAddress(SRC_MAC);
 
     let config = Config::new(ethernet_addr.into());
-    let mut iface = Interface::new(config, &mut &mut dma, Instant::ZERO);
+    let mut iface = Interface::new(config, &mut dma, Instant::ZERO);
 
     iface.update_ip_addrs(|addr| {
         addr.push(IpCidr::Ipv4(Ipv4Cidr::new(IP_ADDRESS, 24))).ok();
@@ -90,11 +90,7 @@ fn main() -> ! {
             *eth_pending = false;
         });
 
-        iface.poll(
-            Instant::from_millis(time as i64),
-            &mut &mut dma,
-            &mut sockets,
-        );
+        iface.poll(Instant::from_millis(time as i64), &mut dma, &mut sockets);
 
         let socket = sockets.get_mut::<TcpSocket>(server_handle);
 
@@ -112,7 +108,7 @@ fn main() -> ! {
                         // Poll to get the message out of the door
                         iface.poll(
                             Instant::from_millis(time as i64 + 1),
-                            &mut &mut dma,
+                            &mut dma,
                             &mut sockets,
                         );
                     }
@@ -122,11 +118,7 @@ fn main() -> ! {
                     socket.abort();
                     defmt::info!("Transmitted hello! Closing socket...");
 
-                    iface.poll(
-                        Instant::from_millis(time as i64),
-                        &mut &mut dma,
-                        &mut sockets,
-                    );
+                    iface.poll(Instant::from_millis(time as i64), &mut dma, &mut sockets);
                 }
                 Err(_) => {}
             }

examples/rtic-echo.rs

@@ -110,7 +110,7 @@ mod app {
 
         let config = iface::Config::new(EthernetAddress::from_bytes(&crate::MAC).into());
 
-        let mut interface = Interface::new(config, &mut &mut dma, smoltcp::time::Instant::ZERO);
+        let mut interface = Interface::new(config, &mut dma, smoltcp::time::Instant::ZERO);
         interface.update_ip_addrs(|addr| {
             addr.push(IpCidr::Ipv4(Ipv4Cidr::new(crate::IP_ADDRESS, 24)))
                 .ok();
@@ -123,7 +123,7 @@ mod app {
         let socket = sockets.get_mut::<TcpSocket>(tcp_handle);
         socket.listen(crate::SOCKET_ADDRESS).ok();
 
-        interface.poll(now_fn(), &mut &mut dma, &mut sockets);
+        interface.poll(now_fn(), &mut dma, &mut sockets);
 
         if let Ok(mut phy) = EthernetPhy::from_miim(mac, 0) {
             defmt::info!(

examples/smoltcp-timesync/client.rs

@@ -132,7 +132,7 @@ mod app {
 
         let cfg = Config::new(EthernetAddress(CLIENT_ADDR).into());
 
-        let mut interface = Interface::new(cfg, &mut &mut dma, smoltcp::time::Instant::ZERO);
+        let mut interface = Interface::new(cfg, &mut dma, smoltcp::time::Instant::ZERO);
         interface.update_ip_addrs(|a| {
             a.push(IpCidr::new(IpAddress::v4(10, 0, 0, 2), 24)).ok();
         });

examples/smoltcp-timesync/server.rs

@@ -100,7 +100,7 @@ mod app {
 
         let cfg = Config::new(EthernetAddress(SERVER_ADDR).into());
 
-        let mut interface = Interface::new(cfg, &mut &mut dma, smoltcp::time::Instant::ZERO);
+        let mut interface = Interface::new(cfg, &mut dma, smoltcp::time::Instant::ZERO);
         interface.update_ip_addrs(|a| {
             a.push(IpCidr::new(IpAddress::v4(10, 0, 0, 1), 24)).ok();
         });

src/dma/smoltcp_phy.rs

@@ -10,8 +10,32 @@ use super::PacketId;
 use smoltcp::phy::{ChecksumCapabilities, Device, DeviceCapabilities, RxToken, TxToken};
 use smoltcp::time::Instant;
 
+impl<'rx, 'tx, 'a> Device for &'a mut EthernetDMA<'rx, 'tx> {
+    type RxToken<'token>
+        = <EthernetDMA<'rx, 'tx> as Device>::RxToken<'token>
+    where
+        Self: 'token;
+
+    type TxToken<'token>
+        = <EthernetDMA<'rx, 'tx> as Device>::TxToken<'token>
+    where
+        Self: 'token;
+
+    fn receive(&mut self, timestamp: Instant) -> Option<(Self::RxToken<'_>, Self::TxToken<'_>)> {
+        <EthernetDMA<'rx, 'tx> as Device>::receive(self, timestamp)
+    }
+
+    fn transmit(&mut self, timestamp: Instant) -> Option<Self::TxToken<'_>> {
+        <EthernetDMA<'rx, 'tx> as Device>::transmit(self, timestamp)
+    }
+
+    fn capabilities(&self) -> DeviceCapabilities {
+        <EthernetDMA<'rx, 'tx> as Device>::capabilities(self)
+    }
+}
+
 /// Use this Ethernet driver with [smoltcp](https://github.com/smoltcp-rs/smoltcp)
-impl<'a, 'rx, 'tx> Device for &'a mut EthernetDMA<'rx, 'tx> {
+impl<'rx, 'tx> Device for EthernetDMA<'rx, 'tx> {
     type RxToken<'token>
         = EthRxToken<'token, 'rx>
     where