Skip to content

Commit 3091ecb

Browse files
committed
docs/projects: update documentation of projects
Update NUM_OF_SDI to NUM_OF_SDIO in the projects documentations. The variable was updated on the spi_engine library since SDI and SDO have symmetrical sizes. Signed-off-by: Carlos Souza <carlos.souza@analog.com>
1 parent f6d80b8 commit 3091ecb

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

docs/projects/ad4630_fmc/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ digital interface:
183183
- 0 - SPI mode
184184
- 1 - Echo-clock or Master clock mode
185185

186-
The NUM_OF_SDI configuration parameter defines the number of MOSI lines of the
186+
The NUM_OF_SDIO configuration parameter defines the number of MOSI lines of the
187187
SPI interface:
188188

189189
- 1 - Interleaved mode
@@ -351,14 +351,14 @@ the HDL repository, and then build the project as follows:.
351351
.. shell::
352352

353353
$cd hdl/projects/ad4630_fmc/zed
354-
$make NUM_OF_SDI=4 CAPTURE_ZONE=2
354+
$make NUM_OF_SDIO=4 CAPTURE_ZONE=2
355355

356356
The result of the build, if parameters were used, will be in a folder named
357357
by the configuration used:
358358

359359
if the following command was run
360360

361-
``make NUM_OF_SDI=4 CAPTURE_ZONE=2``
361+
``make NUM_OF_SDIO=4 CAPTURE_ZONE=2``
362362

363363
then the folder name will be:
364364

docs/projects/ad738x_fmc/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,14 @@ In case of the **Alert Indication Output Pin** functionality:
112112

113113
$make ALERT_SPI_N=1
114114

115-
The **NUM_OF_SDI** configuration parameter defines the number of SDI lines used:
115+
The **NUM_OF_SDIO** configuration parameter defines the number of SDI lines used:
116116
**{1, 2, 4}**. By default is set to 1.
117117

118118
For the **ALERT** functionality, the following parameters will be used in make
119119
command: ALERT_SPI_N.
120120

121121
For the **serial data output** functionality, the following parameters will be
122-
used in make command: ALERT_SPI_N, NUM_OF_SDI.
122+
used in make command: ALERT_SPI_N, NUM_OF_SDIO.
123123

124124
Jumper setup
125125
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -264,14 +264,14 @@ the HDL repository, and then build the project as follows:
264264
.. shell::
265265

266266
$cd hdl/projects/ad738x_fmc/zed
267-
$make ALERT_SPI_N=0 NUM_OF_SDI=4
267+
$make ALERT_SPI_N=0 NUM_OF_SDIO=4
268268

269269
The result of the build, if parameters were used, will be in a folder named
270270
by the configuration used:
271271

272272
if the following command was run
273273

274-
``make ALERT_SPI_N=0 NUM_OF_SDI=4``
274+
``make ALERT_SPI_N=0 NUM_OF_SDIO=4``
275275

276276
then the folder name will be:
277277

docs/projects/ad7606x_fmc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ In case of the **SERIAL** interface:
125125
- JP5 - Position A - Serial interface
126126
- JP5 - Position B - Parallel interface
127127

128-
The NUM_OF_SDI configuration parameter defines the number of SDI lines used:
128+
The NUM_OF_SDIO configuration parameter defines the number of SDI lines used:
129129
**{1, 2, 4, 8}**. By default is set to 8.
130130

131131
The ADC_N_BITS configuration parameter specifies the ADC resolution:

docs/projects/ad7616_sdz/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The following are the parameters of this project that can be configured:
8585
- 0 - parallel (default)
8686
- 1 - serial
8787

88-
- NUM_OF_SDI: number of SDI lines used, **only in serial interface mode**;
88+
- NUM_OF_SDIO: number of SDI lines used, **only in serial interface mode**;
8989

9090
- 1 - one SDI line
9191
- 2 - two SDI lines (default)
@@ -264,14 +264,14 @@ the HDL repository, and then build the project as follows:.
264264
.. shell::
265265

266266
$cd hdl/projects/ad7616_sdz/zed
267-
$make INTF=1 NUM_OF_SDI=2
267+
$make INTF=1 NUM_OF_SDIO=2
268268

269269
The result of the build, if parameters were used, will be in a folder named
270270
by the configuration used:
271271

272272
if the following command was run
273273

274-
``make INTF=1 NUM_OF_SDI=2``
274+
``make INTF=1 NUM_OF_SDIO=2``
275275

276276
then the folder name will be:
277277

docs/user_guide/ip_cores/use_adi_ips.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,10 @@ An example of instantiation, using the default values for ``cmd_mem_addr_width``
179179
.. code:: tcl
180180
181181
# name data_width async_spi_clk num_csn num_sdi sdi_delay echo_sclk
182-
spi_engine_create "spi_ad463x" 32 1 1 $NUM_OF_SDI 0 1
182+
spi_engine_create "spi_ad463x" 32 1 1 $NUM_OF_SDIO 0 1
183183
ad_ip_parameter spi_ad463x/execution CONFIG.DEFAULT_SPI_CFG 1 ;
184184
185-
ad_ip_parameter spi_ad463x/axi_regmap CONFIG.CFG_INFO_0 $NUM_OF_SDI
185+
ad_ip_parameter spi_ad463x/axi_regmap CONFIG.CFG_INFO_0 $NUM_OF_SDIO
186186
ad_ip_parameter spi_ad463x/axi_regmap CONFIG.CFG_INFO_1 $CAPTURE_ZONE
187187
ad_ip_parameter spi_ad463x/axi_regmap CONFIG.CFG_INFO_2 $CLK_MODE
188188
ad_ip_parameter spi_ad463x/axi_regmap CONFIG.CFG_INFO_3 $DDR_EN

0 commit comments

Comments
 (0)