README: update doc for nvboard_bind_pin()

This commit is contained in:
Zihao Yu 2022-02-22 18:51:28 +08:00
parent c049f96fd9
commit 14f0e41e33
1 changed files with 6 additions and 1 deletions

View File

@ -54,7 +54,12 @@ NVBoard提供了以下几组API
- `void nvboard_init()`: 初始化NVBoard
- `void nvboard_quit()`: 退出NVBoard
- `void nvboard_bind_pin(pin, void *signal)`: 将HDL的信号signal连接到NVBoard里的引脚pin上
- `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中各组件的状态每当电路状态发生改变时都需要调用该函数
### 引脚绑定