blob: cb53127534fd00f3076581503fc4ac465fbca761 [file] [log] [blame]
Paul Beesleyea225122019-02-11 17:54:45 +00001Trusted Firmware-A Documentation
2================================
Paul Beesley22994f72019-01-23 15:39:39 +00003
4.. toctree::
5 :maxdepth: 1
Paul Beesleya8790092019-03-07 17:03:22 +00006 :hidden:
Paul Beesley22994f72019-01-23 15:39:39 +00007
Paul Beesleycb238022019-03-07 15:25:14 +00008 Home<self>
Paul Beesley48f12a42019-10-16 13:35:47 +00009 about/index
Paul Beesleyea225122019-02-11 17:54:45 +000010 getting_started/index
11 process/index
12 components/index
13 design/index
14 plat/index
15 perf/index
16 security_advisories/index
Balint Dobszay637f4732019-11-13 12:48:00 +010017 design_documents/index
Paul Beesley22994f72019-01-23 15:39:39 +000018 change-log
laurenw-arm462ab372020-01-17 10:26:21 -060019 change-log-upcoming
Paul Beesley606d8072019-03-13 13:58:02 +000020 glossary
Paul Beesleycb238022019-03-07 15:25:14 +000021 license
Paul Beesley22994f72019-01-23 15:39:39 +000022
Paul Beesleycb238022019-03-07 15:25:14 +000023Trusted Firmware-A (TF-A) provides a reference implementation of secure world
24software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing
25at Exception Level 3 (EL3). It implements various Arm interface standards,
26such as:
27
28- The `Power State Coordination Interface (PSCI)`_
29- `Trusted Board Boot Requirements CLIENT (TBBR-CLIENT)`_
30- `SMC Calling Convention`_
31- `System Control and Management Interface (SCMI)`_
32- `Software Delegated Exception Interface (SDEI)`_
33
34Where possible, the code is designed for reuse or porting to other Armv7-A and
35Armv8-A model and hardware platforms.
36
37This release provides a suitable starting point for productization of secure
38world boot and runtime firmware, in either the AArch32 or AArch64 execution
39states.
40
41Users are encouraged to do their own security validation, including penetration
42testing, on any secure world code derived from TF-A.
43
Paul Beesleyd4414b62019-09-23 15:40:21 +000044In collaboration with interested parties, we will continue to enhance |TF-A|
45with reference implementations of Arm standards to benefit developers working
46with Armv7-A and Armv8-A TrustZone technology.
Paul Beesleycb238022019-03-07 15:25:14 +000047
Paul Beesley48f12a42019-10-16 13:35:47 +000048Getting Started
49---------------
Paul Beesleycb238022019-03-07 15:25:14 +000050
Paul Beesley48f12a42019-10-16 13:35:47 +000051The |TF-A| documentation contains guidance for obtaining and building the
52software for existing, supported platforms, as well as supporting information
53for porting the software to a new platform.
Paul Beesleycb238022019-03-07 15:25:14 +000054
Paul Beesley48f12a42019-10-16 13:35:47 +000055The **About** chapter gives a high-level overview of |TF-A| features as well as
56some information on the project and how it is organized.
Paul Beesleycb238022019-03-07 15:25:14 +000057
Paul Beesley48f12a42019-10-16 13:35:47 +000058Refer to the documents in the **Getting Started** chapter for information about
59the prerequisites and requirements for building |TF-A|.
Paul Beesleycb238022019-03-07 15:25:14 +000060
Paul Beesley48f12a42019-10-16 13:35:47 +000061The **Processes & Policies** chapter explains the project's release schedule
62and process, how security disclosures are handled, and the guidelines for
63contributing to the project (including the coding style).
Paul Beesleycb238022019-03-07 15:25:14 +000064
Paul Beesley48f12a42019-10-16 13:35:47 +000065The **Components** chapter holds documents that explain specific components
66that make up the |TF-A| software, the :ref:`Exception Handling Framework`, for
67example.
Paul Beesleycb238022019-03-07 15:25:14 +000068
Paul Beesley48f12a42019-10-16 13:35:47 +000069In the **System Design** chapter you will find documents that explain the
70design of portions of the software that involve more than one component, such
71as the :ref:`Trusted Board Boot` process.
Paul Beesleycb238022019-03-07 15:25:14 +000072
Paul Beesley48f12a42019-10-16 13:35:47 +000073**Platform Ports** provides a list of the supported hardware and software-model
74platforms that are supported upstream in |TF-A|. Most of these platforms also
75have additional documentation that has been provided by the maintainers of the
76platform.
Paul Beesleycb238022019-03-07 15:25:14 +000077
Paul Beesley48f12a42019-10-16 13:35:47 +000078The results of any performance evaluations are added to the
79**Performance & Testing** chapter.
Paul Beesleycb238022019-03-07 15:25:14 +000080
Paul Beesley48f12a42019-10-16 13:35:47 +000081**Security Advisories** holds a list of documents relating to |CVE| entries that
82have previously been raised against the software.
Paul Beesleycb238022019-03-07 15:25:14 +000083
Paul Beesleycb238022019-03-07 15:25:14 +000084--------------
85
Balint Dobszay637f4732019-11-13 12:48:00 +010086*Copyright (c) 2013-2020, Arm Limited and Contributors. All rights reserved.*
Paul Beesley22994f72019-01-23 15:39:39 +000087
Paul Beesleycb238022019-03-07 15:25:14 +000088.. _Armv7-A and Armv8-A: https://developer.arm.com/products/architecture/a-profile
89.. _Secure Monitor: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php
Paul Beesley48f12a42019-10-16 13:35:47 +000090.. _Power State Coordination Interface (PSCI): http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf
Paul Beesleycb238022019-03-07 15:25:14 +000091.. _Trusted Board Boot Requirements CLIENT (TBBR-CLIENT): https://developer.arm.com/docs/den0006/latest/trusted-board-boot-requirements-client-tbbr-client-armv8-a
Paul Beesley48f12a42019-10-16 13:35:47 +000092.. _System Control and Management Interface (SCMI): http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/DEN0056A_System_Control_and_Management_Interface.pdf
93.. _Software Delegated Exception Interface (SDEI): http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf
laurenw-arm03e7e612020-04-16 10:02:17 -050094.. _SMC Calling Convention: https://developer.arm.com/docs/den0028/latest