Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add release notes for 3.0.0 #21339

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

doc: Add release notes for 3.0.0 #21339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/nrf/links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@

.. #### Source: www.nordicsemi.com/Events/

.. _`nRF Connect SDK v3.0.0 webinar`:
.. _`nRF Connect SDK v2.9.0 webinar`:
.. _`nRF Connect SDK v2.8.0 webinar`: https://webinars.nordicsemi.com/events
.. _`nRF Connect SDK v2.7.0 webinar`: https://www.nordicsemi.com/Events/2024/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v270
Expand Down Expand Up @@ -434,6 +435,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 v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v3-0-0
.. _`known issues for nRF Connect SDK v2.9.1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-1
.. _`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
Expand Down Expand Up @@ -498,6 +500,7 @@

.. _`nRF socket options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/nrf_modem/doc/sockets.html

.. _`Repositories and revisions for v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-3.0.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.9.1`: https://docs.nordicsemi.com/bundle/ncs-2.9.1/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
Expand Down Expand Up @@ -534,6 +537,7 @@
.. _`Repositories and revisions for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrf/introduction.html#repositories_and_revisions
.. _`Repositories and revisions`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/introduction.html#repositories_and_revisions

.. _`Modem library changelog for v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-3.0.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.9.1`: https://docs.nordicsemi.com/bundle/ncs-2.9.1/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
Expand Down Expand Up @@ -566,6 +570,7 @@
.. _`Modem library changelog for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrfxlib/nrf_modem/doc/CHANGELOG.html
.. _`Modem library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html

.. _`LwM2M carrier library changelog for v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-3.0.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.9.1`: https://docs.nordicsemi.com/bundle/ncs-2.9.1/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
Expand Down Expand Up @@ -1627,6 +1632,9 @@

.. ### Source: files.nordicsemi.com

.. _`Twister test report for nRF Connect SDK v3.0.0`:
.. _`Hardware test report for nRF Connect SDK v3.0.0`:

.. _`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
Expand Down
1 change: 0 additions & 1 deletion doc/nrf/releases_and_maturity.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ If an issue is found in a release after it has taken place, those issues are lis
releases_and_maturity/repository_revisions
releases_and_maturity/software_maturity
releases_and_maturity/abi_compatibility
releases_and_maturity/known_issues
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/known_issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_2.0.0_migration:

Migration notes for |NCS| v2.0.0
Expand Down
2 changes: 2 additions & 0 deletions ...rf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:orphan:


.. _migration_2.5:

Migration guide for |NCS| v2.5.0
Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:orphan:


.. _migration_2.6:

Migration guide for |NCS| v2.6.0
Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:orphan:


.. _migration_2.7:

Migration guide for |NCS| v2.7.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.8:

Migration guide for |NCS| v2.8.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.9.0-nRF54H20-1:

Migration guide for |NCS| v2.9.0-nRF54H20-1
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.9:

Migration guide for |NCS| v2.9.0
Expand Down
13 changes: 13 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_3.0:

Migration guide for |NCS| v3.0.0 (Working draft)
Expand Down Expand Up @@ -193,6 +195,9 @@ Build system

If you prefer to continue using ``nrfjprog`` for programming devices, :ref:`specify the west runner <programming_selecting_runner>` with ``west flash``.

* Erasing the external memory when programming a new firmware image with ``west flash`` series now always correctly honors the ``--erase`` flag (and its absence) both when using the ``nrfjprog`` and ``nrfutil`` backends.
Prior to this release, the ``nrjfprog`` backend would always erase only the sectors of the external flash used by the new firmware, and the ``nrfutil`` backend would always erase the whole external flash.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
nRF54H20
========
This section describes the changes specific to the nRF54H20 SoC and DK support in the |NCS|.
Dependencies
------------
The following required dependencies for the nRF54H20 SoC and DK have been updated.
nRF54H20 BICR
+++++++++++++
.. toggle::
* The nRF54H20 BICR has been updated (from the one supporting |NCS| v2.9.0 as well as |NCS| v2.9.0-nRF54H20-1).
To update the BICR of your development kit while in Root of Trust, do the following:
1. Build your application using |NCS| v2.9.0.
#. Connect the nRF54H20 DK to your computer using the **DEBUGGER** port on the DK.
.. note::
On MacOS, connecting the DK might repeatedly trigger a popup displaying the message ``Disk Not Ejected Properly``.
To disable this, run ``JLinkExe``, then run ``MSDDisable`` in the J-Link Commander interface.
#. List all the connected development kits to see their serial number (matching the one on the DK's sticker)::
nrfutil device list
#. Program the BICR by running nRF Util from your application folder using the following command::
nrfutil device program --options chip_erase_mode=ERASE_NONE --firmware ./build/<your_application_name>/zephyr/bicr.hex --core Application --serial-number <serial_number>
nRF54H20 SoC binaries
+++++++++++++++++++++
.. toggle::
* The *nRF54H20 SoC binaries* bundle has been updated to version 0.9.5.
.. caution::
If migrating from |NCS| v2.9.0 or lower, you must follow steps from :ref:`migration_2.9.0-nRF54H20-1` to update the *nRF54H20 SoC binaries* bundle to version 0.9.2.
.. note::
The nRF54H20 SoC binaries only support specific versions of the |NCS| and do not support rollbacks to a previous version.
Upgrading the nRF54H20 SoC binaries on your development kit might break the DK's compatibility with applications developed for previous versions of the |NCS|.
For more information, see :ref:`abi_compatibility`.
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.9.5`_.
.. 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>
nrfutil device reset --reset-kind RESET_PIN --serial-number <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.9.5.zip --serial-number <serial_number>
#. Purge the device again as follows::
nrfutil device recover --core Application --serial-number <serial_number>
nrfutil device recover --core Network --serial-number <serial_number>
nrfutil device reset --reset-kind RESET_PIN --serial-number <serial_number>
Application development
-----------------------
The following are the changes required to migrate your applications to the |NCS| v2.9.0-nRF54H20-1.
Entropy source for radio applications
+++++++++++++++++++++++++++++++++++++
The default entropy source was changed to use the SSF service.
As a result, the communication channel as well as RAM regions, dedicated to communicate with the SDFW are now enabled by default.
This may result in incompatible UICRs if your application relies on the defaults.
If UICRs are incompatible, the application cannot be upgraded using DFU, but must be programmed using the **DEBUGGER** port.
If you want to update your application using DFU, add the following overlay to your radio application if you want to maintain UICR compatibility:
.. code-block:: dts
/* Switch back to the pseudo-random entropy source. */
/ {
chosen {
zephyr,entropy = &prng;
};
/delete-node/ psa-rng;
prng: prng {
compatible = "nordic,entropy-prng";
status = "okay";
};
};
/* Disable IPC between cpusec <-> cpurad. */
&cpusec_cpurad_ipc {
status = "disabled";
};
&cpurad_ram0x_region {
status = "disabled";
};
&cpusec_bellboard {
status = "disabled";
};
SUIT MPI configuration
++++++++++++++++++++++
The SUIT MPI configuration has been moved from local Kconfig options to sysbuild.
To migrate your application, move all ``CONFIG_MPI_*`` options from the application configuration into the ``sysbuild.conf`` file.
For example, to migrate the root manifest vendor ID, remove the following line from the ``prj.conf`` file:
.. code-block:: kconfig
CONFIG_SUIT_MPI_ROOT_VENDOR_NAME="acme.corp"
And add the following line inside the ``sysbuild.conf`` file:
.. code-block:: kconfig
SB_CONFIG_SUIT_MPI_ROOT_VENDOR_NAME="acme.corp"
If your project does not use the ``sysbuild.conf`` file, please create one.

