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