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