Skip to content

Commit fb1879a

Browse files
FrancescoSercarlescufi
authored andcommitted
doc: New improvements to 54h soc binaries docs
New improvements to 54h soc binaries docs. Signed-off-by: Francesco Domenico Servidio <[email protected]>
1 parent 0cb8cf0 commit fb1879a

File tree

4 files changed

+41
-23
lines changed

4 files changed

+41
-23
lines changed

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ The following sections describe the steps required for the nRF54H20 bring-up.
137137

138138
.. note::
139139
To program the nRF54H20 SoC binaries based on IronSide SE on your nRF54H20 SoC-based device, your device must be in lifecycle state (LCS) ``EMPTY``.
140-
Devices already provisioned using SUIT-based binaries and in LCS RoT cannot be transitioned back to LCS EMPTY.
140+
Devices already provisioned using SUIT-based binaries and in LCS ``RoT`` cannot be transitioned back to LCS ``EMPTY``.
141141

142142
.. rst-class:: numbered-step
143143

doc/nrf/releases_and_maturity/abi_compatibility.rst

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,41 +22,56 @@ However, changes that affect data structure layouts, such as altering field orde
2222
ABI compatibility matrix for the nRF54H20 SoC binaries
2323
******************************************************
2424

25+
.. caution::
26+
27+
* To use the most recent version of the |NCS|, you must provision your nRF54H20-based device with the compatible IronSide-based SoC binaries.
28+
Devices already provisioned using SUIT-based SoC binaries and in LCS ``RoT`` cannot be transitioned back to LCS ``EMPTY``.
29+
30+
For more information on provisioning devices, see :ref:`ug_nrf54h20_gs_bringup`.
31+
32+
* The nRF54H20 SoC binaries only support specific versions of the |NCS| and do not support rollbacks to previous versions.
33+
Upgrading the nRF54H20 SoC binaries on your development kit might break the DK's compatibility with applications developed for earlier versions of the |NCS|.
34+
35+
To migrate your existing applications to the newest version of the |NCS|, see :ref:`migration_guides`.
36+
2537
The following table illustrates ABI compatibility between different versions of the nRF54H20 SoC binaries and the |NCS|:
2638

2739
.. list-table::
2840
:header-rows: 1
2941

3042
* - |NCS| versions
31-
- Compatible nRF54H20 SoC binaries version
43+
- Compatible nRF54H20 SoC binaries version based on IronSide Secure Element (IronSide SE)
3244
* - |NCS| v3.1.0
33-
- `nRF54H20 SoC binaries v22.2.0+14`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
34-
It includes IronSide Secure Element (IronSide SE).
45+
- `nRF54H20 SoC binaries v22.2.0+14`_, compatible with the nRF54H20 DK v0.9.0 and later DK revisions in LCS ``EMPTY``.
46+
47+
48+
.. list-table::
49+
:header-rows: 1
50+
51+
* - |NCS| versions
52+
- Compatible nRF54H20 SoC binaries version based on SUIT
53+
(no longer usable with the newest |NCS| versions)
3554
* - |NCS| v3.0.0
36-
- `nRF54H20 SoC binaries v0.9.6`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
55+
- nRF54H20 SoC binaries v0.9.6, compatible with the nRF54H20 DK v0.9.0 and later DK revisions.
3756
* - |NCS| v2.9.0-nRF54H20-1
38-
- `nRF54H20 SoC binaries v0.9.2`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
57+
- nRF54H20 SoC binaries v0.9.2, compatible with the nRF54H20 DK v0.9.0 and later DK revisions.
3958
* - |NCS| v2.9.0
40-
- `nRF54H20 SoC binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
59+
- nRF54H20 SoC binaries v0.7.0 for EngC DKs, compatible with the nRF54H20 DK v0.8.3 and later DK revisions.
4160
* - |NCS| v2.8.0
42-
- `nRF54H20 SoC binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
43-
`nRF54H20 SoC binaries v0.7.0 for EngB DKs`_, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
61+
- nRF54H20 SoC binaries v0.7.0 for EngC DKs, compatible with the nRF54H20 DK v0.8.3 and later DK revisions.
62+
nRF54H20 SoC binaries v0.7.0 for EngB DKs, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
4463
* - |NCS| v2.7.99-cs2
45-
- `nRF54H20 SoC binaries v0.6.5`_
64+
- nRF54H20 SoC binaries v0.6.5
4665
* - |NCS| v2.7.99-cs1
47-
- `nRF54H20 SoC binaries v0.6.2`_
66+
- nRF54H20 SoC binaries v0.6.2
4867
* - |NCS| v2.7.0
49-
- `nRF54H20 SoC binaries v0.5.0`_
68+
- nRF54H20 SoC binaries v0.5.0
5069
* - |NCS| v2.6.99-cs2
51-
- `nRF54H20 SoC binaries v0.3.3`_
70+
- nRF54H20 SoC binaries v0.3.3
5271

