Skip to content

Commit 9586211

Browse files
IuliaCMoldovanhadarauelena
authored andcommitted
docs/projects/adrv9001_dual: Add build configs. Fix links
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
1 parent c5bf5f5 commit 9586211

File tree

1 file changed

+50
-30
lines changed

1 file changed

+50
-30
lines changed

docs/projects/adrv9001_dual/index.rst

Lines changed: 50 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ADRV9001 DUAL HDL Project
1+
ADRV9001-DUAL HDL Project
22
===============================================================================
33

44
Overview
@@ -24,7 +24,7 @@ Supported boards
2424
Supported devices
2525
-------------------------------------------------------------------------------
2626

27-
- :adi:`ADRV9002`, in :adi:`ADRV9002NP/W2/PCBZ <EVAL-ADRV9002>`,
27+
- :adi:`ADRV9002`, in :adi:`ADRV9002NP/W2/PCBZ <EVAL-ADRV9002>`
2828

2929
Supported carriers
3030
-------------------------------------------------------------------------------
@@ -69,39 +69,42 @@ The :git-hdl:`AXI ADRV9001 IP <library/axi_adrv9001>` in this HDL project is
6969
configured to work in LVDS and CMOS interface; it supports two configuration
7070
modes:
7171

72-
- 2R2T - 2x Rx and 2x Tx independent control and DMAs for the two RF channels
73-
- 1R1T - 1x Rx and 1x Tx common control and DMAs for the two RF channels also
72+
- 2R2T - 2x RX and 2x TX independent control and DMAs for the two RF channels
73+
- 1R1T - 1x RX and 1x TX common control and DMAs for the two RF channels also
7474
noted as R1_MODE
7575

76-
For any mode the number of RF channels(two) doesn't change only the controlling
77-
instance and the DMAs.
76+
For any mode, the number of RF channels (two) doesn't change --- only the
77+
controlling instance and the DMAs do.
7878

7979
The design has four receive paths and four transmit paths.
80-
Two of the receive paths (Rx12) have four channels and the other (Rx2) two
80+
81+
Two of the receive paths (RX12) have four channels and the other (RX2) two
8182
channels. These only work independently, not concomitantly.
82-
One must chose between two active paths (2R2T), or just the Rx12 (1R1T) path,
83-
which has four active channels, while Rx2 is disabled.
84-
The same applies to the transmit path but in the other direction.
8583

86-
When only the Rx12 path is active with four channels mode, the axi_adrv9001
87-
core will take ownership of both of its source synchronous interfaces.
84+
One must choose between two active paths (2R2T), or just the RX12 (1R1T) path,
85+
which has four active channels, while RX2 is disabled.
86+
87+
The same applies to the transmit path, but in the other direction.
88+
89+
When only the RX12 path is active with four channels mode, the axi_adrv9001
90+
core will take ownership of both of its source-synchronous interfaces.
8891
The requirement in this case is that both interfaces, of an axi_adrv9001 core,
8992
run at the same rate.
9093

91-
Regarding the INDEPENDENT_1R1T_SUPPORT and COMMON_2R2T_SUPPORT parameters,
94+
Regarding the ``INDEPENDENT_1R1T_SUPPORT`` and ``COMMON_2R2T_SUPPORT`` parameters
9295
related to the above modes, their purpose is to remove the unused data paths,
9396
reducing in this way the resource utilisation. By default all modes/paths are
9497
available.
9598

96-
For more info see the parameter description section of :ref:`axi_adrv9001`.
99+
For more info, see the Parameter Description section of :ref:`axi_adrv9001`.
97100

98101
Clock scheme
99102
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100103

101-
The clocks are managed by the ADRV9002 devices and are software programmable.
102-
Please refer to the device datasheet for the various clocks within the device.
104+
The clocks are managed by the :adi:`ADRV9002` devices and are software-programmable.
105+
Please refer to the device data sheet for the various clocks within the device.
103106

