From 9bbcbc1c31832f0e20a22880b2b37a2ecb267f76 Mon Sep 17 00:00:00 2001 From: Stanca Pop Date: Tue, 15 Oct 2024 15:39:09 +0300 Subject: [PATCH] docs: Update library to next_main structure --- docs/library/drivers/common/index.rst | 14 ++++++++ docs/library/drivers/common/monitor/index.rst | 5 +++ .../drivers/common/scoreboard/index.rst | 5 +++ .../library/drivers/common/watchdog/index.rst | 5 +++ docs/library/drivers/data_offload/index.rst | 5 +++ docs/library/drivers/dmac/index.rst | 5 +++ docs/library/drivers/index.rst | 17 ++++++++++ docs/library/drivers/jesd/index.rst | 5 +++ docs/library/drivers/spi_engine/index.rst | 5 +++ docs/library/drivers/xcvr/index.rst | 5 +++ docs/library/index.rst | 16 ++++----- docs/library/regmaps/index.rst | 8 +++++ docs/library/utilities/index.rst | 3 -- docs/library/vip/adi/index.rst | 13 ++++++++ docs/library/vip/adi/spi_vip/index.rst | 33 +++++++++++++++++++ docs/library/vip/amd/axi_vip/index.rst | 29 ++++++++++++++++ docs/library/vip/amd/axis_vip/index.rst | 28 ++++++++++++++++ docs/library/vip/amd/clk_vip/index.rst | 18 ++++++++++ docs/library/vip/amd/index.rst | 16 +++++++++ docs/library/vip/amd/rst_vip/index.rst | 16 +++++++++ docs/library/vip/index.rst | 13 ++++++++ 21 files changed, 253 insertions(+), 11 deletions(-) create mode 100644 docs/library/drivers/common/index.rst create mode 100644 docs/library/drivers/common/monitor/index.rst create mode 100644 docs/library/drivers/common/scoreboard/index.rst create mode 100644 docs/library/drivers/common/watchdog/index.rst create mode 100644 docs/library/drivers/data_offload/index.rst create mode 100644 docs/library/drivers/dmac/index.rst create mode 100644 docs/library/drivers/index.rst create mode 100644 docs/library/drivers/jesd/index.rst create mode 100644 docs/library/drivers/spi_engine/index.rst create mode 100644 docs/library/drivers/xcvr/index.rst create mode 100644 docs/library/regmaps/index.rst create mode 100644 docs/library/vip/adi/index.rst create mode 100644 docs/library/vip/adi/spi_vip/index.rst create mode 100644 docs/library/vip/amd/axi_vip/index.rst create mode 100644 docs/library/vip/amd/axis_vip/index.rst create mode 100644 docs/library/vip/amd/clk_vip/index.rst create mode 100644 docs/library/vip/amd/index.rst create mode 100644 docs/library/vip/amd/rst_vip/index.rst create mode 100644 docs/library/vip/index.rst diff --git a/docs/library/drivers/common/index.rst b/docs/library/drivers/common/index.rst new file mode 100644 index 00000000..8f765b96 --- /dev/null +++ b/docs/library/drivers/common/index.rst @@ -0,0 +1,14 @@ +.. _common: + +Common +================================================================================ + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + Monitor + Scoreboard + Watchdog diff --git a/docs/library/drivers/common/monitor/index.rst b/docs/library/drivers/common/monitor/index.rst new file mode 100644 index 00000000..f6cd7202 --- /dev/null +++ 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 new file mode 100644 index 00000000..d486a25b --- /dev/null +++ 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 new file mode 100644 index 00000000..1a374b56 --- /dev/null +++ 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 new file mode 100644 index 00000000..5639976c --- /dev/null +++ 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 new file mode 100644 index 00000000..d4cd605e --- /dev/null +++ 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 new file mode 100644 index 00000000..ad595075 --- /dev/null +++ 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 new file mode 100644 index 00000000..b78339bd --- /dev/null +++ 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 new file mode 100644 index 00000000..0d10a112 --- /dev/null +++ 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 new file mode 100644 index 00000000..5afc736e --- /dev/null +++ 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 index 36805121..ee520a7f 100644 --- 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 new file mode 100644 index 00000000..802ee822 --- /dev/null +++ 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 index fbde0b8b..233c394f 100644 --- a/docs/library/utilities/index.rst +++ b/docs/library/utilities/index.rst @@ -9,6 +9,3 @@ Contents .. toctree:: :maxdepth: 2 - Monitor - Scoreboard - Watchdog diff --git a/docs/library/vip/adi/index.rst b/docs/library/vip/adi/index.rst new file mode 100644 index 00000000..eacf276a --- /dev/null +++ b/docs/library/vip/adi/index.rst @@ -0,0 +1,13 @@ +.. _adi_vip: + +ADI VIPs +================================================================================ + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + SPI VIP + diff --git a/docs/library/vip/adi/spi_vip/index.rst b/docs/library/vip/adi/spi_vip/index.rst new file mode 100644 index 00000000..5e9428cb --- /dev/null +++ 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 new file mode 100644 index 00000000..ce3093ad --- /dev/null +++ b/docs/library/vip/amd/axi_vip/index.rst @@ -0,0 +1,29 @@ +.. _xilinx_axi_vip: + +Xilinx AXI Verification IP (VIP) +================================================================================ + +Description + +`[1] `__ + +m_axi_sequencer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Files + +Functions + +s_axi_sequencer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Files + +Functions + +References +------------------------------------------------------------------------------- + +`[1] "AXI Verification IP LogiCORE IP Product Guide (PG267)", Xilinx, 2019 +`__ + diff --git a/docs/library/vip/amd/axis_vip/index.rst b/docs/library/vip/amd/axis_vip/index.rst new file mode 100644 index 00000000..0a327403 --- /dev/null +++ b/docs/library/vip/amd/axis_vip/index.rst @@ -0,0 +1,28 @@ +.. _xilinx_axis_vip: + +Xilinx AXI Stream Verification IP (VIP) +================================================================================ + +Description + +`[1] `__ + +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 `__ diff --git a/docs/library/vip/amd/clk_vip/index.rst b/docs/library/vip/amd/clk_vip/index.rst new file mode 100644 index 00000000..a4bc45eb --- /dev/null +++ b/docs/library/vip/amd/clk_vip/index.rst @@ -0,0 +1,18 @@ +.. _xilinx_clk_vip: + +Xilinx Clock Verification IP (VIP) +================================================================================ + +Overview +------------------------------------------------------------------------------- + +`[1] `__ + + +References +------------------------------------------------------------------------------- + +`[1] "Clock Verification IP v1.0 Product Guide (PG291)", Xilinx, 2019 +`__ + + diff --git a/docs/library/vip/amd/index.rst b/docs/library/vip/amd/index.rst new file mode 100644 index 00000000..2c840fa1 --- /dev/null +++ b/docs/library/vip/amd/index.rst @@ -0,0 +1,16 @@ +.. _amd_vip: + +AMD VIPs +================================================================================ + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + AXI VIP + AXIS VIP + Clock VIP + Reset VIP + diff --git a/docs/library/vip/amd/rst_vip/index.rst b/docs/library/vip/amd/rst_vip/index.rst new file mode 100644 index 00000000..c28672a5 --- /dev/null +++ b/docs/library/vip/amd/rst_vip/index.rst @@ -0,0 +1,16 @@ +.. _xilinx_rst_vip: + +Xilinx Reset Verification IP (VIP) +================================================================================ + +Overview +------------------------------------------------------------------------------- + +`[1] `__ + + +References +------------------------------------------------------------------------------- + +`[1] "Reset Verification IP Product Guide (PG298)", Xilinx, 2019 +`__ diff --git a/docs/library/vip/index.rst b/docs/library/vip/index.rst new file mode 100644 index 00000000..99c1f418 --- /dev/null +++ b/docs/library/vip/index.rst @@ -0,0 +1,13 @@ +.. _vip: + +Verification IPs (VIP) +================================================================================ + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + ADI + AMD