Skip to contentSkip to conversation

of: populate of_root node if not set

PATCH In review Clément Léger 2 participants 7 messages Jun 23, 2022 – Jun 24, 2022 Device tree

lore
Share & tools
lore
#0 lore raw

cover of: populate of_root node if not set

In order to apply overlays or create new nodes under the root node, the kernel expects of_root to be set. On some system were a device-tree us not provided by firmware (x86 for instance) if CONFIG_OF is enabled, then we will end up with a null of_root. This series add support to create this root node using a builtin dtb and remove the manual creation of the root node done in unittests.c.

Clément Léger (2):
of: base: populate of_root node if not set
of: unittest: remove check for of_root

 drivers/of/Makefile       |  2 +-
 drivers/of/base.c         | 18 ++++++++++++++++--
 drivers/of/empty_root.dts |  6 ++++++
 drivers/of/unittest.c     | 10 ----------
 4 files changed, 23 insertions(+), 13 deletions(-)
 create mode 100644 drivers/of/empty_root.dts
Signature · 1 line
2.36.1
#1 lore raw

PATCH 1/2 of: base: populate of_root node if not set

When enabling CONFIG_OF on a platform where of_root is not populated by firmware, we end up without a root node. In order to apply overlays and create subnodes of the root node, we need one. Create this root node by unflattening an empty builtin dtb with of_fdt_unflatten().

---
 drivers/of/Makefile       |  2 +-
 drivers/of/base.c         | 18 ++++++++++++++++--
 drivers/of/empty_root.dts |  6 ++++++
 3 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 drivers/of/empty_root.dts
drivers/of/Makefile +1 -1
index e0360a44306e..ce56c8b95c83 100644
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
-obj-y = base.o device.o platform.o property.o
+obj-y = base.o empty_root.dtb.o device.o platform.o property.o
 obj-$(CONFIG_OF_KOBJ) += kobj.o
 obj-$(CONFIG_OF_DYNAMIC) += dynamic.o
 obj-$(CONFIG_OF_FLATTREE) += fdt.o
drivers/of/base.c +16 -2
index d4f98c8469ed..43e0f027a49c 100644
@@ -22,6 +22,7 @@
 #include <linux/module.h>
 #include <linux/of.h>
 #include <linux/of_device.h>
+#include <linux/of_fdt.h>
 #include <linux/of_graph.h>
 #include <linux/spinlock.h>
 #include <linux/slab.h>
@@ -163,6 +164,8 @@ void __of_phandle_cache_inv_entry(phandle handle)
 		phandle_cache[handle_hash] = NULL;
 }
 
+extern const char __dtb_empty_root_begin[];
+
 void __init of_core_init(void)
 {
 	struct device_node *np;
@@ -176,6 +179,18 @@ void __init of_core_init(void)
 		pr_err("failed to register existing nodes\n");
 		return;
 	}
