From 0014ec9f33258fba22289b2f3c04140a092d246e Mon Sep 17 00:00:00 2001 From: Erwan Gouriou Date: Thu, 14 Mar 2024 16:51:56 +0100 Subject: [PATCH] boards: st: tfm: Update board documentation regression.sh path is now tfm/api_ns/regression.sh, reflect it in the doc. Remove duplicate TF-M material. Signed-off-by: Erwan Gouriou --- boards/st/b_u585i_iot02a/doc/index.rst | 32 ++--------------- .../st/nucleo_l552ze_q/doc/nucleol552ze_q.rst | 34 ++----------------- boards/st/stm32l562e_dk/doc/index.rst | 34 ++----------------- samples/tfm_integration/tfm_ipc/README.rst | 4 +-- 4 files changed, 8 insertions(+), 96 deletions(-) diff --git a/boards/st/b_u585i_iot02a/doc/index.rst b/boards/st/b_u585i_iot02a/doc/index.rst index 2d9b782c90..166d2ac390 100644 --- a/boards/st/b_u585i_iot02a/doc/index.rst +++ b/boards/st/b_u585i_iot02a/doc/index.rst @@ -230,11 +230,11 @@ option bit TZEN will be set). .. code-block:: bash - $ ./build/tfm/regression.sh + $ ./build/tfm/api_ns/regression.sh $ west flash Please note that, after having run a TFM sample on the board, you will need to -run `./build/tfm/regression.sh` once more to clean up the board from secure +run `./build/tfm/api_ns/regression.sh` once more to clean up the board from secure options and get back the platform back to a "normal" state and be able to run usual, non-TFM, binaries. Also note that, even then, TZEN will remain set, and you will need to use @@ -335,34 +335,6 @@ Here is an example for the :zephyr:code-sample:`blinky` application. :board: b_u585i_iot02a :goals: debug -Building a secure/non-secure with Arm |reg| TrustZone |reg| -=========================================================== - -The TF-M applications can be run on this board, thanks to its Arm |reg| TrustZone |reg| -support. -In TF-M configuration, Zephyr is run on the non-secure domain. A non-secure image -can be generated using ``b_u585i_iot02a/stm32u585xx/ns`` as build target. - -.. code-block:: bash - - $ west build -b b_u585i_iot02a/stm32u585xx/ns path/to/source/directory - -Note: When building the ``*_ns`` image with TF-M, ``build/tfm/api_ns/postbuild.sh`` bash script -is run automatically in a post-build step to make some required flash layout changes. - -Once the build is completed, run the following script to initialize the option bytes. - -.. code-block:: bash - - $ build/tfm/api_ns/regression.sh - -Finally, to flash the board, run: - -.. code-block:: bash - - $ west flash - - Disabling TrustZone |reg| on the board ====================================== diff --git a/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst b/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst index d4b8f59967..f084852c7a 100644 --- a/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst +++ b/boards/st/nucleo_l552ze_q/doc/nucleol552ze_q.rst @@ -209,11 +209,11 @@ option bit TZEN will be set). .. code-block:: bash - $ ./build/tfm/regression.sh + $ ./build/tfm/api_ns/regression.sh $ west flash Please note that, after having run a TFM sample on the board, you will need to -run `./build/tfm/regression.sh` once more to clean up the board from secure +run `./build/tfm/api_ns/regression.sh` once more to clean up the board from secure options and get back the platform back to a "normal" state and be able to run usual, non-TFM, binaries. Also note that, even then, TZEN will remain set, and you will need to use @@ -327,36 +327,6 @@ You should see the following message on the console: Hello World! arm -Building a secure/non-secure with Arm |reg| TrustZone |reg| ------------------------------------------------------------ - -The TF-M integration sample :ref:`tfm_ipc` can be run on a ST Nucleo L552ZE Q. -In TF-M configuration, Zephyr is run on the non-secure domain. A non-secure image -can be generated using ``nucleo_l552ze_q/stm32l552xx/ns`` as build target. - -.. code-block:: bash - - $ west build -b nucleo_l552ze_q/stm32l552xx/ns path/to/source/directory - -Note: When building the ``*_ns`` image with TF-M, ``build/tfm/api_ns/postbuild.sh`` bash script -is run automatically in a post-build step to make some required flash layout changes. - -Once the build is completed, run the following script to initialize the option bytes. - -.. code-block:: bash - - $ build/tfm/regression.sh - -Finally, to flash the board, run: - -.. code-block:: bash - - $ west flash - -Note: Check the ``build/tfm`` directory to ensure that the commands required by these scripts -(``readlink``, etc.) are available on your system. Please also check ``STM32_Programmer_CLI`` -(which is used for initialization) is available in the PATH. - Debugging ========= diff --git a/boards/st/stm32l562e_dk/doc/index.rst b/boards/st/stm32l562e_dk/doc/index.rst index 889f0b8d59..370526ac14 100644 --- a/boards/st/stm32l562e_dk/doc/index.rst +++ b/boards/st/stm32l562e_dk/doc/index.rst @@ -235,11 +235,11 @@ option bit TZEN will be set). .. code-block:: bash - $ ./build/tfm/regression.sh + $ ./build/tfm/api_ns/regression.sh $ west flash Please note that, after having run a TFM sample on the board, you will need to -run `./build/tfm/regression.sh` once more to clean up the board from secure +run `./build/tfm/api_ns/regression.sh` once more to clean up the board from secure options and get back the platform back to a "normal" state and be able to run usual, non-TFM, binaries. Also note that, even then, TZEN will remain set, and you will need to use @@ -329,36 +329,6 @@ You should see the following message on the console: Hello World! stm32l562e_dk -Building Secure/Non-Secure Zephyr applications with Arm |reg| TrustZone |reg| ------------------------------------------------------------------------------ - -The TF-M integration sample :ref:`tfm_ipc` can be run on a ST STM32L562E-DK Discovery. -In TF-M configuration, Zephyr is run on the non-secure domain. A non-secure image -can be generated using ``stm32l562e_dk/stm32l562xx/ns`` as build target. - -.. code-block:: bash - - $ west build -b stm32l562e_dk/stm32l562xx/ns path/to/source/directory - -Note: When building the ``*_ns`` image with TF-M, ``build/tfm/api_ns/postbuild.sh`` bash script -is run automatically in a post-build step to make some required flash layout changes. - -Once the build is completed, run the following script to initialize the option bytes. - -.. code-block:: bash - - $ build/tfm/regression.sh - -Finally, to flash the board, run: - -.. code-block:: bash - - $ west flash --hex-file build/tfm_merged.hex - -Note: Check the ``build/tfm`` directory to ensure that the commands required by these scripts -(``readlink``, etc.) are available on your system. Please also check ``STM32_Programmer_CLI`` -(which is used for initialization) is available in the PATH. - Debugging ========= diff --git a/samples/tfm_integration/tfm_ipc/README.rst b/samples/tfm_integration/tfm_ipc/README.rst index 839f5f9952..64d82de3fd 100644 --- a/samples/tfm_integration/tfm_ipc/README.rst +++ b/samples/tfm_integration/tfm_ipc/README.rst @@ -124,7 +124,7 @@ Build Zephyr with a non-secure configuration: .. code-block:: bash - $ west build -b stm32l562e_dk_ns samples/tfm_integration/tfm_ipc/ + $ west build -b stm32l562e_dk/stm32l562xx/ns samples/tfm_integration/tfm_ipc/ The script to initialize the device is available in the ``build/tfm`` folder: @@ -134,7 +134,7 @@ Run them in the following order to flash the board: .. code-block:: bash - $ ./build/tfm/regression.sh + $ ./build/tfm/api_ns/regression.sh $ west flash .. note::