From d218a67c6708b7d663ff171ad4a80cd057bdbb2b Mon Sep 17 00:00:00 2001 From: Francesco Domenico Servidio Date: Mon, 30 Dec 2024 11:24:29 +0100 Subject: [PATCH] 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 --- .../adding_code.rst | 4 +- doc/nrf/links.txt | 4 + doc/nrf/protocols/matter/index.rst | 4 +- .../abi_compatibility.rst | 2 + ...e_2.4.99-cs3_to_2.6.99-cs2_application.rst | 2 + ...e_2.4.99-cs3_to_2.6.99-cs2_environment.rst | 2 + .../migration/migration_guide_1.x_to_2.x.rst | 2 + ...gration_guide_2.4.99-cs3_to_2.6.99-cs2.rst | 2 + .../migration/migration_guide_2.5.rst | 2 + .../migration/migration_guide_2.6.rst | 2 + .../migration/migration_guide_2.7.rst | 2 + .../migration/migration_guide_2.8.rst | 2 + .../migration_guide_2.9.0-nrf54h20-rc1.rst | 2 + .../migration_guide_2.9.0-nrf54h20.rst | 164 +++++++ .../migration/migration_guide_2.9.rst | 2 + .../migration/migration_guide_3.0.rst | 2 + .../migration_guide_nRF54H20_cs_to_2_7.rst | 2 + ...ration_guide_nRF54H20_cs_to_2_7_99-cs1.rst | 2 + ...ration_guide_nRF54H20_cs_to_2_7_99-cs2.rst | 2 + .../migration/migration_hwmv2.rst | 2 + .../migration/migration_sysbuild.rst | 2 + ...on_guide_2.4.99-cs3_to_2.7_application.rst | 2 + ...on_guide_2.6.99-cs2_to_2.7_application.rst | 2 + ...on_guide_2.6.99-cs2_to_2_7_environment.rst | 2 + ...on_guide_2.4.99-cs3_to_2.7_environment.rst | 2 + .../migration_guides.rst | 22 +- .../release-notes-2.9.0-nrf54h20-rc1.rst | 22 +- .../releases/release-notes-2.9.0-nrf54h20.rst | 445 ++++++++++++++++++ .../releases/release-notes-changelog.rst | 14 +- doc/nrf/shortcuts.txt | 6 +- doc/versions.json | 2 +- 31 files changed, 691 insertions(+), 38 deletions(-) create mode 100644 doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20.rst create mode 100644 doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20.rst diff --git a/doc/nrf/dev_model_and_contributions/adding_code.rst b/doc/nrf/dev_model_and_contributions/adding_code.rst index 867bf6b94a31..ee6c438c1e7a 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 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 index 2824d850df08..a0d90d23782f 100644 --- 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 index ddadcb2e0c09..03567d0ecd1c 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-rc1 | | | +--------------------------+ | | | 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..accbee076398 100644 --- 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/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-rc1.rst index 92dc7bd423ab..4ef8e8a4bd0d 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-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 new file mode 100644 index 000000000000..0048a3502ac6 --- /dev/null +++ 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 + 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 + + #. 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: + + 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 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..79c87d4e7e9a 100644 --- 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`_ 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-rc1.rst index 0879e5b05383..0c5ae5aa5c5a 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-rc1.rst @@ -237,25 +237,13 @@ nRF Desktop * 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_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 --------------------- + * 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). -* 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 +304,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 -------------------- diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20.rst new file mode 100644 index 000000000000..2b421b49f0a0 --- /dev/null +++ b/doc/nrf/releases_and_maturity/releases/release-notes-2.9.0-nrf54h20.rst @@ -0,0 +1,445 @@ +.. _ncs_release_notes_290-nrf54h20: + +|NCS| v2.9.0-nrf54h20 Release Notes +################################### + +.. contents:: + :local: + :depth: 2 + +|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 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`. + +Highlights +********** + +Added the following features as supported: + +* nRF54H20 Series: + + * Triggering firmware recovery by pressing a hardware button or calling the respective API. + For more information, see :ref:`ug_nrf54h20_suit_recovery`. + * Global Domain Frequency Scaling (GDFS), optimizing USB suspend power consumption. + * Drivers adapted for the following peripherals: + + * UARTE120 + * PWM120 + * SPIM120 + * EXMIF + + * UICR validation support. + * MSPI EXMIF support. + +Added the following features as experimental: + +* Bluetooth®: + + * :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: + +* Better BICR handling and generation. +* Enhanced power management features across various subsystems. + +Implemented the following bug fixes: + +* 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. +* NCSDK-30117: Ensured that it is no longer possible to declare a MEM component pointing to a memory region not assigned to a particular core. +* NCSDK-29682: Added support for the ``cose-alg-sha-512`` algorithm in the SUIT module. + +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. + +Release tag +*********** + +The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.9.0-nRF54H20**. +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`_. + +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`_ +* `Hardware test report for nRF Connect SDK v2.9.0-nrf54h20`_ + +IDE and tool support +******************** + +`nRF Connect extension for Visual Studio Code `_ is the recommended IDE for |NCS| v2.9.0-nrf54h20. +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`_ for the list of issues valid for the latest release. + +Migration notes +*************** + +See the `Migration guide for nRF Connect SDK v2.9.0-nrf54h20`_ for the changes required or recommended when migrating your nRF54H Series application from |NCS| v2.8.0 to |NCS| v2.9.0-nrf54h20. + +.. _ncs_release_notes_290-nrf54h20_changelog: + +Changelog +********* + +The following sections provide detailed lists of changes by component. + +IDE, OS, and tool support +========================= + +* Updated the deprecation notes for `nRF Command Line Tools`_ added in the previous release. + The notes now clearly state the tools will be archived, no updates will be made to the software, but it will still be available for download. + +Board support +============= + +* Updated various tests and samples to use Zephyr's :ref:`native simulator ` instead of Zephyr's :ref:`native POSIX ` for :ref:`running_unit_tests`. + This mirrors the deprecation of ``native_posix`` in Zephyr. + Support for ``native_posix`` will be removed in Zephyr with the v4.2 release. + In the |NCS|, it will be removed once Zephyr v4.2 is upmerged to sdk-nrf. + +Build and configuration system +============================== + +* Fixed the issue in the ``nordic-bt-rpc`` snippet, where an invalid memory map was created for nRF54H20 devices, which resulted in a runtime failure. + +Security +======== + +* Extended the ``west ncs-provision`` command so that different key lifetime policies can be selected. + +Protocols +========= + +This section provides detailed lists of changes by :ref:`protocol `. +See `Samples`_ for lists of changes for the protocol-related samples. + +Bluetooth LE +------------- + +* Added support for scanning and initiating at the same time. + This was introduced in |NCS| 2.7.0 as experimental. + The :ref:`bt_scanning_while_connecting` sample showcases how you can use this feature to reduce the time to establish connections to many devices. + +* Updated the Bluetooth LE SoftDevice Controller driver to make the :c:func:`hci_vs_sdc_llpm_mode_set` function return an error if Low Latency Packet Mode (LLPM) is not supported or not enabled in the Bluetooth LE Controller driver configuration (:kconfig:option:`CONFIG_BT_CTLR_SDC_LLPM`). + +Matter +------ + +* Added: + + * Implementation of the ``Spake2pVerifier`` class for the PSA crypto backend. + You can use this class to generate the Spake2+ verifier at runtime. + To use this class, enable the Kconfig options :kconfig:option:`CONFIG_PSA_WANT_ALG_PBKDF2_HMAC` and :kconfig:option:`CONFIG_PSA_WANT_KEY_TYPE_SPAKE2P_KEY_PAIR_DERIVE`. + * The :ref:`ug_matter_device_watchdog_pause_mode` to the :ref:`ug_matter_device_watchdog` feature. + +Matter fork ++++++++++++ + +The Matter fork in the |NCS| (``sdk-connectedhomeip``) contains all commits from the upstream Matter repository up to, and including, the ``v1.4.0.0`` tag. + +The following list summarizes the most important changes inherited from the upstream Matter: + +* Added: + + * Enhanced Network Infrastructure with Home Routers and Access Points (HRAP). + This provides requirements for devices such as home routers, modems, or access points to create a necessary infrastructure for Matter products. + * Enhanced multi-admin that aims to simplify the smart home management from the user perspective. + This term includes several different features and in this release only Fabric Synchronization was fully delivered. + The Fabric Synchronization enables commissioning of devices from one fabric to another without requiring manual user actions, only user consent. + * Dynamic SIT LIT switching support that allows the application to switch between these modes, as long as the requirements for these modes are met. + You can enable this using the :kconfig:option:`CONFIG_CHIP_ICD_DSLS_SUPPORT` Kconfig option. + * The Kconfig option :kconfig:option:`CONFIG_CHIP_ICD_SIT_SLOW_POLL_LIMIT` to limit the slow polling interval value for the device while it is in the SIT mode. + You can use this to limit the slow poll interval for the ICD LIT device while it is temporarily working in the SIT mode. + * New device types: + + * Water heater + * Solar power + * Battery storage + * Heat pump + * Mounted on/off control + * Mounted dimmable load control + +* Updated: + + * Thermostat cluster with support for scheduling and preset modes, like vacation, and home or away settings. + * Electric Vehicle Supply Equipment (EVSE) with support for user-defined charging preferences, like specifying the time when the car will be charged. + * Occupancy sensing cluster with features like radar, vision, and ambient sensing. + * Intermittently Connected Devices feature with enhancements for the Long Idle Time (LIT) and Check-In protocol. + With these enhancements, the state of this feature is changed from provisional to certifiable. + +Thread +------ + +* Added Kconfig options for configuring the MLE child update timeout, child supervision interval, and child supervision check timeout. + +Zigbee +------ + +* Updated: + + * :ref:`nrfxlib:zboss` to v3.11.6.0 and platform v5.1.7 (``v3.11.6.0+5.1.7``). + They contain several fixes related to malfunctioning in a heavy traffic environment and more. + For details, see :ref:`zboss_changelog`. + * The :ref:`ZBOSS Network Co-processor Host ` package to the new version v2.2.5. + +Applications +============ + +This section provides detailed lists of changes by :ref:`application `. + +Machine learning +---------------- + +* Updated the application to enable the :ref:`Zephyr Memory Storage (ZMS) ` file system for the :ref:`zephyr:nrf54h20dk_nrf54h20` board. + +IPC radio firmware +------------------ + +* Updated the application to enable the :ref:`Zephyr Memory Storage (ZMS) ` file system in all devices that contain MRAM, such as the nRF54H Series devices. + +Matter bridge +------------- + +* Added: + + * Support for the ``UniqueID`` attribute in the Bridged Device Basic Information cluster. + * Version 2 of the bridged device data scheme containing ``UniqueID``. + * Kconfig options :ref:`CONFIG_BRIDGE_MIGRATE_PRE_2_7_0 ` and :ref:`CONFIG_BRIDGE_MIGRATE_VERSION_1 ` to enable migration from older data schemes. + +nRF Desktop +----------- + +* Updated: + + * The :ref:`nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) ` the default settings backend for all board targets that use the MRAM technology. + As a result, all :ref:`zephyr:nrf54h20dk_nrf54h20` configurations were migrated from the NVS settings backend to the ZMS settings backend. + * :ref:`nrf_desktop_watchdog` by adding the :ref:`zephyr:nrf54h20dk_nrf54h20` release configuration. + * 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_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. + + * 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 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 +======= + +This section provides detailed lists of changes by :ref:`sample `. + +Bluetooth samples +----------------- + +* Added: + + * The :ref:`channel_sounding_ras_reflector` sample demonstrating how to implement a Channel Sounding Reflector that exposes the Ranging Responder GATT Service. + * The :ref:`channel_sounding_ras_initiator` sample demonstrating Channel Sounding by setting up a Channel Sounding Initiator that acts as a Ranging Requestor GATT Client. + It includes a basic distance estimation to demonstrate IQ data handling. + The accuracy is not representative for Channel Sounding and should be replaced if accuracy is important. + * The :ref:`bt_peripheral_with_multiple_identities` sample demonstrating how to use a single physical device to create and manage multiple advertisers, making it appear as multiple distinct devices by assigning each a unique identity. + * The :ref:`bt_scanning_while_connecting` sample demonstrating how to establish multiple connections faster using the :kconfig:option:`CONFIG_BT_SCAN_AND_INITIATE_IN_PARALLEL` Kconfig option. + +* Updated: + + * Configurations of the following Bluetooth samples to make the :ref:`Zephyr Memory Storage (ZMS) ` the default settings backend for all board targets that use the MRAM technology: + + * :ref:`bluetooth_central_hids` + * :ref:`peripheral_hids_keyboard` + * :ref:`peripheral_hids_mouse` + * :ref:`central_and_peripheral_hrs` + * :ref:`central_bas` + * :ref:`central_nfc_pairing` + * :ref:`central_uart` + * :ref:`peripheral_bms` + * :ref:`peripheral_cgms` + * :ref:`peripheral_cts_client` + * :ref:`peripheral_lbs` + * :ref:`peripheral_mds` + * :ref:`peripheral_nfc_pairing` + * :ref:`power_profiling` + * :ref:`peripheral_rscs` + * :ref:`peripheral_status` + * :ref:`peripheral_uart` + * :ref:`ble_rpc_host` + + As a result, all :ref:`zephyr:nrf54h20dk_nrf54h20` configurations of the affected samples were migrated from the NVS settings backend to the ZMS settings backend. + * Testing steps in the :ref:`peripheral_hids_mouse` to provide the build configuration that is compatible with the `Bluetooth Low Energy app`_ testing tool. + +* :ref:`power_profiling` sample: + + * Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board target. + +* :ref:`nrf_auraconfig` sample: + + * Fixed an issue with data transmission (OCT-3251). + Data is now sent on all BISes when generated by the application (no SD card inserted). + +Bluetooth Fast Pair samples +--------------------------- + +* :ref:`fast_pair_input_device` sample: + + * 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 +-------------------- + +* Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board target in the following samples: + + * :ref:`ei_data_forwarder_sample` + * :ref:`ei_wrapper_sample` + +Matter samples +-------------- + +* Updated: + + * All Matter samples that support low-power mode to enable the :ref:`lib_ram_pwrdn` feature. + It is enabled by default for the release configuration of the following samples: + + * :ref:`matter_lock_sample` + * :ref:`matter_light_switch_sample` + * :ref:`matter_smoke_co_alarm_sample` + * :ref:`matter_window_covering_sample` + + * All Matter samples to enable the ZMS file subsystem in all devices that contain MRAM, such as the nRF54H Series devices. + +* Disabled pausing Matter watchdog while CPU is in idle state in all Matter samples. + To enable it, set the :ref:`CONFIG_NCS_SAMPLE_MATTER_WATCHDOG_PAUSE_IN_SLEEP` Kconfig option to ``y``. + +* :ref:`matter_smoke_co_alarm_sample` sample: + + * Added support for ICD dynamic SIT LIT switching (DSLS). + +SUIT samples +------------ + +* Updated the :ref:`suit_recovery` by adding support for triggering firmware recovery by pressing a hardware button or calling a dedicated API. + For more information, see :ref:`ug_nrf54h20_suit_recovery`. + +Other samples +------------- + +* :ref:`coremark_sample` sample: + + * Updated: + + * Configuration for the :ref:`zephyr:nrf54h20dk_nrf54h20` board to support multi-domain logging using the ARM Coresight STM. + * The logging format in the standard logging mode to align it with the format used in the multi-domain logging mode. + * Support for alternative configurations to use the :ref:`file suffix feature from Zephyr `. + The following file suffixes are supported as alternative configurations: + + * ``flash_and_run`` + * ``heap_memory`` + * ``static_memory`` + * ``multiple_threads`` + +Libraries +========= + +This section provides detailed lists of changes by :ref:`library `. + +Bluetooth libraries and services +-------------------------------- + +* Added the :ref:`rreq_readme` and :ref:`rrsp_readme` libraries. + +* :ref:`hogp_readme` library: + + * Updated the :c:func:`bt_hogp_rep_read` function to forward the GATT read error code through the registered user callback. + This ensures that API user is aware of the error. + +* :ref:`bt_fast_pair_readme` library: + + * Added support in 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 +----------------- + +* Added the :ref:`nrf_rpc_dev_info` library for obtaining information about a device connected through the :ref:`nrfxlib:nrf_rpc`. + +sdk-nrfxlib +----------- + +See the changelog for each library in the :doc:`nrfxlib documentation ` for additional information. + +Integrations +============ + +This section provides detailed lists of changes by :ref:`integration `. + +Google Fast Pair integration +---------------------------- + +* Added instructions on how to provision the Fast Pair data onto devices without the :ref:`partition_manager` support, specifically for the :ref:`zephyr:nrf54h20dk_nrf54h20`. + +Zephyr +====== + +.. NOTE TO MAINTAINERS: All the Zephyr commits in the below git commands must be handled specially after each upmerge and each nRF Connect SDK release. + +The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``beb733919d8d64a778a11bd5e7d5cbe5ae27b8ee``, with some |NCS| specific additions. + +For the list of upstream Zephyr commits (not including cherry-picked commits) incorporated into nRF Connect SDK since the most recent release, run the following command from the :file:`ncs/zephyr` repository (after running ``west update``): + +.. code-block:: none + + git log --oneline beb733919d ^ea02b93eea + +For the list of |NCS| specific commits, including commits cherry-picked from upstream, run: + +.. code-block:: none + + git log --oneline manifest-rev ^beb733919d + +The current |NCS| main branch is based on revision ``beb733919d`` of Zephyr. + +.. note:: + For possible breaking changes and changes between the latest Zephyr release and the current Zephyr version, refer to the :ref:`Zephyr release notes `. + +Documentation +============= + +* Added: + + * The :ref:`matter_samples_config` page that documents Kconfig options and snippets shared by Matter samples and applications. + * A page about :ref:`add_new_driver`. + * A page for the :ref:`sdp_gpio` application. + +* Updated: + + * The :ref:`ug_nrf54h20_gs` page. + * The :ref:`ug_nrf54h20_custom_pcb` page. + * The :ref:`abi_compatibility` page. + * The structure and contents of the :ref:`gpio_pin_config` page with more detailed information. + +* Fixed an issue on the :ref:`install_ncs` page where an incorrect directory path was provided for Linux and macOS at the end of the :ref:`cloning_the_repositories_win` section. 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..780fbec7ba85 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`_ for the list of issues valid for the latest release. Changelog ********* @@ -200,11 +202,7 @@ nRF5340 Audio nRF Desktop ----------- -* 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 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). +|no_changes_yet_note| nRF Machine Learning (Edge Impulse) ----------------------------------- @@ -241,9 +239,7 @@ Bluetooth samples Bluetooth Fast Pair samples --------------------------- -* :ref:`fast_pair_locator_tag` sample: - - * Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board target. +|no_changes_yet_note| Bluetooth Mesh samples ---------------------- diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt index 8361b2c37cfb..4dea59f78c95 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 +.. |release_tt| replace:: ``v2.9.0-nRF54H20`` +.. |release_number_tt| replace:: ``2.9.0-nRF54H20`` .. |jlink_ver| replace:: v7.94i .. |jlink_ver_vsc| replace:: v7.94i diff --git a/doc/versions.json b/doc/versions.json index 452e71804346..3da20c287b5b 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,5 +1,5 @@ [ - "2.9.99", + "2.9.0-nRF54H20", "2.9.0-nRF54H20-rc1", "2.9.0", "2.8.0",