xref: /rk3399_ARM-atf/docs/about/release-information.rst (revision 8eb9490b61c65288eaacbf229afbbe0f99484c86)
1*8eb9490bSPaul BeesleyRelease Processes
2*8eb9490bSPaul Beesley=================
3*8eb9490bSPaul Beesley
4*8eb9490bSPaul BeesleyProject Release Cadence
5*8eb9490bSPaul Beesley-----------------------
6*8eb9490bSPaul Beesley
7*8eb9490bSPaul BeesleyThe project currently aims to do a release once every 6 months which will be
8*8eb9490bSPaul Beesleytagged on the master branch. There will be a code freeze (stop merging
9*8eb9490bSPaul Beesleynon-essential PRs) up to 4 weeks prior to the target release date. The release
10*8eb9490bSPaul Beesleycandidates will start appearing after this and only bug fixes or updates
11*8eb9490bSPaul Beesleyrequired for the release will be merged. The maintainers are free to use their
12*8eb9490bSPaul Beesleyjudgement on what PRs are essential for the release. A release branch may be
13*8eb9490bSPaul Beesleycreated after code freeze if there are significant PRs that need merging onto
14*8eb9490bSPaul Beesleythe integration branch during the merge window.
15*8eb9490bSPaul Beesley
16*8eb9490bSPaul BeesleyThe release testing will be performed on release candidates and depending on
17*8eb9490bSPaul Beesleyissues found, additional release candidates may be created to fix the issues.
18*8eb9490bSPaul Beesley
19*8eb9490bSPaul Beesley::
20*8eb9490bSPaul Beesley
21*8eb9490bSPaul Beesley                            |<----------6 months---------->|
22*8eb9490bSPaul Beesley            |<---4 weeks--->|              |<---4 weeks--->|
23*8eb9490bSPaul Beesley       +-----------------------------------------------------------> time
24*8eb9490bSPaul Beesley            |               |              |               |
25*8eb9490bSPaul Beesley         code freeze       ver w.x       code freeze     ver y.z
26*8eb9490bSPaul Beesley
27*8eb9490bSPaul Beesley
28*8eb9490bSPaul BeesleyUpcoming Releases
29*8eb9490bSPaul Beesley~~~~~~~~~~~~~~~~~
30*8eb9490bSPaul Beesley
31*8eb9490bSPaul BeesleyThese are the estimated dates for the upcoming release. These may change
32*8eb9490bSPaul Beesleydepending on project requirement and partner feedback.
33*8eb9490bSPaul Beesley
34*8eb9490bSPaul Beesley+-----------------+---------------------------+------------------------------+
35*8eb9490bSPaul Beesley| Release Version |  Target Date              | Expected Code Freeze         |
36*8eb9490bSPaul Beesley+=================+===========================+==============================+
37*8eb9490bSPaul Beesley| v2.0            | 1st week of Oct '18       | 1st week of Sep '18          |
38*8eb9490bSPaul Beesley+-----------------+---------------------------+------------------------------+
39*8eb9490bSPaul Beesley| v2.1            | 5th week of Mar '19       | 1st week of Mar '19          |
40*8eb9490bSPaul Beesley+-----------------+---------------------------+------------------------------+
41*8eb9490bSPaul Beesley
42*8eb9490bSPaul BeesleyRemoval of Deprecated Interfaces
43*8eb9490bSPaul Beesley--------------------------------
44*8eb9490bSPaul Beesley
45*8eb9490bSPaul BeesleyAs mentioned in the :ref:`Platform Compatibility Policy`, this is a live
46*8eb9490bSPaul Beesleydocument cataloging all the deprecated interfaces in TF-A project and the
47*8eb9490bSPaul BeesleyRelease version after which it will be removed.
48*8eb9490bSPaul Beesley
49*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
50*8eb9490bSPaul Beesley| Interface                      | Deprecation | Removed | Comments                                                |
51*8eb9490bSPaul Beesley|                                | Date        | after   |                                                         |
52*8eb9490bSPaul Beesley|                                |             | Release |                                                         |
53*8eb9490bSPaul Beesley+================================+=============+=========+=========================================================+
54*8eb9490bSPaul Beesley| Legacy Console API             | Jan '18     | v2.1    | Deprecated in favour of ``MULTI_CONSOLE_API``           |
55*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
56*8eb9490bSPaul Beesley| Weak default                   | Oct '18     | v2.1    | The default implementations are defined in              |
57*8eb9490bSPaul Beesley| ``plat_crash_console_*``       |             |         | ``crash_console_helpers.S``. The platforms have to      |
58*8eb9490bSPaul Beesley| APIs                           |             |         | define ``plat_crash_console_*``.                        |
59*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
60*8eb9490bSPaul Beesley| ``finish_console_register``    | Oct '18     | v2.1    | The old version of the macro is deprecated. See commit  |
61*8eb9490bSPaul Beesley| macro in                       |             |         | cc5859c_ for more details.                              |
62*8eb9490bSPaul Beesley| ``MULTI_CONSOLE_API``          |             |         |                                                         |
63*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
64*8eb9490bSPaul Beesley| Types ``tzc_action_t`` and     | Oct '18     | v2.1    | Using logical operations such as OR in enumerations     |
65*8eb9490bSPaul Beesley| ``tzc_region_attributes_t``    |             |         | goes against the MISRA guidelines.                      |
66*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
67*8eb9490bSPaul Beesley| Macro ``EL_IMPLEMENTED()``     | Oct '18     | v2.1    | Deprecated in favour of ``el_implemented()``.           |
68*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
69*8eb9490bSPaul Beesley| ``get_afflvl_shift()``,        | Dec '18     | v2.1    | Removed.                                                |
70*8eb9490bSPaul Beesley| ``mpidr_mask_lower_afflvls()``,|             |         |                                                         |
71*8eb9490bSPaul Beesley| and ``eret()``.                |             |         |                                                         |
72*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
73*8eb9490bSPaul Beesley| Extra include paths in the     | Jan '18     | v2.1    | Now it is needed to use the full path of the common     |
74*8eb9490bSPaul Beesley| Makefile in ``INCLUDES``.      |             |         | header files. More information in commit 09d40e0e0828_. |
75*8eb9490bSPaul Beesley+--------------------------------+-------------+---------+---------------------------------------------------------+
76*8eb9490bSPaul Beesley
77*8eb9490bSPaul Beesley--------------
78*8eb9490bSPaul Beesley
79*8eb9490bSPaul Beesley*Copyright (c) 2018-2019, Arm Limited and Contributors. All rights reserved.*
80*8eb9490bSPaul Beesley
81*8eb9490bSPaul Beesley.. _cc5859c: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/commit/?id=cc5859ca19ff546c35eb0331000dae090b6eabcf
82*8eb9490bSPaul Beesley.. _09d40e0e0828: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git/commit/?id=09d40e0e08283a249e7dce0e106c07c5141f9b7e
83