@@ -43,7 +43,7 @@ export PATH=$SVUT:$PATH
4343SVUT relies on [ Icarus Verilog] ( http://iverilog.icarus.com/ ) as simulation
4444back-end. Please install it with your favourite package manager and be sure to
4545use a version greater or equal to v10.2. SVUT is tested with ` v10.2 ` and cannot
46- work with with lower version ( ` <= v9.x ` ) .
46+ work with lower version ` <= v9.x ` .
4747
4848SVUT can also use [ Verilator] ( https://github.com/verilator/verilator ) with a limited support
4949for the moment. A future release will improve it, with example & tutorial. SVUT is tested with
@@ -62,7 +62,7 @@ No argument is required. SVUT will create "your_file_testbench.sv" which contain
6262instanciated and a place to write your testcase(s). Some codes are also commented to describe the
6363different macros and how to create a clock or dump a VCD for
6464[ GTKWave] ( https://gtkwave.sourceforge.net ) or
65- [ Surfer] ( https://gitlab.com/surfer-project/surfer ) . A c ++ file being the verilator
65+ [ Surfer] ( https://gitlab.com/surfer-project/surfer ) . A C ++ file being the verilator
6666top level is also generated (` sim_main.cpp ` ). It can be ignored if you don't use Verilator.
6767An example to understand how to use can be found [ here] ( https://github.com/dpretet/friscv/tree/master/test/common )
6868
@@ -78,16 +78,16 @@ or simply `svutRun` to execute all testbenchs in the current folder.
7878svutRun
7979```
8080
81- SVUT will scan your current folder, search for the files with " \ _ testbench.sv"
81+ SVUT will scan your current folder, search for the files with ` _testbench.sv `
8282suffix and run all tests available. Multiple suffix patterns are
83- [ possible] ( https://github.com/dpretet/svut/blob/master/svutRun.py#L46 ) .
83+ [ possible] ( https://github.com/dpretet/svut/blob/master/svut/ svutRun.py#L46 ) .
8484
8585svutRun proposes several arguments, most optional:
8686
8787- ` -test ` : specify the testsuite file path or a folder containing tests
8888- ` -f ` : pass the fileset description, default is ` files.f `
8989- ` -sim ` : specify the simulator, ` icarus ` or ` verilator `
90- - ` -main ` : specify the main.cpp file when using verilator, default is ` sim_main.cpp `
90+ - ` -main ` : specify the C++ main file when using verilator, default is ` sim_main.cpp `
9191- ` -define ` : pass verilog defines to the tool, like ` -define "DEF1=2;DEF2;DEF3=3" `
9292- ` -vpi ` : specify a compiled VPI, for instance ` -vpi "-M. -mMyVPI" `
9393- ` -dry-run ` : print the commands but don't execute them
@@ -144,11 +144,11 @@ also specify include folder in this way:
144144```
145145
146146Right after the module instance, you can use the example to generate a clock
147- (uncomment):
147+ (to uncomment):
148148
149149``` verilog
150150initial aclk = 0;
151- always #2 aclk < = !aclk;
151+ always #2 aclk = !aclk;
152152```
153153
154154Next line explains how to dump your signals values into a VCD file to open a
@@ -172,13 +172,13 @@ A testcase is enclosed between two specific defines:
172172`UNIT_TEST_END
173173```
174174
175- ` TESTNAME ` is a string, which will be displayed when test execution
175+ ` TESTNAME ` is a string which will be displayed when test execution
176176will start. Then you can use the macros provided to display information,
177- warning, error and check some signals status and values. Each error found with
178- macros increments an error counter which determine a testsuite status. If the
179- error counter is bigger than ` 0 ` , the test is considered as failed.
177+ warning, error and check some signals values. Each error encountered by a
178+ macro increments a globla error counter which determine a testsuite status.
179+ If the error counter is bigger than ` 0 ` , the test is considered as failed.
180180
181- A testsuite, comprising several ` UNIT_TEST ` is declared with another define:
181+ A testsuite, comprising several ` UNIT_TEST ` , is declared with another define:
182182
183183``` verilog
184184`TEST_SUITE("SUITENAME")
0 commit comments