Update gram simulation documentation
authorJean THOMAS <git0@pub.jeanthomas.me>
Fri, 3 Jul 2020 12:32:10 +0000 (14:32 +0200)
committerJean THOMAS <git0@pub.jeanthomas.me>
Fri, 3 Jul 2020 12:32:10 +0000 (14:32 +0200)
gram/simulation/README.md

index 8392d0aaf5b6f639b5c3082432a52ef51eb97cae..4d15f572d2fedeaf871297a798e04cd1c3377c54 100644 (file)
@@ -4,15 +4,27 @@ This folder contains code used for low level simulation of various aspects of gr
 
 ## Requirements
 
- * Icarus Verilog (preferably a recent version)
+ * Icarus Verilog (built from latest sources)
  * ECP5 instances models from a Lattice Diamond installation (just install Lattice Diamond)
 
 ## Available simulations
 
 ### simcrg
 
+Simulates the CRG used in ECPIX5 gram tests and checks for a few assertions.
+
 ```
 ./runsimcrg.sh
 ```
 
-Produces `simcrg.vcd`.
+Produces `simcrg.fst` (compatbile with Gtkwave).
+
+### simsoc
+
+Simulates a full SoC with a UART Wishbone master and a DDR3 model, and sends the init commands that libgram would send over serial.
+
+```
+./runsimsoc.sh
+```
+
+Produces `simsoc.fst` (compatible with Gtkwave).