lib/fdtdec.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2011 The Chromium OS Authors.
   4  */
   5
   6 #ifndef USE_HOSTCC
   7 #include <common.h>
   8 #include <boot_fit.h>
   9 #include <dm.h>
  10 #include <hang.h>
  11 #include <init.h>
  12 #include <log.h>
  13 #include <malloc.h>
  14 #include <net.h>
  15 #include <dm/of_extra.h>
  16 #include <env.h>
  17 #include <errno.h>
  18 #include <fdtdec.h>
  19 #include <fdt_support.h>
  20 #include <gzip.h>
  21 #include <mapmem.h>
  22 #include <linux/libfdt.h>
  23 #include <serial.h>
  24 #include <asm/sections.h>
  25 #include <linux/ctype.h>
  26 #include <linux/lzo.h>
  27 #include <linux/ioport.h>
  28
  29 DECLARE_GLOBAL_DATA_PTR;
  30
  31 /*
  32  * Here are the type we know about. One day we might allow drivers to
  33  * register. For now we just put them here. The COMPAT macro allows us to
  34  * turn this into a sparse list later, and keeps the ID with the name.
  35  *
  36  * NOTE: This list is basically a TODO list for things that need to be
  37  * converted to driver model. So don't add new things here unless there is a
  38  * good reason why driver-model conversion is infeasible. Examples include
  39  * things which are used before driver model is available.
  40  */
  41 #define COMPAT(id, name) name
  42 static const char * const compat_names[COMPAT_COUNT] = {
  43         COMPAT(UNKNOWN, "<none>"),
  44         COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
  45         COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
  46         COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
  47         COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
  48         COMPAT(NVIDIA_TEGRA210_XUSB_PADCTL, "nvidia,tegra210-xusb-padctl"),
  49         COMPAT(SMSC_LAN9215, "smsc,lan9215"),
  50         COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
  51         COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
  52         COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
  53         COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
  54         COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
  55         COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
  56         COMPAT(GENERIC_SPI_FLASH, "jedec,spi-nor"),
  57         COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
  58         COMPAT(INTEL_MICROCODE, "intel,microcode"),
  59         COMPAT(INTEL_QRK_MRC, "intel,quark-mrc"),
  60         COMPAT(ALTERA_SOCFPGA_DWMAC, "altr,socfpga-stmmac"),
  61         COMPAT(ALTERA_SOCFPGA_DWMMC, "altr,socfpga-dw-mshc"),
  62         COMPAT(ALTERA_SOCFPGA_DWC2USB, "snps,dwc2"),
  63         COMPAT(INTEL_BAYTRAIL_FSP, "intel,baytrail-fsp"),
  64         COMPAT(INTEL_BAYTRAIL_FSP_MDP, "intel,baytrail-fsp-mdp"),
  65         COMPAT(INTEL_IVYBRIDGE_FSP, "intel,ivybridge-fsp"),
  66         COMPAT(COMPAT_SUNXI_NAND, "allwinner,sun4i-a10-nand"),
  67         COMPAT(ALTERA_SOCFPGA_CLK, "altr,clk-mgr"),
  68         COMPAT(ALTERA_SOCFPGA_PINCTRL_SINGLE, "pinctrl-single"),
  69         COMPAT(ALTERA_SOCFPGA_H2F_BRG, "altr,socfpga-hps2fpga-bridge"),
  70         COMPAT(ALTERA_SOCFPGA_LWH2F_BRG, "altr,socfpga-lwhps2fpga-bridge"),
  71         COMPAT(ALTERA_SOCFPGA_F2H_BRG, "altr,socfpga-fpga2hps-bridge"),
  72         COMPAT(ALTERA_SOCFPGA_F2SDR0, "altr,socfpga-fpga2sdram0-bridge"),
  73         COMPAT(ALTERA_SOCFPGA_F2SDR1, "altr,socfpga-fpga2sdram1-bridge"),
  74         COMPAT(ALTERA_SOCFPGA_F2SDR2, "altr,socfpga-fpga2sdram2-bridge"),
  75         COMPAT(ALTERA_SOCFPGA_FPGA0, "altr,socfpga-a10-fpga-mgr"),
  76         COMPAT(ALTERA_SOCFPGA_NOC, "altr,socfpga-a10-noc"),
  77         COMPAT(ALTERA_SOCFPGA_CLK_INIT, "altr,socfpga-a10-clk-init")
  78 };
  79
  80 const char *fdtdec_get_compatible(enum fdt_compat_id id)
  81 {
  82         /* We allow reading of the 'unknown' ID for testing purposes */
  83         assert(id >= 0 && id < COMPAT_COUNT);
  84         return compat_names[id];
  85 }
  86
  87 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
  88                                       const char *prop_name, int index, int na,
  89                                       int ns, fdt_size_t *sizep,
  90                                       bool translate)
  91 {
  92         const fdt32_t *prop, *prop_end;
  93         const fdt32_t *prop_addr, *prop_size, *prop_after_size;
  94         int len;
  95         fdt_addr_t addr;
  96
  97         debug("%s: %s: ", __func__, prop_name);
  98
  99         prop = fdt_getprop(blob, node, prop_name, &len);
 100         if (!prop) {
 101                 debug("(not found)\n");
 102                 return FDT_ADDR_T_NONE;
 103         }
 104         prop_end = prop + (len / sizeof(*prop));
 105
 106         prop_addr = prop + (index * (na + ns));
 107         prop_size = prop_addr + na;
 108         prop_after_size = prop_size + ns;
 109         if (prop_after_size > prop_end) {
 110                 debug("(not enough data: expected >= %d cells, got %d cells)\n",
 111                       (u32)(prop_after_size - prop), ((u32)(prop_end - prop)));
 112                 return FDT_ADDR_T_NONE;
 113         }
 114
 115 #if CONFIG_IS_ENABLED(OF_TRANSLATE)
 116         if (translate)
 117                 addr = fdt_translate_address(blob, node, prop_addr);
 118         else
 119 #endif
 120                 addr = fdtdec_get_number(prop_addr, na);
 121
 122         if (sizep) {
 123                 *sizep = fdtdec_get_number(prop_size, ns);
 124                 debug("addr=%08llx, size=%llx\n", (unsigned long long)addr,
 125                       (unsigned long long)*sizep);
 126         } else {
 127                 debug("addr=%08llx\n", (unsigned long long)addr);
 128         }
 129
 130         return addr;
 131 }
 132
 133 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
 134                                             int node, const char *prop_name,
 135                                             int index, fdt_size_t *sizep,
 136                                             bool translate)
 137 {
 138         int na, ns;
 139
 140         debug("%s: ", __func__);
 141
 142         na = fdt_address_cells(blob, parent);
 143         if (na < 1) {
 144                 debug("(bad #address-cells)\n");
 145                 return FDT_ADDR_T_NONE;
 146         }
 147
 148         ns = fdt_size_cells(blob, parent);
 149         if (ns < 0) {
 150                 debug("(bad #size-cells)\n");
 151                 return FDT_ADDR_T_NONE;
 152         }
 153
 154         debug("na=%d, ns=%d, ", na, ns);
 155
 156         return fdtdec_get_addr_size_fixed(blob, node, prop_name, index, na,
 157                                           ns, sizep, translate);
 158 }
 159
 160 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
 161                                               const char *prop_name, int index,
 162                                               fdt_size_t *sizep,
 163                                               bool translate)
 164 {
 165         int parent;
 166
 167         debug("%s: ", __func__);
 168
 169         parent = fdt_parent_offset(blob, node);
 170         if (parent < 0) {
 171                 debug("(no parent found)\n");
 172                 return FDT_ADDR_T_NONE;
 173         }
 174
 175         return fdtdec_get_addr_size_auto_parent(blob, parent, node, prop_name,
 176                                                 index, sizep, translate);
 177 }
 178
 179 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
 180                                 const char *prop_name, fdt_size_t *sizep)
 181 {
 182         int ns = sizep ? (sizeof(fdt_size_t) / sizeof(fdt32_t)) : 0;
 183
 184         return fdtdec_get_addr_size_fixed(blob, node, prop_name, 0,
 185                                           sizeof(fdt_addr_t) / sizeof(fdt32_t),
 186                                           ns, sizep, false);
 187 }
 188
 189 fdt_addr_t fdtdec_get_addr(const void *blob, int node, const char *prop_name)
 190 {
 191         return fdtdec_get_addr_size(blob, node, prop_name, NULL);
 192 }
 193
 194 #if CONFIG_IS_ENABLED(PCI) && defined(CONFIG_DM_PCI)
 195 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
 196 {
 197         const char *list, *end;
 198         int len;
 199
 200         list = fdt_getprop(blob, node, "compatible", &len);
 201         if (!list)
 202                 return -ENOENT;
 203
 204         end = list + len;
 205         while (list < end) {
 206                 len = strlen(list);
 207                 if (len >= strlen("pciVVVV,DDDD")) {
 208                         char *s = strstr(list, "pci");
 209
 210                         /*
 211                          * check if the string is something like pciVVVV,DDDD.RR
 212                          * or just pciVVVV,DDDD
 213                          */
 214                         if (s && s[7] == ',' &&
 215                             (s[12] == '.' || s[12] == 0)) {
 216                                 s += 3;
 217                                 *vendor = simple_strtol(s, NULL, 16);
 218
 219                                 s += 5;
 220                                 *device = simple_strtol(s, NULL, 16);
 221
 222                                 return 0;
 223                         }
 224                 }
 225                 list += (len + 1);
 226         }
 227
 228         return -ENOENT;
 229 }
 230
 231 int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr,
 232                          u32 *bar)
 233 {
 234         int barnum;
 235
 236         /* extract the bar number from fdt_pci_addr */
 237         barnum = addr->phys_hi & 0xff;
 238         if (barnum < PCI_BASE_ADDRESS_0 || barnum > PCI_CARDBUS_CIS)
 239                 return -EINVAL;
 240
 241         barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
 242         *bar = dm_pci_read_bar32(dev, barnum);
 243
 244         return 0;
 245 }
 246
 247 int fdtdec_get_pci_bus_range(const void *blob, int node,
 248                              struct fdt_resource *res)
 249 {
 250         const u32 *values;
 251         int len;
 252
 253         values = fdt_getprop(blob, node, "bus-range", &len);
 254         if (!values || len < sizeof(*values) * 2)
 255                 return -EINVAL;
 256
 257         res->start = fdt32_to_cpu(*values++);
 258         res->end = fdt32_to_cpu(*values);
 259
 260         return 0;
 261 }
 262 #endif
 263
 264 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
 265                            uint64_t default_val)
 266 {
 267         const unaligned_fdt64_t *cell64;
 268         int length;
 269
 270         cell64 = fdt_getprop(blob, node, prop_name, &length);
 271         if (!cell64 || length < sizeof(*cell64))
 272                 return default_val;
 273
 274         return fdt64_to_cpu(*cell64);
 275 }
 276
 277 int fdtdec_get_is_enabled(const void *blob, int node)
 278 {
 279         const char *cell;
 280
 281         /*
 282          * It should say "okay", so only allow that. Some fdts use "ok" but
 283          * this is a bug. Please fix your device tree source file. See here
 284          * for discussion:
 285          *
 286          * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
 287          */
 288         cell = fdt_getprop(blob, node, "status", NULL);
 289         if (cell)
 290                 return strcmp(cell, "okay") == 0;
 291         return 1;
 292 }
 293
 294 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
 295 {
 296         enum fdt_compat_id id;
 297
 298         /* Search our drivers */
 299         for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
 300                 if (fdt_node_check_compatible(blob, node,
 301                                               compat_names[id]) == 0)
 302                         return id;
 303         return COMPAT_UNKNOWN;
 304 }
 305
 306 int fdtdec_next_compatible(const void *blob, int node, enum fdt_compat_id id)
 307 {
 308         return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
 309 }
 310
 311 int fdtdec_next_compatible_subnode(const void *blob, int node,
 312                                    enum fdt_compat_id id, int *depthp)
 313 {
 314         do {
 315                 node = fdt_next_node(blob, node, depthp);
 316         } while (*depthp > 1);
 317
 318         /* If this is a direct subnode, and compatible, return it */
 319         if (*depthp == 1 && 0 == fdt_node_check_compatible(
 320                                                 blob, node, compat_names[id]))
 321                 return node;
 322
 323         return -FDT_ERR_NOTFOUND;
 324 }
 325
 326 int fdtdec_next_alias(const void *blob, const char *name, enum fdt_compat_id id,
 327                       int *upto)
 328 {
 329 #define MAX_STR_LEN 20
 330         char str[MAX_STR_LEN + 20];
 331         int node, err;
 332
 333         /* snprintf() is not available */
 334         assert(strlen(name) < MAX_STR_LEN);
 335         sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
 336         node = fdt_path_offset(blob, str);
 337         if (node < 0)
 338                 return node;
 339         err = fdt_node_check_compatible(blob, node, compat_names[id]);
 340         if (err < 0)
 341                 return err;
 342         if (err)
 343                 return -FDT_ERR_NOTFOUND;
 344         (*upto)++;
 345         return node;
 346 }
 347
 348 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
 349                                enum fdt_compat_id id, int *node_list,
 350                                int maxcount)
 351 {
 352         memset(node_list, '\0', sizeof(*node_list) * maxcount);
 353
 354         return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
 355 }
 356
 357 /* TODO: Can we tighten this code up a little? */
 358 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
 359                               enum fdt_compat_id id, int *node_list,
 360                               int maxcount)
 361 {
 362         int name_len = strlen(name);
 363         int nodes[maxcount];
 364         int num_found = 0;
 365         int offset, node;
 366         int alias_node;
 367         int count;
 368         int i, j;
 369
 370         /* find the alias node if present */
 371         alias_node = fdt_path_offset(blob, "/aliases");
 372
 373         /*
 374          * start with nothing, and we can assume that the root node can't
 375          * match
 376          */
 377         memset(nodes, '\0', sizeof(nodes));
 378
 379         /* First find all the compatible nodes */
 380         for (node = count = 0; node >= 0 && count < maxcount;) {
 381                 node = fdtdec_next_compatible(blob, node, id);
 382                 if (node >= 0)
 383                         nodes[count++] = node;
 384         }
 385         if (node >= 0)
 386                 debug("%s: warning: maxcount exceeded with alias '%s'\n",
 387                       __func__, name);
 388
 389         /* Now find all the aliases */
 390         for (offset = fdt_first_property_offset(blob, alias_node);
 391                         offset > 0;
 392                         offset = fdt_next_property_offset(blob, offset)) {
 393                 const struct fdt_property *prop;
 394                 const char *path;
 395                 int number;
 396                 int found;
 397
 398                 node = 0;
 399                 prop = fdt_get_property_by_offset(blob, offset, NULL);
 400                 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
 401                 if (prop->len && 0 == strncmp(path, name, name_len))
 402                         node = fdt_path_offset(blob, prop->data);
 403                 if (node <= 0)
 404                         continue;
 405
 406                 /* Get the alias number */
 407                 number = simple_strtoul(path + name_len, NULL, 10);
 408                 if (number < 0 || number >= maxcount) {
 409                         debug("%s: warning: alias '%s' is out of range\n",
 410                               __func__, path);
 411                         continue;
 412                 }
 413
 414                 /* Make sure the node we found is actually in our list! */
 415                 found = -1;
 416                 for (j = 0; j < count; j++)
 417                         if (nodes[j] == node) {
 418                                 found = j;
 419                                 break;
 420                         }
 421
 422                 if (found == -1) {
 423                         debug("%s: warning: alias '%s' points to a node "
 424                                 "'%s' that is missing or is not compatible "
 425                                 " with '%s'\n", __func__, path,
 426                                 fdt_get_name(blob, node, NULL),
 427                                compat_names[id]);
 428                         continue;
 429                 }
 430
 431                 /*
 432                  * Add this node to our list in the right place, and mark
 433                  * it as done.
 434                  */
 435                 if (fdtdec_get_is_enabled(blob, node)) {
 436                         if (node_list[number]) {
 437                                 debug("%s: warning: alias '%s' requires that "
 438                                       "a node be placed in the list in a "
 439                                       "position which is already filled by "
 440                                       "node '%s'\n", __func__, path,
 441                                       fdt_get_name(blob, node, NULL));
 442                                 continue;
 443                         }
 444                         node_list[number] = node;
 445                         if (number >= num_found)
 446                                 num_found = number + 1;
 447                 }
 448                 nodes[found] = 0;
 449         }
 450
 451         /* Add any nodes not mentioned by an alias */
 452         for (i = j = 0; i < maxcount; i++) {
 453                 if (!node_list[i]) {
 454                         for (; j < maxcount; j++)
 455                                 if (nodes[j] &&
 456                                     fdtdec_get_is_enabled(blob, nodes[j]))
 457                                         break;
 458
 459                         /* Have we run out of nodes to add? */
 460                         if (j == maxcount)
 461                                 break;
 462
 463                         assert(!node_list[i]);
 464                         node_list[i] = nodes[j++];
 465                         if (i >= num_found)
 466                                 num_found = i + 1;
 467                 }
 468         }
 469
 470         return num_found;
 471 }
 472
 473 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
 474                          int *seqp)
 475 {
 476         int base_len = strlen(base);
 477         const char *find_name;
 478         int find_namelen;
 479         int prop_offset;
 480         int aliases;
 481
 482         find_name = fdt_get_name(blob, offset, &find_namelen);
 483         debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
 484
 485         aliases = fdt_path_offset(blob, "/aliases");
 486         for (prop_offset = fdt_first_property_offset(blob, aliases);
 487              prop_offset > 0;
 488              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
 489                 const char *prop;
 490                 const char *name;
 491                 const char *slash;
 492                 int len, val;
 493
 494                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
 495                 debug("   - %s, %s\n", name, prop);
 496                 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
 497                     strncmp(name, base, base_len))
 498                         continue;
 499
 500                 slash = strrchr(prop, '/');
 501                 if (strcmp(slash + 1, find_name))
 502                         continue;
 503                 val = trailing_strtol(name);
 504                 if (val != -1) {
 505                         *seqp = val;
 506                         debug("Found seq %d\n", *seqp);
 507                         return 0;
 508                 }
 509         }
 510
 511         debug("Not found\n");
 512         return -ENOENT;
 513 }
 514
 515 int fdtdec_get_alias_highest_id(const void *blob, const char *base)
 516 {
 517         int base_len = strlen(base);
 518         int prop_offset;
 519         int aliases;
 520         int max = -1;
 521
 522         debug("Looking for highest alias id for '%s'\n", base);
 523
 524         aliases = fdt_path_offset(blob, "/aliases");
 525         for (prop_offset = fdt_first_property_offset(blob, aliases);
 526              prop_offset > 0;
 527              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
 528                 const char *prop;
 529                 const char *name;
 530                 int len, val;
 531
 532                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
 533                 debug("   - %s, %s\n", name, prop);
 534                 if (*prop != '/' || prop[len - 1] ||
 535                     strncmp(name, base, base_len))
 536                         continue;
 537
 538                 val = trailing_strtol(name);
 539                 if (val > max) {
 540                         debug("Found seq %d\n", val);
 541                         max = val;
 542                 }
 543         }
 544
 545         return max;
 546 }
 547
 548 const char *fdtdec_get_chosen_prop(const void *blob, const char *name)
 549 {
 550         int chosen_node;
 551
 552         if (!blob)
 553                 return NULL;
 554         chosen_node = fdt_path_offset(blob, "/chosen");
 555         return fdt_getprop(blob, chosen_node, name, NULL);
 556 }
 557
 558 int fdtdec_get_chosen_node(const void *blob, const char *name)
 559 {
 560         const char *prop;
 561
 562         prop = fdtdec_get_chosen_prop(blob, name);
 563         if (!prop)
 564                 return -FDT_ERR_NOTFOUND;
 565         return fdt_path_offset(blob, prop);
 566 }
 567
 568 int fdtdec_check_fdt(void)
 569 {
 570         /*
 571          * We must have an FDT, but we cannot panic() yet since the console
 572          * is not ready. So for now, just assert(). Boards which need an early
 573          * FDT (prior to console ready) will need to make their own
 574          * arrangements and do their own checks.
 575          */
 576         assert(!fdtdec_prepare_fdt());
 577         return 0;
 578 }
 579
 580 /*
 581  * This function is a little odd in that it accesses global data. At some
 582  * point if the architecture board.c files merge this will make more sense.
 583  * Even now, it is common code.
 584  */
 585 int fdtdec_prepare_fdt(void)
 586 {
 587         if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
 588             fdt_check_header(gd->fdt_blob)) {
 589 #ifdef CONFIG_SPL_BUILD
 590                 puts("Missing DTB\n");
 591 #else
 592                 puts("No valid device tree binary found - please append one to U-Boot binary, use u-boot-dtb.bin or define CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
 593 # ifdef DEBUG
 594                 if (gd->fdt_blob) {
 595                         printf("fdt_blob=%p\n", gd->fdt_blob);
 596                         print_buffer((ulong)gd->fdt_blob, gd->fdt_blob, 4,
 597                                      32, 0);
 598                 }
 599 # endif
 600 #endif
 601                 return -1;
 602         }
 603         return 0;
 604 }
 605
 606 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
 607 {
 608         const u32 *phandle;
 609         int lookup;
 610
 611         debug("%s: %s\n", __func__, prop_name);
 612         phandle = fdt_getprop(blob, node, prop_name, NULL);
 613         if (!phandle)
 614                 return -FDT_ERR_NOTFOUND;
 615
 616         lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
 617         return lookup;
 618 }
 619
 620 /**
 621  * Look up a property in a node and check that it has a minimum length.
 622  *
 623  * @param blob          FDT blob
 624  * @param node          node to examine
 625  * @param prop_name     name of property to find
 626  * @param min_len       minimum property length in bytes
 627  * @param err           0 if ok, or -FDT_ERR_NOTFOUND if the property is not
 628                         found, or -FDT_ERR_BADLAYOUT if not enough data
 629  * @return pointer to cell, which is only valid if err == 0
 630  */
 631 static const void *get_prop_check_min_len(const void *blob, int node,
 632                                           const char *prop_name, int min_len,
 633                                           int *err)
 634 {
 635         const void *cell;
 636         int len;
 637
 638         debug("%s: %s\n", __func__, prop_name);
 639         cell = fdt_getprop(blob, node, prop_name, &len);
 640         if (!cell)
 641                 *err = -FDT_ERR_NOTFOUND;
 642         else if (len < min_len)
 643                 *err = -FDT_ERR_BADLAYOUT;
 644         else
 645                 *err = 0;
 646         return cell;
 647 }
 648
 649 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
 650                          u32 *array, int count)
 651 {
 652         const u32 *cell;
 653         int err = 0;
 654
 655         debug("%s: %s\n", __func__, prop_name);
 656         cell = get_prop_check_min_len(blob, node, prop_name,
 657                                       sizeof(u32) * count, &err);
 658         if (!err) {
 659                 int i;
 660
 661                 for (i = 0; i < count; i++)
 662                         array[i] = fdt32_to_cpu(cell[i]);
 663         }
 664         return err;
 665 }
 666
 667 int fdtdec_get_int_array_count(const void *blob, int node,
 668                                const char *prop_name, u32 *array, int count)
 669 {
 670         const u32 *cell;
 671         int len, elems;
 672         int i;
 673
 674         debug("%s: %s\n", __func__, prop_name);
 675         cell = fdt_getprop(blob, node, prop_name, &len);
 676         if (!cell)
 677                 return -FDT_ERR_NOTFOUND;
 678         elems = len / sizeof(u32);
 679         if (count > elems)
 680                 count = elems;
 681         for (i = 0; i < count; i++)
 682                 array[i] = fdt32_to_cpu(cell[i]);
 683
 684         return count;
 685 }
 686
 687 const u32 *fdtdec_locate_array(const void *blob, int node,
 688                                const char *prop_name, int count)
 689 {
 690         const u32 *cell;
 691         int err;
 692
 693         cell = get_prop_check_min_len(blob, node, prop_name,
 694                                       sizeof(u32) * count, &err);
 695         return err ? NULL : cell;
 696 }
 697
 698 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
 699 {
 700         const s32 *cell;
 701         int len;
 702
 703         debug("%s: %s\n", __func__, prop_name);
 704         cell = fdt_getprop(blob, node, prop_name, &len);
 705         return cell != NULL;
 706 }
 707
 708 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
 709                                    const char *list_name,
 710                                    const char *cells_name,
 711                                    int cell_count, int index,
 712                                    struct fdtdec_phandle_args *out_args)
 713 {
 714         const __be32 *list, *list_end;
 715         int rc = 0, size, cur_index = 0;
 716         uint32_t count = 0;
 717         int node = -1;
 718         int phandle;
 719
 720         /* Retrieve the phandle list property */
 721         list = fdt_getprop(blob, src_node, list_name, &size);
 722         if (!list)
 723                 return -ENOENT;
 724         list_end = list + size / sizeof(*list);
 725
 726         /* Loop over the phandles until all the requested entry is found */
 727         while (list < list_end) {
 728                 rc = -EINVAL;
 729                 count = 0;
 730
 731                 /*
 732                  * If phandle is 0, then it is an empty entry with no
 733                  * arguments.  Skip forward to the next entry.
 734                  */
 735                 phandle = be32_to_cpup(list++);
 736                 if (phandle) {
 737                         /*
 738                          * Find the provider node and parse the #*-cells
 739                          * property to determine the argument length.
 740                          *
 741                          * This is not needed if the cell count is hard-coded
 742                          * (i.e. cells_name not set, but cell_count is set),
 743                          * except when we're going to return the found node
 744                          * below.
 745                          */
 746                         if (cells_name || cur_index == index) {
 747                                 node = fdt_node_offset_by_phandle(blob,
 748                                                                   phandle);
 749                                 if (node < 0) {
 750                                         debug("%s: could not find phandle\n",
 751                                               fdt_get_name(blob, src_node,
 752                                                            NULL));
 753                                         goto err;
 754                                 }
 755                         }
 756
 757                         if (cells_name) {
 758                                 count = fdtdec_get_int(blob, node, cells_name,
 759                                                        -1);
 760                                 if (count == -1) {
 761                                         debug("%s: could not get %s for %s\n",
 762                                               fdt_get_name(blob, src_node,
 763                                                            NULL),
 764                                               cells_name,
 765                                               fdt_get_name(blob, node,
 766                                                            NULL));
 767                                         goto err;
 768                                 }
 769                         } else {
 770                                 count = cell_count;
 771                         }
 772
 773                         /*
 774                          * Make sure that the arguments actually fit in the
 775                          * remaining property data length
 776                          */
 777                         if (list + count > list_end) {
 778                                 debug("%s: arguments longer than property\n",
 779                                       fdt_get_name(blob, src_node, NULL));
 780                                 goto err;
 781                         }
 782                 }
 783
 784                 /*
 785                  * All of the error cases above bail out of the loop, so at
 786                  * this point, the parsing is successful. If the requested
 787                  * index matches, then fill the out_args structure and return,
 788                  * or return -ENOENT for an empty entry.
 789                  */
 790                 rc = -ENOENT;
 791                 if (cur_index == index) {
 792                         if (!phandle)
 793                                 goto err;
 794
 795                         if (out_args) {
 796                                 int i;
 797
 798                                 if (count > MAX_PHANDLE_ARGS) {
 799                                         debug("%s: too many arguments %d\n",
 800                                               fdt_get_name(blob, src_node,
 801                                                            NULL), count);
 802                                         count = MAX_PHANDLE_ARGS;
 803                                 }
 804                                 out_args->node = node;
 805                                 out_args->args_count = count;
 806                                 for (i = 0; i < count; i++) {
 807                                         out_args->args[i] =
 808                                                         be32_to_cpup(list++);
 809                                 }
 810                         }
 811
 812                         /* Found it! return success */
 813                         return 0;
 814                 }
 815
 816                 node = -1;
 817                 list += count;
 818                 cur_index++;
 819         }
 820
 821         /*
 822          * Result will be one of:
 823          * -ENOENT : index is for empty phandle
 824          * -EINVAL : parsing error on data
 825          * [1..n]  : Number of phandle (count mode; when index = -1)
 826          */
 827         rc = index < 0 ? cur_index : -ENOENT;
 828  err:
 829         return rc;
 830 }
 831
 832 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
 833                           u8 *array, int count)
 834 {
 835         const u8 *cell;
 836         int err;
 837
 838         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 839         if (!err)
 840                 memcpy(array, cell, count);
 841         return err;
 842 }
 843
 844 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
 845                                    const char *prop_name, int count)
 846 {
 847         const u8 *cell;
 848         int err;
 849
 850         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 851         if (err)
 852                 return NULL;
 853         return cell;
 854 }
 855
 856 int fdtdec_get_config_int(const void *blob, const char *prop_name,
 857                           int default_val)
 858 {
 859         int config_node;
 860
 861         debug("%s: %s\n", __func__, prop_name);
 862         config_node = fdt_path_offset(blob, "/config");
 863         if (config_node < 0)
 864                 return default_val;
 865         return fdtdec_get_int(blob, config_node, prop_name, default_val);
 866 }
 867
 868 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
 869 {
 870         int config_node;
 871         const void *prop;
 872
 873         debug("%s: %s\n", __func__, prop_name);
 874         config_node = fdt_path_offset(blob, "/config");
 875         if (config_node < 0)
 876                 return 0;
 877         prop = fdt_get_property(blob, config_node, prop_name, NULL);
 878
 879         return prop != NULL;
 880 }
 881
 882 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
 883 {
 884         const char *nodep;
 885         int nodeoffset;
 886         int len;
 887
 888         debug("%s: %s\n", __func__, prop_name);
 889         nodeoffset = fdt_path_offset(blob, "/config");
 890         if (nodeoffset < 0)
 891                 return NULL;
 892
 893         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
 894         if (!nodep)
 895                 return NULL;
 896
 897         return (char *)nodep;
 898 }
 899
 900 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
 901 {
 902         u64 number = 0;
 903
 904         while (cells--)
 905                 number = (number << 32) | fdt32_to_cpu(*ptr++);
 906
 907         return number;
 908 }
 909
 910 int fdt_get_resource(const void *fdt, int node, const char *property,
 911                      unsigned int index, struct fdt_resource *res)
 912 {
 913         const fdt32_t *ptr, *end;
 914         int na, ns, len, parent;
 915         unsigned int i = 0;
 916
 917         parent = fdt_parent_offset(fdt, node);
 918         if (parent < 0)
 919                 return parent;
 920
 921         na = fdt_address_cells(fdt, parent);
 922         ns = fdt_size_cells(fdt, parent);
 923
 924         ptr = fdt_getprop(fdt, node, property, &len);
 925         if (!ptr)
 926                 return len;
 927
 928         end = ptr + len / sizeof(*ptr);
 929
 930         while (ptr + na + ns <= end) {
 931                 if (i == index) {
 932                         res->start = fdtdec_get_number(ptr, na);
 933                         res->end = res->start;
 934                         res->end += fdtdec_get_number(&ptr[na], ns) - 1;
 935                         return 0;
 936                 }
 937
 938                 ptr += na + ns;
 939                 i++;
 940         }
 941
 942         return -FDT_ERR_NOTFOUND;
 943 }
 944
 945 int fdt_get_named_resource(const void *fdt, int node, const char *property,
 946                            const char *prop_names, const char *name,
 947                            struct fdt_resource *res)
 948 {
 949         int index;
 950
 951         index = fdt_stringlist_search(fdt, node, prop_names, name);
 952         if (index < 0)
 953                 return index;
 954
 955         return fdt_get_resource(fdt, node, property, index, res);
 956 }
 957
 958 static int decode_timing_property(const void *blob, int node, const char *name,
 959                                   struct timing_entry *result)
 960 {
 961         int length, ret = 0;
 962         const u32 *prop;
 963
 964         prop = fdt_getprop(blob, node, name, &length);
 965         if (!prop) {
 966                 debug("%s: could not find property %s\n",
 967                       fdt_get_name(blob, node, NULL), name);
 968                 return length;
 969         }
 970
 971         if (length == sizeof(u32)) {
 972                 result->typ = fdtdec_get_int(blob, node, name, 0);
 973                 result->min = result->typ;
 974                 result->max = result->typ;
 975         } else {
 976                 ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
 977         }
 978
 979         return ret;
 980 }
 981
 982 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
 983                                  struct display_timing *dt)
 984 {
 985         int i, node, timings_node;
 986         u32 val = 0;
 987         int ret = 0;
 988
 989         timings_node = fdt_subnode_offset(blob, parent, "display-timings");
 990         if (timings_node < 0)
 991                 return timings_node;
 992
 993         for (i = 0, node = fdt_first_subnode(blob, timings_node);
 994              node > 0 && i != index;
 995              node = fdt_next_subnode(blob, node))
 996                 i++;
 997
 998         if (node < 0)
 999                 return node;
1000
1001         memset(dt, 0, sizeof(*dt));
1002
1003         ret |= decode_timing_property(blob, node, "hback-porch",
1004                                       &dt->hback_porch);
1005         ret |= decode_timing_property(blob, node, "hfront-porch",
1006                                       &dt->hfront_porch);
1007         ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1008         ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1009         ret |= decode_timing_property(blob, node, "vback-porch",
1010                                       &dt->vback_porch);
1011         ret |= decode_timing_property(blob, node, "vfront-porch",
1012                                       &dt->vfront_porch);
1013         ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1014         ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1015         ret |= decode_timing_property(blob, node, "clock-frequency",
1016                                       &dt->pixelclock);
1017
1018         dt->flags = 0;
1019         val = fdtdec_get_int(blob, node, "vsync-active", -1);
1020         if (val != -1) {
1021                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1022                                 DISPLAY_FLAGS_VSYNC_LOW;
1023         }
1024         val = fdtdec_get_int(blob, node, "hsync-active", -1);
1025         if (val != -1) {
1026                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1027                                 DISPLAY_FLAGS_HSYNC_LOW;
1028         }
1029         val = fdtdec_get_int(blob, node, "de-active", -1);
1030         if (val != -1) {
1031                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1032                                 DISPLAY_FLAGS_DE_LOW;
1033         }
1034         val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1035         if (val != -1) {
1036                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1037                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1038         }
1039
1040         if (fdtdec_get_bool(blob, node, "interlaced"))
1041                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
1042         if (fdtdec_get_bool(blob, node, "doublescan"))
1043                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1044         if (fdtdec_get_bool(blob, node, "doubleclk"))
1045                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1046
1047         return ret;
1048 }
1049
1050 int fdtdec_setup_mem_size_base(void)
1051 {
1052         int ret;
1053         ofnode mem;
1054         struct resource res;
1055
1056         mem = ofnode_path("/memory");
1057         if (!ofnode_valid(mem)) {
1058                 debug("%s: Missing /memory node\n", __func__);
1059                 return -EINVAL;
1060         }
1061
1062         ret = ofnode_read_resource(mem, 0, &res);
1063         if (ret != 0) {
1064                 debug("%s: Unable to decode first memory bank\n", __func__);
1065                 return -EINVAL;
1066         }
1067
1068         gd->ram_size = (phys_size_t)(res.end - res.start + 1);
1069         gd->ram_base = (unsigned long)res.start;
1070         debug("%s: Initial DRAM size %llx\n", __func__,
1071               (unsigned long long)gd->ram_size);
1072
1073         return 0;
1074 }
1075
1076 ofnode get_next_memory_node(ofnode mem)
1077 {
1078         do {
1079                 mem = ofnode_by_prop_value(mem, "device_type", "memory", 7);
1080         } while (!ofnode_is_available(mem));
1081
1082         return mem;
1083 }
1084
1085 int fdtdec_setup_memory_banksize(void)
1086 {
1087         int bank, ret, reg = 0;
1088         struct resource res;
1089         ofnode mem = ofnode_null();
1090
1091         mem = get_next_memory_node(mem);
1092         if (!ofnode_valid(mem)) {
1093                 debug("%s: Missing /memory node\n", __func__);
1094                 return -EINVAL;
1095         }
1096
1097         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
1098                 ret = ofnode_read_resource(mem, reg++, &res);
1099                 if (ret < 0) {
1100                         reg = 0;
1101                         mem = get_next_memory_node(mem);
1102                         if (!ofnode_valid(mem))
1103                                 break;
1104
1105                         ret = ofnode_read_resource(mem, reg++, &res);
1106                         if (ret < 0)
1107                                 break;
1108                 }
1109
1110                 if (ret != 0)
1111                         return -EINVAL;
1112
1113                 gd->bd->bi_dram[bank].start = (phys_addr_t)res.start;
1114                 gd->bd->bi_dram[bank].size =
1115                         (phys_size_t)(res.end - res.start + 1);
1116
1117                 debug("%s: DRAM Bank #%d: start = 0x%llx, size = 0x%llx\n",
1118                       __func__, bank,
1119                       (unsigned long long)gd->bd->bi_dram[bank].start,
1120                       (unsigned long long)gd->bd->bi_dram[bank].size);
1121         }
1122
1123         return 0;
1124 }
1125
1126 int fdtdec_setup_mem_size_base_lowest(void)
1127 {
1128         int bank, ret, reg = 0;
1129         struct resource res;
1130         unsigned long base;
1131         phys_size_t size;
1132         ofnode mem = ofnode_null();
1133
1134         gd->ram_base = (unsigned long)~0;
1135
1136         mem = get_next_memory_node(mem);
1137         if (!ofnode_valid(mem)) {
1138                 debug("%s: Missing /memory node\n", __func__);
1139                 return -EINVAL;
1140         }
1141
1142         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
1143                 ret = ofnode_read_resource(mem, reg++, &res);
1144                 if (ret < 0) {
1145                         reg = 0;
1146                         mem = get_next_memory_node(mem);
1147                         if (!ofnode_valid(mem))
1148                                 break;
1149
1150                         ret = ofnode_read_resource(mem, reg++, &res);
1151                         if (ret < 0)
1152                                 break;
1153                 }
1154
1155                 if (ret != 0)
1156                         return -EINVAL;
1157
1158                 base = (unsigned long)res.start;
1159                 size = (phys_size_t)(res.end - res.start + 1);
1160
1161                 if (gd->ram_base > base && size) {
1162                         gd->ram_base = base;
1163                         gd->ram_size = size;
1164                         debug("%s: Initial DRAM base %lx size %lx\n",
1165                               __func__, base, (unsigned long)size);
1166                 }
1167         }
1168
1169         return 0;
1170 }
1171
1172 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1173 # if CONFIG_IS_ENABLED(MULTI_DTB_FIT_GZIP) ||\
1174         CONFIG_IS_ENABLED(MULTI_DTB_FIT_LZO)
1175 static int uncompress_blob(const void *src, ulong sz_src, void **dstp)
1176 {
1177         size_t sz_out = CONFIG_VAL(MULTI_DTB_FIT_UNCOMPRESS_SZ);
1178         bool gzip = 0, lzo = 0;
1179         ulong sz_in = sz_src;
1180         void *dst;
1181         int rc;
1182
1183         if (CONFIG_IS_ENABLED(GZIP))
1184                 if (gzip_parse_header(src, sz_in) >= 0)
1185                         gzip = 1;
1186         if (CONFIG_IS_ENABLED(LZO))
1187                 if (!gzip && lzop_is_valid_header(src))
1188                         lzo = 1;
1189
1190         if (!gzip && !lzo)
1191                 return -EBADMSG;
1192
1193
1194         if (CONFIG_IS_ENABLED(MULTI_DTB_FIT_DYN_ALLOC)) {
1195                 dst = malloc(sz_out);
1196                 if (!dst) {
1197                         puts("uncompress_blob: Unable to allocate memory\n");
1198                         return -ENOMEM;
1199                 }
1200         } else  {
1201 #  if CONFIG_IS_ENABLED(MULTI_DTB_FIT_USER_DEFINED_AREA)
1202                 dst = (void *)CONFIG_VAL(MULTI_DTB_FIT_USER_DEF_ADDR);
1203 #  else
1204                 return -ENOTSUPP;
1205 #  endif
1206         }
1207
1208         if (CONFIG_IS_ENABLED(GZIP) && gzip)
1209                 rc = gunzip(dst, sz_out, (u8 *)src, &sz_in);
1210         else if (CONFIG_IS_ENABLED(LZO) && lzo)
1211                 rc = lzop_decompress(src, sz_in, dst, &sz_out);
1212         else
1213                 hang();
1214
1215         if (rc < 0) {
1216                 /* not a valid compressed blob */
1217                 puts("uncompress_blob: Unable to uncompress\n");
1218                 if (CONFIG_IS_ENABLED(MULTI_DTB_FIT_DYN_ALLOC))
1219                         free(dst);
1220                 return -EBADMSG;
1221         }
1222         *dstp = dst;
1223         return 0;
1224 }
1225 # else
1226 static int uncompress_blob(const void *src, ulong sz_src, void **dstp)
1227 {
1228         *dstp = (void *)src;
1229         return 0;
1230 }
1231 # endif
1232 #endif
1233
1234 #if defined(CONFIG_OF_BOARD) || defined(CONFIG_OF_SEPARATE)
1235 /*
1236  * For CONFIG_OF_SEPARATE, the board may optionally implement this to
1237  * provide and/or fixup the fdt.
1238  */
1239 __weak void *board_fdt_blob_setup(void)
1240 {
1241         void *fdt_blob = NULL;
1242 #ifdef CONFIG_SPL_BUILD
1243         /* FDT is at end of BSS unless it is in a different memory region */
1244         if (IS_ENABLED(CONFIG_SPL_SEPARATE_BSS))
1245                 fdt_blob = (ulong *)&_image_binary_end;
1246         else
1247                 fdt_blob = (ulong *)&__bss_end;
1248 #else
1249         /* FDT is at end of image */
1250         fdt_blob = (ulong *)&_end;
1251 #endif
1252         return fdt_blob;
1253 }
1254 #endif
1255
1256 int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size)
1257 {
1258         const char *path;
1259         int offset, err;
1260
1261         if (!is_valid_ethaddr(mac))
1262                 return -EINVAL;
1263
1264         path = fdt_get_alias(fdt, "ethernet");
1265         if (!path)
1266                 return 0;
1267
1268         debug("ethernet alias found: %s\n", path);
1269
1270         offset = fdt_path_offset(fdt, path);
1271         if (offset < 0) {
1272                 debug("ethernet alias points to absent node %s\n", path);
1273                 return -ENOENT;
1274         }
1275
1276         err = fdt_setprop_inplace(fdt, offset, "local-mac-address", mac, size);
1277         if (err < 0)
1278                 return err;
1279
1280         debug("MAC address: %pM\n", mac);
1281
1282         return 0;
1283 }
1284
1285 static int fdtdec_init_reserved_memory(void *blob)
1286 {
1287         int na, ns, node, err;
1288         fdt32_t value;
1289
1290         /* inherit #address-cells and #size-cells from the root node */
1291         na = fdt_address_cells(blob, 0);
1292         ns = fdt_size_cells(blob, 0);
1293
1294         node = fdt_add_subnode(blob, 0, "reserved-memory");
1295         if (node < 0)
1296                 return node;
1297
1298         err = fdt_setprop(blob, node, "ranges", NULL, 0);
1299         if (err < 0)
1300                 return err;
1301
1302         value = cpu_to_fdt32(ns);
1303
1304         err = fdt_setprop(blob, node, "#size-cells", &value, sizeof(value));
1305         if (err < 0)
1306                 return err;
1307
1308         value = cpu_to_fdt32(na);
1309
1310         err = fdt_setprop(blob, node, "#address-cells", &value, sizeof(value));
1311         if (err < 0)
1312                 return err;
1313
1314         return node;
1315 }
1316
1317 int fdtdec_add_reserved_memory(void *blob, const char *basename,
1318                                const struct fdt_memory *carveout,
1319                                uint32_t *phandlep, bool no_map)
1320 {
1321         fdt32_t cells[4] = {}, *ptr = cells;
1322         uint32_t upper, lower, phandle;
1323         int parent, node, na, ns, err;
1324         fdt_size_t size;
1325         char name[64];
1326
1327         /* create an empty /reserved-memory node if one doesn't exist */
1328         parent = fdt_path_offset(blob, "/reserved-memory");
1329         if (parent < 0) {
1330                 parent = fdtdec_init_reserved_memory(blob);
1331                 if (parent < 0)
1332                         return parent;
1333         }
1334
1335         /* only 1 or 2 #address-cells and #size-cells are supported */
1336         na = fdt_address_cells(blob, parent);
1337         if (na < 1 || na > 2)
1338                 return -FDT_ERR_BADNCELLS;
1339
1340         ns = fdt_size_cells(blob, parent);
1341         if (ns < 1 || ns > 2)
1342                 return -FDT_ERR_BADNCELLS;
1343
1344         /* find a matching node and return the phandle to that */
1345         fdt_for_each_subnode(node, blob, parent) {
1346                 const char *name = fdt_get_name(blob, node, NULL);
1347                 fdt_addr_t addr;
1348                 fdt_size_t size;
1349
1350                 addr = fdtdec_get_addr_size_fixed(blob, node, "reg", 0, na, ns,
1351                                                   &size, false);
1352                 if (addr == FDT_ADDR_T_NONE) {
1353                         debug("failed to read address/size for %s\n", name);
1354                         continue;
1355                 }
1356
1357                 if (addr == carveout->start && (addr + size - 1) ==
1358                                                 carveout->end) {
1359                         if (phandlep)
1360                                 *phandlep = fdt_get_phandle(blob, node);
1361                         return 0;
1362                 }
1363         }
1364
1365         /*
1366          * Unpack the start address and generate the name of the new node
1367          * base on the basename and the unit-address.
1368          */
1369         upper = upper_32_bits(carveout->start);
1370         lower = lower_32_bits(carveout->start);
1371
1372         if (na > 1 && upper > 0)
1373                 snprintf(name, sizeof(name), "%s@%x,%x", basename, upper,
1374                          lower);
1375         else {
1376                 if (upper > 0) {
1377                         debug("address %08x:%08x exceeds addressable space\n",
1378                               upper, lower);
1379                         return -FDT_ERR_BADVALUE;
1380                 }
1381
1382                 snprintf(name, sizeof(name), "%s@%x", basename, lower);
1383         }
1384
1385         node = fdt_add_subnode(blob, parent, name);
1386         if (node < 0)
1387                 return node;
1388
1389         if (phandlep) {
1390                 err = fdt_generate_phandle(blob, &phandle);
1391                 if (err < 0)
1392                         return err;
1393
1394                 err = fdtdec_set_phandle(blob, node, phandle);
1395                 if (err < 0)
1396                         return err;
1397         }
1398
1399         /* store one or two address cells */
1400         if (na > 1)
1401                 *ptr++ = cpu_to_fdt32(upper);
1402
1403         *ptr++ = cpu_to_fdt32(lower);
1404
1405         /* store one or two size cells */
1406         size = carveout->end - carveout->start + 1;
1407         upper = upper_32_bits(size);
1408         lower = lower_32_bits(size);
1409
1410         if (ns > 1)
1411                 *ptr++ = cpu_to_fdt32(upper);
1412
1413         *ptr++ = cpu_to_fdt32(lower);
1414
1415         err = fdt_setprop(blob, node, "reg", cells, (na + ns) * sizeof(*cells));
1416         if (err < 0)
1417                 return err;
1418
1419         if (no_map) {
1420                 err = fdt_setprop(blob, node, "no-map", NULL, 0);
1421                 if (err < 0)
1422                         return err;
1423         }
1424
1425         /* return the phandle for the new node for the caller to use */
1426         if (phandlep)
1427                 *phandlep = phandle;
1428
1429         return 0;
1430 }
1431
1432 int fdtdec_get_carveout(const void *blob, const char *node, const char *name,
1433                         unsigned int index, struct fdt_memory *carveout)
1434 {
1435         const fdt32_t *prop;
1436         uint32_t phandle;
1437         int offset, len;
1438         fdt_size_t size;
1439
1440         offset = fdt_path_offset(blob, node);
1441         if (offset < 0)
1442                 return offset;
1443
1444         prop = fdt_getprop(blob, offset, name, &len);
1445         if (!prop) {
1446                 debug("failed to get %s for %s\n", name, node);
1447                 return -FDT_ERR_NOTFOUND;
1448         }
1449
1450         if ((len % sizeof(phandle)) != 0) {
1451                 debug("invalid phandle property\n");
1452                 return -FDT_ERR_BADPHANDLE;
1453         }
1454
1455         if (len < (sizeof(phandle) * (index + 1))) {
1456                 debug("invalid phandle index\n");
1457                 return -FDT_ERR_BADPHANDLE;
1458         }
1459
1460         phandle = fdt32_to_cpu(prop[index]);
1461
1462         offset = fdt_node_offset_by_phandle(blob, phandle);
1463         if (offset < 0) {
1464                 debug("failed to find node for phandle %u\n", phandle);
1465                 return offset;
1466         }
1467
1468         carveout->start = fdtdec_get_addr_size_auto_noparent(blob, offset,
1469                                                              "reg", 0, &size,
1470                                                              true);
1471         if (carveout->start == FDT_ADDR_T_NONE) {
1472                 debug("failed to read address/size from \"reg\" property\n");
1473                 return -FDT_ERR_NOTFOUND;
1474         }
1475
1476         carveout->end = carveout->start + size - 1;
1477
1478         return 0;
1479 }
1480
1481 int fdtdec_set_carveout(void *blob, const char *node, const char *prop_name,
1482                         unsigned int index, const char *name,
1483                         const struct fdt_memory *carveout)
1484 {
1485         uint32_t phandle;
1486         int err, offset, len;
1487         fdt32_t value;
1488         void *prop;
1489
1490         err = fdtdec_add_reserved_memory(blob, name, carveout, &phandle, false);
1491         if (err < 0) {
1492                 debug("failed to add reserved memory: %d\n", err);
1493                 return err;
1494         }
1495
1496         offset = fdt_path_offset(blob, node);
1497         if (offset < 0) {
1498                 debug("failed to find offset for node %s: %d\n", node, offset);
1499                 return offset;
1500         }
1501
1502         value = cpu_to_fdt32(phandle);
1503
1504         if (!fdt_getprop(blob, offset, prop_name, &len)) {
1505                 if (len == -FDT_ERR_NOTFOUND)
1506                         len = 0;
1507                 else
1508                         return len;
1509         }
1510
1511         if ((index + 1) * sizeof(value) > len) {
1512                 err = fdt_setprop_placeholder(blob, offset, prop_name,
1513                                               (index + 1) * sizeof(value),
1514                                               &prop);
1515                 if (err < 0) {
1516                         debug("failed to resize reserved memory property: %s\n",
1517                               fdt_strerror(err));
1518                         return err;
1519                 }
1520         }
1521
1522         err = fdt_setprop_inplace_namelen_partial(blob, offset, prop_name,
1523                                                   strlen(prop_name),
1524                                                   index * sizeof(value),
1525                                                   &value, sizeof(value));
1526         if (err < 0) {
1527                 debug("failed to update %s property for node %s: %s\n",
1528                       prop_name, node, fdt_strerror(err));
1529                 return err;
1530         }
1531
1532         return 0;
1533 }
1534
1535 __weak int fdtdec_board_setup(const void *fdt_blob)
1536 {
1537         return 0;
1538 }
1539
1540 int fdtdec_setup(void)
1541 {
1542         int ret;
1543 #if CONFIG_IS_ENABLED(OF_CONTROL)
1544 # if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1545         void *fdt_blob;
1546 # endif
1547 # ifdef CONFIG_OF_EMBED
1548         /* Get a pointer to the FDT */
1549 #  ifdef CONFIG_SPL_BUILD
1550         gd->fdt_blob = __dtb_dt_spl_begin;
1551 #  else
1552         gd->fdt_blob = __dtb_dt_begin;
1553 #  endif
1554 # elif defined(CONFIG_OF_BOARD) || defined(CONFIG_OF_SEPARATE)
1555         /* Allow the board to override the fdt address. */
1556         gd->fdt_blob = board_fdt_blob_setup();
1557 # elif defined(CONFIG_OF_HOSTFILE)
1558         if (sandbox_read_fdt_from_file()) {
1559                 puts("Failed to read control FDT\n");
1560                 return -1;
1561         }
1562 # elif defined(CONFIG_OF_PRIOR_STAGE)
1563         gd->fdt_blob = (void *)prior_stage_fdt_address;
1564 # endif
1565 # ifndef CONFIG_SPL_BUILD
1566         /* Allow the early environment to override the fdt address */
1567         gd->fdt_blob = map_sysmem
1568                 (env_get_ulong("fdtcontroladdr", 16,
1569                                (unsigned long)map_to_sysmem(gd->fdt_blob)), 0);
1570 # endif
1571
1572 # if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1573         /*
1574          * Try and uncompress the blob.
1575          * Unfortunately there is no way to know how big the input blob really
1576          * is. So let us set the maximum input size arbitrarily high. 16MB
1577          * ought to be more than enough for packed DTBs.
1578          */
1579         if (uncompress_blob(gd->fdt_blob, 0x1000000, &fdt_blob) == 0)
1580                 gd->fdt_blob = fdt_blob;
1581
1582         /*
1583          * Check if blob is a FIT images containings DTBs.
1584          * If so, pick the most relevant
1585          */
1586         fdt_blob = locate_dtb_in_fit(gd->fdt_blob);
1587         if (fdt_blob) {
1588                 gd->multi_dtb_fit = gd->fdt_blob;
1589                 gd->fdt_blob = fdt_blob;
1590         }
1591
1592 # endif
1593 #endif
1594
1595         ret = fdtdec_prepare_fdt();
1596         if (!ret)
1597                 ret = fdtdec_board_setup(gd->fdt_blob);
1598         return ret;
1599 }
1600
1601 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1602 int fdtdec_resetup(int *rescan)
1603 {
1604         void *fdt_blob;
1605
1606         /*
1607          * If the current DTB is part of a compressed FIT image,
1608          * try to locate the best match from the uncompressed
1609          * FIT image stillpresent there. Save the time and space
1610          * required to uncompress it again.
1611          */
1612         if (gd->multi_dtb_fit) {
1613                 fdt_blob = locate_dtb_in_fit(gd->multi_dtb_fit);
1614
1615                 if (fdt_blob == gd->fdt_blob) {
1616                         /*
1617                          * The best match did not change. no need to tear down
1618                          * the DM and rescan the fdt.
1619                          */
1620                         *rescan = 0;
1621                         return 0;
1622                 }
1623
1624                 *rescan = 1;
1625                 gd->fdt_blob = fdt_blob;
1626                 return fdtdec_prepare_fdt();
1627         }
1628
1629         /*
1630          * If multi_dtb_fit is NULL, it means that blob appended to u-boot is
1631          * not a FIT image containings DTB, but a single DTB. There is no need
1632          * to teard down DM and rescan the DT in this case.
1633          */
1634         *rescan = 0;
1635         return 0;
1636 }
1637 #endif
1638
1639 int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id,
1640                            phys_addr_t *basep, phys_size_t *sizep,
1641                            struct bd_info *bd)
1642 {
1643         int addr_cells, size_cells;
1644         const u32 *cell, *end;
1645         u64 total_size, size, addr;
1646         int node, child;
1647         bool auto_size;
1648         int bank;
1649         int len;
1650
1651         debug("%s: board_id=%d\n", __func__, board_id);
1652         if (!area)
1653                 area = "/memory";
1654         node = fdt_path_offset(blob, area);
1655         if (node < 0) {
1656                 debug("No %s node found\n", area);
1657                 return -ENOENT;
1658         }
1659
1660         cell = fdt_getprop(blob, node, "reg", &len);
1661         if (!cell) {
1662                 debug("No reg property found\n");
1663                 return -ENOENT;
1664         }
1665
1666         addr_cells = fdt_address_cells(blob, node);
1667         size_cells = fdt_size_cells(blob, node);
1668
1669         /* Check the board id and mask */
1670         for (child = fdt_first_subnode(blob, node);
1671              child >= 0;
1672              child = fdt_next_subnode(blob, child)) {
1673                 int match_mask, match_value;
1674
1675                 match_mask = fdtdec_get_int(blob, child, "match-mask", -1);
1676                 match_value = fdtdec_get_int(blob, child, "match-value", -1);
1677
1678                 if (match_value >= 0 &&
1679                     ((board_id & match_mask) == match_value)) {
1680                         /* Found matching mask */
1681                         debug("Found matching mask %d\n", match_mask);
1682                         node = child;
1683                         cell = fdt_getprop(blob, node, "reg", &len);
1684                         if (!cell) {
1685                                 debug("No memory-banks property found\n");
1686                                 return -EINVAL;
1687                         }
1688                         break;
1689                 }
1690         }
1691         /* Note: if no matching subnode was found we use the parent node */
1692
1693         if (bd) {
1694                 memset(bd->bi_dram, '\0', sizeof(bd->bi_dram[0]) *
1695                                                 CONFIG_NR_DRAM_BANKS);
1696         }
1697
1698         auto_size = fdtdec_get_bool(blob, node, "auto-size");
1699
1700         total_size = 0;
1701         end = cell + len / 4 - addr_cells - size_cells;
1702         debug("cell at %p, end %p\n", cell, end);
1703         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
1704                 if (cell > end)
1705                         break;
1706                 addr = 0;
1707                 if (addr_cells == 2)
1708                         addr += (u64)fdt32_to_cpu(*cell++) << 32UL;
1709                 addr += fdt32_to_cpu(*cell++);
1710                 if (bd)
1711                         bd->bi_dram[bank].start = addr;
1712                 if (basep && !bank)
1713                         *basep = (phys_addr_t)addr;
1714
1715                 size = 0;
1716                 if (size_cells == 2)
1717                         size += (u64)fdt32_to_cpu(*cell++) << 32UL;
1718                 size += fdt32_to_cpu(*cell++);
1719
1720                 if (auto_size) {
1721                         u64 new_size;
1722
1723                         debug("Auto-sizing %llx, size %llx: ", addr, size);
1724                         new_size = get_ram_size((long *)(uintptr_t)addr, size);
1725                         if (new_size == size) {
1726                                 debug("OK\n");
1727                         } else {
1728                                 debug("sized to %llx\n", new_size);
1729                                 size = new_size;
1730                         }
1731                 }
1732
1733                 if (bd)
1734                         bd->bi_dram[bank].size = size;
1735                 total_size += size;
1736         }
1737
1738         debug("Memory size %llu\n", total_size);
1739         if (sizep)
1740                 *sizep = (phys_size_t)total_size;
1741
1742         return 0;
1743 }
1744
1745 #endif /* !USE_HOSTCC */