+
+	if (!of_root) {
+		void *dt;
+		const unsigned long *fdt = (const unsigned long *)
+							__dtb_empty_root_begin;
+		dt = of_fdt_unflatten_tree(fdt, NULL, &of_root);
+		if (!dt) {
+			pr_err("Failed to setup empty root dt\n");
+			return;
+		}
+	}
+
 	for_each_of_allnodes(np) {
 		__of_attach_node_sysfs(np);
 		if (np->phandle && !phandle_cache[of_phandle_cache_hash(np->phandle)])
@@ -184,8 +199,7 @@ void __init of_core_init(void)
 	mutex_unlock(&of_mutex);
 
 	/* Symlink in /proc as required by userspace ABI */
-	if (of_root)
-		proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
+	proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
 }
 
 static struct property *__of_find_property(const struct device_node *np,
drivers/of/empty_root.dts new file +6 -0
new file mode 100644
index 000000000000..cf9e97a60f48
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/dts-v1/;
+
+/ {
+
+};
Signature · 1 line
2.36.1
#2 lore raw

Re: [PATCH v1 1/2] of: base: populate of_root node if not set

Hi Clement,

I said that I would send a patch to do this, but have failed to follow through. Sorry about that.

Quoted 67 lines · Clément Léger

When enabling CONFIG_OF on a platform where of_root is not populated by firmware, we end up without a root node. In order to apply overlays and create subnodes of the root node, we need one. Create this root node by unflattening an empty builtin dtb with of_fdt_unflatten().

---
 drivers/of/Makefile       |  2 +-
 drivers/of/base.c         | 18 ++++++++++++++++--
 drivers/of/empty_root.dts |  6 ++++++
 3 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 drivers/of/empty_root.dts
drivers/of/Makefile +1 -1
index e0360a44306e..ce56c8b95c83 100644
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
-obj-y = base.o device.o platform.o property.o
+obj-y = base.o empty_root.dtb.o device.o platform.o property.o
 obj-$(CONFIG_OF_KOBJ) += kobj.o
 obj-$(CONFIG_OF_DYNAMIC) += dynamic.o
 obj-$(CONFIG_OF_FLATTREE) += fdt.o
drivers/of/base.c +15 -0
index d4f98c8469ed..43e0f027a49c 100644
@@ -22,6 +22,7 @@
 #include <linux/module.h>
 #include <linux/of.h>
 #include <linux/of_device.h>
+#include <linux/of_fdt.h>
 #include <linux/of_graph.h>
 #include <linux/spinlock.h>
 #include <linux/slab.h>
@@ -163,6 +164,8 @@ void __of_phandle_cache_inv_entry(phandle handle)
 		phandle_cache[handle_hash] = NULL;
 }
 
+extern const char __dtb_empty_root_begin[];
+
 void __init of_core_init(void)
 {
 	struct device_node *np;
@@ -176,6 +179,18 @@ void __init of_core_init(void)
 		pr_err("failed to register existing nodes\n");
 		return;
 	}
+
+	if (!of_root) {
+		void *dt;
+		const unsigned long *fdt = (const unsigned long *)
+							__dtb_empty_root_begin;
+		dt = of_fdt_unflatten_tree(fdt, NULL, &of_root);
+		if (!dt) {
+			pr_err("Failed to setup empty root dt\n");
+			return;
+		}
+	}
+
 	for_each_of_allnodes(np) {
 		__of_attach_node_sysfs(np);
 		if (np->phandle && !phandle_cache[of_phandle_cache_hash(np->phandle)])

drivers/of/base.c void __init of_core_init(void) · line 203

Quoted 7 lines
drivers/of/base.c +1 -2
@@ -184,8 +199,7 @@ void __init of_core_init(void)
 	mutex_unlock(&of_mutex);
 
 	/* Symlink in /proc as required by userspace ABI */
-	if (of_root)
-		proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
+	proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
 }

This approach is adding an additional method of unflattening the tree. I would prefer to consolidate in a single location.

I have leveraged this patch series into a different patch series to accomplish that. I have boot tested with one configuration, but want to test two more configurations before sending the new series. It should only take "a few minutes".

-Frank

