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