application: nrf_desktop: Align docs after upmerge + migration to sysbuild #15998

mkapala-nordic · 2024-06-13T13:54:40Z

Jira: NCSDK-27889

The #15851 PR aligns partialy few modules that are also aligned here:

dfu_mcumgr.rst
dfu.rst

Depends on: ~~#15851~~, ~~#16022~~

NordicBuilder · 2024-06-13T14:28:44Z

Test specification

CI/Jenkins/NRF

Skipped

CI/Jenkins/integration

Skipped

Note: This message is automatically posted and updated by the CI

NordicBuilder · 2024-06-14T14:14:26Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

applications/nrf_desktop/board_configuration.rst

applications/nrf_desktop/bluetooth.rst

applications/nrf_desktop/bootloader_dfu.rst

applications/nrf_desktop/doc/dfu.rst

applications/nrf_desktop/bootloader_dfu.rst

MarekPieta · 2024-06-18T13:03:24Z

I would also consider some follow-up actions:

mentioning Sysbuild configuration under description.rst->Configuration
providing some more information about Sysbuild (inform that it is used to combine multiple images that are used by application - main application image, bootloader, net core image etc.; may simplify getting started)
providing build command examples for nRF Desktop (e.g. a command that uses FILE_SUFFIX)
Building with EK shield support doc section still uses hci_ipc as netcore image name
Documenting usage of SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY - required for using external FLASH for MCUboot secondary image slot
Image transfer over SMP section mentions random HCI identities which is not relevant for nRF Desktop - consider removing this part if possible
nRF Desktop support for a board could also mention sysbuild (or link to section describing sysbuild configuration that would be important as subsequent step)

zycz · 2024-06-18T14:37:44Z

applications/nrf_desktop/bootloader_dfu.rst

-* :kconfig:option:`CONFIG_BUILD_S1_VARIANT` - Required for the build system to be able to construct the application binaries for both application's slots in non-volatile memory.
+* In the sysbuild configuration:
+
+  * :kconfig:option:`SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE` - Required for providing the signature key file used for image signing and verification.


The decision was to change to ``SB_CONF_...``

zycz · 2024-06-18T14:39:00Z

applications/nrf_desktop/bootloader_dfu.rst


 .. _nrf_desktop_configuring_mcuboot_bootloader:

 Configuring the MCUboot bootloader
 ==================================

