Skip to content

Commit 4c7942e

Browse files
nordicjmnordicjm
committed
zephyr: Add estimated image footer size to cache in sysbuild
Adds MCUboot's estimated overhead footer size to the application's cache when using sysbuild, this allows that information to be propagated to applications which can use the information to reduce the available size for an application, preventing the MCUboot error of image too large to swap. Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
1 parent 26d6423 commit 4c7942e

File tree

3 files changed

+169
-0
lines changed

3 files changed

+169
-0
lines changed

‎boot/zephyr/CMakeLists.txt

+128
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# CMakeLists.txt for building mcuboot as a Zephyr project
22
#
33
# Copyright (c) 2017 Open Source Foundries Limited
4+
# Copyright (c) 2023 Nordic Semiconductor ASA
45
#
56
# SPDX-License-Identifier: Apache-2.0
67

@@ -356,3 +357,130 @@ zephyr_library_sources(
356357
${BOOT_DIR}/zephyr/arm_cleanup.c
357358
)
358359
endif()
360+
361+
if(SYSBUILD)
362+
function(align_up num align result)
363+
math(EXPR out "(((${num}) + ((${align}) - 1)) & ~((${align}) - 1))")
364+
set(${result} "${out}" PARENT_SCOPE)
365+
endfunction()
366+
367+
function(dt_get_parent node)
368+
string(FIND "${${node}}" "/" pos REVERSE)
369+
370+
if(pos EQUAL -1)
371+
message(ERROR "Unable to get parent of node: ${${node}}")
372+
endif()
373+
374+
string(SUBSTRING "${${node}}" 0 ${pos} ${node})
375+
set(${node} "${${node}}" PARENT_SCOPE)
376+
endfunction()
377+
378+
if(CONFIG_SINGLE_APPLICATION_SLOT OR CONFIG_BOOT_FIRMWARE_LOADER OR CONFIG_BOOT_SWAP_USING_SCRATCH OR CONFIG_BOOT_SWAP_USING_MOVE OR CONFIG_BOOT_UPGRADE_ONLY OR CONFIG_BOOT_DIRECT_XIP OR CONFIG_BOOT_RAM_LOAD)
379+
# TODO: RAM LOAD support
380+
dt_nodelabel(slot0_flash NODELABEL "slot0_partition")
381+
dt_get_parent(slot0_flash)
382+
dt_get_parent(slot0_flash)
383+
384+
if(NOT CONFIG_SINGLE_APPLICATION_SLOT)
385+
dt_nodelabel(slot1_flash NODELABEL "slot1_partition")
386+
dt_get_parent(slot1_flash)
387+
dt_get_parent(slot1_flash)
388+
389+
if(NOT "${slot0_flash}" STREQUAL "${slot1_flash}")
390+
# Check both slots for the one with the largest write/erase block size
391+
dt_prop(erase_size_slot0 PATH "${slot0_flash}" PROPERTY "erase-block-size")
392+
dt_prop(write_size_slot0 PATH "${slot0_flash}" PROPERTY "write-block-size")
393+
dt_prop(erase_size_slot1 PATH "${slot1_flash}" PROPERTY "erase-block-size")
394+
dt_prop(write_size_slot1 PATH "${slot1_flash}" PROPERTY "write-block-size")
395+
396+
if(${erase_size_slot0} GREATER ${erase_size_slot1})
397+
set(erase_size ${erase_size_slot0})
398+
else()
399+
set(erase_size ${erase_size_slot1})
400+
endif()
401+
402+
if(${write_size_slot0} GREATER ${write_size_slot1})
403+
set(write_size ${write_size_slot0})
404+
else()
405+
set(write_size ${write_size_slot1})
406+
endif()
407+
else()
408+
dt_prop(erase_size PATH "${slot0_flash}" PROPERTY "erase-block-size")
409+
dt_prop(write_size PATH "${slot0_flash}" PROPERTY "write-block-size")
410+
endif()
411+
else()
412+
dt_prop(erase_size PATH "${slot0_flash}" PROPERTY "erase-block-size")
413+
dt_prop(write_size PATH "${slot0_flash}" PROPERTY "write-block-size")
414+
endif()
415+
416+
if(write_size LESS 8)
417+
set(write_size 8)
418+
endif()
419+
420+
set(key_size 0)
421+
422+
# Boot trailer magic size
423+
set(boot_magic_size 16)
424+
425+
# Estimates for trailer TLV data size, this was taken from hello world builds for nrf52840dk
426+
if(CONFIG_BOOT_SIGNATURE_TYPE_RSA)
427+
if(CONFIG_BOOT_SIGNATURE_TYPE_RSA_LEN EQUAL 3072)
428+
set(boot_tlv_estimate 464)
429+
else()
430+
set(boot_tlv_estimate 336)
431+
endif()
432+
elseif(CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256)
433+
set(boot_tlv_estimate 150)
434+
elseif(CONFIG_BOOT_SIGNATURE_TYPE_ED25519)
435+
set(boot_tlv_estimate 144)
436+
else()
437+
set(boot_tlv_estimate 40)
438+
endif()
439+
440+
if(CONFIG_BOOT_ENCRYPT_RSA OR CONFIG_BOOT_ENCRYPT_EC256 OR CONFIG_BOOT_ENCRYPT_X25519)
441+
# 128-bit AES key size
442+
set(boot_enc_key_size 16)
443+
444+
if(CONFIG_BOOT_SWAP_SAVE_ENCTLV)
445+
if(CONFIG_BOOT_ENCRYPT_RSA)
446+
set(key_size 256)
447+
elseif(CONFIG_BOOT_ENCRYPT_EC256)
448+
math(EXPR key_size "65 + 32 + ${boot_enc_key_size}")
449+
elseif(CONFIG_BOOT_ENCRYPT_X25519)
450+
math(EXPR key_size "32 + 32 + ${boot_enc_key_size}")
451+
endif()
452+
else()
453+
set(key_size "${boot_enc_key_size}")
454+
endif()
455+
456+
align_up(${key_size} ${write_size} key_size)
457+
math(EXPR key_size "${key_size} * 2")
458+
endif()
459+
460+
align_up(${boot_magic_size} ${write_size} boot_magic_size)
461+
462+
if(CONFIG_SINGLE_APPLICATION_SLOT OR CONFIG_BOOT_FIRMWARE_LOADER)
463+
set(boot_swap_data_size 0)
464+
else()
465+
math(EXPR boot_swap_data_size "${write_size} * 4")
466+
endif()
467+
468+
if(CONFIG_BOOT_SWAP_USING_SCRATCH OR CONFIG_BOOT_SWAP_USING_MOVE)
469+
math(EXPR boot_status_data_size "${CONFIG_BOOT_MAX_IMG_SECTORS} * (3 * ${write_size})")
470+
else()
471+
set(boot_status_data_size 0)
472+
endif()
473+
474+
math(EXPR required_size "${key_size} + ${boot_magic_size} + ${boot_swap_data_size} + ${boot_status_data_size} + ${boot_tlv_estimate}")
475+
476+
align_up(${required_size} ${erase_size} required_size)
477+
478+
if(CONFIG_BOOT_SWAP_USING_MOVE)
479+
math(EXPR required_size "${required_size} + ${erase_size}")
480+
endif()
481+
else()
482+
set(required_size 0)
483+
endif()
484+
485+
set(mcuboot_image_footer_size ${required_size} CACHE INTERNAL "Estimated MCUboot image trailer size" FORCE)
486+
endif()

