From 259da58eb9b1321e694c10f3f557ab354eb5ae2e Mon Sep 17 00:00:00 2001
From: Jonah Dahlquist <hi@jonah.name>
Date: Mon, 30 Nov 2020 21:57:52 -0800
Subject: [PATCH] Recovered MAC address docs from previous driver code

---
 src/uninitialized_device.rs | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/uninitialized_device.rs b/src/uninitialized_device.rs
index c557b4c..1523561 100644
--- a/src/uninitialized_device.rs
+++ b/src/uninitialized_device.rs
@@ -31,6 +31,22 @@ impl<SpiBus: ActiveBus> UninitializedDevice<SpiBus> {
         UninitializedDevice { bus }
     }
 
+    /// Initialize the device with a MAC address and mode settings.
+    ///
+    /// Consider using freely available private/locally administered mac
+    /// addresses that match the following hex pattern:
+    ///
+    /// ```code
+    ///  x2-xx-xx-xx-xx-xx
+    ///  x6-xx-xx-xx-xx-xx
+    ///  xA-xx-xx-xx-xx-xx
+    ///  xE-xx-xx-xx-xx-xx
+    /// ```
+    ///
+    /// "Universally administered and locally administered addresses are
+    /// distinguished by setting the second-least-significant bit of the first
+    /// octet of the address"
+    /// [Wikipedia](https://en.wikipedia.org/wiki/MAC_address#Universal_vs._local)
     pub fn initialize(
         self,
         mac: MacAddress,