blob: 654fd7a36b8ea49469bcf6e2bd0c96a3ca4688da [file] [log] [blame]
Anton Komlev1f1bec02022-06-17 15:45:09 +01001################################
Galanakis, Minos0c1ad782019-11-08 11:28:40 +00002Trusted Firmware-M Documentation
Anton Komlev1f1bec02022-06-17 15:45:09 +01003################################
Galanakis, Minos0c1ad782019-11-08 11:28:40 +00004
Minos Galanakise4094012020-06-12 14:25:34 +01005.. raw:: html
6
7 <ul class="grid">
8 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +01009 <a href="introduction/readme.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010010 <img alt="" src="_static/images/tfm-introduction.png"/>
Minos Galanakise4094012020-06-12 14:25:34 +010011 <h2>Introduction</h2>
12 </a>
13 <p>Introducing the Trusted Firmware-M Project: overview,
Summer Qinabf66982021-04-06 17:22:15 +080014 architecture, features, and licensing.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010015 </li>
16 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010017 <a href="getting_started/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010018 <img alt="" src="_static/images/tfm-documentation.png"/>
19 <h2>Getting Started</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010020 </a>
21 <p>Follow this guide to set up a development environment on your
22 system, and then build and run a sample application.</p>
23 </li>
24 <li class="grid-item">
Gabor Abonyi2cac6662022-07-19 14:33:17 +020025 <a href="platform/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010026 <img alt="" src="_static/images/tfm-platform.png"/>
Summer Qinabf66982021-04-06 17:22:15 +080027 <h2>Supported Platforms</h2>
28 </a>
29 <p>List of supported boards and platforms.</p>
30 </li>
31 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010032 <a href="contributing/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010033 <img alt="" src="_static/images/tfm-contribution.png"/>
34 <h2>Contribution</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010035 </a>
36 <p>As an open-source project, we welcome and encourage the community
37 to submit patches directly to the project.</p>
38 </li>
39 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010040 <a href="integration_guide/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010041 <img alt="" src="_static/images/tfm-integration.png"/>
42 <h2>Integration</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010043 </a>
Summer Qinabf66982021-04-06 17:22:15 +080044 <p>Guidelines for integration with TF-M.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010045 </li>
46 <li class="grid-item">
Anton Komlevff7cbae2023-01-12 16:28:26 +000047 <a href="design_docs/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010048 <img alt="" src="_static/images/tfm-reference.png"/>
49 <h2>References</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010050 </a>
Summer Qinabf66982021-04-06 17:22:15 +080051 <p>Design documents.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010052 </li>
53 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010054 <a href="security/index.html">
Minos Galanakise4094012020-06-12 14:25:34 +010055 <img alt="" src="_static/images/tfm.png"/>
Summer Qinabf66982021-04-06 17:22:15 +080056 <h2>Security</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010057 </a>
Summer Qinabf66982021-04-06 17:22:15 +080058 <p>Requirements, processes, and thread models for ensuring security
59 is addressed within the TF-M project.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010060 </li>
61 <li class="grid-item">
Anton Komlev3356ba32022-03-31 22:02:11 +010062 <a href="releases/index.html">
Anton Komlevd36e51f2021-05-05 23:17:57 +010063 <img alt="" src="_static/images/tfm-release.png"/>
Summer Qinabf66982021-04-06 17:22:15 +080064 <h2>Releases</h2>
Minos Galanakise4094012020-06-12 14:25:34 +010065 </a>
Summer Qinabf66982021-04-06 17:22:15 +080066 <p>Release notes.</p>
Minos Galanakise4094012020-06-12 14:25:34 +010067 </li>
68 </ul>
69
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000070.. toctree::
Anton Komlev91281f02022-04-22 09:24:20 +010071 :caption: Overview
Anton Komlev1f1bec02022-06-17 15:45:09 +010072 :titlesonly:
Minos Galanakise4094012020-06-12 14:25:34 +010073 :maxdepth: 1
Galanakis, Minos0c1ad782019-11-08 11:28:40 +000074 :hidden:
75
Anton Komlev3356ba32022-03-31 22:02:11 +010076 introduction/index
Anton Komlev91281f02022-04-22 09:24:20 +010077 Getting Started <getting_started/index>
Anton Komlev3356ba32022-03-31 22:02:11 +010078 security/index
79 releases/index
Anton Komlev91281f02022-04-22 09:24:20 +010080 Glossary <glossary>
Minos Galanakise4094012020-06-12 14:25:34 +010081
Anton Komlev91281f02022-04-22 09:24:20 +010082.. toctree::
83 :caption: Development
Anton Komlev1f1bec02022-06-17 15:45:09 +010084 :titlesonly:
Anton Komlev91281f02022-04-22 09:24:20 +010085 :maxdepth: 1
86 :hidden:
87
Anton Komlev90657c12023-01-17 13:01:22 +000088 Platforms <platform/index>
Anton Komlev0dbe8f12022-06-17 16:48:12 +010089 building/tfm_build_instruction
Anton Komlevaffe14f2022-11-01 00:07:41 +000090 configuration/index
Anton Komlev91281f02022-04-22 09:24:20 +010091 integration_guide/index
Anton Komlevff7cbae2023-01-12 16:28:26 +000092 design_docs/index
Anton Komlev91281f02022-04-22 09:24:20 +010093 Tools <tools/index>
94
95.. toctree::
96 :caption: Contribution
97 :titlesonly:
98 :hidden:
99
100 Guidelines <contributing/index>
101 contributing/lic
102 DCO <contributing/dco>
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000103
104.. toctree::
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000105 :maxdepth: 2
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000106 :hidden:
Anton Komlev91281f02022-04-22 09:24:20 +0100107 :caption: Links
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000108
Gilles Peskinec8a3a052023-03-01 20:46:19 +0100109 API Reference <https://ci.trustedfirmware.org/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 +0100110 Security Center <https://developer.trustedfirmware.org/w/collaboration/security_center>
Anton Komlev91281f02022-04-22 09:24:20 +0100111 PSA <https://www.arm.com/architecture/security-features/platform-security>
Galanakis, Minos0c1ad782019-11-08 11:28:40 +0000112
113--------------
114
Gabor Abonyi2cac6662022-07-19 14:33:17 +0200115*Copyright (c) 2017-2022, Arm Limited. All rights reserved.*