docs: Update library to next_main structure

analogdevicesinc · Oct 15, 2024 · 9bbcbc1 · 9bbcbc1
1 parent aeb4855
commit 9bbcbc1
Show file tree

Hide file tree

Showing 21 changed files with 253 additions and 11 deletions.
diff --git a/docs/library/drivers/common/index.rst b/docs/library/drivers/common/index.rst
@@ -0,0 +1,14 @@
+.. _common:
+
+Common
+================================================================================
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   Monitor <monitor/index>
+   Scoreboard <scoreboard/index>
+   Watchdog <watchdog/index>
diff --git a/docs/library/drivers/common/monitor/index.rst b/docs/library/drivers/common/monitor/index.rst
@@ -0,0 +1,5 @@
+.. _monitor:
+
+Monitor
+================================================================================
+
diff --git a/docs/library/drivers/common/scoreboard/index.rst b/docs/library/drivers/common/scoreboard/index.rst
@@ -0,0 +1,5 @@
+.. _scoreboard:
+
+Scoreboard
+================================================================================
+
diff --git a/docs/library/drivers/common/watchdog/index.rst b/docs/library/drivers/common/watchdog/index.rst
@@ -0,0 +1,5 @@
+.. _watchdog:
+
+Watchdog
+================================================================================
+
diff --git a/docs/library/drivers/data_offload/index.rst b/docs/library/drivers/data_offload/index.rst
@@ -0,0 +1,5 @@
+.. _data_offload:
+
+Data Offload
+================================================================================
+
diff --git a/docs/library/drivers/dmac/index.rst b/docs/library/drivers/dmac/index.rst
@@ -0,0 +1,5 @@
+.. _dmac:
+
+DMAC
+================================================================================
+
diff --git a/docs/library/drivers/index.rst b/docs/library/drivers/index.rst
@@ -0,0 +1,17 @@
+.. _drivers:
+
+Drivers
+================================================================================
+
+Contents
+-------------------------------------------------------------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   common/index
+   data_offload/index
+   dmac/index
+   jesd/index
+   spi_engine/index
+   xcvr/index
diff --git a/docs/library/drivers/jesd/index.rst b/docs/library/drivers/jesd/index.rst
@@ -0,0 +1,5 @@
+.. _jesd:
+
+JESD
+================================================================================
+
diff --git a/docs/library/drivers/spi_engine/index.rst b/docs/library/drivers/spi_engine/index.rst
@@ -0,0 +1,5 @@
+.. _spi_engine:
+
+SPI Engine
+================================================================================
+
diff --git a/docs/library/drivers/xcvr/index.rst b/docs/library/drivers/xcvr/index.rst
@@ -0,0 +1,5 @@
+.. _xcvr:
+
+XCVR
+================================================================================
+
diff --git a/docs/library/index.rst b/docs/library/index.rst
@@ -2,22 +2,22 @@
 
 Library
 ===============================================================================
-
-ADI VIP
+  
+Drivers
 -------------------------------------------------------------------------------
 
 .. toctree::
    :maxdepth: 1
 
-   adi_vip/index
+   drivers/index
 
-Custom IP
+Registermaps
 -------------------------------------------------------------------------------
 
 .. toctree::
    :maxdepth: 1
 
-   custom_ip/index
+   regmaps/index
 
 Utilities
 -------------------------------------------------------------------------------
@@ -27,11 +27,11 @@ Utilities
 
    utilities/index
 
-Xilinx VIP
+VIPs
 -------------------------------------------------------------------------------
 
 .. toctree::
    :maxdepth: 1
 
