Skip to content

soc: espressif: Build MCUboot Espressif Port using sysbuild #87710

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

soc: espressif: Build MCUboot Espressif Port using sysbuild #87710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14cd426
boards: espressif: sysbuild: move BOOTLOADER_MCUBOOT default choice
almir-okato Mar 11, 2025
af9776f
espressif: sysbuild: integrate MCUboot Espressif Port build
almir-okato Mar 11, 2025
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
4 changes: 0 additions & 4 deletions boards/espressif/esp32_devkitc/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32_ethernet_kit/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32c3_devkitc/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2024 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32c3_devkitm/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32c3_rust/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2024 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32c6_devkitc/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32s2_devkitc/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2024 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32s2_saola/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32s3_devkitc/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2024 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32s3_devkitm/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp32s3_eye/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2024 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp8684_devkitm/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2024 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
4 changes: 0 additions & 4 deletions boards/espressif/esp_wrover_kit/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Copyright (c) 2023 Espressif Systems (Shanghai) Co., Ltd.
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT
endchoice

choice BOOT_SIGNATURE_TYPE
default BOOT_SIGNATURE_TYPE_NONE
endchoice
11 changes: 11 additions & 0 deletions scripts/ci/check_compliance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,7 +1059,18 @@ def check_no_undef_outside_kconfig(self, kconf):
"DEEP_SLEEP", # #defined by RV32M1 in ext/
"DESCRIPTION",
"ERR",
"ESP_BOOT_SWAP_USING_MOVE", # Used on MCUboot Espressif Port
"ESP_BOOT_SWAP_USING_OFFSET", # Used on MCUboot Espressif Port
"ESP_BOOT_SWAP_USING_SCRATCH", # Used on MCUboot Espressif Port
"ESP_BOOT_UPGRADE_ONLY", # Used on MCUboot Espressif Port
"ESP_DIF_LIBRARY", # Referenced in CMake comment
"ESP_DOWNGRADE_PREVENTION", # Used on MCUboot Espressif Port
"ESP_SIGN_EC256", # Used on MCUboot Espressif Port
"ESP_SIGN_ED25519", # Used on MCUboot Espressif Port
"ESP_SIGN_KEY_FILE", # Used on MCUboot Espressif Port
"ESP_SIGN_NONE", # Used on MCUboot Espressif Port
"ESP_SIGN_RSA", # Used on MCUboot Espressif Port
"ESP_SINGLE_APPLICATION_SLOT", # Used on MCUboot Espressif Port
"EXPERIMENTAL",
"EXTRA_FIRMWARE_DIR", # Linux, in boards/xtensa/intel_adsp_cavs25/doc
"FFT", # Used as an example in cmake/extensions.cmake
Expand Down
13 changes: 7 additions & 6 deletions share/sysbuild/image_configurations/MAIN_image_default.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@
# on the main Zephyr image.

set_config_bool(${ZCMAKE_APPLICATION} CONFIG_BOOTLOADER_MCUBOOT "${SB_CONFIG_BOOTLOADER_MCUBOOT}")
set_config_string(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_SIGNATURE_KEY_FILE
"${SB_CONFIG_BOOT_SIGNATURE_KEY_FILE}"
)
set_config_string(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_ENCRYPTION_KEY_FILE
"${SB_CONFIG_BOOT_ENCRYPTION_KEY_FILE}"
)

if(SB_CONFIG_BOOTLOADER_MCUBOOT)
set_config_string(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_SIGNATURE_KEY_FILE
"${SB_CONFIG_BOOT_SIGNATURE_KEY_FILE}"
)
set_config_string(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_ENCRYPTION_KEY_FILE
"${SB_CONFIG_BOOT_ENCRYPTION_KEY_FILE}"
)

if("${SB_CONFIG_SIGNATURE_TYPE}" STREQUAL "NONE")
set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_GENERATE_UNSIGNED_IMAGE y)
else()
Expand Down
135 changes: 135 additions & 0 deletions soc/espressif/Kconfig.sysbuild
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,141 @@
# Copyright (c) 2024 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0

choice BOOTLOADER
default BOOTLOADER_MCUBOOT

