Skip to content

Commit 2f9c68a

Browse files
FrancescoSercarlescufi
FrancescoSer
authored and
carlescufi
committed
doc: updated ug_nrf54h20_gs
Updated the ug_nrf54h20_gs user guide. Signed-off-by: Francesco Domenico Servidio <[email protected]>
1 parent fb1879a commit 2f9c68a

File tree

6 files changed

+88
-111
lines changed

6 files changed

+88
-111
lines changed

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

Lines changed: 81 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -7,147 +7,114 @@ Getting started with the nRF54H20 DK
77
:local:
88
:depth: 2
99

10-
This document gets you started with your nRF54H20 Development Kit (DK) using the |NCS| for the first time.
11-
It tells you how to install the :zephyr:code-sample:`sysbuild_hello_world` sample and perform a quick test of your DK.
12-
13-
If you are migrating from an earlier version of the |NCS|, see :ref:`migration_guides`.
14-
15-
.. _ug_nrf54h20_gs_requirements:
16-
17-
Minimum requirements
18-
********************
19-
20-
Make sure you have all the required hardware and that your computer has one of the supported operating systems.
21-
22-
Hardware
23-
========
24-
25-
* nRF54H20 DK version PCA10175 Engineering C - v0.9.0 and later revisions.
26-
Check the version number on your DK's sticker to verify its compatibility with the |NCS|.
27-
* USB-C cable.
28-
29-
Software
30-
========
10+
.. note::
11+
If you are migrating from an earlier version of the |NCS|, see :ref:`migration_guides`.
3112

32-
On your computer, one of the following operating systems:
13+
This document will get you started with your new nRF54H20 Development Kit (DK) using the |NCS| for the first time.
14+
It will guide you through the following:
3315

34-
.. include:: ../../../installation/recommended_versions.rst
35-
:start-after: os_table_start
36-
:end-before: os_table_end
16+
1. Installing the |NCS| and other required software and tools.
17+
#. Preparing the nRF54H20 DK for first use:
3718

38-
See :ref:`supported_OS` for more information.
19+
a. Programming the nRF54H20 DK's Board Information Configuration Registers (BICR) using the provided binary file.
20+
#. Programming the Secure Domain and System Controller of the nRF54H20 SoC using the provided SoC binaries.
21+
#. Transitioning the SoC's lifecycle state (LCS) to Root of Trust (RoT).
3922

40-
|supported OS|
23+
#. Programming the :zephyr:code-sample:`sysbuild_hello_world` sample on the DK.
24+
#. Testing the sample by capturing and reviewing the UART console output.
4125

42-
You also need the following:
26+
.. _ug_nrf54h20_gs_requirements:
4327

44-
* `Git`_ or `Git for Windows`_ (on Linux and Mac, or Windows, respectively)
45-
* `curl`_
46-
* SEGGER J-Link |jlink_ver| and, on Windows, also the SEGGER USB Driver for J-Link from `SEGGER J-Link`_ |jlink_ver|.
47-
For information on how to install the USB Driver, see the `nRF Util prerequisites`_ documentation.
48-
* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_
49-
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_
50-
* On Linux, the `nrf-udev`_ module with udev rules required to access USB ports on Nordic Semiconductor devices and program the firmware
28+
Hardware requirements
29+
*********************
5130

52-
.. _ug_nrf54h20_gs_installing_software:
31+
To follow this guide, make sure you have all the required hardware:
5332

54-
Installing the required software
55-
********************************
33+
* nRF54H20 DK version PCA10175 Engineering C - v0.9.0 and later DK revisions in lifecycle state (LCS) ``EMPTY`` (new DKs will always be in LCS ``EMPTY``).
34+
Check the version number on your DK's sticker to verify its compatibility with the |NCS|.
35+
* USB-C cable.
5636

57-
To work with the nRF54H20 DK, follow the instructions in the next sections to install the required tools.
37+
.. rst-class:: numbered-step
5838

59-
Install prerequisites
60-
=====================
39+
Installing the |NCS|
40+
********************
6141

