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 #ifndef CONFIG_SYS_BOOTM_LEN
16 #define CONFIG_SYS_BOOTM_LEN (64 << 20)
19 __weak void board_spl_fit_post_load(ulong load_addr, size_t length)
23 __weak ulong board_spl_fit_size_align(ulong size)
29 * spl_fit_get_image_name(): By using the matching configuration subnode,
30 * retrieve the name of an image, specified by a property name and an index
32 * @fit: Pointer to the FDT blob.
33 * @images: Offset of the /images subnode.
34 * @type: Name of the property within the configuration subnode.
35 * @index: Index into the list of strings in this property.
36 * @outname: Name of the image
38 * Return: 0 on success, or a negative error number
40 static int spl_fit_get_image_name(const void *fit, int images,
41 const char *type, int index,
44 const char *name, *str;
45 __maybe_unused int node;
49 conf_node = fit_find_config_node(fit);
51 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
52 printf("No matching DT out of these options:\n");
53 for (node = fdt_first_subnode(fit, conf_node);
55 node = fdt_next_subnode(fit, node)) {
56 name = fdt_getprop(fit, node, "description", &len);
57 printf(" %s\n", name);
63 name = fdt_getprop(fit, conf_node, type, &len);
65 debug("cannot find property '%s': %d\n", type, len);
70 for (i = 0; i < index; i++) {
71 str = strchr(str, '\0') + 1;
72 if (!str || (str - name >= len)) {
73 debug("no string for index %d\n", index);
78 *outname = (char *)str;
83 * spl_fit_get_image_node(): By using the matching configuration subnode,
84 * retrieve the name of an image, specified by a property name and an index
86 * @fit: Pointer to the FDT blob.
87 * @images: Offset of the /images subnode.
88 * @type: Name of the property within the configuration subnode.
89 * @index: Index into the list of strings in this property.
91 * Return: the node offset of the respective image node or a negative
94 static int spl_fit_get_image_node(const void *fit, int images,
95 const char *type, int index)
101 err = spl_fit_get_image_name(fit, images, type, index, &str);
105 debug("%s: '%s'\n", type, str);
107 node = fdt_subnode_offset(fit, images, str);
109 debug("cannot find image node '%s': %d\n", str, node);
116 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
119 * If it is a FS read, get the first address before offset which is
120 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
121 * block number to which offset belongs.
124 return offset & ~(ARCH_DMA_MINALIGN - 1);
126 return offset / info->bl_len;
129 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
132 * If it is a FS read, get the difference between the offset and
133 * the first address before offset which is aligned to
134 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
138 return offset & (ARCH_DMA_MINALIGN - 1);
140 return offset % info->bl_len;
143 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
146 data_size = data_size + get_aligned_image_overhead(info, offset);
151 return (data_size + info->bl_len - 1) / info->bl_len;
155 * spl_load_fit_image(): load the image described in a certain FIT node
156 * @info: points to information about the device to load data from
157 * @sector: the start sector of the FIT image on the device
158 * @fit: points to the flattened device tree blob describing the FIT
160 * @base_offset: the beginning of the data area containing the actual
161 * image data, relative to the beginning of the FIT
162 * @node: offset of the DT node describing the image to load (relative
164 * @image_info: will be filled with information about the loaded image
165 * If the FIT node does not contain a "load" (address) property,
166 * the image gets loaded to the address pointed to by the
167 * load_addr member in this struct.
169 * Return: 0 on success or a negative error number.
171 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
172 void *fit, ulong base_offset, int node,
173 struct spl_image_info *image_info)
179 ulong load_addr, load_ptr;
183 int align_len = ARCH_DMA_MINALIGN - 1;
184 uint8_t image_comp = -1, type = -1;
186 bool external_data = false;
188 if (IS_ENABLED(CONFIG_SPL_FPGA_SUPPORT) ||
189 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
190 if (fit_image_get_type(fit, node, &type))
191 puts("Cannot get image type.\n");
193 debug("%s ", genimg_get_type_name(type));
196 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) {
197 if (fit_image_get_comp(fit, node, &image_comp))
198 puts("Cannot get image compression format.\n");
200 debug("%s ", genimg_get_comp_name(image_comp));
203 if (fit_image_get_load(fit, node, &load_addr))
204 load_addr = image_info->load_addr;
206 if (!fit_image_get_data_position(fit, node, &offset)) {
207 external_data = true;
208 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
209 offset += base_offset;
210 external_data = true;
215 if (fit_image_get_data_size(fit, node, &len))
218 load_ptr = (load_addr + align_len) & ~align_len;
221 overhead = get_aligned_image_overhead(info, offset);
222 nr_sectors = get_aligned_image_size(info, length, offset);
225 sector + get_aligned_image_offset(info, offset),
226 nr_sectors, (void *)load_ptr) != nr_sectors)
229 debug("External data: dst=%lx, offset=%x, size=%lx\n",
230 load_ptr, offset, (unsigned long)length);
231 src = (void *)load_ptr + overhead;
234 if (fit_image_get_data(fit, node, &data, &length)) {
235 puts("Cannot get image data/size\n");
238 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
239 (unsigned long)length);
243 #ifdef CONFIG_SPL_FIT_SIGNATURE
244 printf("## Checking hash(es) for Image %s ... ",
245 fit_get_name(fit, node, NULL));
246 if (!fit_image_verify_with_data(fit, node,
252 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
253 board_fit_image_post_process(&src, &length);
256 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
258 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
260 puts("Uncompressing error\n");
265 memcpy((void *)load_addr, src, length);
269 image_info->load_addr = load_addr;
270 image_info->size = length;
271 image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
277 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
278 struct spl_load_info *info, ulong sector,
279 void *fit, int images, ulong base_offset)
281 struct spl_image_info image_info;
284 /* Figure out which device tree the board wants to use */
285 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);
287 debug("%s: cannot find FDT node\n", __func__);
292 * Read the device tree and place it after the image.
293 * Align the destination address to ARCH_DMA_MINALIGN.
295 image_info.load_addr = spl_image->load_addr + spl_image->size;
296 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
302 /* Make the load-address of the FDT available for the SPL framework */
303 spl_image->fdt_addr = (void *)image_info.load_addr;
304 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
305 /* Try to make space, so we can inject details on the loadables */
306 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
312 static int spl_fit_record_loadable(const void *fit, int images, int index,
313 void *blob, struct spl_image_info *image)
316 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
320 ret = spl_fit_get_image_name(fit, images, "loadables",
325 node = spl_fit_get_image_node(fit, images, "loadables", index);
327 ret = fdt_record_loadable(blob, index, name, image->load_addr,
328 image->size, image->entry_point,
329 fdt_getprop(fit, node, "type", NULL),
330 fdt_getprop(fit, node, "os", NULL));
335 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
337 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) && !defined(CONFIG_SPL_OS_BOOT)
340 return fit_image_get_os(fit, noffset, os);
345 * Weak default function to allow customizing SPL fit loading for load-only
346 * use cases by allowing to skip the parsing/processing of the FIT contents
347 * (so that this can be done separately in a more customized fashion)
349 __weak bool spl_load_simple_fit_skip_processing(void)
354 int spl_load_simple_fit(struct spl_image_info *spl_image,
355 struct spl_load_info *info, ulong sector, void *fit)
360 struct spl_image_info image_info;
363 int base_offset, hsize, align_len = ARCH_DMA_MINALIGN - 1;
367 * For FIT with external data, figure out where the external images
368 * start. This is the base for the data-offset properties in each
371 size = fdt_totalsize(fit);
372 size = (size + 3) & ~3;
373 size = board_spl_fit_size_align(size);
374 base_offset = (size + 3) & ~3;
377 * So far we only have one block of data from the FIT. Read the entire
378 * thing, including that first block, placing it so it finishes before
379 * where we will load the image.
381 * Note that we will load the image such that its first byte will be
382 * at the load address. Since that byte may be part-way through a
383 * block, we may load the image up to one block before the load
384 * address. So take account of that here by subtracting an addition
385 * block length from the FIT start position.
387 * In fact the FIT has its own load address, but we assume it cannot
388 * be before CONFIG_SYS_TEXT_BASE.
390 * For FIT with data embedded, data is loaded as part of FIT image.
391 * For FIT with external data, data is not loaded in this step.
393 hsize = (size + info->bl_len + align_len) & ~align_len;
394 fit = spl_get_load_buffer(-hsize, hsize);
395 sectors = get_aligned_image_size(info, size, 0);
396 count = info->read(info, sector, sectors, fit);
397 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
398 sector, sectors, fit, count, size);
403 /* skip further processing if requested to enable load-only use cases */
404 if (spl_load_simple_fit_skip_processing())
407 /* find the node holding the images information */
408 images = fdt_path_offset(fit, FIT_IMAGES_PATH);
410 debug("%s: Cannot find /images node: %d\n", __func__, images);
414 #ifdef CONFIG_SPL_FPGA_SUPPORT
415 node = spl_fit_get_image_node(fit, images, "fpga", 0);
417 /* Load the image and set up the spl_image structure */
418 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
421 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
425 debug("FPGA bitstream at: %x, size: %x\n",
426 (u32)spl_image->load_addr, spl_image->size);
428 ret = fpga_load(0, (const void *)spl_image->load_addr,
429 spl_image->size, BIT_FULL);
431 printf("%s: Cannot load the image to the FPGA\n",
436 puts("FPGA image loaded from FIT\n");
442 * Find the U-Boot image using the following search order:
443 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
444 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
445 * - fall back to using the first 'loadables' entry
448 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP,
450 #ifdef CONFIG_SPL_OS_BOOT
452 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0);
455 debug("could not find firmware image, trying loadables...\n");
456 node = spl_fit_get_image_node(fit, images, "loadables", 0);
458 * If we pick the U-Boot image from "loadables", start at
459 * the second image when later loading additional images.
464 debug("%s: Cannot find u-boot image node: %d\n",
469 /* Load the image and set up the spl_image structure */
470 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
476 * For backward compatibility, we treat the first node that is
477 * as a U-Boot image, if no OS-type has been declared.
479 if (!spl_fit_image_get_os(fit, node, &spl_image->os))
480 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
481 #if !defined(CONFIG_SPL_OS_BOOT)
483 spl_image->os = IH_OS_U_BOOT;
487 * Booting a next-stage U-Boot may require us to append the FDT.
488 * We allow this to fail, as the U-Boot image might embed its FDT.
490 if (spl_image->os == IH_OS_U_BOOT)
491 spl_fit_append_fdt(spl_image, info, sector, fit,
492 images, base_offset);
494 /* Now check if there are more images for us to load */
496 uint8_t os_type = IH_OS_INVALID;
498 node = spl_fit_get_image_node(fit, images, "loadables", index);
502 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
507 if (!spl_fit_image_get_os(fit, node, &os_type))
508 debug("Loadable is %s\n", genimg_get_os_name(os_type));
509 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
511 os_type = IH_OS_U_BOOT;
514 if (os_type == IH_OS_U_BOOT) {
515 spl_fit_append_fdt(&image_info, info, sector,
516 fit, images, base_offset);
517 spl_image->fdt_addr = image_info.fdt_addr;
521 * If the "firmware" image did not provide an entry point,
522 * use the first valid entry point from the loadables.
524 if (spl_image->entry_point == FDT_ERROR &&
525 image_info.entry_point != FDT_ERROR)
526 spl_image->entry_point = image_info.entry_point;
528 /* Record our loadables into the FDT */
529 if (spl_image->fdt_addr)
530 spl_fit_record_loadable(fit, images, index,
536 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
537 * Makefile will set it to 0 and it will end up as the entry point
538 * here. What it actually means is: use the load address.
540 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
541 spl_image->entry_point = spl_image->load_addr;
543 spl_image->flags |= SPL_FIT_FOUND;
545 #ifdef CONFIG_SECURE_BOOT
546 board_spl_fit_post_load((ulong)fit, size);