code-comment for get_pinspecs()

diff --git a/src/soc/config/pinouts.py b/src/soc/config/pinouts.py
index 03cfa974b957f654512d8ff204ce1262ce7d632f..a66317aa051cb4e45e48506d71b7acbc09a6da3b 100644 (file)
--- 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