diff options
author | Jimmy Brisson <jimmy.brisson@arm.com> | 2020-04-02 15:19:20 -0500 |
---|---|---|
committer | Jimmy Brisson <jimmy.brisson@arm.com> | 2020-04-20 10:04:20 -0500 |
commit | 6fcd961325227ec0cb54e8b8ab2c9dc9a52a4739 (patch) | |
tree | 232fcac52d79f6b40ca1816be608c9a3a5a87abc /docs | |
parent | a48f50719a5c957bd67c68d5bdeec582dff6c59c (diff) | |
download | tf-a-tests-6fcd961325227ec0cb54e8b8ab2c9dc9a52a4739.tar.gz |
doc: Sync common content with TF-A
Some information, such as contact details, is shared between
TF-A and the TF-A Tests. Bring this into line with what is in
the TF-A repo.
Change-Id: I910e229a93da67c85d70c633d5a4597a6a788b50
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/about/contact.rst | 30 | ||||
-rw-r--r-- | docs/about/features.rst | 45 | ||||
-rw-r--r-- | docs/index.rst | 22 |
3 files changed, 61 insertions, 36 deletions
diff --git a/docs/about/contact.rst b/docs/about/contact.rst index 0f3821e1b..a84dc5218 100644 --- a/docs/about/contact.rst +++ b/docs/about/contact.rst @@ -1,15 +1,33 @@ Support & Contact ================= -Contact us ----------- +We welcome any feedback on TF-A Tests and there are several methods for +providing it or for obtaining support. -We welcome any feedback on TF-A Tests. You can use either the `issue tracker`_ -or our `mailing list`_. +Mailing Lists +^^^^^^^^^^^^^ + +Public mailing lists for TF-A Tests and the wider Trusted Firmware project are +hosted on TrustedFirmware.org. The mailing lists can be used for general +enquiries, enhancement requests and issue reports, or to follow and participate +in technical or organizational discussions around the project. These discussions +include design proposals, advance notice of changes and upcoming events. + +The relevant list for the TF-A Tests project is `TF-A-Tests development`_ + +You can see a `summary of all the lists`_ on the TrustedFirmware.org website. + +Issue Tracker +^^^^^^^^^^^^^ + +Specific issues may be raised using the `issue tracker`_ on the +TrustedFirmware.org website. Using this tracker makes it easy for the +maintainers to prioritise and respond to your ticket. -------------- *Copyright (c) 2019, Arm Limited. All rights reserved.* -.. _issue tracker: https://developer.trustedfirmware.org/project/board/9/ -.. _mailing list: https://lists.trustedfirmware.org/mailman/listinfo/tf-a-tests +.. _`issue tracker`: https://developer.trustedfirmware.org +.. _`TF-A-Tests development`: https://lists.trustedfirmware.org/pipermail/tf-a-tests/ +.. _`summary of all the lists`: https://lists.trustedfirmware.org diff --git a/docs/about/features.rst b/docs/about/features.rst index 16055fc96..2b810cec8 100644 --- a/docs/about/features.rst +++ b/docs/about/features.rst @@ -1,15 +1,44 @@ Feature Overview ================ +This page provides an overview of the current TF-A Tests feature set. The +:ref:`Change Log & Release Notes` document provides details of changes made +since the last release. + +Current Features +---------------- + +The following TF-A features are currently tested to some extent (this list is +not exhaustive): + +- `SMC Calling Convention`_ +- `Power State Coordination Interface (PSCI)`_ +- `Software Delegated Exception Interface (SDEI)`_ +- `Performance Measurement Framework (PMF)`_ +- Communication and interaction with the `Test Secure Payload (TSP)`_ +- `Firmware update`_ (or recovery mode) +- `EL3 payload`_ boot flow +- `Secure partition`_ support + +These tests are not a compliance test suite for the Arm interface standards used +in TF-A (such as PSCI). + +They do not cover 100% of the TF-A code. The fact that all tests pass does not +mean that TF-A is free of bugs. + +They are not reference code. They should not be considered as the official way +to test hardware/firmware features. Instead, they are provided as example code +to experiment with and improve on. + Still to come -````````````` - -- More tests. -- Support for new platforms. -- Design improvements. -- Stability improvements. -- Enhance test framework to make it easier to implement tests. -- Fixing known issues (see the `change log`_ for more details). +------------- + +- Additional tests +- Support for new platforms +- Design improvements +- Stability improvements +- Enhancements to the test framework to make it easier to implement tests +- Fixes for known issues (detailed in :ref:`Change Log & Release Notes`) -------------- diff --git a/docs/index.rst b/docs/index.rst index e8eee2f30..b48367119 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,28 +23,6 @@ mainly interacts with TF-A through its SMC interface. It provides a basis for TF-A developers to validate their own platform ports and add their own test cases. -The following TF-A features are currently tested to some extent (this list is -not exhaustive): - -- `SMC Calling Convention`_ -- `Power State Coordination Interface (PSCI)`_ -- `Software Delegated Exception Interface (SDEI)`_ -- `Performance Measurement Framework (PMF)`_ -- Communication and interaction with the `Test Secure Payload (TSP)`_ -- `Firmware update`_ (or recovery mode) -- `EL3 payload`_ boot flow -- `Secure partition`_ support - -These tests are not a compliance test suite for the Arm interface standards used -in TF-A (such as PSCI). - -They do not cover 100% of the TF-A code. The fact that all tests pass does not -mean that TF-A is free of bugs. - -They are not reference code. They should not be considered as the official way -to test hardware/firmware features. Instead, they are provided as example code -to experiment with and improve on. - Getting started --------------- |