xref: /arm-trusted-firmware/docs/about/release-information.rst (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700SchasingluluRelease Processes
2*91f16700Schasinglulu=================
3*91f16700Schasinglulu
4*91f16700SchasingluluProject Release Cadence
5*91f16700Schasinglulu-----------------------
6*91f16700Schasinglulu
7*91f16700SchasingluluThe project currently aims to do a release once every 6 months which will be
8*91f16700Schasinglulutagged on the master branch. There will be a code freeze (stop merging
9*91f16700Schasinglulunon-essential changes) up to 4 weeks prior to the target release date. The release
10*91f16700Schasinglulucandidates will start appearing after this and only bug fixes or updates
11*91f16700Schasinglulurequired for the release will be merged. The maintainers are free to use their
12*91f16700Schasinglulujudgement on what changes are essential for the release. A release branch may be
13*91f16700Schasinglulucreated after code freeze if there are significant changes that need merging onto
14*91f16700Schasingluluthe integration branch during the merge window.
15*91f16700Schasinglulu
16*91f16700SchasingluluThe release testing will be performed on release candidates and depending on
17*91f16700Schasingluluissues found, additional release candidates may be created to fix the issues.
18*91f16700Schasinglulu
19*91f16700Schasinglulu::
20*91f16700Schasinglulu
21*91f16700Schasinglulu                            |<----------6 months---------->|
22*91f16700Schasinglulu            |<---4 weeks--->|              |<---4 weeks--->|
23*91f16700Schasinglulu       +-----------------------------------------------------------> time
24*91f16700Schasinglulu            |               |              |               |
25*91f16700Schasinglulu         code freeze       ver w.x       code freeze     ver y.z
26*91f16700Schasinglulu
27*91f16700Schasinglulu
28*91f16700SchasingluluVersion numbering
29*91f16700Schasinglulu~~~~~~~~~~~~~~~~~
30*91f16700SchasingluluTF-A version is given in Makefile, through several macros:
31*91f16700Schasinglulu
32*91f16700Schasinglulu- VERSION_MAJOR
33*91f16700Schasinglulu- VERSION_MINOR
34*91f16700Schasinglulu- VERSION_PATCH
35*91f16700Schasinglulu
36*91f16700SchasingluluFor example, TF-A v2.10 has VERSION_MAJOR=2, VERSION_MINOR=10 and VERSION_PATCH=0.
37*91f16700Schasinglulu
38*91f16700SchasingluluThis VERSION_PATCH macro is only increased for LTS releases.
39*91f16700Schasinglulu
40*91f16700SchasingluluUpcoming Releases
41*91f16700Schasinglulu~~~~~~~~~~~~~~~~~
42*91f16700Schasinglulu
43*91f16700SchasingluluThese are the estimated dates for the upcoming release. These may change
44*91f16700Schasingluludepending on project requirement and partner feedback.
45*91f16700Schasinglulu
46*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
47*91f16700Schasinglulu| Release Version |  Target Date              | Expected Code Freeze         |
48*91f16700Schasinglulu+=================+===========================+==============================+
49*91f16700Schasinglulu| v2.0            | 1st week of Oct '18       | 1st week of Sep '18          |
50*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
51*91f16700Schasinglulu| v2.1            | 5th week of Mar '19       | 1st week of Mar '19          |
52*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
53*91f16700Schasinglulu| v2.2            | 4th week of Oct '19       | 1st week of Oct '19          |
54*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
55*91f16700Schasinglulu| v2.3            | 4th week of Apr '20       | 1st week of Apr '20          |
56*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
57*91f16700Schasinglulu| v2.4            | 2nd week of Nov '20       | 4th week of Oct '20          |
58*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
59*91f16700Schasinglulu| v2.5            | 3rd week of May '21       | 5th week of Apr '21          |
60*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
61*91f16700Schasinglulu| v2.6            | 4th week of Nov '21       | 2nd week of Nov '21          |
62*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
63*91f16700Schasinglulu| v2.7            | 5th week of May '22       | 3rd week of May '22          |
64*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
65*91f16700Schasinglulu| v2.8            | 5th week of Nov '22       | 3rd week of Nov '22          |
66*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
67*91f16700Schasinglulu| v2.9            | 4th week of May '23       | 2nd week of May '23          |
68*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
69*91f16700Schasinglulu| v2.10           | 4th week of Nov '23       | 2nd week of Nov '23          |
70*91f16700Schasinglulu+-----------------+---------------------------+------------------------------+
71*91f16700Schasinglulu
72*91f16700SchasingluluRemoval of Deprecated Interfaces
73*91f16700Schasinglulu--------------------------------
74*91f16700Schasinglulu
75*91f16700SchasingluluAs mentioned in the :ref:`Platform Ports Policy`, this is a live document
76*91f16700Schasinglulucataloging all the deprecated interfaces in TF-A project and the Release version
77*91f16700Schasingluluafter which it will be removed.
78*91f16700Schasinglulu
79*91f16700Schasinglulu+--------------------------------+-------------+---------+---------------------------------------------------------+
80*91f16700Schasinglulu| Interface                      | Deprecation | Removed | Comments                                                |
81*91f16700Schasinglulu|                                | Date        | after   |                                                         |
82*91f16700Schasinglulu|                                |             | Release |                                                         |
83*91f16700Schasinglulu+================================+=============+=========+=========================================================+
84*91f16700Schasinglulu| Mbedtls-2.x                    |     2.10    |   2.10  | Support for TF-A builds with Mbedtls-2.x will be removed|
85*91f16700Schasinglulu+--------------------------------+-------------+---------+---------------------------------------------------------+
86*91f16700Schasinglulu| STM32MP15_OPTEE_RSV_SHM        |     2.10    |   3.0   | OP-TEE manages its own memory on STM32MP15              |
87*91f16700Schasinglulu+--------------------------------+-------------+---------+---------------------------------------------------------+
88*91f16700Schasinglulu
89*91f16700SchasingluluRemoval of Deprecated Drivers
90*91f16700Schasinglulu-----------------------------
91*91f16700Schasinglulu
92*91f16700SchasingluluAs mentioned in the :ref:`Platform Ports Policy`, this is a live document
93*91f16700Schasinglulucataloging all the deprecated drivers in TF-A project and the Release version
94*91f16700Schasingluluafter which it will be removed.
95*91f16700Schasinglulu
96*91f16700Schasinglulu+--------------------------------+-------------+---------+---------------------------------------------------------+
97*91f16700Schasinglulu| Driver                         | Deprecation | Removed | Comments                                                |
98*91f16700Schasinglulu|                                | Date        | after   |                                                         |
99*91f16700Schasinglulu|                                |             | Release |                                                         |
100*91f16700Schasinglulu+================================+=============+=========+=========================================================+
101*91f16700Schasinglulu| None at this time.             |             |         |                                                         |
102*91f16700Schasinglulu+--------------------------------+-------------+---------+---------------------------------------------------------+
103*91f16700Schasinglulu
104*91f16700Schasinglulu--------------
105*91f16700Schasinglulu
106*91f16700Schasinglulu*Copyright (c) 2018-2023, Arm Limited and Contributors. All rights reserved.*
107