Skip to contentSkip to conversation

cmd: pxe: add support for FDT overlays

PATCH Superseded Neil Armstrong 3 participants 8 messages Jan 4, 2021 – Jan 20, 2021

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Example:
label linux
kernel /Image
devicetree /soc-board.dtb
fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>

---
Hi Tom,

This is repost of my last year's attempt.
It fills a hole to allow loading FDT overlays using PXE/Extlinux without using FIT.

V2 adds documentation.

Neil

 cmd/pxe_utils.c | 103 ++++++++++++++++++++++++++++++++++++++++++++++++
 cmd/pxe_utils.h |   1 +
 doc/README.pxe  |   9 +++++
 3 files changed, 113 insertions(+)
cmd/pxe_utils.c +103 -0
index 8716e782f6..25367190a7 100644
@@ -13,6 +13,8 @@
 #include <mapmem.h>
 #include <lcd.h>
 #include <net.h>
+#include <fdt_support.h>
+#include <linux/libfdt.h>
 #include <linux/string.h>
 #include <linux/ctype.h>
 #include <errno.h>
@@ -284,6 +286,9 @@ static void label_destroy(struct pxe_label *label)
 	if (label->fdtdir)
 		free(label->fdtdir);
 
+	if (label->fdtoverlays)
+		free(label->fdtoverlays);
+
 	free(label);
 }
 
@@ -331,6 +336,92 @@ static int label_localboot(struct pxe_label *label)
 	return run_command_list(localcmd, strlen(localcmd), 0);
 }
 
