Skip to contentSkip to conversation

device property: Add scoped fwnode child node iterators

PATCH Superseded Jean-François Lessard 3 participants 5 messages Aug 29, 2025 – Sep 1, 2025

Subsystems (3)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 device property: Add scoped fwnode child node iterators

Add scoped versions of fwnode child node iterators that automatically handle reference counting cleanup using the __free() attribute:

- fwnode_for_each_child_node_scoped()
- fwnode_for_each_named_child_node_scoped()
- fwnode_for_each_available_child_node_scoped()

These macros follow the same pattern as existing scoped iterators in the kernel, ensuring fwnode references are automatically released when the iterator variable goes out of scope. This prevents resource leaks and eliminates the need for manual cleanup in error paths.

The implementation mirrors the non-scoped variants but uses __free(fwnode_handle) for automatic resource management, providing a safer and more convenient interface for drivers iterating over firmware node children.

---

Notes:
checkpatch reports false positives that are intentionally ignored:
COMPLEX_MACRO, MACRO_ARG_REUSE, MACRO_ARG_PRECEDENCE This is a standard iterator pattern following kernel conventions.

 include/linux/property.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
include/linux/property.h +14 -0
index 82f0cb3ab..279c244db 100644
@@ -176,6 +176,20 @@ struct fwnode_handle *fwnode_get_next_available_child_node(
 	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
 	     child = fwnode_get_next_available_child_node(fwnode, child))
 
+#define fwnode_for_each_child_node_scoped(fwnode, child)		\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_child_node(fwnode, NULL);		\
+	     child; child = fwnode_get_next_child_node(fwnode, child))
+
+#define fwnode_for_each_named_child_node_scoped(fwnode, child, name)	\
+	fwnode_for_each_child_node_scoped(fwnode, child)		\
+		for_each_if(fwnode_name_eq(child, name))
+
+#define fwnode_for_each_available_child_node_scoped(fwnode, child)	\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_available_child_node(fwnode, NULL);	\
+	     child; child = fwnode_get_next_available_child_node(fwnode, child))
+
 struct fwnode_handle *device_get_next_child_node(const struct device *dev,
 						 struct fwnode_handle *child);
 
Signature · 1 line
2.43.0
#1 lore raw
Quoted 43 lines · Jean-François Lessard

Add scoped versions of fwnode child node iterators that automatically handle reference counting cleanup using the __free() attribute:

- fwnode_for_each_child_node_scoped()
- fwnode_for_each_named_child_node_scoped()
- fwnode_for_each_available_child_node_scoped()

These macros follow the same pattern as existing scoped iterators in the kernel, ensuring fwnode references are automatically released when the iterator variable goes out of scope. This prevents resource leaks and eliminates the need for manual cleanup in error paths.

The implementation mirrors the non-scoped variants but uses __free(fwnode_handle) for automatic resource management, providing a safer and more convenient interface for drivers iterating over firmware node children.

---

Notes:
checkpatch reports false positives that are intentionally ignored:
COMPLEX_MACRO, MACRO_ARG_REUSE, MACRO_ARG_PRECEDENCE This is a standard iterator pattern following kernel conventions.

 include/linux/property.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
include/linux/property.h +7 -0
index 82f0cb3ab..279c244db 100644
@@ -176,6 +176,20 @@ struct fwnode_handle *fwnode_get_next_available_child_node(
 	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
 	     child = fwnode_get_next_available_child_node(fwnode, child))
 
+#define fwnode_for_each_child_node_scoped(fwnode, child)		\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_child_node(fwnode, NULL);		\
+	     child; child = fwnode_get_next_child_node(fwnode, child))
+
+#define fwnode_for_each_named_child_node_scoped(fwnode, child, name)	\
+	fwnode_for_each_child_node_scoped(fwnode, child)		\

include/linux/property.h struct fwnode_handle *fwnode_get_next_available_child_node( · line 195

Quoted 10 lines
include/linux/property.h +7 -0
+		for_each_if(fwnode_name_eq(child, name))
+
+#define fwnode_for_each_available_child_node_scoped(fwnode, child)	\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_available_child_node(fwnode, NULL);	\
+	     child; child = fwnode_get_next_available_child_node(fwnode, child))
+
 struct fwnode_handle *device_get_next_child_node(const struct device *dev,
 						 struct fwnode_handle *child);
 

We need a real user of this before we can add them, so please do that as part of a patch series.

thanks

greg k-h

#2 lore raw

Le 29 août 2025 00 h 23 min 22 s HAE, Greg Kroah-Hartman <[email protected]> a écrit :

Quoted 49 lines · Jean-François Lessard
Quoted 48 lines

Add scoped versions of fwnode child node iterators that automatically handle reference counting cleanup using the __free() attribute:

- fwnode_for_each_child_node_scoped()
- fwnode_for_each_named_child_node_scoped()
- fwnode_for_each_available_child_node_scoped()

These macros follow the same pattern as existing scoped iterators in the kernel, ensuring fwnode references are automatically released when the iterator variable goes out of scope. This prevents resource leaks and eliminates the need for manual cleanup in error paths.

The implementation mirrors the non-scoped variants but uses __free(fwnode_handle) for automatic resource management, providing a safer and more convenient interface for drivers iterating over firmware node children.

---

Notes:
checkpatch reports false positives that are intentionally ignored:
COMPLEX_MACRO, MACRO_ARG_REUSE, MACRO_ARG_PRECEDENCE This is a standard iterator pattern following kernel conventions.

 include/linux/property.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
include/linux/property.h +12 -0
index 82f0cb3ab..279c244db 100644
@@ -176,6 +176,20 @@ struct fwnode_handle *fwnode_get_next_available_child_node(
 	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
 	     child = fwnode_get_next_available_child_node(fwnode, child))
 
