[nrf fromlist] storage: Allow to use subpartitions in flash_map

Allow to use both partition and subpartition names when suing the
flash_map API.
That way it is possible to introduce a hierarchy within DTS in a
backward compatible way.

Upstream PR #: 96808

Signed-off-by: Tomasz Chyrowicz <[email protected]>

Author: tomchy

include/zephyr/storage/flash_map.h

@@ -353,14 +353,17 @@ uint8_t flash_area_erased_val(const struct flash_area *fa);
 #else
 
 /**
- * Returns non-0 value if fixed-partition of given DTS node label exists.
+ * Returns non-0 value if fixed-partition as well as fixed-subpartition of given
+ * DTS node label exists.
  *
  * @param label DTS node label
  *
  * @return non-0 if fixed-partition node exists and is enabled;
  *	   0 if node does not exist, is not enabled or is not fixed-partition.
  */
-#define FIXED_PARTITION_EXISTS(label) DT_FIXED_PARTITION_EXISTS(DT_NODELABEL(label))
+#define FIXED_PARTITION_EXISTS(label) \
+	UTIL_OR(DT_FIXED_PARTITION_EXISTS(DT_NODELABEL(label)), \
+		DT_FIXED_SUBPARTITION_EXISTS(DT_NODELABEL(label)))
 
 /**
  * Get flash area ID from fixed-partition DTS node label
@@ -372,14 +375,40 @@ uint8_t flash_area_erased_val(const struct flash_area *fa);
 #define FIXED_PARTITION_ID(label) DT_FIXED_PARTITION_ID(DT_NODELABEL(label))
 
 /**
- * Get fixed-partition offset from DTS node label
+ * Get fixed-partition as well as fixed-subpartition offset from DTS node label
  *
  * @param label DTS node label of a partition
  *
  * @return fixed-partition offset, as defined for the partition in DTS.
  */
 #define FIXED_PARTITION_OFFSET(label) DT_REG_ADDR(DT_NODELABEL(label))
 
+/**
+ * Get fixed-partition as well as fixed-subpartition address from DTS node label
+ *
+ * @param label DTS node label of a partition or subpartition
+ *
+ * @return fixed-partition address, as defined for the partition in DTS.
+ */
+#define FIXED_PARTITION_ADDRESS(label) \
+	(DT_REG_ADDR(DT_NODELABEL(label)) + \
+	 COND_CODE_1(DT_FIXED_SUBPARTITION_EXISTS(DT_NODELABEL(label)), \
+		(DT_REG_ADDR(DT_GPARENT(DT_PARENT(DT_NODELABEL(label))))), \
+		(DT_REG_ADDR(DT_GPARENT(DT_NODELABEL(label))))))
+
+/**
+ * Get fixed-partition as well as fixed-subpartition address from DTS node
+ *
+ * @param node DTS node of a partition
+ *
+ * @return fixed-partition address, as defined for the partition in DTS.
+ */
+#define FIXED_PARTITION_NODE_ADDRESS(node) \
+	(DT_REG_ADDR(node) + \
+	 COND_CODE_1(DT_FIXED_SUBPARTITION_EXISTS(node), \
+		(DT_REG_ADDR(DT_GPARENT(DT_PARENT(node)))), \
+		(DT_REG_ADDR(DT_GPARENT(node)))))
+
 /**
  * Get fixed-partition offset from DTS node
  *
@@ -425,8 +454,10 @@ uint8_t flash_area_erased_val(const struct flash_area *fa);
  * @return Pointer to a device.
  */
 #define FIXED_PARTITION_DEVICE(label) \
-	DEVICE_DT_GET(DT_MTD_FROM_FIXED_PARTITION(DT_NODELABEL(label)))
-
+	DEVICE_DT_GET(COND_CODE_1( \
+		DT_FIXED_SUBPARTITION_EXISTS(DT_NODELABEL(label)), \
+			(DT_MTD_FROM_FIXED_SUBPARTITION(DT_NODELABEL(label))), \
+			(DT_MTD_FROM_FIXED_PARTITION(DT_NODELABEL(label)))))
 /**
  * Get device pointer for device the area/partition resides on
  *
@@ -435,7 +466,10 @@ uint8_t flash_area_erased_val(const struct flash_area *fa);
  * @return Pointer to a device.
  */
 #define FIXED_PARTITION_NODE_DEVICE(node) \