Quoted 14 lines
drivers/of/base.c +0 -0
 static struct property *__of_find_property(const struct device_node *np,
drivers/of/empty_root.dts new file +6 -0
new file mode 100644
index 000000000000..cf9e97a60f48
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/dts-v1/;
+
+/ {
+
+};
#3 lore raw

Re: [PATCH v1 1/2] of: base: populate of_root node if not set

Quoted 85 lines · Frank Rowand

Hi Clement,

I said that I would send a patch to do this, but have failed to follow through. Sorry about that.

Quoted 67 lines · Clément Léger

When enabling CONFIG_OF on a platform where of_root is not populated by firmware, we end up without a root node. In order to apply overlays and create subnodes of the root node, we need one. Create this root node by unflattening an empty builtin dtb with of_fdt_unflatten().

---
 drivers/of/Makefile       |  2 +-
 drivers/of/base.c         | 18 ++++++++++++++++--
 drivers/of/empty_root.dts |  6 ++++++
 3 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 drivers/of/empty_root.dts
drivers/of/Makefile +1 -1
index e0360a44306e..ce56c8b95c83 100644
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
-obj-y = base.o device.o platform.o property.o
+obj-y = base.o empty_root.dtb.o device.o platform.o property.o
 obj-$(CONFIG_OF_KOBJ) += kobj.o
 obj-$(CONFIG_OF_DYNAMIC) += dynamic.o
 obj-$(CONFIG_OF_FLATTREE) += fdt.o
drivers/of/base.c +15 -0
index d4f98c8469ed..43e0f027a49c 100644
@@ -22,6 +22,7 @@
 #include <linux/module.h>
 #include <linux/of.h>
 #include <linux/of_device.h>
+#include <linux/of_fdt.h>
 #include <linux/of_graph.h>
 #include <linux/spinlock.h>
 #include <linux/slab.h>
@@ -163,6 +164,8 @@ void __of_phandle_cache_inv_entry(phandle handle)
 		phandle_cache[handle_hash] = NULL;
 }
 
+extern const char __dtb_empty_root_begin[];
+
 void __init of_core_init(void)
 {
 	struct device_node *np;
@@ -176,6 +179,18 @@ void __init of_core_init(void)
 		pr_err("failed to register existing nodes\n");
 		return;
 	}
+
+	if (!of_root) {
+		void *dt;
+		const unsigned long *fdt = (const unsigned long *)
+							__dtb_empty_root_begin;
+		dt = of_fdt_unflatten_tree(fdt, NULL, &of_root);
+		if (!dt) {
+			pr_err("Failed to setup empty root dt\n");
+			return;
+		}
+	}
+
 	for_each_of_allnodes(np) {
 		__of_attach_node_sysfs(np);
 		if (np->phandle && !phandle_cache[of_phandle_cache_hash(np->phandle)])

drivers/of/base.c void __init of_core_init(void) · line 203

Quoted 7 lines
drivers/of/base.c +1 -2
@@ -184,8 +199,7 @@ void __init of_core_init(void)
 	mutex_unlock(&of_mutex);
 
 	/* Symlink in /proc as required by userspace ABI */
-	if (of_root)
-		proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
+	proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
 }

This approach is adding an additional method of unflattening the tree. I would prefer to consolidate in a single location.

Quoted 4 lines

I have leveraged this patch series into a different patch series to accomplish that. I have boot tested with one configuration, but want to test two more configurations before sending the new series. It should only take "a few minutes".

"a few minutes" is taking longer than expected. One of the devicetree interrupt unittests is not giving the expected result for one of the configurations I am checking.

-Frank

Quoted 18 lines

-Frank

Quoted 14 lines
drivers/of/base.c +0 -0
 static struct property *__of_find_property(const struct device_node *np,
drivers/of/empty_root.dts new file +6 -0
new file mode 100644
index 000000000000..cf9e97a60f48
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/dts-v1/;
+
+/ {
+
+};
#4 lore raw

Re: [PATCH v1 1/2] of: base: populate of_root node if not set

Quoted 86 lines · Frank Rowand
Quoted 85 lines · Frank Rowand

Hi Clement,

I said that I would send a patch to do this, but have failed to follow through. Sorry about that.

Quoted 67 lines · Clément Léger

When enabling CONFIG_OF on a platform where of_root is not populated by firmware, we end up without a root node. In order to apply overlays and create subnodes of the root node, we need one. Create this root node by unflattening an empty builtin dtb with of_fdt_unflatten().

---
 drivers/of/Makefile       |  2 +-
 drivers/of/base.c         | 18 ++++++++++++++++--
 drivers/of/empty_root.dts |  6 ++++++
 3 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 drivers/of/empty_root.dts
drivers/of/Makefile +1 -1
index e0360a44306e..ce56c8b95c83 100644
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
-obj-y = base.o device.o platform.o property.o
+obj-y = base.o empty_root.dtb.o device.o platform.o property.o
 obj-$(CONFIG_OF_KOBJ) += kobj.o
 obj-$(CONFIG_OF_DYNAMIC) += dynamic.o
 obj-$(CONFIG_OF_FLATTREE) += fdt.o
drivers/of/base.c +15 -0
index d4f98c8469ed..43e0f027a49c 100644
@@ -22,6 +22,7 @@
 #include <linux/module.h>
 #include <linux/of.h>
 #include <linux/of_device.h>
+#include <linux/of_fdt.h>
 #include <linux/of_graph.h>
 #include <linux/spinlock.h>
 #include <linux/slab.h>
@@ -163,6 +164,8 @@ void __of_phandle_cache_inv_entry(phandle handle)
 		phandle_cache[handle_hash] = NULL;
 }
 
