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