Merge tag 'efi-2020-07-rc6' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / common / spl / spl.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2010
4  * Texas Instruments, <www.ti.com>
5  *
6  * Aneesh V <aneesh@ti.com>
7  */
8
9 #include <common.h>
10 #include <bloblist.h>
11 #include <binman_sym.h>
12 #include <bootstage.h>
13 #include <dm.h>
14 #include <handoff.h>
15 #include <hang.h>
16 #include <init.h>
17 #include <irq_func.h>
18 #include <log.h>
19 #include <serial.h>
20 #include <spl.h>
21 #include <asm/u-boot.h>
22 #include <nand.h>
23 #include <fat.h>
24 #include <u-boot/crc.h>
25 #include <version.h>
26 #include <image.h>
27 #include <malloc.h>
28 #include <mapmem.h>
29 #include <dm/root.h>
30 #include <linux/compiler.h>
31 #include <fdt_support.h>
32 #include <bootcount.h>
33 #include <wdt.h>
34
35 DECLARE_GLOBAL_DATA_PTR;
36
37 #ifndef CONFIG_SYS_UBOOT_START
38 #define CONFIG_SYS_UBOOT_START  CONFIG_SYS_TEXT_BASE
39 #endif
40 #ifndef CONFIG_SYS_MONITOR_LEN
41 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */
42 #define CONFIG_SYS_MONITOR_LEN  (200 * 1024)
43 #endif
44
45 u32 *boot_params_ptr = NULL;
46
47 /* See spl.h for information about this */
48 binman_sym_declare(ulong, u_boot_any, image_pos);
49 binman_sym_declare(ulong, u_boot_any, size);
50
51 #ifdef CONFIG_TPL
52 binman_sym_declare(ulong, spl, image_pos);
53 binman_sym_declare(ulong, spl, size);
54 #endif
55
56 /* Define board data structure */
57 static bd_t bdata __attribute__ ((section(".data")));
58
59 /*
60  * Board-specific Platform code can reimplement show_boot_progress () if needed
61  */
62 __weak void show_boot_progress(int val) {}
63
64 #if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) || \
65         defined(CONFIG_SPL_ATF)
66 /* weak, default platform-specific function to initialize dram banks */
67 __weak int dram_init_banksize(void)
68 {
69         return 0;
70 }
71 #endif
72
73 /*
74  * Default function to determine if u-boot or the OS should
75  * be started. This implementation always returns 1.
76  *
77  * Please implement your own board specific funcion to do this.
78  *
79  * RETURN
80  * 0 to not start u-boot
81  * positive if u-boot should start
82  */
83 #ifdef CONFIG_SPL_OS_BOOT
84 __weak int spl_start_uboot(void)
85 {
86         puts(SPL_TPL_PROMPT
87              "Please implement spl_start_uboot() for your board\n");
88         puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
89         return 1;
90 }
91
92 /*
93  * Weak default function for arch specific zImage check. Return zero
94  * and fill start and end address if image is recognized.
95  */
96 int __weak bootz_setup(ulong image, ulong *start, ulong *end)
97 {
98          return 1;
99 }
100 #endif
101
102 /* Weak default function for arch/board-specific fixups to the spl_image_info */
103 void __weak spl_perform_fixups(struct spl_image_info *spl_image)
104 {
105 }
106
107 void spl_fixup_fdt(void *fdt_blob)
108 {
109 #if defined(CONFIG_SPL_OF_LIBFDT)
110         int err;
111
112         if (!fdt_blob)
113                 return;
114
115         err = fdt_check_header(fdt_blob);
116         if (err < 0) {
117                 printf("fdt_root: %s\n", fdt_strerror(err));
118                 return;
119         }
120
121         /* fixup the memory dt node */
122         err = fdt_shrink_to_minimum(fdt_blob, 0);
123         if (err == 0) {
124                 printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
125                 return;
126         }
127
128         err = arch_fixup_fdt(fdt_blob);
129         if (err) {
130                 printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
131                 return;
132         }
133 #endif
134 }
135
136 ulong spl_get_image_pos(void)
137 {
138         return spl_phase() == PHASE_TPL ?
139                 binman_sym(ulong, spl, image_pos) :
140                 binman_sym(ulong, u_boot_any, image_pos);
141 }
142
143 ulong spl_get_image_size(void)
144 {
145         return spl_phase() == PHASE_TPL ?
146                 binman_sym(ulong, spl, size) :
147                 binman_sym(ulong, u_boot_any, size);
148 }
149
150 /*
151  * Weak default function for board specific cleanup/preparation before
152  * Linux boot. Some boards/platforms might not need it, so just provide
153  * an empty stub here.
154  */
155 __weak void spl_board_prepare_for_linux(void)
156 {
157         /* Nothing to do! */
158 }
159
160 __weak void spl_board_prepare_for_boot(void)
161 {
162         /* Nothing to do! */
163 }
164
165 __weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
166 {
167         return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
168 }
169
170 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
171 {
172         ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
173
174         spl_image->size = CONFIG_SYS_MONITOR_LEN;
175
176         /*
177          * Binman error cases: address of the end of the previous region or the
178          * start of the image's entry area (usually 0) if there is no previous
179          * region.
180          */
181         if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
182                 /* Binman does not support separated entry addresses */
183                 spl_image->entry_point = u_boot_pos;
184                 spl_image->load_addr = u_boot_pos;
185         } else {
186                 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
187                 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
188         }
189         spl_image->os = IH_OS_U_BOOT;
190         spl_image->name = "U-Boot";
191 }
192
193 #ifdef CONFIG_SPL_LOAD_FIT_FULL
194 /* Parse and load full fitImage in SPL */
195 static int spl_load_fit_image(struct spl_image_info *spl_image,
196                               const struct image_header *header)
197 {
198         bootm_headers_t images;
199         const char *fit_uname_config = NULL;
200         const char *fit_uname_fdt = FIT_FDT_PROP;
201         const char *uname;
202         ulong fw_data = 0, dt_data = 0, img_data = 0;
203         ulong fw_len = 0, dt_len = 0, img_len = 0;
204         int idx, conf_noffset;
205         int ret;
206
207 #ifdef CONFIG_SPL_FIT_SIGNATURE
208         images.verify = 1;
209 #endif
210         ret = fit_image_load(&images, (ulong)header,
211                              NULL, &fit_uname_config,
212                              IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
213                              FIT_LOAD_REQUIRED, &fw_data, &fw_len);
214         if (ret < 0)
215                 return ret;
216
217         spl_image->size = fw_len;
218         spl_image->entry_point = fw_data;
219         spl_image->load_addr = fw_data;
220         spl_image->os = IH_OS_U_BOOT;
221         spl_image->name = "U-Boot";
222
223         debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
224               spl_image->name, spl_image->load_addr, spl_image->size);
225
226 #ifdef CONFIG_SPL_FIT_SIGNATURE
227         images.verify = 1;
228 #endif
229         ret = fit_image_load(&images, (ulong)header,
230                        &fit_uname_fdt, &fit_uname_config,
231                        IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
232                        FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
233         if (ret >= 0)
234                 spl_image->fdt_addr = (void *)dt_data;
235
236         conf_noffset = fit_conf_get_node((const void *)header,
237                                          fit_uname_config);
238         if (conf_noffset <= 0)
239                 return 0;
240
241         for (idx = 0;
242              uname = fdt_stringlist_get((const void *)header, conf_noffset,
243                                         FIT_LOADABLE_PROP, idx,
244                                 NULL), uname;
245              idx++)
246         {
247 #ifdef CONFIG_SPL_FIT_SIGNATURE
248                 images.verify = 1;
249 #endif
250                 ret = fit_image_load(&images, (ulong)header,
251                                      &uname, &fit_uname_config,
252                                      IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
253                                      FIT_LOAD_OPTIONAL_NON_ZERO,
254                                      &img_data, &img_len);
255                 if (ret < 0)
256                         return ret;
257         }
258
259         return 0;
260 }
261 #endif
262
263 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
264                                    const struct image_header *header)
265 {
266         /* LEGACY image not supported */
267         debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
268         return -EINVAL;
269 }
270
271 int spl_parse_image_header(struct spl_image_info *spl_image,
272                            const struct image_header *header)
273 {
274 #ifdef CONFIG_SPL_LOAD_FIT_FULL
275         int ret = spl_load_fit_image(spl_image, header);
276
277         if (!ret)
278                 return ret;
279 #endif
280         if (image_get_magic(header) == IH_MAGIC) {
281                 int ret;
282
283                 ret = spl_parse_legacy_header(spl_image, header);
284                 if (ret)
285                         return ret;
286         } else {
287 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
288                 /*
289                  * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
290                  * code which loads images in SPL cannot guarantee that
291                  * absolutely all read errors will be reported.
292                  * An example is the LPC32XX MLC NAND driver, which
293                  * will consider that a completely unreadable NAND block
294                  * is bad, and thus should be skipped silently.
295                  */
296                 panic("** no mkimage signature but raw image not supported");
297 #endif
298
299 #ifdef CONFIG_SPL_OS_BOOT
300                 ulong start, end;
301
302                 if (!bootz_setup((ulong)header, &start, &end)) {
303                         spl_image->name = "Linux";
304                         spl_image->os = IH_OS_LINUX;
305                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
306                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
307                         spl_image->size = end - start;
308                         debug(SPL_TPL_PROMPT
309                               "payload zImage, load addr: 0x%lx size: %d\n",
310                               spl_image->load_addr, spl_image->size);
311                         return 0;
312                 }
313 #endif
314
315 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
316                 /* Signature not found - assume u-boot.bin */
317                 debug("mkimage signature not found - ih_magic = %x\n",
318                         header->ih_magic);
319                 spl_set_header_raw_uboot(spl_image);
320 #else
321                 /* RAW image not supported, proceed to other boot methods. */
322                 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
323                 return -EINVAL;
324 #endif
325         }
326
327         return 0;
328 }
329
330 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
331 {
332         typedef void __noreturn (*image_entry_noargs_t)(void);
333
334         image_entry_noargs_t image_entry =
335                 (image_entry_noargs_t)spl_image->entry_point;
336
337         debug("image entry point: 0x%lx\n", spl_image->entry_point);
338         image_entry();
339 }
340
341 #if CONFIG_IS_ENABLED(HANDOFF)
342 /**
343  * Set up the SPL hand-off information
344  *
345  * This is initially empty (zero) but can be written by
346  */
347 static int setup_spl_handoff(void)
348 {
349         struct spl_handoff *ho;
350
351         ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
352         if (!ho)
353                 return -ENOENT;
354
355         return 0;
356 }
357
358 __weak int handoff_arch_save(struct spl_handoff *ho)
359 {
360         return 0;
361 }
362
363 static int write_spl_handoff(void)
364 {
365         struct spl_handoff *ho;
366         int ret;
367
368         ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
369         if (!ho)
370                 return -ENOENT;
371         handoff_save_dram(ho);
372         ret = handoff_arch_save(ho);
373         if (ret)
374                 return ret;
375         debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
376
377         return 0;
378 }
379 #else
380 static inline int setup_spl_handoff(void) { return 0; }
381 static inline int write_spl_handoff(void) { return 0; }
382
383 #endif /* HANDOFF */
384
385 static int spl_common_init(bool setup_malloc)
386 {
387         int ret;
388
389 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
390         if (setup_malloc) {
391 #ifdef CONFIG_MALLOC_F_ADDR
392                 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
393 #endif
394                 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
395                 gd->malloc_ptr = 0;
396         }
397 #endif
398         ret = bootstage_init(u_boot_first_phase());
399         if (ret) {
400                 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
401                       ret);
402                 return ret;
403         }
404 #ifdef CONFIG_BOOTSTAGE_STASH
405         if (!u_boot_first_phase()) {
406                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
407                                                CONFIG_BOOTSTAGE_STASH_SIZE);
408
409                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
410                 if (ret)
411                         debug("%s: Failed to unstash bootstage: ret=%d\n",
412                               __func__, ret);
413         }
414 #endif /* CONFIG_BOOTSTAGE_STASH */
415         bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_START_TPL :
416                             BOOTSTAGE_ID_START_SPL, SPL_TPL_NAME);
417 #if CONFIG_IS_ENABLED(LOG)
418         ret = log_init();
419         if (ret) {
420                 debug("%s: Failed to set up logging\n", __func__);
421                 return ret;
422         }
423 #endif
424         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
425                 ret = fdtdec_setup();
426                 if (ret) {
427                         debug("fdtdec_setup() returned error %d\n", ret);
428                         return ret;
429                 }
430         }
431         if (CONFIG_IS_ENABLED(DM)) {
432                 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
433                                 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
434                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
435                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
436                 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
437                 if (ret) {
438                         debug("dm_init_and_scan() returned error %d\n", ret);
439                         return ret;
440                 }
441         }
442
443         return 0;
444 }
445
446 void spl_set_bd(void)
447 {
448         /*
449          * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
450          * writeable.
451          */
452         if (!gd->bd)
453                 gd->bd = &bdata;
454 }
455
456 int spl_early_init(void)
457 {
458         int ret;
459
460         debug("%s\n", __func__);
461
462         ret = spl_common_init(true);
463         if (ret)
464                 return ret;
465         gd->flags |= GD_FLG_SPL_EARLY_INIT;
466
467         return 0;
468 }
469
470 int spl_init(void)
471 {
472         int ret;
473         bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
474                         IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
475
476         debug("%s\n", __func__);
477
478         if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
479                 ret = spl_common_init(setup_malloc);
480                 if (ret)
481                         return ret;
482         }
483         gd->flags |= GD_FLG_SPL_INIT;
484
485         return 0;
486 }
487
488 #ifndef BOOT_DEVICE_NONE
489 #define BOOT_DEVICE_NONE 0xdeadbeef
490 #endif
491
492 __weak void board_boot_order(u32 *spl_boot_list)
493 {
494         spl_boot_list[0] = spl_boot_device();
495 }
496
497 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
498 {
499         struct spl_image_loader *drv =
500                 ll_entry_start(struct spl_image_loader, spl_image_loader);
501         const int n_ents =
502                 ll_entry_count(struct spl_image_loader, spl_image_loader);
503         struct spl_image_loader *entry;
504
505         for (entry = drv; entry != drv + n_ents; entry++) {
506                 if (boot_device == entry->boot_device)
507                         return entry;
508         }
509
510         /* Not found */
511         return NULL;
512 }
513
514 static int spl_load_image(struct spl_image_info *spl_image,
515                           struct spl_image_loader *loader)
516 {
517         int ret;
518         struct spl_boot_device bootdev;
519
520         bootdev.boot_device = loader->boot_device;
521         bootdev.boot_device_name = NULL;
522
523         ret = loader->load_image(spl_image, &bootdev);
524 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
525         if (!ret && spl_image->dcrc_length) {
526                 /* check data crc */
527                 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
528                                       spl_image->dcrc_length, CHUNKSZ_CRC32);
529                 if (dcrc != spl_image->dcrc) {
530                         puts("SPL: Image data CRC check failed!\n");
531                         ret = -EINVAL;
532                 }
533         }
534 #endif
535         return ret;
536 }
537
538 /**
539  * boot_from_devices() - Try loading a booting U-Boot from a list of devices
540  *
541  * @spl_image: Place to put the image details if successful
542  * @spl_boot_list: List of boot devices to try
543  * @count: Number of elements in spl_boot_list
544  * @return 0 if OK, -ve on error
545  */
546 static int boot_from_devices(struct spl_image_info *spl_image,
547                              u32 spl_boot_list[], int count)
548 {
549         int i;
550
551         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
552                 struct spl_image_loader *loader;
553
554                 loader = spl_ll_find_loader(spl_boot_list[i]);
555 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
556                 if (loader)
557                         printf("Trying to boot from %s\n", loader->name);
558                 else
559                         puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
560 #endif
561                 if (loader && !spl_load_image(spl_image, loader)) {
562                         spl_image->boot_device = spl_boot_list[i];
563                         return 0;
564                 }
565         }
566
567         return -ENODEV;
568 }
569
570 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
571 void board_init_f(ulong dummy)
572 {
573         if (CONFIG_IS_ENABLED(OF_CONTROL)) {
574                 int ret;
575
576                 ret = spl_early_init();
577                 if (ret) {
578                         debug("spl_early_init() failed: %d\n", ret);
579                         hang();
580                 }
581         }
582
583         preloader_console_init();
584 }
585 #endif
586
587 void board_init_r(gd_t *dummy1, ulong dummy2)
588 {
589         u32 spl_boot_list[] = {
590                 BOOT_DEVICE_NONE,
591                 BOOT_DEVICE_NONE,
592                 BOOT_DEVICE_NONE,
593                 BOOT_DEVICE_NONE,
594                 BOOT_DEVICE_NONE,
595         };
596         struct spl_image_info spl_image;
597         int ret;
598
599         debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
600
601         spl_set_bd();
602
603 #if defined(CONFIG_SYS_SPL_MALLOC_START)
604         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
605                         CONFIG_SYS_SPL_MALLOC_SIZE);
606         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
607 #endif
608         if (!(gd->flags & GD_FLG_SPL_INIT)) {
609                 if (spl_init())
610                         hang();
611         }
612 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
613         /*
614          * timer_init() does not exist on PPC systems. The timer is initialized
615          * and enabled (decrementer) in interrupt_init() here.
616          */
617         timer_init();
618 #endif
619         if (CONFIG_IS_ENABLED(BLOBLIST)) {
620                 ret = bloblist_init();
621                 if (ret) {
622                         debug("%s: Failed to set up bloblist: ret=%d\n",
623                               __func__, ret);
624                         puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
625                         hang();
626                 }
627         }
628         if (CONFIG_IS_ENABLED(HANDOFF)) {
629                 int ret;
630
631                 ret = setup_spl_handoff();
632                 if (ret) {
633                         puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
634                         hang();
635                 }
636         }
637
638 #if CONFIG_IS_ENABLED(BOARD_INIT)
639         spl_board_init();
640 #endif
641
642 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
643         initr_watchdog();
644 #endif
645
646         if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
647             IS_ENABLED(CONFIG_SPL_ATF))
648                 dram_init_banksize();
649
650         bootcount_inc();
651
652         memset(&spl_image, '\0', sizeof(spl_image));
653 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
654         spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
655 #endif
656         spl_image.boot_device = BOOT_DEVICE_NONE;
657         board_boot_order(spl_boot_list);
658
659         if (boot_from_devices(&spl_image, spl_boot_list,
660                               ARRAY_SIZE(spl_boot_list))) {
661                 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
662                 hang();
663         }
664
665         spl_perform_fixups(&spl_image);
666         if (CONFIG_IS_ENABLED(HANDOFF)) {
667                 ret = write_spl_handoff();
668                 if (ret)
669                         printf(SPL_TPL_PROMPT
670                                "SPL hand-off write failed (err=%d)\n", ret);
671         }
672         if (CONFIG_IS_ENABLED(BLOBLIST)) {
673                 ret = bloblist_finish();
674                 if (ret)
675                         printf("Warning: Failed to finish bloblist (ret=%d)\n",
676                                ret);
677         }
678
679 #ifdef CONFIG_CPU_V7M
680         spl_image.entry_point |= 0x1;
681 #endif
682         switch (spl_image.os) {
683         case IH_OS_U_BOOT:
684                 debug("Jumping to U-Boot\n");
685                 break;
686 #if CONFIG_IS_ENABLED(ATF)
687         case IH_OS_ARM_TRUSTED_FIRMWARE:
688                 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
689                 spl_fixup_fdt(spl_image.fdt_addr);
690                 spl_invoke_atf(&spl_image);
691                 break;
692 #endif
693 #if CONFIG_IS_ENABLED(OPTEE)
694         case IH_OS_TEE:
695                 debug("Jumping to U-Boot via OP-TEE\n");
696                 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
697                                 (void *)spl_image.entry_point);
698                 break;
699 #endif
700 #if CONFIG_IS_ENABLED(OPENSBI)
701         case IH_OS_OPENSBI:
702                 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
703                 spl_invoke_opensbi(&spl_image);
704                 break;
705 #endif
706 #ifdef CONFIG_SPL_OS_BOOT
707         case IH_OS_LINUX:
708                 debug("Jumping to Linux\n");
709 #if defined(CONFIG_SYS_SPL_ARGS_ADDR)
710                 spl_fixup_fdt((void *)CONFIG_SYS_SPL_ARGS_ADDR);
711 #endif
712                 spl_board_prepare_for_linux();
713                 jump_to_image_linux(&spl_image);
714 #endif
715         default:
716                 debug("Unsupported OS image.. Jumping nevertheless..\n");
717         }
718 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
719         debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
720               gd->malloc_ptr / 1024);
721 #endif
722         bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_END_TPL :
723                             BOOTSTAGE_ID_END_SPL, "end " SPL_TPL_NAME);
724 #ifdef CONFIG_BOOTSTAGE_STASH
725         ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
726                               CONFIG_BOOTSTAGE_STASH_SIZE);
727         if (ret)
728                 debug("Failed to stash bootstage: err=%d\n", ret);
729 #endif
730
731         debug("loaded - jumping to U-Boot...\n");
732         spl_board_prepare_for_boot();
733         jump_to_image_no_args(&spl_image);
734 }
735
736 /*
737  * This requires UART clocks to be enabled.  In order for this to work the
738  * caller must ensure that the gd pointer is valid.
739  */
740 void preloader_console_init(void)
741 {
742 #ifdef CONFIG_SPL_SERIAL_SUPPORT
743         gd->baudrate = CONFIG_BAUDRATE;
744
745         serial_init();          /* serial communications setup */
746
747         gd->have_console = 1;
748
749 #if CONFIG_IS_ENABLED(BANNER_PRINT)
750         puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
751              U_BOOT_TIME " " U_BOOT_TZ ")\n");
752 #endif
753 #ifdef CONFIG_SPL_DISPLAY_PRINT
754         spl_display_print();
755 #endif
756 #endif
757 }
758
759 /**
760  * This function is called before the stack is changed from initial stack to
761  * relocated stack. It tries to dump the stack size used
762  */
763 __weak void spl_relocate_stack_check(void)
764 {
765 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
766         ulong init_sp = gd->start_addr_sp;
767         ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
768         u8 *ptr = (u8 *)stack_bottom;
769         ulong i;
770
771         for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
772                 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
773                         break;
774                 ptr++;
775         }
776         printf("SPL initial stack usage: %lu bytes\n",
777                CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
778 #endif
779 }
780
781 /**
782  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
783  *
784  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
785  * for the main board_init_r() execution. This is typically because we need
786  * more stack space for things like the MMC sub-system.
787  *
788  * This function calculates the stack position, copies the global_data into
789  * place, sets the new gd (except for ARM, for which setting GD within a C
790  * function may not always work) and returns the new stack position. The
791  * caller is responsible for setting up the sp register and, in the case
792  * of ARM, setting up gd.
793  *
794  * All of this is done using the same layout and alignments as done in
795  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
796  *
797  * @return new stack location, or 0 to use the same stack
798  */
799 ulong spl_relocate_stack_gd(void)
800 {
801 #ifdef CONFIG_SPL_STACK_R
802         gd_t *new_gd;
803         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
804
805         if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
806                 spl_relocate_stack_check();
807
808 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
809         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
810                 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
811                       gd->malloc_ptr, gd->malloc_ptr / 1024);
812                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
813                 gd->malloc_base = ptr;
814                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
815                 gd->malloc_ptr = 0;
816         }
817 #endif
818         /* Get stack position: use 8-byte alignment for ABI compliance */
819         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
820         new_gd = (gd_t *)ptr;
821         memcpy(new_gd, (void *)gd, sizeof(gd_t));
822 #if CONFIG_IS_ENABLED(DM)
823         dm_fixup_for_gd_move(new_gd);
824 #endif
825 #if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
826         gd = new_gd;
827 #endif
828         return ptr;
829 #else
830         return 0;
831 #endif
832 }
833
834 #if defined(CONFIG_BOOTCOUNT_LIMIT) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)
835 void bootcount_store(ulong a)
836 {
837 }
838
839 ulong bootcount_load(void)
840 {
841         return 0;
842 }
843 #endif