Merge changes from topics "sb/deprecate-cryptocell", "sb/deprecation-policy" into integration

* changes:
  docs: deprecate CryptoCell-712/713 drivers
  docs: split deprecated interfaces and drivers
  docs: extend deprecation policy
This commit is contained in:
Sandrine Bailleux 2023-04-26 13:39:28 +02:00 committed by TrustedFirmware Code Review
commit 00cdd81ea7
2 changed files with 28 additions and 12 deletions

View file

@ -69,9 +69,26 @@ after which it will be removed.
+================================+=============+=========+=========================================================+ +================================+=============+=========+=========================================================+
| plat_convert_pk() function | Nov'22 | 2.9 | Platform conversion to manage specific PK hash | | plat_convert_pk() function | Nov'22 | 2.9 | Platform conversion to manage specific PK hash |
+--------------------------------+-------------+---------+---------------------------------------------------------+ +--------------------------------+-------------+---------+---------------------------------------------------------+
Removal of Deprecated Drivers
-----------------------------
As mentioned in the :ref:`Platform Ports Policy`, this is a live document
cataloging all the deprecated drivers in TF-A project and the Release version
after which it will be removed.
+--------------------------------+-------------+---------+---------------------------------------------------------+
| Driver | Deprecation | Removed | Comments |
| | Date | after | |
| | | Release | |
+================================+=============+=========+=========================================================+
| io_dummy driver | Nov'22 | 2.9 | No more used by any upstream platform | | io_dummy driver | Nov'22 | 2.9 | No more used by any upstream platform |
+--------------------------------+-------------+---------+---------------------------------------------------------+ +--------------------------------+-------------+---------+---------------------------------------------------------+
| CryptoCell-712 | 2.9 | 3.0 | No longer maintained. |
+--------------------------------+-------------+---------+---------------------------------------------------------+
| CryptoCell-713 | 2.9 | 3.0 | No longer maintained. |
+--------------------------------+-------------+---------+---------------------------------------------------------+
-------------- --------------
*Copyright (c) 2018-2022, Arm Limited and Contributors. All rights reserved.* *Copyright (c) 2018-2023, Arm Limited and Contributors. All rights reserved.*

View file

@ -32,20 +32,19 @@ public mailing list`_ to notify platforms that they should migrate away from the
deprecated interfaces. Platforms are expected to migrate before the removal of deprecated interfaces. Platforms are expected to migrate before the removal of
the deprecated interface. the deprecated interface.
Platform deprecation policy Deprecation policy
--------------------------- ------------------
If a platform is no longer maintained, it is best to deprecate it to keep the If a platform, driver or library interface is no longer maintained, it is best
projects' source tree clean and healthy. Deprecation can be a 1-stage or 2-stage to deprecate it to keep the projects' source tree clean and healthy. Deprecation
process (up to the platform maintainers). can be a 1-stage or 2-stage process (up to the maintainers).
- *2-stage*: The platform's source code can be kept in the repository for a - *2-stage*: The source code can be kept in the repository for a cooling off
cooling off period before deleting it (typically 2 release cycles). In this period before deleting it (typically 2 release cycles). In this case, we keep
case, we keep track ot the *Deprecated* version separately from the *Deleted* track of the *Deprecated* version separately from the *Deleted* version.
version.
- *1-stage*: The platform's source code can be deleted straight away. In this - *1-stage*: The source code can be deleted straight away. In this case, both
case, both versions are the same. versions are the same.
The :ref:`Platform Ports` page provides a list of all deprecated/deleted The :ref:`Platform Ports` page provides a list of all deprecated/deleted
platform ports (or soon to be) to this day. platform ports (or soon to be) to this day.