62-
.. include:: ../../../installation/install_ncs.rst
63-
:start-after: .. prerequisites-include-start
64-
:end-before: .. prerequisites-include-end
42+
Install the |NCS| following the instructions in the :ref:`install_ncs` documentation page.
6543

66-
.. _ug_nrf54h20_install_toolchain:
44+
.. rst-class:: numbered-step
6745

68-
Installing the |NCS| toolchain
69-
==============================
46+
Installing additional nRF Util commands
47+
***************************************
7048

71-
.. include:: ../../../installation/install_ncs.rst
72-
:start-after: .. installncstoolchain-include-start
73-
:end-before: .. installncstoolchain-include-end
49+
After installing the |NCS| and its toolchain, you get the :ncs-tool-version:`NRFUTIL_VERSION_WIN10` version of nRF Util core module (``nrfutil``).
50+
Using the nRF54H20 DK with the |NCS| version |release| also requires the following nRF Util components:
7451

75-
Installing nRF Util and its commands
76-
====================================
52+
.. _ug_nrf54h20_nrfutil_comm_ver:
7753

78-
When you install the |NCS| toolchain as listed above, you get the :ncs-tool-version:`NRFUTIL_VERSION_WIN10` version of nRF Util core module (``nrfutil``).
79-
Using the nRF54H20 DK with the |NCS| version |release| requires the following:
54+
+----------------------------------------------+-------------------------------------+
55+
| nRF Util component | Required version |
56+
+==============================================+=====================================+
57+
| nRF Util (``nrfutil``) | Latest |
58+
+----------------------------------------------+-------------------------------------+
59+
| nRF Util ``device`` command | version |54H_nrfutil_device_ver| |
60+
+----------------------------------------------+-------------------------------------+
61+
| nRF Util ``trace`` command | version |54H_nrfutil_trace_ver| |
62+
+----------------------------------------------+-------------------------------------+
8063

81-
* The latest version of nRF Util core module (``nrfutil``), which might or might not be the same as the version installed with the |NCS| toolchain
82-
* nRF Util ``device`` command version |54H_nrfutil_device_ver|
83-
* nRF Util ``trace`` command v4.0.1
64+
To install the required versions of the nRF Util commands, complete the following steps:
8465

85-
To update your nRF Util installation, complete the following steps:
66+
1. Update your existing nRF Util installation:
8667

87-
1. Make sure you have removed the lock on the nRF Util installation to be able to install other nRF Util commands.
88-
See `Locking nRF Util home directory`_ in the tool documentation for more information.
89-
#. Run the following command to update the core module to the latest version:
68+
a. Make sure you have removed the lock on the nRF Util installation to be able to install other nRF Util commands.
69+
See `Locking nRF Util home directory`_ in the tool documentation for more information.
70+
#. Run the following command to update the core module to the latest version:
9071

91-
.. code-block::
72+
.. code-block::
9273
93-
nrfutil self-upgrade
74+
nrfutil self-upgrade
9475
95-
For more information, consult the `Upgrading nRF Util core module`_ documentation.
76+
For more information, consult the `Upgrading nRF Util core module`_ documentation.
9677

97-
#. Install the required versions of nRF Util commands, as listed above, using the command from `Installing specific versions of nRF Util commands`_.
98-
For example, the following command installs the nRF Util ``device`` command:
78+
#. Install the required versions of the nRF Util commands:
9979

100-
.. code-block::
80+
.. parsed-literal::
81+
:class: highlight
10182
102-
nrfutil install device=<version_number> --force
83+
nrfutil install device=\ |54H_nrfutil_device_ver|\ --force
84+
nrfutil install trace=\ |54H_nrfutil_trace_ver|\ --force
10385
104-
.. note::
105-
Substitute ``<version_number>`` with |54H_nrfutil_device_ver|.
86+
For more information, see the `Installing specific versions of nRF Util commands`_ documentation.
10687

107-
#. To verify the installation of the nRF Util commands, run the following command:
88+
#. Verify the installation of the nRF Util commands:
10889

10990
.. code-block::
11091
111-
nrfutil <command> --version
112-
113-
.. note::
114-
Substitute ``<command>`` with either ``device``, or ``trace``.
92+
nrfutil device --version
93+
nrfutil trace --version
11594
116-
The output will show the installed version of that command.
95+
The output will show the installed versions.
96+
Ensure they match the required versions.
11797

