2022-07-28 14:43:58 +00:00
|
|
|
Copyright - Yehowshua Immanuel
|
2022-05-21 21:55:27 +00:00
|
|
|
|
2022-07-28 14:43:58 +00:00
|
|
|
# A High performance, VCD Parser written in Rust
|
2022-04-14 04:50:37 +00:00
|
|
|
|
2022-05-22 00:40:46 +00:00
|
|
|
## Current Features
|
2022-07-28 14:43:58 +00:00
|
|
|
- pretty fast
|
2022-05-22 00:40:46 +00:00
|
|
|
|
2022-07-19 17:48:22 +00:00
|
|
|
## Planned Features
|
2022-07-28 14:43:58 +00:00
|
|
|
- rapid log2n scrubbing through a signal's timeline
|
|
|
|
|
|
|
|
|
|
# Current Limitations
|
|
|
|
|
Unable to handle VCD files that have signals with more than
|
|
|
|
|
2^32 - 1 = 4,294,967,295 deltas/changes.
|
2022-04-14 04:50:37 +00:00
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
|
|
|
|
Make sure you have a test vcd file to get you started. You can grab
|
|
|
|
|
a large VCD file from
|
|
|
|
|
[here](https://drive.google.com/file/d/1pfm2qo2l8fGTHHJ8TLrg1vSGaV_TUbp2/view?usp=sharing).
|
|
|
|
|
|
|
|
|
|
The first build of the program may take some time.
|
|
|
|
|
|
2022-05-19 00:47:55 +00:00
|
|
|
``cargo run --release test-vcd-files/aldec/SPI_Write.vcd``
|
2022-04-14 04:50:37 +00:00
|
|
|
|
2022-06-22 01:06:51 +00:00
|
|
|
You can run all the tests with ``cargo test``
|
|
|
|
|
|
2022-05-19 02:57:42 +00:00
|
|
|
# TODO
|
2022-07-19 17:48:22 +00:00
|
|
|
- [ ] make a custon date parser for possibly up to 18 different versions(that
|
|
|
|
|
is, for each possible tool).
|
2022-06-22 01:06:51 +00:00
|
|
|
- [ ] Fix warning especially usage and restriction warnings once I'm
|
|
|
|
|
able to successfully parse all sample VCDs.
|
2022-07-20 14:38:56 +00:00
|
|
|
- [ ] Change error messages to line and filenames. Go through all calls to ``format!``
|
|
|
|
|
whilst also keep performance in mind.
|
2022-07-26 01:16:15 +00:00
|
|
|
- [ ] Create compressed fungible numeric enums with good heuristic support.
|
2022-07-20 14:38:56 +00:00
|
|
|
- [ ] Print out git commit or release number.
|
2022-07-18 16:53:44 +00:00
|
|
|
- [ ] Should be able to load waveform whilst viewing it live.
|
|
|
|
|
- could be quite challenging to implement for various reasons
|
2022-06-19 13:44:57 +00:00
|
|
|
|
2022-07-14 22:52:12 +00:00
|
|
|
- [ ] Consolidate error messages and add cursors throughout.
|
2022-05-24 03:59:57 +00:00
|
|
|
- [ ] Consider what to do with don't care values
|
2022-07-14 22:52:12 +00:00
|
|
|
will probably just convert them to strings for now.
|
2022-05-23 03:00:03 +00:00
|
|
|
- [ ] Include line and possible column numbers
|
2022-05-19 02:57:42 +00:00
|
|
|
- [ ] Take a look at GTKWave parser to compare effificiency.
|
|
|
|
|
- [ ] Send survey to community channel.
|
|
|
|
|
|
2022-07-19 17:48:22 +00:00
|
|
|
# Questions to Answer
|
|
|
|
|
- [ ] Is it safe to assume that we may treat any values before the first
|
|
|
|
|
non-zero timestamp as having occured on `#0`?
|
|
|
|
|
|
2022-05-24 03:59:57 +00:00
|
|
|
# Probably No Longer Needed
|
2022-06-24 00:56:44 +00:00
|
|
|
- [ ] Should insert nodes in BFS order
|
