Skip to contentSkip to conversation

driver core & device property: clean up APIs

PATCH Superseded Andy Shevchenko 2 participants 7 messages Feb 29, 2024 – Mar 1, 2024

Subsystems (3)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Andy Shevchenko

author reviewer
#0 lore raw

v3 cover driver core & device property: clean up APIs

There are two, but dependent pair of patches that:
- makes some of devlink APIs static
- removes 'proxy' header use

This is rebased on top of latest patches from Jonathan as it has a minor conflict in property.h. The series can be applied directly to driver core tree with reduced context, but it may be better just to route it via IIO. Greg, which way do you prefer?

v3:
- improved commit message in patch 2 (Rafael)
- added tag (Rafael)

v2: https://lore.kernel.org/r/[email protected]
- most of the patches were sent separately as v1, thus this series is v2
- harvested tags from that patches (Sakari, Saravana)

Andy Shevchenko (4):
driver core: Drop unneeded 'extern' keyword in fwnode.h driver core: Move fw_devlink stuff to where it belongs device property: Move enum dev_dma_attr to fwnode.h device property: Don't use "proxy" headers

 drivers/base/core.c      | 58 ++++++++++++++++++++++++++++++++++
 drivers/base/property.c  | 67 ++++------------------------------------
 drivers/base/swnode.c    | 13 +++++++-
 include/linux/fwnode.h   | 13 +++++---
 include/linux/property.h |  9 +-----
 5 files changed, 86 insertions(+), 74 deletions(-)
Signature · 1 line
2.43.0.rc1.1.gbec44491f096
author reviewer
#1 lore raw

PATCH v3 1/4 driver core: Drop unneeded 'extern' keyword in fwnode.h

We do not use 'extern' keyword with functions. Remove the last one mistakenly added to fwnode.h.

---
 include/linux/fwnode.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/fwnode.h +1 -1
index 2a72f55d26eb..2d23a14857c7 100644
@@ -209,9 +209,9 @@ static inline void fwnode_dev_initialized(struct fwnode_handle *fwnode,
 		fwnode->flags &= ~FWNODE_FLAG_INITIALIZED;
 }
 
-extern bool fw_devlink_is_strict(void);
 int fwnode_link_add(struct fwnode_handle *con, struct fwnode_handle *sup);
 void fwnode_links_purge(struct fwnode_handle *fwnode);
 void fw_devlink_purge_absent_suppliers(struct fwnode_handle *fwnode);
+bool fw_devlink_is_strict(void);
 
 #endif
Signature · 1 line
2.43.0.rc1.1.gbec44491f096
author reviewer
#2 lore raw

PATCH v3 2/4 driver core: Move fw_devlink stuff to where it belongs

In reply to Andy Shevchenko

A few APIs, i.e. fwnode_is_ancestor_of(), fwnode_get_next_parent_dev(), and get_dev_from_fwnode(), that belong specifically to the fw_devlink APIs, may be static, but they are not.

Resolve this mess by moving them to the driver/base/core where the all users are being resided and make static.

No functional changes intended.

---
 drivers/base/core.c      | 58 ++++++++++++++++++++++++++++++++++++++++
 drivers/base/property.c  | 56 --------------------------------------
 include/linux/fwnode.h   |  1 -
 include/linux/property.h |  2 --
 4 files changed, 58 insertions(+), 59 deletions(-)
drivers/base/core.c +58 -0
index 9828da9b933c..35ccd8bb2c9b 100644
@@ -1871,6 +1871,7 @@ static void fw_devlink_unblock_consumers(struct device *dev)
 	device_links_write_unlock();
 }
 
+#define get_dev_from_fwnode(fwnode)	get_device((fwnode)->dev)
 
 static bool fwnode_init_without_drv(struct fwnode_handle *fwnode)
 {
@@ -1901,6 +1902,63 @@ static bool fwnode_ancestor_init_without_drv(struct fwnode_handle *fwnode)
 	return false;
 }
 
