blob: 3b3b6f22120ba145c6ab7f299a1abb651643fc43 [file] [log] [blame]
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +00001##################
2Trusted Firmware-M
3##################
Antonio de Angelisea8ebc92025-02-13 11:05:20 +00004
5.. image:: https://scan.coverity.com/projects/22164/badge.svg
6 :alt: Coverity Scan Build Status
7 :target: https://scan.coverity.com/projects/trusted-firmware-m-35b064f0-65c2-4afb-9ba9-24aa432fb7fa
8
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +00009The Trusted Firmware-M software implementation contained in this project is
10designed to be a reference implementation of the
11`Platform Security Architecture`_ (PSA) for `ARMv7-M and Armv8-M`_.
12
13###########
14Quick Links
15###########
Gyorgy Szingdb9783c2019-04-17 21:08:48 +020016
17.. Note::
Antonio de Angelise9c7d222023-09-11 17:17:55 +010018 This git contains the source code for Trusted Firmware-M. It is primarily
19 hosted at `git.trustedfirmware.org`_ with a read-only mirror available on
20 `GitHub`_.
Gyorgy Szingdb9783c2019-04-17 21:08:48 +020021
Anton Komleve74e2d92025-07-18 10:31:50 +010022 All official documentation is available in the `Trusted Firmware-M documentation`_
Gyorgy Szingdb9783c2019-04-17 21:08:48 +020023
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000024* `ARMv7-M and Armv8-M`_
25* `ARMv8-M Architecture`_
26* `Platform Security Architecture`_
27* `PSA certified`_
28* `Documentation home`_
Soby Mathewd8efe8f2020-03-16 15:19:05 +000029* `Release notes`_
Summer Qin6d5c91c2021-05-24 15:32:44 +080030* `TF-M getting started`_
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000031* `Build instructions`_
Summer Qin0de91c92021-06-17 16:30:18 +080032* `Run TF-M examples on Arm platforms`_
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000033* `Contribution guidelines`_
34* `trustedfirmware.org`_
Gyorgy Szingdb9783c2019-04-17 21:08:48 +020035
36####################
37Feedback and support
38####################
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000039Feedback can be submitted via email to
Kevin Pengb29d5f92020-06-11 11:03:11 +080040`TF-M mailing list <tf-m@lists.trustedfirmware.org>`__.
Gyorgy Szingdb9783c2019-04-17 21:08:48 +020041
Anton Komleve74e2d92025-07-18 10:31:50 +010042.. _License: https://trustedfirmware-m.readthedocs.io/en/latest/contributing/lic.html
43.. _Contribution guidelines: https://trustedfirmware-m.readthedocs.io/en/latest/contributing/contributing_process.html
44.. _Build instructions: https://trustedfirmware-m.readthedocs.io/en/latest/building/tfm_build_instruction.html
45.. _TF-M getting started: https://trustedfirmware-m.readthedocs.io/en/latest/getting_started/tfm_getting_started.html
46.. _Run TF-M examples on Arm platforms: https://trustedfirmware-m.readthedocs.io/en/latest/building/run_tfm_examples_on_arm_platforms.html
Galanakis, Minos6ccf7ec2019-11-07 15:15:05 +000047.. _ARMv7-M and Armv8-M: https://developer.arm.com/architectures/cpu-architecture/m-profile
48.. _ARMv8-M Architecture: https://developer.arm.com/docs/100688/latest/an-introduction-to-the-armv8-m-architecture
49.. _Platform Security Architecture: https://www.arm.com/why-arm/architecture/platform-security-architecture
50.. _PSA certified: https://www.psacertified.org/
Galanakis, Minosdc6694b2020-01-06 13:54:56 +000051.. _Trusted Firmware-M documentation: `Documentation home`_
Anton Komleve74e2d92025-07-18 10:31:50 +010052.. _Documentation home: https://trustedfirmware-m.readthedocs.io/en/latest/index.html
Antonio de Angelise9c7d222023-09-11 17:17:55 +010053.. _trustedfirmware.org: https://www.trustedfirmware.org
Anton Komleve74e2d92025-07-18 10:31:50 +010054.. _Release notes: https://trustedfirmware-m.readthedocs.io/en/latest/releases/index.html
Antonio de Angelise9c7d222023-09-11 17:17:55 +010055.. _git.trustedfirmware.org: https://git.trustedfirmware.org/
56.. _GitHub: https://github.com/TrustedFirmware-M
Gyorgy Szingdb9783c2019-04-17 21:08:48 +020057
Antonio de Angelisea8ebc92025-02-13 11:05:20 +000058*Copyright (c) 2017-2025, Arm Limited. All rights reserved.*