[nrf noup] tree-wide: support NCS Partition Manager (PM) definitions

Partition Manager (PM) is a component of the nRF Connect SDK (NCS)
which uses yaml files to resolve flash partition placement with a
holistic view of the entire device, including each firmware image
present on the flash device, and various subsystems, such as settings
and NFFS.

When this NCS extension is used, various source files which would use
partition information from devicetree in "vanilla" zephyr instead use
defines generated by PM instead.

This commit removes support for HEX_FILES_TO_MERGE, as it conflicts
with PM.

The settings subsystem pm.yml defines a partition 'settings_storage'.
The nffs subsystem pm.yml defines 'nffs_storage'.

Refer to the NCS documentation page for this feature for more details.

Signed-off-by: Håkon Øye Amundsen <[email protected]>
Signed-off-by: Øyvind Rønningstad <[email protected]>
Signed-off-by: Sigvart Hovland <[email protected]>
Signed-off-by: Sebastian Bøe <[email protected]>
Signed-off-by: Andrzej Puzdrowski <[email protected]>
Signed-off-by: Robert Lubos <[email protected]>
Signed-off-by: Dominik Ermel <[email protected]>
Signed-off-by: Torsten Rasmussen <[email protected]>
Signed-off-by: Martí Bolívar <[email protected]>
Signed-off-by: Thomas Stenersen <[email protected]>
Signed-off-by: Andrzej Głąbek <[email protected]>
Signed-off-by: Joakim Andersson <[email protected]>
(cherry picked from commit 1fb3734,
with conflicts resolved in Kconfig.zephyr to account for the
TEXT_SECTION_OFFSET rename)
(cherry picked from commit f4aa2ea)

Author: sigvartmh

CMakeLists.txt

@@ -1099,6 +1099,10 @@ set(logical_target_for_zephyr_elf ${logical_target_for_zephyr_elf} PARENT_SCOPE)
 # 2. it can be defined in Kconfig
 set_target_properties(${logical_target_for_zephyr_elf} PROPERTIES OUTPUT_NAME ${KERNEL_NAME})
 
+if (ZEPHYR_NRF_MODULE_DIR)
+  include(${ZEPHYR_NRF_MODULE_DIR}/cmake/s1.cmake)
+endif()
+
 set(post_build_commands "")
 set(post_build_byproducts "")
 

Kconfig.zephyr

@@ -119,9 +119,7 @@ config FLASH_LOAD_SIZE
 endif # HAS_FLASH_LOAD_OFFSET
 
 config ROM_START_OFFSET
-	hex
-	prompt "ROM start offset" if !BOOTLOADER_MCUBOOT
-	default 0x200 if BOOTLOADER_MCUBOOT
+	hex "ROM start offset"
 	default 0
 	help
 	  If the application is built for chain-loading by a bootloader this

cmake/app/boilerplate.cmake

@@ -595,6 +595,10 @@ set_property(TARGET app PROPERTY ARCHIVE_OUTPUT_DIRECTORY app)
 
 add_subdirectory(${ZEPHYR_BASE} ${__build_dir})
 
+if(ZEPHYR_NRF_MODULE_DIR)
+  include(${ZEPHYR_NRF_MODULE_DIR}/cmake/partition_manager.cmake)
+endif()
+
 # Link 'app' with the Zephyr interface libraries.
 #
 # NB: This must be done in boilerplate.cmake because 'app' can only be

drivers/flash/soc_flash_nrf.c

@@ -30,6 +30,13 @@
 
 #define SOC_NV_FLASH_NODE DT_INST(0, soc_nv_flash)
 
+#if CONFIG_ARM_NONSECURE_FIRMWARE && CONFIG_SPM
+#include <secure_services.h>
+#if USE_PARTITION_MANAGER
+#include <pm_config.h>
+#endif /* USE_PARTITION_MANAGER */
+#endif /* CONFIG_ARM_NONSECURE_FIRMWARE  && CONFIG_SPM */
+
 #if defined(CONFIG_SOC_FLASH_NRF_RADIO_SYNC)
 #include <sys/__assert.h>
 #include <bluetooth/hci.h>
