1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Copyright (c) 2013, Google Inc. 4 * 5 * (C) Copyright 2008 Semihalf 6 * 7 * (C) Copyright 2000-2006 8 * Wolfgang Denk, DENX Software Engineering, wd (at) denx.de. 9 */ 10 11 #include <common.h> 12 #include <fdt_support.h> 13 #include <errno.h> 14 #include <image.h> 15 #include <linux/libfdt.h> 16 #include <mapmem.h> 17 #include <asm/io.h> 18 19 #ifndef CONFIG_SYS_FDT_PAD 20 #define CONFIG_SYS_FDT_PAD 0x3000 21 #endif 22 23 /* adding a ramdisk needs 0x44 bytes in version 2008.10 */ 24 #define FDT_RAMDISK_OVERHEAD 0x80 25 26 DECLARE_GLOBAL_DATA_PTR; 27 28 static void fdt_error(const char *msg) 29 { 30 puts("ERROR: "); 31 puts(msg); 32 puts(" - must RESET the board to recover.\n"); 33 } 34 35 #if defined(CONFIG_IMAGE_FORMAT_LEGACY) 36 static const image_header_t *image_get_fdt(ulong fdt_addr) 37 { 38 const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0); 39 40 image_print_contents(fdt_hdr); 41 42 puts(" Verifying Checksum ... "); 43 if (!image_check_hcrc(fdt_hdr)) { 44 fdt_error("fdt header checksum invalid"); 45 return NULL; 46 } 47 48 if (!image_check_dcrc(fdt_hdr)) { 49 fdt_error("fdt checksum invalid"); 50 return NULL; 51 } 52 puts("OK\n"); 53 54 if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) { 55 fdt_error("uImage is not a fdt"); 56 return NULL; 57 } 58 if (image_get_comp(fdt_hdr) != IH_COMP_NONE) { 59 fdt_error("uImage is compressed"); 60 return NULL; 61 } 62 if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) { 63 fdt_error("uImage data is not a fdt"); 64 return NULL; 65 } 66 return fdt_hdr; 67 } 68 #endif 69 70 /** 71 * boot_fdt_add_mem_rsv_regions - Mark the memreserve sections as unusable 72 * @lmb: pointer to lmb handle, will be used for memory mgmt 73 * @fdt_blob: pointer to fdt blob base address 74 * 75 * Adds the memreserve regions in the dtb to the lmb block. Adding the 76 * memreserve regions prevents u-boot from using them to store the initrd 77 * or the fdt blob. 78 */ 79 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob) 80 { 81 uint64_t addr, size; 82 int i, total; 83 84 if (fdt_check_header(fdt_blob) != 0) 85 return; 86 87 total = fdt_num_mem_rsv(fdt_blob); 88 for (i = 0; i < total; i++) { 89 if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0) 90 continue; 91 printf(" reserving fdt memory region: addr=%llx size=%llx\n", 92 (unsigned long long)addr, (unsigned long long)size); 93 lmb_reserve(lmb, addr, size); 94 } 95 } 96 97 /** 98 * boot_relocate_fdt - relocate flat device tree 99 * @lmb: pointer to lmb handle, will be used for memory mgmt 100 * @of_flat_tree: pointer to a char* variable, will hold fdt start address 101 * @of_size: pointer to a ulong variable, will hold fdt length 102 * 103 * boot_relocate_fdt() allocates a region of memory within the bootmap and 104 * relocates the of_flat_tree into that region, even if the fdt is already in 105 * the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD 106 * bytes. 107 * 108 * of_flat_tree and of_size are set to final (after relocation) values 109 * 110 * returns: 111 * 0 - success 112 * 1 - failure 113 */ 114 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size) 115 { 116 void *fdt_blob = *of_flat_tree; 117 void *of_start = NULL; 118 char *fdt_high; 119 ulong of_len = 0; 120 int err; 121 int disable_relocation = 0; 122 123 /* nothing to do */ 124 if (*of_size == 0) 125 return 0; 126 127 if (fdt_check_header(fdt_blob) != 0) { 128 fdt_error("image is not a fdt"); 129 goto error; 130 } 131 132 /* position on a 4K boundary before the alloc_current */ 133 /* Pad the FDT by a specified amount */ 134 of_len = *of_size + CONFIG_SYS_FDT_PAD; 135 136 /* If fdt_high is set use it to select the relocation address */ 137 fdt_high = env_get("fdt_high"); 138 if (fdt_high) { 139 void *desired_addr = (void *)simple_strtoul(fdt_high, NULL, 16); 140 141 if (((ulong) desired_addr) == ~0UL) { 142 /* All ones means use fdt in place */ 143 of_start = fdt_blob; 144 lmb_reserve(lmb, (ulong)of_start, of_len); 145 disable_relocation = 1; 146 } else if (desired_addr) { 147 of_start = 148 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000, 149 (ulong)desired_addr); 150 if (of_start == NULL) { 151 puts("Failed using fdt_high value for Device Tree"); 152 goto error; 153 } 154 } else { 155 of_start = 156 (void *)(ulong) lmb_alloc(lmb, of_len, 0x1000); 157 } 158 } else { 159 of_start = 160 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000, 161 env_get_bootm_mapsize() 162 + env_get_bootm_low()); 163 } 164 165 if (of_start == NULL) { 166 puts("device tree - allocation error\n"); 167 goto error; 168 } 169 170 if (disable_relocation) { 171 /* 172 * We assume there is space after the existing fdt to use 173 * for padding 174 */ 175 fdt_set_totalsize(of_start, of_len); 176 printf(" Using Device Tree in place at %p, end %p\n", 177 of_start, of_start + of_len - 1); 178 } else { 179 debug("## device tree at %p ... %p (len=%ld [0x%lX])\n", 180 fdt_blob, fdt_blob + *of_size - 1, of_len, of_len); 181 182 printf(" Loading Device Tree to %p, end %p ... ", 183 of_start, of_start + of_len - 1); 184 185 err = fdt_open_into(fdt_blob, of_start, of_len); 186 if (err != 0) { 187 fdt_error("fdt move failed"); 188 goto error; 189 } 190 puts("OK\n"); 191 } 192 193 *of_flat_tree = of_start; 194 *of_size = of_len; 195 196 set_working_fdt_addr((ulong)*of_flat_tree); 197 return 0; 198 199 error: 200 return 1; 201 } 202 203 /** 204 * boot_get_fdt - main fdt handling routine 205 * @argc: command argument count 206 * @argv: command argument list 207 * @arch: architecture (IH_ARCH_...) 208 * @images: pointer to the bootm images structure 209 * @of_flat_tree: pointer to a char* variable, will hold fdt start address 210 * @of_size: pointer to a ulong variable, will hold fdt length 211 * 212 * boot_get_fdt() is responsible for finding a valid flat device tree image. 213 * Curently supported are the following ramdisk sources: 214 * - multicomponent kernel/ramdisk image, 215 * - commandline provided address of decicated ramdisk image. 216 * 217 * returns: 218 * 0, if fdt image was found and valid, or skipped 219 * of_flat_tree and of_size are set to fdt start address and length if 220 * fdt image is found and valid 221 * 222 * 1, if fdt image is found but corrupted 223 * of_flat_tree and of_size are set to 0 if no fdt exists 224 */ 225 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch, 226 bootm_headers_t *images, char **of_flat_tree, ulong *of_size) 227 { 228 #if defined(CONFIG_IMAGE_FORMAT_LEGACY) 229 const image_header_t *fdt_hdr; 230 ulong load, load_end; 231 ulong image_start, image_data, image_end; 232 #endif 233 ulong fdt_addr; 234 char *fdt_blob = NULL; 235 void *buf; 236 #if CONFIG_IS_ENABLED(FIT) 237 const char *fit_uname_config = images->fit_uname_cfg; 238 const char *fit_uname_fdt = NULL; 239 ulong default_addr; 240 int fdt_noffset; 241 #endif 242 const char *select = NULL; 243 int ok_no_fdt = 0; 244 245 *of_flat_tree = NULL; 246 *of_size = 0; 247 248 if (argc > 2) 249 select = argv[2]; 250 if (select || genimg_has_config(images)) { 251 #if CONFIG_IS_ENABLED(FIT) 252 if (select) { 253 /* 254 * If the FDT blob comes from the FIT image and the 255 * FIT image address is omitted in the command line 256 * argument, try to use ramdisk or os FIT image 257 * address or default load address. 258 */ 259 if (images->fit_uname_rd) 260 default_addr = (ulong)images->fit_hdr_rd; 261 else if (images->fit_uname_os) 262 default_addr = (ulong)images->fit_hdr_os; 263 else 264 default_addr = load_addr; 265 266 if (fit_parse_conf(select, default_addr, 267 &fdt_addr, &fit_uname_config)) { 268 debug("* fdt: config '%s' from image at 0x%08lx\n", 269 fit_uname_config, fdt_addr); 270 } else if (fit_parse_subimage(select, default_addr, 271 &fdt_addr, &fit_uname_fdt)) { 272 debug("* fdt: subimage '%s' from image at 0x%08lx\n", 273 fit_uname_fdt, fdt_addr); 274 } else 275 #endif 276 { 277 fdt_addr = simple_strtoul(select, NULL, 16); 278 debug("* fdt: cmdline image address = 0x%08lx\n", 279 fdt_addr); 280 } 281 #if CONFIG_IS_ENABLED(FIT) 282 } else { 283 /* use FIT configuration provided in first bootm 284 * command argument 285 */ 286 fdt_addr = map_to_sysmem(images->fit_hdr_os); 287 fdt_noffset = fit_get_node_from_config(images, 288 FIT_FDT_PROP, 289 fdt_addr); 290 if (fdt_noffset == -ENOENT) 291 return 0; 292 else if (fdt_noffset < 0) 293 return 1; 294 } 295 #endif 296 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n", 297 fdt_addr); 298 299 /* 300 * Check if there is an FDT image at the 301 * address provided in the second bootm argument 302 * check image type, for FIT images get a FIT node. 303 */ 304 buf = map_sysmem(fdt_addr, 0); 305 switch (genimg_get_format(buf)) { 306 #if defined(CONFIG_IMAGE_FORMAT_LEGACY) 307 case IMAGE_FORMAT_LEGACY: 308 /* verify fdt_addr points to a valid image header */ 309 printf("## Flattened Device Tree from Legacy Image at %08lx\n", 310 fdt_addr); 311 fdt_hdr = image_get_fdt(fdt_addr); 312 if (!fdt_hdr) 313 goto no_fdt; 314 315 /* 316 * move image data to the load address, 317 * make sure we don't overwrite initial image 318 */ 319 image_start = (ulong)fdt_hdr; 320 image_data = (ulong)image_get_data(fdt_hdr); 321 image_end = image_get_image_end(fdt_hdr); 322 323 load = image_get_load(fdt_hdr); 324 load_end = load + image_get_data_size(fdt_hdr); 325 326 if (load == image_start || 327 load == image_data) { 328 fdt_addr = load; 329 break; 330 } 331 332 if ((load < image_end) && (load_end > image_start)) { 333 fdt_error("fdt overwritten"); 334 goto error; 335 } 336 337 debug(" Loading FDT from 0x%08lx to 0x%08lx\n", 338 image_data, load); 339 340 memmove((void *)load, 341 (void *)image_data, 342 image_get_data_size(fdt_hdr)); 343 344 fdt_addr = load; 345 break; 346 #endif 347 case IMAGE_FORMAT_FIT: 348 /* 349 * This case will catch both: new uImage format 350 * (libfdt based) and raw FDT blob (also libfdt 351 * based). 352 */ 353 #if CONFIG_IS_ENABLED(FIT) 354 /* check FDT blob vs FIT blob */ 355 if (fit_check_format(buf)) { 356 ulong load, len; 357 358 fdt_noffset = boot_get_fdt_fit(images, 359 fdt_addr, &fit_uname_fdt, 360 &fit_uname_config, 361 arch, &load, &len); 362 363 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0); 364 images->fit_uname_fdt = fit_uname_fdt; 365 images->fit_noffset_fdt = fdt_noffset; 366 fdt_addr = load; 367 368 break; 369 } else 370 #endif 371 { 372 /* 373 * FDT blob 374 */ 375 debug("* fdt: raw FDT blob\n"); 376 printf("## Flattened Device Tree blob at %08lx\n", 377 (long)fdt_addr); 378 } 379 break; 380 default: 381 puts("ERROR: Did not find a cmdline Flattened Device Tree\n"); 382 goto no_fdt; 383 } 384 385 printf(" Booting using the fdt blob at %#08lx\n", fdt_addr); 386 fdt_blob = map_sysmem(fdt_addr, 0); 387 } else if (images->legacy_hdr_valid && 388 image_check_type(&images->legacy_hdr_os_copy, 389 IH_TYPE_MULTI)) { 390 ulong fdt_data, fdt_len; 391 392 /* 393 * Now check if we have a legacy multi-component image, 394 * get second entry data start address and len. 395 */ 396 printf("## Flattened Device Tree from multi component Image at %08lX\n", 397 (ulong)images->legacy_hdr_os); 398 399 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data, 400 &fdt_len); 401 if (fdt_len) { 402 fdt_blob = (char *)fdt_data; 403 printf(" Booting using the fdt at 0x%p\n", fdt_blob); 404 405 if (fdt_check_header(fdt_blob) != 0) { 406 fdt_error("image is not a fdt"); 407 goto error; 408 } 409 410 if (fdt_totalsize(fdt_blob) != fdt_len) { 411 fdt_error("fdt size != image size"); 412 goto error; 413 } 414 } else { 415 debug("## No Flattened Device Tree\n"); 416 goto no_fdt; 417 } 418 } else { 419 debug("## No Flattened Device Tree\n"); 420 goto no_fdt; 421 } 422 423 *of_flat_tree = fdt_blob; 424 *of_size = fdt_totalsize(fdt_blob); 425 debug(" of_flat_tree at 0x%08lx size 0x%08lx\n", 426 (ulong)*of_flat_tree, *of_size); 427 428 return 0; 429 430 no_fdt: 431 ok_no_fdt = 1; 432 error: 433 *of_flat_tree = NULL; 434 *of_size = 0; 435 if (!select && ok_no_fdt) { 436 debug("Continuing to boot without FDT\n"); 437 return 0; 438 } 439 return 1; 440 } 441 442 /* 443 * Verify the device tree. 444 * 445 * This function is called after all device tree fix-ups have been enacted, 446 * so that the final device tree can be verified. The definition of "verified" 447 * is up to the specific implementation. However, it generally means that the 448 * addresses of some of the devices in the device tree are compared with the 449 * actual addresses at which U-Boot has placed them. 450 * 451 * Returns 1 on success, 0 on failure. If 0 is returned, U-Boot will halt the 452 * boot process. 453 */ 454 __weak int ft_verify_fdt(void *fdt) 455 { 456 return 1; 457 } 458 459 __weak int arch_fixup_fdt(void *blob) 460 { 461 return 0; 462 } 463 464 int image_setup_libfdt(bootm_headers_t *images, void *blob, 465 int of_size, struct lmb *lmb) 466 { 467 ulong *initrd_start = &images->initrd_start; 468 ulong *initrd_end = &images->initrd_end; 469 int ret = -EPERM; 470 int fdt_ret; 471 472 if (fdt_root(blob) < 0) { 473 printf("ERROR: root node setup failed\n"); 474 goto err; 475 } 476 if (fdt_chosen(blob) < 0) { 477 printf("ERROR: /chosen node create failed\n"); 478 goto err; 479 } 480 if (arch_fixup_fdt(blob) < 0) { 481 printf("ERROR: arch-specific fdt fixup failed\n"); 482 goto err; 483 } 484 /* Update ethernet nodes */ 485 fdt_fixup_ethernet(blob); 486 if (IMAGE_OF_BOARD_SETUP) { 487 fdt_ret = ft_board_setup(blob, gd->bd); 488 if (fdt_ret) { 489 printf("ERROR: board-specific fdt fixup failed: %s\n", 490 fdt_strerror(fdt_ret)); 491 goto err; 492 } 493 } 494 if (IMAGE_OF_SYSTEM_SETUP) { 495 fdt_ret = ft_system_setup(blob, gd->bd); 496 if (fdt_ret) { 497 printf("ERROR: system-specific fdt fixup failed: %s\n", 498 fdt_strerror(fdt_ret)); 499 goto err; 500 } 501 } 502 503 /* Delete the old LMB reservation */ 504 if (lmb) 505 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob, 506 (phys_size_t)fdt_totalsize(blob)); 507 508 ret = fdt_shrink_to_minimum(blob, 0); 509 if (ret < 0) 510 goto err; 511 of_size = ret; 512 513 if (*initrd_start && *initrd_end) { 514 of_size += FDT_RAMDISK_OVERHEAD; 515 fdt_set_totalsize(blob, of_size); 516 } 517 /* Create a new LMB reservation */ 518 if (lmb) 519 lmb_reserve(lmb, (ulong)blob, of_size); 520 521 fdt_initrd(blob, *initrd_start, *initrd_end); 522 if (!ft_verify_fdt(blob)) 523 goto err; 524 525 #if defined(CONFIG_SOC_KEYSTONE) 526 if (IMAGE_OF_BOARD_SETUP) 527 ft_board_setup_ex(blob, gd->bd); 528 #endif 529 530 return 0; 531 err: 532 printf(" - must RESET the board to recover.\n\n"); 533 534 return ret; 535 } 536
