libfdt: Implement fdt_get_property_namelen() and fdt_getprop_namelen()
[platform/kernel/u-boot.git] / include / libfdt.h
1 #ifndef _LIBFDT_H
2 #define _LIBFDT_H
3 /*
4  * libfdt - Flat Device Tree manipulation
5  * Copyright (C) 2006 David Gibson, IBM Corporation.
6  *
7  * libfdt is dual licensed: you can use it either under the terms of
8  * the GPL, or the BSD license, at your option.
9  *
10  *  a) This library is free software; you can redistribute it and/or
11  *     modify it under the terms of the GNU General Public License as
12  *     published by the Free Software Foundation; either version 2 of the
13  *     License, or (at your option) any later version.
14  *
15  *     This library is distributed in the hope that it will be useful,
16  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *     GNU General Public License for more details.
19  *
20  *     You should have received a copy of the GNU General Public
21  *     License along with this library; if not, write to the Free
22  *     Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
23  *     MA 02110-1301 USA
24  *
25  * Alternatively,
26  *
27  *  b) Redistribution and use in source and binary forms, with or
28  *     without modification, are permitted provided that the following
29  *     conditions are met:
30  *
31  *     1. Redistributions of source code must retain the above
32  *        copyright notice, this list of conditions and the following
33  *        disclaimer.
34  *     2. Redistributions in binary form must reproduce the above
35  *        copyright notice, this list of conditions and the following
36  *        disclaimer in the documentation and/or other materials
37  *        provided with the distribution.
38  *
39  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
40  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
41  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
42  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
44  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
49  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
50  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
51  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52  */
53
54 #include <libfdt_env.h>
55 #include <fdt.h>
56
57 #define FDT_FIRST_SUPPORTED_VERSION     0x10
58 #define FDT_LAST_SUPPORTED_VERSION      0x11
59
60 /* Error codes: informative error codes */
61 #define FDT_ERR_NOTFOUND        1
62         /* FDT_ERR_NOTFOUND: The requested node or property does not exist */
63 #define FDT_ERR_EXISTS          2
64         /* FDT_ERR_EXISTS: Attemped to create a node or property which
65          * already exists */
66 #define FDT_ERR_NOSPACE         3
67         /* FDT_ERR_NOSPACE: Operation needed to expand the device
68          * tree, but its buffer did not have sufficient space to
69          * contain the expanded tree. Use fdt_open_into() to move the
70          * device tree to a buffer with more space. */
71
72 /* Error codes: codes for bad parameters */
73 #define FDT_ERR_BADOFFSET       4
74         /* FDT_ERR_BADOFFSET: Function was passed a structure block
75          * offset which is out-of-bounds, or which points to an
76          * unsuitable part of the structure for the operation. */
77 #define FDT_ERR_BADPATH         5
78         /* FDT_ERR_BADPATH: Function was passed a badly formatted path
79          * (e.g. missing a leading / for a function which requires an
80          * absolute path) */
81 #define FDT_ERR_BADPHANDLE      6
82         /* FDT_ERR_BADPHANDLE: Function was passed an invalid phandle
83          * value.  phandle values of 0 and -1 are not permitted. */
84 #define FDT_ERR_BADSTATE        7
85         /* FDT_ERR_BADSTATE: Function was passed an incomplete device
86          * tree created by the sequential-write functions, which is
87          * not sufficiently complete for the requested operation. */
88
89 /* Error codes: codes for bad device tree blobs */
90 #define FDT_ERR_TRUNCATED       8
91         /* FDT_ERR_TRUNCATED: Structure block of the given device tree
92          * ends without an FDT_END tag. */
93 #define FDT_ERR_BADMAGIC        9
94         /* FDT_ERR_BADMAGIC: Given "device tree" appears not to be a
95          * device tree at all - it is missing the flattened device
96          * tree magic number. */
97 #define FDT_ERR_BADVERSION      10
98         /* FDT_ERR_BADVERSION: Given device tree has a version which
99          * can't be handled by the requested operation.  For
100          * read-write functions, this may mean that fdt_open_into() is
101          * required to convert the tree to the expected version. */
102 #define FDT_ERR_BADSTRUCTURE    11
103         /* FDT_ERR_BADSTRUCTURE: Given device tree has a corrupt
104          * structure block or other serious error (e.g. misnested
105          * nodes, or subnodes preceding properties). */
106 #define FDT_ERR_BADLAYOUT       12
107         /* FDT_ERR_BADLAYOUT: For read-write functions, the given
108          * device tree has it's sub-blocks in an order that the
109          * function can't handle (memory reserve map, then structure,
110          * then strings).  Use fdt_open_into() to reorganize the tree
111          * into a form suitable for the read-write operations. */
112
113 /* "Can't happen" error indicating a bug in libfdt */
114 #define FDT_ERR_INTERNAL        13
115         /* FDT_ERR_INTERNAL: libfdt has failed an internal assertion.
116          * Should never be returned, if it is, it indicates a bug in
117          * libfdt itself. */
118
119 #define FDT_ERR_MAX             13
120
121 /**********************************************************************/
122 /* Low-level functions (you probably don't need these)                */
123 /**********************************************************************/
124
125 const void *fdt_offset_ptr(const void *fdt, int offset, int checklen);
126 static inline void *fdt_offset_ptr_w(void *fdt, int offset, int checklen)
127 {
128         return (void *)(uintptr_t)fdt_offset_ptr(fdt, offset, checklen);
129 }
130
131 uint32_t fdt_next_tag(const void *fdt, int offset, int *nextoffset);
132
133 /**********************************************************************/
134 /* Traversal functions                                                */
135 /**********************************************************************/
136
137 int fdt_next_node(const void *fdt, int offset, int *depth);
138
139 /**********************************************************************/
140 /* General functions                                                  */
141 /**********************************************************************/
142
143 #define fdt_get_header(fdt, field) \
144         (fdt32_to_cpu(((const struct fdt_header *)(fdt))->field))
145 #define fdt_magic(fdt)                  (fdt_get_header(fdt, magic))
146 #define fdt_totalsize(fdt)              (fdt_get_header(fdt, totalsize))
147 #define fdt_off_dt_struct(fdt)          (fdt_get_header(fdt, off_dt_struct))
148 #define fdt_off_dt_strings(fdt)         (fdt_get_header(fdt, off_dt_strings))
149 #define fdt_off_mem_rsvmap(fdt)         (fdt_get_header(fdt, off_mem_rsvmap))
150 #define fdt_version(fdt)                (fdt_get_header(fdt, version))
151 #define fdt_last_comp_version(fdt)      (fdt_get_header(fdt, last_comp_version))
152 #define fdt_boot_cpuid_phys(fdt)        (fdt_get_header(fdt, boot_cpuid_phys))
153 #define fdt_size_dt_strings(fdt)        (fdt_get_header(fdt, size_dt_strings))
154 #define fdt_size_dt_struct(fdt)         (fdt_get_header(fdt, size_dt_struct))
155
156 #define __fdt_set_hdr(name) \
157         static inline void fdt_set_##name(void *fdt, uint32_t val) \
158         { \
159                 struct fdt_header *fdth = fdt; \
160                 fdth->name = cpu_to_fdt32(val); \
161         }
162 __fdt_set_hdr(magic);
163 __fdt_set_hdr(totalsize);
164 __fdt_set_hdr(off_dt_struct);
165 __fdt_set_hdr(off_dt_strings);
166 __fdt_set_hdr(off_mem_rsvmap);
167 __fdt_set_hdr(version);
168 __fdt_set_hdr(last_comp_version);
169 __fdt_set_hdr(boot_cpuid_phys);
170 __fdt_set_hdr(size_dt_strings);
171 __fdt_set_hdr(size_dt_struct);
172 #undef __fdt_set_hdr
173
174 /**
175  * fdt_check_header - sanity check a device tree or possible device tree
176  * @fdt: pointer to data which might be a flattened device tree
177  *
178  * fdt_check_header() checks that the given buffer contains what
179  * appears to be a flattened device tree with sane information in its
180  * header.
181  *
182  * returns:
183  *     0, if the buffer appears to contain a valid device tree
184  *     -FDT_ERR_BADMAGIC,
185  *     -FDT_ERR_BADVERSION,
186  *     -FDT_ERR_BADSTATE, standard meanings, as above
187  */
188 int fdt_check_header(const void *fdt);
189
190 /**
191  * fdt_move - move a device tree around in memory
192  * @fdt: pointer to the device tree to move
193  * @buf: pointer to memory where the device is to be moved
194  * @bufsize: size of the memory space at buf
195  *
196  * fdt_move() relocates, if possible, the device tree blob located at
197  * fdt to the buffer at buf of size bufsize.  The buffer may overlap
198  * with the existing device tree blob at fdt.  Therefore,
199  *     fdt_move(fdt, fdt, fdt_totalsize(fdt))
200  * should always succeed.
201  *
202  * returns:
203  *     0, on success
204  *     -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree
205  *     -FDT_ERR_BADMAGIC,
206  *     -FDT_ERR_BADVERSION,
207  *     -FDT_ERR_BADSTATE, standard meanings
208  */
209 int fdt_move(const void *fdt, void *buf, int bufsize);
210
211 /**********************************************************************/
212 /* Read-only functions                                                */
213 /**********************************************************************/
214
215 /**
216  * fdt_string - retrieve a string from the strings block of a device tree
217  * @fdt: pointer to the device tree blob
218  * @stroffset: offset of the string within the strings block (native endian)
219  *
220  * fdt_string() retrieves a pointer to a single string from the
221  * strings block of the device tree blob at fdt.
222  *
223  * returns:
224  *     a pointer to the string, on success
225  *     NULL, if stroffset is out of bounds
226  */
227 const char *fdt_string(const void *fdt, int stroffset);
228
229 /**
230  * fdt_num_mem_rsv - retrieve the number of memory reserve map entries
231  * @fdt: pointer to the device tree blob
232  *
233  * Returns the number of entries in the device tree blob's memory
234  * reservation map.  This does not include the terminating 0,0 entry
235  * or any other (0,0) entries reserved for expansion.
236  *
237  * returns:
238  *     the number of entries
239  */
240 int fdt_num_mem_rsv(const void *fdt);
241
242 /**
243  * fdt_get_mem_rsv - retrieve one memory reserve map entry
244  * @fdt: pointer to the device tree blob
245  * @address, @size: pointers to 64-bit variables
246  *
247  * On success, *address and *size will contain the address and size of
248  * the n-th reserve map entry from the device tree blob, in
249  * native-endian format.
250  *
251  * returns:
252  *     0, on success
253  *     -FDT_ERR_BADMAGIC,
254  *     -FDT_ERR_BADVERSION,
255  *     -FDT_ERR_BADSTATE, standard meanings
256  */
257 int fdt_get_mem_rsv(const void *fdt, int n, uint64_t *address, uint64_t *size);
258
259 /**
260  * fdt_subnode_offset_namelen - find a subnode based on substring
261  * @fdt: pointer to the device tree blob
262  * @parentoffset: structure block offset of a node
263  * @name: name of the subnode to locate
264  * @namelen: number of characters of name to consider
265  *
266  * Identical to fdt_subnode_offset(), but only examine the first
267  * namelen characters of name for matching the subnode name.  This is
268  * useful for finding subnodes based on a portion of a larger string,
269  * such as a full path.
270  */
271 int fdt_subnode_offset_namelen(const void *fdt, int parentoffset,
272                                const char *name, int namelen);
273 /**
274  * fdt_subnode_offset - find a subnode of a given node
275  * @fdt: pointer to the device tree blob
276  * @parentoffset: structure block offset of a node
277  * @name: name of the subnode to locate
278  *
279  * fdt_subnode_offset() finds a subnode of the node at structure block
280  * offset parentoffset with the given name.  name may include a unit
281  * address, in which case fdt_subnode_offset() will find the subnode
282  * with that unit address, or the unit address may be omitted, in
283  * which case fdt_subnode_offset() will find an arbitrary subnode
284  * whose name excluding unit address matches the given name.
285  *
286  * returns:
287  *      structure block offset of the requested subnode (>=0), on success
288  *      -FDT_ERR_NOTFOUND, if the requested subnode does not exist
289  *      -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag
290  *      -FDT_ERR_BADMAGIC,
291  *      -FDT_ERR_BADVERSION,
292  *      -FDT_ERR_BADSTATE,
293  *      -FDT_ERR_BADSTRUCTURE,
294  *      -FDT_ERR_TRUNCATED, standard meanings.
295  */
296 int fdt_subnode_offset(const void *fdt, int parentoffset, const char *name);
297
298 /**
299  * fdt_path_offset - find a tree node by its full path
300  * @fdt: pointer to the device tree blob
301  * @path: full path of the node to locate
302  *
303  * fdt_path_offset() finds a node of a given path in the device tree.
304  * Each path component may omit the unit address portion, but the
305  * results of this are undefined if any such path component is
306  * ambiguous (that is if there are multiple nodes at the relevant
307  * level matching the given component, differentiated only by unit
308  * address).
309  *
310  * returns:
311  *      structure block offset of the node with the requested path (>=0), on success
312  *      -FDT_ERR_BADPATH, given path does not begin with '/' or is invalid
313  *      -FDT_ERR_NOTFOUND, if the requested node does not exist
314  *      -FDT_ERR_BADMAGIC,
315  *      -FDT_ERR_BADVERSION,
316  *      -FDT_ERR_BADSTATE,
317  *      -FDT_ERR_BADSTRUCTURE,
318  *      -FDT_ERR_TRUNCATED, standard meanings.
319  */
320 int fdt_path_offset(const void *fdt, const char *path);
321
322 /**
323  * fdt_get_name - retrieve the name of a given node
324  * @fdt: pointer to the device tree blob
325  * @nodeoffset: structure block offset of the starting node
326  * @lenp: pointer to an integer variable (will be overwritten) or NULL
327  *
328  * fdt_get_name() retrieves the name (including unit address) of the
329  * device tree node at structure block offset nodeoffset.  If lenp is
330  * non-NULL, the length of this name is also returned, in the integer
331  * pointed to by lenp.
332  *
333  * returns:
334  *      pointer to the node's name, on success
335  *              If lenp is non-NULL, *lenp contains the length of that name (>=0)
336  *      NULL, on error
337  *              if lenp is non-NULL *lenp contains an error code (<0):
338  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
339  *              -FDT_ERR_BADMAGIC,
340  *              -FDT_ERR_BADVERSION,
341  *              -FDT_ERR_BADSTATE, standard meanings
342  */
343 const char *fdt_get_name(const void *fdt, int nodeoffset, int *lenp);
344
345 /**
346  * fdt_get_property_namelen - find a property based on substring
347  * @fdt: pointer to the device tree blob
348  * @nodeoffset: offset of the node whose property to find
349  * @name: name of the property to find
350  * @namelen: number of characters of name to consider
351  * @lenp: pointer to an integer variable (will be overwritten) or NULL
352  *
353  * Identical to fdt_get_property_namelen(), but only examine the first
354  * namelen characters of name for matching the property name.
355  */
356 const struct fdt_property *fdt_get_property_namelen(const void *fdt,
357                                                     int nodeoffset,
358                                                     const char *name,
359                                                     int namelen, int *lenp);
360
361 /**
362  * fdt_get_property - find a given property in a given node
363  * @fdt: pointer to the device tree blob
364  * @nodeoffset: offset of the node whose property to find
365  * @name: name of the property to find
366  * @lenp: pointer to an integer variable (will be overwritten) or NULL
367  *
368  * fdt_get_property() retrieves a pointer to the fdt_property
369  * structure within the device tree blob corresponding to the property
370  * named 'name' of the node at offset nodeoffset.  If lenp is
371  * non-NULL, the length of the property value is also returned, in the
372  * integer pointed to by lenp.
373  *
374  * returns:
375  *      pointer to the structure representing the property
376  *              if lenp is non-NULL, *lenp contains the length of the property
377  *              value (>=0)
378  *      NULL, on error
379  *              if lenp is non-NULL, *lenp contains an error code (<0):
380  *              -FDT_ERR_NOTFOUND, node does not have named property
381  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
382  *              -FDT_ERR_BADMAGIC,
383  *              -FDT_ERR_BADVERSION,
384  *              -FDT_ERR_BADSTATE,
385  *              -FDT_ERR_BADSTRUCTURE,
386  *              -FDT_ERR_TRUNCATED, standard meanings
387  */
388 const struct fdt_property *fdt_get_property(const void *fdt, int nodeoffset,
389                                             const char *name, int *lenp);
390 static inline struct fdt_property *fdt_get_property_w(void *fdt, int nodeoffset,
391                                                       const char *name,
392                                                       int *lenp)
393 {
394         return (struct fdt_property *)(uintptr_t)
395                 fdt_get_property(fdt, nodeoffset, name, lenp);
396 }
397
398 /**
399  * fdt_getprop_namelen - get property value based on substring
400  * @fdt: pointer to the device tree blob
401  * @nodeoffset: offset of the node whose property to find
402  * @name: name of the property to find
403  * @namelen: number of characters of name to consider
404  * @lenp: pointer to an integer variable (will be overwritten) or NULL
405  *
406  * Identical to fdt_getprop(), but only examine the first namelen
407  * characters of name for matching the property name.
408  */
409 const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
410                                 const char *name, int namelen, int *lenp);
411
412 /**
413  * fdt_getprop - retrieve the value of a given property
414  * @fdt: pointer to the device tree blob
415  * @nodeoffset: offset of the node whose property to find
416  * @name: name of the property to find
417  * @lenp: pointer to an integer variable (will be overwritten) or NULL
418  *
419  * fdt_getprop() retrieves a pointer to the value of the property
420  * named 'name' of the node at offset nodeoffset (this will be a
421  * pointer to within the device blob itself, not a copy of the value).
422  * If lenp is non-NULL, the length of the property value is also
423  * returned, in the integer pointed to by lenp.
424  *
425  * returns:
426  *      pointer to the property's value
427  *              if lenp is non-NULL, *lenp contains the length of the property
428  *              value (>=0)
429  *      NULL, on error
430  *              if lenp is non-NULL, *lenp contains an error code (<0):
431  *              -FDT_ERR_NOTFOUND, node does not have named property
432  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
433  *              -FDT_ERR_BADMAGIC,
434  *              -FDT_ERR_BADVERSION,
435  *              -FDT_ERR_BADSTATE,
436  *              -FDT_ERR_BADSTRUCTURE,
437  *              -FDT_ERR_TRUNCATED, standard meanings
438  */
439 const void *fdt_getprop(const void *fdt, int nodeoffset,
440                         const char *name, int *lenp);
441 static inline void *fdt_getprop_w(void *fdt, int nodeoffset,
442                                   const char *name, int *lenp)
443 {
444         return (void *)(uintptr_t)fdt_getprop(fdt, nodeoffset, name, lenp);
445 }
446
447 /**
448  * fdt_get_phandle - retrieve the phandle of a given node
449  * @fdt: pointer to the device tree blob
450  * @nodeoffset: structure block offset of the node
451  *
452  * fdt_get_phandle() retrieves the phandle of the device tree node at
453  * structure block offset nodeoffset.
454  *
455  * returns:
456  *      the phandle of the node at nodeoffset, on success (!= 0, != -1)
457  *      0, if the node has no phandle, or another error occurs
458  */
459 uint32_t fdt_get_phandle(const void *fdt, int nodeoffset);
460
461 /**
462  * fdt_get_path - determine the full path of a node
463  * @fdt: pointer to the device tree blob
464  * @nodeoffset: offset of the node whose path to find
465  * @buf: character buffer to contain the returned path (will be overwritten)
466  * @buflen: size of the character buffer at buf
467  *
468  * fdt_get_path() computes the full path of the node at offset
469  * nodeoffset, and records that path in the buffer at buf.
470  *
471  * NOTE: This function is expensive, as it must scan the device tree
472  * structure from the start to nodeoffset.
473  *
474  * returns:
475  *      0, on success
476  *              buf contains the absolute path of the node at
477  *              nodeoffset, as a NUL-terminated string.
478  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
479  *      -FDT_ERR_NOSPACE, the path of the given node is longer than (bufsize-1)
480  *              characters and will not fit in the given buffer.
481  *      -FDT_ERR_BADMAGIC,
482  *      -FDT_ERR_BADVERSION,
483  *      -FDT_ERR_BADSTATE,
484  *      -FDT_ERR_BADSTRUCTURE, standard meanings
485  */
486 int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen);
487
488 /**
489  * fdt_supernode_atdepth_offset - find a specific ancestor of a node
490  * @fdt: pointer to the device tree blob
491  * @nodeoffset: offset of the node whose parent to find
492  * @supernodedepth: depth of the ancestor to find
493  * @nodedepth: pointer to an integer variable (will be overwritten) or NULL
494  *
495  * fdt_supernode_atdepth_offset() finds an ancestor of the given node
496  * at a specific depth from the root (where the root itself has depth
497  * 0, its immediate subnodes depth 1 and so forth).  So
498  *      fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, NULL);
499  * will always return 0, the offset of the root node.  If the node at
500  * nodeoffset has depth D, then:
501  *      fdt_supernode_atdepth_offset(fdt, nodeoffset, D, NULL);
502  * will return nodeoffset itself.
503  *
504  * NOTE: This function is expensive, as it must scan the device tree
505  * structure from the start to nodeoffset.
506  *
507  * returns:
508
509  *      structure block offset of the node at node offset's ancestor
510  *              of depth supernodedepth (>=0), on success
511  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
512 *       -FDT_ERR_NOTFOUND, supernodedepth was greater than the depth of nodeoffset
513  *      -FDT_ERR_BADMAGIC,
514  *      -FDT_ERR_BADVERSION,
515  *      -FDT_ERR_BADSTATE,
516  *      -FDT_ERR_BADSTRUCTURE, standard meanings
517  */
518 int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
519                                  int supernodedepth, int *nodedepth);
520
521 /**
522  * fdt_node_depth - find the depth of a given node
523  * @fdt: pointer to the device tree blob
524  * @nodeoffset: offset of the node whose parent to find
525  *
526  * fdt_node_depth() finds the depth of a given node.  The root node
527  * has depth 0, its immediate subnodes depth 1 and so forth.
528  *
529  * NOTE: This function is expensive, as it must scan the device tree
530  * structure from the start to nodeoffset.
531  *
532  * returns:
533  *      depth of the node at nodeoffset (>=0), on success
534  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
535  *      -FDT_ERR_BADMAGIC,
536  *      -FDT_ERR_BADVERSION,
537  *      -FDT_ERR_BADSTATE,
538  *      -FDT_ERR_BADSTRUCTURE, standard meanings
539  */
540 int fdt_node_depth(const void *fdt, int nodeoffset);
541
542 /**
543  * fdt_parent_offset - find the parent of a given node
544  * @fdt: pointer to the device tree blob
545  * @nodeoffset: offset of the node whose parent to find
546  *
547  * fdt_parent_offset() locates the parent node of a given node (that
548  * is, it finds the offset of the node which contains the node at
549  * nodeoffset as a subnode).
550  *
551  * NOTE: This function is expensive, as it must scan the device tree
552  * structure from the start to nodeoffset, *twice*.
553  *
554  * returns:
555  *      structure block offset of the parent of the node at nodeoffset
556  *              (>=0), on success
557  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
558  *      -FDT_ERR_BADMAGIC,
559  *      -FDT_ERR_BADVERSION,
560  *      -FDT_ERR_BADSTATE,
561  *      -FDT_ERR_BADSTRUCTURE, standard meanings
562  */
563 int fdt_parent_offset(const void *fdt, int nodeoffset);
564
565 /**
566  * fdt_node_offset_by_prop_value - find nodes with a given property value
567  * @fdt: pointer to the device tree blob
568  * @startoffset: only find nodes after this offset
569  * @propname: property name to check
570  * @propval: property value to search for
571  * @proplen: length of the value in propval
572  *
573  * fdt_node_offset_by_prop_value() returns the offset of the first
574  * node after startoffset, which has a property named propname whose
575  * value is of length proplen and has value equal to propval; or if
576  * startoffset is -1, the very first such node in the tree.
577  *
578  * To iterate through all nodes matching the criterion, the following
579  * idiom can be used:
580  *      offset = fdt_node_offset_by_prop_value(fdt, -1, propname,
581  *                                             propval, proplen);
582  *      while (offset != -FDT_ERR_NOTFOUND) {
583  *              ... other code here ...
584  *              offset = fdt_node_offset_by_prop_value(fdt, offset, propname,
585  *                                                     propval, proplen);
586  *      }
587  *
588  * Note the -1 in the first call to the function, if 0 is used here
589  * instead, the function will never locate the root node, even if it
590  * matches the criterion.
591  *
592  * returns:
593  *      structure block offset of the located node (>= 0, >startoffset),
594  *               on success
595  *      -FDT_ERR_NOTFOUND, no node matching the criterion exists in the
596  *              tree after startoffset
597  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
598  *      -FDT_ERR_BADMAGIC,
599  *      -FDT_ERR_BADVERSION,
600  *      -FDT_ERR_BADSTATE,
601  *      -FDT_ERR_BADSTRUCTURE, standard meanings
602  */
603 int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
604                                   const char *propname,
605                                   const void *propval, int proplen);
606
607 /**
608  * fdt_node_offset_by_phandle - find the node with a given phandle
609  * @fdt: pointer to the device tree blob
610  * @phandle: phandle value
611  *
612  * fdt_node_offset_by_phandle() returns the offset of the node
613  * which has the given phandle value.  If there is more than one node
614  * in the tree with the given phandle (an invalid tree), results are
615  * undefined.
616  *
617  * returns:
618  *      structure block offset of the located node (>= 0), on success
619  *      -FDT_ERR_NOTFOUND, no node with that phandle exists
620  *      -FDT_ERR_BADPHANDLE, given phandle value was invalid (0 or -1)
621  *      -FDT_ERR_BADMAGIC,
622  *      -FDT_ERR_BADVERSION,
623  *      -FDT_ERR_BADSTATE,
624  *      -FDT_ERR_BADSTRUCTURE, standard meanings
625  */
626 int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle);
627
628 /**
629  * fdt_node_check_compatible: check a node's compatible property
630  * @fdt: pointer to the device tree blob
631  * @nodeoffset: offset of a tree node
632  * @compatible: string to match against
633  *
634  *
635  * fdt_node_check_compatible() returns 0 if the given node contains a
636  * 'compatible' property with the given string as one of its elements,
637  * it returns non-zero otherwise, or on error.
638  *
639  * returns:
640  *      0, if the node has a 'compatible' property listing the given string
641  *      1, if the node has a 'compatible' property, but it does not list
642  *              the given string
643  *      -FDT_ERR_NOTFOUND, if the given node has no 'compatible' property
644  *      -FDT_ERR_BADOFFSET, if nodeoffset does not refer to a BEGIN_NODE tag
645  *      -FDT_ERR_BADMAGIC,
646  *      -FDT_ERR_BADVERSION,
647  *      -FDT_ERR_BADSTATE,
648  *      -FDT_ERR_BADSTRUCTURE, standard meanings
649  */
650 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
651                               const char *compatible);
652
653 /**
654  * fdt_node_offset_by_compatible - find nodes with a given 'compatible' value
655  * @fdt: pointer to the device tree blob
656  * @startoffset: only find nodes after this offset
657  * @compatible: 'compatible' string to match against
658  *
659  * fdt_node_offset_by_compatible() returns the offset of the first
660  * node after startoffset, which has a 'compatible' property which
661  * lists the given compatible string; or if startoffset is -1, the
662  * very first such node in the tree.
663  *
664  * To iterate through all nodes matching the criterion, the following
665  * idiom can be used:
666  *      offset = fdt_node_offset_by_compatible(fdt, -1, compatible);
667  *      while (offset != -FDT_ERR_NOTFOUND) {
668  *              ... other code here ...
669  *              offset = fdt_node_offset_by_compatible(fdt, offset, compatible);
670  *      }
671  *
672  * Note the -1 in the first call to the function, if 0 is used here
673  * instead, the function will never locate the root node, even if it
674  * matches the criterion.
675  *
676  * returns:
677  *      structure block offset of the located node (>= 0, >startoffset),
678  *               on success
679  *      -FDT_ERR_NOTFOUND, no node matching the criterion exists in the
680  *              tree after startoffset
681  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
682  *      -FDT_ERR_BADMAGIC,
683  *      -FDT_ERR_BADVERSION,
684  *      -FDT_ERR_BADSTATE,
685  *      -FDT_ERR_BADSTRUCTURE, standard meanings
686  */
687 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
688                                   const char *compatible);
689
690 /**********************************************************************/
691 /* Write-in-place functions                                           */
692 /**********************************************************************/
693
694 /**
695  * fdt_setprop_inplace - change a property's value, but not its size
696  * @fdt: pointer to the device tree blob
697  * @nodeoffset: offset of the node whose property to change
698  * @name: name of the property to change
699  * @val: pointer to data to replace the property value with
700  * @len: length of the property value
701  *
702  * fdt_setprop_inplace() replaces the value of a given property with
703  * the data in val, of length len.  This function cannot change the
704  * size of a property, and so will only work if len is equal to the
705  * current length of the property.
706  *
707  * This function will alter only the bytes in the blob which contain
708  * the given property value, and will not alter or move any other part
709  * of the tree.
710  *
711  * returns:
712  *      0, on success
713  *      -FDT_ERR_NOSPACE, if len is not equal to the property's current length
714  *      -FDT_ERR_NOTFOUND, node does not have the named property
715  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
716  *      -FDT_ERR_BADMAGIC,
717  *      -FDT_ERR_BADVERSION,
718  *      -FDT_ERR_BADSTATE,
719  *      -FDT_ERR_BADSTRUCTURE,
720  *      -FDT_ERR_TRUNCATED, standard meanings
721  */
722 int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,
723                         const void *val, int len);
724
725 /**
726  * fdt_setprop_inplace_cell - change the value of a single-cell property
727  * @fdt: pointer to the device tree blob
728  * @nodeoffset: offset of the node whose property to change
729  * @name: name of the property to change
730  * @val: cell (32-bit integer) value to replace the property with
731  *
732  * fdt_setprop_inplace_cell() replaces the value of a given property
733  * with the 32-bit integer cell value in val, converting val to
734  * big-endian if necessary.  This function cannot change the size of a
735  * property, and so will only work if the property already exists and
736  * has length 4.
737  *
738  * This function will alter only the bytes in the blob which contain
739  * the given property value, and will not alter or move any other part
740  * of the tree.
741  *
742  * returns:
743  *      0, on success
744  *      -FDT_ERR_NOSPACE, if the property's length is not equal to 4
745   *     -FDT_ERR_NOTFOUND, node does not have the named property
746  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
747  *      -FDT_ERR_BADMAGIC,
748  *      -FDT_ERR_BADVERSION,
749  *      -FDT_ERR_BADSTATE,
750  *      -FDT_ERR_BADSTRUCTURE,
751  *      -FDT_ERR_TRUNCATED, standard meanings
752  */
753 static inline int fdt_setprop_inplace_cell(void *fdt, int nodeoffset,
754                                            const char *name, uint32_t val)
755 {
756         val = cpu_to_fdt32(val);
757         return fdt_setprop_inplace(fdt, nodeoffset, name, &val, sizeof(val));
758 }
759
760 /**
761  * fdt_nop_property - replace a property with nop tags
762  * @fdt: pointer to the device tree blob
763  * @nodeoffset: offset of the node whose property to nop
764  * @name: name of the property to nop
765  *
766  * fdt_nop_property() will replace a given property's representation
767  * in the blob with FDT_NOP tags, effectively removing it from the
768  * tree.
769  *
770  * This function will alter only the bytes in the blob which contain
771  * the property, and will not alter or move any other part of the
772  * tree.
773  *
774  * returns:
775  *      0, on success
776  *      -FDT_ERR_NOTFOUND, node does not have the named property
777  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
778  *      -FDT_ERR_BADMAGIC,
779  *      -FDT_ERR_BADVERSION,
780  *      -FDT_ERR_BADSTATE,
781  *      -FDT_ERR_BADSTRUCTURE,
782  *      -FDT_ERR_TRUNCATED, standard meanings
783  */
784 int fdt_nop_property(void *fdt, int nodeoffset, const char *name);
785
786 /**
787  * fdt_nop_node - replace a node (subtree) with nop tags
788  * @fdt: pointer to the device tree blob
789  * @nodeoffset: offset of the node to nop
790  *
791  * fdt_nop_node() will replace a given node's representation in the
792  * blob, including all its subnodes, if any, with FDT_NOP tags,
793  * effectively removing it from the tree.
794  *
795  * This function will alter only the bytes in the blob which contain
796  * the node and its properties and subnodes, and will not alter or
797  * move any other part of the tree.
798  *
799  * returns:
800  *      0, on success
801  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
802  *      -FDT_ERR_BADMAGIC,
803  *      -FDT_ERR_BADVERSION,
804  *      -FDT_ERR_BADSTATE,
805  *      -FDT_ERR_BADSTRUCTURE,
806  *      -FDT_ERR_TRUNCATED, standard meanings
807  */
808 int fdt_nop_node(void *fdt, int nodeoffset);
809
810 /**********************************************************************/
811 /* Sequential write functions                                         */
812 /**********************************************************************/
813
814 int fdt_create(void *buf, int bufsize);
815 int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size);
816 int fdt_finish_reservemap(void *fdt);
817 int fdt_begin_node(void *fdt, const char *name);
818 int fdt_property(void *fdt, const char *name, const void *val, int len);
819 static inline int fdt_property_cell(void *fdt, const char *name, uint32_t val)
820 {
821         val = cpu_to_fdt32(val);
822         return fdt_property(fdt, name, &val, sizeof(val));
823 }
824 #define fdt_property_string(fdt, name, str) \
825         fdt_property(fdt, name, str, strlen(str)+1)
826 int fdt_end_node(void *fdt);
827 int fdt_finish(void *fdt);
828
829 /**********************************************************************/
830 /* Read-write functions                                               */
831 /**********************************************************************/
832
833 int fdt_open_into(const void *fdt, void *buf, int bufsize);
834 int fdt_pack(void *fdt);
835
836 /**
837  * fdt_add_mem_rsv - add one memory reserve map entry
838  * @fdt: pointer to the device tree blob
839  * @address, @size: 64-bit values (native endian)
840  *
841  * Adds a reserve map entry to the given blob reserving a region at
842  * address address of length size.
843  *
844  * This function will insert data into the reserve map and will
845  * therefore change the indexes of some entries in the table.
846  *
847  * returns:
848  *      0, on success
849  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
850  *              contain the new reservation entry
851  *      -FDT_ERR_BADMAGIC,
852  *      -FDT_ERR_BADVERSION,
853  *      -FDT_ERR_BADSTATE,
854  *      -FDT_ERR_BADSTRUCTURE,
855  *      -FDT_ERR_BADLAYOUT,
856  *      -FDT_ERR_TRUNCATED, standard meanings
857  */
858 int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size);
859
860 /**
861  * fdt_del_mem_rsv - remove a memory reserve map entry
862  * @fdt: pointer to the device tree blob
863  * @n: entry to remove
864  *
865  * fdt_del_mem_rsv() removes the n-th memory reserve map entry from
866  * the blob.
867  *
868  * This function will delete data from the reservation table and will
869  * therefore change the indexes of some entries in the table.
870  *
871  * returns:
872  *      0, on success
873  *      -FDT_ERR_NOTFOUND, there is no entry of the given index (i.e. there
874  *              are less than n+1 reserve map entries)
875  *      -FDT_ERR_BADMAGIC,
876  *      -FDT_ERR_BADVERSION,
877  *      -FDT_ERR_BADSTATE,
878  *      -FDT_ERR_BADSTRUCTURE,
879  *      -FDT_ERR_BADLAYOUT,
880  *      -FDT_ERR_TRUNCATED, standard meanings
881  */
882 int fdt_del_mem_rsv(void *fdt, int n);
883
884 /**
885  * fdt_set_name - change the name of a given node
886  * @fdt: pointer to the device tree blob
887  * @nodeoffset: structure block offset of a node
888  * @name: name to give the node
889  *
890  * fdt_set_name() replaces the name (including unit address, if any)
891  * of the given node with the given string.  NOTE: this function can't
892  * efficiently check if the new name is unique amongst the given
893  * node's siblings; results are undefined if this function is invoked
894  * with a name equal to one of the given node's siblings.
895  *
896  * This function may insert or delete data from the blob, and will
897  * therefore change the offsets of some existing nodes.
898  *
899  * returns:
900  *      0, on success
901  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob
902  *              to contain the new name
903  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
904  *      -FDT_ERR_BADMAGIC,
905  *      -FDT_ERR_BADVERSION,
906  *      -FDT_ERR_BADSTATE, standard meanings
907  */
908 int fdt_set_name(void *fdt, int nodeoffset, const char *name);
909
910 /**
911  * fdt_setprop - create or change a property
912  * @fdt: pointer to the device tree blob
913  * @nodeoffset: offset of the node whose property to change
914  * @name: name of the property to change
915  * @val: pointer to data to set the property value to
916  * @len: length of the property value
917  *
918  * fdt_setprop() sets the value of the named property in the given
919  * node to the given value and length, creating the property if it
920  * does not already exist.
921  *
922  * This function may insert or delete data from the blob, and will
923  * therefore change the offsets of some existing nodes.
924  *
925  * returns:
926  *      0, on success
927  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
928  *              contain the new property value
929  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
930  *      -FDT_ERR_BADLAYOUT,
931  *      -FDT_ERR_BADMAGIC,
932  *      -FDT_ERR_BADVERSION,
933  *      -FDT_ERR_BADSTATE,
934  *      -FDT_ERR_BADSTRUCTURE,
935  *      -FDT_ERR_BADLAYOUT,
936  *      -FDT_ERR_TRUNCATED, standard meanings
937  */
938 int fdt_setprop(void *fdt, int nodeoffset, const char *name,
939                 const void *val, int len);
940
941 /**
942  * fdt_setprop_cell - set a property to a single cell value
943  * @fdt: pointer to the device tree blob
944  * @nodeoffset: offset of the node whose property to change
945  * @name: name of the property to change
946  * @val: 32-bit integer value for the property (native endian)
947  *
948  * fdt_setprop_cell() sets the value of the named property in the
949  * given node to the given cell value (converting to big-endian if
950  * necessary), or creates a new property with that value if it does
951  * not already exist.
952  *
953  * This function may insert or delete data from the blob, and will
954  * therefore change the offsets of some existing nodes.
955  *
956  * returns:
957  *      0, on success
958  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
959  *              contain the new property value
960  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
961  *      -FDT_ERR_BADLAYOUT,
962  *      -FDT_ERR_BADMAGIC,
963  *      -FDT_ERR_BADVERSION,
964  *      -FDT_ERR_BADSTATE,
965  *      -FDT_ERR_BADSTRUCTURE,
966  *      -FDT_ERR_BADLAYOUT,
967  *      -FDT_ERR_TRUNCATED, standard meanings
968  */
969 static inline int fdt_setprop_cell(void *fdt, int nodeoffset, const char *name,
970                                    uint32_t val)
971 {
972         val = cpu_to_fdt32(val);
973         return fdt_setprop(fdt, nodeoffset, name, &val, sizeof(val));
974 }
975
976 /**
977  * fdt_setprop_string - set a property to a string value
978  * @fdt: pointer to the device tree blob
979  * @nodeoffset: offset of the node whose property to change
980  * @name: name of the property to change
981  * @str: string value for the property
982  *
983  * fdt_setprop_string() sets the value of the named property in the
984  * given node to the given string value (using the length of the
985  * string to determine the new length of the property), or creates a
986  * new property with that value if it does not already exist.
987  *
988  * This function may insert or delete data from the blob, and will
989  * therefore change the offsets of some existing nodes.
990  *
991  * returns:
992  *      0, on success
993  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
994  *              contain the new property value
995  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
996  *      -FDT_ERR_BADLAYOUT,
997  *      -FDT_ERR_BADMAGIC,
998  *      -FDT_ERR_BADVERSION,
999  *      -FDT_ERR_BADSTATE,
1000  *      -FDT_ERR_BADSTRUCTURE,
1001  *      -FDT_ERR_BADLAYOUT,
1002  *      -FDT_ERR_TRUNCATED, standard meanings
1003  */
1004 #define fdt_setprop_string(fdt, nodeoffset, name, str) \
1005         fdt_setprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
1006
1007 /**
1008  * fdt_delprop - delete a property
1009  * @fdt: pointer to the device tree blob
1010  * @nodeoffset: offset of the node whose property to nop
1011  * @name: name of the property to nop
1012  *
1013  * fdt_del_property() will delete the given property.
1014  *
1015  * This function will delete data from the blob, and will therefore
1016  * change the offsets of some existing nodes.
1017  *
1018  * returns:
1019  *      0, on success
1020  *      -FDT_ERR_NOTFOUND, node does not have the named property
1021  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1022  *      -FDT_ERR_BADLAYOUT,
1023  *      -FDT_ERR_BADMAGIC,
1024  *      -FDT_ERR_BADVERSION,
1025  *      -FDT_ERR_BADSTATE,
1026  *      -FDT_ERR_BADSTRUCTURE,
1027  *      -FDT_ERR_TRUNCATED, standard meanings
1028  */
1029 int fdt_delprop(void *fdt, int nodeoffset, const char *name);
1030
1031 /**
1032  * fdt_add_subnode_namelen - creates a new node based on substring
1033  * @fdt: pointer to the device tree blob
1034  * @parentoffset: structure block offset of a node
1035  * @name: name of the subnode to locate
1036  * @namelen: number of characters of name to consider
1037  *
1038  * Identical to fdt_add_subnode(), but use only the first namelen
1039  * characters of name as the name of the new node.  This is useful for
1040  * creating subnodes based on a portion of a larger string, such as a
1041  * full path.
1042  */
1043 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
1044                             const char *name, int namelen);
1045
1046 /**
1047  * fdt_add_subnode - creates a new node
1048  * @fdt: pointer to the device tree blob
1049  * @parentoffset: structure block offset of a node
1050  * @name: name of the subnode to locate
1051  *
1052  * fdt_add_subnode() creates a new node as a subnode of the node at
1053  * structure block offset parentoffset, with the given name (which
1054  * should include the unit address, if any).
1055  *
1056  * This function will insert data into the blob, and will therefore
1057  * change the offsets of some existing nodes.
1058
1059  * returns:
1060  *      structure block offset of the created nodeequested subnode (>=0), on success
1061  *      -FDT_ERR_NOTFOUND, if the requested subnode does not exist
1062  *      -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag
1063  *      -FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of
1064  *              the given name
1065  *      -FDT_ERR_NOSPACE, if there is insufficient free space in the
1066  *              blob to contain the new node
1067  *      -FDT_ERR_NOSPACE
1068  *      -FDT_ERR_BADLAYOUT
1069  *      -FDT_ERR_BADMAGIC,
1070  *      -FDT_ERR_BADVERSION,
1071  *      -FDT_ERR_BADSTATE,
1072  *      -FDT_ERR_BADSTRUCTURE,
1073  *      -FDT_ERR_TRUNCATED, standard meanings.
1074  */
1075 int fdt_add_subnode(void *fdt, int parentoffset, const char *name);
1076
1077 /**
1078  * fdt_del_node - delete a node (subtree)
1079  * @fdt: pointer to the device tree blob
1080  * @nodeoffset: offset of the node to nop
1081  *
1082  * fdt_del_node() will remove the given node, including all its
1083  * subnodes if any, from the blob.
1084  *
1085  * This function will delete data from the blob, and will therefore
1086  * change the offsets of some existing nodes.
1087  *
1088  * returns:
1089  *      0, on success
1090  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1091  *      -FDT_ERR_BADLAYOUT,
1092  *      -FDT_ERR_BADMAGIC,
1093  *      -FDT_ERR_BADVERSION,
1094  *      -FDT_ERR_BADSTATE,
1095  *      -FDT_ERR_BADSTRUCTURE,
1096  *      -FDT_ERR_TRUNCATED, standard meanings
1097  */
1098 int fdt_del_node(void *fdt, int nodeoffset);
1099
1100 /**********************************************************************/
1101 /* Debugging / informational functions                                */
1102 /**********************************************************************/
1103
1104 const char *fdt_strerror(int errval);
1105
1106 #endif /* _LIBFDT_H */