Regvue: 现代寄存器文档

在上个月举行的 DVcon us 2023 上,一篇名为 Regvue: Modern Register Documentation 的论文获得了最佳论文排名的第三名,论文尚未公开下载,不过代码已经在 github 开源。

作者基于 vue 实现了一个网页,当用户导入寄存器 json 文件后,可以很直观方便的看到 soc 的 memory map,每个模块的寄存器地址及位域定义,效果如下:


项目提供了四个例子,可以直接打开体验

进入每个模块后可以看到整体的寄存器结构,每个寄存器都是一个链接,点击后会在当前位置显示寄存器的详细位域定义,再次点击可以收起细节,非常方便。
相比于大多数公司使用 excel/word 维护寄存器文档,然后通过邮件发送或者共享目录,具有非常明显的优势:

  1. excel/word 难以做版本管理,无法解决什么时候谁为什么改了那一行的问题
  2. 邮件通知的方式往往会带来设计验证使用的寄存器文档版本不一致,造成仿真用例失败去定位的额外工作量
  3. 在一个地方看所有的寄存器,免得搜邮件,对版本,找来找去

那么怎么用这个工具呢?

  1. 实现 json 格式的寄存器原始文件,json格式见 regvue/register-description-format.adoc at main · nasa-jpl/regvue (github.com)
  2. 自己部署作者的工程或者使用作者在 github上的部署 regvue (nasa-jpl.github.io),上传 json 格式的寄存器文件。
2 个赞

这个和以前的ip-xact格式,通过工具可以生成的html文件比较呢?

这个更现代,那个像是十几年前的东西