Merge pull request #45 from datdenkikniet/more_smi

Add `ieee802_3_miim` crate for MIIM support, and allow MAC to borrow or own Mii

Author: korken89

.github/workflows/build.yml

@@ -43,7 +43,7 @@ jobs:
         toolchain:
           - stable
         features:
-          - stm32f745,smi
+          - stm32f745
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
@@ -74,25 +74,25 @@ jobs:
         toolchain:
           - stable
         features:
-          - stm32f107,smi
-          - stm32f407,smi
-          - stm32f417,smi
-          - stm32f427,smi
-          - stm32f429,smi
-          - stm32f437,smi
-          - stm32f439,smi
-          - stm32f469,smi
-          - stm32f479,smi
-          - stm32f429,smi
-          - stm32f745,smi
-          - stm32f746,smi
-          - stm32f756,smi
-          - stm32f765,smi
-          - stm32f767,smi
-          - stm32f769,smi
-          - stm32f777,smi
-          - stm32f778,smi
-          - stm32f779,smi
+          - stm32f107
+          - stm32f407
+          - stm32f417
+          - stm32f427
+          - stm32f429
+          - stm32f437
+          - stm32f439
+          - stm32f469
+          - stm32f479
+          - stm32f429
+          - stm32f745
+          - stm32f746
+          - stm32f756
+          - stm32f765
+          - stm32f767
+          - stm32f769
+          - stm32f777
+          - stm32f778
+          - stm32f779
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -137,7 +137,7 @@ jobs:
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --example pktgen --features stm32f429,smi
+          args: --target=${{ matrix.target }} --example pktgen --features stm32f429
 
       - name: cargo build f4 example ip
         uses: actions-rs/cargo@v1
@@ -151,14 +151,14 @@ jobs:
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --example arp --features stm32f407,smi
+          args: --target=${{ matrix.target }} --example arp --features stm32f407
 
       - name: cargo build f4 example arp-smoltcp
         uses: actions-rs/cargo@v1
         with:
           use-cross: false
           command: build
-          args: --target=${{ matrix.target }} --example arp-smoltcp --features stm32f407,smi,smoltcp-phy,smoltcp/socket-icmp
+          args: --target=${{ matrix.target }} --example arp-smoltcp --features stm32f407,smoltcp-phy,smoltcp/socket-icmp
 
       - name: cargo build f1 example ip
         uses: actions-rs/cargo@v1

Cargo.toml

@@ -15,14 +15,15 @@ travis-ci = { repository = "astro/stm32-eth", branch = "master" }
 maintenance = { status = "experimental" }
 
 [package.metadata.docs.rs]
-features = ["smi", "smoltcp-phy", "stm32f429", "smoltcp/socket-tcp"]
+features = ["smoltcp-phy", "smoltcp/socket-raw", "stm32f429"]
 
 [dependencies]
 volatile-register = "0.2"
 aligned = "0.4"
 stm32f7xx-hal = { version = "0.7.0", optional = true }
 stm32f4xx-hal = { version = "0.13", optional = true }
 stm32f1xx-hal = { version = "0.9", optional = true }
+ieee802_3_miim = { version = "0.7", optional = true }
 cortex-m = "0.7"
 log = { version = "0.4", optional = true }
 
@@ -33,9 +34,9 @@ features = ["medium-ethernet", "proto-ipv4"]
 optional = true
 
 [features]
+default = [ "ieee802_3_miim" ]
 device-selected = []
 fence = []
-smi = []
 
 stm32f107 = ["stm32f1xx-hal/stm32f107", "device-selected"]
 
@@ -69,7 +70,7 @@ fugit = "0.3"
 
 [[example]]
 name = "pktgen"
-required-features = ["smi", "stm32f429"]
+required-features = ["stm32f429"]
 
 [[example]]
 name = "ip"
