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 <dm.h>
   9 #include <errno.h>
  10 #include <serial.h>
  11 #include <libfdt.h>
  12 #include <fdtdec.h>
  13 #include <asm/sections.h>
  14 #include <linux/ctype.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_EMC, "nvidia,tegra20-emc"),
  27         COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
  28         COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
  29         COMPAT(NVIDIA_TEGRA124_PMC, "nvidia,tegra124-pmc"),
  30         COMPAT(NVIDIA_TEGRA186_SDMMC, "nvidia,tegra186-sdhci"),
  31         COMPAT(NVIDIA_TEGRA210_SDMMC, "nvidia,tegra210-sdhci"),
  32         COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
  33         COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
  34         COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
  35         COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
  36         COMPAT(NVIDIA_TEGRA210_XUSB_PADCTL, "nvidia,tegra210-xusb-padctl"),
  37         COMPAT(SMSC_LAN9215, "smsc,lan9215"),
  38         COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
  39         COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
  40         COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
  41         COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
  42         COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
  43         COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
  44         COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
  45         COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
  46         COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
  47         COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
  48         COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
  49         COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
  50         COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
  51         COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686"),
  52         COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
  53         COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
  54         COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
  55         COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
  56         COMPAT(INTEL_MICROCODE, "intel,microcode"),
  57         COMPAT(AMS_AS3722, "ams,as3722"),
  58         COMPAT(INTEL_QRK_MRC, "intel,quark-mrc"),
  59         COMPAT(SOCIONEXT_XHCI, "socionext,uniphier-xhci"),
  60         COMPAT(ALTERA_SOCFPGA_DWMAC, "altr,socfpga-stmmac"),
  61         COMPAT(ALTERA_SOCFPGA_DWMMC, "altr,socfpga-dw-mshc"),
  62         COMPAT(ALTERA_SOCFPGA_DWC2USB, "snps,dwc2"),
  63         COMPAT(COMPAT_INTEL_BAYTRAIL_FSP, "intel,baytrail-fsp"),
  64         COMPAT(COMPAT_INTEL_BAYTRAIL_FSP_MDP, "intel,baytrail-fsp-mdp"),
  65         COMPAT(COMPAT_INTEL_IVYBRIDGE_FSP, "intel,ivybridge-fsp"),
  66 };
  67
  68 const char *fdtdec_get_compatible(enum fdt_compat_id id)
  69 {
  70         /* We allow reading of the 'unknown' ID for testing purposes */
  71         assert(id >= 0 && id < COMPAT_COUNT);
  72         return compat_names[id];
  73 }
  74
  75 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
  76                 const char *prop_name, int index, int na, int ns,
  77                 fdt_size_t *sizep)
  78 {
  79         const fdt32_t *prop, *prop_end;
  80         const fdt32_t *prop_addr, *prop_size, *prop_after_size;
  81         int len;
  82         fdt_addr_t addr;
  83
  84         debug("%s: %s: ", __func__, prop_name);
  85
  86         if (na > (sizeof(fdt_addr_t) / sizeof(fdt32_t))) {
  87                 debug("(na too large for fdt_addr_t type)\n");
  88                 return FDT_ADDR_T_NONE;
  89         }
  90
  91         if (ns > (sizeof(fdt_size_t) / sizeof(fdt32_t))) {
  92                 debug("(ns too large for fdt_size_t type)\n");
  93                 return FDT_ADDR_T_NONE;
  94         }
  95
  96         prop = fdt_getprop(blob, node, prop_name, &len);
  97         if (!prop) {
  98                 debug("(not found)\n");
  99                 return FDT_ADDR_T_NONE;
 100         }
 101         prop_end = prop + (len / sizeof(*prop));
 102
 103         prop_addr = prop + (index * (na + ns));
 104         prop_size = prop_addr + na;
 105         prop_after_size = prop_size + ns;
 106         if (prop_after_size > prop_end) {
 107                 debug("(not enough data: expected >= %d cells, got %d cells)\n",
 108                       (u32)(prop_after_size - prop), ((u32)(prop_end - prop)));
 109                 return FDT_ADDR_T_NONE;
 110         }
 111
 112         addr = fdtdec_get_number(prop_addr, na);
 113
 114         if (sizep) {
 115                 *sizep = fdtdec_get_number(prop_size, ns);
 116                 debug("addr=%08llx, size=%llx\n", (unsigned long long)addr,
 117                       (unsigned long long)*sizep);
 118         } else {
 119                 debug("addr=%08llx\n", (unsigned long long)addr);
 120         }
 121
 122         return addr;
 123 }
 124
 125 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
 126                 int node, const char *prop_name, int index, fdt_size_t *sizep)
 127 {
 128         int na, ns;
 129
 130         debug("%s: ", __func__);
 131
 132         na = fdt_address_cells(blob, parent);
 133         if (na < 1) {
 134                 debug("(bad #address-cells)\n");
 135                 return FDT_ADDR_T_NONE;
 136         }
 137
 138         ns = fdt_size_cells(blob, parent);
 139         if (ns < 0) {
 140                 debug("(bad #size-cells)\n");
 141                 return FDT_ADDR_T_NONE;
 142         }
 143
 144         debug("na=%d, ns=%d, ", na, ns);
 145
 146         return fdtdec_get_addr_size_fixed(blob, node, prop_name, index, na,
 147                                           ns, sizep);
 148 }
 149
 150 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
 151                 const char *prop_name, int index, fdt_size_t *sizep)
 152 {
 153         int parent;
 154
 155         debug("%s: ", __func__);
 156
 157         parent = fdt_parent_offset(blob, node);
 158         if (parent < 0) {
 159                 debug("(no parent found)\n");
 160                 return FDT_ADDR_T_NONE;
 161         }
 162
 163         return fdtdec_get_addr_size_auto_parent(blob, parent, node, prop_name,
 164                                                 index, sizep);
 165 }
 166
 167 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
 168                 const char *prop_name, fdt_size_t *sizep)
 169 {
 170         int ns = sizep ? (sizeof(fdt_size_t) / sizeof(fdt32_t)) : 0;
 171
 172         return fdtdec_get_addr_size_fixed(blob, node, prop_name, 0,
 173                                           sizeof(fdt_addr_t) / sizeof(fdt32_t),
 174                                           ns, sizep);
 175 }
 176
 177 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
 178                 const char *prop_name)
 179 {
 180         return fdtdec_get_addr_size(blob, node, prop_name, NULL);
 181 }
 182
 183 #if defined(CONFIG_PCI) && defined(CONFIG_DM_PCI)
 184 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
 185                 const char *prop_name, struct fdt_pci_addr *addr)
 186 {
 187         const u32 *cell;
 188         int len;
 189         int ret = -ENOENT;
 190
 191         debug("%s: %s: ", __func__, prop_name);
 192
 193         /*
 194          * If we follow the pci bus bindings strictly, we should check
 195          * the value of the node's parent node's #address-cells and
 196          * #size-cells. They need to be 3 and 2 accordingly. However,
 197          * for simplicity we skip the check here.
 198          */
 199         cell = fdt_getprop(blob, node, prop_name, &len);
 200         if (!cell)
 201                 goto fail;
 202
 203         if ((len % FDT_PCI_REG_SIZE) == 0) {
 204                 int num = len / FDT_PCI_REG_SIZE;
 205                 int i;
 206
 207                 for (i = 0; i < num; i++) {
 208                         debug("pci address #%d: %08lx %08lx %08lx\n", i,
 209                               (ulong)fdt32_to_cpu(cell[0]),
 210                               (ulong)fdt32_to_cpu(cell[1]),
 211                               (ulong)fdt32_to_cpu(cell[2]));
 212                         if ((fdt32_to_cpu(*cell) & type) == type) {
 213                                 addr->phys_hi = fdt32_to_cpu(cell[0]);
 214                                 addr->phys_mid = fdt32_to_cpu(cell[1]);
 215                                 addr->phys_lo = fdt32_to_cpu(cell[1]);
 216                                 break;
 217                         } else {
 218                                 cell += (FDT_PCI_ADDR_CELLS +
 219                                          FDT_PCI_SIZE_CELLS);
 220                         }
 221                 }
 222
 223                 if (i == num) {
 224                         ret = -ENXIO;
 225                         goto fail;
 226                 }
 227
 228                 return 0;
 229         } else {
 230                 ret = -EINVAL;
 231         }
 232
 233 fail:
 234         debug("(not found)\n");
 235         return ret;
 236 }
 237
 238 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
 239 {
 240         const char *list, *end;
 241         int len;
 242
 243         list = fdt_getprop(blob, node, "compatible", &len);
 244         if (!list)
 245                 return -ENOENT;
 246
 247         end = list + len;
 248         while (list < end) {
 249                 char *s;
 250
 251                 len = strlen(list);
 252                 if (len >= strlen("pciVVVV,DDDD")) {
 253                         s = strstr(list, "pci");
 254
 255                         /*
 256                          * check if the string is something like pciVVVV,DDDD.RR
 257                          * or just pciVVVV,DDDD
 258                          */
 259                         if (s && s[7] == ',' &&
 260                             (s[12] == '.' || s[12] == 0)) {
 261                                 s += 3;
 262                                 *vendor = simple_strtol(s, NULL, 16);
 263
 264                                 s += 5;
 265                                 *device = simple_strtol(s, NULL, 16);
 266
 267                                 return 0;
 268                         }
 269                 }
 270                 list += (len + 1);
 271         }
 272
 273         return -ENOENT;
 274 }
 275
 276 int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
 277                          u32 *bar)
 278 {
 279         int barnum;
 280
 281         /* extract the bar number from fdt_pci_addr */
 282         barnum = addr->phys_hi & 0xff;
 283         if ((barnum < PCI_BASE_ADDRESS_0) || (barnum > PCI_CARDBUS_CIS))
 284                 return -EINVAL;
 285
 286         barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
 287         *bar = dm_pci_read_bar32(dev, barnum);
 288
 289         return 0;
 290 }
 291 #endif
 292
 293 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
 294                 uint64_t default_val)
 295 {
 296         const uint64_t *cell64;
 297         int length;
 298
 299         cell64 = fdt_getprop(blob, node, prop_name, &length);
 300         if (!cell64 || length < sizeof(*cell64))
 301                 return default_val;
 302
 303         return fdt64_to_cpu(*cell64);
 304 }
 305
 306 int fdtdec_get_is_enabled(const void *blob, int node)
 307 {
 308         const char *cell;
 309
 310         /*
 311          * It should say "okay", so only allow that. Some fdts use "ok" but
 312          * this is a bug. Please fix your device tree source file. See here
 313          * for discussion:
 314          *
 315          * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
 316          */
 317         cell = fdt_getprop(blob, node, "status", NULL);
 318         if (cell)
 319                 return 0 == strcmp(cell, "okay");
 320         return 1;
 321 }
 322
 323 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
 324 {
 325         enum fdt_compat_id id;
 326
 327         /* Search our drivers */
 328         for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
 329                 if (0 == fdt_node_check_compatible(blob, node,
 330                                 compat_names[id]))
 331                         return id;
 332         return COMPAT_UNKNOWN;
 333 }
 334
 335 int fdtdec_next_compatible(const void *blob, int node,
 336                 enum fdt_compat_id id)
 337 {
 338         return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
 339 }
 340
 341 int fdtdec_next_compatible_subnode(const void *blob, int node,
 342                 enum fdt_compat_id id, int *depthp)
 343 {
 344         do {
 345                 node = fdt_next_node(blob, node, depthp);
 346         } while (*depthp > 1);
 347
 348         /* If this is a direct subnode, and compatible, return it */
 349         if (*depthp == 1 && 0 == fdt_node_check_compatible(
 350                                                 blob, node, compat_names[id]))
 351                 return node;
 352
 353         return -FDT_ERR_NOTFOUND;
 354 }
 355
 356 int fdtdec_next_alias(const void *blob, const char *name,
 357                 enum fdt_compat_id id, int *upto)
 358 {
 359 #define MAX_STR_LEN 20
 360         char str[MAX_STR_LEN + 20];
 361         int node, err;
 362
 363         /* snprintf() is not available */
 364         assert(strlen(name) < MAX_STR_LEN);
 365         sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
 366         node = fdt_path_offset(blob, str);
 367         if (node < 0)
 368                 return node;
 369         err = fdt_node_check_compatible(blob, node, compat_names[id]);
 370         if (err < 0)
 371                 return err;
 372         if (err)
 373                 return -FDT_ERR_NOTFOUND;
 374         (*upto)++;
 375         return node;
 376 }
 377
 378 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
 379                         enum fdt_compat_id id, int *node_list, int maxcount)
 380 {
 381         memset(node_list, '\0', sizeof(*node_list) * maxcount);
 382
 383         return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
 384 }
 385
 386 /* TODO: Can we tighten this code up a little? */
 387 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
 388                         enum fdt_compat_id id, int *node_list, int maxcount)
 389 {
 390         int name_len = strlen(name);
 391         int nodes[maxcount];
 392         int num_found = 0;
 393         int offset, node;
 394         int alias_node;
 395         int count;
 396         int i, j;
 397
 398         /* find the alias node if present */
 399         alias_node = fdt_path_offset(blob, "/aliases");
 400
 401         /*
 402          * start with nothing, and we can assume that the root node can't
 403          * match
 404          */
 405         memset(nodes, '\0', sizeof(nodes));
 406
 407         /* First find all the compatible nodes */
 408         for (node = count = 0; node >= 0 && count < maxcount;) {
 409                 node = fdtdec_next_compatible(blob, node, id);
 410                 if (node >= 0)
 411                         nodes[count++] = node;
 412         }
 413         if (node >= 0)
 414                 debug("%s: warning: maxcount exceeded with alias '%s'\n",
 415                        __func__, name);
 416
 417         /* Now find all the aliases */
 418         for (offset = fdt_first_property_offset(blob, alias_node);
 419                         offset > 0;
 420                         offset = fdt_next_property_offset(blob, offset)) {
 421                 const struct fdt_property *prop;
 422                 const char *path;
 423                 int number;
 424                 int found;
 425
 426                 node = 0;
 427                 prop = fdt_get_property_by_offset(blob, offset, NULL);
 428                 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
 429                 if (prop->len && 0 == strncmp(path, name, name_len))
 430                         node = fdt_path_offset(blob, prop->data);
 431                 if (node <= 0)
 432                         continue;
 433
 434                 /* Get the alias number */
 435                 number = simple_strtoul(path + name_len, NULL, 10);
 436                 if (number < 0 || number >= maxcount) {
 437                         debug("%s: warning: alias '%s' is out of range\n",
 438                                __func__, path);
 439                         continue;
 440                 }
 441
 442                 /* Make sure the node we found is actually in our list! */
 443                 found = -1;
 444                 for (j = 0; j < count; j++)
 445                         if (nodes[j] == node) {
 446                                 found = j;
 447                                 break;
 448                         }
 449
 450                 if (found == -1) {
 451                         debug("%s: warning: alias '%s' points to a node "
 452                                 "'%s' that is missing or is not compatible "
 453                                 " with '%s'\n", __func__, path,
 454                                 fdt_get_name(blob, node, NULL),
 455                                compat_names[id]);
 456                         continue;
 457                 }
 458
 459                 /*
 460                  * Add this node to our list in the right place, and mark
 461                  * it as done.
 462                  */
 463                 if (fdtdec_get_is_enabled(blob, node)) {
 464                         if (node_list[number]) {
 465                                 debug("%s: warning: alias '%s' requires that "
 466                                       "a node be placed in the list in a "
 467                                       "position which is already filled by "
 468                                       "node '%s'\n", __func__, path,
 469                                       fdt_get_name(blob, node, NULL));
 470                                 continue;
 471                         }
 472                         node_list[number] = node;
 473                         if (number >= num_found)
 474                                 num_found = number + 1;
 475                 }
 476                 nodes[found] = 0;
 477         }
 478
 479         /* Add any nodes not mentioned by an alias */
 480         for (i = j = 0; i < maxcount; i++) {
 481                 if (!node_list[i]) {
 482                         for (; j < maxcount; j++)
 483                                 if (nodes[j] &&
 484                                         fdtdec_get_is_enabled(blob, nodes[j]))
 485                                         break;
 486
 487                         /* Have we run out of nodes to add? */
 488                         if (j == maxcount)
 489                                 break;
 490
 491                         assert(!node_list[i]);
 492                         node_list[i] = nodes[j++];
 493                         if (i >= num_found)
 494                                 num_found = i + 1;
 495                 }
 496         }
 497
 498         return num_found;
 499 }
 500
 501 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
 502                          int *seqp)
 503 {
 504         int base_len = strlen(base);
 505         const char *find_name;
 506         int find_namelen;
 507         int prop_offset;
 508         int aliases;
 509
 510         find_name = fdt_get_name(blob, offset, &find_namelen);
 511         debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
 512
 513         aliases = fdt_path_offset(blob, "/aliases");
 514         for (prop_offset = fdt_first_property_offset(blob, aliases);
 515              prop_offset > 0;
 516              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
 517                 const char *prop;
 518                 const char *name;
 519                 const char *slash;
 520                 int len, val;
 521
 522                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
 523                 debug("   - %s, %s\n", name, prop);
 524                 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
 525                     strncmp(name, base, base_len))
 526                         continue;
 527
 528                 slash = strrchr(prop, '/');
 529                 if (strcmp(slash + 1, find_name))
 530                         continue;
 531                 val = trailing_strtol(name);
 532                 if (val != -1) {
 533                         *seqp = val;
 534                         debug("Found seq %d\n", *seqp);
 535                         return 0;
 536                 }
 537         }
 538
 539         debug("Not found\n");
 540         return -ENOENT;
 541 }
 542
 543 const char *fdtdec_get_chosen_prop(const void *blob, const char *name)
 544 {
 545         int chosen_node;
 546
 547         if (!blob)
 548                 return NULL;
 549         chosen_node = fdt_path_offset(blob, "/chosen");
 550         return fdt_getprop(blob, chosen_node, name, NULL);
 551 }
 552
 553 int fdtdec_get_chosen_node(const void *blob, const char *name)
 554 {
 555         const char *prop;
 556
 557         prop = fdtdec_get_chosen_prop(blob, name);
 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_child_count(const void *blob, int node)
 825 {
 826         int subnode;
 827         int num = 0;
 828
 829         fdt_for_each_subnode(blob, subnode, node)
 830                 num++;
 831
 832         return num;
 833 }
 834
 835 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
 836                 u8 *array, int count)
 837 {
 838         const u8 *cell;
 839         int err;
 840
 841         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 842         if (!err)
 843                 memcpy(array, cell, count);
 844         return err;
 845 }
 846
 847 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
 848                              const char *prop_name, int count)
 849 {
 850         const u8 *cell;
 851         int err;
 852
 853         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 854         if (err)
 855                 return NULL;
 856         return cell;
 857 }
 858
 859 int fdtdec_get_config_int(const void *blob, const char *prop_name,
 860                 int default_val)
 861 {
 862         int config_node;
 863
 864         debug("%s: %s\n", __func__, prop_name);
 865         config_node = fdt_path_offset(blob, "/config");
 866         if (config_node < 0)
 867                 return default_val;
 868         return fdtdec_get_int(blob, config_node, prop_name, default_val);
 869 }
 870
 871 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
 872 {
 873         int config_node;
 874         const void *prop;
 875
 876         debug("%s: %s\n", __func__, prop_name);
 877         config_node = fdt_path_offset(blob, "/config");
 878         if (config_node < 0)
 879                 return 0;
 880         prop = fdt_get_property(blob, config_node, prop_name, NULL);
 881
 882         return prop != NULL;
 883 }
 884
 885 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
 886 {
 887         const char *nodep;
 888         int nodeoffset;
 889         int len;
 890
 891         debug("%s: %s\n", __func__, prop_name);
 892         nodeoffset = fdt_path_offset(blob, "/config");
 893         if (nodeoffset < 0)
 894                 return NULL;
 895
 896         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
 897         if (!nodep)
 898                 return NULL;
 899
 900         return (char *)nodep;
 901 }
 902
 903 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
 904                          fdt_addr_t *basep, fdt_size_t *sizep)
 905 {
 906         const fdt_addr_t *cell;
 907         int len;
 908
 909         debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
 910               prop_name);
 911         cell = fdt_getprop(blob, node, prop_name, &len);
 912         if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
 913                 debug("cell=%p, len=%d\n", cell, len);
 914                 return -1;
 915         }
 916
 917         *basep = fdt_addr_to_cpu(*cell);
 918         *sizep = fdt_size_to_cpu(cell[1]);
 919         debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
 920               (ulong)*sizep);
 921
 922         return 0;
 923 }
 924
 925 /**
 926  * Read a flash entry from the fdt
 927  *
 928  * @param blob          FDT blob
 929  * @param node          Offset of node to read
 930  * @param name          Name of node being read
 931  * @param entry         Place to put offset and size of this node
 932  * @return 0 if ok, -ve on error
 933  */
 934 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
 935                            struct fmap_entry *entry)
 936 {
 937         const char *prop;
 938         u32 reg[2];
 939
 940         if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
 941                 debug("Node '%s' has bad/missing 'reg' property\n", name);
 942                 return -FDT_ERR_NOTFOUND;
 943         }
 944         entry->offset = reg[0];
 945         entry->length = reg[1];
 946         entry->used = fdtdec_get_int(blob, node, "used", entry->length);
 947         prop = fdt_getprop(blob, node, "compress", NULL);
 948         entry->compress_algo = prop && !strcmp(prop, "lzo") ?
 949                 FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
 950         prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
 951         entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
 952         entry->hash = (uint8_t *)prop;
 953
 954         return 0;
 955 }
 956
 957 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
 958 {
 959         u64 number = 0;
 960
 961         while (cells--)
 962                 number = (number << 32) | fdt32_to_cpu(*ptr++);
 963
 964         return number;
 965 }
 966
 967 int fdt_get_resource(const void *fdt, int node, const char *property,
 968                      unsigned int index, struct fdt_resource *res)
 969 {
 970         const fdt32_t *ptr, *end;
 971         int na, ns, len, parent;
 972         unsigned int i = 0;
 973
 974         parent = fdt_parent_offset(fdt, node);
 975         if (parent < 0)
 976                 return parent;
 977
 978         na = fdt_address_cells(fdt, parent);
 979         ns = fdt_size_cells(fdt, parent);
 980
 981         ptr = fdt_getprop(fdt, node, property, &len);
 982         if (!ptr)
 983                 return len;
 984
 985         end = ptr + len / sizeof(*ptr);
 986
 987         while (ptr + na + ns <= end) {
 988                 if (i == index) {
 989                         res->start = res->end = fdtdec_get_number(ptr, na);
 990                         res->end += fdtdec_get_number(&ptr[na], ns) - 1;
 991                         return 0;
 992                 }
 993
 994                 ptr += na + ns;
 995                 i++;
 996         }
 997
 998         return -FDT_ERR_NOTFOUND;
 999 }
