1 /* 2 * (C) Copyright 2010 3 * Texas Instruments, <www.ti.com> 4 * 5 * Aneesh V <aneesh@ti.com> 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 */ 9 #include <common.h> 10 #include <dm.h> 11 #include <spl.h> 12 #include <asm/u-boot.h> 13 #include <nand.h> 14 #include <fat.h> 15 #include <version.h> 16 #include <image.h> 17 #include <malloc.h> 18 #include <dm/root.h> 19 #include <linux/compiler.h> 20 21 DECLARE_GLOBAL_DATA_PTR; 22 23 #ifndef CONFIG_SYS_UBOOT_START 24 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE 25 #endif 26 #ifndef CONFIG_SYS_MONITOR_LEN 27 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */ 28 #define CONFIG_SYS_MONITOR_LEN (200 * 1024) 29 #endif 30 31 u32 *boot_params_ptr = NULL; 32 struct spl_image_info spl_image; 33 34 /* Define board data structure */ 35 static bd_t bdata __attribute__ ((section(".data"))); 36 37 /* 38 * Board-specific Platform code can reimplement show_boot_progress () if needed 39 */ 40 __weak void show_boot_progress(int val) {} 41 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 { 55 puts("SPL: Please implement spl_start_uboot() for your board\n"); 56 puts("SPL: Direct Linux boot not active!\n"); 57 return 1; 58 } 59 60 /* 61 * Weak default function for arch specific zImage check. Return zero 62 * and fill start and end address if image is recognized. 63 */ 64 int __weak bootz_setup(ulong image, ulong *start, ulong *end) 65 { 66 return 1; 67 } 68 #endif 69 70 /* 71 * Weak default function for board specific cleanup/preparation before 72 * Linux boot. Some boards/platforms might not need it, so just provide 73 * an empty stub here. 74 */ 75 __weak void spl_board_prepare_for_linux(void) 76 { 77 /* Nothing to do! */ 78 } 79 80 __weak void spl_board_prepare_for_boot(void) 81 { 82 /* Nothing to do! */ 83 } 84 85 void spl_set_header_raw_uboot(struct spl_image_info *spl_image) 86 { 87 spl_image->size = CONFIG_SYS_MONITOR_LEN; 88 spl_image->entry_point = CONFIG_SYS_UBOOT_START; 89 spl_image->load_addr = CONFIG_SYS_TEXT_BASE; 90 spl_image->os = IH_OS_U_BOOT; 91 spl_image->name = "U-Boot"; 92 } 93 94 int spl_parse_image_header(struct spl_image_info *spl_image, 95 const struct image_header *header) 96 { 97 u32 header_size = sizeof(struct image_header); 98 99 if (image_get_magic(header) == IH_MAGIC) { 100 if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) { 101 /* 102 * On some system (e.g. powerpc), the load-address and 103 * entry-point is located at address 0. We can't load 104 * to 0-0x40. So skip header in this case. 105 */ 106 spl_image->load_addr = image_get_load(header); 107 spl_image->entry_point = image_get_ep(header); 108 spl_image->size = image_get_data_size(header); 109 } else { 110 spl_image->entry_point = image_get_load(header); 111 /* Load including the header */ 112 spl_image->load_addr = spl_image->entry_point - 113 header_size; 114 spl_image->size = image_get_data_size(header) + 115 header_size; 116 } 117 spl_image->os = image_get_os(header); 118 spl_image->name = image_get_name(header); 119 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n", 120 (int)sizeof(spl_image->name), spl_image->name, 121 spl_image->load_addr, spl_image->size); 122 } else { 123 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE 124 /* 125 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the 126 * code which loads images in SPL cannot guarantee that 127 * absolutely all read errors will be reported. 128 * An example is the LPC32XX MLC NAND driver, which 129 * will consider that a completely unreadable NAND block 130 * is bad, and thus should be skipped silently. 131 */ 132 panic("** no mkimage signature but raw image not supported"); 133 #endif 134 135 #ifdef CONFIG_SPL_OS_BOOT 136 ulong start, end; 137 138 if (!bootz_setup((ulong)header, &start, &end)) { 139 spl_image->name = "Linux"; 140 spl_image->os = IH_OS_LINUX; 141 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR; 142 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR; 143 spl_image->size = end - start; 144 debug("spl: payload zImage, load addr: 0x%x size: %d\n", 145 spl_image->load_addr, spl_image->size); 146 return 0; 147 } 148 #endif 149 150 #ifdef CONFIG_SPL_ABORT_ON_RAW_IMAGE 151 /* Signature not found, proceed to other boot methods. */ 152 return -EINVAL; 153 #else 154 /* Signature not found - assume u-boot.bin */ 155 debug("mkimage signature not found - ih_magic = %x\n", 156 header->ih_magic); 157 spl_set_header_raw_uboot(spl_image); 158 #endif 159 } 160 return 0; 161 } 162 163 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image) 164 { 165 typedef void __noreturn (*image_entry_noargs_t)(void); 166 167 image_entry_noargs_t image_entry = 168 (image_entry_noargs_t)(unsigned long)spl_image->entry_point; 169 170 debug("image entry point: 0x%X\n", spl_image->entry_point); 171 image_entry(); 172 } 173 174 #ifndef CONFIG_SPL_LOAD_FIT_ADDRESS 175 # define CONFIG_SPL_LOAD_FIT_ADDRESS 0 176 #endif 177 178 #if defined(CONFIG_SPL_RAM_DEVICE) || defined(CONFIG_SPL_DFU_SUPPORT) 179 static ulong spl_ram_load_read(struct spl_load_info *load, ulong sector, 180 ulong count, void *buf) 181 { 182 debug("%s: sector %lx, count %lx, buf %lx\n", 183 __func__, sector, count, (ulong)buf); 184 memcpy(buf, (void *)(CONFIG_SPL_LOAD_FIT_ADDRESS + sector), count); 185 return count; 186 } 187 188 static int spl_ram_load_image(struct spl_boot_device *bootdev) 189 { 190 struct image_header *header; 191 192 header = (struct image_header *)CONFIG_SPL_LOAD_FIT_ADDRESS; 193 194 #if defined(CONFIG_SPL_DFU_SUPPORT) 195 if (bootdev->boot_device == BOOT_DEVICE_DFU) 196 spl_dfu_cmd(0, "dfu_alt_info_ram", "ram", "0"); 197 #endif 198 199 if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) && 200 image_get_magic(header) == FDT_MAGIC) { 201 struct spl_load_info load; 202 203 debug("Found FIT\n"); 204 load.bl_len = 1; 205 load.read = spl_ram_load_read; 206 spl_load_simple_fit(&load, 0, header); 207 } else { 208 debug("Legacy image\n"); 209 /* 210 * Get the header. It will point to an address defined by 211 * handoff which will tell where the image located inside 212 * the flash. For now, it will temporary fixed to address 213 * pointed by U-Boot. 214 */ 215 header = (struct image_header *) 216 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header)); 217 218 spl_parse_image_header(&spl_image, header); 219 } 220 221 return 0; 222 } 223 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_RAM, spl_ram_load_image); 224 #if defined(CONFIG_SPL_DFU_SUPPORT) 225 SPL_LOAD_IMAGE_METHOD(0, BOOT_DEVICE_DFU, spl_ram_load_image); 226 #endif 227 #endif 228 229 int spl_init(void) 230 { 231 int ret; 232 233 debug("spl_init()\n"); 234 #if defined(CONFIG_SYS_MALLOC_F_LEN) 235 #ifdef CONFIG_MALLOC_F_ADDR 236 gd->malloc_base = CONFIG_MALLOC_F_ADDR; 237 #endif 238 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN; 239 gd->malloc_ptr = 0; 240 #endif 241 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) { 242 ret = fdtdec_setup(); 243 if (ret) { 244 debug("fdtdec_setup() returned error %d\n", ret); 245 return ret; 246 } 247 } 248 if (IS_ENABLED(CONFIG_SPL_DM)) { 249 /* With CONFIG_OF_PLATDATA, bring in all devices */ 250 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA)); 251 if (ret) { 252 debug("dm_init_and_scan() returned error %d\n", ret); 253 return ret; 254 } 255 } 256 gd->flags |= GD_FLG_SPL_INIT; 257 258 return 0; 259 } 260 261 #ifndef BOOT_DEVICE_NONE 262 #define BOOT_DEVICE_NONE 0xdeadbeef 263 #endif 264 265 static u32 spl_boot_list[] = { 266 BOOT_DEVICE_NONE, 267 BOOT_DEVICE_NONE, 268 BOOT_DEVICE_NONE, 269 BOOT_DEVICE_NONE, 270 BOOT_DEVICE_NONE, 271 }; 272 273 __weak void board_boot_order(u32 *spl_boot_list) 274 { 275 spl_boot_list[0] = spl_boot_device(); 276 } 277 278 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE 279 __weak void spl_board_announce_boot_device(void) { } 280 #endif 281 282 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT 283 struct boot_device_name { 284 u32 boot_dev; 285 const char *name; 286 }; 287 288 struct boot_device_name boot_name_table[] = { 289 #ifdef CONFIG_SPL_RAM_DEVICE 290 { BOOT_DEVICE_RAM, "RAM" }, 291 #endif 292 #ifdef CONFIG_SPL_MMC_SUPPORT 293 { BOOT_DEVICE_MMC1, "MMC1" }, 294 { BOOT_DEVICE_MMC2, "MMC2" }, 295 { BOOT_DEVICE_MMC2_2, "MMC2_2" }, 296 #endif 297 #ifdef CONFIG_SPL_NAND_SUPPORT 298 { BOOT_DEVICE_NAND, "NAND" }, 299 #endif 300 #ifdef CONFIG_SPL_ONENAND_SUPPORT 301 { BOOT_DEVICE_ONENAND, "OneNAND" }, 302 #endif 303 #ifdef CONFIG_SPL_NOR_SUPPORT 304 { BOOT_DEVICE_NOR, "NOR" }, 305 #endif 306 #ifdef CONFIG_SPL_YMODEM_SUPPORT 307 { BOOT_DEVICE_UART, "UART" }, 308 #endif 309 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT) 310 { BOOT_DEVICE_SPI, "SPI" }, 311 #endif 312 #ifdef CONFIG_SPL_ETH_SUPPORT 313 #ifdef CONFIG_SPL_ETH_DEVICE 314 { BOOT_DEVICE_CPGMAC, "eth device" }, 315 #else 316 { BOOT_DEVICE_CPGMAC, "net" }, 317 #endif 318 #endif 319 #ifdef CONFIG_SPL_USBETH_SUPPORT 320 { BOOT_DEVICE_USBETH, "USB eth" }, 321 #endif 322 #ifdef CONFIG_SPL_USB_SUPPORT 323 { BOOT_DEVICE_USB, "USB" }, 324 #endif 325 #ifdef CONFIG_SPL_DFU_SUPPORT 326 { BOOT_DEVICE_DFU, "USB DFU" }, 327 #endif 328 #ifdef CONFIG_SPL_SATA_SUPPORT 329 { BOOT_DEVICE_SATA, "SATA" }, 330 #endif 331 /* Keep this entry last */ 332 { BOOT_DEVICE_NONE, "unknown boot device" }, 333 }; 334 335 static void announce_boot_device(u32 boot_device) 336 { 337 int i; 338 339 puts("Trying to boot from "); 340 341 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE 342 if (boot_device == BOOT_DEVICE_BOARD) { 343 spl_board_announce_boot_device(); 344 puts("\n"); 345 return; 346 } 347 #endif 348 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) { 349 if (boot_name_table[i].boot_dev == boot_device) 350 break; 351 } 352 353 printf("%s\n", boot_name_table[i].name); 354 } 355 #else 356 static inline void announce_boot_device(u32 boot_device) { } 357 #endif 358 359 static struct spl_image_loader *spl_ll_find_loader(uint boot_device) 360 { 361 struct spl_image_loader *drv = 362 ll_entry_start(struct spl_image_loader, spl_image_loader); 363 const int n_ents = 364 ll_entry_count(struct spl_image_loader, spl_image_loader); 365 struct spl_image_loader *entry; 366 367 for (entry = drv; entry != drv + n_ents; entry++) { 368 if (boot_device == entry->boot_device) 369 return entry; 370 } 371 372 /* Not found */ 373 return NULL; 374 } 375 376 static int spl_load_image(u32 boot_device) 377 { 378 struct spl_boot_device bootdev; 379 struct spl_image_loader *loader = spl_ll_find_loader(boot_device); 380 381 bootdev.boot_device = boot_device; 382 bootdev.boot_device_name = NULL; 383 if (loader) 384 return loader->load_image(&bootdev); 385 386 switch (boot_device) { 387 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT) 388 case BOOT_DEVICE_SPI: 389 return spl_spi_load_image(&bootdev); 390 #endif 391 #ifdef CONFIG_SPL_ETH_SUPPORT 392 case BOOT_DEVICE_CPGMAC: 393 #ifdef CONFIG_SPL_ETH_DEVICE 394 bootdev.boot_device_name = CONFIG_SPL_ETH_DEVICE; 395 #endif 396 return spl_net_load_image(&bootdev); 397 #endif 398 #ifdef CONFIG_SPL_USBETH_SUPPORT 399 case BOOT_DEVICE_USBETH: 400 bootdev.boot_device_name = "usb_ether"; 401 return spl_net_load_image(&bootdev); 402 #endif 403 #endif 404 #ifdef CONFIG_SPL_SATA_SUPPORT 405 case BOOT_DEVICE_SATA: 406 return spl_sata_load_image(&bootdev); 407 #endif 408 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE 409 case BOOT_DEVICE_BOARD: 410 return spl_board_load_image(&bootdev); 411 #endif 412 default: 413 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT) 414 puts("SPL: Unsupported Boot Device!\n"); 415 #endif 416 return -ENODEV; 417 } 418 419 return -EINVAL; 420 } 421 422 void board_init_r(gd_t *dummy1, ulong dummy2) 423 { 424 int i; 425 426 debug(">>spl:board_init_r()\n"); 427 428 #if defined(CONFIG_SYS_SPL_MALLOC_START) 429 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START, 430 CONFIG_SYS_SPL_MALLOC_SIZE); 431 gd->flags |= GD_FLG_FULL_MALLOC_INIT; 432 #endif 433 if (!(gd->flags & GD_FLG_SPL_INIT)) { 434 if (spl_init()) 435 hang(); 436 } 437 #ifndef CONFIG_PPC 438 /* 439 * timer_init() does not exist on PPC systems. The timer is initialized 440 * and enabled (decrementer) in interrupt_init() here. 441 */ 442 timer_init(); 443 #endif 444 445 #ifdef CONFIG_SPL_BOARD_INIT 446 spl_board_init(); 447 #endif 448 449 board_boot_order(spl_boot_list); 450 for (i = 0; i < ARRAY_SIZE(spl_boot_list) && 451 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) { 452 announce_boot_device(spl_boot_list[i]); 453 if (!spl_load_image(spl_boot_list[i])) 454 break; 455 } 456 457 if (i == ARRAY_SIZE(spl_boot_list) || 458 spl_boot_list[i] == BOOT_DEVICE_NONE) { 459 puts("SPL: failed to boot from all boot devices\n"); 460 hang(); 461 } 462 463 switch (spl_image.os) { 464 case IH_OS_U_BOOT: 465 debug("Jumping to U-Boot\n"); 466 break; 467 #ifdef CONFIG_SPL_OS_BOOT 468 case IH_OS_LINUX: 469 debug("Jumping to Linux\n"); 470 spl_board_prepare_for_linux(); 471 jump_to_image_linux(&spl_image, 472 (void *)CONFIG_SYS_SPL_ARGS_ADDR); 473 #endif 474 default: 475 debug("Unsupported OS image.. Jumping nevertheless..\n"); 476 } 477 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE) 478 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr, 479 gd->malloc_ptr / 1024); 480 #endif 481 482 debug("loaded - jumping to U-Boot..."); 483 spl_board_prepare_for_boot(); 484 jump_to_image_no_args(&spl_image); 485 } 486 487 /* 488 * This requires UART clocks to be enabled. In order for this to work the 489 * caller must ensure that the gd pointer is valid. 490 */ 491 void preloader_console_init(void) 492 { 493 gd->bd = &bdata; 494 gd->baudrate = CONFIG_BAUDRATE; 495 496 serial_init(); /* serial communications setup */ 497 498 gd->have_console = 1; 499 500 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \ 501 U_BOOT_TIME ")\n"); 502 #ifdef CONFIG_SPL_DISPLAY_PRINT 503 spl_display_print(); 504 #endif 505 } 506 507 /** 508 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution 509 * 510 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM 511 * for the main board_init_r() execution. This is typically because we need 512 * more stack space for things like the MMC sub-system. 513 * 514 * This function calculates the stack position, copies the global_data into 515 * place, sets the new gd (except for ARM, for which setting GD within a C 516 * function may not always work) and returns the new stack position. The 517 * caller is responsible for setting up the sp register and, in the case 518 * of ARM, setting up gd. 519 * 520 * All of this is done using the same layout and alignments as done in 521 * board_init_f_init_reserve() / board_init_f_alloc_reserve(). 522 * 523 * @return new stack location, or 0 to use the same stack 524 */ 525 ulong spl_relocate_stack_gd(void) 526 { 527 #ifdef CONFIG_SPL_STACK_R 528 gd_t *new_gd; 529 ulong ptr = CONFIG_SPL_STACK_R_ADDR; 530 531 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE 532 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) { 533 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 534 gd->malloc_base = ptr; 535 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 536 gd->malloc_ptr = 0; 537 } 538 #endif 539 /* Get stack position: use 8-byte alignment for ABI compliance */ 540 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16); 541 new_gd = (gd_t *)ptr; 542 memcpy(new_gd, (void *)gd, sizeof(gd_t)); 543 #if !defined(CONFIG_ARM) 544 gd = new_gd; 545 #endif 546 return ptr; 547 #else 548 return 0; 549 #endif 550 } 551