2 * Copyright (C) 2016 Google, Inc
3 * Written by Simon Glass <sjg@chromium.org>
5 * SPDX-License-Identifier: GPL-2.0+
14 #ifndef CONFIG_SYS_BOOTM_LEN
15 #define CONFIG_SYS_BOOTM_LEN (64 << 20)
19 * spl_fit_get_image_node(): 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.
27 * Return: the node offset of the respective image node or a negative
30 static int spl_fit_get_image_node(const void *fit
, int images
,
31 const char *type
, int index
)
33 const char *name
, *str
;
37 conf_node
= fit_find_config_node(fit
);
39 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
40 printf("No matching DT out of these options:\n");
41 for (node
= fdt_first_subnode(fit
, conf_node
);
43 node
= fdt_next_subnode(fit
, node
)) {
44 name
= fdt_getprop(fit
, node
, "description", &len
);
45 printf(" %s\n", name
);
51 name
= fdt_getprop(fit
, conf_node
, type
, &len
);
53 debug("cannot find property '%s': %d\n", type
, len
);
58 for (i
= 0; i
< index
; i
++) {
59 str
= strchr(str
, '\0') + 1;
60 if (!str
|| (str
- name
>= len
)) {
61 debug("no string for index %d\n", index
);
66 debug("%s: '%s'\n", type
, str
);
67 node
= fdt_subnode_offset(fit
, images
, str
);
69 debug("cannot find image node '%s': %d\n", str
, node
);
76 static int get_aligned_image_offset(struct spl_load_info
*info
, int offset
)
79 * If it is a FS read, get the first address before offset which is
80 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
81 * block number to which offset belongs.
84 return offset
& ~(ARCH_DMA_MINALIGN
- 1);
86 return offset
/ info
->bl_len
;
89 static int get_aligned_image_overhead(struct spl_load_info
*info
, int offset
)
92 * If it is a FS read, get the difference between the offset and
93 * the first address before offset which is aligned to
94 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
98 return offset
& (ARCH_DMA_MINALIGN
- 1);
100 return offset
% info
->bl_len
;
103 static int get_aligned_image_size(struct spl_load_info
*info
, int data_size
,
106 data_size
= data_size
+ get_aligned_image_overhead(info
, offset
);
111 return (data_size
+ info
->bl_len
- 1) / info
->bl_len
;
115 * spl_load_fit_image(): load the image described in a certain FIT node
116 * @info: points to information about the device to load data from
117 * @sector: the start sector of the FIT image on the device
118 * @fit: points to the flattened device tree blob describing the FIT
120 * @base_offset: the beginning of the data area containing the actual
121 * image data, relative to the beginning of the FIT
122 * @node: offset of the DT node describing the image to load (relative
124 * @image_info: will be filled with information about the loaded image
125 * If the FIT node does not contain a "load" (address) property,
126 * the image gets loaded to the address pointed to by the
127 * load_addr member in this struct.
129 * Return: 0 on success or a negative error number.
131 static int spl_load_fit_image(struct spl_load_info
*info
, ulong sector
,
132 void *fit
, ulong base_offset
, int node
,
133 struct spl_image_info
*image_info
)
139 ulong load_addr
, load_ptr
;
143 int align_len
= ARCH_DMA_MINALIGN
- 1;
144 uint8_t image_comp
= -1, type
= -1;
147 if (IS_ENABLED(CONFIG_SPL_OS_BOOT
) && IS_ENABLED(CONFIG_SPL_GZIP
)) {
148 if (fit_image_get_comp(fit
, node
, &image_comp
))
149 puts("Cannot get image compression format.\n");
151 debug("%s ", genimg_get_comp_name(image_comp
));
153 if (fit_image_get_type(fit
, node
, &type
))
154 puts("Cannot get image type.\n");
156 debug("%s ", genimg_get_type_name(type
));
159 if (fit_image_get_load(fit
, node
, &load_addr
))
160 load_addr
= image_info
->load_addr
;
162 if (!fit_image_get_data_offset(fit
, node
, &offset
)) {
164 offset
+= base_offset
;
165 if (fit_image_get_data_size(fit
, node
, &len
))
168 load_ptr
= (load_addr
+ align_len
) & ~align_len
;
171 overhead
= get_aligned_image_overhead(info
, offset
);
172 nr_sectors
= get_aligned_image_size(info
, length
, offset
);
175 sector
+ get_aligned_image_offset(info
, offset
),
176 nr_sectors
, (void *)load_ptr
) != nr_sectors
)
179 debug("External data: dst=%lx, offset=%x, size=%lx\n",
180 load_ptr
, offset
, (unsigned long)length
);
181 src
= (void *)load_ptr
+ overhead
;
184 if (fit_image_get_data(fit
, node
, &data
, &length
)) {
185 puts("Cannot get image data/size\n");
188 debug("Embedded data: dst=%lx, size=%lx\n", load_addr
,
189 (unsigned long)length
);
193 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
194 board_fit_image_post_process(&src
, &length
);
197 if (IS_ENABLED(CONFIG_SPL_OS_BOOT
) &&
198 IS_ENABLED(CONFIG_SPL_GZIP
) &&
199 image_comp
== IH_COMP_GZIP
&&
200 type
== IH_TYPE_KERNEL
) {
202 if (gunzip((void *)load_addr
, CONFIG_SYS_BOOTM_LEN
,
204 puts("Uncompressing error\n");
209 memcpy((void *)load_addr
, src
, length
);
213 image_info
->load_addr
= load_addr
;
214 image_info
->size
= length
;
215 image_info
->entry_point
= fdt_getprop_u32(fit
, node
, "entry");
221 int spl_load_simple_fit(struct spl_image_info
*spl_image
,
222 struct spl_load_info
*info
, ulong sector
, void *fit
)
227 struct spl_image_info image_info
;
228 bool boot_os
= false;
231 int base_offset
, align_len
= ARCH_DMA_MINALIGN
- 1;
235 * For FIT with external data, figure out where the external images
236 * start. This is the base for the data-offset properties in each
239 size
= fdt_totalsize(fit
);
240 size
= (size
+ 3) & ~3;
241 base_offset
= (size
+ 3) & ~3;
244 * So far we only have one block of data from the FIT. Read the entire
245 * thing, including that first block, placing it so it finishes before
246 * where we will load the image.
248 * Note that we will load the image such that its first byte will be
249 * at the load address. Since that byte may be part-way through a
250 * block, we may load the image up to one block before the load
251 * address. So take account of that here by subtracting an addition
252 * block length from the FIT start position.
254 * In fact the FIT has its own load address, but we assume it cannot
255 * be before CONFIG_SYS_TEXT_BASE.
257 * For FIT with data embedded, data is loaded as part of FIT image.
258 * For FIT with external data, data is not loaded in this step.
260 fit
= (void *)((CONFIG_SYS_TEXT_BASE
- size
- info
->bl_len
-
261 align_len
) & ~align_len
);
262 sectors
= get_aligned_image_size(info
, size
, 0);
263 count
= info
->read(info
, sector
, sectors
, fit
);
264 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n",
265 sector
, sectors
, fit
, count
);
269 /* find the node holding the images information */
270 images
= fdt_path_offset(fit
, FIT_IMAGES_PATH
);
272 debug("%s: Cannot find /images node: %d\n", __func__
, images
);
276 #ifdef CONFIG_SPL_OS_BOOT
277 /* Find OS image first */
278 node
= spl_fit_get_image_node(fit
, images
, FIT_KERNEL_PROP
, 0);
280 debug("No kernel image.\n");
284 /* find the U-Boot image */
286 node
= spl_fit_get_image_node(fit
, images
, "firmware", 0);
288 debug("could not find firmware image, trying loadables...\n");
289 node
= spl_fit_get_image_node(fit
, images
, "loadables", 0);
291 * If we pick the U-Boot image from "loadables", start at
292 * the second image when later loading additional images.
297 debug("%s: Cannot find u-boot image node: %d\n",
302 /* Load the image and set up the spl_image structure */
303 ret
= spl_load_fit_image(info
, sector
, fit
, base_offset
, node
,
308 #ifdef CONFIG_SPL_OS_BOOT
309 if (!fit_image_get_os(fit
, node
, &spl_image
->os
))
310 debug("Image OS is %s\n", genimg_get_os_name(spl_image
->os
));
312 spl_image
->os
= IH_OS_U_BOOT
;
316 /* Figure out which device tree the board wants to use */
317 node
= spl_fit_get_image_node(fit
, images
, FIT_FDT_PROP
, 0);
319 debug("%s: cannot find FDT node\n", __func__
);
324 * Read the device tree and place it after the image.
325 * Align the destination address to ARCH_DMA_MINALIGN.
327 image_info
.load_addr
= spl_image
->load_addr
+ spl_image
->size
;
328 ret
= spl_load_fit_image(info
, sector
, fit
, base_offset
, node
,
334 /* Now check if there are more images for us to load */
336 node
= spl_fit_get_image_node(fit
, images
, "loadables", index
);
340 ret
= spl_load_fit_image(info
, sector
, fit
, base_offset
, node
,
346 * If the "firmware" image did not provide an entry point,
347 * use the first valid entry point from the loadables.
349 if (spl_image
->entry_point
== FDT_ERROR
&&
350 image_info
.entry_point
!= FDT_ERROR
)
351 spl_image
->entry_point
= image_info
.entry_point
;
355 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
356 * Makefile will set it to 0 and it will end up as the entry point
357 * here. What it actually means is: use the load address.
359 if (spl_image
->entry_point
== FDT_ERROR
|| spl_image
->entry_point
== 0)
360 spl_image
->entry_point
= spl_image
->load_addr
;