digital-vcd-parser/README.md

2.5 KiB

Value Change Dump (VCD) parser using llparse based on wavedrom.

Prepare

  1. Install emcc compiler

  2. clone https://github.com/Digital-EDA/digital-vcd-parser

构建

source $EMCC_HOME/emsdk_env.sh

# 只需要运行一次
npm install browserify terser node-gyp -g
# 只需要运行一次
npm i

# 构建左推解析器代码(每次修改 ./bin/build.js 都需要重新运行)
node bin/build.js

# build
make -j 12

生成 :

  • ./out/vcd.js
  • ./out/vcd.wasm

部署代码:

# 将生成的 wasm 通过 浏览器化和特殊处理后部署到 render 项目中
source deploy.sh /mnt/c/Users/11934/Project/Digital-IDE/digital-vcd-render

Test

After first building, run following

npm run test

note: don't run browserify if you want to test.

Deploy to web

source deploy.sh /path/to/digital-vcd-render

Usage

Only stream of Uint8 is supported as input. e.g. we want to parse a certain *.vcd read in browser-like environment. Mount vcd to window in your index.html:

<!DOCTYPE html>
<html lang="">

<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <link rel="icon" href="<%= BASE_URL %>favicon.ico">
    <link rel="stylesheet" href="./vcd.css">
    <title>
        <%= htmlWebpackPlugin.options.title %>
    </title>
    <script src="./vcd.js"></script>
</head>

<body>
    <noscript>
        <strong>We're sorry but <%= htmlWebpackPlugin.options.title %> doesn't work properly without JavaScript enabled.
                Please enable it to continue.</strong>
    </noscript>
    <div id="app"></div>
</body>

</html>

In your main workspace (App.vue for example), goes like this:

const uint8array = await readVcdFile();
const vcdstream = await getVcdStream();

// level size diagram data
const values = {};

vcdstream.change.any((id, time, cmd, value, mask) => {
    if (values[id] === undefined) {
        values[id] = [];
    }
    values[id].push({time, cmd, value, mask});
})

const maxChunkLength = 1 << 17;
for (let i = 0; i < uint8array.length; i += maxChunkLength) {
    const piece = uint8array.slice(i, i + maxChunkLength);
    vcdstream.write(piece);
}

// structure info of wires in vcdstream.info
console.log(vcdstream.info);


License

MIT LICENSE