Skip to content

Commit 60b7474

Browse files
committed
docs/cn0577: Update doc to include adaq2387x
Signed-off-by: Stanca Pop <stanca.pop@analog.com>
1 parent 18f655f commit 60b7474

File tree

1 file changed

+40
-31
lines changed
  • docs/testbenches/project_based/cn0577

1 file changed

+40
-31
lines changed

docs/testbenches/project_based/cn0577/index.rst

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
1-
.. _cn0577:
1+
.. _cn0577_adaq2387x:
22

3-
CN0577
3+
CN0577/ ADAQ2387X
44
================================================================================
55

66
Overview
77
-------------------------------------------------------------------------------
88

99
The purpose of this testbench is to validate the of the
10-
:git-hdl:`projects/cn0577` reference design.
10+
:git-hdl:`projects/cn0577` and :git-hdl:`projects/adaq2387x` reference designs.
1111

1212
The entire HDL documentation can be found here
13-
:external+hdl:ref:`CN0577 HDL project <cn0577>`.
13+
:external+hdl:ref:`CN0577 HDL project <cn0577>` and here
14+
:external+hdl:ref:`ADAQ2387X HDL project <adaq2387x>`.
1415

1516
Block design
1617
-------------------------------------------------------------------------------
1718

18-
The testbench block design includes part of the CN0577 HDL reference design,
19-
along with VIPs used for clocking, reset, PS and DDR simulations.
19+
The testbench block design includes part of the CN0577/ ADAQ2387X HDL reference
20+
designs, along with VIPs used for clocking, reset, PS and DDR simulations.
2021

2122
Block diagram
2223
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2324

2425
The data path and clock domains are depicted in the below diagram:
2526

26-
CN0577 parallel interface
27+
CN0577/ ADAQ2387X Testbench block diagram
2728
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2829

2930
.. image:: ./cn0577_tb.svg
@@ -40,36 +41,44 @@ The following parameter of this project that can be configured:
4041
Options: 0 - One lane, 1 - Two lanes
4142
- ADC_RES: defines the device's resolution in bits:
4243
Options: 16 - 16 bits, 18 - 18 bits
43-
44+
- USE_MMCM: defines the ref clk value in MHz:
45+
Options: 0 - 100MHz, 1 - 120MHz
46+
- CN0577_ADAQ2387X_N: selects the HDL project
47+
Options: 0 - ADAQ2387X, 1 - CN0577
48+
4449
Configuration files
4550
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4651

4752
The following configuration files are available:
4853

49-
+-----------------------+--------------------+
50-
| Configuration mode | Parameters |
51-
| +--------------------+
52-
| | TWOLANES | ADC_RES |
53-
+=======================+==========+=========+
54-
| cfg_1lane_16b | 0 | 16 |
55-
+-----------------------+----------+---------+
56-
| cfg_1lane_18b | 0 | 18 |
57-
+-----------------------+----------+---------+
58-
| cfg_2lanes_16b | 1 | 16 |
59-
+-----------------------+----------+---------+
60-
| cfg_2lanes_18b | 1 | 18 |
61-
+-----------------------+----------+---------+
54+
+--------------------------+----------------------------------------------------+
55+
| Configuration mode | Parameters |
56+
| +-------------------------------+--------------------+
57+
| | TWOLANES | ADC_RES | USE_MMCM | CN0577_ADAQ2387X_N |
58+
+==========================+==========+=========+==========+====================+
59+
| cfg_adaq2387x_1lane_16b | 0 | 16 | 0 | 0 |
60+
+--------------------------+----------+---------+----------+--------------------+
61+
| cfg_adaq2387x_1lane_18b | 0 | 18 | 0 | 0 |
62+
+--------------------------+----------+---------+----------+--------------------+
63+
| cfg_adaq2387x_2lanes_16b | 1 | 16 | 0 | 0 |
64+
+--------------------------+----------+---------+----------+--------------------+
65+
| cfg_adaq2387x_2lanes_18b | 1 | 18 | 0 | 0 |
66+
+--------------------------+----------+---------+----------+--------------------+
67+
| cfg_cn0577_1lane | 0 | 18 | 0 | 1 |
68+
+--------------------------+----------+---------+----------+--------------------+
69+
| cfg_cn0577_2lanes | 1 | 18 | 0 | 1 |
70+
+--------------------------+----------+---------+----------+--------------------+
6271

6372
Tests
6473
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6574

6675
The following test program files are available:
6776

68-
============ =====================================
77+
============ ================================================
6978
Test program Usage
70-
============ =====================================
71-
test_program Tests the cn0577 design capabilities.
72-
============ =====================================
79+
============ ================================================
80+
test_program Tests the cn0577/ adaq2387x design capabilities.
81+
============ ================================================
7382

7483
Available configurations & tests combinations
7584
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -175,7 +184,7 @@ command line.
175184
.. shell::
176185
:showuser:
177186

178-
$cd testbenches/project/cn0577
187+
$cd testbenches/project/cn0577_adaq2387x
179188
$make
180189

181190
*Example 2*
@@ -187,7 +196,7 @@ the waveforms.
187196
.. shell::
188197
:showuser:
189198

190-
$cd testbenches/project/cn0577
199+
$cd testbenches/project/cn0577_adaq2387x
191200
$make MODE=gui
192201

193202
*Example 3*
@@ -199,19 +208,19 @@ waveforms.
199208
.. shell::
200209
:showuser:
201210

202-
$cd testbenches/project/cn0577
203-
$make MODE=gui CFG=cfg_2lanes_18b TST=test_program
211+
$cd testbenches/project/cn0577_adaq2387x
212+
$make MODE=gui CFG=cfg_adaq2387x_2lanes_18b TST=test_program
204213

205214
The built projects can be found in the ``runs`` folder, where each configuration
206215
specific build has it's own folder named after the configuration file's name.
207216
Example: if the following command was run for a single configuration in the
208217
clean folder (no runs folder available):
209218

210-
``make CFG=cfg_2lanes_18b``
219+
``make CFG=cfg_adaq2387x_2lanes_18b``
211220

212221
Then the subfolder under ``runs`` name will be:
213222

214-
``cfg_2lanes_18b``
223+
``cfg_adaq2387x_2lanes_18b``
215224

216225
Resources
217226
-------------------------------------------------------------------------------

0 commit comments

Comments
 (0)