+#define fwnode_for_each_child_node_scoped(fwnode, child)		\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_child_node(fwnode, NULL);		\
+	     child; child = fwnode_get_next_child_node(fwnode, child))
+
+#define fwnode_for_each_named_child_node_scoped(fwnode, child, name)	\
+	fwnode_for_each_child_node_scoped(fwnode, child)		\
+		for_each_if(fwnode_name_eq(child, name))
+
+#define fwnode_for_each_available_child_node_scoped(fwnode, child)	\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_available_child_node(fwnode, NULL);	\
Quoted 9 lines

include/linux/property.h struct fwnode_handle *fwnode_get_next_available_child_node( · line 195

Quoted 5 lines
include/linux/property.h +2 -0
+	     child; child = fwnode_get_next_available_child_node(fwnode, child))
+
 struct fwnode_handle *device_get_next_child_node(const struct device *dev,
 						 struct fwnode_handle *child);
 

We need a real user of this before we can add them, so please do that as part of a patch series.

I understand the "no dead code" policy, but I found existing manual implementations of this exact pattern in the current kernel.

For example, drivers/i2c/i2c-core-slave.c already does:

		struct fwnode_handle *child __free(fwnode_handle) = NULL;
...
		fwnode_for_each_child_node(fwnode, child) {
...
		}

This suggests developers are already wanting this functionality but implementing it manually.

If included with my driver series, I would only add the fwnode_for_each_available_child_node_scoped() variant that I actually use, avoiding any dead code.

Best Regards

Jean-François Lessard

#3 lore raw
Quoted 65 lines · Jean-François Lessard

Le 29 août 2025 00 h 23 min 22 s HAE, Greg Kroah-Hartman <[email protected]> a écrit :

Quoted 49 lines · Jean-François Lessard
Quoted 48 lines

Add scoped versions of fwnode child node iterators that automatically handle reference counting cleanup using the __free() attribute:

- fwnode_for_each_child_node_scoped()
- fwnode_for_each_named_child_node_scoped()
- fwnode_for_each_available_child_node_scoped()

These macros follow the same pattern as existing scoped iterators in the kernel, ensuring fwnode references are automatically released when the iterator variable goes out of scope. This prevents resource leaks and eliminates the need for manual cleanup in error paths.

The implementation mirrors the non-scoped variants but uses __free(fwnode_handle) for automatic resource management, providing a safer and more convenient interface for drivers iterating over firmware node children.

---

Notes:
checkpatch reports false positives that are intentionally ignored:
COMPLEX_MACRO, MACRO_ARG_REUSE, MACRO_ARG_PRECEDENCE This is a standard iterator pattern following kernel conventions.

 include/linux/property.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
include/linux/property.h +12 -0
index 82f0cb3ab..279c244db 100644
@@ -176,6 +176,20 @@ struct fwnode_handle *fwnode_get_next_available_child_node(
 	for (child = fwnode_get_next_available_child_node(fwnode, NULL); child;\
 	     child = fwnode_get_next_available_child_node(fwnode, child))
 
+#define fwnode_for_each_child_node_scoped(fwnode, child)		\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_child_node(fwnode, NULL);		\
+	     child; child = fwnode_get_next_child_node(fwnode, child))
+
+#define fwnode_for_each_named_child_node_scoped(fwnode, child, name)	\
+	fwnode_for_each_child_node_scoped(fwnode, child)		\
+		for_each_if(fwnode_name_eq(child, name))
+
+#define fwnode_for_each_available_child_node_scoped(fwnode, child)	\
+	for (struct fwnode_handle *child __free(fwnode_handle) =	\
+		fwnode_get_next_available_child_node(fwnode, NULL);	\
Quoted 9 lines

include/linux/property.h struct fwnode_handle *fwnode_get_next_available_child_node( · line 195

Quoted 5 lines
include/linux/property.h +2 -0
+	     child; child = fwnode_get_next_available_child_node(fwnode, child))
+
 struct fwnode_handle *device_get_next_child_node(const struct device *dev,
 						 struct fwnode_handle *child);
 

We need a real user of this before we can add them, so please do that as part of a patch series.

I understand the "no dead code" policy, but I found existing manual implementations of this exact pattern in the current kernel.

For example, drivers/i2c/i2c-core-slave.c already does:

Quoted 8 lines
		struct fwnode_handle *child __free(fwnode_handle) = NULL;
...
		fwnode_for_each_child_node(fwnode, child) {
...
		}

This suggests developers are already wanting this functionality but implementing it manually.

Great, then add it here and fix up drivers/i2c/i2c-core-slave.c to use it!

thanks,

greg k-h

#4 lore raw
In reply to Jean-François Lessard
Quoted 2 lines · Jean-François Lessard

Le 29 août 2025 00 h 23 min 22 s HAE, Greg Kroah-Hartman <[email protected]> a écrit :

Quoted 1 line · Jean-François Lessard

...

Quoted 15 lines
Quoted 3 lines

We need a real user of this before we can add them, so please do that as part of a patch series.

I understand the "no dead code" policy, but I found existing manual implementations of this exact pattern in the current kernel.

For example, drivers/i2c/i2c-core-slave.c already does:

		struct fwnode_handle *child __free(fwnode_handle) = NULL;
...
		fwnode_for_each_child_node(fwnode, child) {
...
		}
Quoted 5 lines

This suggests developers are already wanting this functionality but implementing it manually.

If included with my driver series, I would only add the fwnode_for_each_available_child_node_scoped() variant that I actually use,

I fully agree with Greg, please make it series out of two, I will review both as soon as it appears in my mailbox.

Signature · 2 lines
With Best Regards,
Andy Shevchenko