ARM Trusted Firmware
Clone or download
Pull request Compare This branch is 2176 commits ahead of 96boards:hikey.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bl1
bl2
bl2u
bl31
bl32
common
docs
drivers
fdts Add Linux DTS for FVP with threaded CPUs Aug 1, 2017
include
lib aarch64: Add PubSub events to capture security state transitions Oct 31, 2017
make_helpers
plat Hikey960: Fix hikey960 pcie mount fail Jan 10, 2018
services
tools
.checkpatch.conf Mandate 'Signed-off-by' line in commit messages Oct 24, 2016
.gitignore
Makefile Use -fno-pic Oct 30, 2017
acknowledgements.rst
contributing.rst
dco.txt
license.rst
maintainers.rst
readme.rst

readme.rst

ARM Trusted Firmware - version 1.4

ARM Trusted Firmware provides a reference implementation of secure world software for ARMv8-A, including a Secure Monitor executing at Exception Level 3 (EL3). It implements various ARM interface standards, such as:

As far as possible the code is designed for reuse or porting to other ARMv8-A model and hardware platforms.

ARM will continue development in collaboration with interested parties to provide a full reference implementation of Secure Monitor code and ARM standards to the benefit of all developers working with ARMv8-A TrustZone technology.

License

The software is provided under a BSD-3-Clause license. Contributions to this project are accepted under the same license with developer sign-off as described in the Contributing Guidelines.

This project contains code from other projects as listed below. The original license text is included in those source files.

  • The stdlib source code is derived from FreeBSD code, which uses various BSD licenses, including BSD-3-Clause and BSD-2-Clause.
  • The libfdt source code is dual licensed. It is used by this project under the terms of the BSD-2-Clause license.
  • The LLVM compiler-rt source code is dual licensed. It is used by this project under the terms of the NCSA license (also known as the University of Illinois/NCSA Open Source License).

This Release

This release provides a suitable starting point for productization of secure world boot and runtime firmware, in either the AArch32 or AArch64 execution state.

Users are encouraged to do their own security validation, including penetration testing, on any secure world code derived from ARM Trusted Firmware.

Functionality

  • Initialization of the secure world, for example exception vectors, control registers and interrupts for the platform.
  • Library support for CPU specific reset and power down sequences. This includes support for errata workarounds and the latest ARM DynamIQ CPUs.
  • Drivers to enable standard initialization of ARM System IP, for example Generic Interrupt Controller (GIC), Cache Coherent Interconnect (CCI), Cache Coherent Network (CCN), Network Interconnect (NIC) and TrustZone Controller (TZC).
  • A generic SCMI driver to interface with conforming power controllers, for example the ARM System Control Processor (SCP).
  • SMC (Secure Monitor Call) handling, conforming to the SMC Calling Convention using an EL3 runtime services framework.
  • PSCI library support for CPU, cluster and system power management use-cases. This library is pre-integrated with the AArch64 EL3 Runtime Software, and is also suitable for integration with other AArch32 EL3 Runtime Software, for example an AArch32 Secure OS.
  • A minimal AArch32 Secure Payload (SP_MIN) to demonstrate PSCI library integration with AArch32 EL3 Runtime Software.
  • Secure Monitor library code such as world switching, EL1 context management and interrupt routing. When a Secure-EL1 Payload (SP) is present, for example a Secure OS, the AArch64 EL3 Runtime Software must be integrated with a dispatcher component (SPD) to customize the interaction with the SP.
  • A Test SP/SPD to demonstrate AArch64 Secure Monitor functionality and SP interaction with PSCI.
  • SPDs for the OP-TEE Secure OS, NVidia Trusted Little Kernel and Trusty Secure OS.
  • A Trusted Board Boot implementation, conforming to all mandatory TBBR requirements. This includes image authentication, Firmware Update (or recovery mode), and packaging of the various firmware images into a Firmware Image Package (FIP).
  • Pre-integration of TBB with the ARM TrustZone CryptoCell product, to take advantage of its hardware Root of Trust and crypto acceleration services.
  • Support for alternative boot flows, for example to support platforms where the EL3 Runtime Software is loaded using other firmware or a separate secure system processor.
  • Support for the GCC, LLVM and ARM Compiler 6 toolchains.

For a full description of functionality and implementation details, please see the Firmware Design and supporting documentation. The Change Log provides details of changes made since the last release.

Platforms

Various AArch32 and AArch64 builds of this release has been tested on variants r0, r1 and r2 of the Juno ARM Development Platform.

Various AArch64 builds of this release have been tested on the following ARM FVPs (64-bit host machine only):

NOTE: Unless otherwise stated, the FVP Version is 11.0, Build 11.0.34.

  • Foundation_Platform
  • FVP_Base_AEMv8A-AEMv8A (Version 8.5, Build 0.8.8502)
  • FVP_Base_Cortex-A35x4
  • FVP_Base_Cortex-A53x4
  • FVP_Base_Cortex-A57x4-A53x4
  • FVP_Base_Cortex-A57x4
  • FVP_Base_Cortex-A72x4-A53x4
  • FVP_Base_Cortex-A72x4
  • FVP_Base_Cortex-A73x4-A53x4
  • FVP_Base_Cortex-A73x4
  • FVP_CSS_SGM-775 (Version 11.0, Build 11.0.36)

Various AArch32 builds of this release has been tested on the following ARM FVPs (64-bit host machine only):

  • FVP_Base_AEMv8A-AEMv8A (Version 8.5, Build 0.8.8502)
  • FVP_Base_Cortex-A32x4

The Foundation FVP can be downloaded free of charge. The Base FVPs can be licensed from ARM. See the ARM FVP website.

All the above platforms have been tested with Linaro Release 17.04.

This release also contains the following platform support:

  • HiKey and HiKey960 boards
  • MediaTek MT6795 and MT8173 SoCs
  • NVidia T132, T186 and T210 SoCs
  • QEMU emulator
  • RockChip RK3328, RK3368 and RK3399 SoCs
  • Socionext UniPhier SoC family
  • Xilinx Zynq UltraScale + MPSoC

Still to Come

  • More platform support.
  • Ongoing support for new architectural features, CPUs and System IP.
  • Ongoing support for new PSCI, SCMI and TBBR features.
  • Ongoing security hardening, optimization and quality improvements.

For a full list of detailed issues in the current code, please see the Change Log and the GitHub issue tracker.

Getting Started

Get the Trusted Firmware source code from GitHub.

See the User Guide for instructions on how to install, build and use the Trusted Firmware with the ARM FVPs.

See the Firmware Design for information on how the Trusted Firmware works.

See the Porting Guide as well for information about how to use this software on another ARMv8-A platform.

See the Contributing Guidelines for information on how to contribute to this project and the Acknowledgments file for a list of contributors to the project.

Feedback and support

ARM welcomes any feedback on Trusted Firmware. If you think you have found a security vulnerability, please report this using the process defined in the Trusted Firmware Security Centre. For all other feedback, please use the GitHub issue tracker.

ARM licensees may contact ARM directly via their partner managers.


Copyright (c) 2013-2017, ARM Limited and Contributors. All rights reserved.