Skip to content

Commit

Permalink
doc: Updated H20 GS and ABI comp
Browse files Browse the repository at this point in the history
Updated H20 GS and ABI comp for 2.9-nRF54H20.

Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
  • Loading branch information
FrancescoSer committed Dec 16, 2024
1 parent a661b92 commit 2edbc13
Show file tree
Hide file tree
Showing 4 changed files with 219 additions and 13 deletions.
40 changes: 27 additions & 13 deletions doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Make sure you have all the required hardware and that your computer has one of t
Hardware
========

* nRF54H20 DK version PCA10175 Engineering C - v0.8.3 and later revisions
* nRF54H20 DK version PCA10175 Engineering C - v0.9.0 and later revisions

Check the version number on your DK's sticker to verify its compatibility with the |NCS|.

Expand Down Expand Up @@ -62,7 +62,9 @@ You also need the following:
.\JLink_Windows_V794i_x86_64.exe -InstUSBDriver=1

#. Follow the on-screen instructions.
#. After installing, 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.
#. After installing, add the J-Link executable to the system path on Linux and MacOS.
On Windows, add it to the environment variables.
This allows you to run it from anywhere on the system.

* The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_.
* In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_.
Expand Down Expand Up @@ -91,7 +93,7 @@ To install the toolchain and the SDK using the Toolchain Manager app, complete t

a. `Download nRF Connect for Desktop`_ for your operating system.
#. Install and run the tool on your machine.
#. In the :guilabel:`APPS` section, click :guilabel:`Install` next to Toolchain Manager.
#. In the :guilabel:`Apps` section, click :guilabel:`Install` next to Toolchain Manager.

The app installs on your machine, and the :guilabel:`Install` button changes to :guilabel:`Open`.

Expand Down Expand Up @@ -153,8 +155,10 @@ Installing nRF Util and its commands

Using the nRF54H20 DK with the |NCS| version |release| requires the following:

* nRF Util version 7.11.1 or higher
* nRF Util ``device`` version 2.7.2
* nRF Util version 7.13.0 or higher
* nRF Util ``device`` version 2.7.8
* nRF Util ``trace`` version 3.10.0
* nRF Util ``suit`` version 0.9.0

1. Download the nrfutil executable file from the `nRF Util development tool`_ product page.
#. Add nRF Util to the system path on Linux and MacOS, or environment variables on Windows, to run it from anywhere on the system.
Expand All @@ -170,15 +174,23 @@ Using the nRF54H20 DK with the |NCS| version |release| requires the following:

nrfutil --version

#. If your version is below 7.11.1, run the following command to update nRF Util::
#. If your version is below 7.13.0, run the following command to update nRF Util::

nrfutil self-upgrade

For more information, consult the `nRF Util`_ documentation.

#. Install the nRF Util ``device`` command version 2.7.2 as follows::
#. Install the nRF Util ``device`` command version 2.7.8 as follows::

nrfutil install device=2.7.2 --force
nrfutil install device=2.7.8 --force

#. Install the nRF Util ``trace`` command version 3.10.0 as follows::

nrfutil install trace=3.10.0 --force

#. Install the nRF Util ``suit`` command version 0.9.0 as follows::

nrfutil install suit=0.9.0 --force

.. _ug_nrf54h20_gs_bringup:

Expand All @@ -199,7 +211,7 @@ To prepare the nRF54H20 DK for first use, you must manually program the values o
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.

.. note::
On MacOS, connecting the DK might cause a popup containing the message ``Disk Not Ejected Properly`` to appear repeatedly on screen.
On MacOS, connecting the DK might cause a popup containing the message ``Disk Not Ejected Properly`` to appear on screen multiple times.
To disable this, run ``JLinkExe``, then run ``MSDDisable`` in the J-Link Commander interface.

