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