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 <i2c.h> 17 #include <image.h> 18 #include <malloc.h> 19 #include <dm/root.h> 20 #include <linux/compiler.h> 21 22 DECLARE_GLOBAL_DATA_PTR; 23 24 #ifndef CONFIG_SYS_UBOOT_START 25 #define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE 26 #endif 27 #ifndef CONFIG_SYS_MONITOR_LEN 28 /* Unknown U-Boot size, let's assume it will not be more than 200 KB */ 29 #define CONFIG_SYS_MONITOR_LEN (200 * 1024) 30 #endif 31 32 u32 *boot_params_ptr = NULL; 33 struct spl_image_info spl_image; 34 35 /* Define board data structure */ 36 static bd_t bdata __attribute__ ((section(".data"))); 37 38 /* 39 * Default function to determine if u-boot or the OS should 40 * be started. This implementation always returns 1. 41 * 42 * Please implement your own board specific funcion to do this. 43 * 44 * RETURN 45 * 0 to not start u-boot 46 * positive if u-boot should start 47 */ 48 #ifdef CONFIG_SPL_OS_BOOT 49 __weak int spl_start_uboot(void) 50 { 51 puts("SPL: Please implement spl_start_uboot() for your board\n"); 52 puts("SPL: Direct Linux boot not active!\n"); 53 return 1; 54 } 55 #endif 56 57 /* 58 * Weak default function for board specific cleanup/preparation before 59 * Linux boot. Some boards/platforms might not need it, so just provide 60 * an empty stub here. 61 */ 62 __weak void spl_board_prepare_for_linux(void) 63 { 64 /* Nothing to do! */ 65 } 66 67 void spl_set_header_raw_uboot(void) 68 { 69 spl_image.size = CONFIG_SYS_MONITOR_LEN; 70 spl_image.entry_point = CONFIG_SYS_UBOOT_START; 71 spl_image.load_addr = CONFIG_SYS_TEXT_BASE; 72 spl_image.os = IH_OS_U_BOOT; 73 spl_image.name = "U-Boot"; 74 } 75 76 void spl_parse_image_header(const struct image_header *header) 77 { 78 u32 header_size = sizeof(struct image_header); 79 80 if (image_get_magic(header) == IH_MAGIC) { 81 if (spl_image.flags & SPL_COPY_PAYLOAD_ONLY) { 82 /* 83 * On some system (e.g. powerpc), the load-address and 84 * entry-point is located at address 0. We can't load 85 * to 0-0x40. So skip header in this case. 86 */ 87 spl_image.load_addr = image_get_load(header); 88 spl_image.entry_point = image_get_ep(header); 89 spl_image.size = image_get_data_size(header); 90 } else { 91 spl_image.entry_point = image_get_load(header); 92 /* Load including the header */ 93 spl_image.load_addr = spl_image.entry_point - 94 header_size; 95 spl_image.size = image_get_data_size(header) + 96 header_size; 97 } 98 spl_image.os = image_get_os(header); 99 spl_image.name = image_get_name(header); 100 debug("spl: payload image: %.*s load addr: 0x%x size: %d\n", 101 (int)sizeof(spl_image.name), spl_image.name, 102 spl_image.load_addr, spl_image.size); 103 } else { 104 #ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE 105 /* 106 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the 107 * code which loads images in SPL cannot guarantee that 108 * absolutely all read errors will be reported. 109 * An example is the LPC32XX MLC NAND driver, which 110 * will consider that a completely unreadable NAND block 111 * is bad, and thus should be skipped silently. 112 */ 113 panic("** no mkimage signature but raw image not supported"); 114 #else 115 /* Signature not found - assume u-boot.bin */ 116 debug("mkimage signature not found - ih_magic = %x\n", 117 header->ih_magic); 118 spl_set_header_raw_uboot(); 119 #endif 120 } 121 } 122 123 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image) 124 { 125 typedef void __noreturn (*image_entry_noargs_t)(void); 126 127 image_entry_noargs_t image_entry = 128 (image_entry_noargs_t)(unsigned long)spl_image->entry_point; 129 130 debug("image entry point: 0x%X\n", spl_image->entry_point); 131 image_entry(); 132 } 133 134 #ifdef CONFIG_SPL_RAM_DEVICE 135 static int spl_ram_load_image(void) 136 { 137 const struct image_header *header; 138 139 /* 140 * Get the header. It will point to an address defined by handoff 141 * which will tell where the image located inside the flash. For 142 * now, it will temporary fixed to address pointed by U-Boot. 143 */ 144 header = (struct image_header *) 145 (CONFIG_SYS_TEXT_BASE - sizeof(struct image_header)); 146 147 spl_parse_image_header(header); 148 149 return 0; 150 } 151 #endif 152 153 int spl_init(void) 154 { 155 int ret; 156 157 debug("spl_init()\n"); 158 #if defined(CONFIG_SYS_MALLOC_F_LEN) 159 gd->malloc_limit = CONFIG_SYS_MALLOC_F_LEN; 160 gd->malloc_ptr = 0; 161 #endif 162 if (CONFIG_IS_ENABLED(OF_CONTROL)) { 163 ret = fdtdec_setup(); 164 if (ret) { 165 debug("fdtdec_setup() returned error %d\n", ret); 166 return ret; 167 } 168 } 169 if (IS_ENABLED(CONFIG_SPL_DM)) { 170 ret = dm_init_and_scan(true); 171 if (ret) { 172 debug("dm_init_and_scan() returned error %d\n", ret); 173 return ret; 174 } 175 } 176 gd->flags |= GD_FLG_SPL_INIT; 177 178 return 0; 179 } 180 181 static int spl_load_image(u32 boot_device) 182 { 183 switch (boot_device) { 184 #ifdef CONFIG_SPL_RAM_DEVICE 185 case BOOT_DEVICE_RAM: 186 return spl_ram_load_image(); 187 #endif 188 #ifdef CONFIG_SPL_MMC_SUPPORT 189 case BOOT_DEVICE_MMC1: 190 case BOOT_DEVICE_MMC2: 191 case BOOT_DEVICE_MMC2_2: 192 return spl_mmc_load_image(); 193 #endif 194 #ifdef CONFIG_SPL_NAND_SUPPORT 195 case BOOT_DEVICE_NAND: 196 return spl_nand_load_image(); 197 #endif 198 #ifdef CONFIG_SPL_ONENAND_SUPPORT 199 case BOOT_DEVICE_ONENAND: 200 return spl_onenand_load_image(); 201 #endif 202 #ifdef CONFIG_SPL_NOR_SUPPORT 203 case BOOT_DEVICE_NOR: 204 return spl_nor_load_image(); 205 #endif 206 #ifdef CONFIG_SPL_YMODEM_SUPPORT 207 case BOOT_DEVICE_UART: 208 return spl_ymodem_load_image(); 209 #endif 210 #ifdef CONFIG_SPL_SPI_SUPPORT 211 case BOOT_DEVICE_SPI: 212 return spl_spi_load_image(); 213 #endif 214 #ifdef CONFIG_SPL_ETH_SUPPORT 215 case BOOT_DEVICE_CPGMAC: 216 #ifdef CONFIG_SPL_ETH_DEVICE 217 return spl_net_load_image(CONFIG_SPL_ETH_DEVICE); 218 #else 219 return spl_net_load_image(NULL); 220 #endif 221 #endif 222 #ifdef CONFIG_SPL_USBETH_SUPPORT 223 case BOOT_DEVICE_USBETH: 224 return spl_net_load_image("usb_ether"); 225 #endif 226 #ifdef CONFIG_SPL_USB_SUPPORT 227 case BOOT_DEVICE_USB: 228 return spl_usb_load_image(); 229 #endif 230 #ifdef CONFIG_SPL_SATA_SUPPORT 231 case BOOT_DEVICE_SATA: 232 return spl_sata_load_image(); 233 #endif 234 #ifdef CONFIG_SPL_BOARD_LOAD_IMAGE 235 case BOOT_DEVICE_BOARD: 236 return spl_board_load_image(); 237 #endif 238 default: 239 #if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT) 240 puts("SPL: Unsupported Boot Device!\n"); 241 #endif 242 return -ENODEV; 243 } 244 245 return -EINVAL; 246 } 247 248 void board_init_r(gd_t *dummy1, ulong dummy2) 249 { 250 u32 boot_device; 251 252 debug(">>spl:board_init_r()\n"); 253 254 #if defined(CONFIG_SYS_SPL_MALLOC_START) 255 mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START, 256 CONFIG_SYS_SPL_MALLOC_SIZE); 257 gd->flags |= GD_FLG_FULL_MALLOC_INIT; 258 #endif 259 if (!(gd->flags & GD_FLG_SPL_INIT)) { 260 if (spl_init()) 261 hang(); 262 } 263 #ifndef CONFIG_PPC 264 /* 265 * timer_init() does not exist on PPC systems. The timer is initialized 266 * and enabled (decrementer) in interrupt_init() here. 267 */ 268 timer_init(); 269 #endif 270 271 #ifdef CONFIG_SPL_BOARD_INIT 272 spl_board_init(); 273 #endif 274 275 boot_device = spl_boot_device(); 276 debug("boot device - %d\n", boot_device); 277 if (spl_load_image(boot_device)) 278 hang(); 279 280 switch (spl_image.os) { 281 case IH_OS_U_BOOT: 282 debug("Jumping to U-Boot\n"); 283 break; 284 #ifdef CONFIG_SPL_OS_BOOT 285 case IH_OS_LINUX: 286 debug("Jumping to Linux\n"); 287 spl_board_prepare_for_linux(); 288 jump_to_image_linux((void *)CONFIG_SYS_SPL_ARGS_ADDR); 289 #endif 290 default: 291 debug("Unsupported OS image.. Jumping nevertheless..\n"); 292 } 293 #if defined(CONFIG_SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE) 294 debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr, 295 gd->malloc_ptr / 1024); 296 #endif 297 298 debug("loaded - jumping to U-Boot..."); 299 jump_to_image_no_args(&spl_image); 300 } 301 302 /* 303 * This requires UART clocks to be enabled. In order for this to work the 304 * caller must ensure that the gd pointer is valid. 305 */ 306 void preloader_console_init(void) 307 { 308 gd->bd = &bdata; 309 gd->baudrate = CONFIG_BAUDRATE; 310 311 serial_init(); /* serial communications setup */ 312 313 gd->have_console = 1; 314 315 puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \ 316 U_BOOT_TIME ")\n"); 317 #ifdef CONFIG_SPL_DISPLAY_PRINT 318 spl_display_print(); 319 #endif 320 } 321 322 /** 323 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution 324 * 325 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM 326 * for the main board_init_r() execution. This is typically because we need 327 * more stack space for things like the MMC sub-system. 328 * 329 * This function calculates the stack position, copies the global_data into 330 * place and returns the new stack position. The caller is responsible for 331 * setting up the sp register. 332 * 333 * @return new stack location, or 0 to use the same stack 334 */ 335 ulong spl_relocate_stack_gd(void) 336 { 337 #ifdef CONFIG_SPL_STACK_R 338 gd_t *new_gd; 339 ulong ptr; 340 341 /* Get stack position: use 8-byte alignment for ABI compliance */ 342 ptr = CONFIG_SPL_STACK_R_ADDR - sizeof(gd_t); 343 ptr &= ~7; 344 new_gd = (gd_t *)ptr; 345 memcpy(new_gd, (void *)gd, sizeof(gd_t)); 346 gd = new_gd; 347 348 #ifdef CONFIG_SPL_SYS_MALLOC_SIMPLE 349 if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) { 350 if (!(gd->flags & GD_FLG_SPL_INIT)) 351 panic("spl_init must be called before heap reloc"); 352 353 ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 354 gd->malloc_base = ptr; 355 gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN; 356 gd->malloc_ptr = 0; 357 } 358 #endif 359 360 return ptr; 361 #else 362 return 0; 363 #endif 364 } 365