Merge branch 'dev' into main

maksyuki · maksyuki · commit 3531713ccece · 2022-01-16T09:31:01.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -14,4 +14,7 @@ dramsim3.txt
 dramsim3epoch.json
 *.vcd
 *.wave
+.mypy_cache
+.pytest_cache
+dependency
 __pycache__
diff --git a/README.md b/README.md
@@ -77,17 +77,18 @@ Now, the develop schedule is recorded by the **Tencent Document**. You can click
 #### Enviroment setup(ubuntu 20.04 LTS)
 install verilator, mill and dep lib: 
 ```bash
-sudo apt-get install g++-riscv64-linux-gnu binutils-riscv64-linux-gnu
-./setup.sh -a
+make install
+make setup
 ```
-
 change the sim memory from 8G to 256MB. need to enter 'make menuconfig' and modify [Memory - Configuration]->[Memory size] to '0x10000000' manually.
 cd in root rtl dir
 ```bash
 make nemuBuild
-make diffBuild
-make difftestBuild
-make demoTest
+make dramsim3Build
+make simpleTestBuild
+make riscvTestBuild
+make cpuTestBuild
+make amTestBuild
 ```
 
 ### Software test
diff --git a/rtl/Makefile b/rtl/Makefile
@@ -1,9 +1,12 @@
 SHELL=/bin/bash
 
 # be carefully, this path will be used in clean(rm -rf)!!!
-ROOT_PATH        := $(shell pwd)/tc_l2
-BUILD_DIR        := ${ROOT_PATH}/build
-MILL_OUT_DIR     := ${ROOT_PATH}/../out
+# need to set the $(CHIP_TARGET) with tc_lx(2, 3, 4...)
+CHIP_TARGET      := tc_l2
+ROOT_PATH        := $(shell pwd)/dependency
+SOURCE_PATH      := $(ROOT_PATH)/../$(CHIP_TARGET)
+BUILD_DIR        := $(SOURCE_PATH)/build
+MILL_OUT_DIR     := $(ROOT_PATH)/../out
 
 AM_FOLDER_PATH   := $(ROOT_PATH)/am
 AM_KERNEL_PATH   := $(AM_FOLDER_PATH)/am-kernels
@@ -22,7 +25,7 @@ DRAMSIM3_HOME    := $(ROOT_PATH)/DRAMsim3
 YSYXSOC_HOME     := $(ROOT_PATH)/ysyxSoC/ysyx
 
 ###### soc var ######
-SOC_CSRC_HOME     += $(ROOT_PATH)/src/main/csrc
+SOC_CSRC_HOME     += $(SOURCE_PATH)/src/main/csrc
 SOC_CSRC_LIB_HOME += $(ROOT_PATH)/ysyxSoC/ysyx/peripheral/spiFlash
 SOC_CXXFILES      += $(shell find $(SOC_CSRC_HOME) -name "*.cpp")
 SOC_CXXFILES      += $(shell find $(SOC_CSRC_LIB_HOME) -name "*.cpp")
@@ -76,16 +79,23 @@ define getRecursiveTestRes
 	fi
 endef
 
+###### dev env target ######
+install:
+	./scripts/install.sh -g -c
+
+setup:
+	./scripts/setup.sh -a
+
 ###### chisel target ######
 millTest:
 	mill -i __.test
 
 chiselBuild:
 	mkdir -p $(BUILD_DIR)
-	mill -i tc_l2.runMain top.TopMain -td $(BUILD_DIR)
+	mill -i $(CHIP_TARGET).runMain top.TopMain -td $(BUILD_DIR)
 
 chiselHelp:
-	mill -i tc_l2.runMain top.TopMain --help
+	mill -i $(CHIP_TARGET).runMain top.TopMain --help
 
 millCompile:
 	mill -i __.compile
@@ -117,13 +127,13 @@ difftestBuild:
 	@sed -i 's/io_memAXI_0_\([a-z]*\)_bits_data,/io_memAXI_0_\1_bits_data[3:0],/g' $(BUILD_DIR)/SimTop.v
 	@sed -i 's/io_memAXI_0_w_bits_data =/io_memAXI_0_w_bits_data[0] =/g' $(BUILD_DIR)/SimTop.v
 	@sed -i 's/ io_memAXI_0_r_bits_data;/ io_memAXI_0_r_bits_data[0];/g' $(BUILD_DIR)/SimTop.v
-	$(MAKE) -C $(DIFFTEST_HOME) WITH_DRAMSIM3=1 EMU_TRACE=1
+	$(MAKE) -C $(DIFFTEST_HOME) WITH_DRAMSIM3=1 EMU_TRACE=1 DESIGN_DIR=$(SOURCE_PATH)
 
 changeTargetToSimTop:
