From 67f8e332f7f2e38e60aac4918a4e6bb9bcb87b5c Mon Sep 17 00:00:00 2001 From: divya pillai Date: Mon, 21 Oct 2024 20:21:27 +0200 Subject: [PATCH] doc: doc updates for release 2.8.0-preview1 doc updates for release 2.8.0-preview1. Also, added missing changelog entries for the 2.8 release. Signed-off-by: divya pillai --- doc/nrf/index.rst | 5 + doc/nrf/links.txt | 1 + doc/nrf/protocols/bt/bt_solutions.rst | 6 + doc/nrf/protocols/bt/bt_stack_arch.rst | 2 + doc/nrf/releases_and_maturity.rst | 1 - .../releases_and_maturity/known_issues.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_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 + .../migration_guides.rst | 19 +- .../releases/release-notes-changelog.rst | 350 +++++++++--------- doc/versions.json | 1 + 20 files changed, 237 insertions(+), 172 deletions(-) diff --git a/doc/nrf/index.rst b/doc/nrf/index.rst index 6431725f87d8..b67c337c79d7 100644 --- a/doc/nrf/index.rst +++ b/doc/nrf/index.rst @@ -4,6 +4,11 @@ Introduction ############ +.. important:: + + |NCS| v2.8.0-preview1 is a development tag used for development purposes but is not recommended to use in a production environment. + This tag may be replaced by a release in the future. + The |NCS| is a modern, unified software development kit for building low-power wireless applications based on the Nordic Semiconductor nRF52, nRF53, nRF54, nRF70, and nRF91 Series wireless devices. It supports :ref:`Microsoft Windows, Linux, and macOS ` for development. diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 034b338b7058..6e41d658bd5a 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -548,6 +548,7 @@ .. _`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.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.8.html .. _`Migration guide for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.7.html .. _`Migration guide for nRF Connect SDK v2.6.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.6.html .. _`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 diff --git a/doc/nrf/protocols/bt/bt_solutions.rst b/doc/nrf/protocols/bt/bt_solutions.rst index 341341fd79eb..9279c0240a99 100644 --- a/doc/nrf/protocols/bt/bt_solutions.rst +++ b/doc/nrf/protocols/bt/bt_solutions.rst @@ -1,6 +1,12 @@ +.. _ug_bt_solution: + Bluetooth solution areas ######################## +.. contents:: + :local: + :depth: 2 + Bluetooth® technology provides full stack support for a wide and expanding range of use cases. Audio streaming diff --git a/doc/nrf/protocols/bt/bt_stack_arch.rst b/doc/nrf/protocols/bt/bt_stack_arch.rst index 140265eb23e5..838b4650790d 100644 --- a/doc/nrf/protocols/bt/bt_stack_arch.rst +++ b/doc/nrf/protocols/bt/bt_stack_arch.rst @@ -1,3 +1,5 @@ +.. _ug_bt_stack_arch: + Bluetooth stack architecture ############################ diff --git a/doc/nrf/releases_and_maturity.rst b/doc/nrf/releases_and_maturity.rst index 1f2f92ae00d2..b492d6eda2d4 100644 --- a/doc/nrf/releases_and_maturity.rst +++ b/doc/nrf/releases_and_maturity.rst @@ -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 diff --git a/doc/nrf/releases_and_maturity/known_issues.rst b/doc/nrf/releases_and_maturity/known_issues.rst index a50e6e7929b4..1d0b3f6795c1 100644 --- a/doc/nrf/releases_and_maturity/known_issues.rst +++ b/doc/nrf/releases_and_maturity/known_issues.rst @@ -1,3 +1,5 @@ +:orphan: + .. _known_issues: Known issues 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 86f04155e708..a74ee2b8c93f 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 6921ef6bee69..fea0e6e69baf 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 7c3b2d687cd5..65ceecc9665b 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 (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 c8721e98a065..a0e50e87b666 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 8196089eeb73..c191a9593a54 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_guides.rst b/doc/nrf/releases_and_maturity/migration_guides.rst index d169e313c883..19be4b4d05af 100644 --- a/doc/nrf/releases_and_maturity/migration_guides.rst +++ b/doc/nrf/releases_and_maturity/migration_guides.rst @@ -9,10 +9,17 @@ 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.8.0 (Working draft) `_ +* `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 customer sampling participants: + +* `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-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index 8573c4039d6f..3cb0cc84bafa 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -1,7 +1,7 @@ .. _ncs_release_notes_changelog: -Changelog for |NCS| v2.7.99 -########################### +Changelog for |NCS| v2.8.0-preview1 +################################### .. contents:: :local: @@ -53,21 +53,22 @@ Board support Build and configuration system ============================== -* Added the ``SB_CONFIG_MCUBOOT_USE_ALL_AVAILABLE_RAM`` sysbuild Kconfig option to system to allow utilizing all available RAM when using TF-M on an nRF5340 device. +* Added: - .. note:: - This has security implications and may allow secrets to be leaked to the non-secure application in RAM. + * The ``SB_CONFIG_MCUBOOT_USE_ALL_AVAILABLE_RAM`` sysbuild Kconfig option to system that allows utilizing all available RAM when using TF-M on an nRF5340 device. -* Added the ``SB_CONFIG_MCUBOOT_NRF53_MULTI_IMAGE_UPDATE`` sysbuild Kconfig option that enables updating the network core on the nRF5340 SoC from external flash. + .. note:: + This has security implications and may allow secrets to be leaked to the non-secure application in RAM. -* Added AP-Protect sysbuild Kconfig options to enable the corresponding AP-Protect Kconfig options for all images in the build: + * The ``SB_CONFIG_MCUBOOT_NRF53_MULTI_IMAGE_UPDATE`` sysbuild Kconfig option that enables updating the network core on the nRF5340 SoC from external flash. + * The AP-Protect sysbuild Kconfig options to enable the corresponding AP-Protect Kconfig options for all images in the build: - * ``SB_CONFIG_APPROTECT_LOCK`` for the :kconfig:option:`CONFIG_NRF_APPROTECT_LOCK` Kconfig option. - * ``SB_CONFIG_APPROTECT_USER_HANDLING`` for the :kconfig:option:`CONFIG_NRF_APPROTECT_USER_HANDLING` Kconfig option. - * ``SB_CONFIG_APPROTECT_USE_UICR`` for the :kconfig:option:`CONFIG_NRF_APPROTECT_USE_UICR` Kconfig option. - * ``SB_CONFIG_SECURE_APPROTECT_LOCK`` for the :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_LOCK` Kconfig option. - * ``SB_CONFIG_SECURE_APPROTECT_USER_HANDLING`` for the :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_USER_HANDLING` Kconfig option. - * ``SB_CONFIG_SECURE_APPROTECT_USE_UICR`` for the :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_USE_UICR` Kconfig option. + * ``SB_CONFIG_APPROTECT_LOCK`` for the :kconfig:option:`CONFIG_NRF_APPROTECT_LOCK` Kconfig option. + * ``SB_CONFIG_APPROTECT_USER_HANDLING`` for the :kconfig:option:`CONFIG_NRF_APPROTECT_USER_HANDLING` Kconfig option. + * ``SB_CONFIG_APPROTECT_USE_UICR`` for the :kconfig:option:`CONFIG_NRF_APPROTECT_USE_UICR` Kconfig option. + * ``SB_CONFIG_SECURE_APPROTECT_LOCK`` for the :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_LOCK` Kconfig option. + * ``SB_CONFIG_SECURE_APPROTECT_USER_HANDLING`` for the :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_USER_HANDLING` Kconfig option. + * ``SB_CONFIG_SECURE_APPROTECT_USE_UICR`` for the :kconfig:option:`CONFIG_NRF_SECURE_APPROTECT_USE_UICR` Kconfig option. * Added the ``SB_CONFIG_LWM2M_CARRIER_DIVIDED_DFU`` sysbuild Kconfig option that enables the generation of proprietary application update files required for the LwM2M carrier divided FOTA procedure. @@ -89,11 +90,18 @@ Build and configuration system It is recommended to replace them with the new devicetree property: ``nordic,access``. See the :ref:`migration guide ` for more information. +* Removed the non-working support for configuring the NSIB signing key through the environmental or command line variable (``SB_SIGNING_KEY_FILE``) along with child image. + + .. note:: + This feature has never been functional. + To configure the signing key, use any available Kconfig method. + Bootloaders and DFU =================== * Added: + * Documentation for :ref:`mcuboot_image_compression`. * Documentation for :ref:`qspi_xip_split_image` functionality. * A section in the sysbuild-related migration guide about the migration of :ref:`child_parent_to_sysbuild_migration_qspi_xip` from child/parent image to sysbuild. @@ -181,33 +189,35 @@ Amazon Sidewalk Bluetooth® LE ------------- +* Added functions :c:func:`bt_hci_err_to_str` and :c:func:`bt_security_err_to_str` to allow printing error codes as strings. + Each function returns string representations of the error codes when the corresponding Kconfig option, :kconfig:option:`CONFIG_BT_HCI_ERR_TO_STR` or :kconfig:option:`CONFIG_BT_SECURITY_ERR_TO_STR`, is enabled. + The :ref:`ble_samples` and :ref:`nrf53_audio_app` are updated to use these new functions. + +* Updated: + + * The SoftDevice Controller library to automatically select the :kconfig:option:`CONFIG_BT_LL_SOFTDEVICE_MULTIROLE` Kconfig option when using coexistence based on :kconfig:option:`CONFIG_MPSL_CX` for nRF52 Series devices. + * The Bluetooth HCI driver is now present as a devicetree node in the device tree. + The SoftDevice Controller driver uses a devicetree node named ``bt_hci_sdc`` with a devicetree binding compatible with ``nordic,bt-hci-sdc``. + The Zephyr Bluetooth LE Controller uses a devicetree node named ``bt_hci_controller`` with a devicetree binding compatible with ``zephyr,bt-hci-ll-sw-split``. + You need to update applications using the Zephyr Bluetooth Controller (see the :ref:`migration guide `). + * Host calls in GATT Discovery Manager (DM) callbacks are now scheduled in a workqueue. + The :kconfig:option:`BT_GATT_DM_WORKQ_CHOICE` Kconfig option allows you to select the workqueue implementation. + You can select either a workqueue specific to GATT DM (default) or the system workqueue. + You can use the system workqueue if creating a new thread is not viable due to memory constraints, but it is not recommended to have potential blocking calls in the system workqueue. + * Fixed an issue where the Bluetooth subsystem deadlocked when a Bluetooth link was lost during data transfer. In this scenario, the disconnected event was never delivered to the application. The issue only occurred when the :kconfig:option:`CONFIG_BT_HCI_ACL_FLOW_CONTROL` Kconfig option was enabled. This option is enabled by default on the nRF5340 DK. -* The correct SoftDevice Controller library :kconfig:option:`CONFIG_BT_LL_SOFTDEVICE_MULTIROLE` will now be selected automatically when using coexistence based on :kconfig:option:`CONFIG_MPSL_CX` for nRF52-series devices. -* Added the APIs :c:func:`bt_hci_err_to_str` and :c:func:`bt_security_err_to_str` to allow printing error codes as strings. - Each API returns string representations of the error codes when the corresponding Kconfig option, :kconfig:option:`CONFIG_BT_HCI_ERR_TO_STR` or :kconfig:option:`CONFIG_BT_SECURITY_ERR_TO_STR`, is enabled. - The :ref:`ble_samples` and :ref:`nrf53_audio_app` are updated to utilize these new APIs. -* The Bluetooth HCI driver is now present as a devicetree node in the device tree. - The SoftDevice Controller driver uses a devicetree node named ``bt_hci_sdc`` with a devicetree binding compatible with ``nordic,bt-hci-sdc``. - The Zephyr Bluetooth LE Controller uses a devicetree node named ``bt_hci_controller`` with a devicetree binding compatible with ``zephyr,bt-hci-ll-sw-split``. - Applications using the Zephyr Bluetooth Controller need to be updated (see the :ref:`migration guide `). -* Host calls in GATT Discovery Manager (DM) callbacks are now scheduled in a workqueue. - The :kconfig:option:`BT_GATT_DM_WORKQ_CHOICE` Kconfig option allows you to select the workqueue implementation. - You can select either a workqueue specific to GATT DM (default) or the system workqueue. - You can use the system workqueue if creating a new thread is not viable due to memory constraints, but it is not recommended to have potential blocking calls in the system workqueue. Bluetooth Mesh -------------- -* Updated: - - * Added metadata as optional parameter for models Light Lightness Server, Light HSL Server, Light CTL Temperature Server, Sensor Server, and Time Server. - To use the metadata, enable the :kconfig:option:`CONFIG_BT_MESH_LARGE_COMP_DATA_SRV` Kconfig option. +* Added metadata as optional parameter for models Light Lightness Server, Light HSL Server, Light CTL Temperature Server, Sensor Server, and Time Server. + To use the metadata, enable the :kconfig:option:`CONFIG_BT_MESH_LARGE_COMP_DATA_SRV` Kconfig option. * Removed the ``BT_MESH_SENSOR_USE_LEGACY_SENSOR_VALUE`` Kconfig option, deprecated in the |NCS| v2.6.0, as the old APIs, based on the :c:struct:`sensor_value` type, are removed. - Applications using the old APIs must be updated, as described in the :ref:`v2.6.0 migration guide `. + You need to update applications using the old APIs, as described in the :ref:`v2.6.0 migration guide `. DECT NR+ -------- @@ -229,7 +239,7 @@ Matter * Added: - * The Kconfig options to configure parameters impacting persistent subscriptions re-establishment: + * The following Kconfig options to configure parameters impacting persistent subscriptions re-establishment: * :kconfig:option:`CONFIG_CHIP_MAX_ACTIVE_CASE_CLIENTS` * :kconfig:option:`CONFIG_CHIP_MAX_ACTIVE_DEVICES` @@ -242,12 +252,12 @@ Matter * Migration of the Device Attestation Certificates private key to Key Management Unit (KMU) for the nRF54L Series SoCs. See :ref:`matter_platforms_security_dac_priv_key_kmu` to learn how to enable it in your sample. -* Changed: +* Updated: * The default Trusted Storage AEAD key to Hardware Unique Key (HUK) for supported nRF54L Series devices. * Renamed the ``CONFIG_CHIP_FACTORY_RESET_ERASE_NVS`` Kconfig option to :kconfig:option:`CONFIG_CHIP_FACTORY_RESET_ERASE_SETTINGS`. The new Kconfig option now works for both NVS and ZMS file system backends. - * The firmware version format used for informational purposes when using the :file:``VERSION`` file. + * The firmware version format used for informational purposes when using the :file:`VERSION` file. The format now includes the optional ``EXTRAVERSION`` component. * Storing the Device Attestation Certificates private key in the Trusted Storage library to be enabled for all platforms that support the PSA crypto API. See :ref:`matter_platforms_security_dac_priv_key_its` for more information. @@ -270,7 +280,7 @@ Thread ------ * Added the :ref:`ug_thread_build_report` and described how to use it. -* Changed the default Trusted Storage AEAD key to Hardware Unique Key (HUK) for supported nRF54L Series devices. +* Updated the default Trusted Storage AEAD key to Hardware Unique Key (HUK) for supported nRF54L Series devices. Zigbee ------ @@ -280,7 +290,7 @@ Zigbee Wi-Fi ----- -* The WPA supplicant is now switched to Zephyr upstream's fork instead of |NCS|. +* Updated the WPA supplicant to switch to Zephyr upstream's fork instead of |NCS|. Applications ============ @@ -290,9 +300,7 @@ This section provides detailed lists of changes by :ref:`application ` Kconfig option depends on :kconfig:option:`CONFIG_CAF_PM_EVENTS`. CAF Power Management events support is necessary to disable constant latency interrupts on standby. +* Removed support for the nRF54L15 PDK revision v0.2.x. + nRF Machine Learning (Edge Impulse) ----------------------------------- @@ -393,24 +400,22 @@ Serial LTE modem * Handler for new nRF Cloud event type ``NRF_CLOUD_EVT_RX_DATA_DISCON``. * Support for socket option ``AT_SO_IPV6_DELAYED_ADDR_REFRESH``. +* Updated: + + * AT string parsing to utilize the :ref:`at_parser_readme` library instead of the :ref:`at_cmd_parser_readme` library. + * The ``#XUDPCLI`` and ``#XSSOCKET`` (UDP client sockets) AT commands to use Zephyr's Mbed TLS with DTLS when the :file:`overlay-native_tls.conf` configuration file is used. + * Removed: * Support for the :file:`overlay-native_tls.conf` configuration file with the ``thingy91/nrf9160/ns`` board target. * Support for deprecated RAI socket options ``AT_SO_RAI_LAST``, ``AT_SO_RAI_NO_DATA``, ``AT_SO_RAI_ONE_RESP``, ``AT_SO_RAI_ONGOING``, and ``AT_SO_RAI_WAIT_MORE``. * The ``#XCARRIERCFG="bootstrap_smartcard"`` AT command. -* Updated: - - * AT string parsing to utilize the :ref:`at_parser_readme` library instead of the :ref:`at_cmd_parser_readme` library. - * The ``#XUDPCLI`` and ``#XSSOCKET`` (UDP client sockets) AT commands to use Zephyr's Mbed TLS with DTLS when the :file:`overlay-native_tls.conf` configuration file is used. - Thingy:53: Matter weather station --------------------------------- -* Added: - - * The :kconfig:option:`CONFIG_NCS_SAMPLE_MATTER_ZAP_FILES_PATH` Kconfig option, which specifies ZAP files location for the application. - By default, the option points to the :file:`src/default_zap` directory and can be changed to any path relative to application's location that contains the ZAP file and :file:`zap-generated` directory. +* Added the :kconfig:option:`CONFIG_NCS_SAMPLE_MATTER_ZAP_FILES_PATH` Kconfig option, which specifies ZAP files location for the application. + By default, the option points to the :file:`src/default_zap` directory and can be changed to any path relative to application's location that contains the ZAP file and :file:`zap-generated` directory. Samples ======= @@ -429,6 +434,24 @@ Bluetooth samples * The :ref:`ble_radio_notification_conn_cb` sample demonstrating how to use the :ref:`ug_radio_notification_conn_cb` feature. * The :ref:`bluetooth_conn_time_synchronization` sample demonstrating microsecond-accurate synchronization of connections that are happening over Bluetooth® Low Energy Asynchronous Connection-oriented Logical transport (ACL). + * The :ref:`ble_subrating` sample that showcases the effect of the LE Connection Subrating feature on the duty cycle of a connection. + * The :ref:`broadcast_configuration_tool` sample that implements the :ref:`BIS gateway mode ` and may act as an `Auracast™`_ broadcaster if you are using a preset compatible with Auracast. + * Support for the :ref:`zephyr:nrf54l15dk_nrf54l15` board in the following samples: + + * :ref:`central_bas` + * :ref:`bluetooth_central_hr_coded` + * :ref:`multiple_adv_sets` + * :ref:`peripheral_bms` + * :ref:`peripheral_cgms` + * :ref:`peripheral_cts_client` + * :ref:`peripheral_gatt_dm` + * :ref:`peripheral_hr_coded` + * :ref:`peripheral_mds` + * :ref:`peripheral_nfc_pairing` + * :ref:`power_profiling` + * :ref:`peripheral_rscs` + * :ref:`shell_bt_nus` + * :ref:`ble_throughput` * :ref:`bluetooth_isochronous_time_synchronization`: @@ -441,30 +464,21 @@ Bluetooth samples * :ref:`peripheral_hr_coded` sample: - * Fixed an issue where the HCI LE Set Extended Advertising Enable command was called with a NULL pointer. - -* Added support for the :ref:`zephyr:nrf54l15dk_nrf54l15` board in the following samples: - - * :ref:`central_bas` - * :ref:`bluetooth_central_hr_coded` - * :ref:`multiple_adv_sets` - * :ref:`peripheral_bms` - * :ref:`peripheral_cgms` - * :ref:`peripheral_cts_client` - * :ref:`peripheral_gatt_dm` - * :ref:`peripheral_hr_coded` - * :ref:`peripheral_mds` - * :ref:`peripheral_nfc_pairing` - * :ref:`power_profiling` - * :ref:`peripheral_rscs` - * :ref:`shell_bt_nus` - * :ref:`ble_throughput` + * Fixed an issue where the HCI LE Set Extended Advertising Enable command was called with a NULL pointer. * :ref:`peripheral_mds` sample: * Fixed an issue where device ID was incorrectly set during system initialization because MAC address was not available at that time. The device ID is now set to ``ncs-ble-testdevice`` by default using the :kconfig:option:`CONFIG_MEMFAULT_NCS_DEVICE_ID` Kconfig option. +* :ref:`ble_llpm` sample: + + * Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board. + +* :ref:`bluetooth_radio_coex_1wire_sample` sample: + + * Added support for the ``nrf54h20dk/nrf54h20/cpurad`` and ``nrf54l15dk/nrf54l15/cpuapp`` build targets. + Bluetooth Fast Pair samples --------------------------- @@ -584,8 +598,6 @@ Debug samples * Increased the value of the :kconfig:option:`CONFIG_MAIN_STACK_SIZE` Kconfig option to 8192 bytes to avoid stack overflow. -|no_changes_yet_note| - DECT NR+ samples ---------------- @@ -623,16 +635,17 @@ Matter samples * The :ref:`matter_smoke_co_alarm_sample` sample that demonstrates implementation of Matter Smoke CO alarm device type. * The :kconfig:option:`CONFIG_NCS_SAMPLE_MATTER_LEDS` Kconfig option, which can be used to disable the LEDs in the Matter sample or application. +* Updated all samples to enable the :ref:`ug_thread_build_report` generation. + * :ref:`matter_lock_sample` sample: - * Added :ref:`Matter Lock schedule snippet `, and updated the documentation to use the snippet. + * Added :ref:`Matter Lock schedule snippet ` and updated the documentation to use the snippet. * :ref:`matter_template_sample` sample: - * Updated the DAC private key migration from factory data to KMU to be enabled for the nRF54L Series SoCs by default. + * Updated the DAC private key migration from factory data to KMU to be enabled for the nRF54L Series SoCs by default. -* Enabled the :ref:`ug_thread_build_report` generation in all samples. -* Removed support for the nRF54L15 PDK in all samples. +* Removed support for the nRF54L15 PDK from all samples. Networking samples ------------------ @@ -646,27 +659,24 @@ NFC samples |no_changes_yet_note| -nRF RPC -------- - -* Added the :ref:`nrf_rpc_protocols_serialization_client` and the :ref:`nrf_rpc_protocols_serialization_server` samples. - nRF5340 samples --------------- * :ref:`smp_svr_ext_xip` sample: - * This sample has been converted to support sysbuild. - * Support has been added to demonstrate direct-XIP building and building without network core support. + * Added: + + * Support for sysbuild. + * Support to demonstrate direct-XIP building and building without network core support. Peripheral samples ------------------ * :ref:`802154_sniffer` sample: + * Added sysbuild configuration for nRF5340. * Increased the number of RX buffers to reduce the chances of frame drops during high traffic periods. * Disabled the |NCS| boot banner. - * Added sysbuild configuration for nRF5340. * Fixed the dBm value reported for captured frames. * :ref:`802154_phy_test` sample: @@ -680,14 +690,17 @@ Peripheral samples PMIC samples ------------ -* Added: - - * Support for the :ref:`zephyr:nrf54l15dk_nrf54l15` and :ref:`zephyr:nrf54h20dk_nrf54h20` to the PMIC samples. +* Added support for the :ref:`zephyr:nrf54l15dk_nrf54l15` and :ref:`zephyr:nrf54h20dk_nrf54h20` to the PMIC samples. * :ref:`npm1300_fuel_gauge` sample: * Updated to accommodate API changes in nRF Fuel Gauge library v0.11.1. +Protocol serialization samples +------------------------------ + +* Added the :ref:`nrf_rpc_protocols_serialization_client` and the :ref:`nrf_rpc_protocols_serialization_server` samples. + SDFW samples ------------ @@ -716,7 +729,7 @@ Trusted Firmware-M (TF-M) samples Thread samples -------------- -* Enabled the :ref:`ug_thread_build_report` generation in all samples. +* Updated all samples to enable the :ref:`ug_thread_build_report` generation. * :ref:`ot_cli_sample` sample: @@ -746,11 +759,17 @@ Wi-Fi samples * :ref:`wifi_shell_sample` sample: * Added support for running the full stack on the Thingy:91 X. - This is a special configuration that uses the nRF5340 as the host chip instead of the nRF9151. + This is a special configuration that uses the nRF5340 as the host chip instead of the nRF9151. Other samples ------------- +* Added: + + * The :ref:`nrf_compression_mcuboot_compressed_update` sample that demonstrates how to enable and use :ref:`image compression within MCUboot `. + * A sample for the :ref:`multicore_idle_gpio_test`. + * A sample for the :ref:`multicore_idle_with_pwm_test`. + * :ref:`coremark_sample` sample: * Updated the logging mode to minimal (:kconfig:option:`CONFIG_LOG_MODE_MINIMAL`) to reduce the sample's memory footprint and ensure no logging interference with the running benchmark. @@ -794,17 +813,6 @@ Bluetooth libraries and services It also unpairs the Fast Pair Bluetooth bonds on Fast Pair factory reset. The option is enabled by default for Fast Pair use cases that are selected using :kconfig:option:`CONFIG_BT_FAST_PAIR_USE_CASE_INPUT_DEVICE` and :kconfig:option:`CONFIG_BT_FAST_PAIR_USE_CASE_MOUSE` Kconfig options. - * Removed: - - * The MbedTLS cryptographic backend support in Fast Pair, because it is superseded by the PSA backend. - Consequently, the :kconfig:option:`CONFIG_BT_FAST_PAIR_CRYPTO_MBEDTLS` Kconfig option has also been removed. - * The default overrides for the :kconfig:option:`CONFIG_BT_DIS` and :kconfig:option:`CONFIG_BT_DIS_FW_REV` Kconfig options that enable these options together with the Google Fast Pair Service. - This configuration is now selected only by the Fast Pair use cases that require the Device Information Service (DIS). - * The default override for the :kconfig:option:`CONFIG_BT_DIS_FW_REV_STR` Kconfig option that was set to :kconfig:option:`CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION` if :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT` was enabled. - The default override is now handled in the Kconfig of the Zephyr Device Information Service (DIS) module and is based on Zephyr's :ref:`zephyr:app-version-details` that uses the :file:`VERSION` file. - * The :c:func:`bt_fast_pair_factory_reset_user_action_prepare` weak function definition, which could previously be overridden to prepare for the incoming Fast Pair factory reset. - You can still override the :c:func:`bt_fast_pair_factory_reset_user_action_perform` weak function to perform custom actions during the Fast Pair factory reset. - * Updated the default values of the following Fast Pair Kconfig options: * :kconfig:option:`CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING` @@ -814,13 +822,24 @@ Bluetooth libraries and services These Kconfig options are now disabled by default and are selected only by the Fast Pair use cases that require them. + * Removed: + + * The Mbed TLS cryptographic backend support in Fast Pair, because it is superseded by the PSA backend. + Consequently, the ``CONFIG_BT_FAST_PAIR_CRYPTO_MBEDTLS`` Kconfig option has also been removed. + * The default overrides for the :kconfig:option:`CONFIG_BT_DIS` and :kconfig:option:`CONFIG_BT_DIS_FW_REV` Kconfig options that enable these options together with the Google Fast Pair Service. + This configuration is now selected only by the Fast Pair use cases that require the Device Information Service (DIS). + * The default override for the :kconfig:option:`CONFIG_BT_DIS_FW_REV_STR` Kconfig option that was set to :kconfig:option:`CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION` if :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT` was enabled. + The default override is now handled in the Kconfig of the Zephyr Device Information Service (DIS) module and is based on Zephyr's :ref:`zephyr:app-version-details` that uses the :file:`VERSION` file. + * The :c:func:`bt_fast_pair_factory_reset_user_action_prepare` weak function definition, which could previously be overridden to prepare for the incoming Fast Pair factory reset. + You can still override the :c:func:`bt_fast_pair_factory_reset_user_action_perform` weak function to perform custom actions during the Fast Pair factory reset. + * :ref:`bt_le_adv_prov_readme`: - * Updated the :kconfig:option:`CONFIG_BT_ADV_PROV_FAST_PAIR_SHOW_UI_PAIRING` Kconfig option and the :c:func:`bt_le_adv_prov_fast_pair_show_ui_pairing` function to require the enabling of the :kconfig:option:`CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING` Kconfig option. * Added the :c:member:`bt_le_adv_prov_adv_state.adv_handle` field to the :c:struct:`bt_le_adv_prov_adv_state` structure to store the advertising handle. If the :kconfig:option:`CONFIG_BT_EXT_ADV` Kconfig option is enabled, you can use the :c:func:`bt_hci_get_adv_handle` function to obtain the advertising handle for the advertising set that employs :ref:`bt_le_adv_prov_readme`. If the Kconfig option is disabled, the :c:member:`bt_le_adv_prov_adv_state.adv_handle` field must be set to ``0``. This field is currently used by the TX Power provider (:kconfig:option:`CONFIG_BT_ADV_PROV_TX_POWER`). + * Updated the :kconfig:option:`CONFIG_BT_ADV_PROV_FAST_PAIR_SHOW_UI_PAIRING` Kconfig option and the :c:func:`bt_le_adv_prov_fast_pair_show_ui_pairing` function to require the enabling of the :kconfig:option:`CONFIG_BT_FAST_PAIR_SUBSEQUENT_PAIRING` Kconfig option. Common Application Framework ---------------------------- @@ -838,10 +857,12 @@ Debug libraries DFU libraries ------------- +* Added the :ref:`subsys_suit` library that provides functionality to a local domain for orchestrating the update based on the SUIT manifest. + * :ref:`lib_dfu_target` library: - * Updated the DFU Target SUIT implementation to the newest version of the SUIT. * Added SUIT cache processing to the DFU Target SUIT library, as described in the :ref:`lib_dfu_target_suit_style_update` section. + * Updated the DFU Target SUIT implementation to the newest version of the SUIT. Gazell libraries ---------------- @@ -869,6 +890,7 @@ Modem libraries * :ref:`at_cmd_parser_readme` library: + * Updated to use the :c:func:`at_parser_cmd_type_get` function instead of :c:func:`at_parser_at_cmd_type_get` to prevent a name collision. * Deprecated: * The :ref:`at_cmd_parser_readme` library in favor of the :ref:`at_parser_readme` library. @@ -877,8 +899,6 @@ Modem libraries * The :kconfig:option:`CONFIG_AT_CMD_PARSER`. This option will be removed in a future version. - * Renamed the :c:func:`at_parser_cmd_type_get` function to :c:func:`at_parser_at_cmd_type_get` to prevent a name collision. - * :ref:`lte_lc_readme` library: * Added: @@ -898,14 +918,6 @@ Modem libraries * To use the :ref:`at_parser_readme` library instead of the :ref:`at_cmd_parser_readme` library. * The :c:func:`lte_lc_neighbor_cell_measurement` function to return an error for invalid GCI count. - * The :c:func:`lte_lc_factory_reset` function has been deprecated. - Use the ``AT%XFACTORYRESET`` AT command instead. - Refer to the :ref:`migration guide ` for more details. - * The :c:enum:`lte_lc_factory_reset_type` type has been deprecated. - * The :c:func:`lte_lc_reduced_mobility_get` and :c:func:`lte_lc_reduced_mobility_set` functions have been deprecated. - Refer to the :ref:`migration guide ` for more details. - * The :c:enum:`lte_lc_reduced_mobility_mode` type has been deprecated. - Refer to the :ref:`migration guide ` for more details. * The library was reorganized into modules that are enabled through their respective Kconfig options. By default, the library now enables only the core features related to the network connectivity. This reorganization reduces flash memory consumption for applications that only use the core features of the library related to network connectivity. @@ -919,8 +931,18 @@ Modem libraries * The :c:enumerator:`LTE_LC_EVT_MODEM_SLEEP_EXIT_PRE_WARNING`, :c:enumerator:`LTE_LC_EVT_MODEM_SLEEP_ENTER`, and :c:enumerator:`LTE_LC_EVT_MODEM_SLEEP_EXIT` events require the new :kconfig:option:`CONFIG_LTE_LC_MODEM_SLEEP_MODULE` Kconfig option to be enabled. * The :c:enumerator:`LTE_LC_EVT_TAU_PRE_WARNING` event requires the new :kconfig:option:`CONFIG_LTE_LC_TAU_PRE_WARNING_MODULE` Kconfig option to be enabled. - * Deprecated the :c:macro:`LTE_LC_ON_CFUN` macro. - Use the :c:macro:`NRF_MODEM_LIB_ON_CFUN` macro instead. + * Deprecated: + + * The :c:macro:`LTE_LC_ON_CFUN` macro. + Use the :c:macro:`NRF_MODEM_LIB_ON_CFUN` macro instead. + * The :c:func:`lte_lc_factory_reset` function. + Use the ``AT%XFACTORYRESET`` AT command instead. + Refer to the :ref:`migration guide ` for more details. + * The :c:enum:`lte_lc_factory_reset_type` type. + * The :c:func:`lte_lc_reduced_mobility_get` and :c:func:`lte_lc_reduced_mobility_set` functions. + Refer to the :ref:`migration guide ` for more details. + * The :c:enum:`lte_lc_reduced_mobility_mode` type. + Refer to the :ref:`migration guide ` for more details. * Removed: @@ -945,7 +967,7 @@ Modem libraries * Removed the unused :ref:`at_cmd_parser_readme` library. -* :ref:`lib_zzhc` library: +* :ref:`lib_zzhc`: * Updated to use the :ref:`at_parser_readme` library instead of the :ref:`at_cmd_parser_readme` library. @@ -979,9 +1001,7 @@ Modem libraries The trace thread wakes up when another trace level is set. * The RTT trace backend to return ``-ENOSPC`` when the RTT buffer is full. This allows the trace thread to sleep to save power. - - - * Rename the nRF91 socket offload layer from ``nrf91_sockets`` to ``nrf9x_sockets`` to reflect that the offload layer is not exclusive to the nRF91 Series SiPs. + * The nRF91 socket offload layer is renamed from ``nrf91_sockets`` to ``nrf9x_sockets`` to reflect that the offload layer is not exclusive to the nRF91 Series SiPs. * Removed: @@ -1022,15 +1042,10 @@ Modem libraries Multiprotocol Service Layer libraries ------------------------------------- -* The Kconfig option ``CONFIG_MPSL_CX_THREAD`` has been renamed to :kconfig:option:`CONFIG_MPSL_CX_3WIRE` to better indicate multiprotocol compatibility. -* The Kconfig option ``CONFIG_MPSL_CX_BT_1WIRE`` has been deprecated. -* Added: - - * A 1-wire coexistence implementation which can be enabled using the Kconfig option :kconfig:option:`CONFIG_MPSL_CX_1WIRE`. - -* Fixed: - - * An issue where the HFXO would be left on after uninitializing MPSL when the RC oscillator was used as the Low Frequency clock source (DRGN-22809). +* Added a 1-wire coexistence implementation that you can enable using the Kconfig option :kconfig:option:`CONFIG_MPSL_CX_1WIRE`. +* Updated the name of the Kconfig option ``CONFIG_MPSL_CX_THREAD`` to :kconfig:option:`CONFIG_MPSL_CX_3WIRE` to better indicate multiprotocol compatibility. +* Fixed an issue where the HFXO would be left on after uninitializing MPSL when the RC oscillator was used as the Low Frequency clock source (DRGN-22809). +* Deprecated the Kconfig option :kconfig:option:`CONFIG_MPSL_CX_BT_1WIRE`. Libraries for networking ------------------------ @@ -1070,6 +1085,11 @@ Libraries for networking * The :c:func:`nrf_cloud_credentials_configured_check` function to retrieve the size of the root CA, and compare it to thresholds to decide whether the CoAP, AWS, or both root CA certs are present. Use this information to log helpful information and decide whether the root CA certificates are compatible with the configured connection type. + * Fixed: + + * An issue in the :c:func:`nrf_cloud_send` function that prevented data in the provided :c:struct:`nrf_cloud_obj` structure from being sent to the bulk and bin topics. + * An issue where the modem was not shut down from bootloader mode before attempting to initialize in normal mode after an unsuccessful update. + * Deprecated: * The :kconfig:option:`CONFIG_NRF_CLOUD_IPV6` Kconfig option, which now no longer forces the nRF Cloud MQTT transport to use IPv4 when not enabled. @@ -1078,17 +1098,12 @@ Libraries for networking Support for statically configured nRF Cloud IP Addresses will soon be removed. Leave :kconfig:option:`CONFIG_NRF_CLOUD_STATIC_IPV4` disabled to instead use automatic DNS lookup. - * Fixed: - - * An issue in the :c:func:`nrf_cloud_send` function that prevented data in the provided :c:struct:`nrf_cloud_obj` structure from being sent to the bulk and bin topics. - * An issue where the modem was not shut down from bootloader mode before attempting to initialize in normal mode after an unsuccessful update. - * :ref:`lib_nrf_cloud_coap` library: - * Fixed: + * Added: - * A hard fault that occurred when encoding AGNSS request data and the ``net_info`` field of the :c:struct:`nrf_cloud_rest_agnss_request` structure is NULL. - * An issue where certain CoAP functions could return zero, indidicating success, even though there was an error. + * The :kconfig:option:`CONFIG_NRF_CLOUD_COAP_DISCONNECT_ON_FAILED_REQUEST` Kconfig option to disconnect the CoAP client on a failed request. + * The :kconfig:option:`CONFIG_NRF_CLOUD_COAP_JWT_SEC_TAG` Kconfig option to allow for a separate sec tag to be used for nRF Cloud CoAP JWT signing. * Updated: @@ -1096,10 +1111,12 @@ Libraries for networking * The function :c:func:`nrf_cloud_coap_shadow_get` to return ``-E2BIG`` if the received shadow data was truncated because the provided buffer was not big enough. * The :kconfig:option:`CONFIG_NRF_CLOUD_COAP_DOWNLOADS` Kconfig option to be enabled by default if either the :kconfig:option:`CONFIG_NRF_CLOUD_FOTA_POLL` or :kconfig:option:`CONFIG_NRF_CLOUD_PGPS` Kconfig option is enabled. - * Removed the experimental status (:kconfig:option:`CONFIG_EXPERIMENTAL`) from the :kconfig:option:`CONFIG_NRF_CLOUD_COAP_DOWNLOADS` Kconfig option. + * Fixed: - * Added the :kconfig:option:`CONFIG_NRF_CLOUD_COAP_DISCONNECT_ON_FAILED_REQUEST` Kconfig option to disconnect the CoAP client on a failed request. - * Added the :kconfig:option:`CONFIG_NRF_CLOUD_COAP_JWT_SEC_TAG` Kconfig option to allow for a separate sec tag to be used for nRF Cloud CoAP JWT signing. + * A hard fault that occurred when encoding AGNSS request data and the ``net_info`` field of the :c:struct:`nrf_cloud_rest_agnss_request` structure is NULL. + * An issue where certain CoAP functions could return zero, indicating success, even though there was an error. + + * Removed the experimental status (:kconfig:option:`CONFIG_EXPERIMENTAL`) from the :kconfig:option:`CONFIG_NRF_CLOUD_COAP_DOWNLOADS` Kconfig option. * :ref:`lib_lwm2m_client_utils` library: @@ -1113,11 +1130,11 @@ Libraries for networking * Support for dictionary logs using REST. * Support for dictionary (binary) logs when connected to nRF Cloud using CoAP. + * Updated to use INF log level when the cloud side changes the log level. + * Fixed the missing log source when passing a direct log call to the nRF Cloud logging backend. This caused the log parser to incorrectly use the first declared log source with direct logs when using dictionary mode. - * Updated to use INF log level when the cloud side changes the log level. - * :ref:`lib_fota_download` library: * Fixed an issue where the download client instance did not use native TLS although the :kconfig:option:`CONFIG_FOTA_DOWNLOAD_NATIVE_TLS` Kconfig option was enabled. @@ -1133,7 +1150,7 @@ Libraries for networking * The :kconfig:option:`CONFIG_NRF_CLOUD_FOTA_DOWNLOAD_FRAGMENT_SIZE` Kconfig option to be available and used also when the :kconfig:option:`CONFIG_NRF_CLOUD_FOTA_POLL` Kconfig option is enabled. The range of the option is now from 128 to 1900 bytes, and the default value is 1700 bytes. - * The function :c:func:`nrf_cloud_fota_poll_process` to be used asynchrounously if a callback to handle errors is provided. + * The function :c:func:`nrf_cloud_fota_poll_process` to be used asynchronously if a callback to handle errors is provided. * :ref:`lib_mqtt_helper` library: @@ -1157,25 +1174,27 @@ Libraries for NFC nRF RPC libraries ----------------- -* Updated the internal Bluetooth serialization API and Bluetooth callback proxy API to become part of the public NRF RPC API. * Added: * An experimental serialization of Openthread APIs. * The logging backend that sends logs through nRF RPC events. +* Updated the internal Bluetooth serialization API and Bluetooth callback proxy API to become part of the public NRF RPC API. + Other libraries --------------- -* Added a compression/decompression library with support for the LZMA decompression. -* :ref:`lib_date_time` library: +* Added the :ref:`nrf_compression` library with support for the LZMA decompression. - * Fixed a bug that caused date-time updates to not be rescheduled under certain circumstances. +* :ref:`lib_date_time` library: * Added: * A retry feature that reattempts failed date-time updates up to a certain number of consecutive times. * The Kconfig options :kconfig:option:`CONFIG_DATE_TIME_RETRY_COUNT` to control whether and how many consecutive date-time update retries may be performed, and :kconfig:option:`CONFIG_DATE_TIME_RETRY_INTERVAL_SECONDS` to control how quickly date-time update retries occur. + * Fixed a bug that caused date-time updates to not be rescheduled under certain circumstances. + * :ref:`lib_ram_pwrdn` library: * Added support for the nRF54L15 SoC. @@ -1239,8 +1258,8 @@ AVSystem integration |no_changes_yet_note| -nRF Cloud integation --------------------- +nRF Cloud integration +--------------------- |no_changes_yet_note| @@ -1317,21 +1336,10 @@ Documentation * The :ref:`ug_app_dev` section, which includes pages from the :ref:`configuration_and_build` section and from the removed Device configuration guides section. * The :ref:`dfu_tools_mcumgr_cli` page after it was removed from the Zephyr repository. * The :ref:`ug_nrf54h20_suit_soc_binaries` page. - * The :ref:`ug_nrf54h20_suit_push` page documentating the SUIT push model-based update process. - * The :ref:`app_secure_approtect` section to the :ref:`app_approtect` page. - -* Restructured the :ref:`app_bootloaders` documentation and combined the DFU and bootloader articles. - Additionally, created a new bootloader :ref:`bootloader_quick_start`. -* Separated the instructions about building from :ref:`configure_application` and moved it to a standalone :ref:`building` page. -* Restructured the :ref:`ug_bt_mesh` documentation for clearer distinction between concepts or overview topics and how-to topics, thus moved some information from the Bluetooth Mesh library sections. - -* Removed: - - * The Device configuration guides section and moved its contents to :ref:`ug_app_dev`. - * The Advanced building procedures page and moved its contents to the :ref:`building` page. - * nRF70 Series support is upstreamed to Zephyr, hence the documentation is removed from the |NCS|. - * The standalone pages for getting started with nRF52 Series and with the nRF5340 DK. - These pages have been replaced by the `Quick Start`_ app, which now supports the nRF52 Series devices and the nRF5340 DK. + * The :ref:`ug_nrf54h20_suit_push` page documenting the SUIT push model-based update process. + * The :ref:`ug_nrf54h20_suit_recovery` page. + * The :ref:`nrf_rpc_uart` page. + * The :ref:`ug_bt_stack_arch` and the :ref:`ug_bt_solution` documentation to the :ref:`Bluetooth protocols ` page. * Updated: @@ -1339,6 +1347,18 @@ Documentation * The :ref:`programming_params` section on the :ref:`programming` page with information about readback protection moved from the :ref:`ug_nrf5340_building` page. * The :ref:`security` page with a table that provides an overview of the available general security features. This table replaces the subpage that was previously describing these features in more detail and was duplicating information available in other sections. + * Restructured the :ref:`app_bootloaders` documentation and combined the DFU and bootloader articles. + Additionally, created a new bootloader :ref:`bootloader_quick_start`. + * Separated the instructions about building from :ref:`configure_application` and moved it to a standalone :ref:`building` page. + * Restructured the :ref:`ug_bt_mesh` documentation for clearer distinction between concepts or overview topics and how-to topics, thus moved some information from the Bluetooth Mesh library sections. * The :ref:`nrf_security_drivers_cracen` section with a reference to the :ref:`ug_nrf54l_cryptography` page. * The :ref:`ug_tfm` page with the correct list of samples demonstrating TF-M. * The :ref:`app_approtect_ncs` section on the :ref:`app_approtect` page with details on setting the Kconfig options and register values to enable AP-Protect. + +* Removed: + + * The Device configuration guides section and moved its contents to :ref:`ug_app_dev`. + * The Advanced building procedures page and moved its contents to the :ref:`building` page. + * nRF70 Series support is upstreamed to Zephyr, hence the documentation is removed from the |NCS|. + * The standalone pages for getting started with nRF52 Series and with the nRF5340 DK. + These pages have been replaced by the `Quick Start`_ app, which now supports the nRF52 Series devices and the nRF5340 DK. diff --git a/doc/versions.json b/doc/versions.json index c208abe7ef15..1c8209c055a1 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,4 +1,5 @@ [ + "2.8.0-preview1", "2.7.99", "2.7.99-cs2", "2.7.99-cs1",