1000
1001 int fdt_get_named_resource(const void *fdt, int node, const char *property,
1002                            const char *prop_names, const char *name,
1003                            struct fdt_resource *res)
1004 {
1005         int index;
1006
1007         index = fdt_find_string(fdt, node, prop_names, name);
1008         if (index < 0)
1009                 return index;
1010
1011         return fdt_get_resource(fdt, node, property, index, res);
1012 }
1013
1014 int fdtdec_decode_memory_region(const void *blob, int config_node,
1015                                 const char *mem_type, const char *suffix,
1016                                 fdt_addr_t *basep, fdt_size_t *sizep)
1017 {
1018         char prop_name[50];
1019         const char *mem;
1020         fdt_size_t size, offset_size;
1021         fdt_addr_t base, offset;
1022         int node;
1023
1024         if (config_node == -1) {
1025                 config_node = fdt_path_offset(blob, "/config");
1026                 if (config_node < 0) {
1027                         debug("%s: Cannot find /config node\n", __func__);
1028                         return -ENOENT;
1029                 }
1030         }
1031         if (!suffix)
1032                 suffix = "";
1033
1034         snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
1035                  suffix);
1036         mem = fdt_getprop(blob, config_node, prop_name, NULL);
1037         if (!mem) {
1038                 debug("%s: No memory type for '%s', using /memory\n", __func__,
1039                       prop_name);
1040                 mem = "/memory";
1041         }
1042
1043         node = fdt_path_offset(blob, mem);
1044         if (node < 0) {
1045                 debug("%s: Failed to find node '%s': %s\n", __func__, mem,
1046                       fdt_strerror(node));
1047                 return -ENOENT;
1048         }
1049
1050         /*
1051          * Not strictly correct - the memory may have multiple banks. We just
1052          * use the first
1053          */
1054         if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
1055                 debug("%s: Failed to decode memory region %s\n", __func__,
1056                       mem);
1057                 return -EINVAL;
1058         }
1059
1060         snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
1061                  suffix);
1062         if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
1063                                  &offset_size)) {
1064                 debug("%s: Failed to decode memory region '%s'\n", __func__,
1065                       prop_name);
1066                 return -EINVAL;
1067         }
1068
1069         *basep = base + offset;
1070         *sizep = offset_size;
1071
1072         return 0;
1073 }
1074
1075 static int decode_timing_property(const void *blob, int node, const char *name,
1076                                   struct timing_entry *result)
1077 {
1078         int length, ret = 0;
1079         const u32 *prop;
1080
1081         prop = fdt_getprop(blob, node, name, &length);
1082         if (!prop) {
1083                 debug("%s: could not find property %s\n",
1084                       fdt_get_name(blob, node, NULL), name);
1085                 return length;
1086         }
1087
1088         if (length == sizeof(u32)) {
1089                 result->typ = fdtdec_get_int(blob, node, name, 0);
1090                 result->min = result->typ;
1091                 result->max = result->typ;
1092         } else {
1093                 ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
1094         }
1095
1096         return ret;
1097 }
1098
1099 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
1100                                  struct display_timing *dt)
1101 {
1102         int i, node, timings_node;
1103         u32 val = 0;
1104         int ret = 0;
1105
1106         timings_node = fdt_subnode_offset(blob, parent, "display-timings");
1107         if (timings_node < 0)
1108                 return timings_node;
1109
1110         for (i = 0, node = fdt_first_subnode(blob, timings_node);
1111              node > 0 && i != index;
1112              node = fdt_next_subnode(blob, node))
1113                 i++;
1114
1115         if (node < 0)
1116                 return node;
1117
1118         memset(dt, 0, sizeof(*dt));
1119
1120         ret |= decode_timing_property(blob, node, "hback-porch",
1121                                       &dt->hback_porch);
1122         ret |= decode_timing_property(blob, node, "hfront-porch",
1123                                       &dt->hfront_porch);
1124         ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1125         ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1126         ret |= decode_timing_property(blob, node, "vback-porch",
1127                                       &dt->vback_porch);
1128         ret |= decode_timing_property(blob, node, "vfront-porch",
1129                                       &dt->vfront_porch);
1130         ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1131         ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1132         ret |= decode_timing_property(blob, node, "clock-frequency",
1133                                       &dt->pixelclock);
1134
1135         dt->flags = 0;
1136         val = fdtdec_get_int(blob, node, "vsync-active", -1);
1137         if (val != -1) {
1138                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1139                                 DISPLAY_FLAGS_VSYNC_LOW;
1140         }
1141         val = fdtdec_get_int(blob, node, "hsync-active", -1);
1142         if (val != -1) {
1143                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1144                                 DISPLAY_FLAGS_HSYNC_LOW;
1145         }
1146         val = fdtdec_get_int(blob, node, "de-active", -1);
1147         if (val != -1) {
1148                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1149                                 DISPLAY_FLAGS_DE_LOW;
1150         }
1151         val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1152         if (val != -1) {
1153                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1154                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1155         }
1156
1157         if (fdtdec_get_bool(blob, node, "interlaced"))
1158                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
1159         if (fdtdec_get_bool(blob, node, "doublescan"))
1160                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1161         if (fdtdec_get_bool(blob, node, "doubleclk"))
1162                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1163
1164         return ret;
1165 }
1166
1167 int fdtdec_setup(void)
1168 {
1169 #if CONFIG_IS_ENABLED(OF_CONTROL)
1170 # ifdef CONFIG_OF_EMBED
1171         /* Get a pointer to the FDT */
1172         gd->fdt_blob = __dtb_dt_begin;
1173 # elif defined CONFIG_OF_SEPARATE
1174 #  ifdef CONFIG_SPL_BUILD
1175         /* FDT is at end of BSS unless it is in a different memory region */
1176         if (IS_ENABLED(CONFIG_SPL_SEPARATE_BSS))
1177                 gd->fdt_blob = (ulong *)&_image_binary_end;
1178         else
1179                 gd->fdt_blob = (ulong *)&__bss_end;
1180 #  else
1181         /* FDT is at end of image */
1182         gd->fdt_blob = (ulong *)&_end;
1183 #  endif
1184 # elif defined(CONFIG_OF_HOSTFILE)
1185         if (sandbox_read_fdt_from_file()) {
1186                 puts("Failed to read control FDT\n");
1187                 return -1;
1188         }
1189 # endif
1190 # ifndef CONFIG_SPL_BUILD
1191         /* Allow the early environment to override the fdt address */
1192         gd->fdt_blob = (void *)getenv_ulong("fdtcontroladdr", 16,
1193                                                 (uintptr_t)gd->fdt_blob);
1194 # endif
1195 #endif
1196         return fdtdec_prepare_fdt();
1197 }
1198
1199 #endif /* !USE_HOSTCC */