[RFC PATCH 02/77] Introduce v18 dtb version

Herve Codina posted 77 patches 3 weeks, 5 days ago
[RFC PATCH 02/77] Introduce v18 dtb version
Posted by Herve Codina 3 weeks, 5 days ago
This v18 version will add support for
 - metadata in device-tree blobs in order to have a better handling of
   phandles and unresolved references.
 - Addon device-tree blob (successor of device-tree overlay)
 - Import and export symbols feature
 - multiple trees in a addon device-tree blob (i.e. root device tree and
   orphan node tree)

Signed-off-by: Herve Codina <herve.codina@bootlin.com>
---
 dtc.h                   |  2 +-
 fdtdump.c               |  2 +-
 flattree.c              |  2 ++
 libfdt/fdt.h            |  1 +
 libfdt/fdt_rw.c         | 13 +++++++------
 libfdt/libfdt.h         |  2 +-
 tests/pylibfdt_tests.py |  2 +-
 tests/trees.S           |  2 +-
 8 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/dtc.h b/dtc.h
index 3a220b9..186caad 100644
--- a/dtc.h
+++ b/dtc.h
@@ -29,7 +29,7 @@
 #define debug(...)
 #endif
 
-#define DEFAULT_FDT_VERSION	17
+#define DEFAULT_FDT_VERSION	18
 
 /*
  * Command line options
diff --git a/fdtdump.c b/fdtdump.c
index d424869..ec25edf 100644
--- a/fdtdump.c
+++ b/fdtdump.c
@@ -18,7 +18,7 @@
 #include "util.h"
 
 #define FDT_MAGIC_SIZE	4
-#define MAX_VERSION 17U
+#define MAX_VERSION 18U
 
 #define ALIGN(x, a)	(((x) + ((a) - 1)) & ~((a) - 1))
 #define PALIGN(p, a)	((void *)(ALIGN((uintptr_t)(p), (a))))
diff --git a/flattree.c b/flattree.c
index 30e6de2..c3887da 100644
--- a/flattree.c
+++ b/flattree.c
@@ -30,6 +30,8 @@ static struct version_info {
 	 FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_NOPS},
 	{17, 16, FDT_V17_SIZE,
 	 FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_STRUCTSIZE|FTF_NOPS},
+	{18, 18, FDT_V18_SIZE,
+	 FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_STRUCTSIZE|FTF_NOPS},
 };
 
 struct emitter {
diff --git a/libfdt/fdt.h b/libfdt/fdt.h
index a07abfc..9372353 100644
--- a/libfdt/fdt.h
+++ b/libfdt/fdt.h
@@ -62,5 +62,6 @@ struct fdt_property {
 #define FDT_V3_SIZE	(FDT_V2_SIZE + sizeof(fdt32_t))
 #define FDT_V16_SIZE	FDT_V3_SIZE
 #define FDT_V17_SIZE	(FDT_V16_SIZE + sizeof(fdt32_t))
+#define FDT_V18_SIZE	FDT_V17_SIZE
 
 #endif /* FDT_H */
diff --git a/libfdt/fdt_rw.c b/libfdt/fdt_rw.c
index 7475caf..00e32bb 100644
--- a/libfdt/fdt_rw.c
+++ b/libfdt/fdt_rw.c
@@ -28,13 +28,13 @@ static int fdt_rw_probe_(void *fdt)
 		return 0;
 	FDT_RO_PROBE(fdt);
 
-	if (!can_assume(LATEST) && fdt_version(fdt) < 17)
+	if (!can_assume(LATEST) && fdt_version(fdt) < 18)
 		return -FDT_ERR_BADVERSION;
 	if (fdt_blocks_misordered_(fdt, sizeof(struct fdt_reserve_entry),
 				   fdt_size_dt_struct(fdt)))
 		return -FDT_ERR_BADLAYOUT;
-	if (!can_assume(LATEST) && fdt_version(fdt) > 17)
-		fdt_set_version(fdt, 17);
+	if (!can_assume(LATEST) && fdt_version(fdt) > 18)
+		fdt_set_version(fdt, 18);
 
 	return 0;
 }
@@ -455,7 +455,8 @@ int fdt_open_into(const void *fdt, void *buf, int bufsize)
 		err = fdt_move(fdt, buf, bufsize);
 		if (err)
 			return err;
-		fdt_set_version(buf, 17);
+		fdt_set_version(buf, 18);
+		fdt_set_last_comp_version(buf, 18);
 		fdt_set_size_dt_struct(buf, struct_size);
 		fdt_set_totalsize(buf, bufsize);
 		return 0;
@@ -484,8 +485,8 @@ int fdt_open_into(const void *fdt, void *buf, int bufsize)
 
 	fdt_set_magic(buf, FDT_MAGIC);
 	fdt_set_totalsize(buf, bufsize);
-	fdt_set_version(buf, 17);
-	fdt_set_last_comp_version(buf, 16);
+	fdt_set_version(buf, 18);
+	fdt_set_last_comp_version(buf, 18);
 	fdt_set_boot_cpuid_phys(buf, fdt_boot_cpuid_phys(fdt));
 
 	return 0;
