2 * libfdt - Flat Device Tree manipulation
3 * Copyright (C) 2006 David Gibson, IBM Corporation.
5 * libfdt is dual licensed: you can use it either under the terms of
6 * the GPL, or the BSD license, at your option.
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.
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.
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,
25 * b) Redistribution and use in source and binary forms, with or
26 * without modification, are permitted provided that the following
29 * 1. Redistributions of source code must retain the above
30 * copyright notice, this list of conditions and the following
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.
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.
51 #include "libfdt_env.h"
56 #include "libfdt_internal.h"
58 static int fdt_nodename_eq_(const void *fdt, int offset,
59 const char *s, int len)
62 const char *p = fdt_get_name(fdt, offset, &olen);
68 if (memcmp(p, s, len) != 0)
73 else if (!memchr(s, '@', len) && (p[len] == '@'))
79 const char *fdt_string(const void *fdt, int stroffset)
81 return (const char *)fdt + fdt_off_dt_strings(fdt) + stroffset;
84 static int fdt_string_eq_(const void *fdt, int stroffset,
85 const char *s, int len)
87 const char *p = fdt_string(fdt, stroffset);
89 return (strlen(p) == len) && (memcmp(p, s, len) == 0);
92 uint32_t fdt_get_max_phandle(const void *fdt)
94 uint32_t max_phandle = 0;
97 for (offset = fdt_next_node(fdt, -1, NULL);;
98 offset = fdt_next_node(fdt, offset, NULL)) {
101 if (offset == -FDT_ERR_NOTFOUND)
107 phandle = fdt_get_phandle(fdt, offset);
108 if (phandle == (uint32_t)-1)
111 if (phandle > max_phandle)
112 max_phandle = phandle;
118 int fdt_get_mem_rsv(const void *fdt, int n, uint64_t *address, uint64_t *size)
120 FDT_CHECK_HEADER(fdt);
121 *address = fdt64_to_cpu(fdt_mem_rsv_(fdt, n)->address);
122 *size = fdt64_to_cpu(fdt_mem_rsv_(fdt, n)->size);
126 int fdt_num_mem_rsv(const void *fdt)
130 while (fdt64_to_cpu(fdt_mem_rsv_(fdt, i)->size) != 0)
135 static int nextprop_(const void *fdt, int offset)
141 tag = fdt_next_tag(fdt, offset, &nextoffset);
146 return -FDT_ERR_BADSTRUCTURE;
154 } while (tag == FDT_NOP);
156 return -FDT_ERR_NOTFOUND;
159 int fdt_subnode_offset_namelen(const void *fdt, int offset,
160 const char *name, int namelen)
164 FDT_CHECK_HEADER(fdt);
167 (offset >= 0) && (depth >= 0);
168 offset = fdt_next_node(fdt, offset, &depth))
170 && fdt_nodename_eq_(fdt, offset, name, namelen))
174 return -FDT_ERR_NOTFOUND;
175 return offset; /* error */
178 int fdt_subnode_offset(const void *fdt, int parentoffset,
181 return fdt_subnode_offset_namelen(fdt, parentoffset, name, strlen(name));
184 int fdt_path_offset_namelen(const void *fdt, const char *path, int namelen)
186 const char *end = path + namelen;
187 const char *p = path;
190 FDT_CHECK_HEADER(fdt);
192 /* see if we have an alias */
194 const char *q = memchr(path, '/', end - p);
199 p = fdt_get_alias_namelen(fdt, p, q - p);
201 return -FDT_ERR_BADPATH;
202 offset = fdt_path_offset(fdt, p);
215 q = memchr(p, '/', end - p);
219 offset = fdt_subnode_offset_namelen(fdt, offset, p, q-p);
229 int fdt_path_offset(const void *fdt, const char *path)
231 return fdt_path_offset_namelen(fdt, path, strlen(path));
234 const char *fdt_get_name(const void *fdt, int nodeoffset, int *len)
236 const struct fdt_node_header *nh = fdt_offset_ptr_(fdt, nodeoffset);
240 if (((err = fdt_check_header(fdt)) != 0)
241 || ((err = fdt_check_node_offset_(fdt, nodeoffset)) < 0))
246 if (fdt_version(fdt) < 0x10) {
248 * For old FDT versions, match the naming conventions of V16:
249 * give only the leaf name (after all /). The actual tree
250 * contents are loosely checked.
253 leaf = strrchr(nameptr, '/');
255 err = -FDT_ERR_BADSTRUCTURE;
262 *len = strlen(nameptr);
272 int fdt_first_property_offset(const void *fdt, int nodeoffset)
276 if ((offset = fdt_check_node_offset_(fdt, nodeoffset)) < 0)
279 return nextprop_(fdt, offset);
282 int fdt_next_property_offset(const void *fdt, int offset)
284 if ((offset = fdt_check_prop_offset_(fdt, offset)) < 0)
287 return nextprop_(fdt, offset);
290 static const struct fdt_property *fdt_get_property_by_offset_(const void *fdt,
295 const struct fdt_property *prop;
297 if ((err = fdt_check_prop_offset_(fdt, offset)) < 0) {
303 prop = fdt_offset_ptr_(fdt, offset);
306 *lenp = fdt32_to_cpu(prop->len);
311 const struct fdt_property *fdt_get_property_by_offset(const void *fdt,
315 /* Prior to version 16, properties may need realignment
316 * and this API does not work. fdt_getprop_*() will, however. */
318 if (fdt_version(fdt) < 0x10) {
320 *lenp = -FDT_ERR_BADVERSION;
324 return fdt_get_property_by_offset_(fdt, offset, lenp);
327 static const struct fdt_property *fdt_get_property_namelen_(const void *fdt,
334 for (offset = fdt_first_property_offset(fdt, offset);
336 (offset = fdt_next_property_offset(fdt, offset))) {
337 const struct fdt_property *prop;
339 if (!(prop = fdt_get_property_by_offset_(fdt, offset, lenp))) {
340 offset = -FDT_ERR_INTERNAL;
343 if (fdt_string_eq_(fdt, fdt32_to_cpu(prop->nameoff),
357 const struct fdt_property *fdt_get_property_namelen(const void *fdt,
360 int namelen, int *lenp)
362 /* Prior to version 16, properties may need realignment
363 * and this API does not work. fdt_getprop_*() will, however. */
364 if (fdt_version(fdt) < 0x10) {
366 *lenp = -FDT_ERR_BADVERSION;
370 return fdt_get_property_namelen_(fdt, offset, name, namelen, lenp,
375 const struct fdt_property *fdt_get_property(const void *fdt,
377 const char *name, int *lenp)
379 return fdt_get_property_namelen(fdt, nodeoffset, name,
383 const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
384 const char *name, int namelen, int *lenp)
387 const struct fdt_property *prop;
389 prop = fdt_get_property_namelen_(fdt, nodeoffset, name, namelen, lenp,
394 /* Handle realignment */
395 if (fdt_version(fdt) < 0x10 && (poffset + sizeof(*prop)) % 8 &&
396 fdt32_to_cpu(prop->len) >= 8)
397 return prop->data + 4;
401 const void *fdt_getprop_by_offset(const void *fdt, int offset,
402 const char **namep, int *lenp)
404 const struct fdt_property *prop;
406 prop = fdt_get_property_by_offset_(fdt, offset, lenp);
410 *namep = fdt_string(fdt, fdt32_to_cpu(prop->nameoff));
412 /* Handle realignment */
413 if (fdt_version(fdt) < 0x10 && (offset + sizeof(*prop)) % 8 &&
414 fdt32_to_cpu(prop->len) >= 8)
415 return prop->data + 4;
419 const void *fdt_getprop(const void *fdt, int nodeoffset,
420 const char *name, int *lenp)
422 return fdt_getprop_namelen(fdt, nodeoffset, name, strlen(name), lenp);
425 uint32_t fdt_get_phandle(const void *fdt, int nodeoffset)
430 /* FIXME: This is a bit sub-optimal, since we potentially scan
431 * over all the properties twice. */
432 php = fdt_getprop(fdt, nodeoffset, "phandle", &len);
433 if (!php || (len != sizeof(*php))) {
434 php = fdt_getprop(fdt, nodeoffset, "linux,phandle", &len);
435 if (!php || (len != sizeof(*php)))
439 return fdt32_to_cpu(*php);
442 const char *fdt_get_alias_namelen(const void *fdt,
443 const char *name, int namelen)
447 aliasoffset = fdt_path_offset(fdt, "/aliases");
451 return fdt_getprop_namelen(fdt, aliasoffset, name, namelen, NULL);
454 const char *fdt_get_alias(const void *fdt, const char *name)
456 return fdt_get_alias_namelen(fdt, name, strlen(name));
459 int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen)
461 int pdepth = 0, p = 0;
462 int offset, depth, namelen;
465 FDT_CHECK_HEADER(fdt);
468 return -FDT_ERR_NOSPACE;
470 for (offset = 0, depth = 0;
471 (offset >= 0) && (offset <= nodeoffset);
472 offset = fdt_next_node(fdt, offset, &depth)) {
473 while (pdepth > depth) {
476 } while (buf[p-1] != '/');
480 if (pdepth >= depth) {
481 name = fdt_get_name(fdt, offset, &namelen);
484 if ((p + namelen + 1) <= buflen) {
485 memcpy(buf + p, name, namelen);
492 if (offset == nodeoffset) {
493 if (pdepth < (depth + 1))
494 return -FDT_ERR_NOSPACE;
496 if (p > 1) /* special case so that root path is "/", not "" */
503 if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
504 return -FDT_ERR_BADOFFSET;
505 else if (offset == -FDT_ERR_BADOFFSET)
506 return -FDT_ERR_BADSTRUCTURE;
508 return offset; /* error from fdt_next_node() */
511 int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
512 int supernodedepth, int *nodedepth)
515 int supernodeoffset = -FDT_ERR_INTERNAL;
517 FDT_CHECK_HEADER(fdt);
519 if (supernodedepth < 0)
520 return -FDT_ERR_NOTFOUND;
522 for (offset = 0, depth = 0;
523 (offset >= 0) && (offset <= nodeoffset);
524 offset = fdt_next_node(fdt, offset, &depth)) {
525 if (depth == supernodedepth)
526 supernodeoffset = offset;
528 if (offset == nodeoffset) {
532 if (supernodedepth > depth)
533 return -FDT_ERR_NOTFOUND;
535 return supernodeoffset;
539 if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
540 return -FDT_ERR_BADOFFSET;
541 else if (offset == -FDT_ERR_BADOFFSET)
542 return -FDT_ERR_BADSTRUCTURE;
544 return offset; /* error from fdt_next_node() */
547 int fdt_node_depth(const void *fdt, int nodeoffset)
552 err = fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, &nodedepth);
554 return (err < 0) ? err : -FDT_ERR_INTERNAL;
558 int fdt_parent_offset(const void *fdt, int nodeoffset)
560 int nodedepth = fdt_node_depth(fdt, nodeoffset);
564 return fdt_supernode_atdepth_offset(fdt, nodeoffset,
565 nodedepth - 1, NULL);
568 int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
569 const char *propname,
570 const void *propval, int proplen)
576 FDT_CHECK_HEADER(fdt);
578 /* FIXME: The algorithm here is pretty horrible: we scan each
579 * property of a node in fdt_getprop(), then if that didn't
580 * find what we want, we scan over them again making our way
581 * to the next node. Still it's the easiest to implement
582 * approach; performance can come later. */
583 for (offset = fdt_next_node(fdt, startoffset, NULL);
585 offset = fdt_next_node(fdt, offset, NULL)) {
586 val = fdt_getprop(fdt, offset, propname, &len);
587 if (val && (len == proplen)
588 && (memcmp(val, propval, len) == 0))
592 return offset; /* error from fdt_next_node() */
595 int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle)
599 if ((phandle == 0) || (phandle == -1))
600 return -FDT_ERR_BADPHANDLE;
602 FDT_CHECK_HEADER(fdt);
604 /* FIXME: The algorithm here is pretty horrible: we
605 * potentially scan each property of a node in
606 * fdt_get_phandle(), then if that didn't find what
607 * we want, we scan over them again making our way to the next
608 * node. Still it's the easiest to implement approach;
609 * performance can come later. */
610 for (offset = fdt_next_node(fdt, -1, NULL);
612 offset = fdt_next_node(fdt, offset, NULL)) {
613 if (fdt_get_phandle(fdt, offset) == phandle)
617 return offset; /* error from fdt_next_node() */
620 int fdt_stringlist_contains(const char *strlist, int listlen, const char *str)
622 int len = strlen(str);
625 while (listlen >= len) {
626 if (memcmp(str, strlist, len+1) == 0)
628 p = memchr(strlist, '\0', listlen);
630 return 0; /* malformed strlist.. */
631 listlen -= (p-strlist) + 1;
637 int fdt_stringlist_count(const void *fdt, int nodeoffset, const char *property)
639 const char *list, *end;
640 int length, count = 0;
642 list = fdt_getprop(fdt, nodeoffset, property, &length);
649 length = strnlen(list, end - list) + 1;
651 /* Abort if the last string isn't properly NUL-terminated. */
652 if (list + length > end)
653 return -FDT_ERR_BADVALUE;
662 int fdt_stringlist_search(const void *fdt, int nodeoffset, const char *property,
665 int length, len, idx = 0;
666 const char *list, *end;
668 list = fdt_getprop(fdt, nodeoffset, property, &length);
672 len = strlen(string) + 1;
676 length = strnlen(list, end - list) + 1;
678 /* Abort if the last string isn't properly NUL-terminated. */
679 if (list + length > end)
680 return -FDT_ERR_BADVALUE;
682 if (length == len && memcmp(list, string, length) == 0)
689 return -FDT_ERR_NOTFOUND;
692 const char *fdt_stringlist_get(const void *fdt, int nodeoffset,
693 const char *property, int idx,
696 const char *list, *end;
699 list = fdt_getprop(fdt, nodeoffset, property, &length);
710 length = strnlen(list, end - list) + 1;
712 /* Abort if the last string isn't properly NUL-terminated. */
713 if (list + length > end) {
715 *lenp = -FDT_ERR_BADVALUE;
732 *lenp = -FDT_ERR_NOTFOUND;
737 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
738 const char *compatible)
743 prop = fdt_getprop(fdt, nodeoffset, "compatible", &len);
747 return !fdt_stringlist_contains(prop, len, compatible);
750 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
751 const char *compatible)
755 FDT_CHECK_HEADER(fdt);
757 /* FIXME: The algorithm here is pretty horrible: we scan each
758 * property of a node in fdt_node_check_compatible(), then if
759 * that didn't find what we want, we scan over them again
760 * making our way to the next node. Still it's the easiest to
761 * implement approach; performance can come later. */
762 for (offset = fdt_next_node(fdt, startoffset, NULL);
764 offset = fdt_next_node(fdt, offset, NULL)) {
765 err = fdt_node_check_compatible(fdt, offset, compatible);
766 if ((err < 0) && (err != -FDT_ERR_NOTFOUND))
772 return offset; /* error from fdt_next_node() */