lib/libfdt/fdt_ro.c

   1 /*
   2  * libfdt - Flat Device Tree manipulation
   3  * Copyright (C) 2006 David Gibson, IBM Corporation.
   4  *
   5  * libfdt is dual licensed: you can use it either under the terms of
   6  * the GPL, or the BSD license, at your option.
   7  *
   8  *  a) This library is free software; you can redistribute it and/or
   9  *     modify it under the terms of the GNU General Public License as
  10  *     published by the Free Software Foundation; either version 2 of the
  11  *     License, or (at your option) any later version.
  12  *
  13  *     This library is distributed in the hope that it will be useful,
  14  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *     GNU General Public License for more details.
  17  *
  18  *     You should have received a copy of the GNU General Public
  19  *     License along with this library; if not, write to the Free
  20  *     Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  21  *     MA 02110-1301 USA
  22  *
  23  * Alternatively,
  24  *
  25  *  b) Redistribution and use in source and binary forms, with or
  26  *     without modification, are permitted provided that the following
  27  *     conditions are met:
  28  *
  29  *     1. Redistributions of source code must retain the above
  30  *        copyright notice, this list of conditions and the following
  31  *        disclaimer.
  32  *     2. Redistributions in binary form must reproduce the above
  33  *        copyright notice, this list of conditions and the following
  34  *        disclaimer in the documentation and/or other materials
  35  *        provided with the distribution.
  36  *
  37  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  38  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  39  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  40  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  41  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  42  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  47  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  48  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  49  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50  */
  51 #include "libfdt_env.h"
  52
  53 #ifndef USE_HOSTCC
  54 #include <fdt.h>
  55 #include <libfdt.h>
  56 #else
  57 #include "fdt_host.h"
  58 #endif
  59
  60 #include "libfdt_internal.h"
  61
  62 static int _fdt_nodename_eq(const void *fdt, int offset,
  63                             const char *s, int len)
  64 {
  65         const char *p = fdt_offset_ptr(fdt, offset + FDT_TAGSIZE, len+1);
  66
  67         if (! p)
  68                 /* short match */
  69                 return 0;
  70
  71         if (memcmp(p, s, len) != 0)
  72                 return 0;
  73
  74         if (p[len] == '\0')
  75                 return 1;
  76         else if (!memchr(s, '@', len) && (p[len] == '@'))
  77                 return 1;
  78         else
  79                 return 0;
  80 }
  81
  82 const char *fdt_string(const void *fdt, int stroffset)
  83 {
  84         return (const char *)fdt + fdt_off_dt_strings(fdt) + stroffset;
  85 }
  86
  87 static int _fdt_string_eq(const void *fdt, int stroffset,
  88                           const char *s, int len)
  89 {
  90         const char *p = fdt_string(fdt, stroffset);
  91
  92         return (strlen(p) == len) && (memcmp(p, s, len) == 0);
  93 }
  94
  95 int fdt_get_mem_rsv(const void *fdt, int n, uint64_t *address, uint64_t *size)
  96 {
  97         FDT_CHECK_HEADER(fdt);
  98         *address = fdt64_to_cpu(_fdt_mem_rsv(fdt, n)->address);
  99         *size = fdt64_to_cpu(_fdt_mem_rsv(fdt, n)->size);
 100         return 0;
 101 }
 102
 103 int fdt_num_mem_rsv(const void *fdt)
 104 {
 105         int i = 0;
 106
 107         while (fdt64_to_cpu(_fdt_mem_rsv(fdt, i)->size) != 0)
 108                 i++;
 109         return i;
 110 }
 111
 112 int fdt_subnode_offset_namelen(const void *fdt, int offset,
 113                                const char *name, int namelen)
 114 {
 115         int depth;
 116
 117         FDT_CHECK_HEADER(fdt);
 118
 119         for (depth = 0;
 120              (offset >= 0) && (depth >= 0);
 121              offset = fdt_next_node(fdt, offset, &depth))
 122                 if ((depth == 1)
 123                     && _fdt_nodename_eq(fdt, offset, name, namelen))
 124                         return offset;
 125
 126         if (depth < 0)
 127                 return -FDT_ERR_NOTFOUND;
 128         return offset; /* error */
 129 }
 130
 131 int fdt_subnode_offset(const void *fdt, int parentoffset,
 132                        const char *name)
 133 {
 134         return fdt_subnode_offset_namelen(fdt, parentoffset, name, strlen(name));
 135 }
 136
 137 int fdt_path_offset(const void *fdt, const char *path)
 138 {
 139         const char *end = path + strlen(path);
 140         const char *p = path;
 141         int offset = 0;
 142
 143         FDT_CHECK_HEADER(fdt);
 144
 145         /* see if we have an alias */
 146         if (*path != '/') {
 147                 const char *q = strchr(path, '/');
 148
 149                 if (!q)
 150                         q = end;
 151
 152                 p = fdt_get_alias_namelen(fdt, p, q - p);
 153                 if (!p)
 154                         return -FDT_ERR_BADPATH;
 155                 offset = fdt_path_offset(fdt, p);
 156
 157                 p = q;
 158         }
 159
 160         while (*p) {
 161                 const char *q;
 162
 163                 while (*p == '/')
 164                         p++;
 165                 if (! *p)
 166                         return offset;
 167                 q = strchr(p, '/');
 168                 if (! q)
 169                         q = end;
 170
 171                 offset = fdt_subnode_offset_namelen(fdt, offset, p, q-p);
 172                 if (offset < 0)
 173                         return offset;
 174
 175                 p = q;
 176         }
 177
 178         return offset;
 179 }
 180
 181 const char *fdt_get_name(const void *fdt, int nodeoffset, int *len)
 182 {
 183         const struct fdt_node_header *nh = _fdt_offset_ptr(fdt, nodeoffset);
 184         int err;
 185
 186         if (((err = fdt_check_header(fdt)) != 0)
 187             || ((err = _fdt_check_node_offset(fdt, nodeoffset)) < 0))
 188                         goto fail;
 189
 190         if (len)
 191                 *len = strlen(nh->name);
 192
 193         return nh->name;
 194
 195  fail:
 196         if (len)
 197                 *len = err;
 198         return NULL;
 199 }
 200
 201 const struct fdt_property *fdt_get_property_namelen(const void *fdt,
 202                                                     int nodeoffset,
 203                                                     const char *name,
 204                                                     int namelen, int *lenp)
 205 {
 206         uint32_t tag;
 207         const struct fdt_property *prop;
 208         int offset, nextoffset;
 209         int err;
 210
 211         if (((err = fdt_check_header(fdt)) != 0)
 212             || ((err = _fdt_check_node_offset(fdt, nodeoffset)) < 0))
 213                         goto fail;
 214
 215         nextoffset = err;
 216         do {
 217                 offset = nextoffset;
 218
 219                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 220                 switch (tag) {
 221                 case FDT_END:
 222                         if (nextoffset < 0)
 223                                 err = nextoffset;
 224                         else
 225                                 /* FDT_END tag with unclosed nodes */
 226                                 err = -FDT_ERR_BADSTRUCTURE;
 227                         goto fail;
 228
 229                 case FDT_PROP:
 230                         prop = _fdt_offset_ptr(fdt, offset);
 231                         if (_fdt_string_eq(fdt, fdt32_to_cpu(prop->nameoff),
 232                                            name, namelen)) {
 233                                 /* Found it! */
 234                                 if (lenp)
 235                                         *lenp = fdt32_to_cpu(prop->len);
 236
 237                                 return prop;
 238                         }
 239                         break;
 240                 }
 241         } while ((tag != FDT_BEGIN_NODE) && (tag != FDT_END_NODE));
 242
 243         err = -FDT_ERR_NOTFOUND;
 244  fail:
 245         if (lenp)
 246                 *lenp = err;
 247         return NULL;
 248 }
 249
 250 const struct fdt_property *fdt_get_property(const void *fdt,
 251                                             int nodeoffset,
 252                                             const char *name, int *lenp)
 253 {
 254         return fdt_get_property_namelen(fdt, nodeoffset, name,
 255                                         strlen(name), lenp);
 256 }
 257
 258 const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
 259                                 const char *name, int namelen, int *lenp)
 260 {
 261         const struct fdt_property *prop;
 262
 263         prop = fdt_get_property_namelen(fdt, nodeoffset, name, namelen, lenp);
 264         if (! prop)
 265                 return NULL;
 266
 267         return prop->data;
 268 }
 269
 270 const void *fdt_getprop(const void *fdt, int nodeoffset,
 271                         const char *name, int *lenp)
 272 {
 273         return fdt_getprop_namelen(fdt, nodeoffset, name, strlen(name), lenp);
 274 }
 275
 276 uint32_t fdt_get_phandle(const void *fdt, int nodeoffset)
 277 {
 278         const uint32_t *php;
 279         int len;
 280
 281         /* FIXME: This is a bit sub-optimal, since we potentially scan
 282          * over all the properties twice. */
 283         php = fdt_getprop(fdt, nodeoffset, "phandle", &len);
 284         if (!php || (len != sizeof(*php))) {
 285                 php = fdt_getprop(fdt, nodeoffset, "linux,phandle", &len);
 286                 if (!php || (len != sizeof(*php)))
 287                         return 0;
 288         }
 289
 290         return fdt32_to_cpu(*php);
 291 }
 292
 293 const char *fdt_get_alias_namelen(const void *fdt,
 294                                   const char *name, int namelen)
 295 {
 296         int aliasoffset;
 297
 298         aliasoffset = fdt_path_offset(fdt, "/aliases");
 299         if (aliasoffset < 0)
 300                 return NULL;
 301
 302         return fdt_getprop_namelen(fdt, aliasoffset, name, namelen, NULL);
 303 }
 304
 305 const char *fdt_get_alias(const void *fdt, const char *name)
 306 {
 307         return fdt_get_alias_namelen(fdt, name, strlen(name));
 308 }
 309
 310 int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen)
 311 {
 312         int pdepth = 0, p = 0;
 313         int offset, depth, namelen;
 314         const char *name;
 315
 316         FDT_CHECK_HEADER(fdt);
 317
 318         if (buflen < 2)
 319                 return -FDT_ERR_NOSPACE;
 320
 321         for (offset = 0, depth = 0;
 322              (offset >= 0) && (offset <= nodeoffset);
 323              offset = fdt_next_node(fdt, offset, &depth)) {
 324                 while (pdepth > depth) {
 325                         do {
 326                                 p--;
 327                         } while (buf[p-1] != '/');
 328                         pdepth--;
 329                 }
 330
 331                 if (pdepth >= depth) {
 332                         name = fdt_get_name(fdt, offset, &namelen);
 333                         if (!name)
 334                                 return namelen;
 335                         if ((p + namelen + 1) <= buflen) {
 336                                 memcpy(buf + p, name, namelen);
 337                                 p += namelen;
 338                                 buf[p++] = '/';
 339                                 pdepth++;
 340                         }
 341                 }
 342
 343                 if (offset == nodeoffset) {
 344                         if (pdepth < (depth + 1))
 345                                 return -FDT_ERR_NOSPACE;
 346
 347                         if (p > 1) /* special case so that root path is "/", not "" */
 348                                 p--;
 349                         buf[p] = '\0';
 350                         return 0;
 351                 }
 352         }
 353
 354         if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
 355                 return -FDT_ERR_BADOFFSET;
 356         else if (offset == -FDT_ERR_BADOFFSET)
 357                 return -FDT_ERR_BADSTRUCTURE;
 358
 359         return offset; /* error from fdt_next_node() */
 360 }
 361
 362 int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
 363                                  int supernodedepth, int *nodedepth)
 364 {
 365         int offset, depth;
 366         int supernodeoffset = -FDT_ERR_INTERNAL;
 367
 368         FDT_CHECK_HEADER(fdt);
 369
 370         if (supernodedepth < 0)
 371                 return -FDT_ERR_NOTFOUND;
 372
 373         for (offset = 0, depth = 0;
 374              (offset >= 0) && (offset <= nodeoffset);
 375              offset = fdt_next_node(fdt, offset, &depth)) {
 376                 if (depth == supernodedepth)
 377                         supernodeoffset = offset;
 378
 379                 if (offset == nodeoffset) {
 380                         if (nodedepth)
 381                                 *nodedepth = depth;
 382
 383                         if (supernodedepth > depth)
 384                                 return -FDT_ERR_NOTFOUND;
 385                         else
 386                                 return supernodeoffset;
 387                 }
 388         }
 389
 390         if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
 391                 return -FDT_ERR_BADOFFSET;
 392         else if (offset == -FDT_ERR_BADOFFSET)
 393                 return -FDT_ERR_BADSTRUCTURE;
 394
 395         return offset; /* error from fdt_next_node() */
 396 }
 397
 398 int fdt_node_depth(const void *fdt, int nodeoffset)
 399 {
 400         int nodedepth;
 401         int err;
 402
 403         err = fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, &nodedepth);
 404         if (err)
 405                 return (err < 0) ? err : -FDT_ERR_INTERNAL;
 406         return nodedepth;
 407 }
 408
 409 int fdt_parent_offset(const void *fdt, int nodeoffset)
 410 {
 411         int nodedepth = fdt_node_depth(fdt, nodeoffset);
 412
 413         if (nodedepth < 0)
 414                 return nodedepth;
 415         return fdt_supernode_atdepth_offset(fdt, nodeoffset,
 416                                             nodedepth - 1, NULL);
 417 }
 418
 419 int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
 420                                   const char *propname,
 421                                   const void *propval, int proplen)
 422 {
 423         int offset;
 424         const void *val;
 425         int len;
 426
 427         FDT_CHECK_HEADER(fdt);
 428
 429         /* FIXME: The algorithm here is pretty horrible: we scan each
 430          * property of a node in fdt_getprop(), then if that didn't
 431          * find what we want, we scan over them again making our way
 432          * to the next node.  Still it's the easiest to implement
 433          * approach; performance can come later. */
 434         for (offset = fdt_next_node(fdt, startoffset, NULL);
 435              offset >= 0;
 436              offset = fdt_next_node(fdt, offset, NULL)) {
 437                 val = fdt_getprop(fdt, offset, propname, &len);
 438                 if (val && (len == proplen)
 439                     && (memcmp(val, propval, len) == 0))
 440                         return offset;
 441         }
 442
 443         return offset; /* error from fdt_next_node() */
 444 }
 445
 446 int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle)
 447 {
 448         int offset;
 449
 450         if ((phandle == 0) || (phandle == -1))
 451                 return -FDT_ERR_BADPHANDLE;
 452
 453         FDT_CHECK_HEADER(fdt);
 454
 455         /* FIXME: The algorithm here is pretty horrible: we
 456          * potentially scan each property of a node in
 457          * fdt_get_phandle(), then if that didn't find what
 458          * we want, we scan over them again making our way to the next
 459          * node.  Still it's the easiest to implement approach;
 460          * performance can come later. */
 461         for (offset = fdt_next_node(fdt, -1, NULL);
 462              offset >= 0;
 463              offset = fdt_next_node(fdt, offset, NULL)) {
 464                 if (fdt_get_phandle(fdt, offset) == phandle)
 465                         return offset;
 466         }
 467
 468         return offset; /* error from fdt_next_node() */
 469 }
 470
 471 static int _fdt_stringlist_contains(const char *strlist, int listlen,
 472                                     const char *str)
 473 {
 474         int len = strlen(str);
 475         const char *p;
 476
 477         while (listlen >= len) {
 478                 if (memcmp(str, strlist, len+1) == 0)
 479                         return 1;
 480                 p = memchr(strlist, '\0', listlen);
 481                 if (!p)
 482                         return 0; /* malformed strlist.. */
 483                 listlen -= (p-strlist) + 1;
 484                 strlist = p + 1;
 485         }
 486         return 0;
 487 }
 488
 489 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
 490                               const char *compatible)
 491 {
 492         const void *prop;
 493         int len;
 494
 495         prop = fdt_getprop(fdt, nodeoffset, "compatible", &len);
 496         if (!prop)
 497                 return len;
 498         if (_fdt_stringlist_contains(prop, len, compatible))
 499                 return 0;
 500         else
 501                 return 1;
 502 }
 503
 504 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
 505                                   const char *compatible)
 506 {
 507         int offset, err;
 508
 509         FDT_CHECK_HEADER(fdt);
 510
 511         /* FIXME: The algorithm here is pretty horrible: we scan each
 512          * property of a node in fdt_node_check_compatible(), then if
 513          * that didn't find what we want, we scan over them again
 514          * making our way to the next node.  Still it's the easiest to
 515          * implement approach; performance can come later. */
 516         for (offset = fdt_next_node(fdt, startoffset, NULL);
 517              offset >= 0;
 518              offset = fdt_next_node(fdt, offset, NULL)) {
 519                 err = fdt_node_check_compatible(fdt, offset, compatible);
 520                 if ((err < 0) && (err != -FDT_ERR_NOTFOUND))
 521                         return err;
 522                 else if (err == 0)
 523                         return offset;
 524         }
 525
 526         return offset; /* error from fdt_next_node() */
 527 }