Merge tag 'v2021.04-rc4' 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 static int spl_common_init(bool setup_malloc)
391 {
392         int ret;
393
394 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
395         if (setup_malloc) {
396 #ifdef CONFIG_MALLOC_F_ADDR
397                 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
398 #endif
399                 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
400                 gd->malloc_ptr = 0;
401         }
402 #endif
403         ret = bootstage_init(u_boot_first_phase());
404         if (ret) {
405                 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
406                       ret);
407                 return ret;
408         }
409 #ifdef CONFIG_BOOTSTAGE_STASH
410         if (!u_boot_first_phase()) {
411                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
412                                                CONFIG_BOOTSTAGE_STASH_SIZE);
413
414                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
415                 if (ret)
416                         debug("%s: Failed to unstash bootstage: ret=%d\n",
417                               __func__, ret);
418         }
419 #endif /* CONFIG_BOOTSTAGE_STASH */
420         bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_START_TPL :
421                             BOOTSTAGE_ID_START_SPL, SPL_TPL_NAME);
422 #if CONFIG_IS_ENABLED(LOG)
423         ret = log_init();
424         if (ret) {
425                 debug("%s: Failed to set up logging\n", __func__);
426                 return ret;
427         }
428 #endif
429         if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
430                 ret = fdtdec_setup();
431                 if (ret) {
432                         debug("fdtdec_setup() returned error %d\n", ret);
433                         return ret;
434                 }
435         }
436         if (CONFIG_IS_ENABLED(DM)) {
437                 bootstage_start(BOOTSTAGE_ID_ACCUM_DM_SPL,
438                                 spl_phase() == PHASE_TPL ? "dm tpl" : "dm_spl");
439                 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
440                 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
441                 bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_SPL);
442                 if (ret) {
443                         debug("dm_init_and_scan() returned error %d\n", ret);
444                         return ret;
445                 }
446         }
447
448         return 0;
449 }
450
451 int spl_alloc_bd(void)
452 {
453         /*
454          * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
455          * writeable.
456          */
457         if (!gd->bd) {
458                 gd->bd = malloc(sizeof(*gd->bd));
459                 if (!gd->bd)
460                         return -ENOMEM;
461         }
462
463         return 0;
464 }
465
466 int spl_early_init(void)
467 {
468         int ret;
469
470         debug("%s\n", __func__);
471
472         ret = spl_common_init(true);
473         if (ret)
474                 return ret;
475         gd->flags |= GD_FLG_SPL_EARLY_INIT;
476
477         return 0;
478 }
479
480 int spl_init(void)
481 {
482         int ret;
483         bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
484                         IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
485
486         debug("%s\n", __func__);
487
488         if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
489                 ret = spl_common_init(setup_malloc);
490                 if (ret)
491                         return ret;
492         }
493         gd->flags |= GD_FLG_SPL_INIT;
494
495         return 0;
496 }
497
498 #ifndef BOOT_DEVICE_NONE
499 #define BOOT_DEVICE_NONE 0xdeadbeef
500 #endif
501
502 __weak void board_boot_order(u32 *spl_boot_list)
503 {
504         spl_boot_list[0] = spl_boot_device();
505 }
506
507 static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
508 {
509         struct spl_image_loader *drv =
510                 ll_entry_start(struct spl_image_loader, spl_image_loader);
511         const int n_ents =
512                 ll_entry_count(struct spl_image_loader, spl_image_loader);
513         struct spl_image_loader *entry;
514
515         for (entry = drv; entry != drv + n_ents; entry++) {
516                 if (boot_device == entry->boot_device)
517                         return entry;
518         }
519
520         /* Not found */
521         return NULL;
522 }
523
524 static int spl_load_image(struct spl_image_info *spl_image,
525                           struct spl_image_loader *loader)
526 {
527         int ret;
528         struct spl_boot_device bootdev;
529
530         bootdev.boot_device = loader->boot_device;
531         bootdev.boot_device_name = NULL;
532
533         ret = loader->load_image(spl_image, &bootdev);
534 #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
535         if (!ret && spl_image->dcrc_length) {
536                 /* check data crc */
537                 ulong dcrc = crc32_wd(0, (unsigned char *)spl_image->dcrc_data,
538                                       spl_image->dcrc_length, CHUNKSZ_CRC32);
539                 if (dcrc != spl_image->dcrc) {
540                         puts("SPL: Image data CRC check failed!\n");
541                         ret = -EINVAL;
542                 }
543         }
544 #endif
545         return ret;
546 }
547
548 /**
549  * boot_from_devices() - Try loading a booting U-Boot from a list of devices
550  *
551  * @spl_image: Place to put the image details if successful
552  * @spl_boot_list: List of boot devices to try
553  * @count: Number of elements in spl_boot_list
554  * @return 0 if OK, -ve on error
555  */
556 static int boot_from_devices(struct spl_image_info *spl_image,
557                              u32 spl_boot_list[], int count)
558 {
559         int i;
560
561         for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
562                 struct spl_image_loader *loader;
563
564                 loader = spl_ll_find_loader(spl_boot_list[i]);
565 #if defined(CONFIG_SPL_SERIAL_SUPPORT) \
566     && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)    \
567     && !defined(CONFIG_SILENT_CONSOLE)
568                 if (loader)
569                         printf("Trying to boot from %s\n", loader->name);
570                 else
571                         puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
572 #endif
573                 if (loader && !spl_load_image(spl_image, loader)) {
574                         spl_image->boot_device = spl_boot_list[i];
575                         return 0;
576                 }
577         }
578
579         return -ENODEV;
580 }
581
582 #if defined(CONFIG_SPL_FRAMEWORK_BOARD_INIT_F)
583 void board_init_f(ulong dummy)
584 {
585         if (CONFIG_IS_ENABLED(OF_CONTROL)) {
586                 int ret;
587
588                 ret = spl_early_init();
589                 if (ret) {
590                         debug("spl_early_init() failed: %d\n", ret);
591                         hang();
592                 }
593         }
594
595         preloader_console_init();
596 }
597 #endif
598
599 void board_init_r(gd_t *dummy1, ulong dummy2)
600 {
601         u32 spl_boot_list[] = {
602                 BOOT_DEVICE_NONE,
603                 BOOT_DEVICE_NONE,
604                 BOOT_DEVICE_NONE,
605                 BOOT_DEVICE_NONE,
606                 BOOT_DEVICE_NONE,
607         };
608         struct spl_image_info spl_image;
609         int ret;
610
611         debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
612
613 #if defined(CONFIG_SYS_SPL_MALLOC_START)
614         mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
615                         CONFIG_SYS_SPL_MALLOC_SIZE);
616         gd->flags |= GD_FLG_FULL_MALLOC_INIT;
617 #endif
618         if (!(gd->flags & GD_FLG_SPL_INIT)) {
619                 if (spl_init())
620                         hang();
621         }
622         if (IS_ENABLED(CONFIG_SPL_ALLOC_BD) && spl_alloc_bd()) {
623                 puts("Cannot alloc bd\n");
624                 hang();
625         }
626 #if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
627         /*
628          * timer_init() does not exist on PPC systems. The timer is initialized
629          * and enabled (decrementer) in interrupt_init() here.
630          */
631         timer_init();
632 #endif
633         if (CONFIG_IS_ENABLED(BLOBLIST)) {
634                 ret = bloblist_init();
635                 if (ret) {
636                         debug("%s: Failed to set up bloblist: ret=%d\n",
637                               __func__, ret);
638                         puts(SPL_TPL_PROMPT "Cannot set up bloblist\n");
639                         hang();
640                 }
641         }
642         if (CONFIG_IS_ENABLED(HANDOFF)) {
643                 int ret;
644
645                 ret = setup_spl_handoff();
646                 if (ret) {
647                         puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
648                         hang();
649                 }
650         }
651
652 #if CONFIG_IS_ENABLED(BOARD_INIT)
653         spl_board_init();
654 #endif
655
656 #if defined(CONFIG_SPL_WATCHDOG_SUPPORT) && CONFIG_IS_ENABLED(WDT)
657         initr_watchdog();
658 #endif
659
660         if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF) ||
661             IS_ENABLED(CONFIG_SPL_ATF))
662                 dram_init_banksize();
663
664         bootcount_inc();
665
666         memset(&spl_image, '\0', sizeof(spl_image));
667 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
668         spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
669 #endif
670         spl_image.boot_device = BOOT_DEVICE_NONE;
671         board_boot_order(spl_boot_list);
672
673         if (boot_from_devices(&spl_image, spl_boot_list,
674                               ARRAY_SIZE(spl_boot_list))) {
675                 puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
676                 hang();
677         }
678
679         spl_perform_fixups(&spl_image);
680         if (CONFIG_IS_ENABLED(HANDOFF)) {
681                 ret = write_spl_handoff();
682                 if (ret)
683                         printf(SPL_TPL_PROMPT
684                                "SPL hand-off write failed (err=%d)\n", ret);
685         }
686         if (CONFIG_IS_ENABLED(BLOBLIST)) {
687                 ret = bloblist_finish();
688                 if (ret)
689                         printf("Warning: Failed to finish bloblist (ret=%d)\n",
690                                ret);
691         }
692
693 #ifdef CONFIG_CPU_V7M
694         spl_image.entry_point |= 0x1;
695 #endif
696         switch (spl_image.os) {
697         case IH_OS_U_BOOT:
698                 debug("Jumping to %s...\n", spl_phase_name(spl_next_phase()));
699                 break;
700 #if CONFIG_IS_ENABLED(ATF)
701         case IH_OS_ARM_TRUSTED_FIRMWARE:
702                 debug("Jumping to U-Boot via ARM Trusted Firmware\n");
703                 spl_fixup_fdt(spl_image.fdt_addr);
704                 spl_invoke_atf(&spl_image);
705                 break;
706 #endif
707 #if CONFIG_IS_ENABLED(OPTEE)
708         case IH_OS_TEE:
709                 debug("Jumping to U-Boot via OP-TEE\n");
710                 spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
711                                 (void *)spl_image.entry_point);
712                 break;
713 #endif
714 #if CONFIG_IS_ENABLED(OPENSBI)
715         case IH_OS_OPENSBI:
716                 debug("Jumping to U-Boot via RISC-V OpenSBI\n");
717                 spl_invoke_opensbi(&spl_image);
718                 break;
719 #endif
720 #ifdef CONFIG_SPL_OS_BOOT
721         case IH_OS_LINUX:
722                 debug("Jumping to Linux\n");
723 #if defined(CONFIG_SYS_SPL_ARGS_ADDR)
724                 spl_fixup_fdt((void *)CONFIG_SYS_SPL_ARGS_ADDR);
725 #endif
726                 spl_board_prepare_for_linux();
727                 jump_to_image_linux(&spl_image);
728 #endif
729         default:
730                 debug("Unsupported OS image.. Jumping nevertheless..\n");
731         }
732 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
733         debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
734               gd->malloc_ptr / 1024);
735 #endif
736         bootstage_mark_name(spl_phase() == PHASE_TPL ? BOOTSTAGE_ID_END_TPL :
737                             BOOTSTAGE_ID_END_SPL, "end " SPL_TPL_NAME);
738 #ifdef CONFIG_BOOTSTAGE_STASH
739         ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
740                               CONFIG_BOOTSTAGE_STASH_SIZE);
741         if (ret)
742                 debug("Failed to stash bootstage: err=%d\n", ret);
743 #endif
744
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