src/bsv/interface_decl.py

   1 import os.path
   2
   3 try:
   4     from UserDict import UserDict
   5 except ImportError:
   6     from collections import UserDict
   7
   8 from bsv.wire_def import generic_io  # special case
   9 from bsv.wire_def import muxwire  # special case
  10 from ifacebase import InterfacesBase
  11 from bsv.peripheral_gen import PeripheralIface
  12 from bsv.peripheral_gen import PeripheralInterfaces
  13
  14
  15 class Pin(object):
  16     """ pin interface declaration.
  17         * name is the name of the pin
  18         * ready, enabled and io all create a (* .... *) prefix
  19         * action changes it to an "in" if true
  20     """
  21
  22     def __init__(self, name,
  23                  name_=None,
  24                  idx=None,
  25                  ready=True,
  26                  enabled=True,
  27                  io=False,
  28                  action=False,
  29                  bitspec=None,
  30                  outenmode=False):
  31         self.name = name
  32         self.name_ = name_
  33         self.idx = idx
  34         self.ready = ready
  35         self.enabled = enabled
  36         self.io = io
  37         self.action = action
  38         self.bitspec = bitspec if bitspec else 'Bit#(1)'
  39         self.outenmode = outenmode
  40
  41     # bsv will look like this (method declaration):
  42     """
  43     (*always_ready,always_enabled*) method Bit#(1) io0_cell_outen;
  44     (*always_ready,always_enabled,result="io"*) method
  45                        Action io0_inputval (Bit#(1) in);
  46     """
  47
  48     def ifacepfmt(self, fmtfn):
  49         res = '          '
  50         status = []
  51         res += "interface "
  52         name = fmtfn(self.name_)
  53         if self.action:
  54             res += "Put"
  55         else:
  56             res += "Get"
  57         res += "#(%s) %s;" % (self.bitspec, name)
  58         return res
  59
  60     def ifacefmt(self, fmtfn):
  61         res = '    '
  62         status = []
  63         if self.ready:
  64             status.append('always_ready')
  65         if self.enabled:
  66             status.append('always_enabled')
  67         if self.io:
  68             status.append('result="io"')
  69         if status:
  70             res += '(*'
  71             res += ','.join(status)
  72             res += '*)'
  73         res += " method "
  74         if self.io:
  75             res += "\n                      "
  76         name = fmtfn(self.name)
  77         if self.action:
  78             res += " Action "
  79             res += name
  80             res += ' (%s in)' % self.bitspec
  81         else:
  82             res += " %s " % self.bitspec
  83             res += name
  84         res += ";"
  85         return res
  86
  87     def ifacedef(self, fmtoutfn, fmtinfn, fmtdecfn):
  88         res = '      method '
  89         if self.action:
  90             fmtname = fmtinfn(self.name)
  91             res += "Action  "
  92             res += fmtdecfn(self.name)
  93             res += '(%s in);\n' % self.bitspec
  94             res += '         %s<=in;\n' % fmtname
  95             res += '      endmethod'
  96         else:
  97             fmtname = fmtoutfn(self.name)
  98             res += "%s=%s;" % (self.name, fmtname)
  99         return res
 100     # sample bsv method definition :
 101     """
 102     method Action  cell0_mux(Bit#(2) in);
 103         wrcell0_mux<=in;
 104     endmethod
 105     """
 106
 107     # sample bsv wire (wire definiton):
 108     """
 109     Wire#(Bit#(2)) wrcell0_mux<-mkDWire(0);
 110     """
 111
 112     def wirefmt(self, fmtoutfn, fmtinfn, fmtdecfn):
 113         res = '      Wire#(%s) ' % self.bitspec
 114         if self.action:
 115             res += '%s' % fmtinfn(self.name)
 116         else:
 117             res += '%s' % fmtoutfn(self.name)
 118         res += "<-mkDWire(0);"
 119         return res
 120
 121     def ifacedef2(self, fmtoutfn, fmtinfn, fmtdecfn):
 122         if self.action:
 123             fmtname = fmtinfn(self.name)
 124             res = "            interface %s = interface Put\n" % self.name_
 125             res += '              method '
 126             res += "Action put"
 127             #res += fmtdecfn(self.name)
 128             res += '(%s in);\n' % self.bitspec
 129             res += '                %s<=in;\n' % fmtname
 130             res += '              endmethod\n'
 131             res += '            endinterface;'
 132         else:
 133             fmtname = fmtoutfn(self.name)
 134             res = "            interface %s = interface Get\n" % self.name_
 135             res += '              method ActionValue#'
 136             res += '(%s) get;\n' % self.bitspec
 137             res += "                return %s;\n" % (fmtname)
 138             res += '              endmethod\n'
 139             res += '            endinterface;'
 140         return res
 141
 142     def ifacedef3(self, idx, fmtoutfn, fmtinfn, fmtdecfn):
 143         if self.action:
 144             fmtname = fmtinfn(self.name)
 145             if self.name.endswith('outen'):
 146                 name = "tputen"
 147             else:
 148                 name = "tput"
 149             res = "                   %s <= in[%d];" % (fmtname, idx)
 150         else:
 151             fmtname = fmtoutfn(self.name)
 152             res = "                   tget[%d] = %s;" % (idx, fmtname)
 153             name = 'tget'
 154         return (name, res)
 155
 156
 157 class InterfaceFmt(object):
 158
 159     def ifacepfmtdecpin(self, pin):
 160         return pin.ifacepfmt(self.ifacepfmtdecfn)
 161
 162     def ifacepfmtdecfn(self, name):
 163         return name
 164
 165     def ifacefmtoutfn(self, name):
 166         return "wr%s" % name  # like wruart
 167
 168     def ifacefmtdecfn2(self, name):
 169         return name  # like: uart
 170
 171     def ifacefmtdecfn3(self, name):
 172         """ HACK! """
 173         return "%s_outen" % name  # like uart_outen
 174
 175     def ifacefmtinfn(self, name):
 176         return "wr%s" % name
 177
 178     def ifacedef2pin(self, pin):
 179         decfn = self.ifacefmtdecfn2
 180         outfn = self.ifacefmtoutfn
 181         # print pin, pin.outenmode
 182         if pin.outenmode:
 183             decfn = self.ifacefmtdecfn3
 184             outfn = self.ifacefmtoutenfn
 185         return pin.ifacedef2(outfn, self.ifacefmtinfn,
 186                              decfn)
 187
 188     def vectorifacedef2(self, pins, count, names, bitfmt, *args):
 189         tput = []
 190         tget = []
 191         tputen = []
 192         if len(pins) == 0:
 193             return ''
 194         # XXX HACK! assume in, out and inout, create set of indices
 195         # that are repeated three times.
 196         plens = []
 197         # ARG even worse hack for LCD *sigh*...
 198         if names[1] is None and names[2] is None:
 199             plens = range(len(pins))
 200         else:
 201             for i in range(0, len(pins), 3):
 202                 plens += [i / 3, i / 3, i / 3]
 203         for (typ, txt) in map(self.ifacedef3pin, plens, pins):
 204             if typ == 'tput':
 205                 tput.append(txt)
 206             elif typ == 'tget':
 207                 tget.append(txt)
 208             elif typ == 'tputen':
 209                 tputen.append(txt)
 210         tput = '\n'.join(tput).format(*args)
 211         tget = '\n'.join(tget).format(*args)
 212         tputen = '\n'.join(tputen).format(*args)
 213         bitfmt = bitfmt.format(count)
 214         template = ["""\
 215               interface {3} = interface Put#({0})
 216                  method Action put({2} in);
 217 {1}
 218                  endmethod
 219                endinterface;
 220 """,
 221                     """\
 222                interface {3} = interface Put#({0})
 223                  method Action put({2} in);
 224 {1}
 225                  endmethod
 226                endinterface;
 227 """,
 228                     """\
 229                interface {3} = interface Get#({0})
 230                  method ActionValue#({2}) get;
 231                    {2} tget;
 232 {1}
 233                    return tget;
 234                  endmethod
 235                endinterface;
 236 """]
 237         res = ''
 238         tlist = [tput, tputen, tget]
 239         for i, n in enumerate(names):
 240             if n:
 241                 res += template[i].format(count, tlist[i], bitfmt, n)
 242         return '\n' + res + '\n'
 243
 244
 245
 246 class Interface(PeripheralIface, InterfaceFmt):
 247     """ create an interface from a list of pinspecs.
 248         each pinspec is a dictionary, see Pin class arguments
 249         single indicates that there is only one of these, and
 250         so the name must *not* be extended numerically (see pname)
 251     """
 252     # sample interface object:
 253     """
 254     twiinterface_decl = Interface('twi',
 255                                   [{'name': 'sda', 'outen': True},
 256                                    {'name': 'scl', 'outen': True},
 257                                    ])
 258     """
 259
 260     def __init__(self, ifacename, pinspecs, ganged=None, single=False):
 261         PeripheralIface.__init__(self, ifacename)
 262         InterfaceFmt.__init__(self)
 263         self.ifacename = ifacename
 264         self.ganged = ganged or {}
 265         self.pins = []  # a list of instances of class Pin
 266         self.pinspecs = pinspecs  # a list of dictionary
 267         self.single = single
 268
 269         for idx, p in enumerate(pinspecs):
 270             _p = {}
 271             _p.update(p)
 272             if 'type' in _p:
 273                 del _p['type']
 274             if p.get('outen') is True:  # special case, generate 3 pins
 275                 del _p['outen']
 276                 for psuffix in ['out', 'outen', 'in']:
 277                     # changing the name (like sda) to (twi_sda_out)
 278                     _p['name_'] = "%s_%s" % (p['name'], psuffix)
 279                     _p['name'] = "%s_%s" % (self.pname(p['name']), psuffix)
 280                     _p['action'] = psuffix != 'in'
 281                     _p['idx'] = idx
 282                     self.pins.append(Pin(**_p))
 283                     # will look like {'name': 'twi_sda_out', 'action': True}
 284                     # {'name': 'twi_sda_outen', 'action': True}
 285                     #{'name': 'twi_sda_in', 'action': False}
 286                     # NOTice - outen key is removed
 287             else:
 288                 name = p['name']
 289                 if name.isdigit():  # HACK!  deals with EINT case
 290                     name = self.pname(name)
 291                 _p['name_'] = name
 292                 _p['idx'] = idx
 293                 _p['name'] = self.pname(p['name'])
 294                 self.pins.append(Pin(**_p))
 295
 296     # sample interface object:
 297     """
 298         uartinterface_decl = Interface('uart',
 299                                    [{'name': 'rx'},
 300                                     {'name': 'tx', 'action': True},
 301                                     ])
 302     """
 303     """
 304     getifacetype is called multiple times in actual_pinmux.py
 305     x = ifaces.getifacetype(temp), where temp is uart_rx, spi_mosi
 306     Purpose is to identify is function : input/output/inout
 307     """
 308
 309     def getifacetype(self, name):
 310         for p in self.pinspecs:
 311             fname = "%s_%s" % (self.ifacename, p['name'])
 312             # print "search", self.ifacename, name, fname
 313             if fname == name:
 314                 if p.get('action'):
 315                     return 'out'
 316                 elif p.get('outen'):
 317                     return 'inout'
 318                 return 'input'
 319         return None
 320
 321     def iname(self):
 322         """ generates the interface spec e.g. flexbus_ale
 323             if there is only one flexbus interface, or
 324             sd{0}_cmd if there are several.  string format
 325             function turns this into sd0_cmd, sd1_cmd as
 326             appropriate.  single mode stops the numerical extension.
 327         """
 328         if self.single:
 329             return self.ifacename
 330         return '%s{0}' % self.ifacename
 331
 332     def pname(self, name):
 333         """ generates the interface spec e.g. flexbus_ale
 334             if there is only one flexbus interface, or
 335             sd{0}_cmd if there are several.  string format
 336             function turns this into sd0_cmd, sd1_cmd as
 337             appropriate.  single mode stops the numerical extension.
 338         """
 339         return "%s_%s" % (self.iname(), name)
 340
 341     def busfmt(self, *args):
 342         """ this function creates a bus "ganging" system based
 343             on input from the {interfacename}.txt file.
 344             only inout pins that are under the control of the
 345             interface may be "ganged" together.
 346         """
 347         if not self.ganged:
 348             return ''  # when self.ganged is None
 349         # print self.ganged
 350         res = []
 351         for (k, pnames) in self.ganged.items():
 352             name = self.pname('%senable' % k).format(*args)
 353             decl = 'Bit#(1) %s = 0;' % name
 354             res.append(decl)
 355             ganged = []
 356             for p in self.pinspecs:
 357                 if p['name'] not in pnames:
 358                     continue
 359                 pname = self.pname(p['name']).format(*args)
 360                 if p.get('outen') is True:
 361                     outname = self.ifacefmtoutfn(pname)
 362                     ganged.append("%s_outen" % outname)  # match wirefmt
 363
 364             gangedfmt = '{%s} = duplicate(%s);'
 365             res.append(gangedfmt % (',\n  '.join(ganged), name))
 366         return '\n'.join(res) + '\n\n'
 367
 368     def wirefmt(self, *args):
 369         res = '\n'.join(map(self.wirefmtpin, self.pins)).format(*args)
 370         res += '\n'
 371         return '\n' + res
 372
 373     def ifacepfmt(self, *args):
 374         res = '\n'.join(map(self.ifacepfmtdecpin, self.pins)).format(*args)
 375         return '\n' + res  # pins is a list
 376
 377     def ifacefmt(self, *args):
 378         res = '\n'.join(map(self.ifacefmtdecpin, self.pins)).format(*args)
 379         return '\n' + res  # pins is a list
 380
 381     def ifacefmtdecfn(self, name):
 382         return name  # like: uart
 383
 384     def wirefmtpin(self, pin):
 385         return pin.wirefmt(self.ifacefmtoutfn, self.ifacefmtinfn,
 386                            self.ifacefmtdecfn2)
 387
 388     def ifacefmtdecpin(self, pin):
 389         return pin.ifacefmt(self.ifacefmtdecfn)
 390
 391     def ifacefmtpin(self, pin):
 392         decfn = self.ifacefmtdecfn2
 393         outfn = self.ifacefmtoutfn
 394         # print pin, pin.outenmode
 395         if pin.outenmode:
 396             decfn = self.ifacefmtdecfn3
 397             outfn = self.ifacefmtoutenfn
 398         return pin.ifacedef(outfn, self.ifacefmtinfn,
 399                             decfn)
 400
 401     def ifacedef(self, *args):
 402         res = '\n'.join(map(self.ifacefmtpin, self.pins))
 403         res = res.format(*args)
 404         return '\n' + res + '\n'
 405
 406     def ifacedef2(self, *args):
 407         res = '\n'.join(map(self.ifacedef2pin, self.pins))
 408         res = res.format(*args)
 409         return '\n' + res + '\n'
 410
 411
 412 class MuxInterface(Interface):
 413
 414     def wirefmt(self, *args):
 415         return muxwire.format(*args)
 416
 417
 418 class IOInterface(Interface):
 419
 420     def ifacefmtoutenfn(self, name):
 421         return "cell{0}_mux_outen"
 422
 423     def ifacefmtoutfn(self, name):
 424         """ for now strip off io{0}_ part """
 425         return "cell{0}_mux_out"
 426
 427     def ifacefmtinfn(self, name):
 428         return "cell{0}_mux_in"
 429
 430     def wirefmt(self, *args):
 431         return generic_io.format(*args)
 432
 433
 434 class InterfaceBus(InterfaceFmt):
 435
 436     def __init__(self, pins, is_inout, namelist, bitspec, filterbus):
 437         InterfaceFmt.__init__(self)
 438         self.namelist = namelist
 439         self.bitspec = bitspec
 440         self.fbus = filterbus  # filter identifying which are bus pins
 441         self.pins_ = pins
 442         self.is_inout = is_inout
 443         self.buspins = filter(lambda x: x.name_.startswith(self.fbus),
 444                               self.pins_)
 445         self.nonbuspins = filter(lambda x: not x.name_.startswith(self.fbus),
 446                               self.pins_)
 447
 448     def get_nonbuspins(self):
 449         return self.nonbuspins
 450
 451     def get_buspins(self):
 452         return self.buspins
 453
 454     def get_n_iopinsdiv(self):
 455         return 3 if self.is_inout else 1
 456
 457     def ifacepfmt(self, *args):
 458         pins = self.get_nonbuspins()
 459         res = '\n'.join(map(self.ifacepfmtdecpin, pins)).format(*args)
 460         res = res.format(*args)
 461
 462         pins = self.get_buspins()
 463         plen = len(pins) / self.get_n_iopinsdiv()
 464
 465         template = "          interface {1}#(%s) {2};\n" % self.bitspec
 466         for i, n in enumerate(self.namelist):
 467             if not n:
 468                 continue
 469             ftype = 'Get' if i == 2 else "Put"
 470             res += template.format(plen, ftype, n)
 471
 472         return "\n" + res
 473
 474     def ifacedef2(self, *args):
 475         pins = self.get_nonbuspins()
 476         res = '\n'.join(map(self.ifacedef2pin, pins))
 477         res = res.format(*args)
 478
 479         pins = self.get_buspins()
 480         plen = len(pins) / self.get_n_iopinsdiv()
 481         for pin in pins:
 482             print "ifbus pins", pin.name_, plen
 483         bitspec = self.bitspec.format(plen)
 484         print self
 485         return '\n' + res + self.vectorifacedef2(
 486             pins, plen, self.namelist, bitspec, *args) + '\n'
 487
 488     def ifacedef3pin(self, idx, pin):
 489         decfn = self.ifacefmtdecfn2
 490         outfn = self.ifacefmtoutfn
 491         # print pin, pin.outenmode
 492         if pin.outenmode:
 493             decfn = self.ifacefmtdecfn3
 494             outfn = self.ifacefmtoutenfn
 495         return pin.ifacedef3(idx, outfn, self.ifacefmtinfn,
 496                              decfn)
 497
 498
 499 class InterfaceMultiBus(object):
 500
 501     def __init__(self, pins):
 502         self.multibus_specs = []
 503         self.nonbuspins = pins
 504         self.nonb = self.add_bus(False, [], '', "xxxxxxxnofilter")
 505
 506     def add_bus(self, is_inout, namelist, bitspec, filterbus):
 507         pins = self.nonbuspins
 508         buspins = filter(lambda x: x.name_.startswith(filterbus), pins)
 509         nbuspins = filter(lambda x: not x.name_.startswith(filterbus), pins)
 510         self.nonbuspins = nbuspins
 511         b = InterfaceBus(buspins, is_inout,
 512                          namelist, bitspec, filterbus)
 513         print is_inout, namelist, filterbus, buspins
 514         self.multibus_specs.append(b)
 515         self.multibus_specs[0].pins_ = nbuspins
 516         self.multibus_specs[0].nonbuspins = nbuspins
 517
 518     def ifacepfmt(self, *args):
 519         res = ''
 520         #res = Interface.ifacepfmt(self, *args)
 521         for b in self.multibus_specs:
 522             res += b.ifacepfmt(*args)
 523         return res
 524
 525     def ifacedef2(self, *args):
 526         res = ''
 527         #res = Interface.ifacedef2(self, *args)
 528         for b in self.multibus_specs:
 529             res += b.ifacedef2(*args)
 530         return res
 531
 532
 533 class InterfaceLCD(InterfaceBus, Interface):
 534
 535     def __init__(self, *args):
 536         Interface.__init__(self, *args)
 537         InterfaceBus.__init__(self, self.pins, False, ['data_out', None, None],
 538                               "Bit#({0})", "out")
 539
 540 class InterfaceFlexBus(InterfaceMultiBus, Interface):
 541
 542     def __init__(self, ifacename, pinspecs, ganged=None, single=False):
 543         Interface.__init__(self, ifacename, pinspecs, ganged, single)
 544         InterfaceMultiBus.__init__(self, self.pins)
 545         self.add_bus(True, ['ad_out', 'ad_out_en', 'ad_in'],
 546                               "Bit#({0})", "ad")
 547         self.add_bus(False, ['bwe', None, None],
 548                               "Bit#({0})", "bwe")
 549         self.add_bus(False, ['tsiz', None, None],
 550                               "Bit#({0})", "tsiz")
 551         self.add_bus(False, ['cs', None, None],
 552                               "Bit#({0})", "cs")
 553
 554     def ifacedef2(self, *args):
 555         return InterfaceMultiBus.ifacedef2(self, *args)
 556
 557 class InterfaceSD(InterfaceBus, Interface):
 558
 559     def __init__(self, *args):
 560         Interface.__init__(self, *args)
 561         InterfaceBus.__init__(self, self.pins, True, ['out', 'out_en', 'in'],
 562                               "Bit#({0})", "d")
 563
 564 class InterfaceNSPI(InterfaceBus, Interface):
 565
 566     def __init__(self, *args):
 567         Interface.__init__(self, *args)
 568         InterfaceBus.__init__(self, self.pins, True,
 569                               ['io_out', 'io_out_en', 'io_in'],
 570                               "Bit#({0})", "io")
 571
 572 class InterfaceEINT(Interface):
 573     """ uses old-style (non-get/put) for now
 574     """
 575
 576     def ifacepfmt(self, *args):
 577         res = '\n'.join(map(self.ifacefmtdecpin, self.pins)).format(*args)
 578         return '\n' + res  # pins is a list
 579
 580     def ifacedef2(self, *args):
 581         return self.ifacedef(*args)
 582
 583
 584 class InterfaceGPIO(InterfaceBus, Interface):
 585     """ note: the busfilter cuts out everything as the entire set of pins
 586         is a bus, but it's less code.  get_nonbuspins returns empty list.
 587     """
 588
 589     def __init__(self, ifacename, pinspecs, ganged=None, single=False):
 590         Interface.__init__(self, ifacename, pinspecs, ganged, single)
 591         InterfaceBus.__init__(self, self.pins, True, ['out', 'out_en', 'in'],
 592                               "Vector#({0},Bit#(1))", ifacename[-1])
 593
 594 class Interfaces(InterfacesBase, PeripheralInterfaces):
 595     """ contains a list of interface definitions
 596     """
 597
 598     def __init__(self, pth=None):
 599         InterfacesBase.__init__(self, Interface, pth,
 600                                 {'gpio': InterfaceGPIO,
 601                                  'spi': InterfaceNSPI,
 602                                  'mspi': InterfaceNSPI,
 603                                  'lcd': InterfaceLCD,
 604                                  'sd': InterfaceSD,
 605                                  'fb': InterfaceFlexBus,
 606                                  'qspi': InterfaceNSPI,
 607                                  'mqspi': InterfaceNSPI,
 608                                  'eint': InterfaceEINT})
 609         PeripheralInterfaces.__init__(self)
 610
 611     def ifacedef(self, f, *args):
 612         for (name, count) in self.ifacecount:
 613             for i in range(count):
 614                 f.write(self.data[name].ifacedef(i))
 615
 616     def ifacedef2(self, f, *args):
 617         c = "        interface {0} = interface PeripheralSide{1}"
 618         for (name, count) in self.ifacecount:
 619             for i in range(count):
 620                 iname = self.data[name].iname().format(i)
 621                 f.write(c.format(iname, name.upper()))
 622                 f.write(self.data[name].ifacedef2(i))
 623                 f.write("        endinterface;\n\n")
 624
 625     def busfmt(self, f, *args):
 626         f.write("import BUtils::*;\n\n")
 627         for (name, count) in self.ifacecount:
 628             for i in range(count):
 629                 bf = self.data[name].busfmt(i)
 630                 f.write(bf)
 631
 632     def ifacepfmt(self, f, *args):
 633         comment = '''
 634       // interface declaration between {0} and pinmux
 635       (*always_ready,always_enabled*)
 636       interface PeripheralSide{0};'''
 637         for (name, count) in self.ifacecount:
 638             f.write(comment.format(name.upper()))
 639             f.write(self.data[name].ifacepfmt(0))
 640             f.write("\n      endinterface\n")
 641
 642     def ifacefmt(self, f, *args):
 643         comment = '''
 644           // interface declaration between %s-{0} and pinmux'''
 645         for (name, count) in self.ifacecount:
 646             for i in range(count):
 647                 c = comment % name.upper()
 648                 f.write(c.format(i))
 649                 f.write(self.data[name].ifacefmt(i))
 650
 651     def ifacefmt2(self, f, *args):
 652         comment = '''
 653             interface PeripheralSide{0} {1};'''
 654         for (name, count) in self.ifacecount:
 655             for i in range(count):
 656                 iname = self.data[name].iname().format(i)
 657                 f.write(comment.format(name.upper(), iname))
 658
 659     def wirefmt(self, f, *args):
 660         comment = '\n      // following wires capture signals ' \
 661                   'to IO CELL if %s-{0} is\n' \
 662                   '      // allotted to it'
 663         for (name, count) in self.ifacecount:
 664             for i in range(count):
 665                 c = comment % name
 666                 f.write(c.format(i))
 667                 f.write(self.data[name].wirefmt(i))
 668
 669
 670 # ========= Interface declarations ================ #
 671
 672 mux_interface = MuxInterface('cell',
 673                              [{'name': 'mux', 'ready': False, 'enabled': False,
 674                                'bitspec': '{1}', 'action': True}])
 675
 676 io_interface = IOInterface(
 677     'io',
 678     [{'name': 'cell_out', 'enabled': True, },
 679      {'name': 'cell_outen', 'enabled': True, 'outenmode': True, },
 680      {'name': 'cell_in', 'action': True, 'io': True}, ])
 681
 682 # == Peripheral Interface definitions == #
 683 # these are the interface of the peripherals to the pin mux
 684 # Outputs from the peripherals will be inputs to the pinmux
 685 # module. Hence the change in direction for most pins
 686
 687 # ======================================= #
 688
 689 # basic test
 690 if __name__ == '__main__':
 691
 692     uartinterface_decl = Interface('uart',
 693                                    [{'name': 'rx'},
 694                                     {'name': 'tx', 'action': True},
 695                                     ])
 696
 697     twiinterface_decl = Interface('twi',
 698                                   [{'name': 'sda', 'outen': True},
 699                                    {'name': 'scl', 'outen': True},
 700                                    ])
 701
 702     def _pinmunge(p, sep, repl, dedupe=True):
 703         """ munges the text so it's easier to compare.
 704             splits by separator, strips out blanks, re-joins.
 705         """
 706         p = p.strip()
 707         p = p.split(sep)
 708         if dedupe:
 709             p = filter(lambda x: x, p)  # filter out blanks
 710         return repl.join(p)
 711
 712     def pinmunge(p):
 713         """ munges the text so it's easier to compare.
 714         """
 715         # first join lines by semicolons, strip out returns
 716         p = p.split(";")
 717         p = map(lambda x: x.replace('\n', ''), p)
 718         p = '\n'.join(p)
 719         # now split first by brackets, then spaces (deduping on spaces)
 720         p = _pinmunge(p, "(", " ( ", False)
 721         p = _pinmunge(p, ")", " ) ", False)
 722         p = _pinmunge(p, " ", " ")
 723         return p
 724
 725     def zipcmp(l1, l2):
 726         l1 = l1.split("\n")
 727         l2 = l2.split("\n")
 728         for p1, p2 in zip(l1, l2):
 729             print (repr(p1))
 730             print (repr(p2))
 731             print ()
 732             assert p1 == p2
 733
 734     ifaces = Interfaces()
 735
 736     ifaceuart = ifaces['uart']
 737     print (ifaceuart.ifacedef(0))
 738     print (uartinterface_decl.ifacedef(0))
 739     assert ifaceuart.ifacedef(0) == uartinterface_decl.ifacedef(0)
 740
 741     ifacetwi = ifaces['twi']
 742     print (ifacetwi.ifacedef(0))
 743     print (twiinterface_decl.ifacedef(0))
 744     assert ifacetwi.ifacedef(0) == twiinterface_decl.ifacedef(0)