lib/fdtdec.c

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