docs: Common testbench related dependency list

Signed-off-by: Istvan-Zsolt Szekely <[email protected]>
analogdevicesinc · Nov 29, 2024 · 6b49057 · 6b49057
1 parent 996e7dc
commit 6b49057
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 85 deletions.
diff --git a/docs/testbenches/dependency_common.rst b/docs/testbenches/dependency_common.rst
@@ -0,0 +1,30 @@
+Common with most testbenches:
+
+.. list-table::
+   :widths: 30 45 25
+   :header-rows: 1
+
+   * - SV dependency name
+     - Source code link
+     - Documentation link
+   * - LOGGER_PKG
+     - :git-testbenches:`library/utilities/logger_pkg.sv`
+     - ---
+   * - M_AXI_SEQUENCER
+     - :git-testbenches:`library/vip/amd/m_axi_sequencer.sv`
+     - ---
+   * - REG_ACCESSOR
+     - :git-testbenches:`library/regmaps/reg_accessor.sv`
+     - ---
+   * - S_AXI_SEQUENCER
+     - :git-testbenches:`library/vip/amd/s_axi_sequencer.sv`
+     - ---
+   * - TEST_HARNESS_ENV
+     - :git-testbenches:`library/utilities/test_harness_env.sv`
+     - :ref:`test_harness`
+   * - UTILS
+     - :git-testbenches:`library/utilities/utils.svh`
+     - ---
+   * - WATCHDOG
+     - :git-testbenches:`library/drivers/common/watchdog.sv`
+     - :ref:`watchdog`
diff --git a/docs/testbenches/ip_based/axis_sequencers/index.rst b/docs/testbenches/ip_based/axis_sequencers/index.rst
@@ -191,6 +191,10 @@ Resources
 Testbenches related dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. list-table::
    :widths: 30 45 25
    :header-rows: 1
