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