-To enable the MCUboot bootloader, select the :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT` Kconfig option in the application configuration.
+To enable the MCUboot bootloader, select the :kconfig:option:`SB_CONFIG_BOOTLOADER_MCUBOOT` Kconfig option in the sysbuild configuration.


Also here :kconfig:option:`SB_CONFIG_BOOTLOADER_MCUBOOT` -> ``SB_CONFIG_BOOTLOADER_MCUBOOT``

zycz · 2024-06-18T14:39:19Z

applications/nrf_desktop/bootloader_dfu.rst


-The MCUboot private key path (:kconfig:option:`CONFIG_BOOT_SIGNATURE_KEY_FILE`) must be set only in the MCUboot bootloader configuration file.
+The MCUboot private key path (:kconfig:option:`SB_CONFIG_BOOT_SIGNATURE_KEY_FILE`) must be also set in the sysbuild configuration.


And here ``SB_CONFIG_BOOT_SIGNATURE_KEY_FILE``

mkapala-nordic · 2024-06-19T08:32:27Z

* mentioning Sysbuild configuration under `description.rst`->`Configuration`

follow-up: everything in NCS now runs sysbuild by default so I would say it is improvement not alignment

* providing some more information about Sysbuild (inform that it is used to combine multiple images that are used by application - main application image, bootloader, net core image etc.; may simplify getting started)

follow-up: instead of providing info directly we can link to sysbuild docs

* providing build command examples for nRF Desktop (e.g. a command that uses FILE_SUFFIX)

follow-up: improvement

* `Building with EK shield support` doc section still uses `hci_ipc` as netcore image name

NOW: already aligning ipc_radio stuff so it fits to do it now

* Documenting usage of `SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY` - required for using external FLASH for MCUboot secondary image slot

NOW: I'll add a sentence now in the _nrf_desktop_pm_external_flash section.

* Image transfer over SMP section mentions `random HCI identities` which is not relevant for nRF Desktop - consider removing this part if possible

follow-up: not related

* `nRF Desktop support for a board` could also mention sysbuild (or link to section describing sysbuild configuration that would be important as subsequent step)

follow-up: improvement as I think there was no link to previous build system

Created ticket: https://nordicsemi.atlassian.net/browse/NCSDK-28054

mkapala-nordic · 2024-06-19T12:49:04Z

Rebase only

annwoj · 2024-06-19T14:32:18Z

applications/nrf_desktop/bluetooth.rst

@@ -168,7 +168,7 @@ Fast Pair
 =========

 The nRF Desktop peripheral can be built with Google `Fast Pair`_ support.
-The configurations that enable Fast Pair are set in the :file:`prj_fast_pair.conf` and :file:`prj_release_fast_pair.conf` files.
+The configurations that enable Fast Pair are set in the configurations with the ``fast_pair`` and ``release_fast_pair`` file suffixes.


Suggested change

The configurations that enable Fast Pair are set in the configurations with the ``fast_pair`` and ``release_fast_pair`` file suffixes.

The configurations that enable Fast Pair are specified in the files with the ``fast_pair`` and ``release_fast_pair`` suffixes.

annwoj · 2024-06-19T14:42:42Z

applications/nrf_desktop/bluetooth.rst

@@ -201,6 +201,8 @@ After a successful erase advertising procedure, the peripheral removes all of th

 Apart from that, the following changes are applied in configurations that support Fast Pair:

+* The ``SB_CONFIG_BT_FAST_PAIR`` Kconfig option is enabled in the sysbuild configuration.
+  See :ref:`ug_bt_fast_pair_prerequisite_ops_kconfig` for the details.


I guess we could use the same approach as the one pointed out in here: #16022 (comment)

annwoj · 2024-06-19T14:51:18Z

applications/nrf_desktop/board_configuration.rst

@@ -43,7 +44,7 @@ nRF52840 Gaming Mouse (``nrf52840gmouse``)
        * Bluetooth is configured to use Nordic's SoftDevice link layer.

      * The configuration with the B0 bootloader is set as default.
-      * The board supports ``debug`` (:file:`prj_fast_pair.conf`) and ``release`` (:file:`prj_release_fast_pair.conf`) :ref:`nrf_desktop_bluetooth_guide_fast_pair` configurations.
+      * The board supports ``debug`` (``fast_pair`` file suffix) and ``release`` (``release_fast_pair`` file suffix) :ref:`nrf_desktop_bluetooth_guide_fast_pair` configurations.


Suggested change

* The board supports ``debug`` (``fast_pair`` file suffix) and ``release`` (``release_fast_pair`` file suffix) :ref:`nrf_desktop_bluetooth_guide_fast_pair` configurations.

* The board supports the ``debug`` (``fast_pair`` file suffix) and ``release`` (``release_fast_pair`` file suffix) configurations for :ref:`nrf_desktop_bluetooth_guide_fast_pair`.

annwoj · 2024-06-19T14:57:08Z

applications/nrf_desktop/bootloader_dfu.rst

@@ -72,27 +72,45 @@ See :ref:`nrf_desktop_memory_layout` for details.
 Configuring the B0 bootloader
 =============================

-To enable the B0 bootloader, select the :kconfig:option:`CONFIG_SECURE_BOOT` Kconfig option in the application configuration.
+To enable the B0 bootloader, select the ``SB_CONFIG_SECURE_BOOT_APPCORE`` Kconfig option in the sysbuild configuration.
+It automatically enables the ``SB_CONFIG_SECURE_BOOT_BUILD_S1_VARIANT_IMAGE`` option to construct the application binaries for both application's slots in non-volatile memory.


Suggested change

It automatically enables the ``SB_CONFIG_SECURE_BOOT_BUILD_S1_VARIANT_IMAGE`` option to construct the application binaries for both application's slots in non-volatile memory.

This setting automatically enables the ``SB_CONFIG_SECURE_BOOT_BUILD_S1_VARIANT_IMAGE`` Kconfig option, which generates application binaries for both slots in non-volatile memory.

annwoj · 2024-06-19T15:07:45Z

applications/nrf_desktop/bootloader_dfu.rst

+* In the sysbuild configuration:
+
+  * ``SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE`` - Required for providing the signature key file used for image signing and verification.
+    If this Kconfig option does not specify the signature key file, automatically generated signature key files will be used by default.


Suggested change

If this Kconfig option does not specify the signature key file, automatically generated signature key files will be used by default.

If this Kconfig option does not specify the signature key file, the application will use the default files.

Discussed.
Decided to change whole bulletpoint to:

* ``SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE`` - Required for providing the signature key file used by the build system (to sign the application update images) and by the bootloader (to verify the application signature). If this Kconfig option does not specify the signature key file, debug signature key files will be used by default.

annwoj · 2024-06-19T15:39:09Z

applications/nrf_desktop/bootloader_dfu.rst

-This option automatically enables :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` to build application update images for both slots.
+To set the MCUboot mode of operations to the direct-xip mode, make sure to enable the ``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP`` Kconfig option in the sysbuild configuration.
+This option automatically enables ``SB_CONFIG_MCUBOOT_BUILD_DIRECT_XIP_VARIANT`` to build application update images for both slots.
+The nRF Desktop application configurations do not use the direct-xip mode with revert mechanism (``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT``).