-	@sed -i 's/SoCEna\([ ]*\)=\([ ]*\)true/SoCEna\1=\2false/g' $(ROOT_PATH)/src/main/scala/common/InstConfig.scala
+	@sed -i 's/SoCEna\([ ]*\)=\([ ]*\)true/SoCEna\1=\2false/g' $(SOURCE_PATH)/src/main/scala/common/InstConfig.scala
 
 changeTargetToSoCTop:
-	@sed -i 's/SoCEna\([ ]*\)=\([ ]*\)false/SoCEna\1=\2true/g' $(ROOT_PATH)/src/main/scala/common/InstConfig.scala
+	@sed -i 's/SoCEna\([ ]*\)=\([ ]*\)false/SoCEna\1=\2true/g' $(SOURCE_PATH)/src/main/scala/common/InstConfig.scala
 
 simBuild: changeTargetToSimTop chiselBuild difftestBuild
 
@@ -286,7 +296,8 @@ cleanDepRepo:
 cleanAll: cleanBuild cleanMillOut cleanDepRepo
 
 
-.PHONY: millTest chiselBuild chiselHelp millCompile millBsp format checkformat \
+.PHONY: install, setup,
+		millTest chiselBuild chiselHelp millCompile millBsp format checkformat \
 		nemuBuild dramsim3Build difftestBuild changeTargetToSimTop changeTargetToSoCTop simBuild \
 		simpleTestBuild riscvTestBuild cpuTestBuild amTestBuild coremarkTestBuild \
 		dhrystoneTestBuild microbenchTestBuild fecmuxTestBuild demoTest \
