blob: f41abca0ccb59baf486f5383d6cef64a92cfeb33 [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
7#include <common.h>
8#include <errno.h>
Michal Simekf707b5a2018-07-18 14:33:15 +02009#include <fpga.h>
Simon Glass1a974af2019-08-01 09:46:36 -060010#include <gzip.h>
Simon Glassa6131a22016-02-22 22:55:56 -070011#include <image.h>
Simon Glass0f2af882020-05-10 11:40:05 -060012#include <log.h>
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +020013#include <malloc.h>
Simon Glass2192e982021-03-07 17:35:14 -070014#include <mapmem.h>
Simon Glassa6131a22016-02-22 22:55:56 -070015#include <spl.h>
Simon Glass458b66a2020-11-05 06:32:05 -070016#include <sysinfo.h>
Simon Glass274e0b02020-05-10 11:39:56 -060017#include <asm/cache.h>
Simon Glass3ba929a2020-10-30 21:38:53 -060018#include <asm/global_data.h>
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +020019#include <linux/libfdt.h>
Simon Glassa6131a22016-02-22 22:55:56 -070020
Lukas Auer80afee72019-08-21 21:14:42 +020021DECLARE_GLOBAL_DATA_PTR;
22
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +020023#ifndef CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
24#define CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ (64 * 1024)
25#endif
26
York Suna6945fe2017-08-15 11:14:43 -070027#ifndef CONFIG_SYS_BOOTM_LEN
28#define CONFIG_SYS_BOOTM_LEN (64 << 20)
29#endif
30
Alexandru Gagniuc23243c92021-01-20 10:46:50 -060031struct spl_fit_info {
32 const void *fit; /* Pointer to a valid FIT blob */
33 size_t ext_data_offset; /* Offset to FIT external data (end of FIT) */
34 int images_node; /* FDT offset to "/images" node */
Alexandru Gagniucfa11a442021-01-20 10:46:53 -060035 int conf_node; /* FDT offset to selected configuration node */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -060036};
37
Alexandru Gagniuc44af2a52021-01-20 10:46:49 -060038__weak void board_spl_fit_post_load(const void *fit)
Ye Li9d5b0f42018-11-17 09:10:25 +000039{
40}
41
42__weak ulong board_spl_fit_size_align(ulong size)
43{
44 return size;
45}
46
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020047static int find_node_from_desc(const void *fit, int node, const char *str)
48{
49 int child;
50
51 if (node < 0)
52 return -EINVAL;
53
54 /* iterate the FIT nodes and find a matching description */
55 for (child = fdt_first_subnode(fit, node); child >= 0;
56 child = fdt_next_subnode(fit, child)) {
57 int len;
58 const char *desc = fdt_getprop(fit, child, "description", &len);
59
60 if (!desc)
61 continue;
62
63 if (!strcmp(desc, str))
64 return child;
65 }
66
67 return -ENOENT;
68}
69
Andre Przywara525e9c92017-04-26 01:32:34 +010070/**
Philipp Tomsiche61eff92017-09-13 21:29:34 +020071 * spl_fit_get_image_name(): By using the matching configuration subnode,
Andre Przywara525e9c92017-04-26 01:32:34 +010072 * retrieve the name of an image, specified by a property name and an index
73 * into that.
74 * @fit: Pointer to the FDT blob.
75 * @images: Offset of the /images subnode.
76 * @type: Name of the property within the configuration subnode.
77 * @index: Index into the list of strings in this property.
Philipp Tomsiche61eff92017-09-13 21:29:34 +020078 * @outname: Name of the image
Andre Przywara525e9c92017-04-26 01:32:34 +010079 *
Philipp Tomsiche61eff92017-09-13 21:29:34 +020080 * Return: 0 on success, or a negative error number
Andre Przywara525e9c92017-04-26 01:32:34 +010081 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -060082static int spl_fit_get_image_name(const struct spl_fit_info *ctx,
Philipp Tomsiche61eff92017-09-13 21:29:34 +020083 const char *type, int index,
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +020084 const char **outname)
Andre Przywara1e329b62017-04-26 01:32:33 +010085{
Simon Glass458b66a2020-11-05 06:32:05 -070086 struct udevice *sysinfo;
Andre Przywara1e329b62017-04-26 01:32:33 +010087 const char *name, *str;
Philipp Tomsiche61eff92017-09-13 21:29:34 +020088 __maybe_unused int node;
Andre Przywara1e329b62017-04-26 01:32:33 +010089 int len, i;
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +020090 bool found = true;
Andre Przywara1e329b62017-04-26 01:32:33 +010091
Alexandru Gagniucfa11a442021-01-20 10:46:53 -060092 name = fdt_getprop(ctx->fit, ctx->conf_node, type, &len);
Andre Przywara1e329b62017-04-26 01:32:33 +010093 if (!name) {
94 debug("cannot find property '%s': %d\n", type, len);
95 return -EINVAL;
96 }
Simon Glassa6131a22016-02-22 22:55:56 -070097
Andre Przywara1e329b62017-04-26 01:32:33 +010098 str = name;
99 for (i = 0; i < index; i++) {
100 str = strchr(str, '\0') + 1;
101 if (!str || (str - name >= len)) {
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200102 found = false;
103 break;
Andre Przywara1e329b62017-04-26 01:32:33 +0100104 }
Simon Glassa6131a22016-02-22 22:55:56 -0700105 }
106
Simon Glass458b66a2020-11-05 06:32:05 -0700107 if (!found && CONFIG_IS_ENABLED(SYSINFO) && !sysinfo_get(&sysinfo)) {
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200108 int rc;
109 /*
Simon Glass458b66a2020-11-05 06:32:05 -0700110 * no string in the property for this index. Check if the
111 * sysinfo-level code can supply one.
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200112 */
Sean Anderson6ccf10a2021-04-20 10:50:56 -0400113 rc = sysinfo_detect(sysinfo);
114 if (rc)
115 return rc;
116
Simon Glass458b66a2020-11-05 06:32:05 -0700117 rc = sysinfo_get_fit_loadable(sysinfo, index - i - 1, type,
118 &str);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200119 if (rc && rc != -ENOENT)
120 return rc;
121
122 if (!rc) {
123 /*
Simon Glass458b66a2020-11-05 06:32:05 -0700124 * The sysinfo provided a name for a loadable.
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200125 * Try to match it against the description properties
126 * first. If no matching node is found, use it as a
127 * node name.
128 */
129 int node;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600130 int images = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200131
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600132 node = find_node_from_desc(ctx->fit, images, str);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200133 if (node > 0)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600134 str = fdt_get_name(ctx->fit, node, NULL);
Jean-Jacques Hiblot9037b7f2019-10-22 16:39:22 +0200135
136 found = true;
137 }
138 }
139
140 if (!found) {
141 debug("no string for index %d\n", index);
142 return -E2BIG;
143 }
144
145 *outname = str;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200146 return 0;
147}
148
149/**
150 * spl_fit_get_image_node(): By using the matching configuration subnode,
151 * retrieve the name of an image, specified by a property name and an index
152 * into that.
153 * @fit: Pointer to the FDT blob.
154 * @images: Offset of the /images subnode.
155 * @type: Name of the property within the configuration subnode.
156 * @index: Index into the list of strings in this property.
157 *
158 * Return: the node offset of the respective image node or a negative
159 * error number.
160 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600161static int spl_fit_get_image_node(const struct spl_fit_info *ctx,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200162 const char *type, int index)
163{
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +0200164 const char *str;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200165 int err;
166 int node;
167
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600168 err = spl_fit_get_image_name(ctx, type, index, &str);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200169 if (err)
170 return err;
171
Andre Przywara1e329b62017-04-26 01:32:33 +0100172 debug("%s: '%s'\n", type, str);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200173
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600174 node = fdt_subnode_offset(ctx->fit, ctx->images_node, str);
Andre Przywara1e329b62017-04-26 01:32:33 +0100175 if (node < 0) {
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200176 pr_err("cannot find image node '%s': %d\n", str, node);
Andre Przywara1e329b62017-04-26 01:32:33 +0100177 return -EINVAL;
Simon Glassa6131a22016-02-22 22:55:56 -0700178 }
Simon Glassa6131a22016-02-22 22:55:56 -0700179
Andre Przywara525e9c92017-04-26 01:32:34 +0100180 return node;
Simon Glassa6131a22016-02-22 22:55:56 -0700181}
182
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530183static int get_aligned_image_offset(struct spl_load_info *info, int offset)
184{
185 /*
186 * If it is a FS read, get the first address before offset which is
187 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
188 * block number to which offset belongs.
189 */
190 if (info->filename)
191 return offset & ~(ARCH_DMA_MINALIGN - 1);
192
193 return offset / info->bl_len;
194}
195
196static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
197{
198 /*
199 * If it is a FS read, get the difference between the offset and
200 * the first address before offset which is aligned to
201 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
202 * block.
203 */
204 if (info->filename)
205 return offset & (ARCH_DMA_MINALIGN - 1);
206
207 return offset % info->bl_len;
208}
209
210static int get_aligned_image_size(struct spl_load_info *info, int data_size,
211 int offset)
212{
Lokesh Vutlaf0531a62016-07-19 14:56:14 +0530213 data_size = data_size + get_aligned_image_overhead(info, offset);
214
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530215 if (info->filename)
Lokesh Vutlaf0531a62016-07-19 14:56:14 +0530216 return data_size;
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530217
218 return (data_size + info->bl_len - 1) / info->bl_len;
219}
220
Andre Przywara29053e92017-04-26 01:32:36 +0100221/**
222 * spl_load_fit_image(): load the image described in a certain FIT node
223 * @info: points to information about the device to load data from
224 * @sector: the start sector of the FIT image on the device
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600225 * @ctx: points to the FIT context structure
Andre Przywara29053e92017-04-26 01:32:36 +0100226 * @node: offset of the DT node describing the image to load (relative
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200227 * to @fit)
Andre Przywara29053e92017-04-26 01:32:36 +0100228 * @image_info: will be filled with information about the loaded image
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200229 * If the FIT node does not contain a "load" (address) property,
230 * the image gets loaded to the address pointed to by the
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500231 * load_addr member in this struct, if load_addr is not 0
Andre Przywara29053e92017-04-26 01:32:36 +0100232 *
233 * Return: 0 on success or a negative error number.
234 */
235static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600236 const struct spl_fit_info *ctx, int node,
Andre Przywara29053e92017-04-26 01:32:36 +0100237 struct spl_image_info *image_info)
238{
Michal Simekf707b5a2018-07-18 14:33:15 +0200239 int offset;
Andre Przywara29053e92017-04-26 01:32:36 +0100240 size_t length;
York Sunadf99fa2017-08-15 11:14:44 -0700241 int len;
York Sun25d65f12017-09-15 08:21:13 -0700242 ulong size;
Simon Glass2192e982021-03-07 17:35:14 -0700243 ulong load_addr;
244 void *load_ptr;
Andre Przywara29053e92017-04-26 01:32:36 +0100245 void *src;
246 ulong overhead;
247 int nr_sectors;
York Suna6945fe2017-08-15 11:14:43 -0700248 uint8_t image_comp = -1, type = -1;
York Sunadf99fa2017-08-15 11:14:44 -0700249 const void *data;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600250 const void *fit = ctx->fit;
Peng Fan8876c7e2017-12-05 13:20:59 +0800251 bool external_data = false;
York Suna6945fe2017-08-15 11:14:43 -0700252
Michal Simek1aab1142020-09-09 14:41:56 +0200253 if (IS_ENABLED(CONFIG_SPL_FPGA) ||
Marek Vasut72bc5d52018-06-01 23:19:29 +0200254 (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
255 if (fit_image_get_type(fit, node, &type))
256 puts("Cannot get image type.\n");
257 else
258 debug("%s ", genimg_get_type_name(type));
259 }
260
Klaus H. Sorensen4a9a0422019-12-11 11:03:33 +0000261 if (IS_ENABLED(CONFIG_SPL_GZIP)) {
262 fit_image_get_comp(fit, node, &image_comp);
263 debug("%s ", genimg_get_comp_name(image_comp));
York Suna6945fe2017-08-15 11:14:43 -0700264 }
Andre Przywara29053e92017-04-26 01:32:36 +0100265
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500266 if (fit_image_get_load(fit, node, &load_addr)) {
267 if (!image_info->load_addr) {
268 printf("Can't load %s: No load address and no buffer\n",
269 fit_get_name(fit, node, NULL));
270 return -ENOBUFS;
271 }
Andre Przywara29053e92017-04-26 01:32:36 +0100272 load_addr = image_info->load_addr;
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500273 }
Andre Przywara29053e92017-04-26 01:32:36 +0100274
Peng Fan8876c7e2017-12-05 13:20:59 +0800275 if (!fit_image_get_data_position(fit, node, &offset)) {
276 external_data = true;
277 } else if (!fit_image_get_data_offset(fit, node, &offset)) {
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600278 offset += ctx->ext_data_offset;
Peng Fan8876c7e2017-12-05 13:20:59 +0800279 external_data = true;
280 }
281
282 if (external_data) {
Simon Glass2192e982021-03-07 17:35:14 -0700283 void *src_ptr;
284
Peng Fan8876c7e2017-12-05 13:20:59 +0800285 /* External data */
York Sunadf99fa2017-08-15 11:14:44 -0700286 if (fit_image_get_data_size(fit, node, &len))
287 return -ENOENT;
Andre Przywara29053e92017-04-26 01:32:36 +0100288
Simon Glass2192e982021-03-07 17:35:14 -0700289 src_ptr = map_sysmem(ALIGN(load_addr, ARCH_DMA_MINALIGN), len);
York Sunadf99fa2017-08-15 11:14:44 -0700290 length = len;
291
292 overhead = get_aligned_image_overhead(info, offset);
293 nr_sectors = get_aligned_image_size(info, length, offset);
294
Michal Simekf707b5a2018-07-18 14:33:15 +0200295 if (info->read(info,
296 sector + get_aligned_image_offset(info, offset),
Simon Glass2192e982021-03-07 17:35:14 -0700297 nr_sectors, src_ptr) != nr_sectors)
York Sunadf99fa2017-08-15 11:14:44 -0700298 return -EIO;
299
Simon Glass2192e982021-03-07 17:35:14 -0700300 debug("External data: dst=%p, offset=%x, size=%lx\n",
301 src_ptr, offset, (unsigned long)length);
302 src = src_ptr + overhead;
York Sunadf99fa2017-08-15 11:14:44 -0700303 } else {
304 /* Embedded data */
305 if (fit_image_get_data(fit, node, &data, &length)) {
306 puts("Cannot get image data/size\n");
307 return -ENOENT;
308 }
309 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
310 (unsigned long)length);
Simon Glass2192e982021-03-07 17:35:14 -0700311 src = (void *)data; /* cast away const */
York Sunadf99fa2017-08-15 11:14:44 -0700312 }
Andre Przywara29053e92017-04-26 01:32:36 +0100313
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600314 if (CONFIG_IS_ENABLED(FIT_SIGNATURE)) {
315 printf("## Checking hash(es) for Image %s ... ",
316 fit_get_name(fit, node, NULL));
317 if (!fit_image_verify_with_data(fit, node, src, length))
318 return -EPERM;
319 puts("OK\n");
320 }
Ben Whitten54a91192018-06-07 11:37:27 +0100321
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600322 if (CONFIG_IS_ENABLED(FIT_IMAGE_POST_PROCESS))
Lokesh Vutlab36dd3e2021-06-11 11:45:05 +0300323 board_fit_image_post_process(fit, node, &src, &length);
Andre Przywara29053e92017-04-26 01:32:36 +0100324
Simon Glass2192e982021-03-07 17:35:14 -0700325 load_ptr = map_sysmem(load_addr, length);
Michal Simekf354c3f2018-07-24 15:05:00 +0200326 if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
York Sun25d65f12017-09-15 08:21:13 -0700327 size = length;
Simon Glass2192e982021-03-07 17:35:14 -0700328 if (gunzip(load_ptr, CONFIG_SYS_BOOTM_LEN, src, &size)) {
York Suna6945fe2017-08-15 11:14:43 -0700329 puts("Uncompressing error\n");
330 return -EIO;
331 }
York Sun25d65f12017-09-15 08:21:13 -0700332 length = size;
York Suna6945fe2017-08-15 11:14:43 -0700333 } else {
Simon Glass2192e982021-03-07 17:35:14 -0700334 memcpy(load_ptr, src, length);
York Suna6945fe2017-08-15 11:14:43 -0700335 }
Andre Przywara29053e92017-04-26 01:32:36 +0100336
337 if (image_info) {
Michal Simek9e64a552020-09-03 11:24:28 +0200338 ulong entry_point;
339
Andre Przywara29053e92017-04-26 01:32:36 +0100340 image_info->load_addr = load_addr;
341 image_info->size = length;
Michal Simek9e64a552020-09-03 11:24:28 +0200342
343 if (!fit_image_get_entry(fit, node, &entry_point))
344 image_info->entry_point = entry_point;
345 else
346 image_info->entry_point = FDT_ERROR;
Andre Przywara29053e92017-04-26 01:32:36 +0100347 }
348
349 return 0;
350}
351
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600352static bool os_takes_devicetree(uint8_t os)
353{
354 switch (os) {
355 case IH_OS_U_BOOT:
356 return true;
357 case IH_OS_LINUX:
358 return IS_ENABLED(CONFIG_SPL_OS_BOOT);
359 default:
360 return false;
361 }
362}
363
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200364static int spl_fit_append_fdt(struct spl_image_info *spl_image,
365 struct spl_load_info *info, ulong sector,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600366 const struct spl_fit_info *ctx)
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200367{
368 struct spl_image_info image_info;
Michal Simekbf703df2019-10-22 16:39:11 +0200369 int node, ret = 0, index = 0;
Lukas Auer80afee72019-08-21 21:14:42 +0200370
371 /*
372 * Use the address following the image as target address for the
Marek Vasutc27cbe82020-10-19 23:40:26 +0200373 * device tree.
Lukas Auer80afee72019-08-21 21:14:42 +0200374 */
Marek Vasutc27cbe82020-10-19 23:40:26 +0200375 image_info.load_addr = spl_image->load_addr + spl_image->size;
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200376
377 /* Figure out which device tree the board wants to use */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600378 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index++);
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200379 if (node < 0) {
380 debug("%s: cannot find FDT node\n", __func__);
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200381
Lukas Auer80afee72019-08-21 21:14:42 +0200382 /*
383 * U-Boot did not find a device tree inside the FIT image. Use
384 * the U-Boot device tree instead.
385 */
386 if (gd->fdt_blob)
387 memcpy((void *)image_info.load_addr, gd->fdt_blob,
388 fdt_totalsize(gd->fdt_blob));
389 else
390 return node;
391 } else {
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600392 ret = spl_load_fit_image(info, sector, ctx, node,
Lukas Auer80afee72019-08-21 21:14:42 +0200393 &image_info);
394 if (ret < 0)
395 return ret;
396 }
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200397
398 /* Make the load-address of the FDT available for the SPL framework */
Simon Glass2192e982021-03-07 17:35:14 -0700399 spl_image->fdt_addr = map_sysmem(image_info.load_addr, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600400 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
401 return 0;
402
Michal Simekbf703df2019-10-22 16:39:11 +0200403 if (CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)) {
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200404 void *tmpbuffer = NULL;
405
Michal Simekbf703df2019-10-22 16:39:11 +0200406 for (; ; index++) {
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600407 node = spl_fit_get_image_node(ctx, FIT_FDT_PROP, index);
Jean-Jacques Hiblotc6ab6a12019-10-22 16:39:14 +0200408 if (node == -E2BIG) {
Michal Simekbf703df2019-10-22 16:39:11 +0200409 debug("%s: No additional FDT node\n", __func__);
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200410 break;
Jean-Jacques Hiblotc6ab6a12019-10-22 16:39:14 +0200411 } else if (node < 0) {
412 debug("%s: unable to find FDT node %d\n",
413 __func__, index);
414 continue;
Michal Simekbf703df2019-10-22 16:39:11 +0200415 }
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200416
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200417 if (!tmpbuffer) {
418 /*
419 * allocate memory to store the DT overlay
420 * before it is applied. It may not be used
421 * depending on how the overlay is stored, so
422 * don't fail yet if the allocation failed.
423 */
424 tmpbuffer = malloc(CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ);
425 if (!tmpbuffer)
426 debug("%s: unable to allocate space for overlays\n",
427 __func__);
428 }
429 image_info.load_addr = (ulong)tmpbuffer;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600430 ret = spl_load_fit_image(info, sector, ctx,
Michal Simekbf703df2019-10-22 16:39:11 +0200431 node, &image_info);
432 if (ret < 0)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200433 break;
Michal Simekbf703df2019-10-22 16:39:11 +0200434
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200435 /* Make room in FDT for changes from the overlay */
436 ret = fdt_increase_size(spl_image->fdt_addr,
437 image_info.size);
438 if (ret < 0)
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200439 break;
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200440
Michal Simekbf703df2019-10-22 16:39:11 +0200441 ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
442 (void *)image_info.load_addr);
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200443 if (ret) {
444 pr_err("failed to apply DT overlay %s\n",
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600445 fit_get_name(ctx->fit, node, NULL));
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200446 break;
Jean-Jacques Hiblot9443a732019-10-22 16:39:15 +0200447 }
Michal Simekbf703df2019-10-22 16:39:11 +0200448
449 debug("%s: DT overlay %s applied\n", __func__,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600450 fit_get_name(ctx->fit, node, NULL));
Michal Simekbf703df2019-10-22 16:39:11 +0200451 }
Heinrich Schuchardt939a9612020-04-20 12:44:01 +0200452 free(tmpbuffer);
Jean-Jacques Hiblot0da58152019-10-22 16:39:13 +0200453 if (ret)
454 return ret;
Michal Simekbf703df2019-10-22 16:39:11 +0200455 }
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200456 /* Try to make space, so we can inject details on the loadables */
457 ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
458 if (ret < 0)
459 return ret;
Jean-Jacques Hiblot74addb62019-10-22 16:39:12 +0200460
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200461 return ret;
462}
463
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600464static int spl_fit_record_loadable(const struct spl_fit_info *ctx, int index,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200465 void *blob, struct spl_image_info *image)
466{
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100467 int ret = 0;
Jean-Jacques Hiblot64e82dc2019-10-22 16:39:17 +0200468 const char *name;
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100469 int node;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200470
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600471 if (CONFIG_IS_ENABLED(FIT_IMAGE_TINY))
472 return 0;
473
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600474 ret = spl_fit_get_image_name(ctx, "loadables", index, &name);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200475 if (ret < 0)
476 return ret;
477
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600478 node = spl_fit_get_image_node(ctx, "loadables", index);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200479
480 ret = fdt_record_loadable(blob, index, name, image->load_addr,
481 image->size, image->entry_point,
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600482 fdt_getprop(ctx->fit, node, "type", NULL),
Michal Simek0e4f43d2021-05-27 11:40:09 +0200483 fdt_getprop(ctx->fit, node, "os", NULL),
484 fdt_getprop(ctx->fit, node, "arch", NULL));
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200485 return ret;
486}
487
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500488static int spl_fit_image_is_fpga(const void *fit, int node)
489{
490 const char *type;
491
492 if (!IS_ENABLED(CONFIG_SPL_FPGA))
493 return 0;
494
495 type = fdt_getprop(fit, node, FIT_TYPE_PROP, NULL);
496 if (!type)
497 return 0;
498
499 return !strcmp(type, "fpga");
500}
501
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100502static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
503{
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600504 if (!CONFIG_IS_ENABLED(FIT_IMAGE_TINY) || CONFIG_IS_ENABLED(OS_BOOT))
505 return fit_image_get_os(fit, noffset, os);
Samuel Hollande646f512020-10-21 21:12:13 -0500506
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600507 const char *name = fdt_getprop(fit, noffset, FIT_OS_PROP, NULL);
Samuel Hollande646f512020-10-21 21:12:13 -0500508 if (!name)
509 return -ENOENT;
510
511 /*
512 * We don't care what the type of the image actually is,
513 * only whether or not it is U-Boot. This saves some
514 * space by omitting the large table of OS types.
515 */
516 if (!strcmp(name, "u-boot"))
517 *os = IH_OS_U_BOOT;
518 else
519 *os = IH_OS_INVALID;
520
521 return 0;
Philipp Tomsich4faa0112017-11-24 13:26:03 +0100522}
523
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500524/*
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500525 * The purpose of the FIT load buffer is to provide a memory location that is
526 * independent of the load address of any FIT component.
527 */
528static void *spl_get_fit_load_buffer(size_t size)
529{
530 void *buf;
531
532 buf = malloc(size);
533 if (!buf) {
534 pr_err("Could not get FIT buffer of %lu bytes\n", (ulong)size);
535 pr_err("\tcheck CONFIG_SYS_SPL_MALLOC_SIZE\n");
536 buf = spl_get_load_buffer(0, size);
537 }
538 return buf;
539}
540
541/*
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500542 * Weak default function to allow customizing SPL fit loading for load-only
543 * use cases by allowing to skip the parsing/processing of the FIT contents
544 * (so that this can be done separately in a more customized fashion)
545 */
546__weak bool spl_load_simple_fit_skip_processing(void)
547{
548 return false;
549}
550
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500551static void warn_deprecated(const char *msg)
552{
553 printf("DEPRECATED: %s\n", msg);
554 printf("\tSee doc/uImage.FIT/source_file_format.txt\n");
555}
556
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500557static int spl_fit_upload_fpga(struct spl_fit_info *ctx, int node,
558 struct spl_image_info *fpga_image)
559{
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500560 const char *compatible;
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500561 int ret;
562
563 debug("FPGA bitstream at: %x, size: %x\n",
564 (u32)fpga_image->load_addr, fpga_image->size);
565
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500566 compatible = fdt_getprop(ctx->fit, node, "compatible", NULL);
567 if (!compatible)
568 warn_deprecated("'fpga' image without 'compatible' property");
569 else if (strcmp(compatible, "u-boot,fpga-legacy"))
570 printf("Ignoring compatible = %s property\n", compatible);
571
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500572 ret = fpga_load(0, (void *)fpga_image->load_addr, fpga_image->size,
573 BIT_FULL);
574 if (ret) {
575 printf("%s: Cannot load the image to the FPGA\n", __func__);
576 return ret;
577 }
578
579 puts("FPGA image loaded from FIT\n");
580
581 return 0;
582}
583
584static int spl_fit_load_fpga(struct spl_fit_info *ctx,
585 struct spl_load_info *info, ulong sector)
586{
587 int node, ret;
588
589 struct spl_image_info fpga_image = {
590 .load_addr = 0,
591 };
592
593 node = spl_fit_get_image_node(ctx, "fpga", 0);
594 if (node < 0)
595 return node;
596
Alexandru Gagniuc69a99662021-03-29 12:05:13 -0500597 warn_deprecated("'fpga' property in config node. Use 'loadables'");
598
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500599 /* Load the image and set up the fpga_image structure */
600 ret = spl_load_fit_image(info, sector, ctx, node, &fpga_image);
601 if (ret) {
602 printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
603 return ret;
604 }
605
606 return spl_fit_upload_fpga(ctx, node, &fpga_image);
607}
608
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600609static int spl_simple_fit_read(struct spl_fit_info *ctx,
610 struct spl_load_info *info, ulong sector,
611 const void *fit_header)
Simon Glassa6131a22016-02-22 22:55:56 -0700612{
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600613 unsigned long count, size;
Simon Glassa6131a22016-02-22 22:55:56 -0700614 int sectors;
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600615 void *buf;
Simon Glassa6131a22016-02-22 22:55:56 -0700616
617 /*
York Suna058b8a2017-08-15 11:14:45 -0700618 * For FIT with external data, figure out where the external images
619 * start. This is the base for the data-offset properties in each
620 * image.
Simon Glassa6131a22016-02-22 22:55:56 -0700621 */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600622 size = ALIGN(fdt_totalsize(fit_header), 4);
Ye Li9d5b0f42018-11-17 09:10:25 +0000623 size = board_spl_fit_size_align(size);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600624 ctx->ext_data_offset = ALIGN(size, 4);
Simon Glassa6131a22016-02-22 22:55:56 -0700625
626 /*
627 * So far we only have one block of data from the FIT. Read the entire
Alexandru Gagniuc02560172020-10-21 18:32:58 -0500628 * thing, including that first block.
York Suna058b8a2017-08-15 11:14:45 -0700629 *
630 * For FIT with data embedded, data is loaded as part of FIT image.
631 * For FIT with external data, data is not loaded in this step.
Simon Glassa6131a22016-02-22 22:55:56 -0700632 */
Lokesh Vutlaf62cef12016-05-24 10:34:38 +0530633 sectors = get_aligned_image_size(info, size, 0);
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600634 buf = spl_get_fit_load_buffer(sectors * info->bl_len);
Ye Li9d5b0f42018-11-17 09:10:25 +0000635
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600636 count = info->read(info, sector, sectors, buf);
637 ctx->fit = buf;
638 debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
639 sector, sectors, buf, count, size);
Simon Glassa6131a22016-02-22 22:55:56 -0700640
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600641 return (count == 0) ? -EIO : 0;
642}
Andreas Dannenberg8d9f7f12019-06-04 17:55:46 -0500643
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600644static int spl_simple_fit_parse(struct spl_fit_info *ctx)
645{
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600646 /* Find the correct subnode under "/configurations" */
647 ctx->conf_node = fit_find_config_node(ctx->fit);
648 if (ctx->conf_node < 0)
649 return -EINVAL;
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100650
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600651 if (IS_ENABLED(CONFIG_SPL_FIT_SIGNATURE)) {
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100652 printf("## Checking hash(es) for config %s ... ",
Alexandru Gagniucfa11a442021-01-20 10:46:53 -0600653 fit_get_name(ctx->fit, ctx->conf_node, NULL));
654 if (fit_config_verify(ctx->fit, ctx->conf_node))
Philippe Reynes6c5c03c2020-10-29 18:50:29 +0100655 return -EPERM;
656 puts("OK\n");
657 }
658
Andre Przywara525e9c92017-04-26 01:32:34 +0100659 /* find the node holding the images information */
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600660 ctx->images_node = fdt_path_offset(ctx->fit, FIT_IMAGES_PATH);
661 if (ctx->images_node < 0) {
662 debug("%s: Cannot find /images node: %d\n", __func__,
663 ctx->images_node);
664 return -EINVAL;
Simon Glassa6131a22016-02-22 22:55:56 -0700665 }
Marek Vasut33dd00e2018-05-12 22:25:28 +0200666
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600667 return 0;
668}
669
670int spl_load_simple_fit(struct spl_image_info *spl_image,
671 struct spl_load_info *info, ulong sector, void *fit)
672{
673 struct spl_image_info image_info;
674 struct spl_fit_info ctx;
675 int node = -1;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600676 int ret;
Alexandru Gagniuc23243c92021-01-20 10:46:50 -0600677 int index = 0;
678 int firmware_node;
679
680 ret = spl_simple_fit_read(&ctx, info, sector, fit);
681 if (ret < 0)
682 return ret;
683
684 /* skip further processing if requested to enable load-only use cases */
685 if (spl_load_simple_fit_skip_processing())
686 return 0;
687
688 ret = spl_simple_fit_parse(&ctx);
689 if (ret < 0)
690 return ret;
691
Alexandru Gagniucec2a5742021-03-29 12:05:12 -0500692 if (IS_ENABLED(CONFIG_SPL_FPGA))
693 spl_fit_load_fpga(&ctx, info, sector);
Andre Przywara525e9c92017-04-26 01:32:34 +0100694
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200695 /*
696 * Find the U-Boot image using the following search order:
697 * - start at 'firmware' (e.g. an ARM Trusted Firmware)
698 * - fall back 'kernel' (e.g. a Falcon-mode OS boot
699 * - fall back to using the first 'loadables' entry
700 */
701 if (node < 0)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600702 node = spl_fit_get_image_node(&ctx, FIT_FIRMWARE_PROP, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600703
704 if (node < 0 && IS_ENABLED(CONFIG_SPL_OS_BOOT))
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600705 node = spl_fit_get_image_node(&ctx, FIT_KERNEL_PROP, 0);
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600706
Andre Przywara525e9c92017-04-26 01:32:34 +0100707 if (node < 0) {
708 debug("could not find firmware image, trying loadables...\n");
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600709 node = spl_fit_get_image_node(&ctx, "loadables", 0);
Andre Przywarae7c58562017-04-26 01:32:37 +0100710 /*
711 * If we pick the U-Boot image from "loadables", start at
712 * the second image when later loading additional images.
713 */
714 index = 1;
Andre Przywara525e9c92017-04-26 01:32:34 +0100715 }
Simon Glassa6131a22016-02-22 22:55:56 -0700716 if (node < 0) {
Andre Przywara525e9c92017-04-26 01:32:34 +0100717 debug("%s: Cannot find u-boot image node: %d\n",
718 __func__, node);
Simon Glassa6131a22016-02-22 22:55:56 -0700719 return -1;
720 }
721
Andre Przywara29053e92017-04-26 01:32:36 +0100722 /* Load the image and set up the spl_image structure */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600723 ret = spl_load_fit_image(info, sector, &ctx, node, spl_image);
Andre Przywara29053e92017-04-26 01:32:36 +0100724 if (ret)
725 return ret;
Daniel Allredcf839bd2016-06-27 09:19:21 -0500726
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200727 /*
728 * For backward compatibility, we treat the first node that is
729 * as a U-Boot image, if no OS-type has been declared.
730 */
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600731 if (!spl_fit_image_get_os(ctx.fit, node, &spl_image->os))
York Suna058b8a2017-08-15 11:14:45 -0700732 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600733 else if (!IS_ENABLED(CONFIG_SPL_OS_BOOT))
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200734 spl_image->os = IH_OS_U_BOOT;
Simon Glassa6131a22016-02-22 22:55:56 -0700735
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200736 /*
737 * Booting a next-stage U-Boot may require us to append the FDT.
738 * We allow this to fail, as the U-Boot image might embed its FDT.
739 */
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600740 if (os_takes_devicetree(spl_image->os)) {
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600741 ret = spl_fit_append_fdt(spl_image, info, sector, &ctx);
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600742 if (ret < 0 && spl_image->os != IH_OS_U_BOOT)
Dario Binacchifaf8d142020-05-27 13:56:19 +0200743 return ret;
744 }
Andre Przywarae7c58562017-04-26 01:32:37 +0100745
Jean-Jacques Hiblot776ce602019-10-22 16:39:10 +0200746 firmware_node = node;
Andre Przywarae7c58562017-04-26 01:32:37 +0100747 /* Now check if there are more images for us to load */
748 for (; ; index++) {
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200749 uint8_t os_type = IH_OS_INVALID;
750
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600751 node = spl_fit_get_image_node(&ctx, "loadables", index);
Andre Przywarae7c58562017-04-26 01:32:37 +0100752 if (node < 0)
753 break;
754
Jean-Jacques Hiblot776ce602019-10-22 16:39:10 +0200755 /*
756 * if the firmware is also a loadable, skip it because
757 * it already has been loaded. This is typically the case with
758 * u-boot.img generated by mkimage.
759 */
760 if (firmware_node == node)
761 continue;
762
Alexandru Gagniucc5236c32021-03-29 12:05:10 -0500763 image_info.load_addr = 0;
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600764 ret = spl_load_fit_image(info, sector, &ctx, node, &image_info);
Philippe Reynesba87da42020-11-24 16:15:05 +0100765 if (ret < 0) {
766 printf("%s: can't load image loadables index %d (ret = %d)\n",
767 __func__, index, ret);
768 return ret;
769 }
Andre Przywarae7c58562017-04-26 01:32:37 +0100770
Alexandru Gagniuc0df07592021-03-29 12:05:14 -0500771 if (spl_fit_image_is_fpga(ctx.fit, node))
772 spl_fit_upload_fpga(&ctx, node, &image_info);
773
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600774 if (!spl_fit_image_get_os(ctx.fit, node, &os_type))
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200775 debug("Loadable is %s\n", genimg_get_os_name(os_type));
776
Alexandru Gagniuc769ed252021-01-20 10:46:56 -0600777 if (os_takes_devicetree(os_type)) {
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600778 spl_fit_append_fdt(&image_info, info, sector, &ctx);
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200779 spl_image->fdt_addr = image_info.fdt_addr;
780 }
Philipp Tomsich1345ffa2017-09-13 21:29:32 +0200781
Andre Przywarae7c58562017-04-26 01:32:37 +0100782 /*
783 * If the "firmware" image did not provide an entry point,
784 * use the first valid entry point from the loadables.
785 */
786 if (spl_image->entry_point == FDT_ERROR &&
787 image_info.entry_point != FDT_ERROR)
788 spl_image->entry_point = image_info.entry_point;
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200789
790 /* Record our loadables into the FDT */
791 if (spl_image->fdt_addr)
Alexandru Gagniuc93d15572021-01-20 10:46:51 -0600792 spl_fit_record_loadable(&ctx, index,
Philipp Tomsiche61eff92017-09-13 21:29:34 +0200793 spl_image->fdt_addr,
794 &image_info);
Andre Przywarae7c58562017-04-26 01:32:37 +0100795 }
796
797 /*
798 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
799 * Makefile will set it to 0 and it will end up as the entry point
800 * here. What it actually means is: use the load address.
801 */
802 if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
803 spl_image->entry_point = spl_image->load_addr;
804
Ye Li9d5b0f42018-11-17 09:10:25 +0000805 spl_image->flags |= SPL_FIT_FOUND;
806
Alexandru Gagniuca4fed792021-01-20 10:46:55 -0600807 if (IS_ENABLED(CONFIG_IMX_HAB))
808 board_spl_fit_post_load(ctx.fit);
Ye Li9d5b0f42018-11-17 09:10:25 +0000809
Andre Przywarae7c58562017-04-26 01:32:37 +0100810 return 0;
Simon Glassa6131a22016-02-22 22:55:56 -0700811}