Skip to content

Commit 5956ce2

Browse files
committed
docs(linux): U-Boot: Falcon-Mode: consistency fixes
Use :file: markup instead of double backticks for consistency with rest of the docs. No visual changes to the rendered HTML are intended from this patch. Signed-off-by: Anshul Dalal <[email protected]>
1 parent 2f53dcf commit 5956ce2

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

source/linux/Foundational_Components/U-Boot/UG-Falcon-Mode.rst

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,21 @@ TI-SPL:
4747
=======
4848

4949
Falcon mode makes use of a cut down variant of the tispl binary called
50-
``tifalcon.bin`` with the Cortex-A SPL and it's corresponding DTB removed.
50+
:file:`tifalcon.bin` with the Cortex-A SPL and its corresponding DTB removed.
5151
This file is deployed to the boot directory inside rootfs so it can be picked by
5252
the R5 SPL at boot time.
5353

5454
R5 SPL:
5555
=======
5656

57-
The R5 SPL is used for loading the kernel ``fitImage`` and ``tifalcon.bin``
58-
file, though the ``fitImage`` for falcon boot is signed by using an x509
57+
The R5 SPL is used for loading the kernel :file:`fitImage` and :file:`tifalcon.bin`
58+
file, though the :file:`fitImage` for falcon boot is signed by using an x509
5959
certificate with TIFS keys instead of making use of signature nodes and keys
6060
present in the DT. This allows for faster authentication since TIFS uses the
6161
security accelerator for authentication, which is much faster than doing the
6262
same on R5 core.
6363

64-
This support depends on the U-Boot's ``k3_r5_falcon.config`` fragment, which is
64+
This support depends on the U-Boot's :file:`k3_r5_falcon.config` fragment, which is
6565
built alongside the standard R5 defconfig when ``ti-falcon`` is enabled. This
6666
updates the R5 memory map at U-Boot SPL stage to the following:
6767

@@ -99,7 +99,7 @@ updates the R5 memory map at U-Boot SPL stage to the following:
9999
fitImage:
100100
=========
101101

102-
The resulting ``fitImage`` file in the boot directory of rootfs is produced
102+
The resulting :file:`fitImage` file in the boot directory of rootfs is produced
103103
with the constituent binaries pre-signed with x509 certificates. This file is
104104
authenticated from TIFS at boot time, which allows for a lower boot time than
105105
authenticating on the R5 core.
@@ -113,13 +113,13 @@ OSPI boot:
113113

114114
.. ifconfig:: CONFIG_part_variant not in ('AM62AX')
115115

116-
For OSPI boot, the ``tiboot3.bin`` and ``tifalcon.bin`` files should be
116+
For OSPI boot, the :file:`tiboot3.bin` and :file:`tifalcon.bin` files should be
117117
flashed to the same addresses in flash as regular boot flow but the
118-
``fitImage`` is read from the rootfs's boot directory. The MMC device is
118+
:file:`fitImage` is read from the rootfs's boot directory. The MMC device is
119119
selected by the ``mmcdev`` env variable for R5 SPL.
120120

121-
Below U-Boot commands can be used to download ``tiboot3.bin`` and
122-
``tifalcon.bin`` over tftp and then flash those to OSPI at their respective
121+
Below U-Boot commands can be used to download :file:`tiboot3.bin` and
122+
:file:`tifalcon.bin` over tftp and then flash those to OSPI at their respective
123123
addresses.
124124

125125
.. code-block:: console
@@ -137,10 +137,10 @@ OSPI boot:
137137
eMMC Boot:
138138
==========
139139

140-
In eMMC boot mode, the ``tiboot3.bin`` file should be flashed to the hardware
141-
boot partition whereas ``tifalcon.bin`` and the ``fitImage`` are read from
140+
In eMMC boot mode, the :file:`tiboot3.bin` file should be flashed to the hardware
141+
boot partition whereas :file:`tifalcon.bin` and the :file:`fitImage` are read from
142142
the rootfs inside UDA. Use the U-Boot commands below to set the correct boot
143-
partition and write ``tiboot3.bin`` to the correct offset.
143+
partition and write :file:`tiboot3.bin` to the correct offset.
144144

