140d553cfSPaul BeesleyTrusted Firmware-A Documentation 240d553cfSPaul Beesley================================ 3653279b0SPaul Beesley 4653279b0SPaul Beesley.. toctree:: 5653279b0SPaul Beesley :maxdepth: 1 657354abbSPaul Beesley :hidden: 7653279b0SPaul Beesley 89f1622b0SPaul Beesley Home<self> 98eb9490bSPaul Beesley about/index 1040d553cfSPaul Beesley getting_started/index 1140d553cfSPaul Beesley process/index 1240d553cfSPaul Beesley components/index 1340d553cfSPaul Beesley design/index 1440d553cfSPaul Beesley plat/index 1540d553cfSPaul Beesley perf/index 1640d553cfSPaul Beesley security_advisories/index 17653279b0SPaul Beesley change-log 18*992d2fe0Slaurenw-arm change-log-upcoming 198f62ca7bSPaul Beesley glossary 209f1622b0SPaul Beesley license 21653279b0SPaul Beesley 229f1622b0SPaul BeesleyTrusted Firmware-A (TF-A) provides a reference implementation of secure world 239f1622b0SPaul Beesleysoftware for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing 249f1622b0SPaul Beesleyat Exception Level 3 (EL3). It implements various Arm interface standards, 259f1622b0SPaul Beesleysuch as: 26653279b0SPaul Beesley 279f1622b0SPaul Beesley- The `Power State Coordination Interface (PSCI)`_ 289f1622b0SPaul Beesley- `Trusted Board Boot Requirements CLIENT (TBBR-CLIENT)`_ 299f1622b0SPaul Beesley- `SMC Calling Convention`_ 309f1622b0SPaul Beesley- `System Control and Management Interface (SCMI)`_ 319f1622b0SPaul Beesley- `Software Delegated Exception Interface (SDEI)`_ 329f1622b0SPaul Beesley 339f1622b0SPaul BeesleyWhere possible, the code is designed for reuse or porting to other Armv7-A and 349f1622b0SPaul BeesleyArmv8-A model and hardware platforms. 359f1622b0SPaul Beesley 369f1622b0SPaul BeesleyThis release provides a suitable starting point for productization of secure 379f1622b0SPaul Beesleyworld boot and runtime firmware, in either the AArch32 or AArch64 execution 389f1622b0SPaul Beesleystates. 399f1622b0SPaul Beesley 409f1622b0SPaul BeesleyUsers are encouraged to do their own security validation, including penetration 419f1622b0SPaul Beesleytesting, on any secure world code derived from TF-A. 429f1622b0SPaul Beesley 438cc36aecSPaul BeesleyIn collaboration with interested parties, we will continue to enhance |TF-A| 448cc36aecSPaul Beesleywith reference implementations of Arm standards to benefit developers working 458cc36aecSPaul Beesleywith Armv7-A and Armv8-A TrustZone technology. 469f1622b0SPaul Beesley 478eb9490bSPaul BeesleyGetting Started 488eb9490bSPaul Beesley--------------- 499f1622b0SPaul Beesley 508eb9490bSPaul BeesleyThe |TF-A| documentation contains guidance for obtaining and building the 518eb9490bSPaul Beesleysoftware for existing, supported platforms, as well as supporting information 528eb9490bSPaul Beesleyfor porting the software to a new platform. 539f1622b0SPaul Beesley 548eb9490bSPaul BeesleyThe **About** chapter gives a high-level overview of |TF-A| features as well as 558eb9490bSPaul Beesleysome information on the project and how it is organized. 569f1622b0SPaul Beesley 578eb9490bSPaul BeesleyRefer to the documents in the **Getting Started** chapter for information about 588eb9490bSPaul Beesleythe prerequisites and requirements for building |TF-A|. 599f1622b0SPaul Beesley 608eb9490bSPaul BeesleyThe **Processes & Policies** chapter explains the project's release schedule 618eb9490bSPaul Beesleyand process, how security disclosures are handled, and the guidelines for 628eb9490bSPaul Beesleycontributing to the project (including the coding style). 639f1622b0SPaul Beesley 648eb9490bSPaul BeesleyThe **Components** chapter holds documents that explain specific components 658eb9490bSPaul Beesleythat make up the |TF-A| software, the :ref:`Exception Handling Framework`, for 668eb9490bSPaul Beesleyexample. 679f1622b0SPaul Beesley 688eb9490bSPaul BeesleyIn the **System Design** chapter you will find documents that explain the 698eb9490bSPaul Beesleydesign of portions of the software that involve more than one component, such 708eb9490bSPaul Beesleyas the :ref:`Trusted Board Boot` process. 719f1622b0SPaul Beesley 728eb9490bSPaul Beesley**Platform Ports** provides a list of the supported hardware and software-model 738eb9490bSPaul Beesleyplatforms that are supported upstream in |TF-A|. Most of these platforms also 748eb9490bSPaul Beesleyhave additional documentation that has been provided by the maintainers of the 758eb9490bSPaul Beesleyplatform. 769f1622b0SPaul Beesley 778eb9490bSPaul BeesleyThe results of any performance evaluations are added to the 788eb9490bSPaul Beesley**Performance & Testing** chapter. 799f1622b0SPaul Beesley 808eb9490bSPaul Beesley**Security Advisories** holds a list of documents relating to |CVE| entries that 818eb9490bSPaul Beesleyhave previously been raised against the software. 829f1622b0SPaul Beesley 839f1622b0SPaul Beesley-------------- 849f1622b0SPaul Beesley 859f1622b0SPaul Beesley*Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.* 869f1622b0SPaul Beesley 879f1622b0SPaul Beesley.. _Armv7-A and Armv8-A: https://developer.arm.com/products/architecture/a-profile 889f1622b0SPaul Beesley.. _Secure Monitor: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php 898eb9490bSPaul Beesley.. _Power State Coordination Interface (PSCI): http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf 909f1622b0SPaul Beesley.. _Trusted Board Boot Requirements CLIENT (TBBR-CLIENT): https://developer.arm.com/docs/den0006/latest/trusted-board-boot-requirements-client-tbbr-client-armv8-a 918eb9490bSPaul Beesley.. _System Control and Management Interface (SCMI): http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/DEN0056A_System_Control_and_Management_Interface.pdf 928eb9490bSPaul Beesley.. _Software Delegated Exception Interface (SDEI): http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf 938eb9490bSPaul Beesley.. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf 94