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