VS Code+Ubuntu环境下Chisel开发环境搭建全攻略(含WSL2配置)
最近几年,硬件描述语言领域出现了一股新潮流——用高级编程语言来设计硬件。Chisel(Constructing Hardware in a Scala Embedded Language)正是这一趋势下的产物。作为一个基于Scala的领域特定语言(DSL),Chisel让硬件设计变得更像软件开发,这对于习惯传统Verilog/VHDL的工程师来说,可能需要一个适应过程,但一旦掌握,开发效率将大幅提升。
本文将手把手带你完成从零开始的Chisel开发环境搭建,涵盖Ubuntu原生系统和WSL2两种环境。无论你是完全没有Scala/Verilog背景的新手,还是想尝试新工具的资深工程师,都能找到适合自己的配置方案。我们会重点解决环境配置中的常见坑点,比如Java版本冲突、sbt下载慢等问题。
1. 环境准备:选择你的开发平台
在开始之前,你需要决定使用哪种开发环境。目前主流的有三种选择:
- 原生Ubuntu系统:性能最佳,适合长期进行Chisel开发的用户
- WSL2(Windows Subsystem for Linux):Windows用户的折中方案
- 云开发环境(如GitHub Codespaces):免配置,但网络依赖性强
提示:如果你主要使用Windows系统,WSL2是最佳选择。它比虚拟机更轻量,又能提供完整的Linux开发体验。
1.1 WSL2环境配置(仅Windows用户)
如果你选择WSL2,需要先完成以下准备工作:
# 以管理员身份打开PowerShell执行 wsl --install -d Ubuntu-22.04 wsl --set-default-version 2安装完成后,在开始菜单中启动Ubuntu终端,进行初始设置:
sudo apt update && sudo apt upgrade -y sudo apt install build-essential git curl -y验证WSL2版本:
wsl --list --verbose应该能看到类似这样的输出:
| NAME | STATE | VERSION |
|---|---|---|
| Ubuntu-22.04 | Running | 2 |
1.2 原生Ubuntu系统准备
对于使用原生Ubuntu系统的用户,确保系统已经更新到最新:
sudo apt update && sudo apt upgrade -y sudo apt install build-essential git curl -y2. 基础工具链安装
Chisel开发需要几个核心组件:Java运行时、Scala编译器和sbt构建工具。以下是详细的安装步骤。
2.1 Java开发环境配置
Chisel需要Java 8或11,推荐使用OpenJDK 11:
sudo apt install openjdk-11-jdk -y验证安装:
java -version应该能看到类似输出:
openjdk version "11.0.22" 2024-01-16 OpenJDK Runtime Environment (build 11.0.22+7-post-Ubuntu-0ubuntu222.04.1) OpenJDK 64-Bit Server VM (build 11.0.22+7-post-Ubuntu-0ubuntu222.04.1, mixed mode, sharing)注意:如果你的系统中有多个Java版本,可以使用
update-alternatives来管理默认版本。
2.2 安装sbt构建工具
sbt是Scala项目的标准构建工具。由于官方源的版本可能较旧,我们手动添加sbt仓库:
echo "deb https://repo.scala-sbt.org/scalasbt/debian all main" | sudo tee /etc/apt/sources.list.d/sbt.list echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | sudo tee /etc/apt/sources.list.d/sbt_old.list curl -sL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x2EE0EA64E40A89B84B2DF73499E82A75642AC823" | sudo apt-key add sudo apt update sudo apt install sbt -y验证安装:
sbt sbtVersion首次运行会下载大量依赖,可能需要较长时间。完成后会显示类似:
[info] 1.9.72.3 解决sbt下载慢的问题
国内用户可能会遇到sbt下载依赖慢的问题。可以通过以下方法加速:
- 创建
~/.sbt/repositories文件:
mkdir -p ~/.sbt/repositories- 添加以下内容:
[repositories] local maven-central: https://maven.aliyun.com/repository/public typesafe-ivy-releases: https://repo.typesafe.com/typesafe/ivy-releases/, [organization]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]3. VS Code开发环境配置
VS Code是目前最适合Chisel开发的IDE,配合适当的插件可以提供接近专业EDA工具的开发体验。
3.1 安装VS Code
在Ubuntu/WSL2中安装VS Code:
sudo apt install wget gpg wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > packages.microsoft.gpg sudo install -o root -g root -m 644 packages.microsoft.gpg /usr/share/keyrings/ sudo sh -c 'echo "deb [arch=amd64 signed-by=/usr/share/keyrings/packages.microsoft.gpg] https://packages.microsoft.com/repos/vscode stable main" > /etc/apt/sources.list.d/vscode.list' sudo apt update sudo apt install code -y对于WSL2用户,也可以在Windows端安装VS Code,然后安装"Remote - WSL"扩展。
3.2 必备插件安装
打开VS Code后,安装以下关键插件:
- Scala (Metals):提供Scala语言支持
- Scala Syntax:Scala语法高亮
- Chisel3 Syntax Highlight:Chisel语法高亮
- GitLens:Git集成
- Rainbow Brackets:括号匹配高亮
安装完成后,按Ctrl+Shift+P打开命令面板,输入"Metals: New Scala project"创建一个测试项目验证环境是否正常。
4. 创建第一个Chisel项目
现在我们来创建一个标准的Chisel项目结构。
4.1 项目初始化
mkdir my-chisel-project && cd my-chisel-project mkdir -p src/main/scala touch build.sbt编辑build.sbt文件,添加以下内容:
ThisBuild / scalaVersion := "2.13.10" ThisBuild / version := "0.1.0" lazy val root = (project in file(".")) .settings( name := "my-chisel-project", libraryDependencies += "edu.berkeley.cs" %% "chisel3" % "3.6.0", addCompilerPlugin("edu.berkeley.cs" % "chisel3-plugin" % "3.6.0" cross CrossVersion.full) )4.2 编写第一个Chisel模块
创建src/main/scala/Hello.scala文件:
import chisel3._ class Hello extends Module { val io = IO(new Bundle { val led = Output(Bool()) }) val counter = RegInit(0.U(32.W)) counter := counter + 1.U io.led := counter(25) } object Hello extends App { (new chisel3.stage.ChiselStage).emitVerilog(new Hello(), Array("--target-dir", "generated")) }4.3 编译并生成Verilog
在项目根目录运行:
sbt run如果一切正常,你会在generated目录下看到生成的Verilog文件Hello.v。
5. 常见问题解决
在实际环境搭建过程中,你可能会遇到以下问题:
5.1 Java版本冲突
症状:sbt运行时出现"Unsupported major.minor version"错误
解决方案:
sudo update-alternatives --config java选择Java 11对应的版本号。
5.2 WSL2中VS Code无法启动
症状:在WSL终端输入code .没有反应
解决方案:
- 在Windows端安装VS Code
- 安装"Remote - WSL"扩展
- 在WSL终端中运行:
code --install-extension ms-vscode-remote.remote-wsl5.3 sbt下载卡住
症状:sbt在resolving dependencies阶段长时间无响应
解决方案:
- 按
Ctrl+C中断当前进程 - 删除
~/.ivy2和~/.sbt目录 - 按照前面"解决sbt下载慢的问题"一节配置镜像源
- 重新运行sbt命令
6. 进阶配置与优化
环境基本可用后,我们可以进行一些优化配置提升开发体验。
6.1 配置VS Code的Scala环境
在项目根目录创建.scalafmt.conf文件:
version = "3.7.14" maxColumn = 120 align.preset = more continuationIndent.defnSite = 2 assumeStandardLibraryStripMargin = true docstrings.style = Asterisk lineEndings = unix includeCurlyBraceInSelectChains = false includeNoParensInSelectChains = false optIn.breakChainOnFirstMethodDot = false rewrite.rules = [SortImports, RedundantBraces]然后在VS Code设置中启用"Format on Save"。
6.2 添加测试支持
修改build.sbt,添加测试依赖:
libraryDependencies += "edu.berkeley.cs" %% "chiseltest" % "0.6.0" % "test"创建测试目录和示例测试:
mkdir -p src/test/scala创建src/test/scala/HelloTest.scala:
import chisel3._ import chiseltest._ import org.scalatest.flatspec.AnyFlatSpec class HelloTest extends AnyFlatSpec with ChiselScalatestTester { behavior of "Hello" it should "toggle led" in { test(new Hello()) { c => c.io.led.expect(false.B) c.clock.step(1 << 25) c.io.led.expect(true.B) } } }运行测试:
sbt test6.3 性能优化建议
对于WSL2用户,可以显著提升文件系统性能:
- 在Windows端创建
%UserProfile%\.wslconfig文件 - 添加以下内容:
[wsl2] memory=8GB processors=4 localhostForwarding=true- 重启WSL实例:
wsl --shutdown对于大型项目,可以配置sbt的JVM参数。创建~/.sbt/1.0/sbtopts文件:
-J-Xmx4G -J-Xms2G -J-XX:+UseG1GC -J-XX:MaxGCPauseMillis=200