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