From e24e07c4abc14f75b2f4e64e57ce2e083b0dc285 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc Date: Thu, 6 Feb 2025 14:33:52 +0100 Subject: [PATCH] doc: mcuboot: fix outdated links + multi-image Edited the readme-ncs.rst file and links.txt in MCUboot module docs to update the old links and remove info about multi-image support. Also updated the note about direct-xip mode. NCSDK-31689 and PRs #20005 and #20153. Signed-off-by: Grzegorz Ferenc --- doc/mcuboot/links.txt | 29 ++++++++++++----------------- doc/mcuboot/readme-ncs.rst | 12 +++++------- 2 files changed, 17 insertions(+), 24 deletions(-) diff --git a/doc/mcuboot/links.txt b/doc/mcuboot/links.txt index d77246f65fa0..d71bf678ffbc 100644 --- a/doc/mcuboot/links.txt +++ b/doc/mcuboot/links.txt @@ -1,4 +1,4 @@ -.. ### This page lists links used in the nrfxlib docs. +.. ### This page lists links used in the mcuboot wrapper docs. Links are grouped by source URL if three or more have the same source URL. Otherwise, they are placed in "Source: other". Links not separated by blank line are related to one another. @@ -7,26 +7,21 @@ .. _`sdk-nrf`: https://github.com/nrfconnect/sdk-nrf -.. ### Source: infocenter.nordicsemi.com - -.. _`Infocenter`: https://infocenter.nordicsemi.com/index.jsp - .. ### Source: www.nordicsemi.com .. _`Nordic Semiconductor`: https://www.nordicsemi.com/ -.. ### Source: https://developer.nordicsemi.com/ - -.. _`Immutable first-stage bootloader`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader.html#immutable-bootloader -.. _`Second-stage upgradable bootloader`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader.html#upgradable-bootloader -.. _`Secure bootloader chain`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader.html -.. _`Adding a bootloader chain`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_adding.html -.. _`Testing the bootloader chain`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_testing.html -.. _`Using external memory partitions`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_external_flash.html -.. _`Customizing the bootloader`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_config.html -.. _`Signature keys`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/bootloaders/bootloader_signature_keys.html -.. _`Multi-image builds`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/multi_image.html -.. _`MCUboot output build files`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/config_and_build/output_build_files.html#mcuboot-output-build-files +.. ### Source: https://docs.nordicsemi.com/ + +.. _`Immutable first-stage bootloader`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.html#immutable-bootloader +.. _`Second-stage upgradable bootloader`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.html#upgradable-bootloader +.. _`Secure bootloader chain`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader.html +.. _`Enabling a bootloader chain using sysbuild`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_adding_sysbuild.html +.. _`MCUboot and NSIB`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_mcuboot_nsib.html +.. _`Partitioning device memory`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_partitioning.html +.. _`Customizing the bootloader`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/bootloaders_dfu/mcuboot_nsib/bootloader_config.html +.. _`Signature keys`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/config_and_build/bootloaders/bootloader_signature_keys.html +.. _`MCUboot output build files`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/config_and_build/output_build_files.html#mcuboot-output-build-files .. ### Source: other diff --git a/doc/mcuboot/readme-ncs.rst b/doc/mcuboot/readme-ncs.rst index 711247290e57..4c07c9b590a8 100644 --- a/doc/mcuboot/readme-ncs.rst +++ b/doc/mcuboot/readme-ncs.rst @@ -15,19 +15,17 @@ You can use MCUboot in the |NCS| in one of the following roles: See the following user guides for more information on adding, configuring, and testing MCUboot for your application build in the |NCS|: * `Secure bootloader chain`_ -* `Adding a bootloader chain`_ -* `Testing the bootloader chain`_ -* `Using external memory partitions`_ +* `Enabling a bootloader chain using sysbuild`_ +* `MCUboot and NSIB`_ +* `Partitioning device memory`_ * `Customizing the bootloader`_ * `Signature keys`_ When you add MCUboot to your application build, the files that can be used for firmware over-the-air (FOTA) upgrades are automatically generated. See the `MCUboot output build files`_ page for a list of all these files. -See the `Multi-image builds`_ page for more information on image files in multi-image builds. - .. note:: When you use MCUboot in the direct-xip mode, enable the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option to let the build system generate an additional set of files for the second application slot. - These ``.hex`` files are identical to the ones listed above, but their names also use the ``mcuboot_secondary_`` prefix. - For example, :file:`mcuboot_secondary_app_signed.hex` is created and placed in the second slot on the target device when the :file:`app_signed.hex` file is placed in the first slot. + These files are identical to the ones listed on the `MCUboot output build files`_ page, but they are placed in the :file:`mcuboot_secondary_app` folder. + For example, :file:`mcuboot_secondary_app/zephyr/zephyr.signed.bin` is created and placed in the second slot on the target device when the :file:`zephyr.signed.bin` file is placed in the first slot. For more information about the direct-xip mode, see the *Equal slots (direct-xip)* section in the :doc:`Bootloader documentation `.