Suggested change

The nRF Desktop application configurations do not use the direct-xip mode with revert mechanism (``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT``).

The nRF Desktop application configurations do not use the direct-xip mode with the revert mechanism (``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT``).

annwoj · 2024-06-19T15:43:10Z

applications/nrf_desktop/bootloader_dfu.rst

-Enable the ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option in the bootloader configuration to make the MCUboot run the image directly from both image slots.
-The nRF Desktop's bootloader configurations do not enable the revert mechanism (``CONFIG_BOOT_DIRECT_XIP_REVERT``).
-When the direct-xip mode is enabled (the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is set in the application configuration), the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.
+The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option is automatically applied to the bootloader configuration based on the sysbuild configuration to make the MCUboot run the image directly from both image slots.


Suggested change

The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option is automatically applied to the bootloader configuration based on the sysbuild configuration to make the MCUboot run the image directly from both image slots.

The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option enables MCUboot to run the image directly from both image slot, and it is automatically applied to the bootloader configuration based on the sysbuild configuration.

annwoj · 2024-06-19T15:48:44Z

applications/nrf_desktop/bootloader_dfu.rst

-The nRF Desktop's bootloader configurations do not enable the revert mechanism (``CONFIG_BOOT_DIRECT_XIP_REVERT``).
-When the direct-xip mode is enabled (the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is set in the application configuration), the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.
+The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option is automatically applied to the bootloader configuration based on the sysbuild configuration to make the MCUboot run the image directly from both image slots.
+Similarly, the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is automatically applied to the application configuration based on the sysbuild configuration to inform the application in which mode the MCUboot bootloader works.


Suggested change

Similarly, the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is automatically applied to the application configuration based on the sysbuild configuration to inform the application in which mode the MCUboot bootloader works.

Similarly, the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option, that informs the application about the MCUboot bootloader's mode, is also applied automatically based on the sysbuild configuration.

Tried to make it flow better - not sure if achieved, please double-check

annwoj · 2024-06-19T15:52:04Z

applications/nrf_desktop/bootloader_dfu.rst

-When the direct-xip mode is enabled (the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is set in the application configuration), the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.
+The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option is automatically applied to the bootloader configuration based on the sysbuild configuration to make the MCUboot run the image directly from both image slots.
+Similarly, the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is automatically applied to the application configuration based on the sysbuild configuration to inform the application in which mode the MCUboot bootloader works.
+When the direct-xip mode is enabled, the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.


Suggested change

When the direct-xip mode is enabled, the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.

