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