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