From 52ad21aa2cc55f53da19436f457a8590abf0d125 Mon Sep 17 00:00:00 2001
From: Simon Glass <sjg@chromium.org>
Date: Tue, 6 Sep 2022 20:27:16 -0600
Subject: [PATCH] dm: core: Add a macro to iterate through properties

Add a 'for_each' macro like we have for nodes.

Fix the comment for struct ofprop while we are here.

Signed-off-by: Simon Glass <sjg@chromium.org>
---
 include/dm/ofnode.h      | 38 ++++++++++++++++++++++++++++++++++++++
 include/dm/ofnode_decl.h |  2 +-
 test/dm/ofnode.c         | 24 ++++++++++++++++++++++++
 3 files changed, 63 insertions(+), 1 deletion(-)

diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h
index 1e23a40c99..7b0ef109b7 100644
--- a/include/dm/ofnode.h
+++ b/include/dm/ofnode.h
@@ -176,6 +176,20 @@ static inline ofnode ofnode_root(void)
 	return node;
 }
 
+/**
+ * ofprop_valid() - check if an ofprop is valid
+ *
+ * @prop: Pointer to ofprop to check
+ * Return: true if the reference contains a valid ofprop, false if not
+ */
+static inline bool ofprop_valid(struct ofprop *prop)
+{
+	if (of_live_active())
+		return prop->prop;
+	else
+		return prop->offset >= 0;
+}
+
 /**
  * oftree_default() - Returns the default device tree (U-Boot's control FDT)
  *
@@ -821,6 +835,30 @@ int ofnode_first_property(ofnode node, struct ofprop *prop);
  */
 int ofnode_next_property(struct ofprop *prop);
 
+/**
+ * ofnode_for_each_prop() - iterate over all properties of a node
+ *
+ * @prop:	struct ofprop
+ * @node:	node (lvalue, ofnode)
+ *
+ * This is a wrapper around a for loop and is used like this::
+ *
+ *   ofnode node;
+ *   struct ofprop prop;
+ *
+ *   ofnode_for_each_prop(prop, node) {
+ *       ...use prop...
+ *   }
+ *
+ * Note that this is implemented as a macro and @prop is used as
+ * iterator in the loop. The parent variable can be a constant or even a
+ * literal.
+ */
+#define ofnode_for_each_prop(prop, node) \
+	for (ofnode_first_property(node, &prop); \
+	     ofprop_valid(&prop); \
+	     ofnode_next_property(&prop))
+
 /**
  * ofprop_get_property() - get a pointer to the value of a property
  *
diff --git a/include/dm/ofnode_decl.h b/include/dm/ofnode_decl.h
index 8d0d7885aa..f666a0287b 100644
--- a/include/dm/ofnode_decl.h
+++ b/include/dm/ofnode_decl.h
@@ -57,7 +57,7 @@ typedef union ofnode_union {
  *
  * @node: Pointer to device node
  * @offset: Pointer into flat device tree, used for flat tree.
- * @prop: Pointer to property, used for live treee.
+ * @prop: Pointer to property, used for live tree.
  */
 
 struct ofprop {
diff --git a/test/dm/ofnode.c b/test/dm/ofnode.c
index a421392a97..5ddfd0298a 100644
--- a/test/dm/ofnode.c
+++ b/test/dm/ofnode.c
@@ -669,3 +669,27 @@ static int dm_test_ofnode_add_subnode(struct unit_test_state *uts)
 	return 0;
 }
 DM_TEST(dm_test_ofnode_add_subnode, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
+
+static int dm_test_ofnode_for_each_prop(struct unit_test_state *uts)
+{
+	ofnode node, subnode;
+	struct ofprop prop;
+	int count;
+
+	node = ofnode_path("/buttons");
+	count = 0;
+
+	/* we expect "compatible" for each node */
+	ofnode_for_each_prop(prop, node)
+		count++;
+	ut_asserteq(1, count);
+
+	/* there are two nodes, each with 2 properties */
+	ofnode_for_each_subnode(subnode, node)
+		ofnode_for_each_prop(prop, subnode)
+			count++;
+	ut_asserteq(5, count);
+
+	return 0;
+}
+DM_TEST(dm_test_ofnode_for_each_prop, UT_TESTF_SCAN_FDT);
-- 
2.39.5