xref: /rk3399_ARM-atf/docs/index.rst (revision 714a1a93d10637ed00e087585c6aa625b6c254f8)
1Trusted Firmware-A Documentation
2================================
3
4.. toctree::
5   :maxdepth: 1
6   :numbered:
7
8   Home<self>
9   about/index
10   getting_started/index
11   process/index
12   components/index
13   design/index
14   porting-guide
15   plat/index
16   perf/index
17   security_advisories/index
18   design_documents/index
19   threat_model/index
20   architecture_features
21   tools/index
22   change-log
23   glossary
24   license
25
26Trusted Firmware-A (TF-A) provides a reference implementation of secure world
27software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing
28at Exception Level 3 (EL3). It implements various Arm interface standards,
29such as:
30
31-  The `Power State Coordination Interface (PSCI)`_
32-  `Trusted Board Boot Requirements CLIENT (TBBR-CLIENT)`_
33-  `SMC Calling Convention`_
34-  `System Control and Management Interface (SCMI)`_
35-  `Software Delegated Exception Interface (SDEI)`_
36-  `PSA FW update specification`_
37
38Where possible, the code is designed for reuse or porting to other Armv7-A and
39Armv8-A model and hardware platforms.
40
41This release provides a suitable starting point for productization of secure
42world boot and runtime firmware, in either the AArch32 or AArch64 execution
43states.
44
45Users are encouraged to do their own security validation, including penetration
46testing, on any secure world code derived from TF-A.
47
48In collaboration with interested parties, we will continue to enhance |TF-A|
49with reference implementations of Arm standards to benefit developers working
50with Armv7-A and Armv8-A TrustZone technology.
51
52Getting Started
53---------------
54
55The |TF-A| documentation contains guidance for obtaining and building the
56software for existing, supported platforms, as well as supporting information
57for porting the software to a new platform.
58
59The **About** chapter gives a high-level overview of |TF-A| features as well as
60some information on the project and how it is organized.
61
62Refer to the documents in the **Getting Started** chapter for information about
63the prerequisites and requirements for building |TF-A|.
64
65The **Processes & Policies** chapter explains the project's release schedule
66and process, how security disclosures are handled, and the guidelines for
67contributing to the project (including the coding style).
68
69The **Components** chapter holds documents that explain specific components
70that make up the |TF-A| software, the :ref:`Exception Handling Framework`, for
71example.
72
73In the **System Design** chapter you will find documents that explain the
74design of portions of the software that involve more than one component, such
75as the :ref:`Trusted Board Boot` process.
76
77**Platform Ports** provides a list of the supported hardware and software-model
78platforms that are supported upstream in |TF-A|. Most of these platforms also
79have additional documentation that has been provided by the maintainers of the
80platform.
81
82The results of any performance evaluations are added to the
83**Performance & Testing** chapter.
84
85**Security Advisories** holds a list of documents relating to |CVE| entries that
86have previously been raised against the software.
87
88--------------
89
90*Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.*
91
92.. _Armv7-A and Armv8-A: https://developer.arm.com/products/architecture/a-profile
93.. _Secure Monitor: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php
94.. _Power State Coordination Interface (PSCI): https://developer.arm.com/documentation/den0022/latest/
95.. _Trusted Board Boot Requirements CLIENT (TBBR-CLIENT): https://developer.arm.com/docs/den0006/latest
96.. _System Control and Management Interface (SCMI): https://developer.arm.com/documentation/den0056
97.. _Software Delegated Exception Interface (SDEI): https://developer.arm.com/documentation/den0054
98.. _SMC Calling Convention: https://developer.arm.com/docs/den0028/latest
99.. _PSA FW update specification: https://developer.arm.com/documentation/den0118/latest/
100