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