+/*
+ * Loads fdt overlays specified in 'fdtoverlays'.
+ */
+#ifdef CONFIG_OF_LIBFDT_OVERLAY
+static void label_boot_fdtoverlay(struct cmd_tbl *cmdtp, struct pxe_label *label)
+{
+	char *fdtoverlay = label->fdtoverlays;
+	struct fdt_header *working_fdt;
+	char *fdtoverlay_addr_env;
+	ulong fdtoverlay_addr;
+	ulong fdt_addr;
+	int err;
+
+	/* Get the main fdt and map it */
+	fdt_addr = simple_strtoul(env_get("fdt_addr_r"), NULL, 16);
+	working_fdt = map_sysmem(fdt_addr, 0);
+	err = fdt_check_header(working_fdt);
+	if (err)
+		return;
+
+	/* Get the specific overlay loading address */
+	fdtoverlay_addr_env = env_get("fdtoverlay_addr_r");
+	if (!fdtoverlay_addr_env) {
+		printf("Invalid fdtoverlay_addr_r for loading overlays\n");
+		return;
+	}
+
+	fdtoverlay_addr = simple_strtoul(fdtoverlay_addr_env, NULL, 16);
+
+	/* Cycle over the overlay files and apply them in order */
+	do {
+		struct fdt_header *blob;
+		char *overlayfile;
+		char *end;
+		int len;
+
+		/* Drop leading spaces */
+		while (*fdtoverlay == ' ')
+			++fdtoverlay;
+
+		/* Copy a single filename if multiple provided */
+		end = strstr(fdtoverlay, " ");
+		if (end) {
+			len = (int)(end - fdtoverlay);
+			overlayfile = malloc(len + 1);
+			strncpy(overlayfile, fdtoverlay, len);
+			overlayfile[len] = '\0';
+		} else
+			overlayfile = fdtoverlay;
+
+		if (!strlen(overlayfile))
+			goto skip_overlay;
+
+		/* Load overlay file */
+		err = get_relfile_envaddr(cmdtp, overlayfile,
+					  "fdtoverlay_addr_r");
+		if (err < 0) {
+			printf("Failed loading overlay %s\n", overlayfile);
+			goto skip_overlay;
+		}
+
+		/* Resize main fdt */
+		fdt_shrink_to_minimum(working_fdt, 8192);
+
+		blob = map_sysmem(fdtoverlay_addr, 0);
+		err = fdt_check_header(blob);
+		if (err) {
+			printf("Invalid overlay %s, skipping\n",
+			       overlayfile);
+			goto skip_overlay;
+		}
+
+		err = fdt_overlay_apply_verbose(working_fdt, blob);
+		if (err) {
+			printf("Failed to apply overlay %s, skipping\n",
+			       overlayfile);
+			goto skip_overlay;
+		}
+
+skip_overlay:
+		if (end)
+			free(overlayfile);
+	} while ((fdtoverlay = strstr(fdtoverlay, " ")));
+}
+#endif
+
 /*
  * Boot according to the contents of a pxe_label.
  *
@@ -525,6 +616,11 @@ static int label_boot(struct cmd_tbl *cmdtp, struct pxe_label *label)
 				       label->name);
 				goto cleanup;
 			}
+
+#ifdef CONFIG_OF_LIBFDT_OVERLAY
+			if (label->fdtoverlays)
+				label_boot_fdtoverlay(cmdtp, label);
+#endif
 		} else {
 			bootm_argv[3] = NULL;
 		}
@@ -582,6 +678,7 @@ enum token_type {
 	T_INCLUDE,
 	T_FDT,
 	T_FDTDIR,
+	T_FDTOVERLAYS,
 	T_ONTIMEOUT,
 	T_IPAPPEND,
 	T_BACKGROUND,
@@ -616,6 +713,7 @@ static const struct token keywords[] = {
 	{"fdt", T_FDT},
 	{"devicetreedir", T_FDTDIR},
 	{"fdtdir", T_FDTDIR},
+	{"fdtoverlays", T_FDTOVERLAYS},
 	{"ontimeout", T_ONTIMEOUT,},
 	{"ipappend", T_IPAPPEND,},
 	{"background", T_BACKGROUND,},
@@ -1048,6 +1146,11 @@ static int parse_label(char **c, struct pxe_menu *cfg)
 				err = parse_sliteral(c, &label->fdtdir);
 			break;
 
+		case T_FDTOVERLAYS:
+			if (!label->fdtoverlays)
+				err = parse_sliteral(c, &label->fdtoverlays);
+			break;
+
 		case T_LOCALBOOT:
 			label->localboot = 1;
 			err = parse_integer(c, &label->localboot_val);
cmd/pxe_utils.h +1 -0
index 77d2588875..6af9523734 100644
@@ -43,6 +43,7 @@ struct pxe_label {
 	char *initrd;
 	char *fdt;
 	char *fdtdir;
+	char *fdtoverlays;
 	int ipappend;
 	int attempted;
 	int localboot;
doc/README.pxe +9 -0
index 42f913c61f..352415b581 100644
@@ -89,6 +89,9 @@ pxe boot
      fdt_addr - the location of a fdt blob. 'fdt_addr' will be passed to bootm
      command if it is set and 'fdt_addr_r' is not passed to bootm command.
 
+     fdtoverlay_addr_r - location in RAM at which 'pxe boot' will temporarily store
+     fdt overlay(s) before applying them to the fdt blob stored at 'fdt_addr_r'.
+
 pxe file format
 ===============
 The pxe file format is nearly a subset of the PXELINUX file format; see
@@ -148,6 +151,12 @@ kernel <path>	    - if this label is chosen, use tftp to retrieve the kernel
 		      It useful for overlay selection in pxe file
 		      (see: doc/uImage.FIT/overlay-fdt-boot.txt)
 
+fdtoverlays <path> [...] - if this label is chosen, use tftp to retrieve the DT
+                      overlay(s) at <path>. it will temporarily stored at the
+                      address indicated in the fdtoverlay_addr_r environment variable,
+                      and then applied in the load order to the fdt blob stored at the
+                      address indicated in the fdt_addr_r environment variable.
+
 append <string>	    - use <string> as the kernel command line when booting this
 		      label.
 
Signature · 1 line
2.25.1
#1 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

Quoted 25 lines · Neil Armstrong

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Example:
label linux
kernel /Image
devicetree /soc-board.dtb
fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>
Quoted 8 lines

---
Hi Tom,

This is repost of my last year's attempt.
It fills a hole to allow loading FDT overlays using PXE/Extlinux without using FIT.

V2 adds documentation.

Thanks for following up. I assume this follows what the spec says for this file?

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210104/72b23985/attachment.sig>
#2 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

Dne ponedeljek, 04. januar 2021 ob 15:41:17 CET je Tom Rini napisal(a):

Quoted 12 lines · Neil Armstrong
Quoted 11 lines

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple
overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Quoted 5 lines
Quoted 5 lines

Example:
label linux

kernel /Image
devicetree /soc-board.dtb

This should be "fdt /soc-board.dtb",

Quoted 11 lines
Quoted 11 lines

fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>

With above fix:

Quoted 11 lines
Quoted 8 lines

---
Hi Tom,

This is repost of my last year's attempt.
It fills a hole to allow loading FDT overlays using PXE/Extlinux without using FIT.

V2 adds documentation.

Thanks for following up. I assume this follows what the spec says for this file?

Which specs? Official extlinux configuration specs [1] don't say anything about device tree files, so anything related to that is an extension (I hope I found correct specs). I think this one is extremely useful, users can easily specify which overlay file(s) they want to be applied in a text file.

Best regards,
Jernej

[1] https://repo.or.cz/syslinux.git/blob/HEAD:/doc/syslinux.txt

#3 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

Quoted 62 lines · Jernej ?krabec

Dne ponedeljek, 04. januar 2021 ob 15:41:17 CET je Tom Rini napisal(a):

Quoted 12 lines · Neil Armstrong
Quoted 11 lines

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple
overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Quoted 5 lines
Quoted 5 lines

Example:
label linux

kernel /Image
devicetree /soc-board.dtb

This should be "fdt /soc-board.dtb",

Quoted 11 lines
Quoted 11 lines

fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>

With above fix:

Quoted 11 lines
Quoted 8 lines

---
Hi Tom,

This is repost of my last year's attempt.
It fills a hole to allow loading FDT overlays using PXE/Extlinux without using FIT.

V2 adds documentation.

Thanks for following up. I assume this follows what the spec says for this file?

Which specs? Official extlinux configuration specs [1] don't say anything about device tree files, so anything related to that is an extension (I hope I found correct specs). I think this one is extremely useful, users can easily specify which overlay file(s) they want to be applied in a text file.

Best regards,
Jernej

[1] https://repo.or.cz/syslinux.git/blob/HEAD:/doc/syslinux.txt

#4 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

In reply to Jernej Škrabec
Quoted 13 lines · Jernej ?krabec

Dne ponedeljek, 04. januar 2021 ob 15:41:17 CET je Tom Rini napisal(a):

Quoted 12 lines · Neil Armstrong
Quoted 11 lines

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple
overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Quoted 7 lines
Quoted 5 lines
Quoted 5 lines

Example:
label linux

kernel /Image
devicetree /soc-board.dtb

This should be "fdt /soc-board.dtb",

Indeed, thx

Quoted 27 lines
Quoted 4 lines
Quoted 4 lines

fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

Quoted 8 lines
Quoted 8 lines

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>

With above fix:

Quoted 9 lines
Quoted 8 lines

---
Hi Tom,

This is repost of my last year's attempt.
It fills a hole to allow loading FDT overlays using PXE/Extlinux without using FIT.

V2 adds documentation.

Quoted 7 lines
Quoted 2 lines

Thanks for following up. I assume this follows what the spec says for this file?

Which specs? Official extlinux configuration specs [1] don't say anything about device tree files, so anything related to that is an extension (I hope I found correct specs). I think this one is extremely useful, users can easily specify which overlay file(s) they want to be applied in a text file.

Indeed, it follows the spec by not breaking it and simply extends the already u-boot specific pxe format.

Neil

Quoted 7 lines

Best regards,
Jernej

[1] https://repo.or.cz/syslinux.git/blob/HEAD:/doc/syslinux.txt

#5 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

Quoted 55 lines · Neil Armstrong
Quoted 13 lines · Jernej ?krabec

Dne ponedeljek, 04. januar 2021 ob 15:41:17 CET je Tom Rini napisal(a):

Quoted 12 lines · Neil Armstrong
Quoted 11 lines

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple
overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Quoted 7 lines
Quoted 5 lines
Quoted 5 lines

Example:
label linux

kernel /Image
devicetree /soc-board.dtb

This should be "fdt /soc-board.dtb",

Indeed, thx

Quoted 30 lines
Quoted 4 lines
Quoted 4 lines

fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

Quoted 8 lines
Quoted 8 lines

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>

With above fix:

Quoted 11 lines
Quoted 8 lines

---
Hi Tom,

This is repost of my last year's attempt.
It fills a hole to allow loading FDT overlays using PXE/Extlinux without using FIT.

V2 adds documentation.

Thanks for following up. I assume this follows what the spec says for this file?

Quoted 7 lines
Quoted 4 lines

Which specs? Official extlinux configuration specs [1] don't say anything about device tree files, so anything related to that is an extension (I hope I found correct specs). I think this one is extremely useful, users can easily specify which overlay file(s) they want to be applied in a text file.

Indeed, it follows the spec by not breaking it and simply extends the already u-boot specific pxe format.

I could have sworn that the spec on freedesktop.org had been extended for overlays, but I don't see it now. Thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210108/67db0efe/attachment.sig>
#6 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

In reply to Neil Armstrong
Quoted 17 lines · Neil Armstrong
Quoted 16 lines · Jernej ?krabec

Dne ponedeljek, 04. januar 2021 ob 15:41:17 CET je Tom Rini napisal(a):

Quoted 15 lines · Neil Armstrong
Quoted 14 lines

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple
overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Example:
label linux

Quoted 25 lines
Quoted 4 lines
Quoted 2 lines
Quoted 2 lines

kernel /Image
devicetree /soc-board.dtb

This should be "fdt /soc-board.dtb",

Indeed, thx

Quoted 17 lines
Quoted 4 lines
Quoted 4 lines

fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

Quoted 8 lines
Quoted 8 lines

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>

With above fix:

Since I'll almost certainly forget when applying, can I get a v3 with the change? Thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210114/acfe0f53/attachment.sig>
#7 lore raw

PATCH v2 1/1 cmd: pxe: add support for FDT overlays

Hi Tom,

Quoted 39 lines · Tom Rini
Quoted 38 lines · Neil Armstrong
Quoted 13 lines · Jernej ?krabec

Dne ponedeljek, 04. januar 2021 ob 15:41:17 CET je Tom Rini napisal(a):

Quoted 12 lines · Neil Armstrong
Quoted 11 lines

This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file.

Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command.

This change adds the 'fdtoverlays' keyword for a label, supporting multiple
overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword.

Quoted 7 lines
Quoted 5 lines
Quoted 5 lines

Example:
label linux

kernel /Image
devicetree /soc-board.dtb

This should be "fdt /soc-board.dtb",

Indeed, thx

Quoted 13 lines
Quoted 12 lines
Quoted 12 lines

fdtoverlays /soc-board-function.dtbo
append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait

This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important.

Cc Tom Rini <[email protected]>
Cc Andre Heider <[email protected]>
Cc Jernej ?krabec <[email protected]>
Cc Jonas Karlman <[email protected]>
Quoted 8 lines
Quoted 4 lines
Quoted 4 lines

With above fix:

Since I'll almost certainly forget when applying, can I get a v3 with the change? Thanks!

Sure !

Neil

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210120/193d44b3/attachment.sig>