blob: 95109a249cec25ee32b062b2069753a265b00317 [file] [log] [blame]
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +00001##################
2Trusted Firmware M
3##################
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +00004
Minos Galanakisa8f9d102020-07-06 16:09:45 +01005Trusted Firmware-M (TF-M) implements the Secure Processing Environment (SPE)
6for Armv8-M, Armv8.1-M architectures (e.g. the `Cortex-M33`_, `Cortex-M23`_,
Summer Qina1f68962021-04-08 16:31:27 +08007`Cortex-M55`_ processors) and dual-core platforms. It is the platform security
8architecture reference implementation aligning with PSA Certified guidelines,
9enabling chips, Real Time Operating Systems and devices to become PSA Certified.
Minos Galanakisa8f9d102020-07-06 16:09:45 +010010
11TF-M relies on an isolation boundary between the Non-secure Processing
12Environment (NSPE) and the Secure Processing Environment (SPE). It can but is
13not limited to using the `Arm TrustZone technology`_ on Armv8-M and Armv8.1-M
14architectures. In pre-Armv8-M architectures physical core isolation is required.
15
16**Trusted Firmware-M consists of:**
17
18- Secure Boot to authenticate integrity of NSPE and SPE images
19- TF-M Core responsible for controlling the isolation, communication and
20 execution within SPE and with NSPE
21- Crypto, Internal Trusted Storage (ITS), Protected Storage (PS) and
22 Attestation secure services
23
24.. figure:: readme_tfm_v8.png
25 :scale: 65 %
26 :align: center
27
Minos Galanakis01da63f2020-09-15 17:38:59 +010028 FF-M compliant design with TF-M
Minos Galanakisa8f9d102020-07-06 16:09:45 +010029
30Applications and Libraries in the Non-secure Processing Environment can
31utilize these secure services with a standardized set of PSA Functional APIs.
32Applications running on Cortex-M devices can leverage TF-M services to ensure
33secure connection with edge gateways and IoT cloud services. It also protects
34the critical security assets such as sensitive data, keys and certificates on
35the platform. TF-M is supported on several Cortex-M based
36:doc:`Microcontrollers </platform/ext/index>` and Real Time Operating
37Systems (RTOS).
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000038
39Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both
Anton Komlev3356ba32022-03-31 22:02:11 +010040refer to ``Trusted Firmware M.`` :doc:`Glossary </glossary>` has the list
Summer Qinabf66982021-04-06 17:22:15 +080041of terms and abbreviations.
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000042
43#######
44License
45#######
Anton Komlev3356ba32022-03-31 22:02:11 +010046The software is provided under a BSD-3-Clause :doc:`License </contributing/lic>`.
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000047Contributions to this project are accepted under the same license with developer
Anton Komlev3356ba32022-03-31 22:02:11 +010048sign-off as described in the :doc:`Contributing Guidelines </contributing/contributing_process>`.
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000049
50This project contains code from other projects as listed below. The code from
Ken Liufc750062020-05-09 15:16:20 +080051external projects is limited to ``app``, ``bl2``, ``lib`` and ``platform``
52folders. The original license text is included in those source files.
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000053
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000054- The ``app`` folder contains files imported from CMSIS_5 project and the files
55 have Apache 2.0 license.
56- The ``bl2`` folder contains files imported from MCUBoot project and the files
57 have Apache 2.0 license.
Ken Liufc750062020-05-09 15:16:20 +080058- The ``lib`` folder may contain 3rd party files with diverse licenses.
59- The ``platform`` folder currently contains platforms support imported from
60 the external project and the files may have different licenses.
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000061
Anton Komlev91281f02022-04-22 09:24:20 +010062.. include:: /platform/ext/platform_introduction.rst
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000063
Summer Qina1f68962021-04-08 16:31:27 +080064The document :doc:`Supported Platforms </platform/ext/index>` lists the details.
Mark Horvath9a5a9b92019-11-29 15:57:55 +010065
Summer Qina1f68962021-04-08 16:31:27 +080066#########################
67Release Notes and Process
68#########################
Anton Komlev3356ba32022-03-31 22:02:11 +010069The :doc:`Release Cadence and Process </releases/release_process>` provides
Summer Qina1f68962021-04-08 16:31:27 +080070release cadence and process information.
Mark Horvath9a5a9b92019-11-29 15:57:55 +010071
Anton Komlev3356ba32022-03-31 22:02:11 +010072The :doc:`Releases </releases/index>` provides details of
Summer Qina1f68962021-04-08 16:31:27 +080073major features of the release and platforms supported.
Soby Mathew175efe12020-07-03 14:33:11 +010074
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000075####################
Anton Komlev91281f02022-04-22 09:24:20 +010076Feedback and Support
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000077####################
Minos Galanakisfc6804e2020-03-10 11:03:34 +000078For this release, feedback is requested via email to
79`tf-m@lists.trustedfirmware.org <tf-m@lists.trustedfirmware.org>`__.
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000080
Minos Galanakisa8f9d102020-07-06 16:09:45 +010081.. _Cortex-M33: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m33
82.. _Cortex-M23: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m23
83.. _Cortex-M55: https://developer.arm.com/ip-products/processors/cortex-m/cortex-m55
84.. _PSA Certified: https://www.psacertified.org/about/developing-psa-certified/
85.. _Arm TrustZone technology: https://developer.arm.com/ip-products/security-ip/trustzone/trustzone-for-cortex-m
86
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000087--------------
88
Hugo L'Hostiscd94d472021-01-27 12:03:21 +000089*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*