deploy: 39b80f1 #241 (synchronize)

Author: github-actions[bot]

pull/241/_sources/testbenches/project_based/adrv9001/index.rst.txt

@@ -48,8 +48,8 @@ The following parameters of this project can be configured:
 -  DDS_DISABLE: By setting this parameter you can remove the dual tone DDS logic
    from the TX channels. This will reduce resource utilization significantly,
    but will lose the ability to generate a test tone:
-   Options: 0 - Enable DDS, 1 - Disable DDS                   
-   
+   Options: 0 - Enable DDS, 1 - Disable DDS
+
 Configuration files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -162,7 +162,7 @@ The PN test verifies the PN data.
 
 .. note::
 
-PN Test Skipped in 8 bits symbol mode.
+   PN Test Skipped in 8 bits symbol mode.
 
 The steps of this test are for:
     * NIBBLE_RAMP

pull/241/_sources/user_guide/build_tb.rst.txt

@@ -77,6 +77,14 @@ You may also do this manually (for better or worse); the following snippet is
 from a **.bashrc** file. Please note that unless you are an expert at manipulating
 these things, it is best to leave it to the tools to set up the environment.
 
+For Vivado versions of 2025 and later, use the following command:
+
+.. shell::
+
+   $export PATH=$PATH:/opt/Xilinx/202x.x/Vivado/bin:/opt/Xilinx/202x.x/Vitis/bin
+
+For Vivado versions prior to 2025, use the following command:
+
 .. shell::
 
    $export PATH=$PATH:/opt/Xilinx/Vivado/202x.x/bin:/opt/Xilinx/Vitis/202x.x/bin
@@ -89,6 +97,14 @@ The best option on Windows is to use
 ``make`` and ``git`` packages. You should do changes to your **.bashrc** in a
 similar manner to the Linux environment.
 
+For Vivado versions of 2025 and later, use the following command:
+
+.. shell::
+
+   $export PATH=$PATH:/cygdrive/d/Xilinx/202x.x/Vivado/bin:/cygdrive/d/Xilinx/202x.x/Vitis/bin
+
+For Vivado versions prior to 2025, use the following command:
+
 .. shell::
 
    $export PATH=$PATH:/cygdrive/d/Xilinx/Vivado/202x.x/bin:/cygdrive/d/Xilinx/Vitis/202x.x/bin
@@ -97,6 +113,14 @@ A very good alternative to Cygwin is
 `WSL <https://learn.microsoft.com/en-us/windows/wsl/install/>`__. The
 manual changes to your **.bashrc** should look like:
 
+For Vivado versions of 2025 and later, use the following command:
+
+.. shell::
+
+   $export PATH=$PATH:/opt/path_to/202x.x/Vivado/bin:/opt/202x.x/Vitis/bin
+
+For Vivado versions prior to 2025, use the following command:
+
 .. shell::
 
    $export PATH=$PATH:/opt/path_to/Vivado/202x.x/bin:/opt/Vitis/202x.x/bin
@@ -108,7 +132,8 @@ variations** installed by the tools itself.
 
 Some of these may not be fully functional with our scripts and/or projects.
 If you are an AMD user, use the **gnuwin** installed as part of the SDK,
-usually at ``C:\Xilinx\Vitis\202x.x\gnuwin\bin``.
+usually at ``C:\Xilinx\202x.x\Vitis\gnuwin\bin`` for Vitis versions of 2025 and
+later, or ``C:\Xilinx\Vitis\202x.x\gnuwin\bin`` for prior versions.
 
 Repository path setup
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -138,41 +163,106 @@ In this example, it is building the **AD7616** testbench.
    $cd ad7616
    $make
 
-The ``make`` builds all the libraries first and then builds the testbench.
-This assumes that you have the tools and licenses set up correctly. If
-you don't get to the last line, the make failed to build one or more
-targets: it could be a library component or the project itself. There is
-nothing you can gather from the ``make`` output (other than which one
-failed). The actual information about the failure is in a log file inside
-the project directory. By default, ``make`` builds all of the available
+The ``make`` builds all the libraries first and then builds the testbench. The
+testbench build folder is in the testbench project's location under ``runs/``
+with the configuration's name as Vivado project name. This assumes that you have
+the tools and licenses set up correctly and the build finishes with no errors.
+If the make fails to build one or more targets, there is no useful information
+you can gather from the ``make`` output (other than which target failed to
+build). The actual information about the failure is in a log file inside
+the target's directory. By default, ``make`` builds all of the available
 configurations and runs all of the ``test programs`` that are predefined
 in the ``Makefile``.
 
-Also, there's an option to use ``make`` using GUI, so that at the end of the
-build it will launch Vivado and start the simulation with the waveform viewer
-started as well.
+There are multiple ``make`` parameters that can be used to build and run a
+simulation.
+
+**Examples**
+
+The ``all`` keyword is the same as running ``make`` by itself with no additional
+configuration/test program parameter. Often used in combination with ``clean``
+parameter.
 
 .. shell::
 