#. List all the connected development kits to see their serial number (matching the one on the DK's sticker)::
Expand All @@ -217,10 +229,11 @@ To prepare the nRF54H20 DK for first use, you must manually program the values o
Programming the nRF54H20 SoC binaries
=====================================

After programming the BICR, you need to provide the nRF54H20 SoC with the provisioning of the nRF54H20 SoC binaries, a bundle containing the precompiled firmware for the Secure Domain and System Controller.
After programming the BICR, program the nRF54H20 SoC with the nRF54H20 SoC binaries.
This bundle contains the precompiled firmware for the Secure Domain and System Controller.
To program the nRF54H20 SoC binaries to the nRF54H20 DK, do the following:

1. Download the `nRF54H20 SoC Binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
1. Download the `nRF54H20 SoC Binaries v0.8.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.

.. note::
On MacOS, ensure that the ZIP file is not unpacked automatically upon download.
Expand Down Expand Up @@ -275,7 +288,7 @@ If you have multiple Nordic Semiconductor devices, ensure that only the nRF54H20
west flash
The sample will be built and programmed automatically on both the application core and the Peripheral Processor (PPR) of the nRF54H20.
This command builds and programs the sample automatically on both the application core and the Peripheral Processor (PPR) of the nRF54H20.

.. include:: /includes/nRF54H20_erase_UICR.txt

Expand Down Expand Up @@ -309,7 +322,8 @@ Next steps
You are now all set to use the nRF54H20 DK.
See the following links for where to go next:

* :ref:`ug_nrf54h20_architecture` for information about the multicore System on Chip, such as the responsibilities of the cores and their interprocessor interactions, the memory mapping, and the boot sequence.
* :ref:`ug_nrf54h20_architecture` for information about the multicore System on Chip.
This includes the responsibilities of the cores, their interprocessor interactions, the memory mapping, and the boot sequence.
* The :ref:`introductory documentation <getting_started>` for more information on the |NCS| and the development environment.
* :ref:`configuration_and_build` documentation to learn more about the |NCS| development environment.
* :ref:`ug_nrf54h` documentation for more advanced topics related to the nRF54H20.
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1741,6 +1741,7 @@
.. _`nRF54H20 SoC binaries v0.6.5`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.6.5.zip
.. _`nRF54H20 SoC Binaries v0.7.0 for EngC DKs`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.7.0_engc.zip
.. _`nRF54H20 SoC Binaries v0.7.0 for EngB DKs`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.7.0_engb.zip
.. _`nRF54H20 SoC binaries v0.8.0`: https://files.nordicsemi.com/ui/native/SDSC/external/nrf54h20_soc_binaries_v0.8.0.zip

.. _`BICR binary file`: https://files.nordicsemi.com/artifactory/SDSC/external/bicr_ext_loadcap.hex
.. _`BICR new binary file`: https://files.nordicsemi.com/artifactory/SDSC/external/bicr/bicr.hex
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/abi_compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ The following table illustrates ABI compatibility between different versions of

