SPL: extend FIT loading support

Currently the SPL FIT loader uses the spl_fit_select_fdt() function to find the offset to the right DTB within the FIT image.
For this it iterates over all subnodes of the /configuration node in the FIT tree and compares all "description" strings therein using a board specific matching function.
If that finds a match, it uses the string in the "fdt" property of that subnode to locate the matching subnode in the /images node, which points to the DTB data.
Now this works very well, but is quite specific to cover this particular use case. To open up the door for a more generic usage, let's split this function into:
1) a function that just returns the node offset for the matching configuration node (spl_fit_find_config_node())
2) a function that returns the image data any given property in a given configuration node points to, additionally using a given index into a possbile list of strings (spl_fit_select_index())
This allows us to replace the specific function above by asking for the image the _first string of the "fdt" property_ in the matching configuration subnode points to.

This patch introduces no functional changes, it just refactors the code to allow reusing it later.

(diff is overly clever here and produces a hard-to-read patch, so I recommend to throw a look at the result instead).

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Reviewed-by Simon Glass <[email protected]>

Currently the SPL FIT loader uses the spl_fit_select_fdt() function to find the offset to the right DTB within the FIT image.
For this it iterates over all subnodes of the /configuration node in the FIT tree and compares all "description" strings therein using a board specific matching function.
If that finds a match, it uses the string in the "fdt" property of that subnode to locate the matching subnode in the /images node, which points to the DTB data.
Now this works very well, but is quite specific to cover this particular use case. To open up the door for a more generic usage, let's split this function into:
1) a function that just returns the node offset for the matching configuration node (spl_fit_find_config_node())
2) a function that returns the image data any given property in a given configuration node points to, additionally using a given index into a possbile list of strings (spl_fit_select_index())
This allows us to replace the specific function above by asking for the image the _first string of the "fdt" property_ in the matching configuration subnode points to.

This patch introduces no functional changes, it just refactors the code to allow reusing it later.

(diff is overly clever here and produces a hard-to-read patch, so I recommend to throw a look at the result instead).

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Reviewed-by Simon Glass <[email protected]>

---
  common/spl/spl_fit.c | 88 ++++++++++++++++++++++++++++++++++------------------
  1 file changed, 57 insertions(+), 31 deletions(-)

common/spl/spl_fit.c +57 -31

index aae556f..67372ca 100644
@@ -22,13 +22,16 @@ static ulong fdt_getprop_u32(const void *fdt, int node, const char *prop)
  	return fdt32_to_cpu(*cell);
  }
 
-static int spl_fit_select_fdt(const void *fdt, int images, int *fdt_offsetp)
+/*
+ * Iterate over all /configurations subnodes and call a platform specific
+ * function to find the matching configuration.
+ * Returns the node offset or a negative error number.
+ */
+static int spl_fit_find_config_node(const void *fdt)
  {
-	const char *name, *fdt_name;
-	int conf, node, fdt_node;
-	int len;
+	const char *name;
+	int conf, node, len;
 
-	*fdt_offsetp = 0;
  	conf = fdt_path_offset(fdt, FIT_CONFS_PATH);
  	if (conf < 0) {
  		debug("%s: Cannot find /configurations node: %d\n", __func__,

@@ -50,39 +53,61 @@ static int spl_fit_select_fdt(const void *fdt, int images, int *fdt_offsetp)
  			continue;
 
  		debug("Selecting config '%s'", name);
-		fdt_name = fdt_getprop(fdt, node, FIT_FDT_PROP, &len);
-		if (!fdt_name) {
-			debug("%s: Cannot find fdt name property: %d\n",
-			      __func__, len);
-			return -EINVAL;
-		}
 
-		debug(", fdt '%s'\n", fdt_name);
-		fdt_node = fdt_subnode_offset(fdt, images, fdt_name);
-		if (fdt_node < 0) {
-			debug("%s: Cannot find fdt node '%s': %d\n",
-			      __func__, fdt_name, fdt_node);
-			return -EINVAL;
+		return node;
+	}
+
+	return -ENOENT;
+}
+
+static int spl_fit_select_index(const void *fit, int images, int *offsetp,
+				const char *type, int index)
+{
+	const char *name, *str;
+	int node, conf_node;
+	int len, i;
+
+	*offsetp = 0;
+	conf_node = spl_fit_find_config_node(fit);
+	if (conf_node < 0) {
+#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
+		printf("No matching DT out of these options:\n");
+		for (node = fdt_first_subnode(fit, conf_node);
+		     node >= 0;
+		     node = fdt_next_subnode(fit, node)) {
+			name = fdt_getprop(fit, node, "description", &len);
+			printf("   %s\n", name);
  		}
+#endif
+		return conf_node;
+	}
 
-		*fdt_offsetp = fdt_getprop_u32(fdt, fdt_node, "data-offset");
-		len = fdt_getprop_u32(fdt, fdt_node, "data-size");
-		debug("FIT: Selected '%s'\n", name);
+	name = fdt_getprop(fit, conf_node, type, &len);
+	if (!name) {
+		debug("cannot find property '%s': %d\n", type, len);
+		return -EINVAL;
+	}
 
-		return len;
+	str = name;
+	for (i = 0; i < index; i++) {
+		str = strchr(str, '\0') + 1;
+		if (!str || (str - name >= len)) {
+			debug("no string for index %d\n", index);
+			return -E2BIG;
+		}
  	}
 
-#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
-	printf("No matching DT out of these options:\n");
-	for (node = fdt_first_subnode(fdt, conf);
-	     node >= 0;
-	     node = fdt_next_subnode(fdt, node)) {
-		name = fdt_getprop(fdt, node, "description", &len);
-		printf("   %s\n", name);
+	debug("%s: '%s'\n", type, str);
+	node = fdt_subnode_offset(fit, images, str);
+	if (node < 0) {
+		debug("cannot find image node '%s': %d\n", str, node);
+		return -EINVAL;
  	}
-#endif
 
-	return -ENOENT;
+	*offsetp = fdt_getprop_u32(fit, node, "data-offset");
+	len = fdt_getprop_u32(fit, node, "data-size");
+
+	return len;
  }
 
  static int get_aligned_image_offset(struct spl_load_info *info, int offset)

@@ -218,7 +243,8 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	memcpy(dst, src, data_size);
 
  	/* Figure out which device tree the board wants to use */
-	fdt_len = spl_fit_select_fdt(fit, images, &fdt_offset);
+	fdt_len = spl_fit_select_index(fit, images, &fdt_offset,
+				       FIT_FDT_PROP, 0);
  	if (fdt_len < 0)
  		return fdt_len;
 

Currently the SPL FIT loader uses the spl_fit_select_fdt() function to find the offset to the right DTB within the FIT image.
For this it iterates over all subnodes of the /configuration node in the FIT tree and compares all "description" strings therein using a board specific matching function.
If that finds a match, it uses the string in the "fdt" property of that subnode to locate the matching subnode in the /images node, which points to the DTB data.
Now this works very well, but is quite specific to cover this particular use case. To open up the door for a more generic usage, let's split this function into:
1) a function that just returns the node offset for the matching configuration node (spl_fit_find_config_node())
2) a function that returns the image data any given property in a given configuration node points to, additionally using a given index into a possbile list of strings (spl_fit_select_index())
This allows us to replace the specific function above by asking for the image the _first string of the "fdt" property_ in the matching configuration subnode points to.

This patch introduces no functional changes, it just refactors the code to allow reusing it later.

(diff is overly clever here and produces a hard-to-read patch, so I recommend to throw a look at the result instead).

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Currently the SPL FIT loader always looks only for the first image in the /images node a FIT tree, which it loads and later executes.

Generalize this by looking for a "firmware" property in the matched configuration subnode, or, if that does not exist, for the first string in the "loadables" property. Then using the string in that property, load the image of that name from the /images node.
This still loads only one image at the moment, but refactors the code to allow extending this in a following patch.
To simplify later re-usage, we also generalize the spl_fit_select_index() function to not return the image location, but just the node offset.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Reviewed-by Simon Glass <[email protected]>

Currently the SPL FIT loader always looks only for the first image in the /images node a FIT tree, which it loads and later executes.

Generalize this by looking for a "firmware" property in the matched configuration subnode, or, if that does not exist, for the first string in the "loadables" property. Then using the string in that property, load the image of that name from the /images node.
This still loads only one image at the moment, but refactors the code to allow extending this in a following patch.
To simplify later re-usage, we also generalize the spl_fit_select_index() function to not return the image location, but just the node offset.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Reviewed-by Simon Glass <[email protected]>

---
  common/spl/spl_fit.c | 46 ++++++++++++++++++++++++++++++++--------------
  1 file changed, 32 insertions(+), 14 deletions(-)

common/spl/spl_fit.c +32 -14

index 67372ca..85af980 100644
@@ -60,14 +60,25 @@ static int spl_fit_find_config_node(const void *fdt)
  	return -ENOENT;
  }
 
