Merge pull request #75 from stm32-rs/async-await

Async await

Author: datdenkikniet

.github/workflows/build.yml

@@ -9,6 +9,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
+  RUSTFLAGS: "-D warnings"
 
 jobs:
   style:
@@ -90,16 +91,21 @@ jobs:
         run: |
           cargo build --release --target=${{ matrix.target }} --features ${{ matrix.features }}
 
-  build-no-ptp:
-    name: build-no-ptp
+  build-feature-mixer:
+    name: build-feature-mixer
     runs-on: ubuntu-20.04
     strategy:
       matrix:
         target:
           - x86_64-unknown-linux-gnu
+        features:
+          - "ptp,async-await"
+          - "ptp"
+          - "async-await"
+          - ""
         toolchain:
           - stable
-        features:
+        mcu:
           - stm32f107
           - stm32f407
           - stm32f745
@@ -115,7 +121,7 @@ jobs:
 
       - name: cargo build
         run: |
-          cargo build --release --target=${{ matrix.target }} --features ${{ matrix.features }} --no-default-features
+          cargo build --release --target=${{ matrix.target }} --features "${{ matrix.mcu }}" --features "${{ matrix.features }}" --no-default-features
 
   # Test that all of the examples compile
   # for stm32f429
@@ -204,7 +210,7 @@ jobs:
       - test
       - examples
       - examples-common
-      - build-no-ptp
+      - build-feature-mixer
     runs-on: ubuntu-20.04
     steps:
       - name: Mark the job as a success

CHANGELOG.md

@@ -1,18 +1,32 @@
 ## Unreleased
