Adding some documentation to code_8b10b.py

mithro · sbourdeauducq · commit 25d9e5dc7265 · 2016-12-15T16:46:37.000+08:00
diff --git a/misoc/cores/code_8b10b.py b/misoc/cores/code_8b10b.py
@@ -1,3 +1,17 @@
+"""
+IBM's 8b/10b Encoding
+
+This scheme is used by a large number of protocols including Display Port, PCI
+Express, Gigabit Ethernet, SATA and USB 3.
+
+The encoding is built by combining an 5b/6b and 3b/4b encoding schemes and
+guarantees both DC balance and enough bit transitions to recover the clock
+signal.
+
+Note: This encoding is *not* used by DVI/HDMI (that uses a *different* 8b/10b
+scheme called TMDS).
+"""
+
 from migen import *
 
 
