yield needed for unit tests to work (has to go)
[soc.git] / src / soc / fu / compunits / test / test_compunit.py
1 from nmigen import Module, Signal, ResetSignal
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.power_decoder import (create_pdecode)
7 from soc.decoder.power_decoder2 import (PowerDecode2)
8 from soc.decoder.power_enums import Function
9 from soc.decoder.isa.all import ISA
10
11 from soc.experiment.compalu_multi import find_ok # hack
12
13
14 def set_cu_input(cu, idx, data):
15 rdop = cu.get_in_name(idx)
16 yield cu.src_i[idx].eq(data)
17 while True:
18 rd_rel_o = yield cu.rd.rel[idx]
19 print ("rd_rel %d wait HI" % idx, rd_rel_o, rdop, hex(data))
20 if rd_rel_o:
21 break
22 yield
23 yield cu.rd.go[idx].eq(1)
24 while True:
25 yield
26 rd_rel_o = yield cu.rd.rel[idx]
27 if rd_rel_o:
28 break
29 print ("rd_rel %d wait HI" % idx, rd_rel_o)
30 yield
31 yield cu.rd.go[idx].eq(0)
32 yield cu.src_i[idx].eq(0)
33
34
35 def get_cu_output(cu, idx, code):
36 wrmask = yield cu.wrmask
37 wrop = cu.get_out_name(idx)
38 wrok = cu.get_out(idx)
39 fname = find_ok(wrok.fields)
40 wrok = yield getattr(wrok, fname)
41 print ("wr_rel mask", repr(code), idx, wrop, bin(wrmask), fname, wrok)
42 assert wrmask & (1<<idx), \
43 "get_cu_output '%s': mask bit %d not set\n" \
44 "write-operand '%s' Data.ok likely not set (%s)" \
45 % (code, idx, wrop, hex(wrok))
46 while True:
47 wr_relall_o = yield cu.wr.rel
48 wr_rel_o = yield cu.wr.rel[idx]
49 print ("wr_rel %d wait" % idx, hex(wr_relall_o), wr_rel_o)
50 if wr_rel_o:
51 break
52 yield
53 yield cu.wr.go[idx].eq(1)
54 yield Settle()
55 result = yield cu.dest[idx]
56 yield
57 yield cu.wr.go[idx].eq(0)
58 print ("result", repr(code), idx, wrop, wrok, hex(result))
59
60 return result
61
62
63 def set_cu_inputs(cu, inp):
64 for idx, data in inp.items():
65 yield from set_cu_input(cu, idx, data)
66
67
68 def set_operand(cu, dec2, sim):
69 yield from cu.oper_i.eq_from_execute1(dec2.e)
70 yield cu.issue_i.eq(1)
71 yield
72 yield cu.issue_i.eq(0)
73 yield
74
75
76 def get_cu_outputs(cu, code):
77 res = {}
78 wrmask = yield cu.wrmask
79 print ("get_cu_outputs", cu.n_dst, wrmask)
80 if not wrmask: # no point waiting (however really should doublecheck wr.rel)
81 return {}
82 # wait for at least one result
83 while True:
84 wr_rel_o = yield cu.wr.rel
85 if wr_rel_o:
86 break
87 yield
88 for i in range(cu.n_dst):
89 wr_rel_o = yield cu.wr.rel[i]
90 if wr_rel_o:
91 result = yield from get_cu_output(cu, i, code)
92 wrop = cu.get_out_name(i)
93 print ("output", i, wrop, hex(result))
94 res[wrop] = result
95 return res
96
97
98 def get_inp_indexed(cu, inp):
99 res = {}
100 for i in range(cu.n_src):
101 wrop = cu.get_in_name(i)
102 if wrop in inp:
103 res[i] = inp[wrop]
104 return res
105
106
107 class TestRunner(FHDLTestCase):
108 def __init__(self, test_data, fukls, iodef, funit):
109 super().__init__("run_all")
110 self.test_data = test_data
111 self.fukls = fukls
112 self.iodef = iodef
113 self.funit = funit
114
115 def run_all(self):
116 m = Module()
117 comb = m.d.comb
118 instruction = Signal(32)
119
120 pdecode = create_pdecode()
121
122 m.submodules.pdecode2 = pdecode2 = PowerDecode2(pdecode)
123 if self.funit == Function.LDST:
124 from soc.experiment.l0_cache import TstL0CacheBuffer
125 m.submodules.l0 = l0 = TstL0CacheBuffer(n_units=1, regwid=64)
126 pi = l0.l0.dports[0].pi
127 m.submodules.cu = cu = self.fukls(pi, awid=4)
128 m.d.comb += cu.ad.go.eq(cu.ad.rel) # link addr-go direct to rel
129 m.d.comb += cu.st.go.eq(cu.st.rel) # link store-go direct to rel
130 else:
131 m.submodules.cu = cu = self.fukls()
132
133 comb += pdecode2.dec.raw_opcode_in.eq(instruction)
134 sim = Simulator(m)
135
136 sim.add_clock(1e-6)
137
138 def process():
139 yield cu.issue_i.eq(0)
140 yield
141
142 for test in self.test_data:
143 print(test.name)
144 program = test.program
145 self.subTest(test.name)
146 print ("test", test.name, test.mem)
147 sim = ISA(pdecode2, test.regs, test.sprs, test.cr, test.mem,
148 test.msr)
149 gen = program.generate_instructions()
150 instructions = list(zip(gen, program.assembly.splitlines()))
151
152 # initialise memory
153 if self.funit == Function.LDST:
154 mem = l0.mem.mem
155 memlist = []
156 for i in range(mem.depth//2):
157 data = sim.mem.ld(i*16, 8)
158 data1 = sim.mem.ld(i*16+8, 8)
159 yield mem._array[i].eq(data | (data1<<32))
160 print (mem, mem.depth, mem.width)
161 print ("mem init", list(map(hex,memlist)))
162
163 index = sim.pc.CIA.value//4
164 while index < len(instructions):
165 ins, code = instructions[index]
166
167 print("0x{:X}".format(ins & 0xffffffff))
168 print(code)
169
170 # ask the decoder to decode this binary data (endian'd)
171 yield pdecode2.dec.bigendian.eq(0) # little / big?
172 yield instruction.eq(ins) # raw binary instr.
173 yield Settle()
174 fn_unit = yield pdecode2.e.fn_unit
175 fuval = self.funit.value
176 self.assertEqual(fn_unit & fuval, fuval)
177
178 # set operand and get inputs
179 yield from set_operand(cu, pdecode2, sim)
180 iname = yield from self.iodef.get_cu_inputs(pdecode2, sim)
181 inp = get_inp_indexed(cu, iname)
182
183 # reset read-operand mask
184 rdmask = pdecode2.rdflags(cu)
185 #print ("hardcoded rdmask", cu.rdflags(pdecode2.e))
186 #print ("decoder rdmask", rdmask)
187 yield cu.rdmaskn.eq(~rdmask)
188
189 # reset write-operand mask
190 for idx in range(cu.n_dst):
191 wrok = cu.get_out(idx)
192 fname = find_ok(wrok.fields)
193 yield getattr(wrok, fname).eq(0)
194
195 yield Settle()
196
197 # set inputs into CU
198 rd_rel_o = yield cu.rd.rel
199 wr_rel_o = yield cu.wr.rel
200 print ("before inputs, rd_rel, wr_rel: ",
201 bin(rd_rel_o), bin(wr_rel_o))
202 assert wr_rel_o == 0, "wr.rel %s must be zero. "\
203 "previous instr not written all regs\n"\
204 "respec %s" % \
205 (bin(wr_rel_o), cu.rwid[1])
206 yield from set_cu_inputs(cu, inp)
207 yield
208 rd_rel_o = yield cu.rd.rel
209 wr_rel_o = yield cu.wr.rel
210 wrmask = yield cu.wrmask
211 print ("after inputs, rd_rel, wr_rel, wrmask: ",
212 bin(rd_rel_o), bin(wr_rel_o), bin(wrmask))
213
214 # call simulated operation
215 opname = code.split(' ')[0]
216 yield from sim.call(opname)
217 index = sim.pc.CIA.value//4
218
219 yield Settle()
220 # get all outputs (one by one, just "because")
221 res = yield from get_cu_outputs(cu, code)
222 wrmask = yield cu.wrmask
223 rd_rel_o = yield cu.rd.rel
224 wr_rel_o = yield cu.wr.rel
225 print ("after got outputs, rd_rel, wr_rel, wrmask: ",
226 bin(rd_rel_o), bin(wr_rel_o), bin(wrmask))
227
228 # wait for busy to go low
229 while True:
230 busy_o = yield cu.busy_o
231 print ("busy", busy_o)
232 if not busy_o:
233 break
234 yield
235
236 yield from self.iodef.check_cu_outputs(res, pdecode2,
237 sim, code)
238
239 # sigh. hard-coded. test memory
240 if self.funit == Function.LDST:
241 print ("mem dump", sim.mem.mem)
242
243 sim.add_sync_process(process)
244
245 name = self.funit.name.lower()
246 with sim.write_vcd("%s_simulator.vcd" % name,
247 "%s_simulator.gtkw" % name,
248 traces=[]):
249 sim.run()
250
251