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