src/soc/simple/test/test_issuer.py

   1 """simple core test, runs instructions from a TestMemory
   2
   3 related bugs:
   4
   5  * https://bugs.libre-soc.org/show_bug.cgi?id=363
   6 """
   7 from nmigen import Module, Signal, Cat
   8 from nmigen.back.pysim import Simulator, Delay, Settle
   9 from nmutil.formaltest import FHDLTestCase
  10 from nmigen.cli import rtlil
  11 import unittest
  12 from soc.decoder.isa.caller import special_sprs
  13 from soc.decoder.isa.all import ISA
  14 from soc.decoder.power_enums import Function, XER_bits
  15
  16
  17 from soc.simple.issuer import TestIssuer
  18 from soc.experiment.compalu_multi import find_ok # hack
  19
  20 from soc.config.test.test_loadstore import TestMemPspec
  21 from soc.simple.test.test_core import (setup_regs, check_regs,
  22                                        wait_for_busy_clear,
  23                                        wait_for_busy_hi)
  24 from soc.fu.compunits.test.test_compunit import (setup_test_memory,
  25                                                  check_sim_memory)
  26
  27 # test with ALU data and Logical data
  28 from soc.fu.alu.test.test_pipe_caller import ALUTestCase
  29 from soc.fu.logical.test.test_pipe_caller import LogicalTestCase
  30 from soc.fu.shift_rot.test.test_pipe_caller import ShiftRotTestCase
  31 from soc.fu.cr.test.test_pipe_caller import CRTestCase
  32 from soc.fu.branch.test.test_pipe_caller import BranchTestCase
  33 from soc.fu.spr.test.test_pipe_caller import SPRTestCase
  34 from soc.fu.ldst.test.test_pipe_caller import LDSTTestCase
  35 from soc.simulator.test_sim import GeneralTestCases
  36
  37
  38 def setup_i_memory(imem, startaddr, instructions):
  39     mem = imem
  40     print ("insn before, init mem", mem.depth, mem.width, mem)
  41     for i in range(mem.depth):
  42         yield mem._array[i].eq(0)
  43     yield Settle()
  44     startaddr //= 4 # instructions are 32-bit
  45     mask = ((1<<64)-1)
  46     for insn, code in instructions:
  47         msbs = (startaddr>>1) & mask
  48         val = yield mem._array[msbs]
  49         print ("before set", hex(startaddr), hex(msbs), hex(val))
  50         lsb = 1 if (startaddr & 1) else 0
  51         val = (val | (insn << (lsb*32))) & mask
  52         yield mem._array[msbs].eq(val)
  53         yield Settle()
  54         print ("after  set", hex(startaddr), hex(msbs), hex(val))
  55         print ("instr: %06x 0x%x %s %08x" % (4*startaddr, insn, code, val))
  56         startaddr += 1
  57         startaddr = startaddr & mask
  58
  59
  60 class TestRunner(FHDLTestCase):
  61     def __init__(self, tst_data):
  62         super().__init__("run_all")
  63         self.test_data = tst_data
  64
  65     def run_all(self):
  66         m = Module()
  67         comb = m.d.comb
  68         go_insn_i = Signal()
  69         pc_i = Signal(32)
  70
  71         pspec = TestMemPspec(ldst_ifacetype='test_bare_wb',
  72                              imem_ifacetype='test_bare_wb',
  73                              addr_wid=48,
  74                              mask_wid=8,
  75                              reg_wid=64)
  76         m.submodules.issuer = issuer = TestIssuer(pspec)
  77         imem = issuer.imem._get_memory()
  78         core = issuer.core
  79         pdecode2 = core.pdecode2
  80         l0 = core.l0
  81
  82         comb += issuer.pc_i.data.eq(pc_i)
  83         comb += issuer.go_insn_i.eq(go_insn_i)
  84
  85         # nmigen Simulation
  86         sim = Simulator(m)
  87         sim.add_clock(1e-6)
  88
  89         def process():
  90
  91             for test in self.test_data:
  92                 print(test.name)
  93                 program = test.program
  94                 self.subTest(test.name)
  95                 print ("regs", test.regs)
  96                 print ("sprs", test.sprs)
  97                 print ("cr", test.cr)
  98                 print ("mem", test.mem)
  99                 print ("msr", test.msr)
 100                 print ("assem", program.assembly)
 101                 gen = list(program.generate_instructions())
 102                 insncode = program.assembly.splitlines()
 103                 instructions = list(zip(gen, insncode))
 104                 sim = ISA(pdecode2, test.regs, test.sprs, test.cr, test.mem,
 105                           test.msr,
 106                           initial_insns=gen, respect_pc=True,
 107                           disassembly=insncode)
 108
 109                 pc = 0 # start address
 110
 111                 yield from setup_i_memory(imem, pc, instructions)
 112                 yield from setup_test_memory(l0, sim)
 113                 yield from setup_regs(core, test)
 114
 115                 yield pc_i.eq(pc)
 116                 yield issuer.pc_i.ok.eq(1)
 117
 118                 index = sim.pc.CIA.value//4
 119                 while index < len(instructions):
 120                     ins, code = instructions[index]
 121
 122                     print("instruction: 0x{:X}".format(ins & 0xffffffff))
 123                     print(index, code)
 124
 125                     # start the instruction
 126                     yield go_insn_i.eq(1)
 127                     yield
 128                     yield issuer.pc_i.ok.eq(0) # don't change PC from now on
 129                     yield go_insn_i.eq(0)      # and don't issue a new insn
 130
 131                     # wait until executed
 132                     yield from wait_for_busy_hi(core)
 133                     yield from wait_for_busy_clear(core)
 134
 135                     print ("sim", code)
 136                     # call simulated operation
 137                     opname = code.split(' ')[0]
 138                     yield from sim.call(opname)
 139                     yield Settle()
 140                     index = sim.pc.CIA.value//4
 141
 142                     # register check
 143                     yield from check_regs(self, sim, core, test, code)
 144
 145                     # Memory check
 146                     yield from check_sim_memory(self, l0, sim, code)
 147
 148         sim.add_sync_process(process)
 149         with sim.write_vcd("issuer_simulator.vcd",
 150                             traces=[]):
 151             sim.run()
 152
 153
 154 if __name__ == "__main__":
 155     unittest.main(exit=False)
 156     suite = unittest.TestSuite()
 157     suite.addTest(TestRunner(GeneralTestCases.test_data))
 158     suite.addTest(TestRunner(LDSTTestCase.test_data))
 159     suite.addTest(TestRunner(CRTestCase.test_data))
 160     suite.addTest(TestRunner(ShiftRotTestCase.test_data))
 161     suite.addTest(TestRunner(LogicalTestCase.test_data))
 162     suite.addTest(TestRunner(ALUTestCase.test_data))
 163     suite.addTest(TestRunner(BranchTestCase.test_data))
 164     #suite.addTest(TestRunner(SPRTestCase.test_data))
 165
 166     runner = unittest.TextTestRunner()
 167     runner.run(suite)
 168