+extern const char __dtb_empty_root_begin[];
+
 void __init of_core_init(void)
 {
 	struct device_node *np;
@@ -176,6 +179,18 @@ void __init of_core_init(void)
 		pr_err("failed to register existing nodes\n");
 		return;
 	}
+
+	if (!of_root) {
+		void *dt;
+		const unsigned long *fdt = (const unsigned long *)
+							__dtb_empty_root_begin;
+		dt = of_fdt_unflatten_tree(fdt, NULL, &of_root);
+		if (!dt) {
+			pr_err("Failed to setup empty root dt\n");
+			return;
+		}
+	}
+
 	for_each_of_allnodes(np) {
 		__of_attach_node_sysfs(np);
 		if (np->phandle && !phandle_cache[of_phandle_cache_hash(np->phandle)])

drivers/of/base.c void __init of_core_init(void) · line 203

Quoted 7 lines
drivers/of/base.c +1 -2
@@ -184,8 +199,7 @@ void __init of_core_init(void)
 	mutex_unlock(&of_mutex);
 
 	/* Symlink in /proc as required by userspace ABI */
-	if (of_root)
-		proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
+	proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
 }

This approach is adding an additional method of unflattening the tree. I would prefer to consolidate in a single location.

Quoted 8 lines
Quoted 4 lines

I have leveraged this patch series into a different patch series to accomplish that. I have boot tested with one configuration, but want to test two more configurations before sending the new series. It should only take "a few minutes".

"a few minutes" is taking longer than expected. One of the devicetree interrupt unittests is not giving the expected result for one of the configurations I am checking.

The test is ok. The problem was unrelated asynchronous output to the console intermingled with test output.

My suggested alternative patch series is at:

https://lore.kernel.org/r/[email protected]

-Frank

Quoted 22 lines

-Frank

Quoted 18 lines

-Frank

Quoted 14 lines
drivers/of/base.c +0 -0
 static struct property *__of_find_property(const struct device_node *np,
drivers/of/empty_root.dts new file +6 -0
new file mode 100644
index 000000000000..cf9e97a60f48
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/dts-v1/;
+
+/ {
+
+};
#5 lore raw

Re: [PATCH v1 1/2] of: base: populate of_root node if not set

In reply to Frank Rowand
Quoted 4 lines · Frank Rowand

Hi Clement,

I said that I would send a patch to do this, but have failed to follow through. Sorry about that.

Hi Frank, no worries, I just needed this topic to move forward, that's why I decided to sent this .

Thanks !

Clément

Quoted 103 lines · Clément Léger
Quoted 67 lines

When enabling CONFIG_OF on a platform where of_root is not populated by firmware, we end up without a root node. In order to apply overlays and create subnodes of the root node, we need one. Create this root node by unflattening an empty builtin dtb with of_fdt_unflatten().

---
 drivers/of/Makefile       |  2 +-
 drivers/of/base.c         | 18 ++++++++++++++++--
 drivers/of/empty_root.dts |  6 ++++++
 3 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 drivers/of/empty_root.dts
drivers/of/Makefile +1 -1
index e0360a44306e..ce56c8b95c83 100644
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
-obj-y = base.o device.o platform.o property.o
+obj-y = base.o empty_root.dtb.o device.o platform.o property.o
 obj-$(CONFIG_OF_KOBJ) += kobj.o
 obj-$(CONFIG_OF_DYNAMIC) += dynamic.o
 obj-$(CONFIG_OF_FLATTREE) += fdt.o
drivers/of/base.c +15 -0
index d4f98c8469ed..43e0f027a49c 100644
@@ -22,6 +22,7 @@
 #include <linux/module.h>
 #include <linux/of.h>
 #include <linux/of_device.h>
+#include <linux/of_fdt.h>
 #include <linux/of_graph.h>
 #include <linux/spinlock.h>
 #include <linux/slab.h>
@@ -163,6 +164,8 @@ void __of_phandle_cache_inv_entry(phandle handle)
 		phandle_cache[handle_hash] = NULL;
 }
 