Samples and applications
========================

Expand All @@ -207,6 +212,14 @@ Serial LTE Modem

* Errors that were previously notified to the application with the ``LWM2M_CARRIER_ERROR_RUN`` event type have instead been added to :c:macro:`LWM2M_CARRIER_ERROR_CONFIGURATION`.

Bluetooth Fast Pair Locator tag sample
--------------------------------------

.. toggle::

If you want to align your application project with the newest version of the :ref:`fast_pair_locator_tag` sample and still maintain the DFU backwards compatibility for your already deployed products that are based on the ``nrf52840dk/nrf52840`` board target, use the RSA signature algorithm (the ``SB_CONFIG_BOOT_SIGNATURE_TYPE_RSA`` Kconfig option) that is supported as part of the previous |NCS| releases.
In the current |NCS| release, the MCUboot DFU signature type for the ``nrf52840dk/nrf52840`` board target has been changed to the Elliptic curve digital signatures with curve P-256 (ECDSA P256 - the ``SB_CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256`` Kconfig option), and you will not be able to perform DFU from an old version to a new one.

Libraries
=========

Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7:

Migration notes for |NCS| v2.7.0 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions ...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs1:

Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions ...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs2:

Migration notes for |NCS| v2.7.99-cs2 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _hwmv1_to_v2_migration:

Migrating to the current hardware model
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _child_parent_to_sysbuild_migration:

Migrating from multi-image builds to sysbuild
Expand Down
24 changes: 18 additions & 6 deletions doc/nrf/releases_and_maturity/migration_guides.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,22 @@ Migration guides are also provided for major functionality updates.
.. note::
|migration_contact_devzone|

.. toctree::
:maxdepth: 1
:glob:
:reversed:
:caption: Subpages:

migration/*
* `Migrating from multi-image builds to sysbuild`_
* `Migrating to the current hardware model`_
* `Migration guide for nRF Connect SDK v3.0.0`_
* `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`_


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`_
3 changes: 1 addition & 2 deletions doc/nrf/releases_and_maturity/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,14 @@ This page is included only in the latest documentation, because it might contain
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:

* Changes between releases are tracked on the :ref:`ncs_release_notes_changelog` page, but the main branch might contain additional changes that are not yet 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.

.. toctree::
:maxdepth: 1
:caption: Subpages:

releases/release-notes-changelog
releases/release-notes-3.0.0
releases/release-notes-3.0.0-preview2
releases/release-notes-3.0.0-preview1
releases/release-notes-2.9.1
Expand Down
Loading