]> git.sur5r.net Git - u-boot/blob - libfdt/fdt_ro.c
libfdt: Fix bugs in fdt_get_path()
[u-boot] / 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                 while (pdepth > depth) {
324                         do {
325                                 p--;
326                         } while (buf[p-1] != '/');
327                         pdepth--;
328                 }
329
330                 if (pdepth >= depth) {
331                         name = fdt_get_name(fdt, offset, &namelen);
332                         if (!name)
333                                 return namelen;
334                         if ((p + namelen + 1) <= buflen) {
335                                 memcpy(buf + p, name, namelen);
336                                 p += namelen;
337                                 buf[p++] = '/';
338                                 pdepth++;
339                         }
340                 }
341
342                 if (offset == nodeoffset) {
343                         if (pdepth < (depth + 1))
344                                 return -FDT_ERR_NOSPACE;
345
346                         if (p > 1) /* special case so that root path is "/", not "" */
347                                 p--;
348                         buf[p] = '\0';
349                         return 0;
350                 }
351         }
352
353         if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
354                 return -FDT_ERR_BADOFFSET;
355         else if (offset == -FDT_ERR_BADOFFSET)
356                 return -FDT_ERR_BADSTRUCTURE;
357
358         return offset; /* error from fdt_next_node() */
359 }
360
361 int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
362                                  int supernodedepth, int *nodedepth)
363 {
364         int offset, depth;
365         int supernodeoffset = -FDT_ERR_INTERNAL;
366
367         FDT_CHECK_HEADER(fdt);
368
369         if (supernodedepth < 0)
370                 return -FDT_ERR_NOTFOUND;
371
372         for (offset = 0, depth = 0;
373              (offset >= 0) && (offset <= nodeoffset);
374              offset = fdt_next_node(fdt, offset, &depth)) {
375                 if (depth == supernodedepth)
376                         supernodeoffset = offset;
377
378                 if (offset == nodeoffset) {
379                         if (nodedepth)
380                                 *nodedepth = depth;
381
382                         if (supernodedepth > depth)
383                                 return -FDT_ERR_NOTFOUND;
384                         else
385                                 return supernodeoffset;
386                 }
387         }
388
389         if ((offset == -FDT_ERR_NOTFOUND) || (offset >= 0))
390                 return -FDT_ERR_BADOFFSET;
391         else if (offset == -FDT_ERR_BADOFFSET)
392                 return -FDT_ERR_BADSTRUCTURE;
393
394         return offset; /* error from fdt_next_node() */
395 }
396
397 int fdt_node_depth(const void *fdt, int nodeoffset)
398 {
399         int nodedepth;
400         int err;
401
402         err = fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, &nodedepth);
403         if (err)
404                 return (err < 0) ? err : -FDT_ERR_INTERNAL;
405         return nodedepth;
406 }
407
408 int fdt_parent_offset(const void *fdt, int nodeoffset)
409 {
410         int nodedepth = fdt_node_depth(fdt, nodeoffset);
411
412         if (nodedepth < 0)
413                 return nodedepth;
414         return fdt_supernode_atdepth_offset(fdt, nodeoffset,
415                                             nodedepth - 1, NULL);
416 }
417
418 int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
419                                   const char *propname,
420                                   const void *propval, int proplen)
421 {
422         int offset;
423         const void *val;
424         int len;
425
426         FDT_CHECK_HEADER(fdt);
427
428         /* FIXME: The algorithm here is pretty horrible: we scan each
429          * property of a node in fdt_getprop(), then if that didn't
430          * find what we want, we scan over them again making our way
431          * to the next node.  Still it's the easiest to implement
432          * approach; performance can come later. */
433         for (offset = fdt_next_node(fdt, startoffset, NULL);
434              offset >= 0;
435              offset = fdt_next_node(fdt, offset, NULL)) {
436                 val = fdt_getprop(fdt, offset, propname, &len);
437                 if (val && (len == proplen)
438                     && (memcmp(val, propval, len) == 0))
439                         return offset;
440         }
441
442         return offset; /* error from fdt_next_node() */
443 }
444
445 int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle)
446 {
447         if ((phandle == 0) || (phandle == -1))
448                 return -FDT_ERR_BADPHANDLE;
449         phandle = cpu_to_fdt32(phandle);
450         return fdt_node_offset_by_prop_value(fdt, -1, "linux,phandle",
451                                              &phandle, sizeof(phandle));
452 }
453
454 static int _fdt_stringlist_contains(const char *strlist, int listlen,
455                                     const char *str)
456 {
457         int len = strlen(str);
458         const char *p;
459
460         while (listlen >= len) {
461                 if (memcmp(str, strlist, len+1) == 0)
462                         return 1;
463                 p = memchr(strlist, '\0', listlen);
464                 if (!p)
465                         return 0; /* malformed strlist.. */
466                 listlen -= (p-strlist) + 1;
467                 strlist = p + 1;
468         }
469         return 0;
470 }
471
472 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
473                               const char *compatible)
474 {
475         const void *prop;
476         int len;
477
478         prop = fdt_getprop(fdt, nodeoffset, "compatible", &len);
479         if (!prop)
480                 return len;
481         if (_fdt_stringlist_contains(prop, len, compatible))
482                 return 0;
483         else
484                 return 1;
485 }
486
487 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
488                                   const char *compatible)
489 {
490         int offset, err;
491
492         FDT_CHECK_HEADER(fdt);
493
494         /* FIXME: The algorithm here is pretty horrible: we scan each
495          * property of a node in fdt_node_check_compatible(), then if
496          * that didn't find what we want, we scan over them again
497          * making our way to the next node.  Still it's the easiest to
498          * implement approach; performance can come later. */
499         for (offset = fdt_next_node(fdt, startoffset, NULL);
500              offset >= 0;
501              offset = fdt_next_node(fdt, offset, NULL)) {
502                 err = fdt_node_check_compatible(fdt, offset, compatible);
503                 if ((err < 0) && (err != -FDT_ERR_NOTFOUND))
504                         return err;
505                 else if (err == 0)
506                         return offset;
507         }
508
509         return offset; /* error from fdt_next_node() */
510 }