doc: Release notes for 2.9.0-nRF54H20-1

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

Hide file tree

Showing 32 changed files with 177 additions and 127 deletions.
diff --git a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_suit_recovery.rst b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_suit_recovery.rst
@@ -125,15 +125,15 @@ To turn an application into a recovery application, the following steps have to
 
    * :kconfig:option:`CONFIG_SUIT_RECOVERY` set to ``y``
    * :kconfig:option:`CONFIG_NRF_REGTOOL_GENERATE_UICR` set to ``n``
-   * :kconfig:option:`CONFIG_NRF_REGTOOL_GENERATE_BICR` set to ``n``
+   * :kconfig:option:`CONFIG_SOC_NRF54H20_GENERATE_BICR` set to ``n``
 
    To do that you can simply paste the following code snippet into your configuration files:
 
       .. code-block:: cfg
 
          CONFIG_SUIT_RECOVERY=y
          CONFIG_NRF_REGTOOL_GENERATE_UICR=n
-         CONFIG_NRF_REGTOOL_GENERATE_BICR=n
+         CONFIG_SOC_NRF54H20_GENERATE_BICR=n
 
 #. Create the overlay files to be used by the recovery application.
    In this guide it is assumed that for the application core they are placed in the custom recovery application directory in the :file:`boards/nrf54h20dk_nrf54h20_cpuapp.overlay` file.

diff --git a/doc/nrf/conf.py b/doc/nrf/conf.py
@@ -26,7 +26,7 @@
 # General configuration --------------------------------------------------------
 
 project = "nRF Connect SDK"
-copyright = "2019-2024, Nordic Semiconductor"
+copyright = "2019-2025, Nordic Semiconductor"
 author = "Nordic Semiconductor"
 version = release = os.environ.get("DOCSET_VERSION")
 

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-1
          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-1
          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,7 +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-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-nRF54H20-1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0-nRF54H20-1
 .. _`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
 .. _`known issues for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-7-0
@@ -480,7 +480,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-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-nRF54H20-1`: https://docs.nordicsemi.com/bundle/ncs-2.9.0-nRF54H20-1/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
 .. _`Repositories and revisions for v2.7.99-cs2`: https://docs.nordicsemi.com/bundle/ncs-2.7.99-cs2/page/nrf/releases_and_maturity/repository_revisions.html
@@ -572,7 +572,7 @@
 .. _`LwM2M carrier library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html
 
 .. _`Migration guide for nRF Connect SDK v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_3.0.html
-.. _`Migration guide for nRF Connect SDK v2.9.0-nRF54H20-rc1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20-rc1.html
+.. _`Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1.html
 .. _`Migration guide for nRF Connect SDK v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.html
 .. _`Migration guide for nRF Connect SDK v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.8.html
 .. _`Migration guide for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.7.html
@@ -1565,8 +1565,8 @@
 
 .. ### Source: files.nordicsemi.com
 
-.. _`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-nRF54H20-1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-1/test-report/twister_test_results_report.html?isNativeBrowsing=true
+.. _`Hardware test report for nRF Connect SDK v2.9.0-nRF54H20-1`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0-nrf54h20-1/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
 .. _`Hardware 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/common_ncs_test_results_report.html?isNativeBrowsing=true
 .. _`Twister test report for nRF Connect SDK v2.8.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.8.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-1        |                                                     |                        |
    +--------------------------+                                                     |                        |
    | v2.9.0                   |                                                     |                        |
    +--------------------------+-----------------------------------------------------+------------------------+

diff --git a/doc/nrf/releases_and_maturity/abi_compatibility.rst b/doc/nrf/releases_and_maturity/abi_compatibility.rst
@@ -28,7 +28,7 @@ The following table illustrates ABI compatibility between different versions of
 
    * - |NCS| versions
      - Compatible nRF54H20 SoC binaries version
-   * - |NCS| v2.9.0-nRF54H20
+   * - |NCS| v2.9.0-nRF54H20-1
      - `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.

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/...on/migration_guide_2.9.0-nrf54h20-rc1.rst → ...tion/migration_guide_2.9.0-nRF54H20-1.rst b/...on/migration_guide_2.9.0-nrf54h20-rc1.rst → ...tion/migration_guide_2.9.0-nRF54H20-1.rst
@@ -1,13 +1,15 @@
-.. _migration_2.9.0-nrf54h20-rc1:
+:orphan:
 
