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