aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Beesley <paul.beesley@arm.com>2019-11-28 10:36:42 +0000
committerTrustedFirmware Code Review <review@review.trustedfirmware.org>2019-11-28 10:36:42 +0000
commit535f1be59d83351423aa6e712f8fcf49a7116450 (patch)
tree71d766a25093b4e8bb82605c3fafc2bfc20d571b
parent6c81de700adcf68a9db9a3e6ae2c747d434d3dd9 (diff)
parent9fec7b280cff4cbd6b7556510829e26e02c5cce7 (diff)
downloadtf-a-tests-535f1be59d83351423aa6e712f8fcf49a7116450.tar.gz
Merge changes from topic "sphinx-doc"
* changes: doc: Move license file to docs folder doc: Reformat RST content for Sphinx rendering
-rw-r--r--docs/change-log.rst85
-rw-r--r--docs/design.rst9
-rw-r--r--docs/implementing-tests.rst11
-rw-r--r--docs/index.rst1
-rw-r--r--docs/license.rst68
-rw-r--r--docs/porting-guide.rst11
-rw-r--r--docs/user-guide.rst9
-rw-r--r--license.rst39
8 files changed, 118 insertions, 115 deletions
diff --git a/docs/change-log.rst b/docs/change-log.rst
index 29de0ed64..da967e4f0 100644
--- a/docs/change-log.rst
+++ b/docs/change-log.rst
@@ -1,8 +1,5 @@
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+Change Log & Release Notes
+==========================
Please note that the Trusted Firmware-A Tests version follows the Trusted
Firmware-A version for simplicity. At any point in time, TF-A Tests version
@@ -10,11 +7,11 @@ Firmware-A version for simplicity. At any point in time, TF-A Tests version
Tests are not guaranteed to be compatible. This also means that a version
upgrade on the TF-A-Tests side might not necessarily introduce any new feature.
-Trusted Firmware-A Tests - version 2.2
-======================================
+Version 2.2
+-----------
New features
-------------
+^^^^^^^^^^^^
- A wide range of tests are made available in this release to help validate
the functionality of TF-A.
@@ -22,7 +19,7 @@ New features
- Various improvements to test framework and test suite.
TFTF
-````
+~~~~
- Enhancement to xlat table library synchronous to TF-A code base.
@@ -74,18 +71,18 @@ TFTF
and fix the conditional check of AMU Group0 counter value.
Secure partitions
-`````````````````
+~~~~~~~~~~~~~~~~~
A new Secure Partition Quark is introduced in this release.
Quark
-'''''''''
+~~~~~
The Quark test secure partition provided is a simple service which returns a
magic number. Further, a simple test is added to test if Quark is functional.
Issues resolved since last release
-----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Bug fix in libc memchr implementation.
@@ -97,18 +94,14 @@ Issues resolved since last release
corresponding tests are stable in this release.
Known issues and limitations
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The sections below list the known issues and limitations of each test image
provided in this repository. Unless and otherwise stated, issues and limitations
stated in previous release continue to exist in this release.
TFTF
-````
-
-Tests
-'''''
-
+~~~~
- Multicore spurious interrupt test is observed to have unstable behavior. As a
temporary solution, this test is skipped for AArch64 Juno configurations.
@@ -119,11 +112,11 @@ Tests
-Trusted Firmware-A Tests - version 2.1
-======================================
+Version 2.1
+-----------
New features
-------------
+^^^^^^^^^^^^
- Add initial support for testing Secure Partition Client Interface (SPCI)
and Secure Partition Run-Time (SPRT) standards.
@@ -139,7 +132,7 @@ New features
- Various stability improvements, code refactoring and clean ups.
TFTF
-````
+~~~~
- Reorganize tests build infrastructure to allow the selection of a subset of
tests.
@@ -173,7 +166,7 @@ TFTF
- `Arm Neoverse Reference Design N1 Edge (RD-N1-Edge)`_ FVP (experimental).
Secure partitions
-`````````````````
+~~~~~~~~~~~~~~~~~
We now have 3 Secure Partitions to test the SPM implementation in TF-A.
@@ -211,7 +204,7 @@ multiple partitions support in TF-A. It is derived from Cactus and essentially
provides the same services but with different identifiers at the moment.
EL3 payload
-```````````
+~~~~~~~~~~~
- New platform ports:
@@ -220,7 +213,7 @@ EL3 payload
- `Arm Neoverse Reference Design N1 Edge (RD-N1-Edge)`_ FVP (experimental).
Issues resolved since last release
-----------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- The GICv2 spurious IRQ test is no longer Juno-specific. It is now only
GICv2-specific.
@@ -233,19 +226,19 @@ Issues resolved since last release
- Cactus-MM now successfully links with GNU toolchain 7.3.1.
Known issues and limitations
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The sections below lists the known issues and limitations of each test image
provided in this repository.
TFTF
-````
+~~~~
The TFTF test image might be conceptually sub-divided further in 2 parts: the
tests themselves, and the test framework they are based upon.
Test framework
-''''''''''''''
+~~~~~~~~~~~~~~
- Some stability issues.
@@ -285,7 +278,7 @@ Test framework
It is only enabled on the primary CPU on the cold boot.
Tests
-'''''
+~~~~~
- Some tests are implemented for AArch64 only and are skipped on AArch32.
@@ -324,7 +317,7 @@ Tests
The root cause is unknown.
FWU images
-``````````
+~~~~~~~~~~
- The FWU tests do not work on the revC of the Base AEM FVP. They only work on
the revB.
@@ -333,7 +326,7 @@ FWU images
is not a clean design and may cause confusion.
Test secure partitions (Cactus, Cactus-MM, Ivy)
-```````````````````````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- This is experimental code. It's likely to change a lot as the secure
partition software architecture evolves.
@@ -341,7 +334,7 @@ Test secure partitions (Cactus, Cactus-MM, Ivy)
- Supported on AArch64 FVP platform only.
All test images
-```````````````
+~~~~~~~~~~~~~~~
- TF-A Tests are derived from a fork of TF-A so:
@@ -376,16 +369,16 @@ All test images
all such direct reads of the ``CNTPCT_EL0`` register and replace them with a
call to ``syscounter_read()`` where appropriate.
-Trusted Firmware-A Tests - version 2.0
-======================================
+Version 2.0
+-----------
New features
-------------
+^^^^^^^^^^^^
This is the first public release of the Trusted Firmware-A Tests source code.
TFTF
-````
+~~~~
- Provides a baremetal test framework to exercise TF-A features through its
``SMC`` interface.
@@ -433,7 +426,7 @@ TFTF
test results in non-volatile memory (e.g. flash).
FWU images
-``````````
+~~~~~~~~~~
- Provides example code to exercise the Firmware Update feature of TF-A.
@@ -442,12 +435,12 @@ FWU images
to the TF-A BL1 image.
EL3 test payload
-````````````````
+~~~~~~~~~~~~~~~~
- Tests the ability of TF-A to load an EL3 payload.
Cactus test secure partition
-````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Tests that TF-A has correctly setup the secure partition environment: it
should be allowed to perform cache maintenance operations, access floating
@@ -459,19 +452,19 @@ Cactus test secure partition
- Tests the ability of a secure partition to handle StandaloneMM requests.
Known issues and limitations
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The sections below lists the known issues and limitations of each test image
provided in this repository.
TFTF
-````
+~~~~
The TFTF test image might be conceptually sub-divided further in 2 parts: the
tests themselves, and the test framework they are based upon.
Test framework
-''''''''''''''
+~~~~~~~~~~~~~~
- Some stability issues.
@@ -507,7 +500,7 @@ Test framework
not complete. As a result, there are still some TFTF files scattered around.
Tests
-'''''
+~~~~~
- Some tests are implemented for AArch64 only and are skipped on AArch32.
@@ -555,7 +548,7 @@ Tests
The root cause is unknown.
FWU images
-``````````
+~~~~~~~~~~
- The FWU tests do not work on the revC of the Base AEM FVP. They only work on
the revB.
@@ -564,7 +557,7 @@ FWU images
is not a clean design and may cause confusion.
Cactus test secure partition
-````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Cactus is experimental code. It's likely to change a lot as the secure
partition software architecture evolves.
@@ -574,7 +567,7 @@ Cactus test secure partition
- Cactus is supported on AArch64 FVP platform only.
All test images
-```````````````
+~~~~~~~~~~~~~~~
- TF-A Tests are derived from a fork of TF-A so:
diff --git a/docs/design.rst b/docs/design.rst
index 91815d02d..4df620c45 100644
--- a/docs/design.rst
+++ b/docs/design.rst
@@ -1,10 +1,5 @@
-Trusted Firmware-A Tests - Design
-=================================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+Design
+======
This document provides some details about the internals of the TF-A Tests
design. It is incomplete at the moment.
diff --git a/docs/implementing-tests.rst b/docs/implementing-tests.rst
index f7be28433..3810c14de 100644
--- a/docs/implementing-tests.rst
+++ b/docs/implementing-tests.rst
@@ -1,10 +1,5 @@
-How to implement tests
-======================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+Implementing Tests
+==================
This document aims at providing some pointers to help implementing new tests in
the TFTF image.
@@ -114,7 +109,7 @@ See the template test manifest for reference: `tftf/tests/tests-template.xml`_.
--------------
-*Copyright (c) 2018, Arm Limited. All rights reserved.*
+*Copyright (c) 2018-2019, Arm Limited. All rights reserved.*
.. _SMC Calling Convention: SMCCC_
.. _SMCCC: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ARM_DEN0028B_SMC_Calling_Convention.pdf
diff --git a/docs/index.rst b/docs/index.rst
index 8a326082c..29b25d527 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,6 +11,7 @@ Trusted Firmware-A Tests Documentation
implementing-tests
design
change-log
+ license
--------------
diff --git a/docs/license.rst b/docs/license.rst
new file mode 100644
index 000000000..46124fcd2
--- /dev/null
+++ b/docs/license.rst
@@ -0,0 +1,68 @@
+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`_.
+
+::
+
+ Copyright (c) <year> <owner>. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ - Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ - Neither the name of the copyright holder nor the names of its
+ contributors may be used to endorse or promote products derived from this
+ software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+
+SPDX Identifiers
+----------------
+
+Individual files contain the following tag instead of the full license text.
+
+::
+
+ SPDX-License-Identifier: BSD-3-Clause
+
+This enables machine processing of license information based on the SPDX
+License Identifiers that are here available: http://spdx.org/licenses/
+
+Other Projects
+--------------
+
+This project contains code from other projects as listed below. The original
+license text is included in those source files.
+
+- The libc source code is derived from `FreeBSD`_ and `SCC`_. FreeBSD uses
+ various BSD licenses, including BSD-3-Clause and BSD-2-Clause. The SCC code
+ is used under the BSD-3-Clause license with the author's permission.
+
+- The `LLVM compiler-rt`_ source code is disjunctively dual licensed
+ (NCSA OR MIT). It is used by this project under the terms of the NCSA
+ license (also known as the University of Illinois/NCSA Open Source License),
+ which is a permissive license compatible with BSD-3-Clause. Any
+ contributions to this code must be made under the terms of both licenses.
+
+.. _FreeBSD: http://www.freebsd.org
+.. _SCC: http://www.simple-cc.org/
+.. _LLVM compiler-rt: https://compiler-rt.llvm.org/
diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst
index 9759c9865..ba9b9aaf8 100644
--- a/docs/porting-guide.rst
+++ b/docs/porting-guide.rst
@@ -1,12 +1,5 @@
-Trusted Firmware-A Tests - Porting Guide
-========================================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
-
---------------
+Porting Guide
+=============
Introduction
------------
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 2e6f7bae5..41d0ba778 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -1,10 +1,5 @@
-Trusted Firmware-A Tests - User Guide
-=====================================
-
-.. section-numbering::
- :suffix: .
-
-.. contents::
+User Guide
+==========
This document describes how to build the Trusted Firmware-A Tests (TF-A Tests)
and run them on a set of platforms. It assumes that the reader has previous
diff --git a/license.rst b/license.rst
index 3c873110c..3ec3b74f9 100644
--- a/license.rst
+++ b/license.rst
@@ -1,38 +1 @@
-Copyright (c) <year> <owner>. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-- Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
-
-- Redistributions in binary form must reproduce the above copyright notice, this
- list of conditions and the following disclaimer in the documentation and/or
- other materials provided with the distribution.
-
-- Neither the name of the copyright holder nor the names of its contributors
- may be used to endorse or promote products derived from this software without
- specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
---------------
-
-Note:
-Individual files contain the following tag instead of the full license text.
-
-::
-
- SPDX-License-Identifier: BSD-3-Clause
-
-This enables machine processing of license information based on the SPDX
-License Identifiers that are here available: http://spdx.org/licenses/
+See docs/license.rst