NVBoard(NJU Virtual Board)是基于SDL开发的虚拟FPGA开发板,可以在Verilator仿真环境中模拟FPGA,支持LED,七段数码管,开关,键盘和VGA。
.
├── board # 引脚说明文件
│ └── ...
├── example # 示例项目
│ └── ...
├── include
│ ├── at_scancode.h
│ ├── component.h
│ ├── configs.h
│ ├── constrs.h
│ ├── keyboard.h
│ ├── macro.h
│ ├── nvboard.h
│ ├── render.h
│ └── vga.h
├── LICENSE
├── pic # NVBoard图片资源
├── README.md
├── scripts
│ ├── auto_pin_bind.py # 生成引脚绑定代码的脚本
│ └── nvboard.mk # NVBoard构建规则
└── src NVBorad源码
├── component.cpp
├── event.cpp
├── nvboard.cpp
├── render.cpp
└── vga.cpp
- 将项目拷贝到本地,
git clone https://github.com/NJU-ProjectN/nvboard.git
- 通过
apt-get install libsdl2-dev libsdl2-image-dev
安装SDL2和SDL2-image - 把本项目的目录设置成环境变量
NVBOARD_HOME
example
目录下包含一个示例项目,在该目录下通过 make run
命令可运行该项目。
NVBoard提供了以下几组API
void nvboard_init()
: 初始化NVBoardvoid nvboard_quit()
: 退出NVBoardvoid nvboard_bind_pin(pin, void *signal)
: 将HDL的信号signal连接到NVBoard里的引脚pin上void nvboard_update()
: 更新NVBoard中各组件的状态,每当电路状态发生改变时都需要调用该函数
手动调用nvboard_bind_pin()
来绑定所有引脚较为繁琐。
为了方便进行信号的绑定,NVBoard项目提供了一套从自定义约束文件生成绑定代码的流程。具体地
- 编写一个自定义格式的约束文件,其格式为
top=top_name
signal pin
signal (pin1,pin2,... pink)
在约束文件的开头,需要指定顶层模块名为top_name
。约束文件支持两种信号绑定方式,signal pin
表示将顶层模块的signal
端口信号绑定到引脚pin
上,
signal (pin1,pin2,...,pink)
表示将顶层模块的signal
信号的每一位从高到低依次绑定到pin1,pin2,...,pink
上。
约束文件支持空行。
2. 通过命令python $(NVBOARD_HOME)/auto_pin_bind.py 约束文件 auto_bind.cpp
来生成C++文件。
调用该文件中的nvboard_bind_all_pins(dut)
函数即可完成所有信号的绑定。
注意,该脚本的错误处理并不完善,若自定义约束文件中存在错误,则可能无法生成正确的C++文件。
可以在board
目录下的引脚说明文件中查看引脚信息。
在C++仿真代码中调用NVBoard提供的API
#include <nvboard.h>
// ...
nvboard_bind_all_pins(&dut);
nvboard_init();
while (1) {
// ...
nvboard_update();
}
nvboard_quit();
具体地
- 在进入verilator仿真的循环前,先对引脚进行绑定,然后对NVBoard进行初始化
- 在verilator仿真的循环中更新NVBoard各组件的状态
- 退出verilator仿真的循环后,销毁NVBoard的相关资源
在Makefile中
- 将生成的上述引脚绑定的C++文件加入源文件列表
- 将NVBoard的构建脚本包含进来
include $(NVBOARD_HOME)/scripts/nvboard.mk
- 通过
make nvboard-archive
生成NVBoard的库文件 - 在生成verilator仿真可执行文件(即
$(NVBOARD_ARCHIEVE)
)将这个库文件加入链接过程,并添加链接选项-lSDL2 -lSDL2_image
可以参考示例项目中的Makefile文件,即example/Makefile
- 可以用
include/configs.h
选择贴图,让自己的虚拟FPGA开发板更有特色,贴图放在pic
目录下;