Paul Beesley | ea22512 | 2019-02-11 17:54:45 +0000 | [diff] [blame] | 1 | Trusted Firmware-A Documentation |
| 2 | ================================ |
Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 3 | |
| 4 | .. toctree:: |
| 5 | :maxdepth: 1 |
Paul Beesley | a879009 | 2019-03-07 17:03:22 +0000 | [diff] [blame] | 6 | :hidden: |
Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 7 | |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 8 | Home<self> |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 9 | about/index |
Paul Beesley | ea22512 | 2019-02-11 17:54:45 +0000 | [diff] [blame] | 10 | getting_started/index |
| 11 | process/index |
| 12 | components/index |
| 13 | design/index |
| 14 | plat/index |
| 15 | perf/index |
| 16 | security_advisories/index |
Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 17 | change-log |
Paul Beesley | 606d807 | 2019-03-13 13:58:02 +0000 | [diff] [blame] | 18 | glossary |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 19 | license |
Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 20 | |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 21 | Trusted Firmware-A (TF-A) provides a reference implementation of secure world |
| 22 | software for `Armv7-A and Armv8-A`_, including a `Secure Monitor`_ executing |
| 23 | at Exception Level 3 (EL3). It implements various Arm interface standards, |
| 24 | such as: |
| 25 | |
| 26 | - The `Power State Coordination Interface (PSCI)`_ |
| 27 | - `Trusted Board Boot Requirements CLIENT (TBBR-CLIENT)`_ |
| 28 | - `SMC Calling Convention`_ |
| 29 | - `System Control and Management Interface (SCMI)`_ |
| 30 | - `Software Delegated Exception Interface (SDEI)`_ |
| 31 | |
| 32 | Where possible, the code is designed for reuse or porting to other Armv7-A and |
| 33 | Armv8-A model and hardware platforms. |
| 34 | |
| 35 | This release provides a suitable starting point for productization of secure |
| 36 | world boot and runtime firmware, in either the AArch32 or AArch64 execution |
| 37 | states. |
| 38 | |
| 39 | Users are encouraged to do their own security validation, including penetration |
| 40 | testing, on any secure world code derived from TF-A. |
| 41 | |
Paul Beesley | d4414b6 | 2019-09-23 15:40:21 +0000 | [diff] [blame] | 42 | In collaboration with interested parties, we will continue to enhance |TF-A| |
| 43 | with reference implementations of Arm standards to benefit developers working |
| 44 | with Armv7-A and Armv8-A TrustZone technology. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 45 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 46 | Getting Started |
| 47 | --------------- |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 48 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 49 | The |TF-A| documentation contains guidance for obtaining and building the |
| 50 | software for existing, supported platforms, as well as supporting information |
| 51 | for porting the software to a new platform. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 52 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 53 | The **About** chapter gives a high-level overview of |TF-A| features as well as |
| 54 | some information on the project and how it is organized. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 55 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 56 | Refer to the documents in the **Getting Started** chapter for information about |
| 57 | the prerequisites and requirements for building |TF-A|. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 58 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 59 | The **Processes & Policies** chapter explains the project's release schedule |
| 60 | and process, how security disclosures are handled, and the guidelines for |
| 61 | contributing to the project (including the coding style). |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 62 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 63 | The **Components** chapter holds documents that explain specific components |
| 64 | that make up the |TF-A| software, the :ref:`Exception Handling Framework`, for |
| 65 | example. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 66 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 67 | In the **System Design** chapter you will find documents that explain the |
| 68 | design of portions of the software that involve more than one component, such |
| 69 | as the :ref:`Trusted Board Boot` process. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 70 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 71 | **Platform Ports** provides a list of the supported hardware and software-model |
| 72 | platforms that are supported upstream in |TF-A|. Most of these platforms also |
| 73 | have additional documentation that has been provided by the maintainers of the |
| 74 | platform. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 75 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 76 | The results of any performance evaluations are added to the |
| 77 | **Performance & Testing** chapter. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 78 | |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 79 | **Security Advisories** holds a list of documents relating to |CVE| entries that |
| 80 | have previously been raised against the software. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 81 | |
| 82 | Platforms |
| 83 | --------- |
| 84 | |
| 85 | Various AArch32 and AArch64 builds of this release have been tested on r0, r1 |
| 86 | and r2 variants of the `Juno Arm Development Platform`_. |
| 87 | |
| 88 | The latest version of the AArch64 build of TF-A has been tested on the following |
| 89 | Arm FVPs without shifted affinities, and that do not support threaded CPU cores |
| 90 | (64-bit host machine only). |
| 91 | |
Paul Beesley | ba3ed40 | 2019-03-13 16:20:44 +0000 | [diff] [blame] | 92 | .. note:: |
Artsem Artsemenka | 9c20550 | 2019-10-15 14:59:04 +0100 | [diff] [blame] | 93 | The FVP models used are Version 11.6 Build 45, unless otherwise stated. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 94 | |
| 95 | - ``FVP_Base_AEMv8A-AEMv8A`` |
| 96 | - ``FVP_Base_AEMv8A-AEMv8A-AEMv8A-AEMv8A-CCN502`` |
| 97 | - ``FVP_Base_RevC-2xAEMv8A`` |
| 98 | - ``FVP_Base_Cortex-A32x4`` |
| 99 | - ``FVP_Base_Cortex-A35x4`` |
| 100 | - ``FVP_Base_Cortex-A53x4`` |
| 101 | - ``FVP_Base_Cortex-A55x4+Cortex-A75x4`` |
| 102 | - ``FVP_Base_Cortex-A55x4`` |
| 103 | - ``FVP_Base_Cortex-A57x1-A53x1`` |
| 104 | - ``FVP_Base_Cortex-A57x2-A53x4`` |
| 105 | - ``FVP_Base_Cortex-A57x4-A53x4`` |
| 106 | - ``FVP_Base_Cortex-A57x4`` |
| 107 | - ``FVP_Base_Cortex-A72x4-A53x4`` |
| 108 | - ``FVP_Base_Cortex-A72x4`` |
| 109 | - ``FVP_Base_Cortex-A73x4-A53x4`` |
| 110 | - ``FVP_Base_Cortex-A73x4`` |
| 111 | - ``FVP_Base_Cortex-A75x4`` |
| 112 | - ``FVP_Base_Cortex-A76x4`` |
| 113 | - ``FVP_Base_Cortex-A76AEx4`` (Tested with internal model) |
| 114 | - ``FVP_Base_Cortex-A76AEx8`` (Tested with internal model) |
Balint Dobszay | cc94264 | 2019-07-03 13:02:56 +0200 | [diff] [blame] | 115 | - ``FVP_Base_Cortex-A77x4`` (Version 11.7 build 36) |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 116 | - ``FVP_Base_Neoverse-N1x4`` (Tested with internal model) |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 117 | - ``FVP_CSS_SGI-575`` (Version 11.3 build 42) |
| 118 | - ``FVP_CSS_SGM-775`` (Version 11.3 build 42) |
| 119 | - ``FVP_RD_E1Edge`` (Version 11.3 build 42) |
| 120 | - ``FVP_RD_N1Edge`` (Version 11.3 build 42) |
| 121 | - ``Foundation_Platform`` |
| 122 | |
| 123 | The latest version of the AArch32 build of TF-A has been tested on the following |
| 124 | Arm FVPs without shifted affinities, and that do not support threaded CPU cores |
| 125 | (64-bit host machine only). |
| 126 | |
| 127 | - ``FVP_Base_AEMv8A-AEMv8A`` |
| 128 | - ``FVP_Base_Cortex-A32x4`` |
| 129 | |
Paul Beesley | ba3ed40 | 2019-03-13 16:20:44 +0000 | [diff] [blame] | 130 | .. note:: |
| 131 | The ``FVP_Base_RevC-2xAEMv8A`` FVP only supports shifted affinities. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 132 | |
| 133 | The Foundation FVP can be downloaded free of charge. The Base FVPs can be |
| 134 | licensed from Arm. See the `Arm FVP website`_. |
| 135 | |
Paul Beesley | a27573b | 2019-10-15 09:08:12 +0000 | [diff] [blame] | 136 | All the above platforms have been tested with `Linaro Release 19.06`_. |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 137 | |
| 138 | This release also contains the following platform support: |
| 139 | |
| 140 | - Allwinner sun50i_a64 and sun50i_h6 |
| 141 | - Amlogic Meson S905 (GXBB) |
| 142 | - Arm Juno Software Development Platform |
| 143 | - Arm Neoverse N1 System Development Platform (N1SDP) |
| 144 | - Arm Neoverse Reference Design N1 Edge (RD-N1-Edge) FVP |
| 145 | - Arm Neoverse Reference Design E1 Edge (RD-E1-Edge) FVP |
| 146 | - Arm SGI-575 and SGM-775 |
| 147 | - Arm Versatile Express FVP |
| 148 | - HiKey, HiKey960 and Poplar boards |
| 149 | - Intel Stratix 10 SoC FPGA |
| 150 | - Marvell Armada 3700 and 8K |
| 151 | - MediaTek MT6795 and MT8173 SoCs |
| 152 | - NVIDIA T132, T186 and T210 SoCs |
| 153 | - NXP QorIQ LS1043A, i.MX8MM, i.MX8MQ, i.MX8QX, i.MX8QM and i.MX7Solo WaRP7 |
| 154 | - QEMU |
| 155 | - Raspberry Pi 3 |
| 156 | - Renesas R-Car Generation 3 |
| 157 | - RockChip RK3328, RK3368 and RK3399 SoCs |
| 158 | - Socionext UniPhier SoC family and SynQuacer SC2A11 SoCs |
| 159 | - STMicroelectronics STM32MP1 |
| 160 | - Texas Instruments K3 SoCs |
| 161 | - Xilinx Versal and Zynq UltraScale + MPSoC |
| 162 | |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 163 | -------------- |
| 164 | |
| 165 | *Copyright (c) 2013-2019, Arm Limited and Contributors. All rights reserved.* |
Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 166 | |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 167 | .. _Armv7-A and Armv8-A: https://developer.arm.com/products/architecture/a-profile |
| 168 | .. _Secure Monitor: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 169 | .. _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 Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 170 | .. _Trusted Board Boot Requirements CLIENT (TBBR-CLIENT): https://developer.arm.com/docs/den0006/latest/trusted-board-boot-requirements-client-tbbr-client-armv8-a |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 171 | .. _System Control and Management Interface (SCMI): http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/DEN0056A_System_Control_and_Management_Interface.pdf |
| 172 | .. _Software Delegated Exception Interface (SDEI): http://infocenter.arm.com/help/topic/com.arm.doc.den0054a/ARM_DEN0054A_Software_Delegated_Exception_Interface.pdf |
Paul Beesley | cb23802 | 2019-03-07 15:25:14 +0000 | [diff] [blame] | 173 | .. _Juno Arm Development Platform: http://www.arm.com/products/tools/development-boards/versatile-express/juno-arm-development-platform.php |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 174 | .. _Arm FVP website: https://developer.arm.com/products/system-design/fixed-virtual-platforms |
Paul Beesley | a27573b | 2019-10-15 09:08:12 +0000 | [diff] [blame] | 175 | .. _Linaro Release 19.06: http://releases.linaro.org/members/arm/platforms/19.06 |
Paul Beesley | 48f12a4 | 2019-10-16 13:35:47 +0000 | [diff] [blame^] | 176 | .. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf |