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;
 149                 int aliasoffset = fdt_path_offset(fdt, "/aliases");
 150
 151                 if (aliasoffset < 0)
 152                         return -FDT_ERR_BADPATH;
 153
 154                 q = strchr(path, '/');
 155                 if (!q)
 156                         q = end;
 157
 158                 p = fdt_getprop_namelen(fdt, aliasoffset, path, q - p, NULL);
 159                 if (!p)
 160                         return -FDT_ERR_BADPATH;
 161                 offset = fdt_path_offset(fdt, p);
 162
 163                 p = q;
 164         }
 165
 166         while (*p) {
 167                 const char *q;
 168
 169                 while (*p == '/')
 170                         p++;
 171                 if (! *p)
 172                         return offset;
 173                 q = strchr(p, '/');
 174                 if (! q)
 175                         q = end;
 176
 177                 offset = fdt_subnode_offset_namelen(fdt, offset, p, q-p);
 178                 if (offset < 0)
 179                         return offset;
 180
 181                 p = q;
 182         }
 183
 184         return offset;
 185 }
 186
 187 const char *fdt_get_name(const void *fdt, int nodeoffset, int *len)
 188 {
 189         const struct fdt_node_header *nh = _fdt_offset_ptr(fdt, nodeoffset);
 190         int err;
 191
 192         if (((err = fdt_check_header(fdt)) != 0)
 193             || ((err = _fdt_check_node_offset(fdt, nodeoffset)) < 0))
 194                         goto fail;
 195
 196         if (len)
 197                 *len = strlen(nh->name);
 198
 199         return nh->name;
 200
 201  fail:
 202         if (len)
 203                 *len = err;
 204         return NULL;
 205 }
 206
 207 const struct fdt_property *fdt_get_property_namelen(const void *fdt,
 208                                                     int nodeoffset,
 209                                                     const char *name,
 210                                                     int namelen, int *lenp)
 211 {
 212         uint32_t tag;
 213         const struct fdt_property *prop;
 214         int namestroff;
 215         int offset, nextoffset;
 216         int err;
 217
 218         if (((err = fdt_check_header(fdt)) != 0)
 219             || ((err = _fdt_check_node_offset(fdt, nodeoffset)) < 0))
 220                         goto fail;
 221
 222         nextoffset = err;
 223         do {
 224                 offset = nextoffset;
 225
 226                 tag = fdt_next_tag(fdt, offset, &nextoffset);
 227                 switch (tag) {
 228                 case FDT_END:
 229                         err = -FDT_ERR_TRUNCATED;
 230                         goto fail;
 231
 232                 case FDT_BEGIN_NODE:
 233                 case FDT_END_NODE:
 234                 case FDT_NOP:
 235                         break;
 236
 237                 case FDT_PROP:
 238                         err = -FDT_ERR_BADSTRUCTURE;
 239                         prop = fdt_offset_ptr(fdt, offset, sizeof(*prop));
 240                         if (! prop)
 241                                 goto fail;
 242                         namestroff = fdt32_to_cpu(prop->nameoff);
 243                         if (_fdt_string_eq(fdt, namestroff, name, namelen)) {
 244                                 /* Found it! */
 245                                 int len = fdt32_to_cpu(prop->len);
 246                                 prop = fdt_offset_ptr(fdt, offset,
 247                                                       sizeof(*prop)+len);
 248                                 if (! prop)
 249                                         goto fail;
 250
 251                                 if (lenp)
 252                                         *lenp = len;
 253
 254                                 return prop;
 255                         }
 256                         break;
 257
 258                 default:
 259                         err = -FDT_ERR_BADSTRUCTURE;
 260                         goto fail;
 261                 }
 262         } while ((tag != FDT_BEGIN_NODE) && (tag != FDT_END_NODE));
 263
 264         err = -FDT_ERR_NOTFOUND;
 265  fail:
 266         if (lenp)
 267                 *lenp = err;
 268         return NULL;
 269 }
 270
 271 const struct fdt_property *fdt_get_property(const void *fdt,
 272                                             int nodeoffset,
 273                                             const char *name, int *lenp)
 274 {
 275         return fdt_get_property_namelen(fdt, nodeoffset, name,
 276                                         strlen(name), lenp);
 277 }
 278
 279 const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
 280                                 const char *name, int namelen, int *lenp)
 281 {
 282         const struct fdt_property *prop;
 283
 284         prop = fdt_get_property_namelen(fdt, nodeoffset, name, namelen, lenp);
 285         if (! prop)
 286                 return NULL;
 287
 288         return prop->data;
 289 }
 290
 291 const void *fdt_getprop(const void *fdt, int nodeoffset,
 292                         const char *name, int *lenp)
 293 {
 294         return fdt_getprop_namelen(fdt, nodeoffset, name, strlen(name), lenp);
 295 }
 296
 297 uint32_t fdt_get_phandle(const void *fdt, int nodeoffset)
 298 {
 299         const uint32_t *php;
 300         int len;
 301
 302         php = fdt_getprop(fdt, nodeoffset, "linux,phandle", &len);
 303         if (!php || (len != sizeof(*php)))
 304                 return 0;
 305
 306         return fdt32_to_cpu(*php);
 307 }
 308
 309 int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen)
 310 {
 311         int pdepth = 0, p = 0;
 312         int offset, depth, namelen;
 313         const char *name;
 314
 315         FDT_CHECK_HEADER(fdt);
 316
 317         if (buflen < 2)
 318                 return -FDT_ERR_NOSPACE;
 319
 320         for (offset = 0, depth = 0;
 321              (offset >= 0) && (offset <= nodeoffset);
 322              offset = fdt_next_node(fdt, offset, &depth)) {
 323                 if (pdepth < depth)
 324                         continue; /* overflowed buffer */
 325
 326                 while (pdepth > depth) {
 327                         do {
 328                                 p--;
 329                         } while (buf[p-1] != '/');
 330                         pdepth--;
 331                 }
 332
 333                 name = fdt_get_name(fdt, offset, &namelen);
 334                 if (!name)
 335                         return namelen;
 336                 if ((p + namelen + 1) <= buflen) {
 337                         memcpy(buf + p, name, namelen);
 338                         p += namelen;
 339                         buf[p++] = '/';
 340                         pdepth++;
 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 p;
 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         if ((phandle == 0) || (phandle == -1))
 449                 return -FDT_ERR_BADPHANDLE;
 450         phandle = cpu_to_fdt32(phandle);
 451         return fdt_node_offset_by_prop_value(fdt, -1, "linux,phandle",
 452                                              &phandle, sizeof(phandle));
 453 }
 454
 455 static int _fdt_stringlist_contains(const char *strlist, int listlen,
 456                                     const char *str)
 457 {
 458         int len = strlen(str);
 459         const char *p;
 460
 461         while (listlen >= len) {
 462                 if (memcmp(str, strlist, len+1) == 0)
 463                         return 1;
 464                 p = memchr(strlist, '\0', listlen);
 465                 if (!p)
 466                         return 0; /* malformed strlist.. */
 467                 listlen -= (p-strlist) + 1;
 468                 strlist = p + 1;
 469         }
 470         return 0;
 471 }
 472
 473 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
 474                               const char *compatible)
 475 {
 476         const void *prop;
 477         int len;
 478
 479         prop = fdt_getprop(fdt, nodeoffset, "compatible", &len);
 480         if (!prop)
 481                 return len;
 482         if (_fdt_stringlist_contains(prop, len, compatible))
 483                 return 0;
 484         else
 485                 return 1;
 486 }
 487
 488 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
 489                                   const char *compatible)
 490 {
 491         int offset, err;
 492
 493         FDT_CHECK_HEADER(fdt);
 494
 495         /* FIXME: The algorithm here is pretty horrible: we scan each
 496          * property of a node in fdt_node_check_compatible(), then if
 497          * that didn't find what we want, we scan over them again
 498          * making our way to the next node.  Still it's the easiest to
 499          * implement approach; performance can come later. */
 500         for (offset = fdt_next_node(fdt, startoffset, NULL);
 501              offset >= 0;
 502              offset = fdt_next_node(fdt, offset, NULL)) {
 503                 err = fdt_node_check_compatible(fdt, offset, compatible);
 504                 if ((err < 0) && (err != -FDT_ERR_NOTFOUND))
 505                         return err;
 506                 else if (err == 0)
 507                         return offset;
 508         }
 509
 510         return offset; /* error from fdt_next_node() */
 511 }