Add PTP timestamping

Author: datdenkikniet

.github/workflows/build.yml

@@ -31,7 +31,7 @@ jobs:
         toolchain:
           - stable
         features:
-          - stm32f745
+          - stm32f745,ptp
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
@@ -90,6 +90,33 @@ jobs:
         run: |
           cargo build --release --target=${{ matrix.target }} --features ${{ matrix.features }}
 
+  build-ptp:
+    name: build-no-ptp
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        target:
+          - x86_64-unknown-linux-gnu
+        toolchain:
+          - stable
+        features:
+          - stm32f107
+          - stm32f407
+          - stm32f745
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Rust ${{ matrix.toolchain }} with target (${{ matrix.target }})
+        run: |
+          rustup set profile minimal
+          rustup override set ${{ matrix.toolchain }}
+          rustup target add ${{ matrix.target }}
+
+      - name: cargo build
+        run: |
+          cargo build --release --target=${{ matrix.target }} --features ${{ matrix.features }} --no-default-features
+
   # Examples
   examples:
     name: examples

Cargo.toml

@@ -31,14 +31,15 @@ log = { version = "0.4", optional = true }
 defmt = { version = "0.3", optional = true }
 
 [dependencies.smoltcp]
-version = "0.8"
+version = "0.8.2"
 default-features = false
 optional = true
 
 [features]
-default = [ "defmt" ]
+default = [ "defmt", "ptp" ]
 device-selected = []
 fence = []
+ptp = [ ]
 
 stm32f107 = ["stm32f1xx-hal/stm32f107", "device-selected"]
 
@@ -89,6 +90,10 @@ required-features = [ "defmt" ]
 name = "rtic-echo"
 required-features = [ "defmt" , "smoltcp-phy" ]
 
+[[example]]
+name = "rtic-timestamp"
+required-features = [ "defmt", "ptp" ]
+
 [profile.release]
 debug = 2
 lto = true

README.md

@@ -63,9 +63,10 @@ fn main() {
         mac: p.ETHERNET_MAC,
         mmc: p.ETHERNET_MMC,
         dma: p.ETHERNET_DMA,
+        ptp: p.ETHERNET_PTP,
     };
 
-    let stm32_eth::Parts { dma: mut eth_dma, mac: _ } = stm32_eth::new(
+    let stm32_eth::Parts { dma: mut eth_dma, mac: _, ptp: _ } = stm32_eth::new(
         parts,
         &mut rx_ring[..],
         &mut tx_ring[..],
@@ -75,12 +76,12 @@ fn main() {
     .unwrap();
     eth_dma.enable_interrupt();
 
-    if let Ok(pkt) = eth_dma.recv_next() {
+    if let Ok(pkt) = eth_dma.recv_next(None) {
         // handle received pkt
     }
 
     let size = 42;
-    eth_dma.send(size, |buf| {
+    eth_dma.send(size, None, |buf| {
         // write up to `size` bytes into buf before it is being sent
     }).expect("send");
 }

examples/arp.rs

@@ -46,7 +46,12 @@ fn main() -> ! {
     let mut rx_ring: [RxRingEntry; 2] = Default::default();
     let mut tx_ring: [TxRingEntry; 2] = Default::default();
 
-    let Parts { mut dma, mac } = stm32_eth::new(
+    let Parts {
+        mut dma,
+        mac,
+        #[cfg(feature = "ptp")]
+            ptp: _,
+    } = stm32_eth::new(
         ethernet,
         &mut rx_ring[..],
         &mut tx_ring[..],
@@ -87,7 +92,7 @@ fn main() -> ! {
             const TARGET_MAC: [u8; 6] = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
             const TARGET_IP: [u8; 4] = [0x0A, 0x00, 0x00, 0x02]; // 10.0.0.2
 
-            let r = dma.send(SIZE, |buf| {
+            let r = dma.send(SIZE, None, |buf| {
                 buf[0..6].copy_from_slice(&DST_MAC);
                 buf[6..12].copy_from_slice(&SRC_MAC);
                 buf[12..14].copy_from_slice(&ETH_TYPE);

examples/common.rs

@@ -24,6 +24,8 @@ pub fn setup_peripherals(p: stm32_eth::stm32::Peripherals) -> (Clocks, Gpio, Par
         dma: p.ETHERNET_DMA,
         mac: p.ETHERNET_MAC,
         mmc: p.ETHERNET_MMC,
+        #[cfg(feature = "ptp")]
+        ptp: p.ETHERNET_PTP,
     };
 
     #[cfg(any(feature = "stm32f7xx-hal", feature = "stm32f4xx-hal"))]

examples/ip.rs

@@ -47,7 +47,12 @@ fn main() -> ! {
 
     let mut rx_ring: [RxRingEntry; 2] = Default::default();
     let mut tx_ring: [TxRingEntry; 2] = Default::default();
-    let Parts { mut dma, mac: _ } = stm32_eth::new(
+    let Parts {
+        mut dma,
+        mac: _,
+        #[cfg(feature = "ptp")]
+            ptp: _,
+    } = stm32_eth::new(
         ethernet,
         &mut rx_ring[..],
         &mut tx_ring[..],

examples/pktgen.rs

@@ -44,7 +44,12 @@ fn main() -> ! {
 
     let mut rx_ring: [RxRingEntry; 2] = Default::default();
     let mut tx_ring: [TxRingEntry; 2] = Default::default();
-    let Parts { mut dma, mac } = stm32_eth::new(
+    let Parts {
+        mut dma,
+        mac,
+        #[cfg(feature = "ptp")]
+            ptp: _,
+    } = stm32_eth::new(
         ethernet,
         &mut rx_ring[..],
         &mut tx_ring[..],
@@ -106,7 +111,7 @@ fn main() -> ! {
         // handle rx packet
         {
             let mut recvd = 0usize;
-            while let Ok(pkt) = dma.recv_next() {
+            while let Ok(pkt) = dma.recv_next(None) {
                 rx_bytes += pkt.len();
                 rx_pkts += 1;
                 pkt.free();
@@ -126,7 +131,7 @@ fn main() -> ! {
         const SIZE: usize = 1500;
         if phy.phy_link_up() {
             'egress: loop {
-                let r = dma.send(SIZE, |buf| {
+                let r = dma.send(SIZE, None, |buf| {
                     buf[0..6].copy_from_slice(&DST_MAC);
                     buf[6..12].copy_from_slice(&SRC_MAC);
                     buf[12..14].copy_from_slice(&ETH_TYPE);

examples/rtic-echo.rs

@@ -82,8 +82,12 @@ mod app {
 
         defmt::info!("Configuring ethernet");
 
-        let Parts { dma, mac } =
-            stm32_eth::new_with_mii(ethernet, rx_ring, tx_ring, clocks, pins, mdio, mdc).unwrap();
+        let Parts {
+            dma,
+            mac,
+            #[cfg(feature = "ptp")]
+                ptp: _,
+        } = stm32_eth::new_with_mii(ethernet, rx_ring, tx_ring, clocks, pins, mdio, mdc).unwrap();
 
         let dma = cx.local.dma.write(dma);