add msr exception bits setting function in hardware
[soc.git] / src / soc / decoder / isa / caller.py
index 7d73551ae9ff894a2bd2f15040a738307e6b07e5..5c8d6b6f06a12d0dadf43d9d5db114209f984e7e 100644 (file)
@@ -3,15 +3,20 @@
 this is part of a cycle-accurate POWER9 simulator.  its primary purpose is
 not speed, it is for both learning and educational purposes, as well as
 a method of verifying the HDL.
+
+related bugs:
+
+* https://bugs.libre-soc.org/show_bug.cgi?id=424
 """
 
 from functools import wraps
+from copy import copy
 from soc.decoder.orderedset import OrderedSet
 from soc.decoder.selectable_int import (FieldSelectableInt, SelectableInt,
                                         selectconcat)
 from soc.decoder.power_enums import (spr_dict, spr_byname, XER_bits,
-                                     insns, InternalOp)
-from soc.decoder.helpers import exts, trunc_div, trunc_rem
+                                     insns, MicrOp)
+from soc.decoder.helpers import exts
 from soc.consts import PI, MSR
 
 from collections import namedtuple
@@ -245,8 +250,10 @@ class ISACaller:
                        initial_mem=None, initial_msr=0,
                        initial_insns=None, respect_pc=False,
                        disassembly=None,
-                       initial_pc=0):
+                       initial_pc=0,
+                       bigendian=False):
 
+        self.bigendian = bigendian
         self.halted = False
         self.respect_pc = respect_pc
         if initial_sprs is None:
@@ -258,6 +265,7 @@ class ISACaller:
             assert self.respect_pc == False, "instructions required to honor pc"
 
         print ("ISACaller insns", respect_pc, initial_insns, disassembly)
+        print ("ISACaller initial_msr", initial_msr)
 
         # "fake program counter" mode (for unit testing)
         self.fake_pc = 0
@@ -336,10 +344,22 @@ class ISACaller:
         print ("TRAP:", hex(trap_addr))
         # store CIA(+4?) in SRR0, set NIA to 0x700
         # store MSR in SRR1, set MSR to um errr something, have to check spec
-        self.spr['SRR0'] = self.pc.CIA
-        self.spr['SRR1'] = self.namespace['MSR']
+        self.spr['SRR0'].value = self.pc.CIA.value
+        self.spr['SRR1'].value = self.namespace['MSR'].value
         self.trap_nia = SelectableInt(trap_addr, 64)
-        self.namespace['MSR'][63-trap_bit] = 1
+        self.spr['SRR1'][63-trap_bit] = 1 # change *copy* of MSR in SRR1
+
+        # set exception bits.  TODO: this should, based on the address
+        # in figure 66 p1065 V3.0B and the table figure 65 p1063 set these
+        # bits appropriately.  however it turns out that *for now* in all
+        # cases (all trap_addrs) the exact same thing is needed.
+        self.namespace['MSR'][63-MSR.SF] = 1
+        self.namespace['MSR'][63-MSR.EE] = 0
+        self.namespace['MSR'][63-MSR.PR] = 0
+        self.namespace['MSR'][63-MSR.IR] = 0
+        self.namespace['MSR'][63-MSR.DR] = 0
+        self.namespace['MSR'][63-MSR.RI] = 0
+        self.namespace['MSR'][63-MSR.LE] = 1
 
     def memassign(self, ea, sz, val):
         self.mem.memassign(ea, sz, val)
@@ -413,13 +433,13 @@ class ISACaller:
             inputs.append(SelectableInt(imm, 64))
         assert len(outputs) >= 1
         print ("handle_overflow", inputs, outputs, div_overflow)
-        if len(inputs) < 2 and div_overflow != 1:
+        if len(inputs) < 2 and div_overflow is None:
             return
 
         # div overflow is different: it's returned by the pseudo-code
         # because it's more complex than can be done by analysing the output
-        if div_overflow == 1:
-            ov, ov32 = 1, 1
+        if div_overflow is not None:
+            ov, ov32 = div_overflow, div_overflow
         # arithmetic overflow can be done by analysing the input and output
         elif len(inputs) >= 2:
             output = outputs[0]
@@ -444,11 +464,19 @@ class ISACaller:
 
     def handle_comparison(self, outputs):
         out = outputs[0]
+        print ("handle_comparison", out.bits, hex(out.value))
+        # TODO - XXX *processor* in 32-bit mode
+        # https://bugs.libre-soc.org/show_bug.cgi?id=424
+        #if is_32bit:
+        #    o32 = exts(out.value, 32)
+        #    print ("handle_comparison exts 32 bit", hex(o32))
         out = exts(out.value, out.bits)
+        print ("handle_comparison exts", hex(out))
         zero = SelectableInt(out == 0, 1)
         positive = SelectableInt(out > 0, 1)
         negative = SelectableInt(out < 0, 1)
         SO = self.spr['XER'][XER_bits['SO']]
+        print ("handle_comparison SO", SO)
         cr_field = selectconcat(negative, positive, zero, SO)
         self.crl[0].eq(cr_field)
 
@@ -471,7 +499,7 @@ class ISACaller:
         print ("CIA NIA", self.respect_pc, self.pc.CIA.value, self.pc.NIA.value)
 
         yield self.dec2.dec.raw_opcode_in.eq(ins & 0xffffffff)
-        yield self.dec2.dec.bigendian.eq(0)  # little / big?
+        yield self.dec2.dec.bigendian.eq(self.bigendian)
 
     def execute_one(self):
         """execute one instruction
