From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Sat, 13 Nov 2021 14:42:05 +0000 (+0000)
Subject: code-comment for get_pinspecs()
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=1fe860406256e7c350ad0232db64720557dc0c8b;p=soc.git

code-comment for get_pinspecs()
---

diff --git a/src/soc/config/pinouts.py b/src/soc/config/pinouts.py
index 03cfa974..a66317aa 100644
--- a/src/soc/config/pinouts.py
+++ b/src/soc/config/pinouts.py
@@ -26,6 +26,10 @@ def _byteify(data, ignore_dicts = False):
 
 
 def get_pinspecs(chipname=None, subset=None):
+    """get_pinspecs - returns a dictionary of lists of pins for an IO function
+    example: {'uart': ['tx+', 'rx-'],
+             'i2c': ['sda*', 'scl+']}
+    """
     chip = load_pinouts(chipname)
     pinmap = chip['pins.map']
     specs = OrderedDict() # preserve order