diff --git a/libfdt/libfdt.h b/libfdt/libfdt.h
index 7a10f66..c5cd35d 100644
--- a/libfdt/libfdt.h
+++ b/libfdt/libfdt.h
@@ -15,7 +15,7 @@ extern "C" {
 
 #define FDT_FIRST_SUPPORTED_VERSION	0x02
 #define FDT_LAST_COMPATIBLE_VERSION	0x10
-#define FDT_LAST_SUPPORTED_VERSION	0x11
+#define FDT_LAST_SUPPORTED_VERSION	0x12
 
 /* Error codes: informative error codes */
 #define FDT_ERR_NOTFOUND	1
diff --git a/tests/pylibfdt_tests.py b/tests/pylibfdt_tests.py
index a4f73ed..373e11a 100644
--- a/tests/pylibfdt_tests.py
+++ b/tests/pylibfdt_tests.py
@@ -288,7 +288,7 @@ class PyLibfdtBasicTests(unittest.TestCase):
         self.assertEqual(self.fdt.off_dt_struct(), 88)
         self.assertEqual(self.fdt.off_dt_strings(), 652)
         self.assertEqual(self.fdt.off_mem_rsvmap(), 40)
-        self.assertEqual(self.fdt.version(), 17)
+        self.assertEqual(self.fdt.version(), 18)
         self.assertEqual(self.fdt.last_comp_version(), 16)
         self.assertEqual(self.fdt.boot_cpuid_phys(), 0)
         self.assertEqual(self.fdt.size_dt_strings(), 105)
diff --git a/tests/trees.S b/tests/trees.S
index d69f7f1..ecd43bc 100644
--- a/tests/trees.S
+++ b/tests/trees.S
@@ -17,7 +17,7 @@
 	fdtlong	(\tree\()_struct - \tree)
 	fdtlong	(\tree\()_strings - \tree)
 	fdtlong	(\tree\()_rsvmap - \tree)
-	fdtlong	0x11
+	fdtlong	0x12
 	fdtlong	0x10
 	fdtlong	0
 	fdtlong	(\tree\()_strings_end - \tree\()_strings)
-- 
2.52.0
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by David Gibson 3 weeks, 3 days ago
On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:
> This v18 version will add support for
>  - metadata in device-tree blobs in order to have a better handling of
>    phandles and unresolved references.
>  - Addon device-tree blob (successor of device-tree overlay)
>  - Import and export symbols feature
>  - multiple trees in a addon device-tree blob (i.e. root device tree and
>    orphan node tree)

So, once this patch is applied, the rest of the series pretty much has
to be applied "atomically" - otherwise a version built in the interim
will be lying in saying that it supports v18.

I therefore suggest moving any changes that *can* be moved before this
patch, should be moved before this patch.  That will assist in
reviewing and merging the series piecemeal, rather than as a single
giant blob.


Regarding the content itself.  It seems like this is a pretty major
change to the dtb format - maybe that would suggest bumping the
version by more than one (e.g. like we went from v3 to v16 in the
past).

It would also be nice to have some docs for the new dtb extensions
before or at the same time as this.

> 
> Signed-off-by: Herve Codina <herve.codina@bootlin.com>
> ---
>  dtc.h                   |  2 +-
>  fdtdump.c               |  2 +-
>  flattree.c              |  2 ++
>  libfdt/fdt.h            |  1 +
>  libfdt/fdt_rw.c         | 13 +++++++------
>  libfdt/libfdt.h         |  2 +-
>  tests/pylibfdt_tests.py |  2 +-
>  tests/trees.S           |  2 +-
>  8 files changed, 15 insertions(+), 11 deletions(-)
> 
> diff --git a/dtc.h b/dtc.h
> index 3a220b9..186caad 100644
> --- a/dtc.h
> +++ b/dtc.h
> @@ -29,7 +29,7 @@
>  #define debug(...)
>  #endif
>  
> -#define DEFAULT_FDT_VERSION	17
> +#define DEFAULT_FDT_VERSION	18
>  
>  /*
>   * Command line options
> diff --git a/fdtdump.c b/fdtdump.c
> index d424869..ec25edf 100644
> --- a/fdtdump.c
> +++ b/fdtdump.c
> @@ -18,7 +18,7 @@
>  #include "util.h"
>  
>  #define FDT_MAGIC_SIZE	4
> -#define MAX_VERSION 17U
> +#define MAX_VERSION 18U
>  
>  #define ALIGN(x, a)	(((x) + ((a) - 1)) & ~((a) - 1))
>  #define PALIGN(p, a)	((void *)(ALIGN((uintptr_t)(p), (a))))
> diff --git a/flattree.c b/flattree.c
> index 30e6de2..c3887da 100644
> --- a/flattree.c
> +++ b/flattree.c
> @@ -30,6 +30,8 @@ static struct version_info {
>  	 FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_NOPS},
>  	{17, 16, FDT_V17_SIZE,
>  	 FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_STRUCTSIZE|FTF_NOPS},
> +	{18, 18, FDT_V18_SIZE,
> +	 FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_STRUCTSIZE|FTF_NOPS},
>  };
>  
>  struct emitter {
> diff --git a/libfdt/fdt.h b/libfdt/fdt.h
> index a07abfc..9372353 100644
> --- a/libfdt/fdt.h
> +++ b/libfdt/fdt.h
> @@ -62,5 +62,6 @@ struct fdt_property {
>  #define FDT_V3_SIZE	(FDT_V2_SIZE + sizeof(fdt32_t))
>  #define FDT_V16_SIZE	FDT_V3_SIZE
>  #define FDT_V17_SIZE	(FDT_V16_SIZE + sizeof(fdt32_t))
> +#define FDT_V18_SIZE	FDT_V17_SIZE
>  
>  #endif /* FDT_H */
> diff --git a/libfdt/fdt_rw.c b/libfdt/fdt_rw.c
> index 7475caf..00e32bb 100644
> --- a/libfdt/fdt_rw.c
> +++ b/libfdt/fdt_rw.c
> @@ -28,13 +28,13 @@ static int fdt_rw_probe_(void *fdt)
>  		return 0;
>  	FDT_RO_PROBE(fdt);
>  
> -	if (!can_assume(LATEST) && fdt_version(fdt) < 17)
> +	if (!can_assume(LATEST) && fdt_version(fdt) < 18)
>  		return -FDT_ERR_BADVERSION;
>  	if (fdt_blocks_misordered_(fdt, sizeof(struct fdt_reserve_entry),
>  				   fdt_size_dt_struct(fdt)))
>  		return -FDT_ERR_BADLAYOUT;
> -	if (!can_assume(LATEST) && fdt_version(fdt) > 17)
> -		fdt_set_version(fdt, 17);
> +	if (!can_assume(LATEST) && fdt_version(fdt) > 18)
> +		fdt_set_version(fdt, 18);
>  
>  	return 0;
>  }
> @@ -455,7 +455,8 @@ int fdt_open_into(const void *fdt, void *buf, int bufsize)
>  		err = fdt_move(fdt, buf, bufsize);
>  		if (err)
>  			return err;
> -		fdt_set_version(buf, 17);
> +		fdt_set_version(buf, 18);
> +		fdt_set_last_comp_version(buf, 18);
>  		fdt_set_size_dt_struct(buf, struct_size);
>  		fdt_set_totalsize(buf, bufsize);
>  		return 0;
> @@ -484,8 +485,8 @@ int fdt_open_into(const void *fdt, void *buf, int bufsize)
>  
>  	fdt_set_magic(buf, FDT_MAGIC);
>  	fdt_set_totalsize(buf, bufsize);
> -	fdt_set_version(buf, 17);
> -	fdt_set_last_comp_version(buf, 16);
> +	fdt_set_version(buf, 18);
> +	fdt_set_last_comp_version(buf, 18);
>  	fdt_set_boot_cpuid_phys(buf, fdt_boot_cpuid_phys(fdt));
>  
>  	return 0;
> diff --git a/libfdt/libfdt.h b/libfdt/libfdt.h
> index 7a10f66..c5cd35d 100644
> --- a/libfdt/libfdt.h
> +++ b/libfdt/libfdt.h
> @@ -15,7 +15,7 @@ extern "C" {
>  
>  #define FDT_FIRST_SUPPORTED_VERSION	0x02
>  #define FDT_LAST_COMPATIBLE_VERSION	0x10
> -#define FDT_LAST_SUPPORTED_VERSION	0x11
> +#define FDT_LAST_SUPPORTED_VERSION	0x12
>  
>  /* Error codes: informative error codes */
>  #define FDT_ERR_NOTFOUND	1
> diff --git a/tests/pylibfdt_tests.py b/tests/pylibfdt_tests.py
> index a4f73ed..373e11a 100644
> --- a/tests/pylibfdt_tests.py
> +++ b/tests/pylibfdt_tests.py
> @@ -288,7 +288,7 @@ class PyLibfdtBasicTests(unittest.TestCase):
>          self.assertEqual(self.fdt.off_dt_struct(), 88)
>          self.assertEqual(self.fdt.off_dt_strings(), 652)
>          self.assertEqual(self.fdt.off_mem_rsvmap(), 40)
> -        self.assertEqual(self.fdt.version(), 17)
> +        self.assertEqual(self.fdt.version(), 18)
>          self.assertEqual(self.fdt.last_comp_version(), 16)
>          self.assertEqual(self.fdt.boot_cpuid_phys(), 0)
>          self.assertEqual(self.fdt.size_dt_strings(), 105)
> diff --git a/tests/trees.S b/tests/trees.S
> index d69f7f1..ecd43bc 100644
> --- a/tests/trees.S
> +++ b/tests/trees.S
> @@ -17,7 +17,7 @@
>  	fdtlong	(\tree\()_struct - \tree)
>  	fdtlong	(\tree\()_strings - \tree)
>  	fdtlong	(\tree\()_rsvmap - \tree)
> -	fdtlong	0x11
> +	fdtlong	0x12
>  	fdtlong	0x10
>  	fdtlong	0
>  	fdtlong	(\tree\()_strings_end - \tree\()_strings)
> -- 
> 2.52.0
> 
> 

-- 
David Gibson (he or they)	| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you, not the other way
				| around.
http://www.ozlabs.org/~dgibson
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by Herve Codina 3 weeks, 2 days ago
Hi David,

On Thu, 15 Jan 2026 11:12:49 +1100
David Gibson <david@gibson.dropbear.id.au> wrote:

> On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:
> > This v18 version will add support for
> >  - metadata in device-tree blobs in order to have a better handling of
> >    phandles and unresolved references.
> >  - Addon device-tree blob (successor of device-tree overlay)
> >  - Import and export symbols feature
> >  - multiple trees in a addon device-tree blob (i.e. root device tree and
> >    orphan node tree)  
> 
> So, once this patch is applied, the rest of the series pretty much has
> to be applied "atomically" - otherwise a version built in the interim
> will be lying in saying that it supports v18.
> 
> I therefore suggest moving any changes that *can* be moved before this
> patch, should be moved before this patch.  That will assist in
> reviewing and merging the series piecemeal, rather than as a single
> giant blob.
> 
> 
> Regarding the content itself.  It seems like this is a pretty major
> change to the dtb format - maybe that would suggest bumping the
> version by more than one (e.g. like we went from v3 to v16 in the
> past).

I see your point.

Maybe the Rob's idea related to 'unknown tag' and the suggestion I did [1]
related to the generic tag value definition to support those 'unknown tag'
could help here.

As a reminder here, this generic tag value definition consist in:
--- 8< ---
A tag value is on 32bits. We can define the structure of this value.
  - bit 31 (msb):
     - 0: This is not a new kind to tag and so it doesn't follow this definition.
          All existing tags are in this category
     - 1: New kind of tag adopting this definition

  - bits 30..28:
     tag data length encoding
     0b000: No data related to the tag
     0b001: 1 data cell (u32) directly follows the tag
     0b010: 2 data cells (2 u32) directly follow the tag
     ...
     0b110: 6 data cells (6 u32) directly follow the tag
     0b111: Tag is followed by a cell (u32) indicating the size (in bytes)
            of data available just after this cell (including any padding
            if needed).
	    Because this size include some possible padding, its value is a
            multiple of 4 bytes.
            The offset of the tag + 4 + size points to the next tag.
          

  - bit 27..0
     tag specific identifier
--- 8< ---

I mean dtb version v20 could be:

 - New header size with dt_flags added in the header (if this new field is
   kept).

 - Support for the generic tag values and so the notion of 'unknown tag'

With that done, everything else added afterward will have no impact on the
dtb format itself.

Only libfdt and dtc will have versions defined at some point with support for
some new flags or new keyword.

What do you think about this v20 dtb version?

> 
> It would also be nice to have some docs for the new dtb extensions
> before or at the same time as this.

Yes, the generic tag value definition.


[1] https://lore.kernel.org/all/20260114171822.2a44d2a5@bootlin.com/

Best regards
Hervé
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by David Gibson 2 weeks, 6 days ago
On Fri, Jan 16, 2026 at 10:09:34AM +0100, Herve Codina wrote:
> Hi David,
> 
> On Thu, 15 Jan 2026 11:12:49 +1100
> David Gibson <david@gibson.dropbear.id.au> wrote:
> 
> > On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:
> > > This v18 version will add support for
> > >  - metadata in device-tree blobs in order to have a better handling of
> > >    phandles and unresolved references.
> > >  - Addon device-tree blob (successor of device-tree overlay)
> > >  - Import and export symbols feature
> > >  - multiple trees in a addon device-tree blob (i.e. root device tree and
> > >    orphan node tree)  
> > 
> > So, once this patch is applied, the rest of the series pretty much has
> > to be applied "atomically" - otherwise a version built in the interim
> > will be lying in saying that it supports v18.
> > 
> > I therefore suggest moving any changes that *can* be moved before this
> > patch, should be moved before this patch.  That will assist in
> > reviewing and merging the series piecemeal, rather than as a single
> > giant blob.
> > 
> > 
> > Regarding the content itself.  It seems like this is a pretty major
> > change to the dtb format - maybe that would suggest bumping the
> > version by more than one (e.g. like we went from v3 to v16 in the
> > past).
> 
> I see your point.
> 
> Maybe the Rob's idea related to 'unknown tag' and the suggestion I did [1]
> related to the generic tag value definition to support those 'unknown tag'
> could help here.

Having a standard encoding of tag length so unknown tags can be
skipped is a reasonable idea.  I think you do need provision to mark a
tag as "safe to ignore" or not - e.g. something like FDT_BEGIN_NODE
could never be safely ignored.

> As a reminder here, this generic tag value definition consist in:
> --- 8< ---
> A tag value is on 32bits. We can define the structure of this value.
>   - bit 31 (msb):
>      - 0: This is not a new kind to tag and so it doesn't follow this definition.
>           All existing tags are in this category
>      - 1: New kind of tag adopting this definition
> 
>   - bits 30..28:
>      tag data length encoding
>      0b000: No data related to the tag
>      0b001: 1 data cell (u32) directly follows the tag
>      0b010: 2 data cells (2 u32) directly follow the tag
>      ...
>      0b110: 6 data cells (6 u32) directly follow the tag
>      0b111: Tag is followed by a cell (u32) indicating the size (in bytes)
>             of data available just after this cell (including any padding
>             if needed).

I'd suggesting giving a byte length not including alignment padding.
That way if you wanted to encode a bytestring in there, you wouldn't
need a way of encoding the unpadded length in adddition to the
standard way encoding the padded length.

> 	    Because this size include some possible padding, its value is a
>             multiple of 4 bytes.
>             The offset of the tag + 4 + size points to the next tag.
>           
> 
>   - bit 27..0
>      tag specific identifier
> --- 8< ---
> 
> I mean dtb version v20 could be:
> 
>  - New header size with dt_flags added in the header (if this new field is
>    kept).
> 
>  - Support for the generic tag values and so the notion of 'unknown tag'
> 
> With that done, everything else added afterward will have no impact on the
> dtb format itself.

Well... maybe.  It's not entirely clear to me whether all the new tags
can be safely ignored by something that doesn't understand them.
e.g. a consumer can't safely ignore the tags which give unresolved
phandle references if it then expects the phandle values in the actual
property values to be correct.
> 
> Only libfdt and dtc will have versions defined at some point with support for
> some new flags or new keyword.
> 
> What do you think about this v20 dtb version?
> 
> > 
> > It would also be nice to have some docs for the new dtb extensions
> > before or at the same time as this.
> 
> Yes, the generic tag value definition.

We'd want that, but it's not enough.  The specific tag types should be
documented as well.

> 
> 
> [1] https://lore.kernel.org/all/20260114171822.2a44d2a5@bootlin.com/
> 
> Best regards
> Hervé
> 

-- 
David Gibson (he or they)	| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you, not the other way
				| around.
http://www.ozlabs.org/~dgibson
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by Rob Herring 2 weeks, 4 days ago
On Sun, Jan 18, 2026 at 11:18 PM David Gibson
<david@gibson.dropbear.id.au> wrote:
>
> On Fri, Jan 16, 2026 at 10:09:34AM +0100, Herve Codina wrote:
> > Hi David,
> >
> > On Thu, 15 Jan 2026 11:12:49 +1100
> > David Gibson <david@gibson.dropbear.id.au> wrote:
> >
> > > On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:
> > > > This v18 version will add support for
> > > >  - metadata in device-tree blobs in order to have a better handling of
> > > >    phandles and unresolved references.
> > > >  - Addon device-tree blob (successor of device-tree overlay)
> > > >  - Import and export symbols feature
> > > >  - multiple trees in a addon device-tree blob (i.e. root device tree and
> > > >    orphan node tree)
> > >
> > > So, once this patch is applied, the rest of the series pretty much has
> > > to be applied "atomically" - otherwise a version built in the interim
> > > will be lying in saying that it supports v18.
> > >
> > > I therefore suggest moving any changes that *can* be moved before this
> > > patch, should be moved before this patch.  That will assist in
> > > reviewing and merging the series piecemeal, rather than as a single
> > > giant blob.
> > >
> > >
> > > Regarding the content itself.  It seems like this is a pretty major
> > > change to the dtb format - maybe that would suggest bumping the
> > > version by more than one (e.g. like we went from v3 to v16 in the
> > > past).
> >
> > I see your point.
> >
> > Maybe the Rob's idea related to 'unknown tag' and the suggestion I did [1]
> > related to the generic tag value definition to support those 'unknown tag'
> > could help here.
>
> Having a standard encoding of tag length so unknown tags can be
> skipped is a reasonable idea.  I think you do need provision to mark a
> tag as "safe to ignore" or not - e.g. something like FDT_BEGIN_NODE
> could never be safely ignored.
>
> > As a reminder here, this generic tag value definition consist in:
> > --- 8< ---
> > A tag value is on 32bits. We can define the structure of this value.
> >   - bit 31 (msb):
> >      - 0: This is not a new kind to tag and so it doesn't follow this definition.
> >           All existing tags are in this category
> >      - 1: New kind of tag adopting this definition
> >
> >   - bits 30..28:
> >      tag data length encoding
> >      0b000: No data related to the tag
> >      0b001: 1 data cell (u32) directly follows the tag
> >      0b010: 2 data cells (2 u32) directly follow the tag
> >      ...
> >      0b110: 6 data cells (6 u32) directly follow the tag
> >      0b111: Tag is followed by a cell (u32) indicating the size (in bytes)
> >             of data available just after this cell (including any padding
> >             if needed).
>
> I'd suggesting giving a byte length not including alignment padding.
> That way if you wanted to encode a bytestring in there, you wouldn't
> need a way of encoding the unpadded length in adddition to the
> standard way encoding the padded length.
>
> >           Because this size include some possible padding, its value is a
> >             multiple of 4 bytes.
> >             The offset of the tag + 4 + size points to the next tag.
> >
> >
> >   - bit 27..0
> >      tag specific identifier
> > --- 8< ---
> >
> > I mean dtb version v20 could be:
> >
> >  - New header size with dt_flags added in the header (if this new field is
> >    kept).
> >
> >  - Support for the generic tag values and so the notion of 'unknown tag'
> >
> > With that done, everything else added afterward will have no impact on the
> > dtb format itself.
>
> Well... maybe.  It's not entirely clear to me whether all the new tags
> can be safely ignored by something that doesn't understand them.
> e.g. a consumer can't safely ignore the tags which give unresolved
> phandle references if it then expects the phandle values in the actual
> property values to be correct.

I think we'd want some higher level "this is an addon or base DT" than
presence of tags. Maybe that's just the version. Perhaps a new header
field to say this is a base or addon DT. Or both?

Everything in this series intended for the base DT should be safe to
ignore just as __symbols__ (and __local_fixups__ if you add /plugin/)
is safe to ignore. It's only software that understands and wants to
use the new "addons" that needs to understand.

Rob
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by David Gibson 1 week, 3 days ago
On Tue, Jan 20, 2026 at 02:38:45PM -0600, Rob Herring wrote:
> On Sun, Jan 18, 2026 at 11:18 PM David Gibson
> <david@gibson.dropbear.id.au> wrote:
> >
> > On Fri, Jan 16, 2026 at 10:09:34AM +0100, Herve Codina wrote:
> > > Hi David,
> > >
> > > On Thu, 15 Jan 2026 11:12:49 +1100
> > > David Gibson <david@gibson.dropbear.id.au> wrote:
> > >
> > > > On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:
> > > > > This v18 version will add support for
> > > > >  - metadata in device-tree blobs in order to have a better handling of
> > > > >    phandles and unresolved references.
> > > > >  - Addon device-tree blob (successor of device-tree overlay)
> > > > >  - Import and export symbols feature
> > > > >  - multiple trees in a addon device-tree blob (i.e. root device tree and
> > > > >    orphan node tree)
> > > >
> > > > So, once this patch is applied, the rest of the series pretty much has
> > > > to be applied "atomically" - otherwise a version built in the interim
> > > > will be lying in saying that it supports v18.
> > > >
> > > > I therefore suggest moving any changes that *can* be moved before this
> > > > patch, should be moved before this patch.  That will assist in
> > > > reviewing and merging the series piecemeal, rather than as a single
> > > > giant blob.
> > > >
> > > >
> > > > Regarding the content itself.  It seems like this is a pretty major
> > > > change to the dtb format - maybe that would suggest bumping the
> > > > version by more than one (e.g. like we went from v3 to v16 in the
> > > > past).
> > >
> > > I see your point.
> > >
> > > Maybe the Rob's idea related to 'unknown tag' and the suggestion I did [1]
> > > related to the generic tag value definition to support those 'unknown tag'
> > > could help here.
> >
> > Having a standard encoding of tag length so unknown tags can be
> > skipped is a reasonable idea.  I think you do need provision to mark a
> > tag as "safe to ignore" or not - e.g. something like FDT_BEGIN_NODE
> > could never be safely ignored.
> >
> > > As a reminder here, this generic tag value definition consist in:
> > > --- 8< ---
> > > A tag value is on 32bits. We can define the structure of this value.
> > >   - bit 31 (msb):
> > >      - 0: This is not a new kind to tag and so it doesn't follow this definition.
> > >           All existing tags are in this category
> > >      - 1: New kind of tag adopting this definition
> > >
> > >   - bits 30..28:
> > >      tag data length encoding
> > >      0b000: No data related to the tag
> > >      0b001: 1 data cell (u32) directly follows the tag
> > >      0b010: 2 data cells (2 u32) directly follow the tag
> > >      ...
> > >      0b110: 6 data cells (6 u32) directly follow the tag
> > >      0b111: Tag is followed by a cell (u32) indicating the size (in bytes)
> > >             of data available just after this cell (including any padding
> > >             if needed).
> >
> > I'd suggesting giving a byte length not including alignment padding.
> > That way if you wanted to encode a bytestring in there, you wouldn't
> > need a way of encoding the unpadded length in adddition to the
> > standard way encoding the padded length.
> >
> > >           Because this size include some possible padding, its value is a
> > >             multiple of 4 bytes.
> > >             The offset of the tag + 4 + size points to the next tag.
> > >
> > >
> > >   - bit 27..0
> > >      tag specific identifier
> > > --- 8< ---
> > >
> > > I mean dtb version v20 could be:
> > >
> > >  - New header size with dt_flags added in the header (if this new field is
> > >    kept).
> > >
> > >  - Support for the generic tag values and so the notion of 'unknown tag'
> > >
> > > With that done, everything else added afterward will have no impact on the
> > > dtb format itself.
> >
> > Well... maybe.  It's not entirely clear to me whether all the new tags
> > can be safely ignored by something that doesn't understand them.
> > e.g. a consumer can't safely ignore the tags which give unresolved
> > phandle references if it then expects the phandle values in the actual
> > property values to be correct.
> 
> I think we'd want some higher level "this is an addon or base DT" than
> presence of tags. Maybe that's just the version. Perhaps a new header
> field to say this is a base or addon DT. Or both?

I think Herve's flags proposed flags field does that.  I tend to
prefer the idea of using new and different magic numbers for the
variant forms though - makes it really clear that they're a different
thing from a "normal" fdt.

> 
> Everything in this series intended for the base DT should be safe to
> ignore just as __symbols__ (and __local_fixups__ if you add /plugin/)
> is safe to ignore.

That kind of depends what you're doing with the DT.  If you need to do
phandle lookups, you can't safely ignore the fixups.

> It's only software that understands and wants to
> use the new "addons" that needs to understand.
> 
> Rob
> 

-- 
David Gibson (he or they)	| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you, not the other way
				| around.
http://www.ozlabs.org/~dgibson
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by Herve Codina 2 weeks, 6 days ago
On Mon, 19 Jan 2026 16:13:35 +1100
David Gibson <david@gibson.dropbear.id.au> wrote:

> On Fri, Jan 16, 2026 at 10:09:34AM +0100, Herve Codina wrote:
> > Hi David,
> > 
> > On Thu, 15 Jan 2026 11:12:49 +1100
> > David Gibson <david@gibson.dropbear.id.au> wrote:
> >   
> > > On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:  
> > > > This v18 version will add support for
> > > >  - metadata in device-tree blobs in order to have a better handling of
> > > >    phandles and unresolved references.
> > > >  - Addon device-tree blob (successor of device-tree overlay)
> > > >  - Import and export symbols feature
> > > >  - multiple trees in a addon device-tree blob (i.e. root device tree and
> > > >    orphan node tree)    
> > > 
> > > So, once this patch is applied, the rest of the series pretty much has
> > > to be applied "atomically" - otherwise a version built in the interim
> > > will be lying in saying that it supports v18.
> > > 
> > > I therefore suggest moving any changes that *can* be moved before this
> > > patch, should be moved before this patch.  That will assist in
> > > reviewing and merging the series piecemeal, rather than as a single
> > > giant blob.
> > > 
> > > 
> > > Regarding the content itself.  It seems like this is a pretty major
> > > change to the dtb format - maybe that would suggest bumping the
> > > version by more than one (e.g. like we went from v3 to v16 in the
> > > past).  
> > 
> > I see your point.
> > 
> > Maybe the Rob's idea related to 'unknown tag' and the suggestion I did [1]
> > related to the generic tag value definition to support those 'unknown tag'
> > could help here.  
> 
> Having a standard encoding of tag length so unknown tags can be
> skipped is a reasonable idea.  I think you do need provision to mark a
> tag as "safe to ignore" or not - e.g. something like FDT_BEGIN_NODE
> could never be safely ignored.

A bit can be used for marking a tag as "safe to ignore if unknown".
I can reduce the bits 30..28 field.

bit 30:
 - 0b0: Do not ignore this tag if the tag id is unknown.
        If this tag id is unknown an error in the parsing should be reported.
 - 0b1: This tag can be safely ignore if its id is unknown. I that case the
        tag and its related data are simply skipped.

bits 29..28:
 - 0b00: No data
 - 0b01: tag followed by 1 cell (u32) data
 - 0b10: tag followed by 2 cells (2 x u32) data
 - 0b11: Tag is followed by a cell (u32) indicating the size of following
         data

Also, it is worth noting that the 0x0....... tag value family can still be
used.

Even if related to "old" tags, if a tag in this family is an unknwown tag,
the parser will report an error (at least because it doesn't know how to
skip the data part).

> 
> > As a reminder here, this generic tag value definition consist in:
> > --- 8< ---
> > A tag value is on 32bits. We can define the structure of this value.
> >   - bit 31 (msb):
> >      - 0: This is not a new kind to tag and so it doesn't follow this definition.
> >           All existing tags are in this category
> >      - 1: New kind of tag adopting this definition
> > 
> >   - bits 30..28:
> >      tag data length encoding
> >      0b000: No data related to the tag
> >      0b001: 1 data cell (u32) directly follows the tag
> >      0b010: 2 data cells (2 u32) directly follow the tag
> >      ...
> >      0b110: 6 data cells (6 u32) directly follow the tag
> >      0b111: Tag is followed by a cell (u32) indicating the size (in bytes)
> >             of data available just after this cell (including any padding
> >             if needed).  
> 
> I'd suggesting giving a byte length not including alignment padding.
> That way if you wanted to encode a bytestring in there, you wouldn't
> need a way of encoding the unpadded length in adddition to the
> standard way encoding the padded length.

And so, next tag is always length + sizeof(padding). Next tag is aligned
on 32bits.

> 
> > 	    Because this size include some possible padding, its value is a
> >             multiple of 4 bytes.
> >             The offset of the tag + 4 + size points to the next tag.
> >           
> > 
> >   - bit 27..0
> >      tag specific identifier
> > --- 8< ---
> > 
> > I mean dtb version v20 could be:
> > 
> >  - New header size with dt_flags added in the header (if this new field is
> >    kept).
> > 
> >  - Support for the generic tag values and so the notion of 'unknown tag'
> > 
> > With that done, everything else added afterward will have no impact on the
> > dtb format itself.  
> 
> Well... maybe.  It's not entirely clear to me whether all the new tags
> can be safely ignored by something that doesn't understand them.
> e.g. a consumer can't safely ignore the tags which give unresolved
> phandle references if it then expects the phandle values in the actual
> property values to be correct.

I would say that it depends on new (future) tags.

For instance, FDT_EXPORT_SYM, the tag used for exported symbols can be ignore
by the bootloader if it doesn't know about this tag.
Indeed, it doesn't need to understand and manipulate this tag. It just needs to
keep it in the dtb passed to the kernel.

> > 
> > Only libfdt and dtc will have versions defined at some point with support for
> > some new flags or new keyword.
> > 
> > What do you think about this v20 dtb version?
> >   
> > > 
> > > It would also be nice to have some docs for the new dtb extensions
> > > before or at the same time as this.  
> > 
> > Yes, the generic tag value definition.  
> 
> We'd want that, but it's not enough.  The specific tag types should be
> documented as well.

Yes they will be documented as soon as they are introduced.

The generic tag value definition is the first step to have in docs to allow
the "skip if unknown" feature.

Best regards,
Hervé
Re: [RFC PATCH 02/77] Introduce v18 dtb version
Posted by David Gibson 1 week, 4 days ago
On Mon, Jan 19, 2026 at 10:48:52AM +0100, Herve Codina wrote:
> On Mon, 19 Jan 2026 16:13:35 +1100
> David Gibson <david@gibson.dropbear.id.au> wrote:
> 
> > On Fri, Jan 16, 2026 at 10:09:34AM +0100, Herve Codina wrote:
> > > Hi David,
> > > 
> > > On Thu, 15 Jan 2026 11:12:49 +1100
> > > David Gibson <david@gibson.dropbear.id.au> wrote:
> > >   
> > > > On Mon, Jan 12, 2026 at 03:18:52PM +0100, Herve Codina wrote:  
> > > > > This v18 version will add support for
> > > > >  - metadata in device-tree blobs in order to have a better handling of
> > > > >    phandles and unresolved references.
> > > > >  - Addon device-tree blob (successor of device-tree overlay)
> > > > >  - Import and export symbols feature
> > > > >  - multiple trees in a addon device-tree blob (i.e. root device tree and
> > > > >    orphan node tree)    
> > > > 
> > > > So, once this patch is applied, the rest of the series pretty much has
> > > > to be applied "atomically" - otherwise a version built in the interim
> > > > will be lying in saying that it supports v18.
> > > > 
> > > > I therefore suggest moving any changes that *can* be moved before this
> > > > patch, should be moved before this patch.  That will assist in
> > > > reviewing and merging the series piecemeal, rather than as a single
> > > > giant blob.
> > > > 
> > > > 
> > > > Regarding the content itself.  It seems like this is a pretty major
> > > > change to the dtb format - maybe that would suggest bumping the
> > > > version by more than one (e.g. like we went from v3 to v16 in the
> > > > past).  
> > > 
> > > I see your point.
> > > 
> > > Maybe the Rob's idea related to 'unknown tag' and the suggestion I did [1]
> > > related to the generic tag value definition to support those 'unknown tag'
> > > could help here.  
> > 
> > Having a standard encoding of tag length so unknown tags can be
> > skipped is a reasonable idea.  I think you do need provision to mark a
> > tag as "safe to ignore" or not - e.g. something like FDT_BEGIN_NODE
> > could never be safely ignored.
> 
> A bit can be used for marking a tag as "safe to ignore if unknown".
> I can reduce the bits 30..28 field.
> 
> bit 30:
>  - 0b0: Do not ignore this tag if the tag id is unknown.
>         If this tag id is unknown an error in the parsing should be reported.
>  - 0b1: This tag can be safely ignore if its id is unknown. I that case the
>         tag and its related data are simply skipped.
> 
> bits 29..28:
>  - 0b00: No data
>  - 0b01: tag followed by 1 cell (u32) data
>  - 0b10: tag followed by 2 cells (2 x u32) data
>  - 0b11: Tag is followed by a cell (u32) indicating the size of following
>          data
> 
> Also, it is worth noting that the 0x0....... tag value family can still be
> used.

Actually, that's a good point.  We can do this more simply: the new
ranges with defined lengths are only used for ignorable tags.  If we
need to add new tags which aren't safe to ignore, they go in the 0x0
range, like the existing tags.

> Even if related to "old" tags, if a tag in this family is an unknwown tag,
> the parser will report an error (at least because it doesn't know how to
> skip the data part).
> 
> > 
> > > As a reminder here, this generic tag value definition consist in:
> > > --- 8< ---
> > > A tag value is on 32bits. We can define the structure of this value.
> > >   - bit 31 (msb):
> > >      - 0: This is not a new kind to tag and so it doesn't follow this definition.
> > >           All existing tags are in this category
> > >      - 1: New kind of tag adopting this definition
> > > 
> > >   - bits 30..28:
> > >      tag data length encoding
> > >      0b000: No data related to the tag
> > >      0b001: 1 data cell (u32) directly follows the tag
> > >      0b010: 2 data cells (2 u32) directly follow the tag
> > >      ...
> > >      0b110: 6 data cells (6 u32) directly follow the tag
> > >      0b111: Tag is followed by a cell (u32) indicating the size (in bytes)
> > >             of data available just after this cell (including any padding
> > >             if needed).  
> > 
> > I'd suggesting giving a byte length not including alignment padding.
> > That way if you wanted to encode a bytestring in there, you wouldn't
> > need a way of encoding the unpadded length in adddition to the
> > standard way encoding the padded length.
> 
> And so, next tag is always length + sizeof(padding). Next tag is aligned
> on 32bits.

Exactly.  Or to make it clearer that we don't need any additional
information, next tag is at ALIGN_UP(length, FDT_TAG_SIZE).  We
already do something like this with with FDT_BEGIN_NODE tags - we
ignore bytes to realign after the node name string.

> > > 	    Because this size include some possible padding, its value is a
> > >             multiple of 4 bytes.
> > >             The offset of the tag + 4 + size points to the next tag.
> > >           
> > > 
> > >   - bit 27..0
> > >      tag specific identifier
> > > --- 8< ---
> > > 
> > > I mean dtb version v20 could be:
> > > 
> > >  - New header size with dt_flags added in the header (if this new field is
> > >    kept).
> > > 
> > >  - Support for the generic tag values and so the notion of 'unknown tag'
> > > 
> > > With that done, everything else added afterward will have no impact on the
> > > dtb format itself.  
> > 
> > Well... maybe.  It's not entirely clear to me whether all the new tags
> > can be safely ignored by something that doesn't understand them.
> > e.g. a consumer can't safely ignore the tags which give unresolved
> > phandle references if it then expects the phandle values in the actual
> > property values to be correct.
> 
> I would say that it depends on new (future) tags.

Certainly.

> For instance, FDT_EXPORT_SYM, the tag used for exported symbols can be ignore
> by the bootloader if it doesn't know about this tag.
> Indeed, it doesn't need to understand and manipulate this tag. It just needs to
> keep it in the dtb passed to the kernel.

Ow, that's when it gets complicated.  Whether a tag is safely
ignorable depends on what the consumer is doing with it.  Fixups and
exports can be safely ignored by something just passing it through.
However reference fixups *can't* be safely ignored by something that
will consult phandles, because they might not be correct until the
fixups are applied.

> > > Only libfdt and dtc will have versions defined at some point with support for
> > > some new flags or new keyword.
> > > 
> > > What do you think about this v20 dtb version?
> > >   
> > > > 
> > > > It would also be nice to have some docs for the new dtb extensions
> > > > before or at the same time as this.  
> > > 
> > > Yes, the generic tag value definition.  
> > 
> > We'd want that, but it's not enough.  The specific tag types should be
> > documented as well.
> 
> Yes they will be documented as soon as they are introduced.
> 
> The generic tag value definition is the first step to have in docs to allow
> the "skip if unknown" feature.
> 
> Best regards,
> Hervé
> 

-- 
David Gibson (he or they)	| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you, not the other way
				| around.
http://www.ozlabs.org/~dgibson