145145
.. code-block:: console
146146
@@ -166,10 +166,10 @@ Clone the `core-secdev-k3 source <https://git.ti.com/cgit/security-development-t
166166
167167
$ git clone https://git.ti.com/cgit/security-development-tools/core-secdev-k3
168168
169-
Copy the required kernel image renamed to ``Image`` and the DTB renamed to
170-
``falcon.dtb`` inside the core-secdev-k3 source directory.
169+
Copy the required kernel image renamed to :file:`Image` and the DTB renamed to
170+
:file:`falcon.dtb` inside the core-secdev-k3 source directory.
171171

172-
Copy the following contents to a file named ``fitImage.its`` inside
172+
Copy the following contents to a file named :file:`fitImage.its` inside
173173
core-secdev-k3 source:
174174

175175
.. code-block:: dts
@@ -212,8 +212,8 @@ core-secdev-k3 source:
212212
};
213213
};
214214
215-
Sign the kernel and dtb with ``secure-binary-image.sh`` and create the
216-
``fitImage`` by using mkimage:
215+
Sign the kernel and dtb with :file:`secure-binary-image.sh` and create the
216+
:file:`fitImage` by using mkimage:
217217

218218
.. code-block:: console
219219
@@ -226,20 +226,20 @@ Sign the kernel and dtb with ``secure-binary-image.sh`` and create the
226226
Non-Yocto Users:
227227
****************
228228

229-
Following are the steps to build ``tiboot3.bin``, ``tifalcon.bin`` and the
230-
``fitImage`` required for falcon mode:
229+
Following are the steps to build :file:`tiboot3.bin`, :file:`tifalcon.bin` and the
230+
:file:`fitImage` required for falcon mode:
231231

232232
#. For :ref:`ATF build <foundational-components-atf>`, use the following
233233
arguments to update the ATF's jump address for the kernel and the
234234
device-tree: ``PRELOADED_BL33_BASE=0x82000000 K3_HW_CONFIG_BASE=0x88000000``.
235235

236236
#. For :ref:`R5 U-Boot build <Build-U-Boot-label>`, use the
237-
``k3_r5_falcon.config`` fragment to enable flacon support at the R5 SPL
237+
:file:`k3_r5_falcon.config` fragment to enable flacon support at the R5 SPL
238238
stage.
239239

240240
#. Refer to the :ref:`fitImage creation step
241241
<u-boot_falcon_mode_fitImage_creation>` above for preparing a bootable
242-
``fitImage`` with an appropriate kernel and DTB.
242+
:file:`fitImage` with an appropriate kernel and DTB.
243243

244244
#. Copy the files generated to correct path on SD/eMMC as in the table below:
245245

@@ -252,26 +252,26 @@ Following are the steps to build ``tiboot3.bin``, ``tifalcon.bin`` and the
252252
- Partition
253253
- Description
254254

255-
* - ``tiboot3.bin``
256-
- ``/tiboot3.bin``
255+
* - :file:`tiboot3.bin`
256+
- :file:`/tiboot3.bin`
257257
- boot (fat)
258258
- R5 SPL with falcon support
259259

260-
* - ``tifalcon.bin``
261-
- ``/boot/tifalcon.bin``
260+
* - :file:`tifalcon.bin`
261+
- :file:`/boot/tifalcon.bin`
262262
- rootfs (ext4)
263263
- tispl binary without SPL for the A core and DTB
264264

265-
* - ``fitImage``
266-
- ``/boot/fitImage``
265+
* - :file:`fitImage`
266+
- :file:`/boot/fitImage`
267267
- rootfs (ext4)
268268
- kernel and dtb fitImage with pre-signed binaries
269269

270270
.. note::
271271

272-
The ``tifalcon.bin`` binary is generated by default for all falcon
272+
The :file:`tifalcon.bin` binary is generated by default for all falcon
273273
supported platforms at the A-Core U-Boot build step and can be found
274-
alongside the existing ``tispl.bin`` file in U-Boot build's output directory.
274+
alongside the existing :file:`tispl.bin` file in U-Boot build's output directory.
275275

276276
**********************
277277
Boot time comparisons:

0 commit comments

Comments
 (0)