fb6a4025346affe97ddeea2bfbafdbd11647d72c
1 from nmigen
import Module
, Signal
2 from nmigen
.back
.pysim
import Simulator
, Delay
, Settle
3 from nmutil
.formaltest
import FHDLTestCase
4 from nmigen
.cli
import rtlil
6 from soc
.decoder
.isa
.caller
import ISACaller
, special_sprs
7 from soc
.decoder
.power_decoder
import (create_pdecode
)
8 from soc
.decoder
.power_decoder2
import (PowerDecode2
)
9 from soc
.decoder
.power_enums
import (XER_bits
, Function
, InternalOp
, CryIn
)
10 from soc
.decoder
.selectable_int
import SelectableInt
11 from soc
.simulator
.program
import Program
12 from soc
.decoder
.isa
.all
import ISA
15 from soc
.fu
.test
.common
import (TestCase
, ALUHelpers
)
16 from soc
.fu
.div
.pipeline
import DIVBasePipe
17 from soc
.fu
.div
.pipe_data
import DIVPipeSpec
21 def get_cu_inputs(dec2
, sim
):
22 """naming (res) must conform to DIVFunctionUnit input regspec
26 yield from ALUHelpers
.get_sim_int_ra(res
, sim
, dec2
) # RA
27 yield from ALUHelpers
.get_sim_int_rb(res
, sim
, dec2
) # RB
28 yield from ALUHelpers
.get_sim_xer_so(res
, sim
, dec2
) # XER.so
30 print ("alu get_cu_inputs", res
)
36 def set_alu_inputs(alu
, dec2
, sim
):
37 # TODO: see https://bugs.libre-soc.org/show_bug.cgi?id=305#c43
38 # detect the immediate here (with m.If(self.i.ctx.op.imm_data.imm_ok))
39 # and place it into data_i.b
41 inp
= yield from get_cu_inputs(dec2
, sim
)
42 yield from ALUHelpers
.set_int_ra(alu
, dec2
, inp
)
43 yield from ALUHelpers
.set_int_rb(alu
, dec2
, inp
)
45 yield from ALUHelpers
.set_xer_so(alu
, dec2
, inp
)
48 # This test bench is a bit different than is usual. Initially when I
49 # was writing it, I had all of the tests call a function to create a
50 # device under test and simulator, initialize the dut, run the
51 # simulation for ~2 cycles, and assert that the dut output what it
52 # should have. However, this was really slow, since it needed to
53 # create and tear down the dut and simulator for every test case.
55 # Now, instead of doing that, every test case in DIVTestCase puts some
56 # data into the test_data list below, describing the instructions to
57 # be tested and the initial state. Once all the tests have been run,
58 # test_data gets passed to TestRunner which then sets up the DUT and
59 # simulator once, runs all the data through it, and asserts that the
60 # results match the pseudocode sim at every cycle.
62 # By doing this, I've reduced the time it takes to run the test suite
63 # massively. Before, it took around 1 minute on my computer, now it
64 # takes around 3 seconds
67 class DIVTestCase(FHDLTestCase
):
70 def __init__(self
, name
):
71 super().__init
__(name
)
74 def run_tst_program(self
, prog
, initial_regs
=None, initial_sprs
=None):
75 tc
= TestCase(prog
, self
.test_name
, initial_regs
, initial_sprs
)
76 self
.test_data
.append(tc
)
78 def test_rand_divw(self
):
79 insns
= ["divw", "divw.", "divwo", "divwo."]
81 choice
= random
.choice(insns
)
82 lst
= [f
"{choice} 3, 1, 2"]
83 initial_regs
= [0] * 32
84 initial_regs
[1] = random
.randint(0, (1<<64)-1)
85 initial_regs
[2] = random
.randint(0, (1<<64)-1)
86 self
.run_tst_program(Program(lst
), initial_regs
)
89 pspec
= DIVPipeSpec(id_wid
=2)
90 alu
= DIVBasePipe(pspec
)
91 vl
= rtlil
.convert(alu
, ports
=alu
.ports())
92 with
open("alu_pipeline.il", "w") as f
:
96 class TestRunner(FHDLTestCase
):
97 def __init__(self
, test_data
):
98 super().__init
__("run_all")
99 self
.test_data
= test_data
104 instruction
= Signal(32)
106 pdecode
= create_pdecode()
108 m
.submodules
.pdecode2
= pdecode2
= PowerDecode2(pdecode
)
110 pspec
= DIVPipeSpec(id_wid
=2)
111 m
.submodules
.alu
= alu
= DIVBasePipe(pspec
)
113 comb
+= alu
.p
.data_i
.ctx
.op
.eq_from_execute1(pdecode2
.e
)
114 comb
+= alu
.p
.valid_i
.eq(1)
115 comb
+= alu
.n
.ready_i
.eq(1)
116 comb
+= pdecode2
.dec
.raw_opcode_in
.eq(instruction
)
121 for test
in self
.test_data
:
123 program
= test
.program
124 self
.subTest(test
.name
)
125 sim
= ISA(pdecode2
, test
.regs
, test
.sprs
, test
.cr
,
127 gen
= program
.generate_instructions()
128 instructions
= list(zip(gen
, program
.assembly
.splitlines()))
130 index
= sim
.pc
.CIA
.value
//4
131 while index
< len(instructions
):
132 ins
, code
= instructions
[index
]
134 print("instruction: 0x{:X}".format(ins
& 0xffffffff))
137 so
= 1 if sim
.spr
['XER'][XER_bits
['SO']] else 0
138 ov
= 1 if sim
.spr
['XER'][XER_bits
['OV']] else 0
139 ov32
= 1 if sim
.spr
['XER'][XER_bits
['OV32']] else 0
140 print ("before: so/ov/32", so
, ov
, ov32
)
142 # ask the decoder to decode this binary data (endian'd)
143 yield pdecode2
.dec
.bigendian
.eq(0) # little / big?
144 yield instruction
.eq(ins
) # raw binary instr.
146 fn_unit
= yield pdecode2
.e
.do
.fn_unit
147 self
.assertEqual(fn_unit
, Function
.DIV
.value
)
148 yield from set_alu_inputs(alu
, pdecode2
, sim
)
150 opname
= code
.split(' ')[0]
151 yield from sim
.call(opname
)
152 index
= sim
.pc
.CIA
.value
//4
154 vld
= yield alu
.n
.valid_o
157 vld
= yield alu
.n
.valid_o
160 yield from self
.check_alu_outputs(alu
, pdecode2
, sim
, code
)
162 sim
.add_sync_process(process
)
163 with sim
.write_vcd("div_simulator.vcd", "div_simulator.gtkw",
167 def check_alu_outputs(self
, alu
, dec2
, sim
, code
):
169 rc
= yield dec2
.e
.do
.rc
.data
170 cridx_ok
= yield dec2
.e
.write_cr
.ok
171 cridx
= yield dec2
.e
.write_cr
.data
173 print ("check extra output", repr(code
), cridx_ok
, cridx
)
175 self
.assertEqual(cridx
, 0, code
)
177 oe
= yield dec2
.e
.do
.oe
.oe
178 oe_ok
= yield dec2
.e
.do
.oe
.ok
179 if not oe
or not oe_ok
:
180 # if OE not enabled, XER SO and OV must correspondingly be false
181 so_ok
= yield alu
.n
.data_o
.xer_so
.ok
182 ov_ok
= yield alu
.n
.data_o
.xer_ov
.ok
183 self
.assertEqual(so_ok
, False, code
)
184 self
.assertEqual(ov_ok
, False, code
)
189 yield from ALUHelpers
.get_cr_a(res
, alu
, dec2
)
190 yield from ALUHelpers
.get_xer_ov(res
, alu
, dec2
)
191 yield from ALUHelpers
.get_int_o(res
, alu
, dec2
)
192 yield from ALUHelpers
.get_xer_so(res
, alu
, dec2
)
194 yield from ALUHelpers
.get_sim_int_o(sim_o
, sim
, dec2
)
195 yield from ALUHelpers
.get_wr_sim_cr_a(sim_o
, sim
, dec2
)
196 yield from ALUHelpers
.get_sim_xer_ov(sim_o
, sim
, dec2
)
197 yield from ALUHelpers
.get_sim_xer_so(sim_o
, sim
, dec2
)
199 ALUHelpers
.check_cr_a(self
, res
, sim_o
, "CR%d %s" % (cridx
, code
))
200 ALUHelpers
.check_xer_ov(self
, res
, sim_o
, code
)
201 ALUHelpers
.check_int_o(self
, res
, sim_o
, code
)
202 ALUHelpers
.check_xer_so(self
, res
, sim_o
, code
)
205 if __name__
== "__main__":
206 unittest
.main(exit
=False)
207 suite
= unittest
.TestSuite()
208 suite
.addTest(TestRunner(DIVTestCase
.test_data
))
210 runner
= unittest
.TextTestRunner()