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, [email protected].
   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         if (CONFIG_IS_ENABLED(CMD_FDT))
 197                 set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
 198         return 0;
 199
 200 error:
 201         return 1;
 202 }
 203
 204 /**
 205  * boot_get_fdt - main fdt handling routine
 206  * @argc: command argument count
 207  * @argv: command argument list
 208  * @arch: architecture (IH_ARCH_...)
 209  * @images: pointer to the bootm images structure
 210  * @of_flat_tree: pointer to a char* variable, will hold fdt start address
 211  * @of_size: pointer to a ulong variable, will hold fdt length
 212  *
 213  * boot_get_fdt() is responsible for finding a valid flat device tree image.
 214  * Curently supported are the following ramdisk sources:
 215  *      - multicomponent kernel/ramdisk image,
 216  *      - commandline provided address of decicated ramdisk image.
 217  *
 218  * returns:
 219  *     0, if fdt image was found and valid, or skipped
 220  *     of_flat_tree and of_size are set to fdt start address and length if
 221  *     fdt image is found and valid
 222  *
 223  *     1, if fdt image is found but corrupted
 224  *     of_flat_tree and of_size are set to 0 if no fdt exists
 225  */
 226 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
 227                 bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
 228 {
 229 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 230         const image_header_t *fdt_hdr;
 231         ulong           load, load_end;
 232         ulong           image_start, image_data, image_end;
 233 #endif
 234         ulong           fdt_addr;
 235         char            *fdt_blob = NULL;
 236         void            *buf;
 237 #if CONFIG_IS_ENABLED(FIT)
 238         const char      *fit_uname_config = images->fit_uname_cfg;
 239         const char      *fit_uname_fdt = NULL;
 240         ulong           default_addr;
 241         int             fdt_noffset;
 242 #endif
 243         const char *select = NULL;
 244         int             ok_no_fdt = 0;
 245
 246         *of_flat_tree = NULL;
 247         *of_size = 0;
 248
 249         if (argc > 2)
 250                 select = argv[2];
 251         if (select || genimg_has_config(images)) {
 252 #if CONFIG_IS_ENABLED(FIT)
 253                 if (select) {
 254                         /*
 255                          * If the FDT blob comes from the FIT image and the
 256                          * FIT image address is omitted in the command line
 257                          * argument, try to use ramdisk or os FIT image
 258                          * address or default load address.
 259                          */
 260                         if (images->fit_uname_rd)
 261                                 default_addr = (ulong)images->fit_hdr_rd;
 262                         else if (images->fit_uname_os)
 263                                 default_addr = (ulong)images->fit_hdr_os;
 264                         else
 265                                 default_addr = load_addr;
 266
 267                         if (fit_parse_conf(select, default_addr,
 268                                            &fdt_addr, &fit_uname_config)) {
 269                                 debug("*  fdt: config '%s' from image at 0x%08lx\n",
 270                                       fit_uname_config, fdt_addr);
 271                         } else if (fit_parse_subimage(select, default_addr,
 272                                    &fdt_addr, &fit_uname_fdt)) {
 273                                 debug("*  fdt: subimage '%s' from image at 0x%08lx\n",
 274                                       fit_uname_fdt, fdt_addr);
 275                         } else
 276 #endif
 277                         {
 278                                 fdt_addr = simple_strtoul(select, NULL, 16);
 279                                 debug("*  fdt: cmdline image address = 0x%08lx\n",
 280                                       fdt_addr);
 281                         }
 282 #if CONFIG_IS_ENABLED(FIT)
 283                 } else {
 284                         /* use FIT configuration provided in first bootm
 285                          * command argument
 286                          */
 287                         fdt_addr = map_to_sysmem(images->fit_hdr_os);
 288                         fdt_noffset = fit_get_node_from_config(images,
 289                                                                FIT_FDT_PROP,
 290                                                                fdt_addr);
 291                         if (fdt_noffset == -ENOENT)
 292                                 return 0;
 293                         else if (fdt_noffset < 0)
 294                                 return 1;
 295                 }
 296 #endif
 297                 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
 298                       fdt_addr);
 299
 300                 /*
 301                  * Check if there is an FDT image at the
 302                  * address provided in the second bootm argument
 303                  * check image type, for FIT images get a FIT node.
 304                  */
 305                 buf = map_sysmem(fdt_addr, 0);
 306                 switch (genimg_get_format(buf)) {
 307 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 308                 case IMAGE_FORMAT_LEGACY:
 309                         /* verify fdt_addr points to a valid image header */
 310                         printf("## Flattened Device Tree from Legacy Image at %08lx\n",
 311                                fdt_addr);
 312                         fdt_hdr = image_get_fdt(fdt_addr);
 313                         if (!fdt_hdr)
 314                                 goto no_fdt;
 315
 316                         /*
 317                          * move image data to the load address,
 318                          * make sure we don't overwrite initial image
 319                          */
 320                         image_start = (ulong)fdt_hdr;
 321                         image_data = (ulong)image_get_data(fdt_hdr);
 322                         image_end = image_get_image_end(fdt_hdr);
 323
 324                         load = image_get_load(fdt_hdr);
 325                         load_end = load + image_get_data_size(fdt_hdr);
 326
 327                         if (load == image_start ||
 328                             load == image_data) {
 329                                 fdt_addr = load;
 330                                 break;
 331                         }
 332
 333                         if ((load < image_end) && (load_end > image_start)) {
 334                                 fdt_error("fdt overwritten");
 335                                 goto error;
 336                         }
 337
 338                         debug("   Loading FDT from 0x%08lx to 0x%08lx\n",
 339                               image_data, load);
 340
 341                         memmove((void *)load,
 342                                 (void *)image_data,
 343                                 image_get_data_size(fdt_hdr));
 344
 345                         fdt_addr = load;
 346                         break;
 347 #endif
 348                 case IMAGE_FORMAT_FIT:
 349                         /*
 350                          * This case will catch both: new uImage format
 351                          * (libfdt based) and raw FDT blob (also libfdt
 352                          * based).
 353                          */
 354 #if CONFIG_IS_ENABLED(FIT)
 355                         /* check FDT blob vs FIT blob */
 356                         if (fit_check_format(buf)) {
 357                                 ulong load, len;
 358
 359                                 fdt_noffset = boot_get_fdt_fit(images,
 360                                         fdt_addr, &fit_uname_fdt,
 361                                         &fit_uname_config,
 362                                         arch, &load, &len);
 363
 364                                 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
 365                                 images->fit_uname_fdt = fit_uname_fdt;
 366                                 images->fit_noffset_fdt = fdt_noffset;
 367                                 fdt_addr = load;
 368
 369                                 break;
 370                         } else
 371 #endif
 372                         {
 373                                 /*
 374                                  * FDT blob
 375                                  */
 376                                 debug("*  fdt: raw FDT blob\n");
 377                                 printf("## Flattened Device Tree blob at %08lx\n",
 378                                        (long)fdt_addr);
 379                         }
 380                         break;
 381                 default:
 382                         puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
 383                         goto no_fdt;
 384                 }
 385
 386                 printf("   Booting using the fdt blob at %#08lx\n", fdt_addr);
 387                 fdt_blob = map_sysmem(fdt_addr, 0);
 388         } else if (images->legacy_hdr_valid &&
 389                         image_check_type(&images->legacy_hdr_os_copy,
 390                                          IH_TYPE_MULTI)) {
 391                 ulong fdt_data, fdt_len;
 392
 393                 /*
 394                  * Now check if we have a legacy multi-component image,
 395                  * get second entry data start address and len.
 396                  */
 397                 printf("## Flattened Device Tree from multi component Image at %08lX\n",
 398                        (ulong)images->legacy_hdr_os);
 399
 400                 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
 401                                    &fdt_len);
 402                 if (fdt_len) {
 403                         fdt_blob = (char *)fdt_data;
 404                         printf("   Booting using the fdt at 0x%p\n", fdt_blob);
 405
 406                         if (fdt_check_header(fdt_blob) != 0) {
 407                                 fdt_error("image is not a fdt");
 408                                 goto error;
 409                         }
 410
 411                         if (fdt_totalsize(fdt_blob) != fdt_len) {
 412                                 fdt_error("fdt size != image size");
 413                                 goto error;
 414                         }
 415                 } else {
 416                         debug("## No Flattened Device Tree\n");
 417                         goto no_fdt;
 418                 }
 419         } else {
 420                 debug("## No Flattened Device Tree\n");
 421                 goto no_fdt;
 422         }
 423
 424         *of_flat_tree = fdt_blob;
 425         *of_size = fdt_totalsize(fdt_blob);
 426         debug("   of_flat_tree at 0x%08lx size 0x%08lx\n",
 427               (ulong)*of_flat_tree, *of_size);
 428
 429         return 0;
 430
 431 no_fdt:
 432         ok_no_fdt = 1;
 433 error:
 434         *of_flat_tree = NULL;
 435         *of_size = 0;
 436         if (!select && ok_no_fdt) {
 437                 debug("Continuing to boot without FDT\n");
 438                 return 0;
 439         }
 440         return 1;
 441 }
 442
 443 /*
 444  * Verify the device tree.
 445  *
 446  * This function is called after all device tree fix-ups have been enacted,
 447  * so that the final device tree can be verified.  The definition of "verified"
 448  * is up to the specific implementation.  However, it generally means that the
 449  * addresses of some of the devices in the device tree are compared with the
 450  * actual addresses at which U-Boot has placed them.
 451  *
 452  * Returns 1 on success, 0 on failure.  If 0 is returned, U-Boot will halt the
 453  * boot process.
 454  */
 455 __weak int ft_verify_fdt(void *fdt)
 456 {
 457         return 1;
 458 }
 459
 460 __weak int arch_fixup_fdt(void *blob)
 461 {
 462         return 0;
 463 }
 464
 465 int image_setup_libfdt(bootm_headers_t *images, void *blob,
 466                        int of_size, struct lmb *lmb)
 467 {
 468         ulong *initrd_start = &images->initrd_start;
 469         ulong *initrd_end = &images->initrd_end;
 470         int ret = -EPERM;
 471         int fdt_ret;
 472
 473         if (fdt_root(blob) < 0) {
 474                 printf("ERROR: root node setup failed\n");
 475                 goto err;
 476         }
 477         if (fdt_chosen(blob) < 0) {
 478                 printf("ERROR: /chosen node create failed\n");
 479                 goto err;
 480         }
 481         if (arch_fixup_fdt(blob) < 0) {
 482                 printf("ERROR: arch-specific fdt fixup failed\n");
 483                 goto err;
 484         }
 485         /* Update ethernet nodes */
 486         fdt_fixup_ethernet(blob);
 487         if (IMAGE_OF_BOARD_SETUP) {
 488                 fdt_ret = ft_board_setup(blob, gd->bd);
 489                 if (fdt_ret) {
 490                         printf("ERROR: board-specific fdt fixup failed: %s\n",
 491                                fdt_strerror(fdt_ret));
 492                         goto err;
 493                 }
 494         }
 495         if (IMAGE_OF_SYSTEM_SETUP) {
 496                 fdt_ret = ft_system_setup(blob, gd->bd);
 497                 if (fdt_ret) {
 498                         printf("ERROR: system-specific fdt fixup failed: %s\n",
 499                                fdt_strerror(fdt_ret));
 500                         goto err;
 501                 }
 502         }
 503
 504         /* Delete the old LMB reservation */
 505         if (lmb)
 506                 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
 507                          (phys_size_t)fdt_totalsize(blob));
 508
 509         ret = fdt_shrink_to_minimum(blob, 0);
 510         if (ret < 0)
 511                 goto err;
 512         of_size = ret;
 513
 514         if (*initrd_start && *initrd_end) {
 515                 of_size += FDT_RAMDISK_OVERHEAD;
 516                 fdt_set_totalsize(blob, of_size);
 517         }
 518         /* Create a new LMB reservation */
 519         if (lmb)
 520                 lmb_reserve(lmb, (ulong)blob, of_size);
 521
 522         fdt_initrd(blob, *initrd_start, *initrd_end);
 523         if (!ft_verify_fdt(blob))
 524                 goto err;
 525
 526 #if defined(CONFIG_SOC_KEYSTONE)
 527         if (IMAGE_OF_BOARD_SETUP)
 528                 ft_board_setup_ex(blob, gd->bd);
 529 #endif
 530
 531         return 0;
 532 err:
 533         printf(" - must RESET the board to recover.\n\n");
 534
 535         return ret;
 536 }