[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'.

Leverage label translation to avoid patching partition names.

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

This is a long-running out of tree patch which has been worked on by
several people. The following sign-offs are in alphabetical order by
first name.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
Signed-off-by: Håkon Øye Amundsen <haakon.amundsen@nordicsemi.no>
Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
Signed-off-by: Ole Sæther <ole.saether@nordicsemi.no>
Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
Signed-off-by: Sigvart Hovland <sigvart.hovland@nordicsemi.no>
Signed-off-by: Thomas Stenersen <thomas.stenersen@nordicsemi.no>
Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
Signed-off-by: Øyvind Rønningstad <oyvind.ronningstad@nordicsemi.no>
Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
(cherry picked from commit 32b99c7)
(cherry picked from commit 30f63cb)
(cherry picked from commit c1017afdf66982c039dc6d77d21b9d4fba477abc)
(cherry picked from commit 1be5e92)
(cherry picked from commit 91edf7b)

Author: sigvartmh

Kconfig.zephyr

@@ -120,9 +120,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/modules/kernel.cmake

@@ -238,3 +238,7 @@ if("${CMAKE_EXTRA_GENERATOR}" STREQUAL "Eclipse CDT4")
   include(${ZEPHYR_BASE}/cmake/ide/eclipse_cdt4_generator_amendment.cmake)
   eclipse_cdt4_generator_amendment(1)
 endif()
+
+if(ZEPHYR_NRF_MODULE_DIR)
+  include(${ZEPHYR_NRF_MODULE_DIR}/cmake/partition_manager.cmake)
+endif()

drivers/flash/soc_flash_nrf.c

@@ -37,6 +37,11 @@ LOG_MODULE_REGISTER(flash_nrf);
 
 #define SOC_NV_FLASH_NODE DT_INST(0, soc_nv_flash)
 
+#if CONFIG_TRUSTED_EXECUTION_NONSECURE && USE_PARTITION_MANAGER
+#include <soc_secure.h>
+#include <pm_config.h>
+#endif /* CONFIG_TRUSTED_EXECUTION_NONSECURE && USE_PARTITION_MANAGER */
+
 #ifndef CONFIG_SOC_FLASH_NRF_RADIO_SYNC_NONE
 #define FLASH_SLOT_WRITE     7500
 #if defined(CONFIG_SOC_FLASH_NRF_PARTIAL_ERASE)
@@ -137,6 +142,12 @@ static int flash_nrf_read(const struct device *dev, off_t addr,
 		return 0;
 	}
 
+#if CONFIG_TRUSTED_EXECUTION_NONSECURE && USE_PARTITION_MANAGER && PM_APP_ADDRESS
+	if (addr < PM_APP_ADDRESS) {
+		return soc_secure_mem_read(data, (void *)addr, len);
+	}
+#endif
+
 	memcpy(data, (void *)addr, len);
 
 	return 0;

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

@@ -27,6 +27,35 @@
 #define RAMABLE_REGION SRAM
 #endif
 
+#if USE_PARTITION_MANAGER
+
+#include <pm_config.h>
+
+#if CONFIG_NCS_IS_VARIANT_IMAGE
+/* 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;
+
+#else /* ! CONFIG_NCS_IS_VARIANT_IMAGE */
+
+#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 */
+
+#endif /* CONFIG_NCS_IS_VARIANT_IMAGE */
+
+#define ROM_ADDR PM_ADDRESS
+#define ROM_SIZE PM_SIZE
+
+#define RAM_SIZE PM_SRAM_SIZE
+#define RAM_ADDR PM_SRAM_ADDRESS
+
+#else /* ! USE_PARTITION_MANAGER */
+
 #if !defined(CONFIG_XIP) && (CONFIG_FLASH_SIZE == 0)
 #define ROM_ADDR RAM_ADDR
 #else
@@ -53,6 +82,23 @@
 #define RAM_ADDR CONFIG_SRAM_BASE_ADDRESS
 #endif
 
+#endif /* USE_PARTITION_MANAGER */
+
+#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_ccm), okay)
+#define CCM_SIZE DT_REG_SIZE(DT_CHOSEN(zephyr_ccm))
+#define CCM_ADDR DT_REG_ADDR(DT_CHOSEN(zephyr_ccm))
+#endif
+
+#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_itcm), okay)
+#define ITCM_SIZE DT_REG_SIZE(DT_CHOSEN(zephyr_itcm))
+#define ITCM_ADDR DT_REG_ADDR(DT_CHOSEN(zephyr_itcm))
+#endif
+
+#if DT_NODE_HAS_STATUS(DT_CHOSEN(zephyr_dtcm), okay)
+#define DTCM_SIZE DT_REG_SIZE(DT_CHOSEN(zephyr_dtcm))
+#define DTCM_ADDR DT_REG_ADDR(DT_CHOSEN(zephyr_dtcm))
+#endif
+
 #if defined(CONFIG_CUSTOM_SECTION_ALIGN)
 _region_min_align = CONFIG_CUSTOM_SECTION_MIN_ALIGN_SIZE;
 #else

include/zephyr/storage/flash_map.h

@@ -256,6 +256,10 @@ const struct device *flash_area_get_device(const struct flash_area *fa);
  */
 uint8_t flash_area_erased_val(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)
 
@@ -281,6 +285,9 @@ uint8_t flash_area_erased_val(const struct flash_area *fa);
 #define FLASH_AREA_DEVICE(label) \
 	DEVICE_DT_GET(DT_MTD_FROM_FIXED_PARTITION(DT_NODE_BY_FIXED_PARTITION_LABEL(label)))
 
+
+#endif /* USE_PARTITION_MANAGER */
+
 #ifdef __cplusplus
 }
 #endif