+/**
+ * fwnode_is_ancestor_of - Test if @ancestor is ancestor of @child
+ * @ancestor: Firmware which is tested for being an ancestor
+ * @child: Firmware which is tested for being the child
+ *
+ * A node is considered an ancestor of itself too.
+ *
+ * Return: true if @ancestor is an ancestor of @child. Otherwise, returns false.
+ */
+static bool fwnode_is_ancestor_of(const struct fwnode_handle *ancestor,
+				  const struct fwnode_handle *child)
+{
+	struct fwnode_handle *parent;
+
+	if (IS_ERR_OR_NULL(ancestor))
+		return false;
+
+	if (child == ancestor)
+		return true;
+
+	fwnode_for_each_parent_node(child, parent) {
+		if (parent == ancestor) {
+			fwnode_handle_put(parent);
+			return true;
+		}
+	}
+	return false;
+}
+
+/**
+ * fwnode_get_next_parent_dev - Find device of closest ancestor fwnode
+ * @fwnode: firmware node
+ *
+ * Given a firmware node (@fwnode), this function finds its closest ancestor
+ * firmware node that has a corresponding struct device and returns that struct
+ * device.
+ *
+ * The caller is responsible for calling put_device() on the returned device
+ * pointer.
+ *
+ * Return: a pointer to the device of the @fwnode's closest ancestor.
+ */
+static struct device *fwnode_get_next_parent_dev(const struct fwnode_handle *fwnode)
+{
+	struct fwnode_handle *parent;
+	struct device *dev;
+
+	fwnode_for_each_parent_node(fwnode, parent) {
+		dev = get_dev_from_fwnode(parent);
+		if (dev) {
+			fwnode_handle_put(parent);
+			return dev;
+		}
+	}
+	return NULL;
+}
+
 /**
  * __fw_devlink_relax_cycles - Relax and mark dependency cycles.
  * @con: Potential consumer device.
drivers/base/property.c +0 -56

68 lines not on this page · raw message

include/linux/fwnode.h +0 -1
index 2d23a14857c7..416cbe72f0c7 100644
@@ -187,7 +187,6 @@ struct fwnode_operations {
 		if (fwnode_has_op(fwnode, op))				\
 			(fwnode)->ops->op(fwnode, ## __VA_ARGS__);	\
 	} while (false)
-#define get_dev_from_fwnode(fwnode)	get_device((fwnode)->dev)
 
 static inline void fwnode_init(struct fwnode_handle *fwnode,
 			       const struct fwnode_operations *ops)
include/linux/property.h +0 -2
index eefd662a2f9d..420420a1d8ad 100644
@@ -157,11 +157,9 @@ struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode);
 	for (parent = fwnode_get_parent(fwnode); parent;	\
 	     parent = fwnode_get_next_parent(parent))
 
-struct device *fwnode_get_next_parent_dev(const struct fwnode_handle *fwnode);
 unsigned int fwnode_count_parents(const struct fwnode_handle *fwn);
 struct fwnode_handle *fwnode_get_nth_parent(struct fwnode_handle *fwn,
 					    unsigned int depth);
-bool fwnode_is_ancestor_of(const struct fwnode_handle *ancestor, const struct fwnode_handle *child);
 struct fwnode_handle *fwnode_get_next_child_node(
 	const struct fwnode_handle *fwnode, struct fwnode_handle *child);
 struct fwnode_handle *fwnode_get_next_available_child_node(
Signature · 1 line
2.43.0.rc1.1.gbec44491f096
author reviewer
#3 lore raw

PATCH v3 3/4 device property: Move enum dev_dma_attr to fwnode.h

In reply to Andy Shevchenko

The struct fwnode_operations defines one of the callback to return enum dev_dma_attr. But this currently is defined in property.h. Move it to the correct location.

Fixes 8c756a0a2de1 ("device property: Convert device_{dma_supported,get_dma_attr} to fwnode")
---
 include/linux/fwnode.h   | 6 ++++++
 include/linux/property.h | 6 ------
 2 files changed, 6 insertions(+), 6 deletions(-)
include/linux/fwnode.h +6 -0
index 416cbe72f0c7..4228c45d5ccc 100644
@@ -14,6 +14,12 @@
 #include <linux/bits.h>
 #include <linux/err.h>
 
+enum dev_dma_attr {
+	DEV_DMA_NOT_SUPPORTED,
+	DEV_DMA_NON_COHERENT,
+	DEV_DMA_COHERENT,
+};
+
 struct fwnode_operations;
 struct device;
 
include/linux/property.h +0 -6
index 420420a1d8ad..5761878d42c7 100644
@@ -28,12 +28,6 @@ enum dev_prop_type {
 	DEV_PROP_REF,
 };
 
-enum dev_dma_attr {
-	DEV_DMA_NOT_SUPPORTED,
-	DEV_DMA_NON_COHERENT,
-	DEV_DMA_COHERENT,
-};
-
 const struct fwnode_handle *__dev_fwnode_const(const struct device *dev);
 struct fwnode_handle *__dev_fwnode(struct device *dev);
 #define dev_fwnode(dev)							\
Signature · 1 line
2.43.0.rc1.1.gbec44491f096
author reviewer
#4 lore raw

PATCH v3 4/4 device property: Don't use "proxy" headers

In reply to Andy Shevchenko

Update header inclusions to follow IWYU (Include What You Use) principle.

---
 drivers/base/property.c  | 11 ++++++-----
 drivers/base/swnode.c    | 13 ++++++++++++-
 include/linux/fwnode.h   |  4 ++--
 include/linux/property.h |  1 +
 4 files changed, 21 insertions(+), 8 deletions(-)
drivers/base/property.c +6 -5
index d983a4dea105..6a3a434d0d6f 100644
@@ -7,15 +7,16 @@
  *          Mika Westerberg <[email protected]>
  */
 
