Skip to content

Commit

Permalink
doc: Release notes for 2.9.0-nRF54H20
Browse files Browse the repository at this point in the history
Added release notes for 2.9.0-nRF54H20
Added migration guide for 2.9.0-nRF54H20
Added other minor release edits for 2.9.0-nRF54H20

Signed-off-by: Francesco Domenico Servidio <[email protected]>
  • Loading branch information
FrancescoSer committed Dec 30, 2024
1 parent 6862306 commit d64f1d9
Show file tree
Hide file tree
Showing 5 changed files with 612 additions and 20 deletions.
5 changes: 5 additions & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,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
Expand Down Expand Up @@ -478,6 +479,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
Expand Down Expand Up @@ -569,6 +571,7 @@
.. _`LwM2M carrier library changelog for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html
.. _`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 v2.9.0-nRF54H20`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nrf54h20.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`: 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
Expand Down Expand Up @@ -1557,6 +1560,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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
.. _migration_2.9.0-nrf54h20:

Migration guide for |NCS| v2.9.0-nRF54H20
#########################################

.. contents::
:local:
:depth: 3

This document describes the changes required or recommended when migrating your nRF54H20 application from the |NCS| v2.8.0 to the |NCS| v2.9.0-nRF54H20.

.. HOWTO
Add changes in the following format:
Component (for example, application, sample or libraries)
*********************************************************
.. toggle::
* Change1 and description
* Change2 and description
.. _migration_2.9.0-nrf54h20_required:

Required changes
****************

The following changes are mandatory to make your application work in the same way as in previous releases.

nRF54H20
========

This section describes the changes specific to the nRF54H20 SoC and DK support in the |NCS|.

DK compatibility
----------------

.. toggle::

* The |NCS| v2.9.0-nRF54H20 is compatible only with the Engineering C - v0.9.0 and later revisions of the nRF54H20 DK, PCA10175.
Check the version number on your DK's sticker to verify its compatibility with the |NCS|.

Dependencies
------------

The following required dependencies for the nRF54H20 SoC and DK have been updated.

SDK and toolchain
+++++++++++++++++

.. toggle::

* To update the SDK and the toolchain, do the following:

1. Open Toolchain Manager in nRF Connect for Desktop.
#. Click :guilabel:`SETTINGS` in the navigation bar to specify where you want to install the |NCS|.
#. In :guilabel:`SDK ENVIRONMENTS`, click the :guilabel:`Install` button next to the |NCS| version |release|.

nRF54H20 SoC binaries
+++++++++++++++++++++

.. toggle::

* The *nRF54H20 SoC binaries* bundle has been updated to version 0.8.0.

To update the SoC binaries bundle of your development kit while in Root of Trust, do the following:

1. Download the `nRF54H20 SoC Binaries v0.8.0`_.

.. note::
On macOS, ensure that the ZIP file is not unpacked automatically upon download.

#. Purge the device as follows::

nrfutil device recover --core Application --serial-number <serial_number>
nrfutil device recover --core Network --serial-number <serial_number>

#. Erase the device as follows::

nrfutil device erase --all --core Network --serial-number <snr>
nrfutil device erase --all --core Application --serial-number <snr>
nrfutil device reset --reset-kind RESET_PIN --serial-number <snr>

#. Run ``west update``.
#. Move the correct :file:`.zip` bundle to a folder of your choice, then run nRF Util to program the binaries using the following command::

nrfutil device x-suit-dfu --firmware nrf54h20_soc_binaries_v0.8.0.zip --serial-number <serial_number>

#. Erase the device again as follows::

nrfutil device erase --all --core Network --serial-number <snr>
nrfutil device erase --all --core Application --serial-number <snr>
nrfutil device reset --reset-kind RESET_PIN --serial-number <snr>

nrfutil
+++++++

.. toggle::

* ``nrfutil`` has been updated to version 7.13.0.

Install nRF Util version 7.13.0 as follows:

1. Download the nRF Util executable file from the `nRF Util development tool`_ product page.
#. Add nRF Util to the system path on Linux and macOS, or environment variables on Windows, to run it from anywhere on the system.
On Linux and macOS, use one of the following options:

* Add nRF Util's directory to the system path.
* Move the file to a directory in the system path.

#. On macOS and Linux, give ``nrfutil`` execute permissions by typing ``chmod +x nrfutil`` in a terminal or using a file browser.
This is typically a checkbox found under file properties.
#. On macOS, to run the nRF Util executable, you need to allow it in the system settings.
#. Verify the version of the nRF Util installation on your machine by running the following command::

nrfutil --version

#. If your version is below 7.13.0, run the following command to update nRF Util::

nrfutil self-upgrade

For more information, see the `nRF Util`_ documentation.

nrfutil device
++++++++++++++

.. toggle::

* ``nrfutil device`` has been updated to version 2.7.8.

Install the nRF Util ``device`` command version 2.7.8 as follows::

nrfutil install device=2.7.8 --force

For more information, consult the `nRF Util`_ documentation.

nrfutil trace
+++++++++++++

.. toggle::

* ``nrfutil trace`` has been updated to version 3.10.0.

Install the nRF Util ``trace`` command version 3.10.0 as follows::

nrfutil install trace=3.10.0 --force

For more information, consult the `nRF Util`_ documentation.

nrfutil suit
++++++++++++

.. toggle::

* ``nrfutil suit`` has been updated to version 0.9.0.

Install the nRF Util ``suit`` command version 0.9.0 as follows::

nrfutil install suit=0.9.0 --force

For more information, consult the `nRF Util`_ documentation.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <config_desktop_app_options>`).
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 <config_desktop_app_options>` Kconfig option).

Samples
=======
Expand Down
Loading

0 comments on commit d64f1d9

Please sign in to comment.