104-
Independently a board provides a 38.4MHz crystal for the :adi:`ADRV9002`.
107+
Independently, a board provides a 38.4MHz crystal for the :adi:`ADRV9002`.
105108
An external reference clock can also be used.
106109

107110
CPU/Memory interconnects addresses
@@ -227,13 +230,39 @@ If you want to build the sources, ADI makes them available on the
227230
`clone <https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository>`__
228231
the HDL repository.
229232

233+
This project has the following `make` parameters:
234+
235+
- CMOS_LVDS_N - selects the interface type
236+
- 0 = LVDS (default)
237+
- 1 = CMOS
238+
- USE_RX_CLK_FOR_TX1 - selects the clock to drive the TX1 SSI interface
239+
- 0 = TX1 dedicated clock (default)
240+
- 1 = RX1 SSI clock
241+
- 2 = RX2 SSI clock
242+
- USE_RX_CLK_FOR_TX2 - selects the clock to drive the TX2 SSI interface
243+
- 0 = TX2 dedicated clock (default)
244+
- 1 = RX1 SSI clock
245+
- 2 = RX2 SSI clock
246+
230247
**Linux/Cygwin/WSL**
231248

232-
.. shell::
249+
Building the default configuration (LVDS):
250+
251+
.. shell:: bash
233252

234253
$cd hdl/projects/adrv9001_dual/zcu102
235254
$make
236255

256+
Example configuration with CMOS:
257+
258+
.. shell:: bash
259+
260+
~/hdl/projects/adrv9001_dual/zcu102
261+
$make CMOS_LVDS_N=1
262+
263+
The result of the build, if parameters were used, will be in a folder named
264+
by the configuration used ``CMOSLVDSN1``.
265+
237266
A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
238267

239268
Resources
@@ -242,18 +271,12 @@ Resources
242271
Systems related
243272
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
244273

245-
Here you can find the quick start guides available for these evaluation boards:
246-
247-
- :dokuwiki:`ZCU102 <resources/eval/user-guides/adrv9002_dual/quickstart/zynqmp>`
248-
249-
Other useful information:
250-
251274
- :dokuwiki:`[Wiki] ADRV9001/2 User Guide <resources/eval/user-guides/adrv9001>`
252275

253276
HDL related
254277
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
255278

256-
- :git-hdl:`ADRV9001 HDL project source code <projects/adrv9001>`
279+
- :git-hdl:`ADRV9001_DUAL HDL project source code <projects/adrv9001_dual>`
257280

258281
.. list-table::
259282
:widths: 30 35 35
@@ -289,11 +312,8 @@ Software related
289312

290313
- :dokuwiki:`[Wiki] ADRV9002 Device Driver Customization <resources/tools-software/linux-drivers/iio-transceiver/adrv9002-customization>`
291314
- :dokuwiki:`[Wiki] ADRV9002 Integrated Dual RF Transceiver Linux device driver <resources/tools-software/linux-drivers/iio-transceiver/adrv9002>`
292-
293-
List of Linux device trees (to be dev).
294-
295-
- :git-linux:`adrv9002 ZCU102 (rev10) Linux device tree <arch/arm/boot/dts/xilinx/zynqmp-zcu102-rev10-adrv9002-dual.dts>`
296-
- :git-linux:`adrv9002 ZCU102 (rev10) Linux device 2rx2tx tree <arch/arm/boot/dts/xilinx/zynqmp-zcu102-rev10-adrv9002-dual-rx2tx2.dts>`
315+
- :git-linux:`ADRV9002/ZCU102 Linux device tree <arch/arm/boot/dts/xilinx/zynqmp-zcu102-rev10-adrv9002-dual.dts>`
316+
- :git-linux:`ADRV9002/ZCU102 Linux device tree 2RX2TX <arch/arm/boot/dts/xilinx/zynqmp-zcu102-rev10-adrv9002-dual-rx2tx2.dts>`
297317

298318
.. include:: ../common/more_information.rst
299319

0 commit comments

Comments
 (0)