blob: c606c795e462bf87e6d77e620d91bd1c1c62645f [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 Komlevda5fb7c2022-04-27 19:04:23 +010046 <a href="technical_references/design_docs/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::
Anton Komlev91281f02022-04-22 09:24:20 +010070 :caption: Overview
Minos Galanakise4094012020-06-12 14:25:34 +010071 :maxdepth: 1
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000072 :hidden:
73
Anton Komlev3356ba32022-03-31 22:02:11 +010074 introduction/index
Anton Komlev91281f02022-04-22 09:24:20 +010075 Getting Started <getting_started/index>
Anton Komlev3356ba32022-03-31 22:02:11 +010076 security/index
77 releases/index
Anton Komlev91281f02022-04-22 09:24:20 +010078 Glossary <glossary>
Minos Galanakise4094012020-06-12 14:25:34 +010079
Anton Komlev91281f02022-04-22 09:24:20 +010080.. toctree::
81 :caption: Development
82 :maxdepth: 1
83 :hidden:
84
85 Platform Selection<platform/ext/index>
86 Building <technical_references/instructions/tfm_build_instruction>
87 integration_guide/index
88 technical_references/design_docs/index
89 Tools <tools/index>
90
91.. toctree::
92 :caption: Contribution
93 :titlesonly:
94 :hidden:
95
96 Guidelines <contributing/index>
97 contributing/lic
98 DCO <contributing/dco>
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000099
100.. toctree::
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000101 :maxdepth: 2
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000102 :hidden:
Anton Komlev91281f02022-04-22 09:24:20 +0100103 :caption: Links
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000104
Summer Qinabf66982021-04-06 17:22:15 +0800105 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 +0100106 Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
Anton Komlev91281f02022-04-22 09:24:20 +0100107 PSA <https://www.arm.com/architecture/security-features/platform-security>
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000108
109--------------
110
Summer Qinabf66982021-04-06 17:22:15 +0800111*Copyright (c) 2017-2021, Arm Limited. All rights reserved.*