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