-* Update to `smoltcp` v0.9 ([#71](https://github.com/stm32-rs/stm32-eth/pull/71))
-* Add `timesync-server` and `timesync-client` examples ([#72](https://github.com/stm32-rs/stm32-eth/pull/72))
+* Update to `smoltcp` v0.9 ([#71])
+* Add `timesync-server` and `timesync-client` examples ([#72])
+* Remove argument from `eth_interrupt_handler` ([#75], fixes [#44])
+* [#75]
+    * Make EthernetDMA drop safe
+    * Add `EthernetDMA::split`: support for using RX and TX independently
+    * Make the interrupt handler methods and `EthernetPTP::get_time` static FNs
+    * Add feature `async-await`, used for accessing RX and/or TX asynchronously, as well as the ethernet PTP timestamp interrupt
+    * Add `async-rtic-timestamp` exmaple (nightly only)
+
+[#44]: https://github.com/stm32-rs/stm32-eth/issues/44
+[#71]: https://github.com/stm32-rs/stm32-eth/pull/71
+[#72]: https://github.com/stm32-rs/stm32-eth/pull/72
+[#75]: https://github.com/stm32-rs/stm32-eth/pull/75
 
 ## [0.4.1](https://github.com/stm32-rs/stm32-eth/tree/v0.4.1)
-* Fix a bug when caching timestamps in the TX path ([#73](https://github.com/stm32-rs/stm32-eth/pull/73))
+* Fix a bug when caching timestamps in the TX path ([#73])
+
+[#73]: https://github.com/stm32-rs/stm32-eth/pull/73
 
 ## [0.4.0](https://github.com/stm32-rs/stm32-eth/tree/v0.4.0)
-* Remove the `smi` feature and always enable miim/smi. Use `ieee802_3_miim` for SMI access [#45](https://github.com/stm32-rs/stm32-eth/pull/45)
+* Remove the `smi` feature and always enable miim/smi. Use `ieee802_3_miim` for SMI access ([#45])
 * Update stm32f1xx-hal and stm32f4xx-hal to their latests version as of 15-12-2022.
-* Allow for configuration of MAC speed. ([#53](https://github.com/stm32-rs/stm32-eth/pull/53), fixes [#24](https://github.com/stm32-rs/stm32-eth/pull/24))
-* Fix [#57](https://github.com/stm32-rs/stm32-eth/issues/57). ([#58](https://github.com/stm32-rs/stm32-eth/pull/58))
-* Move all DMA related files into modules under `dma` ([#66](https://github.com/stm32-rs/stm32-eth/pull/66))
-* Add support for the PTP peripheral ([#66](https://github.com/stm32-rs/stm32-eth/pull/66))
-* Use `PartsIn` and `Parts` as structs for initalization & configuration ([#66](https://github.com/stm32-rs/stm32-eth/pull/66))
+* Allow for configuration of MAC speed. ([#53], fixes [#24])
+* Fix [#57](https://github.com/stm32-rs/stm32-eth/issues/57). ([#58])
+* Move all DMA related files into modules under `dma` ([#66])
+* Add support for the PTP peripheral ([#66])
+* Use `PartsIn` and `Parts` as structs for initalization & configuration ([#66])
 * CI
     * Test compilability of examples more extensively
     * Move away from actions-rs
@@ -26,10 +40,22 @@
     * Use a more simple `memory.x` that works for all supported MCUs
     * Add `rtic-timestamp` example
 
+[#45]: https://github.com/stm32-rs/stm32-eth/pull/45
+[#24]: https://github.com/stm32-rs/stm32-eth/pull/24
+[#53]: https://github.com/stm32-rs/stm32-eth/pull/53
+[#58]: https://github.com/stm32-rs/stm32-eth/pull/58
+[#66]: https://github.com/stm32-rs/stm32-eth/pull/66
+
 ## [0.3.0](https://github.com/stm32-rs/stm32-eth/tree/v0.3.0)
 
-* Enable ICMP, TCP, and UDP checksum offloading for IPv4 and IPv6. ([#48](https://github.com/stm32-rs/stm32-eth/pull/48))
-* Separate MAC and DMA into separate structs for separate access. ([#39](https://github.com/stm32-rs/stm32-eth/pull/39))
-* Add support for `stm32f107` and fix an MMC interrupt bug. ([#43](https://github.com/stm32-rs/stm32-eth/pull/43), [#42](https://github.com/stm32-rs/stm32-eth/pull/42), [#41](https://github.com/stm32-rs/stm32-eth/pull/41))
+* Enable ICMP, TCP, and UDP checksum offloading for IPv4 and IPv6. ([#48])
+* Separate MAC and DMA into separate structs for separate access. ([#39])
+* Add support for `stm32f107` and fix an MMC interrupt bug. ([#43], [#42], [#41])
 * Update the HALs and dependencies to their latest versions as of 12-07-2022.
 * Add more examples
+
+[#48]: https://github.com/stm32-rs/stm32-eth/pull/48
+[#39]: https://github.com/stm32-rs/stm32-eth/pull/39
+[#43]: https://github.com/stm32-rs/stm32-eth/pull/43
+[#42]: https://github.com/stm32-rs/stm32-eth/pull/42
+[#41]: https://github.com/stm32-rs/stm32-eth/pull/41

Cargo.toml

@@ -16,7 +16,7 @@ travis-ci = { repository = "astro/stm32-eth", branch = "master" }
 maintenance = { status = "experimental" }
 
 [package.metadata.docs.rs]
-features = ["smoltcp-phy", "smoltcp/socket-raw", "stm32f429"]
+features = ["smoltcp-phy", "stm32f429", "async-await"]
 
 [dependencies]
 volatile-register = "0.2"
@@ -29,6 +29,7 @@ ieee802_3_miim = "0.8"
 cortex-m = "0.7"
 log = { version = "0.4", optional = true }
 defmt = { version = "0.3", optional = true }
+futures = { version = "0.3", default-features = false, features = ["async-await"], optional = true }
 
 [dependencies.smoltcp]
 version = "0.9"
@@ -40,6 +41,7 @@ default = [ "defmt", "ptp" ]
 device-selected = []
 fence = []
 ptp = [ ]
+async-await = ["dep:futures"]
 
 stm32f107 = ["stm32f1xx-hal/stm32f107", "device-selected"]
 
@@ -68,12 +70,30 @@ smoltcp-phy = ["smoltcp"]
 cortex-m = { version = "0.7", features = ["critical-section-single-core"] }
 cortex-m-rt = "0.7"
 fugit = "0.3"
-cortex-m-rtic = "1.0"
 defmt-rtt = "0.4"
 panic-probe = { version = "0.3", features = [ "print-defmt" ] }
 systick-monotonic = "1.0"
 smoltcp = { version = "0.9", features = [ "medium-ethernet", "proto-ipv4", "socket-udp", "socket-tcp", "defmt" ], default-features = false }
 
+[dev-dependencies.rtic]
+package = "cortex-m-rtic"
+version = "1.0"
+
+[dev-dependencies.async-rtic]
+package = "rtic"
+git = "https://github.com/rtic-rs/cortex-m-rtic.git"
+rev = "364edb707ebf7baa2e7bdd1b1e6b02156d7b5569"
+
+[dev-dependencies.rtic-arbiter]
+package = "rtic-arbiter"
+git = "https://github.com/rtic-rs/cortex-m-rtic.git"
+rev = "364edb707ebf7baa2e7bdd1b1e6b02156d7b5569"
+
+[dev-dependencies.rtic-channel]
+package = "rtic-channel"
+git = "https://github.com/rtic-rs/cortex-m-rtic.git"
+rev = "364edb707ebf7baa2e7bdd1b1e6b02156d7b5569"
+
 # This isn't an actual example. It just exists so we can easily
 # test the common items :)
 [[example]]
@@ -110,6 +130,10 @@ name = "timesync-server"
 path = "./examples/timesync/server.rs"
 required-features = [ "defmt", "ptp" ]
 
+[[example]]
+name = "async-rtic-timestamp"
+required-features = [ "defmt", "ptp", "async-await" ]
+
 [profile.release]
 debug = 2
 lto = true

README.md

@@ -76,14 +76,22 @@ fn main() {
     .unwrap();
     eth_dma.enable_interrupt();
 
-    if let Ok(pkt) = eth_dma.recv_next(None) {
-        // handle received pkt
+    loop {
+        if let Ok(pkt) = eth_dma.recv_next(None) {
+            // handle received pkt
+        }
+
+        let size = 42;
+        eth_dma.send(size, None, |buf| {
+            // write up to `size` bytes into buf before it is being sent
+        }).expect("send");
     }
+}
 
-    let size = 42;
-    eth_dma.send(size, None, |buf| {
-        // write up to `size` bytes into buf before it is being sent
-    }).expect("send");
+use stm32_eth::stm32::interrupt;
+#[interrupt]
+fn ETH() {
+    stm32_eth::eth_interrupt_handler();
 }
 ```
 

examples/arp.rs

@@ -147,7 +147,5 @@ fn ETH() {
         *eth_pending = true;
     });
 
-    // Clear interrupt flags
-    let p = unsafe { Peripherals::steal() };
-    stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
+    stm32_eth::eth_interrupt_handler();
 }