Skip to content

Commit 035908b

Browse files
committed
[doc] add coverage description in readme
1 parent ddbf390 commit 035908b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

Diff for: readme.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ It's build script is in `nix/gcd` folder, providing the below attributes:
3737
* [{tb,formal}-]rtl: SystemVerilog generated from the lowered MLIR bytecode
3838
* tb-dpi-lib: DPI library written in Rust for both Verilator and VCS
3939
* verilated[-trace]: C++ simulation executable and libaray generated by Verilator with/without `fst` waveform trace
40-
* vcs[-trace]: C simulation executable compiled by VCS with/without `fsdb` waveform trace
40+
* vcs[-trace]: C simulation executable compiled by VCS with/without `fsdb` waveform trace and 'coverage.vdb' for coverage report
4141
* jg-fpv: Formal Property Verification report generated by JasperGold
4242

4343
To get the corresponding output, developers can use:
@@ -90,6 +90,14 @@ nix run '.#gcd.vcs-trace' --impure -- +dump-start=0 +dump-end=10000 +wave-path=t
9090

9191
The DPI lib can automatically match the arguments and does not interact with VCS. In this case, the first three parameters will be passed to the DPI lib to control waveform generation, and the last parameter will be passed to the VCS to dump the results of all sva statements.
9292

93+
To generate the coverage report, you can run:
94+
95+
```bash
96+
urg -dir gcd-sim-result/result/coverage.vdb/
97+
``
98+
99+
The coverage report will be generated in the `./urgReport` directory.
100+
93101
* Note that in order to use VCS for simulation, you need to set the environment variables `VC_STATIC_HOME` and `SNPSLMD_LICENSE_FILE` and add the`--impure` flag.
94102

95103
To run the formal property verification. Then you can run:

0 commit comments

Comments
 (0)