| Soby Mathew | 175efe1 | 2020-07-03 14:33:11 +0100 | [diff] [blame] | 1 | ################################ |
| 2 | Platform deprecation and removal |
| 3 | ################################ |
| 4 | |
| 5 | ******************************************** |
| 6 | Process for Platform deprecation and removal |
| 7 | ******************************************** |
| 8 | |
| 9 | A platform may need to be removed from upstream code due to lack of community |
| 10 | interest or it may have reached end of life. The below section calls out the |
| 11 | process for removing platform support from TF-M. |
| 12 | |
| 13 | 1. An email to the TF-M mailing list proposing the removal of the platform. |
| 14 | |
| 15 | 2. The merit of the proposal will be considered by the maintainers for a |
| 16 | period of 4 weeks and community can express their opinion on the same |
| 17 | during this time window. The platform owner can veto the proposal and |
| 18 | incase of multiple platform owners with differing opinion or community |
| 19 | having interest in the platform, then the project maintainer can work |
| 20 | with the platform owner and use their discretion to decide on the |
| 21 | proposal. |
| 22 | |
| 23 | 3. Once a decision is made to remove the platform, the platform is |
| 24 | considered to be in `deprecated` state as per platform support lifecyle |
| 25 | defined here: "https://developer.trustedfirmware.org/w/collaboration/project-maintenance-process/". |
| 26 | The platform will be marked as deprecated and the TF-M version after |
| 27 | which it will be removed will also be mentioned. Suitable build time |
| 28 | or runtime messages needs to be incorporated to the platform to warn |
| 29 | about the `deprecation`. |
| 30 | |
| 31 | 4. The project should strive to keep the `deprecated` platforms |
| 32 | building/running till the removal. This relies on platform owners being |
| 33 | still actively involved with the project and maintaining the platform. |
| 34 | |
| 35 | 5. Although this will be the usual process for platform deprecation and |
| 36 | eventual removal, the process still leaves room for the platform |
| 37 | deprecation to be cancelled after it has been marked as `deprecated` |
| 38 | due to evolving project and market requirements. This is left to |
| 39 | consensus between project maintainers and platform owner/s. |
| 40 | |
| 41 | 6. Once a platform has been removed, it can be added back in future and |
| 42 | this would follow the same guidelines as for a new platform contribution. |
| 43 | |
| 44 | **************************** |
| 45 | List of Deprecated Platforms |
| 46 | **************************** |
| 47 | |
| 48 | The below list calls out platforms marked for deprecation according to the |
| 49 | above process and the platform will be removed soon after the mentioned |
| 50 | release. |
| 51 | |
| 52 | +------------------------------+-----------+-----------------------------------+ |
| 53 | | Deprecated Platform | Removed | Comments | |
| 54 | | | after | | |
| 55 | | | release | | |
| 56 | +==============================+===========+===================================+ |
| Minos Galanakis | c9a81db | 2020-11-16 20:22:11 +0000 | [diff] [blame] | 57 | | mps2/an539 | v1.2.0 | N.A | |
| Soby Mathew | 175efe1 | 2020-07-03 14:33:11 +0100 | [diff] [blame] | 58 | +------------------------------+-----------+-----------------------------------+ |
| 59 | |
| 60 | -------------- |
| 61 | |
| Minos Galanakis | 78458aa | 2020-10-19 16:07:40 +0100 | [diff] [blame] | 62 | *Copyright (c) 2020, Arm Limited. All rights reserved.* |