1 from nmigen
import Module
, Signal
2 from nmigen
.back
.pysim
import Simulator
, Delay
, Settle
3 from nmigen
.test
.utils
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
)
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
.logical
.pipeline
import LogicalBasePipe
16 from soc
.alu
.alu_input_record
import CompALUOpSubset
17 from soc
.alu
.pipe_data
import ALUPipeSpec
22 def __init__(self
, program
, regs
, sprs
, name
):
23 self
.program
= program
28 def get_rec_width(rec
):
30 # Setup random inputs for dut.op
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 reg3_ok
= yield dec2
.e
.read_reg3
.ok
42 reg1_ok
= yield dec2
.e
.read_reg1
.ok
43 assert reg3_ok
!= reg1_ok
45 data1
= yield dec2
.e
.read_reg3
.data
46 data1
= sim
.gpr(data1
).value
48 data1
= yield dec2
.e
.read_reg1
.data
49 data1
= sim
.gpr(data1
).value
53 yield alu
.p
.data_i
.a
.eq(data1
)
55 # If there's an immediate, set the B operand to that
56 reg2_ok
= yield dec2
.e
.read_reg2
.ok
57 imm_ok
= yield dec2
.e
.imm_data
.imm_ok
59 data2
= yield dec2
.e
.imm_data
.imm
61 data2
= yield dec2
.e
.read_reg2
.data
62 data2
= sim
.gpr(data2
).value
65 yield alu
.p
.data_i
.b
.eq(data2
)
69 def set_extra_alu_inputs(alu
, dec2
, sim
):
70 carry
= 1 if sim
.spr
['XER'][XER_bits
['CA']] else 0
71 yield alu
.p
.data_i
.carry_in
.eq(carry
)
72 so
= 1 if sim
.spr
['XER'][XER_bits
['SO']] else 0
73 yield alu
.p
.data_i
.so
.eq(so
)
76 # This test bench is a bit different than is usual. Initially when I
77 # was writing it, I had all of the tests call a function to create a
78 # device under test and simulator, initialize the dut, run the
79 # simulation for ~2 cycles, and assert that the dut output what it
80 # should have. However, this was really slow, since it needed to
81 # create and tear down the dut and simulator for every test case.
83 # Now, instead of doing that, every test case in ALUTestCase puts some
84 # data into the test_data list below, describing the instructions to
85 # be tested and the initial state. Once all the tests have been run,
86 # test_data gets passed to TestRunner which then sets up the DUT and
87 # simulator once, runs all the data through it, and asserts that the
88 # results match the pseudocode sim at every cycle.
90 # By doing this, I've reduced the time it takes to run the test suite
91 # massively. Before, it took around 1 minute on my computer, now it
92 # takes around 3 seconds
97 class LogicalTestCase(FHDLTestCase
):
98 def __init__(self
, name
):
99 super().__init
__(name
)
100 self
.test_name
= name
101 def run_tst_program(self
, prog
, initial_regs
=[0] * 32, initial_sprs
={}):
102 tc
= TestCase(prog
, initial_regs
, initial_sprs
, self
.test_name
)
106 insns
= ["and", "or", "xor"]
108 choice
= random
.choice(insns
)
109 lst
= [f
"{choice} 3, 1, 2"]
110 initial_regs
= [0] * 32
111 initial_regs
[1] = random
.randint(0, (1<<64)-1)
112 initial_regs
[2] = random
.randint(0, (1<<64)-1)
113 self
.run_tst_program(Program(lst
), initial_regs
)
115 def test_rand_imm_logical(self
):
116 insns
= ["andi.", "andis.", "ori", "oris", "xori", "xoris"]
118 choice
= random
.choice(insns
)
119 imm
= random
.randint(0, (1<<16)-1)
120 lst
= [f
"{choice} 3, 1, {imm}"]
122 initial_regs
= [0] * 32
123 initial_regs
[1] = random
.randint(0, (1<<64)-1)
124 self
.run_tst_program(Program(lst
), initial_regs
)
126 @unittest.skip("broken")
128 insns
= ["cntlzd", "cnttzd"]
130 choice
= random
.choice(insns
)
131 lst
= [f
"{choice} 3, 1"]
133 initial_regs
= [0] * 32
134 initial_regs
[1] = random
.randint(0, (1<<64)-1)
135 self
.run_tst_program(Program(lst
), initial_regs
)
137 def test_parity(self
):
138 insns
= ["prtyw", "prtyd"]
140 choice
= random
.choice(insns
)
141 lst
= [f
"{choice} 3, 1"]
143 initial_regs
= [0] * 32
144 initial_regs
[1] = random
.randint(0, (1<<64)-1)
145 self
.run_tst_program(Program(lst
), initial_regs
)
147 @unittest.skip("broken")
148 def test_popcnt(self
):
149 insns
= ["popcntb", "popcntw", "popcntd"]
151 choice
= random
.choice(insns
)
152 lst
= [f
"{choice} 3, 1"]
154 initial_regs
= [0] * 32
155 initial_regs
[1] = random
.randint(0, (1<<64)-1)
156 self
.run_tst_program(Program(lst
), initial_regs
)
159 lst
= ["cmpb 3, 1, 2"]
160 initial_regs
= [0] * 32
161 initial_regs
[1] = 0xdeadbeefcafec0de
162 initial_regs
[2] = 0xd0adb0000afec1de
163 self
.run_tst_program(Program(lst
), initial_regs
)
165 def test_ilang(self
):
166 rec
= CompALUOpSubset()
168 pspec
= ALUPipeSpec(id_wid
=2, op_wid
=get_rec_width(rec
))
169 alu
= LogicalBasePipe(pspec
)
170 vl
= rtlil
.convert(alu
, ports
=[])
171 with
open("logical_pipeline.il", "w") as f
:
175 class TestRunner(FHDLTestCase
):
176 def __init__(self
, test_data
):
177 super().__init
__("run_all")
178 self
.test_data
= test_data
183 instruction
= Signal(32)
185 pdecode
= create_pdecode()
187 m
.submodules
.pdecode2
= pdecode2
= PowerDecode2(pdecode
)
189 rec
= CompALUOpSubset()
191 pspec
= ALUPipeSpec(id_wid
=2, op_wid
=get_rec_width(rec
))
192 m
.submodules
.alu
= alu
= LogicalBasePipe(pspec
)
194 comb
+= alu
.p
.data_i
.ctx
.op
.eq_from_execute1(pdecode2
.e
)
195 comb
+= alu
.p
.valid_i
.eq(1)
196 comb
+= alu
.n
.ready_i
.eq(1)
197 comb
+= pdecode2
.dec
.raw_opcode_in
.eq(instruction
)
202 for test
in self
.test_data
:
204 program
= test
.program
205 self
.subTest(test
.name
)
206 simulator
= ISA(pdecode2
, test
.regs
, test
.sprs
)
207 gen
= program
.generate_instructions()
208 instructions
= list(zip(gen
, program
.assembly
.splitlines()))
210 index
= simulator
.pc
.CIA
.value
//4
211 while index
< len(instructions
):
212 ins
, code
= instructions
[index
]
214 print("0x{:X}".format(ins
& 0xffffffff))
217 # ask the decoder to decode this binary data (endian'd)
218 yield pdecode2
.dec
.bigendian
.eq(0) # little / big?
219 yield instruction
.eq(ins
) # raw binary instr.
221 fn_unit
= yield pdecode2
.e
.fn_unit
222 self
.assertEqual(fn_unit
, Function
.LOGICAL
.value
, code
)
223 yield from set_alu_inputs(alu
, pdecode2
, simulator
)
224 yield from set_extra_alu_inputs(alu
, pdecode2
, simulator
)
226 opname
= code
.split(' ')[0]
227 yield from simulator
.call(opname
)
228 index
= simulator
.pc
.CIA
.value
//4
230 vld
= yield alu
.n
.valid_o
233 vld
= yield alu
.n
.valid_o
235 alu_out
= yield alu
.n
.data_o
.o
236 out_reg_valid
= yield pdecode2
.e
.write_reg
.ok
238 write_reg_idx
= yield pdecode2
.e
.write_reg
.data
239 expected
= simulator
.gpr(write_reg_idx
).value
240 print(f
"expected {expected:x}, actual: {alu_out:x}")
241 self
.assertEqual(expected
, alu_out
, code
)
242 yield from self
.check_extra_alu_outputs(alu
, pdecode2
,
245 sim
.add_sync_process(process
)
246 with sim
.write_vcd("simulator.vcd", "simulator.gtkw",
249 def check_extra_alu_outputs(self
, alu
, dec2
, sim
):
250 rc
= yield dec2
.e
.rc
.data
252 cr_expected
= sim
.crl
[0].get_range().value
253 cr_actual
= yield alu
.n
.data_o
.cr0
254 self
.assertEqual(cr_expected
, cr_actual
)
257 if __name__
== "__main__":
258 unittest
.main(exit
=False)
259 suite
= unittest
.TestSuite()
260 suite
.addTest(TestRunner(test_data
))
262 runner
= unittest
.TextTestRunner()