]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/spl/spl.c
spl: fit: implement recording of loadables into /fit-images
[people/ms/u-boot.git] / common / spl / spl.c
CommitLineData
bcae7211
A
1/*
2 * (C) Copyright 2010
3 * Texas Instruments, <www.ti.com>
4 *
5 * Aneesh V <aneesh@ti.com>
6 *
1a459660 7 * SPDX-License-Identifier: GPL-2.0+
bcae7211 8 */
f1c6e192 9
bcae7211 10#include <common.h>
11516518 11#include <dm.h>
47f7bcae 12#include <spl.h>
bcae7211 13#include <asm/u-boot.h>
bb085b87 14#include <nand.h>
8cf686e1 15#include <fat.h>
efb2172e 16#include <version.h>
8cf686e1 17#include <image.h>
2d01dd95 18#include <malloc.h>
11516518 19#include <dm/root.h>
761ca31e 20#include <linux/compiler.h>
6e7585bb 21#include <fdt_support.h>
bcae7211
A
22
23DECLARE_GLOBAL_DATA_PTR;
24
3c6f8a0d
SR
25#ifndef CONFIG_SYS_UBOOT_START
26#define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
27#endif
ae83d882 28#ifndef CONFIG_SYS_MONITOR_LEN
e76caa62 29/* Unknown U-Boot size, let's assume it will not be more than 200 KB */
ae83d882
SB
30#define CONFIG_SYS_MONITOR_LEN (200 * 1024)
31#endif
32
47f7bcae 33u32 *boot_params_ptr = NULL;
9ea5c6ef 34
6507f133 35/* Define board data structure */
bcae7211
A
36static bd_t bdata __attribute__ ((section(".data")));
37
496c5483
HS
38/*
39 * Board-specific Platform code can reimplement show_boot_progress () if needed
40 */
41__weak void show_boot_progress(int val) {}
42
379c19ab
SS
43/*
44 * Default function to determine if u-boot or the OS should
45 * be started. This implementation always returns 1.
46 *
47 * Please implement your own board specific funcion to do this.
48 *
49 * RETURN
50 * 0 to not start u-boot
51 * positive if u-boot should start
52 */
53#ifdef CONFIG_SPL_OS_BOOT
54__weak int spl_start_uboot(void)
55{
026b2fe3
TR
56 puts("SPL: Please implement spl_start_uboot() for your board\n");
57 puts("SPL: Direct Linux boot not active!\n");
379c19ab
SS
58 return 1;
59}
431889d6 60
6e7585bb
R
61/* weak default platform specific function to initialize
62 * dram banks
63 */
64__weak int dram_init_banksize(void)
65{
66 return 0;
67}
68
431889d6
LM
69/*
70 * Weak default function for arch specific zImage check. Return zero
71 * and fill start and end address if image is recognized.
72 */
73int __weak bootz_setup(ulong image, ulong *start, ulong *end)
74{
75 return 1;
76}
379c19ab
SS
77#endif
78
6e7585bb
R
79void spl_fixup_fdt(void)
80{
81#if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
82 void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
83 int err;
84
85 err = fdt_check_header(fdt_blob);
86 if (err < 0) {
87 printf("fdt_root: %s\n", fdt_strerror(err));
88 return;
89 }
90
91 /* fixup the memory dt node */
92 err = fdt_shrink_to_minimum(fdt_blob, 0);
93 if (err == 0) {
94 printf("spl: fdt_shrink_to_minimum err - %d\n", err);
95 return;
96 }
97
98 err = arch_fixup_fdt(fdt_blob);
99 if (err) {
100 printf("spl: arch_fixup_fdt err - %d\n", err);
101 return;
102 }
103#endif
104}
105
ea8256f0
SR
106/*
107 * Weak default function for board specific cleanup/preparation before
108 * Linux boot. Some boards/platforms might not need it, so just provide
109 * an empty stub here.
110 */
111__weak void spl_board_prepare_for_linux(void)
112{
113 /* Nothing to do! */
114}
115
3a3b9147
MS
116__weak void spl_board_prepare_for_boot(void)
117{
118 /* Nothing to do! */
119}
120
d95ceb97 121void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
0c3117b1 122{
d95ceb97
SG
123 spl_image->size = CONFIG_SYS_MONITOR_LEN;
124 spl_image->entry_point = CONFIG_SYS_UBOOT_START;
125 spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
126 spl_image->os = IH_OS_U_BOOT;
127 spl_image->name = "U-Boot";
0c3117b1
HS
128}
129
71316c1d
SG
130int spl_parse_image_header(struct spl_image_info *spl_image,
131 const struct image_header *header)
8cf686e1 132{
77552b06 133 if (image_get_magic(header) == IH_MAGIC) {
722a6b17
AD
134#ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
135 u32 header_size = sizeof(struct image_header);
136
71316c1d 137 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
022b4975
SR
138 /*
139 * On some system (e.g. powerpc), the load-address and
140 * entry-point is located at address 0. We can't load
141 * to 0-0x40. So skip header in this case.
142 */
71316c1d
SG
143 spl_image->load_addr = image_get_load(header);
144 spl_image->entry_point = image_get_ep(header);
145 spl_image->size = image_get_data_size(header);
022b4975 146 } else {
71316c1d 147 spl_image->entry_point = image_get_load(header);
022b4975 148 /* Load including the header */
71316c1d 149 spl_image->load_addr = spl_image->entry_point -
022b4975 150 header_size;
71316c1d 151 spl_image->size = image_get_data_size(header) +
022b4975
SR
152 header_size;
153 }
71316c1d
SG
154 spl_image->os = image_get_os(header);
155 spl_image->name = image_get_name(header);
11e1479b 156 debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
3fe3839a 157 IH_NMLEN, spl_image->name,
71316c1d 158 spl_image->load_addr, spl_image->size);
722a6b17
AD
159#else
160 /* LEGACY image not supported */
2d2531be 161 debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
722a6b17
AD
162 return -EINVAL;
163#endif
8cf686e1 164 } else {
8c80eb3b
AA
165#ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
166 /*
167 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
168 * code which loads images in SPL cannot guarantee that
169 * absolutely all read errors will be reported.
170 * An example is the LPC32XX MLC NAND driver, which
171 * will consider that a completely unreadable NAND block
172 * is bad, and thus should be skipped silently.
173 */
174 panic("** no mkimage signature but raw image not supported");
85a37729
PK
175#endif
176
431889d6
LM
177#ifdef CONFIG_SPL_OS_BOOT
178 ulong start, end;
179
180 if (!bootz_setup((ulong)header, &start, &end)) {
71316c1d
SG
181 spl_image->name = "Linux";
182 spl_image->os = IH_OS_LINUX;
183 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
184 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
185 spl_image->size = end - start;
11e1479b 186 debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
71316c1d 187 spl_image->load_addr, spl_image->size);
431889d6
LM
188 return 0;
189 }
190#endif
85a37729 191
24eb39b5 192#ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
8cf686e1 193 /* Signature not found - assume u-boot.bin */
026b2fe3 194 debug("mkimage signature not found - ih_magic = %x\n",
8cf686e1 195 header->ih_magic);
71316c1d 196 spl_set_header_raw_uboot(spl_image);
24eb39b5
AD
197#else
198 /* RAW image not supported, proceed to other boot methods. */
2d2531be 199 debug("Raw boot image support not enabled, proceeding to other boot methods\n");
24eb39b5 200 return -EINVAL;
8c80eb3b 201#endif
8cf686e1 202 }
24eb39b5 203
7e0f2267 204 return 0;
8cf686e1
A
205}
206
a759f1e0 207__weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
8cf686e1 208{
4a0eb757
S
209 typedef void __noreturn (*image_entry_noargs_t)(void);
210
8cf686e1 211 image_entry_noargs_t image_entry =
11e1479b 212 (image_entry_noargs_t)spl_image->entry_point;
8cf686e1 213
11e1479b 214 debug("image entry point: 0x%lX\n", spl_image->entry_point);
4a0eb757 215 image_entry();
8cf686e1
A
216}
217
340f418a 218static int spl_common_init(bool setup_malloc)
bcae7211 219{
f3d46bd6
SG
220 int ret;
221
340f418a
EC
222 debug("spl_early_init()\n");
223
f1896c45 224#if CONFIG_VAL(SYS_MALLOC_F_LEN)
340f418a 225 if (setup_malloc) {
94b9e22e 226#ifdef CONFIG_MALLOC_F_ADDR
340f418a 227 gd->malloc_base = CONFIG_MALLOC_F_ADDR;
94b9e22e 228#endif
f1896c45 229 gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
340f418a
EC
230 gd->malloc_ptr = 0;
231 }
24dafad5 232#endif
824bb1b4
SG
233 ret = bootstage_init(true);
234 if (ret) {
235 debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
236 ret);
237 return ret;
238 }
239 bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
d223e0a8 240 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
f3d46bd6
SG
241 ret = fdtdec_setup();
242 if (ret) {
243 debug("fdtdec_setup() returned error %d\n", ret);
070d00b8 244 return ret;
f3d46bd6
SG
245 }
246 }
f1c6e192 247 if (CONFIG_IS_ENABLED(DM)) {
824bb1b4 248 bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
7f73ca48 249 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
7d23b9cf 250 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
824bb1b4 251 bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
f3d46bd6
SG
252 if (ret) {
253 debug("dm_init_and_scan() returned error %d\n", ret);
070d00b8 254 return ret;
f3d46bd6
SG
255 }
256 }
340f418a
EC
257
258 return 0;
259}
260
d1fc0a31
YS
261void spl_set_bd(void)
262{
263 if (!gd->bd)
264 gd->bd = &bdata;
265}
266
340f418a
EC
267int spl_early_init(void)
268{
269 int ret;
270
271 ret = spl_common_init(true);
272 if (ret)
273 return ret;
274 gd->flags |= GD_FLG_SPL_EARLY_INIT;
275
276 return 0;
277}
278
279int spl_init(void)
280{
281 int ret;
cf334edf
TR
282 bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
283 IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
340f418a
EC
284
285 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
cf334edf 286 ret = spl_common_init(setup_malloc);
340f418a
EC
287 if (ret)
288 return ret;
289 }
070d00b8 290 gd->flags |= GD_FLG_SPL_INIT;
2d01dd95 291
070d00b8
SG
292 return 0;
293}
294
f101e4bd
NK
295#ifndef BOOT_DEVICE_NONE
296#define BOOT_DEVICE_NONE 0xdeadbeef
297#endif
298
f101e4bd
NK
299__weak void board_boot_order(u32 *spl_boot_list)
300{
301 spl_boot_list[0] = spl_boot_device();
302}
303
a0a80290
SG
304static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
305{
306 struct spl_image_loader *drv =
307 ll_entry_start(struct spl_image_loader, spl_image_loader);
308 const int n_ents =
309 ll_entry_count(struct spl_image_loader, spl_image_loader);
310 struct spl_image_loader *entry;
311
312 for (entry = drv; entry != drv + n_ents; entry++) {
313 if (boot_device == entry->boot_device)
314 return entry;
315 }
316
317 /* Not found */
318 return NULL;
319}
320
29d357d7
SG
321static int spl_load_image(struct spl_image_info *spl_image,
322 struct spl_image_loader *loader)
070d00b8 323{
ecdfd69a
SG
324 struct spl_boot_device bootdev;
325
29d357d7 326 bootdev.boot_device = loader->boot_device;
ecdfd69a
SG
327 bootdev.boot_device_name = NULL;
328
540bfe7d
SG
329 return loader->load_image(spl_image, &bootdev);
330}
331
332/**
333 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
334 *
335 * @spl_image: Place to put the image details if successful
336 * @spl_boot_list: List of boot devices to try
337 * @count: Number of elements in spl_boot_list
338 * @return 0 if OK, -ve on error
339 */
340static int boot_from_devices(struct spl_image_info *spl_image,
341 u32 spl_boot_list[], int count)
342{
343 int i;
344
345 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
346 struct spl_image_loader *loader;
347
540bfe7d 348 loader = spl_ll_find_loader(spl_boot_list[i]);
18f26fdb 349#if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
2acf35db 350 if (loader)
cf947da1 351 printf("Trying to boot from %s\n", loader->name);
2acf35db 352 else
540bfe7d 353 puts("SPL: Unsupported Boot Device!\n");
18f26fdb 354#endif
29d357d7 355 if (loader && !spl_load_image(spl_image, loader))
540bfe7d
SG
356 return 0;
357 }
358
97d9df0a 359 return -ENODEV;
5211b87e
NK
360}
361
362void board_init_r(gd_t *dummy1, ulong dummy2)
363{
d32b2d1c
SG
364 u32 spl_boot_list[] = {
365 BOOT_DEVICE_NONE,
366 BOOT_DEVICE_NONE,
367 BOOT_DEVICE_NONE,
368 BOOT_DEVICE_NONE,
369 BOOT_DEVICE_NONE,
370 };
371 struct spl_image_info spl_image;
5211b87e
NK
372
373 debug(">>spl:board_init_r()\n");
d1fc0a31
YS
374
375 spl_set_bd();
376
6e7585bb
R
377#ifdef CONFIG_SPL_OS_BOOT
378 dram_init_banksize();
379#endif
5211b87e
NK
380
381#if defined(CONFIG_SYS_SPL_MALLOC_START)
382 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
383 CONFIG_SYS_SPL_MALLOC_SIZE);
384 gd->flags |= GD_FLG_FULL_MALLOC_INIT;
385#endif
386 if (!(gd->flags & GD_FLG_SPL_INIT)) {
387 if (spl_init())
388 hang();
389 }
f9d42d82 390#if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
5211b87e
NK
391 /*
392 * timer_init() does not exist on PPC systems. The timer is initialized
393 * and enabled (decrementer) in interrupt_init() here.
394 */
395 timer_init();
396#endif
397
398#ifdef CONFIG_SPL_BOARD_INIT
399 spl_board_init();
400#endif
401
d32b2d1c 402 memset(&spl_image, '\0', sizeof(spl_image));
5bf5250e
VM
403#ifdef CONFIG_SYS_SPL_ARGS_ADDR
404 spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
405#endif
f101e4bd 406 board_boot_order(spl_boot_list);
f101e4bd 407
540bfe7d
SG
408 if (boot_from_devices(&spl_image, spl_boot_list,
409 ARRAY_SIZE(spl_boot_list))) {
f101e4bd 410 puts("SPL: failed to boot from all boot devices\n");
5211b87e 411 hang();
f101e4bd 412 }
5211b87e 413
6bcdd66d
VM
414#ifdef CONFIG_CPU_V7M
415 spl_image.entry_point |= 0x1;
416#endif
9ea5c6ef 417 switch (spl_image.os) {
8cf686e1
A
418 case IH_OS_U_BOOT:
419 debug("Jumping to U-Boot\n");
8cf686e1 420 break;
379c19ab
SS
421#ifdef CONFIG_SPL_OS_BOOT
422 case IH_OS_LINUX:
423 debug("Jumping to Linux\n");
6e7585bb 424 spl_fixup_fdt();
379c19ab 425 spl_board_prepare_for_linux();
5bf5250e 426 jump_to_image_linux(&spl_image);
379c19ab 427#endif
8cf686e1 428 default:
42120981 429 debug("Unsupported OS image.. Jumping nevertheless..\n");
8cf686e1 430 }
f1896c45 431#if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
fb4f5e7c
SG
432 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
433 gd->malloc_ptr / 1024);
434#endif
824bb1b4
SG
435#ifdef CONFIG_BOOTSTAGE_STASH
436 int ret;
437
438 bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
439 ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
440 CONFIG_BOOTSTAGE_STASH_SIZE);
441 if (ret)
442 debug("Failed to stash bootstage: err=%d\n", ret);
443#endif
a8c5112a
KY
444
445 if (CONFIG_IS_ENABLED(ATF_SUPPORT)) {
446 debug("loaded - jumping to U-Boot via ATF BL31.\n");
447 bl31_entry();
448 }
449
450 debug("loaded - jumping to U-Boot...\n");
3a3b9147 451 spl_board_prepare_for_boot();
a759f1e0 452 jump_to_image_no_args(&spl_image);
bcae7211
A
453}
454
6507f133
TR
455/*
456 * This requires UART clocks to be enabled. In order for this to work the
457 * caller must ensure that the gd pointer is valid.
458 */
bcae7211
A
459void preloader_console_init(void)
460{
bcae7211
A
461 gd->baudrate = CONFIG_BAUDRATE;
462
bcae7211
A
463 serial_init(); /* serial communications setup */
464
b88befa5
IY
465 gd->have_console = 1;
466
026b2fe3
TR
467 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
468 U_BOOT_TIME ")\n");
861a86f4
TR
469#ifdef CONFIG_SPL_DISPLAY_PRINT
470 spl_display_print();
471#endif
cc3f7058 472}
db910353
SG
473
474/**
475 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
476 *
477 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
478 * for the main board_init_r() execution. This is typically because we need
479 * more stack space for things like the MMC sub-system.
480 *
481 * This function calculates the stack position, copies the global_data into
adc421e4
AA
482 * place, sets the new gd (except for ARM, for which setting GD within a C
483 * function may not always work) and returns the new stack position. The
484 * caller is responsible for setting up the sp register and, in the case
485 * of ARM, setting up gd.
486 *
487 * All of this is done using the same layout and alignments as done in
488 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
db910353
SG
489 *
490 * @return new stack location, or 0 to use the same stack
491 */
492ulong spl_relocate_stack_gd(void)
493{
494#ifdef CONFIG_SPL_STACK_R
495 gd_t *new_gd;
adc421e4 496 ulong ptr = CONFIG_SPL_STACK_R_ADDR;
db910353 497
ae2cee2e 498#if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
dcfcb8d4 499 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
dcfcb8d4
HG
500 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
501 gd->malloc_base = ptr;
502 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
503 gd->malloc_ptr = 0;
504 }
505#endif
adc421e4
AA
506 /* Get stack position: use 8-byte alignment for ABI compliance */
507 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
508 new_gd = (gd_t *)ptr;
509 memcpy(new_gd, (void *)gd, sizeof(gd_t));
2f11cd91
SG
510#if CONFIG_IS_ENABLED(DM)
511 dm_fixup_for_gd_move(new_gd);
512#endif
adc421e4
AA
513#if !defined(CONFIG_ARM)
514 gd = new_gd;
515#endif
db910353
SG
516 return ptr;
517#else
518 return 0;
519#endif
520}