Skip to content

Commit 2f50c3e

Browse files
committed
docs/projects/pulsar_adc: Fix HDL Documentation
Signed-off-by: Elena-Hadarau_adi <Elena.Hadarau@analog.com>
1 parent 9d1e440 commit 2f50c3e

File tree

1 file changed

+57
-6
lines changed

1 file changed

+57
-6
lines changed

docs/projects/pulsar_adc/index.rst

Lines changed: 57 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ when utilizing the boards.
2020
With PMOD
2121
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2222

23-
ADAQ40xx families is also part of the family of PulSAR converters with PMOD
24-
connector.
23+
The ADAQ40xx family is also part of the PulSAR converters with PMOD connector.
2524

2625
This type of boards come with the :adi:`EVAL-PMD-IB1Z` PMOD to
2726
field programmable gate array (FPGA) mezzanine card (FMC) interposer board that
@@ -160,13 +159,60 @@ PulSAR_ADC_FMC
160159
:align: center
161160
:alt: PulSAR_ADC_FMC block diagram
162161

162+
Design configuration
163+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164+
165+
The reference design uses a clock generator for the division of the SPI clock
166+
and a PWM generator for the conversion signal. The required parameters can be
167+
set in the
168+
:git-hdl:`pulsar_adc_pmdz_bd.tcl <projects/pulsar_adc/common/pulsar_adc_bd.tcl>`
169+
file using the following values, where the ``PULSE_0_PERIOD`` is computed as
170+
``Tcyc_min / Tspi_clk``:
171+
172+
.. list-table::
173+
:widths: 30 30
174+
:header-rows: 1
175+
176+
* - Part
177+
- PULSE_0_PERIOD
178+
* - AD7942
179+
- 640
180+
* - AD7946
181+
- 320
182+
* - AD7988-1
183+
- 1600
184+
* - AD7685
185+
- 640
186+
* - AD7687
187+
- 640
188+
* - AD7691
189+
- 640
190+
* - AD7686
191+
- 320
192+
* - AD7688
193+
- 320
194+
* - AD7693
195+
- 320
196+
* - AD7988-5
197+
- 320
198+
* - AD7980
199+
- 160
200+
* - AD7983
201+
- 120
202+
* - AD7690
203+
- 250
204+
* - AD7982
205+
- 160
206+
* - AD7984
207+
- 120
208+
163209
Configuration modes
164210
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
165211

166212
The Zedboard-based PulSAR ADC project can be built to use either the FMC
167-
connector or the Pmod JA connector.
213+
connector or the PMOD JA connector.
168214

169-
The ``FMC_N_PMOD`` parameter is used to select between the them:
215+
The ``FMC_N_PMOD`` parameter is used to select between them:
170216

171217
- 0 - for PMOD
172218
- 1 - for FMC (default)
@@ -329,35 +375,40 @@ the HDL repository, and then build the project as follows:.
329375

330376
Build examples:
331377

332-
Zedboard Pmod support
378+
Zedboard PMOD support
333379

334380
.. shell:: bash
335381

382+
$cd hdl/projects/pulsar_adc/zed
336383
$make FMC_N_PMOD=0
337384

338385
Zedboard standard configuration FMC support (default)
339386

340387
.. shell:: bash
341388

389+
$cd hdl/projects/pulsar_adc/zed
342390
$make FMC_N_PMOD=1 SPI_OP_MODE=0 - builds standard FMC version
343391

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

346394
.. shell:: bash
347395

396+
$cd hdl/projects/pulsar_adc/zed
348397
$make FMC_N_PMOD=1 SPI_OP_MODE=1
349398

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

352401
.. shell:: bash
353402

403+
$cd hdl/projects/pulsar_adc/zed
354404
$make FMC_N_PMOD=1 SPI_OP_MODE=2
355405

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

359409
.. shell:: bash
360410

411+
$cd hdl/projects/pulsar_adc/zed
361412
$make FMC_N_PMOD=1 SPI_OP_MODE=0
362413

363414
then the folder name will be:
@@ -366,7 +417,7 @@ then the folder name will be:
366417

367418
.. note::
368419

369-
For the CoraZ7S-based projects, the build is donw without parameters!
420+
For the CoraZ7S-based projects, the build is done without parameters!
370421

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

0 commit comments

Comments
 (0)