blob: 49b4df605607b17a884473a094a26ce766646891 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glassa6131a22016-02-22 22:55:56 -07002/*
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Simon Glassa6131a22016-02-22 22:55:56 -07005 */
6
Simon Glassa6131a22016-02-22 22:55:56 -07007#include <errno.h>
Michal Simekf707b5a2018-07-18 14:33:15 +02008#include <fpga.h>
Simon Glass1a974af2019-08-01 09:46:36 -06009#include <gzip.h>
Simon Glassa6131a22016-02-22 22:55:56 -070010#include <image.h>
Simon Glass0f2af882020-05-10 11:40:05 -060011#include <log.h>
Stefan Herbrechtsmeier66249102022-06-14 16:12:00 +020012#include <memalign.h>
Simon Glass2192e982021-03-07 17:35:14 -070013#include <mapmem.h>
Simon Glassa6131a22016-02-22 22:55:56 -070014#include <spl.h>
Simon Glass9b5bfba2024-08-07 16:47:33 -060015#include <upl.h>
Simon Glass458b66a2020-11-05 06:32:05 -070016#include <sysinfo.h>
Simon Glass3ba929a2020-10-30 21:38:53 -060017#include <asm/global_data.h>
Sean Anderson5ff77722023-10-14 16:47:55 -040018#include <asm/io.h>
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +020019#include <linux/libfdt.h>
Simon Glassbdd5f812023-09-14 18:21:46 -060020#include <linux/printk.h>
Simon Glassa6131a22016-02-22 22:55:56 -070021
Lukas Auer80afee72019-08-21 21:14:42 +020022DECLARE_GLOBAL_DATA_PTR;
23
Alexandru Gagniuc23243c92021-01-20 10:46:50 -060024struct spl_fit_info {
25 const void *fit; /* Pointer to a valid FIT blob */
26 size_t ext_data_offset; /* Offset to FIT external data (end of FIT) */
27 int images_node; /* FDT offset to "/images" node */
Alexandru Gagniucfa11a442021-01-20 10:46:53 -060028 int conf_node; /* FDT offset to selected configuration node */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -060029};
30
Ye Li9d5b0f42018-11-17 09:10:25 +000031__weak ulong board_spl_fit_size_align(ulong size)
32{
33 return size;
34}
35
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020036static int find_node_from_desc(const void *fit, int node, const char *str)
37{
38 int child;
39
40 if (node < 0)
41 return -EINVAL;
42
43 /* iterate the FIT nodes and find a matching description */
44 for (child = fdt_first_subnode(fit, node); child >= 0;
45 child = fdt_next_subnode(fit, child)) {
46 int len;
Simon Glassdff90432023-09-26 08:14:35 -060047 const char *desc = fdt_getprop(fit, child, FIT_DESC_PROP, &len);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020048
49 if (!desc)
50 continue;
51
52 if (!strcmp(desc, str))
53 return child;
54 }
55
56 return -ENOENT;
57}
58
Andre Przywara525e9c92017-04-26 01:32:34 +010059/**
Philipp Tomsiche61eff92017-09-13 21:29:34 +020060 * spl_fit_get_image_name(): By using the matching configuration subnode,
Andre Przywara525e9c92017-04-26 01:32:34 +010061 * retrieve the name of an image, specified by a property name and an index
62 * into that.
63 * @fit: Pointer to the FDT blob.
64 * @images: Offset of the /images subnode.
65 * @type: Name of the property within the configuration subnode.
66 * @index: Index into the list of strings in this property.
Philipp Tomsiche61eff92017-09-13 21:29:34 +020067 * @outname: Name of the image
Andre Przywara525e9c92017-04-26 01:32:34 +010068 *
Philipp Tomsiche61eff92017-09-13 21:29:34 +020069 * Return: 0 on success, or a negative error number
Andre Przywara525e9c92017-04-26 01:32:34 +010070 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -060071static int spl_fit_get_image_name(const struct spl_fit_info *ctx,
Philipp Tomsiche61eff92017-09-13 21:29:34 +020072 const char *type, int index,
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +020073 const char **outname)
Andre Przywara1e329b62017-04-26 01:32:33 +010074{
Simon Glass458b66a2020-11-05 06:32:05 -070075 struct udevice *sysinfo;
Andre Przywara1e329b62017-04-26 01:32:33 +010076 const char *name, *str;
Philipp Tomsiche61eff92017-09-13 21:29:34 +020077 __maybe_unused int node;
Andre Przywara1e329b62017-04-26 01:32:33 +010078 int len, i;
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020079 bool found = true;
Andre Przywara1e329b62017-04-26 01:32:33 +010080
Alexandru Gagniucfa11a442021-01-20 10:46:53 -060081 name = fdt_getprop(ctx->fit, ctx->conf_node, type, &len);
Andre Przywara1e329b62017-04-26 01:32:33 +010082 if (!name) {
83 debug("cannot find property '%s': %d\n", type, len);
84 return -EINVAL;
85 }
Simon Glassa6131a22016-02-22 22:55:56 -070086
Andre Przywara1e329b62017-04-26 01:32:33 +010087 str = name;
88 for (i = 0; i < index; i++) {
89 str = strchr(str, '\0') + 1;
90 if (!str || (str - name >= len)) {
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020091 found = false;
92 break;
Andre Przywara1e329b62017-04-26 01:32:33 +010093 }
Simon Glassa6131a22016-02-22 22:55:56 -070094 }
95
Simon Glass458b66a2020-11-05 06:32:05 -070096 if (!found && CONFIG_IS_ENABLED(SYSINFO) && !sysinfo_get(&sysinfo)) {
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020097 int rc;
98 /*
Simon Glass458b66a2020-11-05 06:32:05 -070099 * no string in the property for this index. Check if the
100 * sysinfo-level code can supply one.
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200101 */
Sean Anderson6ccf10a2021-04-20 10:50:56 -0400102 rc = sysinfo_detect(sysinfo);
103 if (rc)
104 return rc;
105
Simon Glass458b66a2020-11-05 06:32:05 -0700106 rc = sysinfo_get_fit_loadable(sysinfo, index - i - 1, type,
107 &str);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200108 if (rc && rc != -ENOENT)
109 return rc;
110
111 if (!rc) {
112 /*
Simon Glass458b66a2020-11-05 06:32:05 -0700113 * The sysinfo provided a name for a loadable.
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200114 * Try to match it against the description properties
115 * first. If no matching node is found, use it as a
116 * node name.
117 */
118 int node;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600119 int images = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200120
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600121 node = find_node_from_desc(ctx->fit, images, str);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200122 if (node > 0)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600123 str = fdt_get_name(ctx->fit, node, NULL);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200124
125 found = true;
126 }
127 }
128
129 if (!found) {
130 debug("no string for index %d\n", index);
131 return -E2BIG;
132 }
133
134 *outname = str;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200135 return 0;
136}
137
138/**
139 * spl_fit_get_image_node(): By using the matching configuration subnode,
140 * retrieve the name of an image, specified by a property name and an index
141 * into that.
142 * @fit: Pointer to the FDT blob.
143 * @images: Offset of the /images subnode.
144 * @type: Name of the property within the configuration subnode.
145 * @index: Index into the list of strings in this property.
146 *
147 * Return: the node offset of the respective image node or a negative
148 * error number.
149 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600150static int spl_fit_get_image_node(const struct spl_fit_info *ctx,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200151 const char *type, int index)
152{
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +0200153 const char *str;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200154 int err;
155 int node;
156
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600157 err = spl_fit_get_image_name(ctx, type, index, &str);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200158 if (err)
159 return err;
160
Andre Przywara1e329b62017-04-26 01:32:33 +0100161 debug("%s: '%s'\n", type, str);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200162
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600163 node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
Andre Przywara1e329b62017-04-26 01:32:33 +0100164 if (node < 0) {
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200165 pr_err("cannot find image node '%s': %d\n", str, node);
Andre Przywara1e329b62017-04-26 01:32:33 +0100166 return -EINVAL;
Simon Glassa6131a22016-02-22 22:55:56 -0700167 }
Simon Glassa6131a22016-02-22 22:55:56 -0700168
Andre Przywara525e9c92017-04-26 01:32:34 +0100169 return node;
Simon Glassa6131a22016-02-22 22:55:56 -0700170}
171
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530172static int get_aligned_image_offset(struct spl_load_info *info, int offset)
173{
Sean Anderson35f15fe2023-11-08 11:48:43 -0500174 return ALIGN_DOWN(offset, spl_get_bl_len(info));
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530175}
176
177static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
178{
Sean Anderson35f15fe2023-11-08 11:48:43 -0500179 return offset & (spl_get_bl_len(info) - 1);
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530180}
181
182static int get_aligned_image_size(struct spl_load_info *info, int data_size,
183 int offset)
184{
Lokesh Vutlaf0531a62016-07-19 14:56:14 +0530185 data_size = data_size + get_aligned_image_overhead(info, offset);
186
Sean Anderson35f15fe2023-11-08 11:48:43 -0500187 return ALIGN(data_size, spl_get_bl_len(info));
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530188}
189
Andre Przywara29053e92017-04-26 01:32:36 +0100190/**
Simon Glass205ff7b2023-09-26 08:14:33 -0600191 * load_simple_fit(): load the image described in a certain FIT node
Andre Przywara29053e92017-04-26 01:32:36 +0100192 * @info: points to information about the device to load data from
Simon Glass97c434b2024-12-19 11:29:02 -0700193 * @fit_offset: the offset of the FIT image on the device
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600194 * @ctx: points to the FIT context structure
Andre Przywara29053e92017-04-26 01:32:36 +0100195 * @node: offset of the DT node describing the image to load (relative
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200196 * to @fit)
Andre Przywara29053e92017-04-26 01:32:36 +0100197 * @image_info: will be filled with information about the loaded image
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200198 * If the FIT node does not contain a "load" (address) property,
199 * the image gets loaded to the address pointed to by the
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500200 * load_addr member in this struct, if load_addr is not 0
Andre Przywara29053e92017-04-26 01:32:36 +0100201 *
Simon Glassc811ef92025-01-26 11:43:17 -0700202 * Return: 0 on success, -EPERM if this image is not the correct phase
203 * (for CONFIG_BOOTMETH_VBE_SIMPLE_FW), or another negative error number on
204 * other error.
Andre Przywara29053e92017-04-26 01:32:36 +0100205 */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500206static int load_simple_fit(struct spl_load_info *info, ulong fit_offset,
Simon Glass205ff7b2023-09-26 08:14:33 -0600207 const struct spl_fit_info *ctx, int node,
208 struct spl_image_info *image_info)
Andre Przywara29053e92017-04-26 01:32:36 +0100209{
Michal Simekf707b5a2018-07-18 14:33:15 +0200210 int offset;
Andre Przywara29053e92017-04-26 01:32:36 +0100211 size_t length;
York Sunadf99fa2017-08-15 11:14:44 -0700212 int len;
York Sun25d65f12017-09-15 08:21:13 -0700213 ulong size;
Simon Glass2192e982021-03-07 17:35:14 -0700214 ulong load_addr;
215 void *load_ptr;
Andre Przywara29053e92017-04-26 01:32:36 +0100216 void *src;
217 ulong overhead;
York Suna6945fe2017-08-15 11:14:43 -0700218 uint8_t image_comp = -1, type = -1;
York Sunadf99fa2017-08-15 11:14:44 -0700219 const void *data;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600220 const void *fit = ctx->fit;
Peng Fan8876c7e2017-12-05 13:20:59 +0800221 bool external_data = false;
York Suna6945fe2017-08-15 11:14:43 -0700222
Simon Glassc811ef92025-01-26 11:43:17 -0700223 log_debug("starting\n");
224 if (CONFIG_IS_ENABLED(BOOTMETH_VBE) &&
225 xpl_get_phase(info) != IH_PHASE_NONE) {
226 enum image_phase_t phase;
227 int ret;
228
229 ret = fit_image_get_phase(fit, node, &phase);
230 /* if the image is for any phase, let's use it */
231 if (ret == -ENOENT || phase == xpl_get_phase(info)) {
232 log_debug("found\n");
233 } else if (ret < 0) {
234 log_debug("err=%d\n", ret);
235 return ret;
236 } else {
237 log_debug("- phase mismatch, skipping this image\n");
238 return -EPERM;
239 }
240 }
241
Michal Simek1aab1142020-09-09 14:41:56 +0200242 if (IS_ENABLED(CONFIG_SPL_FPGA) ||
Manoj Sai2b2e6282023-09-18 00:56:25 +0530243 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && spl_decompression_enabled())) {
Marek Vasut72bc5d52018-06-01 23:19:29 +0200244 if (fit_image_get_type(fit, node, &type))
245 puts("Cannot get image type.\n");
246 else
247 debug("%s ", genimg_get_type_name(type));
248 }
249
Manoj Sai2b2e6282023-09-18 00:56:25 +0530250 if (spl_decompression_enabled()) {
Klaus H. Sorensen4a9a0422019-12-11 11:03:33 +0000251 fit_image_get_comp(fit, node, &image_comp);
252 debug("%s ", genimg_get_comp_name(image_comp));
York Suna6945fe2017-08-15 11:14:43 -0700253 }
Andre Przywara29053e92017-04-26 01:32:36 +0100254
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500255 if (fit_image_get_load(fit, node, &load_addr)) {
256 if (!image_info->load_addr) {
257 printf("Can't load %s: No load address and no buffer\n",
258 fit_get_name(fit, node, NULL));
259 return -ENOBUFS;
260 }
Andre Przywara29053e92017-04-26 01:32:36 +0100261 load_addr = image_info->load_addr;
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500262 }
Andre Przywara29053e92017-04-26 01:32:36 +0100263
Peng Fan8876c7e2017-12-05 13:20:59 +0800264 if (!fit_image_get_data_position(fit, node, &offset)) {
265 external_data = true;
266 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
Simon Glass97c434b2024-12-19 11:29:02 -0700267 log_debug("read offset %x = offset from fit %lx\n",
268 offset, (ulong)offset + ctx->ext_data_offset);
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600269 offset += ctx->ext_data_offset;
Peng Fan8876c7e2017-12-05 13:20:59 +0800270 external_data = true;
271 }
272
273 if (external_data) {
Simon Glass97c434b2024-12-19 11:29:02 -0700274 ulong read_offset;
Simon Glass2192e982021-03-07 17:35:14 -0700275 void *src_ptr;
276
Peng Fan8876c7e2017-12-05 13:20:59 +0800277 /* External data */
York Sunadf99fa2017-08-15 11:14:44 -0700278 if (fit_image_get_data_size(fit, node, &len))
279 return -ENOENT;
Andre Przywara29053e92017-04-26 01:32:36 +0100280
Nishanth Menone4cb6452021-10-19 12:32:29 -0500281 /* Dont bother to copy 0 byte data, but warn, though */
282 if (!len) {
283 log_warning("%s: Skip load '%s': image size is 0!\n",
284 __func__, fit_get_name(fit, node, NULL));
285 return 0;
286 }
287
Manoj Saia8560992023-09-18 00:56:26 +0530288 if (spl_decompression_enabled() &&
289 (image_comp == IH_COMP_GZIP || image_comp == IH_COMP_LZMA))
Manoj Sai2b2e6282023-09-18 00:56:25 +0530290 src_ptr = map_sysmem(ALIGN(CONFIG_SYS_LOAD_ADDR, ARCH_DMA_MINALIGN), len);
291 else
292 src_ptr = map_sysmem(ALIGN(load_addr, ARCH_DMA_MINALIGN), len);
York Sunadf99fa2017-08-15 11:14:44 -0700293 length = len;
294
295 overhead = get_aligned_image_overhead(info, offset);
Sean Anderson7d8d6132023-11-08 11:48:40 -0500296 size = get_aligned_image_size(info, length, offset);
Simon Glass97c434b2024-12-19 11:29:02 -0700297 read_offset = fit_offset + get_aligned_image_offset(info,
298 offset);
299 log_debug("reading from offset %x / %lx size %lx to %p: ",
300 offset, read_offset, size, src_ptr);
York Sunadf99fa2017-08-15 11:14:44 -0700301
Simon Glassc811ef92025-01-26 11:43:17 -0700302 if (info->read(info, read_offset, size, src_ptr) < length)
York Sunadf99fa2017-08-15 11:14:44 -0700303 return -EIO;
304
Simon Glass2192e982021-03-07 17:35:14 -0700305 debug("External data: dst=%p, offset=%x, size=%lx\n",
306 src_ptr, offset, (unsigned long)length);
307 src = src_ptr + overhead;
York Sunadf99fa2017-08-15 11:14:44 -0700308 } else {
309 /* Embedded data */
Simon Glassd3ca4012025-01-10 17:00:12 -0700310 if (fit_image_get_emb_data(fit, node, &data, &length)) {
York Sunadf99fa2017-08-15 11:14:44 -0700311 puts("Cannot get image data/size\n");
312 return -ENOENT;
313 }
314 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
315 (unsigned long)length);
Simon Glass2192e982021-03-07 17:35:14 -0700316 src = (void *)data; /* cast away const */
York Sunadf99fa2017-08-15 11:14:44 -0700317 }
Andre Przywara29053e92017-04-26 01:32:36 +0100318
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600319 if (CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
320 printf("## Checking hash(es) for Image %s ... ",
321 fit_get_name(fit, node, NULL));
Simon Glasse10e2ee2021-11-12 12:28:10 -0700322 if (!fit_image_verify_with_data(fit, node, gd_fdt_blob(), src,
323 length))
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600324 return -EPERM;
325 puts("OK\n");
326 }
Ben Whitten54a91192018-06-07 11:37:27 +0100327
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600328 if (CONFIG_IS_ENABLED(FIT_IMAGE_POST_PROCESS))
Lokesh Vutlab36dd3e2021-06-11 11:45:05 +0300329 board_fit_image_post_process(fit, node, &src, &length);
Andre Przywara29053e92017-04-26 01:32:36 +0100330
Simon Glass2192e982021-03-07 17:35:14 -0700331 load_ptr = map_sysmem(load_addr, length);
Michal Simekf354c3f2018-07-24 15:05:00 +0200332 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
York Sun25d65f12017-09-15 08:21:13 -0700333 size = length;
Simon Glass2192e982021-03-07 17:35:14 -0700334 if (gunzip(load_ptr, CONFIG_SYS_BOOTM_LEN, src, &size)) {
York Suna6945fe2017-08-15 11:14:43 -0700335 puts("Uncompressing error\n");
336 return -EIO;
337 }
York Sun25d65f12017-09-15 08:21:13 -0700338 length = size;
Manoj Saia8560992023-09-18 00:56:26 +0530339 } else if (IS_ENABLED(CONFIG_SPL_LZMA) && image_comp == IH_COMP_LZMA) {
340 size = CONFIG_SYS_BOOTM_LEN;
341 ulong loadEnd;
342
343 if (image_decomp(IH_COMP_LZMA, CONFIG_SYS_LOAD_ADDR, 0, 0,
344 load_ptr, src, length, size, &loadEnd)) {
345 puts("Uncompressing error\n");
346 return -EIO;
347 }
348 length = loadEnd - CONFIG_SYS_LOAD_ADDR;
York Suna6945fe2017-08-15 11:14:43 -0700349 } else {
Simon Glass2192e982021-03-07 17:35:14 -0700350 memcpy(load_ptr, src, length);
York Suna6945fe2017-08-15 11:14:43 -0700351 }
Andre Przywara29053e92017-04-26 01:32:36 +0100352
353 if (image_info) {
Michal Simek9e64a552020-09-03 11:24:28 +0200354 ulong entry_point;
355
Andre Przywara29053e92017-04-26 01:32:36 +0100356 image_info->load_addr = load_addr;
357 image_info->size = length;
Michal Simek9e64a552020-09-03 11:24:28 +0200358
359 if (!fit_image_get_entry(fit, node, &entry_point))
360 image_info->entry_point = entry_point;
361 else
362 image_info->entry_point = FDT_ERROR;
Andre Przywara29053e92017-04-26 01:32:36 +0100363 }
Simon Glass97c434b2024-12-19 11:29:02 -0700364 log_debug("- done loading\n");
Andre Przywara29053e92017-04-26 01:32:36 +0100365
Simon Glass9b5bfba2024-08-07 16:47:33 -0600366 upl_add_image(fit, node, load_addr, length);
367
Andre Przywara29053e92017-04-26 01:32:36 +0100368 return 0;
369}
370
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600371static bool os_takes_devicetree(uint8_t os)
372{
373 switch (os) {
374 case IH_OS_U_BOOT:
375 return true;
376 case IH_OS_LINUX:
Randolph263e2ae2023-10-12 14:35:07 +0800377 return IS_ENABLED(CONFIG_SPL_OS_BOOT) ||
378 IS_ENABLED(CONFIG_SPL_OPENSBI);
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600379 default:
380 return false;
381 }
382}
383
Marek Vasuta0494272023-09-21 20:44:16 +0200384__weak int board_spl_fit_append_fdt_skip(const char *name)
385{
386 return 0; /* Do not skip */
387}
388
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200389static int spl_fit_append_fdt(struct spl_image_info *spl_image,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500390 struct spl_load_info *info, ulong offset,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600391 const struct spl_fit_info *ctx)
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200392{
393 struct spl_image_info image_info;
Michal Simekbf703df2019-10-22 16:39:11 +0200394 int node, ret = 0, index = 0;
Lukas Auer80afee72019-08-21 21:14:42 +0200395
396 /*
397 * Use the address following the image as target address for the
Marek Vasutc27cbe82020-10-19 23:40:26 +0200398 * device tree.
Lukas Auer80afee72019-08-21 21:14:42 +0200399 */
Marek Vasutc27cbe82020-10-19 23:40:26 +0200400 image_info.load_addr = spl_image->load_addr + spl_image->size;
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200401
402 /* Figure out which device tree the board wants to use */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600403 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index++);
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200404 if (node < 0) {
Sean Anderson5ff77722023-10-14 16:47:55 -0400405 size_t size;
406
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200407 debug("%s: cannot find FDT node\n", __func__);
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200408
Lukas Auer80afee72019-08-21 21:14:42 +0200409 /*
410 * U-Boot did not find a device tree inside the FIT image. Use
411 * the U-Boot device tree instead.
412 */
Sean Anderson5ff77722023-10-14 16:47:55 -0400413 if (!gd->fdt_blob)
Lukas Auer80afee72019-08-21 21:14:42 +0200414 return node;
Sean Anderson5ff77722023-10-14 16:47:55 -0400415
416 /*
417 * Make the load-address of the FDT available for the SPL
418 * framework
419 */
420 size = fdt_totalsize(gd->fdt_blob);
421 spl_image->fdt_addr = map_sysmem(image_info.load_addr, size);
422 memcpy(spl_image->fdt_addr, gd->fdt_blob, size);
Lukas Auer80afee72019-08-21 21:14:42 +0200423 } else {
Sean Anderson7d8d6132023-11-08 11:48:40 -0500424 ret = load_simple_fit(info, offset, ctx, node, &image_info);
Lukas Auer80afee72019-08-21 21:14:42 +0200425 if (ret < 0)
426 return ret;
Sean Anderson5ff77722023-10-14 16:47:55 -0400427
428 spl_image->fdt_addr = phys_to_virt(image_info.load_addr);
Lukas Auer80afee72019-08-21 21:14:42 +0200429 }
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200430
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600431 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
432 return 0;
433
Tom Rinid259d9c2023-01-10 11:19:28 -0500434#if CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200435 void *tmpbuffer = NULL;
436
Michal Simekbf703df2019-10-22 16:39:11 +0200437 for (; ; index++) {
Marek Vasuta0494272023-09-21 20:44:16 +0200438 const char *str;
439
440 ret = spl_fit_get_image_name(ctx, FIT_FDT_PROP, index, &str);
441 if (ret == -E2BIG) {
Michal Simekbf703df2019-10-22 16:39:11 +0200442 debug("%s: No additional FDT node\n", __func__);
Marek Vasuta0494272023-09-21 20:44:16 +0200443 ret = 0;
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200444 break;
Marek Vasuta0494272023-09-21 20:44:16 +0200445 } else if (ret < 0) {
446 continue;
447 }
448
449 ret = board_spl_fit_append_fdt_skip(str);
450 if (ret)
451 continue;
452
453 node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
454 if (node < 0) {
Jean-Jacques Hiblotc6ab6a12019-10-22 16:39:14 +0200455 debug("%s: unable to find FDT node %d\n",
456 __func__, index);
457 continue;
Michal Simekbf703df2019-10-22 16:39:11 +0200458 }
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200459
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200460 if (!tmpbuffer) {
461 /*
462 * allocate memory to store the DT overlay
463 * before it is applied. It may not be used
464 * depending on how the overlay is stored, so
465 * don't fail yet if the allocation failed.
466 */
Stefan Herbrechtsmeier66249102022-06-14 16:12:00 +0200467 size_t size = CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ;
468
469 tmpbuffer = malloc_cache_aligned(size);
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200470 if (!tmpbuffer)
471 debug("%s: unable to allocate space for overlays\n",
472 __func__);
473 }
474 image_info.load_addr = (ulong)tmpbuffer;
Sean Anderson7d8d6132023-11-08 11:48:40 -0500475 ret = load_simple_fit(info, offset, ctx, node,
Simon Glass205ff7b2023-09-26 08:14:33 -0600476 &image_info);
Simon Glassc811ef92025-01-26 11:43:17 -0700477 if (ret == -EPERM)
478 continue;
479 else if (ret < 0)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200480 break;
Michal Simekbf703df2019-10-22 16:39:11 +0200481
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200482 /* Make room in FDT for changes from the overlay */
483 ret = fdt_increase_size(spl_image->fdt_addr,
484 image_info.size);
485 if (ret < 0)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200486 break;
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200487
Michal Simekbf703df2019-10-22 16:39:11 +0200488 ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
489 (void *)image_info.load_addr);
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200490 if (ret) {
491 pr_err("failed to apply DT overlay %s\n",
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600492 fit_get_name(ctx->fit, node, NULL));
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200493 break;
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200494 }
Michal Simekbf703df2019-10-22 16:39:11 +0200495
496 debug("%s: DT overlay %s applied\n", __func__,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600497 fit_get_name(ctx->fit, node, NULL));
Michal Simekbf703df2019-10-22 16:39:11 +0200498 }
Heinrich Schuchardt939a9612020-04-20 12:44:01 +0200499 free(tmpbuffer);
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200500 if (ret)
501 return ret;
Tom Rinid259d9c2023-01-10 11:19:28 -0500502#endif
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200503 /* Try to make space, so we can inject details on the loadables */
504 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
505 if (ret < 0)
506 return ret;
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200507
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200508 return ret;
509}
510
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600511static int spl_fit_record_loadable(const struct spl_fit_info *ctx, int index,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200512 void *blob, struct spl_image_info *image)
513{
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100514 int ret = 0;
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +0200515 const char *name;
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100516 int node;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200517
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600518 ret = spl_fit_get_image_name(ctx, "loadables", index, &name);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200519 if (ret < 0)
520 return ret;
521
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600522 node = spl_fit_get_image_node(ctx, "loadables", index);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200523
524 ret = fdt_record_loadable(blob, index, name, image->load_addr,
Simon Glassdff90432023-09-26 08:14:35 -0600525 image->size, image->entry_point,
526 fdt_getprop(ctx->fit, node, FIT_TYPE_PROP, NULL),
527 fdt_getprop(ctx->fit, node, FIT_OS_PROP, NULL),
528 fdt_getprop(ctx->fit, node, FIT_ARCH_PROP, NULL));
529
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200530 return ret;
531}
532
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500533static int spl_fit_image_is_fpga(const void *fit, int node)
534{
535 const char *type;
536
537 if (!IS_ENABLED(CONFIG_SPL_FPGA))
538 return 0;
539
540 type = fdt_getprop(fit, node, FIT_TYPE_PROP, NULL);
541 if (!type)
542 return 0;
543
544 return !strcmp(type, "fpga");
545}
546
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100547static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
548{
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600549 if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) || CONFIG_IS_ENABLED(OS_BOOT))
550 return fit_image_get_os(fit, noffset, os);
Samuel Hollande646f512020-10-21 21:12:13 -0500551
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600552 const char *name = fdt_getprop(fit, noffset, FIT_OS_PROP, NULL);
Samuel Hollande646f512020-10-21 21:12:13 -0500553 if (!name)
554 return -ENOENT;
555
556 /*
557 * We don't care what the type of the image actually is,
558 * only whether or not it is U-Boot. This saves some
559 * space by omitting the large table of OS types.
560 */
561 if (!strcmp(name, "u-boot"))
562 *os = IH_OS_U_BOOT;
563 else
564 *os = IH_OS_INVALID;
565
566 return 0;
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100567}
568
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500569/*
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500570 * The purpose of the FIT load buffer is to provide a memory location that is
571 * independent of the load address of any FIT component.
572 */
573static void *spl_get_fit_load_buffer(size_t size)
574{
575 void *buf;
576
Stefan Herbrechtsmeier66249102022-06-14 16:12:00 +0200577 buf = malloc_cache_aligned(size);
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500578 if (!buf) {
579 pr_err("Could not get FIT buffer of %lu bytes\n", (ulong)size);
Leo Yu-Chi Liangecb7eaa2024-03-13 14:53:15 +0800580
581 if (IS_ENABLED(CONFIG_SPL_SYS_MALLOC))
582 pr_err("\tcheck CONFIG_SPL_SYS_MALLOC_SIZE\n");
583 else
584 pr_err("\tcheck CONFIG_SPL_SYS_MALLOC_F_LEN\n");
585
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500586 buf = spl_get_load_buffer(0, size);
587 }
588 return buf;
589}
590
Heiko Schocher7d7c3672021-08-17 08:17:18 +0200591__weak void *board_spl_fit_buffer_addr(ulong fit_size, int sectors, int bl_len)
592{
593 return spl_get_fit_load_buffer(sectors * bl_len);
594}
595
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500596/*
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500597 * Weak default function to allow customizing SPL fit loading for load-only
598 * use cases by allowing to skip the parsing/processing of the FIT contents
599 * (so that this can be done separately in a more customized fashion)
600 */
601__weak bool spl_load_simple_fit_skip_processing(void)
602{
603 return false;
604}
605
Heiko Schocher67e8f5d2021-08-06 06:44:26 +0200606/*
607 * Weak default function to allow fixes after fit header
608 * is loaded.
609 */
610__weak void *spl_load_simple_fit_fix_load(const void *fit)
611{
612 return (void *)fit;
613}
614
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500615static void warn_deprecated(const char *msg)
616{
617 printf("DEPRECATED: %s\n", msg);
Heinrich Schuchardt01e836c2024-06-18 08:32:30 +0200618 printf("\tSee https://fitspec.osfw.foundation/\n");
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500619}
620
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500621static int spl_fit_upload_fpga(struct spl_fit_info *ctx, int node,
622 struct spl_image_info *fpga_image)
623{
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500624 const char *compatible;
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500625 int ret;
Oleksandr Suvorov4ff163d2022-07-22 17:16:07 +0300626 int devnum = 0;
627 int flags = 0;
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500628
629 debug("FPGA bitstream at: %x, size: %x\n",
630 (u32)fpga_image->load_addr, fpga_image->size);
631
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500632 compatible = fdt_getprop(ctx->fit, node, "compatible", NULL);
Oleksandr Suvorov2fddf3e2022-07-22 17:16:09 +0300633 if (!compatible) {
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500634 warn_deprecated("'fpga' image without 'compatible' property");
Oleksandr Suvorov2fddf3e2022-07-22 17:16:09 +0300635 } else {
636 if (CONFIG_IS_ENABLED(FPGA_LOAD_SECURE))
637 flags = fpga_compatible2flag(devnum, compatible);
638 if (strcmp(compatible, "u-boot,fpga-legacy"))
639 debug("Ignoring compatible = %s property\n",
640 compatible);
641 }
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500642
Oleksandr Suvorov4ff163d2022-07-22 17:16:07 +0300643 ret = fpga_load(devnum, (void *)fpga_image->load_addr,
644 fpga_image->size, BIT_FULL, flags);
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500645 if (ret) {
646 printf("%s: Cannot load the image to the FPGA\n", __func__);
647 return ret;
648 }
649
650 puts("FPGA image loaded from FIT\n");
651
652 return 0;
653}
654
655static int spl_fit_load_fpga(struct spl_fit_info *ctx,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500656 struct spl_load_info *info, ulong offset)
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500657{
658 int node, ret;
659
660 struct spl_image_info fpga_image = {
661 .load_addr = 0,
662 };
663
664 node = spl_fit_get_image_node(ctx, "fpga", 0);
665 if (node < 0)
666 return node;
667
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500668 warn_deprecated("'fpga' property in config node. Use 'loadables'");
669
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500670 /* Load the image and set up the fpga_image structure */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500671 ret = load_simple_fit(info, offset, ctx, node, &fpga_image);
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500672 if (ret) {
673 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
674 return ret;
675 }
676
677 return spl_fit_upload_fpga(ctx, node, &fpga_image);
678}
679
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600680static int spl_simple_fit_read(struct spl_fit_info *ctx,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500681 struct spl_load_info *info, ulong offset,
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600682 const void *fit_header)
Simon Glassa6131a22016-02-22 22:55:56 -0700683{
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600684 unsigned long count, size;
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600685 void *buf;
Simon Glassa6131a22016-02-22 22:55:56 -0700686
687 /*
York Suna058b8a2017-08-15 11:14:45 -0700688 * For FIT with external data, figure out where the external images
689 * start. This is the base for the data-offset properties in each
690 * image.
Simon Glassa6131a22016-02-22 22:55:56 -0700691 */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600692 size = ALIGN(fdt_totalsize(fit_header), 4);
Ye Li9d5b0f42018-11-17 09:10:25 +0000693 size = board_spl_fit_size_align(size);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600694 ctx->ext_data_offset = ALIGN(size, 4);
Simon Glassa6131a22016-02-22 22:55:56 -0700695
696 /*
697 * So far we only have one block of data from the FIT. Read the entire
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500698 * thing, including that first block.
York Suna058b8a2017-08-15 11:14:45 -0700699 *
700 * For FIT with data embedded, data is loaded as part of FIT image.
701 * For FIT with external data, data is not loaded in this step.
Simon Glassa6131a22016-02-22 22:55:56 -0700702 */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500703 size = get_aligned_image_size(info, size, 0);
704 buf = board_spl_fit_buffer_addr(size, size, 1);
Ye Li9d5b0f42018-11-17 09:10:25 +0000705
Sean Anderson7d8d6132023-11-08 11:48:40 -0500706 count = info->read(info, offset, size, buf);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600707 ctx->fit = buf;
Sean Anderson7d8d6132023-11-08 11:48:40 -0500708 debug("fit read offset %lx, size=%lu, dst=%p, count=%lu\n",
709 offset, size, buf, count);
Simon Glassa6131a22016-02-22 22:55:56 -0700710
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600711 return (count == 0) ? -EIO : 0;
712}
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500713
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600714static int spl_simple_fit_parse(struct spl_fit_info *ctx)
715{
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600716 /* Find the correct subnode under "/configurations" */
717 ctx->conf_node = fit_find_config_node(ctx->fit);
718 if (ctx->conf_node < 0)
719 return -EINVAL;
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100720
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600721 if (IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) {
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100722 printf("## Checking hash(es) for config %s ... ",
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600723 fit_get_name(ctx->fit, ctx->conf_node, NULL));
724 if (fit_config_verify(ctx->fit, ctx->conf_node))
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100725 return -EPERM;
726 puts("OK\n");
727 }
728
Andre Przywara525e9c92017-04-26 01:32:34 +0100729 /* find the node holding the images information */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600730 ctx->images_node = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
731 if (ctx->images_node < 0) {
732 debug("%s: Cannot find /images node: %d\n", __func__,
733 ctx->images_node);
734 return -EINVAL;
Simon Glassa6131a22016-02-22 22:55:56 -0700735 }
Marek Vasut33dd00e2018-05-12 22:25:28 +0200736
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600737 return 0;
738}
739
740int spl_load_simple_fit(struct spl_image_info *spl_image,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500741 struct spl_load_info *info, ulong offset, void *fit)
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600742{
743 struct spl_image_info image_info;
744 struct spl_fit_info ctx;
745 int node = -1;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600746 int ret;
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600747 int index = 0;
748 int firmware_node;
749
Sean Anderson7d8d6132023-11-08 11:48:40 -0500750 ret = spl_simple_fit_read(&ctx, info, offset, fit);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600751 if (ret < 0)
752 return ret;
753
754 /* skip further processing if requested to enable load-only use cases */
755 if (spl_load_simple_fit_skip_processing())
756 return 0;
757
Heiko Schocher67e8f5d2021-08-06 06:44:26 +0200758 ctx.fit = spl_load_simple_fit_fix_load(ctx.fit);
759
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600760 ret = spl_simple_fit_parse(&ctx);
761 if (ret < 0)
762 return ret;
763
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500764 if (IS_ENABLED(CONFIG_SPL_FPGA))
Sean Anderson7d8d6132023-11-08 11:48:40 -0500765 spl_fit_load_fpga(&ctx, info, offset);
Andre Przywara525e9c92017-04-26 01:32:34 +0100766
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200767 /*
768 * Find the U-Boot image using the following search order:
769 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
770 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
771 * - fall back to using the first 'loadables' entry
772 */
773 if (node < 0)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600774 node = spl_fit_get_image_node(&ctx, FIT_FIRMWARE_PROP, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600775
776 if (node < 0 && IS_ENABLED(CONFIG_SPL_OS_BOOT))
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600777 node = spl_fit_get_image_node(&ctx, FIT_KERNEL_PROP, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600778
Andre Przywara525e9c92017-04-26 01:32:34 +0100779 if (node < 0) {
780 debug("could not find firmware image, trying loadables...\n");
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600781 node = spl_fit_get_image_node(&ctx, "loadables", 0);
Andre Przywarae7c58562017-04-26 01:32:37 +0100782 /*
783 * If we pick the U-Boot image from "loadables", start at
784 * the second image when later loading additional images.
785 */
786 index = 1;
Andre Przywara525e9c92017-04-26 01:32:34 +0100787 }
Simon Glassa6131a22016-02-22 22:55:56 -0700788 if (node < 0) {
Andre Przywara525e9c92017-04-26 01:32:34 +0100789 debug("%s: Cannot find u-boot image node: %d\n",
790 __func__, node);
Simon Glassa6131a22016-02-22 22:55:56 -0700791 return -1;
792 }
793
Andre Przywara29053e92017-04-26 01:32:36 +0100794 /* Load the image and set up the spl_image structure */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500795 ret = load_simple_fit(info, offset, &ctx, node, spl_image);
Andre Przywara29053e92017-04-26 01:32:36 +0100796 if (ret)
797 return ret;
Daniel Allredcf839bd2016-06-27 09:19:21 -0500798
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200799 /*
800 * For backward compatibility, we treat the first node that is
801 * as a U-Boot image, if no OS-type has been declared.
802 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600803 if (!spl_fit_image_get_os(ctx.fit, node, &spl_image->os))
York Suna058b8a2017-08-15 11:14:45 -0700804 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600805 else if (!IS_ENABLED(CONFIG_SPL_OS_BOOT))
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200806 spl_image->os = IH_OS_U_BOOT;
Simon Glassa6131a22016-02-22 22:55:56 -0700807
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200808 /*
809 * Booting a next-stage U-Boot may require us to append the FDT.
810 * We allow this to fail, as the U-Boot image might embed its FDT.
811 */
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600812 if (os_takes_devicetree(spl_image->os)) {
Sean Anderson7d8d6132023-11-08 11:48:40 -0500813 ret = spl_fit_append_fdt(spl_image, info, offset, &ctx);
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600814 if (ret < 0 && spl_image->os != IH_OS_U_BOOT)
Dario Binacchifaf8d142020-05-27 13:56:19 +0200815 return ret;
816 }
Andre Przywarae7c58562017-04-26 01:32:37 +0100817
Jean-Jacques Hiblot776ce602019-10-22 16:39:10 +0200818 firmware_node = node;
Andre Przywarae7c58562017-04-26 01:32:37 +0100819 /* Now check if there are more images for us to load */
820 for (; ; index++) {
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200821 uint8_t os_type = IH_OS_INVALID;
822
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600823 node = spl_fit_get_image_node(&ctx, "loadables", index);
Andre Przywarae7c58562017-04-26 01:32:37 +0100824 if (node < 0)
825 break;
826
Jean-Jacques Hiblot776ce602019-10-22 16:39:10 +0200827 /*
828 * if the firmware is also a loadable, skip it because
829 * it already has been loaded. This is typically the case with
830 * u-boot.img generated by mkimage.
831 */
832 if (firmware_node == node)
833 continue;
834
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500835 image_info.load_addr = 0;
Sean Anderson7d8d6132023-11-08 11:48:40 -0500836 ret = load_simple_fit(info, offset, &ctx, node, &image_info);
Simon Glassc811ef92025-01-26 11:43:17 -0700837 if (ret < 0 && ret != -EPERM) {
Philippe Reynesba87da42020-11-24 16:15:05 +0100838 printf("%s: can't load image loadables index %d (ret = %d)\n",
839 __func__, index, ret);
840 return ret;
841 }
Andre Przywarae7c58562017-04-26 01:32:37 +0100842
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500843 if (spl_fit_image_is_fpga(ctx.fit, node))
844 spl_fit_upload_fpga(&ctx, node, &image_info);
845
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600846 if (!spl_fit_image_get_os(ctx.fit, node, &os_type))
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200847 debug("Loadable is %s\n", genimg_get_os_name(os_type));
848
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600849 if (os_takes_devicetree(os_type)) {
Sean Anderson7d8d6132023-11-08 11:48:40 -0500850 spl_fit_append_fdt(&image_info, info, offset, &ctx);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200851 spl_image->fdt_addr = image_info.fdt_addr;
852 }
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200853
Andre Przywarae7c58562017-04-26 01:32:37 +0100854 /*
855 * If the "firmware" image did not provide an entry point,
856 * use the first valid entry point from the loadables.
857 */
858 if (spl_image->entry_point == FDT_ERROR &&
859 image_info.entry_point != FDT_ERROR)
860 spl_image->entry_point = image_info.entry_point;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200861
862 /* Record our loadables into the FDT */
Simon Glassd4315522025-01-26 11:43:28 -0700863 if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) &&
864 xpl_get_fdt_update(info) && spl_image->fdt_addr)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600865 spl_fit_record_loadable(&ctx, index,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200866 spl_image->fdt_addr,
867 &image_info);
Andre Przywarae7c58562017-04-26 01:32:37 +0100868 }
869
870 /*
Jesse Taube93ee5c82023-08-24 21:59:48 -0400871 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
Andre Przywarae7c58562017-04-26 01:32:37 +0100872 * Makefile will set it to 0 and it will end up as the entry point
873 * here. What it actually means is: use the load address.
874 */
875 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
876 spl_image->entry_point = spl_image->load_addr;
877
Ye Li9d5b0f42018-11-17 09:10:25 +0000878 spl_image->flags |= SPL_FIT_FOUND;
Simon Glass9b5bfba2024-08-07 16:47:33 -0600879 upl_set_fit_info(map_to_sysmem(ctx.fit), ctx.conf_node,
880 spl_image->entry_point);
Ye Li9d5b0f42018-11-17 09:10:25 +0000881
Andre Przywarae7c58562017-04-26 01:32:37 +0100882 return 0;
Simon Glassa6131a22016-02-22 22:55:56 -0700883}
Simon Glassc0bd55e2023-09-26 08:14:34 -0600884
885/* Parse and load full fitImage in SPL */
886int spl_load_fit_image(struct spl_image_info *spl_image,
887 const struct legacy_img_hdr *header)
888{
889 struct bootm_headers images;
890 const char *fit_uname_config = NULL;
Simon Glass9a9097f2024-12-19 11:29:00 -0700891 ulong fdt_hack;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600892 const char *uname;
893 ulong fw_data = 0, dt_data = 0, img_data = 0;
894 ulong fw_len = 0, dt_len = 0, img_len = 0;
895 int idx, conf_noffset;
896 int ret;
897
898#ifdef CONFIG_SPL_FIT_SIGNATURE
899 images.verify = 1;
900#endif
Sean Anderson5ff77722023-10-14 16:47:55 -0400901 ret = fit_image_load(&images, virt_to_phys((void *)header),
Simon Glassc0bd55e2023-09-26 08:14:34 -0600902 NULL, &fit_uname_config,
903 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
904 FIT_LOAD_OPTIONAL, &fw_data, &fw_len);
905 if (ret >= 0) {
906 printf("DEPRECATED: 'standalone = ' property.");
907 printf("Please use either 'firmware =' or 'kernel ='\n");
908 } else {
Sean Anderson5ff77722023-10-14 16:47:55 -0400909 ret = fit_image_load(&images, virt_to_phys((void *)header),
910 NULL, &fit_uname_config, IH_ARCH_DEFAULT,
Simon Glassc0bd55e2023-09-26 08:14:34 -0600911 IH_TYPE_FIRMWARE, -1, FIT_LOAD_OPTIONAL,
912 &fw_data, &fw_len);
913 }
914
915 if (ret < 0) {
Sean Anderson5ff77722023-10-14 16:47:55 -0400916 ret = fit_image_load(&images, virt_to_phys((void *)header),
917 NULL, &fit_uname_config, IH_ARCH_DEFAULT,
Simon Glassc0bd55e2023-09-26 08:14:34 -0600918 IH_TYPE_KERNEL, -1, FIT_LOAD_OPTIONAL,
919 &fw_data, &fw_len);
920 }
921
922 if (ret < 0)
923 return ret;
924
925 spl_image->size = fw_len;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600926 spl_image->load_addr = fw_data;
Sean Andersone99b2cd2023-10-14 16:47:39 -0400927 if (fit_image_get_entry(header, ret, &spl_image->entry_point))
928 spl_image->entry_point = fw_data;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600929 if (fit_image_get_os(header, ret, &spl_image->os))
930 spl_image->os = IH_OS_INVALID;
931 spl_image->name = genimg_get_os_name(spl_image->os);
932
Simon Glass8bc93262024-09-29 19:49:55 -0600933 debug(PHASE_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
Simon Glassc0bd55e2023-09-26 08:14:34 -0600934 spl_image->name, spl_image->load_addr, spl_image->size);
935
936#ifdef CONFIG_SPL_FIT_SIGNATURE
937 images.verify = 1;
938#endif
Sean Anderson5ff77722023-10-14 16:47:55 -0400939 ret = fit_image_load(&images, virt_to_phys((void *)header), NULL,
940 &fit_uname_config, IH_ARCH_DEFAULT, IH_TYPE_FLATDT,
941 -1, FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
Simon Glassc0bd55e2023-09-26 08:14:34 -0600942 if (ret >= 0) {
943 spl_image->fdt_addr = (void *)dt_data;
944
945 if (spl_image->os == IH_OS_U_BOOT) {
946 /* HACK: U-Boot expects FDT at a specific address */
947 fdt_hack = spl_image->load_addr + spl_image->size;
948 fdt_hack = (fdt_hack + 3) & ~3;
949 debug("Relocating FDT to %p\n", spl_image->fdt_addr);
950 memcpy((void *)fdt_hack, spl_image->fdt_addr, dt_len);
951 }
952 }
953
954 conf_noffset = fit_conf_get_node((const void *)header,
955 fit_uname_config);
956 if (conf_noffset < 0)
957 return 0;
958
959 for (idx = 0;
960 uname = fdt_stringlist_get((const void *)header, conf_noffset,
961 FIT_LOADABLE_PROP, idx,
962 NULL), uname;
963 idx++) {
964#ifdef CONFIG_SPL_FIT_SIGNATURE
965 images.verify = 1;
966#endif
967 ret = fit_image_load(&images, (ulong)header,
968 &uname, &fit_uname_config,
969 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
970 FIT_LOAD_OPTIONAL_NON_ZERO,
971 &img_data, &img_len);
972 if (ret < 0)
973 return ret;
974 }
Simon Glass32668282024-08-07 16:47:32 -0600975 spl_image->flags |= SPL_FIT_FOUND;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600976
Simon Glass9b5bfba2024-08-07 16:47:33 -0600977 upl_set_fit_info(map_to_sysmem(header), conf_noffset,
978 spl_image->entry_point);
979
Simon Glassc0bd55e2023-09-26 08:14:34 -0600980 return 0;
981}