add SVSTATE to StateRegs
[soc.git] / src / soc / regfile / regfiles.py
index d44242a5161946cd23e2c6a8448a6f05f273c1ca..27aaecb9c7268488d807f23a9d0447614765bd47 100644 (file)
@@ -7,7 +7,11 @@ Defines the following register files:
     * SPR regfile   - 110x 64-bit
     * CR regfile    - CR0-7
     * XER regfile   - XER.so, XER.ca/ca32, XER.ov/ov32
-    * FAST regfile  - PC, MSR, CTR, LR, TAR, SRR1, SRR2
+    * FAST regfile  - CTR, LR, TAR, SRR1, SRR2
+    * STATE regfile  - PC, MSR, (SimpleV VL later)
+
+Note: this should NOT have name conventions hard-coded (dedicated ports per
+regname).  However it is convenient for now.
 
 Links:
 
@@ -15,17 +19,49 @@ Links:
 * https://bugs.libre-soc.org/show_bug.cgi?id=351
 * https://libre-soc.org/3d_gpu/architecture/regfile/
 * https://libre-soc.org/openpower/isatables/sprs.csv
+* https://libre-soc.org/openpower/sv/sprs/ (SVSTATE)
 """
 
 # TODO
 
-from soc.regfile.regfile import RegFile, RegFileArray
+from soc.regfile.regfile import RegFile, RegFileArray, RegFileMem
 from soc.regfile.virtual_port import VirtualRegPort
 from soc.decoder.power_enums import SPR
 
 
+# "State" Regfile
+class StateRegs(RegFileArray):
+    """StateRegs
+
+    State regfile  - PC, MSR, SVSTATE (for SimpleV)
+
+    * QTY 3of 64-bit registers
+    * 4R3W
+    * Array-based unary-indexed (not binary-indexed)
+    * write-through capability (read on same cycle as write)
+
+    Note: d_wr1 d_rd1 are for use by the decoder, to get at the PC.
+    will probably have to also add one so it can get at the MSR as well.
+    (d_rd2)
+
+    """
+    PC = 0
+    MSR = 1
+    SVSTATE = 2
+    def __init__(self):
+        super().__init__(64, 3)
+        self.w_ports = {'nia': self.write_port("nia"),
+                        'msr': self.write_port("msr"),
+                        'sv': self.write_port("sv"), # writing SVSTATE (issuer)
+                        'd_wr1': self.write_port("d_wr1")} # writing PC (issuer)
+        self.r_ports = {'cia': self.read_port("cia"), # reading PC (issuer)
+                        'msr': self.read_port("msr"), # reading MSR (issuer)
+                        'sv': self.read_port("sv"), # reading SV (issuer)
+                        }
+
+
 # Integer Regfile
-class IntRegs(RegFileArray):
+class IntRegs(RegFileMem): #class IntRegs(RegFileArray):
     """IntRegs
 
     * QTY 32of 64-bit registers
@@ -35,38 +71,46 @@ class IntRegs(RegFileArray):
     """
     def __init__(self):
         super().__init__(64, 32)
-        self.w_ports = [self.write_port("dest1"),
-                        self.write_port("dest2")] # for now (LD/ST update)
-        self.r_ports = [self.read_port("src1"),
-                        self.read_port("src2"),
-                        self.read_port("src3")]
+        self.w_ports = {'o': self.write_port("dest1"),
+                        #'o1': self.write_port("dest2") # for now (LD/ST update)
+                        }
+        self.r_ports = {'ra': self.read_port("src1"),
+                        'rb': self.read_port("src2"),
+                        'rc': self.read_port("src3"),
+                        'dmi': self.read_port("dmi")} # needed for Debug (DMI)
 
 
 # Fast SPRs Regfile
-class FastRegs(RegFileArray):
+class FastRegs(RegFileMem): #RegFileArray):
     """FastRegs
 
-    FAST regfile  - PC, MSR, CTR, LR, TAR, SRR1, SRR2
+    FAST regfile  - CTR, LR, TAR, SRR1, SRR2, XER, TB, DEC
 
-    * QTY 8of 64-bit registers
+    * QTY 6of 64-bit registers
     * 3R2W
     * Array-based unary-indexed (not binary-indexed)
     * write-through capability (read on same cycle as write)
