M2354: Refine TF-M/Mbed integration readme

ARMmbed · May 26, 2021 · 98f5a99 · 98f5a99
1 parent 9fee7d9
commit 98f5a99
Showing 1 changed file with 94 additions and 38 deletions.
diff --git a/...ET_NUVOTON/TARGET_M2354/TARGET_TFM/TARGET_NU_M2354/COMPONENT_TFM_S_FW/README.md b/...ET_NUVOTON/TARGET_M2354/TARGET_TFM/TARGET_NU_M2354/COMPONENT_TFM_S_FW/README.md
@@ -1,40 +1,27 @@
-# TF-M exported stuff for Mbed integration
+# Rebuild TF-M and integrate with Mbed on M2354
 
-This directory contains TF-M exported stuff to integrate with Mbed.
+This document guides how to rebuild TF-M and integrate with Mbed on M2354.
 
-## TF-M exported stuff
+### Downloading TF-M source
 
--   bl2.bin: [MCUboot](https://github.com/mcu-tools/mcuboot) bootloader binary
-
--   tfm_s.bin: TF-M secure binary
-
--   s_veneers.o: TF-M secure gateway library
-
--   partition/: Flash layout for image signing and concatenating in post-build process
-
-    **NOTE**: On import, `signing_layout_s_ns.o` is renamed to `signing_layout_preprocessed.h` for the following reasons:
-    -   Post-build script checks file name with `_s`/`_ns` to resolve `sw_type` as `SPE`/`NSPE` respectively.
-        To recognize as `NSPE_SPE`, don't use `_s_ns`/`_ns_s` file name to avoid mis-recognized.
-    -   Use `.h` instead of `.c` as file extension name.
-        This is to enable custom TF-M build where the locatioin of this directory can change elsewhere.
-        In Greentea build process, `.c` file isn't but`.h` file is copied into `BUILD` directory, so that post-build script can still access the file.
-
--   [signing_key/](signing_key/nuvoton_m2354-root-rsa-3072.md)
+The M2354 port in TF-M must patch to enable TF-M integration with Mbed.
+For TF-M 1.2/Mbed integration on M2354, the [mainstream TF-M](https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git) is patched as follows:
+-   Apply Mbed-enabled patch to `nuvoton/m2354` TF-M target.
+-   Backport to base on [ARMmbed TF-M mbed-tfm-1.2](https://github.com/ARMmbed/trusted-firmware-m/tree/mbed-tfm-1.2).
 
-### Copy path summary
+Run the following command to fetch and switch to the intended version:
+```sh
+git clone https://github.com/OpenNuvoton/trusted-firmware-m -b nuvoton_mbed_m2354_tfm-1.2
+```
 
-This section summarizes the copy paths from TF-M to Mbed.
+## Customizing TF-M
 
--   trusted-firmware-m/cmake_build/bin/bl2.bin → bl2.bin
--   trusted-firmware-m/cmake_build/install/export/tfm/lib/s_veneers.o → s_veneers.o
--   trusted-firmware-m/cmake_build/bin/tfm_s.bin → tfm_s.bin
--   trusted-firmware-m/platform/ext/target/nuvoton/m2354/partition/flash_layout.h → partition/flash_layout.h
--   trusted-firmware-m/cmake_build/bl2/ext/mcuboot/CMakeFiles/signing_layout_s.dir/signing_layout_s_ns.o → partition/signing_layout_preprocessed.h
--   trusted-firmware-m/bl2/ext/mcuboot/root-RSA-3072.pem → signing_key/nuvoton_m2354-root-rsa-3072.pem
+TF-M is out of scope of Mbed.
+We only provide limited support for customizing M2354 port in TF-M.
 
-## Partitioning the hardware
+### Default hardware partition
 
-In TF-M, the hardware is partitioned as follows:
+In TF-M, by default, the M2354 hardware is partitioned as follows:
 
 - Flash (1024KiB in total): 448KiB for secure and 576KiB for nonsecure.
 - SRAM (256KiB in total): 80KiB for secure and 176KiB for nonsecure.
@@ -49,18 +36,54 @@ In TF-M, the hardware is partitioned as follows:
     - **PDMA0**: Hardwired to secure. Inaccessible to Mbed.
     - **PDMA1**: Configured to nonsecure for Mbed asynchronous transfer.
     - **CRYPTO**: Configured to secure. Inaccessible to Mbed.
-    - **TRNG**: Hardwired to secure. Accessible to Mbed through secure gateway.
+    - **TRNG**: Hardwired to secure. Accessible to Mbed indirectly through PSA Cryptography API.
 
-## Building TF-M
+### Defining Flash for TF-M/Mbed
 
-For Mbed/TF-M 1.2 integration, the mainstream TF-M is patched as follows:
--   Apply Mbed-enabled patch to `nuvoton/m2354` TF-M target.
--   Backport to base on [ARMmbed TF-M mbed-tfm-1.2](https://github.com/ARMmbed/trusted-firmware-m/tree/mbed-tfm-1.2).
+To define memory spec of Flash for TF-M/Mbed, search/change the line:
+
+**trusted-firmware-m/platform/ext/target/nuvoton/m2354/partition/flash_layout.h**:
+```C
+/* Max Flash size for TF-M + bootloader information */
+#define FLASH_S_PARTITION_SIZE          (0x50000)
+/* Max Flash size for Mbed + bootloader information */
+#define FLASH_NS_PARTITION_SIZE         (0x90000)
+```
+
+M2354 has 1024KiB Flash in total, among which 128KiB have been allocated for bootloader code and ITS/PS storage.
+896KiB are left for `FLASH_S_PARTITION_SIZE` and `FLASH_NS_PARTITION_SIZE`.
+
+**NOTE**: `FLASH_S_PARTITION_SIZE` and `FLASH_NS_PARTITION_SIZE` must be sector size (2KiB)-aligned.
+
+### Defining SRAM for TF-M/Mbed
+
+To define memory spec of SRAM for TF-M/Mbed, search/change the line:
+
+**trusted-firmware-m/platform/ext/target/nuvoton/m2354/partition/region_defs.h**:
+```C
+/* Max SRAM size for TF-M */
+#define S_DATA_SIZE     (80 * 1024)
+/* Max SRAM size for Mbed = Total - Max SRAM size for TF-M */
+#define NS_DATA_SIZE    (TOTAL_RAM_SIZE - S_DATA_SIZE)
+```
+
+**NOTE**: `S_DATA_SIZE` and `NS_DATA_SIZE` must be 16KiB-aligned required by M2354 Security Configuration Unit (SCU).
+
+## Rebuilding TF-M
+
+### Environment
+
+Navigate [TF-M](https://www.trustedfirmware.org/projects/tf-m/).
+Then go through **DOCS** → **Getting Started Guides** → **Software requirements** for TF-M build environment setup.
 
-To re-build TF-M, run:
+**NOTE**: For unknown reason, **GNU Arm Embedded Toolchain 10-2020-q4-major** built code **FAILS** to run. Avoid this toolchain version.
+
+### Compile
+
+To compile TF-M on M2354, run:
 
 ```sh
-$ cmake -S . \
+cmake -S . \
 -B cmake_build \
 -DTFM_PLATFORM=nuvoton/m2354 \
 -DTFM_TOOLCHAIN_FILE=toolchain_GNUARM.cmake \
@@ -69,8 +92,41 @@ $ cmake -S . \
 -G"Unix Makefiles"
 ```
 
+Then:
+
 ```sh
-$ cmake --build cmake_build -- install
+cmake --build cmake_build -- install
 ```
 
-**NOTE**: This patch has not been public yet.
+## Integrating with Mbed
+
+### Updating TF-M exported stuff
+
+The following TF-M exported stuffs must update into Mbed:
+
+-   bl2.bin: [MCUboot](https://github.com/mcu-tools/mcuboot) bootloader binary
+
+-   tfm_s.bin: TF-M secure binary
+
+-   s_veneers.o: TF-M secure gateway library
+
+-   partition/: Flash layout for image signing and concatenating in post-build process
+
+    **NOTE**: On import, `signing_layout_s_ns.o` is renamed to `signing_layout_preprocessed.h` for the following reasons:
+    -   Post-build script checks file name with `_s`/`_ns` to resolve `sw_type` as `SPE`/`NSPE` respectively.
+        To recognize as `NSPE_SPE`, don't use `_s_ns`/`_ns_s` file name to avoid mis-recognized.
+    -   Use `.h` instead of `.c` as file extension name.
+        This is to enable custom TF-M build where the locatioin of this directory can change elsewhere.
+        In Greentea build process, `.c` file isn't but`.h` file is copied into `BUILD` directory, so that post-build script can still access the file.
+
+-   [signing_key/](signing_key/nuvoton_m2354-root-rsa-3072.md)
+
+Below summarizes the copy paths from TF-M into Mbed:
+
+-   trusted-firmware-m/cmake_build/bin/bl2.bin → bl2.bin
+-   trusted-firmware-m/cmake_build/install/export/tfm/lib/s_veneers.o → s_veneers.o
+-   trusted-firmware-m/cmake_build/bin/tfm_s.bin → tfm_s.bin
+-   trusted-firmware-m/platform/ext/target/nuvoton/m2354/partition/flash_layout.h → partition/flash_layout.h
+-   trusted-firmware-m/platform/ext/target/nuvoton/m2354/partition/region_defs.h → partition/region_defs.h
+-   trusted-firmware-m/cmake_build/bl2/ext/mcuboot/CMakeFiles/signing_layout_s.dir/signing_layout_s_ns.o → partition/signing_layout_preprocessed.h
+-   trusted-firmware-m/bl2/ext/mcuboot/root-RSA-3072.pem → signing_key/nuvoton_m2354-root-rsa-3072.pem