1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
12 #include <linux/libfdt.h>
15 DECLARE_GLOBAL_DATA_PTR;
17 #ifndef CONFIG_SYS_BOOTM_LEN
18 #define CONFIG_SYS_BOOTM_LEN (64 << 20)
21 __weak void board_spl_fit_post_load(ulong load_addr, size_t length)
25 __weak ulong board_spl_fit_size_align(ulong size)
31 * spl_fit_get_image_name(): By using the matching configuration subnode,
32 * retrieve the name of an image, specified by a property name and an index
34 * @fit: Pointer to the FDT blob.
35 * @images: Offset of the /images subnode.
36 * @type: Name of the property within the configuration subnode.
37 * @index: Index into the list of strings in this property.
38 * @outname: Name of the image
40 * Return: 0 on success, or a negative error number
42 static int spl_fit_get_image_name(const void *fit, int images,
43 const char *type, int index,
46 const char *name, *str;
47 __maybe_unused int node;
51 conf_node = fit_find_config_node(fit);
53 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
54 printf("No matching DT out of these options:\n");
55 for (node = fdt_first_subnode(fit, conf_node);
57 node = fdt_next_subnode(fit, node)) {
58 name = fdt_getprop(fit, node, "description", &len);
59 printf(" %s\n", name);
65 name = fdt_getprop(fit, conf_node, type, &len);
67 debug("cannot find property '%s': %d\n", type, len);
72 for (i = 0; i < index; i++) {
73 str = strchr(str, '\0') + 1;
74 if (!str || (str - name >= len)) {
75 debug("no string for index %d\n", index);
80 *outname = (char *)str;
85 * spl_fit_get_image_node(): By using the matching configuration subnode,
86 * retrieve the name of an image, specified by a property name and an index
88 * @fit: Pointer to the FDT blob.
89 * @images: Offset of the /images subnode.
90 * @type: Name of the property within the configuration subnode.
91 * @index: Index into the list of strings in this property.
93 * Return: the node offset of the respective image node or a negative
96 static int spl_fit_get_image_node(const void *fit, int images,
97 const char *type, int index)
103 err = spl_fit_get_image_name(fit, images, type, index, &str);
107 debug("%s: '%s'\n", type, str);
109 node = fdt_subnode_offset(fit, images, str);
111 debug("cannot find image node '%s': %d\n", str, node);
118 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
121 * If it is a FS read, get the first address before offset which is
122 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
123 * block number to which offset belongs.
126 return offset & ~(ARCH_DMA_MINALIGN - 1);
128 return offset / info->bl_len;
131 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
134 * If it is a FS read, get the difference between the offset and
135 * the first address before offset which is aligned to
136 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
140 return offset & (ARCH_DMA_MINALIGN - 1);
142 return offset % info->bl_len;
145 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
148 data_size = data_size + get_aligned_image_overhead(info, offset);
153 return (data_size + info->bl_len - 1) / info->bl_len;
157 * spl_load_fit_image(): load the image described in a certain FIT node
158 * @info: points to information about the device to load data from
159 * @sector: the start sector of the FIT image on the device
160 * @fit: points to the flattened device tree blob describing the FIT
162 * @base_offset: the beginning of the data area containing the actual
163 * image data, relative to the beginning of the FIT
164 * @node: offset of the DT node describing the image to load (relative
166 * @image_info: will be filled with information about the loaded image
167 * If the FIT node does not contain a "load" (address) property,
168 * the image gets loaded to the address pointed to by the
169 * load_addr member in this struct.
171 * Return: 0 on success or a negative error number.
173 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
174 void *fit, ulong base_offset, int node,
175 struct spl_image_info *image_info)
181 ulong load_addr, load_ptr;
185 int align_len = ARCH_DMA_MINALIGN - 1;
186 uint8_t image_comp = -1, type = -1;
188 bool external_data = false;
190 if (IS_ENABLED(CONFIG_SPL_FPGA_SUPPORT) ||
191 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
192 if (fit_image_get_type(fit, node, &type))
193 puts("Cannot get image type.\n");
195 debug("%s ", genimg_get_type_name(type));
198 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) {
199 if (fit_image_get_comp(fit, node, &image_comp))
200 puts("Cannot get image compression format.\n");
202 debug("%s ", genimg_get_comp_name(image_comp));
205 if (fit_image_get_load(fit, node, &load_addr))
206 load_addr = image_info->load_addr;
208 if (!fit_image_get_data_position(fit, node, &offset)) {
209 external_data = true;
210 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
211 offset += base_offset;
212 external_data = true;
217 if (fit_image_get_data_size(fit, node, &len))
220 load_ptr = (load_addr + align_len) & ~align_len;
223 overhead = get_aligned_image_overhead(info, offset);
224 nr_sectors = get_aligned_image_size(info, length, offset);
227 sector + get_aligned_image_offset(info, offset),
228 nr_sectors, (void *)load_ptr) != nr_sectors)
231 debug("External data: dst=%lx, offset=%x, size=%lx\n",
232 load_ptr, offset, (unsigned long)length);
233 src = (void *)load_ptr + overhead;
236 if (fit_image_get_data(fit, node, &data, &length)) {
237 puts("Cannot get image data/size\n");
240 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
241 (unsigned long)length);
245 #ifdef CONFIG_SPL_FIT_SIGNATURE
246 printf("## Checking hash(es) for Image %s ... ",
247 fit_get_name(fit, node, NULL));
248 if (!fit_image_verify_with_data(fit, node,
254 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
255 board_fit_image_post_process(&src, &length);
258 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
260 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
262 puts("Uncompressing error\n");
267 memcpy((void *)load_addr, src, length);
271 image_info->load_addr = load_addr;
272 image_info->size = length;
273 image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
279 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
280 struct spl_load_info *info, ulong sector,
281 void *fit, int images, ulong base_offset)
283 struct spl_image_info image_info;
287 * Use the address following the image as target address for the
290 image_info.load_addr = spl_image->load_addr + spl_image->size;
292 /* Figure out which device tree the board wants to use */
293 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);
295 debug("%s: cannot find FDT node\n", __func__);
298 * U-Boot did not find a device tree inside the FIT image. Use
299 * the U-Boot device tree instead.
302 memcpy((void *)image_info.load_addr, gd->fdt_blob,
303 fdt_totalsize(gd->fdt_blob));
307 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
313 /* Make the load-address of the FDT available for the SPL framework */
314 spl_image->fdt_addr = (void *)image_info.load_addr;
315 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
316 /* Try to make space, so we can inject details on the loadables */
317 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
323 static int spl_fit_record_loadable(const void *fit, int images, int index,
324 void *blob, struct spl_image_info *image)
327 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
331 ret = spl_fit_get_image_name(fit, images, "loadables",
336 node = spl_fit_get_image_node(fit, images, "loadables", index);
338 ret = fdt_record_loadable(blob, index, name, image->load_addr,
339 image->size, image->entry_point,
340 fdt_getprop(fit, node, "type", NULL),
341 fdt_getprop(fit, node, "os", NULL));
346 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
348 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) && !defined(CONFIG_SPL_OS_BOOT)
351 return fit_image_get_os(fit, noffset, os);
356 * Weak default function to allow customizing SPL fit loading for load-only
357 * use cases by allowing to skip the parsing/processing of the FIT contents
358 * (so that this can be done separately in a more customized fashion)
360 __weak bool spl_load_simple_fit_skip_processing(void)
365 int spl_load_simple_fit(struct spl_image_info *spl_image,
366 struct spl_load_info *info, ulong sector, void *fit)
371 struct spl_image_info image_info;
374 int base_offset, hsize, align_len = ARCH_DMA_MINALIGN - 1;
378 * For FIT with external data, figure out where the external images
379 * start. This is the base for the data-offset properties in each
382 size = fdt_totalsize(fit);
383 size = (size + 3) & ~3;
384 size = board_spl_fit_size_align(size);
385 base_offset = (size + 3) & ~3;
388 * So far we only have one block of data from the FIT. Read the entire
389 * thing, including that first block, placing it so it finishes before
390 * where we will load the image.
392 * Note that we will load the image such that its first byte will be
393 * at the load address. Since that byte may be part-way through a
394 * block, we may load the image up to one block before the load
395 * address. So take account of that here by subtracting an addition
396 * block length from the FIT start position.
398 * In fact the FIT has its own load address, but we assume it cannot
399 * be before CONFIG_SYS_TEXT_BASE.
401 * For FIT with data embedded, data is loaded as part of FIT image.
402 * For FIT with external data, data is not loaded in this step.
404 hsize = (size + info->bl_len + align_len) & ~align_len;
405 fit = spl_get_load_buffer(-hsize, hsize);
406 sectors = get_aligned_image_size(info, size, 0);
407 count = info->read(info, sector, sectors, fit);
408 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
409 sector, sectors, fit, count, size);
414 /* skip further processing if requested to enable load-only use cases */
415 if (spl_load_simple_fit_skip_processing())
418 /* find the node holding the images information */
419 images = fdt_path_offset(fit, FIT_IMAGES_PATH);
421 debug("%s: Cannot find /images node: %d\n", __func__, images);
425 #ifdef CONFIG_SPL_FPGA_SUPPORT
426 node = spl_fit_get_image_node(fit, images, "fpga", 0);
428 /* Load the image and set up the spl_image structure */
429 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
432 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
436 debug("FPGA bitstream at: %x, size: %x\n",
437 (u32)spl_image->load_addr, spl_image->size);
439 ret = fpga_load(0, (const void *)spl_image->load_addr,
440 spl_image->size, BIT_FULL);
442 printf("%s: Cannot load the image to the FPGA\n",
447 puts("FPGA image loaded from FIT\n");
453 * Find the U-Boot image using the following search order:
454 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
455 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
456 * - fall back to using the first 'loadables' entry
459 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP,
461 #ifdef CONFIG_SPL_OS_BOOT
463 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0);
466 debug("could not find firmware image, trying loadables...\n");
467 node = spl_fit_get_image_node(fit, images, "loadables", 0);
469 * If we pick the U-Boot image from "loadables", start at
470 * the second image when later loading additional images.
475 debug("%s: Cannot find u-boot image node: %d\n",
480 /* Load the image and set up the spl_image structure */
481 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
487 * For backward compatibility, we treat the first node that is
488 * as a U-Boot image, if no OS-type has been declared.
490 if (!spl_fit_image_get_os(fit, node, &spl_image->os))
491 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
492 #if !defined(CONFIG_SPL_OS_BOOT)
494 spl_image->os = IH_OS_U_BOOT;
498 * Booting a next-stage U-Boot may require us to append the FDT.
499 * We allow this to fail, as the U-Boot image might embed its FDT.
501 if (spl_image->os == IH_OS_U_BOOT)
502 spl_fit_append_fdt(spl_image, info, sector, fit,
503 images, base_offset);
505 /* Now check if there are more images for us to load */
507 uint8_t os_type = IH_OS_INVALID;
509 node = spl_fit_get_image_node(fit, images, "loadables", index);
513 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
518 if (!spl_fit_image_get_os(fit, node, &os_type))
519 debug("Loadable is %s\n", genimg_get_os_name(os_type));
520 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
522 os_type = IH_OS_U_BOOT;
525 if (os_type == IH_OS_U_BOOT) {
526 spl_fit_append_fdt(&image_info, info, sector,
527 fit, images, base_offset);
528 spl_image->fdt_addr = image_info.fdt_addr;
532 * If the "firmware" image did not provide an entry point,
533 * use the first valid entry point from the loadables.
535 if (spl_image->entry_point == FDT_ERROR &&
536 image_info.entry_point != FDT_ERROR)
537 spl_image->entry_point = image_info.entry_point;
539 /* Record our loadables into the FDT */
540 if (spl_image->fdt_addr)
541 spl_fit_record_loadable(fit, images, index,
547 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
548 * Makefile will set it to 0 and it will end up as the entry point
549 * here. What it actually means is: use the load address.
551 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
552 spl_image->entry_point = spl_image->load_addr;
554 spl_image->flags |= SPL_FIT_FOUND;
556 #ifdef CONFIG_IMX_HAB
557 board_spl_fit_post_load((ulong)fit, size);