NVBoard

接入verilator步骤

API说明

NVBoard提供了以下几组API - void nvboard_init(): 初始化NVBoard - void nvboard_quit(): 退出NVBoard - void nvboard_bind_pin(void *signal, bool is_rt, bool is_output, int len, ...): 将HDL的信号signal连接到NVBoard里的引脚上，具体地 - is_rt为true时，表示该信号为实时信号，每个周期都要更新才能正确工作，如键盘和VGA相关信号； is_rt为false时，表示该信号为普通信号，可以在NVBoard更新画面时才更新，从而提升NVBoard的性能，如拨码开关和LED灯等，无需每个周期都更新 - is_output为true时，表示该信号方向为输出方向(从RTL代码到NVBoard)；否则为输入方向(从NVBoard到RTL代码) - len为信号的长度，大于1时为向量信号 - 可变参数列表...为引脚编号列表，编号为整数；绑定向量信号时，引脚编号列表从MSB到LSB排列 - void nvboard_update(): 更新NVBoard中各组件的状态，每当电路状态发生改变时都需要调用该函数

引脚绑定

手动调用nvboard_bind_pin()来绑定所有引脚较为繁琐。为了方便进行信号的绑定，NVBoard项目提供了一套从自定义约束文件生成绑定代码的流程。具体地 1. 编写一个自定义格式的约束文件，其格式为

top=top_name

# Line comment inside nxdc
signal pin
signal (pin1, pin2, ..., pink)

在约束文件的第一行，需要指定顶层模块名（上文中为top_name）。约束文件支持两种信号绑定方式，signal pin表示将顶层模块的signal端口信号绑定到引脚pin上， signal (pin1, pin2, ..., pink)表示将顶层模块的signal信号的每一位从高到低依次绑定到pin1, pin2, ..., pink上。约束文件支持空行与行注释。

通过命令python $(NVBOARD_HOME)/scripts/auto_pin_bind.py nxdc约束文件路径 auto_bind.cpp输出路径来生成C++文件。

调用该文件中的nvboard_bind_all_pins(dut)函数即可完成所有信号的绑定。

注意，该脚本的错误处理并不完善，若自定义约束文件中存在错误，则可能无法生成正确的报错信息与C++文件。 ~~如果发现脚本中的错误也可以尝试修复一下然后丢pr~~

可以在board目录下的引脚说明文件中查看引脚信息。

其中，复位引脚RST不使用，因为NVBoard在cpp文件中包含一些内部状态，仅复位RTL设计部分会使其与NVBoard状态不一致。一个实现全系统复位效果的简单方法是退出NVBoard并重新运行。RTL设计的复位工作由verilator的wrapper完成，具体见example/csrc/main.cpp。

调用API

在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_ARCHIVE))将这个库文件加入链接过程，并添加链接选项-lSDL2 -lSDL2_image

可以参考示例项目中的Makefile文件，即example/Makefile

特技

可以用 include/configs.h选择贴图，让自己的虚拟FPGA开发板更有特色，贴图放在 pic目录下；

引脚说明

input BTNC
input BTNU
input BTND
input BTNL
input BTNR

input SW0
input SW1
input SW2
input SW3
input SW4
input SW5
input SW6
input SW7
input SW8
input SW9
input SW10
input SW11
input SW12
input SW13
input SW14
input SW15

output LD0
output LD1
output LD2
output LD3
output LD4
output LD5
output LD6
output LD7
output LD8
output LD9
output LD10
output LD11
output LD12
output LD13
output LD14
output LD15

output R16
output G16
output B16
output R17
output G17
output B17

output SEG0A
output SEG0B
output SEG0C
output SEG0D
output SEG0E
output SEG0F
output SEG0G
output DEC0P

output SEG1A
output SEG1B
output SEG1C
output SEG1D
output SEG1E
output SEG1F
output SEG1G
output DEC1P

output SEG2A
output SEG2B
output SEG2C
output SEG2D
output SEG2E
output SEG2F
output SEG2G
output DEC2P

output SEG3A
output SEG3B
output SEG3C
output SEG3D
output SEG3E
output SEG3F
output SEG3G
output DEC3P

output SEG4A
output SEG4B
output SEG4C
output SEG4D
output SEG4E
output SEG4F
output SEG4G
output DEC4P

output SEG5A
output SEG5B
output SEG5C
output SEG5D
output SEG5E
output SEG5F
output SEG5G
output DEC5P

output SEG6A
output SEG6B
output SEG6C
output SEG6D
output SEG6E
output SEG6F
output SEG6G
output DEC6P

output SEG7A
output SEG7B
output SEG7C
output SEG7D
output SEG7E
output SEG7F
output SEG7G
output DEC7P

rt_output VGA_VSYNC
rt_output VGA_HSYNC
rt_output VGA_BLANK_N
rt_output VGA_R0
rt_output VGA_R1
rt_output VGA_R2
rt_output VGA_R3
rt_output VGA_R4
rt_output VGA_R5
rt_output VGA_R6
rt_output VGA_R7
rt_output VGA_G0
rt_output VGA_G1
rt_output VGA_G2
rt_output VGA_G3
rt_output VGA_G4
rt_output VGA_G5
rt_output VGA_G6
rt_output VGA_G7
rt_output VGA_B0
rt_output VGA_B1
rt_output VGA_B2
rt_output VGA_B3
rt_output VGA_B4
rt_output VGA_B5
rt_output VGA_B6
rt_output VGA_B7

rt_input PS2_CLK
rt_input PS2_DAT