Skip to content

Commit 60bfdc3

Browse files
ArchUsr64StaticRocket
authored andcommitted
docs(linux): U-Boot: Falcon-Mode: consistency fixes
Use file markup tag instead of double backticks for consistency with rest of the docs alongside making the language more clear in some sections. Signed-off-by: Anshul Dalal <[email protected]>
1 parent f837876 commit 60bfdc3

File tree

1 file changed

+46
-47
lines changed

1 file changed

+46
-47
lines changed

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

Lines changed: 46 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,22 @@ 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.
51-
This file is deployed to the boot directory inside rootfs so it can be picked by
52-
the R5 SPL at boot time.
50+
:file:`tifalcon.bin` with the Cortex-A SPL and its corresponding device-tree
51+
removed. This file is deployed to the boot directory inside the root filesystem
52+
so it can be picked by 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
59-
certificate with TIFS keys instead of making use of signature nodes and keys
60-
present in the DT. This allows for faster authentication since TIFS uses the
61-
security accelerator for authentication, which is much faster than doing the
62-
same on R5 core.
63-
64-
This support depends on the U-Boot's ``k3_r5_falcon.config`` fragment, which is
65-
built alongside the standard R5 defconfig when ``ti-falcon`` is enabled. This
66-
updates the R5 memory map at U-Boot SPL stage to the following:
57+
The R5 SPL loads the kernel :file:`fitImage` and :file:`tifalcon.bin` file. An
58+
x509 certificate with TIFS keys verifies the :file:`fitImage` for falcon boot
59+
instead of making use of signature nodes and keys present in the DT. This allows
60+
for faster authentication since TIFS uses the security accelerator for
61+
authentication, which is much faster than doing the same on R5 core.
6762

63+
This support is present alongside the standard R5 ``defconfig`` when ``ti-falcon``
64+
is enabled due to U-Boot's :file:`k3_r5_falcon.config` fragment. This updates
65+
the R5 memory map at U-Boot SPL stage to the following:
6866

6967
.. code-block::
7068
@@ -99,10 +97,10 @@ updates the R5 memory map at U-Boot SPL stage to the following:
9997
fitImage:
10098
=========
10199

102-
The resulting ``fitImage`` file in the boot directory of rootfs is produced
103-
with the constituent binaries pre-signed with x509 certificates. This file is
104-
authenticated from TIFS at boot time, which allows for a lower boot time than
105-
authenticating on the R5 core.
100+
The system produces the resulting :file:`fitImage` file in the boot directory
101+
of the root filesystem. This file has its constituent binaries pre-signed with
102+
x509 certificates. At boot time, TIFS authenticates this file, which allows for
103+
a lower boot time compared to authenticating on the R5 core.
106104

107105
*******************
108106
Extra Configuration
@@ -113,13 +111,13 @@ OSPI boot:
113111

114112
.. ifconfig:: CONFIG_part_variant not in ('AM62AX')
115113

116-
For OSPI boot, the ``tiboot3.bin`` and ``tifalcon.bin`` files should be
114+
For OSPI boot, the :file:`tiboot3.bin` and :file:`tifalcon.bin` files should be
117115
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
119-
selected by the ``mmcdev`` env variable for R5 SPL.
116+
:file:`fitImage` is read from the root filesystem's boot directory. The MMC
117+
device is selected by the ``mmcdev`` env variable for R5 SPL.
120118

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
119+
Below U-Boot commands can be used to download :file:`tiboot3.bin` and
120+
:file:`tifalcon.bin` over tftp and then flash those to OSPI at their respective
123121
addresses.
124122

125123
.. code-block:: console
@@ -137,10 +135,11 @@ OSPI boot:
137135
eMMC Boot:
138136
==========
139137

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
142-
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.
138+
In eMMC boot mode, the :file:`tiboot3.bin` file should be flashed to the
139+
hardware boot partition whereas :file:`tifalcon.bin` and the :file:`fitImage`
140+
are read from the root filesystem inside UDA. Use the U-Boot commands below
141+
to set the correct boot partition and write :file:`tiboot3.bin` to the correct
142+
offset.
144143

145144
.. code-block:: console
146145
@@ -166,10 +165,10 @@ Clone the `core-secdev-k3 source <https://git.ti.com/cgit/security-development-t
166165
167166
$ git clone https://git.ti.com/cgit/security-development-tools/core-secdev-k3
168167
169-
Copy the required kernel image renamed to ``Image`` and the DTB renamed to
170-
``falcon.dtb`` inside the core-secdev-k3 source directory.
168+
Copy the required kernel image renamed to :file:`Image` and the device-tree
169+
renamed to :file:`falcon.dtb` inside the `core-secdev-k3` source directory.
171170

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

175174
.. code-block:: dts
@@ -212,8 +211,8 @@ core-secdev-k3 source:
212211
};
213212
};
214213
215-
Sign the kernel and dtb with ``secure-binary-image.sh`` and create the
216-
``fitImage`` by using mkimage:
214+
Sign the kernel and device-tree with :file:`secure-binary-image.sh` and create the
215+
:file:`fitImage` by using ``mkimage``:
217216

218217
.. code-block:: console
219218
@@ -226,20 +225,20 @@ Sign the kernel and dtb with ``secure-binary-image.sh`` and create the
226225
Non-Yocto Users:
227226
****************
228227

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

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

236235
#. 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
236+
:file:`k3_r5_falcon.config` fragment to enable flacon support at the R5 SPL
238237
stage.
239238

240239
#. Refer to the :ref:`fitImage creation step
241240
<u-boot_falcon_mode_fitImage_creation>` above for preparing a bootable
242-
``fitImage`` with an appropriate kernel and DTB.
241+
:file:`fitImage` with an appropriate kernel and device-tree.
243242

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

@@ -252,26 +251,26 @@ Following are the steps to build ``tiboot3.bin``, ``tifalcon.bin`` and the
252251
- Partition
253252
- Description
254253

255-
* - ``tiboot3.bin``
256-
- ``/tiboot3.bin``
254+
* - :file:`tiboot3.bin`
255+
- :file:`/tiboot3.bin`
257256
- boot (fat)
258257
- R5 SPL with falcon support
259258

260-
* - ``tifalcon.bin``
261-
- ``/boot/tifalcon.bin``
262-
- rootfs (ext4)
263-
- tispl binary without SPL for the A core and DTB
259+
* - :file:`tifalcon.bin`
260+
- :file:`/boot/tifalcon.bin`
261+
- root filesystem (ext4)
262+
- tispl binary without SPL for the A core and device-tree
264263

265-
* - ``fitImage``
266-
- ``/boot/fitImage``
267-
- rootfs (ext4)
268-
- kernel and dtb fitImage with pre-signed binaries
264+
* - :file:`fitImage`
265+
- :file:`/boot/fitImage`
266+
- root filesystem (ext4)
267+
- :file:`fitImage` with pre-signed kernel and device-tree
269268

270269
.. note::
271270

272-
The ``tifalcon.bin`` binary is generated by default for all falcon
271+
The :file:`tifalcon.bin` binary is generated by default for all falcon
273272
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.
273+
alongside the existing :file:`tispl.bin` file in U-Boot build's output directory.
275274

276275
**********************
277276
Boot time comparisons:

0 commit comments

Comments
 (0)