docs/build: accuracy fixes for testbench comments, property docs, and Makefile clean#1
Open
billdmar wants to merge 2 commits into
Open
docs/build: accuracy fixes for testbench comments, property docs, and Makefile clean#1billdmar wants to merge 2 commits into
billdmar wants to merge 2 commits into
Conversation
The prove script formal/sync_fifo.sby produces output in formal/sync_fifo/, not formal/sync_fifo_prove/ (which is never created). Drop the dead path and annotate the real one.
- tb: rewrite the depth-sweep header note; the bench does not read DEPTH back from the model at runtime, it uses the -DDEPTH_PARAM compile define that the Makefile keeps in lock-step with -GDEPTH. - tb: correct the fault-injection description to match the code (XOR 0xFF on every third accepted write, not a swap of two pop values). - tb: note DATA_WIDTH tracks the DUT default (8) and is never overridden. - properties: document what each Group 6 count/flag assertion pins down. Comment-only; no RTL, assertion, or scoreboard behavior changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Small, safe accuracy refinements to documentation/comments and one Makefile clean-target fix. No RTL, SVA assertion, formal-script, or scoreboard logic was changed — verification results and the existing honesty notes are preserved exactly.
Changes
Makefilecleanremovedformal/sync_fifo_prove/, a directory that is never created. The prove scriptformal/sync_fifo.sbywrites its output toformal/sync_fifo/(already cleaned on the next line). Dropped the dead path and annotated the real one.tb/tb_sync_fifo.cpp(comment-only)-DDEPTH_PARAM=<N>compile define that the Makefile passes in lock-step with-GDEPTH=<N>.sample_transactions()) actually XORs every third accepted write with0xFFbefore pushing to the golden queue. Comment now matches the code.DATA_WIDTHtracks the DUT default (8) and is never overridden via-GDATA_WIDTH.rtl/sync_fifo_properties.sv(comment-only)a_count_in_range,a_empty/full_iff_count_*,a_shadow_count).Audit notes
main: BMC=20, prove (k-induction)=15, cover=30 are consistent across the.sbyscripts, Makefile, CI, README, and the RTL header. No change needed.a_data_integrity's k-induction step does not close (shadow-tracker limitation on the OSS Yosys frontend) is left untouched.Verification status
Not executed locally — verilator / iverilog / sby / yosys are not installed in this environment, so these are static, read-based refinements only. All changes are comment/doc/clean-target edits with no impact on lint, synthesis, simulation, or formal behavior. CI (lint + synth + formal BMC depth 20 + sim) will verify on push.