common/image-fdt.c

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