5372
Maintaining ABI compatibility ensures that the Secure Domain and System Controller firmware binaries do not need to be recompiled each time the application, radio binaries, or both are recompiled, as long as they are based on a compatible |NCS| version.
5473
Additionally, maintaining ABI compatibility allows the nRF54H20 SoC binary components to work together without recompilation when updating to newer |NCS| versions.
5574

56-
.. note::
57-
The nRF54H20 SoC binaries only support specific versions of the |NCS| and do not support rollbacks to previous versions.
58-
Upgrading the nRF54H20 SoC binaries on your development kit might break the DK's compatibility with applications developed for earlier versions of the |NCS|.
59-
6075
Provisioning the nRF54H20 SoC
6176
*****************************
6277

doc/nrf/releases_and_maturity/migration/migration_3.1_54h_suit_ironside.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ To follow this guide, you must meet the following prerequisites:
2020
Moreover, to program your modified application on the nRF54H20 SoC, your nRF54H20-based device must be provisioned with the relevant nRF54H20 SoC binaries version.
2121
For more information, see :ref:`abi_compatibility`.
2222

23-
.. note::
23+
.. caution::
2424
To program the nRF54H20 SoC binaries based on IronSide SE on your nRF54H20 SoC-based device, your device must be in lifecycle state (LCS) ``EMPTY``.
25-
Devices already provisioned using SUIT-based binaries and in LCS RoT cannot be transitioned back to LCS EMPTY.
26-
For more information on provisioning new devices, see :ref:`ug_nrf54h20_gs_bringup`.
25+
Devices already provisioned using SUIT-based SoC binaries and in LCS ``RoT`` cannot be transitioned back to LCS ``EMPTY``.
26+
27+
For more information on provisioning devices, see :ref:`ug_nrf54h20_gs_bringup`.
28+
For more information on the nRF54H20 SoC binaries, see :ref:`abi_compatibility`.
2729

2830
Breaking changes
2931
****************

doc/nrf/releases_and_maturity/migration/migration_guide_3.1.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,11 @@ nRF54H20 SoC binaries
8282
* The nRF54H20 SoC binaries have been updated to version v22.2.0+14, and are now based on IronSide SE.
8383
For more information, see :ref:`abi_compatibility`.
8484

85-
.. note::
85+
.. caution::
8686
To program the nRF54H20 SoC binaries based on IronSide SE on your nRF54H20 SoC-based device, your device must be in lifecycle state (LCS) ``EMPTY``.
87-
Devices already provisioned using SUIT-based binaries and in LCS RoT cannot be transitioned back to LCS EMPTY.
88-
For more information on provisioning new devices, see :ref:`ug_nrf54h20_gs_bringup`.
87+
Devices already provisioned using SUIT-based SoC binaries and in LCS ``RoT`` cannot be transitioned back to LCS ``EMPTY``.
88+
89+
For more information on provisioning devices, see :ref:`ug_nrf54h20_gs_bringup`.
8990

9091
SUIT to IronSide SE migration
9192
-----------------------------

0 commit comments

Comments
 (0)