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