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