-static int spl_fit_select_index(const void *fit, int images, int *offsetp,
-				const char *type, int index)
+/**
+ * spl_fit_get_image_node(): By using the matching configuration subnode,
+ * retrieve the name of an image, specified by a property name and an index
+ * into that.
+ * @fit:	Pointer to the FDT blob.
+ * @images:	Offset of the /images subnode.
+ * @type:	Name of the property within the configuration subnode.
+ * @index:	Index into the list of strings in this property.
+ *
+ * Return:	the node offset of the respective image node or a negative
+ * 		error number.
+ */
+static int spl_fit_get_image_node(const void *fit, int images,
+				  const char *type, int index)
  {
  	const char *name, *str;
  	int node, conf_node;
  	int len, i;
 
-	*offsetp = 0;
  	conf_node = spl_fit_find_config_node(fit);
  	if (conf_node < 0) {
  #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT

@@ -104,10 +115,7 @@ static int spl_fit_select_index(const void *fit, int images, int *offsetp,
  		return -EINVAL;
  	}
 
-	*offsetp = fdt_getprop_u32(fit, node, "data-offset");
-	len = fdt_getprop_u32(fit, node, "data-size");
-
-	return len;
+	return node;
  }
 
  static int get_aligned_image_offset(struct spl_load_info *info, int offset)

@@ -193,15 +201,22 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	if (count == 0)
  		return -EIO;
 
-	/* find the firmware image to load */
+	/* find the node holding the images information */
  	images = fdt_path_offset(fit, FIT_IMAGES_PATH);
  	if (images < 0) {
  		debug("%s: Cannot find /images node: %d\n", __func__, images);
  		return -1;
  	}
-	node = fdt_first_subnode(fit, images);
+
+	/* find the U-Boot image */
+	node = spl_fit_get_image_node(fit, images, "firmware", 0);
  	if (node < 0) {
-		debug("%s: Cannot find first image node: %d\n", __func__, node);
+		debug("could not find firmware image, trying loadables...\n");
+		node = spl_fit_get_image_node(fit, images, "loadables", 0);
+	}
+	if (node < 0) {
+		debug("%s: Cannot find u-boot image node: %d\n",
+		      __func__, node);
  		return -1;
  	}
 

@@ -243,10 +258,13 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	memcpy(dst, src, data_size);
 
  	/* Figure out which device tree the board wants to use */
-	fdt_len = spl_fit_select_index(fit, images, &fdt_offset,
-				       FIT_FDT_PROP, 0);
-	if (fdt_len < 0)
-		return fdt_len;
+	node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);
+	if (node < 0) {
+		debug("%s: cannot find FDT node\n", __func__);
+		return node;
+	}
+	fdt_offset = fdt_getprop_u32(fit, node, "data-offset");
+	fdt_len = fdt_getprop_u32(fit, node, "data-size");
 
  	/*
  	 * Read the device tree and place it after the image. There may be

At the moment we ignore any errors due to missing FIT properties, instead go ahead and calculate our addresses with the -1 return value. Fix this and bail out if any of the mandatory properties are missing.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Simon Glass <[email protected]>

At the moment we ignore any errors due to missing FIT properties, instead go ahead and calculate our addresses with the -1 return value. Fix this and bail out if any of the mandatory properties are missing.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Simon Glass <[email protected]>

---
  common/spl/spl_fit.c | 15 +++++++++++++--
  1 file changed, 13 insertions(+), 2 deletions(-)

common/spl/spl_fit.c +13 -2

index 85af980..ecd42d8 100644
@@ -11,14 +11,17 @@
  #include <libfdt.h>
  #include <spl.h>
 
+#define FDT_ERROR ((ulong)(-1))
+
  static ulong fdt_getprop_u32(const void *fdt, int node, const char *prop)
  {
  	const u32 *cell;
  	int len;
 
  	cell = fdt_getprop(fdt, node, prop, &len);
-	if (len != sizeof(*cell))
-		return -1U;
+	if (!cell || len != sizeof(*cell))
+		return FDT_ERROR;
+
  	return fdt32_to_cpu(*cell);
  }
 

@@ -222,7 +225,11 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
 
  	/* Get its information and set up the spl_image structure */
  	data_offset = fdt_getprop_u32(fit, node, "data-offset");
+	if (data_offset == FDT_ERROR)
+		return -ENOENT;
  	data_size = fdt_getprop_u32(fit, node, "data-size");
+	if (data_size == FDT_ERROR)
+		return -ENOENT;
  	load = fdt_getprop_u32(fit, node, "load");
  	debug("data_offset=%x, data_size=%x\n", data_offset, data_size);
  	spl_image->load_addr = load;

@@ -265,6 +272,10 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	}
  	fdt_offset = fdt_getprop_u32(fit, node, "data-offset");
  	fdt_len = fdt_getprop_u32(fit, node, "data-size");