When the direct-xip mode is enabled, the application modules that control the DFU transport do not request firmware upgrades or confirm the running image.

annwoj · 2024-06-19T15:54:33Z

applications/nrf_desktop/memory_layout.rst

@@ -83,6 +83,7 @@ The Partition Manager supports partitions in external flash.
 Enabling external flash can be useful especially for memory-limited devices.
 For example, the MCUboot can use it as a secondary image partition for the :ref:`background firmware upgrade <nrf_desktop_bootloader_background_dfu>`.
 The MCUboot moves the image data from the secondary image partition to the primary image partition before booting the new firmware.
+To use external flash for the secondary image partition, besides defining the proper static Partition Manager configuration, you must enable the ``SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY`` Kconfig option in the sysbuild configuration.


Suggested change

To use external flash for the secondary image partition, besides defining the proper static Partition Manager configuration, you must enable the ``SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY`` Kconfig option in the sysbuild configuration.

To use external flash for the secondary image partition, in addition to defining the proper static Partition Manager configuration, you must enable the ``SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY`` Kconfig option in the sysbuild configuration.

mkapala-nordic

Applied @annwoj suggestions

mkapala-nordic · 2024-06-21T09:18:16Z

applications/nrf_desktop/bootloader_dfu.rst

+* In the sysbuild configuration:
+
+  * ``SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE`` - Required for providing the signature key file used for image signing and verification.
+    If this Kconfig option does not specify the signature key file, automatically generated signature key files will be used by default.


Discussed.
Decided to change whole bulletpoint to:

* ``SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE`` - Required for providing the signature key file used by the build system (to sign the application update images) and by the bootloader (to verify the application signature). If this Kconfig option does not specify the signature key file, debug signature key files will be used by default.

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

mkapala-nordic · 2024-06-21T09:50:39Z

Rebased

annwoj

few small additional suggestions

annwoj · 2024-06-21T10:43:50Z

applications/nrf_desktop/bluetooth.rst

@@ -168,7 +168,7 @@ Fast Pair
 =========

 The nRF Desktop peripheral can be built with Google `Fast Pair`_ support.
-The configurations that enable Fast Pair are set in the :file:`prj_fast_pair.conf` and :file:`prj_release_fast_pair.conf` files.
+The configurations that enable Fast Pair are specified in the files with the ``fast_pair`` and ``release_fast_pair`` suffixes.


Suggested change

The configurations that enable Fast Pair are specified in the files with the ``fast_pair`` and ``release_fast_pair`` suffixes.

The configurations that enable Fast Pair are specified in the files with filenames ending with the ``fast_pair`` and ``release_fast_pair`` suffixes.

felt it's missing something

annwoj · 2024-06-21T10:48:22Z

applications/nrf_desktop/bootloader_dfu.rst

+If this Kconfig option is not overwritten in the sysbuild configuration, debug signature key files located in the MCUboot bootloader repository will be used by default.
+
+To select a specific version of the application, set the :kconfig:option:`CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION` Kconfig option in the application configuration.
+If the nRF Desktop application is configured with the MCUboot in the direct-xip mode, the build system builds two application images: one for the primary slot and the other for the secondary slot named ``mcuboot_secondary_app``.


Suggested change

If the nRF Desktop application is configured with the MCUboot in the direct-xip mode, the build system builds two application images: one for the primary slot and the other for the secondary slot named ``mcuboot_secondary_app``.

If the nRF Desktop application is configured with the MCUboot in the direct-xip mode, the build system builds two application images: one for the primary slot and the other for the secondary slot, named ``mcuboot_secondary_app``.

annwoj · 2024-06-21T10:49:01Z

applications/nrf_desktop/bootloader_dfu.rst

+You need to update this configuration only in the main application image, as the ``mcuboot_secondary_app`` image mirrors it.
+
+.. note::
+    When the MCUboot bootloader is in direct-xip mode, the update image must have a higher version number than the application currently running on the device.


Suggested change

When the MCUboot bootloader is in direct-xip mode, the update image must have a higher version number than the application currently running on the device.

