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