118-
Getting the |NCS| code
119-
======================
120-
121-
.. include:: ../../../installation/install_ncs.rst
122-
:start-after: .. getncscode-include-start
123-
:end-before: .. getncscode-include-end
98+
.. rst-class:: numbered-step
12499

125100
Installing a terminal application
126-
=================================
101+
*********************************
127102

128103
Install a terminal emulator, such as the `Serial Terminal app`_ (from the nRF Connect for Desktop application) or the nRF Terminal (part of the `nRF Connect for Visual Studio Code`_ extension).
129104
Both of these terminal emulators start the required :ref:`toolchain environment <using_toolchain_environment>`.
130105

131106
.. _ug_nrf54h20_gs_bringup:
132-
133-
nRF54H20 DK bring-up
134-
********************
135-
136-
The following sections describe the steps required for the nRF54H20 bring-up.
137-
138-
.. note::
139-
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``.
107+
.. _ug_nrf54h20_gs_bicr:
141108

142109
.. rst-class:: numbered-step
143110

144111
Programming the BICR
145-
====================
112+
********************
146113

147114
The Board Information Configuration Registers (BICR) are non-volatile memory (NVM) registers that contain information on how the nRF54H20 SoC must interact with other board elements, including information about power and clock delivery to the SoC.
148115
To prepare the nRF54H20 DK for first use, you must manually program the values of the BICR using a precompiled BICR binary file (:file:`bicr.hex`).
149116

150-
1. Download the `BICR new binary file`_.
117+
1. Download the `nRF54H20 DK BICR binary file`_.
151118
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.
152119

153120
.. note::
@@ -161,18 +128,25 @@ To prepare the nRF54H20 DK for first use, you must manually program the values o
161128

162129
nrfutil device program --options chip_erase_mode=ERASE_NONE --firmware bicr.hex --core Application --serial-number <serial_number>
163130

164-
.. rst-class:: numbered-step
165-
166131
.. _ug_nrf54h20_SoC_binaries:
167132

133+
.. rst-class:: numbered-step
134+
168135
Programming the nRF54H20 SoC binaries
169-
=====================================
136+
*************************************
137+
138+
.. note::
139+
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+
This means that this is likely the first use of your nRF54H20 DK.
141+
142+
Devices already provisioned using SUIT-based binaries and in LCS ``RoT`` cannot be transitioned back to LCS ``EMPTY``.
143+
For more information, see :ref:`abi_compatibility`.
170144

171145
After programming the BICR, program the nRF54H20 SoC with the :ref:`nRF54H20 SoC binaries <abi_compatibility>`.
172146
This bundle contains the precompiled firmware for the :ref:`Secure Domain <ug_nrf54h20_secure_domain>` and :ref:`System Controller <ug_nrf54h20_sys_ctrl>`.
173147
To program the nRF54H20 SoC binaries to the nRF54H20 DK, do the following:
174148

175-
1. Download the `nRF54H20 SoC binaries v22.2.0+14`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
149+
1. Download the `nRF54H20 SoC binaries v22.2.0+14`_, compatible with the nRF54H20 DK v0.9.0 and later DK revisions.
176150

177151
.. note::
178152
On MacOS, ensure that the ZIP file is not unpacked automatically upon download.
@@ -184,7 +158,7 @@ To program the nRF54H20 SoC binaries to the nRF54H20 DK, do the following:
184158
.. rst-class:: numbered-step
185159

186160
Transitioning the nRF54H20 SoC to RoT
187-
=====================================
161+
*************************************
188162

189163
The current nRF54H20 DK comes with its lifecycle state (LCS) set to ``EMPTY``.
190164
To operate correctly, you must transition its lifecycle state to Root of Trust (``RoT``).
@@ -205,8 +179,10 @@ To transition the LCS to ``RoT``, do the following:
205179

206180
.. _ug_nrf54h20_gs_sample:
207181

208-
Building and programming the sample
209-
***********************************
182+
.. rst-class:: numbered-step
183+
184+
Building and programming your first sample to the nRF54H20 DK
185+
*************************************************************
210186