@@ -204,12 +208,6 @@ Testbenches related dependencies
    * - S_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/s_axis_sequencer.sv`
      - ---
-   * - WATCHDOG
-     - :git-testbenches:`library/drivers/common/watchdog.sv`
-     - :ref:`watchdog`
-   * - UTILS
-     - :git-testbenches:`library/utilities/utils.svh`
-     - ---
 
 .. include:: ../../../common/more_information.rst
 

diff --git a/docs/testbenches/ip_based/base/index.rst b/docs/testbenches/ip_based/base/index.rst
@@ -135,6 +135,14 @@ Then the subfolder under ``runs`` name will be:
 
 ``cfg1``
 
+Resources
+-------------------------------------------------------------------------------
+
+Testbenches related dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: ../../dependency_common.rst
+
 .. include:: ../../../common/more_information.rst
 
 .. include:: ../../../common/support.rst
diff --git a/docs/testbenches/ip_based/util_pack/index.rst b/docs/testbenches/ip_based/util_pack/index.rst
@@ -228,6 +228,10 @@ HDL related dependencies
 Testbenches related dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. list-table::
    :widths: 30 45 25
    :header-rows: 1
@@ -247,30 +251,12 @@ Testbenches related dependencies
    * - DMAC_API
      - :git-testbenches:`library/drivers/dmac/dmac_api.sv`
      - ---
-   * - LOGGER_PKG
-     - :git-testbenches:`library/utilities/logger_pkg.sv`
-     - ---
-   * - M_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/m_axi_sequencer.sv`
-     - ---
    * - M_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/m_axis_sequencer.sv`
      - ---
-   * - REG_ACCESSOR
-     - :git-testbenches:`library/regmaps/reg_accessor.sv`
-     - ---
-   * - S_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/s_axi_sequencer.sv`
-     - ---
    * - S_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/s_axis_sequencer.sv`
      - ---
-   * - WATCHDOG
-     - :git-testbenches:`library/drivers/common/watchdog.sv`
-     - :ref:`watchdog`
-   * - UTILS
-     - :git-testbenches:`library/utilities/utils.svh`
-     - ---
 
 .. include:: ../../../common/more_information.rst
 

diff --git a/docs/testbenches/project_based/ad463x/index.rst b/docs/testbenches/project_based/ad463x/index.rst
@@ -315,6 +315,10 @@ HDL related dependencies
 Testbenches related dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. list-table::
    :widths: 30 45 25
    :header-rows: 1
@@ -343,26 +347,11 @@ Testbenches related dependencies
    * - DMAC_API
      - :git-testbenches:`library/drivers/dmac/dmac_api.sv`
      - ---
-   * - LOGGER_PKG
-     - :git-testbenches:`library/utilities/logger_pkg.sv`
-     - ---     
-   * - M_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/m_axi_sequencer.sv`
-     - ---
    * - M_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/m_axis_sequencer.sv`
      - ---
-   * - REG_ACCESSOR
-     - :git-testbenches:`library/regmaps/reg_accessor.sv`
-     - ---                            
-   * - S_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/s_axi_sequencer.sv`
-     - ---
    * - S_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/s_axis_sequencer.sv`
-     - ---     
-   * - UTILS
-     - :git-testbenches:`library/utilities/utils.svh`
      - ---
 
 .. include:: ../../../common/more_information.rst

diff --git a/docs/testbenches/project_based/ad738x/index.rst b/docs/testbenches/project_based/ad738x/index.rst
@@ -276,6 +276,10 @@ HDL related dependencies
 Testbenches related dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. list-table::
    :widths: 30 45 25
    :header-rows: 1
@@ -304,26 +308,11 @@ Testbenches related dependencies
    * - DMAC_API
      - :git-testbenches:`library/drivers/dmac/dmac_api.sv`
      - ---
-   * - LOGGER_PKG
-     - :git-testbenches:`library/utilities/logger_pkg.sv`
-     - ---     
-   * - M_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/m_axi_sequencer.sv`
-     - ---
    * - M_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/m_axis_sequencer.sv`
      - ---
-   * - REG_ACCESSOR
-     - :git-testbenches:`library/regmaps/reg_accessor.sv`
-     - ---                            
-   * - S_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/s_axi_sequencer.sv`
-     - ---
    * - S_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/s_axis_sequencer.sv`
-     - ---     
-   * - UTILS
-     - :git-testbenches:`library/utilities/utils.svh`
      - ---
 
 .. include:: ../../../common/more_information.rst

diff --git a/docs/testbenches/project_based/ad7606/index.rst b/docs/testbenches/project_based/ad7606/index.rst
@@ -324,6 +324,10 @@ HDL related dependencies
 Testbenches related dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. list-table::
    :widths: 30 45 25
    :header-rows: 1
@@ -336,7 +340,7 @@ Testbenches related dependencies
      - ---
    * - ADI_REGMAP_COMMON_PKG
      - :git-testbenches:`library/regmaps/adi_regmap_common_pkg.sv`
-     - ---          
+     - ---
    * - ADI_REGMAP_DMAC_PKG
      - :git-testbenches:`library/regmaps/adi_regmap_dmac_pkg.`
      - ---
@@ -352,26 +356,11 @@ Testbenches related dependencies
    * - DMAC_API
      - :git-testbenches:`library/drivers/dmac/dmac_api.sv`
      - ---
-   * - LOGGER_PKG
-     - :git-testbenches:`library/utilities/logger_pkg.sv`
-     - ---     
-   * - M_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/m_axi_sequencer.sv`
-     - ---
    * - M_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/m_axis_sequencer.sv`
      - ---
-   * - REG_ACCESSOR
-     - :git-testbenches:`library/regmaps/reg_accessor.sv`
-     - ---                            
-   * - S_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/s_axi_sequencer.sv`
-     - ---
    * - S_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/s_axis_sequencer.sv`
-     - ---     
-   * - UTILS
-     - :git-testbenches:`library/utilities/utils.svh`
      - ---
 
 .. include:: ../../../common/more_information.rst

diff --git a/docs/testbenches/project_based/pulsar_adc/index.rst b/docs/testbenches/project_based/pulsar_adc/index.rst
@@ -283,6 +283,10 @@ HDL related dependencies
 Testbenches related dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. list-table::
    :widths: 30 45 25
    :header-rows: 1
@@ -311,26 +315,11 @@ Testbenches related dependencies
    * - DMAC_API
      - :git-testbenches:`library/drivers/dmac/dmac_api.sv`
      - ---
-   * - LOGGER_PKG
-     - :git-testbenches:`library/utilities/logger_pkg.sv`
-     - ---     
-   * - M_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/m_axi_sequencer.sv`
-     - ---
    * - M_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/m_axis_sequencer.sv`
      - ---
-   * - REG_ACCESSOR
-     - :git-testbenches:`library/regmaps/reg_accessor.sv`
-     - ---                            
-   * - S_AXI_SEQUENCER
-     - :git-testbenches:`library/vip/amd/s_axi_sequencer.sv`
-     - ---
    * - S_AXIS_SEQUENCER
      - :git-testbenches:`library/vip/amd/s_axis_sequencer.sv`
-     - ---     
-   * - UTILS
-     - :git-testbenches:`library/utilities/utils.svh`
      - ---
 
 .. include:: ../../../common/more_information.rst

diff --git a/docs/testbenches/project_based/template/index.rst b/docs/testbenches/project_based/template/index.rst
@@ -190,6 +190,10 @@ Test stimulus
 Resources
 -------------------------------------------------------------------------------
 
+.. include:: ../../dependency_common.rst
+
+Testbench specific dependencies:
+
 .. include:: ../../../common/more_information.rst
 
 .. include:: ../../../common/support.rst