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
13 """ pin interface declaration.
14 * name is the name of the pin
15 * ready, enabled and io all create a (* .... *) prefix
16 * action changes it to an "in" if true
19 def __init__(self
, name
,
27 self
.enabled
= enabled
30 self
.bitspec
= bitspec
if bitspec
else 'Bit#(1)'
32 def ifacefmt(self
, fmtfn
=None):
36 status
.append('always_ready')
38 status
.append('always_enabled')
40 status
.append('result="io"')
43 res
+= ','.join(status
)
48 name
= fmtfn(self
.name
)
52 res
+= ' (%s in)' % self
.bitspec
54 res
+= " %s " % self
.bitspec
59 def ifacedef(self
, fmtoutfn
=None, fmtinfn
=None, fmtdecfn
=None):
62 fmtname
= fmtinfn(self
.name
)
64 res
+= fmtdecfn(self
.name
)
65 res
+= '(%s in);\n' % self
.bitspec
66 res
+= ' %s<=in;\n' % fmtname
69 fmtname
= fmtoutfn(self
.name
)
70 res
+= "%s=%s;" % (self
.name
, fmtname
)
73 def wirefmt(self
, fmtoutfn
=None, fmtinfn
=None, fmtdecfn
=None):
74 res
= ' Wire#(%s) ' % self
.bitspec
76 res
+= '%s' % fmtinfn(self
.name
)
78 res
+= '%s' % fmtoutfn(self
.name
)
79 res
+= "<-mkDWire(0);"
83 class Interface(object):
84 """ create an interface from a list of pinspecs.
85 each pinspec is a dictionary, see Pin class arguments
86 single indicates that there is only one of these, and
87 so the name must *not* be extended numerically (see pname)
90 def __init__(self
, ifacename
, pinspecs
, ganged
=None, single
=False):
91 self
.ifacename
= ifacename
92 self
.ganged
= ganged
or {}
94 self
.pinspecs
= pinspecs
99 if p
.get('outen') is True: # special case, generate 3 pins
101 for psuffix
in ['out', 'outen', 'in']:
102 _p
['name'] = "%s_%s" % (self
.pname(p
['name']), psuffix
)
103 _p
['action'] = psuffix
!= 'in'
104 self
.pins
.append(Pin(**_p
))
106 _p
['name'] = self
.pname(p
['name'])
107 self
.pins
.append(Pin(**_p
))
109 def getifacetype(self
, name
):
110 for p
in self
.pinspecs
:
111 fname
= "%s_%s" % (self
.ifacename
, p
['name'])
112 #print "search", self.ifacename, name, fname
121 def pname(self
, name
):
122 """ generates the interface spec e.g. flexbus_ale
123 if there is only one flexbus interface, or
124 sd{0}_cmd if there are several. string format
125 function turns this into sd0_cmd, sd1_cmd as
126 appropriate. single mode stops the numerical extension.
129 return '%s_%s' % (self
.ifacename
, name
)
130 return '%s{0}_%s' % (self
.ifacename
, name
)
132 def busfmt(self
, *args
):
133 """ this function creates a bus "ganging" system based
134 on input from the {interfacename}.txt file.
135 only inout pins that are under the control of the
136 interface may be "ganged" together.
142 for (k
, pnames
) in self
.ganged
.items():
143 name
= self
.pname('%senable' % k
).format(*args
)
144 decl
= 'Bit#(1) %s = 0;' % name
147 for p
in self
.pinspecs
:
148 if p
['name'] not in pnames
:
150 pname
= self
.pname(p
['name']).format(*args
)
151 if p
.get('outen') is True:
152 outname
= self
.ifacefmtoutfn(pname
)
153 ganged
.append("%s_outen" % outname
) # match wirefmt
155 gangedfmt
= '{%s} = duplicate(%s);'
156 res
.append(gangedfmt
% (',\n '.join(ganged
), name
))
157 return '\n'.join(res
) + '\n\n'
159 def wirefmt(self
, *args
):
160 res
= '\n'.join(map(self
.wirefmtpin
, self
.pins
)).format(*args
)
162 for p
in self
.pinspecs
:
163 name
= self
.pname(p
['name']).format(*args
)
164 res
+= " GenericIOType %s_io = GenericIOType{\n" % name
166 if p
.get('outen') is True:
167 outname
= self
.ifacefmtoutfn(name
)
168 params
.append('outputval:%s_out,' % outname
)
169 params
.append('output_en:%s_outen,' % outname
) # match busfmt
170 params
.append('input_en:~%s_outen,' % outname
)
171 elif p
.get('action'):
172 outname
= self
.ifacefmtoutfn(name
)
173 params
.append('outputval:%s,' % outname
)
174 params
.append('output_en:1,')
175 params
.append('input_en:0,')
177 params
.append('outputval:0,')
178 params
.append('output_en:0,')
179 params
.append('input_en:1,')
180 params
+= ['pullup_en:0,', 'pulldown_en:0,',
181 'pushpull_en:0,', 'drivestrength:0,',
184 res
+= ' %s\n' % param
188 def ifacefmt(self
, *args
):
189 res
= '\n'.join(map(self
.ifacefmtdecpin
, self
.pins
)).format(*args
)
192 def ifacefmtdecfn(self
, name
):
195 def ifacefmtdecfn2(self
, name
):
198 def ifacefmtoutfn(self
, name
):
201 def ifacefmtinfn(self
, name
):
204 def wirefmtpin(self
, pin
):
205 return pin
.wirefmt(self
.ifacefmtoutfn
, self
.ifacefmtinfn
,
208 def ifacefmtdecpin(self
, pin
):
209 return pin
.ifacefmt(self
.ifacefmtdecfn
)
211 def ifacefmtpin(self
, pin
):
212 return pin
.ifacedef(self
.ifacefmtoutfn
, self
.ifacefmtinfn
,
215 def ifacedef(self
, *args
):
216 res
= '\n'.join(map(self
.ifacefmtpin
, self
.pins
))
217 res
= res
.format(*args
)
218 return '\n' + res
+ '\n'
221 class MuxInterface(Interface
):
223 def wirefmt(self
, *args
):
224 return muxwire
.format(*args
)
227 class IOInterface(Interface
):
229 def ifacefmtoutfn(self
, name
):
230 """ for now strip off io{0}_ part """
231 return "cell{0}_mux_out"
233 def ifacefmtinfn(self
, name
):
234 return "cell{0}_mux_in"
236 def wirefmt(self
, *args
):
237 return generic_io
.format(*args
)
240 class Interfaces(UserDict
):
241 """ contains a list of interface definitions
244 def __init__(self
, pth
):
247 UserDict
.__init
__(self
, {})
248 ift
= 'interfaces.txt'
250 ift
= os
.path
.join(pth
, ift
)
251 with
open(ift
, 'r') as ifile
:
252 for ln
in ifile
.readlines():
257 spec
, ganged
= self
.read_spec(pth
, name
)
258 iface
= Interface(name
, spec
, ganged
, count
== 1)
259 self
.ifaceadd(name
, count
, iface
)
261 def getifacetype(self
, fname
):
262 # finds the interface type, e.g sd_d0 returns "inout"
263 for iface
in self
.values():
264 typ
= iface
.getifacetype(fname
)
269 def ifaceadd(self
, name
, count
, iface
, at
=None):
271 at
= len(self
.ifacecount
)
272 self
.ifacecount
.insert(at
, (name
, count
))
275 def read_spec(self
, pth
, name
):
278 fname
= '%s.txt' % name
280 ift
= os
.path
.join(pth
, fname
)
281 with
open(ift
, 'r') as sfile
:
282 for ln
in sfile
.readlines():
289 elif ln
[1] == 'inout':
293 if not ganged
.has_key(bus
):
295 ganged
[bus
].append(name
)
299 def ifacedef(self
, f
, *args
):
300 for (name
, count
) in self
.ifacecount
:
301 for i
in range(count
):
302 f
.write(self
.data
[name
].ifacedef(i
))
304 def busfmt(self
, f
, *args
):
305 f
.write("import BUtils::*;\n\n")
306 for (name
, count
) in self
.ifacecount
:
307 for i
in range(count
):
308 bf
= self
.data
[name
].busfmt(i
)
311 def ifacefmt(self
, f
, *args
):
313 // interface declaration between %s-{0} and pinmux'''
314 for (name
, count
) in self
.ifacecount
:
315 for i
in range(count
):
316 c
= comment
% name
.upper()
318 f
.write(self
.data
[name
].ifacefmt(i
))
320 def wirefmt(self
, f
, *args
):
321 comment
= '\n // following wires capture signals ' \
322 'to IO CELL if %s-{0} is\n' \
324 for (name
, count
) in self
.ifacecount
:
325 for i
in range(count
):
328 f
.write(self
.data
[name
].wirefmt(i
))
331 # ========= Interface declarations ================ #
333 mux_interface
= MuxInterface('cell', [{'name': 'mux', 'ready': False,
335 'bitspec': '{1}', 'action': True}])
337 io_interface
= IOInterface(
339 [{'name': 'cell', 'enabled': False, 'bitspec': 'GenericIOType'},
340 {'name': 'inputval', 'action': True, 'io': True}, ])
342 # == Peripheral Interface definitions == #
343 # these are the interface of the peripherals to the pin mux
344 # Outputs from the peripherals will be inputs to the pinmux
345 # module. Hence the change in direction for most pins
347 # ======================================= #
350 if __name__
== '__main__':
352 uartinterface_decl
= Interface('uart',
354 {'name': 'tx', 'action': True},
357 twiinterface_decl
= Interface('twi',
358 [{'name': 'sda', 'outen': True},
359 {'name': 'scl', 'outen': True},
362 def _pinmunge(p
, sep
, repl
, dedupe
=True):
363 """ munges the text so it's easier to compare.
364 splits by separator, strips out blanks, re-joins.
369 p
= filter(lambda x
: x
, p
) # filter out blanks
373 """ munges the text so it's easier to compare.
375 # first join lines by semicolons, strip out returns
377 p
= map(lambda x
: x
.replace('\n', ''), p
)
379 # now split first by brackets, then spaces (deduping on spaces)
380 p
= _pinmunge(p
, "(", " ( ", False)
381 p
= _pinmunge(p
, ")", " ) ", False)
382 p
= _pinmunge(p
, " ", " ")
388 for p1
, p2
in zip(l1
, l2
):
394 ifaces
= Interfaces()
396 ifaceuart
= ifaces
['uart']
397 print (ifaceuart
.ifacedef(0))
398 print (uartinterface_decl
.ifacedef(0))
399 assert ifaceuart
.ifacedef(0) == uartinterface_decl
.ifacedef(0)
401 ifacetwi
= ifaces
['twi']
402 print (ifacetwi
.ifacedef(0))
403 print (twiinterface_decl
.ifacedef(0))
404 assert ifacetwi
.ifacedef(0) == twiinterface_decl
.ifacedef(0)