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