chip-png-wavedrom-gen

Chip PNG Wavedrom Generator

任务

为芯片模块生成 Wavedrom 格式的时序图 JSON 源文件，通过 wavedrom-cli + playwright 编译为 PNG。

依赖

• Node.js
• 依赖包：见 requirements.txt（npm install）
• D2 CLI（如需处理 .d2 文件）：见 chip-png-d2-gen/requirements.txt
• 工具路径：chromium 路径通过 CHROME_PATH 环境变量或脚本内默认值配置

执行步骤

1. 编写 JSON 源文件：将 .json 文件写入项目输出目录，命名规则：wd_{描述}.json

2. 生成 PNG：

   # 单文件：wavedrom-cli 生成 SVG，playwright 截图生成 PNG
   npx wavedrom --input <output_dir>/wd_xxx.json > <output_dir>/wd_xxx.svg
   
   # 批量（通过 gen_wavedrom.js，处理所有 wd_*.json + wd_*.d2）
   node .claude/skills/chip-png-wavedrom-gen/gen_wavedrom.js <output_dir>
   

   <output_dir> 为项目中存放图表源文件和输出 PNG 的目录。

3. 在文档中引用：

   ![描述](wd_xxx.png)
   

Wavedrom JSON 格式规范

基本结构

{signal: [
  {name: 'clk',  wave: 'p.......'},
  {name: 'valid', wave: '01..0...'},
  {name: 'data',  wave: 'x222x...', data: ['D0', 'D1', 'D2']},
]}

信号分组（推荐）

多组并行信号用二维数组，第一项为组名：

{signal: [
  ['上游请求',
    {name: 'clk',   wave: 'p.......'},
    {name: 'req',   wave: '010.....'},
    {name: 'data',  wave: 'x22x....', data: ['D0']},
  ],
  ['下游响应',
    {name: 'clk',   wave: 'p.......'},
    {name: 'rsp',   wave: '0..10...'},
  ],
  ['cycle',
    {name: '',      wave: '2222222', data: ['0','1','2','3','4','5','6']},
  ]
]}

wave 符号速查

符号	含义	用途
p	时钟上升沿	时钟信号
P	时钟下降沿	低有效时钟
n	低电平	低有效信号
0	低电平/无效	默认状态
1	高电平/有效	有效状态
2	数据值	数据传输
3	高阻态	三态总线
x	无关	未关心值
.	保持前值	连续有效
=	数据标签	配合 data 数组
-	空/未画	跳过该区域

wave 常用模式

// Valid-Ready 握手
{name: 'valid', wave: '01...0.'},
{name: 'ready', wave: '0.1..0.'},
{name: 'data',  wave: 'x222x..', data: ['D0','D1','D2']},

// 脉冲请求（单周期）
{name: 'req',   wave: '010.....'},

// 多周期等待
{name: 'req',   wave: '010.....'},
{name: 'rsp',   wave: '0...10..'},

// 流水线（多级重叠）
{name: 's0_vld', wave: '01.01.0.'},
{name: 's1_vld', wave: '0.1.01.0'},
{name: 's2_vld', wave: '0..1.01.'},

// 地址-数据分离（读）
{name: 'arvalid', wave: '010......'},
{name: 'araddr',  wave: 'x22x.....', data: ['A0']},
{name: 'rvalid',  wave: '0...10...'},
{name: 'rdata',   wave: 'x...22x..', data: ['D0','D1']},