-   $make MODE=gui
+   $make all
+
+Another build option is to use the configuration file's name as a make parameter
+without any other input. This will build the configuration and run all test
+programs on it.
+
+.. shell::
+
+   $make cfg_si
 
 Some projects support adding additional ``make`` parameters to configure
 the project. This option gives you the ability to build only the configuration
 that you're interested in, without building the rest of the available
-configurations, as well as running the chosen test program, if it is the case.
+configurations, as well as running the chosen test program. ``CFG`` specifies
+the configuration file's name, while ``TST`` specifies the test program's name.
 
-If parameters were used, the result of the build will be in a folder under
-``runs/``, named by the configuration used.
+.. shell::
+
+   $make CFG=cfg_si TST=test_program_si
+
+.. caution::
+
+   Trying to run incompatible configuration and test program combinations will
+   result in simulation error! Please refer to the projects guide to check
+   compatibility.
+
+.. note::
+
+   When running the ``make`` command with one of the above mentioned 3 options,
+   please choose only 1 of them! Using multiple options may lead to building
+   multiple designs and running multiple test programs.
+
+The ``clean`` keyword removes the ``runs`` and ``results`` folders, as well as
+the log files created by Vivado.
+
+.. shell::
+
+   $make clean
+
+There's an option to use Vivado's XSim GUI, so that at the end of the build it
+will launch Vivado and start the simulation with the waveform viewer started as
+well. By default, ``make`` launches Vivado in batch mode, meaning that it won't
+provide a GUI, only a result in the terminal at the end of the simulation.
 
-**Example**
+.. shell::
+
+   $make MODE=gui
 
-Running the command below will create a folder named
-**cfg_si** for the following file combination: **cfg_si** configuration file and
-the **test_program_si** test program.
+The ``STOP_ON_ERROR`` parameter is mainly used for continuous integration
+purposes, which allows the user to build and run all testbenches even if one
+fails. The only exception to this is when a library fails to build, as this will
+prevent any of the testbench designs to be run. The default value is ``y``,
+which halts the simulation once it runs into an error. The other option to run
+all testbenches is ``n``. This is useful for checking which configuration and
+test program configurations are failing.
 
 .. shell::
 
-   $make MODE=gui CFG=cfg_si TST=test_program_si
+   $make STOP_ON_ERROR=y
+
+Rerunning a simulation
+-------------------------------------------------------------------------------
+
+If you want to rerun a simulation, you can do it in a couple of different ways,
+depending on what you're trying to do.
+
+The most straightforward and easiest way is to rerun the ``make`` command with
+the parameters it was ran initially if it is the case. This will rebuild any
+libraries and/or the testbench block design if any of them changed and then run
+the simulation. If there are changes that affect the architecture of the
+testbench, then design is going to be rebuilt. If only the simulation files are
+updated, which don't affect the testbench block design, then only the simulation
+will be run. This is the recommended way to run the testbench to avoid any
+issues if the source files are modified.
+
+.. attention::
+
+   Vivado must be closed before rerunning the ``make`` command!
 
 In GUI mode, if the simulation was already run, there are a couple of options
 for restarting it.
@@ -188,7 +278,16 @@ for restarting it.
   simulation`` option from the Flow Navigator. This will recompile the project
   and start the simulation. This is needed when project simulation parameters
   are changed after the build was created or when the block design is changed
-  manually. When the simulation seed is hard coded, this option must be used.
+  manually. When the simulation seed is changed or randomized, and you want to
+  rerun the simulation with an updated seed value, this is the option that must
+  be used.
+
+.. note::
+
+   When rerunning a simulation in GUI mode, there is a slight chance that
+   Vivado crashes. The reason for this is unknown, and it usually happens when
+   the restarting process is going and the user tries putting the process in the
+   background via the pop-up window.
 
 Opening a testbench
 -------------------------------------------------------------------------------

pull/241/_static/app.min.css

@@ -8,9 +8,9 @@
 
     <title>More information &#8212; Testbenches  documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8e8a900e" />
-    <link rel="stylesheet" type="text/css" href="../_static/app.min.css?v=8d0b0339" />
+    <link rel="stylesheet" type="text/css" href="../_static/app.min.css?v=85dade36" />
     <link rel="stylesheet" type="text/css" href="../_static/custom.css" />
-    <script async="async" src="../_static/app.umd.js?v=2f9373fc"></script>
+    <script async="async" src="../_static/app.umd.js?v=3a4867e9"></script>
     <link rel="icon" href="../_static/icon.svg"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -41,7 +41,10 @@
     }
   }
 </style>
-  </head><body>
+  </head>
+  
+    <body>
+  
   <input type="checkbox" id="input-show-toc">
   <input type="checkbox" id="input-show-localtoc">
   <input type="checkbox" id="input-show-repotoc">
@@ -244,7 +247,7 @@ <h1>More information<a class="headerlink" href="#more-information" title="Link t
   <label id="cancel-area-show-toc" for="input-show-toc"></label>
   <label id="cancel-area-show-localtoc" for="input-show-localtoc"></label>
     <footer>
-      &#169;2024, Analog Devices, Inc.
+      &#169;2024-2025, Analog Devices, Inc.
 
       |
       Made with <a href="https://www.sphinx-doc.org/">Sphinx</a>