Fix examples

Make `mac` a bit more encapsulated to avoid polluting `lib` scope

Author: Johannes Draaijer

README.md

@@ -66,7 +66,7 @@ fn main() {
 
     let mut rx_ring: [RingEntry<_>; 16] = Default::default();
     let mut tx_ring: [RingEntry<_>; 8] = Default::default();
-    let (mut eth_dma, _eth_mac) = stm32_eth::new(
+    let (mut eth_dma, _eth_mac) = stm32_eth::new_no_smi(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,

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,7 +25,7 @@ use smoltcp::wire::{
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    smi,
+    mac::{MdcPin, MdioPin, Smi},
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 use stm32_eth::{EthPins, RingEntry, TxError};
@@ -75,7 +75,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, mut eth_mac) = stm32_eth::new_borrowed_smi(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,
@@ -180,10 +180,10 @@ fn ETH() {
     stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
 }
 
-fn link_detected<Mdio, Mdc>(smi: smi::Smi<Mdio, Mdc>) -> bool
+fn link_detected<Mdio, Mdc>(smi: Smi<Mdio, Mdc>) -> bool
 where
-    Mdio: smi::MdioPin,
-    Mdc: smi::MdcPin,
+    Mdio: MdioPin,
+    Mdc: 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,7 +20,7 @@ use fugit::RateExtU32;
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    smi,
+    mac,
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 
@@ -73,7 +73,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, mut eth_mac) = stm32_eth::new_borrowed_smi(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,
@@ -178,10 +178,10 @@ fn ETH() {
     stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
 }
 
-fn link_detected<Mdio, Mdc>(smi: smi::Smi<Mdio, Mdc>) -> bool
+fn link_detected<Mdio, Mdc>(smi: mac::Smi<Mdio, Mdc>) -> bool
 where
-    Mdio: smi::MdioPin,
-    Mdc: smi::MdcPin,
+    Mdio: mac::MdioPin,
+    Mdc: mac::MdcPin,
 {
     let status = smi.read(PHY_ADDR, PHY_REG_BSR);
     (status & PHY_REG_BSR_UP) == PHY_REG_BSR_UP

examples/ip-f107.rs

@@ -102,7 +102,7 @@ fn main() -> ! {
 
     let mut rx_ring: [RingEntry<_>; 8] = Default::default();
     let mut tx_ring: [RingEntry<_>; 2] = Default::default();
-    let (mut eth_dma, _eth_mac) = stm32_eth::new(
+    let (mut eth_dma, _eth_mac) = stm32_eth::new_no_smi(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,

examples/ip.rs

@@ -85,7 +85,7 @@ fn main() -> ! {
 
     let mut rx_ring: [RingEntry<_>; 8] = Default::default();
     let mut tx_ring: [RingEntry<_>; 2] = Default::default();
-    let (mut eth_dma, _eth_mac) = stm32_eth::new(
+    let (mut eth_dma, _eth_mac) = stm32_eth::new_no_smi(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,

examples/pktgen.rs

@@ -17,7 +17,7 @@ use fugit::RateExtU32;
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    smi,
+    mac,
     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, mut eth_mac) = stm32_eth::new_borrowed_smi(
         p.ETHERNET_MAC,
         p.ETHERNET_MMC,
         p.ETHERNET_DMA,
@@ -214,10 +214,10 @@ fn ETH() {
     stm32_eth::eth_interrupt_handler(&p.ETHERNET_DMA);
 }
 
-fn link_detected<Mdio, Mdc>(smi: smi::Smi<Mdio, Mdc>) -> bool
+fn link_detected<Mdio, Mdc>(smi: mac::Smi<Mdio, Mdc>) -> bool
 where
-    Mdio: smi::MdioPin,
-    Mdc: smi::MdcPin,
+    Mdio: mac::MdioPin,
+    Mdc: mac::MdcPin,
 {
     const STATUS_REG_ADDR: u8 = 0x3;
     const STATUS_REG_UP_MASK: u16 = 1 << 2;

src/lib.rs

@@ -30,8 +30,8 @@ use stm32::{Interrupt, ETHERNET_DMA, ETHERNET_MAC, ETHERNET_MMC, NVIC};
 mod ring;
 pub use ring::RingEntry;
 mod desc;
-mod mac;
-pub use mac::*;
+pub mod mac;
+pub use mac::EthernetMAC;
 mod rx;
 pub use rx::{RxDescriptor, RxError, RxRingEntry};
 use rx::{RxPacket, RxRing};
@@ -131,8 +131,8 @@ macro_rules! new {
     };
 }
 
-new!(new_no_smi, NoSmi);
-new!(new_borrowed_smi, BorrowedSmi);
+new!(new_no_smi, mac::NoSmi);
+new!(new_borrowed_smi, mac::BorrowedSmi);
 
 /// Create and initialise the ethernet driver.
 ///
@@ -177,12 +177,12 @@ where
     TXD1: RmiiTxD1 + AlternateVeryHighSpeed,
     RXD0: RmiiRxD0 + AlternateVeryHighSpeed,
     RXD1: RmiiRxD1 + AlternateVeryHighSpeed,
-    MDIO: MdioPin,
-    MDC: MdcPin,
+    MDIO: mac::MdioPin,
+    MDC: mac::MdcPin,
 {
     pins.setup_pins();
 
-    let eth_mac = EthernetMAC::<OwnedSmi<MDIO, MDC>>::new(eth_mac, mdio, mdc);
+    let eth_mac = EthernetMAC::<mac::OwnedSmi<MDIO, MDC>>::new(eth_mac, mdio, mdc);
 
     unsafe { new_unchecked(eth_mac, eth_mmc, eth_dma, rx_buffer, tx_buffer, clocks) }
 }