Doc: Minor fixes across the documentation
This patch introduces a colection of minor issues:
* Fixed whitespace
* Fixed table formatting
* Fixed link references
* Updated version references in text
Change-Id: I1ff8ac4eec956467506f488df84c95fd4f3df7a0
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
diff --git a/docs/readme.rst b/docs/readme.rst
index ec1312c..8073e19 100644
--- a/docs/readme.rst
+++ b/docs/readme.rst
@@ -7,8 +7,6 @@
.. Note::
The software implementation contained in this project is designed to be a
reference implementation of the Platform Security Architecture (PSA).
- It currently does not implement all the features of that architecture,
- however we expect the code to evolve along with the specifications.
Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both
refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/glossary>` has the list
@@ -46,9 +44,9 @@
- A secure fw model with NS application example.
- Secure services running within this SPE:
- - Secure Storage Service (PSA Protected Storage API - 1.0-beta-2)
- - Attestation (PSA API 1.0-beta-0)
- - Crypto Service (PSA API 1.0-beta-1)
+ - Secure Storage Service (PSA Protected Storage API - 1.0.0)
+ - Attestation (PSA Attestation API 1.0.0)
+ - Crypto Service (PSA API 1.0-beta-3)
- TF-M Audit Log
- Platform Service
- Internal Trusted Storage (PSA API 1.0.0)
@@ -61,6 +59,7 @@
- Build system based on cmake, supporting armclang and GNU Arm.
- Support for integrated CryptoCell-312 cryptographic hardware accelerator
on Musca-B1 platform.
+ - Meets requirements for Updatable RoT for PSA Level 2 Certification
*********
Platforms
@@ -132,8 +131,8 @@
####################
Feedback and support
####################
-For this early access release, feedback is requested via email to
-`support-trustedfirmware-m@arm.com <support-trustedfirmware-m@arm.com>`__.
+For this release, feedback is requested via email to
+`tf-m@lists.trustedfirmware.org <tf-m@lists.trustedfirmware.org>`__.
###############
Version history
@@ -152,4 +151,4 @@
--------------
-*Copyright (c) 2017-2019, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
diff --git a/docs/user_guides/tfm_build_instruction.rst b/docs/user_guides/tfm_build_instruction.rst
index 27c0fe6..bb15f58 100644
--- a/docs/user_guides/tfm_build_instruction.rst
+++ b/docs/user_guides/tfm_build_instruction.rst
@@ -114,6 +114,7 @@
given in the PSA FF compliance tests README.
.. code-block:: bash
+
cd <TF-M base folder>
cd trusted-firmware-m
python tools/tfm_parse_manifest_list.py -m tools/tfm_psa_ff_test_manifest_list.yaml append
@@ -286,33 +287,34 @@
Follow :doc:`secure boot <./tfm_secure_boot>` to build the binaries with or
without BL2 bootloader.
+**************
Configurations
-==============
+**************
Configurations files under `configs` are TF-M provided configurations for building.
They are used by the `-DPROJ_CONFIG` argument for the build command line.
The following table describes the differences between the configurations:
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| Configuration | Model [1]_ | TF-M LVL [2]_ | Regression [3]_ | Core Test [4]_ | IPC Test [5]_ | PSA API Test [6]_ |
-+========================+============+===============+=================+================+===============+===================+
-| Default | Library | 1 | No | No | No | No |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| Regression | Library | 1 | Yes | Yes | No | No |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| CoreIPC | IPC | 1 | No | No | No | No |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| CoreIPCTfmLevel2 | IPC | 2 | No | No | No | No |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| RegressionIPC | IPC | 1 | Yes | Yes | Yes | No |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| RegressionIPCTfmLevel2 | IPC | 2 | Yes | Yes | Yes | No |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| PsaApiTest | Library | 1 | No | No | No | Yes |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| PsaApiTestIPC | IPC | 1 | No | No | No | Yes |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
-| PsaApiTestIPCTfmLevel2 | IPC | 2 | No | No | No | Yes |
-+------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| Configuration | Model [1]_ | TF-M LVL [2]_ | Regression [3]_ | Core Test [4]_ | IPC Test [5]_ | PSA API Test [6]_ | Comment |
++========================+============+===============+=================+================+===============+===================+=========================+
+| Default | Library | 1 | No | No | No | No | TF-M, no tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| Regression | Library | 1 | Yes | Yes | No | No | TF-M & Regression tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| CoreIPC | IPC | 1 | No | No | No | No | TF-M, no tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| CoreIPCTfmLevel2 | IPC | 2 | No | No | No | No | TF-M, no tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| RegressionIPC | IPC | 1 | Yes | Yes | Yes | No | TF-M & Regression tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| RegressionIPCTfmLevel2 | IPC | 2 | Yes | Yes | Yes | No | TF-M & Regression tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| PsaApiTest | Library | 1 | No | No | No | Yes | TF-M & PSA API tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| PsaApiTestIPC | IPC | 1 | No | No | No | Yes | TF-M & PSA API tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
+| PsaApiTestIPCTfmLevel2 | IPC | 2 | No | No | No | Yes | TF-M & PSA API tests |
++------------------------+------------+---------------+-----------------+----------------+---------------+-------------------+-------------------------+
.. [1] Which TF-M Model is set: `CORE_IPC`. If `CORE_IPC` is set to true then the model is IPC model, otherwise it's library model.
@@ -324,7 +326,7 @@
.. [5] Build IPC tests or not: `IPC_TEST`. It can be only enabled in IPC model
-.. [6] `Build for PSA API compliance tests`_ or not: `PSA_API_TEST`.
+.. [6] Build for PSA API compliance tests or not: `PSA_API_TEST`.
--------------
diff --git a/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst b/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst
index 693368a..912e3fe 100644
--- a/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst
+++ b/platform/ext/target/cypress/psoc64/cypress_psoc64_spec.rst
@@ -310,12 +310,12 @@
Running the sign.py script will result in creation of the following files:
-tfm_<s/ns>_signed.hex - signed image for programming
-tfm_<s/ns>_unsigned.hex - a copy of original unsigned hex file for reference
-tfm_<s/ns>_upgrade.hex - signed image for upgrade (if device policy specifies
- upgrade slot). Flashing this image into device will
- trigger the image update. Upgrade image from the
- secondary slot will be moved to the primary slot.
+* tfm_<s/ns>_signed.hex - signed image for programming
+* tfm_<s/ns>_unsigned.hex - a copy of original unsigned hex file for reference
+* tfm_<s/ns>_upgrade.hex - signed image for upgrade (if device policy
+ specifies upgrade slot). Flashing this image into device will
+ trigger the image update. Upgrade image from the
+ secondary slot will be moved to the primary slot.
**********************
Programming the Device
diff --git a/platform/ext/target/musca_b1/readme.rst b/platform/ext/target/musca_b1/readme.rst
index 212c28f..e81b96e 100644
--- a/platform/ext/target/musca_b1/readme.rst
+++ b/platform/ext/target/musca_b1/readme.rst
@@ -10,6 +10,11 @@
`Arm Community page <https://community.arm.com/developer/tools-software/oss-platforms/w/docs/425/musca-b1-firmware-update-qspi-boot-recovery>`__
A short description of how to update the DAPLink FW can be found there as well.
+.. Note::
+ Warm reset of eFlash is not supported on Musca_B1. TF-M may not boot after
+ a warm reset. Further information on the hardware limitation can be
+ found on `Arm Community page <https://community.arm.com/developer/tools-software/oss-platforms/w/docs/426/musca-b1-warm-reset-of-eflash>`__.
+
********************
Platform pin service
********************
@@ -22,4 +27,4 @@
--------------
-*Copyright (c) 2017-2019, Arm Limited. All rights reserved.*
+*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
diff --git a/platform/readme.rst b/platform/readme.rst
index f9d48a5..b3290d6 100644
--- a/platform/readme.rst
+++ b/platform/readme.rst
@@ -2,17 +2,12 @@
Details for the platform folder
###############################
-.. Warning::
-
- This folder and subfolders, especially the target folder, are likely to be
- refactored and updated to improve the overall structure of dependencies.
-
*********************
Interfacing with TF-M
*********************
-platformext/target/tfm_peripherals_def.h
-========================================
+platform/ext/target/tfm_peripherals_def.h
+=========================================
This file should enumerate the hardware peripherals that are available for TF-M
on the platform. The name of the peripheral used by a service is set in its
manifest file. The platform have to provide a macro for each of the provided