aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--rv64cpu/.gitignore3
-rw-r--r--rv64cpu/CMakeLists.txt3
-rw-r--r--rv64cpu/rtl/core/alu.sv65
-rw-r--r--rv64cpu/rtl/core/include/rv64_pkg.sv95
-rw-r--r--rv64cpu/tb/CMakeLists.txt16
-rw-r--r--rv64cpu/tb/unit/tb_alu.cc67
6 files changed, 241 insertions, 8 deletions
diff --git a/rv64cpu/.gitignore b/rv64cpu/.gitignore
index e5b9664..57710b6 100644
--- a/rv64cpu/.gitignore
+++ b/rv64cpu/.gitignore
@@ -28,3 +28,6 @@ fpga/gowin/*.fs
# OS
.DS_Store
Thumbs.db
+
+# Cache
+.cache/ \ No newline at end of file
diff --git a/rv64cpu/CMakeLists.txt b/rv64cpu/CMakeLists.txt
index 1242a58..4649abb 100644
--- a/rv64cpu/CMakeLists.txt
+++ b/rv64cpu/CMakeLists.txt
@@ -52,6 +52,9 @@ include(${CMAKE_SOURCE_DIR}/tools/verilator.cmake)
# ─── Waveform Output Directory ──────────────────────────────────────────────────
file(MAKE_DIRECTORY ${CMAKE_SOURCE_DIR}/waves)
+# ─── Testing ────────────────────────────────────────────────────────────────────
+enable_testing()
+
# ─── Testbench Subdirectory ─────────────────────────────────────────────────────
add_subdirectory(tb)
diff --git a/rv64cpu/rtl/core/alu.sv b/rv64cpu/rtl/core/alu.sv
new file mode 100644
index 0000000..ac2e9c9
--- /dev/null
+++ b/rv64cpu/rtl/core/alu.sv
@@ -0,0 +1,65 @@
+// Richard CPU
+// Copyright (C) 2026 Richard Qin
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+// File path: rtl/core/alu.sv
+// Description: 64-bit Arithmetic Logic Unit (ALU)
+
+module alu
+ import rv64_pkg::*;
+(
+ input alu_op_t alu_op, // ALU operation select (from decoder)
+ input logic [XLEN-1:0] rs1_val, // Operand 1 (register rs1 value or PC)
+ input logic [XLEN-1:0] rs2_val, // Operand 2 (register rs2 value or immediate)
+
+ output logic [XLEN-1:0] alu_res // ALU result
+);
+
+ // Shift amount: RV64I uses lower 6 bits of rs2 (shamt[5:0])
+ logic [5:0] shamt;
+ assign shamt = rs2_val[5:0];
+
+ always_comb begin
+ alu_res = '0;
+
+ case (alu_op)
+ ALU_ADD: alu_res = rs1_val + rs2_val;
+ ALU_SUB: alu_res = rs1_val - rs2_val;
+
+ // Logical left shift: the shift amount is the lower 6 bits of rs2
+ ALU_SLL: alu_res = rs1_val << shamt;
+
+ // Set less than (signed)
+ ALU_SLT: alu_res = {63'b0, $signed(rs1_val) < $signed(rs2_val)};
+
+ // Set less than (unsigned)
+ ALU_SLTU: alu_res = {63'b0, rs1_val < rs2_val};
+
+ ALU_XOR: alu_res = rs1_val ^ rs2_val;
+
+ // Logical right shift: the shift amount is the lower 6 bits of rs2
+ ALU_SRL: alu_res = rs1_val >> shamt;
+
+ // Arithmetic right shift: the shift amount is the lower 6 bits of rs2
+ ALU_SRA: alu_res = $unsigned($signed(rs1_val) >>> shamt);
+
+ ALU_OR: alu_res = rs1_val | rs2_val;
+ ALU_AND: alu_res = rs1_val & rs2_val;
+
+ default: alu_res = '0;
+ endcase
+ end
+
+endmodule
diff --git a/rv64cpu/rtl/core/include/rv64_pkg.sv b/rv64cpu/rtl/core/include/rv64_pkg.sv
new file mode 100644
index 0000000..984a93b
--- /dev/null
+++ b/rv64cpu/rtl/core/include/rv64_pkg.sv
@@ -0,0 +1,95 @@
+// Richard CPU
+// Copyright (C) 2026 Richard Qin
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+// File path: rtl/core/include/rv64_pkg.sv
+// Description: RISC-V 64-bit base instruction set global definition package
+
+package rv64_pkg;
+
+ localparam XLEN = 64;
+ localparam INST_WIDTH = 32;
+
+ // RISC-V Base Opcode Map (inst[6:0])
+ // Reference: RISC-V Unprivileged ISA V20240411, Table 34
+ typedef enum logic [6:0] {
+ // Loads
+ OPCODE_LOAD = 7'b000_0011, // LB/LH/LW/LD/LBU/LHU/LWU
+ OPCODE_LOAD_FP = 7'b000_0111, // FLW/FLD
+
+ // Misc-Mem
+ OPCODE_MISC_MEM = 7'b000_1111, // FENCE / FENCE.I (Zifencei)
+
+ // Immediate ALU
+ OPCODE_OP_IMM = 7'b001_0011, // ADDI/SLTI/ANDI/ORI/XORI/SLLI/SRLI/SRAI...
+ OPCODE_OP_IMM_32 = 7'b001_1011, // ADDIW/SLLIW/SRLIW/SRAIW (RV64 only)
+
+ // Upper Immediate
+ OPCODE_AUIPC = 7'b001_0111, // AUIPC
+ OPCODE_LUI = 7'b011_0111, // LUI
+
+ // Stores
+ OPCODE_STORE = 7'b010_0011, // SB/SH/SW/SD
+ OPCODE_STORE_FP = 7'b010_0111, // FSW/FSD
+
+ // Atomic (A extension)
+ OPCODE_AMO = 7'b010_1111, // LR/SC/AMOSWAP/AMOADD/...
+
+ // Register ALU
+ OPCODE_OP = 7'b011_0011, // ADD/SUB/AND/OR/XOR/SLL/SRL/SRA/SLT/SLTU/MUL/DIV...
+ OPCODE_OP_32 = 7'b011_1011, // ADDW/SUBW/SLLW/SRLW/SRAW/MULW/DIVW... (RV64 only)
+
+ // Floating-point fused multiply-add
+ OPCODE_MADD = 7'b100_0011, // FMADD.S/D
+ OPCODE_MSUB = 7'b100_0111, // FMSUB.S/D
+ OPCODE_NMSUB = 7'b100_1011, // FNMSUB.S/D
+ OPCODE_NMADD = 7'b100_1111, // FNMADD.S/D
+
+ // Floating-point arithmetic
+ OPCODE_OP_FP = 7'b101_0011, // FADD/FSUB/FMUL/FDIV/FSQRT/FCMP/FCVT/FMV/FCLASS...
+
+ // Branches
+ OPCODE_BRANCH = 7'b110_0011, // BEQ/BNE/BLT/BGE/BLTU/BGEU
+
+ // Jumps
+ OPCODE_JALR = 7'b110_0111, // JALR
+ OPCODE_JAL = 7'b110_1111, // JAL
+
+ // System
+ OPCODE_SYSTEM = 7'b111_0011, // ECALL/EBREAK/CSR*/MRET/SRET/WFI/SFENCE.VMA
+
+ // Custom (reserved for extensions)
+ OPCODE_CUSTOM_0 = 7'b000_1011,
+ OPCODE_CUSTOM_1 = 7'b010_1011,
+ OPCODE_CUSTOM_2 = 7'b101_1011,
+ OPCODE_CUSTOM_3 = 7'b111_1011
+ } opcode_t;
+
+ // ALU Operation Encoding
+ // Derived from funct3 + funct7[5] of R-type / I-type instructions
+ typedef enum logic [3:0] {
+ ALU_ADD = 4'b0000, // Add
+ ALU_SUB = 4'b1000, // Subtract
+ ALU_SLL = 4'b0001, // Shift Left Logical
+ ALU_SLT = 4'b0010, // Set Less Than (signed)
+ ALU_SLTU = 4'b0011, // Set Less Than (unsigned)
+ ALU_XOR = 4'b0100, // Exclusive Or
+ ALU_SRL = 4'b0101, // Shift Right Logical
+ ALU_SRA = 4'b1101, // Shift Right Arithmetic
+ ALU_OR = 4'b0110, // Or
+ ALU_AND = 4'b0111 // And
+ } alu_op_t;
+
+endpackage
diff --git a/rv64cpu/tb/CMakeLists.txt b/rv64cpu/tb/CMakeLists.txt
index 8679562..73df088 100644
--- a/rv64cpu/tb/CMakeLists.txt
+++ b/rv64cpu/tb/CMakeLists.txt
@@ -30,14 +30,14 @@ file(GLOB_RECURSE ALL_RTL_SOURCES
#
# Uncomment and fill in as you implement each module, for example:
#
-# add_verilator_target(
-# NAME tb_alu
-# TOP_MODULE alu
-# SOURCES ${RTL_CORE_DIR}/include/rv64_pkg.sv
-# ${RTL_CORE_DIR}/alu.sv
-# INCLUDE_DIRS ${RTL_COMMON_INCLUDES}
-# TB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/unit/tb_alu.cpp
-# )
+add_verilator_target(
+ NAME tb_alu
+ TOP_MODULE alu
+ SOURCES ${RTL_CORE_DIR}/include/rv64_pkg.sv
+ ${RTL_CORE_DIR}/alu.sv
+ INCLUDE_DIRS ${RTL_COMMON_INCLUDES}
+ TB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/unit/tb_alu.cc
+)
#
# add_verilator_target(
# NAME tb_decoder
diff --git a/rv64cpu/tb/unit/tb_alu.cc b/rv64cpu/tb/unit/tb_alu.cc
new file mode 100644
index 0000000..b783815
--- /dev/null
+++ b/rv64cpu/tb/unit/tb_alu.cc
@@ -0,0 +1,67 @@
+#include "Valu.h"
+#include <cassert>
+#include <cstdint>
+#include <iostream>
+#include <verilated.h>
+
+enum AluOp {
+ ALU_ADD = 0b0000,
+ ALU_SUB = 0b1000,
+ ALU_SLL = 0b0001,
+ ALU_SLT = 0b0010,
+ ALU_SLTU = 0b0011,
+ ALU_XOR = 0b0100,
+ ALU_SRL = 0b0101,
+ ALU_SRA = 0b1101,
+ ALU_OR = 0b0110,
+ ALU_AND = 0b0111
+};
+
+void test_alu(Valu* alu, uint8_t op, uint64_t rs1, uint64_t rs2, uint64_t expected, const char* test_name) {
+ alu->alu_op = op;
+ alu->rs1_val = rs1;
+ alu->rs2_val = rs2;
+
+ alu->eval();
+
+ if (alu->alu_res == expected) {
+ std::cout << "\033[32m";
+ std::cout << "[PASS] " << test_name << " | "
+ << rs1 << " op " << rs2 << " = " << expected << std::endl;
+ std::cout << "\033[0m";
+ } else {
+ std::cout << "\033[31m";
+ std::cerr << "[FAIL] " << test_name << " | "
+ << "Expected: " << expected << ", Got: " << alu->alu_res << std::endl;
+ std::cout << "\033[0m";
+ assert(false);
+ }
+}
+
+int main(int argc, char** argv) {
+ Verilated::commandArgs(argc, argv);
+ Valu* alu = new Valu;
+
+ std::cout << "Running ALU Unit Test ..." << std::endl;
+
+ test_alu(alu, ALU_ADD, 100, 50, 150, "ADD_Positive");
+ test_alu(alu, ALU_SUB, 100, 50, 50, "SUB_Positive");
+
+ test_alu(alu, ALU_ADD, (uint64_t)-5, 10, 5, "ADD_Negative");
+
+ test_alu(alu, ALU_AND, 0xFF00, 0x0F0F, 0x0F00, "AND_Mask");
+ test_alu(alu, ALU_XOR, 0xAAAA, 0xFFFF, 0x5555, "XOR_Invert");
+
+ test_alu(alu, ALU_SLL, 1, 10, 1024, "SLL_By_10");
+
+ uint64_t minus_one = (uint64_t)-1;
+ uint64_t five = 5;
+
+ test_alu(alu, ALU_SLTU, minus_one, five, 0, "SLTU (Unsigned: -1 < 5 is False)");
+ test_alu(alu, ALU_SLT, minus_one, five, 1, "SLT (Signed: -1 < 5 is True)");
+
+ std::cout << "All tests passed!" << std::endl;
+
+ delete alu;
+ return 0;
+} \ No newline at end of file