Gitiles
Code Review Sign In
git01.mediatek.com / filogic / atf / 7f16dac897d5806a147bacb8952701917ebfd4fd / . / docs / about / release-information.rst
blob: a5fd1d61c8972726d6a46b755516004245a56752 [file] [log] [blame]
Paul Beesleyfc9ee362019-03-07 15:47:15 +0000[diff] [blame]1Release Processes
2=================
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]3
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]4Project Release Cadence
5-----------------------
6
7The project currently aims to do a release once every 6 months which will be
8tagged on the master branch. There will be a code freeze (stop merging
laurenw-arm0e77f012019-10-16 16:32:16 -0500[diff] [blame]9non-essential changes) up to 4 weeks prior to the target release date. The release
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]10candidates will start appearing after this and only bug fixes or updates
11required for the release will be merged. The maintainers are free to use their
laurenw-arm0e77f012019-10-16 16:32:16 -0500[diff] [blame]12judgement on what changes are essential for the release. A release branch may be
13created after code freeze if there are significant changes that need merging onto
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]14the integration branch during the merge window.
15
16The release testing will be performed on release candidates and depending on
17issues found, additional release candidates may be created to fix the issues.
18
19::
20
21 |<----------6 months---------->|
22 |<---4 weeks--->| |<---4 weeks--->|
23 +-----------------------------------------------------------> time
24 | | | |
25 code freeze ver w.x code freeze ver y.z
26
27
Yann Gautier9a17e242023-10-04 18:59:44 +0200[diff] [blame]28Version numbering
29~~~~~~~~~~~~~~~~~
30TF-A version is given in Makefile, through several macros:
31
32- VERSION_MAJOR
33- VERSION_MINOR
34- VERSION_PATCH
35
36For example, TF-A v2.10 has VERSION_MAJOR=2, VERSION_MINOR=10 and VERSION_PATCH=0.
37
38This VERSION_PATCH macro is only increased for LTS releases.
39
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]40Upcoming Releases
41~~~~~~~~~~~~~~~~~
42
43These are the estimated dates for the upcoming release. These may change
44depending on project requirement and partner feedback.
45
46+-----------------+---------------------------+------------------------------+
47| Release Version | Target Date | Expected Code Freeze |
48+=================+===========================+==============================+
49| v2.0 | 1st week of Oct '18 | 1st week of Sep '18 |
50+-----------------+---------------------------+------------------------------+
51| v2.1 | 5th week of Mar '19 | 1st week of Mar '19 |
52+-----------------+---------------------------+------------------------------+
laurenw-arm0e77f012019-10-16 16:32:16 -0500[diff] [blame]53| v2.2 | 4th week of Oct '19 | 1st week of Oct '19 |
54+-----------------+---------------------------+------------------------------+
laurenw-arme7f63192020-03-31 14:20:25 -0500[diff] [blame]55| v2.3 | 4th week of Apr '20 | 1st week of Apr '20 |
laurenw-arm0e77f012019-10-16 16:32:16 -0500[diff] [blame]56+-----------------+---------------------------+------------------------------+
Manish V Badarkhe76dc2982020-10-08 02:11:20 +0100[diff] [blame]57| v2.4 | 2nd week of Nov '20 | 4th week of Oct '20 |
laurenw-arm489645f2020-04-15 15:19:50 -0500[diff] [blame]58+-----------------+---------------------------+------------------------------+
Madhukar Pappireddy56c6cce2021-04-26 18:53:31 -0500[diff] [blame]59| v2.5 | 3rd week of May '21 | 5th week of Apr '21 |
Manish V Badarkhe95347d12020-10-08 02:16:25 +0100[diff] [blame]60+-----------------+---------------------------+------------------------------+
Bipin Ravi58392c42021-10-05 15:57:06 -0500[diff] [blame]61| v2.6 | 4th week of Nov '21 | 2nd week of Nov '21 |
Madhukar Pappireddy18b3f592021-04-26 19:01:18 -0500[diff] [blame]62+-----------------+---------------------------+------------------------------+
Daniel Boulby7c1aa592022-05-09 11:11:49 +0100[diff] [blame]63| v2.7 | 5th week of May '22 | 3rd week of May '22 |
64+-----------------+---------------------------+------------------------------+
65| v2.8 | 5th week of Nov '22 | 3rd week of Nov '22 |
Bipin Ravi68edfdc2021-12-21 09:14:48 -0600[diff] [blame]66+-----------------+---------------------------+------------------------------+
Harrison Mutai3d7d6f32023-04-26 16:39:08 +0100[diff] [blame]67| v2.9 | 4th week of May '23 | 2nd week of May '23 |
68+-----------------+---------------------------+------------------------------+
Olivier Deprez34934572023-09-28 17:33:10 +0200[diff] [blame]69| v2.10 | 4th week of Nov '23 | 2nd week of Nov '23 |
Joanna Farley623ac722022-11-18 02:33:16 +0200[diff] [blame]70+-----------------+---------------------------+------------------------------+
Harrison Mutaicf937052024-04-04 14:54:58 +0000[diff] [blame]71| v2.11 | 4th week of May '24 | 2nd week of May '24 |
72+-----------------+---------------------------+------------------------------+
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]73
74Removal of Deprecated Interfaces
75--------------------------------
76
Sandrine Bailleuxdad35612022-11-08 13:36:42 +0100[diff] [blame]77As mentioned in the :ref:`Platform Ports Policy`, this is a live document
78cataloging all the deprecated interfaces in TF-A project and the Release version
79after which it will be removed.
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]80
81+--------------------------------+-------------+---------+---------------------------------------------------------+
82| Interface | Deprecation | Removed | Comments |
83| | Date | after | |
84| | | Release | |
85+================================+=============+=========+=========================================================+
Yann Gautierff012d12022-06-30 14:05:21 +0200[diff] [blame]86| STM32MP15_OPTEE_RSV_SHM | 2.10 | 3.0 | OP-TEE manages its own memory on STM32MP15 |
Nicolas Toromanoff7f95ac82020-11-09 12:14:52 +0100[diff] [blame]87+--------------------------------+-------------+---------+---------------------------------------------------------+
Sandrine Bailleux8c333e42023-04-17 16:01:50 +0200[diff] [blame]88
89Removal of Deprecated Drivers
90-----------------------------
91
92As mentioned in the :ref:`Platform Ports Policy`, this is a live document
93cataloging all the deprecated drivers in TF-A project and the Release version
94after which it will be removed.
95
96+--------------------------------+-------------+---------+---------------------------------------------------------+
97| Driver | Deprecation | Removed | Comments |
98| | Date | after | |
99| | | Release | |
100+================================+=============+=========+=========================================================+
Sandrine Bailleux2f37ce62023-10-26 15:14:42 +0200[diff] [blame]101| None at this time. | | | |
Sandrine Bailleuxb0b531f2023-04-17 14:09:41 +0200[diff] [blame]102+--------------------------------+-------------+---------+---------------------------------------------------------+
Joel Hutton9e605632019-02-25 15:18:56 +0000[diff] [blame]103
Govindraj Raja7f16dac2024-04-18 12:04:18 -0500[diff] [blame^]104Build Options deprecated/removed
105~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106
107Populated table provides details about build options that were removed or deprecated.
108
109+-----------------------+--------------------------------+
110| Build Option | Deprecated from TF-A Version |
111+=======================+================================+
112| CTX_INCLUDE_MTE_REGS | 2.11 |
113+-----------------------+--------------------------------+
114| ENABLE_FEAT_MTE | 2.11 |
115+-----------------------+--------------------------------+
116
Paul Beesleyf8640672019-04-12 14:19:42 +0100[diff] [blame]117--------------
118
laurenw-armb3b6de72024-03-05 14:55:18 -0600[diff] [blame]119*Copyright (c) 2018-2024, Arm Limited and Contributors. All rights reserved.*