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