-   xilinx_vip/index
-
+   vip/index
+   
diff --git a/docs/library/regmaps/index.rst b/docs/library/regmaps/index.rst
@@ -0,0 +1,8 @@
+.. _regmaps:
+
+Registermaps
+================================================================================
+
+Contents
+--------
+
diff --git a/docs/library/utilities/index.rst b/docs/library/utilities/index.rst
@@ -9,6 +9,3 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   Monitor <monitor/index>
-   Scoreboard <scoreboard/index>
-   Watchdog <watchdog/index>
diff --git a/docs/library/vip/adi/index.rst b/docs/library/vip/adi/index.rst
@@ -0,0 +1,13 @@
+.. _adi_vip:
+
+ADI VIPs
+================================================================================
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   SPI VIP <spi_vip/index>
+
diff --git a/docs/library/vip/adi/spi_vip/index.rst b/docs/library/vip/adi/spi_vip/index.rst
@@ -0,0 +1,33 @@
+.. _spi_vip:
+
+SPI VIP
+================================================================================
+
+Description
+
+Features
+--------------------------------------------------------------------------------
+
+Files
+--------------------------------------------------------------------------------
+
+VIP interface
+
+Configuration parameters
+--------------------------------------------------------------------------------
+
+Interface
+--------------------------------------------------------------------------------
+
+Functions
+--------------------------------------------------------------------------------
+
+Known Issues
+--------------------------------------------------------------------------------
+
+Technical Support
+--------------------------------------------------------------------------------
+
+References
+--------------------------------------------------------------------------------
+
diff --git a/docs/library/vip/amd/axi_vip/index.rst b/docs/library/vip/amd/axi_vip/index.rst
@@ -0,0 +1,29 @@
+.. _xilinx_axi_vip:
+
+Xilinx AXI Verification IP (VIP)
+================================================================================
+
+Description
+
+`[1] <https://docs.amd.com/r/en-US/pg267-axi-vip>`__
+
+m_axi_sequencer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Files
+
+Functions
+
+s_axi_sequencer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Files
+
+Functions
+
+References
+-------------------------------------------------------------------------------
+
+`[1] "AXI Verification IP LogiCORE IP Product Guide (PG267)", Xilinx, 2019
+<https://docs.amd.com/r/en-US/pg267-axi-vip>`__
+
diff --git a/docs/library/vip/amd/axis_vip/index.rst b/docs/library/vip/amd/axis_vip/index.rst
@@ -0,0 +1,28 @@
+.. _xilinx_axis_vip:
+
+Xilinx AXI Stream Verification IP (VIP)
+================================================================================
+
+Description
+
+`[1] <https://docs.amd.com/v/u/en-US/pg277-axi4stream-vip>`__
+
+m_axi_sequencer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Files
+
+Functions
+
+s_axi_sequencer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Files
+
+Functions
+
+References
+-------------------------------------------------------------------------------
+
+`[1] "AXI4-Stream Verification IP v1.1 LogiCORE IP Product Guide (PG277)",
+Xilinx, 2019 <https://docs.amd.com/v/u/en-US/pg277-axi4stream-vip>`__
diff --git a/docs/library/vip/amd/clk_vip/index.rst b/docs/library/vip/amd/clk_vip/index.rst
@@ -0,0 +1,18 @@
+.. _xilinx_clk_vip:
+
+Xilinx Clock Verification IP (VIP)
+================================================================================
+
+Overview
+-------------------------------------------------------------------------------
+
+`[1] <https://docs.amd.com/v/u/en-US/pg291-clk-vip>`__
+
+
+References
+-------------------------------------------------------------------------------
+
+`[1] "Clock Verification IP v1.0 Product Guide (PG291)", Xilinx, 2019
+<https://docs.amd.com/r/en-US/pg267-axi-vip>`__
+
+
diff --git a/docs/library/vip/amd/index.rst b/docs/library/vip/amd/index.rst
@@ -0,0 +1,16 @@
+.. _amd_vip:
+
+AMD VIPs
+================================================================================
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   AXI VIP <axi_vip/index>
+   AXIS VIP <axis_vip/index>
+   Clock VIP <clk_vip/index>
+   Reset VIP <rst_vip/index>
+
diff --git a/docs/library/vip/amd/rst_vip/index.rst b/docs/library/vip/amd/rst_vip/index.rst
@@ -0,0 +1,16 @@
+.. _xilinx_rst_vip:
+
+Xilinx Reset Verification IP (VIP)
+================================================================================
+
+Overview
+-------------------------------------------------------------------------------
+
+`[1] <https://docs.amd.com/v/u/en-US/pg298-rst-vip>`__
+
+
+References
+-------------------------------------------------------------------------------
+
+`[1] "Reset Verification IP Product Guide (PG298)", Xilinx, 2019
+<https://docs.amd.com/v/u/en-US/pg298-rst-vip>`__
diff --git a/docs/library/vip/index.rst b/docs/library/vip/index.rst
@@ -0,0 +1,13 @@
+.. _vip:
+
+Verification IPs (VIP)
+================================================================================
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   ADI <adi/index>
+   AMD <amd/index>