Skip to contentSkip to conversation

image-fdt: save name of FIT configuration in '/chosen' node

PATCH Superseded Daniel Golle 2 participants 5 messages Mar 21, 2022 – Mar 22, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 image-fdt: save name of FIT configuration in '/chosen' node

It can be useful for the OS (Linux) to know which configuration has been chosen by U-Boot when launching a FIT image.
Store the name of the FIT configuration node used in a new string attribute called 'bootconf' in the '/chosen' node in device tree.

---
 boot/image-fdt.c | 6 ++++++
 1 file changed, 6 insertions(+)
boot/image-fdt.c +6 -0
index 692a9ad3e4..4017bc94a6 100644
@@ -601,6 +601,12 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob,
 		goto err;
 	}
 
+	/* Store name of configuration node as bootconf in /chosen node */
+	if (images->fit_uname_cfg)
+		fdt_find_and_setprop(blob, "/chosen", "bootconf",
+					images->fit_uname_cfg,
+					strlen(images->fit_uname_cfg) + 1, 1);
+
 	/* Update ethernet nodes */
 	fdt_fixup_ethernet(blob);
 #if CONFIG_IS_ENABLED(CMD_PSTORE)
Signature · 1 line
2.35.1
#1 lore raw
Quoted 4 lines · Daniel Golle

It can be useful for the OS (Linux) to know which configuration has been chosen by U-Boot when launching a FIT image.
Store the name of the FIT configuration node used in a new string attribute called 'bootconf' in the '/chosen' node in device tree.

Please, point out where you want to use that information. I cannot see that the Linux kernel will make any use of it.

Quoted 11 lines
---
  boot/image-fdt.c | 6 ++++++
  1 file changed, 6 insertions(+)
boot/image-fdt.c +0 -0
index 692a9ad3e4..4017bc94a6 100644

boot/image-fdt.c int image_setup_libfdt(bootm_headers_t *images, void *blob, · line 609

Quoted 9 lines
boot/image-fdt.c +6 -0
@@ -601,6 +601,12 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob,
  		goto err;
  	}
 
+	/* Store name of configuration node as bootconf in /chosen node */
+	if (images->fit_uname_cfg)
+		fdt_find_and_setprop(blob, "/chosen", "bootconf",
+					images->fit_uname_cfg,
+					strlen(images->fit_uname_cfg) + 1, 1);
+

We should not inject arbitrary properties into the device-tree. Where is the property /chosen/bootconf defined in the Linux documentation or in the device-tree specification?

Best regards

Heinrich

Quoted 3 lines
boot/image-fdt.c +0 -0
  	/* Update ethernet nodes */
  	fdt_fixup_ethernet(blob);
  #if CONFIG_IS_ENABLED(CMD_PSTORE)
#2 lore raw

Hi Heinrich,

Quoted 8 lines · Heinrich Schuchardt
Quoted 4 lines · Daniel Golle

It can be useful for the OS (Linux) to know which configuration has been chosen by U-Boot when launching a FIT image.
Store the name of the FIT configuration node used in a new string attribute called 'bootconf' in the '/chosen' node in device tree.

Please, point out where you want to use that information. I cannot see that the Linux kernel will make any use of it.

It can be useful when parsing FIT image in kernel, but can also be useful in userspace (via /sys/firmware/devicetree/base/chosen/bootconf). For OpenWrt I've written a uImage.FIT partition parser in order to allow a single type of firmware image containing kernel, dtb and rootfs to work accross all storage types (SPI-NOR/mtd, NAND/ubi, eMMC/block).

I haven't yet submitted it upstream, exactly because some edges like selection of configuration would need to be discussed first.

https://git.openwrt.org/?p=openwrt/openwrt.git;a=blob;f=target/linux/generic/files/block/partitions/fit.c;h=89b5fb3454f0b69cdcfe53958169fb2a6f9c48a9;hb=HEAD

However, it's doing the job for a bunch of OpenWrt boards already, incl. some popular devices

https://openwrt.org/toh/linksys/e8450
(boots from SPI-NAND/ubi)

https://openwrt.org/toh/sinovoip/bananapi_bpi-r64_v1.1
(can boot from SD Card, eMMC or SPI-NAND/ubi)

Using uImage.FIT to store the squashfs besides kernel and dtb has several obvious advantages which are hard to obtain in any other way:
* single image accross NOR/mtd, NAND/ubi and MMC/block devices
* dynamically sized sub-partitions for kernel and rootfs
* hash also for rootfs checked by U-Boot before launching kernel
* images may include additional filesystems e.g. for localization or brandinge (hence the need to parse the boot configuration when mapping the 'filesystem' subimages into block partitions).

Quoted 15 lines
Quoted 15 lines
---
  boot/image-fdt.c | 6 ++++++
  1 file changed, 6 insertions(+)
boot/image-fdt.c +0 -0
index 692a9ad3e4..4017bc94a6 100644
@@ -601,6 +601,12 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob,
  		goto err;
  	}
 
Quoted 10 lines