diff --git a/rtl/scripts/install.sh b/rtl/scripts/install.sh
@@ -0,0 +1,83 @@
+#!/bin/bash
+
+help() {
+    echo "Usage:"
+    echo "install.sh [-g] [-c]"
+    echo "Description:"
+    echo "-g: Install gtkwave."
+    echo "-c: Install mill for Chisel env."
+    exit 0
+}
+
+while getopts 'hgc' OPT; do
+    case $OPT in
+        h) help;;
+        g) GTKWAVE="true";;
+        c) CHISEL="true";;
+        ?) help;;
+    esac
+done
+
+if !(cat /etc/*release | grep 'Ubuntu 20.04'); then
+    echo "Your Linux branch does not meet the requirements, please use Ubuntu 20.04."
+    exit 1
+fi
+
+UPDATED="false"
+install_package() {
+    for package in $*                     
+    do
+        dpkg -s "$package" >/dev/null 2>&1 && {
+            echo "$package has been installed."
+        } || {
+            if [[ $UPDATED == "false" ]]; then
+                UPDATED="true"
+                sudo apt-get update
+            fi
+            sudo apt-get --yes install $package
+        }
+    done
+}
+
+install_verilator() {
+    ubt20_64_package_list=("git" "perl" "python3" "make" "g++" "libfl2" "libfl-dev" "zlibc" "zlib1g" "zlib1g-dev" "ccache" "libgoogle-perftools-dev" "numactl" "perl-doc")
+    for package in ${ubt20_64_package_list[@]} ; do
+        install_package $package
+    done
+
+    dpkg -s verilator >/dev/null 2>&1 && {
+        echo "verilator has been installed."
+    } || {
+        wget -O /tmp/verilator_4_204_amd64.deb https://gitee.com/oscpu/install/attach_files/817254/download/verilator_4_204_amd64.deb
+        sudo dpkg -i /tmp/verilator_4_204_amd64.deb
+        rm /tmp/verilator_4_204_amd64.deb
+    }
+}
+
+install_mill() {
+    install_package curl
+    install_package default-jre
+    
+    which mill >/dev/null 2>&1 && {
+        echo "mill has been installed."
+    } || {
+        sudo mkdir /usr/local/bin >/dev/null 2>&1
+        wget -O /tmp/mill https://gitee.com/oscpu/install/raw/master/mill
+        sudo chmod +x /tmp/mill
+        sudo mv /tmp/mill /usr/local/bin/
+    }
+}
+
+install_verilator
+
+# install libsqlite3-dev for difftest
+install_package libsqlite3-dev
+# install libreadline-dev libsdl2-dev bison for NEMU
+install_package libreadline-dev libsdl2-dev bison
+# install cmake for DRAMsim3
+install_package cmake
+
+[[ $GTKWAVE == "true" ]] && install_package gtkwave libcanberra-gtk-module
+[[ $CHISEL == "true" ]] && install_mill
+
+echo "finish!"
diff --git a/rtl/scripts/setup.sh b/rtl/scripts/setup.sh
@@ -7,7 +7,7 @@ RIGHT="\033[0;32m"
 END="\033[0m"
 
 
-ROOT_PATH=$(dirname $(readlink -f "$0"))
+ROOT_PATH=$(dirname $(readlink -f "$0"))/../dependency
 AM_FOLDER_PATH=${ROOT_PATH}"/am"
 ABSTRACT_MACHINE_FOLDER_PATH=${AM_FOLDER_PATH}"/abstract-machine"
 RISCV_TESTS_FOLDER_PATH=${AM_FOLDER_PATH}"/riscv-tests"
@@ -18,6 +18,7 @@ NEMU_FOLDER_PATH=${ROOT_PATH}"/NEMU"
 DRAMSIM3_FOLDER_PATH=${ROOT_PATH}"/DRAMsim3"
 YSYXSOC_PATH=${ROOT_PATH}"/ysyxSoC"
 
+#TODO: am-kernel, simple-test need to dowload from the 'ysyx_software_file' repo
 # download the am repo from the github
 ###### abstract-machine ######
 configAbstractMachine() {
@@ -52,27 +53,34 @@ configAbstractMachine() {
     fi
     echo -e "${RIGHT}AM_HOME: $AM_HOME${END}"
 
-    cd ${ROOT_PATH} # am -> tc-l2
+    cd ${ROOT_PATH}
 }
 
 ###### riscv-tests ######
-configRiscvTests() {
+configTestSuites() {
     mkdir -p ${AM_FOLDER_PATH}
     cd ${AM_FOLDER_PATH}
 
     if [[ -d ${RISCV_TESTS_FOLDER_PATH} ]]; then
         echo -e "${RIGHT}riscv-tests exist!${END}"
-        # if git fsck --full != 0; then
-        #     echo "[download error]: remove the dir and git clone"
-        #     rm -rf riscv-tests
-        #     git clone https://github.com/NJU-ProjectN/riscv-tests.git
-        # fi
     else
         echo -e "${INFO}[no download]: git clone${END}"
     git clone https://github.com/NJU-ProjectN/riscv-tests.git
     fi
 
-    cd ${ROOT_PATH} # am -> tc-l2
+    # cd ${ROOT_PATH}
+
+    # mkdir -p ${AM_FOLDER_PATH}
+    # cd ${AM_FOLDER_PATH}
+
+    # if [[ -d ${CPU_TESTS_FOLDER_PATH} ]]; then
+    #     echo -e "${RIGHT}simple-tests exist!${END}"
+    # else
+    #     echo -e "${INFO}[no download]: git clone${END}"
+    # git clone https://github.com/NJU-ProjectN
+    # fi
+
+    # cd ${ROOT_PATH}
 }
 
 ###### am-kernels ######
@@ -82,17 +90,12 @@ configAMKernels() {
 
     if [[ -d ${AM_KERNELS_FOLDER_PATH} ]]; then
         echo -e "${RIGHT}am-kernels exist!${END}"
-        # if git fsck --full != 0; then
-        #     echo "[download error]: remove the dir and git clone"
-        #     rm -rf am-kernels
-        #     git clone https://github.com/NJU-ProjectN/am-kernels.git
-        # fi
     else
         echo -e "${INFO}[no download]: git clone${END}"
     git clone https://github.com/NJU-ProjectN/am-kernels.git
     fi
 
-    cd ${ROOT_PATH} # am -> tc-l2
+    cd ${ROOT_PATH}
 }
 
 # download the specific commit id difftest and NEMU
@@ -103,11 +106,6 @@ configDiffTest() {
 
     if [[ -d ${DIFFTEST_FOLDER_PATH} ]]; then
         echo -e "${RIGHT}difftest exist!${END}"
-        # if git fsck --full != 0; then
-        #     echo "[download error]: remove the dir and git clone"
-        #     rm -rf am-kernels
-        #     git clone https://github.com/NJU-ProjectN/am-kernels.git
-        # fi
     else
         echo -e "${INFO}[no download]: git clone${END}"
         git clone https://gitee.com/oscpu/difftest.git
@@ -126,11 +124,6 @@ configDiffTest() {
 configNemu() {
     if [[ -d ${NEMU_FOLDER_PATH} ]]; then
         echo -e "${RIGHT}NEMU exist!${END}"
-        # if git fsck --full != 0; then
-        #     echo "[download error]: remove the dir and git clone"
-        #     rm -rf am-kernels
-        #     git clone https://github.com/NJU-ProjectN/am-kernels.git
-        # fi
     else
         echo -e "${INFO}[no download]: git clone${END}"
         git clone https://gitee.com/oscpu/NEMU.git
@@ -171,11 +164,6 @@ configDramSim3() {
 
     if [[ -d ${DRAMSIM3_FOLDER_PATH} ]]; then
         echo -e "${RIGHT}dramsim3 exist!${END}"
-        # if git fsck --full != 0; then
-        #     echo "[download error]: remove the dir and git clone"
-        #     rm -rf am-kernels
-        #     git clone https://github.com/NJU-ProjectN/am-kernels.git
-        # fi
     else
         echo -e "${INFO}[no download]: git clone${END}"
         git clone https://github.com/OpenXiangShan/DRAMsim3.git
@@ -207,19 +195,19 @@ helpInfo() {
     echo -e "${RIGHT}  -d: download and config difftest${END}"
     echo -e "${RIGHT}  -i: download and config dramsim3${END}"
     echo -e "${RIGHT}  -m: download and config abstract-machine${END}"
-    echo -e "${RIGHT}  -r: download and config riscv-tests${END}"
+    echo -e "${RIGHT}  -r: download and config simple-tests, riscv-tests${END}"
     echo -e "${RIGHT}  -k: download and config am-kernels${END}"
     echo -e "${RIGHT}  -y: download and config ysyx-soc${END}"
     echo -e "${RIGHT}  -s: download and config specific repo${END}"
-    echo -e "sample: ./setup.sh -s [repo](default: nemu) ${INFO}[repo]: [nemu, diffttest, dramsim3, am, riscv-tests, am-kernels, ysyx-soc]${END}"
+    echo -e "sample: ./setup.sh -s [repo](default: nemu) ${INFO}[repo]: [nemu, diffttest, dramsim3, am, testsuites, am-kernels, ysyx-soc]${END}"
     echo -e "${RIGHT}  -h: help information${END}"
     
 }
 
 configSpecRepo() {
     if [[ -n $1 && $1 == "all" ]]; then
         configAbstractMachine
-        configRiscvTests
+        configTestSuites
         configAMKernels
         configDiffTest
         configNemu
@@ -233,17 +221,18 @@ configSpecRepo() {
         configDramSim3
     elif [[ -n $1 && $1 == "am" ]]; then
         configAbstractMachine
-    elif [[ -n $1 && $1 == "riscv-tests" ]]; then
-        configRiscvTests
+    elif [[ -n $1 && $1 == "testsuites" ]]; then
+        configTestSuites
     elif [[ -n $1 && $1 == "am-kernels" ]]; then
         configAMKernels
     elif [[ -n $1 && $1 == "ysyx-soc" ]]; then
         configysyxSoC
     else
-        echo -e "${ERROR}the params [$1] is not found.${END} opt value: [nemu, diffttest, dramsim3, am, riscv-tests, am-kernels, ysyx-soc]"
+        echo -e "${ERROR}the params [$1] is not found.${END} opt value: [nemu, diffttest, dramsim3, am, testsuites, am-kernels, ysyx-soc]"
     fi
 }
 
+mkdir -p ${ROOT_PATH}
 # Check parameters
 while getopts 'andimrkys:h' OPT; do
     case $OPT in
@@ -252,7 +241,7 @@ while getopts 'andimrkys:h' OPT; do
         d) configDiffTest;;
         i) configDramSim3;;
         m) configAbstractMachine;;
-        r) configRiscvTests;;
+        r) configTestSuites;;
         k) configAMKernels;;
         y) configysyxSoC;;
         s) configSpecRepo $OPTARG;;
diff --git a/rtl/tc_l2/src/main/scala/common/InstConfig.scala b/rtl/tc_l2/src/main/scala/common/InstConfig.scala
@@ -4,5 +4,13 @@ import chisel3._
 import chisel3.util._
 
 trait InstConfig {
-  val SoCEna = false
+  val SoCEna        = false
+  val CacheEna      = false
+  val XLen          = 64
+  val NWay          = 4
+  val NBank         = 4
+  val NSet          = 32
+  val CacheLineSize = 64 * NBank
+  val ICacheSize    = NWay * NSet * CacheLineSize
+  val DCacheSize    = NWay * NSet * CacheLineSize
 }
diff --git a/rtl/tc_l2/src/main/scala/core/if/Cache.scala b/rtl/tc_l2/src/main/scala/core/if/Cache.scala
diff --git a/rtl/tc_l2/src/main/scala/core/wb/WBU.scala b/rtl/tc_l2/src/main/scala/core/wb/WBU.scala
diff --git a/rtl/tc_l2/src/main/scala/utils/Difftest.scala b/rtl/tc_l2/src/main/scala/utils/Difftest.scala
