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