-#include <linux/acpi.h>
+#include <linux/device.h>
+#include <linux/err.h>
 #include <linux/export.h>
-#include <linux/kernel.h>
+#include <linux/kconfig.h>
 #include <linux/of.h>
-#include <linux/of_address.h>
-#include <linux/of_graph.h>
-#include <linux/of_irq.h>
 #include <linux/property.h>
 #include <linux/phy.h>
+#include <linux/slab.h>
+#include <linux/string.h>
+#include <linux/types.h>
 
 struct fwnode_handle *__dev_fwnode(struct device *dev)
 {
drivers/base/swnode.c +12 -1
index 36512fb75a20..eb6eb25b343b 100644
@@ -6,10 +6,21 @@
  * Author: Heikki Krogerus <[email protected]>
  */
 
+#include <linux/container_of.h>
 #include <linux/device.h>
-#include <linux/kernel.h>
+#include <linux/err.h>
+#include <linux/export.h>
+#include <linux/idr.h>
+#include <linux/init.h>
+#include <linux/kobject.h>
+#include <linux/kstrtox.h>
+#include <linux/list.h>
 #include <linux/property.h>
 #include <linux/slab.h>
+#include <linux/spinlock.h>
+#include <linux/string.h>
+#include <linux/sysfs.h>
+#include <linux/types.h>
 
 #include "base.h"
 
include/linux/fwnode.h +2 -2
index 4228c45d5ccc..80f3cd91b471 100644
@@ -9,10 +9,10 @@
 #ifndef _LINUX_FWNODE_H_
 #define _LINUX_FWNODE_H_
 
-#include <linux/types.h>
-#include <linux/list.h>
 #include <linux/bits.h>
 #include <linux/err.h>
+#include <linux/list.h>
+#include <linux/types.h>
 
 enum dev_dma_attr {
 	DEV_DMA_NOT_SUPPORTED,
include/linux/property.h +1 -0
index 5761878d42c7..61fc20e5f81f 100644
@@ -11,6 +11,7 @@
 #define _LINUX_PROPERTY_H_
 
 #include <linux/args.h>
+#include <linux/array_size.h>
 #include <linux/bits.h>
 #include <linux/cleanup.h>
 #include <linux/fwnode.h>
Signature · 1 line
2.43.0.rc1.1.gbec44491f096
#5 lore raw
In reply to Andy Shevchenko
Quoted 8 lines · Andy Shevchenko

There are two, but dependent pair of patches that:
- makes some of devlink APIs static
- removes 'proxy' header use

This is rebased on top of latest patches from Jonathan as it has a minor conflict in property.h. The series can be applied directly to driver core tree with reduced context, but it may be better just to route it via IIO. Greg, which way do you prefer?

Why would IIO mess with driver core stuff?

I can just take it in my driver core tree, thanks.

greg k-h

author reviewer
#6 lore raw
Quoted 5 lines · Greg Kroah-Hartman
Quoted 4 lines · Andy Shevchenko

There are two, but dependent pair of patches that:
- makes some of devlink APIs static
- removes 'proxy' header use

Quoted 8 lines
Quoted 4 lines

This is rebased on top of latest patches from Jonathan as it has a minor conflict in property.h. The series can be applied directly to driver core tree with reduced context, but it may be better just to route it via IIO. Greg, which way do you prefer?

Why would IIO mess with driver core stuff?

I can just take it in my driver core tree, thanks.

Let me base on your driver-core-testing then.
Thank you!

Signature · 2 lines
With Best Regards,
Andy Shevchenko