lib/fdtdec.c

   1 /*
   2  * Copyright (c) 2011 The Chromium OS Authors.
   3  * SPDX-License-Identifier:     GPL-2.0+
   4  */
   5
   6 #ifndef USE_HOSTCC
   7 #include <common.h>
   8 #include <errno.h>
   9 #include <serial.h>
  10 #include <libfdt.h>
  11 #include <fdtdec.h>
  12 #include <asm/sections.h>
  13 #include <linux/ctype.h>
  14
  15 DECLARE_GLOBAL_DATA_PTR;
  16
  17 /*
  18  * Here are the type we know about. One day we might allow drivers to
  19  * register. For now we just put them here. The COMPAT macro allows us to
  20  * turn this into a sparse list later, and keeps the ID with the name.
  21  */
  22 #define COMPAT(id, name) name
  23 static const char * const compat_names[COMPAT_COUNT] = {
  24         COMPAT(UNKNOWN, "<none>"),
  25         COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
  26         COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
  27         COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
  28         COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
  29         COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
  30         COMPAT(NVIDIA_TEGRA124_DC, "nvidia,tegra124-dc"),
  31         COMPAT(NVIDIA_TEGRA124_SOR, "nvidia,tegra124-sor"),
  32         COMPAT(NVIDIA_TEGRA124_PMC, "nvidia,tegra124-pmc"),
  33         COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
  34         COMPAT(NVIDIA_TEGRA210_SDMMC, "nvidia,tegra210-sdhci"),
  35         COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
  36         COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
  37         COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
  38         COMPAT(NVIDIA_TEGRA124_PCIE, "nvidia,tegra124-pcie"),
  39         COMPAT(NVIDIA_TEGRA30_PCIE, "nvidia,tegra30-pcie"),
  40         COMPAT(NVIDIA_TEGRA20_PCIE, "nvidia,tegra20-pcie"),
  41         COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
  42         COMPAT(NVIDIA_TEGRA210_XUSB_PADCTL, "nvidia,tegra210-xusb-padctl"),
  43         COMPAT(SMSC_LAN9215, "smsc,lan9215"),
  44         COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
  45         COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
  46         COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
  47         COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
  48         COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
  49         COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
  50         COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
  51         COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
  52         COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
  53         COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
  54         COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
  55         COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
  56         COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
  57         COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
  58         COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686"),
  59         COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
  60         COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
  61         COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
  62         COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
  63         COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
  64         COMPAT(INTEL_MICROCODE, "intel,microcode"),
  65         COMPAT(MEMORY_SPD, "memory-spd"),
  66         COMPAT(INTEL_PANTHERPOINT_AHCI, "intel,pantherpoint-ahci"),
  67         COMPAT(INTEL_MODEL_206AX, "intel,model-206ax"),
  68         COMPAT(INTEL_GMA, "intel,gma"),
  69         COMPAT(AMS_AS3722, "ams,as3722"),
  70         COMPAT(INTEL_ICH_SPI, "intel,ich-spi"),
  71         COMPAT(INTEL_QRK_MRC, "intel,quark-mrc"),
  72         COMPAT(INTEL_X86_PINCTRL, "intel,x86-pinctrl"),
  73         COMPAT(SOCIONEXT_XHCI, "socionext,uniphier-xhci"),
  74         COMPAT(COMPAT_INTEL_PCH, "intel,bd82x6x"),
  75         COMPAT(COMPAT_INTEL_IRQ_ROUTER, "intel,irq-router"),
  76         COMPAT(ALTERA_SOCFPGA_DWMAC, "altr,socfpga-stmmac"),
  77         COMPAT(ALTERA_SOCFPGA_DWMMC, "altr,socfpga-dw-mshc"),
  78         COMPAT(COMPAT_INTEL_BAYTRAIL_FSP, "intel,baytrail-fsp"),
  79         COMPAT(COMPAT_INTEL_BAYTRAIL_FSP_MDP, "intel,baytrail-fsp-mdp"),
  80 };
  81
  82 const char *fdtdec_get_compatible(enum fdt_compat_id id)
  83 {
  84         /* We allow reading of the 'unknown' ID for testing purposes */
  85         assert(id >= 0 && id < COMPAT_COUNT);
  86         return compat_names[id];
  87 }
  88
  89 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
  90                 const char *prop_name, int index, int na, int ns,
  91                 fdt_size_t *sizep)
  92 {
  93         const fdt32_t *prop, *prop_end;
  94         const fdt32_t *prop_addr, *prop_size, *prop_after_size;
  95         int len;
  96         fdt_addr_t addr;
  97
  98         debug("%s: %s: ", __func__, prop_name);
  99
 100         if (na > (sizeof(fdt_addr_t) / sizeof(fdt32_t))) {
 101                 debug("(na too large for fdt_addr_t type)\n");
 102                 return FDT_ADDR_T_NONE;
 103         }
 104
 105         if (ns > (sizeof(fdt_size_t) / sizeof(fdt32_t))) {
 106                 debug("(ns too large for fdt_size_t type)\n");
 107                 return FDT_ADDR_T_NONE;
 108         }
 109
 110         prop = fdt_getprop(blob, node, prop_name, &len);
 111         if (!prop) {
 112                 debug("(not found)\n");
 113                 return FDT_ADDR_T_NONE;
 114         }
 115         prop_end = prop + (len / sizeof(*prop));
 116
 117         prop_addr = prop + (index * (na + ns));
 118         prop_size = prop_addr + na;
 119         prop_after_size = prop_size + ns;
 120         if (prop_after_size > prop_end) {
 121                 debug("(not enough data: expected >= %d cells, got %d cells)\n",
 122                       (u32)(prop_after_size - prop), ((u32)(prop_end - prop)));
 123                 return FDT_ADDR_T_NONE;
 124         }
 125
 126         addr = fdtdec_get_number(prop_addr, na);
 127
 128         if (sizep) {
 129                 *sizep = fdtdec_get_number(prop_size, ns);
 130                 debug("addr=%08llx, size=%llx\n", (u64)addr, (u64)*sizep);
 131         } else {
 132                 debug("addr=%08llx\n", (u64)addr);
 133         }
 134
 135         return addr;
 136 }
 137
 138 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
 139                 int node, const char *prop_name, int index, fdt_size_t *sizep)
 140 {
 141         int na, ns;
 142
 143         debug("%s: ", __func__);
 144
 145         na = fdt_address_cells(blob, parent);
 146         if (na < 1) {
 147                 debug("(bad #address-cells)\n");
 148                 return FDT_ADDR_T_NONE;
 149         }
 150
 151         ns = fdt_size_cells(blob, parent);
 152         if (ns < 1) {
 153                 debug("(bad #size-cells)\n");
 154                 return FDT_ADDR_T_NONE;
 155         }
 156
 157         debug("na=%d, ns=%d, ", na, ns);
 158
 159         return fdtdec_get_addr_size_fixed(blob, node, prop_name, index, na,
 160                                           ns, sizep);
 161 }
 162
 163 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
 164                 const char *prop_name, int index, fdt_size_t *sizep)
 165 {
 166         int parent;
 167
 168         debug("%s: ", __func__);
 169
 170         parent = fdt_parent_offset(blob, node);
 171         if (parent < 0) {
 172                 debug("(no parent found)\n");
 173                 return FDT_ADDR_T_NONE;
 174         }
 175
 176         return fdtdec_get_addr_size_auto_parent(blob, parent, node, prop_name,
 177                                                 index, sizep);
 178 }
 179
 180 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
 181                 const char *prop_name, fdt_size_t *sizep)
 182 {
 183         return fdtdec_get_addr_size_fixed(blob, node, prop_name, 0,
 184                                           sizeof(fdt_addr_t) / sizeof(fdt32_t),
 185                                           sizeof(fdt_size_t) / sizeof(fdt32_t),
 186                                           sizep);
 187 }
 188
 189 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
 190                 const char *prop_name)
 191 {
 192         return fdtdec_get_addr_size(blob, node, prop_name, NULL);
 193 }
 194
 195 #ifdef CONFIG_PCI
 196 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
 197                 const char *prop_name, struct fdt_pci_addr *addr)
 198 {
 199         const u32 *cell;
 200         int len;
 201         int ret = -ENOENT;
 202
 203         debug("%s: %s: ", __func__, prop_name);
 204
 205         /*
 206          * If we follow the pci bus bindings strictly, we should check
 207          * the value of the node's parent node's #address-cells and
 208          * #size-cells. They need to be 3 and 2 accordingly. However,
 209          * for simplicity we skip the check here.
 210          */
 211         cell = fdt_getprop(blob, node, prop_name, &len);
 212         if (!cell)
 213                 goto fail;
 214
 215         if ((len % FDT_PCI_REG_SIZE) == 0) {
 216                 int num = len / FDT_PCI_REG_SIZE;
 217                 int i;
 218
 219                 for (i = 0; i < num; i++) {
 220                         debug("pci address #%d: %08lx %08lx %08lx\n", i,
 221                               (ulong)fdt_addr_to_cpu(cell[0]),
 222                               (ulong)fdt_addr_to_cpu(cell[1]),
 223                               (ulong)fdt_addr_to_cpu(cell[2]));
 224                         if ((fdt_addr_to_cpu(*cell) & type) == type) {
 225                                 addr->phys_hi = fdt_addr_to_cpu(cell[0]);
 226                                 addr->phys_mid = fdt_addr_to_cpu(cell[1]);
 227                                 addr->phys_lo = fdt_addr_to_cpu(cell[2]);
 228                                 break;
 229                         } else {
 230                                 cell += (FDT_PCI_ADDR_CELLS +
 231                                          FDT_PCI_SIZE_CELLS);
 232                         }
 233                 }
 234
 235                 if (i == num) {
 236                         ret = -ENXIO;
 237                         goto fail;
 238                 }
 239
 240                 return 0;
 241         } else {
 242                 ret = -EINVAL;
 243         }
 244
 245 fail:
 246         debug("(not found)\n");
 247         return ret;
 248 }
 249
 250 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
 251 {
 252         const char *list, *end;
 253         int len;
 254
 255         list = fdt_getprop(blob, node, "compatible", &len);
 256         if (!list)
 257                 return -ENOENT;
 258
 259         end = list + len;
 260         while (list < end) {
 261                 char *s;
 262
 263                 len = strlen(list);
 264                 if (len >= strlen("pciVVVV,DDDD")) {
 265                         s = strstr(list, "pci");
 266
 267                         /*
 268                          * check if the string is something like pciVVVV,DDDD.RR
 269                          * or just pciVVVV,DDDD
 270                          */
 271                         if (s && s[7] == ',' &&
 272                             (s[12] == '.' || s[12] == 0)) {
 273                                 s += 3;
 274                                 *vendor = simple_strtol(s, NULL, 16);
 275
 276                                 s += 5;
 277                                 *device = simple_strtol(s, NULL, 16);
 278
 279                                 return 0;
 280                         }
 281                 }
 282                 list += (len + 1);
 283         }
 284
 285         return -ENOENT;
 286 }
 287
 288 int fdtdec_get_pci_bdf(const void *blob, int node,
 289                 struct fdt_pci_addr *addr, pci_dev_t *bdf)
 290 {
 291         u16 dt_vendor, dt_device, vendor, device;
 292         int ret;
 293
 294         /* get vendor id & device id from the compatible string */
 295         ret = fdtdec_get_pci_vendev(blob, node, &dt_vendor, &dt_device);
 296         if (ret)
 297                 return ret;
 298
 299         /* extract the bdf from fdt_pci_addr */
 300         *bdf = addr->phys_hi & 0xffff00;
 301
 302         /* read vendor id & device id based on bdf */
 303         pci_read_config_word(*bdf, PCI_VENDOR_ID, &vendor);
 304         pci_read_config_word(*bdf, PCI_DEVICE_ID, &device);
 305
 306         /*
 307          * Note there are two places in the device tree to fully describe
 308          * a pci device: one is via compatible string with a format of
 309          * "pciVVVV,DDDD" and the other one is the bdf numbers encoded in
 310          * the device node's reg address property. We read the vendor id
 311          * and device id based on bdf and compare the values with the
 312          * "VVVV,DDDD". If they are the same, then we are good to use bdf
 313          * to read device's bar. But if they are different, we have to rely
 314          * on the vendor id and device id extracted from the compatible
 315          * string and locate the real bdf by pci_find_device(). This is
 316          * because normally we may only know device's device number and
 317          * function number when writing device tree. The bus number is
 318          * dynamically assigned during the pci enumeration process.
 319          */
 320         if ((dt_vendor != vendor) || (dt_device != device)) {
 321                 *bdf = pci_find_device(dt_vendor, dt_device, 0);
 322                 if (*bdf == -1)
 323                         return -ENODEV;
 324         }
 325
 326         return 0;
 327 }
 328
 329 int fdtdec_get_pci_bar32(const void *blob, int node,
 330                 struct fdt_pci_addr *addr, u32 *bar)
 331 {
 332         pci_dev_t bdf;
 333         int barnum;
 334         int ret;
 335
 336         /* get pci devices's bdf */
 337         ret = fdtdec_get_pci_bdf(blob, node, addr, &bdf);
 338         if (ret)
 339                 return ret;
 340
 341         /* extract the bar number from fdt_pci_addr */
 342         barnum = addr->phys_hi & 0xff;
 343         if ((barnum < PCI_BASE_ADDRESS_0) || (barnum > PCI_CARDBUS_CIS))
 344                 return -EINVAL;
 345
 346         barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
 347         *bar = pci_read_bar32(pci_bus_to_hose(PCI_BUS(bdf)), bdf, barnum);
 348
 349         return 0;
 350 }
 351 #endif
 352
 353 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
 354                 uint64_t default_val)
 355 {
 356         const uint64_t *cell64;
 357         int length;
 358
 359         cell64 = fdt_getprop(blob, node, prop_name, &length);
 360         if (!cell64 || length < sizeof(*cell64))
 361                 return default_val;
 362
 363         return fdt64_to_cpu(*cell64);
 364 }
 365
 366 int fdtdec_get_is_enabled(const void *blob, int node)
 367 {
 368         const char *cell;
 369
 370         /*
 371          * It should say "okay", so only allow that. Some fdts use "ok" but
 372          * this is a bug. Please fix your device tree source file. See here
 373          * for discussion:
 374          *
 375          * http://www.mail-archive.com/[email protected]/msg71598.html
 376          */
 377         cell = fdt_getprop(blob, node, "status", NULL);
 378         if (cell)
 379                 return 0 == strcmp(cell, "okay");
 380         return 1;
 381 }
 382
 383 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
 384 {
 385         enum fdt_compat_id id;
 386
 387         /* Search our drivers */
 388         for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
 389                 if (0 == fdt_node_check_compatible(blob, node,
 390                                 compat_names[id]))
 391                         return id;
 392         return COMPAT_UNKNOWN;
 393 }
 394
 395 int fdtdec_next_compatible(const void *blob, int node,
 396                 enum fdt_compat_id id)
 397 {
 398         return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
 399 }
 400
 401 int fdtdec_next_compatible_subnode(const void *blob, int node,
 402                 enum fdt_compat_id id, int *depthp)
 403 {
 404         do {
 405                 node = fdt_next_node(blob, node, depthp);
 406         } while (*depthp > 1);
 407
 408         /* If this is a direct subnode, and compatible, return it */
 409         if (*depthp == 1 && 0 == fdt_node_check_compatible(
 410                                                 blob, node, compat_names[id]))
 411                 return node;
 412
 413         return -FDT_ERR_NOTFOUND;
 414 }
 415
 416 int fdtdec_next_alias(const void *blob, const char *name,
 417                 enum fdt_compat_id id, int *upto)
 418 {
 419 #define MAX_STR_LEN 20
 420         char str[MAX_STR_LEN + 20];
 421         int node, err;
 422
 423         /* snprintf() is not available */
 424         assert(strlen(name) < MAX_STR_LEN);
 425         sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
 426         node = fdt_path_offset(blob, str);
 427         if (node < 0)
 428                 return node;
 429         err = fdt_node_check_compatible(blob, node, compat_names[id]);
 430         if (err < 0)
 431                 return err;
 432         if (err)
 433                 return -FDT_ERR_NOTFOUND;
 434         (*upto)++;
 435         return node;
 436 }
 437
 438 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
 439                         enum fdt_compat_id id, int *node_list, int maxcount)
 440 {
 441         memset(node_list, '\0', sizeof(*node_list) * maxcount);
 442
 443         return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
 444 }
 445
 446 /* TODO: Can we tighten this code up a little? */
 447 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
 448                         enum fdt_compat_id id, int *node_list, int maxcount)
 449 {
 450         int name_len = strlen(name);
 451         int nodes[maxcount];
 452         int num_found = 0;
 453         int offset, node;
 454         int alias_node;
 455         int count;
 456         int i, j;
 457
 458         /* find the alias node if present */
 459         alias_node = fdt_path_offset(blob, "/aliases");
 460
 461         /*
 462          * start with nothing, and we can assume that the root node can't
 463          * match
 464          */
 465         memset(nodes, '\0', sizeof(nodes));
 466
 467         /* First find all the compatible nodes */
 468         for (node = count = 0; node >= 0 && count < maxcount;) {
 469                 node = fdtdec_next_compatible(blob, node, id);
 470                 if (node >= 0)
 471                         nodes[count++] = node;
 472         }
 473         if (node >= 0)
 474                 debug("%s: warning: maxcount exceeded with alias '%s'\n",
 475                        __func__, name);
 476
 477         /* Now find all the aliases */
 478         for (offset = fdt_first_property_offset(blob, alias_node);
 479                         offset > 0;
 480                         offset = fdt_next_property_offset(blob, offset)) {
 481                 const struct fdt_property *prop;
 482                 const char *path;
 483                 int number;
 484                 int found;
 485
 486                 node = 0;
 487                 prop = fdt_get_property_by_offset(blob, offset, NULL);
 488                 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
 489                 if (prop->len && 0 == strncmp(path, name, name_len))
 490                         node = fdt_path_offset(blob, prop->data);
 491                 if (node <= 0)
 492                         continue;
 493
 494                 /* Get the alias number */
 495                 number = simple_strtoul(path + name_len, NULL, 10);
 496                 if (number < 0 || number >= maxcount) {
 497                         debug("%s: warning: alias '%s' is out of range\n",
 498                                __func__, path);
 499                         continue;
 500                 }
 501
 502                 /* Make sure the node we found is actually in our list! */
 503                 found = -1;
 504                 for (j = 0; j < count; j++)
 505                         if (nodes[j] == node) {
 506                                 found = j;
 507                                 break;
 508                         }
 509
 510                 if (found == -1) {
 511                         debug("%s: warning: alias '%s' points to a node "
 512                                 "'%s' that is missing or is not compatible "
 513                                 " with '%s'\n", __func__, path,
 514                                 fdt_get_name(blob, node, NULL),
 515                                compat_names[id]);
 516                         continue;
 517                 }
 518
 519                 /*
 520                  * Add this node to our list in the right place, and mark
 521                  * it as done.
 522                  */
 523                 if (fdtdec_get_is_enabled(blob, node)) {
 524                         if (node_list[number]) {
 525                                 debug("%s: warning: alias '%s' requires that "
 526                                       "a node be placed in the list in a "
 527                                       "position which is already filled by "
 528                                       "node '%s'\n", __func__, path,
 529                                       fdt_get_name(blob, node, NULL));
 530                                 continue;
 531                         }
 532                         node_list[number] = node;
 533                         if (number >= num_found)
 534                                 num_found = number + 1;
 535                 }
 536                 nodes[found] = 0;
 537         }
 538
 539         /* Add any nodes not mentioned by an alias */
 540         for (i = j = 0; i < maxcount; i++) {
 541                 if (!node_list[i]) {
 542                         for (; j < maxcount; j++)
 543                                 if (nodes[j] &&
 544                                         fdtdec_get_is_enabled(blob, nodes[j]))
 545                                         break;
 546
 547                         /* Have we run out of nodes to add? */
 548                         if (j == maxcount)
 549                                 break;
 550
 551                         assert(!node_list[i]);
 552                         node_list[i] = nodes[j++];
 553                         if (i >= num_found)
 554                                 num_found = i + 1;
 555                 }
 556         }
 557
 558         return num_found;
 559 }
 560
 561 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
 562                          int *seqp)
 563 {
 564         int base_len = strlen(base);
 565         const char *find_name;
 566         int find_namelen;
 567         int prop_offset;
 568         int aliases;
 569
 570         find_name = fdt_get_name(blob, offset, &find_namelen);
 571         debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
 572
 573         aliases = fdt_path_offset(blob, "/aliases");
 574         for (prop_offset = fdt_first_property_offset(blob, aliases);
 575              prop_offset > 0;
 576              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
 577                 const char *prop;
 578                 const char *name;
 579                 const char *slash;
 580                 int len, val;
 581
 582                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
 583                 debug("   - %s, %s\n", name, prop);
 584                 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
 585                     strncmp(name, base, base_len))
 586                         continue;
 587
 588                 slash = strrchr(prop, '/');
 589                 if (strcmp(slash + 1, find_name))
 590                         continue;
 591                 val = trailing_strtol(name);
 592                 if (val != -1) {
 593                         *seqp = val;
 594                         debug("Found seq %d\n", *seqp);
 595                         return 0;
 596                 }
 597         }
 598
 599         debug("Not found\n");
 600         return -ENOENT;
 601 }
 602
 603 int fdtdec_get_chosen_node(const void *blob, const char *name)
 604 {
 605         const char *prop;
 606         int chosen_node;
 607         int len;
 608
 609         if (!blob)
 610                 return -FDT_ERR_NOTFOUND;
 611         chosen_node = fdt_path_offset(blob, "/chosen");
 612         prop = fdt_getprop(blob, chosen_node, name, &len);
 613         if (!prop)
 614                 return -FDT_ERR_NOTFOUND;
 615         return fdt_path_offset(blob, prop);
 616 }
 617
 618 int fdtdec_check_fdt(void)
 619 {
 620         /*
 621          * We must have an FDT, but we cannot panic() yet since the console
 622          * is not ready. So for now, just assert(). Boards which need an early
 623          * FDT (prior to console ready) will need to make their own
 624          * arrangements and do their own checks.
 625          */
 626         assert(!fdtdec_prepare_fdt());
 627         return 0;
 628 }
 629
 630 /*
 631  * This function is a little odd in that it accesses global data. At some
 632  * point if the architecture board.c files merge this will make more sense.
 633  * Even now, it is common code.
 634  */
 635 int fdtdec_prepare_fdt(void)
 636 {
 637         if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
 638             fdt_check_header(gd->fdt_blob)) {
 639 #ifdef CONFIG_SPL_BUILD
 640                 puts("Missing DTB\n");
 641 #else
 642                 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");
 643 # ifdef DEBUG
 644                 if (gd->fdt_blob) {
 645                         printf("fdt_blob=%p\n", gd->fdt_blob);
 646                         print_buffer((ulong)gd->fdt_blob, gd->fdt_blob, 4,
 647                                      32, 0);
 648                 }
 649 # endif
 650 #endif
 651                 return -1;
 652         }
 653         return 0;
 654 }
 655
 656 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
 657 {
 658         const u32 *phandle;
 659         int lookup;
 660
 661         debug("%s: %s\n", __func__, prop_name);
 662         phandle = fdt_getprop(blob, node, prop_name, NULL);
 663         if (!phandle)
 664                 return -FDT_ERR_NOTFOUND;
 665
 666         lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
 667         return lookup;
 668 }
 669
 670 /**
 671  * Look up a property in a node and check that it has a minimum length.
 672  *
 673  * @param blob          FDT blob
 674  * @param node          node to examine
 675  * @param prop_name     name of property to find
 676  * @param min_len       minimum property length in bytes
 677  * @param err           0 if ok, or -FDT_ERR_NOTFOUND if the property is not
 678                         found, or -FDT_ERR_BADLAYOUT if not enough data
 679  * @return pointer to cell, which is only valid if err == 0
 680  */
 681 static const void *get_prop_check_min_len(const void *blob, int node,
 682                 const char *prop_name, int min_len, int *err)
 683 {
 684         const void *cell;
 685         int len;
 686
 687         debug("%s: %s\n", __func__, prop_name);
 688         cell = fdt_getprop(blob, node, prop_name, &len);
 689         if (!cell)
 690                 *err = -FDT_ERR_NOTFOUND;
 691         else if (len < min_len)
 692                 *err = -FDT_ERR_BADLAYOUT;
 693         else
 694                 *err = 0;
 695         return cell;
 696 }
 697
 698 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
 699                 u32 *array, int count)
 700 {
 701         const u32 *cell;
 702         int i, err = 0;
 703
 704         debug("%s: %s\n", __func__, prop_name);
 705         cell = get_prop_check_min_len(blob, node, prop_name,
 706                                       sizeof(u32) * count, &err);
 707         if (!err) {
 708                 for (i = 0; i < count; i++)
 709                         array[i] = fdt32_to_cpu(cell[i]);
 710         }
 711         return err;
 712 }
 713
 714 int fdtdec_get_int_array_count(const void *blob, int node,
 715                                const char *prop_name, u32 *array, int count)
 716 {
 717         const u32 *cell;
 718         int len, elems;
 719         int i;
 720
 721         debug("%s: %s\n", __func__, prop_name);
 722         cell = fdt_getprop(blob, node, prop_name, &len);
 723         if (!cell)
 724                 return -FDT_ERR_NOTFOUND;
 725         elems = len / sizeof(u32);
 726         if (count > elems)
 727                 count = elems;
 728         for (i = 0; i < count; i++)
 729                 array[i] = fdt32_to_cpu(cell[i]);
 730
 731         return count;
 732 }
 733
 734 const u32 *fdtdec_locate_array(const void *blob, int node,
 735                                const char *prop_name, int count)
 736 {
 737         const u32 *cell;
 738         int err;
 739
 740         cell = get_prop_check_min_len(blob, node, prop_name,
 741                                       sizeof(u32) * count, &err);
 742         return err ? NULL : cell;
 743 }
 744
 745 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
 746 {
 747         const s32 *cell;
 748         int len;
 749
 750         debug("%s: %s\n", __func__, prop_name);
 751         cell = fdt_getprop(blob, node, prop_name, &len);
 752         return cell != NULL;
 753 }
 754
 755 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
 756                                    const char *list_name,
 757                                    const char *cells_name,
 758                                    int cell_count, int index,
 759                                    struct fdtdec_phandle_args *out_args)
 760 {
 761         const __be32 *list, *list_end;
 762         int rc = 0, size, cur_index = 0;
 763         uint32_t count = 0;
 764         int node = -1;
 765         int phandle;
 766
 767         /* Retrieve the phandle list property */
 768         list = fdt_getprop(blob, src_node, list_name, &size);
 769         if (!list)
 770                 return -ENOENT;
 771         list_end = list + size / sizeof(*list);
 772
 773         /* Loop over the phandles until all the requested entry is found */
 774         while (list < list_end) {
 775                 rc = -EINVAL;
 776                 count = 0;
 777
 778                 /*
 779                  * If phandle is 0, then it is an empty entry with no
 780                  * arguments.  Skip forward to the next entry.
 781                  */
 782                 phandle = be32_to_cpup(list++);
 783                 if (phandle) {
 784                         /*
 785                          * Find the provider node and parse the #*-cells
 786                          * property to determine the argument length.
 787                          *
 788                          * This is not needed if the cell count is hard-coded
 789                          * (i.e. cells_name not set, but cell_count is set),
 790                          * except when we're going to return the found node
 791                          * below.
 792                          */
 793                         if (cells_name || cur_index == index) {
 794                                 node = fdt_node_offset_by_phandle(blob,
 795                                                                   phandle);
 796                                 if (!node) {
 797                                         debug("%s: could not find phandle\n",
 798                                               fdt_get_name(blob, src_node,
 799                                                            NULL));
 800                                         goto err;
 801                                 }
 802                         }
 803
 804                         if (cells_name) {
 805                                 count = fdtdec_get_int(blob, node, cells_name,
 806                                                        -1);
 807                                 if (count == -1) {
 808                                         debug("%s: could not get %s for %s\n",
 809                                               fdt_get_name(blob, src_node,
 810                                                            NULL),
 811                                               cells_name,
 812                                               fdt_get_name(blob, node,
 813                                                            NULL));
 814                                         goto err;
 815                                 }
 816                         } else {
 817                                 count = cell_count;
 818                         }
 819
 820                         /*
 821                          * Make sure that the arguments actually fit in the
 822                          * remaining property data length
 823                          */
 824                         if (list + count > list_end) {
 825                                 debug("%s: arguments longer than property\n",
 826                                       fdt_get_name(blob, src_node, NULL));
 827                                 goto err;
 828                         }
 829                 }
 830
 831                 /*
 832                  * All of the error cases above bail out of the loop, so at
 833                  * this point, the parsing is successful. If the requested
 834                  * index matches, then fill the out_args structure and return,
 835                  * or return -ENOENT for an empty entry.
 836                  */
 837                 rc = -ENOENT;
 838                 if (cur_index == index) {
 839                         if (!phandle)
 840                                 goto err;
 841
 842                         if (out_args) {
 843                                 int i;
 844
 845                                 if (count > MAX_PHANDLE_ARGS) {
 846                                         debug("%s: too many arguments %d\n",
 847                                               fdt_get_name(blob, src_node,
 848                                                            NULL), count);
 849                                         count = MAX_PHANDLE_ARGS;
 850                                 }
 851                                 out_args->node = node;
 852                                 out_args->args_count = count;
 853                                 for (i = 0; i < count; i++) {
 854                                         out_args->args[i] =
 855                                                         be32_to_cpup(list++);
 856                                 }
 857                         }
 858
 859                         /* Found it! return success */
 860                         return 0;
 861                 }
 862
 863                 node = -1;
 864                 list += count;
 865                 cur_index++;
 866         }
 867
 868         /*
 869          * Result will be one of:
 870          * -ENOENT : index is for empty phandle
 871          * -EINVAL : parsing error on data
 872          * [1..n]  : Number of phandle (count mode; when index = -1)
 873          */
 874         rc = index < 0 ? cur_index : -ENOENT;
 875  err:
 876         return rc;
 877 }
 878
 879 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
 880                 u8 *array, int count)
 881 {
 882         const u8 *cell;
 883         int err;
 884
 885         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 886         if (!err)
 887                 memcpy(array, cell, count);
 888         return err;
 889 }
 890
 891 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
 892                              const char *prop_name, int count)
 893 {
 894         const u8 *cell;
 895         int err;
 896
 897         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 898         if (err)
 899                 return NULL;
 900         return cell;
 901 }
 902
 903 int fdtdec_get_config_int(const void *blob, const char *prop_name,
 904                 int default_val)
 905 {
 906         int config_node;
 907
 908         debug("%s: %s\n", __func__, prop_name);
 909         config_node = fdt_path_offset(blob, "/config");
 910         if (config_node < 0)
 911                 return default_val;
 912         return fdtdec_get_int(blob, config_node, prop_name, default_val);
 913 }
 914
 915 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
 916 {
 917         int config_node;
 918         const void *prop;
 919
 920         debug("%s: %s\n", __func__, prop_name);
 921         config_node = fdt_path_offset(blob, "/config");
 922         if (config_node < 0)
 923                 return 0;
 924         prop = fdt_get_property(blob, config_node, prop_name, NULL);
 925
 926         return prop != NULL;
 927 }
 928
 929 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
 930 {
 931         const char *nodep;
 932         int nodeoffset;
 933         int len;
 934
 935         debug("%s: %s\n", __func__, prop_name);
 936         nodeoffset = fdt_path_offset(blob, "/config");
 937         if (nodeoffset < 0)
 938                 return NULL;
 939
 940         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
 941         if (!nodep)
 942                 return NULL;
 943
 944         return (char *)nodep;
 945 }
 946
 947 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
 948                          fdt_addr_t *basep, fdt_size_t *sizep)
 949 {
 950         const fdt_addr_t *cell;
 951         int len;
 952
 953         debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
 954               prop_name);
 955         cell = fdt_getprop(blob, node, prop_name, &len);
 956         if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
 957                 debug("cell=%p, len=%d\n", cell, len);
 958                 return -1;
 959         }
 960
 961         *basep = fdt_addr_to_cpu(*cell);
 962         *sizep = fdt_size_to_cpu(cell[1]);
 963         debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
 964               (ulong)*sizep);
 965
 966         return 0;
 967 }
 968
 969 /**
 970  * Read a flash entry from the fdt
 971  *
 972  * @param blob          FDT blob
 973  * @param node          Offset of node to read
 974  * @param name          Name of node being read
 975  * @param entry         Place to put offset and size of this node
 976  * @return 0 if ok, -ve on error
 977  */
 978 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
 979                            struct fmap_entry *entry)
 980 {
 981         const char *prop;
 982         u32 reg[2];
 983
 984         if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
 985                 debug("Node '%s' has bad/missing 'reg' property\n", name);
 986                 return -FDT_ERR_NOTFOUND;
 987         }
 988         entry->offset = reg[0];
 989         entry->length = reg[1];
 990         entry->used = fdtdec_get_int(blob, node, "used", entry->length);
 991         prop = fdt_getprop(blob, node, "compress", NULL);
 992         entry->compress_algo = prop && !strcmp(prop, "lzo") ?
 993                 FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
 994         prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
 995         entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
 996         entry->hash = (uint8_t *)prop;
 997
 998         return 0;
 999 }