+
+    Note: r/w issue are used by issuer to increment/decrement TB/DEC.
     """
-    PC = 0
-    MSR = 1
-    CTR = 2
-    LR = 3
-    TAR = 4
-    SRR1 = 5
-    SRR2 = 6
+    CTR = 0
+    LR = 1
+    TAR = 2
+    SRR0 = 3
+    SRR1 = 4
+    XER = 5 # non-XER bits
+    DEC = 6
+    TB = 7
+    N_REGS = 8 # maximum number of regs
     def __init__(self):
-        super().__init__(64, 8)
-        self.w_ports = [self.write_port("dest1"),
-                        self.write_port("dest2")]
-        self.r_ports = [self.read_port("src1"),
-                        self.read_port("src2"),
-                        self.read_port("src3")]
+        super().__init__(64, self.N_REGS)
+        self.w_ports = {'fast1': self.write_port("dest1"),
+                        'issue': self.write_port("issue"), # writing DEC/TB
+                       }
+        self.r_ports = {'fast1': self.read_port("src1"),
+                        'fast2': self.read_port("src2"),
+                        'issue': self.read_port("issue"), # reading DEC/TB
+                        }
 
 
 # CR Regfile
@@ -79,13 +123,15 @@ class CRRegs(VirtualRegPort):
     * write-through capability (read on same cycle as write)
     """
     def __init__(self):
-        super().__init__(32, 8)
-        self.w_ports = [self.full_wr, # 32-bit wide (masked, 8-en lines)
-                        self.write_port("dest")] # 4-bit wide, unary-indexed
-        self.r_ports = [self.full_rd, # 32-bit wide (masked, 8-en lines)
-                        self.read_port("src1"),
-                        self.read_port("src2"),
-                        self.read_port("src3")]
+        super().__init__(32, 8, rd2=True)
+        self.w_ports = {'full_cr': self.full_wr, # 32-bit (masked, 8-en lines)
+                        'cr_a': self.write_port("dest1"), # 4-bit, unary-indexed
+                        'cr_b': self.write_port("dest2")} # 4-bit, unary-indexed
+        self.r_ports = {'full_cr': self.full_rd, # 32-bit (masked, 8-en lines)
+                        'full_cr_dbg': self.full_rd2, # for DMI
+                        'cr_a': self.read_port("src1"),
+                        'cr_b': self.read_port("src2"),
+                        'cr_c': self.read_port("src3")}
 
 
 # XER Regfile
@@ -101,19 +147,19 @@ class XERRegs(VirtualRegPort):
     CA=1 # CA and CA32
     OV=2 # OV and OV32
     def __init__(self):
-        super().__init__(6, 2)
-        self.w_ports = [self.full_wr, # 6-bit wide (masked, 3-en lines)
-                        self.write_port("dest1"),
-                        self.write_port("dest2"),
-                        self.write_port("dest3")]
-        self.r_ports = [self.full_rd, # 6-bit wide (masked, 3-en lines)
-                        self.read_port("src1"),
-                        self.read_port("src2"),
-                        self.read_port("src3")]
+        super().__init__(6, 3)
+        self.w_ports = {'full_xer': self.full_wr, # 6-bit (masked, 3-en lines)
+                        'xer_so': self.write_port("dest1"),
+                        'xer_ca': self.write_port("dest2"),
+                        'xer_ov': self.write_port("dest3")}
+        self.r_ports = {'full_xer': self.full_rd, # 6-bit (masked, 3-en lines)
+                        'xer_so': self.read_port("src1"),
+                        'xer_ca': self.read_port("src2"),
+                        'xer_ov': self.read_port("src3")}
 
 
 # SPR Regfile
-class SPRRegs(RegFile):
+class SPRRegs(RegFileMem):
     """SPRRegs
 
     * QTY len(SPRs) 64-bit registers
@@ -123,6 +169,26 @@ class SPRRegs(RegFile):
     """
     def __init__(self):
         n_sprs = len(SPR)
-        super().__init__(64, n_sprs)
-        self.w_ports = [self.write_port("dest")]
-        self.r_ports = [self.read_port("src")]
+        super().__init__(width=64, depth=n_sprs)
+        self.w_ports = {'spr1': self.write_port("spr1")}
+        self.r_ports = {'spr1': self.read_port("spr1")}
+
+
+# class containing all regfiles: int, cr, xer, fast, spr
+class RegFiles:
+    def __init__(self):
+        self.rf = {}
+        for (name, kls) in [('int', IntRegs),
+                            ('cr', CRRegs),
+                            ('xer', XERRegs),
+                            ('fast', FastRegs),
+                            ('state', StateRegs),
+                            ('spr', SPRRegs),]:
+            rf = self.rf[name] = kls()
+            setattr(self, name, rf)
+
+    def elaborate_into(self, m, platform):
+        for (name, rf) in self.rf.items():
+            setattr(m.submodules, name, rf)
+        return m
+