1 """ Unit tests for Buffered and Unbuffered pipelines
3 contains useful worked examples of how to use the Pipeline API,
6 * Combinatorial Stage "Chaining"
7 * class-based data stages
8 * nmigen module-based data stages
9 * special nmigen module-based data stage, where the stage *is* the module
10 * Record-based data stages
11 * static-class data stages
12 * multi-stage pipelines (and how to connect them)
13 * how to *use* the pipelines (see Test5) - how to get data in and out
17 from nmigen
import Module
, Signal
, Mux
18 from nmigen
.hdl
.rec
import Record
19 from nmigen
.compat
.sim
import run_simulation
20 from nmigen
.cli
import verilog
, rtlil
22 from example_buf_pipe
import ExampleBufPipe
, ExampleBufPipeAdd
23 from example_buf_pipe
import ExamplePipeline
, UnbufferedPipeline
24 from example_buf_pipe
import ExampleStageCls
25 from example_buf_pipe
import PrevControl
, NextControl
, BufferedPipeline
26 from example_buf_pipe
import StageChain
, ControlBase
, StageCls
28 from random
import randint
31 def check_o_n_valid(dut
, val
):
32 o_n_valid
= yield dut
.n
.o_valid
33 assert o_n_valid
== val
35 def check_o_n_valid2(dut
, val
):
36 o_n_valid
= yield dut
.n
.o_valid
37 assert o_n_valid
== val
41 #yield dut.i_p_rst.eq(1)
42 yield dut
.n
.i_ready
.eq(0)
43 yield dut
.p
.o_ready
.eq(0)
46 #yield dut.i_p_rst.eq(0)
47 yield dut
.n
.i_ready
.eq(1)
48 yield dut
.p
.i_data
.eq(5)
49 yield dut
.p
.i_valid
.eq(1)
52 yield dut
.p
.i_data
.eq(7)
53 yield from check_o_n_valid(dut
, 0) # effects of i_p_valid delayed
55 yield from check_o_n_valid(dut
, 1) # ok *now* i_p_valid effect is felt
57 yield dut
.p
.i_data
.eq(2)
59 yield dut
.n
.i_ready
.eq(0) # begin going into "stall" (next stage says ready)
60 yield dut
.p
.i_data
.eq(9)
62 yield dut
.p
.i_valid
.eq(0)
63 yield dut
.p
.i_data
.eq(12)
65 yield dut
.p
.i_data
.eq(32)
66 yield dut
.n
.i_ready
.eq(1)
68 yield from check_o_n_valid(dut
, 1) # buffer still needs to output
70 yield from check_o_n_valid(dut
, 1) # buffer still needs to output
72 yield from check_o_n_valid(dut
, 0) # buffer outputted, *now* we're done.
77 #yield dut.p.i_rst.eq(1)
78 yield dut
.n
.i_ready
.eq(0)
79 #yield dut.p.o_ready.eq(0)
82 #yield dut.p.i_rst.eq(0)
83 yield dut
.n
.i_ready
.eq(1)
84 yield dut
.p
.i_data
.eq(5)
85 yield dut
.p
.i_valid
.eq(1)
88 yield dut
.p
.i_data
.eq(7)
89 yield from check_o_n_valid2(dut
, 0) # effects of i_p_valid delayed 2 clocks
91 yield from check_o_n_valid2(dut
, 0) # effects of i_p_valid delayed 2 clocks
93 yield dut
.p
.i_data
.eq(2)
95 yield from check_o_n_valid2(dut
, 1) # ok *now* i_p_valid effect is felt
96 yield dut
.n
.i_ready
.eq(0) # begin going into "stall" (next stage says ready)
97 yield dut
.p
.i_data
.eq(9)
99 yield dut
.p
.i_valid
.eq(0)
100 yield dut
.p
.i_data
.eq(12)
102 yield dut
.p
.i_data
.eq(32)
103 yield dut
.n
.i_ready
.eq(1)
105 yield from check_o_n_valid2(dut
, 1) # buffer still needs to output
107 yield from check_o_n_valid2(dut
, 1) # buffer still needs to output
109 yield from check_o_n_valid2(dut
, 1) # buffer still needs to output
111 yield from check_o_n_valid2(dut
, 0) # buffer outputted, *now* we're done.
118 def __init__(self
, dut
, resultfn
):
120 self
.resultfn
= resultfn
122 for i
in range(num_tests
):
123 #data.append(randint(0, 1<<16-1))
124 self
.data
.append(i
+1)
129 while self
.o
!= len(self
.data
):
130 send_range
= randint(0, 3)
131 for j
in range(randint(1,10)):
135 send
= randint(0, send_range
) != 0
136 o_p_ready
= yield self
.dut
.p
.o_ready
140 if send
and self
.i
!= len(self
.data
):
141 yield self
.dut
.p
.i_valid
.eq(1)
142 yield self
.dut
.p
.i_data
.eq(self
.data
[self
.i
])
145 yield self
.dut
.p
.i_valid
.eq(0)
149 while self
.o
!= len(self
.data
):
150 stall_range
= randint(0, 3)
151 for j
in range(randint(1,10)):
152 stall
= randint(0, stall_range
) != 0
153 yield self
.dut
.n
.i_ready
.eq(stall
)
155 o_n_valid
= yield self
.dut
.n
.o_valid
156 i_n_ready
= yield self
.dut
.n
.i_ready
157 if not o_n_valid
or not i_n_ready
:
159 o_data
= yield self
.dut
.n
.o_data
160 self
.resultfn(o_data
, self
.data
[self
.o
], self
.i
, self
.o
)
162 if self
.o
== len(self
.data
):
165 def test3_resultfn(o_data
, expected
, i
, o
):
166 assert o_data
== expected
+ 1, \
167 "%d-%d data %x not match %x\n" \
168 % (i
, o
, o_data
, expected
)
170 def data_placeholder():
172 for i
in range(num_tests
):
174 d
.src1
= randint(0, 1<<16-1)
175 d
.src2
= randint(0, 1<<16-1)
181 for i
in range(num_tests
):
182 data
.append({'src1': randint(0, 1<<16-1),
183 'src2': randint(0, 1<<16-1)})
188 def __init__(self
, dut
, resultfn
, data
=None):
190 self
.resultfn
= resultfn
195 for i
in range(num_tests
):
196 self
.data
.append((randint(0, 1<<16-1), randint(0, 1<<16-1)))
201 while self
.o
!= len(self
.data
):
202 send_range
= randint(0, 3)
203 for j
in range(randint(1,10)):
207 send
= randint(0, send_range
) != 0
208 o_p_ready
= yield self
.dut
.p
.o_ready
212 if send
and self
.i
!= len(self
.data
):
213 yield self
.dut
.p
.i_valid
.eq(1)
214 for v
in self
.dut
.set_input(self
.data
[self
.i
]):
218 yield self
.dut
.p
.i_valid
.eq(0)
222 while self
.o
!= len(self
.data
):
223 stall_range
= randint(0, 3)
224 for j
in range(randint(1,10)):
225 stall
= randint(0, stall_range
) != 0
226 yield self
.dut
.n
.i_ready
.eq(stall
)
228 o_n_valid
= yield self
.dut
.n
.o_valid
229 i_n_ready
= yield self
.dut
.n
.i_ready
230 if not o_n_valid
or not i_n_ready
:
232 if isinstance(self
.dut
.n
.o_data
, Record
):
234 dod
= self
.dut
.n
.o_data
235 for k
, v
in dod
.fields
.items():
238 o_data
= yield self
.dut
.n
.o_data
239 self
.resultfn(o_data
, self
.data
[self
.o
], self
.i
, self
.o
)
241 if self
.o
== len(self
.data
):
244 def test5_resultfn(o_data
, expected
, i
, o
):
245 res
= expected
[0] + expected
[1]
246 assert o_data
== res
, \
247 "%d-%d data %x not match %s\n" \
248 % (i
, o
, o_data
, repr(expected
))
252 for i
in range(num_tests
):
253 #data.append(randint(0, 1<<16-1))
258 stall
= randint(0, 3) != 0
259 send
= randint(0, 5) != 0
260 yield dut
.n
.i_ready
.eq(stall
)
261 o_p_ready
= yield dut
.p
.o_ready
263 if send
and i
!= len(data
):
264 yield dut
.p
.i_valid
.eq(1)
265 yield dut
.p
.i_data
.eq(data
[i
])
268 yield dut
.p
.i_valid
.eq(0)
270 o_n_valid
= yield dut
.n
.o_valid
271 i_n_ready
= yield dut
.n
.i_ready
272 if o_n_valid
and i_n_ready
:
273 o_data
= yield dut
.n
.o_data
274 assert o_data
== data
[o
] + 2, "%d-%d data %x not match %x\n" \
275 % (i
, o
, o_data
, data
[o
])
280 ######################################################################
282 ######################################################################
284 class ExampleBufPipe2(ControlBase
):
285 """ Example of how to do chained pipeline stages.
288 def elaborate(self
, platform
):
291 pipe1
= ExampleBufPipe()
292 pipe2
= ExampleBufPipe()
294 m
.submodules
.pipe1
= pipe1
295 m
.submodules
.pipe2
= pipe2
297 m
.d
.comb
+= self
.connect([pipe1
, pipe2
])
302 ######################################################################
304 ######################################################################
306 class ExampleBufPipeChain2(BufferedPipeline
):
307 """ connects two stages together as a *single* combinatorial stage.
310 stage1
= ExampleStageCls()
311 stage2
= ExampleStageCls()
312 combined
= StageChain([stage1
, stage2
])
313 BufferedPipeline
.__init
__(self
, combined
)
318 for i
in range(num_tests
):
319 data
.append(randint(0, 1<<16-2))
323 def test9_resultfn(o_data
, expected
, i
, o
):
325 assert o_data
== res
, \
326 "%d-%d data %x not match %s\n" \
327 % (i
, o
, o_data
, repr(expected
))
330 ######################################################################
332 ######################################################################
335 def __init__(self
, width
, signed
):
337 self
.src1
= Signal((width
, signed
), name
="src1")
338 self
.src2
= Signal((width
, signed
), name
="src2")
339 self
.output
= Signal(width
, name
="out")
341 def elaborate(self
, platform
):
342 self
.m
.d
.comb
+= self
.output
.eq(Mux(self
.src1
< self
.src2
, 1, 0))
346 class LTStage(StageCls
):
347 """ module-based stage example
350 self
.slt
= SetLessThan(16, True)
353 return (Signal(16, name
="sig1"), Signal(16, "sig2"))
356 return Signal(16, "out")
358 def setup(self
, m
, i
):
360 m
.submodules
.slt
= self
.slt
361 m
.d
.comb
+= self
.slt
.src1
.eq(i
[0])
362 m
.d
.comb
+= self
.slt
.src2
.eq(i
[1])
363 m
.d
.comb
+= self
.o
.eq(self
.slt
.output
)
365 def process(self
, i
):
369 class LTStageDerived(SetLessThan
, StageCls
):
370 """ special version of a nmigen module where the module is also a stage
372 shows that you don't actually need to combinatorially connect
373 to the outputs, or add the module as a submodule: just return
374 the module output parameter(s) from the Stage.process() function
378 SetLessThan
.__init
__(self
, 16, True)
381 return (Signal(16), Signal(16))
386 def setup(self
, m
, i
):
387 m
.submodules
.slt
= self
388 m
.d
.comb
+= self
.src1
.eq(i
[0])
389 m
.d
.comb
+= self
.src2
.eq(i
[1])
391 def process(self
, i
):
395 class ExampleLTPipeline(UnbufferedPipeline
):
396 """ an example of how to use the unbuffered pipeline.
401 UnbufferedPipeline
.__init
__(self
, stage
)
404 class ExampleLTBufferedPipeDerived(BufferedPipeline
):
405 """ an example of how to use the buffered pipeline.
409 stage
= LTStageDerived()
410 BufferedPipeline
.__init
__(self
, stage
)
413 def test6_resultfn(o_data
, expected
, i
, o
):
414 res
= 1 if expected
[0] < expected
[1] else 0
415 assert o_data
== res
, \
416 "%d-%d data %x not match %s\n" \
417 % (i
, o
, o_data
, repr(expected
))
420 ######################################################################
422 ######################################################################
424 class ExampleAddRecordStage(StageCls
):
425 """ example use of a Record
428 record_spec
= [('src1', 16), ('src2', 16)]
430 """ returns a Record using the specification
432 return Record(self
.record_spec
)
435 return Record(self
.record_spec
)
437 def process(self
, i
):
438 """ process the input data, returning a dictionary with key names
439 that exactly match the Record's attributes.
441 return {'src1': i
.src1
+ 1,
444 ######################################################################
446 ######################################################################
448 class ExampleAddRecordPlaceHolderStage(StageCls
):
449 """ example use of a Record, with a placeholder as the processing result
452 record_spec
= [('src1', 16), ('src2', 16)]
454 """ returns a Record using the specification
456 return Record(self
.record_spec
)
459 return Record(self
.record_spec
)
461 def process(self
, i
):
462 """ process the input data, returning a PlaceHolder class instance
463 with attributes that exactly match those of the Record.
471 class PlaceHolder
: pass
474 class ExampleAddRecordPipe(UnbufferedPipeline
):
475 """ an example of how to use the combinatorial pipeline.
479 stage
= ExampleAddRecordStage()
480 UnbufferedPipeline
.__init
__(self
, stage
)
483 def test7_resultfn(o_data
, expected
, i
, o
):
484 res
= (expected
['src1'] + 1, expected
['src2'] + 1)
485 assert o_data
['src1'] == res
[0] and o_data
['src2'] == res
[1], \
486 "%d-%d data %s not match %s\n" \
487 % (i
, o
, repr(o_data
), repr(expected
))
490 class ExampleAddRecordPlaceHolderPipe(UnbufferedPipeline
):
491 """ an example of how to use the combinatorial pipeline.
495 stage
= ExampleAddRecordPlaceHolderStage()
496 UnbufferedPipeline
.__init
__(self
, stage
)
499 def test11_resultfn(o_data
, expected
, i
, o
):
500 res1
= expected
.src1
+ 1
501 res2
= expected
.src2
+ 1
502 assert o_data
['src1'] == res1
and o_data
['src2'] == res2
, \
503 "%d-%d data %s not match %s\n" \
504 % (i
, o
, repr(o_data
), repr(expected
))
507 ######################################################################
509 ######################################################################
512 class Example2OpClass
:
513 """ an example of a class used to store 2 operands.
514 requires an eq function, to conform with the pipeline stage API
518 self
.op1
= Signal(16)
519 self
.op2
= Signal(16)
522 return [self
.op1
.eq(i
.op1
), self
.op2
.eq(i
.op2
)]
525 class ExampleAddClassStage(StageCls
):
526 """ an example of how to use the buffered pipeline, as a class instance
530 """ returns an instance of an Example2OpClass.
532 return Example2OpClass()
535 """ returns an output signal which will happen to contain the sum
540 def process(self
, i
):
541 """ process the input data (sums the values in the tuple) and returns it
546 class ExampleBufPipeAddClass(BufferedPipeline
):
547 """ an example of how to use the buffered pipeline, using a class instance
551 addstage
= ExampleAddClassStage()
552 BufferedPipeline
.__init
__(self
, addstage
)
556 """ the eq function, called by set_input, needs an incoming object
557 that conforms to the Example2OpClass.eq function requirements
558 easiest way to do that is to create a class that has the exact
559 same member layout (self.op1, self.op2) as Example2OpClass
561 def __init__(self
, op1
, op2
):
566 def test8_resultfn(o_data
, expected
, i
, o
):
567 res
= expected
.op1
+ expected
.op2
# these are a TestInputAdd instance
568 assert o_data
== res
, \
569 "%d-%d data %x not match %s\n" \
570 % (i
, o
, o_data
, repr(expected
))
574 for i
in range(num_tests
):
575 data
.append(TestInputAdd(randint(0, 1<<16-1), randint(0, 1<<16-1)))
581 if __name__
== '__main__':
583 dut
= ExampleBufPipe()
584 run_simulation(dut
, testbench(dut
), vcd_name
="test_bufpipe.vcd")
587 dut
= ExampleBufPipe2()
588 run_simulation(dut
, testbench2(dut
), vcd_name
="test_bufpipe2.vcd")
589 ports
= [dut
.p
.i_valid
, dut
.n
.i_ready
,
590 dut
.n
.o_valid
, dut
.p
.o_ready
] + \
591 [dut
.p
.i_data
] + [dut
.n
.o_data
]
592 vl
= rtlil
.convert(dut
, ports
=ports
)
593 with
open("test_bufpipe2.il", "w") as f
:
598 dut
= ExampleBufPipe()
599 test
= Test3(dut
, test3_resultfn
)
600 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_bufpipe3.vcd")
603 dut
= ExamplePipeline()
604 test
= Test3(dut
, test3_resultfn
)
605 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_combpipe3.vcd")
608 dut
= ExampleBufPipe2()
609 run_simulation(dut
, testbench4(dut
), vcd_name
="test_bufpipe4.vcd")
612 dut
= ExampleBufPipeAdd()
613 test
= Test5(dut
, test5_resultfn
)
614 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_bufpipe5.vcd")
617 dut
= ExampleLTPipeline()
618 test
= Test5(dut
, test6_resultfn
)
619 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_ltcomb6.vcd")
621 ports
= [dut
.p
.i_valid
, dut
.n
.i_ready
,
622 dut
.n
.o_valid
, dut
.p
.o_ready
] + \
623 list(dut
.p
.i_data
) + [dut
.n
.o_data
]
624 vl
= rtlil
.convert(dut
, ports
=ports
)
625 with
open("test_ltcomb_pipe.il", "w") as f
:
629 dut
= ExampleAddRecordPipe()
631 test
= Test5(dut
, test7_resultfn
, data
=data
)
632 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_addrecord.vcd")
634 ports
= [dut
.p
.i_valid
, dut
.n
.i_ready
,
635 dut
.n
.o_valid
, dut
.p
.o_ready
,
636 dut
.p
.i_data
.src1
, dut
.p
.i_data
.src2
,
637 dut
.n
.o_data
.src1
, dut
.n
.o_data
.src2
]
638 vl
= rtlil
.convert(dut
, ports
=ports
)
639 with
open("test_recordcomb_pipe.il", "w") as f
:
643 dut
= ExampleBufPipeAddClass()
645 test
= Test5(dut
, test8_resultfn
, data
=data
)
646 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_bufpipe8.vcd")
649 dut
= ExampleBufPipeChain2()
650 ports
= [dut
.p
.i_valid
, dut
.n
.i_ready
,
651 dut
.n
.o_valid
, dut
.p
.o_ready
] + \
652 [dut
.p
.i_data
] + [dut
.n
.o_data
]
653 vl
= rtlil
.convert(dut
, ports
=ports
)
654 with
open("test_bufpipechain2.il", "w") as f
:
658 test
= Test5(dut
, test9_resultfn
, data
=data
)
659 run_simulation(dut
, [test
.send
, test
.rcv
],
660 vcd_name
="test_bufpipechain2.vcd")
663 dut
= ExampleLTBufferedPipeDerived()
664 test
= Test5(dut
, test6_resultfn
)
665 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_ltbufpipe10.vcd")
666 vl
= rtlil
.convert(dut
, ports
=ports
)
667 with
open("test_ltbufpipe10.il", "w") as f
:
671 dut
= ExampleAddRecordPlaceHolderPipe()
672 data
=data_placeholder()
673 test
= Test5(dut
, test11_resultfn
, data
=data
)
674 run_simulation(dut
, [test
.send
, test
.rcv
], vcd_name
="test_addrecord.vcd")