1 """ Example 5: Making use of PyRTL and Introspection. """
3 from collections
.abc
import Sequence
5 from nmigen
import Signal
6 from nmigen
.hdl
.rec
import Record
7 from nmigen
import tracer
8 from nmigen
.compat
.fhdl
.bitcontainer
import value_bits_sign
9 from contextlib
import contextmanager
11 from singlepipe
import eq
, StageCls
, ControlBase
, BufferedPipeline
12 from singlepipe
import UnbufferedPipeline
15 # The following example shows how pyrtl can be used to make some interesting
16 # hardware structures using python introspection. In particular, this example
17 # makes a N-stage pipeline structure. Any specific pipeline is then a derived
18 # class of SimplePipeline where methods with names starting with "stage" are
19 # stages, and new members with names not starting with "_" are to be registered
22 def like(value
, rname
, pipe
, pipemode
=False):
23 if isinstance(value
, ObjectProxy
):
24 return ObjectProxy
.like(pipe
, value
, pipemode
=pipemode
,
25 name
=rname
, reset_less
=True)
27 return Signal(value_bits_sign(value
), name
=rname
,
29 return Signal
.like(value
, name
=rname
, reset_less
=True)
31 def get_assigns(_assigns
):
34 if isinstance(e
, ObjectProxy
):
35 assigns
+= get_assigns(e
._assigns
)
44 if isinstance(e
, ObjectProxy
):
45 eqs
+= get_eqs(e
._eqs
)
52 def __init__(self
, m
, name
=None, pipemode
=False):
55 name
= tracer
.get_var_name(default
=None)
57 self
._pipemode
= pipemode
63 def like(cls
, m
, value
, pipemode
=False, name
=None, src_loc_at
=0, **kwargs
):
64 name
= name
or tracer
.get_var_name(depth
=2 + src_loc_at
,
67 src_loc_at_1
= 1 + src_loc_at
68 r
= ObjectProxy(m
, value
.name
, pipemode
)
69 #for a, aname in value._preg_map.items():
70 # r._preg_map[aname] = like(a, aname, m, pipemode)
71 for a
in value
.ports():
73 r
._preg
_map
[aname
] = like(a
, aname
, m
, pipemode
)
78 for a
in self
.ports():
80 ai
= self
._preg
_map
[aname
]
81 subobjs
.append(repr(ai
))
82 return "<OP %s>" % subobjs
84 def get_specs(self
, liked
=False):
86 for k
, v
in self
._preg
_map
.items():
87 #v = like(v, k, stage._m)
89 if isinstance(v
, ObjectProxy
):
94 print ("ObjectProxy eq", self
, i
)
96 for a
in self
.ports():
98 ai
= i
._preg
_map
[aname
]
104 for aname
, a
in self
._preg
_map
.items():
105 if isinstance(a
, Signal
) or isinstance(a
, ObjectProxy
) or \
106 isinstance(a
, Record
):
108 #print ("ObjectPorts", res)
111 def __getattr__(self
, name
):
113 v
= self
._preg
_map
[name
]
115 #return like(v, name, self._m)
117 raise AttributeError(
118 'error, no pipeline register "%s" defined for OP %s'
121 def __setattr__(self
, name
, value
):
122 if name
.startswith('_') or name
in ['name', 'ports', 'eq', 'like']:
123 # do not do anything tricky with variables starting with '_'
124 object.__setattr
__(self
, name
, value
)
126 #rname = "%s_%s" % (self.name, name)
128 new_pipereg
= like(value
, rname
, self
._m
, self
._pipemode
)
129 self
._preg
_map
[name
] = new_pipereg
130 #object.__setattr__(self, name, new_pipereg)
132 print ("OP pipemode", new_pipereg
, value
)
133 #self._m.d.comb += eq(new_pipereg, value)
136 print ("OP !pipemode assign", new_pipereg
, value
, type(value
))
137 self
._m
.d
.comb
+= eq(new_pipereg
, value
)
139 print ("OP !pipemode !m", new_pipereg
, value
, type(value
))
140 self
._assigns
+= eq(new_pipereg
, value
)
141 if isinstance(value
, ObjectProxy
):
142 print ("OP, defer assigns:", value
._assigns
)
143 self
._assigns
+= value
._assigns
144 self
._eqs
.append(value
._eqs
)
148 """ Pipeline builder stage with auto generation of pipeline registers.
151 def __init__(self
, name
, m
, prev
=None, pipemode
=False, ispec
=None):
153 self
._stagename
= name
154 self
._preg
_map
= {'__nextstage__': {}}
155 self
._prev
_stage
= prev
158 self
._preg
_map
[self
._stagename
] = ispec
160 print ("prev", prev
._stagename
, prev
._preg
_map
)
161 #if prev._stagename in prev._preg_map:
162 # m = prev._preg_map[prev._stagename]
163 # self._preg_map[prev._stagename] = m
164 if '__nextstage__' in prev
._preg
_map
:
165 m
= prev
._preg
_map
['__nextstage__']
167 self
._preg
_map
[self
._stagename
] = m
168 #for k, v in m.items():
169 #m[k] = like(v, k, self._m)
170 print ("make current", self
._stagename
, m
)
171 self
._pipemode
= pipemode
175 def __getattribute__(self
, name
):
176 if name
.startswith('_'):
177 return object.__getattribute
__(self
, name
)
178 #if name in self._preg_map['__nextstage__']:
179 # return self._preg_map['__nextstage__'][name]
181 print ("getattr", name
, object.__getattribute
__(self
, '_preg_map'))
182 v
= self
._preg
_map
[self
._stagename
][name
]
184 #return like(v, name, self._m)
186 raise AttributeError(
187 'error, no pipeline register "%s" defined for stage %s'
188 % (name
, self
._stagename
))
190 def __setattr__(self
, name
, value
):
191 if name
.startswith('_'):
192 # do not do anything tricky with variables starting with '_'
193 object.__setattr
__(self
, name
, value
)
195 pipereg_id
= self
._stagename
196 rname
= 'pipereg_' + pipereg_id
+ '_' + name
197 new_pipereg
= like(value
, rname
, self
._m
, self
._pipemode
)
198 next_stage
= '__nextstage__'
199 if next_stage
not in self
._preg
_map
:
200 self
._preg
_map
[next_stage
] = {}
201 self
._preg
_map
[next_stage
][name
] = new_pipereg
202 print ("setattr", name
, value
, self
._preg
_map
)
204 self
._eqs
[name
] = new_pipereg
205 assign
= eq(new_pipereg
, value
)
206 print ("pipemode: append", new_pipereg
, value
, assign
)
207 if isinstance(value
, ObjectProxy
):
208 print ("OP, assigns:", value
._assigns
)
209 self
._assigns
+= value
._assigns
210 self
._eqs
[name
]._eqs
= value
._eqs
211 #self._m.d.comb += assign
212 self
._assigns
+= assign
214 print ("!pipemode: assign", new_pipereg
, value
)
215 assign
= eq(new_pipereg
, value
)
216 self
._m
.d
.sync
+= assign
218 print ("!pipemode !m: defer assign", new_pipereg
, value
)
219 assign
= eq(new_pipereg
, value
)
220 self
._eqs
[name
] = new_pipereg
221 self
._assigns
+= assign
222 if isinstance(value
, ObjectProxy
):
223 print ("OP, defer assigns:", value
._assigns
)
224 self
._assigns
+= value
._assigns
225 self
._eqs
[name
]._eqs
= value
._eqs
230 res
.append(like(v
, v
.name
, None, pipemode
=True))
234 if not isinstance(specs
, dict):
235 return like(specs
, specs
.name
, None, pipemode
=True)
237 for k
, v
in specs
.items():
242 class AutoStage(StageCls
):
243 def __init__(self
, inspecs
, outspecs
, eqs
, assigns
):
244 self
.inspecs
, self
.outspecs
= inspecs
, outspecs
245 self
.eqs
, self
.assigns
= eqs
, assigns
246 #self.o = self.ospec()
247 def ispec(self
): return likedict(self
.inspecs
)
248 def ospec(self
): return likedict(self
.outspecs
)
250 def process(self
, i
):
251 print ("stage process", i
)
254 def setup(self
, m
, i
):
255 print ("stage setup i", i
, m
)
256 print ("stage setup inspecs", self
.inspecs
)
257 print ("stage setup outspecs", self
.outspecs
)
258 print ("stage setup eqs", self
.eqs
)
259 #self.o = self.ospec()
260 m
.d
.comb
+= eq(self
.inspecs
, i
)
261 #m.d.comb += eq(self.outspecs, self.eqs)
262 #m.d.comb += eq(self.o, i)
265 class AutoPipe(UnbufferedPipeline
):
266 def __init__(self
, stage
, assigns
):
267 UnbufferedPipeline
.__init
__(self
, stage
)
268 self
.assigns
= assigns
270 def elaborate(self
, platform
):
271 m
= UnbufferedPipeline
.elaborate(self
, platform
)
272 m
.d
.comb
+= self
.assigns
273 print ("assigns", self
.assigns
, m
)
278 def __init__(self
, m
, pipemode
=False, pipetype
=None):
280 self
.pipemode
= pipemode
281 self
.pipetype
= pipetype
284 def Stage(self
, name
, prev
=None, ispec
=None):
286 ispec
= likedict(ispec
)
287 print ("start stage", name
, ispec
)
288 stage
= PipelineStage(name
, None, prev
, self
.pipemode
, ispec
=ispec
)
290 yield stage
, self
.m
#stage._m
295 print ("use ispec", stage
._ispec
)
296 inspecs
= stage
._ispec
298 inspecs
= self
.get_specs(stage
, name
)
299 #inspecs = likedict(inspecs)
300 outspecs
= self
.get_specs(stage
, '__nextstage__', liked
=True)
301 print ("stage inspecs", name
, inspecs
)
302 print ("stage outspecs", name
, outspecs
)
303 eqs
= stage
._eqs
# get_eqs(stage._eqs)
304 assigns
= get_assigns(stage
._assigns
)
305 print ("stage eqs", name
, eqs
)
306 print ("stage assigns", name
, assigns
)
307 s
= AutoStage(inspecs
, outspecs
, eqs
, assigns
)
308 self
.stages
.append(s
)
309 print ("end stage", name
, self
.pipemode
, "\n")
311 def get_specs(self
, stage
, name
, liked
=False):
312 return stage
._preg
_map
[name
]
313 if name
in stage
._preg
_map
:
315 for k
, v
in stage
._preg
_map
[name
].items():
316 #v = like(v, k, stage._m)
318 #if isinstance(v, ObjectProxy):
319 # res += v.get_specs()
327 def __exit__(self
, *args
):
328 print ("exit stage", args
)
331 for s
in self
.stages
:
332 print ("stage specs", s
, s
.inspecs
, s
.outspecs
)
333 if self
.pipetype
== 'buffered':
334 p
= BufferedPipeline(s
)
336 p
= AutoPipe(s
, s
.assigns
)
338 self
.m
.submodules
+= p
340 self
.m
.d
.comb
+= cb
.connect(pipes
)
343 class SimplePipeline
:
344 """ Pipeline builder with auto generation of pipeline registers.
347 def __init__(self
, m
):
349 self
._pipeline
_register
_map
= {}
350 self
._current
_stage
_num
= 0
354 for method
in dir(self
):
355 if method
.startswith('stage'):
356 stage_list
.append(method
)
357 for stage
in sorted(stage_list
):
358 stage_method
= getattr(self
, stage
)
360 self
._current
_stage
_num
+= 1
362 def __getattr__(self
, name
):
364 return self
._pipeline
_register
_map
[self
._current
_stage
_num
][name
]
366 raise AttributeError(
367 'error, no pipeline register "%s" defined for stage %d'
368 % (name
, self
._current
_stage
_num
))
370 def __setattr__(self
, name
, value
):
371 if name
.startswith('_'):
372 # do not do anything tricky with variables starting with '_'
373 object.__setattr
__(self
, name
, value
)
375 next_stage
= self
._current
_stage
_num
+ 1
376 pipereg_id
= str(self
._current
_stage
_num
) + 'to' + str(next_stage
)
377 rname
= 'pipereg_' + pipereg_id
+ '_' + name
378 #new_pipereg = Signal(value_bits_sign(value), name=rname,
380 if isinstance(value
, ObjectProxy
):
381 new_pipereg
= ObjectProxy
.like(self
._m
, value
,
382 name
=rname
, reset_less
= True)
384 new_pipereg
= Signal
.like(value
, name
=rname
, reset_less
= True)
385 if next_stage
not in self
._pipeline
_register
_map
:
386 self
._pipeline
_register
_map
[next_stage
] = {}
387 self
._pipeline
_register
_map
[next_stage
][name
] = new_pipereg
388 self
._m
.d
.sync
+= eq(new_pipereg
, value
)