Skip to content

Commit 8f0c583

Browse files
divipillaicarlescufi
authored andcommitted
doc: Add release notes for 3.1.0
Add release notes for 3.1.0 Signed-off-by: divya pillai <[email protected]>
1 parent 5884359 commit 8f0c583

31 files changed

+1360
-90
lines changed

doc/_utils/redirects.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,7 @@
561561
("libraries/nrf_security/doc/backend_config", "libraries/security/nrf_security/doc/backend_config"), # Legacy configurations and supported features
562562
("libraries/tfm/index", "libraries/security/tfm/index"), # TF-M libraries (landing)
563563
("libraries/tfm/tfm_ioctl_api", "libraries/security/tfm/tfm_ioctl_api"), # TF-M input/output control (IOCTL)
564+
("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)
564565
("libraries/others/fatal_error", "libraries/security/fatal_error"), # Fatal error handler
565566
("libraries/others/hw_unique_key", "libraries/security/hw_unique_key"), # Hardware unique key
566567
("libraries/others/identity_key", "libraries/security/identity_key"), # Identity key

doc/nrf/app_dev/device_guides/coprocessors/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can use the VPR coprocessor (Fast Lightweight Peripheral Processor - FLPR) a
2020
In these usage modes, it is important to clearly differentiate between the Soft Peripheral and HPF solutions.
2121
Soft Peripherals serve as a direct replacement for hardware peripherals, offering guaranteed performance.
2222
In contrast, the HPF will allow you to accelerate protocol operations, but performance depends on your implementation.
23-
We recommend using the Soft Peripheral solution if it meets your product's requirements.
23+
Nordic Semiconductor recommends using the Soft Peripheral solution if it meets your product's requirements.
2424

2525
The following table outlines the main differences between the usage modes.
2626
For detailed comparison see the :ref:`ug_hpf_softperipherals_comparison` page.

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_gs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ When you install the |NCS| toolchain as listed above, you get the :ncs-tool-vers
7979
Using the nRF54H20 DK with the |NCS| version |release| requires the following:
8080

8181
* 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
82-
* nRF Util ``device`` command v|54H_nrfutil_device_ver|
82+
* nRF Util ``device`` command version |54H_nrfutil_device_ver|
8383
* nRF Util ``trace`` command v4.0.1
8484

8585
To update your nRF Util installation, complete the following steps:

doc/nrf/app_dev/device_guides/nrf54l/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Zephyr and the |NCS| provide support and contain board definitions for developin
4444
* The nRF54L05 and L10 SoCs are not supported for production in the |NCS| versions 2.9.0 or 2.9.1.
4545
Use v3.0.0 or later instead.
4646

47+
.. note::
48+
The RRAM size has decreased from 1024 KB to 1012 KB for the nRF54L10 SoC.
49+
You must update the memory maps accordingly.
50+
4751
.. _ug_nrf54L15_revision:
4852

4953
Make sure to check the revision of your nRF54L15 development kit to see if it is supported:

doc/nrf/installation/recommended_versions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ For firmware OS support, see :ref:`the table at the top of the page <supported_O
327327
- x64
328328
- ARM64
329329
* - `Windows 11`_
330-
- Tier 3
330+
- n/a
331331
- Tier 3
332332
- Not supported
333333
* - `Windows 10`_

doc/nrf/links.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,7 @@
463463
.. _`Asset Tracker Template`: https://docs.nordicsemi.com/bundle/asset-tracker-template-latest/page/index.html
464464

465465
.. _`known issues page on the main branch`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html
466+
.. _`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
466467
.. _`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
467468
.. _`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
468469
.. _`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
@@ -511,6 +512,7 @@
511512
.. _`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
512513
.. _`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
513514

515+
.. _`Repositories and revisions for v3.1.0`: https://docs.nordicsemi.com/bundle/ncs-3.1.0/page/nrf/releases_and_maturity/repository_revisions.html
514516
.. _`Repositories and revisions for v3.0.2`: https://docs.nordicsemi.com/bundle/ncs-3.0.2/page/nrf/releases_and_maturity/repository_revisions.html
515517
.. _`Repositories and revisions for v3.0.1`: https://docs.nordicsemi.com/bundle/ncs-3.0.1/page/nrf/releases_and_maturity/repository_revisions.html
516518
.. _`Repositories and revisions for v3.0.0`: https://docs.nordicsemi.com/bundle/ncs-3.0.0/page/nrf/releases_and_maturity/repository_revisions.html
@@ -551,6 +553,7 @@
551553
.. _`Repositories and revisions for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrf/introduction.html#repositories_and_revisions
552554
.. _`Repositories and revisions`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/introduction.html#repositories_and_revisions
553555

556+
.. _`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
554557
.. _`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
555558
.. _`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
556559
.. _`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
@@ -587,6 +590,7 @@
587590
.. _`Modem library changelog for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrfxlib/nrf_modem/doc/CHANGELOG.html
588591
.. _`Modem library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html
589592

593+
.. _`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
590594
.. _`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
591595
.. _`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
592596
.. _`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
@@ -623,6 +627,7 @@
623627
.. _`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
624628
.. _`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
625629

630+
.. _`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
626631
.. _`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
627632
.. _`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
628633
.. _`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
@@ -632,6 +637,8 @@
632637
.. _`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
633638
.. _`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
634639

640+
.. _`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
641+
.. _`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
635642
.. _`Migrating from multi-image builds to sysbuild`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_sysbuild.html
636643
.. _`Migrating to the current hardware model`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_hwmv2.html
637644
.. _`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
@@ -1007,6 +1014,8 @@
10071014

10081015
.. ### Source: files.nordicsemi.com
10091016

1017+
.. _`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
1018+
.. _`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
10101019
.. _`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
10111020
.. _`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
10121021
.. _`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

doc/nrf/protocols/matter/end_product/certification.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,8 @@ Matter certification process variants
296296
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.
297297
There are separate processes for certification for different devices and recertification for devices that are already certified.
298298

299+
.. _ug_matter_device_recertification_process:
300+
299301
Matter recertification process variants
300302
=======================================
301303

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

340342
Matter's Rapid Recertification program overview
341343

344+
.. _ug_matter_device_portfolio_certification:
345+
342346
Matter portfolio certification process variants
343347
===============================================
344348

doc/nrf/releases_and_maturity.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,3 @@ If an issue is found in a release after it has taken place, those issues are lis
2828
releases_and_maturity/repository_revisions
2929
releases_and_maturity/software_maturity
3030
releases_and_maturity/abi_compatibility
31-
releases_and_maturity/known_issues

doc/nrf/releases_and_maturity/known_issues.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
.. _known_issues:
24

35
Known issues

doc/nrf/releases_and_maturity/migration/migration_3.1_54h_suit_ironside.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
:orphan:
2+
13
.. _migration_3.1_54h_suit_ironside:
24

35
Migration from SUIT to IronSide SE for the nRF54H20 SoC
4-
=======================================================
6+
#######################################################
57

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

2224
Breaking changes
23-
================
25+
****************
2426

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

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

3638
Update prj.conf
37-
---------------
39+
===============
3840

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

@@ -64,7 +66,7 @@ To update :file:`prj.conf`, complete the following steps:
6466
};
6567
6668
Update devicetree files
67-
-----------------------
69+
=======================
6870

6971
To update your devicetree files, complete the following steps:
7072

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

119121
Update PERIPHCONF
120-
-----------------
122+
=================
121123

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

146148
Memory protection and isolation
147-
-------------------------------
149+
===============================
148150

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

156158
Memory map changes
157-
------------------
159+
==================
158160

159161
With IronSide SE, the memory map changed as follows:
160162

@@ -171,7 +173,7 @@ With IronSide SE, the memory map changed as follows:
171173
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.
172174

173175
DFU support with MCUboot
174-
------------------------
176+
========================
175177

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

192194
Other changes
193-
-------------
195+
=============
194196

195197
The radio core is no longer started automatically.

0 commit comments

Comments
 (0)