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