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