* - |NCS| versions
- Compatible nRF54H20 SoC binaries version
* - |NCS| v2.9.0-nRF54H20
- `nRF54H20 SoC Binaries v0.8.0`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
* - |NCS| v2.9.0
- `nRF54H20 SoC Binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
* - |NCS| v2.8.0
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
.. _migration_2.9.0-nrf54h20:

Migration guide for |NCS| v2.9.0-nRF54H20 (Working draft)
#########################################################

.. contents::
:local:
:depth: 3

This document describes the changes required or recommended when migrating your nRF54H20 application from the |NCS| v2.8.0 to the |NCS| v2.9.0-nRF54H20.

.. HOWTO
Add changes in the following format:
Component (for example, application, sample or libraries)
*********************************************************
.. toggle::
* Change1 and description
* Change2 and description
.. _migration_2.9.0-nrf54h20_required:

Required changes
****************

The following changes are mandatory to make your application work in the same way as in previous releases.

nRF54H20
========

This section describes the changes specific to the nRF54H20 SoC and DK support in the |NCS|.
For more information on changes related to samples and applications usage on the nRF54H20 DK, see :ref:`migration_2.9.0-nrf54h20_required_nrf54h`.

DK compatibility
----------------

.. toggle::

* The |NCS| v2.9.0-nRF54H20 is compatible only with the Engineering C - v0.9.0 and later revisions of the nRF54H20 DK, PCA10175.
Check the version number on your DK's sticker to verify its compatibility with the |NCS|.

Dependencies
------------

The following required dependencies for the nRF54H20 SoC and DK have been updated.

## >> ADD toolchain switch <<

nRF54H20 SoC binaries
+++++++++++++++++++++

.. toggle::

* The *nRF54H20 SoC binaries* bundle has been updated to version 0.8.0.

To update the SoC binaries bundle of your development kit while in Root of Trust, do the following:

1. Download the `nRF54H20 SoC Binaries v0.8.0`_.

.. note::
On MacOS, ensure that the ZIP file is not unpacked automatically upon download.

#. Purge the device as follows::

nrfutil device recover --core Application --serial-number <serial_number>
nrfutil device recover --core Network --serial-number <serial_number>

#. Run ``west update``.
#. 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:

nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.8.0.zip --serial-number <serial_number>

nrfutil
+++++++

.. toggle::

* ``nrfutil`` has been updated to version 7.13.0.

Install nRF Util version 7.13.0 as follows:

1. Download the nrfutil executable file from the `nRF Util development tool`_ product page.
#. Add nRF Util to the system path on Linux and MacOS, or environment variables on Windows, to run it from anywhere on the system.
On Linux and MacOS, use one of the following options:

* Add nRF Util's directory to the system path.
* Move the file to a directory in the system path.

#. On MacOS and Linux, give ``nrfutil`` execute permissions by typing ``chmod +x nrfutil`` in a terminal or using a file browser.
This is typically a checkbox found under file properties.
#. On MacOS, to run the nrfutil executable you need to allow it in the system settings.
#. Verify the version of the nRF Util installation on your machine by running the following command::

nrfutil --version

#. If your version is below 7.13.0, run the following command to update nRF Util::

nrfutil self-upgrade

For more information, consult the `nRF Util`_ documentation.

nrfutil device
++++++++++++++

.. toggle::

* ``nrfutil device`` has been updated to version 2.7.8.

Install the nRF Util ``device`` command version 2.7.8 as follows::

nrfutil install device=2.7.8 --force

For more information, consult the `nRF Util`_ documentation.

nrfutil trace
+++++++++++++

.. toggle::

* ``nrfutil trace`` has been updated to version 3.10.0.

Install the nRF Util ``trace`` command version 3.10.0 as follows::

nrfutil install trace=3.10.0 --force

For more information, consult the `nRF Util`_ documentation.

nrfutil suit
++++++++++++

.. toggle::

* ``nrfutil suit`` has been updated to version 0.9.0.

Install the nRF Util ``suit`` command version 0.9.0 as follows::

nrfutil install suit=0.9.0 --force

For more information, consult the `nRF Util`_ documentation.

Samples and applications
========================

This section describes the changes related to samples and applications.

|no_changes_yet_note|

.. _migration_2.9.0-nrf54h20_required_nrf54h:

nRF54H20
--------

|no_changes_yet_note|

Libraries
=========

This section describes the changes related to libraries.

|no_changes_yet_note|

.. _migration_2.9.0-nrf54h20_recommended:

Recommended changes
*******************

The following changes are recommended for your application to work optimally after the migration.

Samples and applications
========================

This section describes the changes related to samples and applications.

Matter
------

This section describes the changes related to Matter support.

|no_changes_yet_note|

Libraries
=========

This section describes the changes related to libraries.

|no_changes_yet_note|

0 comments on commit 2edbc13

Please sign in to comment.