shuffle interface-reading code around to create InterfacesBase class
[pinmux.git] / src / bsv / interface_decl.py
index 3e4a755342a5fbc8dd7bcea8291f85f003a178bd..5493d16a23d26e7195ffed541071767834bc3725 100644 (file)
@@ -7,7 +7,7 @@ except ImportError:
 
 from bsv.wire_def import generic_io  # special case
 from bsv.wire_def import muxwire  # special case
-
+from ifacebase import InterfacesBase
 
 class Pin(object):
     """ pin interface declaration.
@@ -31,6 +31,13 @@ class Pin(object):
         self.bitspec = bitspec if bitspec else 'Bit#(1)'
         self.outenmode = outenmode
 
+    # bsv will look like this (method declaration):
+    """
+    (*always_ready,always_enabled*) method Bit#(1) io0_cell_outen;
+    (*always_ready,always_enabled,result="io"*) method
+                       Action io0_inputval (Bit#(1) in);
+    """
+
     def ifacefmt(self, fmtfn):
         res = '    '
         status = []
@@ -58,6 +65,13 @@ class Pin(object):
         res += ";"
         return res
 
+    # sample bsv method definition :
+    """
+    method Action  cell0_mux(Bit#(2) in);
+        wrcell0_mux<=in;
+    endmethod
+    """
+
     def ifacedef(self, fmtoutfn, fmtinfn, fmtdecfn):
         res = '      method '
         if self.action:
@@ -71,6 +85,10 @@ class Pin(object):
             fmtname = fmtoutfn(self.name)
             res += "%s=%s;" % (self.name, fmtname)
         return res
+    # sample bsv wire (wire definiton):
+    """
+    Wire#(Bit#(2)) wrcell0_mux<-mkDWire(0);
+    """
 
     def wirefmt(self, fmtoutfn, fmtinfn, fmtdecfn):
         res = '      Wire#(%s) ' % self.bitspec
@@ -88,12 +106,19 @@ class Interface(object):
         single indicates that there is only one of these, and
         so the name must *not* be extended numerically (see pname)
     """
+    # sample interface object:
+    """
+    twiinterface_decl = Interface('twi',
+                                  [{'name': 'sda', 'outen': True},
+                                   {'name': 'scl', 'outen': True},
+                                   ])
+    """
 
     def __init__(self, ifacename, pinspecs, ganged=None, single=False):
         self.ifacename = ifacename
         self.ganged = ganged or {}
-        self.pins = []
-        self.pinspecs = pinspecs
+        self.pins = []  # a list of instances of class Pin
+        self.pinspecs = pinspecs  # a list of dictionary
         self.single = single
         for p in pinspecs:
             _p = {}
@@ -101,13 +126,31 @@ class Interface(object):
             if p.get('outen') is True:  # special case, generate 3 pins
                 del _p['outen']
                 for psuffix in ['out', 'outen', 'in']:
+                    # changing the name (like sda) to (twi_sda_out)
                     _p['name'] = "%s_%s" % (self.pname(p['name']), psuffix)
                     _p['action'] = psuffix != 'in'
                     self.pins.append(Pin(**_p))
+                    # will look like {'name': 'twi_sda_out', 'action': True}
+                    # {'name': 'twi_sda_outen', 'action': True}
+                    #{'name': 'twi_sda_in', 'action': False}
+                    # NOTice - outen key is removed
             else:
                 _p['name'] = self.pname(p['name'])
                 self.pins.append(Pin(**_p))
 
+    # sample interface object:
+    """
+        uartinterface_decl = Interface('uart',
+                                   [{'name': 'rx'},
+                                    {'name': 'tx', 'action': True},
+                                    ])
+    """
+    """
+    getifacetype is called multiple times in actual_pinmux.py
+    x = ifaces.getifacetype(temp), where temp is uart_rx, spi_mosi
+    Purpose is to identify is function : input/output/inout
+    """
+
     def getifacetype(self, name):
         for p in self.pinspecs:
             fname = "%s_%s" % (self.ifacename, p['name'])
@@ -138,7 +181,7 @@ class Interface(object):
             interface may be "ganged" together.
         """
         if not self.ganged:
-            return ''
+            return ''  # when self.ganged is None
         #print self.ganged
         res = []
         for (k, pnames) in self.ganged.items():
@@ -165,20 +208,20 @@ class Interface(object):
 
     def ifacefmt(self, *args):
         res = '\n'.join(map(self.ifacefmtdecpin, self.pins)).format(*args)
-        return '\n' + res
+        return '\n' + res  # pins is a list
 
     def ifacefmtdecfn(self, name):
-        return name
+        return name  # like: uart
 
     def ifacefmtdecfn2(self, name):
-        return name
+        return name  # like: uart
 
     def ifacefmtdecfn3(self, name):
         """ HACK! """
-        return "%s_outenX" % name
+        return "%s_outen" % name  # like uart_outen
 
     def ifacefmtoutfn(self, name):
-        return "wr%s" % name
+        return "wr%s" % name  # like wruart
 
     def ifacefmtinfn(self, name):
         return "wr%s" % name
@@ -193,7 +236,7 @@ class Interface(object):
     def ifacefmtpin(self, pin):
         decfn = self.ifacefmtdecfn2
         outfn = self.ifacefmtoutfn
-        print pin, pin.outenmode
+        #print pin, pin.outenmode
         if pin.outenmode:
             decfn = self.ifacefmtdecfn3
             outfn = self.ifacefmtoutenfn
@@ -228,66 +271,12 @@ class IOInterface(Interface):
         return generic_io.format(*args)
 
 
-class Interfaces(UserDict):
+class Interfaces(InterfacesBase):
     """ contains a list of interface definitions
     """
 
     def __init__(self, pth=None):
-        self.pth = pth
-        self.ifacecount = []
-        UserDict.__init__(self, {})
-        if not pth:
-            return
-        ift = 'interfaces.txt'
-        if pth:
-            ift = os.path.join(pth, ift)
-        with open(ift, 'r') as ifile:
-            for ln in ifile.readlines():
-                ln = ln.strip()
-                ln = ln.split("\t")
-                name = ln[0]
-                count = int(ln[1])
-                spec, ganged = self.read_spec(pth, name)
-                iface = Interface(name, spec, ganged, count == 1)
-                self.ifaceadd(name, count, iface)
-
-    def getifacetype(self, fname):
-        # finds the interface type, e.g sd_d0 returns "inout"
-        for iface in self.values():
-            typ = iface.getifacetype(fname)
-            if typ:
-                return typ
-        return None
-
-    def ifaceadd(self, name, count, iface, at=None):
-        if at is None:
-            at = len(self.ifacecount)
-        self.ifacecount.insert(at, (name, count))
-        self[name] = iface
-
-    def read_spec(self, pth, name):
-        spec = []
-        ganged = {}
-        fname = '%s.txt' % name
-        if pth:
-            ift = os.path.join(pth, fname)
-        with open(ift, 'r') as sfile:
-            for ln in sfile.readlines():
-                ln = ln.strip()
-                ln = ln.split("\t")
-                name = ln[0]
-                d = {'name': name}
-                if ln[1] == 'out':
-                    d['action'] = True
-                elif ln[1] == 'inout':
-                    d['outen'] = True
-                    if len(ln) == 3:
-                        bus = ln[2]
-                        if bus not in ganged:
-                            ganged[bus] = []
-                        ganged[bus].append(name)
-                spec.append(d)
-        return spec, ganged
+        InterfacesBase.__init__(self, Interface, pth)
 
     def ifacedef(self, f, *args):
         for (name, count) in self.ifacecount: