RISC-V Mini 项目使用教程

RISC-V Mini 项目使用教程

riscv-mini Simple RISC-V 3-stage Pipeline in Chisel 项目地址: https://gitcode.com/gh_mirrors/ri/riscv-mini

1. 项目的目录结构及介绍

RISC-V Mini 项目的目录结构如下：

riscv-mini/
├── github/
│   └── workflows/
├── custom-bmark/
├── project/
├── src/
│   ├── main/
│   │   ├── scala/
│   │   │   └── mini/
│   │   └── resources/
│   └── test/
│       └── scala/
│           └── mini/
├── tests/
├── .gitignore
├── .gitmodules
├── install_verilator.sh
├── scalafmt.conf
├── LICENSE
├── Makefile
├── README.md
├── build-riscv-tools.sh
├── build.sbt
├── diagram.pdf
└── diagram.png

目录结构介绍

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• custom-bmark/: 用于存放自定义的 RISC-V 程序代码和 Makefile。
• project/: 包含项目的构建配置文件。
• src/: 项目的源代码目录，包含主代码和测试代码。
  • main/scala/mini/: 主代码目录，包含 RISC-V 处理器的实现。
  • test/scala/mini/: 测试代码目录，包含各种测试用例。
• tests/: 包含用于测试的 hex 文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• install_verilator.sh: 安装 Verilator 的脚本。
• scalafmt.conf: Scala 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目的构建文件。
• README.md: 项目介绍和使用说明。
• build-riscv-tools.sh: 构建 RISC-V 工具链的脚本。
• build.sbt: SBT 构建配置文件。
• diagram.pdf: 数据通路图的 PDF 版本。
• diagram.png: 数据通路图的 PNG 版本。

2. 项目的启动文件介绍

项目的启动文件主要是 Makefile 和 build.sbt。

Makefile

Makefile 是项目的构建文件，包含了生成 FIRRTL 和 Verilog 文件的命令。主要命令如下：

• make: 生成 FIRRTL 和 Verilog 文件。
• make verilator: 生成 Verilator 二进制文件。
• make run-tests: 运行所有测试用例。
• make run-custom-bmark: 运行自定义的 RISC-V 程序。

build.sbt

build.sbt 是 SBT 构建配置文件，用于配置项目的依赖和构建任务。通过 make sbt 命令可以启动 SBT 控制台，然后执行各种测试任务。

3. 项目的配置文件介绍

项目的配置文件主要包括 scalafmt.conf 和 Makefile。

scalafmt.conf

scalafmt.conf 是 Scala 代码格式化配置文件，用于配置代码的格式化规则。通过 scalafmt 工具可以自动格式化项目中的 Scala 代码。

Makefile

Makefile 不仅用于构建项目，还包含了一些配置选项，例如：

• RISCV: 配置 RISC-V 工具链的路径。
• VERILATOR_ROOT: 配置 Verilator 的安装路径。

通过这些配置文件，可以方便地定制项目的构建和运行环境。

riscv-mini Simple RISC-V 3-stage Pipeline in Chisel 项目地址: https://gitcode.com/gh_mirrors/ri/riscv-mini