‎boot/zephyr/sysbuild/CMakeLists.txt

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
function(mathup num align result)
2+
math(EXPR out "(((${num}) + ((${align}) - 1)) & ~((${align}) - 1))")
3+
set(${result} "${out}" PARENT_SCOPE)
4+
endfunction()
5+
6+
function(${SYSBUILD_CURRENT_MODULE_NAME}_pre_image_cmake)
7+
cmake_parse_arguments(POST_IMAGE_CMAKE "" "IMAGE" "IMAGES" ${ARGN})
8+
9+
if(NOT "${POST_IMAGE_CMAKE_IMAGE}" STREQUAL "mcuboot")
10+
return()
11+
endif()
12+
13+
set_property(
14+
DIRECTORY APPEND PROPERTY
15+
CMAKE_CONFIGURE_DEPENDS
16+
${CMAKE_BINARY_DIR}/mcuboot/CMakeCache.txt
17+
${CMAKE_BINARY_DIR}/mcuboot/zephyr/.config
18+
)
19+
endfunction(${SYSBUILD_CURRENT_MODULE_NAME}_pre_image_cmake)
20+
21+
function(${SYSBUILD_CURRENT_MODULE_NAME}_post_image_cmake)
22+
cmake_parse_arguments(POST_IMAGE_CMAKE "" "IMAGE" "IMAGES" ${ARGN})
23+
24+
if(NOT "${POST_IMAGE_CMAKE_IMAGE}" STREQUAL "mcuboot")
25+
return()
26+
endif()
27+
28+
foreach(image ${IMAGES})
29+
set(app_type)
30+
get_property(app_type TARGET ${image} PROPERTY APP_TYPE)
31+
32+
if("${app_type}" STREQUAL "MAIN")
33+
sysbuild_get(mcuboot_image_footer_size IMAGE mcuboot CACHE)
34+
math(EXPR mcuboot_image_footer_size "${mcuboot_image_footer_size}" OUTPUT_FORMAT HEXADECIMAL)
35+
36+
set_property(TARGET ${image} APPEND_STRING PROPERTY CONFIG "CONFIG_ROM_END_OFFSET=${mcuboot_image_footer_size}\n")
37+
return()
38+
endif()
39+
endforeach()
40+
endfunction(${SYSBUILD_CURRENT_MODULE_NAME}_post_image_cmake)

‎zephyr/module.yml

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ samples:
22
- boot/zephyr
33
build:
44
cmake: ./boot/bootutil/zephyr
5+
sysbuild-cmake: boot/zephyr/sysbuild

0 commit comments

Comments
 (0)