2014-05-29 18:07:23 +00:00
|
|
|
ARM Trusted Firmware - version 0.4
|
2013-10-25 08:08:21 +00:00
|
|
|
==================================
|
|
|
|
|
|
|
|
|
|
ARM Trusted Firmware provides a reference implementation of secure world
|
2014-02-26 17:20:40 +00:00
|
|
|
software for [ARMv8-A], including Exception Level 3 (EL3) software. This
|
2013-10-25 08:08:21 +00:00
|
|
|
release focuses on support for ARM's [Fixed Virtual Platforms (FVPs)] [FVP].
|
|
|
|
|
|
|
|
|
|
The intent is to provide a reference implementation of various ARM interface
|
|
|
|
|
standards, such as the Power State Coordination Interface ([PSCI]), Trusted
|
|
|
|
|
Board Boot Requirements (TBBR) and [Secure Monitor] [TEE-SMC] code. As far as
|
2013-10-29 10:56:46 +00:00
|
|
|
possible the code is designed for reuse or porting to other ARMv8-A model and
|
2013-10-25 08:08:21 +00:00
|
|
|
hardware platforms.
|
|
|
|
|
|
2014-05-29 18:07:23 +00:00
|
|
|
This release builds on previous source code releases, supporting the Base and
|
|
|
|
|
Foundation FVP platform models from ARM.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
ARM will continue development in collaboration with interested parties to
|
|
|
|
|
provide a full reference implementation of PSCI, TBBR and Secure Monitor code
|
2014-05-29 18:07:23 +00:00
|
|
|
to the benefit of all developers working with ARMv8-A TrustZone technology.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
The software is provided under a BSD 3-Clause [license]. Certain source files
|
|
|
|
|
are derived from FreeBSD code: the original license is included in these
|
|
|
|
|
source files.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This Release
|
|
|
|
|
------------
|
|
|
|
|
|
2014-05-29 18:07:23 +00:00
|
|
|
This release is a limited functionality implementation of the Trusted Firmware.
|
|
|
|
|
It provides a suitable starting point for productization. Future versions will
|
|
|
|
|
contain new features, optimizations and quality improvements.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
### Functionality
|
|
|
|
|
|
|
|
|
|
* Initial implementation of a subset of the Trusted Board Boot Requirements
|
2014-02-26 17:20:40 +00:00
|
|
|
Platform Design Document (PDD). This includes packaging the various firmware
|
|
|
|
|
images into a Firmware Image Package (FIP) to be loaded from non-volatile
|
|
|
|
|
storage.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
* Initializes the secure world (for example, exception vectors, control
|
|
|
|
|
registers, GIC and interrupts for the platform), before transitioning into
|
|
|
|
|
the normal world.
|
|
|
|
|
|
|
|
|
|
* Supports both GICv2 and GICv3 initialization for use by normal world
|
|
|
|
|
software.
|
|
|
|
|
|
|
|
|
|
* Starts the normal world at the highest available Exception Level: EL2
|
|
|
|
|
if available, otherwise EL1.
|
|
|
|
|
|
|
|
|
|
* Handles SMCs (Secure Monitor Calls) conforming to the [SMC Calling
|
2014-02-26 17:20:40 +00:00
|
|
|
Convention PDD] [SMCCC] using an EL3 runtime services framework.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
* Handles SMCs relating to the [Power State Coordination Interface PDD] [PSCI]
|
2014-02-26 17:20:40 +00:00
|
|
|
for the Secondary CPU Boot, CPU hotplug and CPU idle use-cases.
|
|
|
|
|
|
|
|
|
|
* A Test Secure-EL1 Payload and Dispatcher to demonstrate Secure Monitor
|
2014-05-29 18:07:23 +00:00
|
|
|
functionality such as world switching, EL1 context management and interrupt
|
|
|
|
|
routing. This also demonstrates Secure-EL1 interaction with PSCI. Some of
|
|
|
|
|
this functionality is provided in library form for re-use by other
|
|
|
|
|
Secure-EL1 Payload Dispatchers.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
2014-05-29 18:07:23 +00:00
|
|
|
* Support for alternative Trusted Boot Firmware. Some platforms have their own
|
|
|
|
|
Trusted Boot implementation and only require the Secure Monitor
|
|
|
|
|
functionality provided by ARM Trusted Firmware.
|
|
|
|
|
|
|
|
|
|
* Isolation of memory accessible by the secure world from the normal world
|
|
|
|
|
through programming of a TrustZone controller.
|
|
|
|
|
|
|
|
|
|
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.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
### Platforms
|
|
|
|
|
|
|
|
|
|
This release of the Trusted Firmware has been tested on the following ARM
|
|
|
|
|
[FVP]s (64-bit versions only):
|
|
|
|
|
|
2014-02-26 17:20:40 +00:00
|
|
|
* `Foundation_v8` (Version 2.0, Build 0.8.5206)
|
2014-05-29 18:07:23 +00:00
|
|
|
* `FVP_Base_AEMv8A-AEMv8A` (Version 5.6, Build 0.8.5602)
|
|
|
|
|
* `FVP_Base_Cortex-A57x4-A53x4` (Version 5.6, Build 0.8.5602)
|
|
|
|
|
* `FVP_Base_Cortex-A57x1-A53x1` (Version 5.6, Build 0.8.5602)
|
|
|
|
|
* `FVP_Base_Cortex-A57x2-A53x4` (Version 5.6, Build 0.8.5602)
|
2013-10-29 10:56:46 +00:00
|
|
|
|
2014-02-26 17:20:40 +00:00
|
|
|
The Foundation FVP can be downloaded free of charge. The Base FVPs can be
|
|
|
|
|
licensed from ARM: see [www.arm.com/fvp] [FVP].
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
### Still to Come
|
|
|
|
|
|
2014-05-29 18:07:23 +00:00
|
|
|
* Support for ARMv8-A development board as a reference platform.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
2014-05-29 18:07:23 +00:00
|
|
|
* Complete Trusted Boot implementation.
|
|
|
|
|
|
|
|
|
|
* Complete implementation of the [PSCI] specification.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
2014-05-29 18:07:23 +00:00
|
|
|
* Support for alternative types of Secure-EL1 Payloads.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
* Completing the currently experimental GICv3 support.
|
|
|
|
|
|
|
|
|
|
For a full list of detailed issues in the current code, please see the [Change
|
2014-02-26 17:20:40 +00:00
|
|
|
Log] and the [GitHub issue tracker].
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Getting Started
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Get the Trusted Firmware source code from
|
|
|
|
|
[GitHub](https://www.github.com/ARM-software/arm-trusted-firmware).
|
|
|
|
|
|
|
|
|
|
See the [User Guide] for instructions on how to install, build and use
|
|
|
|
|
the Trusted Firmware with the ARM [FVP]s.
|
|
|
|
|
|
2014-02-26 17:20:40 +00:00
|
|
|
See the [Firmware Design] for information on how the ARM Trusted Firmware works.
|
|
|
|
|
|
2013-10-25 08:08:21 +00:00
|
|
|
See the [Porting Guide] as well for information about how to use this
|
2013-10-29 10:56:46 +00:00
|
|
|
software on another ARMv8-A platform.
|
2013-10-25 08:08:21 +00:00
|
|
|
|
2013-12-02 19:25:12 +00:00
|
|
|
See the [Contributing Guidelines] for information on how to contribute to this
|
2014-05-29 18:07:23 +00:00
|
|
|
project and the [Acknowledgments] file for a list of contributors to the
|
2013-12-02 19:25:12 +00:00
|
|
|
project.
|
|
|
|
|
|
2013-10-25 08:08:21 +00:00
|
|
|
### Feedback and support
|
|
|
|
|
|
|
|
|
|
ARM welcomes any feedback on the Trusted Firmware. Please send feedback using
|
2014-02-26 17:20:40 +00:00
|
|
|
the [GitHub issue tracker].
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
ARM licensees may contact ARM directly via their partner managers.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- - - - - - - - - - - - - - - - - - - - - - - - - -
|
|
|
|
|
|
2014-01-14 18:17:09 +00:00
|
|
|
_Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved._
|
2013-10-25 08:08:21 +00:00
|
|
|
|
|
|
|
|
|
2013-12-02 19:25:12 +00:00
|
|
|
[License]: ./license.md "BSD license for ARM Trusted Firmware"
|
|
|
|
|
[Contributing Guidelines]: ./contributing.md "Guidelines for contributors"
|
2014-05-29 18:07:23 +00:00
|
|
|
[Acknowledgments]: ./acknowledgements.md "Contributor acknowledgments"
|
2013-12-02 19:25:12 +00:00
|
|
|
[Change Log]: ./docs/change-log.md
|
|
|
|
|
[User Guide]: ./docs/user-guide.md
|
2014-02-26 17:20:40 +00:00
|
|
|
[Firmware Design]: ./docs/firmware-design.md
|
2013-12-02 19:25:12 +00:00
|
|
|
[Porting Guide]: ./docs/porting-guide.md
|
2013-10-25 08:08:21 +00:00
|
|
|
|
2014-02-26 17:20:40 +00:00
|
|
|
[ARMv8-A]: http://www.arm.com/products/processors/armv8-architecture.php "ARMv8-A Architecture"
|
|
|
|
|
[FVP]: http://www.arm.com/fvp "ARM's Fixed Virtual Platforms"
|
|
|
|
|
[PSCI]: http://infocenter.arm.com/help/topic/com.arm.doc.den0022b/index.html "Power State Coordination Interface PDD (ARM DEN 0022B.b)"
|
|
|
|
|
[SMCCC]: http://infocenter.arm.com/help/topic/com.arm.doc.den0028a/index.html "SMC Calling Convention PDD (ARM DEN 0028A)"
|
|
|
|
|
[TEE-SMC]: http://www.arm.com/products/processors/technologies/trustzone/tee-smc.php "Secure Monitor and TEEs"
|
|
|
|
|
[GitHub issue tracker]: https://github.com/ARM-software/tf-issues/issues
|
