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