+	if (fdt_offset == FDT_ERROR || fdt_len == FDT_ERROR) {
+		debug("%s: cannot load FDT data\n" __func__);
+		return -ENOENT;
+	}
 
  	/*
  	 * Read the device tree and place it after the image. There may be

At the moment we load two images from a FIT image: the actual U-Boot image and the .dtb file. Both times we have very similar code, that deals with alignment requirements the media we load from imposes upon us. Factor out this code into a new function, which we just call twice.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Simon Glass <[email protected]>

At the moment we load two images from a FIT image: the actual U-Boot image and the .dtb file. Both times we have very similar code, that deals with alignment requirements the media we load from imposes upon us. Factor out this code into a new function, which we just call twice.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Simon Glass <[email protected]>

---
  common/spl/spl_fit.c | 162 +++++++++++++++++++++++++--------------------------
  1 file changed, 80 insertions(+), 82 deletions(-)

common/spl/spl_fit.c +80 -82

index ecd42d8..9d9338c 100644
@@ -159,19 +159,81 @@ static int get_aligned_image_size(struct spl_load_info *info, int data_size,
  	return (data_size + info->bl_len - 1) / info->bl_len;
  }
 
+/**
+ * spl_load_fit_image(): load the image described in a certain FIT node
+ * @info:	points to information about the device to load data from
+ * @sector:	the start sector of the FIT image on the device
+ * @fit:	points to the flattened device tree blob describing the FIT
+ * 		image
+ * @base_offset: the beginning of the data area containing the actual
+ *		image data, relative to the beginning of the FIT
+ * @node:	offset of the DT node describing the image to load (relative
+ * 		to @fit)
+ * @image_info:	will be filled with information about the loaded image
+ * 		If the FIT node does not contain a "load" (address) property,
+ * 		the image gets loaded to the address pointed to by the
+ * 		load_addr member in this struct.
+ *
+ * Return:	0 on success or a negative error number.
+ */
+static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
+			      void *fit, ulong base_offset, int node,
+			      struct spl_image_info *image_info)
+{
+	ulong offset;
+	size_t length;
+	ulong load_addr, load_ptr;
+	void *src;
+	ulong overhead;
+	int nr_sectors;
+	int align_len = ARCH_DMA_MINALIGN - 1;
+
+	offset = fdt_getprop_u32(fit, node, "data-offset");
+	if (offset == FDT_ERROR)
+		return -ENOENT;
+	offset += base_offset;
+	length = fdt_getprop_u32(fit, node, "data-size");
+	if (length == FDT_ERROR)
+		return -ENOENT;
+	load_addr = fdt_getprop_u32(fit, node, "load");
+	if (load_addr == FDT_ERROR && image_info)
+		load_addr = image_info->load_addr;
+	load_ptr = (load_addr + align_len) & ~align_len;
+
+	overhead = get_aligned_image_overhead(info, offset);
+	nr_sectors = get_aligned_image_size(info, length, offset);
+
+	if (info->read(info, sector + get_aligned_image_offset(info, offset),
+		       nr_sectors, (void*)load_ptr) != nr_sectors)
+		return -EIO;
+	debug("image: dst=%lx, offset=%lx, size=%lx\n", load_ptr, offset,
+	      (unsigned long)length);
+
+	src = (void *)load_ptr + overhead;
+#ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
+	board_fit_image_post_process(&src, &length);
+#endif
+
+	memcpy((void*)load_addr, src, length);
+
+	if (image_info) {
+		image_info->load_addr = load_addr;
+		image_info->size = length;
+		image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
+	}
+
+	return 0;
+}
+
  int spl_load_simple_fit(struct spl_image_info *spl_image,
  			struct spl_load_info *info, ulong sector, void *fit)
  {
  	int sectors;
-	ulong size, load;
+	ulong size;
  	unsigned long count;
-	int node, images;
-	void *load_ptr;
-	int fdt_offset, fdt_len;
-	int data_offset, data_size;
+	struct spl_image_info image_info;
+	int node, images, ret;
  	int base_offset, align_len = ARCH_DMA_MINALIGN - 1;
-	int src_sector;
-	void *dst, *src;
 
  	/*
  	 * Figure out where the external images start. This is the base for the

@@ -223,46 +285,13 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  		return -1;
  	}
 
-	/* Get its information and set up the spl_image structure */
-	data_offset = fdt_getprop_u32(fit, node, "data-offset");
-	if (data_offset == FDT_ERROR)
-		return -ENOENT;
-	data_size = fdt_getprop_u32(fit, node, "data-size");
-	if (data_size == FDT_ERROR)
-		return -ENOENT;
-	load = fdt_getprop_u32(fit, node, "load");
-	debug("data_offset=%x, data_size=%x\n", data_offset, data_size);
-	spl_image->load_addr = load;
-	spl_image->entry_point = load;
-	spl_image->os = IH_OS_U_BOOT;
-
-	/*
-	 * Work out where to place the image. We read it so that the first
-	 * byte will be at 'load'. This may mean we need to load it starting
-	 * before then, since we can only read whole blocks.
-	 */
-	data_offset += base_offset;
-	sectors = get_aligned_image_size(info, data_size, data_offset);
-	load_ptr = (void *)load;
-	debug("U-Boot size %x, data %p\n", data_size, load_ptr);
-	dst = load_ptr;
-
-	/* Read the image */
-	src_sector = sector + get_aligned_image_offset(info, data_offset);
-	debug("Aligned image read: dst=%p, src_sector=%x, sectors=%x\n",
-	      dst, src_sector, sectors);
-	count = info->read(info, src_sector, sectors, dst);
-	if (count != sectors)
-		return -EIO;
-	debug("image: dst=%p, data_offset=%x, size=%x\n", dst, data_offset,
-	      data_size);
-	src = dst + get_aligned_image_overhead(info, data_offset);
+	/* Load the image and set up the spl_image structure */
+	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
+				 spl_image);
+	if (ret)
+		return ret;
 
-#ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
-	board_fit_image_post_process((void **)&src, (size_t *)&data_size);
-#endif
-
-	memcpy(dst, src, data_size);
+	spl_image->os = IH_OS_U_BOOT;
 
  	/* Figure out which device tree the board wants to use */
  	node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);

@@ -270,43 +299,12 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  		debug("%s: cannot find FDT node\n", __func__);
  		return node;
  	}
-	fdt_offset = fdt_getprop_u32(fit, node, "data-offset");
-	fdt_len = fdt_getprop_u32(fit, node, "data-size");
-	if (fdt_offset == FDT_ERROR || fdt_len == FDT_ERROR) {
-		debug("%s: cannot load FDT data\n" __func__);
-		return -ENOENT;
-	}
 
  	/*
-	 * Read the device tree and place it after the image. There may be
-	 * some extra data before it since we can only read entire blocks.
-	 * And also align the destination address to ARCH_DMA_MINALIGN.
+	 * Read the device tree and place it after the image.
+	 * Align the destination address to ARCH_DMA_MINALIGN.
  	 */
