1. 为什么Verilog开发者需要WaveDrom?
如果你写过Verilog,肯定有过这样的经历:费了老大劲写完一段状态机或者总线协议,想跟同事或者导师解释清楚时序关系,结果发现“只可意会,不可言传”。用文字描述?“在第三个时钟上升沿后,当ready信号拉高且valid信号为1时,数据被锁存”。画图?打开Visio或者Draw.io,一个个矩形去拖拽、对齐、画箭头,一个简单的时序图可能就得折腾半小时,一旦需要修改,更是牵一发而动全身,简直让人抓狂。
我刚开始做FPGA项目时,就深受其苦。直到我发现了WaveDrom,感觉像是打开了一扇新世界的大门。它不是什么复杂的图形软件,而是一个基于JSON的文本描述语言。你只需要用简单的代码描述出时钟、信号的高低变化,它就能自动生成清晰、专业的交互式时序图。对于Verilog开发者来说,这简直是量身定做的神器。你想啊,我们整天和代码、信号打交道,用写代码的方式画图,再自然不过了。修改起来也极其方便,改几行“波形代码”,图片就自动更新了,这和我们写RTL代码、看仿真波形的逻辑是完全一致的。
更重要的是,WaveDrom生成的图可以直接嵌入网页,是交互式的。你可以用鼠标悬停查看数据值,缩放观察细节,这对于设计文档、技术博客或者项目汇报来说,体验提升不是一星半点。它能把枯燥的时序说明,变成一目了然的动态图表。接下来,我就带你从最基础的语法开始,一步步玩转WaveDrom,画出那些能让你的设计文档闪闪发光的专业时序图。
2. 5分钟上手:你的第一个WaveDrom时序图
别被“JSON”、“配置”这些词吓到,WaveDrom的核心语法简单到超乎想象。我们从一个最基础的例子开始,你甚至不需要安装任何软件。
2.1 在线编辑器的魔力
最快捷的方式是直接访问WaveDrom的官方在线编辑器。打开浏览器,输入WaveDrom Editor的网址,你就能看到一个左右分屏的界面。左边是代码编辑区,右边是实时渲染的波形图。这种“所见即所得”的方式,对于学习语法来说再友好不过了。我强烈建议你边读边动手,把下面的例子敲进去,立刻就能看到效果。
2.2 理解核心结构:信号(Signal)与波形(Wave)
所有WaveDrom图都围绕一个核心的JSON对象构建。最基本的结构长这样:
{ signal: [
{ name: ‘clk‘, wave: ‘P...‘ },
{ name: ‘data‘, wave: ‘01.0‘ }
]}
我来拆解一下:
signal:这是一个数组,里面包含了你要画的所有信号线。name:信号的名字,比如clk,rst_n,data_valid,会显示在波形图的左侧。wave:这是灵魂所在!它是一个字符串,里面的每一个字符都代表信号在一个时间单元(你可以暂时理解为一个基础时钟周期)的状态。
那么,字符代表什么意思呢?记住这几个最常用的就够应付80%的场景了:
0: 低电平1: 高电平x: 不定态(高阻或冲突,常用红色表示)z: 高阻态.: 保持上一个状态。这个点非常实用,比如你想画一个持续了3个周期的高电平,不用写111,写1..就行了,更简洁。p,P,n,N: 专门用于画时钟。p/n画的是小写的时钟波形(先低后高/先高后低),P/N画的是大写的时钟波形(带上升沿和下降沿的标识线),通常我们用P和N更多。
现在,把上面的代码贴到在线编辑器里,你会立刻看到一个简单的时钟信号 clk 和一个数据信号 data 的波形。是不是很简单?你已经掌握了最核心的语法。
2.3 添加数据标签(Data)
在数字电路中,总线上的数据值往往比电平本身更重要。WaveDrom可以很方便地为信号的特定周期标注数据值。这就要用到 data 属性。
看这个例子,它描述了一个简单的总线写操作:
{ signal: [
{ name: “clk“, wave: “P.....“ },
{ name: “cmd“, wave: “01.0..“, data: [“IDLE“, “WRITE“, “IDLE“] },
{ name: “addr“, wave: “x===x“, data: [“0x1000“, “0x1004“, “0x1008“] },
{ name: “wdata“, wave: “x===x“, data: [“0xDEAD“, “0xBEEF“, “0xCAFE“] }
]}
在这里,wave 字符串中的 = 字符表示“数据周期”,它通常显示为一个被框起来的区域。data 数组中的字符串会按顺序显示在这些数据周期对应的波形上方。这样,地址总线和数据总线的变化就一目了然了。这种表达方式在描述内存访问、总线传输协议(如 AXI、APB)时极其有用。
3. 进阶技巧:让时序图更清晰、更专业
掌握了基本语法后,你可能会觉得画出来的图有点“简陋”。别急,WaveDrom提供了一系列配置项,能让你的时序图变得和教科书里一样专业。
3.1 组织信号:分组(Groups)与留白
当一个接口信号很多时(比如一个完整的AXI总线),把所有信号平铺开来会显得很乱。这时可以使用分组功能。分组用数组 [] 来实现,可以把相关的信号组织在一起,并给这个组起个名字。
{ signal: [
{ name: ‘sys_clk‘, wave: ‘P..P..P‘ },
[ “AXI Write Channel“,
[ “Control“,
{ name: ‘AWVALID‘, wave: ‘01....0‘ },
{ name: ‘AWREADY‘, wave: ‘0.1..0.‘ }
],
{ name: ‘AWADDR‘, wave: ‘x===.x.‘, data: [‘ADDR1‘, ‘ADDR2‘] }
],
{},
[ “AXI Read Channel“,
{ name: ‘ARVALID‘, wave: ‘0...10.‘ },
{ name: ‘ARREADY‘, wave: ‘0..1.0.‘ }
]
]}
注意上面代码中的 [ “AXI Write Channel“, ... ] 就是一个分组,它还可以嵌套子分组(如 [ “Control“, ... ])。{} 表示一个空行,可以用来分隔不同的逻辑模块,让图纸的排版更有呼吸感,逻辑层次也更清晰。
3.2 控制时间尺度:周期(Period)与相位(Phase)
有时候,不同信号的时钟周期可能不同,或者存在相位差。WaveDrom的 period 和 phase 属性就是用来处理这种情况的。
period: 定义该信号一个“波”字符占用的时间单位数。默认是1。如果设置period: 2,那么这个信号的一个周期(比如一个P)就会占据两个标准时间单位的宽度。这常用于表示频率较低的时钟或使能信号。phase: 定义信号的相位偏移。正数表示向左移动(超前),负数表示向右移动(滞后)。取值可以是小数,比如0.5表示偏移半个时间单位。
看一个DDR内存命令的模拟例子:
{ signal: [
{ name: “CK“, wave: “P“, period: 2 },
{ name: “CMD“, wave: “x=..=..=..“, data: [“ACT“, “NOP“, “RD“, “NOP“], phase: -0.25 },
{ name: “ADDR“, wave: “x===.....“, data: [“ROW“, “COL“], phase: -0.25 }
]}
这里,CK 时钟的周期被拉长了,而 CMD 和 ADDR 信号相对于时钟有一个轻微的右移(phase: -0.25),这非常真实地反映了实际电路中命令/地址总线相对于时钟沿的建立时间关系。
3.3 全局美化:皮肤(Skins)与缩放(Hscale)
图纸的样式也可以定制。这主要通过顶层的 config 对象来实现。
hscale: 水平缩放因子。默认是1。当你信号周期很多,图太挤的时候,可以设置hscale: 2让图变宽,更易读。反之,如果图太稀疏,可以设置小于1的值来压缩。skin: 切换主题皮肤。除了默认的default,还有dark(深色背景)、lowkey(低调线条)和narrow(窄间距)等可选。在制作演示文稿时,根据背景色选择一个合适的皮肤,视觉效果会更好。
{
signal: [
{ name: “clk“, wave: “p....P....“ },
{ name: “data“, wave: “x===x===x“, data: [“A“, “B“, “C“] }
],
config: { hscale: 2, skin: “dark“ }
}
试试这段代码,你会得到一个更宽敞、深色背景的波形图,非常适合在暗色主题的PPT中使用。
4. 高级实战:标注与交互
到了这里,你已经能画出很专业的静态时序图了。但WaveDrom还能做得更多——它可以添加丰富的标注,让图纸自己“说话”,解释关键的时间关系。
4.1 添加箭头与标注(Arrows and Edges)
这是WaveDrom非常强大的一个功能,用于显示信号之间的因果关系或时间约束。实现分为两步:
- 标记节点(Node): 在信号的
wave字符串中,用.来表示一个普通的电平周期,但如果你在某个字符的位置用一个小写字母(如a,b)替换了.,那就表示你在这个时间点标记了一个“节点”。 - 连接边(Edge): 在JSON的
edge数组里,描述这些节点之间的连接关系。
{
signal: [
{ name: ‘clk‘, wave: ‘P....P..‘, node: ‘...a...b‘ },
{ name: ‘req‘, wave: ‘01....0.‘, node: ‘..c....d‘ },
{ name: ‘ack‘, wave: ‘0...1..0‘, node: ‘....e..f‘ }
],
edge: [
‘a~c 触发‘,
‘c~e 等待‘,
‘e~b 响应‘,
‘b~d 完成‘,
‘d~f 结束‘
]
}
在上面的例子中,我们在 clk 的上升沿标记了 a 和 b,在 req 的上升沿和下降沿标记了 c 和 d,在 ack 的上升沿和下降沿标记了 e 和 f。然后在 edge 里,我们用 a~c 表示从节点 a 到节点 c 画一条带箭头的曲线,并标注文字“触发”。~ 表示画曲线,你也可以用 - 画直线,用 ~> 或 -> 画带箭头的线。通过这种方式,可以清晰地展示出“时钟上升沿触发请求,请求拉高后等待应答,应答在下一个时钟上升沿前返回”这样的完整时序逻辑。
4.2 添加图标题与时间轴(Head/Foot)
一份正式的文档,图表应该有标题和编号。WaveDrom的 head 和 foot 属性就是干这个的。
{
signal: [
{ name: ‘clk‘, wave: ‘P..P..P‘ },
{ name: ‘data‘, wave: ‘x=..=..x‘, data: [‘D0‘, ‘D1‘] }
],
head: {
text: ‘图1: 突发数据传输时序‘,
tick: 0,
every: 2
},
foot: {
text: ‘时钟周期‘,
tock: 1,
every: 2
}
}
head: 定义图表顶部的区域。text是标题。tick: 0表示在时间轴0的位置上方(head区)画一个刻度标签。every: 2表示每2个时间单元画一个标签。这样就会在0, 2, 4...的位置显示“0”, “2”, “4”...foot: 定义图表底部的区域。tock: 1表示在时间轴0和1之间(foot区)画一个刻度标签。结合every: 2,会在1, 3, 5...的位置显示“1”, “3”, “5”...。foot的text可以作为图的脚注或说明。
这个功能让生成的波形图完全可以达到出版级的标注水准。
5. 融入工作流:从代码到文档
画好了漂亮的时序图,最后一步就是把它用起来。WaveDrom的集成非常灵活。
保存与导出: 在线编辑器的左下角有保存按钮。你可以将图纸保存为 .svg 或 .png 格式的图片,插入到Word、PPT或PDF文档中。SVG是矢量格式,无限放大都不会模糊,是首选。
本地使用: 如果你更喜欢离线环境,或者想集成到脚本中自动生成文档,可以安装WaveDrom的命令行工具或Node.js包。这样你就可以在本地编辑一个 .js 或 .json 文件,然后用命令一键生成图片。对于需要频繁更新图纸的大型项目,这能节省大量时间。
与Markdown/文档工具结合: 由于WaveDrom代码本身就是一段JSON/JavaScript,它可以被很多文档工具直接解析。例如,在一些支持Mermaid的Markdown编辑器中,也有插件支持直接渲染WaveDrom代码块。更常见的做法是,将WaveDrom代码块放在HTML页面中,并引入WaveDrom的JS库,这样在网页里就能直接显示交互式波形。我在自己的项目文档和技术博客中就一直这么做,读者可以直接与波形图互动,体验非常好。
说到底,WaveDrom不仅仅是一个画图工具,它更是一种思维方式的延伸。它要求你像写代码一样严谨地描述时序,这个过程本身就能帮你理清设计中的模糊点。下次当你需要解释一个Verilog模块的接口时序时,别再费力用文字描述了,直接写一段WaveDrom代码吧,你会发现沟通效率成倍提升。
2万+



被折叠的 条评论
为什么被折叠?



