Skip to content

Commit f0c5b47

Browse files
authored
Minor doc additions
1 parent 102acf9 commit f0c5b47

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The ultra-condensed description of how to use it is:
2424

2525
In slightly more detail, the initial script is written in a sort of
2626
pseudo-Verilog. This defines several modules, each of which will be
27-
turned into an actual Verilog module running `acov`. The code in these
27+
turned into an actual Verilog module by running `acov`. The code in these
2828
auto-generated modules contains DPI calls to a library (also included
2929
with ACov) called `libacovdpi.so`. These calls basically say "Hey,
3030
I've just seen the following coverage group with the following value".
@@ -53,6 +53,9 @@ An ACov input file might look like this:
5353
record bar cover bits;
5454
}
5555

56+
Where the inputs `foo`, `bar`, etc. correspond to internal or external
57+
signals of the module `xxx` that you want to cover.
58+
5659
This will create a Verilog module called `xxx_coverage`, of the
5760
following form:
5861

@@ -284,6 +287,12 @@ means something akin to toggle coverage: we want to see each bit of
284287
the signal equal to zero and equal to one. For a signal of width W,
285288
specifying `cover bits` gives `2 * W` bins.
286289

290+
Further `record` examples:
291+
292+
record c == 4'd10 as c_ten; // where c is 4-bit
293+
record d[1:0] as d_LSBs cover {0..2};
294+
record e[8:6] > 3'd5 && |f as e_thresh cover {1};
295+
287296
### Groups
288297

289298
To specify a cross of multiple signals, use the `group` keyword. For

0 commit comments

Comments
 (0)