doc: Release notes for 2.9.0-nRF54H20

Added release notes for 2.9.0-nRF54H20 Added migration guide for 2.9.0-nRF54H20 Added other minor release edits for 2.9.0-nRF54H20 Signed-off-by: Francesco Domenico Servidio <[email protected]>
nrfconnect · Jan 15, 2025 · d218a67 · d218a67
1 parent 58c72c8
commit d218a67
Show file tree

Hide file tree

Showing 31 changed files with 691 additions and 38 deletions.
diff --git a/doc/nrf/dev_model_and_contributions/adding_code.rst b/doc/nrf/dev_model_and_contributions/adding_code.rst
@@ -162,7 +162,7 @@ This is demonstrated by the following code, that would be placed somewhere in yo
        - name: nrf
          repo-path: sdk-nrf
          remote: ncs
-         revision: 2.9.0-nRF54H20-rc1
+         revision: 2.9.0-nRF54H20
          import: true
      self:
        path: application
@@ -189,7 +189,7 @@ For example:
      projects:
        - name: nrf
          remote: ncs
-         revision: 2.9.0-nRF54H20-rc1
+         revision: 2.9.0-nRF54H20
          import: true
        # Example for how to override a repository in the nRF Connect SDK with your own:
        - name: mcuboot

diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt
@@ -429,6 +429,7 @@
 .. _`nRF Connect SDK latest documentation`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html
 
 .. _`known issues page on the main branch`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html
+.. _`known issues for nRF Connect SDK v2.9.0-nRF54H20`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0-nRF54H20
 .. _`known issues for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0-nRF54H20-rc1
 .. _`known issues for nRF Connect SDK v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0
 .. _`known issues for nRF Connect SDK v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-8-0
@@ -480,6 +481,7 @@
 
 .. _`nRF socket options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/nrf_modem/doc/sockets.html
 
+.. _`Repositories and revisions for v2.9.0-nRF54H20`: https://docs.nordicsemi.com/bundle/ncs-2.9.0-nrf54h20/page/nrf/releases_and_maturity/repository_revisions.html
 .. _`Repositories and revisions for v2.9.0-nRF54H20-rc1`: https://docs.nordicsemi.com/bundle/ncs-2.9.0-nrf54h20-rc1/page/nrf/releases_and_maturity/repository_revisions.html
 .. _`Repositories and revisions for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/releases_and_maturity/repository_revisions.html
 .. _`Repositories and revisions for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/repository_revisions.html
@@ -1565,6 +1567,8 @@
 
 .. ### Source: files.nordicsemi.com
 
+.. _`Twister test report for nRF Connect SDK v2.9.0-nRF54H20`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20/test-report/twister_test_results_report.html?isNativeBrowsing=true
+.. _`Hardware test report for nRF Connect SDK v2.9.0-nRF54H20`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
 .. _`Twister test report for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-rc1/test-report/twister_test_results_report.html?isNativeBrowsing=true
 .. _`Hardware test report for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-rc1/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
 .. _`Twister test report for nRF Connect SDK v2.9.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0/test-report/twister_test_results_report.html?isNativeBrowsing=true

diff --git a/doc/nrf/protocols/matter/index.rst b/doc/nrf/protocols/matter/index.rst
@@ -23,9 +23,9 @@ For a full list of |NCS| and Matter versions, view the following table:
    +--------------------------+-----------------------------------------------------+------------------------+
    | nRF Connect SDK version  | Matter specification version                        | Matter SDK version     |
    +==========================+=====================================================+========================+
-   | v2.9.99 (latest)         | :ref:`1.4.0 <ug_matter_overview_dev_model_support>` | 1.4.0.0                |
+   | |release|                | :ref:`1.4.0 <ug_matter_overview_dev_model_support>` | 1.4.0.0                |
    +--------------------------+                                                     |                        |
-   | |release|                |                                                     |                        |
+   | v2.9.0-nRF54H20-rc1      |                                                     |                        |
    +--------------------------+                                                     |                        |
    | v2.9.0                   |                                                     |                        |
    +--------------------------+-----------------------------------------------------+------------------------+

diff --git a/doc/nrf/releases_and_maturity/abi_compatibility.rst b/doc/nrf/releases_and_maturity/abi_compatibility.rst
@@ -30,6 +30,8 @@ The following table illustrates ABI compatibility between different versions of
      - 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-rc1
+     - `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

diff --git a/...4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_application.rst b/...4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_application.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_cs3_to_2_6_99_cs2_app:
 
 Migrate your application to |NCS| v2.6.99_cs2 (for v2.4.99-cs3 users)

diff --git a/...4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst b/...4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_cs3_to_2_6_99_cs2_env:
 
 Update your development environment for |NCS| v2.6.99_cs2 (for v2.4.99-cs3 users)

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _ncs_2.0.0_migration:
 
 Migration notes for |NCS| v2.0.0

