blob: d8e93a73f76e0296c5c310b7e27fbc017b1f2a38 [file] [log] [blame]
Galanakis, Minos0c1ad782019-11-08 11:28:40 +00001Trusted Firmware-M Documentation
2================================
3
Minos Galanakise4094012020-06-12 14:25:34 +01004.. raw:: html
5
6 <ul class="grid">
7 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +01008 <a href="introduction/readme.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +01009 <img alt="" src="_static/images/tfm-introduction.png"/>
Minos Galanakise4094012020-06-12 14:25:34 +010010 <h2>Introduction</h2>
11 </a>
12 <p>Introducing the Trusted Firmware-M Project: overview,
Summer Qinabf66982021-04-06 17:22:15 +080013 architecture, features, and licensing.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010014 </li>
15 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010016 <a href="getting_started/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010017 <img alt="" src="_static/images/tfm-documentation.png"/>
18 <h2>Getting Started</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010019 </a>
20 <p>Follow this guide to set up a development environment on your
21 system, and then build and run a sample application.</p>
22 </li>
23 <li class="grid-item">
Summer Qinabf66982021-04-06 17:22:15 +080024 <a href="platform/ext/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010025 <img alt="" src="_static/images/tfm-platform.png"/>
Summer Qinabf66982021-04-06 17:22:15 +080026 <h2>Supported Platforms</h2>
27 </a>
28 <p>List of supported boards and platforms.</p>
29 </li>
30 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010031 <a href="contributing/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010032 <img alt="" src="_static/images/tfm-contribution.png"/>
33 <h2>Contribution</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010034 </a>
35 <p>As an open-source project, we welcome and encourage the community
36 to submit patches directly to the project.</p>
37 </li>
38 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010039 <a href="integration_guide/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010040 <img alt="" src="_static/images/tfm-integration.png"/>
41 <h2>Integration</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010042 </a>
Summer Qinabf66982021-04-06 17:22:15 +080043 <p>Guidelines for integration with TF-M.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010044 </li>
45 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010046 <a href="technical_references/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010047 <img alt="" src="_static/images/tfm-reference.png"/>
48 <h2>References</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010049 </a>
Summer Qinabf66982021-04-06 17:22:15 +080050 <p>Design documents.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010051 </li>
52 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010053 <a href="security/index.html">
Minos Galanakise4094012020-06-12 14:25:34 +010054 <img alt="" src="_static/images/tfm.png"/>
Summer Qinabf66982021-04-06 17:22:15 +080055 <h2>Security</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010056 </a>
Summer Qinabf66982021-04-06 17:22:15 +080057 <p>Requirements, processes, and thread models for ensuring security
58 is addressed within the TF-M project.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010059 </li>
60 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010061 <a href="releases/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010062 <img alt="" src="_static/images/tfm-release.png"/>
Summer Qinabf66982021-04-06 17:22:15 +080063 <h2>Releases</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010064 </a>
Summer Qinabf66982021-04-06 17:22:15 +080065 <p>Release notes.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010066 </li>
67 </ul>
68
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000069.. toctree::
Minos Galanakise4094012020-06-12 14:25:34 +010070 :caption: Table of Contents
71 :name: mastertoc
72 :titlesonly:
73 :maxdepth: 1
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000074 :hidden:
75
Minos Galanakise4094012020-06-12 14:25:34 +010076 Home<self>
Anton Komlev3356ba32022-03-31 22:02:11 +010077 introduction/index
78 getting_started/index
Minos Galanakise4094012020-06-12 14:25:34 +010079 platform/ext/index
Anton Komlev3356ba32022-03-31 22:02:11 +010080 contributing/index
81 integration_guide/index
82 technical_references/index
83 security/index
84 releases/index
Minos Galanakise4094012020-06-12 14:25:34 +010085
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000086
87.. toctree::
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000088 :maxdepth: 2
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000089 :hidden:
Minos Galanakise4094012020-06-12 14:25:34 +010090 :caption: Quick Links
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000091
Summer Qinabf66982021-04-06 17:22:15 +080092 API Reference <https://ci.trustedfirmware.org/view/TF-M/job/tf-m-build-docs-nightly/lastSuccessfulBuild/artifact/trusted-firmware-m/build/docs/reference_manual/html/index.html>
Minos Galanakis9f350e92020-07-02 13:26:23 +010093 Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
Summer Qinabf66982021-04-06 17:22:15 +080094 Platform Security Architecture <https://developer.arm.com/architectures/security-architectures/platform-security-architecture>
Anton Komlev8e448342022-04-06 10:19:35 +010095 Glossary <glossary>
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000096
97--------------
98
Summer Qinabf66982021-04-06 17:22:15 +080099*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*