aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinos Galanakis <minos.galanakis@arm.com>2020-07-06 16:09:45 +0100
committerMinos Galanakis <minos.galanakis@arm.com>2020-07-08 12:30:42 +0000
commita8f9d10c6738a9f8d02814d6489748e9c520f1c9 (patch)
tree3c28c58104bf46b11c2c8135e4089ba0dc51c550
parent14d75296c6b9bbb212d177f23013d01a4d6f9120 (diff)
downloadtrusted-firmware-m-a8f9d10c6738a9f8d02814d6489748e9c520f1c9.tar.gz
Docs: Updated introductory readme document
This patch updates the introduction readme with information about TF-M the PSA Certified process and adds external links. Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Change-Id: I28ad40ce89e3a9841b6c60cecf40c6ce78fa94fd
-rw-r--r--docs/introduction/readme.rst53
-rwxr-xr-xdocs/introduction/readme_tfm_v8.pngbin0 -> 129886 bytes
2 files changed, 44 insertions, 9 deletions
diff --git a/docs/introduction/readme.rst b/docs/introduction/readme.rst
index bc30e411b..00fc78060 100644
--- a/docs/introduction/readme.rst
+++ b/docs/introduction/readme.rst
@@ -1,16 +1,45 @@
##################
Trusted Firmware M
##################
-Trusted Firmware M provides a reference implementation of secure world software
-for Arm M-profile architecture.
-.. Note::
- The software implementation contained in this project is designed to be a
- reference implementation of the Platform Security Architecture (PSA).
+Trusted Firmware-M (TF-M) implements the Secure Processing Environment (SPE)
+for Armv8-M, Armv8.1-M architectures (e.g. the `Cortex-M33`_, `Cortex-M23`_,
+`Cortex-M55`_ processors) or dual-core platforms.
+It is the Platform Security Architecture (PSA) reference implementation
+aligning with `PSA Certified`_ guidelines, enabling chips,
+Real Time Operating Systems and devices to become PSA Certified.
+
+TF-M relies on an isolation boundary between the Non-secure Processing
+Environment (NSPE) and the Secure Processing Environment (SPE). It can but is
+not limited to using the `Arm TrustZone technology`_ on Armv8-M and Armv8.1-M
+architectures. In pre-Armv8-M architectures physical core isolation is required.
+
+**Trusted Firmware-M consists of:**
+
+- Secure Boot to authenticate integrity of NSPE and SPE images
+- TF-M Core responsible for controlling the isolation, communication and
+ execution within SPE and with NSPE
+- Crypto, Internal Trusted Storage (ITS), Protected Storage (PS) and
+ Attestation secure services
+
+.. figure:: readme_tfm_v8.png
+ :scale: 65 %
+ :align: center
+
+ PSA FF compiant design with TF-M
+
+Applications and Libraries in the Non-secure Processing Environment can
+utilize these secure services with a standardized set of PSA Functional APIs.
+Applications running on Cortex-M devices can leverage TF-M services to ensure
+secure connection with edge gateways and IoT cloud services. It also protects
+the critical security assets such as sensitive data, keys and certificates on
+the platform. TF-M is supported on several Cortex-M based
+:doc:`Microcontrollers </platform/ext/index>` and Real Time Operating
+Systems (RTOS).
Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both
-refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/reference/glossary>` has the list
-of terms and abbreviations.
+refer to ``Trusted Firmware M.`` :doc:`Glossary </docs/reference/glossary>`
+has the list of terms and abbreviations.
#######
License
@@ -112,7 +141,7 @@ Platforms supported
<https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/mps3>`_
- `Arm DesignStart FPGA on AWS Cloud.
<https://developer.arm.com/docs/101965/0102/arm-designstart-fpga-on-cloud-arm-ds-getting-started>`_
- - `NXP LPC55S69.
+ - `LPC55S69.
<https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc5500-cortex-m33/lpcxpresso55s69-development-board:LPC55S69-EVK>`_
- `NUCLEO L552ZE Q.
<https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-nucleo-boards/nucleo-l552ze-q.html>`_
@@ -126,7 +155,7 @@ Platforms supported
- Dual Core Cortex-M system:
- - `Cypress PSoc64.
+ - `PSoc64.
<https://www.cypress.com/documentation/product-brochures/cypress-psoc-64-secure-microcontrollers>`_
####################
@@ -152,6 +181,12 @@ Version history
| v1.0 | 2020-03-27 | 1.0 release | v20.03_API1.0 |
+-------------+--------------+--------------------+---------------+
+.. _Cortex-M33: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m33
+.. _Cortex-M23: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m23
+.. _Cortex-M55: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m55
+.. _PSA Certified: https://www.psacertified.org/about/developing-psa-certified/
+.. _Arm TrustZone technology: https://developer.arm.com/ip-products/security-ip/trustzone/trustzone-for-cortex-m
+
--------------
*Copyright (c) 2017-2020, Arm Limited. All rights reserved.*
diff --git a/docs/introduction/readme_tfm_v8.png b/docs/introduction/readme_tfm_v8.png
new file mode 100755
index 000000000..0601b0eb2
--- /dev/null
+++ b/docs/introduction/readme_tfm_v8.png
Binary files differ