Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 1 | ################## |
| 2 | Trusted Firmware M |
| 3 | ################## |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 4 | |
Minos Galanakis | a8f9d10 | 2020-07-06 16:09:45 +0100 | [diff] [blame] | 5 | Trusted Firmware-M (TF-M) implements the Secure Processing Environment (SPE) |
| 6 | for Armv8-M, Armv8.1-M architectures (e.g. the `Cortex-M33`_, `Cortex-M23`_, |
Anton Komlev | 44b7b0a | 2022-05-19 15:52:44 +0100 | [diff] [blame] | 7 | `Cortex-M55`_, `Cortex-M85`_ processors) and dual-core platforms. |
| 8 | It is the platform security architecture reference implementation aligning with |
| 9 | PSA Certified guidelines, enabling chips, Real Time Operating Systems and |
| 10 | devices to become PSA Certified. |
Minos Galanakis | a8f9d10 | 2020-07-06 16:09:45 +0100 | [diff] [blame] | 11 | |
| 12 | TF-M relies on an isolation boundary between the Non-secure Processing |
| 13 | Environment (NSPE) and the Secure Processing Environment (SPE). It can but is |
| 14 | not limited to using the `Arm TrustZone technology`_ on Armv8-M and Armv8.1-M |
| 15 | architectures. In pre-Armv8-M architectures physical core isolation is required. |
| 16 | |
| 17 | **Trusted Firmware-M consists of:** |
| 18 | |
| 19 | - Secure Boot to authenticate integrity of NSPE and SPE images |
| 20 | - TF-M Core responsible for controlling the isolation, communication and |
| 21 | execution within SPE and with NSPE |
| 22 | - Crypto, Internal Trusted Storage (ITS), Protected Storage (PS) and |
| 23 | Attestation secure services |
| 24 | |
| 25 | .. figure:: readme_tfm_v8.png |
| 26 | :scale: 65 % |
| 27 | :align: center |
| 28 | |
Minos Galanakis | 01da63f | 2020-09-15 17:38:59 +0100 | [diff] [blame] | 29 | FF-M compliant design with TF-M |
Minos Galanakis | a8f9d10 | 2020-07-06 16:09:45 +0100 | [diff] [blame] | 30 | |
| 31 | Applications and Libraries in the Non-secure Processing Environment can |
| 32 | utilize these secure services with a standardized set of PSA Functional APIs. |
| 33 | Applications running on Cortex-M devices can leverage TF-M services to ensure |
| 34 | secure connection with edge gateways and IoT cloud services. It also protects |
| 35 | the critical security assets such as sensitive data, keys and certificates on |
| 36 | the platform. TF-M is supported on several Cortex-M based |
Anton Komlev | de14f45 | 2022-06-19 15:45:26 +0100 | [diff] [blame] | 37 | :doc:`Microcontrollers </platform/index>` and Real Time Operating |
Minos Galanakis | a8f9d10 | 2020-07-06 16:09:45 +0100 | [diff] [blame] | 38 | Systems (RTOS). |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 39 | |
| 40 | Terms ``TFM`` and ``TF-M`` are commonly used in documents and code and both |
Anton Komlev | 3356ba3 | 2022-03-31 22:02:11 +0100 | [diff] [blame] | 41 | refer to ``Trusted Firmware M.`` :doc:`Glossary </glossary>` has the list |
Summer Qin | abf6698 | 2021-04-06 17:22:15 +0800 | [diff] [blame] | 42 | of terms and abbreviations. |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 43 | |
| 44 | ####### |
| 45 | License |
| 46 | ####### |
Anton Komlev | 3356ba3 | 2022-03-31 22:02:11 +0100 | [diff] [blame] | 47 | The software is provided under a BSD-3-Clause :doc:`License </contributing/lic>`. |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 48 | Contributions to this project are accepted under the same license with developer |
Anton Komlev | 3356ba3 | 2022-03-31 22:02:11 +0100 | [diff] [blame] | 49 | sign-off as described in the :doc:`Contributing Guidelines </contributing/contributing_process>`. |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 50 | |
| 51 | This project contains code from other projects as listed below. The code from |
Ken Liu | fc75006 | 2020-05-09 15:16:20 +0800 | [diff] [blame] | 52 | external projects is limited to ``app``, ``bl2``, ``lib`` and ``platform`` |
| 53 | folders. The original license text is included in those source files. |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 54 | |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 55 | - The ``app`` folder contains files imported from CMSIS_5 project and the files |
| 56 | have Apache 2.0 license. |
| 57 | - The ``bl2`` folder contains files imported from MCUBoot project and the files |
| 58 | have Apache 2.0 license. |
Ken Liu | fc75006 | 2020-05-09 15:16:20 +0800 | [diff] [blame] | 59 | - The ``lib`` folder may contain 3rd party files with diverse licenses. |
| 60 | - The ``platform`` folder currently contains platforms support imported from |
| 61 | the external project and the files may have different licenses. |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 62 | |
Anton Komlev | de14f45 | 2022-06-19 15:45:26 +0100 | [diff] [blame] | 63 | .. include:: /platform/platform_introduction.rst |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 64 | |
Anton Komlev | de14f45 | 2022-06-19 15:45:26 +0100 | [diff] [blame] | 65 | The document :doc:`Supported Platforms </platform/index>` lists the details. |
Mark Horvath | 9a5a9b9 | 2019-11-29 15:57:55 +0100 | [diff] [blame] | 66 | |
Summer Qin | a1f6896 | 2021-04-08 16:31:27 +0800 | [diff] [blame] | 67 | ######################### |
| 68 | Release Notes and Process |
| 69 | ######################### |
Anton Komlev | 3356ba3 | 2022-03-31 22:02:11 +0100 | [diff] [blame] | 70 | The :doc:`Release Cadence and Process </releases/release_process>` provides |
Summer Qin | a1f6896 | 2021-04-08 16:31:27 +0800 | [diff] [blame] | 71 | release cadence and process information. |
Mark Horvath | 9a5a9b9 | 2019-11-29 15:57:55 +0100 | [diff] [blame] | 72 | |
Anton Komlev | 3356ba3 | 2022-03-31 22:02:11 +0100 | [diff] [blame] | 73 | The :doc:`Releases </releases/index>` provides details of |
Summer Qin | a1f6896 | 2021-04-08 16:31:27 +0800 | [diff] [blame] | 74 | major features of the release and platforms supported. |
Soby Mathew | 175efe1 | 2020-07-03 14:33:11 +0100 | [diff] [blame] | 75 | |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 76 | #################### |
Anton Komlev | 91281f0 | 2022-04-22 09:24:20 +0100 | [diff] [blame] | 77 | Feedback and Support |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 78 | #################### |
Minos Galanakis | fc6804e | 2020-03-10 11:03:34 +0000 | [diff] [blame] | 79 | For this release, feedback is requested via email to |
| 80 | `tf-m@lists.trustedfirmware.org <tf-m@lists.trustedfirmware.org>`__. |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 81 | |
Anton Komlev | fb83540 | 2022-08-09 13:04:04 +0100 | [diff] [blame^] | 82 | A bi-weekly technical forum is available for discussion on any technical topics |
| 83 | online. Welcome to join `TF-M Forum <https://www.trustedfirmware.org/meetings/tf-m-technical-forum>`__. |
| 84 | |
Anton Komlev | 44b7b0a | 2022-05-19 15:52:44 +0100 | [diff] [blame] | 85 | .. _Cortex-M33: https://developer.arm.com/Processors/Cortex-M33 |
| 86 | .. _Cortex-M23: https://developer.arm.com/Processors/Cortex-M23 |
| 87 | .. _Cortex-M55: https://developer.arm.com/Processors/Cortex-M55 |
| 88 | .. _Cortex-M85: https://developer.arm.com/Processors/Cortex-M85 |
Minos Galanakis | a8f9d10 | 2020-07-06 16:09:45 +0100 | [diff] [blame] | 89 | .. _PSA Certified: https://www.psacertified.org/about/developing-psa-certified/ |
| 90 | .. _Arm TrustZone technology: https://developer.arm.com/ip-products/security-ip/trustzone/trustzone-for-cortex-m |
| 91 | |
Galanakis, Minos | 6ccf7ec | 2019-11-07 15:15:05 +0000 | [diff] [blame] | 92 | -------------- |
| 93 | |
Anton Komlev | fb83540 | 2022-08-09 13:04:04 +0100 | [diff] [blame^] | 94 | *Copyright (c) 2017-2022, Arm Limited. All rights reserved.* |