Docs

Author: Johannes Draaijer

src/lib.rs

@@ -93,12 +93,8 @@ pub struct EthernetDMA<'rx, 'tx> {
 /// If you wish to use another configuration, please see
 /// [new_unchecked](new_unchecked).
 ///
-/// This method does not initialise the external PHY.
-///
-/// Interacting with a PHY can be done through a struct that implementes the
-/// [`mac::StationManagement`] trait.
-///
-/// You may access SMI through the [`EthernetMAC::smi`] function.
+/// This method does not initialise the external PHY. Interacting with a PHY
+/// can be done by using the struct returned from [`EthernetMAC::smi`].
 pub fn new<'rx, 'tx, REFCLK, CRS, TXEN, TXD0, TXD1, RXD0, RXD1>(
     eth_mac: ETHERNET_MAC,
     eth_mmc: ETHERNET_MMC,
@@ -133,9 +129,10 @@ where
 /// If you wish to use another configuration, please see
 /// [new_unchecked](new_unchecked).
 ///
-/// This method does not initialise the external PHY. The SMI for the external PHY
-/// can be accessed through a struct that implements the [`mac::StationManagement`] trait,
-/// which [`EthernetMAC<OwnedSmi>`] does.
+/// This method does not initialise the external PHY.
+///
+/// The SMI for the external PHY can be accessed through the
+/// returned [`EthernetMAC<OwnedSmi>`], which implements [`mac::StationManagement`].
 ///
 /// # Note
 /// - Make sure that the buffers reside in a memory region that is

src/phy/mod.rs

@@ -8,15 +8,18 @@ pub trait Phy {
 
     /// Reset the PHY
     ///
-    /// TODO: describe what "reset" actually is
+    // TODO: describe what "reset" actually is
     fn reset(&mut self);
 
     /// Initialize the PHY
     ///
-    /// TODO: describe what "init" actually is
+    // TODO: describe what "init" actually is
     fn init(&mut self);
 
-    /// Poll the link status of this
+    /// Poll the link status of this PHY. If it returns `true`, the
+    /// link is up. If it returns `false`, the link is down.
+    /// 
+    // TODO: return an associated type with link information?
     fn poll_link(&mut self) -> bool;
 
     /// Get the link speed reported by the PHY