From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Wed, 4 Jul 2018 15:22:02 +0000 (+0100)
Subject:  add explanation in PinGen class
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=eca6ba1cc6e5f6001b46f959f079f3dad897726c;p=pinmux.git

 add explanation in PinGen class
---

diff --git a/src/spec/interfaces.py b/src/spec/interfaces.py
index 03d7a2a..e2cddba 100644
--- a/src/spec/interfaces.py
+++ b/src/spec/interfaces.py
@@ -30,7 +30,11 @@ class PinGen(object):
         mux   : which column in the multiplexer
         start : the start of a subset of pins to be inserted
         limit : the end of the subset (or the number if start also given)
-        spec  : *EXTRA* pins to be inserted.
+        spec  : *EXTRA* pins to be inserted (at different implicit positions)
+
+        the pins are inserted with the suffix, starting from the
+        offset position using offs as the row and mux as the column,
+        and working in a constant increment down the rows.
 
         spec is slightly complicated, basically there's extra
         functions that we want to be on the same pin (but a different mux)