Skip to content

Commit 1a0594e

Browse files
nicola-mazzucato-armAnton-TF
authored andcommitted
docs: Update build examples to TF-PSA Crypto
Update build instruction to TF-PSA Crypto, which is now the default Crypto. And some other minor corrections and improvements. Signed-off-by: Nicola Mazzucato <nicola.mazzucato@arm.com> Change-Id: I0fec20adb9f8dcf5d37b3c190baf4c44b8efce3d
1 parent c630c68 commit 1a0594e

1 file changed

Lines changed: 14 additions & 12 deletions

File tree

docs/building/tfm_build_instruction.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ The following table lists the commonly used repos. For others, you can refer to
239239
+----------------+---------------------+-----------------------------------------------------+
240240
| Dependency | Cmake variable | Git repo URL |
241241
+================+=====================+=====================================================+
242-
| Mbed Crypto | MBEDCRYPTO_PATH | https://github.com/Mbed-TLS/mbedtls |
242+
| TF-PSA Crypto | TF_PSA_CRYPTO_PATH | https://github.com/Mbed-TLS/TF-PSA-Crypto |
243243
+----------------+---------------------+-----------------------------------------------------+
244244
| MCUboot | MCUBOOT_PATH | https://github.com/mcu-tools/mcuboot |
245245
+----------------+---------------------+-----------------------------------------------------+
@@ -257,8 +257,8 @@ The recommended versions of the dependencies are listed in ``config/config_base.
257257
An alternative is to copy out the auto-downloaded repos under the ``<build_dir>/lib/ext``.
258258
They have been applied with patches and can be used directly.
259259

260-
Example: building TF-M with local Mbed Crypto repo
261-
--------------------------------------------------
260+
Example: building TF-M with local TF-PSA Crypto repo
261+
----------------------------------------------------
262262

263263
Preparing a local repository consists of 2 steps: cloning and patching.
264264
This is only required to be done once. For dependencies without ``.patch``
@@ -267,15 +267,15 @@ cloning the repo and checking out the correct branch.
267267

268268
.. code-block:: bash
269269
270-
cd <Mbed Crypto base folder>
271-
git clone https://github.com/ARMmbed/mbedtls
272-
cd mbedtls
273-
git checkout <MBEDCRYPTO_VERSION> from <TF-M source dir>/config/config_base.cmake>
274-
git apply <TF-M source dir>/lib/ext/mbedcrypto/*.patch
270+
cd <TF-PSA Crypto base folder>
271+
git clone https://github.com/Mbed-TLS/TF-PSA-Crypto
272+
cd TF-PSA-Crypto
273+
git checkout <TF_PSA_CRYPTO_VERSION> from <TF-M source dir>/config/config_base.cmake>
274+
git apply <TF-M source dir>/lib/ext/tf-psa-crypto/*.patch
275275
276276
.. Note::
277277

278-
``<Mbed Crypto base folder>`` does not need to have any fixed position related
278+
``<TF-PSA Crypto base folder>`` does not need to have any fixed position related
279279
to the TF-M repo so alternative method to get prepared dependency repos is to
280280
let TF-M download it once and then copy them out of the ``build/lib/ext`` folder.
281281

@@ -284,7 +284,7 @@ Now build TF-M binaries
284284
.. code-block:: bash
285285
286286
cd <TF-M source dir>
287-
cmake -S . -B build -DTFM_PLATFORM=arm/mps2/an521 -DMBEDCRYPTO_PATH=<Mbed Crypto base folder>/mbedtls
287+
cmake -S . -B build -DTFM_PLATFORM=arm/mps2/an521 -DTF_PSA_CRYPTO_PATH=<TF-PSA Crypto base folder>/tf-psa-crypto
288288
cmake --build build -- install
289289
290290
.. _Building NSPE:
@@ -314,6 +314,7 @@ will have the following structure:
314314
├── cmake
315315
├── config
316316
├── image_signing
317+
├── initial_attestation
317318
├── interface
318319
├── platform
319320
└── CMakeLists.txt
@@ -325,15 +326,16 @@ These folders have the following content:
325326
- **cmake** - CMake scripts like SPE configuration and :ref:`NSPE toolchains`.
326327
- **config** - Configuration files
327328
- **image_signing** - binary image signing tool and keys.
329+
- **initial_attestation** - attestation interface APIs.
328330
- **interface** - PSA interface exposed by SPE.
329331
- **platform** - source code for a selected hardware platform.
330332
- **CMakeLists.txt** - CMake script for the artifacts integration in NSPE.
331333

332334
The content of ``<Artifact Dir>`` is an exported directory for integration with CMake projects.
333335

334336
.. Note::
335-
Attempting to change any file in <Artifact Dir> may cause incompatibility issues.
336-
Instead, please change the corresponding file in the <TF-M source dir>.
337+
Attempting to change any file in ``<Artifact Dir>`` may cause incompatibility issues.
338+
Instead, please change the corresponding file in the ``<TF-M source dir>``.
337339

338340
.. _NSPE toolchains:
339341

0 commit comments

Comments
 (0)