-	dst = (void *)((load + data_size + align_len) & ~align_len);
-	fdt_offset += base_offset;
-	sectors = get_aligned_image_size(info, fdt_len, fdt_offset);
-	src_sector = sector + get_aligned_image_offset(info, fdt_offset);
-	count = info->read(info, src_sector, sectors, dst);
-	debug("Aligned fdt read: dst %p, src_sector = %x, sectors %x\n",
-	      dst, src_sector, sectors);
-	if (count != sectors)
-		return -EIO;
-
-	/*
-	 * Copy the device tree so that it starts immediately after the image.
-	 * After this we will have the U-Boot image and its device tree ready
-	 * for us to start.
-	 */
-	debug("fdt: dst=%p, data_offset=%x, size=%x\n", dst, fdt_offset,
-	      fdt_len);
-	src = dst + get_aligned_image_overhead(info, fdt_offset);
-	dst = load_ptr + data_size;
-
-#ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
-	board_fit_image_post_process((void **)&src, (size_t *)&fdt_len);
-#endif
-
-	memcpy(dst, src, fdt_len);
-
-	return 0;
+	image_info.load_addr = spl_image->load_addr + spl_image->size;
+	return spl_load_fit_image(info, sector, fit, base_offset, node,
+				  &image_info);
  }

So far we were not using the FIT image format to its full potential:
The SPL FIT loader was just loading the first image from the /images node plus one of the listed DTBs.
Now with the refactored loader code it's easy to load an arbitrary number of images in addition to the two mentioned above.
As described in the FIT image source file format description, iterate over all images listed at the "loadables" property in the configuration node and load every image at its desired location.
This allows to load any kind of images:
- firmware images to execute before U-Boot proper (for instance ARM Trusted Firmware (ATF))
- firmware images for management processors (SCP, arisc, ...)
- firmware images for devices like WiFi controllers
- bit files for FPGAs
- additional configuration data
- kernels and/or ramdisks
The actual usage of this feature would be platform and/or board specific.

Also update the FIT documentation to mention the new SPL feature and provide an example .its file to demonstrate its features.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Reviewed-by Simon Glass <[email protected]>

So far we were not using the FIT image format to its full potential:
The SPL FIT loader was just loading the first image from the /images node plus one of the listed DTBs.
Now with the refactored loader code it's easy to load an arbitrary number of images in addition to the two mentioned above.
As described in the FIT image source file format description, iterate over all images listed at the "loadables" property in the configuration node and load every image at its desired location.
This allows to load any kind of images:
- firmware images to execute before U-Boot proper (for instance ARM Trusted Firmware (ATF))
- firmware images for management processors (SCP, arisc, ...)
- firmware images for devices like WiFi controllers
- bit files for FPGAs
- additional configuration data
- kernels and/or ramdisks
The actual usage of this feature would be platform and/or board specific.

Also update the FIT documentation to mention the new SPL feature and provide an example .its file to demonstrate its features.

Signed-off-by Andre Przywara <[email protected]>

Reviewed-by Lokesh Vutla <[email protected]>

Reviewed-by Simon Glass <[email protected]>

---
  common/spl/spl_fit.c         | 42 ++++++++++++++++++++-
  doc/uImage.FIT/howto.txt     | 21 +++++++++++
  doc/uImage.FIT/multi_spl.its | 89 ++++++++++++++++++++++++++++++++++++++++++++
  3 files changed, 150 insertions(+), 2 deletions(-)

create mode 100644 doc/uImage.FIT/multi_spl.its

common/spl/spl_fit.c +40 -2

index 9d9338c..4c42a96 100644
@@ -234,6 +234,7 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	struct spl_image_info image_info;
  	int node, images, ret;
  	int base_offset, align_len = ARCH_DMA_MINALIGN - 1;
