lib/fdtdec.c

   1 /*
   2  * Copyright (c) 2011 The Chromium OS Authors.
   3  * See file CREDITS for list of people who contributed to this
   4  * project.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of
   9  * the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  19  * MA 02111-1307 USA
  20  */
  21
  22 #include <common.h>
  23 #include <serial.h>
  24 #include <libfdt.h>
  25 #include <fdtdec.h>
  26
  27 #include <asm/gpio.h>
  28
  29 DECLARE_GLOBAL_DATA_PTR;
  30
  31 /*
  32  * Here are the type we know about. One day we might allow drivers to
  33  * register. For now we just put them here. The COMPAT macro allows us to
  34  * turn this into a sparse list later, and keeps the ID with the name.
  35  */
  36 #define COMPAT(id, name) name
  37 static const char * const compat_names[COMPAT_COUNT] = {
  38         COMPAT(UNKNOWN, "<none>"),
  39         COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
  40         COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
  41         COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
  42         COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
  43         COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
  44         COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
  45         COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
  46         COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
  47         COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
  48         COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
  49         COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
  50         COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
  51         COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
  52         COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
  53         COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
  54         COMPAT(SMSC_LAN9215, "smsc,lan9215"),
  55         COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
  56         COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
  57         COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
  58         COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
  59         COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
  60         COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
  61         COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
  62         COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
  63         COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
  64         COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
  65         COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
  66         COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
  67         COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
  68         COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
  69         COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
  70         COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
  71 };
  72
  73 const char *fdtdec_get_compatible(enum fdt_compat_id id)
  74 {
  75         /* We allow reading of the 'unknown' ID for testing purposes */
  76         assert(id >= 0 && id < COMPAT_COUNT);
  77         return compat_names[id];
  78 }
  79
  80 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
  81                 const char *prop_name, fdt_size_t *sizep)
  82 {
  83         const fdt_addr_t *cell;
  84         int len;
  85
  86         debug("%s: %s: ", __func__, prop_name);
  87         cell = fdt_getprop(blob, node, prop_name, &len);
  88         if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
  89                      len == sizeof(fdt_addr_t) * 2)) {
  90                 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
  91                 if (sizep) {
  92                         const fdt_size_t *size;
  93
  94                         size = (fdt_size_t *)((char *)cell +
  95                                         sizeof(fdt_addr_t));
  96                         *sizep = fdt_size_to_cpu(*size);
  97                         debug("addr=%p, size=%p\n", (void *)addr,
  98                               (void *)*sizep);
  99                 } else {
 100                         debug("%p\n", (void *)addr);
 101                 }
 102                 return addr;
 103         }
 104         debug("(not found)\n");
 105         return FDT_ADDR_T_NONE;
 106 }
 107
 108 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
 109                 const char *prop_name)
 110 {
 111         return fdtdec_get_addr_size(blob, node, prop_name, NULL);
 112 }
 113
 114 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
 115                 s32 default_val)
 116 {
 117         const s32 *cell;
 118         int len;
 119
 120         debug("%s: %s: ", __func__, prop_name);
 121         cell = fdt_getprop(blob, node, prop_name, &len);
 122         if (cell && len >= sizeof(s32)) {
 123                 s32 val = fdt32_to_cpu(cell[0]);
 124
 125                 debug("%#x (%d)\n", val, val);
 126                 return val;
 127         }
 128         debug("(not found)\n");
 129         return default_val;
 130 }
 131
 132 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
 133                 uint64_t default_val)
 134 {
 135         const uint64_t *cell64;
 136         int length;
 137
 138         cell64 = fdt_getprop(blob, node, prop_name, &length);
 139         if (!cell64 || length < sizeof(*cell64))
 140                 return default_val;
 141
 142         return fdt64_to_cpu(*cell64);
 143 }
 144
 145 int fdtdec_get_is_enabled(const void *blob, int node)
 146 {
 147         const char *cell;
 148
 149         /*
 150          * It should say "okay", so only allow that. Some fdts use "ok" but
 151          * this is a bug. Please fix your device tree source file. See here
 152          * for discussion:
 153          *
 154          * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
 155          */
 156         cell = fdt_getprop(blob, node, "status", NULL);
 157         if (cell)
 158                 return 0 == strcmp(cell, "okay");
 159         return 1;
 160 }
 161
 162 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
 163 {
 164         enum fdt_compat_id id;
 165
 166         /* Search our drivers */
 167         for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
 168                 if (0 == fdt_node_check_compatible(blob, node,
 169                                 compat_names[id]))
 170                         return id;
 171         return COMPAT_UNKNOWN;
 172 }
 173
 174 int fdtdec_next_compatible(const void *blob, int node,
 175                 enum fdt_compat_id id)
 176 {
 177         return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
 178 }
 179
 180 int fdtdec_next_compatible_subnode(const void *blob, int node,
 181                 enum fdt_compat_id id, int *depthp)
 182 {
 183         do {
 184                 node = fdt_next_node(blob, node, depthp);
 185         } while (*depthp > 1);
 186
 187         /* If this is a direct subnode, and compatible, return it */
 188         if (*depthp == 1 && 0 == fdt_node_check_compatible(
 189                                                 blob, node, compat_names[id]))
 190                 return node;
 191
 192         return -FDT_ERR_NOTFOUND;
 193 }
 194
 195 int fdtdec_next_alias(const void *blob, const char *name,
 196                 enum fdt_compat_id id, int *upto)
 197 {
 198 #define MAX_STR_LEN 20
 199         char str[MAX_STR_LEN + 20];
 200         int node, err;
 201
 202         /* snprintf() is not available */
 203         assert(strlen(name) < MAX_STR_LEN);
 204         sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
 205         node = fdt_path_offset(blob, str);
 206         if (node < 0)
 207                 return node;
 208         err = fdt_node_check_compatible(blob, node, compat_names[id]);
 209         if (err < 0)
 210                 return err;
 211         if (err)
 212                 return -FDT_ERR_NOTFOUND;
 213         (*upto)++;
 214         return node;
 215 }
 216
 217 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
 218                         enum fdt_compat_id id, int *node_list, int maxcount)
 219 {
 220         memset(node_list, '\0', sizeof(*node_list) * maxcount);
 221
 222         return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
 223 }
 224
 225 /* TODO: Can we tighten this code up a little? */
 226 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
 227                         enum fdt_compat_id id, int *node_list, int maxcount)
 228 {
 229         int name_len = strlen(name);
 230         int nodes[maxcount];
 231         int num_found = 0;
 232         int offset, node;
 233         int alias_node;
 234         int count;
 235         int i, j;
 236
 237         /* find the alias node if present */
 238         alias_node = fdt_path_offset(blob, "/aliases");
 239
 240         /*
 241          * start with nothing, and we can assume that the root node can't
 242          * match
 243          */
 244         memset(nodes, '\0', sizeof(nodes));
 245
 246         /* First find all the compatible nodes */
 247         for (node = count = 0; node >= 0 && count < maxcount;) {
 248                 node = fdtdec_next_compatible(blob, node, id);
 249                 if (node >= 0)
 250                         nodes[count++] = node;
 251         }
 252         if (node >= 0)
 253                 debug("%s: warning: maxcount exceeded with alias '%s'\n",
 254                        __func__, name);
 255
 256         /* Now find all the aliases */
 257         for (offset = fdt_first_property_offset(blob, alias_node);
 258                         offset > 0;
 259                         offset = fdt_next_property_offset(blob, offset)) {
 260                 const struct fdt_property *prop;
 261                 const char *path;
 262                 int number;
 263                 int found;
 264
 265                 node = 0;
 266                 prop = fdt_get_property_by_offset(blob, offset, NULL);
 267                 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
 268                 if (prop->len && 0 == strncmp(path, name, name_len))
 269                         node = fdt_path_offset(blob, prop->data);
 270                 if (node <= 0)
 271                         continue;
 272
 273                 /* Get the alias number */
 274                 number = simple_strtoul(path + name_len, NULL, 10);
 275                 if (number < 0 || number >= maxcount) {
 276                         debug("%s: warning: alias '%s' is out of range\n",
 277                                __func__, path);
 278                         continue;
 279                 }
 280
 281                 /* Make sure the node we found is actually in our list! */
 282                 found = -1;
 283                 for (j = 0; j < count; j++)
 284                         if (nodes[j] == node) {
 285                                 found = j;
 286                                 break;
 287                         }
 288
 289                 if (found == -1) {
 290                         debug("%s: warning: alias '%s' points to a node "
 291                                 "'%s' that is missing or is not compatible "
 292                                 " with '%s'\n", __func__, path,
 293                                 fdt_get_name(blob, node, NULL),
 294                                compat_names[id]);
 295                         continue;
 296                 }
 297
 298                 /*
 299                  * Add this node to our list in the right place, and mark
 300                  * it as done.
 301                  */
 302                 if (fdtdec_get_is_enabled(blob, node)) {
 303                         if (node_list[number]) {
 304                                 debug("%s: warning: alias '%s' requires that "
 305                                       "a node be placed in the list in a "
 306                                       "position which is already filled by "
 307                                       "node '%s'\n", __func__, path,
 308                                       fdt_get_name(blob, node, NULL));
 309                                 continue;
 310                         }
 311                         node_list[number] = node;
 312                         if (number >= num_found)
 313                                 num_found = number + 1;
 314                 }
 315                 nodes[found] = 0;
 316         }
 317
 318         /* Add any nodes not mentioned by an alias */
 319         for (i = j = 0; i < maxcount; i++) {
 320                 if (!node_list[i]) {
 321                         for (; j < maxcount; j++)
 322                                 if (nodes[j] &&
 323                                         fdtdec_get_is_enabled(blob, nodes[j]))
 324                                         break;
 325
 326                         /* Have we run out of nodes to add? */
 327                         if (j == maxcount)
 328                                 break;
 329
 330                         assert(!node_list[i]);
 331                         node_list[i] = nodes[j++];
 332                         if (i >= num_found)
 333                                 num_found = i + 1;
 334                 }
 335         }
 336
 337         return num_found;
 338 }
 339
 340 int fdtdec_check_fdt(void)
 341 {
 342         /*
 343          * We must have an FDT, but we cannot panic() yet since the console
 344          * is not ready. So for now, just assert(). Boards which need an early
 345          * FDT (prior to console ready) will need to make their own
 346          * arrangements and do their own checks.
 347          */
 348         assert(!fdtdec_prepare_fdt());
 349         return 0;
 350 }
 351
 352 /*
 353  * This function is a little odd in that it accesses global data. At some
 354  * point if the architecture board.c files merge this will make more sense.
 355  * Even now, it is common code.
 356  */
 357 int fdtdec_prepare_fdt(void)
 358 {
 359         if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
 360             fdt_check_header(gd->fdt_blob)) {
 361                 printf("No valid FDT found - please append one to U-Boot "
 362                         "binary, use u-boot-dtb.bin or define "
 363                         "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
 364                 return -1;
 365         }
 366         return 0;
 367 }
 368
 369 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
 370 {
 371         const u32 *phandle;
 372         int lookup;
 373
 374         debug("%s: %s\n", __func__, prop_name);
 375         phandle = fdt_getprop(blob, node, prop_name, NULL);
 376         if (!phandle)
 377                 return -FDT_ERR_NOTFOUND;
 378
 379         lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
 380         return lookup;
 381 }
 382
 383 /**
 384  * Look up a property in a node and check that it has a minimum length.
 385  *
 386  * @param blob          FDT blob
 387  * @param node          node to examine
 388  * @param prop_name     name of property to find
 389  * @param min_len       minimum property length in bytes
 390  * @param err           0 if ok, or -FDT_ERR_NOTFOUND if the property is not
 391                         found, or -FDT_ERR_BADLAYOUT if not enough data
 392  * @return pointer to cell, which is only valid if err == 0
 393  */
 394 static const void *get_prop_check_min_len(const void *blob, int node,
 395                 const char *prop_name, int min_len, int *err)
 396 {
 397         const void *cell;
 398         int len;
 399
 400         debug("%s: %s\n", __func__, prop_name);
 401         cell = fdt_getprop(blob, node, prop_name, &len);
 402         if (!cell)
 403                 *err = -FDT_ERR_NOTFOUND;
 404         else if (len < min_len)
 405                 *err = -FDT_ERR_BADLAYOUT;
 406         else
 407                 *err = 0;
 408         return cell;
 409 }
 410
 411 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
 412                 u32 *array, int count)
 413 {
 414         const u32 *cell;
 415         int i, err = 0;
 416
 417         debug("%s: %s\n", __func__, prop_name);
 418         cell = get_prop_check_min_len(blob, node, prop_name,
 419                                       sizeof(u32) * count, &err);
 420         if (!err) {
 421                 for (i = 0; i < count; i++)
 422                         array[i] = fdt32_to_cpu(cell[i]);
 423         }
 424         return err;
 425 }
 426
 427 const u32 *fdtdec_locate_array(const void *blob, int node,
 428                                const char *prop_name, int count)
 429 {
 430         const u32 *cell;
 431         int err;
 432
 433         cell = get_prop_check_min_len(blob, node, prop_name,
 434                                       sizeof(u32) * count, &err);
 435         return err ? NULL : cell;
 436 }
 437
 438 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
 439 {
 440         const s32 *cell;
 441         int len;
 442
 443         debug("%s: %s\n", __func__, prop_name);
 444         cell = fdt_getprop(blob, node, prop_name, &len);
 445         return cell != NULL;
 446 }
 447
 448 /**
 449  * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
 450  * terminating item.
 451  *
 452  * @param blob          FDT blob to use
 453  * @param node          Node to look at
 454  * @param prop_name     Node property name
 455  * @param gpio          Array of gpio elements to fill from FDT. This will be
 456  *                      untouched if either 0 or an error is returned
 457  * @param max_count     Maximum number of elements allowed
 458  * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
 459  * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
 460  */
 461 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
 462                 struct fdt_gpio_state *gpio, int max_count)
 463 {
 464         const struct fdt_property *prop;
 465         const u32 *cell;
 466         const char *name;
 467         int len, i;
 468
 469         debug("%s: %s\n", __func__, prop_name);
 470         assert(max_count > 0);
 471         prop = fdt_get_property(blob, node, prop_name, &len);
 472         if (!prop) {
 473                 debug("%s: property '%s' missing\n", __func__, prop_name);
 474                 return -FDT_ERR_NOTFOUND;
 475         }
 476
 477         /* We will use the name to tag the GPIO */
 478         name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
 479         cell = (u32 *)prop->data;
 480         len /= sizeof(u32) * 3;         /* 3 cells per GPIO record */
 481         if (len > max_count) {
 482                 debug(" %s: too many GPIOs / cells for "
 483                         "property '%s'\n", __func__, prop_name);
 484                 return -FDT_ERR_BADLAYOUT;
 485         }
 486
 487         /* Read out the GPIO data from the cells */
 488         for (i = 0; i < len; i++, cell += 3) {
 489                 gpio[i].gpio = fdt32_to_cpu(cell[1]);
 490                 gpio[i].flags = fdt32_to_cpu(cell[2]);
 491                 gpio[i].name = name;
 492         }
 493
 494         return len;
 495 }
 496
 497 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
 498                 struct fdt_gpio_state *gpio)
 499 {
 500         int err;
 501
 502         debug("%s: %s\n", __func__, prop_name);
 503         gpio->gpio = FDT_GPIO_NONE;
 504         gpio->name = NULL;
 505         err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
 506         return err == 1 ? 0 : err;
 507 }
 508
 509 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
 510 {
 511         int val;
 512
 513         if (!fdt_gpio_isvalid(gpio))
 514                 return -1;
 515
 516         val = gpio_get_value(gpio->gpio);
 517         return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
 518 }
 519
 520 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
 521 {
 522         if (!fdt_gpio_isvalid(gpio))
 523                 return -1;
 524
 525         val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
 526         return gpio_set_value(gpio->gpio, val);
 527 }
 528
 529 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
 530 {
 531         /*
 532          * Return success if there is no GPIO defined. This is used for
 533          * optional GPIOs)
 534          */
 535         if (!fdt_gpio_isvalid(gpio))
 536                 return 0;
 537
 538         if (gpio_request(gpio->gpio, gpio->name))
 539                 return -1;
 540         return 0;
 541 }
 542
 543 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
 544                 u8 *array, int count)
 545 {
 546         const u8 *cell;
 547         int err;
 548
 549         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 550         if (!err)
 551                 memcpy(array, cell, count);
 552         return err;
 553 }
 554
 555 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
 556                              const char *prop_name, int count)
 557 {
 558         const u8 *cell;
 559         int err;
 560
 561         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
 562         if (err)
 563                 return NULL;
 564         return cell;
 565 }
 566
 567 int fdtdec_get_config_int(const void *blob, const char *prop_name,
 568                 int default_val)
 569 {
 570         int config_node;
 571
 572         debug("%s: %s\n", __func__, prop_name);
 573         config_node = fdt_path_offset(blob, "/config");
 574         if (config_node < 0)
 575                 return default_val;
 576         return fdtdec_get_int(blob, config_node, prop_name, default_val);
 577 }
 578
 579 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
 580 {
 581         int config_node;
 582         const void *prop;
 583
 584         debug("%s: %s\n", __func__, prop_name);
 585         config_node = fdt_path_offset(blob, "/config");
 586         if (config_node < 0)
 587                 return 0;
 588         prop = fdt_get_property(blob, config_node, prop_name, NULL);
 589
 590         return prop != NULL;
 591 }
 592
 593 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
 594 {
 595         const char *nodep;
 596         int nodeoffset;
 597         int len;
 598
 599         debug("%s: %s\n", __func__, prop_name);
 600         nodeoffset = fdt_path_offset(blob, "/config");
 601         if (nodeoffset < 0)
 602                 return NULL;
 603
 604         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
 605         if (!nodep)
 606                 return NULL;
 607
 608         return (char *)nodep;
 609 }
 610
 611 int fdtdec_decode_region(const void *blob, int node,
 612                 const char *prop_name, void **ptrp, size_t *size)
 613 {
 614         const fdt_addr_t *cell;
 615         int len;
 616
 617         debug("%s: %s\n", __func__, prop_name);
 618         cell = fdt_getprop(blob, node, prop_name, &len);
 619         if (!cell || (len != sizeof(fdt_addr_t) * 2))
 620                 return -1;
 621
 622         *ptrp = (void *)fdt_addr_to_cpu(*cell);
 623         *size = fdt_size_to_cpu(cell[1]);
 624         debug("%s: size=%zx\n", __func__, *size);
 625         return 0;
 626 }