-Migration guide for |NCS| v2.9.0-nRF54H20-rc1
-#############################################
+.. _migration_2.9.0-nrf54h20-1:
+
+Migration guide for |NCS| v2.9.0-nRF54H20-1
+###########################################
 
 .. 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-rc1.
+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-1.
 
 .. HOWTO
 
@@ -21,7 +23,7 @@ This document describes the changes required or recommended when migrating your
       * Change1 and description
       * Change2 and description
 
-.. _migration_2.9.0-nrf54h20-rc1_required:
+.. _migration_2.9.0-nrf54h20-1_required:
 
 Required changes
 ****************
@@ -38,7 +40,7 @@ DK compatibility
 
 .. toggle::
 
-   * The |NCS| v2.9.0-nRF54H20-rc1 is compatible only with the Engineering C - v0.9.0 and later revisions of the nRF54H20 DK, PCA10175.
+   * 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
@@ -57,55 +59,14 @@ SDK and toolchain
    #. 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
-+++++++++++++++++++++
+nRF Util
+++++++++
 
 .. 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`` has been updated to v7.13.0.
 
-          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>
-
-    #. Purge the device again as follows::
-
-          nrfutil device recover --core Application --serial-number <serial_number>
-          nrfutil device recover --core Network --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:
+    Install nRF Util v7.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.
@@ -127,41 +88,94 @@ nrfutil
 
          For more information, see the `nRF Util`_ documentation.
 
-nrfutil device
-++++++++++++++
+nRF Util device
++++++++++++++++
 
 .. toggle::
 
-  * ``nrfutil device`` has been updated to version 2.7.10.
+  * nRF Util ``device`` command has been updated to v2.7.10.
 
-    Install the nRF Util ``device`` command version 2.7.10 as follows::
+    Install the nRF Util ``device`` command v2.7.10 as follows::
 
        nrfutil install device=2.7.10 --force
 
     For more information, consult the `nRF Util`_ documentation.
 
-nrfutil trace
-+++++++++++++
+nRF Util trace
+++++++++++++++
 
 .. toggle::
 
-  * ``nrfutil trace`` has been updated to version 3.10.0.
+  * nRF Util ``trace`` command has been updated to v3.1.0.
 
-    Install the nRF Util ``trace`` command version 3.10.0 as follows::
+    Install the nRF Util ``trace`` command v3.1.0 as follows::
 
-       nrfutil install trace=3.10.0 --force
+       nrfutil install trace=3.1.0 --force
 
     For more information, consult the `nRF Util`_ documentation.
 
-nrfutil suit
-++++++++++++
+nRF Util suit
++++++++++++++
 
 .. toggle::
 
-  * ``nrfutil suit`` has been updated to version 0.9.0.
+  * nRF Util ``suit`` command has been updated to v0.9.0.
 
-    Install the nRF Util ``suit`` command version 0.9.0 as follows::
+    Install the nRF Util ``suit`` command v0.9.0 as follows::
 
        nrfutil install suit=0.9.0 --force
 
     For more information, consult the `nRF Util`_ documentation.
+
+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>
+
+    #. Purge the device again as follows::
+
+          nrfutil device recover --core Application --serial-number <serial_number>
+          nrfutil device recover --core Network --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>
+
+nrf-regtool
++++++++++++
+
+.. toggle::
+
+  * ``nrf-regtool`` has been updated to v8.1.2.
+
+    1. Open nRF Connect for Desktop, navigate to the Toolchain Manager, select the v2.9.0-nRF54H20-1 toolchain, and click the :guilabel:`Open terminal` button.
+    #. In the terminal window, install ``nrf-regtool`` v8.1.2 as follows::
+
+          pip install nrf-regtool==8.1.2
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