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
.spr
.pipeline
import SPRBasePipe
17 from soc
.fu
.spr
.pipe_data
import SPRPipeSpec
21 def get_cu_inputs(dec2
, sim
):
22 """naming (res) must conform to SPRFunctionUnit 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_fast_spr1(res
, sim
, dec2
) # SPR1
29 yield from ALUHelpers
.get_rd_sim_xer_ca(res
, sim
, dec2
) # XER.ca
30 yield from ALUHelpers
.get_sim_xer_ov(res
, sim
, dec2
) # XER.ov
31 yield from ALUHelpers
.get_sim_xer_so(res
, sim
, dec2
) # XER.so
33 print ("spr get_cu_inputs", res
)
39 def set_alu_inputs(alu
, dec2
, sim
):
40 # TODO: see https://bugs.libre-soc.org/show_bug.cgi?id=305#c43
41 # detect the immediate here (with m.If(self.i.ctx.op.imm_data.imm_ok))
42 # and place it into data_i.b
44 inp
= yield from get_cu_inputs(dec2
, sim
)
45 yield from ALUHelpers
.set_int_ra(alu
, dec2
, inp
)
46 yield from ALUHelpers
.set_xer_ca(alu
, dec2
, inp
)
47 yield from ALUHelpers
.set_xer_ov(alu
, dec2
, inp
)
48 yield from ALUHelpers
.set_xer_so(alu
, dec2
, inp
)
51 yield from ALUHelpers
.set_fast_spr1(alu
, dec2
, inp
)
54 # This test bench is a bit different than is usual. Initially when I
55 # was writing it, I had all of the tests call a function to create a
56 # device under test and simulator, initialize the dut, run the
57 # simulation for ~2 cycles, and assert that the dut output what it
58 # should have. However, this was really slow, since it needed to
59 # create and tear down the dut and simulator for every test case.
61 # Now, instead of doing that, every test case in SPRTestCase puts some
62 # data into the test_data list below, describing the instructions to
63 # be tested and the initial state. Once all the tests have been run,
64 # test_data gets passed to TestRunner which then sets up the DUT and
65 # simulator once, runs all the data through it, and asserts that the
66 # results match the pseudocode sim at every cycle.
68 # By doing this, I've reduced the time it takes to run the test suite
69 # massively. Before, it took around 1 minute on my computer, now it
70 # takes around 3 seconds
73 class SPRTestCase(FHDLTestCase
):
76 def __init__(self
, name
):
77 super().__init
__(name
)
80 def run_tst_program(self
, prog
, initial_regs
=None, initial_sprs
=None):
81 tc
= TestCase(prog
, self
.test_name
, initial_regs
, initial_sprs
)
82 self
.test_data
.append(tc
)
84 def test_1_mfspr(self
):
85 lst
= ["mfspr 1, 26", # SRR0
88 initial_regs
= [0] * 32
89 initial_sprs
= {'SRR0': 0x12345678, 'SRR1': 0x5678, 'LR': 0x1234}
90 self
.run_tst_program(Program(lst
), initial_regs
, initial_sprs
)
93 pspec
= SPRPipeSpec(id_wid
=2)
94 alu
= SPRBasePipe(pspec
)
95 vl
= rtlil
.convert(alu
, ports
=alu
.ports())
96 with
open("trap_pipeline.il", "w") as f
:
100 class TestRunner(FHDLTestCase
):
101 def __init__(self
, test_data
):
102 super().__init
__("run_all")
103 self
.test_data
= test_data
108 instruction
= Signal(32)
110 pdecode
= create_pdecode()
112 m
.submodules
.pdecode2
= pdecode2
= PowerDecode2(pdecode
)
114 pspec
= SPRPipeSpec(id_wid
=2)
115 m
.submodules
.alu
= alu
= SPRBasePipe(pspec
)
117 comb
+= alu
.p
.data_i
.ctx
.op
.eq_from_execute1(pdecode2
.e
)
118 comb
+= alu
.p
.valid_i
.eq(1)
119 comb
+= alu
.n
.ready_i
.eq(1)
120 comb
+= pdecode2
.dec
.raw_opcode_in
.eq(instruction
)
125 for test
in self
.test_data
:
126 print("test", test
.name
)
127 print ("sprs", test
.sprs
)
128 program
= test
.program
129 self
.subTest(test
.name
)
130 sim
= ISA(pdecode2
, test
.regs
, test
.sprs
, test
.cr
,
132 gen
= program
.generate_instructions()
133 instructions
= list(zip(gen
, program
.assembly
.splitlines()))
135 pc
= sim
.pc
.CIA
.value
137 while index
< len(instructions
):
138 ins
, code
= instructions
[index
]
140 print("pc %08x instr: %08x" % (pc
, ins
& 0xffffffff))
144 so
= 1 if sim
.spr
['XER'][XER_bits
['SO']] else 0
145 ov
= 1 if sim
.spr
['XER'][XER_bits
['OV']] else 0
146 ov32
= 1 if sim
.spr
['XER'][XER_bits
['OV32']] else 0
147 print ("before: so/ov/32", so
, ov
, ov32
)
149 # ask the decoder to decode this binary data (endian'd)
150 yield pdecode2
.dec
.bigendian
.eq(0) # little / big?
151 yield instruction
.eq(ins
) # raw binary instr.
154 fast_in
= yield pdecode2
.e
.read_fast1
.data
155 spr_in
= yield pdecode2
.e
.read_spr1
.data
156 print ("dec2 spr/fast in", fast_in
, spr_in
)
158 fast_out
= yield pdecode2
.e
.write_fast1
.data
159 spr_out
= yield pdecode2
.e
.write_spr
.data
160 print ("dec2 spr/fast in", fast_out
, spr_out
)
162 fn_unit
= yield pdecode2
.e
.fn_unit
163 self
.assertEqual(fn_unit
, Function
.SPR
.value
)
164 yield from set_alu_inputs(alu
, pdecode2
, sim
)
166 opname
= code
.split(' ')[0]
167 yield from sim
.call(opname
)
168 pc
= sim
.pc
.CIA
.value
170 print("pc after %08x" % (pc
))
172 vld
= yield alu
.n
.valid_o
175 vld
= yield alu
.n
.valid_o
178 yield from self
.check_alu_outputs(alu
, pdecode2
, sim
, code
)
180 sim
.add_sync_process(process
)
181 with sim
.write_vcd("alu_simulator.vcd", "simulator.gtkw",
185 def check_alu_outputs(self
, alu
, dec2
, sim
, code
):
187 rc
= yield dec2
.e
.rc
.data
188 cridx_ok
= yield dec2
.e
.write_cr
.ok
189 cridx
= yield dec2
.e
.write_cr
.data
191 print ("check extra output", repr(code
), cridx_ok
, cridx
)
193 self
.assertEqual(cridx
, 0, code
)
198 yield from ALUHelpers
.get_int_o(res
, alu
, dec2
)
199 yield from ALUHelpers
.get_fast_spr1(res
, alu
, dec2
)
200 yield from ALUHelpers
.get_xer_ov(res
, alu
, dec2
)
201 yield from ALUHelpers
.get_xer_ca(res
, alu
, dec2
)
202 yield from ALUHelpers
.get_xer_so(res
, alu
, dec2
)
204 print ("output", res
)
206 yield from ALUHelpers
.get_sim_int_o(sim_o
, sim
, dec2
)
207 yield from ALUHelpers
.get_wr_sim_cr_a(sim_o
, sim
, dec2
)
208 yield from ALUHelpers
.get_sim_xer_ov(sim_o
, sim
, dec2
)
209 yield from ALUHelpers
.get_wr_sim_xer_ca(sim_o
, sim
, dec2
)
210 yield from ALUHelpers
.get_wr_fast_spr1(sim_o
, sim
, dec2
)
212 ALUHelpers
.check_xer_ov(self
, res
, sim_o
, code
)
213 ALUHelpers
.check_xer_ca(self
, res
, sim_o
, code
)
214 ALUHelpers
.check_int_o(self
, res
, sim_o
, code
)
215 ALUHelpers
.check_fast_spr1(self
, res
, sim_o
, code
)
216 ALUHelpers
.check_xer_so(self
, res
, sim_o
, code
)
219 if __name__
== "__main__":
220 unittest
.main(exit
=False)
221 suite
= unittest
.TestSuite()
222 suite
.addTest(TestRunner(SPRTestCase
.test_data
))
224 runner
= unittest
.TextTestRunner()