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
.fu
.logical
.pipeline
import LogicalBasePipe
16 from soc
.fu
.alu
.alu_input_record
import CompALUOpSubset
17 from soc
.fu
.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 carry32
= 1 if sim
.spr
['XER'][XER_bits
['CA32']] else 0
72 yield alu
.p
.data_i
.xer_ca
[0].eq(carry
)
73 yield alu
.p
.data_i
.xer_ca
[1].eq(carry32
)
74 so
= 1 if sim
.spr
['XER'][XER_bits
['SO']] else 0
75 yield alu
.p
.data_i
.xer_so
.eq(so
)
78 # This test bench is a bit different than is usual. Initially when I
79 # was writing it, I had all of the tests call a function to create a
80 # device under test and simulator, initialize the dut, run the
81 # simulation for ~2 cycles, and assert that the dut output what it
82 # should have. However, this was really slow, since it needed to
83 # create and tear down the dut and simulator for every test case.
85 # Now, instead of doing that, every test case in ALUTestCase puts some
86 # data into the test_data list below, describing the instructions to
87 # be tested and the initial state. Once all the tests have been run,
88 # test_data gets passed to TestRunner which then sets up the DUT and
89 # simulator once, runs all the data through it, and asserts that the
90 # results match the pseudocode sim at every cycle.
92 # By doing this, I've reduced the time it takes to run the test suite
93 # massively. Before, it took around 1 minute on my computer, now it
94 # takes around 3 seconds
99 class LogicalTestCase(FHDLTestCase
):
100 def __init__(self
, name
):
101 super().__init
__(name
)
102 self
.test_name
= name
103 def run_tst_program(self
, prog
, initial_regs
=[0] * 32, initial_sprs
={}):
104 tc
= TestCase(prog
, initial_regs
, initial_sprs
, self
.test_name
)
108 insns
= ["and", "or", "xor"]
110 choice
= random
.choice(insns
)
111 lst
= [f
"{choice} 3, 1, 2"]
112 initial_regs
= [0] * 32
113 initial_regs
[1] = random
.randint(0, (1<<64)-1)
114 initial_regs
[2] = random
.randint(0, (1<<64)-1)
115 self
.run_tst_program(Program(lst
), initial_regs
)
117 def test_rand_imm_logical(self
):
118 insns
= ["andi.", "andis.", "ori", "oris", "xori", "xoris"]
120 choice
= random
.choice(insns
)
121 imm
= random
.randint(0, (1<<16)-1)
122 lst
= [f
"{choice} 3, 1, {imm}"]
124 initial_regs
= [0] * 32
125 initial_regs
[1] = random
.randint(0, (1<<64)-1)
126 self
.run_tst_program(Program(lst
), initial_regs
)
129 insns
= ["cntlzd", "cnttzd", "cntlzw", "cnttzw"]
131 choice
= random
.choice(insns
)
132 lst
= [f
"{choice} 3, 1"]
134 initial_regs
= [0] * 32
135 initial_regs
[1] = random
.randint(0, (1<<64)-1)
136 self
.run_tst_program(Program(lst
), initial_regs
)
138 def test_parity(self
):
139 insns
= ["prtyw", "prtyd"]
141 choice
= random
.choice(insns
)
142 lst
= [f
"{choice} 3, 1"]
144 initial_regs
= [0] * 32
145 initial_regs
[1] = random
.randint(0, (1<<64)-1)
146 self
.run_tst_program(Program(lst
), initial_regs
)
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
)
158 def test_popcnt_edge(self
):
159 insns
= ["popcntb", "popcntw", "popcntd"]
161 lst
= [f
"{choice} 3, 1"]
162 initial_regs
= [0] * 32
164 self
.run_tst_program(Program(lst
), initial_regs
)
167 lst
= ["cmpb 3, 1, 2"]
168 initial_regs
= [0] * 32
169 initial_regs
[1] = 0xdeadbeefcafec0de
170 initial_regs
[2] = 0xd0adb0000afec1de
171 self
.run_tst_program(Program(lst
), initial_regs
)
173 def test_ilang(self
):
174 rec
= CompALUOpSubset()
176 pspec
= ALUPipeSpec(id_wid
=2, op_wid
=get_rec_width(rec
))
177 alu
= LogicalBasePipe(pspec
)
178 vl
= rtlil
.convert(alu
, ports
=alu
.ports())
179 with
open("logical_pipeline.il", "w") as f
:
183 class TestRunner(FHDLTestCase
):
184 def __init__(self
, test_data
):
185 super().__init
__("run_all")
186 self
.test_data
= test_data
191 instruction
= Signal(32)
193 pdecode
= create_pdecode()
195 m
.submodules
.pdecode2
= pdecode2
= PowerDecode2(pdecode
)
197 rec
= CompALUOpSubset()
199 pspec
= ALUPipeSpec(id_wid
=2, op_wid
=get_rec_width(rec
))
200 m
.submodules
.alu
= alu
= LogicalBasePipe(pspec
)
202 comb
+= alu
.p
.data_i
.ctx
.op
.eq_from_execute1(pdecode2
.e
)
203 comb
+= alu
.p
.valid_i
.eq(1)
204 comb
+= alu
.n
.ready_i
.eq(1)
205 comb
+= pdecode2
.dec
.raw_opcode_in
.eq(instruction
)
210 for test
in self
.test_data
:
212 program
= test
.program
213 self
.subTest(test
.name
)
214 simulator
= ISA(pdecode2
, test
.regs
, test
.sprs
, 0)
215 gen
= program
.generate_instructions()
216 instructions
= list(zip(gen
, program
.assembly
.splitlines()))
218 index
= simulator
.pc
.CIA
.value
//4
219 while index
< len(instructions
):
220 ins
, code
= instructions
[index
]
222 print("0x{:X}".format(ins
& 0xffffffff))
225 # ask the decoder to decode this binary data (endian'd)
226 yield pdecode2
.dec
.bigendian
.eq(0) # little / big?
227 yield instruction
.eq(ins
) # raw binary instr.
229 fn_unit
= yield pdecode2
.e
.fn_unit
230 self
.assertEqual(fn_unit
, Function
.LOGICAL
.value
, code
)
231 yield from set_alu_inputs(alu
, pdecode2
, simulator
)
232 yield from set_extra_alu_inputs(alu
, pdecode2
, simulator
)
234 opname
= code
.split(' ')[0]
235 yield from simulator
.call(opname
)
236 index
= simulator
.pc
.CIA
.value
//4
238 vld
= yield alu
.n
.valid_o
241 vld
= yield alu
.n
.valid_o
243 alu_out
= yield alu
.n
.data_o
.o
244 out_reg_valid
= yield pdecode2
.e
.write_reg
.ok
246 write_reg_idx
= yield pdecode2
.e
.write_reg
.data
247 expected
= simulator
.gpr(write_reg_idx
).value
248 print(f
"expected {expected:x}, actual: {alu_out:x}")
249 self
.assertEqual(expected
, alu_out
, code
)
250 yield from self
.check_extra_alu_outputs(alu
, pdecode2
,
253 sim
.add_sync_process(process
)
254 with sim
.write_vcd("simulator.vcd", "simulator.gtkw",
257 def check_extra_alu_outputs(self
, alu
, dec2
, sim
, code
):
258 rc
= yield dec2
.e
.rc
.data
260 cr_expected
= sim
.crl
[0].get_range().value
261 cr_actual
= yield alu
.n
.data_o
.cr0
.data
262 self
.assertEqual(cr_expected
, cr_actual
, code
)
265 if __name__
== "__main__":
266 unittest
.main(exit
=False)
267 suite
= unittest
.TestSuite()
268 suite
.addTest(TestRunner(test_data
))
270 runner
= unittest
.TextTestRunner()