1 ARM Trusted Firmware - version 1.4 2 ================================== 3 4 ARM Trusted Firmware provides a reference implementation of secure world 5 software for `ARMv8-A`_, including a `Secure Monitor`_ executing at 6 Exception Level 3 (EL3). It implements various ARM interface standards, such as: 7 8 - The `Power State Coordination Interface (PSCI)`_ 9 - Trusted Board Boot Requirements (TBBR, ARM DEN0006C-1) 10 - `SMC Calling Convention`_ 11 - `System Control and Management Interface`_ 12 13 As far as possible the code is designed for reuse or porting to other ARMv8-A 14 model and hardware platforms. 15 16 ARM will continue development in collaboration with interested parties to 17 provide a full reference implementation of Secure Monitor code and ARM standards 18 to the benefit of all developers working with ARMv8-A TrustZone technology. 19 20 License 21 ------- 22 23 The software is provided under a BSD-3-Clause `license`_. Contributions to this 24 project are accepted under the same license with developer sign-off as 25 described in the `Contributing Guidelines`_. 26 27 This project contains code from other projects as listed below. The original 28 license text is included in those source files. 29 30 - The stdlib source code is derived from FreeBSD code, which uses various 31 BSD licenses, including BSD-3-Clause and BSD-2-Clause. 32 33 - The libfdt source code is dual licensed. It is used by this project under 34 the terms of the BSD-2-Clause license. 35 36 - The LLVM compiler-rt source code is dual licensed. It is used by this 37 project under the terms of the NCSA license (also known as the University of 38 Illinois/NCSA Open Source License). 39 40 This Release 41 ------------ 42 43 This release provides a suitable starting point for productization of secure 44 world boot and runtime firmware, in either the AArch32 or AArch64 execution 45 state. 46 47 Users are encouraged to do their own security validation, including penetration 48 testing, on any secure world code derived from ARM Trusted Firmware. 49 50 Functionality 51 ~~~~~~~~~~~~~ 52 53 - Initialization of the secure world, for example exception vectors, control 54 registers and interrupts for the platform. 55 56 - Library support for CPU specific reset and power down sequences. This 57 includes support for errata workarounds and the latest ARM DynamIQ CPUs. 58 59 - Drivers to enable standard initialization of ARM System IP, for example 60 Generic Interrupt Controller (GIC), Cache Coherent Interconnect (CCI), 61 Cache Coherent Network (CCN), Network Interconnect (NIC) and TrustZone 62 Controller (TZC). 63 64 - A generic `SCMI`_ driver to interface with conforming power controllers, for 65 example the ARM System Control Processor (SCP). 66 67 - SMC (Secure Monitor Call) handling, conforming to the `SMC Calling 68 Convention`_ using an EL3 runtime services framework. 69 70 - `PSCI`_ library support for CPU, cluster and system power management 71 use-cases. 72 This library is pre-integrated with the AArch64 EL3 Runtime Software, and 73 is also suitable for integration with other AArch32 EL3 Runtime Software, 74 for example an AArch32 Secure OS. 75 76 - A minimal AArch32 Secure Payload (SP\_MIN) to demonstrate `PSCI`_ library 77 integration with AArch32 EL3 Runtime Software. 78 79 - Secure Monitor library code such as world switching, EL1 context management 80 and interrupt routing. 81 When a Secure-EL1 Payload (SP) is present, for example a Secure OS, the 82 AArch64 EL3 Runtime Software must be integrated with a dispatcher component 83 (SPD) to customize the interaction with the SP. 84 85 - A Test SP/SPD to demonstrate AArch64 Secure Monitor functionality and SP 86 interaction with PSCI. 87 88 - SPDs for the `OP-TEE Secure OS`_, `NVidia Trusted Little Kernel`_ 89 and `Trusty Secure OS`_. 90 91 - A Trusted Board Boot implementation, conforming to all mandatory TBBR 92 requirements. This includes image authentication, Firmware Update (or 93 recovery mode), and packaging of the various firmware images into a 94 Firmware Image Package (FIP). 95 96 - Pre-integration of TBB with the ARM TrustZone CryptoCell product, to take 97 advantage of its hardware Root of Trust and crypto acceleration services. 98 99 - Support for alternative boot flows, for example to support platforms where 100 the EL3 Runtime Software is loaded using other firmware or a separate 101 secure system processor. 102 103 - Support for the GCC, LLVM and ARM Compiler 6 toolchains. 104 105 For a full description of functionality and implementation details, please 106 see the `Firmware Design`_ and supporting documentation. The `Change Log`_ 107 provides details of changes made since the last release. 108 109 Platforms 110 ~~~~~~~~~ 111 112 Various AArch32 and AArch64 builds of this release has been tested on variants 113 r0, r1 and r2 of the `Juno ARM Development Platform`_. 114 115 Various AArch64 builds of this release have been tested on the following ARM 116 `FVP`_\ s (64-bit host machine only): 117 118 NOTE: Unless otherwise stated, the FVP Version is 11.0, Build 11.0.34. 119 120 - ``Foundation_Platform`` 121 - ``FVP_Base_AEMv8A-AEMv8A`` (Version 8.5, Build 0.8.8502) 122 - ``FVP_Base_Cortex-A35x4`` 123 - ``FVP_Base_Cortex-A53x4`` 124 - ``FVP_Base_Cortex-A57x4-A53x4`` 125 - ``FVP_Base_Cortex-A57x4`` 126 - ``FVP_Base_Cortex-A72x4-A53x4`` 127 - ``FVP_Base_Cortex-A72x4`` 128 - ``FVP_Base_Cortex-A73x4-A53x4`` 129 - ``FVP_Base_Cortex-A73x4`` 130 - ``FVP_CSS_SGM-775`` (Version 11.0, Build 11.0.36) 131 132 Various AArch32 builds of this release has been tested on the following ARM 133 `FVP`_\ s (64-bit host machine only): 134 135 - ``FVP_Base_AEMv8A-AEMv8A`` (Version 8.5, Build 0.8.8502) 136 - ``FVP_Base_Cortex-A32x4`` 137 138 The Foundation FVP can be downloaded free of charge. The Base FVPs can be 139 licensed from ARM. See the `ARM FVP website`_. 140 141 All the above platforms have been tested with `Linaro Release 17.04`_. 142 143 This release also contains the following platform support: 144 145 - HiKey and HiKey960 boards 146 - MediaTek MT6795 and MT8173 SoCs 147 - NVidia T132, T186 and T210 SoCs 148 - QEMU emulator 149 - RockChip RK3328, RK3368 and RK3399 SoCs 150 - Socionext UniPhier SoC family 151 - Xilinx Zynq UltraScale + MPSoC 152 153 Still to Come 154 ~~~~~~~~~~~~~ 155 156 - More platform support. 157 158 - Ongoing support for new architectural features, CPUs and System IP. 159 160 - Ongoing support for new `PSCI`_, `SCMI`_ and TBBR features. 161 162 - Ongoing security hardening, optimization and quality improvements. 163 164 For a full list of detailed issues in the current code, please see the `Change 165 Log`_ and the `GitHub issue tracker`_. 166 167 Getting Started 168 --------------- 169 170 Get the Trusted Firmware source code from `GitHub`_. 171 172 See the `User Guide`_ for instructions on how to install, build and use 173 the Trusted Firmware with the ARM `FVP`_\ s. 174 175 See the `Firmware Design`_ for information on how the Trusted Firmware works. 176 177 See the `Porting Guide`_ as well for information about how to use this 178 software on another ARMv8-A platform. 179 180 See the `Contributing Guidelines`_ for information on how to contribute to this 181 project and the `Acknowledgments`_ file for a list of contributors to the 182 project. 183 184 Feedback and support 185 ~~~~~~~~~~~~~~~~~~~~ 186 187 ARM welcomes any feedback on Trusted Firmware. If you think you have found a 188 security vulnerability, please report this using the process defined in the 189 Trusted Firmware `Security Centre`_. For all other feedback, please use the 190 `GitHub issue tracker`_. 191 192 ARM licensees may contact ARM directly via their partner managers. 193 194 -------------- 195 196 *Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved.* 197 198 .. _ARMv8-A: http://www.arm.com/products/processors/armv8-architecture.php 199 .. _Secure Monitor: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php 200 .. _Power State Coordination Interface (PSCI): PSCI_ 201 .. _PSCI: http://infocenter.arm.com/help/topic/com.arm.doc.den0022d/Power_State_Coordination_Interface_PDD_v1_1_DEN0022D.pdf 202 .. _SMC Calling Convention: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf 203 .. _System Control and Management Interface: SCMI_ 204 .. _SCMI: http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/DEN0056A_System_Control_and_Management_Interface.pdf 205 .. _Juno ARM Development Platform: http://www.arm.com/products/tools/development-boards/versatile-express/juno-arm-development-platform.php 206 .. _ARM FVP website: FVP_ 207 .. _FVP: https://developer.arm.com/products/system-design/fixed-virtual-platforms 208 .. _Linaro Release 17.04: https://community.arm.com/dev-platforms/b/documents/posts/linaro-release-notes-deprecated#LinaroRelease17.04 209 .. _OP-TEE Secure OS: https://github.com/OP-TEE/optee_os 210 .. _NVidia Trusted Little Kernel: http://nv-tegra.nvidia.com/gitweb/?p=3rdparty/ote_partner/tlk.git;a=summary 211 .. _Trusty Secure OS: https://source.android.com/security/trusty 212 .. _GitHub: https://www.github.com/ARM-software/arm-trusted-firmware 213 .. _GitHub issue tracker: https://github.com/ARM-software/tf-issues/issues 214 .. _Security Centre: https://github.com/ARM-software/arm-trusted-firmware/wiki/ARM-Trusted-Firmware-Security-Centre 215 .. _license: ./license.rst 216 .. _Contributing Guidelines: ./contributing.rst 217 .. _Acknowledgments: ./acknowledgements.rst 218 .. _Firmware Design: ./docs/firmware-design.rst 219 .. _Change Log: ./docs/change-log.rst 220 .. _User Guide: ./docs/user-guide.rst 221 .. _Porting Guide: ./docs/porting-guide.rst 222
