Commit 879d4ce7 authored by Daniel DeGrasse's avatar Daniel DeGrasse Committed by Fabio Baltieri
Browse files

modules: mcuboot: add Kconfigs for RAMLOAD_WITH_REVERT mode 



Add Kconfigs for RAMLOAD_WITH_REVERT mode in MCUBoot. This mode works in
a manner similar to DIRECT_XIP_WITH_REVERT- namely, mcuboot will only
boot an image that is either confirmed or marked as pending. If both
images are confirmed, mcuboot will still select the one with the higher
version, so downgrading is not possible using this mode.

Signed-off-by: default avatarDaniel DeGrasse <ddegrasse@tenstorrent.com>
parent ace8207f

cmake/mcuboot.cmake

+3 −3
Original line number Diff line number Diff line
@@ -121,7 +121,7 @@ function(zephyr_mcuboot_tasks) 
  if(CONFIG_MCUBOOT_IMGTOOL_OVERWRITE_ONLY)

    # Use overwrite-only instead of swap upgrades.

    set(imgtool_args --overwrite-only --align 1 ${imgtool_args})

  elseif(CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD)

  elseif(CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD OR CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD_WITH_REVERT)

    # RAM load requires setting the location of where to load the image to

    dt_chosen(chosen_ram PROPERTY "zephyr,sram")

    dt_reg_addr(chosen_ram_address PATH ${chosen_ram})
@@ -197,7 +197,7 @@ function(zephyr_mcuboot_tasks) 
                   ${output}.signed.encrypted.bin)

    endif()



    if(CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD)

    if(CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD OR CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD_WITH_REVERT)

      list(APPEND byproducts ${output}.slot1.signed.encrypted.bin)

      set_property(GLOBAL APPEND PROPERTY extra_post_build_commands COMMAND

                   ${imgtool_sign} ${imgtool_args_alt_slot} ${output}.bin
@@ -260,7 +260,7 @@ function(zephyr_mcuboot_tasks) 
                   ${output}.signed.encrypted.hex)

    endif()



    if(CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD)

    if(CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD OR CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD_WITH_REVERT)

      list(APPEND byproducts ${output}.slot1.signed.hex)

      set_property(GLOBAL APPEND PROPERTY extra_post_build_commands COMMAND

                   ${imgtool_sign} ${imgtool_args_alt_slot} ${output}.hex

modules/Kconfig.mcuboot

+22 −0
Original line number Diff line number Diff line
@@ -211,6 +211,28 @@ config MCUBOOT_BOOTLOADER_MODE_RAM_LOAD 
	  This option automatically selects MCUBOOT_BOOTLOADER_NO_DOWNGRADE as it is not possible

	  to swap back to older version of the application.



config MCUBOOT_BOOTLOADER_MODE_RAM_LOAD_WITH_REVERT

	bool "MCUboot has been configured for RAM LOAD with revert"

	select MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE

	select MCUBOOT_BOOTLOADER_NO_DOWNGRADE

	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.

	  This option automatically selectes MCUBOOT_BOOTLOADER_NO_DOWNGRADE as

	  MCUBoot will automatically select the highest revision of the application

	  to boot. Note however that MCUBoot will select an older revision of

	  the application if the booted revision does not mark itself as confirmed.

	  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. Note that in this mode MCUboot will not boot an

	  application if it does not have an image header, so if an application

	  is flashed manually it should be marked as confirmed



config MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP

	bool "MCUboot has been configured for DirectXIP operation"

	select MCUBOOT_BOOTLOADER_MODE_HAS_NO_DOWNGRADE

share/sysbuild/image_configurations/BOOTLOADER_image_default.cmake

+7 −1
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ 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)

elseif(SB_CONFIG_MCUBOOT_MODE_RAM_LOAD OR SB_CONFIG_MCUBOOT_MODE_RAM_LOAD_WITH_REVERT)

  set(bootmode CONFIG_BOOT_RAM_LOAD)

elseif(SB_CONFIG_MCUBOOT_MODE_SINGLE_APP_RAM_LOAD)

  set(bootmode CONFIG_SINGLE_APPLICATION_SLOT_RAM_LOAD)
@@ -56,6 +56,12 @@ else() 
  set_config_bool(${ZCMAKE_APPLICATION} CONFIG_BOOT_DIRECT_XIP_REVERT n)

endif()



if(SB_CONFIG_MCUBOOT_MODE_RAM_LOAD_WITH_REVERT)

  set_config_bool(${ZCMAKE_APPLICATION} CONFIG_BOOT_RAM_LOAD_REVERT y)

else()

  set_config_bool(${ZCMAKE_APPLICATION} CONFIG_BOOT_RAM_LOAD_REVERT n)

endif()



set(keytypes CONFIG_BOOT_SIGNATURE_TYPE_NONE

             CONFIG_BOOT_SIGNATURE_TYPE_RSA

             CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256

share/sysbuild/image_configurations/MAIN_image_default.cmake

+5 −0
Original line number Diff line number Diff line
@@ -39,6 +39,11 @@ if(SB_CONFIG_BOOTLOADER_MCUBOOT) 
    set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD y)

    set_config_bool(${ZCMAKE_APPLICATION} CONFIG_XIP n)

    set_config_int(${ZCMAKE_APPLICATION} CONFIG_FLASH_SIZE 0)

  elseif(SB_CONFIG_MCUBOOT_MODE_RAM_LOAD_WITH_REVERT)

    # RAM load mode requires XIP be disabled and flash size be set to 0

    set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_RAM_LOAD_WITH_REVERT y)

    set_config_bool(${ZCMAKE_APPLICATION} CONFIG_XIP n)

    set_config_int(${ZCMAKE_APPLICATION} CONFIG_FLASH_SIZE 0)

  elseif(SB_CONFIG_MCUBOOT_MODE_SINGLE_APP_RAM_LOAD)

    set_config_bool(${ZCMAKE_APPLICATION} CONFIG_MCUBOOT_BOOTLOADER_MODE_SINGLE_APP_RAM_LOAD y)

  elseif(SB_CONFIG_MCUBOOT_MODE_FIRMWARE_UPDATER)

share/sysbuild/images/bootloader/Kconfig

+14 −0
Original line number Diff line number Diff line
@@ -120,6 +120,20 @@ config MCUBOOT_MODE_RAM_LOAD 
	  Note: RAM must be assigned to the bootloader that is not used by the application in this

	  mode so that the bootloader is able to function until the application has booted.



config MCUBOOT_MODE_RAM_LOAD_WITH_REVERT

	bool "RAM load with revert"

	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. MCUBoot will only boot an image if 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. 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.



	  Note: RAM must be assigned to the bootloader that is not used by the application in this

	  mode so that the bootloader is able to function until the application has booted.



config MCUBOOT_MODE_FIRMWARE_UPDATER

	bool "Firmware updater"

	help

CRA Git | Maintained and supported by SUSTech CRA and CCSE