Skip to content

Commit

Permalink
docs: PR review changes 2
Browse files Browse the repository at this point in the history
  • Loading branch information
StancaPop committed Aug 5, 2024
1 parent 67ff421 commit acdc420
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 15 deletions.
32 changes: 21 additions & 11 deletions docs/library/IPs/template_ip/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,6 @@ Interface
Detailed Architecture
--------------------------------------------------------------------------------

::

.. image:: detailed_architecture.svg
:alt: Template IP detailed architecture
:align: center
Expand Down Expand Up @@ -92,23 +90,35 @@ Register Map
Design Guidelines
--------------------------------------------------------------------------------

The control of the chip is done through an SPI interface, which is needed at the
The control of the chip is done through an SPI interface, which is needed at
system level.
The :ref:`template_ip interface` must be connected directly to the top file of
the design, as IO primitives are part of the IP.
the design, as I/O primitives are part of the IP.

The example design uses a DMA to move the data from the output of the IP to
the memory. If the data needs to be processed in HDL before moving to the
memory, it can be done at the output of the IP (at the system level) or inside
the ADC interface module (at the IP level).

The example design uses a DMA to move the data from the output of the IP to memory.
If the data needs to be processed in HDL before moving to the memory, it can be
done at the output of the IP (at the system level) or inside the ADC interface
module (at the IP level).
The example design uses a processor to program all the registers.
If no processor is available in your system, you can create your IP starting
If no processor is available in your system, you can create your IP starting
from the interface module.

Software Guidelines
Software Guidelines (if necessary)
--------------------------------------------------------------------------------

To note all the details needed by the software to be in a certain way.

Software Support
--------------------------------------------------------------------------------

Linux is supported also using :git-linux:`master:/`.
* Linux device driver at :git-linux:`/`
* Linux device tree at :git-linux:`/`
* Linux documentation at ...
* No-OS device driver at :git-no-os:`/`
* No-OS project at :git-no-os:`/`
* No-OS documentation at ...
* IIO support at ...

References
--------------------------------------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/library/frameworks/template_framework/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Framework Template
.. toctree::
:hidden:

Template Module<template_module>
Template Interface<interface>
Instruction Set Template<instruction-set>
Template Module <template_module>
Template Interface <interface>
Instruction Set Template <instruction-set>

{brief introdution}.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Release branches
* - :git-testbenches:`main <main:/>`
- Vivado 2023.1
-
* - :git-testbenches:`2022_r2 <2022_r2:>`
* - :git-testbenches:`2022_r2 <2022_r2:/>`
- Vivado 2022.2
- `Release notes 2022_R2 <https://github.com/analogdevicesinc/testbenches/releases/tag/2022_R2>`_

Expand Down

0 comments on commit acdc420

Please sign in to comment.