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;
 121              offset = fdt_next_node(fdt, offset, &depth)) {
 122                 if (depth < 0)
 123                         return -FDT_ERR_NOTFOUND;
 124                 else if ((depth == 1)
 125                          && _fdt_nodename_eq(fdt, offset, name, namelen))
 126                         return offset;
 127         }
 128
 129         return offset; /* error */
 130 }
 131
 132 int fdt_subnode_offset(const void *fdt, int parentoffset,
 133                        const char *name)
 134 {
 135         return fdt_subnode_offset_namelen(fdt, parentoffset, name, strlen(name));
 136 }
 137
 138 int fdt_path_offset(const void *fdt, const char *path)
 139 {
 140         const char *end = path + strlen(path);
 141         const char *p = path;
 142         int offset = 0;
 143
 144         FDT_CHECK_HEADER(fdt);
 145
 146         /* see if we have an alias */
 147         if (*path != '/') {
 148                 const char *q = strchr(path, '/');
 149
 150                 if (!q)
 151                         q = end;
 152
 153                 p = fdt_get_alias_namelen(fdt, p, q - p);
 154                 if (!p)
 155                         return -FDT_ERR_BADPATH;
 156                 offset = fdt_path_offset(fdt, p);
 157
 158                 p = q;
 159         }
 160
 161         while (*p) {
 162                 const char *q;
 163
 164                 while (*p == '/')
 165                         p++;
 166                 if (! *p)
 167                         return offset;
 168                 q = strchr(p, '/');
 169                 if (! q)
 170                         q = end;
 171
 172                 offset = fdt_subnode_offset_namelen(fdt, offset, p, q-p);
 173                 if (offset < 0)
 174                         return offset;
 175
 176                 p = q;
 177         }
 178
 179         return offset;
 180 }
 181
 182 const char *fdt_get_name(const void *fdt, int nodeoffset, int *len)
 183 {
 184         const struct fdt_node_header *nh = _fdt_offset_ptr(fdt, nodeoffset);
 185         int err;
 186
 187         if (((err = fdt_check_header(fdt)) != 0)
 188             || ((err = _fdt_check_node_offset(fdt, nodeoffset)) < 0))
 189                         goto fail;
 190
 191         if (len)
 192                 *len = strlen(nh->name);
 193
 194         return nh->name;
 195
 196  fail:
 197         if (len)
 198                 *len = err;
 199         return NULL;
 200 }
 201
 202 const struct fdt_property *fdt_get_property_namelen(const void *fdt,
 203                                                     int nodeoffset,
 204                                                     const char *name,
 205                                                     int namelen, int *lenp)
 206 {
 207         uint32_t tag;
 208         const struct fdt_property *prop;
 209         int namestroff;
 210         int offset, nextoffset;
 211         int err;
 212
 213         if (((err = fdt_check_header(fdt)) != 0)
 214             || ((err = _fdt_check_node_offset(fdt, nodeoffset)) < 0))
 215                         goto fail;
 216
 217         nextoffset = err;
 218         do {
 219                 offset = nextoffset;
 220
 221                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 222                 switch (tag) {
 223                 case FDT_END:
 224                         err = -FDT_ERR_TRUNCATED;
 225                         goto fail;
 226
 227                 case FDT_BEGIN_NODE:
 228                 case FDT_END_NODE:
 229                 case FDT_NOP:
 230                         break;
 231
 232                 case FDT_PROP:
 233                         err = -FDT_ERR_BADSTRUCTURE;
 234                         prop = fdt_offset_ptr(fdt, offset, sizeof(*prop));
 235                         if (! prop)
 236                                 goto fail;
 237                         namestroff = fdt32_to_cpu(prop->nameoff);
 238                         if (_fdt_string_eq(fdt, namestroff, name, namelen)) {
 239                                 /* Found it! */
 240                                 int len = fdt32_to_cpu(prop->len);
 241                                 prop = fdt_offset_ptr(fdt, offset,
 242                                                       sizeof(*prop)+len);
 243                                 if (! prop)
 244                                         goto fail;
 245
 246                                 if (lenp)
 247                                         *lenp = len;
 248
 249                                 return prop;
 250                         }
 251                         break;
 252
 253                 default:
 254                         err = -FDT_ERR_BADSTRUCTURE;
 255                         goto fail;
 256                 }
 257         } while ((tag != FDT_BEGIN_NODE) && (tag != FDT_END_NODE));
 258
 259         err = -FDT_ERR_NOTFOUND;
 260  fail:
 261         if (lenp)
 262                 *lenp = err;
 263         return NULL;
 264 }
 265
 266 const struct fdt_property *fdt_get_property(const void *fdt,
 267                                             int nodeoffset,
 268                                             const char *name, int *lenp)
 269 {
 270         return fdt_get_property_namelen(fdt, nodeoffset, name,
 271                                         strlen(name), lenp);
 272 }
 273
 274 const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
 275                                 const char *name, int namelen, int *lenp)
 276 {
 277         const struct fdt_property *prop;
 278
 279         prop = fdt_get_property_namelen(fdt, nodeoffset, name, namelen, lenp);
 280         if (! prop)
 281                 return NULL;
 282
 283         return prop->data;
 284 }
 285
 286 const void *fdt_getprop(const void *fdt, int nodeoffset,
 287                         const char *name, int *lenp)
 288 {
 289         return fdt_getprop_namelen(fdt, nodeoffset, name, strlen(name), lenp);
 290 }
 291
 292 uint32_t fdt_get_phandle(const void *fdt, int nodeoffset)
 293 {
 294         const uint32_t *php;
 295         int len;
 296
 297         php = fdt_getprop(fdt, nodeoffset, "linux,phandle", &len);
 298         if (!php || (len != sizeof(*php)))
 299                 return 0;
 300
 301         return fdt32_to_cpu(*php);
 302 }
 303
 304 const char *fdt_get_alias_namelen(const void *fdt,
 305                                   const char *name, int namelen)
 306 {
 307         int aliasoffset;
 308
 309         aliasoffset = fdt_path_offset(fdt, "/aliases");
 310         if (aliasoffset < 0)
 311                 return NULL;
 312
 313         return fdt_getprop_namelen(fdt, aliasoffset, name, namelen, NULL);
 314 }
 315
 316 const char *fdt_get_alias(const void *fdt, const char *name)
 317 {
 318         return fdt_get_alias_namelen(fdt, name, strlen(name));
 319 }
 320
 321 int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen)
 322 {
 323         int pdepth = 0, p = 0;
 324         int offset, depth, namelen;
 325         const char *name;
 326
 327         FDT_CHECK_HEADER(fdt);
 328
 329         if (buflen < 2)
 330                 return -FDT_ERR_NOSPACE;
 331
 332         for (offset = 0, depth = 0;
 333              (offset >= 0) && (offset <= nodeoffset);
 334              offset = fdt_next_node(fdt, offset, &depth)) {
 335                 while (pdepth > depth) {
 336                         do {
 337                                 p--;
 338                         } while (buf[p-1] != '/');
 339                         pdepth--;
 340                 }
 341
 342                 if (pdepth >= depth) {
 343                         name = fdt_get_name(fdt, offset, &namelen);
 344                         if (!name)
 345                                 return namelen;
 346                         if ((p + namelen + 1) <= buflen) {
 347                                 memcpy(buf + p, name, namelen);
 348                                 p += namelen;
 349                                 buf[p++] = '/';
 350                                 pdepth++;
 351                         }
 352                 }
 353
 354                 if (offset == nodeoffset) {
 355                         if (pdepth < (depth + 1))
 356                                 return -FDT_ERR_NOSPACE;
 357
 358                         if (p > 1) /* special case so that root path is "/", not "" */
 359                                 p--;
 360                         buf[p] = '\0';
 361                         return 0;
 362                 }
 363         }
 364
 365         if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
 366                 return -FDT_ERR_BADOFFSET;
 367         else if (offset == -FDT_ERR_BADOFFSET)
 368                 return -FDT_ERR_BADSTRUCTURE;
 369
 370         return offset; /* error from fdt_next_node() */
 371 }
 372
 373 int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
 374                                  int supernodedepth, int *nodedepth)
 375 {
 376         int offset, depth;
 377         int supernodeoffset = -FDT_ERR_INTERNAL;
 378
 379         FDT_CHECK_HEADER(fdt);
 380
 381         if (supernodedepth < 0)
 382                 return -FDT_ERR_NOTFOUND;
 383
 384         for (offset = 0, depth = 0;
 385              (offset >= 0) && (offset <= nodeoffset);
 386              offset = fdt_next_node(fdt, offset, &depth)) {
 387                 if (depth == supernodedepth)
 388                         supernodeoffset = offset;
 389
 390                 if (offset == nodeoffset) {
 391                         if (nodedepth)
 392                                 *nodedepth = depth;
 393
 394                         if (supernodedepth > depth)
 395                                 return -FDT_ERR_NOTFOUND;
 396                         else
 397                                 return supernodeoffset;
 398                 }
 399         }
 400
 401         if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
 402                 return -FDT_ERR_BADOFFSET;
 403         else if (offset == -FDT_ERR_BADOFFSET)
 404                 return -FDT_ERR_BADSTRUCTURE;
 405
 406         return offset; /* error from fdt_next_node() */
 407 }
 408
 409 int fdt_node_depth(const void *fdt, int nodeoffset)
 410 {
 411         int nodedepth;
 412         int err;
 413
 414         err = fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, &nodedepth);
 415         if (err)
 416                 return (err < 0) ? err : -FDT_ERR_INTERNAL;
 417         return nodedepth;
 418 }
 419
 420 int fdt_parent_offset(const void *fdt, int nodeoffset)
 421 {
 422         int nodedepth = fdt_node_depth(fdt, nodeoffset);
 423
 424         if (nodedepth < 0)
 425                 return nodedepth;
 426         return fdt_supernode_atdepth_offset(fdt, nodeoffset,
 427                                             nodedepth - 1, NULL);
 428 }
 429
 430 int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
 431                                   const char *propname,
 432                                   const void *propval, int proplen)
 433 {
 434         int offset;
 435         const void *val;
 436         int len;
 437
 438         FDT_CHECK_HEADER(fdt);
 439
 440         /* FIXME: The algorithm here is pretty horrible: we scan each
 441          * property of a node in fdt_getprop(), then if that didn't
 442          * find what we want, we scan over them again making our way
 443          * to the next node.  Still it's the easiest to implement
 444          * approach; performance can come later. */
 445         for (offset = fdt_next_node(fdt, startoffset, NULL);
 446              offset >= 0;
 447              offset = fdt_next_node(fdt, offset, NULL)) {
 448                 val = fdt_getprop(fdt, offset, propname, &len);
 449                 if (val && (len == proplen)
 450                     && (memcmp(val, propval, len) == 0))
 451                         return offset;
 452         }
 453
 454         return offset; /* error from fdt_next_node() */
 455 }
 456
 457 int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle)
 458 {
 459         if ((phandle == 0) || (phandle == -1))
 460                 return -FDT_ERR_BADPHANDLE;
 461         phandle = cpu_to_fdt32(phandle);
 462         return fdt_node_offset_by_prop_value(fdt, -1, "linux,phandle",
 463                                              &phandle, sizeof(phandle));
 464 }
 465
 466 static int _fdt_stringlist_contains(const char *strlist, int listlen,
 467                                     const char *str)
 468 {
 469         int len = strlen(str);
 470         const char *p;
 471
 472         while (listlen >= len) {
 473                 if (memcmp(str, strlist, len+1) == 0)
 474                         return 1;
 475                 p = memchr(strlist, '\0', listlen);
 476                 if (!p)
 477                         return 0; /* malformed strlist.. */
 478                 listlen -= (p-strlist) + 1;
 479                 strlist = p + 1;
 480         }
 481         return 0;
 482 }
 483
 484 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
 485                               const char *compatible)
 486 {
 487         const void *prop;
 488         int len;
 489
 490         prop = fdt_getprop(fdt, nodeoffset, "compatible", &len);
 491         if (!prop)
 492                 return len;
 493         if (_fdt_stringlist_contains(prop, len, compatible))
 494                 return 0;
 495         else
 496                 return 1;
 497 }
 498
 499 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
 500                                   const char *compatible)
 501 {
 502         int offset, err;
 503
 504         FDT_CHECK_HEADER(fdt);
 505
 506         /* FIXME: The algorithm here is pretty horrible: we scan each
 507          * property of a node in fdt_node_check_compatible(), then if
 508          * that didn't find what we want, we scan over them again
 509          * making our way to the next node.  Still it's the easiest to
 510          * implement approach; performance can come later. */
 511         for (offset = fdt_next_node(fdt, startoffset, NULL);
 512              offset >= 0;
 513              offset = fdt_next_node(fdt, offset, NULL)) {
 514                 err = fdt_node_check_compatible(fdt, offset, compatible);
 515                 if ((err < 0) && (err != -FDT_ERR_NOTFOUND))
 516                         return err;
 517                 else if (err == 0)
 518                         return offset;
 519         }
 520
 521         return offset; /* error from fdt_next_node() */
 522 }