boot: zephyr: boot/zephyr/include/ to zephyr/include/

In the Zephyr directory structure the module-level include is
located as a subdirectory of the module-level CMakeLists.txt.
For a general pattern suitable for extending existing repositories
the Zephyr directory structure must exist within the `zephyr/`
directory along with `module.yml`.  This is necessary to avoid
conflicts with existing repository directory structures and
build files.

Verified by:
1. Building `boot/zephyr` for mimxrt1064_evk and verifying
   that the zephyr image did not change in sizes.
2. Further verified that the following testcases still pass with
   mcuboot options on twister:
      mcuboot/boot/zephyr
      zephyr/tests/subsys/dfu
      zephyr/samples/subsys/mgmt/mcumgr/smp_svr

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

Author: legrand-gregshue

boot/bootutil/zephyr/CMakeLists.txt

@@ -8,9 +8,9 @@ if(CONFIG_MCUBOOT_BOOTUTIL_LIB)
 zephyr_interface_library_named(MCUBOOT_BOOTUTIL)
 
 zephyr_include_directories(MCUBOOT_BOOTUTIL INTERFACE
-  ../
-  ../include
-  ../../zephyr/include
+  ${ZEPHYR_MCUBOOT_MODULE_DIR}/boot/bootutil
+  ${ZEPHYR_MCUBOOT_MODULE_DIR}/boot/bootutil/include
+  ${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include
 )
 
 zephyr_library_named(mcuboot_util)
@@ -31,7 +31,7 @@ target_link_libraries(MCUBOOT_BOOTUTIL INTERFACE zephyr_interface)
 
 if(CONFIG_BOOT_USE_TINYCRYPT)
 target_include_directories(MCUBOOT_BOOTUTIL INTERFACE
-  ../../../ext/tinycrypt/lib/include
+  ${ZEPHYR_MCUBOOT_MODULE_DIR}/ext/tinycrypt/lib/include
 )
 endif()
 

boot/cypress/MCUBootApp/config/mcuboot_config/mcuboot_config.h

@@ -16,7 +16,7 @@
  *
  * For examples, see:
  *
- * boot/zephyr/include/mcuboot_config/mcuboot_config.h
+ * zephyr/include/mcuboot_config/mcuboot_config.h
  * boot/mynewt/mcuboot_config/include/mcuboot_config/mcuboot_config.h
  */
 /* Default maximum number of flash sectors per image slot; change

boot/zephyr/CMakeLists.txt

@@ -1,6 +1,7 @@
 # CMakeLists.txt for building mcuboot as a Zephyr project
 #
 # Copyright (c) 2017 Open Source Foundries Limited
+# Copyright (c) 2022 Legrand North America, LLC.
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -79,7 +80,7 @@ endif()
 endif()
 
 zephyr_library_include_directories(
-  include
+  ${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include
   targets
   )
 if(EXISTS targets/${BOARD}.h)
@@ -155,7 +156,7 @@ if(CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256 OR CONFIG_BOOT_ENCRYPT_EC256 OR CONFIG_
   if(CONFIG_BOOT_USE_TINYCRYPT)
   # When using ECDSA signatures, pull in our copy of the tinycrypt library.
   zephyr_library_include_directories(
-    ${BOOT_DIR}/zephyr/include
+    ${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include
     ${TINYCRYPT_DIR}/include
     )
   zephyr_include_directories(${TINYCRYPT_DIR}/include)
@@ -176,11 +177,11 @@ if(CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256 OR CONFIG_BOOT_ENCRYPT_EC256 OR CONFIG_
   # to set MBEDTLS_CONFIG_FILE ourselves. When using Zephyr's copy, this
   # variable is set by its Kconfig in the Zephyr codebase.
   zephyr_library_compile_definitions(
-    MBEDTLS_CONFIG_FILE="${CMAKE_CURRENT_LIST_DIR}/include/mcuboot-mbedtls-cfg.h"
+    MBEDTLS_CONFIG_FILE="${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include/mcuboot-mbedtls-cfg.h"
     )
 elseif(CONFIG_BOOT_SIGNATURE_TYPE_NONE)
   zephyr_library_include_directories(
-    ${BOOT_DIR}/zephyr/include
+    ${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include
     ${TINYCRYPT_DIR}/include
     )
 
@@ -191,7 +192,7 @@ elseif(CONFIG_BOOT_SIGNATURE_TYPE_NONE)
 elseif(CONFIG_BOOT_SIGNATURE_TYPE_RSA)
   # Use mbedTLS provided by Zephyr for RSA signatures. (Its config file
   # is set using Kconfig.)
-  zephyr_include_directories(include)
+  zephyr_include_directories(${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include)
   if(CONFIG_BOOT_ENCRYPT_RSA)
     set_source_files_properties(
       ${BOOT_DIR}/bootutil/src/encrypted.c
@@ -203,7 +204,7 @@ elseif(CONFIG_BOOT_SIGNATURE_TYPE_ED25519 OR CONFIG_BOOT_ENCRYPT_X25519)
   if(CONFIG_BOOT_USE_TINYCRYPT)
     zephyr_library_include_directories(
       ${MBEDTLS_ASN1_DIR}/include
-      ${BOOT_DIR}/zephyr/include
+      ${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include
       ${TINYCRYPT_DIR}/include
       ${TINYCRYPT_SHA512_DIR}/include
       )
@@ -216,14 +217,14 @@ elseif(CONFIG_BOOT_SIGNATURE_TYPE_ED25519 OR CONFIG_BOOT_ENCRYPT_X25519)
       ${MBEDTLS_ASN1_DIR}/src/platform_util.c
       )
     zephyr_library_compile_definitions(
-      MBEDTLS_CONFIG_FILE="${CMAKE_CURRENT_LIST_DIR}/include/mcuboot-mbedtls-cfg.h"
+      MBEDTLS_CONFIG_FILE="${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include/mcuboot-mbedtls-cfg.h"
       )
   else()
-    zephyr_include_directories(include)
+    zephyr_include_directories(${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include)
   endif()
 
   zephyr_library_include_directories(
-    ${BOOT_DIR}/zephyr/include
+    ${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include
     ${FIAT_DIR}/include/
   )
 
@@ -260,7 +261,7 @@ if(CONFIG_MCUBOOT_SERIAL)
 
   zephyr_include_directories(${BOOT_DIR}/bootutil/include)
   zephyr_include_directories(${BOOT_DIR}/boot_serial/include)
-  zephyr_include_directories(include)
+  zephyr_include_directories(${ZEPHYR_MCUBOOT_MODULE_DIR}/zephyr/include)
 
   zephyr_include_directories_ifdef(
     CONFIG_BOOT_ERASE_PROGRESSIVELY

docs/PORTING.md

@@ -64,7 +64,7 @@ by MCUboot. For example, Mynewt uses MYNEWT_VAL() and Zephyr uses
 Kconfig; these configuration systems are converted to MCUBOOT_ options
 in the following files:
 
-- boot/zephyr/include/mcuboot_config/mcuboot_config.h
+- zephyr/include/mcuboot_config/mcuboot_config.h
 - boot/mynewt/mcuboot_config/include/mcuboot_config/mcuboot_config.h
 
 ## Flash Map

docs/readme-zephyr.md

@@ -61,7 +61,7 @@ it as usual:
 In addition to the partitions defined in DTS, some additional
 information about the flash layout is currently required to build
 MCUboot itself. All the needed configuration is collected in
-`boot/zephyr/include/target.h`. Depending on the board, this information
+`zephyr/include/target.h`. Depending on the board, this information
 may come from board-specific headers, Device Tree, or be configured by
 MCUboot on a per-SoC family basis.
 

samples/mcuboot_config/mcuboot_config.template.h

@@ -17,7 +17,7 @@
  *
  * For examples, see:
  *
- * boot/zephyr/include/mcuboot_config/mcuboot_config.h
+ * zephyr/include/mcuboot_config/mcuboot_config.h
  * boot/mynewt/mcuboot_config/include/mcuboot_config/mcuboot_config.h
  */
 

sim/src/image.rs

@@ -141,7 +141,7 @@ impl ImagesBuilder {
         let mut slots = Vec::with_capacity(num_images);
         for image in 0..num_images {
             // This mapping must match that defined in
-            // `boot/zephyr/include/sysflash/sysflash.h`.
+            // `zephyr/include/sysflash/sysflash.h`.
             let id0 = match image {
                 0 => FlashId::Image0,
                 1 => FlashId::Image2,