Skip to content

Commit 7bb469d

Browse files
committed
docs/ada4355: Update documentation
Signed-off-by: Pop Ioan Daniel <pop.ioan-daniel@analog.com>
1 parent 5a02110 commit 7bb469d

File tree

2 files changed

+90
-6
lines changed

2 files changed

+90
-6
lines changed

docs/library/axi_ada4355/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ Configuration Parameters
4848
- Core ID should be unique for each IP in the system
4949
* - FPGA_TECHNOLOGY
5050
- Used to select between FPGA devices, auto set in project.
51+
* - BUFMRCE_EN
52+
- Used to select between evaluation boards that are differentiated
53+
by how the frame clock signals are distributed.
5154

5255
Interface
5356
--------------------------------------------------------------------------------
@@ -83,6 +86,8 @@ Interface
8386
- Received data output
8487
* - adc_dovf
8588
- Data overflow. Must be connected to the DMA
89+
* - up_adc_pn_err
90+
- Error monitoring
8691
* - s_axi
8792
- Standard AXI Slave Memory Map interface
8893

docs/projects/ada4355_fmc/index.rst

Lines changed: 85 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,32 @@ The data path and clock domains are depicted in the below diagram:
6666
:align: center
6767
:alt: ADA4355_FMC/ZedBoard block diagram
6868

69+
Configuration modes
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71+
72+
The BUFMRCE_EN configuration parameter defines the type of evaluation board
73+
used, which are differentiated by how the frame clock signals are distributed.
74+
For the older evaluation board, the XDC constraints are not optimized for
75+
ISERDES, as the frame clock signals are located in a different I/O bank from
76+
the other related signals. To address this, a BUFMRCE buffer is used to
77+
distribute the frame clock to all ISERDES instances.
78+
79+
By default it is set to 0. Depending on the type of evaluation board, some
80+
hardware modifications need to be done on the board and/or ``make`` command:
81+
82+
In case of the Eval-Board with optimized xdc:
83+
84+
.. shell:: bash
85+
86+
$make BUFMRCE_EN=0
87+
88+
In case of the Eval-Board with non optimized xdc:
89+
90+
.. shell:: bash
91+
92+
$make BUFMRCE_EN=1
93+
94+
6995
CPU/Memory interconnects addresses
7096
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7197

@@ -121,19 +147,55 @@ The Software GPIO number is calculated as follows:
121147
- (from FPGA view)
122148
-
123149
- Zynq-7000
124-
* - gpio_1p8va_en
150+
* - apd_supp_en **
151+
- INOUT
152+
- 42
153+
- 96
154+
* - trig_fmc_out **
155+
- INOUT
156+
- 41
157+
- 95
158+
* - trig_fmc_in **
159+
- INOUT
160+
- 40
161+
- 94
162+
* - freq_sel1 **
163+
- INOUT
164+
- 39
165+
- 93
166+
* - gain_sel3 **
167+
- INOUT
168+
- 38
169+
- 92
170+
* - gpio_test **
171+
- INOUT
172+
- 37
173+
- 91
174+
* - gpio_1p8va_en *
125175
- IN
126176
- 37
127177
- 91
128-
* - gain_sel2
178+
* - gain_sel2 **
179+
- INOUT
180+
- 36
181+
- 90
182+
* - gain_sel2 *
129183
- IN
130184
- 36
131185
- 90
132-
* - gpio_1p8vd_en
186+
* - gpio_vld_en **
133187
- INOUT
134188
- 35
135189
- 89
136-
* - fsel
190+
* - gpio_1p8vd_en *
191+
- INOUT
192+
- 35
193+
- 89
194+
* - freq_sel0 **
195+
- INOUT
196+
- 34
197+
- 88
198+
* - fsel *
137199
- INOUT
138200
- 34
139201
- 88
@@ -146,6 +208,12 @@ The Software GPIO number is calculated as follows:
146208
- 32
147209
- 86
148210

211+
.. admonition:: Legend
212+
:class: note
213+
214+
- ``*`` instantiated only for BUFMRCE_EN=1
215+
- ``**`` instantiated only for BUFMRCE_EN=0
216+
149217
Interrupts
150218
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151219

@@ -186,14 +254,25 @@ ADI distributes the bit/elf files of these projects as part of the
186254
If you want to build the sources, ADI makes them available on the
187255
:git-hdl:`HDL repository </>`. To get the source you must
188256
`clone <https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository>`__
189-
the HDL repository.
257+
the HDL repository, and then build the project as follows:
190258

191259
**Linux/Cygwin/WSL**
192260

193261
.. shell::
194262

195263
$cd hdl/projects/ada4355_fmc/zed
196-
$make
264+
$make BUFMRCE_EN=0
265+
266+
The result of the build, if parameters were used, will be in a folder named
267+
by the configuration used:
268+
269+
if the following command was run
270+
271+
``make BUFMRCE_EN=0``
272+
273+
then the folder name will be:
274+
275+
``BUFMRCEEN0``
197276

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

0 commit comments

Comments
 (0)