@@ -490,40 +518,54 @@ class ISACaller:
         # TODO, asmregs is from the spec, e.g. add RT,RA,RB
         # see http://bugs.libre-riscv.org/show_bug.cgi?id=282
         asmcode = yield self.dec2.dec.op.asmcode
+        print ("get assembly name asmcode", asmcode)
         asmop = insns.get(asmcode, None)
+        int_op = yield self.dec2.dec.op.internal_op
 
         # sigh reconstruct the assembly instruction name
         ov_en = yield self.dec2.e.do.oe.oe
         ov_ok = yield self.dec2.e.do.oe.ok
-        if ov_en & ov_ok:
-            asmop += "."
+        rc_en = yield self.dec2.e.do.rc.data
+        rc_ok = yield self.dec2.e.do.rc.ok
+        # grrrr have to special-case MUL op (see DecodeOE)
+        print ("ov en rc en", ov_ok, ov_en, rc_ok, rc_en, int_op)
+        if int_op in [MicrOp.OP_MUL_H64.value, MicrOp.OP_MUL_H32.value]:
+            print ("mul op")
+            if rc_en & rc_ok:
+                asmop += "."
+        else:
+            if ov_en & ov_ok:
+                asmop += "."
         lk = yield self.dec2.e.do.lk
         if lk:
             asmop += "l"
-        int_op = yield self.dec2.dec.op.internal_op
         print ("int_op", int_op)
-        if int_op in [InternalOp.OP_B.value, InternalOp.OP_BC.value]:
+        if int_op in [MicrOp.OP_B.value, MicrOp.OP_BC.value]:
             AA = yield self.dec2.dec.fields.FormI.AA[0:-1]
             print ("AA", AA)
             if AA:
                 asmop += "a"
-        if int_op == InternalOp.OP_MFCR.value:
-            dec_insn = yield self.dec2.e.do.insn
-            if dec_insn & (1<<20) != 0: # sigh
+        spr_msb = yield from self.get_spr_msb()
+        if int_op == MicrOp.OP_MFCR.value:
+            if spr_msb:
                 asmop = 'mfocrf'
             else:
                 asmop = 'mfcr'
         # XXX TODO: for whatever weird reason this doesn't work
         # https://bugs.libre-soc.org/show_bug.cgi?id=390
-        if int_op == InternalOp.OP_MTCRF.value:
-            dec_insn = yield self.dec2.e.do.insn
-            if dec_insn & (1<<20) != 0: # sigh
+        if int_op == MicrOp.OP_MTCRF.value:
+            if spr_msb:
                 asmop = 'mtocrf'
             else:
                 asmop = 'mtcrf'
         return asmop
 
+    def get_spr_msb(self):
+        dec_insn = yield self.dec2.e.do.insn
+        return dec_insn & (1<<20) != 0 # sigh - XFF.spr[-1]?
+
     def call(self, name):
+        name = name.strip() # remove spaces if not already done so
         if self.halted:
             print ("halted - not executing", name)
             return
@@ -532,19 +574,48 @@ class ISACaller:
         # see http://bugs.libre-riscv.org/show_bug.cgi?id=282
         asmop = yield from self.get_assembly_name()
         print  ("call", name, asmop)
+
+        # check privileged
+        int_op = yield self.dec2.dec.op.internal_op
+        spr_msb = yield from self.get_spr_msb()
+
+        instr_is_privileged = False
+        if int_op in [MicrOp.OP_ATTN.value,
+                      MicrOp.OP_MFMSR.value,
+                      MicrOp.OP_MTMSR.value,
+                      MicrOp.OP_MTMSRD.value,
+                      # TODO: OP_TLBIE
+                      MicrOp.OP_RFID.value]:
+            instr_is_privileged = True
+        if int_op in [MicrOp.OP_MFSPR.value,
+                      MicrOp.OP_MTSPR.value] and spr_msb:
+            instr_is_privileged = True
+
+        print ("is priv", instr_is_privileged, hex(self.msr.value),
+                          self.msr[63-MSR.PR])
+        # check MSR priv bit and whether op is privileged: if so, throw trap
+        if instr_is_privileged and self.msr[63-MSR.PR] == 1:
+            self.TRAP(0x700, PI.PRIV)
+            self.namespace['NIA'] = self.trap_nia
+            self.pc.update(self.namespace)
+            return
+
+        # check halted condition
+        if name == 'attn':
+            self.halted = True
+            return
+
+        # check illegal instruction
         illegal = False
         if name not in ['mtcrf', 'mtocrf']:
             illegal = name != asmop
 
         if illegal:
-            print ("name %s != %s - calling ILLEGAL trap" % (name, asmop))
             self.TRAP(0x700, PI.ILLEG)
             self.namespace['NIA'] = self.trap_nia
             self.pc.update(self.namespace)
-            return
-
-        if name == 'attn':
-            self.halted = True
+            print ("name %s != %s - calling ILLEGAL trap, PC: %x" % \
+                    (name, asmop, self.pc.CIA.value))
             return
 
         info = self.instrs[name]
@@ -609,7 +680,7 @@ class ISACaller:
 
         ov_en = yield self.dec2.e.do.oe.oe
         ov_ok = yield self.dec2.e.do.oe.ok
-        print ("internal overflow", overflow)
+        print ("internal overflow", overflow, ov_en, ov_ok)
         if ov_en & ov_ok:
             yield from self.handle_overflow(inputs, results, overflow)