Doc: Updated for Version 1.0-RC1
This patch updates the documentation landing
page (readme.rst) to reflect the latest
release (Version 1.0-RC1).
* Updated Sphynx documentation version tags
* Updated Doxygen documentation version tags
* Updated features/capabilities described in readme.rst
Change-Id: I273127e18b21e1c71feb140215f80a9826c0e0df
Signed-off-by: Galanakis, Minos <minos.galanakis@arm.com>
diff --git a/cmake/Common/BuildDoxygenDoc.cmake b/cmake/Common/BuildDoxygenDoc.cmake
index a56898b..272948f 100644
--- a/cmake/Common/BuildDoxygenDoc.cmake
+++ b/cmake/Common/BuildDoxygenDoc.cmake
@@ -85,7 +85,7 @@
#Version ID of TF-M.
#TODO: this shall not be hard-coded here. A process need to defined for
# versioning the document (and TF-M).
- set(DOXYCFG_TFM_VERSION "v1.0.0-Beta")
+ set(DOXYCFG_TFM_VERSION "v1.0-RC1")
#Using add_custom_command allows CMake to generate proper clean commands
#for document generation.
diff --git a/cmake/Common/BuildSphinxDoc.cmake b/cmake/Common/BuildSphinxDoc.cmake
index d3dd70f..9027495 100644
--- a/cmake/Common/BuildSphinxDoc.cmake
+++ b/cmake/Common/BuildSphinxDoc.cmake
@@ -83,8 +83,8 @@
#Version ID of TF-M.
#TODO: this shall not be hard-coded here. We need a process to define the
# version number of the document (and TF-M).
- set(SPHINXCFG_TFM_VERSION "1.0.0-Beta")
- set(SPHINXCFG_TFM_VERSION_FULL "Version 1.0.0-Beta")
+ set(SPHINXCFG_TFM_VERSION "v1.0-RC1")
+ set(SPHINXCFG_TFM_VERSION_FULL "Version 1.0-RC1")
get_filename_component(_NDX_FILE_DIR ${SPHINX_CONFIGURED_INDEX_FILE} DIRECTORY )
diff --git a/readme.rst b/readme.rst
index c135b28..3c58b18 100644
--- a/readme.rst
+++ b/readme.rst
@@ -1,12 +1,12 @@
-##############################
-Trusted Firmware M - v1.0-beta
-##############################
+#############################
+Trusted Firmware M - v1.0-RC1
+#############################
Trusted Firmware M provides a reference implementation of secure world software
for ARMv8-M.
.. Note::
The software implementation contained in this project is designed to be a
- reference implementation of the Arm Platform Security Architecture (PSA).
+ reference implementation of the Platform Security Architecture (PSA).
It currently does not implement all the features of that architecture,
however we expect the code to evolve along with the specifications.
@@ -41,44 +41,24 @@
############
This release includes:
- - A Secure FW with support for PSA Level 1 isolation on ARMv8M.
+ - A Secure FW with support for PSA Level 1 and 2 isolation on Armv8-M.
- The Interfaces exposed by the Secure FW to NS side.
- - A blocking secure fw model with NS application example.
+ - A secure fw model with NS application example.
- Secure services running within this SPE:
-
- - Secure Storage Service
- - Attestation
- - Crypto Service
+
+ - Secure Storage Service (PSA Protected Storage API - 1.0-beta-2)
+ - Attestation (PSA API 1.0-beta-0)
+ - Crypto Service (PSA API 1.0-beta-1)
- TF-M Audit Log
- Platform Service
- - Secure Storage Service
-
- - Support for ARMv8-M mainline and baseline
+
+ - PSA IPC support
+ - Support for Armv8-M mainline and baseline
- Testcases running baremetal and with RTX to test the functionality.
- - Basic support for higher level isolation but it is
- ``in progress with limited testing``.
- - BL2 bootloader for image authentication based on SHA256 and RSA-2048
+ - BL2 bootloader for image authentication based on SHA256 and RSA-3072
digital signature.
- Build system based on cmake, supporting armclang and GNU Arm.
-***********
-In progress
-***********
-- Ongoing and incremental support for PSA features:
-
- - Level 2 and 3 PSA isolation
- - PSA IPC support
- - Bootloader enhancements
- - ...
-
-- OS support and use case examples:
-
- - mbed OS upstream support
- - mbed cloud client examples
- - ...
-
-- Ongoing security hardening, optimization and quality improvements.
-
*********
Platforms
*********
@@ -159,6 +139,8 @@
+=============+==============+====================+
| v1.0-beta | 2019-02-15 | 1.0-beta release |
+-------------+--------------+--------------------+
+| v1.0-RC1 | 2019-05-31 | 1.0-RC1 release |
++-------------+--------------+--------------------+
--------------