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