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 index 12ef06071f85..2acc2a76e27c 100644 --- 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 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 index c1dab7cabbd4..d7482642b98f 100644 --- 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,7 +125,7 @@ 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: @@ -133,7 +133,7 @@ To turn an application into a recovery application, the following steps have to 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 index a054e2c25687..cfc5f6924472 100644 --- 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 index 867bf6b94a31..eb51561cffb9 100644 --- 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 index 2824d850df08..46997630d4e7 100644 --- 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 index ddadcb2e0c09..731e32c1cb26 100644 --- 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 ` | 1.4.0.0 | + | |release| | :ref:`1.4.0 ` | 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 index 6e75ebc3fe99..5899513cc883 100644 --- 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/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_application.rst b/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_application.rst index 7c7b49186ca1..1b5276aaa76f 100644 --- a/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_application.rst +++ b/doc/nrf/releases_and_maturity/migration/2.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/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst b/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst index 6cb1e79c1ca6..575cd6d8c25c 100644 --- a/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/2.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 index d58b1e5db81a..a70e4ccbabe4 100644 --- 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/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst index a5791574fac8..2fb0f6413515 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst +++ b/doc/nrf/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 index b7f4539c88be..b2cac995fd0b 100644 --- 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 index d32a2ceab876..28c1318ccd70 100644 --- 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 index 55c845771e92..48d9f138a8a5 100644 --- 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 index fb8865e90cc6..5f31ccc6c84b 100644 --- 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-1.rst similarity index 77% rename from doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20-rc1.rst rename to doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1.rst index 92dc7bd423ab..b6026b6cca70 100644 --- 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-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 - nrfutil device recover --core Network --serial-number - - #. Erase the device as follows:: + * ``nrfutil`` has been updated to v7.13.0. - nrfutil device erase --all --core Network --serial-number - nrfutil device erase --all --core Application --serial-number - nrfutil device reset --reset-kind RESET_PIN --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 the following command:: - - nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.8.0.zip --serial-number - - #. Purge the device again as follows:: - - nrfutil device recover --core Application --serial-number - nrfutil device recover --core Network --serial-number - - #. Erase the device again as follows:: - - nrfutil device erase --all --core Network --serial-number - nrfutil device erase --all --core Application --serial-number - nrfutil device reset --reset-kind RESET_PIN --serial-number - -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 + nrfutil device recover --core Network --serial-number + + #. Erase the device as follows:: + + nrfutil device erase --all --core Network --serial-number + nrfutil device erase --all --core Application --serial-number + nrfutil device reset --reset-kind RESET_PIN --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 the following command:: + + nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.8.0.zip --serial-number + + #. Purge the device again as follows:: + + nrfutil device recover --core Application --serial-number + nrfutil device recover --core Network --serial-number + + #. Erase the device again as follows:: + + nrfutil device erase --all --core Network --serial-number + nrfutil device erase --all --core Application --serial-number + nrfutil device reset --reset-kind RESET_PIN --serial-number + +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 index 411b7cf4934e..56da75321269 100644 --- 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 index 528c68db6745..a1dc0375d60b 100644 --- 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 index faeeff027ef1..74fe158b2745 100644 --- 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/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst index 615f6086bf7c..1885f9f2a449 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst +++ b/doc/nrf/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/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst index fdc471bc30c7..882d359fac3d 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst +++ b/doc/nrf/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 index 5568857ddc18..6689347b3fdf 100644 --- 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 index 45c2ab02cbfb..53de94ce3b9d 100644 --- 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/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst index cc113143b22d..9c5acb89ed32 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst +++ b/doc/nrf/releases_and_maturity/migration/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/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst index 47a0a16f545b..a81f5b0a98c4 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst +++ b/doc/nrf/releases_and_maturity/migration/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/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst index dac4b7f1da1d..4a50dc60d614 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/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/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst index fd1064794aeb..4bef0cc4b916 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/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 index d169e313c883..32c22284a4e0 100644 --- a/doc/nrf/releases_and_maturity/migration_guides.rst +++ b/doc/nrf/releases_and_maturity/migration_guides.rst @@ -9,10 +9,19 @@ 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 releases: + +* `Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1`_ +* `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`_ diff --git a/doc/nrf/releases_and_maturity/release_notes.rst b/doc/nrf/releases_and_maturity/release_notes.rst index ae9c471466ff..8c2c4ad90e25 100644 --- a/doc/nrf/releases_and_maturity/release_notes.rst +++ b/doc/nrf/releases_and_maturity/release_notes.rst @@ -10,9 +10,8 @@ This page is included only in the latest documentation, because it might contain .. note:: A "99" at the end of the version number of this documentation indicates continuous updates on the main branch since the previous major.minor release. - When looking at this latest documentation, be aware of the following aspects: + When looking at this latest documentation, be aware of the following aspect: - * Changes between releases are tracked on the :ref:`ncs_release_notes_changelog` page, but the main branch might contain additional changes that are not listed on that page. * The release note pages that are available in the latest documentation might differ slightly from the release notes that were included in the respective |NCS| release at its release date. Therefore, to see the official version of the release notes for a specific |NCS| release, switch to the documentation for the corresponding |NCS| version using the selector in the upper left corner. @@ -20,8 +19,7 @@ This page is included only in the latest documentation, because it might contain :maxdepth: 1 :caption: Subpages: - releases/release-notes-changelog - releases/release-notes-2.9.0-nrf54h20-rc1 + releases/release-notes-2.9.0-nRF54H20-1 releases/release-notes-2.9.0 releases/release-notes-2.8.0 releases/release-notes-2.7.99-cs2 diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20-rc1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nRF54H20-1.rst similarity index 86% rename from doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20-rc1.rst rename to doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nRF54H20-1.rst index 0879e5b05383..5c5b7f2d2e12 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20-rc1.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nRF54H20-1.rst @@ -1,7 +1,7 @@ -.. _ncs_release_notes_290-nrf54h20-rc1: +.. _ncs_release_notes_290-nrf54h20-1: -|NCS| v2.9.0-nRF54H20-rc1 Release Notes -####################################### +|NCS| v2.9.0-nRF54H20-1 Release Notes +##################################### .. contents:: :local: @@ -10,7 +10,7 @@ |NCS| delivers reference software and supporting libraries for developing low-power wireless applications with Nordic Semiconductor products. The SDK includes open source projects (TF-M, MCUboot, OpenThread, Matter, and the Zephyr RTOS), which are continuously integrated and redistributed with the SDK. -The |NCS| v2.9.0-nrf54h20-rc1 is an nRF54H20-exclusive release tag, only supporting products based on the nRF54H20 SoC. +The |NCS| v2.9.0-nRF54H20-1 is an nRF54H20-exclusive release tag, only supporting products based on the nRF54H20 SoC. Release notes might refer to "experimental" support for features, which indicates that the feature is incomplete in functionality or verification, and can be expected to change in future releases. To learn more, see :ref:`software_maturity`. @@ -42,12 +42,12 @@ Added the following features as experimental: * :ref:`Parallel scanning and initiating connection `. It reduces the overall waiting time when there are several Bluetooth devices to be discovered and connected at the same time. -Improved the following features: +Improved: * Better BICR handling and generation. * Enhanced power management features across various subsystems. -Implemented the following bug fixes: +Fixed: * NCSDK-30802: Resolved an issue where the nRF54H20 device suddenly stopped transmitting ESB packets after nrfxlib 3.9.0. * NCSDK-30161: Fixed an assertion during boot time caused by a combination of :kconfig:option:`CONFIG_ASSERT`, :kconfig:option:`CONFIG_SOC_NRF54H20_GPD`, and external flash. @@ -58,44 +58,45 @@ Limitations *********** On the nRF54H20 SoC, the Device Firmware Update (DFU) procedure from external flash memory does not work with the new flash memory driver based on the MSPI EXMIF handling. +You must use the :file:`spi_dw.c` driver in such case. Release tag *********** -The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.9.0-nRF54H20**. +The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.9.0-nRF54H20-1**. Check the :file:`west.yml` file for the corresponding tags in the project repositories. To use this release, check out the tag in the manifest repository and run ``west update``. See :ref:`cloning_the_repositories` and :ref:`gs_updating_repos_examples` for more information. -For information on the included repositories and revisions, see `Repositories and revisions for v2.9.0-nRF54H20-rc1`_. +For information on the included repositories and revisions, see `Repositories and revisions for v2.9.0-nRF54H20-1`_. Integration test results ************************ The integration test results for this tag can be found in the following external Artifactory: -* `Twister test report for nRF Connect SDK v2.9.0-nRF54H20-rc1`_ -* `Hardware test report for nRF Connect SDK v2.9.0-nRF54H20-rc1`_ +* `Twister test report for nRF Connect SDK v2.9.0-nRF54H20-1`_ +* `Hardware test report for nRF Connect SDK v2.9.0-nRF54H20-1`_ IDE and tool support ******************** -`nRF Connect extension for Visual Studio Code `_ is the recommended IDE for |NCS| v2.9.0-nrf54h20-rc1. +`nRF Connect extension for Visual Studio Code `_ is the recommended IDE for |NCS| v2.9.0-nRF54H20-1. See the :ref:`installation` section for more information about supported operating systems and toolchain. Known issues ************ Known issues are only tracked for the latest official release. -See `known issues for nRF Connect SDK v2.9.0-nRF54H20-rc1`_ for the list of issues valid for the latest release. +See `known issues for nRF Connect SDK v2.9.0-nRF54H20-1`_ for the list of issues valid for the latest release. Migration notes *************** -See the `Migration guide for nRF Connect SDK v2.9.0-nRF54H20-rc1`_ for the changes required or recommended when migrating your nRF54H Series application from |NCS| v2.8.0 to |NCS| v2.9.0-nrf54h20-rc1. +See the `Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1`_ for the changes required or recommended when migrating your nRF54H Series application from |NCS| v2.8.0 to |NCS| v2.9.0-nRF54H20-1. -.. _ncs_release_notes_290-nRF54H20-rc1_changelog: +.. _ncs_release_notes_290-nrf54h20-1_changelog: Changelog ********* @@ -236,26 +237,10 @@ nRF Desktop * Updated the configuration files of the :ref:`nrf_desktop_click_detector` (:file:`click_detector_def.h`) to allow them to be used even when Bluetooth LE peer control using a dedicated button (:ref:`CONFIG_DESKTOP_BLE_PEER_CONTROL `) is disabled. * The DTS description for board targets with a different DTS overlay file for each build type to isolate the common configuration that is now defined in the :file:`app_common.dtsi` file. The :ref:`zephyr:nrf54h20dk_nrf54h20` board configuration has been updated. + * The :ref:`nrf_desktop_failsafe` to use the Zephyr :ref:`zephyr:hwinfo_api` driver for getting and clearing the reset reason information (see the :c:func:`hwinfo_get_reset_cause` and :c:func:`hwinfo_clear_reset_cause` functions). + The Zephyr :ref:`zephyr:hwinfo_api` driver replaces the dependency on the nrfx reset reason helper (see the :c:func:`nrfx_reset_reason_get` and :c:func:`nrfx_reset_reason_clear` functions). - * The :ref:`nrf_desktop_ble_conn_params` with the following changes: - - * Fixed the Bluetooth LE connection parameters update loop (NCSDK-30261) that replicated if an nRF Desktop dongle without Low Latency Packet Mode (LLPM) support was connected to an nRF Desktop peripheral with LLPM support. - * The module now waits until a triggered Bluetooth LE connection parameters update is completed before triggering subsequent updates for a given connection. - * Improved the log to also display the information if USB is suspended. - The information is needed to determine the requested connection parameters. - * The module now uses non-zero Bluetooth LE peripheral latency while USB is suspended. - This is done to prevent peripheral latency increase requests from :ref:`nrf_desktop_ble_latency` on peripheral's end. - * The module reverts the USB suspended Bluetooth LE connection parameter update when USB cable is disconnected. - - * The :ref:`nrf_desktop_ble_scan` to always use a connection interval of 10 ms for peripherals without Low Latency Packet Mode (LLPM) support if a dongle supports LLPM and more than one Bluetooth LE connection. - This is required to avoid Bluetooth Link Layer scheduling conflicts that could lead to HID report rate drop. - -nRF SoC flash driver --------------------- - -* Removed the ``imply`` for the partial erase feature of the nRF SoC flash driver (:kconfig:option:`CONFIG_SOC_FLASH_NRF_PARTIAL_ERASE`) for the USB next stack (:ref:`CONFIG_DESKTOP_USB_STACK_NEXT `). - The partial erase feature was used as a workaround for device errors that might be reported by the Windows USB host in Device Manager if a USB cable is connected while erasing a secondary image slot in the background. - The workaround is no longer needed after the nRF UDC driver was improved. + * The release configuration for the :ref:`zephyr:nrf54h20dk_nrf54h20` board target to enable the :ref:`nrf_desktop_failsafe` (see the :ref:`CONFIG_DESKTOP_FAILSAFE_ENABLE ` Kconfig option). Samples ======= @@ -316,6 +301,10 @@ Bluetooth Fast Pair samples * Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board target. +* :ref:`fast_pair_locator_tag` sample: + + * Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board target. + Edge Impulse samples -------------------- @@ -386,8 +375,9 @@ Bluetooth libraries and services * :ref:`bt_fast_pair_readme` library: - * Added support in build system for devices that do not support the :ref:`partition_manager`. + * Added support in the build system for devices that do not support the :ref:`partition_manager`. The :ref:`zephyr:nrf54h20dk_nrf54h20` board target is the only example of such a device. + * Updated the :c:func:`bt_fast_pair_info_cb_register` API to allow registration of multiple callbacks. nRF RPC libraries diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index 8c79658b7d5f..c1e939f2887a 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -1,3 +1,5 @@ +:orphan: + .. _ncs_release_notes_changelog: Changelog for |NCS| v2.9.99 @@ -23,7 +25,7 @@ Known issues ************ Known issues are only tracked for the latest official release. -See `known issues for nRF Connect SDK v2.9.0-nRF54H20-rc1`_ for the list of issues valid for the latest release. +See `known issues for nRF Connect SDK v2.9.0-nRF54H20-1`_ for the list of issues valid for the latest release. Changelog ********* diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt index 8361b2c37cfb..96940bf53f2f 100644 --- a/doc/nrf/shortcuts.txt +++ b/doc/nrf/shortcuts.txt @@ -2,9 +2,9 @@ .. ### Versions -.. |release| replace:: v2.9.0-nRF54H20-rc1 -.. |release_tt| replace:: ``v2.9.0-nRF54H20-rc1`` -.. |release_number_tt| replace:: ``2.9.0-nRF54H20-rc1`` +.. |release| replace:: v2.9.0-nRF54H20-1 +.. |release_tt| replace:: ``v2.9.0-nRF54H20-1`` +.. |release_number_tt| replace:: ``2.9.0-nRF54H20-1`` .. |jlink_ver| replace:: v7.94i .. |jlink_ver_vsc| replace:: v7.94i diff --git a/doc/versions.json b/doc/versions.json index 452e71804346..75d291d85a5a 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,6 +1,5 @@ [ - "2.9.99", - "2.9.0-nRF54H20-rc1", + "2.9.0-nRF54H20-1", "2.9.0", "2.8.0", "2.8.0-preview1",