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.

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: 3.0.0-preview2 doc updates #21138

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 Kconfig.nrf
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ config NET_SOCKETS_OFFLOAD_TLS
# - For CC3XX RNG
# - For Cracen RNG
config MAIN_STACK_SIZE
default 4096 if PSA_NEED_CRACEN_CTR_DRBG_DRIVER && !BUILD_WITH_TFM && TRUSTED_STORAGE
default 3584 if PSA_NEED_CRACEN_CTR_DRBG_DRIVER && !BUILD_WITH_TFM
default 3584 if (SOC_NRF54H20_CPUAPP || SOC_NRF54H20_CPURAD)
default 2048 if PSA_NEED_OBERON_CTR_DRBG_DRIVER && !BUILD_WITH_TFM
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
app:
address: 0x0000
size: 0x3e000
settings_storage:
address: 0x3e000
size: 0x2000
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
app:
address: 0x0000
size: 0x3e000
settings_storage:
address: 0x3e000
size: 0x2000
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
app:
address: 0x0000
size: 0x7e000
settings_storage:
address: 0x7e000
size: 0x2000
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
app:
address: 0x0000
size: 0x7e000
settings_storage:
address: 0x7e000
size: 0x2000
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
app:
address: 0x0000
size: 0x7e000
settings_storage:
address: 0x7e000
size: 0x2000
4 changes: 2 additions & 2 deletions doc/nrf/dev_model_and_contributions/adding_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ This is demonstrated by the following code, that would be placed somewhere in yo
- name: nrf
repo-path: sdk-nrf
remote: ncs
revision: 2.9.0-nRF54H20-1
revision: 3.0.0-preview2
import: true
self:
path: application
Expand All @@ -189,7 +189,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: 2.9.0-nRF54H20-1
revision: 3.0.0-preview2
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
6 changes: 6 additions & 0 deletions doc/nrf/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
Introduction
############

.. important::

|NCS| v3.0.0-preview2 is a development tag used for development purposes.
It is not recommended to be used 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 <requirements>` for development.

Expand Down
24 changes: 23 additions & 1 deletion doc/nrf/libraries/caf/power_manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,29 @@ Configuration

To enable the |power_manager|, set the :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option in the configuration.

This module uses Zephyr's :ref:`zephyr:pm_api` subsystem.
Implied features
================

The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` option implies the following features that can be used to reduce power consumption:

* System power off support (:kconfig:option:`CONFIG_POWEROFF`).
The option is not implied for an nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`), because the :c:func:`sys_poweroff` API is not yet fully supported on the nRF54H Series SoC.
* Device Power Management (:kconfig:option:`CONFIG_PM_DEVICE`).
The option allows to reduce the power consumption of device drivers while they are inactive.
It is recommended to disable the feature if your application does not use device drivers that integrate device power management.
Disabling the feature reduces the memory footprint.

nRF54H Series SoC
-----------------

For the nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`), the module also implies the following features:

* Zephyr's :ref:`zephyr:pm-system` (:kconfig:option:`CONFIG_PM`).
The nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`) integrates the system power management to reduce power consumption when inactive.
* Zephyr's :ref:`zephyr:pm-device-runtime` (:kconfig:option:`CONFIG_PM_DEVICE_RUNTIME`).
The option extends device power management and depends on the :kconfig:option:`CONFIG_PM_DEVICE` Kconfig option.
Enabling the device runtime power management also prevents using system-managed device power management (:kconfig:option:`CONFIG_PM_DEVICE_SYSTEM_MANAGED`) by default.
The system-managed device power management does not work properly with some drivers (for example, nrfx UARTE) and should be avoided.

Timeout configuration options
=============================
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@
.. _`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
.. _`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

.. _`Migrating from Secure Partition Manager to Trusted Firmware-M`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_spm_to_tf-m.html

.. _`Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.html
.. _`Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.html
Expand Down
1 change: 0 additions & 1 deletion doc/nrf/releases_and_maturity.rst
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
Expand Down
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
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
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
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
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
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
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
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
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
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
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
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _spm_to_tfm_migration:

Migrating from Secure Partition Manager to Trusted Firmware-M
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
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
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
23 changes: 17 additions & 6 deletions doc/nrf/releases_and_maturity/migration_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,21 @@ 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`_
* `Migrating from Secure Partition Manager to Trusted Firmware-M`_
* `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`_

migration/*
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`_
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
.. _ncs_release_notes_changelog:

Changelog for |NCS| v2.9.99
###########################
Changelog for |NCS| v3.0.0-preview2
###################################

.. contents::
:local:
:depth: 2

The most relevant changes that are present on the main branch of the |NCS|, as compared to the latest official release, are tracked in this file.

.. note::
This file is a work in progress and might not cover all relevant changes.
This changelog reflects the most relevant changes from the latest official release.

.. HOWTO

Expand Down Expand Up @@ -295,6 +292,10 @@ nRF Desktop
* Requirement for zero latency in Zephyr's :ref:`zephyr:pm-system` while USB is active (:ref:`CONFIG_DESKTOP_USB_PM_REQ_NO_PM_LATENCY <config_desktop_app_options>` Kconfig option of the :ref:`nrf_desktop_usb_state_pm`).
The feature is enabled by default if Zephyr power management (:kconfig:option:`CONFIG_PM`) is enabled.
It prevents entering power states that introduce wakeup latency and ensure high performance.
* Static Partition Manager memory maps for single-image configurations (without bootloader and separate radio/network core image).
In the |NCS|, the Partition Manager is enabled by default for single-image sysbuild builds.
The static memory map ensures control over settings partition placement and size.
The introduced static memory maps may not be consistent with the ``storage_partition`` defined by the board-level DTS configuration.

* Updated:

Expand Down Expand Up @@ -817,6 +818,17 @@ Common Application Framework
Earlier, only **GPIO0** and **GPIO1** devices were supported.
Now, the generic solution supports all GPIOs available in the DTS.

* :ref:`caf_power_manager`:

* Updated:

* The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option to imply the device power management (:kconfig:option:`CONFIG_DEVICE_PM`) instead of selecting it.
The device power management is not required by the module.
* The :kconfig:option:`CONFIG_CAF_POWER_MANAGER` Kconfig option to imply device runtime power management (:kconfig:option:`CONFIG_PM_DEVICE_RUNTIME`) for the nRF54H Series SoC (:kconfig:option:`CONFIG_SOC_SERIES_NRF54HX`).
The feature can be used to reduce the power consumption of device drivers.
Enabling the device runtime power management also prevents using system-managed device power management (:kconfig:option:`CONFIG_PM_DEVICE_SYSTEM_MANAGED`) by default.
The system-managed device power management does not work properly with some drivers (for example, nrfx UARTE) and should be avoided.

Debug libraries
---------------

Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/shortcuts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. ### Versions

.. |release| replace:: v2.9.0-nRF54H20-1
.. |release_tt| replace:: ``v2.9.0-nRF54H20-1``
.. |release_number_tt| replace:: ``2.9.0-nRF54H20-1``
.. |release| replace:: v3.0.0-preview2
.. |release_tt| replace:: ``v3.0.0-preview2``
.. |release_number_tt| replace:: ``3.0.0-preview2``

.. |jlink_ver| replace:: v8.18

Expand Down
2 changes: 1 addition & 1 deletion doc/versions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
"2.9.99",
"3.0.0-preview2",
"3.0.0-preview1",
"2.9.1",
"2.9.0-nRF54H20-1",
Expand Down
Loading
Loading