+	int index = 0;
 
  	/*
  	 * Figure out where the external images start. This is the base for the

@@ -278,6 +279,11 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	if (node < 0) {
  		debug("could not find firmware image, trying loadables...\n");
  		node = spl_fit_get_image_node(fit, images, "loadables", 0);
+		/*
+		 * If we pick the U-Boot image from "loadables", start at
+		 * the second image when later loading additional images.
+		 */
+		index = 1;
  	}
  	if (node < 0) {
  		debug("%s: Cannot find u-boot image node: %d\n",

@@ -305,6 +311,38 @@ int spl_load_simple_fit(struct spl_image_info *spl_image,
  	 * Align the destination address to ARCH_DMA_MINALIGN.
  	 */
  	image_info.load_addr = spl_image->load_addr + spl_image->size;
-	return spl_load_fit_image(info, sector, fit, base_offset, node,
-				  &image_info);
+	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
+				 &image_info);
+	if (ret < 0)
+		return ret;
+
+	/* Now check if there are more images for us to load */
+	for (; ; index++) {
+		node = spl_fit_get_image_node(fit, images, "loadables", index);
+		if (node < 0)
+			break;
+
+		ret = spl_load_fit_image(info, sector, fit, base_offset, node,
+					 &image_info);
+		if (ret < 0)
+			continue;
+
+		/*
+		 * If the "firmware" image did not provide an entry point,
+		 * use the first valid entry point from the loadables.
+		 */
+		if (spl_image->entry_point == FDT_ERROR &&
+		    image_info.entry_point != FDT_ERROR)
+			spl_image->entry_point = image_info.entry_point;
+	}
+
+	/*
+	 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
+	 * Makefile will set it to 0 and it will end up as the entry point
+	 * here. What it actually means is: use the load address.
+	 */
+	if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
+		spl_image->entry_point = spl_image->load_addr;
+
+	return 0;
  }

doc/uImage.FIT/howto.txt +21 -0

index 14e316f..2988a52 100644
@@ -44,6 +44,27 @@ image source file     mkimage + dtc		  transfer to target
  	+	     ---------------> image file --------------------> bootm
  image data file(s)
 
+SPL usage
+---------
+
+The SPL can make use of the new image format as well, this traditionally
+is used to ship multiple device tree files within one image. Code in the SPL
+will choose the one matching the current board and append this to the
+U-Boot proper binary to be automatically used up by it.
+Aside from U-Boot proper and one device tree blob the SPL can load multiple,
+arbitrary image files as well. These binaries should be specified in their
+own subnode under the /images node, which should then be referenced from one or
+multiple /configurations subnodes. The required images must be enumerated in
+the "loadables" property as a list of strings.
+
+If a platform specific image source file (.its) is shipped with the U-Boot
+source, it can be specified using the CONFIG_SPL_FIT_SOURCE Kconfig symbol.
+In this case it will be automatically used by U-Boot's Makefile to generate
+the image.
+If a static source file is not flexible enough, CONFIG_SPL_FIT_GENERATOR
+can point to a script which generates this image source file during
+the build process. It gets passed a list of device tree files (taken from the
+CONFIG_OF_LIST symbol).
 
  Example 1 -- old-style (non-FDT) kernel booting
  -----------------------------------------------

doc/uImage.FIT/multi_spl.its new file +89 -0

new file mode 100644
index 0000000..e5551d4
@@ -0,0 +1,89 @@
+/dts-v1/;
+
+/*
+ * (Bogus) example FIT image description file demonstrating the usage
+ * of multiple images loaded by the SPL.
+ * Several binaries will be loaded at their respective load addresses.
+ * Finally the one image specifying an entry point will be entered by the SPL.
+ */
+
+/ {
+	description = "multiple firmware blobs and U-Boot, loaded by SPL";
+	#address-cells = <0x1>;
+
+	images {
+
+		uboot {
+			description = "U-Boot (64-bit)";
+			type = "standalone";
+			arch = "arm64";
+			compression = "none";
+			load = <0x4a000000>;
+		};
+
+		atf {
+			description = "ARM Trusted Firmware";
+			type = "firmware";
+			arch = "arm64";
+			compression = "none";
+			load = <0x18000>;
+			entry = <0x18000>;
+		};
+
+		mgmt-firmware {
+			description = "arisc management processor firmware";
+			type = "firmware";
+			arch = "or1k";
+			compression = "none";
+			load = <0x40000>;
+		};
+
+		fdt at 1 {
+			description = "Pine64+ DT";
+			type = "flat_dt";
+			compression = "none";
+			load = <0x4fa00000>;
+			arch = "arm64";
+		};
+
+		fdt at 2 {
+			description = "Pine64 DT";
+			type = "flat_dt";
+			compression = "none";
+			load = <0x4fa00000>;
+			arch = "arm64";
+		};
+
+		kernel {
+			description = "4.7-rc5 kernel";
+			type = "kernel";
+			compression = "none";
+			load = <0x40080000>;
+			arch = "arm64";
+		};
+
+		initrd {
+			description = "Debian installer initrd";
+			type = "ramdisk";
+			compression = "none";
+			load = <0x4fe00000>;
+			arch = "arm64";
+		};
+	};
+
+	configurations {
+		default = "config at 1";
+
+		config at 1 {
+			description = "sun50i-a64-pine64-plus";
+			loadables = "uboot", "atf", "kernel", "initrd";
+			fdt = "fdt at 1";
+		};
+
+		config at 2 {
+			description = "sun50i-a64-pine64";
+			loadables = "uboot", "atf", "mgmt-firmware";
+			fdt = "fdt at 2";
+		};
+	};
+};

SPL_FIT obviously requires libfdt in SPL, so let Kconfig express that by selecting SPL_OF_LIBFDT.
Also make the actual options that users want (SPL signature and SPL FIT loading) visible in the menu and let them select the SPL_FIT as a requirement.
Also remove the now redundant SPL_OF_LIBFDT from those Kconfigs that had it in for the SPL FIT loading feature.

Signed-off-by Andre Przywara <[email protected]>

---
 Kconfig                      | 4 +++-
 configs/am335x_evm_defconfig | 1 -
 configs/evb-rk3399_defconfig | 1 -
 3 files changed, 3 insertions(+), 3 deletions(-)

When a board uses a FIT image to load U-Boot proper, it requires a list of supported device trees to be supplied in CONFIG_OF_LIST, from which it chooses the right one at runtime.
For boards with just one possible DT (like the OrangePi PC2) this defaults to CONFIG_DEFAULT_DEVICE_TREE, but for the Pine64 with its two possible models we provide all compatible DTs in this config symbol.

Signed-off-by Andre Przywara <[email protected]>

---
 configs/pine64_plus_defconfig | 1 +
 1 file changed, 1 insertion(+)

configs/pine64_plus_defconfig +0 -0

index 92bda60..593e24a 100644

Quoted 12 lines · Andre Przywara

When a board uses a FIT image to load U-Boot proper, it requires a list of supported device trees to be supplied in CONFIG_OF_LIST, from which it chooses the right one at runtime.
For boards with just one possible DT (like the OrangePi PC2) this defaults to CONFIG_DEFAULT_DEVICE_TREE, but for the Pine64 with its two possible models we provide all compatible DTs in this config symbol.

Signed-off-by Andre Przywara <[email protected]>

---
 configs/pine64_plus_defconfig | 1 +
 1 file changed, 1 insertion(+)

configs/pine64_plus_defconfig CONFIG_ARCH_SUNXI=y · line 6

Quoted 9 lines

configs/pine64_plus_defconfig +1 -0

index 92bda60..593e24a 100644
@@ -3,6 +3,7 @@ CONFIG_ARCH_SUNXI=y
 CONFIG_MACH_SUN50I=y
 CONFIG_RESERVE_ALLWINNER_BOOT0_HEADER=y
 CONFIG_DEFAULT_DEVICE_TREE="sun50i-a64-pine64-plus"
+CONFIG_OF_LIST="sun50i-a64-pine64 sun50i-a64-pine64-plus"

fdtfile env is compile option now, so it all ways assign CONFIG_DEFAULT_DEVICE_TREE so it can't pick sun50i-a64-pine64.dtb here, are you manage this in runtime board code?

When a board uses a FIT image to load U-Boot proper, it requires a list of supported device trees to be supplied in CONFIG_OF_LIST, from which it chooses the right one at runtime.
For boards with just one possible DT (like the OrangePi PC2) this defaults to CONFIG_DEFAULT_DEVICE_TREE, but for the Pine64 with its two possible models we provide all compatible DTs in this config symbol.

Signed-off-by Andre Przywara <[email protected]>

---
 configs/pine64_plus_defconfig | 1 +
 1 file changed, 1 insertion(+)

Another round of smaller fixes for the SPL FIT loading series and the respective patches to enable this feature on 64-bit Allwinner SoCs. The README has been changed to address all 64-bit Allwinner boards and has consequently been renamed to README.sunxi64. Also we can now point U-Boot to the ARM Trusted Firmware build by specifying the filename in the BL31 environment variable. If this is not set, we default to look for bl31.bin in U-Boot's build directory.
The other minor fixes are detailed in the Changelog below.
---

The first five patches introduce the core of the extened SPL FIT loading support, see below for a description. Patch 6 fixes a Kconfig dependency to simplify the usage of this option.
Patches 7-10 make some room in the sunxi 64-bit SPL to allow compiling in the FIT loading bits. Patch 11 and 12 let the SPL choose the proper DT from the FIT image.
The next two patches add the infrastructure and an actual generator script, so the FIT image is automatically created at build time.
Patches 14, 15 and 16 enable the SPL FIT support for Allwinner 64-bit SoCs in general and for the Pine64 and OrangePi PC 2 in particular.
The following two patches store a DT file name in the SPL header, so U-Boot can easily pick the proper DT when scanning the FIT image. The idea is that this DT name should stay with the board, ideally on eMMC or SPI flash. So both U-Boot and a firmware update tool could identify a board, updating with compatible firmware while keeping the DT name in place. Ideally a board vendor would once seed this name onto on-board storage like SPI flash.
I kept those two patches in, as the work on replacing mksunxiboot with an mkimage extension is not ready yet. Feel free to drop those from the series if this is a problem.
The penultimate patch updates the Pine64 README file to document the current way of building U-Boot, which now includes the ARM Trusted Firmware build in its image.
The last patch moves the maintainership from Hans over to me.

I would be delighted if that series could get merged into the sunxi tree. This finally enables the fully open source firmware for the 64-bit Allwinner SoCs (including the ATF binary).

This series is based on current sunxi/master.

Cheers,
Andre.

-------
Currently the FIT format is not used to its full potential in the SPL:
It only loads the first image from the /images node and appends the proper FDT.
Some boards and platforms would benefit from loading more images before starting U-Boot proper, notably Allwinner A64 and ARMv8 Rockchip boards, which use an ARM Trusted Firmware (ATF) image to be executed before U-Boot.

This series tries to solve this in a board agnostic and generic way:
We extend the SPL FIT loading scheme to allow loading multiple images. So apart from loading the image which is referenced by the "firmware" property in the respective configuration node and placing the DTB right behind it, we iterate over all strings in the "loadable" property. Each image referenced there will be loaded to its specified load address. The entry point U-Boot eventually branches to will be taken from the first image to explicitly provide the "entry" property, or, if none of them does so, from the load address of the "firmware" image. This keeps the scheme compatible with the FIT images our Makefile creates automatically at the moment.
Apart from the already mentioned ATF scenario this opens up more usage scenarios, of which the commit message of patch 04/11 lists some. The remaining patches prepare ane finally enable this scheme for the 64-bit Allwinner boards.

Changelog v3 ... v4:
- [01/20]: return proper error codes instead of just -1 (+Simon's RB)
- [02/20]: improve kernel-doc comment (+Simon's RB)
- [03/20]: return proper error codes instead of just -1 (+Simon's RB)
- [04/20]: improve kernel-doc comment and error codes (+Simon's RB)
- [05/20]: add example .its source file (+Simon's RB)
- [10,11,12/20]: add Maxime's Acked-by
- [14/20]: add BL31 environment variable (+Maxime's Acked-by)
- [15/20]: drop unneeded OrangePi PC2 change
- [16/20]: add Maxime's Acked-by
- [19/20]: rewrite to be more generic, rename to README.sunxi64
- [20/20]: new patch to change maintainership

Changelog v2 ... v3:
- new patch 06/19 to improve SPL_FIT Kconfig dependencies
- rename symbol in mksunxiboot (SUNXI_SRAM instead of SUN4I_SRAM)
- enable SPL_LOAD_FIT for all Allwinner A64 and H5 boards in Kconfig
- add only CONFIG_OF_LIST to defconfigs (patch 15/19)

Changelog v1 ... v2:
- Add some function comments to spl_fit.c (patch 1-5)
- Improve error handling in SPL FIT code (patch 1-5)
- Fix bisectability (observing entry-point property)
- add documentation to doc/uImage.FIT/howto.txt
- fix Freescale CCN504 build failure
- (no changes in the last 10 patches)
- update README.pine64 (new last patch)
- add Reviewed-by's from Simon and Lokesh

--
Andre Przywara (19):
SPL: FIT: refactor FDT loading
SPL: FIT: rework U-Boot image loading
SPL: FIT: improve error handling
SPL: FIT: factor out spl_load_fit_image()
SPL: FIT: allow loading multiple images
Kconfig: fix SPL_FIT dependency
tools: mksunxiboot: allow larger SPL binaries
armv8: SPL: only compile GIC code if needed
armv8: fsl: move ccn504 code into FSL Makefile
sunxi: A64: move SPL stack to end of SRAM A2
sunxi: SPL: store RAM size in gd
sunxi: SPL: add FIT config selector for Pine64 boards
Makefile: add rules to generate SPL FIT images
sunxi: 64-bit SoCs: introduce FIT generator script
sunxi: defconfig: add supported DT list for Pine64
sunxi: enable automatic FIT build for 64-bit SoCs
sunxi: use SPL header DT name for FIT board matching
sunxi: update Pine64 README
sunxi: Move maintainership for Pine64

Siarhei Siamashka (1):
sunxi: Store the device tree name in the SPL header

  Kconfig                               |  22 ++-
  Makefile                              |  20 +++
  arch/arm/include/asm/arch-sunxi/spl.h |  19 ++-
  arch/arm/lib/Makefile                 |   4 +-
  board/sunxi/Kconfig                   |   4 +
  board/sunxi/MAINTAINERS               |   6 +-
  board/sunxi/README.pine64             |  98 -----------
  board/sunxi/README.sunxi64            | 165 +++++++++++++++++++
  board/sunxi/board.c                   |  36 +++-
  board/sunxi/mksunxi_fit_atf.sh        |  75 +++++++++
  common/spl/spl_fit.c                  | 301 ++++++++++++++++++++++------------
  configs/am335x_evm_defconfig          |   1 -
  configs/evb-rk3399_defconfig          |   1 -
  configs/pine64_plus_defconfig         |   1 +
  doc/uImage.FIT/howto.txt              |  21 +++
  doc/uImage.FIT/multi_spl.its          |  89 ++++++++++
  include/configs/sunxi-common.h        |  17 +-
  scripts/Makefile.spl                  |   3 +-
  tools/mksunxiboot.c                   |  53 +++++-
  19 files changed, 710 insertions(+), 226 deletions(-)

delete mode 100644 board/sunxi/README.pine64 create mode 100644 board/sunxi/README.sunxi64 create mode 100755 board/sunxi/mksunxi_fit_atf.sh create mode 100644 doc/uImage.FIT/multi_spl.its

I though I have add review and test tags for the first 5 patches, anyway,

I will add again.

Not sure if some patches for sunxi still need to wait, can we merge patches for SPL/FIT first?

Thanks,
- Kever

Quoted 153 lines · Andre Przywara

Another round of smaller fixes for the SPL FIT loading series and the respective patches to enable this feature on 64-bit Allwinner SoCs. The README has been changed to address all 64-bit Allwinner boards and has consequently been renamed to README.sunxi64. Also we can now point U-Boot to the ARM Trusted Firmware build by specifying the filename in the BL31 environment variable. If this is not set, we default to look for bl31.bin in U-Boot's build directory.
The other minor fixes are detailed in the Changelog below.
---

The first five patches introduce the core of the extened SPL FIT loading support, see below for a description. Patch 6 fixes a Kconfig dependency to simplify the usage of this option.
Patches 7-10 make some room in the sunxi 64-bit SPL to allow compiling in the FIT loading bits. Patch 11 and 12 let the SPL choose the proper DT from the FIT image.
The next two patches add the infrastructure and an actual generator script,
so the FIT image is automatically created at build time. Patches 14, 15 and 16 enable the SPL FIT support for Allwinner 64-bit SoCs in
general and for the Pine64 and OrangePi PC 2 in particular. The following two patches store a DT file name in the SPL header, so U-Boot can easily pick the proper DT when scanning the FIT image. The idea is that this DT name should stay with the board, ideally on eMMC or SPI flash. So both U-Boot and a firmware update tool could identify a board, updating with compatible firmware while keeping the DT name in place. Ideally a board vendor would once seed this name onto on-board storage like SPI flash.
I kept those two patches in, as the work on replacing mksunxiboot with an mkimage extension is not ready yet. Feel free to drop those from the series if this is a problem.
The penultimate patch updates the Pine64 README file to document the current
way of building U-Boot, which now includes the ARM Trusted Firmware build in its image.
The last patch moves the maintainership from Hans over to me.

I would be delighted if that series could get merged into the sunxi tree. This finally enables the fully open source firmware for the 64-bit Allwinner SoCs (including the ATF binary).

This series is based on current sunxi/master.

Cheers,
Andre.

-------
Currently the FIT format is not used to its full potential in the SPL:
It only loads the first image from the /images node and appends the proper FDT.
Some boards and platforms would benefit from loading more images before starting U-Boot proper, notably Allwinner A64 and ARMv8 Rockchip boards, which use an ARM Trusted Firmware (ATF) image to be executed before U-Boot.

This series tries to solve this in a board agnostic and generic way:
We extend the SPL FIT loading scheme to allow loading multiple images. So apart from loading the image which is referenced by the "firmware" property in the respective configuration node and placing the DTB right behind it, we iterate over all strings in the "loadable" property. Each image referenced there will be loaded to its specified load address. The entry point U-Boot eventually branches to will be taken from the first image to explicitly provide the "entry" property, or, if none of them does so, from the load address of the "firmware" image. This keeps the scheme compatible with the FIT images our Makefile creates automatically at the moment.
Apart from the already mentioned ATF scenario this opens up more usage scenarios, of which the commit message of patch 04/11 lists some. The remaining patches prepare ane finally enable this scheme for the 64-bit
Allwinner boards.

Changelog v3 ... v4:
- [01/20]: return proper error codes instead of just -1 (+Simon's RB)
- [02/20]: improve kernel-doc comment (+Simon's RB)
- [03/20]: return proper error codes instead of just -1 (+Simon's RB)
- [04/20]: improve kernel-doc comment and error codes (+Simon's RB)
- [05/20]: add example .its source file (+Simon's RB)
- [10,11,12/20]: add Maxime's Acked-by
- [14/20]: add BL31 environment variable (+Maxime's Acked-by)
- [15/20]: drop unneeded OrangePi PC2 change
- [16/20]: add Maxime's Acked-by
- [19/20]: rewrite to be more generic, rename to README.sunxi64
- [20/20]: new patch to change maintainership

Changelog v2 ... v3:
- new patch 06/19 to improve SPL_FIT Kconfig dependencies
- rename symbol in mksunxiboot (SUNXI_SRAM instead of SUN4I_SRAM)
- enable SPL_LOAD_FIT for all Allwinner A64 and H5 boards in Kconfig
- add only CONFIG_OF_LIST to defconfigs (patch 15/19)

Changelog v1 ... v2:
- Add some function comments to spl_fit.c (patch 1-5)
- Improve error handling in SPL FIT code (patch 1-5)
- Fix bisectability (observing entry-point property)
- add documentation to doc/uImage.FIT/howto.txt
- fix Freescale CCN504 build failure
- (no changes in the last 10 patches)
- update README.pine64 (new last patch)
- add Reviewed-by's from Simon and Lokesh

Signature · 49 lines

Andre Przywara (19):
   SPL: FIT: refactor FDT loading
   SPL: FIT: rework U-Boot image loading
   SPL: FIT: improve error handling
   SPL: FIT: factor out spl_load_fit_image()
   SPL: FIT: allow loading multiple images
   Kconfig: fix SPL_FIT dependency
   tools: mksunxiboot: allow larger SPL binaries
   armv8: SPL: only compile GIC code if needed
   armv8: fsl: move ccn504 code into FSL Makefile
   sunxi: A64: move SPL stack to end of SRAM A2
   sunxi: SPL: store RAM size in gd
   sunxi: SPL: add FIT config selector for Pine64 boards
   Makefile: add rules to generate SPL FIT images
   sunxi: 64-bit SoCs: introduce FIT generator script
   sunxi: defconfig: add supported DT list for Pine64
   sunxi: enable automatic FIT build for 64-bit SoCs
   sunxi: use SPL header DT name for FIT board matching
   sunxi: update Pine64 README
   sunxi: Move maintainership for Pine64

Siarhei Siamashka (1):
   sunxi: Store the device tree name in the SPL header

  Kconfig                               |  22 ++-
  Makefile                              |  20 +++
  arch/arm/include/asm/arch-sunxi/spl.h |  19 ++-
  arch/arm/lib/Makefile                 |   4 +-
  board/sunxi/Kconfig                   |   4 +
  board/sunxi/MAINTAINERS               |   6 +-
  board/sunxi/README.pine64             |  98 -----------
  board/sunxi/README.sunxi64            | 165 +++++++++++++++++++
  board/sunxi/board.c                   |  36 +++-
  board/sunxi/mksunxi_fit_atf.sh        |  75 +++++++++
  common/spl/spl_fit.c                  | 301
++++++++++++++++++++++------------
  configs/am335x_evm_defconfig          |   1 -
  configs/evb-rk3399_defconfig          |   1 -
  configs/pine64_plus_defconfig         |   1 +
  doc/uImage.FIT/howto.txt              |  21 +++
  doc/uImage.FIT/multi_spl.its          |  89 ++++++++++
  include/configs/sunxi-common.h        |  17 +-
  scripts/Makefile.spl                  |   3 +-
  tools/mksunxiboot.c                   |  53 +++++-
  19 files changed, 710 insertions(+), 226 deletions(-)
  delete mode 100644 board/sunxi/README.pine64
  create mode 100644 board/sunxi/README.sunxi64
  create mode 100755 board/sunxi/mksunxi_fit_atf.sh
  create mode 100644 doc/uImage.FIT/multi_spl.its

From: Andre Przywara <[email protected]>
Date: Tue, 16 May 2017 09:10:06 +0100

Hi,

Quoted 2 lines · Kever Yang

Not sure if some patches for sunxi still need to wait, can we merge patches for SPL/FIT first?

That is a good question.

Tom, Simon: Are you OK with these (first six) patches? Are we good to merge them? Who will take them?

I see that "spl: add support to booting with ATF" from Kever has been merged already, my understanding is that this series here is a prerequisite for this?

Shall I repost the first six patches separately, rebased and with the new tags added?

Quoted 6 lines

From: Andre Przywara <[email protected]>
Date: Tue, 16 May 2017 09:10:06 +0100

Hi,

Quoted 8 lines · Kever Yang

Quoted 2 lines

Not sure if some patches for sunxi still need to wait, can we merge patches for SPL/FIT first?

That is a good question.

Tom, Simon: Are you OK with these (first six) patches? Are we good to merge them? Who will take them?

Quoted 7 lines

I see that "spl: add support to booting with ATF" from Kever has been merged already, my understanding is that this series here is a prerequisite for this?

Shall I repost the first six patches separately, rebased and with the new tags added?

It'd be great if this would happen. It'll allow us (OpenBSD) to distribute a working "firmware" image for the Firefly-RK3399 and bring the number of patches that we need to juggle for the Pine64 and other Allwinner A64/H5 boards down to a more manageable level.

I myself tested these patches on the Firefly-RK3399, so feel free to add a

Tested-by Mark Kettenis <[email protected]>

Cheers,

Mark

Another round of smaller fixes for the SPL FIT loading series and the respective patches to enable this feature on 64-bit Allwinner SoCs. The README has been changed to address all 64-bit Allwinner boards and has consequently been renamed to README.sunxi64. Also we can now point U-Boot to the ARM Trusted Firmware build by specifying the filename in the BL31 environment variable. If this is not set, we default to look for bl31.bin in U-Boot's build directory.
The other minor fixes are detailed in the Changelog below.
---

The first five patches introduce the core of the extened SPL FIT loading support, see below for a description. Patch 6 fixes a Kconfig dependency to simplify the usage of this option.
Patches 7-10 make some room in the sunxi 64-bit SPL to allow compiling in the FIT loading bits. Patch 11 and 12 let the SPL choose the proper DT from the FIT image.
The next two patches add the infrastructure and an actual generator script, so the FIT image is automatically created at build time.
Patches 14, 15 and 16 enable the SPL FIT support for Allwinner 64-bit SoCs in general and for the Pine64 and OrangePi PC 2 in particular.
The following two patches store a DT file name in the SPL header, so U-Boot can easily pick the proper DT when scanning the FIT image. The idea is that this DT name should stay with the board, ideally on eMMC or SPI flash. So both U-Boot and a firmware update tool could identify a board, updating with compatible firmware while keeping the DT name in place. Ideally a board vendor would once seed this name onto on-board storage like SPI flash.
I kept those two patches in, as the work on replacing mksunxiboot with an mkimage extension is not ready yet. Feel free to drop those from the series if this is a problem.
The penultimate patch updates the Pine64 README file to document the current way of building U-Boot, which now includes the ARM Trusted Firmware build in its image.
The last patch moves the maintainership from Hans over to me.

I would be delighted if that series could get merged into the sunxi tree. This finally enables the fully open source firmware for the 64-bit Allwinner SoCs (including the ATF binary).

This series is based on current sunxi/master.

Cheers,
Andre.

-------
Currently the FIT format is not used to its full potential in the SPL:
It only loads the first image from the /images node and appends the proper FDT.
Some boards and platforms would benefit from loading more images before starting U-Boot proper, notably Allwinner A64 and ARMv8 Rockchip boards, which use an ARM Trusted Firmware (ATF) image to be executed before U-Boot.

This series tries to solve this in a board agnostic and generic way:
We extend the SPL FIT loading scheme to allow loading multiple images. So apart from loading the image which is referenced by the "firmware" property in the respective configuration node and placing the DTB right behind it, we iterate over all strings in the "loadable" property. Each image referenced there will be loaded to its specified load address. The entry point U-Boot eventually branches to will be taken from the first image to explicitly provide the "entry" property, or, if none of them does so, from the load address of the "firmware" image. This keeps the scheme compatible with the FIT images our Makefile creates automatically at the moment.
Apart from the already mentioned ATF scenario this opens up more usage scenarios, of which the commit message of patch 04/11 lists some. The remaining patches prepare ane finally enable this scheme for the 64-bit Allwinner boards.

Changelog v3 ... v4:
- [01/20]: return proper error codes instead of just -1 (+Simon's RB)
- [02/20]: improve kernel-doc comment (+Simon's RB)
- [03/20]: return proper error codes instead of just -1 (+Simon's RB)
- [04/20]: improve kernel-doc comment and error codes (+Simon's RB)
- [05/20]: add example .its source file (+Simon's RB)
- [10,11,12/20]: add Maxime's Acked-by
- [14/20]: add BL31 environment variable (+Maxime's Acked-by)
- [15/20]: drop unneeded OrangePi PC2 change
- [16/20]: add Maxime's Acked-by
- [19/20]: rewrite to be more generic, rename to README.sunxi64
- [20/20]: new patch to change maintainership

Changelog v2 ... v3:
- new patch 06/19 to improve SPL_FIT Kconfig dependencies
- rename symbol in mksunxiboot (SUNXI_SRAM instead of SUN4I_SRAM)
- enable SPL_LOAD_FIT for all Allwinner A64 and H5 boards in Kconfig
- add only CONFIG_OF_LIST to defconfigs (patch 15/19)

Changelog v1 ... v2:
- Add some function comments to spl_fit.c (patch 1-5)
- Improve error handling in SPL FIT code (patch 1-5)
- Fix bisectability (observing entry-point property)
- add documentation to doc/uImage.FIT/howto.txt
- fix Freescale CCN504 build failure
- (no changes in the last 10 patches)
- update README.pine64 (new last patch)
- add Reviewed-by's from Simon and Lokesh

--
Andre Przywara (19):
SPL: FIT: refactor FDT loading
SPL: FIT: rework U-Boot image loading
SPL: FIT: improve error handling
SPL: FIT: factor out spl_load_fit_image()
SPL: FIT: allow loading multiple images
Kconfig: fix SPL_FIT dependency

tools: mksunxiboot: allow larger SPL binaries
armv8: SPL: only compile GIC code if needed
armv8: fsl: move ccn504 code into FSL Makefile
sunxi: A64: move SPL stack to end of SRAM A2
sunxi: SPL: store RAM size in gd
sunxi: SPL: add FIT config selector for Pine64 boards
Makefile: add rules to generate SPL FIT images
sunxi: 64-bit SoCs: introduce FIT generator script
sunxi: defconfig: add supported DT list for Pine64
sunxi: enable automatic FIT build for 64-bit SoCs

sunxi: use SPL header DT name for FIT board matching
sunxi: update Pine64 README
sunxi: Move maintainership for Pine64

Siarhei Siamashka (1):
sunxi: Store the device tree name in the SPL header