1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
17 #include <asm/cache.h>
18 #include <asm/global_data.h>
19 #include <linux/libfdt.h>
21 DECLARE_GLOBAL_DATA_PTR;
23 #ifndef CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
24 #define CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ (64 * 1024)
27 #ifndef CONFIG_SYS_BOOTM_LEN
28 #define CONFIG_SYS_BOOTM_LEN (64 << 20)
32 const void *fit; /* Pointer to a valid FIT blob */
33 size_t ext_data_offset; /* Offset to FIT external data (end of FIT) */
34 int images_node; /* FDT offset to "/images" node */
35 int conf_node; /* FDT offset to selected configuration node */
38 __weak void board_spl_fit_post_load(const void *fit)
42 __weak ulong board_spl_fit_size_align(ulong size)
47 static int find_node_from_desc(const void *fit, int node, const char *str)
54 /* iterate the FIT nodes and find a matching description */
55 for (child = fdt_first_subnode(fit, node); child >= 0;
56 child = fdt_next_subnode(fit, child)) {
58 const char *desc = fdt_getprop(fit, child, "description", &len);
63 if (!strcmp(desc, str))
71 * spl_fit_get_image_name(): By using the matching configuration subnode,
72 * retrieve the name of an image, specified by a property name and an index
74 * @fit: Pointer to the FDT blob.
75 * @images: Offset of the /images subnode.
76 * @type: Name of the property within the configuration subnode.
77 * @index: Index into the list of strings in this property.
78 * @outname: Name of the image
80 * Return: 0 on success, or a negative error number
82 static int spl_fit_get_image_name(const struct spl_fit_info *ctx,
83 const char *type, int index,
86 struct udevice *sysinfo;
87 const char *name, *str;
88 __maybe_unused int node;
92 name = fdt_getprop(ctx->fit, ctx->conf_node, type, &len);
94 debug("cannot find property '%s': %d\n", type, len);
99 for (i = 0; i < index; i++) {
100 str = strchr(str, '\0') + 1;
101 if (!str || (str - name >= len)) {
107 if (!found && CONFIG_IS_ENABLED(SYSINFO) && !sysinfo_get(&sysinfo)) {
110 * no string in the property for this index. Check if the
111 * sysinfo-level code can supply one.
113 rc = sysinfo_detect(sysinfo);
117 rc = sysinfo_get_fit_loadable(sysinfo, index - i - 1, type,
119 if (rc && rc != -ENOENT)
124 * The sysinfo provided a name for a loadable.
125 * Try to match it against the description properties
126 * first. If no matching node is found, use it as a
130 int images = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
132 node = find_node_from_desc(ctx->fit, images, str);
134 str = fdt_get_name(ctx->fit, node, NULL);
141 debug("no string for index %d\n", index);
150 * spl_fit_get_image_node(): By using the matching configuration subnode,
151 * retrieve the name of an image, specified by a property name and an index
153 * @fit: Pointer to the FDT blob.
154 * @images: Offset of the /images subnode.
155 * @type: Name of the property within the configuration subnode.
156 * @index: Index into the list of strings in this property.
158 * Return: the node offset of the respective image node or a negative
161 static int spl_fit_get_image_node(const struct spl_fit_info *ctx,
162 const char *type, int index)
168 err = spl_fit_get_image_name(ctx, type, index, &str);
172 debug("%s: '%s'\n", type, str);
174 node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
176 pr_err("cannot find image node '%s': %d\n", str, node);
183 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
186 * If it is a FS read, get the first address before offset which is
187 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
188 * block number to which offset belongs.
191 return offset & ~(ARCH_DMA_MINALIGN - 1);
193 return offset / info->bl_len;
196 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
199 * If it is a FS read, get the difference between the offset and
200 * the first address before offset which is aligned to
201 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
205 return offset & (ARCH_DMA_MINALIGN - 1);
207 return offset % info->bl_len;
210 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
213 data_size = data_size + get_aligned_image_overhead(info, offset);
218 return (data_size + info->bl_len - 1) / info->bl_len;
222 * spl_load_fit_image(): load the image described in a certain FIT node
223 * @info: points to information about the device to load data from
224 * @sector: the start sector of the FIT image on the device
225 * @ctx: points to the FIT context structure
226 * @node: offset of the DT node describing the image to load (relative
228 * @image_info: will be filled with information about the loaded image
229 * If the FIT node does not contain a "load" (address) property,
230 * the image gets loaded to the address pointed to by the
231 * load_addr member in this struct, if load_addr is not 0
233 * Return: 0 on success or a negative error number.
235 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
236 const struct spl_fit_info *ctx, int node,
237 struct spl_image_info *image_info)
248 uint8_t image_comp = -1, type = -1;
250 const void *fit = ctx->fit;
251 bool external_data = false;
253 if (IS_ENABLED(CONFIG_SPL_FPGA) ||
254 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
255 if (fit_image_get_type(fit, node, &type))
256 puts("Cannot get image type.\n");
258 debug("%s ", genimg_get_type_name(type));
261 if (IS_ENABLED(CONFIG_SPL_GZIP)) {
262 fit_image_get_comp(fit, node, &image_comp);
263 debug("%s ", genimg_get_comp_name(image_comp));
266 if (fit_image_get_load(fit, node, &load_addr)) {
267 if (!image_info->load_addr) {
268 printf("Can't load %s: No load address and no buffer\n",
269 fit_get_name(fit, node, NULL));
272 load_addr = image_info->load_addr;
275 if (!fit_image_get_data_position(fit, node, &offset)) {
276 external_data = true;
277 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
278 offset += ctx->ext_data_offset;
279 external_data = true;
286 if (fit_image_get_data_size(fit, node, &len))
289 src_ptr = map_sysmem(ALIGN(load_addr, ARCH_DMA_MINALIGN), len);
292 overhead = get_aligned_image_overhead(info, offset);
293 nr_sectors = get_aligned_image_size(info, length, offset);
296 sector + get_aligned_image_offset(info, offset),
297 nr_sectors, src_ptr) != nr_sectors)
300 debug("External data: dst=%p, offset=%x, size=%lx\n",
301 src_ptr, offset, (unsigned long)length);
302 src = src_ptr + overhead;
305 if (fit_image_get_data(fit, node, &data, &length)) {
306 puts("Cannot get image data/size\n");
309 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
310 (unsigned long)length);
311 src = (void *)data; /* cast away const */
314 if (CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
315 printf("## Checking hash(es) for Image %s ... ",
316 fit_get_name(fit, node, NULL));
317 if (!fit_image_verify_with_data(fit, node, src, length))
322 if (CONFIG_IS_ENABLED(FIT_IMAGE_POST_PROCESS))
323 board_fit_image_post_process(&src, &length);
325 load_ptr = map_sysmem(load_addr, length);
326 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
328 if (gunzip(load_ptr, CONFIG_SYS_BOOTM_LEN, src, &size)) {
329 puts("Uncompressing error\n");
334 memcpy(load_ptr, src, length);
340 image_info->load_addr = load_addr;
341 image_info->size = length;
343 if (!fit_image_get_entry(fit, node, &entry_point))
344 image_info->entry_point = entry_point;
346 image_info->entry_point = FDT_ERROR;
352 static bool os_takes_devicetree(uint8_t os)
358 return IS_ENABLED(CONFIG_SPL_OS_BOOT);
364 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
365 struct spl_load_info *info, ulong sector,
366 const struct spl_fit_info *ctx)
368 struct spl_image_info image_info;
369 int node, ret = 0, index = 0;
372 * Use the address following the image as target address for the
375 image_info.load_addr = spl_image->load_addr + spl_image->size;
377 /* Figure out which device tree the board wants to use */
378 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index++);
380 debug("%s: cannot find FDT node\n", __func__);
383 * U-Boot did not find a device tree inside the FIT image. Use
384 * the U-Boot device tree instead.
387 memcpy((void *)image_info.load_addr, gd->fdt_blob,
388 fdt_totalsize(gd->fdt_blob));
392 ret = spl_load_fit_image(info, sector, ctx, node,
398 /* Make the load-address of the FDT available for the SPL framework */
399 spl_image->fdt_addr = map_sysmem(image_info.load_addr, 0);
400 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
403 if (CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)) {
404 void *tmpbuffer = NULL;
407 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index);
408 if (node == -E2BIG) {
409 debug("%s: No additional FDT node\n", __func__);
411 } else if (node < 0) {
412 debug("%s: unable to find FDT node %d\n",
419 * allocate memory to store the DT overlay
420 * before it is applied. It may not be used
421 * depending on how the overlay is stored, so
422 * don't fail yet if the allocation failed.
424 tmpbuffer = malloc(CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ);
426 debug("%s: unable to allocate space for overlays\n",
429 image_info.load_addr = (ulong)tmpbuffer;
430 ret = spl_load_fit_image(info, sector, ctx,
435 /* Make room in FDT for changes from the overlay */
436 ret = fdt_increase_size(spl_image->fdt_addr,
441 ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
442 (void *)image_info.load_addr);
444 pr_err("failed to apply DT overlay %s\n",
445 fit_get_name(ctx->fit, node, NULL));
449 debug("%s: DT overlay %s applied\n", __func__,
450 fit_get_name(ctx->fit, node, NULL));
456 /* Try to make space, so we can inject details on the loadables */
457 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
464 static int spl_fit_record_loadable(const struct spl_fit_info *ctx, int index,
465 void *blob, struct spl_image_info *image)
471 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
474 ret = spl_fit_get_image_name(ctx, "loadables", index, &name);
478 node = spl_fit_get_image_node(ctx, "loadables", index);
480 ret = fdt_record_loadable(blob, index, name, image->load_addr,
481 image->size, image->entry_point,
482 fdt_getprop(ctx->fit, node, "type", NULL),
483 fdt_getprop(ctx->fit, node, "os", NULL));
487 static int spl_fit_image_is_fpga(const void *fit, int node)
491 if (!IS_ENABLED(CONFIG_SPL_FPGA))
494 type = fdt_getprop(fit, node, FIT_TYPE_PROP, NULL);
498 return !strcmp(type, "fpga");
501 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
503 if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) || CONFIG_IS_ENABLED(OS_BOOT))
504 return fit_image_get_os(fit, noffset, os);
506 const char *name = fdt_getprop(fit, noffset, FIT_OS_PROP, NULL);
511 * We don't care what the type of the image actually is,
512 * only whether or not it is U-Boot. This saves some
513 * space by omitting the large table of OS types.
515 if (!strcmp(name, "u-boot"))
524 * The purpose of the FIT load buffer is to provide a memory location that is
525 * independent of the load address of any FIT component.
527 static void *spl_get_fit_load_buffer(size_t size)
533 pr_err("Could not get FIT buffer of %lu bytes\n", (ulong)size);
534 pr_err("\tcheck CONFIG_SYS_SPL_MALLOC_SIZE\n");
535 buf = spl_get_load_buffer(0, size);
541 * Weak default function to allow customizing SPL fit loading for load-only
542 * use cases by allowing to skip the parsing/processing of the FIT contents
543 * (so that this can be done separately in a more customized fashion)
545 __weak bool spl_load_simple_fit_skip_processing(void)
550 static void warn_deprecated(const char *msg)
552 printf("DEPRECATED: %s\n", msg);
553 printf("\tSee doc/uImage.FIT/source_file_format.txt\n");
556 static int spl_fit_upload_fpga(struct spl_fit_info *ctx, int node,
557 struct spl_image_info *fpga_image)
559 const char *compatible;
562 debug("FPGA bitstream at: %x, size: %x\n",
563 (u32)fpga_image->load_addr, fpga_image->size);
565 compatible = fdt_getprop(ctx->fit, node, "compatible", NULL);
567 warn_deprecated("'fpga' image without 'compatible' property");
568 else if (strcmp(compatible, "u-boot,fpga-legacy"))
569 printf("Ignoring compatible = %s property\n", compatible);
571 ret = fpga_load(0, (void *)fpga_image->load_addr, fpga_image->size,
574 printf("%s: Cannot load the image to the FPGA\n", __func__);
578 puts("FPGA image loaded from FIT\n");
583 static int spl_fit_load_fpga(struct spl_fit_info *ctx,
584 struct spl_load_info *info, ulong sector)
588 struct spl_image_info fpga_image = {
592 node = spl_fit_get_image_node(ctx, "fpga", 0);
596 warn_deprecated("'fpga' property in config node. Use 'loadables'");
598 /* Load the image and set up the fpga_image structure */
599 ret = spl_load_fit_image(info, sector, ctx, node, &fpga_image);
601 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
605 return spl_fit_upload_fpga(ctx, node, &fpga_image);
608 static int spl_simple_fit_read(struct spl_fit_info *ctx,
609 struct spl_load_info *info, ulong sector,
610 const void *fit_header)
612 unsigned long count, size;
617 * For FIT with external data, figure out where the external images
618 * start. This is the base for the data-offset properties in each
621 size = ALIGN(fdt_totalsize(fit_header), 4);
622 size = board_spl_fit_size_align(size);
623 ctx->ext_data_offset = ALIGN(size, 4);
626 * So far we only have one block of data from the FIT. Read the entire
627 * thing, including that first block.
629 * For FIT with data embedded, data is loaded as part of FIT image.
630 * For FIT with external data, data is not loaded in this step.
632 sectors = get_aligned_image_size(info, size, 0);
633 buf = spl_get_fit_load_buffer(sectors * info->bl_len);
635 count = info->read(info, sector, sectors, buf);
637 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
638 sector, sectors, buf, count, size);
640 return (count == 0) ? -EIO : 0;
643 static int spl_simple_fit_parse(struct spl_fit_info *ctx)
645 /* Find the correct subnode under "/configurations" */
646 ctx->conf_node = fit_find_config_node(ctx->fit);
647 if (ctx->conf_node < 0)
650 if (IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) {
651 printf("## Checking hash(es) for config %s ... ",
652 fit_get_name(ctx->fit, ctx->conf_node, NULL));
653 if (fit_config_verify(ctx->fit, ctx->conf_node))
658 /* find the node holding the images information */
659 ctx->images_node = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
660 if (ctx->images_node < 0) {
661 debug("%s: Cannot find /images node: %d\n", __func__,
669 int spl_load_simple_fit(struct spl_image_info *spl_image,
670 struct spl_load_info *info, ulong sector, void *fit)
672 struct spl_image_info image_info;
673 struct spl_fit_info ctx;
679 ret = spl_simple_fit_read(&ctx, info, sector, fit);
683 /* skip further processing if requested to enable load-only use cases */
684 if (spl_load_simple_fit_skip_processing())
687 ret = spl_simple_fit_parse(&ctx);
691 if (IS_ENABLED(CONFIG_SPL_FPGA))
692 spl_fit_load_fpga(&ctx, info, sector);
695 * Find the U-Boot image using the following search order:
696 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
697 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
698 * - fall back to using the first 'loadables' entry
701 node = spl_fit_get_image_node(&ctx, FIT_FIRMWARE_PROP, 0);
703 if (node < 0 && IS_ENABLED(CONFIG_SPL_OS_BOOT))
704 node = spl_fit_get_image_node(&ctx, FIT_KERNEL_PROP, 0);
707 debug("could not find firmware image, trying loadables...\n");
708 node = spl_fit_get_image_node(&ctx, "loadables", 0);
710 * If we pick the U-Boot image from "loadables", start at
711 * the second image when later loading additional images.
716 debug("%s: Cannot find u-boot image node: %d\n",
721 /* Load the image and set up the spl_image structure */
722 ret = spl_load_fit_image(info, sector, &ctx, node, spl_image);
727 * For backward compatibility, we treat the first node that is
728 * as a U-Boot image, if no OS-type has been declared.
730 if (!spl_fit_image_get_os(ctx.fit, node, &spl_image->os))
731 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
732 else if (!IS_ENABLED(CONFIG_SPL_OS_BOOT))
733 spl_image->os = IH_OS_U_BOOT;
736 * Booting a next-stage U-Boot may require us to append the FDT.
737 * We allow this to fail, as the U-Boot image might embed its FDT.
739 if (os_takes_devicetree(spl_image->os)) {
740 ret = spl_fit_append_fdt(spl_image, info, sector, &ctx);
741 if (ret < 0 && spl_image->os != IH_OS_U_BOOT)
745 firmware_node = node;
746 /* Now check if there are more images for us to load */
748 uint8_t os_type = IH_OS_INVALID;
750 node = spl_fit_get_image_node(&ctx, "loadables", index);
755 * if the firmware is also a loadable, skip it because
756 * it already has been loaded. This is typically the case with
757 * u-boot.img generated by mkimage.
759 if (firmware_node == node)
762 image_info.load_addr = 0;
763 ret = spl_load_fit_image(info, sector, &ctx, node, &image_info);
765 printf("%s: can't load image loadables index %d (ret = %d)\n",
766 __func__, index, ret);
770 if (spl_fit_image_is_fpga(ctx.fit, node))
771 spl_fit_upload_fpga(&ctx, node, &image_info);
773 if (!spl_fit_image_get_os(ctx.fit, node, &os_type))
774 debug("Loadable is %s\n", genimg_get_os_name(os_type));
776 if (os_takes_devicetree(os_type)) {
777 spl_fit_append_fdt(&image_info, info, sector, &ctx);
778 spl_image->fdt_addr = image_info.fdt_addr;
782 * If the "firmware" image did not provide an entry point,
783 * use the first valid entry point from the loadables.
785 if (spl_image->entry_point == FDT_ERROR &&
786 image_info.entry_point != FDT_ERROR)
787 spl_image->entry_point = image_info.entry_point;
789 /* Record our loadables into the FDT */
790 if (spl_image->fdt_addr)
791 spl_fit_record_loadable(&ctx, index,
797 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
798 * Makefile will set it to 0 and it will end up as the entry point
799 * here. What it actually means is: use the load address.
801 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
802 spl_image->entry_point = spl_image->load_addr;
804 spl_image->flags |= SPL_FIT_FOUND;
806 if (IS_ENABLED(CONFIG_IMX_HAB))
807 board_spl_fit_post_load(ctx.fit);