1f3d0942bc0a107b7453d025112b707669e44386
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 #self._eqs.append(new_pipereg)
142 if isinstance(value
, ObjectProxy
):
143 print ("OP, defer assigns:", value
._assigns
)
144 self
._assigns
+= value
._assigns
145 self
._eqs
.append(value
._eqs
)
149 """ Pipeline builder stage with auto generation of pipeline registers.
152 def __init__(self
, name
, m
, prev
=None, pipemode
=False, ispec
=None):
154 self
._stagename
= name
156 self
._prev
_stage
= prev
159 print ("prev", prev
._stagename
, prev
._preg
_map
)
160 if prev
._stagename
in prev
._preg
_map
:
161 m
= prev
._preg
_map
[prev
._stagename
]
162 self
._preg
_map
[prev
._stagename
] = m
163 #for k, v in m.items():
164 #m[k] = like(v, k, self._m)
165 if '__nextstage__' in prev
._preg
_map
:
166 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 __getattr__(self
, name
):
177 v
= self
._preg
_map
[self
._stagename
][name
]
179 #return like(v, name, self._m)
181 raise AttributeError(
182 'error, no pipeline register "%s" defined for stage %s'
183 % (name
, self
._stagename
))
185 def __setattr__(self
, name
, value
):
186 if name
.startswith('_'):
187 # do not do anything tricky with variables starting with '_'
188 object.__setattr
__(self
, name
, value
)
190 pipereg_id
= self
._stagename
191 rname
= 'pipereg_' + pipereg_id
+ '_' + name
192 new_pipereg
= like(value
, rname
, self
._m
, self
._pipemode
)
193 next_stage
= '__nextstage__'
194 if next_stage
not in self
._preg
_map
:
195 self
._preg
_map
[next_stage
] = {}
196 self
._preg
_map
[next_stage
][name
] = new_pipereg
198 self
._eqs
.append(new_pipereg
)
199 assign
= eq(new_pipereg
, value
)
200 print ("pipemode: append", new_pipereg
, value
, assign
)
201 if isinstance(value
, ObjectProxy
):
202 print ("OP, assigns:", value
._assigns
)
203 self
._assigns
+= value
._assigns
204 self
._eqs
+= value
._eqs
205 #self._m.d.comb += assign
206 self
._assigns
+= assign
208 print ("!pipemode: assign", new_pipereg
, value
)
209 assign
= eq(new_pipereg
, value
)
210 self
._m
.d
.sync
+= assign
212 print ("!pipemode !m: defer assign", new_pipereg
, value
)
213 assign
= eq(new_pipereg
, value
)
214 self
._assigns
+= assign
215 if isinstance(value
, ObjectProxy
):
216 print ("OP, defer assigns:", value
._assigns
)
217 self
._assigns
+= value
._assigns
222 res
.append(like(v
, v
.name
, None, pipemode
=True))
226 class AutoStage(StageCls
):
227 def __init__(self
, inspecs
, outspecs
, eqs
, assigns
):
228 self
.inspecs
, self
.outspecs
= inspecs
, outspecs
229 self
.eqs
, self
.assigns
= eqs
, assigns
230 #self.o = self.ospec()
231 def ispec(self
): return likelist(self
.inspecs
)
232 def ospec(self
): return likelist(self
.outspecs
)
234 def process(self
, i
):
235 print ("stage process", i
)
238 def setup(self
, m
, i
):
239 print ("stage setup i", i
)
240 print ("stage setup inspecs", self
.inspecs
)
241 print ("stage setup outspecs", self
.outspecs
)
242 print ("stage setup eqs", self
.eqs
)
243 #self.o = self.ospec()
244 m
.d
.comb
+= eq(self
.eqs
, i
)
245 #m.d.comb += eq(self.outspecs, self.eqs)
246 #m.d.comb += eq(self.o, i)
249 class AutoPipe(UnbufferedPipeline
):
250 def __init__(self
, stage
, assigns
):
251 UnbufferedPipeline
.__init
__(self
, stage
)
252 self
.assigns
= assigns
254 def elaborate(self
, platform
):
255 m
= UnbufferedPipeline
.elaborate(self
, platform
)
256 m
.d
.comb
+= self
.assigns
257 print ("assigns", self
.assigns
)
262 def __init__(self
, m
, pipemode
=False, pipetype
=None):
264 self
.pipemode
= pipemode
265 self
.pipetype
= pipetype
268 def Stage(self
, name
, prev
=None, ispec
=None):
269 print ("start stage", name
)
271 ispec
= likelist(ispec
)
272 stage
= PipelineStage(name
, None, prev
, self
.pipemode
, ispec
=ispec
)
274 yield stage
, self
.m
#stage._m
279 print ("use ispec", stage
._ispec
)
280 inspecs
= stage
._ispec
282 inspecs
= self
.get_specs(stage
, name
)
283 inspecs
= likelist(inspecs
)
284 outspecs
= self
.get_specs(stage
, '__nextstage__', liked
=True)
285 eqs
= get_eqs(stage
._eqs
)
286 assigns
= get_assigns(stage
._assigns
)
287 print ("stage eqs", name
, eqs
)
288 print ("stage assigns", name
, assigns
)
289 s
= AutoStage(inspecs
, outspecs
, eqs
, assigns
)
290 self
.stages
.append(s
)
291 print ("end stage", name
, self
.pipemode
, "\n")
293 def get_specs(self
, stage
, name
, liked
=False):
294 if name
in stage
._preg
_map
:
296 for k
, v
in stage
._preg
_map
[name
].items():
297 #v = like(v, k, stage._m)
299 #if isinstance(v, ObjectProxy):
300 # res += v.get_specs()
308 def __exit__(self
, *args
):
309 print ("exit stage", args
)
312 for s
in self
.stages
:
313 print ("stage specs", s
, s
.inspecs
, s
.outspecs
)
314 if self
.pipetype
== 'buffered':
315 p
= BufferedPipeline(s
)
317 p
= AutoPipe(s
, s
.assigns
)
319 self
.m
.submodules
+= p
321 self
.m
.d
.comb
+= cb
.connect(pipes
)
324 class SimplePipeline
:
325 """ Pipeline builder with auto generation of pipeline registers.
328 def __init__(self
, m
):
330 self
._pipeline
_register
_map
= {}
331 self
._current
_stage
_num
= 0
335 for method
in dir(self
):
336 if method
.startswith('stage'):
337 stage_list
.append(method
)
338 for stage
in sorted(stage_list
):
339 stage_method
= getattr(self
, stage
)
341 self
._current
_stage
_num
+= 1
343 def __getattr__(self
, name
):
345 return self
._pipeline
_register
_map
[self
._current
_stage
_num
][name
]
347 raise AttributeError(
348 'error, no pipeline register "%s" defined for stage %d'
349 % (name
, self
._current
_stage
_num
))
351 def __setattr__(self
, name
, value
):
352 if name
.startswith('_'):
353 # do not do anything tricky with variables starting with '_'
354 object.__setattr
__(self
, name
, value
)
356 next_stage
= self
._current
_stage
_num
+ 1
357 pipereg_id
= str(self
._current
_stage
_num
) + 'to' + str(next_stage
)
358 rname
= 'pipereg_' + pipereg_id
+ '_' + name
359 #new_pipereg = Signal(value_bits_sign(value), name=rname,
361 if isinstance(value
, ObjectProxy
):
362 new_pipereg
= ObjectProxy
.like(self
._m
, value
,
363 name
=rname
, reset_less
= True)
365 new_pipereg
= Signal
.like(value
, name
=rname
, reset_less
= True)
366 if next_stage
not in self
._pipeline
_register
_map
:
367 self
._pipeline
_register
_map
[next_stage
] = {}
368 self
._pipeline
_register
_map
[next_stage
][name
] = new_pipereg
369 self
._m
.d
.sync
+= eq(new_pipereg
, value
)