Skip to content

Commit 21d7014

Browse files
committed
applications: nrf_desktop: doc: dfu: align with MCUboot RAM load
Updated the documentation of the DFU application module that is part of the nRF Desktop application to describe the support for the MCUboot RAM load mode. Ref: NCSDK-36374 Signed-off-by: Kamil Piszczek <[email protected]>
1 parent 52ea3d7 commit 21d7014

File tree

1 file changed

+31
-7
lines changed
  • applications/nrf_desktop/doc

1 file changed

+31
-7
lines changed

applications/nrf_desktop/doc/dfu.rst

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,43 @@ If the buffer is small, the host must perform the DFU progress synchronization m
4747
MCUboot bootloader mode
4848
=======================
4949

50-
The MCUboot bootloader can either move the image to the primary slot before booting it (``swap mode``) or boot the image directly from the secondary slot (``direct-xip mode``).
50+
This module supports the following modes of the MCUboot bootloader and reports the corresponding bootloader name:
5151

52-
If the MCUboot bootloader in the swap mode is selected, the DFU module does the following:
52+
* ``swap`` (:kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_SWAP_USING_MOVE`) - ``MCUBOOT``
53+
* ``direct-xip`` (:kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP`) - ``MCUBOOT+XIP``
54+
* ``RAM load`` (:kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD`) - ``MCUBOOT``
55+
56+
The DFU module relies on the listed Kconfig options that indicate the MCUboot bootloader mode to determine the correct behavior.
57+
58+
.. caution::
59+
Other bootloader modes might be compatible with this module, but they are not actively tested as part of the nRF Desktop configurations.
60+
61+
See the :ref:`nrf_desktop_bootloader` section for more information on the MCUboot bootloader modes.
62+
63+
Swap mode
64+
---------
65+
66+
If this bootloader mode is selected, the DFU module does the following:
5367

5468
* Requests the image upgrade after the whole image is transferred over the :ref:`nrf_desktop_config_channel`.
5569
* Confirms the running image after the device is rebooted.
5670

57-
If the MCUboot bootloader's direct-xip mode is used, the module does not mark the newly uploaded image as pending and does not confirm it after a successful boot.
58-
In that case, the DFU module assumes that the MCUboot direct-xip bootloader simply boots an image with the higher version, so there is no need to mark the image as pending and confirm it.
71+
Direct-xip mode
72+
---------------
73+
74+
If this bootloader mode is selected, the DFU module does not mark the newly uploaded image as pending and does not confirm it after a successful boot.
5975

60-
The :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` Kconfig option is used to inform the DFU module that the device uses the MCUboot bootloader in the direct-xip mode.
61-
If the option is enabled, the DFU module reports the ``MCUBOOT+XIP`` bootloader name instead of ``MCUBOOT`` to indicate that the bootloader working in the direct-xip mode is used.
62-
See the :ref:`nrf_desktop_bootloader` section for more information on the MCUboot bootloader configuration.
76+
RAM load mode
77+
-------------
78+
79+
If this bootloader mode is selected, the DFU module does not mark the newly uploaded image as pending and does not confirm it after a successful boot.
80+
81+
.. note::
82+
Support for the RAM load mode in this module is experimental.
83+
For more details about the support of the MCUboot RAM load mode in the nRF Desktop application, see the MCUboot :ref:`nrf_desktop_configuring_mcuboot_bootloader_ram_load` section in the nRF Desktop documentation.
84+
85+
.. note::
86+
DTS is the only supported partitioning method when you use the MCUboot bootloader in the RAM load mode.
6387

6488
Partitioning methods
6589
====================

0 commit comments

Comments
 (0)