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