add MISA and MIE
[rv32.git] / cpu.py
diff --git a/cpu.py b/cpu.py
index 07ba97316f588a10d3291bb7d65dfe8af91876a2..4fbeafe61938fff05d0a6994e6240b4dd9705966 100644 (file)
--- a/cpu.py
+++ b/cpu.py
@@ -26,6 +26,7 @@
 `include "cpu.vh"
 """
 
+import string
 from migen import *
 from migen.fhdl import verilog
 from migen.fhdl.structure import _Operator
@@ -47,8 +48,97 @@ class MemoryInterface:
     rw_wait = Signal(name="memory_interface_rw_wait")
 
 
+class Decoder:
+    funct7 = Signal(7, name="decoder_funct7")
+    funct3 = Signal(3, name="decoder_funct3")
+    rd = Signal(5, name="decoder_rd")
+    rs1 = Signal(5, name="decoder_rs1")
+    rs2 = Signal(5, name="decoder_rs2")
+    immediate = Signal(32, name="decoder_immediate")
+    opcode = Signal(7, name="decoder_opcode")
+    act = Signal(decode_action, name="decoder_action")
+
+class MStatus:
+    def __init__(self, comb, sync):
+        self.comb = comb
+        self.sync = sync
+        self.mpie = Signal(name="mstatus_mpie")
+        self.mie = Signal(name="mstatus_mie")
+        self.mprv = Signal(name="mstatus_mprv")
+        self.tsr = Signal(name="mstatus_tsr")
+        self.tw = Signal(name="mstatus_tw")
+        self.tvm = Signal(name="mstatus_tvm")
+        self.mxr = Signal(name="mstatus_mxr")
+        self._sum = Signal(name="mstatus_sum")
+        self.xs = Signal(name="mstatus_xs")
+        self.fs = Signal(name="mstatus_fs")
+        self.mpp = Signal(2, name="mstatus_mpp")
+        self.spp = Signal(name="mstatus_spp")
+        self.spie = Signal(name="mstatus_spie")
+        self.upie = Signal(name="mstatus_upie")
+        self.sie = Signal(name="mstatus_sie")
+        self.uie = Signal(name="mstatus_uie")
+
+        for n in dir(self):
+            if n in ['mpp', 'comb', 'sync'] or n.startswith("_"):
+                continue
+            self.comb += getattr(self, n).eq(0x0)
+        self.comb += self.mpp.eq(0b11)
+
+        self.sync += self.mie.eq(0)
+        self.sync += self.mpie.eq(0)
+
+class MIE:
+    def __init__(self, comb, sync):
+        self.comb = comb
+        self.sync = sync
+        self.meie = Signal(name="mie_meie")
+        self.mtie = Signal(name="mie_mtie")
+        self.msie = Signal(name="mie_msie")
+        self.ueie = Signal(name="mie_ueie")
+        self.stie = Signal(name="mie_stie")
+        self.utie = Signal(name="mie_utie")
+        self.ssie = Signal(name="mie_ssie")
+        self.usie = Signal(name="mie_usie")
+
+        for n in dir(self):
+            if n in ['comb', 'sync'] or n.startswith("_"):
+                continue
+            self.comb += getattr(self, n).eq(0x0)
+
+        self.sync += self.meie.eq(0)
+        self.sync += self.mtie.eq(0)
+        self.sync += self.msie.eq(0)
+
+
+class M:
+    def __init__(self, comb, sync):
+        self.comb = comb
+        self.sync = sync
+        self.mcause = Signal(32)
+        self.mepc = Signal(32)
+        self.mscratch = Signal(32)
+        self.sync += self.mcause.eq(0)
+        self.sync += self.mepc.eq(0) # 32'hXXXXXXXX;
+        self.sync += self.mscratch.eq(0) # 32'hXXXXXXXX;
+
+class Misa:
+
+    def __init__(self, comb, sync):
+        self.comb = comb
+        self.sync = sync
+        self.misa = Signal(32)
+        cl = []
+        for l in list(string.ascii_lowercase):
+            value = 1 if l == 'i' else 0
+            cl.append(Constant(value))
+        cl.append(Constant(0, 4))
+        cl.append(Constant(0b01, 2))
+        self.comb += self.misa.eq(Cat(cl))
+
+
 class CPU(Module):
-    """ 
+    """
     """
 
     def get_ls_misaligned(self, ls, funct3, load_store_address_low_2):
@@ -59,16 +149,33 @@ class CPU(Module):
                   "default": ls.eq(Constant(1))
                 })
 
-    def get_lsbm(self, decoder_funct3):
+    def get_lsbm(self, dc):
         return Cat(Constant(1),
-                   Mux((decoder_funct3[1] | decoder_funct3[0]),
+                   Mux((dc.funct3[1] | dc.funct3[0]),
                        Constant(1), Constant(0)),
-                   Mux((decoder_funct3[1]),
+                   Mux((dc.funct3[1]),
                        Constant(0b11, 2), Constant(0, 2)))
 
+    # XXX this happens to get done by various self.sync actions
+    #def reset_to_initial(self, m, mstatus, mie, registers):
+    #    return [m.mcause.eq(0),
+    #            ]
+
+    def write_register(self, register_number, value):
+        return If(register_number != 0,
+                  self.registers[register_number].eq(value)
+               )
+
+    def evaluate_csr_funct3_op(self, funct3, previous_value, written_value):
+        c = { "default": Constant(0, 32)}
+        for f in [F3.csrrw, F3.csrrwi]: c[f] = written_value
+        for f in [F3.csrrs, F3.csrrsi]: c[f] = written_value | previous_value
+        for f in [F3.csrrc, F3.csrrci]: c[f] = ~written_value & previous_value
+        return Case(funct3, c)
+
     def __init__(self):
-        #self.clk = ClockSignal()
-        #self.reset = ResetSignal()
+        self.clk = ClockSignal()
+        self.reset = ResetSignal()
         self.tty_write = Signal()
         self.tty_write_data = Signal(8)
         self.tty_write_busy = Signal()
@@ -87,8 +194,10 @@ class CPU(Module):
 
         l = []
         for i in range(31):
-            l.append(Signal(32, name="register%d" % i))
-        registers = Array(l)
+            r = Signal(32, name="register%d" % i)
+            l.append(r)
+            self.sync += r.eq(Constant(0, 32))
+        self.registers = Array(l)
 
         mi = MemoryInterface()
 
@@ -140,49 +249,42 @@ class CPU(Module):
         )
         self.specials += fs
 
-        decoder_funct7 = Signal(7)
-        decoder_funct3 = Signal(3)
-        decoder_rd = Signal(5)
-        decoder_rs1 = Signal(5)
-        decoder_rs2 = Signal(5)
-        decoder_immediate = Signal(32)
-        decoder_opcode = Signal(7)
-        decode_act = Signal(decode_action)
+        dc = Decoder()
 
         cd = Instance("CPUDecoder", name="decoder",
             i_instruction = fetch_output_instruction,
-            o_funct7 = decoder_funct7,
-            o_funct3 = decoder_funct3,
-            o_rd = decoder_rd,
-            o_rs1 = decoder_rs1,
-            o_rs2 = decoder_rs2,
-            o_immediate = decoder_immediate,
-            o_opcode = decoder_opcode,
-            o_decode_action = decode_act
+            o_funct7 = dc.funct7,
+            o_funct3 = dc.funct3,
+            o_rd = dc.rd,
+            o_rs1 = dc.rs1,
+            o_rs2 = dc.rs2,
+            o_immediate = dc.immediate,
+            o_opcode = dc.opcode,
+            o_decode_action = dc.act
         )
         self.specials += cd
 
         register_rs1 = Signal(32)
         register_rs2 = Signal(32)
-        self.comb += If(decoder_rs1 == 0,
+        self.comb += If(dc.rs1 == 0,
                         register_rs1.eq(0)
                      ).Else(
-                        register_rs1.eq(registers[decoder_rs1-1]))
-        self.comb += If(decoder_rs2 == 0,
+                        register_rs1.eq(self.registers[dc.rs1-1]))
+        self.comb += If(dc.rs2 == 0,
                         register_rs2.eq(0)
                      ).Else(
-                        register_rs2.eq(registers[decoder_rs2-1]))
+                        register_rs2.eq(self.registers[dc.rs2-1]))
 
         load_store_address = Signal(32)
         load_store_address_low_2 = Signal(2)
 
-        self.comb += load_store_address.eq(decoder_immediate + register_rs1)
+        self.comb += load_store_address.eq(dc.immediate + register_rs1)
         self.comb += load_store_address_low_2.eq(
-                            decoder_immediate[:2] + register_rs1[:2])
+                            dc.immediate[:2] + register_rs1[:2])
 
         load_store_misaligned = Signal()
 
-        lsa = self.get_ls_misaligned(load_store_misaligned, decoder_funct3,
+        lsa = self.get_ls_misaligned(load_store_misaligned, dc.funct3,
                                      load_store_address_low_2)
         self.comb += lsa
 
@@ -191,8 +293,7 @@ class CPU(Module):
 
         unshifted_load_store_byte_mask = Signal(4)
 
-        self.comb += unshifted_load_store_byte_mask.eq(self.get_lsbm(
-                                                       decoder_funct3))
+        self.comb += unshifted_load_store_byte_mask.eq(self.get_lsbm(dc))
 
         # XXX yuck.  this will cause migen simulation to fail
         # (however conversion to verilog works)
@@ -232,18 +333,80 @@ class CPU(Module):
         loaded_value = Signal(32)
 
         b0 = unmasked_loaded_value[0:8]
-        b1 = Mux(decoder_funct3[0:2] == 0,
-                Replicate(~decoder_funct3[2] & unmasked_loaded_value[7], 8),
+        b1 = Mux(dc.funct3[0:2] == 0,
+                Replicate(~dc.funct3[2] & unmasked_loaded_value[7], 8),
                 unmasked_loaded_value[8:16])
-        b2 = Mux(decoder_funct3[1] == 0,
-                Replicate(~decoder_funct3[2] &
-                           Mux(decoder_funct3[0], unmasked_loaded_value[15],
+        b2 = Mux(dc.funct3[1] == 0,
+                Replicate(~dc.funct3[2] &
+                           Mux(dc.funct3[0], unmasked_loaded_value[15],
                                                   unmasked_loaded_value[7]),
                           16),
                 unmasked_loaded_value[16:32])
 
         self.comb += loaded_value.eq(Cat(b0, b1, b2))
 
+        self.comb += mi.rw_active.eq(~self.reset
+                        & (fetch_output_st == fetch_output_state_valid)
+                        & ~load_store_misaligned
+                        & ((dc.act & (DA.load | DA.store)) != 0))
+
+        self.comb += mi.rw_read_not_write.eq(~dc.opcode[5])
+
+        # alu
+        alu_a = Signal(32)
+        alu_b = Signal(32)
+        alu_result = Signal(32)
+
+        self.comb += alu_a.eq(register_rs1)
+        self.comb += alu_b.eq(Mux(dc.opcode[5],
+                                  register_rs2,
+                                  dc.immediate))
+
+        ali = Instance("cpu_alu", name="alu",
+            i_funct7 = dc.funct7,
+            i_funct3 = dc.funct3,
+            i_opcode = dc.opcode,
+            i_a = alu_a,
+            i_b = alu_b,
+            o_result = alu_result
+        )
+        self.specials += ali
+
+        lui_auipc_result = Signal(32)
+        self.comb += lui_auipc_result.eq(Mux(dc.opcode[5],
+                                             dc.immediate,
+                                             dc.immediate + fetch_output_pc))
+
+        self.comb += fetch_target_pc.eq(Cat(0,
+                    Mux(dc.opcode != OP.jalr,
+                                fetch_output_pc[1:32],
+                                register_rs1[1:32] + dc.immediate[1:32])))
+
+        misaligned_jump_target = Signal()
+        self.comb += misaligned_jump_target.eq(fetch_target_pc[1])
+
+        branch_arg_a = Signal(32)
+        branch_arg_b = Signal(32)
+        self.comb += branch_arg_a.eq(Cat( register_rs1[0:31],
+                                          register_rs1[31] ^ ~dc.funct3[1]))
+        self.comb += branch_arg_b.eq(Cat( register_rs2[0:31],
+                                          register_rs2[31] ^ ~dc.funct3[1]))
+
+        branch_taken = Signal()
+        self.comb += branch_taken.eq(dc.funct3[0] ^
+                                     Mux(dc.funct3[2],
+                                         branch_arg_a < branch_arg_b,
+                                         branch_arg_a == branch_arg_b))
+
+        m = M(self.comb, self.sync)
+        mstatus = MStatus(self.comb, self.sync)
+        mie = MIE(self.comb, self.sync)
+
+        misa = Misa(self.comb, self.sync)
+
+        #self.sync += If(self.reset, self.reset_to_initial(m, mstatus, mie,
+        #                                                  registers))
+
 if __name__ == "__main__":
     example = CPU()
     print(verilog.convert(example,
@@ -259,191 +422,6 @@ if __name__ == "__main__":
 
 """
 
-    assign memory_interface_rw_active = ~reset
-                                        & (fetch_output_state == `fetch_output_state_valid)
-                                        & ~load_store_misaligned
-                                        & ((decode_action & (`decode_action_load | `decode_action_store)) != 0);
-
-    assign memory_interface_rw_read_not_write = ~decoder_opcode[5];
-
-    wire [31:0] alu_a = register_rs1;
-    wire [31:0] alu_b = decoder_opcode[5] ? register_rs2 : decoder_immediate;
-    wire [31:0] alu_result;
-
-    cpu_alu alu(
-        .funct7(decoder_funct7),
-        .funct3(decoder_funct3),
-        .opcode(decoder_opcode),
-        .a(alu_a),
-        .b(alu_b),
-        .result(alu_result)
-        );
-
-    wire [31:0] lui_auipc_result = decoder_opcode[5] ? decoder_immediate : decoder_immediate + fetch_output_pc;
-
-    assign fetch_target_pc[31:1] = ((decoder_opcode != `opcode_jalr ? fetch_output_pc[31:1] : register_rs1[31:1]) + decoder_immediate[31:1]);
-    assign fetch_target_pc[0] = 0;
-
-    wire misaligned_jump_target = fetch_target_pc[1];
-
-    wire [31:0] branch_arg_a = {register_rs1[31] ^ ~decoder_funct3[1], register_rs1[30:0]};
-    wire [31:0] branch_arg_b = {register_rs2[31] ^ ~decoder_funct3[1], register_rs2[30:0]};
-
-    wire branch_taken = decoder_funct3[0] ^ (decoder_funct3[2] ? branch_arg_a < branch_arg_b : branch_arg_a == branch_arg_b);
-
-    reg [31:0] mcause = 0;
-    reg [31:0] mepc = 32'hXXXXXXXX;
-    reg [31:0] mscratch = 32'hXXXXXXXX;
-
-    reg mstatus_mpie = 1'bX;
-    reg mstatus_mie = 0;
-    parameter mstatus_mprv = 0;
-    parameter mstatus_tsr = 0;
-    parameter mstatus_tw = 0;
-    parameter mstatus_tvm = 0;
-    parameter mstatus_mxr = 0;
-    parameter mstatus_sum = 0;
-    parameter mstatus_xs = 0;
-    parameter mstatus_fs = 0;
-    parameter mstatus_mpp = 2'b11;
-    parameter mstatus_spp = 0;
-    parameter mstatus_spie = 0;
-    parameter mstatus_upie = 0;
-    parameter mstatus_sie = 0;
-    parameter mstatus_uie = 0;
-
-    reg mie_meie = 1'bX;
-    reg mie_mtie = 1'bX;
-    reg mie_msie = 1'bX;
-    parameter mie_seie = 0;
-    parameter mie_ueie = 0;
-    parameter mie_stie = 0;
-    parameter mie_utie = 0;
-    parameter mie_ssie = 0;
-    parameter mie_usie = 0;
-
-    task reset_to_initial;
-    begin
-        mcause = 0;
-        mepc = 32'hXXXXXXXX;
-        mscratch = 32'hXXXXXXXX;
-        mstatus_mie = 0;
-        mstatus_mpie = 1'bX;
-        mie_meie = 1'bX;
-        mie_mtie = 1'bX;
-        mie_msie = 1'bX;
-        registers['h01] <= 32'hXXXXXXXX;
-        registers['h02] <= 32'hXXXXXXXX;
-        registers['h03] <= 32'hXXXXXXXX;
-        registers['h04] <= 32'hXXXXXXXX;
-        registers['h05] <= 32'hXXXXXXXX;
-        registers['h06] <= 32'hXXXXXXXX;
-        registers['h07] <= 32'hXXXXXXXX;
-        registers['h08] <= 32'hXXXXXXXX;
-        registers['h09] <= 32'hXXXXXXXX;
-        registers['h0A] <= 32'hXXXXXXXX;
-        registers['h0B] <= 32'hXXXXXXXX;
-        registers['h0C] <= 32'hXXXXXXXX;
-        registers['h0D] <= 32'hXXXXXXXX;
-        registers['h0E] <= 32'hXXXXXXXX;
-        registers['h0F] <= 32'hXXXXXXXX;
-        registers['h10] <= 32'hXXXXXXXX;
-        registers['h11] <= 32'hXXXXXXXX;
-        registers['h12] <= 32'hXXXXXXXX;
-        registers['h13] <= 32'hXXXXXXXX;
-        registers['h14] <= 32'hXXXXXXXX;
-        registers['h15] <= 32'hXXXXXXXX;
-        registers['h16] <= 32'hXXXXXXXX;
-        registers['h17] <= 32'hXXXXXXXX;
-        registers['h18] <= 32'hXXXXXXXX;
-        registers['h19] <= 32'hXXXXXXXX;
-        registers['h1A] <= 32'hXXXXXXXX;
-        registers['h1B] <= 32'hXXXXXXXX;
-        registers['h1C] <= 32'hXXXXXXXX;
-        registers['h1D] <= 32'hXXXXXXXX;
-        registers['h1E] <= 32'hXXXXXXXX;
-        registers['h1F] <= 32'hXXXXXXXX;
-    end
-    endtask
-
-    task write_register(input [4:0] register_number, input [31:0] value);
-    begin
-        if(register_number != 0)
-            registers[register_number] <= value;
-    end
-    endtask
-
-    function [31:0] evaluate_csr_funct3_operation(input [2:0] funct3, input [31:0] previous_value, input [31:0] written_value);
-    begin
-        case(funct3)
-        `funct3_csrrw, `funct3_csrrwi:
-            evaluate_csr_funct3_operation = written_value;
-        `funct3_csrrs, `funct3_csrrsi:
-            evaluate_csr_funct3_operation = written_value | previous_value;
-        `funct3_csrrc, `funct3_csrrci:
-            evaluate_csr_funct3_operation = ~written_value & previous_value;
-        default:
-            evaluate_csr_funct3_operation = 32'hXXXXXXXX;
-        endcase
-    end
-    endfunction
-
-    parameter misa_a = 1'b0;
-    parameter misa_b = 1'b0;
-    parameter misa_c = 1'b0;
-    parameter misa_d = 1'b0;
-    parameter misa_e = 1'b0;
-    parameter misa_f = 1'b0;
-    parameter misa_g = 1'b0;
-    parameter misa_h = 1'b0;
-    parameter misa_i = 1'b1;
-    parameter misa_j = 1'b0;
-    parameter misa_k = 1'b0;
-    parameter misa_l = 1'b0;
-    parameter misa_m = 1'b0;
-    parameter misa_n = 1'b0;
-    parameter misa_o = 1'b0;
-    parameter misa_p = 1'b0;
-    parameter misa_q = 1'b0;
-    parameter misa_r = 1'b0;
-    parameter misa_s = 1'b0;
-    parameter misa_t = 1'b0;
-    parameter misa_u = 1'b0;
-    parameter misa_v = 1'b0;
-    parameter misa_w = 1'b0;
-    parameter misa_x = 1'b0;
-    parameter misa_y = 1'b0;
-    parameter misa_z = 1'b0;
-    parameter misa = {
-        2'b01,
-        4'b0,
-        misa_z,
-        misa_y,
-        misa_x,
-        misa_w,
-        misa_v,
-        misa_u,
-        misa_t,
-        misa_s,
-        misa_r,
-        misa_q,
-        misa_p,
-        misa_o,
-        misa_n,
-        misa_m,
-        misa_l,
-        misa_k,
-        misa_j,
-        misa_i,
-        misa_h,
-        misa_g,
-        misa_f,
-        misa_e,
-        misa_d,
-        misa_c,
-        misa_b,
-        misa_a};
-
     parameter mvendorid = 32'b0;
     parameter marchid = 32'b0;
     parameter mimpid = 32'b0;
@@ -691,7 +669,7 @@ if __name__ == "__main__":
         endcase
     end
     endfunction
-    
+
     assign csr_op_is_valid = get_csr_op_is_valid(csr_number, csr_reads, csr_writes);
 
     wire [63:0] cycle_counter = 0; // TODO: implement cycle_counter