Skip to content

Commit

Permalink
docs: Apply patches on projects and architecture
Browse files Browse the repository at this point in the history
Signed-off-by: Iulia Moldovan <[email protected]>
  • Loading branch information
IuliaCMoldovan committed Nov 25, 2024
1 parent 30339da commit 7c4429a
Show file tree
Hide file tree
Showing 11 changed files with 138 additions and 94 deletions.
8 changes: 4 additions & 4 deletions docs/projects/ad469x_evb/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ modifications need to be done on the board and/or ``make`` command:

In case we link CNV signal to PWM:

.. shell::
.. shell:: bash

make SPI_4WIRE=0
$make SPI_4WIRE=0

In case we link CNV signal to SPI_CS:

.. shell::
.. shell:: bash

make SPI_4WIRE=1
$make SPI_4WIRE=1

CPU/Memory interconnects addresses
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
8 changes: 4 additions & 4 deletions docs/projects/ad738x_fmc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,15 +103,15 @@ be done on the board and/or ``make`` command:

In case of the **Serial Data Output Pin** functionality:

.. shell::
.. shell:: bash

make ALERT_SPI_N=0
$make ALERT_SPI_N=0

In case of the **Alert Indication Output Pin** functionality:

.. shell::
.. shell:: bash

make ALERT_SPI_N=1
$make ALERT_SPI_N=1

The **NUM_OF_SDI** configuration parameter defines the number of SDI lines used:
**{1, 2, 4}**. By default is set to 1.
Expand Down
8 changes: 4 additions & 4 deletions docs/projects/ad7606x_fmc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ hardware modifications need to be done on the board and/or ``make`` command:

In case of the **PARALLEL** interface:

.. shell::
.. shell:: bash

make INTF=0
$make INTF=0

In case of the **SERIAL** interface:

.. shell::
.. shell:: bash

make INTF=1
$make INTF=1

.. note::

Expand Down
8 changes: 4 additions & 4 deletions docs/projects/ad7616_sdz/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,15 @@ some hardware modifications need to be done on the board and/or make command:

In case of the **PARALLEL** interface:

.. shell::
.. shell:: bash

make SER_PAR_N=0
$make SER_PAR_N=0

In case of the **SERIAL** interface:

.. shell::
.. shell:: bash

make SER_PAR_N=1
$make SER_PAR_N=1

.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/projects/ad7768evb/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ the HDL repository, and then build the project as follows:
.. shell::

$cd hdl/projects/ad7768evb/zed
/hdl/projects/ad7768evb/zed$make
$make

A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.

Expand Down
27 changes: 15 additions & 12 deletions docs/projects/ad9081_fmca_ebz/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,17 +254,17 @@ Example block design for Single link; M=2; L=8; JESD204C

.. shell:: bash

make JESD_MODE=64B66B \
RX_RATE=16.5 \
TX_RATE=16.5 \
RX_JESD_M=2 \
RX_JESD_L=8 \
RX_JESD_S=2 \
RX_JESD_NP=16 \
TX_JESD_M=2 \
TX_JESD_L=8 \
TX_JESD_S=4 \
TX_JESD_NP=8
$make JESD_MODE=64B66B \
$ RX_RATE=16.5 \
$ TX_RATE=16.5 \
$ RX_JESD_M=2 \
$ RX_JESD_L=8 \
$ RX_JESD_S=2 \
$ RX_JESD_NP=16 \
$ TX_JESD_M=2 \
$ TX_JESD_L=8 \
$ TX_JESD_S=4 \
$ TX_JESD_NP=8

The Rx link is operating with the following parameters:

Expand Down Expand Up @@ -545,7 +545,10 @@ Example for building the project with parameters:
.. shell::

$cd hdl/projects/ad9081_fmca_ebz/zcu102
$make RX_LANE_RATE=2.5 TX_LANE_RATE=2.5 RX_JESD_L=8 RX_JESD_M=4 RX_JESD_S=1 RX_JESD_NP=16 TX_JESD_L=8 TX_JESD_M=4 TX_JESD_S=1 TX_JESD_NP=16
$make RX_LANE_RATE=2.5 TX_LANE_RATE=2.5 \
$ RX_JESD_L=8 RX_JESD_M=4 RX_JESD_S=1 \
$ RX_JESD_NP=16 TX_JESD_L=8 TX_JESD_M=4 \
$ TX_JESD_S=1 TX_JESD_NP=16

The following dropdowns contain tables with the parameters that can be used to
configure this project, depending on the carrier used.
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/max96724/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Software related
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `GMSL-related repository <https://github.com/analogdevicesinc/gmsl>`_
- The user guide that exemplify the system interfaced using
:adi:`AD-GMSLCAMRPI-ADP adaptor <AD-GMSLCAMRPI-ADP>` is available in
:adi:`AD-GMSLCAMRPI-ADP adaptor <AD-GMSLCAMRPI-ADP>` is available at
:dokuwiki:`wiki page <resources/eval/user-guides/ad-gmslcamrpi-adp/ug_amd_kria>`
- :git-linux:`GMSL drivers/dts <gmsl/xilinx_v6.1_LTS:/>`

Expand Down
22 changes: 11 additions & 11 deletions docs/projects/pulsar_adc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ the HDL repository, and then build the project as follows:.

**Linux/Cygwin/WSL**

.. shell::
.. shell:: bash

$cd hdl/projects/pulsar_adc/zed
$make FMC_N_PMOD=1 SPI_OP_MODE=0
Expand All @@ -315,34 +315,34 @@ Build examples:

Zedboard Pmod support

.. shell::
.. shell:: bash

make FMC_N_PMOD=0
$make FMC_N_PMOD=0

Zedboard standard configuration FMC support (default)

.. shell::
.. shell:: bash

make FMC_N_PMOD=1 SPI_OP_MODE=0 - builds standard FMC version
$make FMC_N_PMOD=1 SPI_OP_MODE=0 - builds standard FMC version

Zedboard FMC support for AD7944 4-wire mode ("multi")

.. shell::
.. shell:: bash

make FMC_N_PMOD=1 SPI_OP_MODE=1
$make FMC_N_PMOD=1 SPI_OP_MODE=1

Zedboard FMC support for AD7944 chain mode or 3-wire "single"

.. shell::
.. shell:: bash

make FMC_N_PMOD=1 SPI_OP_MODE=2
$make FMC_N_PMOD=1 SPI_OP_MODE=2

The result of the build, if parameters were used, will be in a folder named
by the used configuration. If the following command was run

.. shell::
.. shell:: bash

make FMC_N_PMOD=1 SPI_OP_MODE=0
$make FMC_N_PMOD=1 SPI_OP_MODE=0

then the folder name will be:

Expand Down
10 changes: 5 additions & 5 deletions docs/projects/pulsar_lvds/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ hardware modifications need to be done on the board and/or make command:

In case of the **AD7960** project:

.. shell::
.. shell:: bash

make RESOLUTION_16_18N=0
$make RESOLUTION_16_18N=0

In case of the **AD7625/AD7626/AD7961** project:

.. shell::
.. shell:: bash

make RESOLUTION_16_18N=1
$make RESOLUTION_16_18N=1

Jumper setup AD7625/AD7626
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -264,7 +264,7 @@ the HDL repository, and then build the project as follows:

**Linux/Cygwin/WSL**

.. shell::
.. shell:: bash

$cd hdl/projects/pulsar_lvds_adc/zed
$make RESOLUTION_16_18N=0
Expand Down
Loading

0 comments on commit 7c4429a

Please sign in to comment.