@@ -185,6 +192,12 @@ static int flash_nrf_read(struct device *dev, off_t addr,
 		return 0;
 	}
 
+#if CONFIG_ARM_NONSECURE_FIRMWARE && CONFIG_SPM && USE_PARTITION_MANAGER
+	if (addr < PM_APP_ADDRESS) {
+		return spm_request_read(data, addr, len);
+	}
+#endif
+
 	memcpy(data, (void *)addr, len);
 
 	return 0;

include/arch/arm/aarch32/cortex_m/scripts/linker.ld

@@ -33,6 +33,31 @@
 #define _DATA_IN_ROM
 #endif
 
+#if USE_PARTITION_MANAGER
+#include <pm_config.h>
+
+#ifdef LINK_INTO_s1
+/* We are linking against S1, create symbol containing the flash ID of S0.
+ * This is used when writing code operating on the "other" slot.
+ */
+_image_1_primary_slot_id = PM_S0_ID;
+
+#define ROM_ADDR PM_ADDRESS + PM_S1_ADDRESS - PM_S0_ADDRESS
+
+#else /* ! LINK_INTO_s1 */
+
+#ifdef PM_S1_ID
+/* We are linking against S0, create symbol containing the flash ID of S1.
+ * This is used when writing code operating on the "other" slot.
+ */
+_image_1_primary_slot_id = PM_S1_ID;
+#endif /* PM_S1_ID */
+
+#define ROM_ADDR PM_ADDRESS
+#endif /* LINK_MCUBOOT_INTO_s1 */
+#define ROM_SIZE PM_SIZE
+#else
+
 #if !defined(CONFIG_XIP) && (CONFIG_FLASH_SIZE == 0)
 #define ROM_ADDR RAM_ADDR
 #else
@@ -49,8 +74,9 @@
 #define ROM_SIZE CONFIG_FLASH_LOAD_SIZE
 #else
 #define ROM_SIZE (CONFIG_FLASH_SIZE*1K - CONFIG_FLASH_LOAD_OFFSET)
-#endif
-#endif
+#endif /* CONFIG_FLASH_LOAD_SIZE > 0 */
+#endif /* CONFIG_HAS_TI_CCFG */
+#endif /* USE_PARTITION_MANAGER */
 
 #if defined(CONFIG_XIP)
 #if defined(CONFIG_IS_BOOTLOADER)

include/storage/flash_map.h

@@ -209,6 +209,10 @@ int flash_area_has_driver(const struct flash_area *fa);
  */
 struct device *flash_area_get_device(const struct flash_area *fa);
 
+#if USE_PARTITION_MANAGER
+#include <flash_map_pm.h>
+#else
+
 #define FLASH_AREA_LABEL_EXISTS(label) \
 	DT_HAS_FIXED_PARTITION_LABEL(label)
 
@@ -221,6 +225,8 @@ struct device *flash_area_get_device(const struct flash_area *fa);
 #define FLASH_AREA_SIZE(label) \
 	DT_REG_SIZE(DT_NODE_BY_FIXED_PARTITION_LABEL(label))
 
+#endif /* USE_PARTITION_MANAGER */
+
 #ifdef __cplusplus
 }
 #endif

subsys/dfu/boot/mcuboot.c

