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