@@ -87,11 +88,11 @@ required-features = [
 
 [[example]]
 name = "arp"
-required-features = ["stm32f407", "smi"]
+required-features = ["stm32f407"]
 
 [[example]]
 name = "arp-smoltcp"
-required-features = ["stm32f407", "smi", "smoltcp-phy", "smoltcp/socket-icmp"]
+required-features = ["stm32f407", "smoltcp-phy", "smoltcp/socket-icmp"]
 
 [profile.release]
 debug = 2

examples/arp-smoltcp.rs

@@ -1,4 +1,4 @@
-// cargo build --example arp-smoltcp --features=stm32f407,smi,smoltcp-phy,smoltcp/socket-tcp,smoltcp/socket-icmp
+// cargo build --example arp-smoltcp --features=stm32f407,smoltcp-phy,smoltcp/socket-tcp,smoltcp/socket-icmp
 // This example uses the STM32F407 and the KSZ8051R as PHY. If necessary the pins,
 // the PHY register addresses and masks have to be adapted, as well as the IPs.
 // With Wireshark, you can see the ARP packets, which should look like this:
@@ -25,14 +25,11 @@ use smoltcp::wire::{
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    smi,
+    mac::{phy::BarePhy, Phy},
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 use stm32_eth::{EthPins, RingEntry, TxError};
 
-const PHY_REG_BSR: u8 = 0x01;
-const PHY_REG_BSR_UP: u16 = 1 << 2;
-
 const PHY_ADDR: u8 = 0;
 
 static TIME: Mutex<RefCell<usize>> = Mutex::new(RefCell::new(0));
@@ -75,7 +72,7 @@ fn main() -> ! {
 
     let mut rx_ring: [RingEntry<_>; 16] = Default::default();
     let mut tx_ring: [RingEntry<_>; 8] = Default::default();
-    let (mut eth_dma, mut eth_mac) = stm32_eth::new(
+    let (mut eth_dma, eth_mac) = stm32_eth::new(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,
@@ -89,8 +86,10 @@ fn main() -> ! {
 
     let mut last_link_up = false;
 
+    let mut bare_phy = BarePhy::new(eth_mac.with_mii(mdio, mdc), PHY_ADDR, Default::default());
+
     loop {
-        let link_up = link_detected(eth_mac.smi(&mut mdio, &mut mdc));
+        let link_up = bare_phy.phy_link_up();
 
         if link_up != last_link_up {
             if link_up {
@@ -179,12 +178,3 @@ fn ETH() {
     let p = unsafe { Peripherals::steal() };
     stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
 }
-
-fn link_detected<Mdio, Mdc>(smi: smi::Smi<Mdio, Mdc>) -> bool
-where
-    Mdio: smi::MdioPin,
-    Mdc: smi::MdcPin,
-{
-    let status = smi.read(PHY_ADDR, PHY_REG_BSR);
-    (status & PHY_REG_BSR_UP) == PHY_REG_BSR_UP
-}

examples/arp.rs

@@ -1,4 +1,4 @@
-// cargo build --example arp --features=stm32f407,smi
+// cargo build --example arp --features=stm32f407
 // This example uses the STM32F407 and the KSZ8051R as PHY. If necessary the pins,
 // the PHY register addresses and masks have to be adapted, as well as the IPs.
 // With Wireshark, you can see the ARP packets, which should look like this:
@@ -20,17 +20,14 @@ use fugit::RateExtU32;
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    smi,
+    mac::{phy::BarePhy, Phy},
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 
 use cortex_m_semihosting::hprintln;
 
 use stm32_eth::{EthPins, RingEntry, TxError};
 
-const PHY_REG_BSR: u8 = 0x01;
-const PHY_REG_BSR_UP: u16 = 1 << 2;
-
 const PHY_ADDR: u8 = 0;
 
 static TIME: Mutex<RefCell<usize>> = Mutex::new(RefCell::new(0));
@@ -73,7 +70,7 @@ fn main() -> ! {
 
     let mut rx_ring: [RingEntry<_>; 16] = Default::default();
     let mut tx_ring: [RingEntry<_>; 8] = Default::default();
-    let (mut eth_dma, mut eth_mac) = stm32_eth::new(
+    let (mut eth_dma, eth_mac) = stm32_eth::new(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,
@@ -87,8 +84,10 @@ fn main() -> ! {
 
     let mut last_link_up = false;
 
+    let mut bare_phy = BarePhy::new(eth_mac.with_mii(mdio, mdc), PHY_ADDR, Default::default());
+
     loop {
-        let link_up = link_detected(eth_mac.smi(&mut mdio, &mut mdc));
+        let link_up = bare_phy.phy_link_up();
 
         if link_up != last_link_up {
             if link_up {
@@ -177,12 +176,3 @@ fn ETH() {
     let p = unsafe { Peripherals::steal() };
     stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
 }
-
-fn link_detected<Mdio, Mdc>(smi: smi::Smi<Mdio, Mdc>) -> bool
-where
-    Mdio: smi::MdioPin,
-    Mdc: smi::MdcPin,
-{
-    let status = smi.read(PHY_ADDR, PHY_REG_BSR);
-    (status & PHY_REG_BSR_UP) == PHY_REG_BSR_UP
-}

examples/pktgen.rs

@@ -17,7 +17,7 @@ use fugit::RateExtU32;
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    smi,
+    mac::{phy::BarePhy, Phy},
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 
@@ -70,7 +70,7 @@ fn main() -> ! {
 
     let mut rx_ring: [RingEntry<_>; 16] = Default::default();
     let mut tx_ring: [RingEntry<_>; 8] = Default::default();
-    let (mut eth_dma, mut eth_mac) = stm32_eth::new(
+    let (mut eth_dma, eth_mac) = stm32_eth::new(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,
@@ -90,6 +90,8 @@ fn main() -> ! {
     let mut tx_pkts = 0usize;
     let mut last_link_up = false;
 
+    let mut phy = BarePhy::new(eth_mac.with_mii(mdio, mdc), PHY_ADDR, Default::default());
+
     loop {
         let time: usize = cortex_m::interrupt::free(|cs| *TIME.borrow(cs).borrow());
 
@@ -115,7 +117,7 @@ fn main() -> ! {
         }
 
         // Link change detection
-        let link_up = link_detected(eth_mac.smi(&mut mdio, &mut mdc));
+        let link_up = phy.phy_link_up();
         if link_up != last_link_up {
             if link_up {
                 writeln!(stdout, "Ethernet: no link detected").unwrap();
@@ -151,7 +153,7 @@ fn main() -> ! {
 
         // fill tx queue
         const SIZE: usize = 1500;
-        if link_detected(eth_mac.smi(&mut mdio, &mut mdc)) {
+        if phy.phy_link_up() {
             'egress: loop {
                 let r = eth_dma.send(SIZE, |buf| {
                     buf[0..6].copy_from_slice(&DST_MAC);
@@ -213,14 +215,3 @@ fn ETH() {
     let p = unsafe { Peripherals::steal() };
     stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
 }
-
-fn link_detected<Mdio, Mdc>(smi: smi::Smi<Mdio, Mdc>) -> bool
-where
-    Mdio: smi::MdioPin,
-    Mdc: smi::MdcPin,
-{
-    const STATUS_REG_ADDR: u8 = 0x3;
-    const STATUS_REG_UP_MASK: u16 = 1 << 2;
-    let status = smi.read(PHY_ADDR, STATUS_REG_ADDR);
-    (status & STATUS_REG_UP_MASK) == STATUS_REG_UP_MASK
-}