More docs

Author: Johannes Draaijer

examples/arp-smoltcp.rs

@@ -86,7 +86,7 @@ fn main() -> ! {
 
     let mut last_link_up = false;
 
-    let mut bare_phy = BarePhy::new(eth_mac.with_smi(mdio, mdc), PHY_ADDR, Default::default());
+    let mut bare_phy = BarePhy::new(eth_mac.with_mii(mdio, mdc), PHY_ADDR, Default::default());
 
     loop {
         let link_up = bare_phy.phy_link_up();

examples/arp.rs

@@ -84,7 +84,7 @@ fn main() -> ! {
 
     let mut last_link_up = false;
 
-    let mut bare_phy = BarePhy::new(eth_mac.with_smi(mdio, mdc), PHY_ADDR, Default::default());
+    let mut bare_phy = BarePhy::new(eth_mac.with_mii(mdio, mdc), PHY_ADDR, Default::default());
 
     loop {
         let link_up = bare_phy.phy_link_up();

examples/pktgen.rs

@@ -90,7 +90,7 @@ fn main() -> ! {
     let mut tx_pkts = 0usize;
     let mut last_link_up = false;
 
-    let mut phy = BarePhy::new(eth_mac.with_smi(mdio, mdc), PHY_ADDR, Default::default());
+    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());

src/lib.rs

@@ -1,6 +1,6 @@
 //! An abstraction layer for ethernet periperhals embedded in STM32 processors.
 //!
-//! For initialisation, see [`new`], and [`new_with_smi`]
+//! For initialisation, see [`new`], and [`new_with_mii`]
 #![no_std]
 
 /// Re-export
@@ -103,15 +103,15 @@ where
 ///
 /// This method does not initialise the external PHY.
 ///
-/// The SMI for the external PHY can be accessed through the
+/// The MII for the external PHY can be accessed through the
 /// returned [`EthernetMACWithMii`], .
 ///
 /// # Note
 /// - Make sure that the buffers reside in a memory region that is
 /// accessible by the peripheral. Core-Coupled Memory (CCM) is
 /// usually not accessible.
 /// - HCLK must be at least 25 MHz.
-pub fn new_with_smi<'rx, 'tx, REFCLK, CRS, TXEN, TXD0, TXD1, RXD0, RXD1, MDIO, MDC>(
+pub fn new_with_mii<'rx, 'tx, REFCLK, CRS, TXEN, TXD0, TXD1, RXD0, RXD1, MDIO, MDC>(
     eth_mac: ETHERNET_MAC,
     eth_mmc: ETHERNET_MMC,
     eth_dma: ETHERNET_DMA,
@@ -133,7 +133,7 @@ where
     MDIO: mac::MdioPin,
     MDC: mac::MdcPin,
 {
-    let mac = EthernetMAC::new(eth_mac, eth_mmc, clocks, pins)?.with_smi(mdio, mdc);
+    let mac = EthernetMAC::new(eth_mac, eth_mmc, clocks, pins)?.with_mii(mdio, mdc);
 
     let dma = EthernetDMA::new(&mac, eth_dma, rx_buffer, tx_buffer);
 

src/mac/miim.rs

@@ -99,7 +99,7 @@ where
     Mdio: MdioPin,
     Mdc: MdcPin,
 {
-    /// Create a temporary `Smi` instance.
+    /// Create a temporary [`Stm32Mii`] instance.
     ///
     /// Temporarily take exclusive access to the MDIO and MDC pins to ensure they are not used
     /// elsewhere for the duration of SMI communication.

src/mac/mod.rs

@@ -150,8 +150,8 @@ impl EthernetMAC {
     /// pins.
     ///
     /// Exclusive access to the `MDIO` and `MDC` is required to ensure that are not used elsewhere
-    /// for the duration of SMI communication.
-    pub fn smi<'eth, 'pins, Mdio, Mdc>(
+    /// for the duration of Mii communication.
+    pub fn mii<'eth, 'pins, Mdio, Mdc>(
         &'eth mut self,
         mdio: &'pins mut Mdio,
         mdc: &'pins mut Mdc,
@@ -164,7 +164,7 @@ impl EthernetMAC {
     }
 
     /// Turn this [`EthernetMAC`] into an [`EthernetMACWithMii`]
-    pub fn with_smi<MDIO, MDC>(self, mdio: MDIO, mdc: MDC) -> EthernetMACWithMii<MDIO, MDC>
+    pub fn with_mii<MDIO, MDC>(self, mdio: MDIO, mdc: MDC) -> EthernetMACWithMii<MDIO, MDC>
     where
         MDIO: MdioPin,
         MDC: MdcPin,
@@ -177,9 +177,9 @@ impl EthernetMAC {
     }
 }
 
-/// Ethernet media access control (MAC) with owned SMI
+/// Ethernet media access control (MAC) with owned MII
 ///
-/// This version of the struct owns it's SMI pins,
+/// This version of the struct owns it's MII pins,
 /// allowing it to be used directly, instead of requiring
 /// that a  [`Miim`] is created.
 pub struct EthernetMACWithMii<MDIO, MDC>
@@ -233,13 +233,13 @@ where
 {
     pub fn read(&mut self, phy: u8, reg: u8) -> u16 {
         self.eth_mac
-            .smi(&mut self.mdio, &mut self.mdc)
+            .mii(&mut self.mdio, &mut self.mdc)
             .read(phy, reg)
     }
 
     pub fn write(&mut self, phy: u8, reg: u8, data: u16) {
         self.eth_mac
-            .smi(&mut self.mdio, &mut self.mdc)
+            .mii(&mut self.mdio, &mut self.mdc)
             .write(phy, reg, data)
     }
 }