When the MCUboot bootloader is in the direct-xip mode, the update image must have a higher version number than the application currently running on the device.

annwoj · 2024-06-21T10:49:28Z

applications/nrf_desktop/bootloader_dfu.rst

+.. note::
+    When the MCUboot bootloader is in direct-xip mode, the update image must have a higher version number than the application currently running on the device.
+    This ensures that the update image will be booted after a successful DFU image transfer.
+    Otherwise the update image can be rejected by the bootloader.


Suggested change

Otherwise the update image can be rejected by the bootloader.

Otherwise, the update image can be rejected by the bootloader.

annwoj · 2024-06-21T10:49:41Z

applications/nrf_desktop/bootloader_dfu.rst

@@ -116,12 +136,13 @@ Direct-xip mode

 The direct-xip mode is used for the :ref:`background DFU <nrf_desktop_bootloader_background_dfu>`.
 In this mode, the MCUboot bootloader boots an image directly from a given slot, so the swap operation is not needed.
-To set the MCUboot mode of operations to the direct-xip mode, make sure to enable the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option in the application configuration.
-This option automatically enables :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` to build application update images for both slots.
+To set the MCUboot mode of operations to the direct-xip mode, make sure to enable the ``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP`` Kconfig option in the sysbuild configuration.


Suggested change

To set the MCUboot mode of operations to the direct-xip mode, make sure to enable the ``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP`` Kconfig option in the sysbuild configuration.

To set the MCUboot mode of operations to the direct-xip mode, enable the ``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP`` Kconfig option in the sysbuild configuration.

annwoj · 2024-06-21T10:50:20Z

applications/nrf_desktop/bootloader_dfu.rst

-Enable the ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option in the bootloader configuration to make the MCUboot run the image directly from both image slots.
-The nRF Desktop's bootloader configurations do not enable the revert mechanism (``CONFIG_BOOT_DIRECT_XIP_REVERT``).
-When the direct-xip mode is enabled (the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is set in the application configuration), the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.
+The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option enables MCUboot to run the image directly from both image slot, and it is automatically applied to the bootloader configuration based on the sysbuild configuration.


Suggested change

The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option enables MCUboot to run the image directly from both image slot, and it is automatically applied to the bootloader configuration based on the sysbuild configuration.

The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option enables MCUboot to run the image directly from both image slots, and it is automatically applied to the bootloader configuration based on the sysbuild configuration.

annwoj · 2024-06-21T10:51:00Z

applications/nrf_desktop/bootloader_dfu.rst

@@ -137,6 +158,7 @@ Serial recovery mode
 In the :ref:`USB serial recovery <nrf_desktop_bootloader_serial_dfu>` mode, the MCUboot bootloader uses a built-in foreground DFU transport over serial interface through USB.
 The application is not involved in the foreground DFU transport, therefore it can be directly overwritten by the bootloader.
 Because of that, the configuration with the serial recovery mode requires only a single application slot.
+To set the MCUboot mode of operations to single application slot, make sure to enable the ``SB_CONFIG_MCUBOOT_MODE_SINGLE_APP`` Kconfig option in the sysbuild configuration.


Suggested change

To set the MCUboot mode of operations to single application slot, make sure to enable the ``SB_CONFIG_MCUBOOT_MODE_SINGLE_APP`` Kconfig option in the sysbuild configuration.

To set the MCUboot mode of operations to single application slot, enable the ``SB_CONFIG_MCUBOOT_MODE_SINGLE_APP`` Kconfig option in the sysbuild configuration.

annwoj · 2024-06-21T10:51:19Z

applications/nrf_desktop/bootloader_dfu.rst

@@ -155,12 +177,12 @@ You must select the ``CONFIG_MCUBOOT_INDICATION_LED`` Kconfig option to enable t
 By default, both the GPIO pin and the LED are defined in the board's DTS file.
 See :file:`boards/nordic/nrf52833dongle/nrf52833dongle_nrf52833.dts` for an example of board's DTS file used by the nRF Desktop application.

-For an example of bootloader Kconfig configuration file defined by the application, see the MCUboot bootloader ``debug`` configuration defined for nRF52833 dongle (:file:`applications/nrf_desktop/configuration/nrf52833dongle_nrf52833/child_image/mcuboot/prj.conf`).
+For an example of bootloader Kconfig configuration file defined by the application, see the MCUboot bootloader ``debug`` configuration defined for nRF52833 dongle (:file:`applications/nrf_desktop/configuration/nrf52833dongle_nrf52833/images/mcuboot/prj.conf`).


Suggested change

For an example of bootloader Kconfig configuration file defined by the application, see the MCUboot bootloader ``debug`` configuration defined for nRF52833 dongle (:file:`applications/nrf_desktop/configuration/nrf52833dongle_nrf52833/images/mcuboot/prj.conf`).

For an example of a bootloader Kconfig configuration file defined by the application, see the MCUboot bootloader ``debug`` configuration defined for nRF52833 dongle (:file:`applications/nrf_desktop/configuration/nrf52833dongle_nrf52833/images/mcuboot/prj.conf`).

annwoj · 2024-06-21T10:53:02Z

applications/nrf_desktop/description.rst

@@ -378,11 +378,12 @@ See :ref:`nrf_desktop_porting_guide` for details.
 nRF Desktop build types
 =======================

-The nRF Desktop application does not use a single :file:`prj.conf` file.
+The nRF Desktop application uses multiple files to configure the particular build type.


Suggested change

The nRF Desktop application uses multiple files to configure the particular build type.

The nRF Desktop application uses multiple files to configure each specific build type.

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

mkapala-nordic · 2024-06-21T11:11:26Z

Applied @annwoj suggestions

kapi-no · 2024-06-21T13:41:28Z

@anangl, this is ready for merging

mkapala-nordic added this to the 2.7.0 milestone Jun 13, 2024

github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jun 13, 2024

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 0a21be0 to 8b20244 Compare June 14, 2024 13:22

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 4114d5f to a132b50 Compare June 14, 2024 14:48

mkapala-nordic added the DNM label Jun 14, 2024

mkapala-nordic requested review from kapi-no, MarekPieta, zycz and alstrzebonski June 14, 2024 14:56

mkapala-nordic added doc only and removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jun 17, 2024

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch 2 times, most recently from 6cd2bf6 to df1bef7 Compare June 17, 2024 09:40

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 17, 2024

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch 2 times, most recently from a970498 to a8417af Compare June 17, 2024 09:44

mkapala-nordic removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 17, 2024

mkapala-nordic marked this pull request as ready for review June 17, 2024 09:46

MarekPieta requested changes Jun 17, 2024

View reviewed changes

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from a8417af to 6dddc1f Compare June 18, 2024 11:35

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 18, 2024

mkapala-nordic requested a review from MarekPieta June 18, 2024 11:37

MarekPieta approved these changes Jun 18, 2024

View reviewed changes

applications/nrf_desktop/doc/dfu.rst Show resolved Hide resolved

applications/nrf_desktop/bootloader_dfu.rst Outdated Show resolved Hide resolved

zycz approved these changes Jun 18, 2024

View reviewed changes

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 6dddc1f to 04e3b05 Compare June 19, 2024 08:55

mkapala-nordic requested review from MarekPieta and zycz June 19, 2024 12:11

zycz approved these changes Jun 19, 2024

View reviewed changes

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 56c1f64 to 1b27f06 Compare June 19, 2024 12:48

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 1b27f06 to 5674eac Compare June 19, 2024 12:51

MarekPieta approved these changes Jun 19, 2024

View reviewed changes

mkapala-nordic requested review from divipillai and annwoj June 19, 2024 13:29

annwoj reviewed Jun 19, 2024

View reviewed changes

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 5674eac to b4538d7 Compare June 21, 2024 09:48

mkapala-nordic commented Jun 21, 2024

View reviewed changes

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from b4538d7 to 928696a Compare June 21, 2024 09:49

applications: nrf_desktop: Align after upmerge

5b3f548

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 928696a to 4b75366 Compare June 21, 2024 09:50

mkapala-nordic requested a review from annwoj June 21, 2024 09:50

annwoj reviewed Jun 21, 2024

View reviewed changes

mkapala-nordic added 4 commits June 21, 2024 13:06

applications: nrf_desktop: Align after migration to sysbuild

868a21d

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

applications: nrf_desktop: Add note about app version config for MCUboot

d199782

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

applications: nrf_desktop: Align after migration to ipc_radio

866db8e

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

applications: nrf_desktop: Add note about version bump for B0

9bef0f7

Jira: NCSDK-27889 Signed-off-by: Mateusz Kapala <[email protected]>

mkapala-nordic force-pushed the nrf-desktop/align-docs-for-270 branch from 4b75366 to 9bef0f7 Compare June 21, 2024 11:10

mkapala-nordic removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. DNM labels Jun 21, 2024

mkapala-nordic requested a review from annwoj June 21, 2024 11:11

annwoj approved these changes Jun 21, 2024

View reviewed changes

anangl merged commit caf754e into nrfconnect:main Jun 21, 2024
13 of 15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

application: nrf_desktop: Align docs after upmerge + migration to sysbuild #15998

application: nrf_desktop: Align docs after upmerge + migration to sysbuild #15998

mkapala-nordic commented Jun 13, 2024 •

edited

Loading

NordicBuilder commented Jun 13, 2024 •

edited

Loading

NordicBuilder commented Jun 14, 2024

MarekPieta commented Jun 18, 2024 •

edited

Loading

zycz Jun 18, 2024

zycz Jun 18, 2024

zycz Jun 18, 2024

mkapala-nordic commented Jun 19, 2024 •

edited

Loading

mkapala-nordic commented Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

mkapala-nordic Jun 21, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

annwoj Jun 19, 2024

mkapala-nordic left a comment

mkapala-nordic Jun 21, 2024

mkapala-nordic commented Jun 21, 2024

annwoj left a comment •

edited

Loading

annwoj Jun 21, 2024 •

edited

Loading

annwoj Jun 21, 2024

annwoj Jun 21, 2024

annwoj Jun 21, 2024

annwoj Jun 21, 2024

annwoj Jun 21, 2024

annwoj Jun 21, 2024

annwoj Jun 21, 2024

annwoj Jun 21, 2024

mkapala-nordic commented Jun 21, 2024

kapi-no commented Jun 21, 2024


		The MCUboot private key path (:kconfig:option:`CONFIG_BOOT_SIGNATURE_KEY_FILE`) must be set only in the MCUboot bootloader configuration file.
		The MCUboot private key path (:kconfig:option:`SB_CONFIG_BOOT_SIGNATURE_KEY_FILE`) must be also set in the sysbuild configuration.

	The configurations that enable Fast Pair are set in the configurations with the ``fast_pair`` and ``release_fast_pair`` file suffixes.
	The configurations that enable Fast Pair are specified in the files with the ``fast_pair`` and ``release_fast_pair`` suffixes.

	* The board supports ``debug`` (``fast_pair`` file suffix) and ``release`` (``release_fast_pair`` file suffix) :ref:`nrf_desktop_bluetooth_guide_fast_pair` configurations.
	* The board supports the ``debug`` (``fast_pair`` file suffix) and ``release`` (``release_fast_pair`` file suffix) configurations for :ref:`nrf_desktop_bluetooth_guide_fast_pair`.

	It automatically enables the ``SB_CONFIG_SECURE_BOOT_BUILD_S1_VARIANT_IMAGE`` option to construct the application binaries for both application's slots in non-volatile memory.
	This setting automatically enables the ``SB_CONFIG_SECURE_BOOT_BUILD_S1_VARIANT_IMAGE`` Kconfig option, which generates application binaries for both slots in non-volatile memory.

	If this Kconfig option does not specify the signature key file, automatically generated signature key files will be used by default.
	If this Kconfig option does not specify the signature key file, the application will use the default files.

	The nRF Desktop application configurations do not use the direct-xip mode with revert mechanism (``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT``).
	The nRF Desktop application configurations do not use the direct-xip mode with the revert mechanism (``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT``).

	The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option is automatically applied to the bootloader configuration based on the sysbuild configuration to make the MCUboot run the image directly from both image slots.
	The ``CONFIG_BOOT_DIRECT_XIP`` Kconfig option enables MCUboot to run the image directly from both image slot, and it is automatically applied to the bootloader configuration based on the sysbuild configuration.

	Similarly, the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is automatically applied to the application configuration based on the sysbuild configuration to inform the application in which mode the MCUboot bootloader works.
	Similarly, the :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option, that informs the application about the MCUboot bootloader's mode, is also applied automatically based on the sysbuild configuration.

	When the direct-xip mode is enabled, the application modules that control the DFU transport do not request firmware upgrades and do not confirm the running image.
	When the direct-xip mode is enabled, the application modules that control the DFU transport do not request firmware upgrades or confirm the running image.

	To use external flash for the secondary image partition, besides defining the proper static Partition Manager configuration, you must enable the ``SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY`` Kconfig option in the sysbuild configuration.
	To use external flash for the secondary image partition, in addition to defining the proper static Partition Manager configuration, you must enable the ``SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY`` Kconfig option in the sysbuild configuration.

	If the nRF Desktop application is configured with the MCUboot in the direct-xip mode, the build system builds two application images: one for the primary slot and the other for the secondary slot named ``mcuboot_secondary_app``.
	If the nRF Desktop application is configured with the MCUboot in the direct-xip mode, the build system builds two application images: one for the primary slot and the other for the secondary slot, named ``mcuboot_secondary_app``.

	When the MCUboot bootloader is in direct-xip mode, the update image must have a higher version number than the application currently running on the device.
	When the MCUboot bootloader is in the direct-xip mode, the update image must have a higher version number than the application currently running on the device.

	Otherwise the update image can be rejected by the bootloader.
	Otherwise, the update image can be rejected by the bootloader.

	To set the MCUboot mode of operations to the direct-xip mode, make sure to enable the ``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP`` Kconfig option in the sysbuild configuration.
	To set the MCUboot mode of operations to the direct-xip mode, enable the ``SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP`` Kconfig option in the sysbuild configuration.

	For an example of bootloader Kconfig configuration file defined by the application, see the MCUboot bootloader ``debug`` configuration defined for nRF52833 dongle (:file:`applications/nrf_desktop/configuration/nrf52833dongle_nrf52833/images/mcuboot/prj.conf`).
	For an example of a bootloader Kconfig configuration file defined by the application, see the MCUboot bootloader ``debug`` configuration defined for nRF52833 dongle (:file:`applications/nrf_desktop/configuration/nrf52833dongle_nrf52833/images/mcuboot/prj.conf`).

	The nRF Desktop application uses multiple files to configure the particular build type.
	The nRF Desktop application uses multiple files to configure each specific build type.

application: nrf_desktop: Align docs after upmerge + migration to sysbuild #15998

application: nrf_desktop: Align docs after upmerge + migration to sysbuild #15998

Conversation

mkapala-nordic commented Jun 13, 2024 • edited Loading

NordicBuilder commented Jun 13, 2024 • edited Loading

Test specification

NordicBuilder commented Jun 14, 2024

MarekPieta commented Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkapala-nordic commented Jun 19, 2024 • edited Loading

mkapala-nordic commented Jun 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkapala-nordic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkapala-nordic commented Jun 21, 2024

annwoj left a comment • edited Loading

Choose a reason for hiding this comment

annwoj Jun 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkapala-nordic commented Jun 21, 2024

kapi-no commented Jun 21, 2024

mkapala-nordic commented Jun 13, 2024 •

edited

Loading

NordicBuilder commented Jun 13, 2024 •

edited

Loading

MarekPieta commented Jun 18, 2024 •

edited

Loading

mkapala-nordic commented Jun 19, 2024 •

edited

Loading

annwoj left a comment •

edited

Loading

annwoj Jun 21, 2024 •

edited

Loading