michaelh/zephyr
1
0
Fork 0
Code Releases Activity

sysbuild: Add MCUboot operating mode

Browse source 
Adds a sysbuild Kconfig to select the operating mode of MCUboot
which is then propagated to the MCUboot and application images

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
This commit is contained in:
Jamie McCrae 2024-07-24 10:14:36 +01:00 • committed by Carles Cufí
commit 9566aa5b00
3 changed files with 139 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

40
share/sysbuild/image_configurations/BOOTLOADER_image_default.cmake
View file

@ -1,10 +1,48 @@
# Copyright (c) 2023 Nordic Semiconductor
# Copyright (c) 2023-2024 Nordic Semiconductor
#
# SPDX-License-Identifier: Apache-2.0
# This sysbuild CMake file sets the sysbuild controlled settings as properties
# on Zephyr MCUboot / bootloader image.
set(bootmodes CONFIG_SINGLE_APPLICATION_SLOT
CONFIG_BOOT_SWAP_USING_SCRATCH
CONFIG_BOOT_UPGRADE_ONLY
CONFIG_BOOT_SWAP_USING_MOVE
CONFIG_BOOT_DIRECT_XIP
CONFIG_BOOT_RAM_LOAD
CONFIG_BOOT_FIRMWARE_LOADER)
if(SB_CONFIG_MCUBOOT_MODE_SINGLE_APP)
set(bootmode CONFIG_SINGLE_APPLICATION_SLOT)
elseif(SB_CONFIG_MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH)
set(bootmode CONFIG_BOOT_SWAP_USING_MOVE)
elseif(SB_CONFIG_MCUBOOT_MODE_SWAP_SCRATCH)
set(bootmode CONFIG_BOOT_SWAP_USING_SCRATCH)
elseif(SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY)
set(bootmode CONFIG_BOOT_UPGRADE_ONLY)
elseif(SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP OR SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT)
set(bootmode CONFIG_BOOT_DIRECT_XIP)
elseif(SB_CONFIG_MCUBOOT_MODE_RAM_LOAD)
set(bootmode CONFIG_BOOT_RAM_LOAD)
elseif(SB_CONFIG_MCUBOOT_MODE_FIRMWARE_UPDATER)
set(bootmode CONFIG_BOOT_FIRMWARE_LOADER)
endif()
foreach(loopbootmode ${bootmodes})
if("${loopbootmode}" STREQUAL "${bootmode}")
set_config_bool(${ZCMAKE_APPLICATION} ${loopbootmode} y)
else()
set_config_bool(${ZCMAKE_APPLICATION} ${loopbootmode} n)
endif()
endforeach()
if(SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_BOOT_DIRECT_XIP_REVERT y)
else()
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_BOOT_DIRECT_XIP_REVERT n)
endif()
set(keytypes CONFIG_BOOT_SIGNATURE_TYPE_NONE
CONFIG_BOOT_SIGNATURE_TYPE_RSA
CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256

20
share/sysbuild/image_configurations/MAIN_image_default.cmake
View file

@ -1,4 +1,4 @@
# Copyright (c) 2023 Nordic Semiconductor
# Copyright (c) 2023-2024 Nordic Semiconductor
#
# SPDX-License-Identifier: Apache-2.0
@ -19,4 +19,22 @@ if(SB_CONFIG_BOOTLOADER_MCUBOOT)
else()
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_GENERATE_UNSIGNED_IMAGE n)
endif()
if(SB_CONFIG_MCUBOOT_MODE_SINGLE_APP)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_SINGLE_APP y)
elseif(SB_CONFIG_MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_SWAP_WITHOUT_SCRATCH y)
elseif(SB_CONFIG_MCUBOOT_MODE_SWAP_SCRATCH)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_SWAP_SCRATCH y)
elseif(SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_OVERWRITE_ONLY y)
elseif(SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP y)
elseif(SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP_WITH_REVERT y)
elseif(SB_CONFIG_MCUBOOT_MODE_RAM_LOAD)
# Not yet supported in zephyr code
elseif(SB_CONFIG_MCUBOOT_MODE_FIRMWARE_UPDATER)
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_FIRMWARE_UPDATER y)
endif()
endif()