diff --git a/...rf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst b/...rf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_cs3_to_2_6_99_cs2:
 
 Migration notes for |NCS| v2.6.99_cs2 for v2.4.99-cs3 users

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.5.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.5.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.5:
 
 Migration guide for |NCS| v2.5.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.6.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.6.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.6:
 
 Migration guide for |NCS| v2.6.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.7:
 
 Migration guide for |NCS| v2.7.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.8:
 
 Migration guide for |NCS| v2.8.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20-rc1.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20-rc1.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.9.0-nrf54h20-rc1:
 
 Migration guide for |NCS| v2.9.0-nRF54H20-rc1

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20.rst
@@ -0,0 +1,164 @@
+:orphan:
+
+.. _migration_2.9.0-nrf54h20:
+
+Migration guide for |NCS| v2.9.0-nRF54H20
+#########################################
+
+.. 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|.
+
+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.
+
+SDK and toolchain
++++++++++++++++++
+
+.. toggle::
+
+  * To update the SDK and the toolchain, do the following:
+
+   1. Open Toolchain Manager in nRF Connect for Desktop.
+   #. Click :guilabel:`SETTINGS` in the navigation bar to specify where you want to install the |NCS|.
+   #. In :guilabel:`SDK ENVIRONMENTS`, click the :guilabel:`Install` button next to the |NCS| version |release|.
+
+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>
+
+    #. Erase the device as follows::
+
+          nrfutil device erase --all --core Network --serial-number <snr>
+          nrfutil device erase --all --core Application --serial-number <snr>
+          nrfutil device reset --reset-kind RESET_PIN --serial-number <snr>
+
+    #. Run ``west update``.
+    #. Move the correct :file:`.zip` bundle to a folder of your choice, then run nRF Util to program the binaries using the following command::
+
+          nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.8.0.zip --serial-number <serial_number>
+
+    #. Erase the device again as follows::
+
+          nrfutil device erase --all --core Network --serial-number <snr>
+          nrfutil device erase --all --core Application --serial-number <snr>
+          nrfutil device reset --reset-kind RESET_PIN --serial-number <snr>
+
+nrfutil
++++++++
+
+.. toggle::
+
+  * ``nrfutil`` has been updated to version 7.13.0.
+
+    Install nRF Util version 7.13.0 as follows:
+
+      1. Download the nRF Util 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 nRF Util 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, see 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.
diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.9:
 
 Migration guide for |NCS| v2.9.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_3.0:
 
 Migration guide for |NCS| v3.0.0 (Working draft)

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_nrf54h20_to_2.7:
 
 Migration notes for |NCS| v2.7.0 and the nRF54H20 DK

diff --git a/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst b/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_nrf54h20_to_2.7.99-cs1:
 
 Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK

diff --git a/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst b/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_nrf54h20_to_2.7.99-cs2:
 
 Migration notes for |NCS| v2.7.99-cs2 and the nRF54H20 DK

diff --git a/doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst b/doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _hwmv1_to_v2_migration:
 
 Migrating to the current hardware model

diff --git a/doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst b/doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _child_parent_to_sysbuild_migration:
 
 Migrating from multi-image builds to sysbuild

diff --git a/...ration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst b/...ration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_cs3_to_to_2_7_app:
 
 Migrate your application for the nRF54H20 DK to |NCS| v2.7.0 (for v2.4.99-cs3 users)

diff --git a/...ration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst b/...ration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2_6_99_cs2_to_2_7_app:
 
 Migrate your application for the nRF54H20 DK to |NCS| v2.7.0 (for v2.6.99-cs2 users)

diff --git a/...ration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst b/...ration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_cs2_to_2_7_env:
 
 Migrate your development environment to |NCS| v2.7.0 (for v2.6.99-cs2 users)

diff --git a/...ation/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst b/...ation/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _transition_cs3_to_2_7_env:
 
 Transition your development environment to |NCS| v2.7.0 (for v2.4.99-cs3 users)

diff --git a/doc/nrf/releases_and_maturity/migration_guides.rst b/doc/nrf/releases_and_maturity/migration_guides.rst
@@ -9,10 +9,20 @@ Migration guides are also provided for major functionality updates.
 .. note::
     |migration_contact_devzone|
 
-.. toctree::
-   :maxdepth: 1
-   :glob:
-   :reversed:
-   :caption: Subpages:
+* `Migrating from multi-image builds to sysbuild`_
+* `Migrating to the current hardware model`_
+* `Migration guide for nRF Connect SDK v2.9.0`_
+* `Migration guide for nRF Connect SDK v2.8.0`_
+* `Migration guide for nRF Connect SDK v2.7.0`_
+* `Migration guide for nRF Connect SDK v2.6.0`_
+* `Migration guide for nRF Connect SDK v2.5.0`_
+* `Migration guide for nRF Connect SDK v2.0.0`_
 
-   migration/*
+For nRF54H20-exclusive customer sampling releases:
+
+* `Migration guide for nRF Connect SDK v2.9.0-nRF54H20`_
+* `Migration guide for nRF Connect SDK v2.9.0-nRF54H20-rc1`_
+* `Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`_
+* `Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`_
+* `Migration notes for nRF Connect SDK v2.7.0 for nRF54H20 DK users`_
+* `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_