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