aboutsummaryrefslogtreecommitdiff
path: root/platform
diff options
context:
space:
mode:
authorSummer Qin <summer.qin@arm.com>2021-04-06 17:22:15 +0800
committerSummer Qin <summer.qin@arm.com>2021-04-21 10:34:53 +0800
commitabf6698dd6b916de5aea971783aa80776bf296dd (patch)
tree7e1727767491c52d7bce438d2bf88c89fb05da78 /platform
parentcdaec9c383182052b8535b74e92a4799b98236cd (diff)
downloadtrusted-firmware-m-abf6698dd6b916de5aea971783aa80776bf296dd.tar.gz
Docs: Restructure the documents
Restructure the file category to let it more friendly to users. Signed-off-by: Summer Qin <summer.qin@arm.com> Change-Id: I7ced0e2d700ce03423e472e0098608f3445ba169
Diffstat (limited to 'platform')
-rw-r--r--platform/ext/index.rst10
-rw-r--r--platform/ext/platform_deprecation.rst68
-rw-r--r--platform/ext/target/musca_b1/secure_enclave/readme.rst4
3 files changed, 75 insertions, 7 deletions
diff --git a/platform/ext/index.rst b/platform/ext/index.rst
index d763c7c73..1d12b9a7c 100644
--- a/platform/ext/index.rst
+++ b/platform/ext/index.rst
@@ -1,13 +1,13 @@
-Platforms
-=========
+Supported Platforms
+===================
.. toctree::
:maxdepth: 1
:caption: Information
- readme
/platform/readme
- /docs/contributing/platform_deprecation.rst
+ readme
+ /platform/ext/platform_deprecation.rst
.. toctree::
:maxdepth: 4
@@ -55,4 +55,4 @@ Platforms
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/platform/ext/platform_deprecation.rst b/platform/ext/platform_deprecation.rst
new file mode 100644
index 000000000..5d7a3de98
--- /dev/null
+++ b/platform/ext/platform_deprecation.rst
@@ -0,0 +1,68 @@
+################################
+Platform deprecation and removal
+################################
+
+********************************************
+Process for Platform deprecation and removal
+********************************************
+
+A platform may need to be removed from upstream code due to lack of community
+interest or it may have reached end of life. The below section calls out the
+process for removing platform support from TF-M.
+
+ 1. An email to the TF-M mailing list proposing the removal of the platform.
+
+ 2. The merit of the proposal will be considered by the maintainers for a
+ period of 4 weeks and community can express their opinion on the same
+ during this time window. The platform owner can veto the proposal and
+ incase of multiple platform owners with differing opinion or community
+ having interest in the platform, then the project maintainer can work
+ with the platform owner and use their discretion to decide on the
+ proposal.
+
+ 3. Once a decision is made to remove the platform, the platform is
+ considered to be in `deprecated` state as per platform support lifecyle
+ defined here: "https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/".
+ The platform will be marked as deprecated and the TF-M version after
+ which it will be removed will also be mentioned. Suitable build time
+ or runtime messages needs to be incorporated to the platform to warn
+ about the `deprecation`.
+
+ 4. The project should strive to keep the `deprecated` platforms
+ building/running till the removal. This relies on platform owners being
+ still actively involved with the project and maintaining the platform.
+
+ 5. Although this will be the usual process for platform deprecation and
+ eventual removal, the process still leaves room for the platform
+ deprecation to be cancelled after it has been marked as `deprecated`
+ due to evolving project and market requirements. This is left to
+ consensus between project maintainers and platform owner/s.
+
+ 6. Once a platform has been removed, it can be added back in future and
+ this would follow the same guidelines as for a new platform contribution.
+
+****************************
+List of Deprecated Platforms
+****************************
+
+The below list calls out platforms marked for deprecation according to the
+above process and the platform will be removed soon after the mentioned
+release.
+
++--------------------------------------+-----------+---------------------------+
+| Deprecated Platform | Removed | Comments |
+| | after | |
+| | release | |
++======================================+===========+===========================+
+| mps2/an539 | v1.2.0 | N.A |
++--------------------------------------+-----------+---------------------------+
+| mps2/sse-200_aws | v1.3.0 | N.A |
++--------------------------------------+-----------+---------------------------+
+| musca_a | v1.3.0 | N.A |
++--------------------------------------+-----------+---------------------------+
+| nordic_nrf/nrf5340pdk_nrf5340_cpuapp | v1.3.0 | N.A |
++--------------------------------------+-----------+---------------------------+
+
+--------------
+
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
diff --git a/platform/ext/target/musca_b1/secure_enclave/readme.rst b/platform/ext/target/musca_b1/secure_enclave/readme.rst
index 8b301aa37..a9af49577 100644
--- a/platform/ext/target/musca_b1/secure_enclave/readme.rst
+++ b/platform/ext/target/musca_b1/secure_enclave/readme.rst
@@ -17,7 +17,7 @@ SSE-200 subsystem used. But if the ``FORWARD_PROT_MSG`` cmake flag is turned
on, the TF-M instance running on SSE-200 will communicate with the SE.
For more information you can check the
-:doc:`Secure Enclave design document <docs/design_documents/secure_enclave_solution.rst>`.
+:doc:`Secure Enclave design document </docs/technical_references/secure_enclave_solution>`.
***********
System boot
@@ -102,4 +102,4 @@ Known limitations
--------------
-*Copyright (c) 2020, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*