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