boot/image-fdt.c int image_setup_libfdt(bootm_headers_t *images, void *blob, · line 609

Quoted 6 lines
boot/image-fdt.c +6 -0
+	/* Store name of configuration node as bootconf in /chosen node */
+	if (images->fit_uname_cfg)
+		fdt_find_and_setprop(blob, "/chosen", "bootconf",
+					images->fit_uname_cfg,
+					strlen(images->fit_uname_cfg) + 1, 1);
+

We should not inject arbitrary properties into the device-tree. Where is the property /chosen/bootconf defined in the Linux documentation or in the device-tree specification?

From Linux Documenation (chosen.txt):
"The chosen node does not represent a real device, but serves as a place
for passing data between firmware and the operating system, like boot arguments."

From Device Tree specification (Release v0.3):
"The /chosen node does not represent a real device in the system but
describes parameters chosen or specified by the system firmware at run time."

So to me it sounds like the right place for an additional attribute serving the above purpose. It could as well become an additional kernel cmdline argument in (ie. appended to 'bootargs' in '/chosen'), but that seemed more complex and harder to deal with.

The name could be changed into something like 'denx,boot-configuration' if 'bootconf' is perceived to be too generic.

Cheers

Daniel

#3 lore raw
Quoted 77 lines · Daniel Golle

Hi Heinrich,

Quoted 8 lines · Heinrich Schuchardt
Quoted 4 lines · Daniel Golle

It can be useful for the OS (Linux) to know which configuration has been chosen by U-Boot when launching a FIT image.
Store the name of the FIT configuration node used in a new string attribute called 'bootconf' in the '/chosen' node in device tree.

Please, point out where you want to use that information. I cannot see that the Linux kernel will make any use of it.

It can be useful when parsing FIT image in kernel, but can also be useful in userspace (via /sys/firmware/devicetree/base/chosen/bootconf). For OpenWrt I've written a uImage.FIT partition parser in order to allow a single type of firmware image containing kernel, dtb and rootfs to work accross all storage types (SPI-NOR/mtd, NAND/ubi, eMMC/block).

I haven't yet submitted it upstream, exactly because some edges like selection of configuration would need to be discussed first.

https://git.openwrt.org/?p=openwrt/openwrt.git;a=blob;f=target/linux/generic/files/block/partitions/fit.c;h=89b5fb3454f0b69cdcfe53958169fb2a6f9c48a9;hb=HEAD

However, it's doing the job for a bunch of OpenWrt boards already, incl. some popular devices

https://openwrt.org/toh/linksys/e8450
(boots from SPI-NAND/ubi)

https://openwrt.org/toh/sinovoip/bananapi_bpi-r64_v1.1
(can boot from SD Card, eMMC or SPI-NAND/ubi)

Using uImage.FIT to store the squashfs besides kernel and dtb has several obvious advantages which are hard to obtain in any other way:
* single image accross NOR/mtd, NAND/ubi and MMC/block devices
* dynamically sized sub-partitions for kernel and rootfs
* hash also for rootfs checked by U-Boot before launching kernel
* images may include additional filesystems e.g. for localization or brandinge (hence the need to parse the boot configuration when mapping the 'filesystem' subimages into block partitions).

Quoted 26 lines
Quoted 12 lines
---
   boot/image-fdt.c | 6 ++++++
   1 file changed, 6 insertions(+)
boot/image-fdt.c +0 -0
index 692a9ad3e4..4017bc94a6 100644

boot/image-fdt.c int image_setup_libfdt(bootm_headers_t *images, void *blob, · line 609

Quoted 9 lines
boot/image-fdt.c +6 -0
@@ -601,6 +601,12 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob,
   		goto err;
   	}
 
+	/* Store name of configuration node as bootconf in /chosen node */
+	if (images->fit_uname_cfg)
+		fdt_find_and_setprop(blob, "/chosen", "bootconf",
+					images->fit_uname_cfg,
+					strlen(images->fit_uname_cfg) + 1, 1);
+

We should not inject arbitrary properties into the device-tree. Where is the property /chosen/bootconf defined in the Linux documentation or in the device-tree specification?

Quoted 1 line

From Linux Documenation (chosen.txt):

"The chosen node does not represent a real device, but serves as a place
for passing data between firmware and the operating system, like boot arguments."

Quoted 1 line

From Device Tree specification (Release v0.3):

"The /chosen node does not represent a real device in the system but
describes parameters chosen or specified by the system firmware at run time."

Quoted 7 lines

So to me it sounds like the right place for an additional attribute serving the above purpose. It could as well become an additional kernel cmdline argument in (ie. appended to 'bootargs' in '/chosen'), but that seemed more complex and harder to deal with.

The name could be changed into something like 'denx,boot-configuration' if 'bootconf' is perceived to be too generic.

Is this squashfs meant to be served from RAM?
Should U-Boot check a signature of the squashfs?
Should U-Boot already load it into RAM?

Why can't you pack the squashfs into an initrd.img file and do without any modification?

Best regards

Heinrich

Quoted 4 lines

Cheers

Daniel

#4 lore raw
Quoted 83 lines · Heinrich Schuchardt
Quoted 82 lines · Daniel Golle

Hi Heinrich,

Quoted 8 lines · Heinrich Schuchardt
Quoted 4 lines · Daniel Golle

It can be useful for the OS (Linux) to know which configuration has been chosen by U-Boot when launching a FIT image.
Store the name of the FIT configuration node used in a new string attribute called 'bootconf' in the '/chosen' node in device tree.

Please, point out where you want to use that information. I cannot see that the Linux kernel will make any use of it.

It can be useful when parsing FIT image in kernel, but can also be useful in userspace (via /sys/firmware/devicetree/base/chosen/bootconf). For OpenWrt I've written a uImage.FIT partition parser in order to allow a single type of firmware image containing kernel, dtb and rootfs to work accross all storage types (SPI-NOR/mtd, NAND/ubi, eMMC/block).

I haven't yet submitted it upstream, exactly because some edges like selection of configuration would need to be discussed first.

https://git.openwrt.org/?p=openwrt/openwrt.git;a=blob;f=target/linux/generic/files/block/partitions/fit.c;h=89b5fb3454f0b69cdcfe53958169fb2a6f9c48a9;hb=HEAD

However, it's doing the job for a bunch of OpenWrt boards already, incl. some popular devices

https://openwrt.org/toh/linksys/e8450
(boots from SPI-NAND/ubi)

https://openwrt.org/toh/sinovoip/bananapi_bpi-r64_v1.1
(can boot from SD Card, eMMC or SPI-NAND/ubi)

Using uImage.FIT to store the squashfs besides kernel and dtb has several obvious advantages which are hard to obtain in any other way:
* single image accross NOR/mtd, NAND/ubi and MMC/block devices
* dynamically sized sub-partitions for kernel and rootfs
* hash also for rootfs checked by U-Boot before launching kernel
* images may include additional filesystems e.g. for localization or brandinge (hence the need to parse the boot configuration when mapping the 'filesystem' subimages into block partitions).

Quoted 26 lines
Quoted 12 lines
---
   boot/image-fdt.c | 6 ++++++
   1 file changed, 6 insertions(+)
boot/image-fdt.c +0 -0
index 692a9ad3e4..4017bc94a6 100644

boot/image-fdt.c int image_setup_libfdt(bootm_headers_t *images, void *blob, · line 609

Quoted 9 lines
boot/image-fdt.c +6 -0
@@ -601,6 +601,12 @@ int image_setup_libfdt(bootm_headers_t *images, void *blob,
   		goto err;
   	}
 
+	/* Store name of configuration node as bootconf in /chosen node */
+	if (images->fit_uname_cfg)
+		fdt_find_and_setprop(blob, "/chosen", "bootconf",
+					images->fit_uname_cfg,
+					strlen(images->fit_uname_cfg) + 1, 1);
+

We should not inject arbitrary properties into the device-tree. Where is the property /chosen/bootconf defined in the Linux documentation or in the device-tree specification?

Quoted 1 line

From Linux Documenation (chosen.txt):

"The chosen node does not represent a real device, but serves as a place
for passing data between firmware and the operating system, like boot arguments."

Quoted 1 line

From Device Tree specification (Release v0.3):

"The /chosen node does not represent a real device in the system but
describes parameters chosen or specified by the system firmware at run time."

So to me it sounds like the right place for an additional attribute serving the above purpose. It could as well become an additional kernel cmdline argument in (ie. appended to 'bootargs' in '/chosen'), but that seemed more complex and harder to deal with.

Quoted 4 lines
Quoted 2 lines

The name could be changed into something like 'denx,boot-configuration' if 'bootconf' is perceived to be too generic.

Is this squashfs meant to be served from RAM?

No, it is part of the FIT image which lives on a block device (which is typically either a partition on a mmc block device, a ubiblock device or a mtdblock device, depending on the storage type used). An additional partition parser (metioned above) then breaks out the configured filesystem parts into sub-partitions in a generic way, so the kernel can mount the rootfs (and later on maybe other additional filesystems e.g. with firmware localization or customization).

Quoted 1 line

Should U-Boot check a signature of the squashfs?

Yes, as failing to mount it will result in an unusable system, U-Boot should validate the rootfs before launching the kernel (and dual-boot into a recovery system in case anything in the FIT image got damaged).

Quoted 1 line

Should U-Boot already load it into RAM?

No, that's unneeded. The rootfs can be large and serving the compressed image from RAM would result in permanently allocating the space needed for that. (think: total FIT size ~40MiB, total RAM 256MiB; 40MiB additional allocation is about 15% of all the RAM there is, and that's too much)

Quoted 2 lines

Why can't you pack the squashfs into an initrd.img file and do without any modification?

Because this is not about systems running off a ramdisk or even having an initrd at all. But that also doesn't matter too much at this point:
Even if we would solve selecting the (large) rootfs sub-image with a (small) initrd userspace process, also that userspace process would need to know which boot configuration has been selected, so it could select the configured 'filesystem' sub-image from FIT (which is stored on some permanent storage like raw NOR or NAND, or MMC).

Thank you for reviewing!

Cheers

Daniel