diff --git a/doc/Simulation.md b/doc/Simulation.md index 1d3cdb17..3b66a14f 100644 --- a/doc/Simulation.md +++ b/doc/Simulation.md @@ -2,7 +2,7 @@ ### RTL Simulation -[Verilator] (https://www.veripool.org/projects/verilator/wiki) is a Verilog/SystemVerilog design simulator that converts the Verilog HDL to single- or mult-ithreaded C++/SystemC code to perform the design simulation. An installation guide for Verilator is located [here.] (https://www.veripool.org/projects/verilator/wiki/Installing) +[Verilator](https://www.veripool.org/projects/verilator/wiki) is a Verilog/SystemVerilog design simulator that converts the Verilog HDL to single- or mult-ithreaded C++/SystemC code to perform the design simulation. An installation guide for Verilator is located [here.](https://www.veripool.org/projects/verilator/wiki/Installing) ### Cycle-Approximate Simulation @@ -10,7 +10,7 @@ SimX is a C++ cycle-level in-house simulator developed for Vortex. The relevant ### FGPA Simulation -The current target FPGA for simulation is the Arria10 Intel Accelerator Card v1.0. The guide to build the fpga with specific configurations is located [here.] (https://github.com/vortexgpgpu/vortex-dev/blob/master/doc/Flubber_FPGA_Startup_Guide.md) +The current target FPGA for simulation is the Arria10 Intel Accelerator Card v1.0. The guide to build the fpga with specific configurations is located [here.](https://github.com/vortexgpgpu/vortex-dev/blob/master/doc/Flubber_FPGA_Startup_Guide.md) ### How to Test @@ -24,13 +24,12 @@ Running tests under specific drivers (rtlsim,simx,fpga) is done using the script - *L3cache* - used to enable the shared l3cache among the Vortex clusters. - *Driver* - used to specify which driver to run the Vortex simulation (either rtlsim, vlsim, fpga, or simx). - *Debug* - used to enable debug mode for the Vortex simulation. +- *Scope* - - *Perf* - is used to enable the detailed performance counters within the Vortex simulation. - *App* - is used to specify which test/benchmark to run in the Vortex simulation. The main choices are vecadd, sgemm, basic, demo, and dogfood. Other tests/benchmarks are located in the `/benchmarks/opencl` folder though not all of them work wit the current version of Vortex. - *Args* - -An example of using the `blackbox.sh` commandline arguments is shown below. - -Run the sgemm benchmark using the vlsim driver with a Vortex configuration of 1 cluster, 4 cores, 4 warps, and 4 threads: +Example use of command line arguments: Run the sgemm benchmark using the vlsim driver with a Vortex configuration of 1 cluster, 4 cores, 4 warps, and 4 threads. $ ./ci/blackbox.sh --clusters=1 --cores=4 --warps=4 --threads=4 --driver=vlsim --app=sgemm