211187
The :zephyr:code-sample:`sysbuild_hello_world` sample is a multicore sample running on both the application core (``cpuapp``) and the Peripheral Processor (PPR, ``cpuppr``).
212188
It uses the ``nrf54h20dk/nrf54h20/cpuapp`` board target.
@@ -227,20 +203,18 @@ If you have multiple Nordic Semiconductor devices, ensure that only the nRF54H20
227203
228204
west flash
229205
230-
Make sure you have the :ref:`nrfutil device <ug_nrf54h20_install_toolchain>` command installed for ``west flash`` to work with the nRF54H20 DK.
231206
This command builds and programs the sample automatically on both the application core and the Peripheral Processor (PPR) of the nRF54H20 SoC.
232207

233208
.. include:: /includes/nRF54H20_erase_UICR.txt
234209

235210
.. _ug_nrf54h20_sample_reading_logs:
236211

237-
Reading the logs
238-
****************
212+
.. rst-class:: numbered-step
239213

240-
With the :zephyr:code-sample:`sysbuild_hello_world` sample programmed, the nRF54H20 DK outputs logs for the application core and the configured remote processor.
241-
The logs are output over UART.
214+
Testing your first sample on the nRF54H20 DK
215+
********************************************
242216

243-
To read the logs from the :zephyr:code-sample:`sysbuild_hello_world` sample programmed to the nRF54H20 DK, complete the following steps:
217+
Now that the :zephyr:code-sample:`sysbuild_hello_world` sample is programmed, verify its operation by capturing the UART logs from both the application core and the peripheral processor:
244218

245219
1. Connect to the DK with a terminal emulator (for example, the `Serial Terminal app`_) using the :ref:`default serial port connection settings <test_and_optimize>`.
246220
#. Press the **Reset** button on the PCB to reset the DK.

‎doc/nrf/links.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1902,8 +1902,10 @@
19021902

19031903
.. _`nRF54H20 SoC binaries v22.2.0+14`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v22.2.0%2B14.zip
19041904

1905+
## Old BICR file
19051906
.. _`BICR binary file`: https://files.nordicsemi.com/artifactory/SDSC/external/bicr_ext_loadcap.hex
1906-
.. _`BICR new binary file`: https://files.nordicsemi.com/artifactory/SDSC/external/bicr/bicr.hex
1907+
## New BICR file
1908+
.. _`nRF54H20 DK BICR binary file`: https://files.nordicsemi.com/artifactory/SDSC/external/bicr/bicr.hex
19071909

19081910
.. _`DTS format definition`: https://github.com/nrfconnect/sdk-zephyr/blob/v3.7.99-ncs2/dts/bindings/misc/nordic%2Cnrf-bicr.yaml
19091911
.. _`JSON format definition`: https://github.com/nrfconnect/sdk-zephyr/blob/v4.0.99-ncs1/soc/nordic/nrf54h/bicr/bicr-schema.json

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ nRF54H20 BICR
128128

129129
To update the BICR of your development kit while in Root of Trust, do the following:
130130

131-
1. Download the `BICR new binary file`_.
131+
1. Download the `nRF54H20 DK BICR binary file`_.
132132
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.
133133

134134
.. note::

‎doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ nRF54H20 BICR
3333

3434
To update the BICR of your development kit while in Root of Trust, do the following:
3535

36-
1. Download the `BICR new binary file`_.
36+
1. Download the `nRF54H20 DK BICR binary file`_.
3737
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.
3838

3939
.. note::

‎doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ nRF54H20 BICR
4545

4646
To update the BICR of your development kit while in Root of Trust, do the following:
4747

48-
1. Download the `BICR new binary file`_.
48+
1. Download the `nRF54H20 DK BICR binary file`_.
4949
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.
5050

5151
.. note::

‎doc/nrf/shortcuts.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
.. |jlink_ver| replace:: v8.60
1010

1111
.. |54H_nrfutil_device_ver| replace:: 2.12.6
12+
.. |54H_nrfutil_trace_ver| replace:: 4.0.1
1213

1314
.. ### Config shortcuts
1415

0 commit comments

Comments
 (0)