blob: ac8462577ffc594312e823d938eafa5bf9e790c3 [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 *
202 * Return: 0 on success or a negative error number.
203 */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500204static int load_simple_fit(struct spl_load_info *info, ulong fit_offset,
Simon Glass205ff7b2023-09-26 08:14:33 -0600205 const struct spl_fit_info *ctx, int node,
206 struct spl_image_info *image_info)
Andre Przywara29053e92017-04-26 01:32:36 +0100207{
Michal Simekf707b5a2018-07-18 14:33:15 +0200208 int offset;
Andre Przywara29053e92017-04-26 01:32:36 +0100209 size_t length;
York Sunadf99fa2017-08-15 11:14:44 -0700210 int len;
York Sun25d65f12017-09-15 08:21:13 -0700211 ulong size;
Simon Glass2192e982021-03-07 17:35:14 -0700212 ulong load_addr;
213 void *load_ptr;
Andre Przywara29053e92017-04-26 01:32:36 +0100214 void *src;
215 ulong overhead;
York Suna6945fe2017-08-15 11:14:43 -0700216 uint8_t image_comp = -1, type = -1;
York Sunadf99fa2017-08-15 11:14:44 -0700217 const void *data;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600218 const void *fit = ctx->fit;
Peng Fan8876c7e2017-12-05 13:20:59 +0800219 bool external_data = false;
York Suna6945fe2017-08-15 11:14:43 -0700220
Michal Simek1aab1142020-09-09 14:41:56 +0200221 if (IS_ENABLED(CONFIG_SPL_FPGA) ||
Manoj Sai2b2e6282023-09-18 00:56:25 +0530222 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && spl_decompression_enabled())) {
Marek Vasut72bc5d52018-06-01 23:19:29 +0200223 if (fit_image_get_type(fit, node, &type))
224 puts("Cannot get image type.\n");
225 else
226 debug("%s ", genimg_get_type_name(type));
227 }
228
Manoj Sai2b2e6282023-09-18 00:56:25 +0530229 if (spl_decompression_enabled()) {
Klaus H. Sorensen4a9a0422019-12-11 11:03:33 +0000230 fit_image_get_comp(fit, node, &image_comp);
231 debug("%s ", genimg_get_comp_name(image_comp));
York Suna6945fe2017-08-15 11:14:43 -0700232 }
Andre Przywara29053e92017-04-26 01:32:36 +0100233
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500234 if (fit_image_get_load(fit, node, &load_addr)) {
235 if (!image_info->load_addr) {
236 printf("Can't load %s: No load address and no buffer\n",
237 fit_get_name(fit, node, NULL));
238 return -ENOBUFS;
239 }
Andre Przywara29053e92017-04-26 01:32:36 +0100240 load_addr = image_info->load_addr;
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500241 }
Andre Przywara29053e92017-04-26 01:32:36 +0100242
Peng Fan8876c7e2017-12-05 13:20:59 +0800243 if (!fit_image_get_data_position(fit, node, &offset)) {
244 external_data = true;
245 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
Simon Glass97c434b2024-12-19 11:29:02 -0700246 log_debug("read offset %x = offset from fit %lx\n",
247 offset, (ulong)offset + ctx->ext_data_offset);
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600248 offset += ctx->ext_data_offset;
Peng Fan8876c7e2017-12-05 13:20:59 +0800249 external_data = true;
250 }
251
252 if (external_data) {
Simon Glass97c434b2024-12-19 11:29:02 -0700253 ulong read_offset;
Simon Glass2192e982021-03-07 17:35:14 -0700254 void *src_ptr;
255
Peng Fan8876c7e2017-12-05 13:20:59 +0800256 /* External data */
York Sunadf99fa2017-08-15 11:14:44 -0700257 if (fit_image_get_data_size(fit, node, &len))
258 return -ENOENT;
Andre Przywara29053e92017-04-26 01:32:36 +0100259
Nishanth Menone4cb6452021-10-19 12:32:29 -0500260 /* Dont bother to copy 0 byte data, but warn, though */
261 if (!len) {
262 log_warning("%s: Skip load '%s': image size is 0!\n",
263 __func__, fit_get_name(fit, node, NULL));
264 return 0;
265 }
266
Manoj Saia8560992023-09-18 00:56:26 +0530267 if (spl_decompression_enabled() &&
268 (image_comp == IH_COMP_GZIP || image_comp == IH_COMP_LZMA))
Manoj Sai2b2e6282023-09-18 00:56:25 +0530269 src_ptr = map_sysmem(ALIGN(CONFIG_SYS_LOAD_ADDR, ARCH_DMA_MINALIGN), len);
270 else
271 src_ptr = map_sysmem(ALIGN(load_addr, ARCH_DMA_MINALIGN), len);
York Sunadf99fa2017-08-15 11:14:44 -0700272 length = len;
273
274 overhead = get_aligned_image_overhead(info, offset);
Sean Anderson7d8d6132023-11-08 11:48:40 -0500275 size = get_aligned_image_size(info, length, offset);
Simon Glass97c434b2024-12-19 11:29:02 -0700276 read_offset = fit_offset + get_aligned_image_offset(info,
277 offset);
278 log_debug("reading from offset %x / %lx size %lx to %p: ",
279 offset, read_offset, size, src_ptr);
York Sunadf99fa2017-08-15 11:14:44 -0700280
Michal Simekf707b5a2018-07-18 14:33:15 +0200281 if (info->read(info,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500282 fit_offset +
283 get_aligned_image_offset(info, offset), size,
Sean Andersonb27c5f82023-11-08 11:48:41 -0500284 src_ptr) < length)
York Sunadf99fa2017-08-15 11:14:44 -0700285 return -EIO;
286
Simon Glass2192e982021-03-07 17:35:14 -0700287 debug("External data: dst=%p, offset=%x, size=%lx\n",
288 src_ptr, offset, (unsigned long)length);
289 src = src_ptr + overhead;
York Sunadf99fa2017-08-15 11:14:44 -0700290 } else {
291 /* Embedded data */
292 if (fit_image_get_data(fit, node, &data, &length)) {
293 puts("Cannot get image data/size\n");
294 return -ENOENT;
295 }
296 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
297 (unsigned long)length);
Simon Glass2192e982021-03-07 17:35:14 -0700298 src = (void *)data; /* cast away const */
York Sunadf99fa2017-08-15 11:14:44 -0700299 }
Andre Przywara29053e92017-04-26 01:32:36 +0100300
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600301 if (CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
302 printf("## Checking hash(es) for Image %s ... ",
303 fit_get_name(fit, node, NULL));
Simon Glasse10e2ee2021-11-12 12:28:10 -0700304 if (!fit_image_verify_with_data(fit, node, gd_fdt_blob(), src,
305 length))
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600306 return -EPERM;
307 puts("OK\n");
308 }
Ben Whitten54a91192018-06-07 11:37:27 +0100309
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600310 if (CONFIG_IS_ENABLED(FIT_IMAGE_POST_PROCESS))
Lokesh Vutlab36dd3e2021-06-11 11:45:05 +0300311 board_fit_image_post_process(fit, node, &src, &length);
Andre Przywara29053e92017-04-26 01:32:36 +0100312
Simon Glass2192e982021-03-07 17:35:14 -0700313 load_ptr = map_sysmem(load_addr, length);
Michal Simekf354c3f2018-07-24 15:05:00 +0200314 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
York Sun25d65f12017-09-15 08:21:13 -0700315 size = length;
Simon Glass2192e982021-03-07 17:35:14 -0700316 if (gunzip(load_ptr, CONFIG_SYS_BOOTM_LEN, src, &size)) {
York Suna6945fe2017-08-15 11:14:43 -0700317 puts("Uncompressing error\n");
318 return -EIO;
319 }
York Sun25d65f12017-09-15 08:21:13 -0700320 length = size;
Manoj Saia8560992023-09-18 00:56:26 +0530321 } else if (IS_ENABLED(CONFIG_SPL_LZMA) && image_comp == IH_COMP_LZMA) {
322 size = CONFIG_SYS_BOOTM_LEN;
323 ulong loadEnd;
324
325 if (image_decomp(IH_COMP_LZMA, CONFIG_SYS_LOAD_ADDR, 0, 0,
326 load_ptr, src, length, size, &loadEnd)) {
327 puts("Uncompressing error\n");
328 return -EIO;
329 }
330 length = loadEnd - CONFIG_SYS_LOAD_ADDR;
York Suna6945fe2017-08-15 11:14:43 -0700331 } else {
Simon Glass2192e982021-03-07 17:35:14 -0700332 memcpy(load_ptr, src, length);
York Suna6945fe2017-08-15 11:14:43 -0700333 }
Andre Przywara29053e92017-04-26 01:32:36 +0100334
335 if (image_info) {
Michal Simek9e64a552020-09-03 11:24:28 +0200336 ulong entry_point;
337
Andre Przywara29053e92017-04-26 01:32:36 +0100338 image_info->load_addr = load_addr;
339 image_info->size = length;
Michal Simek9e64a552020-09-03 11:24:28 +0200340
341 if (!fit_image_get_entry(fit, node, &entry_point))
342 image_info->entry_point = entry_point;
343 else
344 image_info->entry_point = FDT_ERROR;
Andre Przywara29053e92017-04-26 01:32:36 +0100345 }
Simon Glass97c434b2024-12-19 11:29:02 -0700346 log_debug("- done loading\n");
Andre Przywara29053e92017-04-26 01:32:36 +0100347
Simon Glass9b5bfba2024-08-07 16:47:33 -0600348 upl_add_image(fit, node, load_addr, length);
349
Andre Przywara29053e92017-04-26 01:32:36 +0100350 return 0;
351}
352
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600353static bool os_takes_devicetree(uint8_t os)
354{
355 switch (os) {
356 case IH_OS_U_BOOT:
357 return true;
358 case IH_OS_LINUX:
Randolph263e2ae2023-10-12 14:35:07 +0800359 return IS_ENABLED(CONFIG_SPL_OS_BOOT) ||
360 IS_ENABLED(CONFIG_SPL_OPENSBI);
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600361 default:
362 return false;
363 }
364}
365
Marek Vasuta0494272023-09-21 20:44:16 +0200366__weak int board_spl_fit_append_fdt_skip(const char *name)
367{
368 return 0; /* Do not skip */
369}
370
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200371static int spl_fit_append_fdt(struct spl_image_info *spl_image,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500372 struct spl_load_info *info, ulong offset,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600373 const struct spl_fit_info *ctx)
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200374{
375 struct spl_image_info image_info;
Michal Simekbf703df2019-10-22 16:39:11 +0200376 int node, ret = 0, index = 0;
Lukas Auer80afee72019-08-21 21:14:42 +0200377
378 /*
379 * Use the address following the image as target address for the
Marek Vasutc27cbe82020-10-19 23:40:26 +0200380 * device tree.
Lukas Auer80afee72019-08-21 21:14:42 +0200381 */
Marek Vasutc27cbe82020-10-19 23:40:26 +0200382 image_info.load_addr = spl_image->load_addr + spl_image->size;
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200383
384 /* Figure out which device tree the board wants to use */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600385 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index++);
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200386 if (node < 0) {
Sean Anderson5ff77722023-10-14 16:47:55 -0400387 size_t size;
388
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200389 debug("%s: cannot find FDT node\n", __func__);
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200390
Lukas Auer80afee72019-08-21 21:14:42 +0200391 /*
392 * U-Boot did not find a device tree inside the FIT image. Use
393 * the U-Boot device tree instead.
394 */
Sean Anderson5ff77722023-10-14 16:47:55 -0400395 if (!gd->fdt_blob)
Lukas Auer80afee72019-08-21 21:14:42 +0200396 return node;
Sean Anderson5ff77722023-10-14 16:47:55 -0400397
398 /*
399 * Make the load-address of the FDT available for the SPL
400 * framework
401 */
402 size = fdt_totalsize(gd->fdt_blob);
403 spl_image->fdt_addr = map_sysmem(image_info.load_addr, size);
404 memcpy(spl_image->fdt_addr, gd->fdt_blob, size);
Lukas Auer80afee72019-08-21 21:14:42 +0200405 } else {
Sean Anderson7d8d6132023-11-08 11:48:40 -0500406 ret = load_simple_fit(info, offset, ctx, node, &image_info);
Lukas Auer80afee72019-08-21 21:14:42 +0200407 if (ret < 0)
408 return ret;
Sean Anderson5ff77722023-10-14 16:47:55 -0400409
410 spl_image->fdt_addr = phys_to_virt(image_info.load_addr);
Lukas Auer80afee72019-08-21 21:14:42 +0200411 }
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200412
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600413 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
414 return 0;
415
Tom Rinid259d9c2023-01-10 11:19:28 -0500416#if CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200417 void *tmpbuffer = NULL;
418
Michal Simekbf703df2019-10-22 16:39:11 +0200419 for (; ; index++) {
Marek Vasuta0494272023-09-21 20:44:16 +0200420 const char *str;
421
422 ret = spl_fit_get_image_name(ctx, FIT_FDT_PROP, index, &str);
423 if (ret == -E2BIG) {
Michal Simekbf703df2019-10-22 16:39:11 +0200424 debug("%s: No additional FDT node\n", __func__);
Marek Vasuta0494272023-09-21 20:44:16 +0200425 ret = 0;
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200426 break;
Marek Vasuta0494272023-09-21 20:44:16 +0200427 } else if (ret < 0) {
428 continue;
429 }
430
431 ret = board_spl_fit_append_fdt_skip(str);
432 if (ret)
433 continue;
434
435 node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
436 if (node < 0) {
Jean-Jacques Hiblotc6ab6a12019-10-22 16:39:14 +0200437 debug("%s: unable to find FDT node %d\n",
438 __func__, index);
439 continue;
Michal Simekbf703df2019-10-22 16:39:11 +0200440 }
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200441
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200442 if (!tmpbuffer) {
443 /*
444 * allocate memory to store the DT overlay
445 * before it is applied. It may not be used
446 * depending on how the overlay is stored, so
447 * don't fail yet if the allocation failed.
448 */
Stefan Herbrechtsmeier66249102022-06-14 16:12:00 +0200449 size_t size = CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ;
450
451 tmpbuffer = malloc_cache_aligned(size);
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200452 if (!tmpbuffer)
453 debug("%s: unable to allocate space for overlays\n",
454 __func__);
455 }
456 image_info.load_addr = (ulong)tmpbuffer;
Sean Anderson7d8d6132023-11-08 11:48:40 -0500457 ret = load_simple_fit(info, offset, ctx, node,
Simon Glass205ff7b2023-09-26 08:14:33 -0600458 &image_info);
Michal Simekbf703df2019-10-22 16:39:11 +0200459 if (ret < 0)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200460 break;
Michal Simekbf703df2019-10-22 16:39:11 +0200461
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200462 /* Make room in FDT for changes from the overlay */
463 ret = fdt_increase_size(spl_image->fdt_addr,
464 image_info.size);
465 if (ret < 0)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200466 break;
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200467
Michal Simekbf703df2019-10-22 16:39:11 +0200468 ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
469 (void *)image_info.load_addr);
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200470 if (ret) {
471 pr_err("failed to apply DT overlay %s\n",
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600472 fit_get_name(ctx->fit, node, NULL));
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200473 break;
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200474 }
Michal Simekbf703df2019-10-22 16:39:11 +0200475
476 debug("%s: DT overlay %s applied\n", __func__,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600477 fit_get_name(ctx->fit, node, NULL));
Michal Simekbf703df2019-10-22 16:39:11 +0200478 }
Heinrich Schuchardt939a9612020-04-20 12:44:01 +0200479 free(tmpbuffer);
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200480 if (ret)
481 return ret;
Tom Rinid259d9c2023-01-10 11:19:28 -0500482#endif
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200483 /* Try to make space, so we can inject details on the loadables */
484 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
485 if (ret < 0)
486 return ret;
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200487
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200488 return ret;
489}
490
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600491static int spl_fit_record_loadable(const struct spl_fit_info *ctx, int index,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200492 void *blob, struct spl_image_info *image)
493{
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100494 int ret = 0;
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +0200495 const char *name;
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100496 int node;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200497
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600498 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
499 return 0;
500
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600501 ret = spl_fit_get_image_name(ctx, "loadables", index, &name);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200502 if (ret < 0)
503 return ret;
504
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600505 node = spl_fit_get_image_node(ctx, "loadables", index);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200506
507 ret = fdt_record_loadable(blob, index, name, image->load_addr,
Simon Glassdff90432023-09-26 08:14:35 -0600508 image->size, image->entry_point,
509 fdt_getprop(ctx->fit, node, FIT_TYPE_PROP, NULL),
510 fdt_getprop(ctx->fit, node, FIT_OS_PROP, NULL),
511 fdt_getprop(ctx->fit, node, FIT_ARCH_PROP, NULL));
512
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200513 return ret;
514}
515
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500516static int spl_fit_image_is_fpga(const void *fit, int node)
517{
518 const char *type;
519
520 if (!IS_ENABLED(CONFIG_SPL_FPGA))
521 return 0;
522
523 type = fdt_getprop(fit, node, FIT_TYPE_PROP, NULL);
524 if (!type)
525 return 0;
526
527 return !strcmp(type, "fpga");
528}
529
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100530static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
531{
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600532 if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) || CONFIG_IS_ENABLED(OS_BOOT))
533 return fit_image_get_os(fit, noffset, os);
Samuel Hollande646f512020-10-21 21:12:13 -0500534
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600535 const char *name = fdt_getprop(fit, noffset, FIT_OS_PROP, NULL);
Samuel Hollande646f512020-10-21 21:12:13 -0500536 if (!name)
537 return -ENOENT;
538
539 /*
540 * We don't care what the type of the image actually is,
541 * only whether or not it is U-Boot. This saves some
542 * space by omitting the large table of OS types.
543 */
544 if (!strcmp(name, "u-boot"))
545 *os = IH_OS_U_BOOT;
546 else
547 *os = IH_OS_INVALID;
548
549 return 0;
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100550}
551
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500552/*
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500553 * The purpose of the FIT load buffer is to provide a memory location that is
554 * independent of the load address of any FIT component.
555 */
556static void *spl_get_fit_load_buffer(size_t size)
557{
558 void *buf;
559
Stefan Herbrechtsmeier66249102022-06-14 16:12:00 +0200560 buf = malloc_cache_aligned(size);
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500561 if (!buf) {
562 pr_err("Could not get FIT buffer of %lu bytes\n", (ulong)size);
Leo Yu-Chi Liangecb7eaa2024-03-13 14:53:15 +0800563
564 if (IS_ENABLED(CONFIG_SPL_SYS_MALLOC))
565 pr_err("\tcheck CONFIG_SPL_SYS_MALLOC_SIZE\n");
566 else
567 pr_err("\tcheck CONFIG_SPL_SYS_MALLOC_F_LEN\n");
568
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500569 buf = spl_get_load_buffer(0, size);
570 }
571 return buf;
572}
573
Heiko Schocher7d7c3672021-08-17 08:17:18 +0200574__weak void *board_spl_fit_buffer_addr(ulong fit_size, int sectors, int bl_len)
575{
576 return spl_get_fit_load_buffer(sectors * bl_len);
577}
578
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500579/*
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500580 * Weak default function to allow customizing SPL fit loading for load-only
581 * use cases by allowing to skip the parsing/processing of the FIT contents
582 * (so that this can be done separately in a more customized fashion)
583 */
584__weak bool spl_load_simple_fit_skip_processing(void)
585{
586 return false;
587}
588
Heiko Schocher67e8f5d2021-08-06 06:44:26 +0200589/*
590 * Weak default function to allow fixes after fit header
591 * is loaded.
592 */
593__weak void *spl_load_simple_fit_fix_load(const void *fit)
594{
595 return (void *)fit;
596}
597
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500598static void warn_deprecated(const char *msg)
599{
600 printf("DEPRECATED: %s\n", msg);
Heinrich Schuchardt01e836c2024-06-18 08:32:30 +0200601 printf("\tSee https://fitspec.osfw.foundation/\n");
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500602}
603
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500604static int spl_fit_upload_fpga(struct spl_fit_info *ctx, int node,
605 struct spl_image_info *fpga_image)
606{
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500607 const char *compatible;
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500608 int ret;
Oleksandr Suvorov4ff163d2022-07-22 17:16:07 +0300609 int devnum = 0;
610 int flags = 0;
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500611
612 debug("FPGA bitstream at: %x, size: %x\n",
613 (u32)fpga_image->load_addr, fpga_image->size);
614
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500615 compatible = fdt_getprop(ctx->fit, node, "compatible", NULL);
Oleksandr Suvorov2fddf3e2022-07-22 17:16:09 +0300616 if (!compatible) {
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500617 warn_deprecated("'fpga' image without 'compatible' property");
Oleksandr Suvorov2fddf3e2022-07-22 17:16:09 +0300618 } else {
619 if (CONFIG_IS_ENABLED(FPGA_LOAD_SECURE))
620 flags = fpga_compatible2flag(devnum, compatible);
621 if (strcmp(compatible, "u-boot,fpga-legacy"))
622 debug("Ignoring compatible = %s property\n",
623 compatible);
624 }
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500625
Oleksandr Suvorov4ff163d2022-07-22 17:16:07 +0300626 ret = fpga_load(devnum, (void *)fpga_image->load_addr,
627 fpga_image->size, BIT_FULL, flags);
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500628 if (ret) {
629 printf("%s: Cannot load the image to the FPGA\n", __func__);
630 return ret;
631 }
632
633 puts("FPGA image loaded from FIT\n");
634
635 return 0;
636}
637
638static int spl_fit_load_fpga(struct spl_fit_info *ctx,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500639 struct spl_load_info *info, ulong offset)
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500640{
641 int node, ret;
642
643 struct spl_image_info fpga_image = {
644 .load_addr = 0,
645 };
646
647 node = spl_fit_get_image_node(ctx, "fpga", 0);
648 if (node < 0)
649 return node;
650
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500651 warn_deprecated("'fpga' property in config node. Use 'loadables'");
652
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500653 /* Load the image and set up the fpga_image structure */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500654 ret = load_simple_fit(info, offset, ctx, node, &fpga_image);
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500655 if (ret) {
656 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
657 return ret;
658 }
659
660 return spl_fit_upload_fpga(ctx, node, &fpga_image);
661}
662
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600663static int spl_simple_fit_read(struct spl_fit_info *ctx,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500664 struct spl_load_info *info, ulong offset,
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600665 const void *fit_header)
Simon Glassa6131a22016-02-22 22:55:56 -0700666{
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600667 unsigned long count, size;
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600668 void *buf;
Simon Glassa6131a22016-02-22 22:55:56 -0700669
670 /*
York Suna058b8a2017-08-15 11:14:45 -0700671 * For FIT with external data, figure out where the external images
672 * start. This is the base for the data-offset properties in each
673 * image.
Simon Glassa6131a22016-02-22 22:55:56 -0700674 */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600675 size = ALIGN(fdt_totalsize(fit_header), 4);
Ye Li9d5b0f42018-11-17 09:10:25 +0000676 size = board_spl_fit_size_align(size);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600677 ctx->ext_data_offset = ALIGN(size, 4);
Simon Glassa6131a22016-02-22 22:55:56 -0700678
679 /*
680 * So far we only have one block of data from the FIT. Read the entire
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500681 * thing, including that first block.
York Suna058b8a2017-08-15 11:14:45 -0700682 *
683 * For FIT with data embedded, data is loaded as part of FIT image.
684 * For FIT with external data, data is not loaded in this step.
Simon Glassa6131a22016-02-22 22:55:56 -0700685 */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500686 size = get_aligned_image_size(info, size, 0);
687 buf = board_spl_fit_buffer_addr(size, size, 1);
Ye Li9d5b0f42018-11-17 09:10:25 +0000688
Sean Anderson7d8d6132023-11-08 11:48:40 -0500689 count = info->read(info, offset, size, buf);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600690 ctx->fit = buf;
Sean Anderson7d8d6132023-11-08 11:48:40 -0500691 debug("fit read offset %lx, size=%lu, dst=%p, count=%lu\n",
692 offset, size, buf, count);
Simon Glassa6131a22016-02-22 22:55:56 -0700693
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600694 return (count == 0) ? -EIO : 0;
695}
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500696
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600697static int spl_simple_fit_parse(struct spl_fit_info *ctx)
698{
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600699 /* Find the correct subnode under "/configurations" */
700 ctx->conf_node = fit_find_config_node(ctx->fit);
701 if (ctx->conf_node < 0)
702 return -EINVAL;
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100703
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600704 if (IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) {
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100705 printf("## Checking hash(es) for config %s ... ",
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600706 fit_get_name(ctx->fit, ctx->conf_node, NULL));
707 if (fit_config_verify(ctx->fit, ctx->conf_node))
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100708 return -EPERM;
709 puts("OK\n");
710 }
711
Andre Przywara525e9c92017-04-26 01:32:34 +0100712 /* find the node holding the images information */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600713 ctx->images_node = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
714 if (ctx->images_node < 0) {
715 debug("%s: Cannot find /images node: %d\n", __func__,
716 ctx->images_node);
717 return -EINVAL;
Simon Glassa6131a22016-02-22 22:55:56 -0700718 }
Marek Vasut33dd00e2018-05-12 22:25:28 +0200719
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600720 return 0;
721}
722
723int spl_load_simple_fit(struct spl_image_info *spl_image,
Sean Anderson7d8d6132023-11-08 11:48:40 -0500724 struct spl_load_info *info, ulong offset, void *fit)
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600725{
726 struct spl_image_info image_info;
727 struct spl_fit_info ctx;
728 int node = -1;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600729 int ret;
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600730 int index = 0;
731 int firmware_node;
732
Sean Anderson7d8d6132023-11-08 11:48:40 -0500733 ret = spl_simple_fit_read(&ctx, info, offset, fit);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600734 if (ret < 0)
735 return ret;
736
737 /* skip further processing if requested to enable load-only use cases */
738 if (spl_load_simple_fit_skip_processing())
739 return 0;
740
Heiko Schocher67e8f5d2021-08-06 06:44:26 +0200741 ctx.fit = spl_load_simple_fit_fix_load(ctx.fit);
742
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600743 ret = spl_simple_fit_parse(&ctx);
744 if (ret < 0)
745 return ret;
746
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500747 if (IS_ENABLED(CONFIG_SPL_FPGA))
Sean Anderson7d8d6132023-11-08 11:48:40 -0500748 spl_fit_load_fpga(&ctx, info, offset);
Andre Przywara525e9c92017-04-26 01:32:34 +0100749
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200750 /*
751 * Find the U-Boot image using the following search order:
752 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
753 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
754 * - fall back to using the first 'loadables' entry
755 */
756 if (node < 0)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600757 node = spl_fit_get_image_node(&ctx, FIT_FIRMWARE_PROP, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600758
759 if (node < 0 && IS_ENABLED(CONFIG_SPL_OS_BOOT))
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600760 node = spl_fit_get_image_node(&ctx, FIT_KERNEL_PROP, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600761
Andre Przywara525e9c92017-04-26 01:32:34 +0100762 if (node < 0) {
763 debug("could not find firmware image, trying loadables...\n");
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600764 node = spl_fit_get_image_node(&ctx, "loadables", 0);
Andre Przywarae7c58562017-04-26 01:32:37 +0100765 /*
766 * If we pick the U-Boot image from "loadables", start at
767 * the second image when later loading additional images.
768 */
769 index = 1;
Andre Przywara525e9c92017-04-26 01:32:34 +0100770 }
Simon Glassa6131a22016-02-22 22:55:56 -0700771 if (node < 0) {
Andre Przywara525e9c92017-04-26 01:32:34 +0100772 debug("%s: Cannot find u-boot image node: %d\n",
773 __func__, node);
Simon Glassa6131a22016-02-22 22:55:56 -0700774 return -1;
775 }
776
Andre Przywara29053e92017-04-26 01:32:36 +0100777 /* Load the image and set up the spl_image structure */
Sean Anderson7d8d6132023-11-08 11:48:40 -0500778 ret = load_simple_fit(info, offset, &ctx, node, spl_image);
Andre Przywara29053e92017-04-26 01:32:36 +0100779 if (ret)
780 return ret;
Daniel Allredcf839bd2016-06-27 09:19:21 -0500781
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200782 /*
783 * For backward compatibility, we treat the first node that is
784 * as a U-Boot image, if no OS-type has been declared.
785 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600786 if (!spl_fit_image_get_os(ctx.fit, node, &spl_image->os))
York Suna058b8a2017-08-15 11:14:45 -0700787 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600788 else if (!IS_ENABLED(CONFIG_SPL_OS_BOOT))
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200789 spl_image->os = IH_OS_U_BOOT;
Simon Glassa6131a22016-02-22 22:55:56 -0700790
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200791 /*
792 * Booting a next-stage U-Boot may require us to append the FDT.
793 * We allow this to fail, as the U-Boot image might embed its FDT.
794 */
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600795 if (os_takes_devicetree(spl_image->os)) {
Sean Anderson7d8d6132023-11-08 11:48:40 -0500796 ret = spl_fit_append_fdt(spl_image, info, offset, &ctx);
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600797 if (ret < 0 && spl_image->os != IH_OS_U_BOOT)
Dario Binacchifaf8d142020-05-27 13:56:19 +0200798 return ret;
799 }
Andre Przywarae7c58562017-04-26 01:32:37 +0100800
Jean-Jacques Hiblot776ce602019-10-22 16:39:10 +0200801 firmware_node = node;
Andre Przywarae7c58562017-04-26 01:32:37 +0100802 /* Now check if there are more images for us to load */
803 for (; ; index++) {
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200804 uint8_t os_type = IH_OS_INVALID;
805
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600806 node = spl_fit_get_image_node(&ctx, "loadables", index);
Andre Przywarae7c58562017-04-26 01:32:37 +0100807 if (node < 0)
808 break;
809
Jean-Jacques Hiblot776ce602019-10-22 16:39:10 +0200810 /*
811 * if the firmware is also a loadable, skip it because
812 * it already has been loaded. This is typically the case with
813 * u-boot.img generated by mkimage.
814 */
815 if (firmware_node == node)
816 continue;
817
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500818 image_info.load_addr = 0;
Sean Anderson7d8d6132023-11-08 11:48:40 -0500819 ret = load_simple_fit(info, offset, &ctx, node, &image_info);
Philippe Reynesba87da42020-11-24 16:15:05 +0100820 if (ret < 0) {
821 printf("%s: can't load image loadables index %d (ret = %d)\n",
822 __func__, index, ret);
823 return ret;
824 }
Andre Przywarae7c58562017-04-26 01:32:37 +0100825
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500826 if (spl_fit_image_is_fpga(ctx.fit, node))
827 spl_fit_upload_fpga(&ctx, node, &image_info);
828
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600829 if (!spl_fit_image_get_os(ctx.fit, node, &os_type))
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200830 debug("Loadable is %s\n", genimg_get_os_name(os_type));
831
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600832 if (os_takes_devicetree(os_type)) {
Sean Anderson7d8d6132023-11-08 11:48:40 -0500833 spl_fit_append_fdt(&image_info, info, offset, &ctx);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200834 spl_image->fdt_addr = image_info.fdt_addr;
835 }
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200836
Andre Przywarae7c58562017-04-26 01:32:37 +0100837 /*
838 * If the "firmware" image did not provide an entry point,
839 * use the first valid entry point from the loadables.
840 */
841 if (spl_image->entry_point == FDT_ERROR &&
842 image_info.entry_point != FDT_ERROR)
843 spl_image->entry_point = image_info.entry_point;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200844
845 /* Record our loadables into the FDT */
846 if (spl_image->fdt_addr)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600847 spl_fit_record_loadable(&ctx, index,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200848 spl_image->fdt_addr,
849 &image_info);
Andre Przywarae7c58562017-04-26 01:32:37 +0100850 }
851
852 /*
Jesse Taube93ee5c82023-08-24 21:59:48 -0400853 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
Andre Przywarae7c58562017-04-26 01:32:37 +0100854 * Makefile will set it to 0 and it will end up as the entry point
855 * here. What it actually means is: use the load address.
856 */
857 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
858 spl_image->entry_point = spl_image->load_addr;
859
Ye Li9d5b0f42018-11-17 09:10:25 +0000860 spl_image->flags |= SPL_FIT_FOUND;
Simon Glass9b5bfba2024-08-07 16:47:33 -0600861 upl_set_fit_info(map_to_sysmem(ctx.fit), ctx.conf_node,
862 spl_image->entry_point);
Ye Li9d5b0f42018-11-17 09:10:25 +0000863
Andre Przywarae7c58562017-04-26 01:32:37 +0100864 return 0;
Simon Glassa6131a22016-02-22 22:55:56 -0700865}
Simon Glassc0bd55e2023-09-26 08:14:34 -0600866
867/* Parse and load full fitImage in SPL */
868int spl_load_fit_image(struct spl_image_info *spl_image,
869 const struct legacy_img_hdr *header)
870{
871 struct bootm_headers images;
872 const char *fit_uname_config = NULL;
Simon Glass9a9097f2024-12-19 11:29:00 -0700873 ulong fdt_hack;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600874 const char *uname;
875 ulong fw_data = 0, dt_data = 0, img_data = 0;
876 ulong fw_len = 0, dt_len = 0, img_len = 0;
877 int idx, conf_noffset;
878 int ret;
879
880#ifdef CONFIG_SPL_FIT_SIGNATURE
881 images.verify = 1;
882#endif
Sean Anderson5ff77722023-10-14 16:47:55 -0400883 ret = fit_image_load(&images, virt_to_phys((void *)header),
Simon Glassc0bd55e2023-09-26 08:14:34 -0600884 NULL, &fit_uname_config,
885 IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
886 FIT_LOAD_OPTIONAL, &fw_data, &fw_len);
887 if (ret >= 0) {
888 printf("DEPRECATED: 'standalone = ' property.");
889 printf("Please use either 'firmware =' or 'kernel ='\n");
890 } else {
Sean Anderson5ff77722023-10-14 16:47:55 -0400891 ret = fit_image_load(&images, virt_to_phys((void *)header),
892 NULL, &fit_uname_config, IH_ARCH_DEFAULT,
Simon Glassc0bd55e2023-09-26 08:14:34 -0600893 IH_TYPE_FIRMWARE, -1, FIT_LOAD_OPTIONAL,
894 &fw_data, &fw_len);
895 }
896
897 if (ret < 0) {
Sean Anderson5ff77722023-10-14 16:47:55 -0400898 ret = fit_image_load(&images, virt_to_phys((void *)header),
899 NULL, &fit_uname_config, IH_ARCH_DEFAULT,
Simon Glassc0bd55e2023-09-26 08:14:34 -0600900 IH_TYPE_KERNEL, -1, FIT_LOAD_OPTIONAL,
901 &fw_data, &fw_len);
902 }
903
904 if (ret < 0)
905 return ret;
906
907 spl_image->size = fw_len;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600908 spl_image->load_addr = fw_data;
Sean Andersone99b2cd2023-10-14 16:47:39 -0400909 if (fit_image_get_entry(header, ret, &spl_image->entry_point))
910 spl_image->entry_point = fw_data;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600911 if (fit_image_get_os(header, ret, &spl_image->os))
912 spl_image->os = IH_OS_INVALID;
913 spl_image->name = genimg_get_os_name(spl_image->os);
914
Simon Glass8bc93262024-09-29 19:49:55 -0600915 debug(PHASE_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
Simon Glassc0bd55e2023-09-26 08:14:34 -0600916 spl_image->name, spl_image->load_addr, spl_image->size);
917
918#ifdef CONFIG_SPL_FIT_SIGNATURE
919 images.verify = 1;
920#endif
Sean Anderson5ff77722023-10-14 16:47:55 -0400921 ret = fit_image_load(&images, virt_to_phys((void *)header), NULL,
922 &fit_uname_config, IH_ARCH_DEFAULT, IH_TYPE_FLATDT,
923 -1, FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
Simon Glassc0bd55e2023-09-26 08:14:34 -0600924 if (ret >= 0) {
925 spl_image->fdt_addr = (void *)dt_data;
926
927 if (spl_image->os == IH_OS_U_BOOT) {
928 /* HACK: U-Boot expects FDT at a specific address */
929 fdt_hack = spl_image->load_addr + spl_image->size;
930 fdt_hack = (fdt_hack + 3) & ~3;
931 debug("Relocating FDT to %p\n", spl_image->fdt_addr);
932 memcpy((void *)fdt_hack, spl_image->fdt_addr, dt_len);
933 }
934 }
935
936 conf_noffset = fit_conf_get_node((const void *)header,
937 fit_uname_config);
938 if (conf_noffset < 0)
939 return 0;
940
941 for (idx = 0;
942 uname = fdt_stringlist_get((const void *)header, conf_noffset,
943 FIT_LOADABLE_PROP, idx,
944 NULL), uname;
945 idx++) {
946#ifdef CONFIG_SPL_FIT_SIGNATURE
947 images.verify = 1;
948#endif
949 ret = fit_image_load(&images, (ulong)header,
950 &uname, &fit_uname_config,
951 IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
952 FIT_LOAD_OPTIONAL_NON_ZERO,
953 &img_data, &img_len);
954 if (ret < 0)
955 return ret;
956 }
Simon Glass32668282024-08-07 16:47:32 -0600957 spl_image->flags |= SPL_FIT_FOUND;
Simon Glassc0bd55e2023-09-26 08:14:34 -0600958
Simon Glass9b5bfba2024-08-07 16:47:33 -0600959 upl_set_fit_info(map_to_sysmem(header), conf_noffset,
960 spl_image->entry_point);
961
Simon Glassc0bd55e2023-09-26 08:14:34 -0600962 return 0;
963}