[nrf noup] drivers/flashdisk: Add support for Partition Manager

The commits adds support for generating flash disks from Partition
Manager defined partitions.

Signed-off-by: Dominik Ermel <[email protected]>
(cherry picked from commit 6fba504)

Author: de-nordic

drivers/disk/flashdisk.c

@@ -420,6 +420,8 @@ static const struct disk_operations flash_disk_ops = {
 	.ioctl = disk_flash_access_ioctl,
 };
 
+#ifndef USE_PARTITION_MANAGER
+/* The non-Partition manager, DTS based generators below */
 #define DT_DRV_COMPAT zephyr_flash_disk
 
 #define PARTITION_PHANDLE(n) DT_PHANDLE_BY_IDX(DT_DRV_INST(n), partition, 0)
@@ -461,6 +463,82 @@ DT_INST_FOREACH_STATUS_OKAY(VERIFY_CACHE_SIZE_IS_NOT_ZERO_IF_NOT_READ_ONLY)
 		"Devicetree node " DT_NODE_PATH(DT_DRV_INST(n))				\
 		" has cache size which is not a multiple of its sector size");
 DT_INST_FOREACH_STATUS_OKAY(VERIFY_CACHE_SIZE_IS_MULTIPLY_OF_SECTOR_SIZE)
+#else /* ifndef USE_PARTITION_MANAGER */
+/* Partition Manager based generators below */
+
+/* Gets the PM_..._EXTRA_PARAM_##param value */
+#define PM_FLASH_DISK_ENTRY_EXTRA_PARAM(name, param) PM_##name##_EXTRA_PARAM_disk_##param
+
+/* Gets the PM_..._NAME value which is originally cased, as in yaml, partition name */
+#define PM_FLASH_DISK_ENTRY_PARTITION_NAME(name) PM_##name##_NAME
+
+/* Generates flashdiskN_cache variable name, where N is partition ID */
+#define PM_FLASH_DISK_CACHE_VARIABLE(n) UTIL_CAT(flashdisk, UTIL_CAT(FIXED_PARTITION_ID(n), _cache))
+
+/* Generate cache buffers */
+#define CACHE_SIZE(n) (COND_CODE_1(PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, read_only), (0), (1)) * \
+		       PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, cache_size))
+#define DEFINE_FLASHDISKS_CACHE(n) \
+	static uint8_t __aligned(4) PM_FLASH_DISK_CACHE_VARIABLE(n)[CACHE_SIZE(n)];
+
+PM_FOREACH_AFFILIATED_TO_disk(DEFINE_FLASHDISKS_CACHE)
+
+/* Generated single Flash Disk device data from Partition Manager partition.
+ * Partition is required to have type set to disk in partition definitions:
+ *  type: disk
+ * and following extra params can be provided:
+ *  extra_params: {
+ *	name = "<name>",
+ *	cache_size = <size>,
+ *	sector_size = <ssize>,
+ *	read_only = <ro>
+ *  }
+ * where:
+ *  <name> is mandatory device name that will be used by Disk Access and FAT FS to mount device;
+ *  <cache_size> is cache r/w cache size, which is mandatory if read_only = 0 or not present,
+ *  and should be multiple of <ssize>;
+ *  <ssize> is mandatory device sector size information, usually should be erase page size,
+ *  for flash devices, for example 4096 bytes;
+ *  read_only is optional, if not present then assumed false; <ro> can be 0(false) or 1(true).
+ */
+#define DEFINE_FLASHDISKS_DEVICE(n)						\
+{										\
+	.info = {								\
+		.ops = &flash_disk_ops,						\
+		.name = STRINGIFY(PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, name)),		\
+	},									\
+	.area_id = FIXED_PARTITION_ID(n),					\
+	.offset = FIXED_PARTITION_OFFSET(n),					\
+	.cache = PM_FLASH_DISK_CACHE_VARIABLE(n),				\
+	.cache_size = sizeof(PM_FLASH_DISK_CACHE_VARIABLE(n)),			\
+	.size = FIXED_PARTITION_SIZE(n),					\
+	.sector_size = PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, sector_size),		\
+},
+
+/* The bellow used PM_FOREACH_TYPE_disk is generated by Partition Manager foreach
+ * loop macro. The lower case _disk is type name for which the macro has been generated;
+ * partition entry can have multiple types set and foreach macro will be generated
+ * for every type found across partition definitions.
+ */
+static struct flashdisk_data flash_disks[] = {
+	PM_FOREACH_AFFILIATED_TO_disk(DEFINE_FLASHDISKS_DEVICE)
+};
+
+#define VERIFY_CACHE_SIZE_IS_NOT_ZERO_IF_NOT_READ_ONLY(n)				\
+	COND_CODE_1(PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, read_only),			\
+		(/* cache-size is not used for read-only disks */),			\
+		(BUILD_ASSERT(PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, cache_size) != 0,	\
+		"Flash disk partition " STRINGIFY(PM_FLASH_DISK_ENTRY_PARTITION_NAME(n))\
+		" must have non-zero cache-size");))
+PM_FOREACH_AFFILIATED_TO_disk(VERIFY_CACHE_SIZE_IS_NOT_ZERO_IF_NOT_READ_ONLY)
+
+#define VERIFY_CACHE_SIZE_IS_MULTIPLY_OF_SECTOR_SIZE(n)					\
+	BUILD_ASSERT(PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, cache_size) %			\
+		     PM_FLASH_DISK_ENTRY_EXTRA_PARAM(n, sector_size) == 0,		\
+		"Devicetree node " STRINGIFY(PM_FLASH_DISK_ENTRY_PARTITION_NAME(n))	\
+		" has cache size which is not a multiple of its sector size");
+PM_FOREACH_AFFILIATED_TO_disk(VERIFY_CACHE_SIZE_IS_MULTIPLY_OF_SECTOR_SIZE)
+#endif /* USE_PARTITION_MANAGER */
 
 static int disk_flash_init(void)
 {