Skip to content

Commit c667bd1

Browse files
FrancescoSernordicjm
authored andcommitted
doc: 54H migration guide update
Updated migration guide for 2.8 with 54H info Signed-off-by: Francesco Domenico Servidio <[email protected]>
1 parent 83592d9 commit c667bd1

File tree

1 file changed

+181
-3
lines changed

1 file changed

+181
-3
lines changed

doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst

Lines changed: 181 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,170 @@ This document describes the changes required or recommended when migrating your
2121
* Change1 and description
2222
* Change2 and description
2323
24+
.. _migration_2.8_nrf54h:
25+
26+
nRF54H20
27+
********
28+
29+
This section describes the changes specific to the nRF54H20 SoC and DK support in the |NCS|.
30+
31+
DK compatibility
32+
================
33+
34+
.. toggle::
35+
36+
* The |NCS| v2.8.0 is compatible only with the following versions of the nRF54H20 DK, PCA10175:
37+
38+
* Engineering B - versions ranging from v0.8.0 to 0.8.2
39+
* Engineering C - v0.8.3 and later revisions
40+
41+
Check the version number on your DK's sticker to verify its compatibility with the |NCS|.
42+
43+
Dependencies
44+
============
45+
46+
The following required dependencies for the nRF54H20 SoC and DK have been updated.
47+
48+
nRF54H20 BICR
49+
-------------
50+
51+
.. toggle::
52+
53+
* The nRF54H20 BICR has been updated (from the one supporting |NCS| v2.7.0).
54+
55+
.. note::
56+
BICR update is not required if migrating from |NCS| v2.7.99-cs1 or v2.7.99-cs2.
57+
58+
To update the BICR of your development kit while in Root of Trust, do the following:
59+
60+
1. Download the `BICR new binary file`_.
61+
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.
62+
63+
.. note::
64+
On MacOS, connecting the DK might repeatedly trigger a popup displaying the message ``Disk Not Ejected Properly``.
65+
To disable this, run ``JLinkExe``, then run ``MSDDisable`` in the J-Link Commander interface.
66+
67+
#. List all the connected development kits to see their serial number (matching the one on the DK's sticker)::
68+
69+
nrfutil device list
70+
71+
#. Move the BICR HEX file to a folder of your choice, then program the BICR by running nRF Util from that folder using the following command::
72+
73+
nrfutil device program --options chip_erase_mode=ERASE_NONE --firmware <path_to_bicr.hex> --core Application --serial-number <serial_number>
74+
75+
nRF54H20 SoC binaries
76+
---------------------
77+
78+
.. toggle::
79+
80+
* The *nRF54H20 SoC binaries* bundle has been updated to version 0.7.0.
81+
82+
.. caution::
83+
If migrating from |NCS| v2.7.0, before proceeding with the SoC binaries update, you must first update the BICR as described in the previous section.
84+
85+
To update the SoC binaries bundle of your development kit while in Root of Trust, do the following:
86+
87+
1. Download the nRF54H20 SoC binaries v0.7.0:
88+
89+
* `nRF54H20 SoC Binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions
90+
* `nRF54H20 SoC Binaries v0.7.0 for EngB DKs`_, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
91+
92+
.. note::
93+
On MacOS, ensure that the ZIP file is not unpacked automatically upon download.
94+
95+
#. Purge the device as follows::
96+
97+
nrfutil device recover --core Application --serial-number <serial_number>
98+
nrfutil device recover --core Network --serial-number <serial_number>
99+
100+
#. Run ``west update``.
101+
#. Move the correct :file:`.zip` bundle to a folder of your choice, then run nRF Util to program the binaries using one of the following commands, depending on your DK:
102+
103+
* For Engineering B::
104+
105+
nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.7.0_<revision>.zip --serial-number <serial_number>
106+
107+
* For Engineering C::
108+
109+
nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.7.0_<revision>.zip --serial-number <serial_number> --update-candidate-info-address 0x0e1ef340
110+
111+
nrfutil device
112+
--------------
113+
114+
.. toggle::
115+
116+
* ``nrfutil device`` has been updated to version 2.7.2.
117+
118+
Install the nRF Util ``device`` command version 2.7.2 as follows::
119+
120+
nrfutil install device=2.7.2 --force
121+
122+
For more information, consult the `nRF Util`_ documentation.
123+
124+
nrfutil-trace
125+
-------------
126+
127+
.. toggle::
128+
129+
* ``nrfutil-trace`` has been updated to version 2.11.0.
130+
131+
Install the nRF Util ``trace`` command version 2.11.0 as follows::
132+
133+
nrfutil install trace=2.11.0 --force
134+
135+
For more information, consult the `nRF Util`_ documentation.
136+
137+
nrf-regtool
138+
-----------
139+
140+
.. toggle::
141+
142+
* ``nrf-regtool`` has been updated to version 7.0.0.
143+
144+
1. Open nRF Connect for Desktop, navigate to the Toolchain Manager, select the v2.7.99-cs2 toolchain, and click the :guilabel:`Open terminal` button.
145+
#. In the terminal window, install ``nrf-regtool`` version 7.0.0 as follows::
146+
147+
pip install nrf-regtool==7.0.0
148+
149+
150+
SEGGER J-Link
151+
-------------
152+
153+
.. toggle::
154+
155+
* A new version of SEGGER J-Link is supported: `SEGGER J-Link` version 7.94i.
156+
157+
.. note::
158+
On Windows, to update to the new J-link version, including the USB Driver for J-Link, you must manually install J-Link v7.94i from the command line, using the ``-InstUSBDriver=1`` parameter:
159+
160+
1. Navigate to the download location of the J-Link executable and run one of the following commands:
161+
162+
* From the Command Prompt::
163+
164+
JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1
165+
166+
* From PowerShell::
167+
168+
.\JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1
169+
170+
#. In the :guilabel:`Choose optional components` window, select :guilabel:`update existing installation`.
171+
#. Add the J-Link executable to the system path on Linux and MacOS, or to the environment variables on Windows, to run it from anywhere on the system.
172+
173+
* The STM logging feature for the nRF54H20 SoC was tested using the J-Trace PRO V2 Cortex-M, with firmware compiled on ``Mar 28 2024 15:14:04``.
174+
Using this feature also requires ``nrfutil-trace`` version 2.10.0 or later.
175+
176+
nRF Connect Device Manager
177+
--------------------------
178+
179+
.. toggle::
180+
181+
* The nRF54H20 SUIT DFU feature now requires `nRF Connect Device Manager`_ version v2.2.2 or higher.
182+
183+
Samples and applications
184+
========================
185+
186+
For more information on changes related to samples and applications usage on the nRF54H20 DK, see :ref:`migration_2.8_required_nrf54h`.
187+
24188
.. _migration_2.8_required:
25189

26190
Required changes
@@ -61,12 +225,17 @@ Serial LTE Modem (SLM)
61225
* ``AT#XSOCKETOPT=1,53,`` with ``AT#XSOCKETOPT=1,61,4`` to indicate ``RAI_ONGOING``.
62226
* ``AT#XSOCKETOPT=1,54,`` with ``AT#XSOCKETOPT=1,61,5`` to indicate ``RAI_WAIT_MORE``.
63227

64-
SUIT DFU for nRF54H20
65-
---------------------
228+
.. _migration_2.8_required_nrf54h:
229+
230+
nRF54H20
231+
--------
66232

67233
.. toggle::
68234

69-
* The manifest sequence number is no longer configured through a :ref:`sysbuild <configuring_sysbuild>` Kconfig option.
235+
* When using the nRF54H20 DK Engineering B (from v0.8.0 to 0.8.2), you must build samples and applications using the board revision 0.8.0 with the ``<board>@<revision>`` syntax.
236+
For example , ``[email protected]/nrf54h20/cpuapp`` when building for the application core, or ``[email protected]/nrf54h20/cpurad`` when building for the radio core.
237+
238+
* When using SUIT DFU on the nRF54H20 SoC, the manifest sequence number is no longer configured through a :ref:`sysbuild <configuring_sysbuild>` Kconfig option.
70239
The values are now read from the :file:`VERSION` file, used for :ref:`zephyr:app-version-details` in Zephyr and the |NCS|.
71240
This change to the :ref:`sysbuild <configuring_sysbuild>` Kconfig option requires the following updates in the SUIT templates for your project:
72241

@@ -90,6 +259,15 @@ SUIT DFU for nRF54H20
90259
91260
For the list of all variables, set through the :file:`VERSION`, refer to the :ref:`ug_nrf54h20_suit_customize_dfu`.
92261

262+
* When using MCU Manager, the ``Confirm`` command is now needed to trigger a device firmware update.
263+
* The build command to enable DFU from the external flash is now the following::
264+
265+
west build ./ -b nrf54h20dk/nrf54h20/cpuapp -T sample.suit.smp_transfer.cache_push.extflash.bt
266+
267+
* For updating using the SUIT Device Manager application, you can also use the following zip file: :file:`<main_application_build_directory>/zephyr/dfu_suit_recovery.zip`.
268+
* Some Kconfig options and SUIT manifests have been modified, changing names and configurations.
269+
Ensure the compatibility of your application with these changes.
270+
93271
Nordic Secure Immutable Bootloader (NSIB, B0, or B0n)
94272
-----------------------------------------------------
95273

0 commit comments

Comments
 (0)