Merge pull request #240 from SpinalHDL/upstream

Upstream

source/SpinalHDL/Simulation/bootstraps.rst

@@ -156,9 +156,14 @@ Note is it equivalent to:
       simThread.suspend() // Avoid the "doSim" completion
     }
 
-.. _env_SPINALSIM_WORKSPACE:
+The location where the simulation files will be placed is defined by default in $WORKSPACE/$COMPILED. 
+
+- $WORKSPACE being by default ``simWorkspace``, you can override it with the ``SPINALSIM_WORKSPACE`` environnement variable.
+- $COMPILED being the name of the toplevel being simulated.
+- The location of the wave file depend the backend used. For verilator it will be in the folder (``$WORKSPACE/$COMPILED/$TEST`` by default). 
+- For the verilator backend, you can override the location of the test folder via the ``SimConfig.setTestPath(path)`` function.
+- You can retrieve the location of the test path durring simulation by calling the currentTestPath() function.
 
-Note that by default, the simulation files will be placed into the ``simWorkspace/xxx`` folders. You can override the simWorkspace location by setting the ``SPINALSIM_WORKSPACE`` environment variable.
 
 Running multiple tests on the same hardware
 -------------------------------------------

source/SpinalHDL/Simulation/index.rst

@@ -11,8 +11,8 @@ simulation API, it is easy to integrate testbenches with the most common Scala u
 To be able to simulate user-defined components, SpinalHDL uses external HDL simulators as backend. Currently, four simulators are supported:
 
 - `Verilator <https://www.veripool.org/verilator/>`_
-- `GHDL <http://ghdl.free.fr/>`_ **(experimental, since SpinalHDL 1.4.1)**
-- `Icarus Verilog <https://steveicarus.github.io/iverilog/>`_ **(experimental, since SpinalHDL 1.4.1)**
+- `GHDL <http://ghdl.free.fr/>`_
+- `Icarus Verilog <https://steveicarus.github.io/iverilog/>`_
 - `VCS <https://www.synopsys.com/verification/simulation/vcs.html>`_ **(experimental, since SpinalHDL 1.7.0)**
 - `XSim <https://www.google.com/search?q=site%3Axilinx.com+xsim>`_ **(experimental, since SpinalHDL 1.7.0)**