1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
16 #include <asm/cache.h>
17 #include <asm/global_data.h>
18 #include <linux/libfdt.h>
20 DECLARE_GLOBAL_DATA_PTR;
22 #ifndef CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
23 #define CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ (64 * 1024)
26 #ifndef CONFIG_SYS_BOOTM_LEN
27 #define CONFIG_SYS_BOOTM_LEN (64 << 20)
31 const void *fit; /* Pointer to a valid FIT blob */
32 size_t ext_data_offset; /* Offset to FIT external data (end of FIT) */
33 int images_node; /* FDT offset to "/images" node */
34 int conf_node; /* FDT offset to selected configuration node */
37 __weak void board_spl_fit_post_load(const void *fit)
41 __weak ulong board_spl_fit_size_align(ulong size)
46 static int find_node_from_desc(const void *fit, int node, const char *str)
53 /* iterate the FIT nodes and find a matching description */
54 for (child = fdt_first_subnode(fit, node); child >= 0;
55 child = fdt_next_subnode(fit, child)) {
57 const char *desc = fdt_getprop(fit, child, "description", &len);
62 if (!strcmp(desc, str))
70 * spl_fit_get_image_name(): By using the matching configuration subnode,
71 * retrieve the name of an image, specified by a property name and an index
73 * @fit: Pointer to the FDT blob.
74 * @images: Offset of the /images subnode.
75 * @type: Name of the property within the configuration subnode.
76 * @index: Index into the list of strings in this property.
77 * @outname: Name of the image
79 * Return: 0 on success, or a negative error number
81 static int spl_fit_get_image_name(const struct spl_fit_info *ctx,
82 const char *type, int index,
85 struct udevice *sysinfo;
86 const char *name, *str;
87 __maybe_unused int node;
91 name = fdt_getprop(ctx->fit, ctx->conf_node, type, &len);
93 debug("cannot find property '%s': %d\n", type, len);
98 for (i = 0; i < index; i++) {
99 str = strchr(str, '\0') + 1;
100 if (!str || (str - name >= len)) {
106 if (!found && CONFIG_IS_ENABLED(SYSINFO) && !sysinfo_get(&sysinfo)) {
109 * no string in the property for this index. Check if the
110 * sysinfo-level code can supply one.
112 rc = sysinfo_get_fit_loadable(sysinfo, index - i - 1, type,
114 if (rc && rc != -ENOENT)
119 * The sysinfo provided a name for a loadable.
120 * Try to match it against the description properties
121 * first. If no matching node is found, use it as a
125 int images = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
127 node = find_node_from_desc(ctx->fit, images, str);
129 str = fdt_get_name(ctx->fit, node, NULL);
136 debug("no string for index %d\n", index);
145 * spl_fit_get_image_node(): By using the matching configuration subnode,
146 * retrieve the name of an image, specified by a property name and an index
148 * @fit: Pointer to the FDT blob.
149 * @images: Offset of the /images subnode.
150 * @type: Name of the property within the configuration subnode.
151 * @index: Index into the list of strings in this property.
153 * Return: the node offset of the respective image node or a negative
156 static int spl_fit_get_image_node(const struct spl_fit_info *ctx,
157 const char *type, int index)
163 err = spl_fit_get_image_name(ctx, type, index, &str);
167 debug("%s: '%s'\n", type, str);
169 node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
171 pr_err("cannot find image node '%s': %d\n", str, node);
178 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
181 * If it is a FS read, get the first address before offset which is
182 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
183 * block number to which offset belongs.
186 return offset & ~(ARCH_DMA_MINALIGN - 1);
188 return offset / info->bl_len;
191 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
194 * If it is a FS read, get the difference between the offset and
195 * the first address before offset which is aligned to
196 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
200 return offset & (ARCH_DMA_MINALIGN - 1);
202 return offset % info->bl_len;
205 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
208 data_size = data_size + get_aligned_image_overhead(info, offset);
213 return (data_size + info->bl_len - 1) / info->bl_len;
217 * spl_load_fit_image(): load the image described in a certain FIT node
218 * @info: points to information about the device to load data from
219 * @sector: the start sector of the FIT image on the device
220 * @ctx: points to the FIT context structure
221 * @node: offset of the DT node describing the image to load (relative
223 * @image_info: will be filled with information about the loaded image
224 * If the FIT node does not contain a "load" (address) property,
225 * the image gets loaded to the address pointed to by the
226 * load_addr member in this struct.
228 * Return: 0 on success or a negative error number.
230 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
231 const struct spl_fit_info *ctx, int node,
232 struct spl_image_info *image_info)
238 ulong load_addr, load_ptr;
242 int align_len = ARCH_DMA_MINALIGN - 1;
243 uint8_t image_comp = -1, type = -1;
245 const void *fit = ctx->fit;
246 bool external_data = false;
248 if (IS_ENABLED(CONFIG_SPL_FPGA) ||
249 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
250 if (fit_image_get_type(fit, node, &type))
251 puts("Cannot get image type.\n");
253 debug("%s ", genimg_get_type_name(type));
256 if (IS_ENABLED(CONFIG_SPL_GZIP)) {
257 fit_image_get_comp(fit, node, &image_comp);
258 debug("%s ", genimg_get_comp_name(image_comp));
261 if (fit_image_get_load(fit, node, &load_addr))
262 load_addr = image_info->load_addr;
264 if (!fit_image_get_data_position(fit, node, &offset)) {
265 external_data = true;
266 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
267 offset += ctx->ext_data_offset;
268 external_data = true;
273 if (fit_image_get_data_size(fit, node, &len))
276 load_ptr = (load_addr + align_len) & ~align_len;
279 overhead = get_aligned_image_overhead(info, offset);
280 nr_sectors = get_aligned_image_size(info, length, offset);
283 sector + get_aligned_image_offset(info, offset),
284 nr_sectors, (void *)load_ptr) != nr_sectors)
287 debug("External data: dst=%lx, offset=%x, size=%lx\n",
288 load_ptr, offset, (unsigned long)length);
289 src = (void *)load_ptr + overhead;
292 if (fit_image_get_data(fit, node, &data, &length)) {
293 puts("Cannot get image data/size\n");
296 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
297 (unsigned long)length);
301 if (CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
302 printf("## Checking hash(es) for Image %s ... ",
303 fit_get_name(fit, node, NULL));
304 if (!fit_image_verify_with_data(fit, node, src, length))
309 if (CONFIG_IS_ENABLED(FIT_IMAGE_POST_PROCESS))
310 board_fit_image_post_process(&src, &length);
312 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
314 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
316 puts("Uncompressing error\n");
321 memcpy((void *)load_addr, src, length);
327 image_info->load_addr = load_addr;
328 image_info->size = length;
330 if (!fit_image_get_entry(fit, node, &entry_point))
331 image_info->entry_point = entry_point;
333 image_info->entry_point = FDT_ERROR;
339 static bool os_takes_devicetree(uint8_t os)
345 return IS_ENABLED(CONFIG_SPL_OS_BOOT);
351 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
352 struct spl_load_info *info, ulong sector,
353 const struct spl_fit_info *ctx)
355 struct spl_image_info image_info;
356 int node, ret = 0, index = 0;
359 * Use the address following the image as target address for the
362 image_info.load_addr = spl_image->load_addr + spl_image->size;
364 /* Figure out which device tree the board wants to use */
365 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index++);
367 debug("%s: cannot find FDT node\n", __func__);
370 * U-Boot did not find a device tree inside the FIT image. Use
371 * the U-Boot device tree instead.
374 memcpy((void *)image_info.load_addr, gd->fdt_blob,
375 fdt_totalsize(gd->fdt_blob));
379 ret = spl_load_fit_image(info, sector, ctx, node,
385 /* Make the load-address of the FDT available for the SPL framework */
386 spl_image->fdt_addr = (void *)image_info.load_addr;
387 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
390 if (CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)) {
391 void *tmpbuffer = NULL;
394 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index);
395 if (node == -E2BIG) {
396 debug("%s: No additional FDT node\n", __func__);
398 } else if (node < 0) {
399 debug("%s: unable to find FDT node %d\n",
406 * allocate memory to store the DT overlay
407 * before it is applied. It may not be used
408 * depending on how the overlay is stored, so
409 * don't fail yet if the allocation failed.
411 tmpbuffer = malloc(CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ);
413 debug("%s: unable to allocate space for overlays\n",
416 image_info.load_addr = (ulong)tmpbuffer;
417 ret = spl_load_fit_image(info, sector, ctx,
422 /* Make room in FDT for changes from the overlay */
423 ret = fdt_increase_size(spl_image->fdt_addr,
428 ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
429 (void *)image_info.load_addr);
431 pr_err("failed to apply DT overlay %s\n",
432 fit_get_name(ctx->fit, node, NULL));
436 debug("%s: DT overlay %s applied\n", __func__,
437 fit_get_name(ctx->fit, node, NULL));
443 /* Try to make space, so we can inject details on the loadables */
444 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
451 static int spl_fit_record_loadable(const struct spl_fit_info *ctx, int index,
452 void *blob, struct spl_image_info *image)
458 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
461 ret = spl_fit_get_image_name(ctx, "loadables", index, &name);
465 node = spl_fit_get_image_node(ctx, "loadables", index);
467 ret = fdt_record_loadable(blob, index, name, image->load_addr,
468 image->size, image->entry_point,
469 fdt_getprop(ctx->fit, node, "type", NULL),
470 fdt_getprop(ctx->fit, node, "os", NULL));
474 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
476 if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) || CONFIG_IS_ENABLED(OS_BOOT))
477 return fit_image_get_os(fit, noffset, os);
479 const char *name = fdt_getprop(fit, noffset, FIT_OS_PROP, NULL);
484 * We don't care what the type of the image actually is,
485 * only whether or not it is U-Boot. This saves some
486 * space by omitting the large table of OS types.
488 if (!strcmp(name, "u-boot"))
497 * The purpose of the FIT load buffer is to provide a memory location that is
498 * independent of the load address of any FIT component.
500 static void *spl_get_fit_load_buffer(size_t size)
506 pr_err("Could not get FIT buffer of %lu bytes\n", (ulong)size);
507 pr_err("\tcheck CONFIG_SYS_SPL_MALLOC_SIZE\n");
508 buf = spl_get_load_buffer(0, size);
514 * Weak default function to allow customizing SPL fit loading for load-only
515 * use cases by allowing to skip the parsing/processing of the FIT contents
516 * (so that this can be done separately in a more customized fashion)
518 __weak bool spl_load_simple_fit_skip_processing(void)
523 static int spl_simple_fit_read(struct spl_fit_info *ctx,
524 struct spl_load_info *info, ulong sector,
525 const void *fit_header)
527 unsigned long count, size;
532 * For FIT with external data, figure out where the external images
533 * start. This is the base for the data-offset properties in each
536 size = ALIGN(fdt_totalsize(fit_header), 4);
537 size = board_spl_fit_size_align(size);
538 ctx->ext_data_offset = ALIGN(size, 4);
541 * So far we only have one block of data from the FIT. Read the entire
542 * thing, including that first block.
544 * For FIT with data embedded, data is loaded as part of FIT image.
545 * For FIT with external data, data is not loaded in this step.
547 sectors = get_aligned_image_size(info, size, 0);
548 buf = spl_get_fit_load_buffer(sectors * info->bl_len);
550 count = info->read(info, sector, sectors, buf);
552 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
553 sector, sectors, buf, count, size);
555 return (count == 0) ? -EIO : 0;
558 static int spl_simple_fit_parse(struct spl_fit_info *ctx)
560 /* Find the correct subnode under "/configurations" */
561 ctx->conf_node = fit_find_config_node(ctx->fit);
562 if (ctx->conf_node < 0)
565 if (IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) {
566 printf("## Checking hash(es) for config %s ... ",
567 fit_get_name(ctx->fit, ctx->conf_node, NULL));
568 if (fit_config_verify(ctx->fit, ctx->conf_node))
573 /* find the node holding the images information */
574 ctx->images_node = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
575 if (ctx->images_node < 0) {
576 debug("%s: Cannot find /images node: %d\n", __func__,
584 int spl_load_simple_fit(struct spl_image_info *spl_image,
585 struct spl_load_info *info, ulong sector, void *fit)
587 struct spl_image_info image_info;
588 struct spl_fit_info ctx;
594 ret = spl_simple_fit_read(&ctx, info, sector, fit);
598 /* skip further processing if requested to enable load-only use cases */
599 if (spl_load_simple_fit_skip_processing())
602 ret = spl_simple_fit_parse(&ctx);
606 #ifdef CONFIG_SPL_FPGA
607 node = spl_fit_get_image_node(&ctx, "fpga", 0);
609 /* Load the image and set up the spl_image structure */
610 ret = spl_load_fit_image(info, sector, &ctx, node, spl_image);
612 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
616 debug("FPGA bitstream at: %x, size: %x\n",
617 (u32)spl_image->load_addr, spl_image->size);
619 ret = fpga_load(0, (const void *)spl_image->load_addr,
620 spl_image->size, BIT_FULL);
622 printf("%s: Cannot load the image to the FPGA\n",
627 puts("FPGA image loaded from FIT\n");
633 * Find the U-Boot image using the following search order:
634 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
635 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
636 * - fall back to using the first 'loadables' entry
639 node = spl_fit_get_image_node(&ctx, FIT_FIRMWARE_PROP, 0);
641 if (node < 0 && IS_ENABLED(CONFIG_SPL_OS_BOOT))
642 node = spl_fit_get_image_node(&ctx, FIT_KERNEL_PROP, 0);
645 debug("could not find firmware image, trying loadables...\n");
646 node = spl_fit_get_image_node(&ctx, "loadables", 0);
648 * If we pick the U-Boot image from "loadables", start at
649 * the second image when later loading additional images.
654 debug("%s: Cannot find u-boot image node: %d\n",
659 /* Load the image and set up the spl_image structure */
660 ret = spl_load_fit_image(info, sector, &ctx, node, spl_image);
665 * For backward compatibility, we treat the first node that is
666 * as a U-Boot image, if no OS-type has been declared.
668 if (!spl_fit_image_get_os(ctx.fit, node, &spl_image->os))
669 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
670 else if (!IS_ENABLED(CONFIG_SPL_OS_BOOT))
671 spl_image->os = IH_OS_U_BOOT;
674 * Booting a next-stage U-Boot may require us to append the FDT.
675 * We allow this to fail, as the U-Boot image might embed its FDT.
677 if (os_takes_devicetree(spl_image->os)) {
678 ret = spl_fit_append_fdt(spl_image, info, sector, &ctx);
679 if (ret < 0 && spl_image->os != IH_OS_U_BOOT)
683 firmware_node = node;
684 /* Now check if there are more images for us to load */
686 uint8_t os_type = IH_OS_INVALID;
688 node = spl_fit_get_image_node(&ctx, "loadables", index);
693 * if the firmware is also a loadable, skip it because
694 * it already has been loaded. This is typically the case with
695 * u-boot.img generated by mkimage.
697 if (firmware_node == node)
700 ret = spl_load_fit_image(info, sector, &ctx, node, &image_info);
702 printf("%s: can't load image loadables index %d (ret = %d)\n",
703 __func__, index, ret);
707 if (!spl_fit_image_get_os(ctx.fit, node, &os_type))
708 debug("Loadable is %s\n", genimg_get_os_name(os_type));
710 if (os_takes_devicetree(os_type)) {
711 spl_fit_append_fdt(&image_info, info, sector, &ctx);
712 spl_image->fdt_addr = image_info.fdt_addr;
716 * If the "firmware" image did not provide an entry point,
717 * use the first valid entry point from the loadables.
719 if (spl_image->entry_point == FDT_ERROR &&
720 image_info.entry_point != FDT_ERROR)
721 spl_image->entry_point = image_info.entry_point;
723 /* Record our loadables into the FDT */
724 if (spl_image->fdt_addr)
725 spl_fit_record_loadable(&ctx, index,
731 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
732 * Makefile will set it to 0 and it will end up as the entry point
733 * here. What it actually means is: use the load address.
735 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
736 spl_image->entry_point = spl_image->load_addr;
738 spl_image->flags |= SPL_FIT_FOUND;
740 if (IS_ENABLED(CONFIG_IMX_HAB))
741 board_spl_fit_post_load(ctx.fit);