New sample: mcuboot_external_config

Created a sample of how to configure MCUBoot build from an
external repository.  This sample provides no `main()` definition
and reuses all logic from MCUBoot and other repositories.  The
functionality matches the existing functionality of mcuboot/boot/zephyr.

NOTE: This commit required copying board and .conf files from
mcuboot/boot/zephyr because the _current_ zephyr build system
(about v3.2.0) does not fully support using APPLICATION_CONFIG_DIR
with a list of files/directories in CONF_FILE and with boards/
beneath those settings.  When APPLICATION_CONF_DIR was set to
reference mcuboot/boot/zephyr/ and CONF_FILE referenced
APPLICATION_CONFIG_DIR then here, the boot config did not pick
up a board-specific configuration setting from APPLICATION_CONFIG_DIR,
resulting in FLASH going from ~40000 to ~45000 bytes.

  This is captured in Zephyr Issue #51621.

Verification:

1. (Pass) west build -p always -b nrf52840dk_nrf52840 \
            mcuboot/zephyr/samples/mcuboot_external_config/
2. (Pass) ./zephyr/scripts/twister --testsuite-root mcuboot/zephyr/samples/

Fixes #1410

Signed-off-by: Gregory Shue <[email protected]>

Author: legrand-gregshue

zephyr/module.yml

@@ -5,6 +5,7 @@
 name: mcuboot
 samples:
   - boot/zephyr
+  - zephyr/samples
 build:
   cmake: ./zephyr
   kconfig: ./zephyr/Kconfig

zephyr/samples/mcuboot_external_config/CMakeLists.txt

@@ -0,0 +1,28 @@
+# Copyright (c) 2022 Legrand North America, LLC.
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+
+# Add a common dts overlay necessary to ensure mcuboot is linked into,
+# and fits inside, the boot partition. (If the user specified a
+# DTC_OVERLAY_FILE on the CMake command line, we need to append onto
+# the list).
+set(DTC_OVERLAY_FILE
+  "${DTC_OVERLAY_FILE};${CMAKE_CURRENT_LIST_DIR}/dts.overlay"
+  CACHE STRING "" FORCE
+  )
+
+# NOTE: ${ZEPHYR_MCUBOOT_MODULE_DIR} requires delayed evaluation,
+#   as it has not yet been defined.  Relative paths must be used at this point.
+include(${CMAKE_CURRENT_LIST_DIR}/../../cmake/mcuboot_zephyr_runner_mass_erase.cmake)
+
+# find_package(Zephyr) in order to load application boilerplate:
+# http://docs.zephyrproject.org/application/application.html
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(mcuboot_exernal_config)
+
+target_sources(app PRIVATE
+  keys.c
+  )
+
+include(${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/cmake/mcuboot_signature_key_file_generation.cmake)

zephyr/samples/mcuboot_external_config/README.rst

@@ -0,0 +1,30 @@
+.. _mcuboot_external_config:
+
+MCUBoot External Config
+#######################
+
+Overview
+********
+
+A simple sample illustrating how to configure from a different module
+an MCUBoot image, using local keys and certificates.
+
+NOTE: This references ${ZEPHYR_MCUBOOT_MODULE_DIR}/boot/zephyr
+for most configuration files for the verified set of boards.  Other
+board configuration files will need to be provided locally.
+
+Building and Running
+********************
+
+This application can be built and executed on QEMU as follows:
+
+.. code-block:: console
+
+  west build -b nrf52840dk_nrf52840 \
+    bootloader/mcuboot/samples/zephyr_external_config
+
+
+Sample Output
+=============
+
+None.

zephyr/samples/mcuboot_external_config/boards/actinius_icarus.conf

@@ -0,0 +1,8 @@
+# Disable Zephyr console
+CONFIG_CONSOLE=n
+
+# MCUBoot settings
+CONFIG_BOOT_MAX_IMG_SECTORS=256
+
+# MCUboot serial recovery
+CONFIG_MCUBOOT_SERIAL=y

zephyr/samples/mcuboot_external_config/boards/bl5340_dvk_cpuapp.conf

@@ -0,0 +1,6 @@
+CONFIG_MULTITHREADING=y
+# Enable QSPI (MX25R64) - Slot 1 in QSPI
+CONFIG_NORDIC_QSPI_NOR=y
+CONFIG_NORDIC_QSPI_NOR_FLASH_LAYOUT_PAGE_SIZE=4096
+CONFIG_NORDIC_QSPI_NOR_STACK_WRITE_BUFFER_SIZE=4
+CONFIG_BOOT_MAX_IMG_SECTORS=256

zephyr/samples/mcuboot_external_config/boards/circuitdojo_feather_nrf9160.conf

@@ -0,0 +1,16 @@
+# Disable Zephyr console
+CONFIG_CONSOLE=n
+
+# Multithreading
+CONFIG_MULTITHREADING=y
+
+# MCUBoot settings
+CONFIG_BOOT_MAX_IMG_SECTORS=256
+
+# MCUboot serial recovery
+CONFIG_MCUBOOT_SERIAL=y
+CONFIG_BOOT_SERIAL_DETECT_DELAY=450
+CONFIG_MCUBOOT_INDICATION_LED=y
+
+# Size of mcuboot partition
+CONFIG_SIZE_OPTIMIZATIONS=y

zephyr/samples/mcuboot_external_config/boards/conexio_stratus.conf

@@ -0,0 +1,21 @@
+# Disable Zephyr console
+CONFIG_CONSOLE=n
+CONFIG_CONSOLE_HANDLER=n
+CONFIG_UART_CONSOLE=n
+
+# Multithreading
+CONFIG_MULTITHREADING=y
+
+# MCUBoot settings
+CONFIG_BOOT_MAX_IMG_SECTORS=256
+
+# MCUboot serial recovery
+CONFIG_MCUBOOT_SERIAL=y
+CONFIG_BOOT_SERIAL_DETECT_PORT="GPIO_0"
+CONFIG_BOOT_SERIAL_DETECT_PIN=12
+CONFIG_BOOT_SERIAL_DETECT_PIN_VAL=0
+CONFIG_BOOT_SERIAL_DETECT_DELAY=450
+CONFIG_MCUBOOT_INDICATION_LED=y
+
+# Size of mcuboot partition
+CONFIG_SIZE_OPTIMIZATIONS=y

zephyr/samples/mcuboot_external_config/boards/disco_l475_iot1.conf

@@ -0,0 +1,2 @@
+CONFIG_BOOT_MAX_IMG_SECTORS=256
+CONFIG_WATCHDOG=y

zephyr/samples/mcuboot_external_config/boards/flash_sim_driver.conf

@@ -0,0 +1,2 @@
+CONFIG_FLASH_SIMULATOR=y
+CONFIG_FLASH_SIMULATOR_UNALIGNED_READ=y

zephyr/samples/mcuboot_external_config/boards/frdm_k64f.conf

@@ -0,0 +1 @@
+CONFIG_WATCHDOG=y