[PATCH 12/17] blspec: Rework firmware load

[Michael Tretter]

On Wed, 10 Mar 2021 14:28:24 +0100, Sascha Hauer wrote:
> Applying overlays in blspec currently works in two steps. First
> of_firmware_load_overlay() is called which doesn't load an overlay,
> but instead loads firmware when one is needed by the overlay. This
> is done on the live tree, because that was needed to find the firmware
> manager. The second step is to call of_register_overlay() to apply
> the overlay to the kernel device tree when the fixups are executed.
> 
> Instead of using a separate step to load the firmware, load the firmware
> as part of the of_fixups.

Wouldn't this result in the firmware being loaded whenever of_fix_tree is
called? Then, every use of the of_dump or of_diff commands would result in a
reload of the firmware.

> 
> Signed-off-by: Sascha Hauer <s.hauer at pengutronix.de>
> ---
>  commands/of_overlay.c    |  4 ---
>  common/blspec.c          | 73 +++++++++++-----------------------------
>  drivers/of/of_firmware.c | 24 ++-----------
>  drivers/of/overlay.c     |  2 ++
>  include/of.h             |  4 +--
>  5 files changed, 25 insertions(+), 82 deletions(-)
> 
> diff --git a/commands/of_overlay.c b/commands/of_overlay.c
> index 9b1cc6e8c7..17b0c9f4cb 100644
> --- a/commands/of_overlay.c
> +++ b/commands/of_overlay.c
> @@ -42,10 +42,6 @@ static int do_of_overlay(int argc, char *argv[])
>  	if (IS_ERR(overlay))
>  		return PTR_ERR(overlay);
>  
> -	ret = of_firmware_load_overlay(overlay);
> -	if (ret)
> -		goto err;
> -
>  	ret = of_register_overlay(overlay);
>  	if (ret) {
>  		printf("cannot apply oftree overlay: %s\n", strerror(-ret));
> diff --git a/common/blspec.c b/common/blspec.c
> index d771176a45..fd3e088920 100644
> --- a/common/blspec.c
> +++ b/common/blspec.c
> @@ -32,71 +32,33 @@ int blspec_entry_var_set(struct blspec_entry *entry, const char *name,
>  			val ? strlen(val) + 1 : 0, 1);
>  }
>  
> -static int blspec_apply_oftree_overlay(char *file, const char *abspath,
> -				       int dryrun)
> -{
> -	int ret = 0;
> -	struct fdt_header *fdt;
> -	struct device_node *overlay;
> -	char *path;
> -	size_t size;
> -
> -	path = basprintf("%s/%s", abspath, file);
> -
> -	fdt = read_file(path, &size);
> -	if (!fdt) {
> -		pr_warn("unable to read \"%s\"\n", path);
> -		ret = -EINVAL;
> -		goto out;
> -	}
> -
> -	overlay = of_unflatten_dtb(fdt, size);
> -	free(fdt);
> -	if (IS_ERR(overlay)) {
> -		ret = PTR_ERR(overlay);
> -		goto out;
> -	}
> -
> -	if (dryrun) {
> -		pr_info("dry run: skip overlay %s\n", path);
> -		of_delete_node(overlay);
> -		goto out;
> -	}
> -
> -	ret = of_firmware_load_overlay(overlay);
> -	if (ret) {
> -		pr_warn("failed to load firmware: skip overlay \"%s\"\n", path);
> -		of_delete_node(overlay);
> -		goto out;
> -	}
> -
> -	ret = of_register_overlay(overlay);
> -	if (ret) {
> -		pr_warn("cannot register devicetree overlay \"%s\"\n", path);
> -		of_delete_node(overlay);
> -	}
> -
> -out:
> -	free(path);
> -
> -	return ret;
> -}
> -
> -static void blspec_apply_oftree_overlays(const char *overlays,
> -					 const char *abspath, int dryrun)
> +static int blspec_overlay_fixup(struct device_node *root, void *ctx)
>  {
> +	struct blspec_entry *entry = ctx;
> +	const char *overlays;
>  	char *overlay;
>  	char *sep, *freep;
>  
> +	overlays = blspec_entry_var_get(entry, "devicetree-overlay");
> +
>  	sep = freep = xstrdup(overlays);
>  
>  	while ((overlay = strsep(&sep, " "))) {
> +		char *path;
> +
>  		if (!*overlay)
>  			continue;
> -		blspec_apply_oftree_overlay(overlay, abspath, dryrun);
> +
> +		path = basprintf("%s/%s", entry->rootpath, overlay);
> +
> +		of_overlay_apply_file(root, path);
> +
> +		free(path);
>  	}
>  
>  	free(freep);
> +
> +	return 0;
>  }
>  
>  /*
> @@ -153,7 +115,7 @@ static int blspec_boot(struct bootentry *be, int verbose, int dryrun)
>  	}
>  
>  	if (overlays)
> -		blspec_apply_oftree_overlays(overlays, abspath, dryrun);
> +		of_register_fixup(blspec_overlay_fixup, entry);
>  
>  	if (initrd)
>  		data.initrd_file = basprintf("%s/%s", abspath, initrd);
> @@ -186,6 +148,9 @@ static int blspec_boot(struct bootentry *be, int verbose, int dryrun)
>  	if (ret)
>  		pr_err("Booting failed\n");
>  
> +	if (overlays)
> +		of_unregister_fixup(blspec_overlay_fixup, entry);
> +
>  	firmware_set_searchpath(old_fws);
>  
>  err_out:
> diff --git a/drivers/of/of_firmware.c b/drivers/of/of_firmware.c
> index 12ce1d95d0..d66f0ae7ce 100644
> --- a/drivers/of/of_firmware.c
> +++ b/drivers/of/of_firmware.c
> @@ -48,27 +48,7 @@ static int load_firmware(struct device_node *target,
>  	return err;
>  }
>  
> -int of_firmware_load_overlay(struct device_node *overlay)
> +int of_overlay_load_firmware(struct device_node *root, struct device_node *overlay)
>  {
> -	int err;
> -	struct device_node *root;
> -	struct device_node *resolved;
> -	struct device_node *ovl;
> -
> -	root = of_get_root_node();
> -	resolved = of_resolve_phandles(root, overlay);
> -	/*
> -	 * If the overlay cannot be resolved, use the load_firmware callback
> -	 * with the unresolved overlay to verify that the overlay does not
> -	 * depend on a firmware to be loaded. If a required firmware cannot be
> -	 * loaded, the overlay must not be applied.
> -	 */
> -	ovl = resolved ? resolved : overlay;
> -
> -	err = of_process_overlay(root, ovl, load_firmware, NULL);
> -
> -	if (resolved)
> -		of_delete_node(resolved);
> -
> -	return err;
> +	return of_process_overlay(root, overlay, load_firmware, NULL);

