Station Management Interface -> Serial Managment Interface

Author: Johannes Draaijer

examples/arp-smoltcp.rs

@@ -25,7 +25,7 @@ use smoltcp::wire::{
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    mac::{MdcPin, MdioPin, Smi},
+    mac::{MdcPin, MdioPin, Smi, SerialManagement},
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 use stm32_eth::{EthPins, RingEntry, TxError};

examples/arp.rs

@@ -20,7 +20,7 @@ use fugit::RateExtU32;
 use stm32_eth::{
     hal::gpio::{GpioExt, Speed},
     hal::rcc::RccExt,
-    mac,
+    mac::{self, SerialManagement},
     stm32::{interrupt, CorePeripherals, Peripherals, SYST},
 };
 

src/lib.rs

@@ -135,7 +135,7 @@ where
 /// This method does not initialise the external PHY.
 ///
 /// The SMI for the external PHY can be accessed through the
-/// returned [`EthernetMACWithSmi`], which implements [`mac::StationManagement`].
+/// returned [`EthernetMACWithSmi`], which implements [`mac::SerialManagement`].
 ///
 /// # Note
 /// - Make sure that the buffers reside in a memory region that is
@@ -176,7 +176,7 @@ where
 ///
 /// This method does not initialise the external PHY. However it does return an
 /// [`EthernetMAC`] which implements the
-/// [`mac::StationManagement`] trait. This can be used to
+/// [`mac::SerialManagement`] trait. This can be used to
 /// communicate with the external PHY.
 ///
 /// # Note

src/mac/mod.rs

@@ -50,7 +50,7 @@ impl EthernetMAC {
 /// Ethernet media access control (MAC) with owned SMI
 ///
 /// This version of the struct owns it's SMI pins,
-/// allowing it to be used [`StationManagement`] directly.
+/// allowing it to be used [`SerialManagement`] directly.
 pub struct EthernetMACWithSmi<MDIO, MDC>
 where
     MDIO: MdioPin,
@@ -69,7 +69,7 @@ where
     /// Create a new EthernetMAC with owned MDIO and MDC pins.
     ///
     /// To interact with a connected Phy, use this struct's impl of
-    /// [`StationManagement`]
+    /// [`SerialManagement`]
     pub fn new(eth_mac: ETHERNET_MAC, mdio: MDIO, mdc: MDC) -> Self {
         Self { eth_mac, mdio, mdc }
     }
@@ -87,7 +87,7 @@ where
     }
 }
 
-impl<MDIO, MDC> StationManagement for EthernetMACWithSmi<MDIO, MDC>
+impl<MDIO, MDC> SerialManagement for EthernetMACWithSmi<MDIO, MDC>
 where
     MDIO: MdioPin,
     MDC: MdcPin,

src/mac/smi.rs

@@ -7,7 +7,7 @@ pub unsafe trait MdcPin {}
 
 /// A trait used for implementing access to SMI
 /// peripherals/functionality
-pub trait StationManagement {
+pub trait SerialManagement {
     /// Read an SMI register
     fn read(&self, phy: u8, reg: u8) -> u16;
     /// Write an SMI register
@@ -56,20 +56,18 @@ pub(crate) fn smi_read(iar: &MACMIIAR, dr: &MACMIIDR, phy: u8, reg: u8) -> u16 {
     dr.read().md().bits()
 }
 
-/// Station Management Interface
+/// Serial Management Interface
 ///
 /// Borrows [`MACMIIAR`] and [`MACMIIDR`] from (ETHERNET_MAC)[`crate::stm32::ETHERNET_MAC`], and holds a mutable borrow
 /// to the SMI pins.
-///
-/// Provides access to the MIIM implementation exposed by the MCU's MAC API.
 pub struct Smi<'eth, 'pins, Mdio, Mdc> {
     macmiiar: &'eth MACMIIAR,
     macmiidr: &'eth MACMIIDR,
     _mdio: &'pins mut Mdio,
     _mdc: &'pins mut Mdc,
 }
 
-impl<'eth, 'pins, Mdio, Mdc> StationManagement for Smi<'eth, 'pins, Mdio, Mdc>
+impl<'eth, 'pins, Mdio, Mdc> SerialManagement for Smi<'eth, 'pins, Mdio, Mdc>
 where
     Mdio: MdioPin,
     Mdc: MdcPin,

src/phy/lan87xxa.rs

@@ -1,7 +1,7 @@
 //! SMSC LAN87xxA (LAN8742A, LAN8720A) Ethernet PHYs
 use core::convert::TryFrom;
 
-use crate::{mac::StationManagement, LinkSpeed};
+use crate::{mac::SerialManagement, LinkSpeed};
 
 /// SMSC LAN8720A Ethernet PHY
 pub type LAN8720A<SMI> = LAN87xxA<SMI, false>;
@@ -67,7 +67,7 @@ pub struct LAN87xxA<S, const EXT_WUCSR_CLEAR: bool> {
 
 impl<S, const EXT_WUCSR_CLEAR: bool> LAN87xxA<S, EXT_WUCSR_CLEAR>
 where
-    S: StationManagement,
+    S: SerialManagement,
 {
     /// Create a new LAN87XXA based PHY
     pub fn new(smi: S, phy_addr: u8) -> Self {
@@ -162,15 +162,15 @@ where
         while !self.link_established() {}
     }
 
-    /// Release the underlying [`StationManagement`]
+    /// Release the underlying [`SerialManagement`]
     pub fn release(self) -> S {
         self.smi
     }
 }
 
 impl<S, const EXT_WUCSR_CLEAR: bool> super::Phy for LAN87xxA<S, EXT_WUCSR_CLEAR>
 where
-    S: StationManagement,
+    S: SerialManagement,
 {
     type LinkSpeed = Option<LinkSpeed>;