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 33 /* Define board data structure */ 34 static bd_t bdata __attribute__ ((section(".data"))); 35 36 /* 37 * Board-specific Platform code can reimplement show_boot_progress () if needed 38 */ 39 __weak void show_boot_progress(int val) {} 40 41 /* 42 * Default function to determine if u-boot or the OS should 43 * be started. This implementation always returns 1. 44 * 45 * Please implement your own board specific funcion to do this. 46 * 47 * RETURN 48 * 0 to not start u-boot 49 * positive if u-boot should start 50 */ 51 #ifdef CONFIG_SPL_OS_BOOT 52 __weak int spl_start_uboot(void) 53 { 54 puts("SPL: Please implement spl_start_uboot() for your board\n"); 55 puts("SPL: Direct Linux boot not active!\n"); 56 return 1; 57 } 58 59 /* 60 * Weak default function for arch specific zImage check. Return zero 61 * and fill start and end address if image is recognized. 62 */ 63 int __weak bootz_setup(ulong image, ulong *start, ulong *end) 64 { 65 return 1; 66 } 67 #endif 68 69 /* 70 * Weak default function for board specific cleanup/preparation before 71 * Linux boot. Some boards/platforms might not need it, so just provide 72 * an empty stub here. 73 */ 74 __weak void spl_board_prepare_for_linux(void) 75 { 76 /* Nothing to do! */ 77 } 78 79 __weak void spl_board_prepare_for_boot(void) 80 { 81 /* Nothing to do! */ 82 } 83 84 void spl_set_header_raw_uboot(struct spl_image_info *spl_image) 85 { 86 spl_image->size = CONFIG_SYS_MONITOR_LEN; 87 spl_image->entry_point = CONFIG_SYS_UBOOT_START; 88 spl_image->load_addr = CONFIG_SYS_TEXT_BASE; 89 spl_image->os = IH_OS_U_BOOT; 90 spl_image->name = "U-Boot"; 91 } 92 93 int spl_parse_image_header(struct spl_image_info *spl_image, 94 const struct image_header *header) 95 { 96 if (image_get_magic(header) == IH_MAGIC) { 97 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT 98 u32 header_size = sizeof(struct image_header); 99 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%lx size: %d\n", 120 (int)sizeof(spl_image->name), spl_image->name, 121 spl_image->load_addr, spl_image->size); 122 #else 123 /* LEGACY image not supported */ 124 debug("Legacy boot image support not enabled, proceeding to other boot methods"); 125 return -EINVAL; 126 #endif 127 } else { 128 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE 129 /* 130 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the 131 * code which loads images in SPL cannot guarantee that 132 * absolutely all read errors will be reported. 133 * An example is the LPC32XX MLC NAND driver, which 134 * will consider that a completely unreadable NAND block 135 * is bad, and thus should be skipped silently. 136 */ 137 panic("** no mkimage signature but raw image not supported"); 138 #endif 139 140 #ifdef CONFIG_SPL_OS_BOOT 141 ulong start, end; 142 143 if (!bootz_setup((ulong)header, &start, &end)) { 144 spl_image->name = "Linux"; 145 spl_image->os = IH_OS_LINUX; 146 spl_image->load_addr = CONFIG_SYS_LOAD_ADDR; 147 spl_image->entry_point = CONFIG_SYS_LOAD_ADDR; 148 spl_image->size = end - start; 149 debug("spl: payload zImage, load addr: 0x%lx size: %d\n", 150 spl_image->load_addr, spl_image->size); 151 return 0; 152 } 153 #endif 154 155 #ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT 156 /* Signature not found - assume u-boot.bin */ 157 debug("mkimage signature not found - ih_magic = %x\n", 158 header->ih_magic); 159 spl_set_header_raw_uboot(spl_image); 160 #else 161 /* RAW image not supported, proceed to other boot methods. */ 162 debug("Raw boot image support not enabled, proceeding to other boot methods"); 163 return -EINVAL; 164 #endif 165 } 166 167 return 0; 168 } 169 170 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image) 171 { 172 typedef void __noreturn (*image_entry_noargs_t)(void); 173 174 image_entry_noargs_t image_entry = 175 (image_entry_noargs_t)spl_image->entry_point; 176 177 debug("image entry point: 0x%lX\n", spl_image->entry_point); 178 image_entry(); 179 } 180 181 static int spl_common_init(bool setup_malloc) 182 { 183 int ret; 184 185 debug("spl_early_init()\n"); 186 187 #if defined(CONFIG_SYS_MALLOC_F_LEN) 188 if (setup_malloc) { 189 #ifdef CONFIG_MALLOC_F_ADDR 190 gd->malloc_base = CONFIG_MALLOC_F_ADDR; 191 #endif 192 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN; 193 gd->malloc_ptr = 0; 194 } 195 #endif 196 if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) { 197 ret = fdtdec_setup(); 198 if (ret) { 199 debug("fdtdec_setup() returned error %d\n", ret); 200 return ret; 201 } 202 } 203 if (IS_ENABLED(CONFIG_SPL_DM)) { 204 /* With CONFIG_SPL_OF_PLATDATA, bring in all devices */ 205 ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA)); 206 if (ret) { 207 debug("dm_init_and_scan() returned error %d\n", ret); 208 return ret; 209 } 210 } 211 212 return 0; 213 } 214 215 int spl_early_init(void) 216 { 217 int ret; 218 219 ret = spl_common_init(true); 220 if (ret) 221 return ret; 222 gd->flags |= GD_FLG_SPL_EARLY_INIT; 223 224 return 0; 225 } 226 227 int spl_init(void) 228 { 229 int ret; 230 231 if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) { 232 ret = spl_common_init( 233 !IS_ENABLED(CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN)); 234 if (ret) 235 return ret; 236 } 237 gd->flags |= GD_FLG_SPL_INIT; 238 239 return 0; 240 } 241 242 #ifndef BOOT_DEVICE_NONE 243 #define BOOT_DEVICE_NONE 0xdeadbeef 244 #endif 245 246 __weak void board_boot_order(u32 *spl_boot_list) 247 { 248 spl_boot_list[0] = spl_boot_device(); 249 } 250 251 static struct spl_image_loader *spl_ll_find_loader(uint boot_device) 252 { 253 struct spl_image_loader *drv = 254 ll_entry_start(struct spl_image_loader, spl_image_loader); 255 const int n_ents = 256 ll_entry_count(struct spl_image_loader, spl_image_loader); 257 struct spl_image_loader *entry; 258 259 for (entry = drv; entry != drv + n_ents; entry++) { 260 if (boot_device == entry->boot_device) 261 return entry; 262 } 263 264 /* Not found */ 265 return NULL; 266 } 267 268 static int spl_load_image(struct spl_image_info *spl_image, 269 struct spl_image_loader *loader) 270 { 271 struct spl_boot_device bootdev; 272 273 bootdev.boot_device = loader->boot_device; 274 bootdev.boot_device_name = NULL; 275 276 return loader->load_image(spl_image, &bootdev); 277 } 278 279 /** 280 * boot_from_devices() - Try loading an booting U-Boot from a list of devices 281 * 282 * @spl_image: Place to put the image details if successful 283 * @spl_boot_list: List of boot devices to try 284 * @count: Number of elements in spl_boot_list 285 * @return 0 if OK, -ve on error 286 */ 287 static int boot_from_devices(struct spl_image_info *spl_image, 288 u32 spl_boot_list[], int count) 289 { 290 int i; 291 292 for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) { 293 struct spl_image_loader *loader; 294 295 loader = spl_ll_find_loader(spl_boot_list[i]); 296 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT) 297 if (loader) 298 printf("Trying to boot from %s\n", loader->name); 299 else 300 puts("SPL: Unsupported Boot Device!\n"); 301 #endif 302 if (loader && !spl_load_image(spl_image, loader)) 303 return 0; 304 } 305 306 return -ENODEV; 307 } 308 309 void board_init_r(gd_t *dummy1, ulong dummy2) 310 { 311 u32 spl_boot_list[] = { 312 BOOT_DEVICE_NONE, 313 BOOT_DEVICE_NONE, 314 BOOT_DEVICE_NONE, 315 BOOT_DEVICE_NONE, 316 BOOT_DEVICE_NONE, 317 }; 318 struct spl_image_info spl_image; 319 320 debug(">>spl:board_init_r()\n"); 321 322 #if defined(CONFIG_SYS_SPL_MALLOC_START) 323 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START, 324 CONFIG_SYS_SPL_MALLOC_SIZE); 325 gd->flags |= GD_FLG_FULL_MALLOC_INIT; 326 #endif 327 if (!(gd->flags & GD_FLG_SPL_INIT)) { 328 if (spl_init()) 329 hang(); 330 } 331 #ifndef CONFIG_PPC 332 /* 333 * timer_init() does not exist on PPC systems. The timer is initialized 334 * and enabled (decrementer) in interrupt_init() here. 335 */ 336 timer_init(); 337 #endif 338 339 #ifdef CONFIG_SPL_BOARD_INIT 340 spl_board_init(); 341 #endif 342 343 memset(&spl_image, '\0', sizeof(spl_image)); 344 board_boot_order(spl_boot_list); 345 346 if (boot_from_devices(&spl_image, spl_boot_list, 347 ARRAY_SIZE(spl_boot_list))) { 348 puts("SPL: failed to boot from all boot devices\n"); 349 hang(); 350 } 351 352 switch (spl_image.os) { 353 case IH_OS_U_BOOT: 354 debug("Jumping to U-Boot\n"); 355 break; 356 #ifdef CONFIG_SPL_OS_BOOT 357 case IH_OS_LINUX: 358 debug("Jumping to Linux\n"); 359 spl_board_prepare_for_linux(); 360 jump_to_image_linux(&spl_image, 361 (void *)CONFIG_SYS_SPL_ARGS_ADDR); 362 #endif 363 default: 364 debug("Unsupported OS image.. Jumping nevertheless..\n"); 365 } 366 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE) 367 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr, 368 gd->malloc_ptr / 1024); 369 #endif 370 371 debug("loaded - jumping to U-Boot...\n"); 372 spl_board_prepare_for_boot(); 373 jump_to_image_no_args(&spl_image); 374 } 375 376 /* 377 * This requires UART clocks to be enabled. In order for this to work the 378 * caller must ensure that the gd pointer is valid. 379 */ 380 void preloader_console_init(void) 381 { 382 gd->bd = &bdata; 383 gd->baudrate = CONFIG_BAUDRATE; 384 385 serial_init(); /* serial communications setup */ 386 387 gd->have_console = 1; 388 389 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \ 390 U_BOOT_TIME ")\n"); 391 #ifdef CONFIG_SPL_DISPLAY_PRINT 392 spl_display_print(); 393 #endif 394 } 395 396 /** 397 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution 398 * 399 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM 400 * for the main board_init_r() execution. This is typically because we need 401 * more stack space for things like the MMC sub-system. 402 * 403 * This function calculates the stack position, copies the global_data into 404 * place, sets the new gd (except for ARM, for which setting GD within a C 405 * function may not always work) and returns the new stack position. The 406 * caller is responsible for setting up the sp register and, in the case 407 * of ARM, setting up gd. 408 * 409 * All of this is done using the same layout and alignments as done in 410 * board_init_f_init_reserve() / board_init_f_alloc_reserve(). 411 * 412 * @return new stack location, or 0 to use the same stack 413 */ 414 ulong spl_relocate_stack_gd(void) 415 { 416 #ifdef CONFIG_SPL_STACK_R 417 gd_t *new_gd; 418 ulong ptr = CONFIG_SPL_STACK_R_ADDR; 419 420 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE 421 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) { 422 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 423 gd->malloc_base = ptr; 424 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 425 gd->malloc_ptr = 0; 426 } 427 #endif 428 /* Get stack position: use 8-byte alignment for ABI compliance */ 429 ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16); 430 new_gd = (gd_t *)ptr; 431 memcpy(new_gd, (void *)gd, sizeof(gd_t)); 432 #if CONFIG_IS_ENABLED(DM) 433 dm_fixup_for_gd_move(new_gd); 434 #endif 435 #if !defined(CONFIG_ARM) 436 gd = new_gd; 437 #endif 438 return ptr; 439 #else 440 return 0; 441 #endif 442 } 443