1000
1001 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
1002 {
1003         u64 number = 0;
1004
1005         while (cells--)
1006                 number = (number << 32) | fdt32_to_cpu(*ptr++);
1007
1008         return number;
1009 }
1010
1011 int fdt_get_resource(const void *fdt, int node, const char *property,
1012                      unsigned int index, struct fdt_resource *res)
1013 {
1014         const fdt32_t *ptr, *end;
1015         int na, ns, len, parent;
1016         unsigned int i = 0;
1017
1018         parent = fdt_parent_offset(fdt, node);
1019         if (parent < 0)
1020                 return parent;
1021
1022         na = fdt_address_cells(fdt, parent);
1023         ns = fdt_size_cells(fdt, parent);
1024
1025         ptr = fdt_getprop(fdt, node, property, &len);
1026         if (!ptr)
1027                 return len;
1028
1029         end = ptr + len / sizeof(*ptr);
1030
1031         while (ptr + na + ns <= end) {
1032                 if (i == index) {
1033                         res->start = res->end = fdtdec_get_number(ptr, na);
1034                         res->end += fdtdec_get_number(&ptr[na], ns) - 1;
1035                         return 0;
1036                 }
1037
1038                 ptr += na + ns;
1039                 i++;
1040         }
1041
1042         return -FDT_ERR_NOTFOUND;
1043 }
1044
1045 int fdt_get_named_resource(const void *fdt, int node, const char *property,
1046                            const char *prop_names, const char *name,
1047                            struct fdt_resource *res)
1048 {
1049         int index;
1050
1051         index = fdt_find_string(fdt, node, prop_names, name);
1052         if (index < 0)
1053                 return index;
1054
1055         return fdt_get_resource(fdt, node, property, index, res);
1056 }
1057
1058 int fdtdec_decode_memory_region(const void *blob, int config_node,
1059                                 const char *mem_type, const char *suffix,
1060                                 fdt_addr_t *basep, fdt_size_t *sizep)
1061 {
1062         char prop_name[50];
1063         const char *mem;
1064         fdt_size_t size, offset_size;
1065         fdt_addr_t base, offset;
1066         int node;
1067
1068         if (config_node == -1) {
1069                 config_node = fdt_path_offset(blob, "/config");
1070                 if (config_node < 0) {
1071                         debug("%s: Cannot find /config node\n", __func__);
1072                         return -ENOENT;
1073                 }
1074         }
1075         if (!suffix)
1076                 suffix = "";
1077
1078         snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
1079                  suffix);
1080         mem = fdt_getprop(blob, config_node, prop_name, NULL);
1081         if (!mem) {
1082                 debug("%s: No memory type for '%s', using /memory\n", __func__,
1083                       prop_name);
1084                 mem = "/memory";
1085         }
1086
1087         node = fdt_path_offset(blob, mem);
1088         if (node < 0) {
1089                 debug("%s: Failed to find node '%s': %s\n", __func__, mem,
1090                       fdt_strerror(node));
1091                 return -ENOENT;
1092         }
1093
1094         /*
1095          * Not strictly correct - the memory may have multiple banks. We just
1096          * use the first
1097          */
1098         if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
1099                 debug("%s: Failed to decode memory region %s\n", __func__,
1100                       mem);
1101                 return -EINVAL;
1102         }
1103
1104         snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
1105                  suffix);
1106         if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
1107                                  &offset_size)) {
1108                 debug("%s: Failed to decode memory region '%s'\n", __func__,
1109                       prop_name);
1110                 return -EINVAL;
1111         }
1112
1113         *basep = base + offset;
1114         *sizep = offset_size;
1115
1116         return 0;
1117 }
1118
1119 static int decode_timing_property(const void *blob, int node, const char *name,
1120                                   struct timing_entry *result)
1121 {
1122         int length, ret = 0;
1123         const u32 *prop;
1124
1125         prop = fdt_getprop(blob, node, name, &length);
1126         if (!prop) {
1127                 debug("%s: could not find property %s\n",
1128                       fdt_get_name(blob, node, NULL), name);
1129                 return length;
1130         }
1131
1132         if (length == sizeof(u32)) {
1133                 result->typ = fdtdec_get_int(blob, node, name, 0);
1134                 result->min = result->typ;
1135                 result->max = result->typ;
1136         } else {
1137                 ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
1138         }
1139
1140         return ret;
1141 }
1142
1143 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
1144                                  struct display_timing *dt)
1145 {
1146         int i, node, timings_node;
1147         u32 val = 0;
1148         int ret = 0;
1149
1150         timings_node = fdt_subnode_offset(blob, parent, "display-timings");
1151         if (timings_node < 0)
1152                 return timings_node;
1153
1154         for (i = 0, node = fdt_first_subnode(blob, timings_node);
1155              node > 0 && i != index;
1156              node = fdt_next_subnode(blob, node))
1157                 i++;
1158
1159         if (node < 0)
1160                 return node;
1161
1162         memset(dt, 0, sizeof(*dt));
1163
1164         ret |= decode_timing_property(blob, node, "hback-porch",
1165                                       &dt->hback_porch);
1166         ret |= decode_timing_property(blob, node, "hfront-porch",
1167                                       &dt->hfront_porch);
1168         ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1169         ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1170         ret |= decode_timing_property(blob, node, "vback-porch",
1171                                       &dt->vback_porch);
1172         ret |= decode_timing_property(blob, node, "vfront-porch",
1173                                       &dt->vfront_porch);
1174         ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1175         ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1176         ret |= decode_timing_property(blob, node, "clock-frequency",
1177                                       &dt->pixelclock);
1178
1179         dt->flags = 0;
1180         val = fdtdec_get_int(blob, node, "vsync-active", -1);
1181         if (val != -1) {
1182                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1183                                 DISPLAY_FLAGS_VSYNC_LOW;
1184         }
1185         val = fdtdec_get_int(blob, node, "hsync-active", -1);
1186         if (val != -1) {
1187                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1188                                 DISPLAY_FLAGS_HSYNC_LOW;
1189         }
1190         val = fdtdec_get_int(blob, node, "de-active", -1);
1191         if (val != -1) {
1192                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1193                                 DISPLAY_FLAGS_DE_LOW;
1194         }
1195         val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1196         if (val != -1) {
1197                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1198                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1199         }
1200
1201         if (fdtdec_get_bool(blob, node, "interlaced"))
1202                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
1203         if (fdtdec_get_bool(blob, node, "doublescan"))
1204                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1205         if (fdtdec_get_bool(blob, node, "doubleclk"))
1206                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1207
1208         return 0;
1209 }
1210
1211 int fdtdec_setup(void)
1212 {
1213 #if CONFIG_IS_ENABLED(OF_CONTROL)
1214 # ifdef CONFIG_OF_EMBED
1215         /* Get a pointer to the FDT */
1216         gd->fdt_blob = __dtb_dt_begin;
1217 # elif defined CONFIG_OF_SEPARATE
1218 #  ifdef CONFIG_SPL_BUILD
1219         /* FDT is at end of BSS */
1220         gd->fdt_blob = (ulong *)&__bss_end;
1221 #  else
1222         /* FDT is at end of image */
1223         gd->fdt_blob = (ulong *)&_end;
1224 #  endif
1225 # elif defined(CONFIG_OF_HOSTFILE)
1226         if (sandbox_read_fdt_from_file()) {
1227                 puts("Failed to read control FDT\n");
1228                 return -1;
1229         }
1230 # endif
1231 # ifndef CONFIG_SPL_BUILD
1232         /* Allow the early environment to override the fdt address */
1233         gd->fdt_blob = (void *)getenv_ulong("fdtcontroladdr", 16,
1234                                                 (uintptr_t)gd->fdt_blob);
1235 # endif
1236 #endif
1237         return fdtdec_prepare_fdt();
1238 }
1239
1240 #endif /* !USE_HOSTCC */