1 """TestRunner class, runs TestIssuer instructions
5 * https://bugs.libre-soc.org/show_bug.cgi?id=363
6 * https://bugs.libre-soc.org/show_bug.cgi?id=686#c51
8 from nmigen
import Module
, Signal
, Cat
, ClockSignal
9 from nmigen
.hdl
.xfrm
import ResetInserter
12 # NOTE: to use cxxsim, export NMIGEN_SIM_MODE=cxxsim from the shell
13 # Also, check out the cxxsim nmigen branch, and latest yosys from git
14 from nmutil
.sim_tmp_alternative
import Simulator
, Settle
16 from nmutil
.formaltest
import FHDLTestCase
17 from nmutil
.gtkw
import write_gtkw
18 from nmigen
.cli
import rtlil
19 from openpower
.decoder
.isa
.caller
import special_sprs
, SVP64State
20 from openpower
.decoder
.isa
.all
import ISA
21 from openpower
.endian
import bigendian
23 from openpower
.decoder
.power_decoder
import create_pdecode
24 from openpower
.decoder
.power_decoder2
import PowerDecode2
25 from soc
.regfile
.regfiles
import StateRegs
27 from soc
.simple
.issuer
import TestIssuerInternal
29 from soc
.config
.test
.test_loadstore
import TestMemPspec
30 from soc
.simple
.test
.test_core
import (setup_regs
, check_regs
, check_mem
,
33 from soc
.fu
.compunits
.test
.test_compunit
import (setup_tst_memory
,
35 from soc
.debug
.dmi
import DBGCore
, DBGCtrl
, DBGStat
36 from nmutil
.util
import wrap
37 from soc
.experiment
.test
.test_mmu_dcache
import wb_get
38 from openpower
.test
.state
import TestState
, StateRunner
41 def setup_i_memory(imem
, startaddr
, instructions
):
43 print("insn before, init mem", mem
.depth
, mem
.width
, mem
,
45 for i
in range(mem
.depth
):
46 yield mem
._array
[i
].eq(0)
48 startaddr
//= 4 # instructions are 32-bit
51 for ins
in instructions
:
52 if isinstance(ins
, tuple):
56 insn
= insn
& 0xffffffff
57 yield mem
._array
[startaddr
].eq(insn
)
60 print("instr: %06x 0x%x %s" % (4*startaddr
, insn
, code
))
62 startaddr
= startaddr
& mask
67 for ins
in instructions
:
68 if isinstance(ins
, tuple):
72 insn
= insn
& 0xffffffff
73 msbs
= (startaddr
>> 1) & mask
74 val
= yield mem
._array
[msbs
]
76 print("before set", hex(4*startaddr
),
77 hex(msbs
), hex(val
), hex(insn
))
78 lsb
= 1 if (startaddr
& 1) else 0
79 val
= (val |
(insn
<< (lsb
*32)))
81 yield mem
._array
[msbs
].eq(val
)
84 print("after set", hex(4*startaddr
), hex(msbs
), hex(val
))
85 print("instr: %06x 0x%x %s %08x" % (4*startaddr
, insn
, code
, val
))
87 startaddr
= startaddr
& mask
90 def set_dmi(dmi
, addr
, data
):
92 yield dmi
.addr_i
.eq(addr
)
93 yield dmi
.din
.eq(data
)
101 yield dmi
.req_i
.eq(0)
102 yield dmi
.addr_i
.eq(0)
108 def get_dmi(dmi
, addr
):
109 yield dmi
.req_i
.eq(1)
110 yield dmi
.addr_i
.eq(addr
)
114 ack
= yield dmi
.ack_o
119 data
= yield dmi
.dout
# get data after ack valid for 1 cycle
120 yield dmi
.req_i
.eq(0)
121 yield dmi
.addr_i
.eq(0)
127 class SimRunner(StateRunner
):
128 def __init__(self
, dut
, m
, pspec
):
131 regreduce_en
= pspec
.regreduce_en
== True
132 self
.simdec2
= simdec2
= PowerDecode2(None, regreduce_en
=regreduce_en
)
133 m
.submodules
.simdec2
= simdec2
# pain in the neck
135 def prepare_for_test(self
, test
):
140 def run_test(self
, instructions
, gen
, insncode
):
141 """run_sim_state - runs an ISACaller simulation
144 dut
, test
, simdec2
= self
.dut
, self
.test
, self
.simdec2
147 # set up the Simulator (which must track TestIssuer exactly)
148 sim
= ISA(simdec2
, test
.regs
, test
.sprs
, test
.cr
, test
.mem
,
150 initial_insns
=gen
, respect_pc
=True,
151 disassembly
=insncode
,
153 initial_svstate
=test
.svstate
)
155 # run the loop of the instructions on the current test
156 index
= sim
.pc
.CIA
.value
//4
157 while index
< len(instructions
):
158 ins
, code
= instructions
[index
]
160 print("sim instr: 0x{:X}".format(ins
& 0xffffffff))
163 # set up simulated instruction (in simdec2)
165 yield from sim
.setup_one()
166 except KeyError: # instruction not in imem: stop
170 # call simulated operation
172 yield from sim
.execute_one()
174 index
= sim
.pc
.CIA
.value
//4
176 # get sim register and memory TestState, add to list
177 state
= yield from TestState("sim", sim
, dut
, code
)
178 sim_states
.append(state
)
183 class HDLRunner(StateRunner
):
184 def __init__(self
, dut
, m
, pspec
):
186 self
.pc_i
= Signal(32)
187 self
.svstate_i
= Signal(64)
189 #hard_reset = Signal(reset_less=True)
190 self
.issuer
= TestIssuerInternal(pspec
)
191 # use DMI RESET command instead, this does actually work though
192 #issuer = ResetInserter({'coresync': hard_reset,
193 # 'sync': hard_reset})(issuer)
194 m
.submodules
.issuer
= self
.issuer
195 self
.dmi
= self
.issuer
.dbg
.dmi
198 comb
+= self
.issuer
.pc_i
.data
.eq(self
.pc_i
)
199 comb
+= self
.issuer
.svstate_i
.data
.eq(self
.svstate_i
)
201 # run core clock at same rate as test clock
202 intclk
= ClockSignal("coresync")
203 comb
+= intclk
.eq(ClockSignal())
205 def prepare_for_test(self
, test
):
208 # set up bigendian (TODO: don't do this, use MSR)
209 yield self
.issuer
.core_bigendian_i
.eq(bigendian
)
217 def setup_during_test(self
):
218 yield from set_dmi(self
.dmi
, DBGCore
.CTRL
, 1<<DBGCtrl
.STOP
)
221 def run_test(self
, instructions
):
222 """run_hdl_state - runs a TestIssuer nmigen HDL simulation
225 imem
= self
.issuer
.imem
._get
_memory
()
226 core
= self
.issuer
.core
227 dmi
= self
.issuer
.dbg
.dmi
228 pdecode2
= self
.issuer
.pdecode2
232 # establish the TestIssuer context (mem, regs etc)
234 pc
= 0 # start address
235 counter
= 0 # test to pause/start
237 yield from setup_i_memory(imem
, pc
, instructions
)
238 #yield from setup_tst_memory(l0, self.test.mem)
239 yield from setup_regs(pdecode2
, core
, self
.test
)
242 yield self
.pc_i
.eq(pc
)
243 yield self
.issuer
.pc_i
.ok
.eq(1)
245 # copy initial SVSTATE
246 initial_svstate
= copy(self
.test
.svstate
)
247 if isinstance(initial_svstate
, int):
248 initial_svstate
= SVP64State(initial_svstate
)
249 yield self
.svstate_i
.eq(initial_svstate
.value
)
250 yield self
.issuer
.svstate_i
.ok
.eq(1)
253 print("instructions", instructions
)
255 # run the loop of the instructions on the current test
256 index
= (yield self
.issuer
.cur_state
.pc
) // 4
257 while index
< len(instructions
):
258 ins
, code
= instructions
[index
]
260 print("hdl instr: 0x{:X}".format(ins
& 0xffffffff))
266 yield from set_dmi(dmi
, DBGCore
.CTRL
,
268 yield self
.issuer
.pc_i
.ok
.eq(0) # no change PC after this
269 yield self
.issuer
.svstate_i
.ok
.eq(0) # ditto
273 counter
= counter
+ 1
275 # wait until executed
276 while not (yield self
.issuer
.insn_done
):
281 index
= (yield self
.issuer
.cur_state
.pc
) // 4
283 terminated
= yield self
.issuer
.dbg
.terminated_o
284 print("terminated", terminated
)
286 if index
< len(instructions
):
287 # Get HDL mem and state
288 state
= yield from TestState("hdl", core
, self
.dut
,
290 hdl_states
.append(state
)
292 if index
>= len(instructions
):
293 print ("index over, send dmi stop")
295 yield from set_dmi(dmi
, DBGCore
.CTRL
,
300 terminated
= yield self
.issuer
.dbg
.terminated_o
301 print("terminated(2)", terminated
)
308 yield from set_dmi(self
.dmi
, DBGCore
.CTRL
, 1<<DBGCtrl
.STOP
)
312 # TODO, here is where the static (expected) results
313 # can be checked: register check (TODO, memory check)
314 # see https://bugs.libre-soc.org/show_bug.cgi?id=686#c51
315 # yield from check_regs(self, sim, core, test, code,
316 # >>>expected_data<<<)
319 cr
= yield from get_dmi(self
.dmi
, DBGCore
.CR
)
320 print("after test %s cr value %x" % (self
.test
.name
, cr
))
323 xer
= yield from get_dmi(self
.dmi
, DBGCore
.XER
)
324 print("after test %s XER value %x" % (self
.test
.name
, xer
))
326 # test of dmi reg get
327 for int_reg
in range(32):
328 yield from set_dmi(self
.dmi
, DBGCore
.GSPR_IDX
, int_reg
)
329 value
= yield from get_dmi(self
.dmi
, DBGCore
.GSPR_DATA
)
331 print("after test %s reg %2d value %x" %
332 (self
.test
.name
, int_reg
, value
))
335 yield from set_dmi(self
.dmi
, DBGCore
.CTRL
, 1<<DBGCtrl
.RESET
)
339 class TestRunner(FHDLTestCase
):
340 def __init__(self
, tst_data
, microwatt_mmu
=False, rom
=None,
341 svp64
=True, run_hdl
=True, run_sim
=True):
342 super().__init
__("run_all")
343 self
.test_data
= tst_data
344 self
.microwatt_mmu
= microwatt_mmu
347 self
.run_hdl
= run_hdl
348 self
.run_sim
= run_sim
353 if self
.microwatt_mmu
:
354 ldst_ifacetype
= 'test_mmu_cache_wb'
356 ldst_ifacetype
= 'test_bare_wb'
357 imem_ifacetype
= 'test_bare_wb'
359 pspec
= TestMemPspec(ldst_ifacetype
=ldst_ifacetype
,
360 imem_ifacetype
=imem_ifacetype
,
371 mmu
=self
.microwatt_mmu
,
374 ###### SETUP PHASE #######
375 # StateRunner.setup_for_test()
377 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
379 hdlrun
= HDLRunner(self
, m
, pspec
)
382 simrun
= SimRunner(self
, m
, pspec
)
384 # nmigen Simulation - everything runs around this, so it
385 # still has to be created.
391 ###### PREPARATION PHASE AT START OF RUNNING #######
392 # StateRunner.setup_during_test()
393 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
394 # but "normalise" the APIs, make openpower-isa StateRunner
395 # dummy "yield" functions so if they're not provided at least
396 # there is a fallback which can be "yielded".
399 yield from simrun
.setup_during_test() # TODO, some arguments?
402 yield from hdlrun
.setup_during_test()
404 # get each test, completely reset the core, and run it
406 for test
in self
.test_data
:
408 with self
.subTest(test
.name
):
410 ###### PREPARATION PHASE AT START OF TEST #######
411 # StateRunner.prepare_for_test()
412 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
415 yield from simrun
.prepare_for_test(test
)
418 yield from hdlrun
.prepare_for_test(test
)
421 program
= test
.program
422 print("regs", test
.regs
)
423 print("sprs", test
.sprs
)
425 print("mem", test
.mem
)
426 print("msr", test
.msr
)
427 print("assem", program
.assembly
)
428 gen
= list(program
.generate_instructions())
429 insncode
= program
.assembly
.splitlines()
430 instructions
= list(zip(gen
, insncode
))
432 ###### RUNNING OF EACH TEST #######
433 # StateRunner.step_test()
435 # Run two tests (TODO, move these to functions)
436 # * first the Simulator, collate a batch of results
437 # * then the HDL, likewise
438 # (actually, the other way round because running
439 # Simulator somehow modifies the test state!)
440 # * finally, compare all the results
442 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
448 hdl_states
= yield from hdlrun
.run_test(instructions
)
455 sim_states
= yield from simrun
.run_test(
459 ###### COMPARING THE TESTS #######
465 # TODO: here just grab one entry from list_of_sim_runners
466 # (doesn't matter which one, honestly)
467 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
470 last_sim
= copy(sim_states
[-1])
472 last_sim
= copy(hdl_states
[-1])
474 last_sim
= None # err what are you doing??
476 if self
.run_hdl
and self
.run_sim
:
477 for simstate
, hdlstate
in zip(sim_states
, hdl_states
):
478 simstate
.compare(hdlstate
) # register check
479 simstate
.compare_mem(hdlstate
) # memory check
483 for state
in hdl_states
:
488 for state
in sim_states
:
491 # compare against expected results
492 if test
.expected
is not None:
493 # have to put these in manually
494 test
.expected
.to_test
= test
.expected
495 test
.expected
.dut
= self
496 test
.expected
.state_type
= "expected"
497 test
.expected
.code
= 0
498 # do actual comparison, against last item
499 last_sim
.compare(test
.expected
)
501 if self
.run_hdl
and self
.run_sim
:
502 self
.assertTrue(len(hdl_states
) == len(sim_states
),
503 "number of instructions run not the same")
505 ###### END OF A TEST #######
506 # StateRunner.end_test()
507 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
510 yield from simrun
.end_test() # TODO, some arguments?
513 yield from hdlrun
.end_test()
515 ###### END OF EVERYTHING (but none needs doing, still call fn) ####
516 # StateRunner.cleanup()
517 # TODO https://bugs.libre-soc.org/show_bug.cgi?id=686#c73
520 yield from simrun
.cleanup() # TODO, some arguments?
523 yield from hdlrun
.cleanup()
526 'dec': {'base': 'dec'},
527 'bin': {'base': 'bin'},
528 'closed': {'closed': True}
533 ('state machines', 'closed', [
534 'fetch_pc_i_valid', 'fetch_pc_o_ready',
536 'fetch_insn_o_valid', 'fetch_insn_i_ready',
537 'pred_insn_i_valid', 'pred_insn_o_ready',
538 'fetch_predicate_state',
539 'pred_mask_o_valid', 'pred_mask_i_ready',
541 'exec_insn_i_valid', 'exec_insn_o_ready',
543 'exec_pc_o_valid', 'exec_pc_i_ready',
544 'insn_done', 'core_stop_o', 'pc_i_ok', 'pc_changed',
545 'is_last', 'dec2.no_out_vec']),
546 {'comment': 'fetch and decode'},
548 'cia[63:0]', 'nia[63:0]', 'pc[63:0]',
549 'cur_pc[63:0]', 'core_core_cia[63:0]']),
551 'raw_opcode_in[31:0]', 'insn_type', 'dec2.dec2_exc_happened',
552 ('svp64 decoding', 'closed', [
553 'svp64_rm[23:0]', ('dec2.extra[8:0]', 'bin'),
554 'dec2.sv_rm_dec.mode', 'dec2.sv_rm_dec.predmode',
555 'dec2.sv_rm_dec.ptype_in',
556 'dec2.sv_rm_dec.dstpred[2:0]', 'dec2.sv_rm_dec.srcpred[2:0]',
557 'dstmask[63:0]', 'srcmask[63:0]',
558 'dregread[4:0]', 'dinvert',
559 'sregread[4:0]', 'sinvert',
560 'core.int.pred__addr[4:0]', 'core.int.pred__data_o[63:0]',
561 'core.int.pred__ren']),
562 ('register augmentation', 'dec', 'closed', [
563 {'comment': 'v3.0b registers'},
564 'dec2.dec_o.RT[4:0]',
565 'dec2.dec_a.RA[4:0]',
566 'dec2.dec_b.RB[4:0]',
568 'dec2.o_svdec.reg_in[4:0]',
569 ('dec2.o_svdec.spec[2:0]', 'bin'),
570 'dec2.o_svdec.reg_out[6:0]']),
572 'dec2.in1_svdec.reg_in[4:0]',
573 ('dec2.in1_svdec.spec[2:0]', 'bin'),
574 'dec2.in1_svdec.reg_out[6:0]']),
576 'dec2.in2_svdec.reg_in[4:0]',
577 ('dec2.in2_svdec.spec[2:0]', 'bin'),
578 'dec2.in2_svdec.reg_out[6:0]']),
579 {'comment': 'SVP64 registers'},
580 'dec2.rego[6:0]', 'dec2.reg1[6:0]', 'dec2.reg2[6:0]'
582 {'comment': 'svp64 context'},
583 'core_core_vl[6:0]', 'core_core_maxvl[6:0]',
584 'core_core_srcstep[6:0]', 'next_srcstep[6:0]',
585 'core_core_dststep[6:0]',
586 {'comment': 'issue and execute'},
587 'core.core_core_insn_type',
589 'core_rego[6:0]', 'core_reg1[6:0]', 'core_reg2[6:0]']),
592 'dbg.dmi_req_i', 'dbg.dmi_ack_o',
593 {'comment': 'instruction memory'},
594 'imem.sram.rdport.memory(0)[63:0]',
595 {'comment': 'registers'},
596 # match with soc.regfile.regfiles.IntRegs port names
597 'core.int.rp_src1.memory(0)[63:0]',
598 'core.int.rp_src1.memory(1)[63:0]',
599 'core.int.rp_src1.memory(2)[63:0]',
600 'core.int.rp_src1.memory(3)[63:0]',
601 'core.int.rp_src1.memory(4)[63:0]',
602 'core.int.rp_src1.memory(5)[63:0]',
603 'core.int.rp_src1.memory(6)[63:0]',
604 'core.int.rp_src1.memory(7)[63:0]',
605 'core.int.rp_src1.memory(9)[63:0]',
606 'core.int.rp_src1.memory(10)[63:0]',
607 'core.int.rp_src1.memory(13)[63:0]'
610 # PortInterface module path varies depending on MMU option
611 if self
.microwatt_mmu
:
612 pi_module
= 'core.ldst0'
614 pi_module
= 'core.fus.ldst0'
616 traces
+= [('ld/st port interface', {'submodule': pi_module
}, [
618 'ldst_port0_is_ld_i',
619 'ldst_port0_is_st_i',
621 'ldst_port0_addr_i[47:0]',
622 'ldst_port0_addr_i_ok',
623 'ldst_port0_addr_ok_o',
624 'ldst_port0_exc_happened',
625 'ldst_port0_st_data_i[63:0]',
626 'ldst_port0_st_data_i_ok',
627 'ldst_port0_ld_data_o[63:0]',
628 'ldst_port0_ld_data_o_ok',
633 if self
.microwatt_mmu
:
635 {'comment': 'microwatt_mmu'},
636 'core.fus.mmu0.alu_mmu0.illegal',
637 'core.fus.mmu0.alu_mmu0.debug0[3:0]',
638 'core.fus.mmu0.alu_mmu0.mmu.state',
639 'core.fus.mmu0.alu_mmu0.mmu.pid[31:0]',
640 'core.fus.mmu0.alu_mmu0.mmu.prtbl[63:0]',
641 {'comment': 'wishbone_memory'},
642 'core.fus.mmu0.alu_mmu0.dcache.stb',
643 'core.fus.mmu0.alu_mmu0.dcache.cyc',
644 'core.fus.mmu0.alu_mmu0.dcache.we',
645 'core.fus.mmu0.alu_mmu0.dcache.ack',
646 'core.fus.mmu0.alu_mmu0.dcache.stall,'
649 write_gtkw("issuer_simulator.gtkw",
650 "issuer_simulator.vcd",
651 traces
, styles
, module
='top.issuer')
653 # add run of instructions
654 sim
.add_sync_process(process
)
656 # optionally, if a wishbone-based ROM is passed in, run that as an
657 # extra emulated process
658 if self
.rom
is not None:
659 dcache
= core
.fus
.fus
["mmu0"].alu
.dcache
660 default_mem
= self
.rom
661 sim
.add_sync_process(wrap(wb_get(dcache
, default_mem
, "DCACHE")))
663 with sim
.write_vcd("issuer_simulator.vcd"):