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