spl: LOAD_FIT_FULL: Do not hard-code os to IH_OS_U_BOOT
[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 *uname;
206         ulong fw_data = 0, dt_data = 0, img_data = 0;
207         ulong fw_len = 0, dt_len = 0, img_len = 0;
208         int idx, conf_noffset;
209         int ret;
210
211 #ifdef CONFIG_SPL_FIT_SIGNATURE
212         images.verify = 1;
213 #endif
214         ret = fit_image_load(&images, (ulong)header,
215                              NULL, &fit_uname_config,
216                              IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
217                              FIT_LOAD_REQUIRED, &fw_data, &fw_len);
218         if (ret < 0)
219                 return ret;
220
221         spl_image->size = fw_len;
222         spl_image->entry_point = fw_data;
223         spl_image->load_addr = fw_data;
224         if (fit_image_get_os(header, ret, &spl_image->os))
225                 spl_image->os = IH_OS_INVALID;
226         spl_image->name = genimg_get_os_name(spl_image->os);
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, NULL, &fit_uname_config,
235                        IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
236                        FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
237         if (ret >= 0)
238                 spl_image->fdt_addr = (void *)dt_data;
239
240         conf_noffset = fit_conf_get_node((const void *)header,
241                                          fit_uname_config);
242         if (conf_noffset <= 0)
243                 return 0;
244
245         for (idx = 0;
246              uname = fdt_stringlist_get((const void *)header, conf_noffset,
247                                         FIT_LOADABLE_PROP, idx,
248                                 NULL), uname;
249              idx++)
250         {
251 #ifdef CONFIG_SPL_FIT_SIGNATURE
252                 images.verify = 1;
253 #endif
254                 ret = fit_image_load(&images, (ulong)header,
255                                      &uname, &fit_uname_config,
256                                      IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
257                                      FIT_LOAD_OPTIONAL_NON_ZERO,
258                                      &img_data, &img_len);
259                 if (ret < 0)
260                         return ret;
261         }
262
263         return 0;
264 }
265 #endif
266
267 __weak int spl_parse_legacy_header(struct spl_image_info *spl_image,
268                                    const struct image_header *header)
269 {
270         /* LEGACY image not supported */
271         debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
272         return -EINVAL;
273 }
274
275 int spl_parse_image_header(struct spl_image_info *spl_image,
276                            const struct image_header *header)
277 {
278 #ifdef CONFIG_SPL_LOAD_FIT_FULL
279         int ret = spl_load_fit_image(spl_image, header);
280
281         if (!ret)
282                 return ret;
283 #endif
284         if (image_get_magic(header) == IH_MAGIC) {
285                 int ret;
286
287                 ret = spl_parse_legacy_header(spl_image, header);
288                 if (ret)
289                         return ret;
290         } else {
291 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
292                 /*
293                  * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
294                  * code which loads images in SPL cannot guarantee that
295                  * absolutely all read errors will be reported.
296                  * An example is the LPC32XX MLC NAND driver, which
297                  * will consider that a completely unreadable NAND block
298                  * is bad, and thus should be skipped silently.
299                  */
300                 panic("** no mkimage signature but raw image not supported");
301 #endif
302
303 #ifdef CONFIG_SPL_OS_BOOT
304                 ulong start, end;
305
306                 if (!bootz_setup((ulong)header, &start, &end)) {
307                         spl_image->name = "Linux";
308                         spl_image->os = IH_OS_LINUX;
309                         spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
310                         spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
311                         spl_image->size = end - start;
312                         debug(SPL_TPL_PROMPT
313                               "payload zImage, load addr: 0x%lx size: %d\n",
314                               spl_image->load_addr, spl_image->size);
315                         return 0;
316                 }
317 #endif
318
319 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
320                 /* Signature not found - assume u-boot.bin */
321                 debug("mkimage signature not found - ih_magic = %x\n",
322                         header->ih_magic);
323                 spl_set_header_raw_uboot(spl_image);
324 #else
325                 /* RAW image not supported, proceed to other boot methods. */
326                 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
327                 return -EINVAL;
328 #endif
329         }
330
331         return 0;
332 }
333
334 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
335 {
336         typedef void __noreturn (*image_entry_noargs_t)(void);
337
338         image_entry_noargs_t image_entry =
339                 (image_entry_noargs_t)spl_image->entry_point;
340
341         debug("image entry point: 0x%lx\n", spl_image->entry_point);
342         image_entry();
343 }
344
345 #if CONFIG_IS_ENABLED(HANDOFF)
346 /**
347  * Set up the SPL hand-off information
348  *
349  * This is initially empty (zero) but can be written by
350  */
351 static int setup_spl_handoff(void)
352 {
353         struct spl_handoff *ho;
354
355         ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
356         if (!ho)
357                 return -ENOENT;
358
359         return 0;
360 }
361
362 __weak int handoff_arch_save(struct spl_handoff *ho)
363 {
364         return 0;
365 }
366
367 static int write_spl_handoff(void)
368 {
369         struct spl_handoff *ho;
370         int ret;
371
372         ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
373         if (!ho)
374                 return -ENOENT;
375         handoff_save_dram(ho);
376         ret = handoff_arch_save(ho);
377         if (ret)
378                 return ret;
379         debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
380
381         return 0;
382 }
383 #else
384 static inline int setup_spl_handoff(void) { return 0; }
385 static inline int write_spl_handoff(void) { return 0; }
386
387 #endif /* HANDOFF */
388
389 /**
390  * get_bootstage_id() - Get the bootstage ID to emit
391  *
392  * @start: true if this is for starting SPL, false for ending it
393  * @return bootstage ID to use
394  */
395 static enum bootstage_id get_bootstage_id(bool start)
396 {
397         enum u_boot_phase phase = spl_phase();
398
399         if (IS_ENABLED(CONFIG_TPL_BUILD) && phase == PHASE_TPL)
400                 return start ? BOOTSTAGE_ID_START_TPL : BOOTSTAGE_ID_END_TPL;
401         else
402                 return start ? BOOTSTAGE_ID_START_SPL : BOOTSTAGE_ID_END_SPL;
403 }
404
405 static int spl_common_init(bool setup_malloc)
406 {
407         int ret;
408
409 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
410         if (setup_malloc) {
411 #ifdef CONFIG_MALLOC_F_ADDR
412                 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
413 #endif
414                 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
415                 gd->malloc_ptr = 0;
416         }
417 #endif
418         ret = bootstage_init(u_boot_first_phase());
419         if (ret) {
420                 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
421                       ret);
422                 return ret;
423         }
424 #ifdef CONFIG_BOOTSTAGE_STASH
425         if (!u_boot_first_phase()) {
426                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
427                                                CONFIG_BOOTSTAGE_STASH_SIZE);
428
429                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
430                 if (ret)
431                         debug("%s: Failed to unstash bootstage: ret=%d\n",
432                               __func__, ret);
433         }
434 #endif /* CONFIG_BOOTSTAGE_STASH */
435         bootstage_mark_name(get_bootstage_id(true),
436                             spl_phase_name(spl_phase()));
437 #if CONFIG_IS_ENABLED(LOG)
438         ret = log_init();
439         if (ret) {
440                 debug("%s: Failed to set up logging\n", __func__);
441                 return ret;
442         }
443 #endif
444         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
445                 ret = fdtdec_setup();
446                 if (ret) {
447                         debug("fdtdec_setup() returned error %d\n", ret);
448                         return ret;
449                 }
450         }
451         if (CONFIG_IS_ENABLED(DM)) {
452                 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
453                                 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
454                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
455                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
456                 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
457                 if (ret) {
458                         debug("dm_init_and_scan() returned error %d\n", ret);
459                         return ret;
460                 }
461         }
462
463         return 0;
464 }
465
466 int spl_alloc_bd(void)
467 {
468         /*
469          * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
470          * writeable.
471          */
472         if (!gd->bd) {
473                 gd->bd = malloc(sizeof(*gd->bd));
474                 if (!gd->bd)
475                         return -ENOMEM;
476         }
477
478         return 0;
479 }
480
481 int spl_early_init(void)
482 {
483         int ret;
484
485         debug("%s\n", __func__);
486
487         ret = spl_common_init(true);
488         if (ret)
489                 return ret;
490         gd->flags |= GD_FLG_SPL_EARLY_INIT;
491
492         return 0;
493 }
494
495 int spl_init(void)
496 {
497         int ret;
498         bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
499                         IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
500
501         debug("%s\n", __func__);
502
503         if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
504                 ret = spl_common_init(setup_malloc);
505                 if (ret)
506                         return ret;
507         }
508         gd->flags |= GD_FLG_SPL_INIT;
509
510         return 0;
511 }
512
513 #ifndef BOOT_DEVICE_NONE
514 #define BOOT_DEVICE_NONE 0xdeadbeef
515 #endif
516
517 __weak void board_boot_order(u32 *spl_boot_list)
518 {
519         spl_boot_list[0] = spl_boot_device();
520 }
521
522 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
523 {
524         struct spl_image_loader *drv =
525                 ll_entry_start(struct spl_image_loader, spl_image_loader);
526         const int n_ents =
527                 ll_entry_count(struct spl_image_loader, spl_image_loader);
528         struct spl_image_loader *entry;
529
530         for (entry = drv; entry != drv + n_ents; entry++) {
531                 if (boot_device == entry->boot_device)
532                         return entry;
533         }
534
535         /* Not found */
536         return NULL;
537 }
538
539 static int spl_load_image(struct spl_image_info *spl_image,
540                           struct spl_image_loader *loader)
541 {
542         int ret;
543         struct spl_boot_device bootdev;
544
545         bootdev.boot_device = loader->boot_device;
546         bootdev.boot_device_name = NULL;
547
548         ret = loader->load_image(spl_image, &bootdev);
549 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
550         if (!ret && spl_image->dcrc_length) {
551                 /* check data crc */
552                 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
553                                       spl_image->dcrc_length, CHUNKSZ_CRC32);
554                 if (dcrc != spl_image->dcrc) {
555                         puts("SPL: Image data CRC check failed!\n");
556                         ret = -EINVAL;
557                 }
558         }
559 #endif
560         return ret;
561 }
562
563 /**
564  * boot_from_devices() - Try loading a booting U-Boot from a list of devices
565  *
566  * @spl_image: Place to put the image details if successful
567  * @spl_boot_list: List of boot devices to try
568  * @count: Number of elements in spl_boot_list
569  * @return 0 if OK, -ve on error
570  */
571 static int boot_from_devices(struct spl_image_info *spl_image,
572                              u32 spl_boot_list[], int count)
573 {
574         int i;
575
576         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
577                 struct spl_image_loader *loader;
578
579                 loader = spl_ll_find_loader(spl_boot_list[i]);
580 #if defined(CONFIG_SPL_SERIAL_SUPPORT) \
581     && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)    \
582     && !defined(CONFIG_SILENT_CONSOLE)
583                 if (loader)
584                         printf("Trying to boot from %s\n", loader->name);
585                 else
586                         puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
587 #endif
588                 if (loader && !spl_load_image(spl_image, loader)) {
589                         spl_image->boot_device = spl_boot_list[i];
590                         return 0;
591                 }
592         }
593
594         return -ENODEV;
595 }
596
597 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
598 void board_init_f(ulong dummy)
599 {
600         if (CONFIG_IS_ENABLED(OF_CONTROL)) {
601                 int ret;
602
603                 ret = spl_early_init();
604                 if (ret) {
605                         debug("spl_early_init() failed: %d\n", ret);
606                         hang();
607                 }
608         }
609
610         preloader_console_init();
611 }
612 #endif
613
614 void board_init_r(gd_t *dummy1, ulong dummy2)
615 {
616         u32 spl_boot_list[] = {
617                 BOOT_DEVICE_NONE,
618                 BOOT_DEVICE_NONE,
619                 BOOT_DEVICE_NONE,
620                 BOOT_DEVICE_NONE,
621                 BOOT_DEVICE_NONE,
622         };
623         struct spl_image_info spl_image;
624         int ret;
625
626         debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
627
628 #if defined(CONFIG_SYS_SPL_MALLOC_START)
629         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
630                         CONFIG_SYS_SPL_MALLOC_SIZE);
631         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
632 #endif
633         if (!(gd->flags & GD_FLG_SPL_INIT)) {
634                 if (spl_init())
635                         hang();
636         }
637         if (IS_ENABLED(CONFIG_SPL_ALLOC_BD) && spl_alloc_bd()) {
638                 puts("Cannot alloc bd\n");
639                 hang();
640         }
641 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
642         /*
643          * timer_init() does not exist on PPC systems. The timer is initialized
644          * and enabled (decrementer) in interrupt_init() here.
645          */
646         timer_init();
647 #endif
648         if (CONFIG_IS_ENABLED(BLOBLIST)) {
649                 ret = bloblist_init();
650                 if (ret) {
651                         debug("%s: Failed to set up bloblist: ret=%d\n",
652                               __func__, ret);
653                         puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
654                         hang();
655                 }
656         }
657         if (CONFIG_IS_ENABLED(HANDOFF)) {
658                 int ret;
659
660                 ret = setup_spl_handoff();
661                 if (ret) {
662                         puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
663                         hang();
664                 }
665         }
666
667 #if CONFIG_IS_ENABLED(BOARD_INIT)
668         spl_board_init();
669 #endif
670
671 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
672         initr_watchdog();
673 #endif
674
675         if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
676             IS_ENABLED(CONFIG_SPL_ATF))
677                 dram_init_banksize();
678
679         bootcount_inc();
680
681         memset(&spl_image, '\0', sizeof(spl_image));
682 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
683         spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
684 #endif
685         spl_image.boot_device = BOOT_DEVICE_NONE;
686         board_boot_order(spl_boot_list);
687
688         if (boot_from_devices(&spl_image, spl_boot_list,
689                               ARRAY_SIZE(spl_boot_list))) {
690                 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
691                 hang();
692         }
693
694         spl_perform_fixups(&spl_image);
695         if (CONFIG_IS_ENABLED(HANDOFF)) {
696                 ret = write_spl_handoff();
697                 if (ret)
698                         printf(SPL_TPL_PROMPT
699                                "SPL hand-off write failed (err=%d)\n", ret);
700         }
701         if (CONFIG_IS_ENABLED(BLOBLIST)) {
702                 ret = bloblist_finish();
703                 if (ret)
704                         printf("Warning: Failed to finish bloblist (ret=%d)\n",
705                                ret);
706         }
707
708 #ifdef CONFIG_CPU_V7M
709         spl_image.entry_point |= 0x1;
710 #endif
711         switch (spl_image.os) {
712         case IH_OS_U_BOOT:
713                 debug("Jumping to %s...\n", spl_phase_name(spl_next_phase()));
714                 break;
715 #if CONFIG_IS_ENABLED(ATF)
716         case IH_OS_ARM_TRUSTED_FIRMWARE:
717                 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
718                 spl_fixup_fdt(spl_image.fdt_addr);
719                 spl_invoke_atf(&spl_image);
720                 break;
721 #endif
722 #if CONFIG_IS_ENABLED(OPTEE)
723         case IH_OS_TEE:
724                 debug("Jumping to U-Boot via OP-TEE\n");
725                 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
726                                 (void *)spl_image.entry_point);
727                 break;
728 #endif
729 #if CONFIG_IS_ENABLED(OPENSBI)
730         case IH_OS_OPENSBI:
731                 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
732                 spl_invoke_opensbi(&spl_image);
733                 break;
734 #endif
735 #ifdef CONFIG_SPL_OS_BOOT
736         case IH_OS_LINUX:
737                 debug("Jumping to Linux\n");
738 #if defined(CONFIG_SYS_SPL_ARGS_ADDR)
739                 spl_fixup_fdt((void *)CONFIG_SYS_SPL_ARGS_ADDR);
740 #endif
741                 spl_board_prepare_for_linux();
742                 jump_to_image_linux(&spl_image);
743 #endif
744         default:
745                 debug("Unsupported OS image.. Jumping nevertheless..\n");
746         }
747 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
748         debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
749               gd->malloc_ptr / 1024);
750 #endif
751         bootstage_mark_name(get_bootstage_id(false), "end phase");
752 #ifdef CONFIG_BOOTSTAGE_STASH
753         ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
754                               CONFIG_BOOTSTAGE_STASH_SIZE);
755         if (ret)
756                 debug("Failed to stash bootstage: err=%d\n", ret);
757 #endif
758
759         spl_board_prepare_for_boot();
760         jump_to_image_no_args(&spl_image);
761 }
762
763 /*
764  * This requires UART clocks to be enabled.  In order for this to work the
765  * caller must ensure that the gd pointer is valid.
766  */
767 void preloader_console_init(void)
768 {
769 #ifdef CONFIG_SPL_SERIAL_SUPPORT
770         gd->baudrate = CONFIG_BAUDRATE;
771
772         serial_init();          /* serial communications setup */
773
774         gd->have_console = 1;
775
776 #if CONFIG_IS_ENABLED(BANNER_PRINT)
777         puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
778              U_BOOT_TIME " " U_BOOT_TZ ")\n");
779 #endif
780 #ifdef CONFIG_SPL_DISPLAY_PRINT
781         spl_display_print();
782 #endif
783 #endif
784 }
785
786 /**
787  * This function is called before the stack is changed from initial stack to
788  * relocated stack. It tries to dump the stack size used
789  */
790 __weak void spl_relocate_stack_check(void)
791 {
792 #if CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE)
793         ulong init_sp = gd->start_addr_sp;
794         ulong stack_bottom = init_sp - CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK);
795         u8 *ptr = (u8 *)stack_bottom;
796         ulong i;
797
798         for (i = 0; i < CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK); i++) {
799                 if (*ptr != CONFIG_VAL(SYS_STACK_F_CHECK_BYTE))
800                         break;
801                 ptr++;
802         }
803         printf("SPL initial stack usage: %lu bytes\n",
804                CONFIG_VAL(SIZE_LIMIT_PROVIDE_STACK) - i);
805 #endif
806 }
807
808 /**
809  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
810  *
811  * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
812  * for the main board_init_r() execution. This is typically because we need
813  * more stack space for things like the MMC sub-system.
814  *
815  * This function calculates the stack position, copies the global_data into
816  * place, sets the new gd (except for ARM, for which setting GD within a C
817  * function may not always work) and returns the new stack position. The
818  * caller is responsible for setting up the sp register and, in the case
819  * of ARM, setting up gd.
820  *
821  * All of this is done using the same layout and alignments as done in
822  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
823  *
824  * @return new stack location, or 0 to use the same stack
825  */
826 ulong spl_relocate_stack_gd(void)
827 {
828 #ifdef CONFIG_SPL_STACK_R
829         gd_t *new_gd;
830         ulong ptr = CONFIG_SPL_STACK_R_ADDR;
831
832         if (CONFIG_IS_ENABLED(SYS_REPORT_STACK_F_USAGE))
833                 spl_relocate_stack_check();
834
835 #if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
836         if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
837                 debug("SPL malloc() before relocation used 0x%lx bytes (%ld KB)\n",
838                       gd->malloc_ptr, gd->malloc_ptr / 1024);
839                 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
840                 gd->malloc_base = ptr;
841                 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
842                 gd->malloc_ptr = 0;
843         }
844 #endif
845         /* Get stack position: use 8-byte alignment for ABI compliance */
846         ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
847         new_gd = (gd_t *)ptr;
848         memcpy(new_gd, (void *)gd, sizeof(gd_t));
849 #if CONFIG_IS_ENABLED(DM)
850         dm_fixup_for_gd_move(new_gd);
851 #endif
852 #if !defined(CONFIG_ARM) && !defined(CONFIG_RISCV)
853         gd = new_gd;
854 #endif
855         return ptr;
856 #else
857         return 0;
858 #endif
859 }
860
861 #if defined(CONFIG_BOOTCOUNT_LIMIT) && \
862         ((!defined(CONFIG_TPL_BUILD) && !defined(CONFIG_SPL_BOOTCOUNT_LIMIT)) || \
863          (defined(CONFIG_TPL_BUILD) && !defined(CONFIG_TPL_BOOTCOUNT_LIMIT)))
864 void bootcount_store(ulong a)
865 {
866 }
867
868 ulong bootcount_load(void)
869 {
870         return 0;
871 }
872 #endif