Merge branch 'master' of git://git.denx.de/u-boot-usb
[oweals/u-boot.git] / common / spl / spl_fit.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) 2016 Google, Inc
4  * Written by Simon Glass <sjg@chromium.org>
5  */
6
7 #include <common.h>
8 #include <errno.h>
9 #include <board.h>
10 #include <fpga.h>
11 #include <gzip.h>
12 #include <image.h>
13 #include <malloc.h>
14 #include <spl.h>
15 #include <linux/libfdt.h>
16
17 DECLARE_GLOBAL_DATA_PTR;
18
19 #ifndef CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
20 #define CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ (64 * 1024)
21 #endif
22
23 #ifndef CONFIG_SYS_BOOTM_LEN
24 #define CONFIG_SYS_BOOTM_LEN    (64 << 20)
25 #endif
26
27 __weak void board_spl_fit_post_load(ulong load_addr, size_t length)
28 {
29 }
30
31 __weak ulong board_spl_fit_size_align(ulong size)
32 {
33         return size;
34 }
35
36 static 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;
47                 const char *desc = fdt_getprop(fit, child, "description", &len);
48
49                 if (!desc)
50                         continue;
51
52                 if (!strcmp(desc, str))
53                         return child;
54         }
55
56         return -ENOENT;
57 }
58
59 /**
60  * spl_fit_get_image_name(): By using the matching configuration subnode,
61  * 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.
67  * @outname:    Name of the image
68  *
69  * Return:      0 on success, or a negative error number
70  */
71 static int spl_fit_get_image_name(const void *fit, int images,
72                                   const char *type, int index,
73                                   const char **outname)
74 {
75         struct udevice *board;
76         const char *name, *str;
77         __maybe_unused int node;
78         int conf_node;
79         int len, i;
80         bool found = true;
81
82         conf_node = fit_find_config_node(fit);
83         if (conf_node < 0) {
84 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
85                 printf("No matching DT out of these options:\n");
86                 for (node = fdt_first_subnode(fit, conf_node);
87                      node >= 0;
88                      node = fdt_next_subnode(fit, node)) {
89                         name = fdt_getprop(fit, node, "description", &len);
90                         printf("   %s\n", name);
91                 }
92 #endif
93                 return conf_node;
94         }
95
96         name = fdt_getprop(fit, conf_node, type, &len);
97         if (!name) {
98                 debug("cannot find property '%s': %d\n", type, len);
99                 return -EINVAL;
100         }
101
102         str = name;
103         for (i = 0; i < index; i++) {
104                 str = strchr(str, '\0') + 1;
105                 if (!str || (str - name >= len)) {
106                         found = false;
107                         break;
108                 }
109         }
110
111         if (!found && !board_get(&board)) {
112                 int rc;
113                 /*
114                  * no string in the property for this index. Check if the board
115                  * level code can supply one.
116                  */
117                 rc = board_get_fit_loadable(board, index - i - 1, type, &str);
118                 if (rc && rc != -ENOENT)
119                         return rc;
120
121                 if (!rc) {
122                         /*
123                          * The board provided a name for a loadable.
124                          * Try to match it against the description properties
125                          * first. If no matching node is found, use it as a
126                          * node name.
127                          */
128                         int node;
129                         int images = fdt_path_offset(fit, FIT_IMAGES_PATH);
130
131                         node = find_node_from_desc(fit, images, str);
132                         if (node > 0)
133                                 str = fdt_get_name(fit, node, NULL);
134
135                         found = true;
136                 }
137         }
138
139         if (!found) {
140                 debug("no string for index %d\n", index);
141                 return -E2BIG;
142         }
143
144         *outname = str;
145         return 0;
146 }
147
148 /**
149  * spl_fit_get_image_node(): By using the matching configuration subnode,
150  * retrieve the name of an image, specified by a property name and an index
151  * into that.
152  * @fit:        Pointer to the FDT blob.
153  * @images:     Offset of the /images subnode.
154  * @type:       Name of the property within the configuration subnode.
155  * @index:      Index into the list of strings in this property.
156  *
157  * Return:      the node offset of the respective image node or a negative
158  *              error number.
159  */
160 static int spl_fit_get_image_node(const void *fit, int images,
161                                   const char *type, int index)
162 {
163         const char *str;
164         int err;
165         int node;
166
167         err = spl_fit_get_image_name(fit, images, type, index, &str);
168         if (err)
169                 return err;
170
171         debug("%s: '%s'\n", type, str);
172
173         node = fdt_subnode_offset(fit, images, str);
174         if (node < 0) {
175                 pr_err("cannot find image node '%s': %d\n", str, node);
176                 return -EINVAL;
177         }
178
179         return node;
180 }
181
182 static int get_aligned_image_offset(struct spl_load_info *info, int offset)
183 {
184         /*
185          * If it is a FS read, get the first address before offset which is
186          * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
187          * block number to which offset belongs.
188          */
189         if (info->filename)
190                 return offset & ~(ARCH_DMA_MINALIGN - 1);
191
192         return offset / info->bl_len;
193 }
194
195 static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
196 {
197         /*
198          * If it is a FS read, get the difference between the offset and
199          * the first address before offset which is aligned to
200          * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
201          * block.
202          */
203         if (info->filename)
204                 return offset & (ARCH_DMA_MINALIGN - 1);
205
206         return offset % info->bl_len;
207 }
208
209 static int get_aligned_image_size(struct spl_load_info *info, int data_size,
210                                   int offset)
211 {
212         data_size = data_size + get_aligned_image_overhead(info, offset);
213
214         if (info->filename)
215                 return data_size;
216
217         return (data_size + info->bl_len - 1) / info->bl_len;
218 }
219
220 /**
221  * spl_load_fit_image(): load the image described in a certain FIT node
222  * @info:       points to information about the device to load data from
223  * @sector:     the start sector of the FIT image on the device
224  * @fit:        points to the flattened device tree blob describing the FIT
225  *              image
226  * @base_offset: the beginning of the data area containing the actual
227  *              image data, relative to the beginning of the FIT
228  * @node:       offset of the DT node describing the image to load (relative
229  *              to @fit)
230  * @image_info: will be filled with information about the loaded image
231  *              If the FIT node does not contain a "load" (address) property,
232  *              the image gets loaded to the address pointed to by the
233  *              load_addr member in this struct.
234  *
235  * Return:      0 on success or a negative error number.
236  */
237 static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
238                               void *fit, ulong base_offset, int node,
239                               struct spl_image_info *image_info)
240 {
241         int offset;
242         size_t length;
243         int len;
244         ulong size;
245         ulong load_addr, load_ptr;
246         void *src;
247         ulong overhead;
248         int nr_sectors;
249         int align_len = ARCH_DMA_MINALIGN - 1;
250         uint8_t image_comp = -1, type = -1;
251         const void *data;
252         bool external_data = false;
253
254         if (IS_ENABLED(CONFIG_SPL_FPGA_SUPPORT) ||
255             (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP))) {
256                 if (fit_image_get_type(fit, node, &type))
257                         puts("Cannot get image type.\n");
258                 else
259                         debug("%s ", genimg_get_type_name(type));
260         }
261
262         if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) {
263                 if (fit_image_get_comp(fit, node, &image_comp))
264                         puts("Cannot get image compression format.\n");
265                 else
266                         debug("%s ", genimg_get_comp_name(image_comp));
267         }
268
269         if (fit_image_get_load(fit, node, &load_addr))
270                 load_addr = image_info->load_addr;
271
272         if (!fit_image_get_data_position(fit, node, &offset)) {
273                 external_data = true;
274         } else if (!fit_image_get_data_offset(fit, node, &offset)) {
275                 offset += base_offset;
276                 external_data = true;
277         }
278
279         if (external_data) {
280                 /* External data */
281                 if (fit_image_get_data_size(fit, node, &len))
282                         return -ENOENT;
283
284                 load_ptr = (load_addr + align_len) & ~align_len;
285                 length = len;
286
287                 overhead = get_aligned_image_overhead(info, offset);
288                 nr_sectors = get_aligned_image_size(info, length, offset);
289
290                 if (info->read(info,
291                                sector + get_aligned_image_offset(info, offset),
292                                nr_sectors, (void *)load_ptr) != nr_sectors)
293                         return -EIO;
294
295                 debug("External data: dst=%lx, offset=%x, size=%lx\n",
296                       load_ptr, offset, (unsigned long)length);
297                 src = (void *)load_ptr + overhead;
298         } else {
299                 /* Embedded data */
300                 if (fit_image_get_data(fit, node, &data, &length)) {
301                         puts("Cannot get image data/size\n");
302                         return -ENOENT;
303                 }
304                 debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
305                       (unsigned long)length);
306                 src = (void *)data;
307         }
308
309 #ifdef CONFIG_SPL_FIT_SIGNATURE
310         printf("## Checking hash(es) for Image %s ... ",
311                fit_get_name(fit, node, NULL));
312         if (!fit_image_verify_with_data(fit, node,
313                                          src, length))
314                 return -EPERM;
315         puts("OK\n");
316 #endif
317
318 #ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
319         board_fit_image_post_process(&src, &length);
320 #endif
321
322         if (IS_ENABLED(CONFIG_SPL_GZIP) && image_comp == IH_COMP_GZIP) {
323                 size = length;
324                 if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
325                            src, &size)) {
326                         puts("Uncompressing error\n");
327                         return -EIO;
328                 }
329                 length = size;
330         } else {
331                 memcpy((void *)load_addr, src, length);
332         }
333
334         if (image_info) {
335                 image_info->load_addr = load_addr;
336                 image_info->size = length;
337                 image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
338         }
339
340         return 0;
341 }
342
343 static int spl_fit_append_fdt(struct spl_image_info *spl_image,
344                               struct spl_load_info *info, ulong sector,
345                               void *fit, int images, ulong base_offset)
346 {
347         struct spl_image_info image_info;
348         int node, ret = 0, index = 0;
349
350         /*
351          * Use the address following the image as target address for the
352          * device tree.
353          */
354         image_info.load_addr = spl_image->load_addr + spl_image->size;
355
356         /* Figure out which device tree the board wants to use */
357         node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, index++);
358         if (node < 0) {
359                 debug("%s: cannot find FDT node\n", __func__);
360
361                 /*
362                  * U-Boot did not find a device tree inside the FIT image. Use
363                  * the U-Boot device tree instead.
364                  */
365                 if (gd->fdt_blob)
366                         memcpy((void *)image_info.load_addr, gd->fdt_blob,
367                                fdt_totalsize(gd->fdt_blob));
368                 else
369                         return node;
370         } else {
371                 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
372                                          &image_info);
373                 if (ret < 0)
374                         return ret;
375         }
376
377         /* Make the load-address of the FDT available for the SPL framework */
378         spl_image->fdt_addr = (void *)image_info.load_addr;
379 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
380         if (CONFIG_IS_ENABLED(LOAD_FIT_APPLY_OVERLAY)) {
381                 void *tmpbuffer = NULL;
382
383                 for (; ; index++) {
384                         node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP,
385                                                       index);
386                         if (node == -E2BIG) {
387                                 debug("%s: No additional FDT node\n", __func__);
388                                 break;
389                         } else if (node < 0) {
390                                 debug("%s: unable to find FDT node %d\n",
391                                       __func__, index);
392                                 continue;
393                         }
394
395                         if (!tmpbuffer) {
396                                 /*
397                                  * allocate memory to store the DT overlay
398                                  * before it is applied. It may not be used
399                                  * depending on how the overlay is stored, so
400                                  * don't fail yet if the allocation failed.
401                                  */
402                                 tmpbuffer = malloc(CONFIG_SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ);
403                                 if (!tmpbuffer)
404                                         debug("%s: unable to allocate space for overlays\n",
405                                               __func__);
406                         }
407                         image_info.load_addr = (ulong)tmpbuffer;
408                         ret = spl_load_fit_image(info, sector, fit, base_offset,
409                                                  node, &image_info);
410                         if (ret < 0)
411                                 break;
412
413                         /* Make room in FDT for changes from the overlay */
414                         ret = fdt_increase_size(spl_image->fdt_addr,
415                                                 image_info.size);
416                         if (ret < 0)
417                                 break;
418
419                         ret = fdt_overlay_apply_verbose(spl_image->fdt_addr,
420                                                         (void *)image_info.load_addr);
421                         if (ret) {
422                                 pr_err("failed to apply DT overlay %s\n",
423                                        fit_get_name(fit, node, NULL));
424                                 break;
425                         }
426
427                         debug("%s: DT overlay %s applied\n", __func__,
428                               fit_get_name(fit, node, NULL));
429                 }
430                 if (tmpbuffer)
431                         free(tmpbuffer);
432                 if (ret)
433                         return ret;
434         }
435         /* Try to make space, so we can inject details on the loadables */
436         ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
437         if (ret < 0)
438                 return ret;
439 #endif
440
441         return ret;
442 }
443
444 static int spl_fit_record_loadable(const void *fit, int images, int index,
445                                    void *blob, struct spl_image_info *image)
446 {
447         int ret = 0;
448 #if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
449         const char *name;
450         int node;
451
452         ret = spl_fit_get_image_name(fit, images, "loadables",
453                                      index, &name);
454         if (ret < 0)
455                 return ret;
456
457         node = spl_fit_get_image_node(fit, images, "loadables", index);
458
459         ret = fdt_record_loadable(blob, index, name, image->load_addr,
460                                   image->size, image->entry_point,
461                                   fdt_getprop(fit, node, "type", NULL),
462                                   fdt_getprop(fit, node, "os", NULL));
463 #endif
464         return ret;
465 }
466
467 static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
468 {
469 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY) && !defined(CONFIG_SPL_OS_BOOT)
470         return -ENOTSUPP;
471 #else
472         return fit_image_get_os(fit, noffset, os);
473 #endif
474 }
475
476 /*
477  * Weak default function to allow customizing SPL fit loading for load-only
478  * use cases by allowing to skip the parsing/processing of the FIT contents
479  * (so that this can be done separately in a more customized fashion)
480  */
481 __weak bool spl_load_simple_fit_skip_processing(void)
482 {
483         return false;
484 }
485
486 int spl_load_simple_fit(struct spl_image_info *spl_image,
487                         struct spl_load_info *info, ulong sector, void *fit)
488 {
489         int sectors;
490         ulong size;
491         unsigned long count;
492         struct spl_image_info image_info;
493         int node = -1;
494         int images, ret;
495         int base_offset, hsize, align_len = ARCH_DMA_MINALIGN - 1;
496         int index = 0;
497         int firmware_node;
498
499         /*
500          * For FIT with external data, figure out where the external images
501          * start. This is the base for the data-offset properties in each
502          * image.
503          */
504         size = fdt_totalsize(fit);
505         size = (size + 3) & ~3;
506         size = board_spl_fit_size_align(size);
507         base_offset = (size + 3) & ~3;
508
509         /*
510          * So far we only have one block of data from the FIT. Read the entire
511          * thing, including that first block, placing it so it finishes before
512          * where we will load the image.
513          *
514          * Note that we will load the image such that its first byte will be
515          * at the load address. Since that byte may be part-way through a
516          * block, we may load the image up to one block before the load
517          * address. So take account of that here by subtracting an addition
518          * block length from the FIT start position.
519          *
520          * In fact the FIT has its own load address, but we assume it cannot
521          * be before CONFIG_SYS_TEXT_BASE.
522          *
523          * For FIT with data embedded, data is loaded as part of FIT image.
524          * For FIT with external data, data is not loaded in this step.
525          */
526         hsize = (size + info->bl_len + align_len) & ~align_len;
527         fit = spl_get_load_buffer(-hsize, hsize);
528         sectors = get_aligned_image_size(info, size, 0);
529         count = info->read(info, sector, sectors, fit);
530         debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu, size=0x%lx\n",
531               sector, sectors, fit, count, size);
532
533         if (count == 0)
534                 return -EIO;
535
536         /* skip further processing if requested to enable load-only use cases */
537         if (spl_load_simple_fit_skip_processing())
538                 return 0;
539
540         /* find the node holding the images information */
541         images = fdt_path_offset(fit, FIT_IMAGES_PATH);
542         if (images < 0) {
543                 debug("%s: Cannot find /images node: %d\n", __func__, images);
544                 return -1;
545         }
546
547 #ifdef CONFIG_SPL_FPGA_SUPPORT
548         node = spl_fit_get_image_node(fit, images, "fpga", 0);
549         if (node >= 0) {
550                 /* Load the image and set up the spl_image structure */
551                 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
552                                          spl_image);
553                 if (ret) {
554                         printf("%s: Cannot load the FPGA: %i\n", __func__, ret);
555                         return ret;
556                 }
557
558                 debug("FPGA bitstream at: %x, size: %x\n",
559                       (u32)spl_image->load_addr, spl_image->size);
560
561                 ret = fpga_load(0, (const void *)spl_image->load_addr,
562                                 spl_image->size, BIT_FULL);
563                 if (ret) {
564                         printf("%s: Cannot load the image to the FPGA\n",
565                                __func__);
566                         return ret;
567                 }
568
569                 puts("FPGA image loaded from FIT\n");
570                 node = -1;
571         }
572 #endif
573
574         /*
575          * Find the U-Boot image using the following search order:
576          *   - start at 'firmware' (e.g. an ARM Trusted Firmware)
577          *   - fall back 'kernel' (e.g. a Falcon-mode OS boot
578          *   - fall back to using the first 'loadables' entry
579          */
580         if (node < 0)
581                 node = spl_fit_get_image_node(fit, images, FIT_FIRMWARE_PROP,
582                                               0);
583 #ifdef CONFIG_SPL_OS_BOOT
584         if (node < 0)
585                 node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0);
586 #endif
587         if (node < 0) {
588                 debug("could not find firmware image, trying loadables...\n");
589                 node = spl_fit_get_image_node(fit, images, "loadables", 0);
590                 /*
591                  * If we pick the U-Boot image from "loadables", start at
592                  * the second image when later loading additional images.
593                  */
594                 index = 1;
595         }
596         if (node < 0) {
597                 debug("%s: Cannot find u-boot image node: %d\n",
598                       __func__, node);
599                 return -1;
600         }
601
602         /* Load the image and set up the spl_image structure */
603         ret = spl_load_fit_image(info, sector, fit, base_offset, node,
604                                  spl_image);
605         if (ret)
606                 return ret;
607
608         /*
609          * For backward compatibility, we treat the first node that is
610          * as a U-Boot image, if no OS-type has been declared.
611          */
612         if (!spl_fit_image_get_os(fit, node, &spl_image->os))
613                 debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
614 #if !defined(CONFIG_SPL_OS_BOOT)
615         else
616                 spl_image->os = IH_OS_U_BOOT;
617 #endif
618
619         /*
620          * Booting a next-stage U-Boot may require us to append the FDT.
621          * We allow this to fail, as the U-Boot image might embed its FDT.
622          */
623         if (spl_image->os == IH_OS_U_BOOT)
624                 spl_fit_append_fdt(spl_image, info, sector, fit,
625                                    images, base_offset);
626
627         firmware_node = node;
628         /* Now check if there are more images for us to load */
629         for (; ; index++) {
630                 uint8_t os_type = IH_OS_INVALID;
631
632                 node = spl_fit_get_image_node(fit, images, "loadables", index);
633                 if (node < 0)
634                         break;
635
636                 /*
637                  * if the firmware is also a loadable, skip it because
638                  * it already has been loaded. This is typically the case with
639                  * u-boot.img generated by mkimage.
640                  */
641                 if (firmware_node == node)
642                         continue;
643
644                 ret = spl_load_fit_image(info, sector, fit, base_offset, node,
645                                          &image_info);
646                 if (ret < 0)
647                         continue;
648
649                 if (!spl_fit_image_get_os(fit, node, &os_type))
650                         debug("Loadable is %s\n", genimg_get_os_name(os_type));
651 #if CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
652                 else
653                         os_type = IH_OS_U_BOOT;
654 #endif
655
656                 if (os_type == IH_OS_U_BOOT) {
657                         spl_fit_append_fdt(&image_info, info, sector,
658                                            fit, images, base_offset);
659                         spl_image->fdt_addr = image_info.fdt_addr;
660                 }
661
662                 /*
663                  * If the "firmware" image did not provide an entry point,
664                  * use the first valid entry point from the loadables.
665                  */
666                 if (spl_image->entry_point == FDT_ERROR &&
667                     image_info.entry_point != FDT_ERROR)
668                         spl_image->entry_point = image_info.entry_point;
669
670                 /* Record our loadables into the FDT */
671                 if (spl_image->fdt_addr)
672                         spl_fit_record_loadable(fit, images, index,
673                                                 spl_image->fdt_addr,
674                                                 &image_info);
675         }
676
677         /*
678          * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
679          * Makefile will set it to 0 and it will end up as the entry point
680          * here. What it actually means is: use the load address.
681          */
682         if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
683                 spl_image->entry_point = spl_image->load_addr;
684
685         spl_image->flags |= SPL_FIT_FOUND;
686
687 #ifdef CONFIG_IMX_HAB
688         board_spl_fit_post_load((ulong)fit, size);
689 #endif
690
691         return 0;
692 }