4 from UserDict
import UserDict
6 from collections
import UserDict
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
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
22 def __init__(self
, name
,
35 self
.enabled
= enabled
38 self
.bitspec
= bitspec
if bitspec
else 'Bit#(1)'
39 self
.outenmode
= outenmode
41 # bsv will look like this (method declaration):
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);
48 def ifacepfmt(self
, fmtfn
):
52 name
= fmtfn(self
.name_
)
57 res
+= "#(%s) %s;" % (self
.bitspec
, name
)
60 def ifacefmt(self
, fmtfn
):
64 status
.append('always_ready')
66 status
.append('always_enabled')
68 status
.append('result="io"')
71 res
+= ','.join(status
)
76 name
= fmtfn(self
.name
)
80 res
+= ' (%s in)' % self
.bitspec
82 res
+= " %s " % self
.bitspec
87 def ifacedef(self
, fmtoutfn
, fmtinfn
, fmtdecfn
):
90 fmtname
= fmtinfn(self
.name
)
92 res
+= fmtdecfn(self
.name
)
93 res
+= '(%s in);\n' % self
.bitspec
94 res
+= ' %s<=in;\n' % fmtname
97 fmtname
= fmtoutfn(self
.name
)
98 res
+= "%s=%s;" % (self
.name
, fmtname
)
100 # sample bsv method definition :
102 method Action cell0_mux(Bit#(2) in);
107 # sample bsv wire (wire definiton):
109 Wire#(Bit#(2)) wrcell0_mux<-mkDWire(0);
112 def wirefmt(self
, fmtoutfn
, fmtinfn
, fmtdecfn
):
113 res
= ' Wire#(%s) ' % self
.bitspec
115 res
+= '%s' % fmtinfn(self
.name
)
117 res
+= '%s' % fmtoutfn(self
.name
)
118 res
+= "<-mkDWire(0);"
121 def ifacedef2(self
, fmtoutfn
, fmtinfn
, fmtdecfn
):
123 fmtname
= fmtinfn(self
.name
)
124 res
= " interface %s = interface Put\n" % self
.name_
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;'
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;'
142 def ifacedef3(self
, idx
, fmtoutfn
, fmtinfn
, fmtdecfn
):
144 fmtname
= fmtinfn(self
.name
)
145 if self
.name
.endswith('outen'):
149 res
= " %s <= in[%d];" % (fmtname
, idx
)
151 fmtname
= fmtoutfn(self
.name
)
152 res
= " tget[%d] = %s;" % (idx
, fmtname
)
157 class Interface(PeripheralIface
):
158 """ create an interface from a list of pinspecs.
159 each pinspec is a dictionary, see Pin class arguments
160 single indicates that there is only one of these, and
161 so the name must *not* be extended numerically (see pname)
163 # sample interface object:
165 twiinterface_decl = Interface('twi',
166 [{'name': 'sda', 'outen': True},
167 {'name': 'scl', 'outen': True},
171 def __init__(self
, ifacename
, pinspecs
, ganged
=None, single
=False):
172 PeripheralIface
.__init
__(self
, ifacename
)
173 self
.ifacename
= ifacename
174 self
.ganged
= ganged
or {}
175 self
.pins
= [] # a list of instances of class Pin
176 self
.pinspecs
= pinspecs
# a list of dictionary
179 for idx
, p
in enumerate(pinspecs
):
184 if p
.get('outen') is True: # special case, generate 3 pins
186 for psuffix
in ['out', 'outen', 'in']:
187 # changing the name (like sda) to (twi_sda_out)
188 _p
['name_'] = "%s_%s" % (p
['name'], psuffix
)
189 _p
['name'] = "%s_%s" % (self
.pname(p
['name']), psuffix
)
190 _p
['action'] = psuffix
!= 'in'
192 self
.pins
.append(Pin(**_p
))
193 # will look like {'name': 'twi_sda_out', 'action': True}
194 # {'name': 'twi_sda_outen', 'action': True}
195 #{'name': 'twi_sda_in', 'action': False}
196 # NOTice - outen key is removed
199 if name
.isdigit(): # HACK! deals with EINT case
200 name
= self
.pname(name
)
203 _p
['name'] = self
.pname(p
['name'])
204 self
.pins
.append(Pin(**_p
))
206 # sample interface object:
208 uartinterface_decl = Interface('uart',
210 {'name': 'tx', 'action': True},
214 getifacetype is called multiple times in actual_pinmux.py
215 x = ifaces.getifacetype(temp), where temp is uart_rx, spi_mosi
216 Purpose is to identify is function : input/output/inout
219 def getifacetype(self
, name
):
220 for p
in self
.pinspecs
:
221 fname
= "%s_%s" % (self
.ifacename
, p
['name'])
222 # print "search", self.ifacename, name, fname
232 """ generates the interface spec e.g. flexbus_ale
233 if there is only one flexbus interface, or
234 sd{0}_cmd if there are several. string format
235 function turns this into sd0_cmd, sd1_cmd as
236 appropriate. single mode stops the numerical extension.
239 return self
.ifacename
240 return '%s{0}' % self
.ifacename
242 def pname(self
, name
):
243 """ generates the interface spec e.g. flexbus_ale
244 if there is only one flexbus interface, or
245 sd{0}_cmd if there are several. string format
246 function turns this into sd0_cmd, sd1_cmd as
247 appropriate. single mode stops the numerical extension.
249 return "%s_%s" % (self
.iname(), name
)
251 def busfmt(self
, *args
):
252 """ this function creates a bus "ganging" system based
253 on input from the {interfacename}.txt file.
254 only inout pins that are under the control of the
255 interface may be "ganged" together.
258 return '' # when self.ganged is None
261 for (k
, pnames
) in self
.ganged
.items():
262 name
= self
.pname('%senable' % k
).format(*args
)
263 decl
= 'Bit#(1) %s = 0;' % name
266 for p
in self
.pinspecs
:
267 if p
['name'] not in pnames
:
269 pname
= self
.pname(p
['name']).format(*args
)
270 if p
.get('outen') is True:
271 outname
= self
.ifacefmtoutfn(pname
)
272 ganged
.append("%s_outen" % outname
) # match wirefmt
274 gangedfmt
= '{%s} = duplicate(%s);'
275 res
.append(gangedfmt
% (',\n '.join(ganged
), name
))
276 return '\n'.join(res
) + '\n\n'
278 def wirefmt(self
, *args
):
279 res
= '\n'.join(map(self
.wirefmtpin
, self
.pins
)).format(*args
)
283 def ifacepfmt(self
, *args
):
284 res
= '\n'.join(map(self
.ifacepfmtdecpin
, self
.pins
)).format(*args
)
285 return '\n' + res
# pins is a list
287 def ifacefmt(self
, *args
):
288 res
= '\n'.join(map(self
.ifacefmtdecpin
, self
.pins
)).format(*args
)
289 return '\n' + res
# pins is a list
291 def ifacepfmtdecfn(self
, name
):
294 def ifacefmtdecfn(self
, name
):
295 return name
# like: uart
297 def ifacefmtdecfn2(self
, name
):
298 return name
# like: uart
300 def ifacefmtdecfn3(self
, name
):
302 return "%s_outen" % name
# like uart_outen
304 def ifacefmtoutfn(self
, name
):
305 return "wr%s" % name
# like wruart
307 def ifacefmtinfn(self
, name
):
310 def wirefmtpin(self
, pin
):
311 return pin
.wirefmt(self
.ifacefmtoutfn
, self
.ifacefmtinfn
,
314 def ifacepfmtdecpin(self
, pin
):
315 return pin
.ifacepfmt(self
.ifacepfmtdecfn
)
317 def ifacefmtdecpin(self
, pin
):
318 return pin
.ifacefmt(self
.ifacefmtdecfn
)
320 def ifacefmtpin(self
, pin
):
321 decfn
= self
.ifacefmtdecfn2
322 outfn
= self
.ifacefmtoutfn
323 # print pin, pin.outenmode
325 decfn
= self
.ifacefmtdecfn3
326 outfn
= self
.ifacefmtoutenfn
327 return pin
.ifacedef(outfn
, self
.ifacefmtinfn
,
330 def ifacedef2pin(self
, pin
):
331 decfn
= self
.ifacefmtdecfn2
332 outfn
= self
.ifacefmtoutfn
333 # print pin, pin.outenmode
335 decfn
= self
.ifacefmtdecfn3
336 outfn
= self
.ifacefmtoutenfn
337 return pin
.ifacedef2(outfn
, self
.ifacefmtinfn
,
340 def ifacedef(self
, *args
):
341 res
= '\n'.join(map(self
.ifacefmtpin
, self
.pins
))
342 res
= res
.format(*args
)
343 return '\n' + res
+ '\n'
345 def ifacedef2(self
, *args
):
346 res
= '\n'.join(map(self
.ifacedef2pin
, self
.pins
))
347 res
= res
.format(*args
)
348 return '\n' + res
+ '\n'
350 def vectorifacedef2(self
, pins
, count
, names
, bitfmt
, *args
):
354 # XXX HACK! assume in, out and inout, create set of indices
355 # that are repeated three times.
357 for i
in range(0, len(pins
), 3):
358 plens
+= [i
/3, i
/3, i
/3]
359 for (typ
, txt
) in map(self
.ifacedef3pin
, plens
, pins
):
364 elif typ
== 'tputen':
366 tput
= '\n'.join(tput
).format(*args
)
367 tget
= '\n'.join(tget
).format(*args
)
368 tputen
= '\n'.join(tputen
).format(*args
)
369 bitfmt
= bitfmt
.format(count
)
371 interface {5} = interface Put#({0})
372 method Action put({4} in);
376 interface {6} = interface Put#({0})
377 method Action put({4} in);
381 interface {7} = interface Get#({0})
382 method ActionValue#({4}) get;
388 """.format(count
, tput
, tputen
, tget
,
389 bitfmt
, names
[0], names
[1], names
[2])
390 return '\n' + template
+ '\n'
393 class MuxInterface(Interface
):
395 def wirefmt(self
, *args
):
396 return muxwire
.format(*args
)
399 class IOInterface(Interface
):
401 def ifacefmtoutenfn(self
, name
):
402 return "cell{0}_mux_outen"
404 def ifacefmtoutfn(self
, name
):
405 """ for now strip off io{0}_ part """
406 return "cell{0}_mux_out"
408 def ifacefmtinfn(self
, name
):
409 return "cell{0}_mux_in"
411 def wirefmt(self
, *args
):
412 return generic_io
.format(*args
)
415 class InterfaceQSPI(Interface
):
417 def ifacepfmt(self
, *args
):
418 pins
= filter(lambda x
: not x
.name_
.startswith('io'), self
.pins
)
419 res
= '\n'.join(map(self
.ifacepfmtdecpin
, pins
)).format(*args
)
420 res
= res
.format(*args
)
422 return "\n" + res
+ """
423 interface Put#(Bit#(4)) io_out;
424 interface Put#(Bit#(4)) io_out_en;
425 interface Get#(Bit#(4)) io_in;
426 """.format(len(self
.pinspecs
))
428 def ifacedef2(self
, *args
):
429 pins
= filter(lambda x
: not x
.name_
.startswith('io'), self
.pins
)
430 res
= '\n'.join(map(self
.ifacedef2pin
, pins
))
431 res
= res
.format(*args
)
433 pins
= filter(lambda x
: x
.name_
.startswith('io'), self
.pins
)
434 return '\n' + res
+ self
.vectorifacedef2(pins
, 4,
435 ['io_out', 'io_out_en', 'io_in'],
436 "Bit#(4)", *args
) + '\n'
438 def ifacedef3pin(self
, idx
, pin
):
439 decfn
= self
.ifacefmtdecfn2
440 outfn
= self
.ifacefmtoutfn
441 # print pin, pin.outenmode
443 decfn
= self
.ifacefmtdecfn3
444 outfn
= self
.ifacefmtoutenfn
445 return pin
.ifacedef3(idx
, outfn
, self
.ifacefmtinfn
,
449 class InterfaceGPIO(Interface
):
451 def ifacepfmt(self
, *args
):
453 interface Put#(Vector#({0}, Bit#(1))) out;
454 interface Put#(Vector#({0}, Bit#(1))) out_en;
455 interface Get#(Vector#({0}, Bit#(1))) in;
456 """.format(len(self
.pinspecs
))
458 def ifacedef2(self
, *args
):
459 return self
.vectorifacedef2(self
.pins
, len(self
.pinspecs
),
460 ['out', 'out_en', 'in'],
461 "Vector#({0},Bit#(1))", *args
)
463 def ifacedef3pin(self
, idx
, pin
):
464 decfn
= self
.ifacefmtdecfn2
465 outfn
= self
.ifacefmtoutfn
466 # print pin, pin.outenmode
468 decfn
= self
.ifacefmtdecfn3
469 outfn
= self
.ifacefmtoutenfn
470 return pin
.ifacedef3(idx
, outfn
, self
.ifacefmtinfn
,
474 class Interfaces(InterfacesBase
, PeripheralInterfaces
):
475 """ contains a list of interface definitions
478 def __init__(self
, pth
=None):
479 InterfacesBase
.__init
__(self
, Interface
, pth
,
480 {'gpio': InterfaceGPIO
,
481 'qspi': InterfaceQSPI
})
482 PeripheralInterfaces
.__init
__(self
)
484 def ifacedef(self
, f
, *args
):
485 for (name
, count
) in self
.ifacecount
:
486 for i
in range(count
):
487 f
.write(self
.data
[name
].ifacedef(i
))
489 def ifacedef2(self
, f
, *args
):
490 c
= " interface {0} = interface PeripheralSide{1}"
491 for (name
, count
) in self
.ifacecount
:
492 for i
in range(count
):
493 iname
= self
.data
[name
].iname().format(i
)
494 f
.write(c
.format(iname
, name
.upper()))
495 f
.write(self
.data
[name
].ifacedef2(i
))
496 f
.write(" endinterface;\n\n")
498 def busfmt(self
, f
, *args
):
499 f
.write("import BUtils::*;\n\n")
500 for (name
, count
) in self
.ifacecount
:
501 for i
in range(count
):
502 bf
= self
.data
[name
].busfmt(i
)
505 def ifacepfmt(self
, f
, *args
):
507 // interface declaration between {0} and pinmux
508 (*always_ready,always_enabled*)
509 interface PeripheralSide{0};'''
510 for (name
, count
) in self
.ifacecount
:
511 f
.write(comment
.format(name
.upper()))
512 f
.write(self
.data
[name
].ifacepfmt(0))
513 f
.write("\n endinterface\n")
515 def ifacefmt(self
, f
, *args
):
517 // interface declaration between %s-{0} and pinmux'''
518 for (name
, count
) in self
.ifacecount
:
519 for i
in range(count
):
520 c
= comment
% name
.upper()
522 f
.write(self
.data
[name
].ifacefmt(i
))
524 def ifacefmt2(self
, f
, *args
):
526 interface PeripheralSide{0} {1};'''
527 for (name
, count
) in self
.ifacecount
:
528 for i
in range(count
):
529 iname
= self
.data
[name
].iname().format(i
)
530 f
.write(comment
.format(name
.upper(), iname
))
532 def wirefmt(self
, f
, *args
):
533 comment
= '\n // following wires capture signals ' \
534 'to IO CELL if %s-{0} is\n' \
536 for (name
, count
) in self
.ifacecount
:
537 for i
in range(count
):
540 f
.write(self
.data
[name
].wirefmt(i
))
543 # ========= Interface declarations ================ #
545 mux_interface
= MuxInterface('cell',
546 [{'name': 'mux', 'ready': False, 'enabled': False,
547 'bitspec': '{1}', 'action': True}])
549 io_interface
= IOInterface(
551 [{'name': 'cell_out', 'enabled': True, },
552 {'name': 'cell_outen', 'enabled': True, 'outenmode': True, },
553 {'name': 'cell_in', 'action': True, 'io': True}, ])
555 # == Peripheral Interface definitions == #
556 # these are the interface of the peripherals to the pin mux
557 # Outputs from the peripherals will be inputs to the pinmux
558 # module. Hence the change in direction for most pins
560 # ======================================= #
563 if __name__
== '__main__':
565 uartinterface_decl
= Interface('uart',
567 {'name': 'tx', 'action': True},
570 twiinterface_decl
= Interface('twi',
571 [{'name': 'sda', 'outen': True},
572 {'name': 'scl', 'outen': True},
575 def _pinmunge(p
, sep
, repl
, dedupe
=True):
576 """ munges the text so it's easier to compare.
577 splits by separator, strips out blanks, re-joins.
582 p
= filter(lambda x
: x
, p
) # filter out blanks
586 """ munges the text so it's easier to compare.
588 # first join lines by semicolons, strip out returns
590 p
= map(lambda x
: x
.replace('\n', ''), p
)
592 # now split first by brackets, then spaces (deduping on spaces)
593 p
= _pinmunge(p
, "(", " ( ", False)
594 p
= _pinmunge(p
, ")", " ) ", False)
595 p
= _pinmunge(p
, " ", " ")
601 for p1
, p2
in zip(l1
, l2
):
607 ifaces
= Interfaces()
609 ifaceuart
= ifaces
['uart']
610 print (ifaceuart
.ifacedef(0))
611 print (uartinterface_decl
.ifacedef(0))
612 assert ifaceuart
.ifacedef(0) == uartinterface_decl
.ifacedef(0)
614 ifacetwi
= ifaces
['twi']
615 print (ifacetwi
.ifacedef(0))
616 print (twiinterface_decl
.ifacedef(0))
617 assert ifacetwi
.ifacedef(0) == twiinterface_decl
.ifacedef(0)