# Extension for the BOOTLOADER Kconfig choice to allow
# MCUboot Espressif Port to be built
config BOOTLOADER_MCUBOOT_ESPRESSIF
bool "MCUboot Espressif Port"
depends on SOC_FAMILY_ESPRESSIF_ESP32
help
Use MCUboot Espressif Port as the bootloader

endchoice

choice MCUBOOT_MODE
default MCUBOOT_MODE_OVERWRITE_ONLY if SOC_FAMILY_ESPRESSIF_ESP32
endchoice

if BOOTLOADER_MCUBOOT_ESPRESSIF

config ESP_MCUBOOT_IMGTOOL_OVERWRITE_ONLY
bool
help
If enabled, --overwrite-only option is passed to imgtool to avoid
adding the swap status area size when calculating overflow.

choice ESP_MCUBOOT_MODE
prompt "Mode of operation"
default ESP_MCUBOOT_MODE_SWAP_SCRATCH
help
The operating mode of MCUboot (which will also be propagated to the application).

config ESP_MCUBOOT_MODE_SINGLE_APP
bool "Single slot"
select ESP_MCUBOOT_IMGTOOL_OVERWRITE_ONLY
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 ESP_MCUBOOT_MODE_SWAP_USING_OFFSET
bool "Swap using offset"
select EXPERIMENTAL
select ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE
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 ESP_MCUBOOT_MODE_SWAP_USING_MOVE
bool "Swap using move"
select ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE
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 ESP_MCUBOOT_MODE_SWAP_SCRATCH
bool "Swap using scratch"
select ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE
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 ESP_MCUBOOT_MODE_OVERWRITE_ONLY
bool "Overwrite"
select ESP_MCUBOOT_IMGTOOL_OVERWRITE_ONLY
select ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE
help
MCUboot will take the content 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.

endchoice # ESP_MCUBOOT_MODE

config ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE
bool
help
Selected mode supports downgrade prevention, where you cannot switch to
an application with lower version than the currently running application.

if ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE

config ESP_MCUBOOT_BOOTLOADER_NO_DOWNGRADE
bool "MCUboot downgrade prevention"
help
Selected MCUboot mode has downgrade prevention, where it's not
possible to revert back to image with lower version number.
This options should be selected when MCUboot has been built with
MCUBOOT_DOWNGRADE_PREVENTION option enabled.

endif # ESP_MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE

choice ESP_BOOT_SIGNATURE_TYPE
prompt "Signature type"
default ESP_BOOT_SIGNATURE_TYPE_NONE

config ESP_BOOT_SIGNATURE_TYPE_NONE
bool "No signature; use only hash check"

config ESP_BOOT_SIGNATURE_TYPE_RSA
bool "RSA signatures"

if ESP_BOOT_SIGNATURE_TYPE_RSA

config ESP_BOOT_SIGNATURE_RSA_LEN
int "RSA signature length"
range 2048 3072
default 2048

endif

config ESP_BOOT_SIGNATURE_TYPE_ECDSA_P256
bool "Elliptic curve digital signatures with curve P-256"

config ESP_BOOT_SIGNATURE_TYPE_ED25519
bool "Edwards curve digital signatures using ed25519"

endchoice # ESP_BOOT_SIGNATURE_TYPE

config ESP_BOOT_SIGNATURE_KEY_FILE
string "Signing PEM key file"
depends on !ESP_BOOT_SIGNATURE_TYPE_NONE
default "$(ZEPHYR_MCUBOOT_MODULE_DIR)/root-ec-p256.pem" if ESP_BOOT_SIGNATURE_TYPE_ECDSA_P256
default "$(ZEPHYR_MCUBOOT_MODULE_DIR)/root-ed25519.pem" if ESP_BOOT_SIGNATURE_TYPE_ED25519
default "$(ZEPHYR_MCUBOOT_MODULE_DIR)/root-rsa-2048.pem" if ESP_BOOT_SIGNATURE_TYPE_RSA && ESP_BOOT_SIGNATURE_RSA_LEN=2048
default "$(ZEPHYR_MCUBOOT_MODULE_DIR)/root-rsa-3072.pem" if ESP_BOOT_SIGNATURE_TYPE_RSA && ESP_BOOT_SIGNATURE_RSA_LEN=3072
default ""
help
Absolute path to signing key file to use with MCUBoot.

endif # BOOTLOADER_MCUBOOT_ESPRESSIF
Loading
Loading