Skip to content

[Backport v3.1-branch] doc: Add release notes for 3.1.0 #23978

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

Merged
Parent: ci: Use CI_LIB and test-nrf from v3.1-branch
merged 1 commit into from
Aug 13, 2025
Merged

[Backport v3.1-branch] doc: Add release notes for 3.1.0 #23978

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
1 change: 1 addition & 0 deletions doc/_utils/redirects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""
Copyright (c) 2022 Nordic Semiconductor
SPDX-License-Identifier: Apache-2.0
Expand Down Expand Up @@ -561,6 +561,7 @@
("libraries/nrf_security/doc/backend_config", "libraries/security/nrf_security/doc/backend_config"), # Legacy configurations and supported features
("libraries/tfm/index", "libraries/security/tfm/index"), # TF-M libraries (landing)
("libraries/tfm/tfm_ioctl_api", "libraries/security/tfm/tfm_ioctl_api"), # TF-M input/output control (IOCTL)
("libraries/nrf_rpc/nrf_rpc_dev_info", "libraries/nrf_rpc/nrf_rpc_utils"), # Moved nRF RPC device information to nRF RPC utility commands library (v3.1.0)
("libraries/others/fatal_error", "libraries/security/fatal_error"), # Fatal error handler
("libraries/others/hw_unique_key", "libraries/security/hw_unique_key"), # Hardware unique key
("libraries/others/identity_key", "libraries/security/identity_key"), # Identity key
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/coprocessors/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can use the VPR coprocessor (Fast Lightweight Peripheral Processor - FLPR) a
In these usage modes, it is important to clearly differentiate between the Soft Peripheral and HPF solutions.
Soft Peripherals serve as a direct replacement for hardware peripherals, offering guaranteed performance.
In contrast, the HPF will allow you to accelerate protocol operations, but performance depends on your implementation.
We recommend using the Soft Peripheral solution if it meets your product's requirements.
Nordic Semiconductor recommends using the Soft Peripheral solution if it meets your product's requirements.

The following table outlines the main differences between the usage modes.
For detailed comparison see the :ref:`ug_hpf_softperipherals_comparison` page.
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ When you install the |NCS| toolchain as listed above, you get the :ncs-tool-vers
Using the nRF54H20 DK with the |NCS| version |release| requires the following:

* The latest version of nRF Util core module (``nrfutil``), which might or might not be the same as the version installed with the |NCS| toolchain
* nRF Util ``device`` command v|54H_nrfutil_device_ver|
* nRF Util ``device`` command version |54H_nrfutil_device_ver|
* nRF Util ``trace`` command v4.0.1

To update your nRF Util installation, complete the following steps:
Expand Down
4 changes: 4 additions & 0 deletions doc/nrf/app_dev/device_guides/nrf54l/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Zephyr and the |NCS| provide support and contain board definitions for developin
* The nRF54L05 and L10 SoCs are not supported for production in the |NCS| versions 2.9.0 or 2.9.1.
Use v3.0.0 or later instead.

.. note::
The RRAM size has decreased from 1024 KB to 1012 KB for the nRF54L10 SoC.
You must update the memory maps accordingly.

.. _ug_nrf54L15_revision:

Make sure to check the revision of your nRF54L15 development kit to see if it is supported:
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/installation/recommended_versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ For firmware OS support, see :ref:`the table at the top of the page <supported_O
- x64
- ARM64
* - `Windows 11`_
- Tier 3
- n/a
- Tier 3
- Not supported
* - `Windows 10`_
Expand Down
9 changes: 9 additions & 0 deletions doc/nrf/links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@
.. _`Asset Tracker Template`: https://docs.nordicsemi.com/bundle/asset-tracker-template-latest/page/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.1.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v3-1-0
.. _`known issues for nRF Connect SDK v3.0.2`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v3-0-2
.. _`known issues for nRF Connect SDK v3.0.1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v3-0-1
.. _`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
Expand Down Expand Up @@ -511,6 +512,7 @@
.. _`known issues for nRF Connect SDK v1.4.1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v1-4-1
.. _`known issues for nRF Connect SDK v1.4.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v1-4-0

.. _`Repositories and revisions for v3.1.0`: https://docs.nordicsemi.com/bundle/ncs-3.1.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v3.0.2`: https://docs.nordicsemi.com/bundle/ncs-3.0.2/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v3.0.1`: https://docs.nordicsemi.com/bundle/ncs-3.0.1/page/nrf/releases_and_maturity/repository_revisions.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
Expand Down Expand Up @@ -551,6 +553,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.1.0`: https://docs.nordicsemi.com/bundle/ncs-3.1.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v3.0.2`: https://docs.nordicsemi.com/bundle/ncs-3.0.2/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v3.0.1`: https://docs.nordicsemi.com/bundle/ncs-3.0.1/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`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
Expand Down Expand Up @@ -587,6 +590,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.1.0`: https://docs.nordicsemi.com/bundle/ncs-3.1.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v3.0.2`: https://docs.nordicsemi.com/bundle/ncs-3.0.2/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v3.0.1`: https://docs.nordicsemi.com/bundle/ncs-3.0.1/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`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
Expand Down Expand Up @@ -623,6 +627,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 v3.1.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_3.1.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-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
Expand All @@ -632,6 +637,8 @@
.. _`Migration guide for nRF Connect SDK v2.5.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.5.html
.. _`Migration guide for nRF Connect SDK v2.0.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html

