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 23, 2025 · cd4a2dc · cd4a2dc
1 parent a14701b
commit cd4a2dc
Show file tree

Hide file tree

Showing 34 changed files with 218 additions and 148 deletions.
diff --git a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst
@@ -7,9 +7,11 @@ Getting started with the nRF54H20 DK
    :local:
    :depth: 2
 
-This document gets you started with your nRF54H20 Development Kit (DK) using the |NCS|.
+This document gets you started with your nRF54H20 Development Kit (DK) using the |NCS| for the first time.
 It tells you how to install the :zephyr:code-sample:`sysbuild_hello_world` sample and perform a quick test of your DK.
 
+If you are migrating from an earlier version of the |NCS|, see :ref:`migration_guides`.
+
 .. _ug_nrf54h20_gs_requirements:
 
 Minimum requirements
@@ -214,7 +216,7 @@ After programming the BICR, program the nRF54H20 SoC with the :ref:`nRF54H20 SoC
 This bundle contains the precompiled firmware for the :ref:`Secure Domain <ug_nrf54h20_secure_domain>` and :ref:`System Controller <ug_nrf54h20_sys_ctrl>`.
 To program the nRF54H20 SoC binaries to the nRF54H20 DK, do the following:
 
-1. Download the `nRF54H20 SoC Binaries v0.8.0`_, compatible with the nRF54H20 DK v0.9.0 and later revisions.
+1. Download the `nRF54H20 SoC binaries v0.8.0`_, 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.

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
@@ -1756,12 +1756,12 @@
 
 .. _`curl`: https://curl.se/
 
-.. _`nRF54H20 SoC Binaries v0.3.3`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.3.3.zip
-.. _`nRF54H20 SoC Binaries v0.5.0`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.5.0.zip
-.. _`nRF54H20 SoC Binaries v0.6.2`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.6.2.zip
+.. _`nRF54H20 SoC binaries v0.3.3`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.3.3.zip
+.. _`nRF54H20 SoC binaries v0.5.0`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.5.0.zip
+.. _`nRF54H20 SoC binaries v0.6.2`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.6.2.zip
 .. _`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.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

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
@@ -1,6 +1,6 @@
 .. _abi_compatibility:
 
-ABI Compatibility
+ABI compatibility
 #################
 
 .. contents::
@@ -18,7 +18,7 @@ When ABI compatibility is maintained, binaries of one component can interface co
 For example, adding a new function to a library is typically an ABI-compatible change, as existing binaries remain functional.
 However, changes that affect data structure layouts, such as altering field order or size, break ABI compatibility as they change the memory layout expected by existing binaries.
 
-ABI Compatibility Matrix for the nRF54H20 SoC Binaries
+ABI compatibility matrix for the nRF54H20 SoC binaries
 ******************************************************
 
 The following table illustrates ABI compatibility between different versions of the nRF54H20 SoC binaries and the |NCS|:
@@ -28,26 +28,30 @@ 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-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.
+     - `nRF54H20 SoC binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
    * - |NCS| v2.8.0
-     - `nRF54H20 SoC Binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
-       `nRF54H20 SoC Binaries v0.7.0 for EngB DKs`_, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
+     - `nRF54H20 SoC binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions.
+       `nRF54H20 SoC binaries v0.7.0 for EngB DKs`_, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
    * - |NCS| v2.7.99-cs2
-     - `nRF54H20 SoC Binaries v0.6.5`_
+     - `nRF54H20 SoC binaries v0.6.5`_
    * - |NCS| v2.7.99-cs1
-     - `nRF54H20 SoC Binaries v0.6.2`_
+     - `nRF54H20 SoC binaries v0.6.2`_
    * - |NCS| v2.7.0
-     - `nRF54H20 SoC Binaries v0.5.0`_
+     - `nRF54H20 SoC binaries v0.5.0`_
    * - |NCS| v2.6.99-cs2
-     - `nRF54H20 SoC Binaries v0.3.3`_
+     - `nRF54H20 SoC binaries v0.3.3`_
 
 ABI compatibility ensures that the Secure Domain and System Controller firmware binaries do not need to be recompiled each time the application, radio binaries, or both are recompiled, as long as they are based on a compatible |NCS| version.
 Additionally, maintaining ABI compatibility allows the nRF54H20 SoC binary components to work together without recompilation when updating to newer |NCS| versions.
 
-nRF54H20 SoC Binaries v0.8.0 changelog
+.. note::
+    The nRF54H20 SoC binaries only support specific versions of the |NCS| and do not support rollbacks to a previous version.
+    Upgrading the nRF54H20 SoC binaries on your development kit might break the DK's compatibility with applications developed for previous versions of the |NCS|.
+
+nRF54H20 SoC binaries v0.8.0 changelog
 **************************************
 
 The following sections provide detailed lists of changes by component.

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
@@ -153,8 +155,8 @@ nRF54H20 SoC binaries
 
     1. Download the nRF54H20 SoC binaries v0.7.0:
 
-       * `nRF54H20 SoC Binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions
-       * `nRF54H20 SoC Binaries v0.7.0 for EngB DKs`_, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
+       * `nRF54H20 SoC binaries v0.7.0 for EngC DKs`_, compatible with the nRF54H20 DK v0.8.3 and later revisions
+       * `nRF54H20 SoC binaries v0.7.0 for EngB DKs`_, compatible with the nRF54H20 DKs ranging from v0.8.0 to v0.8.2.
 
        .. note::
           On MacOS, ensure that the ZIP file is not unpacked automatically upon download.