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