.. _`Migration from SUIT to IronSide SE for the nRF54H20 SoC`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_3.1_54h_suit_ironside.html
.. _`Migrating nRF54H20 SoC BICR from DTS to JSON`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_bicr_nRF54H20.html
.. _`Migrating from multi-image builds to sysbuild`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_sysbuild.html
.. _`Migrating to the current hardware model`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_hwmv2.html
.. _`Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.html
Expand Down Expand Up @@ -1007,6 +1014,8 @@

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

.. _`Twister test report for nRF Connect SDK v3.1.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v3.1.0/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v3.1.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v3.1.0/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
.. _`Twister test report for nRF Connect SDK v3.0.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v3.0.0/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v3.0.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v3.0.0/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
Expand Down
4 changes: 4 additions & 0 deletions doc/nrf/protocols/matter/end_product/certification.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,8 @@ Matter certification process variants
The standard Matter certification process has several variants that you can use if you have already obtained the certification or you want to certify several products of the same family.
There are separate processes for certification for different devices and recertification for devices that are already certified.

.. _ug_matter_device_recertification_process:

Matter recertification process variants
=======================================

Expand Down Expand Up @@ -339,6 +341,8 @@ The first certification must still be done at an ATL.

Matter's Rapid Recertification program overview

.. _ug_matter_device_portfolio_certification:

Matter portfolio certification process variants
===============================================

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
20 changes: 11 additions & 9 deletions doc/nrf/releases_and_maturity/migration/migration_3.1_54h_suit_ironside.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
:orphan:

.. _migration_3.1_54h_suit_ironside:

Migration from SUIT to IronSide SE for the nRF54H20 SoC
=======================================================
#######################################################

.. contents::
:local:
Expand All @@ -20,7 +22,7 @@ To follow this guide, you must meet the following prerequisites:
Devices using SUIT in LCS RoT cannot be transitioned back to LCS EMPTY.

Breaking changes
================
****************

The following is a summary of the breaking changes that apply when migrating applications:

Expand All @@ -34,7 +36,7 @@ The following is a summary of the breaking changes that apply when migrating app
You must enable and configure MCUboot in your project.

Update prj.conf
---------------
===============

To update :file:`prj.conf`, complete the following steps:

Expand Down Expand Up @@ -64,7 +66,7 @@ To update :file:`prj.conf`, complete the following steps:
};

Update devicetree files
-----------------------
=======================

To update your devicetree files, complete the following steps:

Expand Down Expand Up @@ -117,7 +119,7 @@ To update your devicetree files, complete the following steps:
#. Remove the SUIT recovery partitions (``cpuapp_recovery_partition`` and ``cpurad_recovery_partition``).

Update PERIPHCONF
-----------------
=================

The new UICR format no longer holds peripheral configuration initial values.
You must generate a PERIPHCONF blob at build time.
Expand All @@ -144,7 +146,7 @@ You do not need to modify your application code.
You only need to ensure the DTS partition exists.

Memory protection and isolation
-------------------------------
===============================

IronSide SE currently grants full memory-access permissions to both application and radio domains by default.
Delete any UICR settings related to the following:
Expand All @@ -154,7 +156,7 @@ Delete any UICR settings related to the following:
* Partition lock bits

Memory map changes
------------------
==================

With IronSide SE, the memory map changed as follows:

Expand All @@ -171,7 +173,7 @@ With IronSide SE, the memory map changed as follows:
To enable ``UICR/PERIPHCONF`` generation, ensure a DTS partition labeled ``peripconf_partition`` exists with sufficient size (for example, 8 KBs) to embed the generated address-value blob.

DFU support with MCUboot
------------------------
========================

IronSide SE drops SUIT in favor of MCUboot.
To migrate the DFU solution, complete the following steps:
Expand All @@ -190,6 +192,6 @@ To migrate the DFU solution, complete the following steps:
#. Remove recovery and companion images, as MCUboot no longer supports them.

Other changes
-------------
=============

The radio core is no longer started automatically.
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_bicr_nRF54H20.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_bicr_nrf54h:

Migrating nRF54H20 SoC BICR from DTS to JSON
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
2 changes: 2 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,5 @@
:orphan:

.. _migration_2.5:

Migration guide for |NCS| v2.5.0
Expand Down
2 changes: 2 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,5 @@
:orphan:

.. _migration_2.6:

Migration guide for |NCS| v2.6.0
Expand Down
2 changes: 2 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,5 @@
: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
2 changes: 2 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
Expand Down
Loading
Loading