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