Skip to content

Commit 233aeaf

Browse files
docs/user_guide/build_boot_bin: Add info when building a prj with params
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
1 parent e8f4d5d commit 233aeaf

File tree

1 file changed

+44
-6
lines changed

1 file changed

+44
-6
lines changed

docs/user_guide/build_boot_bin.rst

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,16 @@ project) and ``u-boot.elf`` (from the SD card with Kuiper image).
2525

2626
Check the :ref:`Enviroment <build_hdl environment>` section of :ref:`build_hdl`.
2727

28+
As prerequisites, you need to have ``xlsclients`` from the ``x11-utils`` package
29+
installed in your Linux/WSL system.
30+
2831
.. _build_boot_bin zynq:
2932

3033
For Zynq
3134
-------------------------------------------------------------------------------
3235

3336
This section applies to the Zynq-based carriers from
34-
:ref:`our list <architecture amd-platforms>`, but not limited to them only.
37+
:ref:`our list <architecture amd-platforms>`.
3538

3639
Make sure that AMD Xilinx Vivado and Vitis are included in the path and a
3740
cross-compiler for ``arm`` exists before running the script.
@@ -58,8 +61,14 @@ The script can take 3 parameters:
5861
See the beginning of :external+documentation:ref:`kuiper sdcard` for
5962
instructions on how to obtain the ADI Kuiper image.
6063

61-
The script can be saved in the folder local to the project (for
62-
example, hdl/projects/fmcomms2/zed) and to be run from there.
64+
If you didn't use ``make`` parameters when building the project, then
65+
the script can be saved in the **folder local to the project** (for
66+
example, hdl/projects/$ADI_PART/$CARRIER) and **to be run from there**.
67+
68+
If you did use ``make`` parameters, then you need to go to the build folder
69+
that was created based on the parameters you gave,
70+
(would look like this hdl/projects/$ADI_PART/$CARRIER/$param1_param2),
71+
save it there and **run it from there**.
6372

6473
.. shell:: bash
6574

@@ -69,7 +78,11 @@ example, hdl/projects/fmcomms2/zed) and to be run from there.
6978

7079
The build output (``BOOT.BIN``) can be found in the local directory
7180
``output_boot_bin`` where you ran the command.
72-
The folder follows the pattern: *hdl/projects/$ADI_PART/$CARRIER/output_boot_bin*.
81+
82+
The folder follows the following pattern if ``make`` parameters were not used
83+
*hdl/projects/$ADI_PART/$CARRIER/output_boot_bin*, and this pattern if
84+
parameters were used
85+
*hdl/projects/$ADI_PART/$CARRIER/$PARAM1_PARAM2/output_boot_bin*.
7386

7487
.. _build_boot_bin zynqmp:
7588

@@ -106,6 +119,15 @@ The script can take 4 parameters (the last one is optional):
106119
See the beginning of :external+documentation:ref:`kuiper sdcard` for
107120
instructions on how to obtain the ADI Kuiper image.
108121

122+
If you didn't use ``make`` parameters when building the project, then
123+
the script can be saved in the **folder local to the project** (for
124+
example, hdl/projects/$ADI_PART/$CARRIER) and **to be run from there**.
125+
126+
If you did use ``make`` parameters, then you need to go to the build folder
127+
that was created based on the parameters you gave,
128+
(would look like this hdl/projects/$ADI_PART/$CARRIER/$param1_param2),
129+
save it there and **run it from there**.
130+
109131
.. shell:: bash
110132

111133
$cd hdl/projects/fmcomms2/zcu102
@@ -114,7 +136,10 @@ The script can take 4 parameters (the last one is optional):
114136

115137
The build output (``BOOT.BIN``) can be found in the local directory
116138
``output_boot_bin`` where you ran the command.
117-
The folder follows the pattern: *hdl/projects/$ADI_PART/$CARRIER/output_boot_bin*.
139+
The folder follows the following pattern if ``make`` parameters were not used
140+
*hdl/projects/$ADI_PART/$CARRIER/output_boot_bin*, and this pattern if
141+
parameters were used
142+
*hdl/projects/$ADI_PART/$CARRIER/$PARAM1_PARAM2/output_boot_bin*.
118143

119144
.. _build_boot_bin versal:
120145

@@ -151,6 +176,15 @@ The script can take 4 parameters:
151176
See the beginning of :external+documentation:ref:`kuiper sdcard` for
152177
instructions on how to obtain the ADI Kuiper image.
153178

179+
If you didn't use ``make`` parameters when building the project, then
180+
the script can be saved in the **folder local to the project** (for
181+
example, hdl/projects/$ADI_PART/$CARRIER) and **to be run from there**.
182+
183+
If you did use ``make`` parameters, then you need to go to the build folder
184+
that was created based on the parameters you gave,
185+
(would look like this hdl/projects/$ADI_PART/$CARRIER/$param1_param2),
186+
save it there and **run it from there**.
187+
154188
.. shell:: bash
155189

156190
$cd hdl/projects/ad9081_fmca_ebz/vck190
@@ -159,7 +193,11 @@ The script can take 4 parameters:
159193

160194
The build output (``BOOT.BIN``) can be found in the local directory
161195
``output_boot_bin`` where you ran the command.
162-
The folder follows the pattern: *hdl/projects/$ADI_PART/$CARRIER/output_boot_bin*.
196+
The folder follows the following pattern if ``make`` parameters were not used
197+
*hdl/projects/$ADI_PART/$CARRIER/output_boot_bin*, and this pattern if
198+
parameters were used
199+
*hdl/projects/$ADI_PART/$CARRIER/$PARAM1_PARAM2/output_boot_bin*.
200+
163201

164202
More information
165203
-------------------------------------------------------------------------------

0 commit comments

Comments
 (0)