81
share/sysbuild/images/bootloader/Kconfig
View file

@ -30,6 +30,87 @@ endchoice
if BOOTLOADER_MCUBOOT
choice MCUBOOT_MODE
prompt "Mode of operation"
default MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH
help
The operating mode of MCUboot (which will also be propagated to the application).
config MCUBOOT_MODE_SINGLE_APP
bool "Single slot"
help
MCUboot will only boot slot0_partition placed application and does not care about other
slots. In this mode application is not able to DFU its own update to secondary slot and
all updates need to be performed using MCUboot serial recovery.
config MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH
bool "Swap without scratch (swap using move)"
help
MCUboot expects slot0_partition and slot1_partition to be present in DT and application
will boot from slot0_partition. MCUBOOT_BOOTLOADER_NO_DOWNGRADE should also be selected
in main application if MCUboot has been built with MCUBOOT_DOWNGRADE_PREVENTION.
config MCUBOOT_MODE_SWAP_SCRATCH
bool "Swap using scratch"
help
MCUboot expects slot0_partition, slot1_partition and scratch_partition to be present in
DT, and application will boot from slot0_partition. In this mode scratch_partition is
used as temporary storage when MCUboot swaps application from the secondary slot to the
primary slot.
MCUBOOT_BOOTLOADER_NO_DOWNGRADE should also be selected in main application if MCUboot
has been built with MCUBOOT_DOWNGRADE_PREVENTION.
config MCUBOOT_MODE_OVERWRITE_ONLY
bool "Overwrite"
help
MCUboot will take contents of secondary slot of an image and will overwrite primary slot
with it. In this mode it is not possible to revert back to previous version as it is not
stored in the secondary slot.
This mode supports MCUBOOT_BOOTLOADER_NO_DOWNGRADE which means that the overwrite will
not happen unless the version of secondary slot is higher than the version in primary
slot.
config MCUBOOT_MODE_DIRECT_XIP
bool "DirectXIP"
help
MCUboot expects slot0_partition and slot1_partition to exist in DT. In this mode MCUboot
can boot from either partition and will select one with higher application image version,
which usually means major.minor.patch triple, unless BOOT_VERSION_CMP_USE_BUILD_NUMBER is
also selected in MCUboot that enables comparison of build number.
This option automatically selectes MCUBOOT_BOOTLOADER_NO_DOWNGRADE as it is not possible
to swap back to older version of application.
config MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT
bool "DirectXIP with revert"
help
MCUboot expects slot0_partition and slot1_partition to exist in DT. In this mode MCUboot
will boot the application with the higher version from either slot, as long as it has
been marked to be boot next time for test or permanently. In case when application is
marked for test it needs to confirm itself, on the first boot, or it will be removed and
MCUboot will revert to booting previously approved application.
This mode does not allow freely switching between application versions, as, once higher
version application is approved, it is not possible to select lower version for boot.
This mode selects MCUBOOT_BOOTLOADER_NO_DOWNGRADE as it is not possible to downgrade
running application, but note that MCUboot may do that if application with higher
version will not get confirmed.
config MCUBOOT_MODE_RAM_LOAD
bool "RAM load"
help
MCUboot expects slot0_partition and slot1_partition to exist in DT. In this mode, MCUboot
will select the image with the higher version number, copy it to RAM and begin execution
from there. The image must be linked to execute from RAM, the address that it is copied
to is specified using the load-addr argument when running imgtool.
config MCUBOOT_MODE_FIRMWARE_UPDATER
bool "Firmware updater"
help
MCUboot will only boot slot0_partition for the main application but has an entrance
mechanism defined for entering the slot1_partition which is a dedicated firmware updater
application used to update the slot0_partition application.
endchoice
config SIGNATURE_TYPE
string
default NONE if BOOT_SIGNATURE_TYPE_NONE