Skip to content

Commit

Permalink
docs: Update content
Browse files Browse the repository at this point in the history
  • Loading branch information
StancaPop committed Oct 25, 2024
1 parent 3bcaca3 commit df863bb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
16 changes: 11 additions & 5 deletions docs/user_guide/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,23 @@ File structure of a project

.. tip::

In ``base/`` you can find a test bench base design.
In ``testbenches/ip/base/`` you can find a test bench base design.

Project files for test benches
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- ``library`` --- common files that are used in many projects

- ``adi_vip`` --- ADI VIPs
- ``ips`` --- IPs
- ``utilities`` --- ADI Utilities
- ``xilinx_vip`` --- Xilinx VIPs
- ``drivers`` --- drivers and APIs used for controlling IPs as well as VIPs;
these modules can use register map files, VIPs and other APIs
- ``regmaps`` --- register map files created for simulations based on the
HDL IP register maps along with a couple of utility files; these are macro
functions that are used to access a specific IP's register's field in a
given variable that is passed to these functions
- ``utilities`` --- common scripts, modules and macros that are used for
testbench design and environment creation
- ``vip`` --- ADI verification IPs (VIP) and additional auxiliary classes
which are vendor specific

- ``scripts`` --- used for creating and running the testbenches

Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ desired). Furthermore, all ADI developed and supported IPs are presented in deta
At the same time, the user guides are not intended to be a guide for any third
party tool. To understand and use the HDL framework efficiently the user needs
to have a **solid understanding on how an FPGA works, to be familiar with all
the design tools and flows, testbenches, SystemVerilog and classes**. These
testbenches are not using UVM, however, some ideas are used from the
verification standard, meaning that a high level overview of UVM can be useful
in understanding the design structure.
the design tools and flows, testbenches, SystemVerilog and object-oriented
programming (OOP)**. These testbenches are not using UVM, however, some ideas
are used from the verification standard, meaning that a high level overview
of UVM can be useful in understanding the design structure.

If somebody does not have this knowledge we highly recommend to make some
general research and go through some basic tutorials with the targeted
Expand Down

0 comments on commit df863bb

Please sign in to comment.