soc/arm/common/cortex_m/arm_mpu_regions.c

@@ -9,6 +9,9 @@
 #include <linker/devicetree_regions.h>
 
 #include "arm_mpu_mem_cfg.h"
+#if USE_PARTITION_MANAGER
+#include <pm_config.h>
+#endif
 
 static const struct arm_mpu_region mpu_regions[] = {
 	/* Region 0 */
@@ -22,6 +25,14 @@ static const struct arm_mpu_region mpu_regions[] = {
 #endif
 	/* Region 1 */
 	MPU_REGION_ENTRY("SRAM_0",
+#if USE_PARTITION_MANAGER
+			 PM_SRAM_ADDRESS,
+#if defined(CONFIG_ARMV8_M_BASELINE) || defined(CONFIG_ARMV8_M_MAINLINE)
+			 REGION_RAM_ATTR(PM_SRAM_ADDRESS, PM_SRAM_SIZE)),
+#else
+			 REGION_RAM_ATTR(REGION_SRAM_SIZE)),
+#endif
+#else
 			 CONFIG_SRAM_BASE_ADDRESS,
 #if defined(CONFIG_ARMV8_M_BASELINE) || defined(CONFIG_ARMV8_M_MAINLINE)
 			 REGION_RAM_ATTR(CONFIG_SRAM_BASE_ADDRESS, \
@@ -30,6 +41,8 @@ static const struct arm_mpu_region mpu_regions[] = {
 			 REGION_RAM_ATTR(REGION_SRAM_SIZE)),
 #endif
 
+#endif /* USE_PARTITION_MANAGER */
+
 	/* DT-defined regions */
 	LINKER_DT_REGION_MPU(ARM_MPU_REGION_INIT)
 };

subsys/fs/littlefs_fs.c

@@ -902,6 +902,12 @@ static const struct fs_file_system_t littlefs_fs = {
 	.statvfs = littlefs_statvfs,
 };
 
+#ifdef USE_PARTITION_MANAGER
+#define _LFS_USE_NCS_PM 1
+#else
+#define _LFS_USE_NCS_PM 0
+#endif
+
 #define DT_DRV_COMPAT zephyr_fstab_littlefs
 #define FS_PARTITION(inst) DT_PHANDLE_BY_IDX(DT_DRV_INST(inst), partition, 0)
 #define FS_PARTITION_LABEL(inst) DT_STRING_TOKEN(FS_PARTITION(inst), label)
@@ -937,7 +943,11 @@ struct fs_mount_t FS_FSTAB_ENTRY(DT_DRV_INST(inst)) = { \
 	.type = FS_LITTLEFS, \
 	.mnt_point = DT_INST_PROP(inst, mount_point), \
 	.fs_data = &fs_data_##inst, \
-	.storage_dev = (void *)FLASH_AREA_ID(FS_PARTITION_LABEL(inst)), \
+	.storage_dev = (void *) (_LFS_USE_NCS_PM ?\
+	  COND_CODE_1(FLASH_AREA_LABEL_EXISTS(littlefs_storage), \
+		      (FLASH_AREA_ID(littlefs_storage)), \
+		      (FLASH_AREA_ID(storage))) :\
+	  FLASH_AREA_ID(FS_PARTITION_LABEL(inst))), \
 	.flags = FSTAB_ENTRY_DT_MOUNT_FLAGS(DT_DRV_INST(inst)), \
 };
 

subsys/ipc/rpmsg_service/rpmsg_backend.h

@@ -13,8 +13,35 @@
 extern "C" {
 #endif
 
+#if CONFIG_PARTITION_MANAGER_ENABLED
+
+#include "pm_config.h"
+
+#if defined(PM_RPMSG_NRF53_SRAM_ADDRESS) || defined(PM__RPMSG_NRF53_SRAM_ADDRESS)
+
+#if defined(PM_RPMSG_NRF53_SRAM_ADDRESS)
+#define VDEV_START_ADDR PM_RPMSG_NRF53_SRAM_ADDRESS
+#define VDEV_SIZE PM_RPMSG_NRF53_SRAM_SIZE
+#else
+/* The current image is a child image in a different domain than the image
+ * which defined the required values. To reach the values of the parent domain
+ * we use the 'PM__' variant of the define.
+ */
+#define VDEV_START_ADDR PM__RPMSG_NRF53_SRAM_ADDRESS
+#define VDEV_SIZE PM__RPMSG_NRF53_SRAM_SIZE
+#endif /* defined(PM_RPMSG_NRF53_SRAM_ADDRESS) */
+
+#else
 #define VDEV_START_ADDR		CONFIG_RPMSG_SERVICE_SHM_BASE_ADDRESS
 #define VDEV_SIZE		    CONFIG_RPMSG_SERVICE_SHM_SIZE
+#endif /* defined(PM_RPMSG_NRF53_SRAM_ADDRESS) || defined(PM__RPMSG_NRF53_SRAM_ADDRESS) */
+
+#else
+
+#define VDEV_START_ADDR		CONFIG_RPMSG_SERVICE_SHM_BASE_ADDRESS
+#define VDEV_SIZE		    CONFIG_RPMSG_SERVICE_SHM_SIZE
+
+#endif /* CONFIG_PARTITION_MANAGER_ENABLED */
 
 #define VDEV_STATUS_ADDR	VDEV_START_ADDR
 #define VDEV_STATUS_SIZE	0x400