This drops the check, if the overlay depends on firmware, which cannot be
loaded, because Barebox could not resolve the overlay. This might be OK,
because in this case, we also don't know if the target is an fpga-region.
Looks fragile to me, anyway.

>  }
> diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c
> index c9ede614a6..d42e15ed1c 100644
> --- a/drivers/of/overlay.c
> +++ b/drivers/of/overlay.c
> @@ -221,6 +221,8 @@ int of_overlay_apply_tree(struct device_node *root,
>  			pr_warn("failed to apply %s\n", fragment->name);
>  	}
>  
> +	err = of_overlay_load_firmware(root, resolved);

The firmware must be loaded before the overlay is applied. If the firmware
cannot be loaded, the device tree must not be modified.

Michael

> +
>  	of_delete_node(resolved);
>  
>  	return err;
> diff --git a/include/of.h b/include/of.h
> index 56291b9801..ecc5f5101a 100644
> --- a/include/of.h
> +++ b/include/of.h
> @@ -1033,7 +1033,7 @@ int of_process_overlay(struct device_node *root,
>  				   struct device_node *overlay, void *data),
>  		    void *data);
>  
> -int of_firmware_load_overlay(struct device_node *overlay);
> +int of_overlay_load_firmware(struct device_node *root, struct device_node *overlay);
>  #else
>  static inline struct device_node *of_resolve_phandles(struct device_node *root,
>  					const struct device_node *overlay)
> @@ -1067,7 +1067,7 @@ static inline int of_process_overlay(struct device_node *root,
>  	return -ENOSYS;
>  }
>  
> -static inline int of_firmware_load_overlay(struct device_node *overlay)
> +static inline int of_overlay_load_firmware(struct device_node *root, struct device_node *overlay)
>  {
>  	return -ENOSYS;
>  }
> -- 
> 2.29.2