add mtmsr tests (fail)
[soc.git] / src / soc / fu / trap / test / test_pipe_caller.py
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
5 import unittest
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
13
14
15 from soc.fu.test.common import (TestCase, ALUHelpers)
16 from soc.fu.trap.pipeline import TrapBasePipe
17 from soc.fu.trap.pipe_data import TrapPipeSpec
18 import random
19
20
21 def get_cu_inputs(dec2, sim):
22 """naming (res) must conform to TrapFunctionUnit input regspec
23 """
24 res = {}
25
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_sim_fast_spr2(res, sim, dec2) # SPR2
30 ALUHelpers.get_sim_cia(res, sim, dec2) # PC
31 ALUHelpers.get_sim_msr(res, sim, dec2) # MSR
32
33 print ("alu get_cu_inputs", res)
34
35 return res
36
37
38
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
43
44 inp = yield from get_cu_inputs(dec2, sim)
45 yield from ALUHelpers.set_int_ra(alu, dec2, inp)
46 yield from ALUHelpers.set_int_rb(alu, dec2, inp)
47 yield from ALUHelpers.set_fast_spr1(alu, dec2, inp) # SPR1
48 yield from ALUHelpers.set_fast_spr2(alu, dec2, inp) # SPR1
49
50 yield from ALUHelpers.set_cia(alu, dec2, inp)
51 yield from ALUHelpers.set_msr(alu, dec2, inp)
52
53
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.
60
61 # Now, instead of doing that, every test case in TrapTestCase 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.
67
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
71
72
73 class TrapTestCase(FHDLTestCase):
74 test_data = []
75
76 def __init__(self, name):
77 super().__init__(name)
78 self.test_name = name
79
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)
83
84 def test_1_rfid(self):
85 lst = ["rfid"]
86 initial_regs = [0] * 32
87 initial_regs[1] = 1
88 initial_sprs = {'SRR0': 0x12345678, 'SRR1': 0x5678}
89 self.run_tst_program(Program(lst), initial_regs, initial_sprs)
90
91 def test_0_trap_eq_imm(self):
92 insns = ["twi", "tdi"]
93 for i in range(2):
94 choice = random.choice(insns)
95 lst = [f"{choice} 4, 1, %d" % i] # TO=4: trap equal
96 initial_regs = [0] * 32
97 initial_regs[1] = 1
98 self.run_tst_program(Program(lst), initial_regs)
99
100 def test_0_trap_eq(self):
101 insns = ["tw", "td"]
102 for i in range(2):
103 choice = insns[i]
104 lst = [f"{choice} 4, 1, 2"] # TO=4: trap equal
105 initial_regs = [0] * 32
106 initial_regs[1] = 1
107 initial_regs[2] = 1
108 self.run_tst_program(Program(lst), initial_regs)
109
110 def test_3_mtmsr_0(self):
111 lst = ["mtmsr 1,0"]
112 initial_regs = [0] * 32
113 initial_regs[1] = 0xffffffffffffffff
114 self.run_tst_program(Program(lst), initial_regs)
115
116 def test_2_mtmsr_1(self):
117 lst = ["mtmsr 1,1"]
118 initial_regs = [0] * 32
119 initial_regs[1] = 0xffffffffffffffff
120 self.run_tst_program(Program(lst), initial_regs)
121
122 def test_999_illegal(self):
123 # ok, um this is a bit of a cheat: use an instruction we know
124 # is not implemented by either ISACaller or the core
125 lst = ["tbegin."]
126 initial_regs = [0] * 32
127 self.run_tst_program(Program(lst), initial_regs)
128
129 def test_ilang(self):
130 pspec = TrapPipeSpec(id_wid=2)
131 alu = TrapBasePipe(pspec)
132 vl = rtlil.convert(alu, ports=alu.ports())
133 with open("trap_pipeline.il", "w") as f:
134 f.write(vl)
135
136
137 class TestRunner(FHDLTestCase):
138 def __init__(self, test_data):
139 super().__init__("run_all")
140 self.test_data = test_data
141
142 def run_all(self):
143 m = Module()
144 comb = m.d.comb
145 instruction = Signal(32)
146
147 pdecode = create_pdecode()
148
149 m.submodules.pdecode2 = pdecode2 = PowerDecode2(pdecode)
150
151 pspec = TrapPipeSpec(id_wid=2)
152 m.submodules.alu = alu = TrapBasePipe(pspec)
153
154 comb += alu.p.data_i.ctx.op.eq_from_execute1(pdecode2.e)
155 comb += alu.p.valid_i.eq(1)
156 comb += alu.n.ready_i.eq(1)
157 comb += pdecode2.dec.raw_opcode_in.eq(instruction)
158 sim = Simulator(m)
159
160 sim.add_clock(1e-6)
161 def process():
162 for test in self.test_data:
163 print(test.name)
164 program = test.program
165 self.subTest(test.name)
166 sim = ISA(pdecode2, test.regs, test.sprs, test.cr,
167 test.mem, test.msr)
168 gen = program.generate_instructions()
169 instructions = list(zip(gen, program.assembly.splitlines()))
170
171 pc = sim.pc.CIA.value
172 index = pc//4
173 while index < len(instructions):
174 ins, code = instructions[index]
175
176 print("pc %08x instr: %08x" % (pc, ins & 0xffffffff))
177 print(code)
178 if 'XER' in sim.spr:
179 so = 1 if sim.spr['XER'][XER_bits['SO']] else 0
180 ov = 1 if sim.spr['XER'][XER_bits['OV']] else 0
181 ov32 = 1 if sim.spr['XER'][XER_bits['OV32']] else 0
182 print ("before: so/ov/32", so, ov, ov32)
183
184 # ask the decoder to decode this binary data (endian'd)
185 yield pdecode2.dec.bigendian.eq(0) # little / big?
186 yield instruction.eq(ins) # raw binary instr.
187 yield Settle()
188 fn_unit = yield pdecode2.e.do.fn_unit
189 self.assertEqual(fn_unit, Function.TRAP.value)
190 yield from set_alu_inputs(alu, pdecode2, sim)
191 yield
192 opname = code.split(' ')[0]
193 yield from sim.call(opname)
194 pc = sim.pc.CIA.value
195 index = pc//4
196 print("pc after %08x" % (pc))
197
198 vld = yield alu.n.valid_o
199 while not vld:
200 yield
201 vld = yield alu.n.valid_o
202 yield
203
204 yield from self.check_alu_outputs(alu, pdecode2, sim, code)
205
206 sim.add_sync_process(process)
207 with sim.write_vcd("alu_simulator.vcd", "simulator.gtkw",
208 traces=[]):
209 sim.run()
210
211 def check_alu_outputs(self, alu, dec2, sim, code):
212
213 rc = yield dec2.e.do.rc.data
214 cridx_ok = yield dec2.e.write_cr.ok
215 cridx = yield dec2.e.write_cr.data
216
217 print ("check extra output", repr(code), cridx_ok, cridx)
218 if rc:
219 self.assertEqual(cridx, 0, code)
220
221 sim_o = {}
222 res = {}
223
224 yield from ALUHelpers.get_int_o(res, alu, dec2)
225 yield from ALUHelpers.get_fast_spr1(res, alu, dec2)
226 yield from ALUHelpers.get_fast_spr2(res, alu, dec2)
227 yield from ALUHelpers.get_nia(res, alu, dec2)
228 yield from ALUHelpers.get_msr(res, alu, dec2)
229
230 print ("output", res)
231
232 yield from ALUHelpers.get_sim_int_o(sim_o, sim, dec2)
233 yield from ALUHelpers.get_wr_fast_spr1(sim_o, sim, dec2)
234 yield from ALUHelpers.get_wr_fast_spr2(sim_o, sim, dec2)
235 ALUHelpers.get_sim_nia(sim_o, sim, dec2)
236 ALUHelpers.get_sim_msr(sim_o, sim, dec2)
237
238 print ("sim output", sim_o)
239
240 ALUHelpers.check_int_o(self, res, sim_o, code)
241 ALUHelpers.check_fast_spr1(self, res, sim_o, code)
242 ALUHelpers.check_fast_spr2(self, res, sim_o, code)
243 ALUHelpers.check_nia(self, res, sim_o, code)
244 ALUHelpers.check_msr(self, res, sim_o, code)
245
246
247 if __name__ == "__main__":
248 unittest.main(exit=False)
249 suite = unittest.TestSuite()
250 suite.addTest(TestRunner(TrapTestCase.test_data))
251
252 runner = unittest.TextTestRunner()
253 runner.run(suite)