1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
11 #include <linux/libfdt.h>
14 #ifndef CONFIG_SYS_BOOTM_LEN
15 #define CONFIG_SYS_BOOTM_LEN (64 << 20)
19 * spl_fit_get_image_name(): By using the matching configuration subnode,
20 * retrieve the name of an image, specified by a property name and an index
22 * @fit: Pointer to the FDT blob.
23 * @images: Offset of the /images subnode.
24 * @type: Name of the property within the configuration subnode.
25 * @index: Index into the list of strings in this property.
26 * @outname: Name of the image
28 * Return: 0 on success, or a negative error number
30 static int spl_fit_get_image_name(const void *fit, int images,
31 const char *type, int index,
34 const char *name, *str;
35 __maybe_unused int node;
39 conf_node = fit_find_config_node(fit);
41 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
42 printf("No matching DT out of these options:\n");
43 for (node = fdt_first_subnode(fit, conf_node);
45 node = fdt_next_subnode(fit, node)) {
46 name = fdt_getprop(fit, node, "description", &len);
47 printf(" %s\n", name);
53 name = fdt_getprop(fit, conf_node, type, &len);
55 debug("cannot find property '%s': %d\n", type, len);
60 for (i = 0; i < index; i++) {
61 str = strchr(str, '\0') + 1;
62 if (!str || (str - name >= len)) {
63 debug("no string for index %d\n", index);
68 *outname = (char *)str;
73 * spl_fit_get_image_node(): By using the matching configuration subnode,
74 * retrieve the name of an image, specified by a property name and an index
76 * @fit: Pointer to the FDT blob.
77 * @images: Offset of the /images subnode.
78 * @type: Name of the property within the configuration subnode.
79 * @index: Index into the list of strings in this property.
81 * Return: the node offset of the respective image node or a negative
84 static int spl_fit_get_image_node(const void *fit, int images,
85 const char *type, int index)
91 err = spl_fit_get_image_name(fit, images, type, index, &str);
95 debug("%s: '%s'\n", type, str);
97 node = fdt_subnode_offset(fit, images, str);
99 debug("cannot find image node '%s': %d\n", str, node);
106 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
109 * If it is a FS read, get the first address before offset which is
110 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
111 * block number to which offset belongs.
114 return offset & ~(ARCH_DMA_MINALIGN - 1);
116 return offset / info->bl_len;
119 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
122 * If it is a FS read, get the difference between the offset and
123 * the first address before offset which is aligned to
124 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
128 return offset & (ARCH_DMA_MINALIGN - 1);
130 return offset % info->bl_len;
133 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
136 data_size = data_size + get_aligned_image_overhead(info, offset);
141 return (data_size + info->bl_len - 1) / info->bl_len;
145 * spl_load_fit_image(): load the image described in a certain FIT node
146 * @info: points to information about the device to load data from
147 * @sector: the start sector of the FIT image on the device
148 * @fit: points to the flattened device tree blob describing the FIT
150 * @base_offset: the beginning of the data area containing the actual
151 * image data, relative to the beginning of the FIT
152 * @node: offset of the DT node describing the image to load (relative
154 * @image_info: will be filled with information about the loaded image
155 * If the FIT node does not contain a "load" (address) property,
156 * the image gets loaded to the address pointed to by the
157 * load_addr member in this struct.
159 * Return: 0 on success or a negative error number.
161 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
162 void *fit, ulong base_offset, int node,
163 struct spl_image_info *image_info)
169 ulong load_addr, load_ptr;
173 int align_len = ARCH_DMA_MINALIGN - 1;
174 uint8_t image_comp = -1, type = -1;
176 bool external_data = false;
178 if (IS_ENABLED(CONFIG_SPL_FPGA_SUPPORT) ||
179 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
180 if (fit_image_get_type(fit, node, &type))
181 puts("Cannot get image type.\n");
183 debug("%s ", genimg_get_type_name(type));
186 if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) {
187 if (fit_image_get_comp(fit, node, &image_comp))
188 puts("Cannot get image compression format.\n");
190 debug("%s ", genimg_get_comp_name(image_comp));
193 if (fit_image_get_load(fit, node, &load_addr))
194 load_addr = image_info->load_addr;
196 if (!fit_image_get_data_position(fit, node, &offset)) {
197 external_data = true;
198 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
199 offset += base_offset;
200 external_data = true;
205 if (fit_image_get_data_size(fit, node, &len))
208 load_ptr = (load_addr + align_len) & ~align_len;
211 overhead = get_aligned_image_overhead(info, offset);
212 nr_sectors = get_aligned_image_size(info, length, offset);
215 sector + get_aligned_image_offset(info, offset),
216 nr_sectors, (void *)load_ptr) != nr_sectors)
219 debug("External data: dst=%lx, offset=%x, size=%lx\n",
220 load_ptr, offset, (unsigned long)length);
221 src = (void *)load_ptr + overhead;
224 if (fit_image_get_data(fit, node, &data, &length)) {
225 puts("Cannot get image data/size\n");
228 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
229 (unsigned long)length);
233 #ifdef CONFIG_SPL_FIT_SIGNATURE
234 printf("## Checking hash(es) for Image %s ... ",
235 fit_get_name(fit, node, NULL));
236 if (!fit_image_verify_with_data(fit, node,
242 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
243 board_fit_image_post_process(&src, &length);
246 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
248 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
250 puts("Uncompressing error\n");
255 memcpy((void *)load_addr, src, length);
259 image_info->load_addr = load_addr;
260 image_info->size = length;
261 image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
267 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
268 struct spl_load_info *info, ulong sector,
269 void *fit, int images, ulong base_offset)
271 struct spl_image_info image_info;
274 /* Figure out which device tree the board wants to use */
275 node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);
277 debug("%s: cannot find FDT node\n", __func__);
282 * Read the device tree and place it after the image.
283 * Align the destination address to ARCH_DMA_MINALIGN.
285 image_info.load_addr = spl_image->load_addr + spl_image->size;
286 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
292 /* Make the load-address of the FDT available for the SPL framework */
293 spl_image->fdt_addr = (void *)image_info.load_addr;
294 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
295 /* Try to make space, so we can inject details on the loadables */
296 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
302 static int spl_fit_record_loadable(const void *fit, int images, int index,
303 void *blob, struct spl_image_info *image)
306 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
310 ret = spl_fit_get_image_name(fit, images, "loadables",
315 node = spl_fit_get_image_node(fit, images, "loadables", index);
317 ret = fdt_record_loadable(blob, index, name, image->load_addr,
318 image->size, image->entry_point,
319 fdt_getprop(fit, node, "type", NULL),
320 fdt_getprop(fit, node, "os", NULL));
325 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
327 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
330 return fit_image_get_os(fit, noffset, os);
334 int spl_load_simple_fit(struct spl_image_info *spl_image,
335 struct spl_load_info *info, ulong sector, void *fit)
340 struct spl_image_info image_info;
343 int base_offset, hsize, align_len = ARCH_DMA_MINALIGN - 1;
347 * For FIT with external data, figure out where the external images
348 * start. This is the base for the data-offset properties in each
351 size = fdt_totalsize(fit);
352 size = (size + 3) & ~3;
353 base_offset = (size + 3) & ~3;
356 * So far we only have one block of data from the FIT. Read the entire
357 * thing, including that first block, placing it so it finishes before
358 * where we will load the image.
360 * Note that we will load the image such that its first byte will be
361 * at the load address. Since that byte may be part-way through a
362 * block, we may load the image up to one block before the load
363 * address. So take account of that here by subtracting an addition
364 * block length from the FIT start position.
366 * In fact the FIT has its own load address, but we assume it cannot
367 * be before CONFIG_SYS_TEXT_BASE.
369 * For FIT with data embedded, data is loaded as part of FIT image.
370 * For FIT with external data, data is not loaded in this step.
372 hsize = (size + info->bl_len + align_len) & ~align_len;
373 fit = spl_get_load_buffer(-hsize, hsize);
374 sectors = get_aligned_image_size(info, size, 0);
375 count = info->read(info, sector, sectors, fit);
376 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n",
377 sector, sectors, fit, count);
381 /* find the node holding the images information */
382 images = fdt_path_offset(fit, FIT_IMAGES_PATH);
384 debug("%s: Cannot find /images node: %d\n", __func__, images);
388 #ifdef CONFIG_SPL_FPGA_SUPPORT
389 node = spl_fit_get_image_node(fit, images, "fpga", 0);
391 /* Load the image and set up the spl_image structure */
392 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
395 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
399 debug("FPGA bitstream at: %x, size: %x\n",
400 (u32)spl_image->load_addr, spl_image->size);
402 ret = fpga_load(0, (const void *)spl_image->load_addr,
403 spl_image->size, BIT_FULL);
405 printf("%s: Cannot load the image to the FPGA\n",
410 puts("FPGA image loaded from FIT\n");
416 * Find the U-Boot image using the following search order:
417 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
418 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
419 * - fall back to using the first 'loadables' entry
422 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP,
424 #ifdef CONFIG_SPL_OS_BOOT
426 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0);
429 debug("could not find firmware image, trying loadables...\n");
430 node = spl_fit_get_image_node(fit, images, "loadables", 0);
432 * If we pick the U-Boot image from "loadables", start at
433 * the second image when later loading additional images.
438 debug("%s: Cannot find u-boot image node: %d\n",
443 /* Load the image and set up the spl_image structure */
444 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
450 * For backward compatibility, we treat the first node that is
451 * as a U-Boot image, if no OS-type has been declared.
453 if (!spl_fit_image_get_os(fit, node, &spl_image->os))
454 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
455 #if !defined(CONFIG_SPL_OS_BOOT)
457 spl_image->os = IH_OS_U_BOOT;
461 * Booting a next-stage U-Boot may require us to append the FDT.
462 * We allow this to fail, as the U-Boot image might embed its FDT.
464 if (spl_image->os == IH_OS_U_BOOT)
465 spl_fit_append_fdt(spl_image, info, sector, fit,
466 images, base_offset);
468 /* Now check if there are more images for us to load */
470 uint8_t os_type = IH_OS_INVALID;
472 node = spl_fit_get_image_node(fit, images, "loadables", index);
476 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
481 if (!spl_fit_image_get_os(fit, node, &os_type))
482 debug("Loadable is %s\n", genimg_get_os_name(os_type));
484 if (os_type == IH_OS_U_BOOT) {
485 spl_fit_append_fdt(&image_info, info, sector,
486 fit, images, base_offset);
487 spl_image->fdt_addr = image_info.fdt_addr;
491 * If the "firmware" image did not provide an entry point,
492 * use the first valid entry point from the loadables.
494 if (spl_image->entry_point == FDT_ERROR &&
495 image_info.entry_point != FDT_ERROR)
496 spl_image->entry_point = image_info.entry_point;
498 /* Record our loadables into the FDT */
499 if (spl_image->fdt_addr)
500 spl_fit_record_loadable(fit, images, index,
506 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
507 * Makefile will set it to 0 and it will end up as the entry point
508 * here. What it actually means is: use the load address.
510 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
511 spl_image->entry_point = spl_image->load_addr;