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 #ifdef CONFIG_SPL_RAM_DEVICE 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_SATA_SUPPORT 316 { BOOT_DEVICE_SATA, "SATA" }, 317 #endif 318 /* Keep this entry last */ 319 { BOOT_DEVICE_NONE, "unknown boot device" }, 320 }; 321 322 static void announce_boot_device(u32 boot_device) 323 { 324 int i; 325 326 puts("Trying to boot from "); 327 328 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE 329 if (boot_device == BOOT_DEVICE_BOARD) { 330 spl_board_announce_boot_device(); 331 puts("\n"); 332 return; 333 } 334 #endif 335 for (i = 0; i < ARRAY_SIZE(boot_name_table) - 1; i++) { 336 if (boot_name_table[i].boot_dev == boot_device) 337 break; 338 } 339 340 printf("%s\n", boot_name_table[i].name); 341 } 342 #else 343 static inline void announce_boot_device(u32 boot_device) { } 344 #endif 345 346 static int spl_load_image(u32 boot_device) 347 { 348 switch (boot_device) { 349 #ifdef CONFIG_SPL_RAM_DEVICE 350 case BOOT_DEVICE_RAM: 351 return spl_ram_load_image(); 352 #endif 353 #ifdef CONFIG_SPL_MMC_SUPPORT 354 case BOOT_DEVICE_MMC1: 355 case BOOT_DEVICE_MMC2: 356 case BOOT_DEVICE_MMC2_2: 357 return spl_mmc_load_image(boot_device); 358 #endif 359 #ifdef CONFIG_SPL_UBI 360 case BOOT_DEVICE_NAND: 361 case BOOT_DEVICE_ONENAND: 362 return spl_ubi_load_image(boot_device); 363 #else 364 #ifdef CONFIG_SPL_NAND_SUPPORT 365 case BOOT_DEVICE_NAND: 366 return spl_nand_load_image(); 367 #endif 368 #ifdef CONFIG_SPL_ONENAND_SUPPORT 369 case BOOT_DEVICE_ONENAND: 370 return spl_onenand_load_image(); 371 #endif 372 #endif 373 #ifdef CONFIG_SPL_NOR_SUPPORT 374 case BOOT_DEVICE_NOR: 375 return spl_nor_load_image(); 376 #endif 377 #ifdef CONFIG_SPL_YMODEM_SUPPORT 378 case BOOT_DEVICE_UART: 379 return spl_ymodem_load_image(); 380 #endif 381 #if defined(CONFIG_SPL_SPI_SUPPORT) || defined(CONFIG_SPL_SPI_FLASH_SUPPORT) 382 case BOOT_DEVICE_SPI: 383 return spl_spi_load_image(); 384 #endif 385 #ifdef CONFIG_SPL_ETH_SUPPORT 386 case BOOT_DEVICE_CPGMAC: 387 #ifdef CONFIG_SPL_ETH_DEVICE 388 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE); 389 #else 390 return spl_net_load_image(NULL); 391 #endif 392 #endif 393 #ifdef CONFIG_SPL_USBETH_SUPPORT 394 case BOOT_DEVICE_USBETH: 395 return spl_net_load_image("usb_ether"); 396 #endif 397 #ifdef CONFIG_SPL_USB_SUPPORT 398 case BOOT_DEVICE_USB: 399 return spl_usb_load_image(); 400 #endif 401 #ifdef CONFIG_SPL_SATA_SUPPORT 402 case BOOT_DEVICE_SATA: 403 return spl_sata_load_image(); 404 #endif 405 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE 406 case BOOT_DEVICE_BOARD: 407 return spl_board_load_image(); 408 #endif 409 default: 410 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT) 411 puts("SPL: Unsupported Boot Device!\n"); 412 #endif 413 return -ENODEV; 414 } 415 416 return -EINVAL; 417 } 418 419 void board_init_r(gd_t *dummy1, ulong dummy2) 420 { 421 int i; 422 423 debug(">>spl:board_init_r()\n"); 424 425 #if defined(CONFIG_SYS_SPL_MALLOC_START) 426 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START, 427 CONFIG_SYS_SPL_MALLOC_SIZE); 428 gd->flags |= GD_FLG_FULL_MALLOC_INIT; 429 #endif 430 if (!(gd->flags & GD_FLG_SPL_INIT)) { 431 if (spl_init()) 432 hang(); 433 } 434 #ifndef CONFIG_PPC 435 /* 436 * timer_init() does not exist on PPC systems. The timer is initialized 437 * and enabled (decrementer) in interrupt_init() here. 438 */ 439 timer_init(); 440 #endif 441 442 #ifdef CONFIG_SPL_BOARD_INIT 443 spl_board_init(); 444 #endif 445 446 board_boot_order(spl_boot_list); 447 for (i = 0; i < ARRAY_SIZE(spl_boot_list) && 448 spl_boot_list[i] != BOOT_DEVICE_NONE; i++) { 449 announce_boot_device(spl_boot_list[i]); 450 if (!spl_load_image(spl_boot_list[i])) 451 break; 452 } 453 454 if (i == ARRAY_SIZE(spl_boot_list) || 455 spl_boot_list[i] == BOOT_DEVICE_NONE) { 456 puts("SPL: failed to boot from all boot devices\n"); 457 hang(); 458 } 459 460 switch (spl_image.os) { 461 case IH_OS_U_BOOT: 462 debug("Jumping to U-Boot\n"); 463 break; 464 #ifdef CONFIG_SPL_OS_BOOT 465 case IH_OS_LINUX: 466 debug("Jumping to Linux\n"); 467 spl_board_prepare_for_linux(); 468 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR); 469 #endif 470 default: 471 debug("Unsupported OS image.. Jumping nevertheless..\n"); 472 } 473 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE) 474 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr, 475 gd->malloc_ptr / 1024); 476 #endif 477 478 debug("loaded - jumping to U-Boot..."); 479 spl_board_prepare_for_boot(); 480 jump_to_image_no_args(&spl_image); 481 } 482 483 /* 484 * This requires UART clocks to be enabled. In order for this to work the 485 * caller must ensure that the gd pointer is valid. 486 */ 487 void preloader_console_init(void) 488 { 489 gd->bd = &bdata; 490 gd->baudrate = CONFIG_BAUDRATE; 491 492 serial_init(); /* serial communications setup */ 493 494 gd->have_console = 1; 495 496 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \ 497 U_BOOT_TIME ")\n"); 498 #ifdef CONFIG_SPL_DISPLAY_PRINT 499 spl_display_print(); 500 #endif 501 } 502 503 /** 504 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution 505 * 506 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM 507 * for the main board_init_r() execution. This is typically because we need 508 * more stack space for things like the MMC sub-system. 509 * 510 * This function calculates the stack position, copies the global_data into 511 * place, sets the new gd (except for ARM, for which setting GD within a C 512 * function may not always work) and returns the new stack position. The 513 * caller is responsible for setting up the sp register and, in the case 514 * of ARM, setting up gd. 515 * 516 * All of this is done using the same layout and alignments as done in 517 * board_init_f_init_reserve() / board_init_f_alloc_reserve(). 518 * 519 * @return new stack location, or 0 to use the same stack 520 */ 521 ulong spl_relocate_stack_gd(void) 522 { 523 #ifdef CONFIG_SPL_STACK_R 524 gd_t *new_gd; 525 ulong ptr = CONFIG_SPL_STACK_R_ADDR; 526 527 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE 528 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) { 529 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 530 gd->malloc_base = ptr; 531 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 532 gd->malloc_ptr = 0; 533 } 534 #endif 535 /* Get stack position: use 8-byte alignment for ABI compliance */ 536 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16); 537 new_gd = (gd_t *)ptr; 538 memcpy(new_gd, (void *)gd, sizeof(gd_t)); 539 #if !defined(CONFIG_ARM) 540 gd = new_gd; 541 #endif 542 return ptr; 543 #else 544 return 0; 545 #endif 546 } 547