aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorDan Handley <dan.handley@arm.com>2014-02-26 17:20:40 +0000
committerDan Handley <dan.handley@arm.com>2014-02-28 18:23:42 +0000
commitb2388490302d41038a5dd9a16d7f6d554c828bd3 (patch)
treec08dc483d22f6e5fa1ee0330da29b03c5012f2f4 /readme.md
parent57de6d72743078ce49587c2042b5da285201b126 (diff)
downloadarm-trusted-firmware-b2388490302d41038a5dd9a16d7f6d554c828bd3.tar.gz
Add v0.3 release documentation
Update the readme.md and change-log.md with release information. Also, remove the "Detailed changes since last release" section of the change-log.md since the same information can be found in the GIT commit messages. Fixes ARM-software/tf-issues#22. Change-Id: I968cc8aaf588aa5c34ba8f1c12a5b797a46e04f5
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md64
1 files changed, 38 insertions, 26 deletions
diff --git a/readme.md b/readme.md
index 2b8bb63..756cf14 100644
--- a/readme.md
+++ b/readme.md
@@ -1,8 +1,8 @@
-ARM Trusted Firmware - version 0.2
+ARM Trusted Firmware - version 0.3
==================================
ARM Trusted Firmware provides a reference implementation of secure world
-software for [ARMv8-A], including Exception Level 3 (EL3) software. This first
+software for [ARMv8-A], including Exception Level 3 (EL3) software. This
release focuses on support for ARM's [Fixed Virtual Platforms (FVPs)] [FVP].
The intent is to provide a reference implementation of various ARM interface
@@ -11,9 +11,9 @@ Board Boot Requirements (TBBR) and [Secure Monitor] [TEE-SMC] code. As far as
possible the code is designed for reuse or porting to other ARMv8-A model and
hardware platforms.
-This release is the first one as source code: an initial prototype
-release was available in binary form in the [Linaro AArch64 OpenEmbedded
-Engineering Build] [AArch64 LEB] to support the new FVP Base platform
+This release builds on the previous source code release, which has been
+available in source and binary form since the [Linaro AArch64 OpenEmbedded 13.11
+Engineering Build] [AArch64 LEB]. These support the Base FVP platform
models from ARM.
ARM will continue development in collaboration with interested parties to
@@ -32,14 +32,16 @@ source files.
This Release
------------
-This software is an early implementation of the Trusted Firmware. Only
+This release is an incomplete implementation of the Trusted Firmware. Only
limited functionality is provided at present and it has not been optimized or
subjected to extended robustness or stress testing.
### Functionality
* Initial implementation of a subset of the Trusted Board Boot Requirements
- Platform Design Document (PDD).
+ Platform Design Document (PDD). This includes packaging the various firmware
+ images into a Firmware Image Package (FIP) to be loaded from non-volatile
+ storage.
* Initializes the secure world (for example, exception vectors, control
registers, GIC and interrupts for the platform), before transitioning into
@@ -52,10 +54,16 @@ subjected to extended robustness or stress testing.
if available, otherwise EL1.
* Handles SMCs (Secure Monitor Calls) conforming to the [SMC Calling
- Convention PDD] [SMCCC].
+ Convention PDD] [SMCCC] using an EL3 runtime services framework.
* Handles SMCs relating to the [Power State Coordination Interface PDD] [PSCI]
- for the Secondary CPU Boot and CPU hotplug use-cases.
+ for the Secondary CPU Boot, CPU hotplug and CPU idle use-cases.
+
+* A Test Secure-EL1 Payload and Dispatcher to demonstrate Secure Monitor
+ functionality such as world switching and EL1 context management. 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.
For a full list of updated functionality and implementation details, please
see the [User Guide]. The [Change Log] provides details of changes made
@@ -66,26 +74,27 @@ since the last release.
This release of the Trusted Firmware has been tested on the following ARM
[FVP]s (64-bit versions only):
-* `FVP_Base_AEMv8A-AEMv8A` (Version 5.1, Build 0.8.5108).
-* `FVP_Base_Cortex-A57x4-A53x4` (Version 5.1, Build 0.8.5108).
-* `FVP_Base_Cortex-A57x1-A53x1` (Version 5.1, Build 0.8.5108).
-
-These models can be licensed from ARM: see [www.arm.com/fvp] [FVP].
+* `Foundation_v8` (Version 2.0, Build 0.8.5206)
+* `FVP_Base_AEMv8A-AEMv8A` (Version 5.4, Build 0.8.5405)
+* `FVP_Base_Cortex-A57x4-A53x4` (Version 5.4, Build 0.8.5405)
+* `FVP_Base_Cortex-A57x1-A53x1` (Version 5.4, Build 0.8.5405)
-For an updated list of supported platforms, please see the [Change Log].
+The Foundation FVP can be downloaded free of charge. The Base FVPs can be
+licensed from ARM: see [www.arm.com/fvp] [FVP].
### Still to Come
* Complete implementation of the [PSCI] specification.
-* Secure memory, Secure monitor, Test Secure OS & Secure interrupts.
+* Secure memory, Secure interrupts and support for other types of Secure-EL1
+ Payloads.
-* Booting the firmware from a block device.
+* Booting the firmware from a Virtio block device.
* Completing the currently experimental GICv3 support.
For a full list of detailed issues in the current code, please see the [Change
-Log].
+Log] and the [GitHub issue tracker].
Getting Started
@@ -97,6 +106,8 @@ Get the Trusted Firmware source code from
See the [User Guide] for instructions on how to install, build and use
the Trusted Firmware with the ARM [FVP]s.
+See the [Firmware Design] for information on how the ARM Trusted Firmware works.
+
See the [Porting Guide] as well for information about how to use this
software on another ARMv8-A platform.
@@ -107,8 +118,7 @@ project.
### Feedback and support
ARM welcomes any feedback on the Trusted Firmware. Please send feedback using
-the [GitHub issue tracker](
-https://github.com/ARM-software/tf-issues/issues).
+the [GitHub issue tracker].
ARM licensees may contact ARM directly via their partner managers.
@@ -123,11 +133,13 @@ _Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved._
[Acknowledgements]: ./acknowledgements.md "Contributor acknowledgements"
[Change Log]: ./docs/change-log.md
[User Guide]: ./docs/user-guide.md
+[Firmware Design]: ./docs/firmware-design.md
[Porting Guide]: ./docs/porting-guide.md
-[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"
-[AArch64 LEB]: http://releases.linaro.org/13.09/openembedded/aarch64 "Linaro AArch64 OpenEmbedded ARM Fast Model 13.09 Release"
+[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"
+[AArch64 LEB]: http://releases.linaro.org/13.11/openembedded/aarch64 "Linaro AArch64 OpenEmbedded ARM Fast Model 13.11 Release"
+[GitHub issue tracker]: https://github.com/ARM-software/tf-issues/issues