-	DEVICE_DT_GET(DT_MTD_FROM_FIXED_PARTITION(node))
+	DEVICE_DT_GET(COND_CODE_1( \
+		DT_FIXED_SUBPARTITION_EXISTS(node), \
+			(DT_MTD_FROM_FIXED_SUBPARTITION(node)), \
+			(DT_MTD_FROM_FIXED_PARTITION(node))))
 
 /**
  * Get pointer to flash_area object by partition label
@@ -471,6 +505,22 @@ DT_FOREACH_STATUS_OKAY(fixed_partitions, FOR_EACH_PARTITION_TABLE)
 #undef DECLARE_PARTITION
 #undef DECLARE_PARTITION_0
 #undef FOR_EACH_PARTITION_TABLE
+
+#define FIXED_SUBPARTITION_1(node) FIXED_SUBPARTITION_0(DT_DEP_ORD(node))
+#define FIXED_SUBPARTITION_0(ord)						\
+	((const struct flash_area *)&DT_CAT(global_fixed_subpartition_ORD_, ord))
+
+#define DECLARE_SUBPARTITION(node) DECLARE_SUBPARTITION_0(DT_DEP_ORD(node))
+#define DECLARE_SUBPARTITION_0(ord)						\
+	extern const struct flash_area DT_CAT(global_fixed_subpartition_ORD_, ord);
+#define FOR_EACH_SUBPARTITION_TABLE(table) DT_FOREACH_CHILD(table, DECLARE_SUBPARTITION)
+
+/* Generate declarations */
+DT_FOREACH_STATUS_OKAY(fixed_subpartitions, FOR_EACH_SUBPARTITION_TABLE)
+
+#undef DECLARE_SUBPARTITION
+#undef DECLARE_SUBPARTITION_0
+#undef FOR_EACH_SUBPARTITION_TABLE
 /** @endcond */
 
 #endif /* USE_PARTITION_MANAGER */

subsys/storage/flash_map/flash_map_default.c

@@ -40,6 +40,7 @@
  */
 const struct flash_area default_flash_map[] = {
 	DT_FOREACH_STATUS_OKAY(fixed_partitions, FOREACH_PARTITION)
+	DT_FOREACH_STATUS_OKAY(fixed_subpartitions, FOREACH_PARTITION)
 };
 
 const int flash_map_entries = ARRAY_SIZE(default_flash_map);
@@ -63,17 +64,17 @@ const struct flash_area *flash_map = default_flash_map;
 #define FOR_EACH_PARTITION_TABLE(table) DT_FOREACH_CHILD(table, DEFINE_PARTITION)
 DT_FOREACH_STATUS_OKAY(fixed_partitions, FOR_EACH_PARTITION_TABLE)
 
-#define DEFINE_SUB_PARTITION(part) DEFINE_SUB_PARTITION_1(part, DT_DEP_ORD(part))
-#define DEFINE_SUB_PARTITION_1(part, ord)							\
+#define DEFINE_SUBPARTITION(part) DEFINE_SUBPARTITION_1(part, DT_DEP_ORD(part))
+#define DEFINE_SUBPARTITION_1(part, ord)							\
 	COND_CODE_1(DT_NODE_HAS_STATUS_OKAY(DT_MTD_FROM_FIXED_SUBPARTITION(part)),		\
-		(DEFINE_SUB_PARTITION_0(part, ord)), ())
-#define DEFINE_SUB_PARTITION_0(part, ord)							\
+		(DEFINE_SUBPARTITION_0(part, ord)), ())
+#define DEFINE_SUBPARTITION_0(part, ord)							\
 	const struct flash_area DT_CAT(global_fixed_subpartition_ORD_, ord) = {			\
 		.fa_id = DT_FIXED_PARTITION_ID(part),						\
 		.fa_off = DT_REG_ADDR(part),							\
 		.fa_dev = DEVICE_DT_GET(DT_MTD_FROM_FIXED_SUBPARTITION(part)),			\
 		.fa_size = DT_REG_SIZE(part),							\
 	};
 
-#define FOR_EACH_SUB_PARTITION_TABLE(table) DT_FOREACH_CHILD(table, DEFINE_SUB_PARTITION)
-DT_FOREACH_STATUS_OKAY(fixed_subpartitions, FOR_EACH_SUB_PARTITION_TABLE)
+#define FOR_EACH_SUBPARTITION_TABLE(table) DT_FOREACH_CHILD(table, DEFINE_SUBPARTITION)
+DT_FOREACH_STATUS_OKAY(fixed_subpartitions, FOR_EACH_SUBPARTITION_TABLE)