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
85 print ("ObjectProxy eq", self
, i
)
87 for a
in self
.ports():
89 ai
= i
._preg
_map
[aname
]
95 for aname
, a
in self
._preg
_map
.items():
96 if isinstance(a
, Signal
) or isinstance(a
, ObjectProxy
) or \
97 isinstance(a
, Record
):
99 #print ("ObjectPorts", res)
102 def __getattr__(self
, name
):
104 v
= self
._preg
_map
[name
]
106 #return like(v, name, self._m)
108 raise AttributeError(
109 'error, no pipeline register "%s" defined for OP %s'
112 def __setattr__(self
, name
, value
):
113 if name
.startswith('_') or name
in ['name', 'ports', 'eq', 'like']:
114 # do not do anything tricky with variables starting with '_'
115 object.__setattr
__(self
, name
, value
)
117 #rname = "%s_%s" % (self.name, name)
119 new_pipereg
= like(value
, rname
, self
._m
, self
._pipemode
)
120 self
._preg
_map
[name
] = new_pipereg
121 #object.__setattr__(self, name, new_pipereg)
123 print ("OP pipemode", new_pipereg
, value
)
124 #self._eqs.append(value)
125 #self._m.d.comb += eq(new_pipereg, value)
128 print ("OP !pipemode assign", new_pipereg
, value
, type(value
))
129 self
._m
.d
.comb
+= eq(new_pipereg
, value
)
131 print ("OP !pipemode !m", new_pipereg
, value
, type(value
))
132 self
._assigns
+= eq(new_pipereg
, value
)
136 """ Pipeline builder stage with auto generation of pipeline registers.
139 def __init__(self
, name
, m
, prev
=None, pipemode
=False, ispec
=None):
141 self
._stagename
= name
143 self
._prev
_stage
= prev
146 print ("prev", prev
._stagename
, prev
._preg
_map
)
147 if prev
._stagename
in prev
._preg
_map
:
148 m
= prev
._preg
_map
[prev
._stagename
]
149 self
._preg
_map
[prev
._stagename
] = m
150 #for k, v in m.items():
151 #m[k] = like(v, k, self._m)
152 if '__nextstage__' in prev
._preg
_map
:
153 m
= prev
._preg
_map
['__nextstage__']
154 self
._preg
_map
[self
._stagename
] = m
155 #for k, v in m.items():
156 #m[k] = like(v, k, self._m)
157 print ("make current", self
._stagename
, m
)
158 self
._pipemode
= pipemode
162 def __getattr__(self
, name
):
164 v
= self
._preg
_map
[self
._stagename
][name
]
166 #return like(v, name, self._m)
168 raise AttributeError(
169 'error, no pipeline register "%s" defined for stage %s'
170 % (name
, self
._stagename
))
172 def __setattr__(self
, name
, value
):
173 if name
.startswith('_'):
174 # do not do anything tricky with variables starting with '_'
175 object.__setattr
__(self
, name
, value
)
177 pipereg_id
= self
._stagename
178 rname
= 'pipereg_' + pipereg_id
+ '_' + name
179 new_pipereg
= like(value
, rname
, self
._m
, self
._pipemode
)
180 next_stage
= '__nextstage__'
181 if next_stage
not in self
._preg
_map
:
182 self
._preg
_map
[next_stage
] = {}
183 self
._preg
_map
[next_stage
][name
] = new_pipereg
185 self
._eqs
.append(value
)
186 assign
= eq(new_pipereg
, value
)
187 print ("pipemode: append", new_pipereg
, value
, assign
)
188 if isinstance(value
, ObjectProxy
):
189 print ("OP, assigns:", value
._assigns
)
190 self
._assigns
+= value
._assigns
191 #self._eqs += value._eqs
192 #self._m.d.comb += assign
193 self
._assigns
+= assign
195 print ("!pipemode: assign", new_pipereg
, value
)
196 assign
= eq(new_pipereg
, value
)
197 self
._m
.d
.sync
+= assign
199 print ("!pipemode !m: defer assign", new_pipereg
, value
)
200 assign
= eq(new_pipereg
, value
)
201 self
._assigns
+= assign
202 if isinstance(value
, ObjectProxy
):
203 print ("OP, defer assigns:", value
._assigns
)
204 self
._assigns
+= value
._assigns
209 res
.append(like(v
, v
.name
, None, pipemode
=True))
212 class AutoStage(StageCls
):
213 def __init__(self
, inspecs
, outspecs
, eqs
, assigns
):
214 self
.inspecs
, self
.outspecs
= inspecs
, outspecs
215 self
.eqs
, self
.assigns
= eqs
, assigns
216 #self.o = self.ospec()
217 def ispec(self
): return likelist(self
.inspecs
)
218 def ospec(self
): return likelist(self
.outspecs
)
220 def process(self
, i
):
221 print ("stage process", i
)
224 def setup(self
, m
, i
):
225 #self.o = self.ospec()
226 m
.d
.comb
+= eq(self
.inspecs
, i
)
227 print ("stage setup", i
)
228 print ("stage setup inspecs", self
.inspecs
)
229 #m.d.comb += eq(self.o, i)
232 class AutoPipe(UnbufferedPipeline
):
233 def __init__(self
, stage
, assigns
):
234 UnbufferedPipeline
.__init
__(self
, stage
)
235 self
.assigns
= assigns
237 def elaborate(self
, platform
):
238 m
= UnbufferedPipeline
.elaborate(self
, platform
)
239 m
.d
.comb
+= self
.assigns
240 print ("assigns", self
.assigns
)
245 def __init__(self
, m
, pipemode
=False, pipetype
=None):
247 self
.pipemode
= pipemode
248 self
.pipetype
= pipetype
251 def Stage(self
, name
, prev
=None, ispec
=None):
252 print ("start stage", name
)
254 ispec
= likelist(ispec
)
255 stage
= PipelineStage(name
, None, prev
, self
.pipemode
, ispec
=ispec
)
257 yield stage
, self
.m
#stage._m
262 print ("use ispec", stage
._ispec
)
263 inspecs
= stage
._ispec
265 inspecs
= self
.get_specs(stage
, name
)
266 inspecs
= likelist(inspecs
)
267 outspecs
= self
.get_specs(stage
, '__nextstage__', liked
=True)
268 eqs
= get_eqs(stage
._eqs
)
269 assigns
= get_assigns(stage
._assigns
)
270 print ("stage eqs", name
, eqs
)
271 print ("stage assigns", name
, assigns
)
272 s
= AutoStage(inspecs
, outspecs
, eqs
, assigns
)
273 self
.stages
.append(s
)
274 print ("end stage", name
, self
.pipemode
, "\n")
276 def get_specs(self
, stage
, name
, liked
=False):
277 if name
in stage
._preg
_map
:
279 for k
, v
in stage
._preg
_map
[name
].items():
280 #v = like(v, k, stage._m)
289 def __exit__(self
, *args
):
290 print ("exit stage", args
)
293 for s
in self
.stages
:
294 print ("stage specs", s
, s
.inspecs
, s
.outspecs
)
295 if self
.pipetype
== 'buffered':
296 p
= BufferedPipeline(s
)
298 p
= AutoPipe(s
, s
.assigns
)
300 self
.m
.submodules
+= p
302 self
.m
.d
.comb
+= cb
.connect(pipes
)
305 class SimplePipeline
:
306 """ Pipeline builder with auto generation of pipeline registers.
309 def __init__(self
, m
):
311 self
._pipeline
_register
_map
= {}
312 self
._current
_stage
_num
= 0
316 for method
in dir(self
):
317 if method
.startswith('stage'):
318 stage_list
.append(method
)
319 for stage
in sorted(stage_list
):
320 stage_method
= getattr(self
, stage
)
322 self
._current
_stage
_num
+= 1
324 def __getattr__(self
, name
):
326 return self
._pipeline
_register
_map
[self
._current
_stage
_num
][name
]
328 raise AttributeError(
329 'error, no pipeline register "%s" defined for stage %d'
330 % (name
, self
._current
_stage
_num
))
332 def __setattr__(self
, name
, value
):
333 if name
.startswith('_'):
334 # do not do anything tricky with variables starting with '_'
335 object.__setattr
__(self
, name
, value
)
337 next_stage
= self
._current
_stage
_num
+ 1
338 pipereg_id
= str(self
._current
_stage
_num
) + 'to' + str(next_stage
)
339 rname
= 'pipereg_' + pipereg_id
+ '_' + name
340 #new_pipereg = Signal(value_bits_sign(value), name=rname,
342 if isinstance(value
, ObjectProxy
):
343 new_pipereg
= ObjectProxy
.like(self
._m
, value
,
344 name
=rname
, reset_less
= True)
346 new_pipereg
= Signal
.like(value
, name
=rname
, reset_less
= True)
347 if next_stage
not in self
._pipeline
_register
_map
:
348 self
._pipeline
_register
_map
[next_stage
] = {}
349 self
._pipeline
_register
_map
[next_stage
][name
] = new_pipereg
350 self
._m
.d
.sync
+= eq(new_pipereg
, value
)