@@ -72,6 +72,17 @@ struct mcuboot_v1_raw_header {
 #define FLASH_MIN_WRITE_SIZE \
 	DT_PROP(DT_CHOSEN(zephyr_flash), write_block_size)
 
+#if USE_PARTITION_MANAGER
+#include <pm_config.h>
+
+#define FLASH_AREA_IMAGE_PRIMARY    PM_MCUBOOT_PRIMARY_ID
+#define FLASH_AREA_IMAGE_SECONDARY  PM_MCUBOOT_SECONDARY_ID
+#ifdef PM_MCUBOOT_SCRATCH_ID
+#define FLASH_AREA_IMAGE_SCRATCH    PM_MCUBOOT_SCRATCH_ID
+#endif
+
+#else
+
 /* FLASH_AREA_ID() values used below are auto-generated by DT */
 #ifdef CONFIG_TRUSTED_EXECUTION_NONSECURE
 #define FLASH_AREA_IMAGE_PRIMARY FLASH_AREA_ID(image_0_nonsecure)
@@ -85,6 +96,8 @@ struct mcuboot_v1_raw_header {
 #define FLASH_AREA_IMAGE_SCRATCH FLASH_AREA_ID(image_scratch)
 #endif
 
+#endif /* USE_PARTITION_MANAGER */
+
 #ifdef CONFIG_MCUBOOT_TRAILER_SWAP_TYPE
 #define SWAP_TYPE_OFFS(bank_area) ((bank_area)->fa_size -\
 				   BOOT_MAGIC_SZ - BOOT_MAX_ALIGN * 3)

subsys/dfu/img_util/flash_img.c

@@ -17,13 +17,22 @@
 #endif
 
 #include <devicetree.h>
+
+#if USE_PARTITION_MANAGER
+
+#include <pm_config.h>
+#define FLASH_AREA_IMAGE_SECONDARY  PM_MCUBOOT_SECONDARY_ID
+#else
+
 /* FLASH_AREA_ID() values used below are auto-generated by DT */
 #ifdef CONFIG_TRUSTED_EXECUTION_NONSECURE
 #define FLASH_AREA_IMAGE_SECONDARY FLASH_AREA_ID(image_1_nonsecure)
 #else
 #define FLASH_AREA_IMAGE_SECONDARY FLASH_AREA_ID(image_1)
 #endif /* CONFIG_TRUSTED_EXECUTION_NONSECURE */
 
+#endif /* USE_PARTITION_MANAGER */
+
 #define FLASH_WRITE_BLOCK_SIZE \
 	DT_PROP(DT_CHOSEN(zephyr_flash), write_block_size)
 

subsys/storage/flash_map/flash_map_default.c

@@ -10,6 +10,35 @@
 #include <zephyr.h>
 #include <storage/flash_map.h>
 
+#if USE_PARTITION_MANAGER
+
+/**
+ * Have flash_map_default use Partition Manager information instead of
+ * DeviceTree information when we are using the Partition Manager.
+ */
+
+#include <pm_config.h>
+#include <sys/util.h>
+
+#define FLASH_MAP_OFFSET(i) UTIL_CAT(PM_, UTIL_CAT(PM_##i##_LABEL, _ADDRESS))
+#define FLASH_MAP_DEV(i)    UTIL_CAT(PM_, UTIL_CAT(PM_##i##_LABEL, _DEV_NAME))
+#define FLASH_MAP_SIZE(i)   UTIL_CAT(PM_, UTIL_CAT(PM_##i##_LABEL, _SIZE))
+#define FLASH_MAP_NUM       PM_NUM
+
+#define FLASH_AREA_FOO(i, _)                \
+	{                                       \
+		.fa_id       = i,                   \
+		.fa_off      = FLASH_MAP_OFFSET(i), \
+		.fa_dev_name = FLASH_MAP_DEV(i),    \
+		.fa_size     = FLASH_MAP_SIZE(i)    \
+	},
+
+const struct flash_area default_flash_map[] = {
+	UTIL_LISTIFY(FLASH_MAP_NUM, FLASH_AREA_FOO, ~)
+};
+
+#else
+
 /* Get the grand parent of a node */
 #define GPARENT(node_id) DT_PARENT(DT_PARENT(node_id))
 
@@ -50,5 +79,7 @@ const struct flash_area default_flash_map[] = {
 	DT_INST_FOREACH_STATUS_OKAY(FOREACH_PARTION)
 };
 
+#endif /* USE_PARTITION_MANAGER */
+
 const int flash_map_entries = ARRAY_SIZE(default_flash_map);
 const struct flash_area *flash_map = default_flash_map;