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 /* Errors in device tree content */
 120 #define FDT_ERR_BADNCELLS       14
 121         /* FDT_ERR_BADNCELLS: Device tree has a #address-cells, #size-cells
 122          * or similar property with a bad format or value */
 123
 124 #define FDT_ERR_MAX             14
 125
 126 /**********************************************************************/
 127 /* Low-level functions (you probably don't need these)                */
 128 /**********************************************************************/
 129
 130 const void *fdt_offset_ptr(const void *fdt, int offset, unsigned int checklen);
 131 static inline void *fdt_offset_ptr_w(void *fdt, int offset, int checklen)
 132 {
 133         return (void *)(uintptr_t)fdt_offset_ptr(fdt, offset, checklen);
 134 }
 135
 136 uint32_t fdt_next_tag(const void *fdt, int offset, int *nextoffset);
 137
 138 /**********************************************************************/
 139 /* Traversal functions                                                */
 140 /**********************************************************************/
 141
 142 int fdt_next_node(const void *fdt, int offset, int *depth);
 143
 144 /**
 145  * fdt_first_subnode() - get offset of first direct subnode
 146  *
 147  * @fdt:        FDT blob
 148  * @offset:     Offset of node to check
 149  * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
 150  */
 151 int fdt_first_subnode(const void *fdt, int offset);
 152
 153 /**
 154  * fdt_next_subnode() - get offset of next direct subnode
 155  *
 156  * After first calling fdt_first_subnode(), call this function repeatedly to
 157  * get direct subnodes of a parent node.
 158  *
 159  * @fdt:        FDT blob
 160  * @offset:     Offset of previous subnode
 161  * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
 162  * subnodes
 163  */
 164 int fdt_next_subnode(const void *fdt, int offset);
 165
 166 /**********************************************************************/
 167 /* General functions                                                  */
 168 /**********************************************************************/
 169
 170 #define fdt_get_header(fdt, field) \
 171         (fdt32_to_cpu(((const struct fdt_header *)(fdt))->field))
 172 #define fdt_magic(fdt)                  (fdt_get_header(fdt, magic))
 173 #define fdt_totalsize(fdt)              (fdt_get_header(fdt, totalsize))
 174 #define fdt_off_dt_struct(fdt)          (fdt_get_header(fdt, off_dt_struct))
 175 #define fdt_off_dt_strings(fdt)         (fdt_get_header(fdt, off_dt_strings))
 176 #define fdt_off_mem_rsvmap(fdt)         (fdt_get_header(fdt, off_mem_rsvmap))
 177 #define fdt_version(fdt)                (fdt_get_header(fdt, version))
 178 #define fdt_last_comp_version(fdt)      (fdt_get_header(fdt, last_comp_version))
 179 #define fdt_boot_cpuid_phys(fdt)        (fdt_get_header(fdt, boot_cpuid_phys))
 180 #define fdt_size_dt_strings(fdt)        (fdt_get_header(fdt, size_dt_strings))
 181 #define fdt_size_dt_struct(fdt)         (fdt_get_header(fdt, size_dt_struct))
 182
 183 #define __fdt_set_hdr(name) \
 184         static inline void fdt_set_##name(void *fdt, uint32_t val) \
 185         { \
 186                 struct fdt_header *fdth = (struct fdt_header*)fdt; \
 187                 fdth->name = cpu_to_fdt32(val); \
 188         }
 189 __fdt_set_hdr(magic);
 190 __fdt_set_hdr(totalsize);
 191 __fdt_set_hdr(off_dt_struct);
 192 __fdt_set_hdr(off_dt_strings);
 193 __fdt_set_hdr(off_mem_rsvmap);
 194 __fdt_set_hdr(version);
 195 __fdt_set_hdr(last_comp_version);
 196 __fdt_set_hdr(boot_cpuid_phys);
 197 __fdt_set_hdr(size_dt_strings);
 198 __fdt_set_hdr(size_dt_struct);
 199 #undef __fdt_set_hdr
 200
 201 /**
 202  * fdt_check_header - sanity check a device tree or possible device tree
 203  * @fdt: pointer to data which might be a flattened device tree
 204  *
 205  * fdt_check_header() checks that the given buffer contains what
 206  * appears to be a flattened device tree with sane information in its
 207  * header.
 208  *
 209  * returns:
 210  *     0, if the buffer appears to contain a valid device tree
 211  *     -FDT_ERR_BADMAGIC,
 212  *     -FDT_ERR_BADVERSION,
 213  *     -FDT_ERR_BADSTATE, standard meanings, as above
 214  */
 215 int fdt_check_header(const void *fdt);
 216
 217 /**
 218  * fdt_move - move a device tree around in memory
 219  * @fdt: pointer to the device tree to move
 220  * @buf: pointer to memory where the device is to be moved
 221  * @bufsize: size of the memory space at buf
 222  *
 223  * fdt_move() relocates, if possible, the device tree blob located at
 224  * fdt to the buffer at buf of size bufsize.  The buffer may overlap
 225  * with the existing device tree blob at fdt.  Therefore,
 226  *     fdt_move(fdt, fdt, fdt_totalsize(fdt))
 227  * should always succeed.
 228  *
 229  * returns:
 230  *     0, on success
 231  *     -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree
 232  *     -FDT_ERR_BADMAGIC,
 233  *     -FDT_ERR_BADVERSION,
 234  *     -FDT_ERR_BADSTATE, standard meanings
 235  */
 236 int fdt_move(const void *fdt, void *buf, int bufsize);
 237
 238 /**********************************************************************/
 239 /* Read-only functions                                                */
 240 /**********************************************************************/
 241
 242 /**
 243  * fdt_string - retrieve a string from the strings block of a device tree
 244  * @fdt: pointer to the device tree blob
 245  * @stroffset: offset of the string within the strings block (native endian)
 246  *
 247  * fdt_string() retrieves a pointer to a single string from the
 248  * strings block of the device tree blob at fdt.
 249  *
 250  * returns:
 251  *     a pointer to the string, on success
 252  *     NULL, if stroffset is out of bounds
 253  */
 254 const char *fdt_string(const void *fdt, int stroffset);
 255
 256 /**
 257  * fdt_num_mem_rsv - retrieve the number of memory reserve map entries
 258  * @fdt: pointer to the device tree blob
 259  *
 260  * Returns the number of entries in the device tree blob's memory
 261  * reservation map.  This does not include the terminating 0,0 entry
 262  * or any other (0,0) entries reserved for expansion.
 263  *
 264  * returns:
 265  *     the number of entries
 266  */
 267 int fdt_num_mem_rsv(const void *fdt);
 268
 269 /**
 270  * fdt_get_mem_rsv - retrieve one memory reserve map entry
 271  * @fdt: pointer to the device tree blob
 272  * @address, @size: pointers to 64-bit variables
 273  *
 274  * On success, *address and *size will contain the address and size of
 275  * the n-th reserve map entry from the device tree blob, in
 276  * native-endian format.
 277  *
 278  * returns:
 279  *     0, on success
 280  *     -FDT_ERR_BADMAGIC,
 281  *     -FDT_ERR_BADVERSION,
 282  *     -FDT_ERR_BADSTATE, standard meanings
 283  */
 284 int fdt_get_mem_rsv(const void *fdt, int n, uint64_t *address, uint64_t *size);
 285
 286 /**
 287  * fdt_subnode_offset_namelen - find a subnode based on substring
 288  * @fdt: pointer to the device tree blob
 289  * @parentoffset: structure block offset of a node
 290  * @name: name of the subnode to locate
 291  * @namelen: number of characters of name to consider
 292  *
 293  * Identical to fdt_subnode_offset(), but only examine the first
 294  * namelen characters of name for matching the subnode name.  This is
 295  * useful for finding subnodes based on a portion of a larger string,
 296  * such as a full path.
 297  */
 298 int fdt_subnode_offset_namelen(const void *fdt, int parentoffset,
 299                                const char *name, int namelen);
 300 /**
 301  * fdt_subnode_offset - find a subnode of a given node
 302  * @fdt: pointer to the device tree blob
 303  * @parentoffset: structure block offset of a node
 304  * @name: name of the subnode to locate
 305  *
 306  * fdt_subnode_offset() finds a subnode of the node at structure block
 307  * offset parentoffset with the given name.  name may include a unit
 308  * address, in which case fdt_subnode_offset() will find the subnode
 309  * with that unit address, or the unit address may be omitted, in
 310  * which case fdt_subnode_offset() will find an arbitrary subnode
 311  * whose name excluding unit address matches the given name.
 312  *
 313  * returns:
 314  *      structure block offset of the requested subnode (>=0), on success
 315  *      -FDT_ERR_NOTFOUND, if the requested subnode does not exist
 316  *      -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag
 317  *      -FDT_ERR_BADMAGIC,
 318  *      -FDT_ERR_BADVERSION,
 319  *      -FDT_ERR_BADSTATE,
 320  *      -FDT_ERR_BADSTRUCTURE,
 321  *      -FDT_ERR_TRUNCATED, standard meanings.
 322  */
 323 int fdt_subnode_offset(const void *fdt, int parentoffset, const char *name);
 324
 325 /**
 326  * fdt_path_offset - find a tree node by its full path
 327  * @fdt: pointer to the device tree blob
 328  * @path: full path of the node to locate
 329  *
 330  * fdt_path_offset() finds a node of a given path in the device tree.
 331  * Each path component may omit the unit address portion, but the
 332  * results of this are undefined if any such path component is
 333  * ambiguous (that is if there are multiple nodes at the relevant
 334  * level matching the given component, differentiated only by unit
 335  * address).
 336  *
 337  * returns:
 338  *      structure block offset of the node with the requested path (>=0), on success
 339  *      -FDT_ERR_BADPATH, given path does not begin with '/' or is invalid
 340  *      -FDT_ERR_NOTFOUND, if the requested node does not exist
 341  *      -FDT_ERR_BADMAGIC,
 342  *      -FDT_ERR_BADVERSION,
 343  *      -FDT_ERR_BADSTATE,
 344  *      -FDT_ERR_BADSTRUCTURE,
 345  *      -FDT_ERR_TRUNCATED, standard meanings.
 346  */
 347 int fdt_path_offset(const void *fdt, const char *path);
 348
 349 /**
 350  * fdt_get_name - retrieve the name of a given node
 351  * @fdt: pointer to the device tree blob
 352  * @nodeoffset: structure block offset of the starting node
 353  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 354  *
 355  * fdt_get_name() retrieves the name (including unit address) of the
 356  * device tree node at structure block offset nodeoffset.  If lenp is
 357  * non-NULL, the length of this name is also returned, in the integer
 358  * pointed to by lenp.
 359  *
 360  * returns:
 361  *      pointer to the node's name, on success
 362  *              If lenp is non-NULL, *lenp contains the length of that name (>=0)
 363  *      NULL, on error
 364  *              if lenp is non-NULL *lenp contains an error code (<0):
 365  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
 366  *              -FDT_ERR_BADMAGIC,
 367  *              -FDT_ERR_BADVERSION,
 368  *              -FDT_ERR_BADSTATE, standard meanings
 369  */
 370 const char *fdt_get_name(const void *fdt, int nodeoffset, int *lenp);
 371
 372 /**
 373  * fdt_first_property_offset - find the offset of a node's first property
 374  * @fdt: pointer to the device tree blob
 375  * @nodeoffset: structure block offset of a node
 376  *
 377  * fdt_first_property_offset() finds the first property of the node at
 378  * the given structure block offset.
 379  *
 380  * returns:
 381  *      structure block offset of the property (>=0), on success
 382  *      -FDT_ERR_NOTFOUND, if the requested node has no properties
 383  *      -FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_BEGIN_NODE tag
 384  *      -FDT_ERR_BADMAGIC,
 385  *      -FDT_ERR_BADVERSION,
 386  *      -FDT_ERR_BADSTATE,
 387  *      -FDT_ERR_BADSTRUCTURE,
 388  *      -FDT_ERR_TRUNCATED, standard meanings.
 389  */
 390 int fdt_first_property_offset(const void *fdt, int nodeoffset);
 391
 392 /**
 393  * fdt_next_property_offset - step through a node's properties
 394  * @fdt: pointer to the device tree blob
 395  * @offset: structure block offset of a property
 396  *
 397  * fdt_next_property_offset() finds the property immediately after the
 398  * one at the given structure block offset.  This will be a property
 399  * of the same node as the given property.
 400  *
 401  * returns:
 402  *      structure block offset of the next property (>=0), on success
 403  *      -FDT_ERR_NOTFOUND, if the given property is the last in its node
 404  *      -FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_PROP tag
 405  *      -FDT_ERR_BADMAGIC,
 406  *      -FDT_ERR_BADVERSION,
 407  *      -FDT_ERR_BADSTATE,
 408  *      -FDT_ERR_BADSTRUCTURE,
 409  *      -FDT_ERR_TRUNCATED, standard meanings.
 410  */
 411 int fdt_next_property_offset(const void *fdt, int offset);
 412
 413 /**
 414  * fdt_get_property_by_offset - retrieve the property at a given offset
 415  * @fdt: pointer to the device tree blob
 416  * @offset: offset of the property to retrieve
 417  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 418  *
 419  * fdt_get_property_by_offset() retrieves a pointer to the
 420  * fdt_property structure within the device tree blob at the given
 421  * offset.  If lenp is non-NULL, the length of the property value is
 422  * also returned, in the integer pointed to by lenp.
 423  *
 424  * returns:
 425  *      pointer to the structure representing the property
 426  *              if lenp is non-NULL, *lenp contains the length of the property
 427  *              value (>=0)
 428  *      NULL, on error
 429  *              if lenp is non-NULL, *lenp contains an error code (<0):
 430  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag
 431  *              -FDT_ERR_BADMAGIC,
 432  *              -FDT_ERR_BADVERSION,
 433  *              -FDT_ERR_BADSTATE,
 434  *              -FDT_ERR_BADSTRUCTURE,
 435  *              -FDT_ERR_TRUNCATED, standard meanings
 436  */
 437 const struct fdt_property *fdt_get_property_by_offset(const void *fdt,
 438                                                       int offset,
 439                                                       int *lenp);
 440
 441 /**
 442  * fdt_get_property_namelen - find a property based on substring
 443  * @fdt: pointer to the device tree blob
 444  * @nodeoffset: offset of the node whose property to find
 445  * @name: name of the property to find
 446  * @namelen: number of characters of name to consider
 447  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 448  *
 449  * Identical to fdt_get_property_namelen(), but only examine the first
 450  * namelen characters of name for matching the property name.
 451  */
 452 const struct fdt_property *fdt_get_property_namelen(const void *fdt,
 453                                                     int nodeoffset,
 454                                                     const char *name,
 455                                                     int namelen, int *lenp);
 456
 457 /**
 458  * fdt_get_property - find a given property in a given node
 459  * @fdt: pointer to the device tree blob
 460  * @nodeoffset: offset of the node whose property to find
 461  * @name: name of the property to find
 462  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 463  *
 464  * fdt_get_property() retrieves a pointer to the fdt_property
 465  * structure within the device tree blob corresponding to the property
 466  * named 'name' of the node at offset nodeoffset.  If lenp is
 467  * non-NULL, the length of the property value is also returned, in the
 468  * integer pointed to by lenp.
 469  *
 470  * returns:
 471  *      pointer to the structure representing the property
 472  *              if lenp is non-NULL, *lenp contains the length of the property
 473  *              value (>=0)
 474  *      NULL, on error
 475  *              if lenp is non-NULL, *lenp contains an error code (<0):
 476  *              -FDT_ERR_NOTFOUND, node does not have named property
 477  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
 478  *              -FDT_ERR_BADMAGIC,
 479  *              -FDT_ERR_BADVERSION,
 480  *              -FDT_ERR_BADSTATE,
 481  *              -FDT_ERR_BADSTRUCTURE,
 482  *              -FDT_ERR_TRUNCATED, standard meanings
 483  */
 484 const struct fdt_property *fdt_get_property(const void *fdt, int nodeoffset,
 485                                             const char *name, int *lenp);
 486 static inline struct fdt_property *fdt_get_property_w(void *fdt, int nodeoffset,
 487                                                       const char *name,
 488                                                       int *lenp)
 489 {
 490         return (struct fdt_property *)(uintptr_t)
 491                 fdt_get_property(fdt, nodeoffset, name, lenp);
 492 }
 493
 494 /**
 495  * fdt_getprop_by_offset - retrieve the value of a property at a given offset
 496  * @fdt: pointer to the device tree blob
 497  * @ffset: offset of the property to read
 498  * @namep: pointer to a string variable (will be overwritten) or NULL
 499  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 500  *
 501  * fdt_getprop_by_offset() retrieves a pointer to the value of the
 502  * property at structure block offset 'offset' (this will be a pointer
 503  * to within the device blob itself, not a copy of the value).  If
 504  * lenp is non-NULL, the length of the property value is also
 505  * returned, in the integer pointed to by lenp.  If namep is non-NULL,
 506  * the property's namne will also be returned in the char * pointed to
 507  * by namep (this will be a pointer to within the device tree's string
 508  * block, not a new copy of the name).
 509  *
 510  * returns:
 511  *      pointer to the property's value
 512  *              if lenp is non-NULL, *lenp contains the length of the property
 513  *              value (>=0)
 514  *              if namep is non-NULL *namep contiains a pointer to the property
 515  *              name.
 516  *      NULL, on error
 517  *              if lenp is non-NULL, *lenp contains an error code (<0):
 518  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag
 519  *              -FDT_ERR_BADMAGIC,
 520  *              -FDT_ERR_BADVERSION,
 521  *              -FDT_ERR_BADSTATE,
 522  *              -FDT_ERR_BADSTRUCTURE,
 523  *              -FDT_ERR_TRUNCATED, standard meanings
 524  */
 525 const void *fdt_getprop_by_offset(const void *fdt, int offset,
 526                                   const char **namep, int *lenp);
 527
 528 /**
 529  * fdt_getprop_namelen - get property value based on substring
 530  * @fdt: pointer to the device tree blob
 531  * @nodeoffset: offset of the node whose property to find
 532  * @name: name of the property to find
 533  * @namelen: number of characters of name to consider
 534  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 535  *
 536  * Identical to fdt_getprop(), but only examine the first namelen
 537  * characters of name for matching the property name.
 538  */
 539 const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
 540                                 const char *name, int namelen, int *lenp);
 541
 542 /**
 543  * fdt_getprop - retrieve the value of a given property
 544  * @fdt: pointer to the device tree blob
 545  * @nodeoffset: offset of the node whose property to find
 546  * @name: name of the property to find
 547  * @lenp: pointer to an integer variable (will be overwritten) or NULL
 548  *
 549  * fdt_getprop() retrieves a pointer to the value of the property
 550  * named 'name' of the node at offset nodeoffset (this will be a
 551  * pointer to within the device blob itself, not a copy of the value).
 552  * If lenp is non-NULL, the length of the property value is also
 553  * returned, in the integer pointed to by lenp.
 554  *
 555  * returns:
 556  *      pointer to the property's value
 557  *              if lenp is non-NULL, *lenp contains the length of the property
 558  *              value (>=0)
 559  *      NULL, on error
 560  *              if lenp is non-NULL, *lenp contains an error code (<0):
 561  *              -FDT_ERR_NOTFOUND, node does not have named property
 562  *              -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
 563  *              -FDT_ERR_BADMAGIC,
 564  *              -FDT_ERR_BADVERSION,
 565  *              -FDT_ERR_BADSTATE,
 566  *              -FDT_ERR_BADSTRUCTURE,
 567  *              -FDT_ERR_TRUNCATED, standard meanings
 568  */
 569 const void *fdt_getprop(const void *fdt, int nodeoffset,
 570                         const char *name, int *lenp);
 571 static inline void *fdt_getprop_w(void *fdt, int nodeoffset,
 572                                   const char *name, int *lenp)
 573 {
 574         return (void *)(uintptr_t)fdt_getprop(fdt, nodeoffset, name, lenp);
 575 }
 576
 577 /**
 578  * fdt_get_phandle - retrieve the phandle of a given node
 579  * @fdt: pointer to the device tree blob
 580  * @nodeoffset: structure block offset of the node
 581  *
 582  * fdt_get_phandle() retrieves the phandle of the device tree node at
 583  * structure block offset nodeoffset.
 584  *
 585  * returns:
 586  *      the phandle of the node at nodeoffset, on success (!= 0, != -1)
 587  *      0, if the node has no phandle, or another error occurs
 588  */
 589 uint32_t fdt_get_phandle(const void *fdt, int nodeoffset);
 590
 591 /**
 592  * fdt_get_alias_namelen - get alias based on substring
 593  * @fdt: pointer to the device tree blob
 594  * @name: name of the alias th look up
 595  * @namelen: number of characters of name to consider
 596  *
 597  * Identical to fdt_get_alias(), but only examine the first namelen
 598  * characters of name for matching the alias name.
 599  */
 600 const char *fdt_get_alias_namelen(const void *fdt,
 601                                   const char *name, int namelen);
 602
 603 /**
 604  * fdt_get_alias - retreive the path referenced by a given alias
 605  * @fdt: pointer to the device tree blob
 606  * @name: name of the alias th look up
 607  *
 608  * fdt_get_alias() retrieves the value of a given alias.  That is, the
 609  * value of the property named 'name' in the node /aliases.
 610  *
 611  * returns:
 612  *      a pointer to the expansion of the alias named 'name', if it exists
 613  *      NULL, if the given alias or the /aliases node does not exist
 614  */
 615 const char *fdt_get_alias(const void *fdt, const char *name);
 616
 617 /**
 618  * fdt_get_path - determine the full path of a node
 619  * @fdt: pointer to the device tree blob
 620  * @nodeoffset: offset of the node whose path to find
 621  * @buf: character buffer to contain the returned path (will be overwritten)
 622  * @buflen: size of the character buffer at buf
 623  *
 624  * fdt_get_path() computes the full path of the node at offset
 625  * nodeoffset, and records that path in the buffer at buf.
 626  *
 627  * NOTE: This function is expensive, as it must scan the device tree
 628  * structure from the start to nodeoffset.
 629  *
 630  * returns:
 631  *      0, on success
 632  *              buf contains the absolute path of the node at
 633  *              nodeoffset, as a NUL-terminated string.
 634  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
 635  *      -FDT_ERR_NOSPACE, the path of the given node is longer than (bufsize-1)
 636  *              characters and will not fit in the given buffer.
 637  *      -FDT_ERR_BADMAGIC,
 638  *      -FDT_ERR_BADVERSION,
 639  *      -FDT_ERR_BADSTATE,
 640  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 641  */
 642 int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen);
 643
 644 /**
 645  * fdt_supernode_atdepth_offset - find a specific ancestor of a node
 646  * @fdt: pointer to the device tree blob
 647  * @nodeoffset: offset of the node whose parent to find
 648  * @supernodedepth: depth of the ancestor to find
 649  * @nodedepth: pointer to an integer variable (will be overwritten) or NULL
 650  *
 651  * fdt_supernode_atdepth_offset() finds an ancestor of the given node
 652  * at a specific depth from the root (where the root itself has depth
 653  * 0, its immediate subnodes depth 1 and so forth).  So
 654  *      fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, NULL);
 655  * will always return 0, the offset of the root node.  If the node at
 656  * nodeoffset has depth D, then:
 657  *      fdt_supernode_atdepth_offset(fdt, nodeoffset, D, NULL);
 658  * will return nodeoffset itself.
 659  *
 660  * NOTE: This function is expensive, as it must scan the device tree
 661  * structure from the start to nodeoffset.
 662  *
 663  * returns:
 664
 665  *      structure block offset of the node at node offset's ancestor
 666  *              of depth supernodedepth (>=0), on success
 667  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
 668 *       -FDT_ERR_NOTFOUND, supernodedepth was greater than the depth of nodeoffset
 669  *      -FDT_ERR_BADMAGIC,
 670  *      -FDT_ERR_BADVERSION,
 671  *      -FDT_ERR_BADSTATE,
 672  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 673  */
 674 int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
 675                                  int supernodedepth, int *nodedepth);
 676
 677 /**
 678  * fdt_node_depth - find the depth of a given node
 679  * @fdt: pointer to the device tree blob
 680  * @nodeoffset: offset of the node whose parent to find
 681  *
 682  * fdt_node_depth() finds the depth of a given node.  The root node
 683  * has depth 0, its immediate subnodes depth 1 and so forth.
 684  *
 685  * NOTE: This function is expensive, as it must scan the device tree
 686  * structure from the start to nodeoffset.
 687  *
 688  * returns:
 689  *      depth of the node at nodeoffset (>=0), on success
 690  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
 691  *      -FDT_ERR_BADMAGIC,
 692  *      -FDT_ERR_BADVERSION,
 693  *      -FDT_ERR_BADSTATE,
 694  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 695  */
 696 int fdt_node_depth(const void *fdt, int nodeoffset);
 697
 698 /**
 699  * fdt_parent_offset - find the parent of a given node
 700  * @fdt: pointer to the device tree blob
 701  * @nodeoffset: offset of the node whose parent to find
 702  *
 703  * fdt_parent_offset() locates the parent node of a given node (that
 704  * is, it finds the offset of the node which contains the node at
 705  * nodeoffset as a subnode).
 706  *
 707  * NOTE: This function is expensive, as it must scan the device tree
 708  * structure from the start to nodeoffset, *twice*.
 709  *
 710  * returns:
 711  *      structure block offset of the parent of the node at nodeoffset
 712  *              (>=0), on success
 713  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
 714  *      -FDT_ERR_BADMAGIC,
 715  *      -FDT_ERR_BADVERSION,
 716  *      -FDT_ERR_BADSTATE,
 717  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 718  */
 719 int fdt_parent_offset(const void *fdt, int nodeoffset);
 720
 721 /**
 722  * fdt_node_offset_by_prop_value - find nodes with a given property value
 723  * @fdt: pointer to the device tree blob
 724  * @startoffset: only find nodes after this offset
 725  * @propname: property name to check
 726  * @propval: property value to search for
 727  * @proplen: length of the value in propval
 728  *
 729  * fdt_node_offset_by_prop_value() returns the offset of the first
 730  * node after startoffset, which has a property named propname whose
 731  * value is of length proplen and has value equal to propval; or if
 732  * startoffset is -1, the very first such node in the tree.
 733  *
 734  * To iterate through all nodes matching the criterion, the following
 735  * idiom can be used:
 736  *      offset = fdt_node_offset_by_prop_value(fdt, -1, propname,
 737  *                                             propval, proplen);
 738  *      while (offset != -FDT_ERR_NOTFOUND) {
 739  *              // other code here
 740  *              offset = fdt_node_offset_by_prop_value(fdt, offset, propname,
 741  *                                                     propval, proplen);
 742  *      }
 743  *
 744  * Note the -1 in the first call to the function, if 0 is used here
 745  * instead, the function will never locate the root node, even if it
 746  * matches the criterion.
 747  *
 748  * returns:
 749  *      structure block offset of the located node (>= 0, >startoffset),
 750  *               on success
 751  *      -FDT_ERR_NOTFOUND, no node matching the criterion exists in the
 752  *              tree after startoffset
 753  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
 754  *      -FDT_ERR_BADMAGIC,
 755  *      -FDT_ERR_BADVERSION,
 756  *      -FDT_ERR_BADSTATE,
 757  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 758  */
 759 int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
 760                                   const char *propname,
 761                                   const void *propval, int proplen);
 762
 763 /**
 764  * fdt_node_offset_by_phandle - find the node with a given phandle
 765  * @fdt: pointer to the device tree blob
 766  * @phandle: phandle value
 767  *
 768  * fdt_node_offset_by_phandle() returns the offset of the node
 769  * which has the given phandle value.  If there is more than one node
 770  * in the tree with the given phandle (an invalid tree), results are
 771  * undefined.
 772  *
 773  * returns:
 774  *      structure block offset of the located node (>= 0), on success
 775  *      -FDT_ERR_NOTFOUND, no node with that phandle exists
 776  *      -FDT_ERR_BADPHANDLE, given phandle value was invalid (0 or -1)
 777  *      -FDT_ERR_BADMAGIC,
 778  *      -FDT_ERR_BADVERSION,
 779  *      -FDT_ERR_BADSTATE,
 780  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 781  */
 782 int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle);
 783
 784 /**
 785  * fdt_node_check_compatible: check a node's compatible property
 786  * @fdt: pointer to the device tree blob
 787  * @nodeoffset: offset of a tree node
 788  * @compatible: string to match against
 789  *
 790  *
 791  * fdt_node_check_compatible() returns 0 if the given node contains a
 792  * 'compatible' property with the given string as one of its elements,
 793  * it returns non-zero otherwise, or on error.
 794  *
 795  * returns:
 796  *      0, if the node has a 'compatible' property listing the given string
 797  *      1, if the node has a 'compatible' property, but it does not list
 798  *              the given string
 799  *      -FDT_ERR_NOTFOUND, if the given node has no 'compatible' property
 800  *      -FDT_ERR_BADOFFSET, if nodeoffset does not refer to a BEGIN_NODE tag
 801  *      -FDT_ERR_BADMAGIC,
 802  *      -FDT_ERR_BADVERSION,
 803  *      -FDT_ERR_BADSTATE,
 804  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 805  */
 806 int fdt_node_check_compatible(const void *fdt, int nodeoffset,
 807                               const char *compatible);
 808
 809 /**
 810  * fdt_node_offset_by_compatible - find nodes with a given 'compatible' value
 811  * @fdt: pointer to the device tree blob
 812  * @startoffset: only find nodes after this offset
 813  * @compatible: 'compatible' string to match against
 814  *
 815  * fdt_node_offset_by_compatible() returns the offset of the first
 816  * node after startoffset, which has a 'compatible' property which
 817  * lists the given compatible string; or if startoffset is -1, the
 818  * very first such node in the tree.
 819  *
 820  * To iterate through all nodes matching the criterion, the following
 821  * idiom can be used:
 822  *      offset = fdt_node_offset_by_compatible(fdt, -1, compatible);
 823  *      while (offset != -FDT_ERR_NOTFOUND) {
 824  *              // other code here
 825  *              offset = fdt_node_offset_by_compatible(fdt, offset, compatible);
 826  *      }
 827  *
 828  * Note the -1 in the first call to the function, if 0 is used here
 829  * instead, the function will never locate the root node, even if it
 830  * matches the criterion.
 831  *
 832  * returns:
 833  *      structure block offset of the located node (>= 0, >startoffset),
 834  *               on success
 835  *      -FDT_ERR_NOTFOUND, no node matching the criterion exists in the
 836  *              tree after startoffset
 837  *      -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
 838  *      -FDT_ERR_BADMAGIC,
 839  *      -FDT_ERR_BADVERSION,
 840  *      -FDT_ERR_BADSTATE,
 841  *      -FDT_ERR_BADSTRUCTURE, standard meanings
 842  */
 843 int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
 844                                   const char *compatible);
 845
 846 /**
 847  * fdt_stringlist_contains - check a string list property for a string
 848  * @strlist: Property containing a list of strings to check
 849  * @listlen: Length of property
 850  * @str: String to search for
 851  *
 852  * This is a utility function provided for convenience. The list contains
 853  * one or more strings, each terminated by \0, as is found in a device tree
 854  * "compatible" property.
 855  *
 856  * @return: 1 if the string is found in the list, 0 not found, or invalid list
 857  */
 858 int fdt_stringlist_contains(const char *strlist, int listlen, const char *str);
 859
 860 /**
 861  * fdt_count_strings - count the number of strings in a string list
 862  * @fdt: pointer to the device tree blob
 863  * @node: offset of the node
 864  * @property: name of the property containing the string list
 865  * @return: the number of strings in the given property
 866  */
 867 int fdt_count_strings(const void *fdt, int node, const char *property);
 868
 869 /**
 870  * fdt_find_string - find a string in a string list and return its index
 871  * @fdt: pointer to the device tree blob
 872  * @node: offset of the node
 873  * @property: name of the property containing the string list
 874  * @string: string to look up in the string list
 875  * @return: the index of the string or negative on error
 876  */
 877 int fdt_find_string(const void *fdt, int node, const char *property,
 878                     const char *string);
 879
 880 /**
 881  * fdt_get_string_index() - obtain the string at a given index in a string list
 882  * @fdt: pointer to the device tree blob
 883  * @node: offset of the node
 884  * @property: name of the property containing the string list
 885  * @index: index of the string to return
 886  * @output: return location for the string
 887  * @return: 0 if the string was found or a negative error code otherwise
 888  */
 889 int fdt_get_string_index(const void *fdt, int node, const char *property,
 890                          int index, const char **output);
 891
 892 /**
 893  * fdt_get_string() - obtain the string at a given index in a string list
 894  * @fdt: pointer to the device tree blob
 895  * @node: offset of the node
 896  * @property: name of the property containing the string list
 897  * @output: return location for the string
 898  * @return: 0 if the string was found or a negative error code otherwise
 899  *
 900  * This is a shortcut for:
 901  *
 902  *      fdt_get_string_index(fdt, node, property, 0, output).
 903  */
 904 int fdt_get_string(const void *fdt, int node, const char *property,
 905                    const char **output);
 906
 907 /**********************************************************************/
 908 /* Read-only functions (addressing related)                           */
 909 /**********************************************************************/
 910
 911 /**
 912  * FDT_MAX_NCELLS - maximum value for #address-cells and #size-cells
 913  *
 914  * This is the maximum value for #address-cells, #size-cells and
 915  * similar properties that will be processed by libfdt.  IEE1275
 916  * requires that OF implementations handle values up to 4.
 917  * Implementations may support larger values, but in practice higher
 918  * values aren't used.
 919  */
 920 #define FDT_MAX_NCELLS          4
 921
 922 /**
 923  * fdt_address_cells - retrieve address size for a bus represented in the tree
 924  * @fdt: pointer to the device tree blob
 925  * @nodeoffset: offset of the node to find the address size for
 926  *
 927  * When the node has a valid #address-cells property, returns its value.
 928  *
 929  * returns:
 930  *      0 <= n < FDT_MAX_NCELLS, on success
 931  *      2, if the node has no #address-cells property
 932  *      -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
 933  *              #address-cells property
 934  *      -FDT_ERR_BADMAGIC,
 935  *      -FDT_ERR_BADVERSION,
 936  *      -FDT_ERR_BADSTATE,
 937  *      -FDT_ERR_BADSTRUCTURE,
 938  *      -FDT_ERR_TRUNCATED, standard meanings
 939  */
 940 int fdt_address_cells(const void *fdt, int nodeoffset);
 941
 942 /**
 943  * fdt_size_cells - retrieve address range size for a bus represented in the
 944  *                  tree
 945  * @fdt: pointer to the device tree blob
 946  * @nodeoffset: offset of the node to find the address range size for
 947  *
 948  * When the node has a valid #size-cells property, returns its value.
 949  *
 950  * returns:
 951  *      0 <= n < FDT_MAX_NCELLS, on success
 952  *      2, if the node has no #address-cells property
 953  *      -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
 954  *              #size-cells property
 955  *      -FDT_ERR_BADMAGIC,
 956  *      -FDT_ERR_BADVERSION,
 957  *      -FDT_ERR_BADSTATE,
 958  *      -FDT_ERR_BADSTRUCTURE,
 959  *      -FDT_ERR_TRUNCATED, standard meanings
 960  */
 961 int fdt_size_cells(const void *fdt, int nodeoffset);
 962
 963
 964 /**********************************************************************/
 965 /* Write-in-place functions                                           */
 966 /**********************************************************************/
 967
 968 /**
 969  * fdt_setprop_inplace - change a property's value, but not its size
 970  * @fdt: pointer to the device tree blob
 971  * @nodeoffset: offset of the node whose property to change
 972  * @name: name of the property to change
 973  * @val: pointer to data to replace the property value with
 974  * @len: length of the property value
 975  *
 976  * fdt_setprop_inplace() replaces the value of a given property with
 977  * the data in val, of length len.  This function cannot change the
 978  * size of a property, and so will only work if len is equal to the
 979  * current length of the property.
 980  *
 981  * This function will alter only the bytes in the blob which contain
 982  * the given property value, and will not alter or move any other part
 983  * of the tree.
 984  *
 985  * returns:
 986  *      0, on success
 987  *      -FDT_ERR_NOSPACE, if len is not equal to the property's current length
 988  *      -FDT_ERR_NOTFOUND, node does not have the named property
 989  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
 990  *      -FDT_ERR_BADMAGIC,
 991  *      -FDT_ERR_BADVERSION,
 992  *      -FDT_ERR_BADSTATE,
 993  *      -FDT_ERR_BADSTRUCTURE,
 994  *      -FDT_ERR_TRUNCATED, standard meanings
 995  */
 996 int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,
 997                         const void *val, int len);
 998
 999 /**
1000  * fdt_setprop_inplace_u32 - change the value of a 32-bit integer property
1001  * @fdt: pointer to the device tree blob
1002  * @nodeoffset: offset of the node whose property to change
1003  * @name: name of the property to change
1004  * @val: 32-bit integer value to replace the property with
1005  *
1006  * fdt_setprop_inplace_u32() replaces the value of a given property
1007  * with the 32-bit integer value in val, converting val to big-endian
1008  * if necessary.  This function cannot change the size of a property,
1009  * and so will only work if the property already exists and has length
1010  * 4.
1011  *
1012  * This function will alter only the bytes in the blob which contain
1013  * the given property value, and will not alter or move any other part
1014  * of the tree.
1015  *
1016  * returns:
1017  *      0, on success
1018  *      -FDT_ERR_NOSPACE, if the property's length is not equal to 4
1019  *      -FDT_ERR_NOTFOUND, node does not have the named property
1020  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1021  *      -FDT_ERR_BADMAGIC,
1022  *      -FDT_ERR_BADVERSION,
1023  *      -FDT_ERR_BADSTATE,
1024  *      -FDT_ERR_BADSTRUCTURE,
1025  *      -FDT_ERR_TRUNCATED, standard meanings
1026  */
1027 static inline int fdt_setprop_inplace_u32(void *fdt, int nodeoffset,
1028                                           const char *name, uint32_t val)
1029 {
1030         fdt32_t tmp = cpu_to_fdt32(val);
1031         return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1032 }
1033
1034 /**
1035  * fdt_setprop_inplace_u64 - change the value of a 64-bit integer property
1036  * @fdt: pointer to the device tree blob
1037  * @nodeoffset: offset of the node whose property to change
1038  * @name: name of the property to change
1039  * @val: 64-bit integer value to replace the property with
1040  *
1041  * fdt_setprop_inplace_u64() replaces the value of a given property
1042  * with the 64-bit integer value in val, converting val to big-endian
1043  * if necessary.  This function cannot change the size of a property,
1044  * and so will only work if the property already exists and has length
1045  * 8.
1046  *
1047  * This function will alter only the bytes in the blob which contain
1048  * the given property value, and will not alter or move any other part
1049  * of the tree.
1050  *
1051  * returns:
1052  *      0, on success
1053  *      -FDT_ERR_NOSPACE, if the property's length is not equal to 8
1054  *      -FDT_ERR_NOTFOUND, node does not have the named property
1055  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1056  *      -FDT_ERR_BADMAGIC,
1057  *      -FDT_ERR_BADVERSION,
1058  *      -FDT_ERR_BADSTATE,
1059  *      -FDT_ERR_BADSTRUCTURE,
1060  *      -FDT_ERR_TRUNCATED, standard meanings
1061  */
1062 static inline int fdt_setprop_inplace_u64(void *fdt, int nodeoffset,
1063                                           const char *name, uint64_t val)
1064 {
1065         fdt64_t tmp = cpu_to_fdt64(val);
1066         return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1067 }
1068
1069 /**
1070  * fdt_setprop_inplace_cell - change the value of a single-cell property
1071  *
1072  * This is an alternative name for fdt_setprop_inplace_u32()
1073  */
1074 static inline int fdt_setprop_inplace_cell(void *fdt, int nodeoffset,
1075                                            const char *name, uint32_t val)
1076 {
1077         return fdt_setprop_inplace_u32(fdt, nodeoffset, name, val);
1078 }
1079
1080 /**
1081  * fdt_nop_property - replace a property with nop tags
1082  * @fdt: pointer to the device tree blob
1083  * @nodeoffset: offset of the node whose property to nop
1084  * @name: name of the property to nop
1085  *
1086  * fdt_nop_property() will replace a given property's representation
1087  * in the blob with FDT_NOP tags, effectively removing it from the
1088  * tree.
1089  *
1090  * This function will alter only the bytes in the blob which contain
1091  * the property, and will not alter or move any other part of the
1092  * tree.
1093  *
1094  * returns:
1095  *      0, on success
1096  *      -FDT_ERR_NOTFOUND, node does not have the named property
1097  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1098  *      -FDT_ERR_BADMAGIC,
1099  *      -FDT_ERR_BADVERSION,
1100  *      -FDT_ERR_BADSTATE,
1101  *      -FDT_ERR_BADSTRUCTURE,
1102  *      -FDT_ERR_TRUNCATED, standard meanings
1103  */
1104 int fdt_nop_property(void *fdt, int nodeoffset, const char *name);
1105
1106 /**
1107  * fdt_nop_node - replace a node (subtree) with nop tags
1108  * @fdt: pointer to the device tree blob
1109  * @nodeoffset: offset of the node to nop
1110  *
1111  * fdt_nop_node() will replace a given node's representation in the
1112  * blob, including all its subnodes, if any, with FDT_NOP tags,
1113  * effectively removing it from the tree.
1114  *
1115  * This function will alter only the bytes in the blob which contain
1116  * the node and its properties and subnodes, and will not alter or
1117  * move any other part of the tree.
1118  *
1119  * returns:
1120  *      0, on success
1121  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1122  *      -FDT_ERR_BADMAGIC,
1123  *      -FDT_ERR_BADVERSION,
1124  *      -FDT_ERR_BADSTATE,
1125  *      -FDT_ERR_BADSTRUCTURE,
1126  *      -FDT_ERR_TRUNCATED, standard meanings
1127  */
1128 int fdt_nop_node(void *fdt, int nodeoffset);
1129
1130 /**********************************************************************/
1131 /* Sequential write functions                                         */
1132 /**********************************************************************/
1133
1134 int fdt_create(void *buf, int bufsize);
1135 int fdt_resize(void *fdt, void *buf, int bufsize);
1136 int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size);
1137 int fdt_finish_reservemap(void *fdt);
1138 int fdt_begin_node(void *fdt, const char *name);
1139 int fdt_property(void *fdt, const char *name, const void *val, int len);
1140 static inline int fdt_property_u32(void *fdt, const char *name, uint32_t val)
1141 {
1142         fdt32_t tmp = cpu_to_fdt32(val);
1143         return fdt_property(fdt, name, &tmp, sizeof(tmp));
1144 }
1145 static inline int fdt_property_u64(void *fdt, const char *name, uint64_t val)
1146 {
1147         fdt64_t tmp = cpu_to_fdt64(val);
1148         return fdt_property(fdt, name, &tmp, sizeof(tmp));
1149 }
1150 static inline int fdt_property_cell(void *fdt, const char *name, uint32_t val)
1151 {
1152         return fdt_property_u32(fdt, name, val);
1153 }
1154 #define fdt_property_string(fdt, name, str) \
1155         fdt_property(fdt, name, str, strlen(str)+1)
1156 int fdt_end_node(void *fdt);
1157 int fdt_finish(void *fdt);
1158
1159 /**********************************************************************/
1160 /* Read-write functions                                               */
1161 /**********************************************************************/
1162
1163 int fdt_create_empty_tree(void *buf, int bufsize);
1164 int fdt_open_into(const void *fdt, void *buf, int bufsize);
1165 int fdt_pack(void *fdt);
1166
1167 /**
1168  * fdt_add_mem_rsv - add one memory reserve map entry
1169  * @fdt: pointer to the device tree blob
1170  * @address, @size: 64-bit values (native endian)
1171  *
1172  * Adds a reserve map entry to the given blob reserving a region at
1173  * address address of length size.
1174  *
1175  * This function will insert data into the reserve map and will
1176  * therefore change the indexes of some entries in the table.
1177  *
1178  * returns:
1179  *      0, on success
1180  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1181  *              contain the new reservation entry
1182  *      -FDT_ERR_BADMAGIC,
1183  *      -FDT_ERR_BADVERSION,
1184  *      -FDT_ERR_BADSTATE,
1185  *      -FDT_ERR_BADSTRUCTURE,
1186  *      -FDT_ERR_BADLAYOUT,
1187  *      -FDT_ERR_TRUNCATED, standard meanings
1188  */
1189 int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size);
1190
1191 /**
1192  * fdt_del_mem_rsv - remove a memory reserve map entry
1193  * @fdt: pointer to the device tree blob
1194  * @n: entry to remove
1195  *
1196  * fdt_del_mem_rsv() removes the n-th memory reserve map entry from
1197  * the blob.
1198  *
1199  * This function will delete data from the reservation table and will
1200  * therefore change the indexes of some entries in the table.
1201  *
1202  * returns:
1203  *      0, on success
1204  *      -FDT_ERR_NOTFOUND, there is no entry of the given index (i.e. there
1205  *              are less than n+1 reserve map entries)
1206  *      -FDT_ERR_BADMAGIC,
1207  *      -FDT_ERR_BADVERSION,
1208  *      -FDT_ERR_BADSTATE,
1209  *      -FDT_ERR_BADSTRUCTURE,
1210  *      -FDT_ERR_BADLAYOUT,
1211  *      -FDT_ERR_TRUNCATED, standard meanings
1212  */
1213 int fdt_del_mem_rsv(void *fdt, int n);
1214
1215 /**
1216  * fdt_set_name - change the name of a given node
1217  * @fdt: pointer to the device tree blob
1218  * @nodeoffset: structure block offset of a node
1219  * @name: name to give the node
1220  *
1221  * fdt_set_name() replaces the name (including unit address, if any)
1222  * of the given node with the given string.  NOTE: this function can't
1223  * efficiently check if the new name is unique amongst the given
1224  * node's siblings; results are undefined if this function is invoked
1225  * with a name equal to one of the given node's siblings.
1226  *
1227  * This function may insert or delete data from the blob, and will
1228  * therefore change the offsets of some existing nodes.
1229  *
1230  * returns:
1231  *      0, on success
1232  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob
1233  *              to contain the new name
1234  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1235  *      -FDT_ERR_BADMAGIC,
1236  *      -FDT_ERR_BADVERSION,
1237  *      -FDT_ERR_BADSTATE, standard meanings
1238  */
1239 int fdt_set_name(void *fdt, int nodeoffset, const char *name);
1240
1241 /**
1242  * fdt_setprop - create or change a property
1243  * @fdt: pointer to the device tree blob
1244  * @nodeoffset: offset of the node whose property to change
1245  * @name: name of the property to change
1246  * @val: pointer to data to set the property value to
1247  * @len: length of the property value
1248  *
1249  * fdt_setprop() sets the value of the named property in the given
1250  * node to the given value and length, creating the property if it
1251  * does not already exist.
1252  *
1253  * This function may insert or delete data from the blob, and will
1254  * therefore change the offsets of some existing nodes.
1255  *
1256  * returns:
1257  *      0, on success
1258  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1259  *              contain the new property value
1260  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1261  *      -FDT_ERR_BADLAYOUT,
1262  *      -FDT_ERR_BADMAGIC,
1263  *      -FDT_ERR_BADVERSION,
1264  *      -FDT_ERR_BADSTATE,
1265  *      -FDT_ERR_BADSTRUCTURE,
1266  *      -FDT_ERR_BADLAYOUT,
1267  *      -FDT_ERR_TRUNCATED, standard meanings
1268  */
1269 int fdt_setprop(void *fdt, int nodeoffset, const char *name,
1270                 const void *val, int len);
1271
1272 /**
1273  * fdt_setprop_u32 - set a property to a 32-bit integer
1274  * @fdt: pointer to the device tree blob
1275  * @nodeoffset: offset of the node whose property to change
1276  * @name: name of the property to change
1277  * @val: 32-bit integer value for the property (native endian)
1278  *
1279  * fdt_setprop_u32() sets the value of the named property in the given
1280  * node to the given 32-bit integer value (converting to big-endian if
1281  * necessary), or creates a new property with that value if it does
1282  * not already exist.
1283  *
1284  * This function may insert or delete data from the blob, and will
1285  * therefore change the offsets of some existing nodes.
1286  *
1287  * returns:
1288  *      0, on success
1289  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1290  *              contain the new property value
1291  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1292  *      -FDT_ERR_BADLAYOUT,
1293  *      -FDT_ERR_BADMAGIC,
1294  *      -FDT_ERR_BADVERSION,
1295  *      -FDT_ERR_BADSTATE,
1296  *      -FDT_ERR_BADSTRUCTURE,
1297  *      -FDT_ERR_BADLAYOUT,
1298  *      -FDT_ERR_TRUNCATED, standard meanings
1299  */
1300 static inline int fdt_setprop_u32(void *fdt, int nodeoffset, const char *name,
1301                                   uint32_t val)
1302 {
1303         fdt32_t tmp = cpu_to_fdt32(val);
1304         return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1305 }
1306
1307 /**
1308  * fdt_setprop_u64 - set a property to a 64-bit integer
1309  * @fdt: pointer to the device tree blob
1310  * @nodeoffset: offset of the node whose property to change
1311  * @name: name of the property to change
1312  * @val: 64-bit integer value for the property (native endian)
1313  *
1314  * fdt_setprop_u64() sets the value of the named property in the given
1315  * node to the given 64-bit integer value (converting to big-endian if
1316  * necessary), or creates a new property with that value if it does
1317  * not already exist.
1318  *
1319  * This function may insert or delete data from the blob, and will
1320  * therefore change the offsets of some existing nodes.
1321  *
1322  * returns:
1323  *      0, on success
1324  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1325  *              contain the new property value
1326  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1327  *      -FDT_ERR_BADLAYOUT,
1328  *      -FDT_ERR_BADMAGIC,
1329  *      -FDT_ERR_BADVERSION,
1330  *      -FDT_ERR_BADSTATE,
1331  *      -FDT_ERR_BADSTRUCTURE,
1332  *      -FDT_ERR_BADLAYOUT,
1333  *      -FDT_ERR_TRUNCATED, standard meanings
1334  */
1335 static inline int fdt_setprop_u64(void *fdt, int nodeoffset, const char *name,
1336                                   uint64_t val)
1337 {
1338         fdt64_t tmp = cpu_to_fdt64(val);
1339         return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1340 }
1341
1342 /**
1343  * fdt_setprop_cell - set a property to a single cell value
1344  *
1345  * This is an alternative name for fdt_setprop_u32()
1346  */
1347 static inline int fdt_setprop_cell(void *fdt, int nodeoffset, const char *name,
1348                                    uint32_t val)
1349 {
1350         return fdt_setprop_u32(fdt, nodeoffset, name, val);
1351 }
1352
1353 /**
1354  * fdt_setprop_string - set a property to a string value
1355  * @fdt: pointer to the device tree blob
1356  * @nodeoffset: offset of the node whose property to change
1357  * @name: name of the property to change
1358  * @str: string value for the property
1359  *
1360  * fdt_setprop_string() sets the value of the named property in the
1361  * given node to the given string value (using the length of the
1362  * string to determine the new length of the property), or creates a
1363  * new property with that value if it does not already exist.
1364  *
1365  * This function may insert or delete data from the blob, and will
1366  * therefore change the offsets of some existing nodes.
1367  *
1368  * returns:
1369  *      0, on success
1370  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1371  *              contain the new property value
1372  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1373  *      -FDT_ERR_BADLAYOUT,
1374  *      -FDT_ERR_BADMAGIC,
1375  *      -FDT_ERR_BADVERSION,
1376  *      -FDT_ERR_BADSTATE,
1377  *      -FDT_ERR_BADSTRUCTURE,
1378  *      -FDT_ERR_BADLAYOUT,
1379  *      -FDT_ERR_TRUNCATED, standard meanings
1380  */
1381 #define fdt_setprop_string(fdt, nodeoffset, name, str) \
1382         fdt_setprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
1383
1384 /**
1385  * fdt_appendprop - append to or create a property
1386  * @fdt: pointer to the device tree blob
1387  * @nodeoffset: offset of the node whose property to change
1388  * @name: name of the property to append to
1389  * @val: pointer to data to append to the property value
1390  * @len: length of the data to append to the property value
1391  *
1392  * fdt_appendprop() appends the value to the named property in the
1393  * given node, creating the property if it does not already exist.
1394  *
1395  * This function may insert data into the blob, and will therefore
1396  * change the offsets of some existing nodes.
1397  *
1398  * returns:
1399  *      0, on success
1400  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1401  *              contain the new property value
1402  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1403  *      -FDT_ERR_BADLAYOUT,
1404  *      -FDT_ERR_BADMAGIC,
1405  *      -FDT_ERR_BADVERSION,
1406  *      -FDT_ERR_BADSTATE,
1407  *      -FDT_ERR_BADSTRUCTURE,
1408  *      -FDT_ERR_BADLAYOUT,
1409  *      -FDT_ERR_TRUNCATED, standard meanings
1410  */
1411 int fdt_appendprop(void *fdt, int nodeoffset, const char *name,
1412                    const void *val, int len);
1413
1414 /**
1415  * fdt_appendprop_u32 - append a 32-bit integer value to a property
1416  * @fdt: pointer to the device tree blob
1417  * @nodeoffset: offset of the node whose property to change
1418  * @name: name of the property to change
1419  * @val: 32-bit integer value to append to the property (native endian)
1420  *
1421  * fdt_appendprop_u32() appends the given 32-bit integer value
1422  * (converting to big-endian if necessary) to the value of the named
1423  * property in the given node, or creates a new property with that
1424  * value if it does not already exist.
1425  *
1426  * This function may insert data into the blob, and will therefore
1427  * change the offsets of some existing nodes.
1428  *
1429  * returns:
1430  *      0, on success
1431  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1432  *              contain the new property value
1433  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1434  *      -FDT_ERR_BADLAYOUT,
1435  *      -FDT_ERR_BADMAGIC,
1436  *      -FDT_ERR_BADVERSION,
1437  *      -FDT_ERR_BADSTATE,
1438  *      -FDT_ERR_BADSTRUCTURE,
1439  *      -FDT_ERR_BADLAYOUT,
1440  *      -FDT_ERR_TRUNCATED, standard meanings
1441  */
1442 static inline int fdt_appendprop_u32(void *fdt, int nodeoffset,
1443                                      const char *name, uint32_t val)
1444 {
1445         fdt32_t tmp = cpu_to_fdt32(val);
1446         return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1447 }
1448
1449 /**
1450  * fdt_appendprop_u64 - append a 64-bit integer value to a property
1451  * @fdt: pointer to the device tree blob
1452  * @nodeoffset: offset of the node whose property to change
1453  * @name: name of the property to change
1454  * @val: 64-bit integer value to append to the property (native endian)
1455  *
1456  * fdt_appendprop_u64() appends the given 64-bit integer value
1457  * (converting to big-endian if necessary) to the value of the named
1458  * property in the given node, or creates a new property with that
1459  * value if it does not already exist.
1460  *
1461  * This function may insert data into the blob, and will therefore
1462  * change the offsets of some existing nodes.
1463  *
1464  * returns:
1465  *      0, on success
1466  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1467  *              contain the new property value
1468  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1469  *      -FDT_ERR_BADLAYOUT,
1470  *      -FDT_ERR_BADMAGIC,
1471  *      -FDT_ERR_BADVERSION,
1472  *      -FDT_ERR_BADSTATE,
1473  *      -FDT_ERR_BADSTRUCTURE,
1474  *      -FDT_ERR_BADLAYOUT,
1475  *      -FDT_ERR_TRUNCATED, standard meanings
1476  */
1477 static inline int fdt_appendprop_u64(void *fdt, int nodeoffset,
1478                                      const char *name, uint64_t val)
1479 {
1480         fdt64_t tmp = cpu_to_fdt64(val);
1481         return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1482 }
1483
1484 /**
1485  * fdt_appendprop_cell - append a single cell value to a property
1486  *
1487  * This is an alternative name for fdt_appendprop_u32()
1488  */
1489 static inline int fdt_appendprop_cell(void *fdt, int nodeoffset,
1490                                       const char *name, uint32_t val)
1491 {
1492         return fdt_appendprop_u32(fdt, nodeoffset, name, val);
1493 }
1494
1495 /**
1496  * fdt_appendprop_string - append a string to a property
1497  * @fdt: pointer to the device tree blob
1498  * @nodeoffset: offset of the node whose property to change
1499  * @name: name of the property to change
1500  * @str: string value to append to the property
1501  *
1502  * fdt_appendprop_string() appends the given string to the value of
1503  * the named property in the given node, or creates a new property
1504  * with that value if it does not already exist.
1505  *
1506  * This function may insert data into the blob, and will therefore
1507  * change the offsets of some existing nodes.
1508  *
1509  * returns:
1510  *      0, on success
1511  *      -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1512  *              contain the new property value
1513  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1514  *      -FDT_ERR_BADLAYOUT,
1515  *      -FDT_ERR_BADMAGIC,
1516  *      -FDT_ERR_BADVERSION,
1517  *      -FDT_ERR_BADSTATE,
1518  *      -FDT_ERR_BADSTRUCTURE,
1519  *      -FDT_ERR_BADLAYOUT,
1520  *      -FDT_ERR_TRUNCATED, standard meanings
1521  */
1522 #define fdt_appendprop_string(fdt, nodeoffset, name, str) \
1523         fdt_appendprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
1524
1525 /**
1526  * fdt_delprop - delete a property
1527  * @fdt: pointer to the device tree blob
1528  * @nodeoffset: offset of the node whose property to nop
1529  * @name: name of the property to nop
1530  *
1531  * fdt_del_property() will delete the given property.
1532  *
1533  * This function will delete data from the blob, and will therefore
1534  * change the offsets of some existing nodes.
1535  *
1536  * returns:
1537  *      0, on success
1538  *      -FDT_ERR_NOTFOUND, node does not have the named property
1539  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1540  *      -FDT_ERR_BADLAYOUT,
1541  *      -FDT_ERR_BADMAGIC,
1542  *      -FDT_ERR_BADVERSION,
1543  *      -FDT_ERR_BADSTATE,
1544  *      -FDT_ERR_BADSTRUCTURE,
1545  *      -FDT_ERR_TRUNCATED, standard meanings
1546  */
1547 int fdt_delprop(void *fdt, int nodeoffset, const char *name);
1548
1549 /**
1550  * fdt_add_subnode_namelen - creates a new node based on substring
1551  * @fdt: pointer to the device tree blob
1552  * @parentoffset: structure block offset of a node
1553  * @name: name of the subnode to locate
1554  * @namelen: number of characters of name to consider
1555  *
1556  * Identical to fdt_add_subnode(), but use only the first namelen
1557  * characters of name as the name of the new node.  This is useful for
1558  * creating subnodes based on a portion of a larger string, such as a
1559  * full path.
1560  */
1561 int fdt_add_subnode_namelen(void *fdt, int parentoffset,
1562                             const char *name, int namelen);
1563
1564 /**
1565  * fdt_add_subnode - creates a new node
1566  * @fdt: pointer to the device tree blob
1567  * @parentoffset: structure block offset of a node
1568  * @name: name of the subnode to locate
1569  *
1570  * fdt_add_subnode() creates a new node as a subnode of the node at
1571  * structure block offset parentoffset, with the given name (which
1572  * should include the unit address, if any).
1573  *
1574  * This function will insert data into the blob, and will therefore
1575  * change the offsets of some existing nodes.
1576
1577  * returns:
1578  *      structure block offset of the created nodeequested subnode (>=0), on success
1579  *      -FDT_ERR_NOTFOUND, if the requested subnode does not exist
1580  *      -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag
1581  *      -FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of
1582  *              the given name
1583  *      -FDT_ERR_NOSPACE, if there is insufficient free space in the
1584  *              blob to contain the new node
1585  *      -FDT_ERR_NOSPACE
1586  *      -FDT_ERR_BADLAYOUT
1587  *      -FDT_ERR_BADMAGIC,
1588  *      -FDT_ERR_BADVERSION,
1589  *      -FDT_ERR_BADSTATE,
1590  *      -FDT_ERR_BADSTRUCTURE,
1591  *      -FDT_ERR_TRUNCATED, standard meanings.
1592  */
1593 int fdt_add_subnode(void *fdt, int parentoffset, const char *name);
1594
1595 /**
1596  * fdt_del_node - delete a node (subtree)
1597  * @fdt: pointer to the device tree blob
1598  * @nodeoffset: offset of the node to nop
1599  *
1600  * fdt_del_node() will remove the given node, including all its
1601  * subnodes if any, from the blob.
1602  *
1603  * This function will delete data from the blob, and will therefore
1604  * change the offsets of some existing nodes.
1605  *
1606  * returns:
1607  *      0, on success
1608  *      -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1609  *      -FDT_ERR_BADLAYOUT,
1610  *      -FDT_ERR_BADMAGIC,
1611  *      -FDT_ERR_BADVERSION,
1612  *      -FDT_ERR_BADSTATE,
1613  *      -FDT_ERR_BADSTRUCTURE,
1614  *      -FDT_ERR_TRUNCATED, standard meanings
1615  */
1616 int fdt_del_node(void *fdt, int nodeoffset);
1617
1618 /**********************************************************************/
1619 /* Debugging / informational functions                                */
1620 /**********************************************************************/
1621
1622 const char *fdt_strerror(int errval);
1623
1624 struct fdt_region {
1625         int offset;
1626         int size;
1627 };
1628
1629 /**
1630  * fdt_find_regions() - find regions in device tree
1631  *
1632  * Given a list of nodes to include and properties to exclude, find
1633  * the regions of the device tree which describe those included parts.
1634  *
1635  * The intent is to get a list of regions which will be invariant provided
1636  * those parts are invariant. For example, if you request a list of regions
1637  * for all nodes but exclude the property "data", then you will get the
1638  * same region contents regardless of any change to "data" properties.
1639  *
1640  * This function can be used to produce a byte-stream to send to a hashing
1641  * function to verify that critical parts of the FDT have not changed.
1642  *
1643  * Nodes which are given in 'inc' are included in the region list, as
1644  * are the names of the immediate subnodes nodes (but not the properties
1645  * or subnodes of those subnodes).
1646  *
1647  * For eaxample "/" means to include the root node, all root properties
1648  * and the FDT_BEGIN_NODE and FDT_END_NODE of all subnodes of /. The latter
1649  * ensures that we capture the names of the subnodes. In a hashing situation
1650  * it prevents the root node from changing at all Any change to non-excluded
1651  * properties, names of subnodes or number of subnodes would be detected.
1652  *
1653  * When used with FITs this provides the ability to hash and sign parts of
1654  * the FIT based on different configurations in the FIT. Then it is
1655  * impossible to change anything about that configuration (include images
1656  * attached to the configuration), but it may be possible to add new
1657  * configurations, new images or new signatures within the existing
1658  * framework.
1659  *
1660  * Adding new properties to a device tree may result in the string table
1661  * being extended (if the new property names are different from those
1662  * already added). This function can optionally include a region for
1663  * the string table so that this can be part of the hash too.
1664  *
1665  * The device tree header is not included in the list.
1666  *
1667  * @fdt:        Device tree to check
1668  * @inc:        List of node paths to included
1669  * @inc_count:  Number of node paths in list
1670  * @exc_prop:   List of properties names to exclude
1671  * @exc_prop_count:     Number of properties in exclude list
1672  * @region:     Returns list of regions
1673  * @max_region: Maximum length of region list
1674  * @path:       Pointer to a temporary string for the function to use for
1675  *              building path names
1676  * @path_len:   Length of path, must be large enough to hold the longest
1677  *              path in the tree
1678  * @add_string_tab:     1 to add a region for the string table
1679  * @return number of regions in list. If this is >max_regions then the
1680  * region array was exhausted. You should increase max_regions and try
1681  * the call again.
1682  */
1683 int fdt_find_regions(const void *fdt, char * const inc[], int inc_count,
1684                      char * const exc_prop[], int exc_prop_count,
1685                      struct fdt_region region[], int max_regions,
1686                      char *path, int path_len, int add_string_tab);
1687
1688 #endif /* _LIBFDT_H */