Vivado加上VsCode让你的生活更美好
Vivado加上VsCode让你的生活更美好
Vivado加上VsCode让你的生活更美好
引言
大二的时候，接触硬件描述语言。Vivado自带的编辑器实在很难用，为了有更加舒适的体验，我寻找着取而代之的方法。 网络上的答案大同小异，基本上都是用的Sublime Text.（我的学长们也都是） 平时写工程的过程中，我习惯使用VsCode,尤其是在微软收购GitHub之后，虽然越来越卡了。但是我还是尽可能的选择了Code,现在用了一年多了，感觉还是很不错的，接下来分享一下如何配置使用，让您的生活更美好。
站在前人的肩膀上
是找了一些年代相对比较久远的文章，关于VsCode替换掉Vivado原本的编辑器的。我稍作尝试，其实也很简单。
步骤一、更换Vivado自带文本编辑器
第一步 打开Vivado 在Tool菜单中 打开Settings
第二步 在Settings里更换默认的文本编辑器
这里需要键入的表达式是：C:/Program Files/Microsoft VS Code/Code.exe [file name] -[line number] 前面是VsCode应用程序的绝对路径。Linux下如果是在环境变量中，可以直接写Code 但是Windows下好像不可以。 这样双击工程下面的文件，Vivado会自动使用Code打开文件。
这样，我们就能用VsCode取代原本的编辑器了。
步骤二、用VsCode舒适的编写Verilog
第一步 安装Verilog扩展
在VsCode扩展商店搜索verilog。 我们安装使用人数最多的扩展。可以看见其是支持Verilog和SystemVerilog的，如果你使用的是VHDL则下载另外的插件即可。 他能帮你实现的功能：
- 语法高亮
- 自动补齐
- 列出端口。
可以看到，我们的verilog文本，被渲染的很漂亮。并且能够实现自动补齐。
第二步 实现自动纠错
使用一个IDE（文本编辑器），我们最关心的问题往往是，他能否实现自动语法纠错？ 当然是可以的，实现这一功能的前提是： vivado安装目录下的xvlog（这个是vivado自带的语法纠错工具）。 你需要将这个工具所在的目录放置在系统的环境变量，以便VsCode能够方便的调用他。 具体的目录就是Vivado的bin文件夹。
如果你不知道上述界面如何调出，请移步:www.google.cn 添加完成之后，在命令行输入 xvlog – version 检测是否生效
如果没有打印出未找到该命令，那么你可能需要重启您的电脑。
接下来我们在设置里，找到刚才安装的verilog扩展，将verilog的Linter更换成xvlog。
同理，如果你想使用的语法纠错插件来自modelsim,quatus，选择他们对应的linter即可。 就我个人的使用经验，各个软件的语法排错机制还是有一点细微的不同的，建议选择正确的解析器。 设置完成之后，就能实现语法的纠错，在平常的工程中已经可以很给力的帮助你了。
需要注意的是，编译器需要您手动保存，才会开启xvlog解析，也就是说观看最新错误之前，需要保存一下。
步骤三、自动生成Testbench
有时候在工程中要例化一个模块，这个模块有几十个输入几十个输出，如果没有一个好的脚本帮助你，不仅人为出错的可能比较大，例化的过程想必也是痛苦的。 还好有人已经在VsCode编写过自动生成Testbench的脚本了，感谢。
扩展商店搜索Verilog_TestBench,安装过后，任意编写一段verilog程序。按下ctrl+shift+p,选择testbench即可生成testbench对应的tb文本。
效果如上图所示。执行脚本之后，其出结果导向powershell的输出结果之中。帮我们自动生成了了时钟信号，复位信号，以及进行了模块的例化。如果你只需要例化模块，复制这一部分进你的代码中就可以了。到这里，VsCode已经能够给你的工程带来及其舒适的体验了。
步骤四、进一步优化
可以看到，美中不足的是，生成的文本你还需复制粘贴到新建的testbench文件中去，真是有些麻烦了。 但是从命令行执行的命令可以看到，这个脚本是用python编写的。顺着文件目录找到原本的python文件，即可修改输出内容。 这里我为了能让输出的testbench自动生成tb文件，上了一段powershell的脚本。
理清一下我们脚本的思路：脚本需要将命令执行，输入的第一个参数为文件名a.v,输出的文件名为tb_a.v. 可以将整个脚本的初始化条件写入powershell的profile文件中（就和bash里的.bashrc一样，ps在启动时会自动加载此配置文件的内容）。
那么profile文件在哪儿呢？打开你的powershell。输入 echo $profile 即可。 想编辑文件，直接在命令行输入 code $profile 。 前提是你的vscode添加进系统环境变量了，关于怎么添加环境变量，请看上文。
最后写的脚本如下，只需更改TestBenchPath的值就行了，你完全可以写的比我好，不如自己试一下？
function createtb_function{
param(
[Parameter(ValueFromPipeline=$true)]
$InputObject
)
$FileName = $InputObject
$tbFileName = "tb_" + $FileName.split("\")[-1]
echo $tbFileName
python $env:TestBenchPath $FileName >> $tbFileName
}
set-alias ll Get-ChildItemColor
$env:TestBenchPath="C:\Users\22306\.vscode\extensions\truecrab.verilog-testbench-instance-0.0.5\out\vTbgenerator.py"
set-alias createtb createtb_function
修改过后，重启vscode的powershell命令行。输入命令createtb xxx.v，即可输出生成文件。
最后testbench文件就自动生成了。
步骤五 VsCode使用小技能
这部分用来总结一下VsCode使用过程中的一些小经验，可能会持续更新
- 按住鼠标中键，可以连续操作多行，这个在例化模块，以及一些无脑操作的时候很管用。
- ctrl + f 搜索 替换
- Code支持文件对比功能，在左边的资源栏中右击比较即可（抄代码很方便）
- ctrl+r可以搜索过去曾经使用code打开的文件，真的方便，不需要鼠标操作，够极客
如果你的vivado在ubuntu系统下
在学院的电脑里装了一个ubuntu18.04系统，发现vivado也有ubuntu的支持，那么为了能够有更好的编程体验，我又对上述过程进行了linux的移植.
首先，安装vscode
其次,把更换vivado中文本编辑器的命令换成 code [filename] , 这样你的vivado文本编辑器就换成vscode了。
然后,在您的系统里安装powershell。
再然后在设置里搜索terminal，把终端在linux上使用的路径换成pwsh所在路径。
最后修改powershell的profile文件，不过与windows的略有不同，这里贴上代码。
#以后要 使用 ll 而不是 ls了。
function createtb_function{
param(
[Parameter(ValueFromPipeline=$true)]
$InputObject
)
$FileName = $InputObject
$tbFileName = "tb_" + $FileName.split("/")[-1]
echo $tbFileName
python $env:TestBenchPath $FileName >> $tbFileName
}
set-alias ll Get-ChildItemColor
$env:TestBenchPath="/home/princeling/.vscode/extensions/truecrab.verilog-testbench-instance-0.0.5/out/vTbgenerator.py"
set-alias createtb createtb_function
其他就能和原来一样喽～
写在最后的
至此，我深深体会到了作为一名verilog编程者的辛酸。
文章最后特别感谢网友南工小王子对本文内容的贡献。