+extern const char __dtb_empty_root_begin[];
+
 void __init of_core_init(void)
 {
 	struct device_node *np;
@@ -176,6 +179,18 @@ void __init of_core_init(void)
 		pr_err("failed to register existing nodes\n");
 		return;
 	}
+
+	if (!of_root) {
+		void *dt;
+		const unsigned long *fdt = (const unsigned long *)
+							__dtb_empty_root_begin;
+		dt = of_fdt_unflatten_tree(fdt, NULL, &of_root);
+		if (!dt) {
+			pr_err("Failed to setup empty root dt\n");
+			return;
+		}
+	}
+
 	for_each_of_allnodes(np) {
 		__of_attach_node_sysfs(np);
 		if (np->phandle && !phandle_cache[of_phandle_cache_hash(np->phandle)])

drivers/of/base.c void __init of_core_init(void) · line 203

Quoted 7 lines
drivers/of/base.c +1 -2
@@ -184,8 +199,7 @@ void __init of_core_init(void)
 	mutex_unlock(&of_mutex);
 
 	/* Symlink in /proc as required by userspace ABI */
-	if (of_root)
-		proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
+	proc_symlink("device-tree", NULL, "/sys/firmware/devicetree/base");
 }  

This approach is adding an additional method of unflattening the tree. I would prefer to consolidate in a single location.

I have leveraged this patch series into a different patch series to accomplish that. I have boot tested with one configuration, but want to test two more configurations before sending the new series. It should only take "a few minutes".

-Frank

Quoted 14 lines
drivers/of/base.c +0 -0
 static struct property *__of_find_property(const struct device_node *np,
drivers/of/empty_root.dts new file +6 -0
new file mode 100644
index 000000000000..cf9e97a60f48
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/dts-v1/;
+
+/ {
+
+};  
Signature · 3 lines
Clément Léger,
Embedded Linux and Kernel engineer at Bootlin
https://bootlin.com
#6 lore raw

PATCH 2/2 of: unittest: remove check for of_root

In reply to Clément Léger

Now that of_root node is always populated in of_core_init(), remove this manual tree creation and assume that the root node always exists.

---
 drivers/of/unittest.c | 10 ----------
 1 file changed, 10 deletions(-)
drivers/of/unittest.c +0 -10
index 7f6bba18c515..a787d212c0f6 100644
@@ -1469,16 +1469,6 @@ static int __init unittest_data_add(void)
 		return -EINVAL;
 	}
 
-	if (!of_root) {
-		of_root = unittest_data_node;
-		for_each_of_allnodes(np)
-			__of_attach_node_sysfs(np);
-		of_aliases = of_find_node_by_path("/aliases");
-		of_chosen = of_find_node_by_path("/chosen");
-		of_overlay_mutex_unlock();
-		return 0;
-	}
-
 	EXPECT_BEGIN(KERN_INFO,
 		     "Duplicate name in testcase-data, renamed to \"duplicate-name#1\"");
 
Signature · 1 line
2.36.1