[mirror_edk2.git] / EmbeddedPkg / Include / libfdt.h

#ifndef _LIBFDT_H\r
#define _LIBFDT_H\r
/*\r
 * libfdt - Flat Device Tree manipulation\r
 * Copyright (C) 2006 David Gibson, IBM Corporation.\r
 *\r
 * libfdt is dual licensed: you can use it either under the terms of\r
 * the GPL, or the BSD license, at your option.\r
 *\r
 *  a) This library is free software; you can redistribute it and/or\r
 *     modify it under the terms of the GNU General Public License as\r
 *     published by the Free Software Foundation; either version 2 of the\r
 *     License, or (at your option) any later version.\r
 *\r
 *     This library is distributed in the hope that it will be useful,\r
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 *     GNU General Public License for more details.\r
 *\r
 *     You should have received a copy of the GNU General Public\r
 *     License along with this library; if not, write to the Free\r
 *     Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,\r
 *     MA 02110-1301 USA\r
 *\r
 * Alternatively,\r
 *\r
 *  b) Redistribution and use in source and binary forms, with or\r
 *     without modification, are permitted provided that the following\r
 *     conditions are met:\r
 *\r
 *     1. Redistributions of source code must retain the above\r
 *        copyright notice, this list of conditions and the following\r
 *        disclaimer.\r
 *     2. Redistributions in binary form must reproduce the above\r
 *        copyright notice, this list of conditions and the following\r
 *        disclaimer in the documentation and/or other materials\r
 *        provided with the distribution.\r
 *\r
 *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
 *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,\r
 *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
 *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
 *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\r
 *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
 *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
 *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
 *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
 *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r
 *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
 *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
 */\r
\r
#include <libfdt_env.h>\r
#include <fdt.h>\r
\r
#define FDT_FIRST_SUPPORTED_VERSION	0x10\r
#define FDT_LAST_SUPPORTED_VERSION	0x11\r
\r
/* Error codes: informative error codes */\r
#define FDT_ERR_NOTFOUND	1\r
	/* FDT_ERR_NOTFOUND: The requested node or property does not exist */\r
#define FDT_ERR_EXISTS		2\r
	/* FDT_ERR_EXISTS: Attemped to create a node or property which\r
	 * already exists */\r
#define FDT_ERR_NOSPACE		3\r
	/* FDT_ERR_NOSPACE: Operation needed to expand the device\r
	 * tree, but its buffer did not have sufficient space to\r
	 * contain the expanded tree. Use fdt_open_into() to move the\r
	 * device tree to a buffer with more space. */\r
\r
/* Error codes: codes for bad parameters */\r
#define FDT_ERR_BADOFFSET	4\r
	/* FDT_ERR_BADOFFSET: Function was passed a structure block\r
	 * offset which is out-of-bounds, or which points to an\r
	 * unsuitable part of the structure for the operation. */\r
#define FDT_ERR_BADPATH		5\r
	/* FDT_ERR_BADPATH: Function was passed a badly formatted path\r
	 * (e.g. missing a leading / for a function which requires an\r
	 * absolute path) */\r
#define FDT_ERR_BADPHANDLE	6\r
	/* FDT_ERR_BADPHANDLE: Function was passed an invalid phandle\r
	 * value.  phandle values of 0 and -1 are not permitted. */\r
#define FDT_ERR_BADSTATE	7\r
	/* FDT_ERR_BADSTATE: Function was passed an incomplete device\r
	 * tree created by the sequential-write functions, which is\r
	 * not sufficiently complete for the requested operation. */\r
\r
/* Error codes: codes for bad device tree blobs */\r
#define FDT_ERR_TRUNCATED	8\r
	/* FDT_ERR_TRUNCATED: Structure block of the given device tree\r
	 * ends without an FDT_END tag. */\r
#define FDT_ERR_BADMAGIC	9\r
	/* FDT_ERR_BADMAGIC: Given "device tree" appears not to be a\r
	 * device tree at all - it is missing the flattened device\r
	 * tree magic number. */\r
#define FDT_ERR_BADVERSION	10\r
	/* FDT_ERR_BADVERSION: Given device tree has a version which\r
	 * can't be handled by the requested operation.  For\r
	 * read-write functions, this may mean that fdt_open_into() is\r
	 * required to convert the tree to the expected version. */\r
#define FDT_ERR_BADSTRUCTURE	11\r
	/* FDT_ERR_BADSTRUCTURE: Given device tree has a corrupt\r
	 * structure block or other serious error (e.g. misnested\r
	 * nodes, or subnodes preceding properties). */\r
#define FDT_ERR_BADLAYOUT	12\r
	/* FDT_ERR_BADLAYOUT: For read-write functions, the given\r
	 * device tree has it's sub-blocks in an order that the\r
	 * function can't handle (memory reserve map, then structure,\r
	 * then strings).  Use fdt_open_into() to reorganize the tree\r
	 * into a form suitable for the read-write operations. */\r
\r
/* "Can't happen" error indicating a bug in libfdt */\r
#define FDT_ERR_INTERNAL	13\r
	/* FDT_ERR_INTERNAL: libfdt has failed an internal assertion.\r
	 * Should never be returned, if it is, it indicates a bug in\r
	 * libfdt itself. */\r
\r
#define FDT_ERR_MAX		13\r
\r
/**********************************************************************/\r
/* Low-level functions (you probably don't need these)                */\r
/**********************************************************************/\r
\r
const void *fdt_offset_ptr(const void *fdt, int offset, unsigned int checklen);\r
static inline void *fdt_offset_ptr_w(void *fdt, int offset, int checklen)\r
{\r
	return (void *)(uintptr_t)fdt_offset_ptr(fdt, offset, checklen);\r
}\r
\r
uint32_t fdt_next_tag(const void *fdt, int offset, int *nextoffset);\r
\r
/**********************************************************************/\r
/* Traversal functions                                                */\r
/**********************************************************************/\r
\r
int fdt_next_node(const void *fdt, int offset, int *depth);\r
\r
/**\r
 * fdt_first_subnode() - get offset of first direct subnode\r
 *\r
 * @fdt:	FDT blob\r
 * @offset:	Offset of node to check\r
 * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none\r
 */\r
int fdt_first_subnode(const void *fdt, int offset);\r
\r
/**\r
 * fdt_next_subnode() - get offset of next direct subnode\r
 *\r
 * After first calling fdt_first_subnode(), call this function repeatedly to\r
 * get direct subnodes of a parent node.\r
 *\r
 * @fdt:	FDT blob\r
 * @offset:	Offset of previous subnode\r
 * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more\r
 * subnodes\r
 */\r
int fdt_next_subnode(const void *fdt, int offset);\r
\r
/**********************************************************************/\r
/* General functions                                                  */\r
/**********************************************************************/\r
\r
#define fdt_get_header(fdt, field) \\r
	(fdt32_to_cpu(((const struct fdt_header *)(fdt))->field))\r
#define fdt_magic(fdt) 			(fdt_get_header(fdt, magic))\r
#define fdt_totalsize(fdt)		(fdt_get_header(fdt, totalsize))\r
#define fdt_off_dt_struct(fdt)		(fdt_get_header(fdt, off_dt_struct))\r
#define fdt_off_dt_strings(fdt)		(fdt_get_header(fdt, off_dt_strings))\r
#define fdt_off_mem_rsvmap(fdt)		(fdt_get_header(fdt, off_mem_rsvmap))\r
#define fdt_version(fdt)		(fdt_get_header(fdt, version))\r
#define fdt_last_comp_version(fdt) 	(fdt_get_header(fdt, last_comp_version))\r
#define fdt_boot_cpuid_phys(fdt) 	(fdt_get_header(fdt, boot_cpuid_phys))\r
#define fdt_size_dt_strings(fdt) 	(fdt_get_header(fdt, size_dt_strings))\r
#define fdt_size_dt_struct(fdt)		(fdt_get_header(fdt, size_dt_struct))\r
\r
#define __fdt_set_hdr(name) \\r
	static inline void fdt_set_##name(void *fdt, uint32_t val) \\r
	{ \\r
		struct fdt_header *fdth = (struct fdt_header*)fdt; \\r
		fdth->name = cpu_to_fdt32(val); \\r
	}\r
__fdt_set_hdr(magic);\r
__fdt_set_hdr(totalsize);\r
__fdt_set_hdr(off_dt_struct);\r
__fdt_set_hdr(off_dt_strings);\r
__fdt_set_hdr(off_mem_rsvmap);\r
__fdt_set_hdr(version);\r
__fdt_set_hdr(last_comp_version);\r
__fdt_set_hdr(boot_cpuid_phys);\r
__fdt_set_hdr(size_dt_strings);\r
__fdt_set_hdr(size_dt_struct);\r
#undef __fdt_set_hdr\r
\r
/**\r
 * fdt_check_header - sanity check a device tree or possible device tree\r
 * @fdt: pointer to data which might be a flattened device tree\r
 *\r
 * fdt_check_header() checks that the given buffer contains what\r
 * appears to be a flattened device tree with sane information in its\r
 * header.\r
 *\r
 * returns:\r
 *     0, if the buffer appears to contain a valid device tree\r
 *     -FDT_ERR_BADMAGIC,\r
 *     -FDT_ERR_BADVERSION,\r
 *     -FDT_ERR_BADSTATE, standard meanings, as above\r
 */\r
int fdt_check_header(const void *fdt);\r
\r
/**\r
 * fdt_move - move a device tree around in memory\r
 * @fdt: pointer to the device tree to move\r
 * @buf: pointer to memory where the device is to be moved\r
 * @bufsize: size of the memory space at buf\r
 *\r
 * fdt_move() relocates, if possible, the device tree blob located at\r
 * fdt to the buffer at buf of size bufsize.  The buffer may overlap\r
 * with the existing device tree blob at fdt.  Therefore,\r
 *     fdt_move(fdt, fdt, fdt_totalsize(fdt))\r
 * should always succeed.\r
 *\r
 * returns:\r
 *     0, on success\r
 *     -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree\r
 *     -FDT_ERR_BADMAGIC,\r
 *     -FDT_ERR_BADVERSION,\r
 *     -FDT_ERR_BADSTATE, standard meanings\r
 */\r
int fdt_move(const void *fdt, void *buf, int bufsize);\r
\r
/**********************************************************************/\r
/* Read-only functions                                                */\r
/**********************************************************************/\r
\r
/**\r
 * fdt_string - retrieve a string from the strings block of a device tree\r
 * @fdt: pointer to the device tree blob\r
 * @stroffset: offset of the string within the strings block (native endian)\r
 *\r
 * fdt_string() retrieves a pointer to a single string from the\r
 * strings block of the device tree blob at fdt.\r
 *\r
 * returns:\r
 *     a pointer to the string, on success\r
 *     NULL, if stroffset is out of bounds\r
 */\r
const char *fdt_string(const void *fdt, int stroffset);\r
\r
/**\r
 * fdt_num_mem_rsv - retrieve the number of memory reserve map entries\r
 * @fdt: pointer to the device tree blob\r
 *\r
 * Returns the number of entries in the device tree blob's memory\r
 * reservation map.  This does not include the terminating 0,0 entry\r
 * or any other (0,0) entries reserved for expansion.\r
 *\r
 * returns:\r
 *     the number of entries\r
 */\r
int fdt_num_mem_rsv(const void *fdt);\r
\r
/**\r
 * fdt_get_mem_rsv - retrieve one memory reserve map entry\r
 * @fdt: pointer to the device tree blob\r
 * @address, @size: pointers to 64-bit variables\r
 *\r
 * On success, *address and *size will contain the address and size of\r
 * the n-th reserve map entry from the device tree blob, in\r
 * native-endian format.\r
 *\r
 * returns:\r
 *     0, on success\r
 *     -FDT_ERR_BADMAGIC,\r
 *     -FDT_ERR_BADVERSION,\r
 *     -FDT_ERR_BADSTATE, standard meanings\r
 */\r
int fdt_get_mem_rsv(const void *fdt, int n, uint64_t *address, uint64_t *size);\r
\r
/**\r
 * fdt_subnode_offset_namelen - find a subnode based on substring\r
 * @fdt: pointer to the device tree blob\r
 * @parentoffset: structure block offset of a node\r
 * @name: name of the subnode to locate\r
 * @namelen: number of characters of name to consider\r
 *\r
 * Identical to fdt_subnode_offset(), but only examine the first\r
 * namelen characters of name for matching the subnode name.  This is\r
 * useful for finding subnodes based on a portion of a larger string,\r
 * such as a full path.\r
 */\r
int fdt_subnode_offset_namelen(const void *fdt, int parentoffset,\r
			       const char *name, int namelen);\r
/**\r
 * fdt_subnode_offset - find a subnode of a given node\r
 * @fdt: pointer to the device tree blob\r
 * @parentoffset: structure block offset of a node\r
 * @name: name of the subnode to locate\r
 *\r
 * fdt_subnode_offset() finds a subnode of the node at structure block\r
 * offset parentoffset with the given name.  name may include a unit\r
 * address, in which case fdt_subnode_offset() will find the subnode\r
 * with that unit address, or the unit address may be omitted, in\r
 * which case fdt_subnode_offset() will find an arbitrary subnode\r
 * whose name excluding unit address matches the given name.\r
 *\r
 * returns:\r
 *	structure block offset of the requested subnode (>=0), on success\r
 *	-FDT_ERR_NOTFOUND, if the requested subnode does not exist\r
 *	-FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag\r
 *      -FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings.\r
 */\r
int fdt_subnode_offset(const void *fdt, int parentoffset, const char *name);\r
\r
/**\r
 * fdt_path_offset - find a tree node by its full path\r
 * @fdt: pointer to the device tree blob\r
 * @path: full path of the node to locate\r
 *\r
 * fdt_path_offset() finds a node of a given path in the device tree.\r
 * Each path component may omit the unit address portion, but the\r
 * results of this are undefined if any such path component is\r
 * ambiguous (that is if there are multiple nodes at the relevant\r
 * level matching the given component, differentiated only by unit\r
 * address).\r
 *\r
 * returns:\r
 *	structure block offset of the node with the requested path (>=0), on success\r
 *	-FDT_ERR_BADPATH, given path does not begin with '/' or is invalid\r
 *	-FDT_ERR_NOTFOUND, if the requested node does not exist\r
 *      -FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings.\r
 */\r
int fdt_path_offset(const void *fdt, const char *path);\r
\r
/**\r
 * fdt_get_name - retrieve the name of a given node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: structure block offset of the starting node\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * fdt_get_name() retrieves the name (including unit address) of the\r
 * device tree node at structure block offset nodeoffset.  If lenp is\r
 * non-NULL, the length of this name is also returned, in the integer\r
 * pointed to by lenp.\r
 *\r
 * returns:\r
 *	pointer to the node's name, on success\r
 *		If lenp is non-NULL, *lenp contains the length of that name (>=0)\r
 *	NULL, on error\r
 *		if lenp is non-NULL *lenp contains an error code (<0):\r
 *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *		-FDT_ERR_BADMAGIC,\r
 *		-FDT_ERR_BADVERSION,\r
 *		-FDT_ERR_BADSTATE, standard meanings\r
 */\r
const char *fdt_get_name(const void *fdt, int nodeoffset, int *lenp);\r
\r
/**\r
 * fdt_first_property_offset - find the offset of a node's first property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: structure block offset of a node\r
 *\r
 * fdt_first_property_offset() finds the first property of the node at\r
 * the given structure block offset.\r
 *\r
 * returns:\r
 *	structure block offset of the property (>=0), on success\r
 *	-FDT_ERR_NOTFOUND, if the requested node has no properties\r
 *	-FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_BEGIN_NODE tag\r
 *      -FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings.\r
 */\r
int fdt_first_property_offset(const void *fdt, int nodeoffset);\r
\r
/**\r
 * fdt_next_property_offset - step through a node's properties\r
 * @fdt: pointer to the device tree blob\r
 * @offset: structure block offset of a property\r
 *\r
 * fdt_next_property_offset() finds the property immediately after the\r
 * one at the given structure block offset.  This will be a property\r
 * of the same node as the given property.\r
 *\r
 * returns:\r
 *	structure block offset of the next property (>=0), on success\r
 *	-FDT_ERR_NOTFOUND, if the given property is the last in its node\r
 *	-FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_PROP tag\r
 *      -FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings.\r
 */\r
int fdt_next_property_offset(const void *fdt, int offset);\r
\r
/**\r
 * fdt_get_property_by_offset - retrieve the property at a given offset\r
 * @fdt: pointer to the device tree blob\r
 * @offset: offset of the property to retrieve\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * fdt_get_property_by_offset() retrieves a pointer to the\r
 * fdt_property structure within the device tree blob at the given\r
 * offset.  If lenp is non-NULL, the length of the property value is\r
 * also returned, in the integer pointed to by lenp.\r
 *\r
 * returns:\r
 *	pointer to the structure representing the property\r
 *		if lenp is non-NULL, *lenp contains the length of the property\r
 *		value (>=0)\r
 *	NULL, on error\r
 *		if lenp is non-NULL, *lenp contains an error code (<0):\r
 *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag\r
 *		-FDT_ERR_BADMAGIC,\r
 *		-FDT_ERR_BADVERSION,\r
 *		-FDT_ERR_BADSTATE,\r
 *		-FDT_ERR_BADSTRUCTURE,\r
 *		-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
const struct fdt_property *fdt_get_property_by_offset(const void *fdt,\r
						      int offset,\r
						      int *lenp);\r
\r
/**\r
 * fdt_get_property_namelen - find a property based on substring\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to find\r
 * @name: name of the property to find\r
 * @namelen: number of characters of name to consider\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * Identical to fdt_get_property_namelen(), but only examine the first\r
 * namelen characters of name for matching the property name.\r
 */\r
const struct fdt_property *fdt_get_property_namelen(const void *fdt,\r
						    int nodeoffset,\r
						    const char *name,\r
						    int namelen, int *lenp);\r
\r
/**\r
 * fdt_get_property - find a given property in a given node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to find\r
 * @name: name of the property to find\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * fdt_get_property() retrieves a pointer to the fdt_property\r
 * structure within the device tree blob corresponding to the property\r
 * named 'name' of the node at offset nodeoffset.  If lenp is\r
 * non-NULL, the length of the property value is also returned, in the\r
 * integer pointed to by lenp.\r
 *\r
 * returns:\r
 *	pointer to the structure representing the property\r
 *		if lenp is non-NULL, *lenp contains the length of the property\r
 *		value (>=0)\r
 *	NULL, on error\r
 *		if lenp is non-NULL, *lenp contains an error code (<0):\r
 *		-FDT_ERR_NOTFOUND, node does not have named property\r
 *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *		-FDT_ERR_BADMAGIC,\r
 *		-FDT_ERR_BADVERSION,\r
 *		-FDT_ERR_BADSTATE,\r
 *		-FDT_ERR_BADSTRUCTURE,\r
 *		-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
const struct fdt_property *fdt_get_property(const void *fdt, int nodeoffset,\r
					    const char *name, int *lenp);\r
static inline struct fdt_property *fdt_get_property_w(void *fdt, int nodeoffset,\r
						      const char *name,\r
						      int *lenp)\r
{\r
	return (struct fdt_property *)(uintptr_t)\r
		fdt_get_property(fdt, nodeoffset, name, lenp);\r
}\r
\r
/**\r
 * fdt_getprop_by_offset - retrieve the value of a property at a given offset\r
 * @fdt: pointer to the device tree blob\r
 * @ffset: offset of the property to read\r
 * @namep: pointer to a string variable (will be overwritten) or NULL\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * fdt_getprop_by_offset() retrieves a pointer to the value of the\r
 * property at structure block offset 'offset' (this will be a pointer\r
 * to within the device blob itself, not a copy of the value).  If\r
 * lenp is non-NULL, the length of the property value is also\r
 * returned, in the integer pointed to by lenp.  If namep is non-NULL,\r
 * the property's namne will also be returned in the char * pointed to\r
 * by namep (this will be a pointer to within the device tree's string\r
 * block, not a new copy of the name).\r
 *\r
 * returns:\r
 *	pointer to the property's value\r
 *		if lenp is non-NULL, *lenp contains the length of the property\r
 *		value (>=0)\r
 *		if namep is non-NULL *namep contiains a pointer to the property\r
 *		name.\r
 *	NULL, on error\r
 *		if lenp is non-NULL, *lenp contains an error code (<0):\r
 *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag\r
 *		-FDT_ERR_BADMAGIC,\r
 *		-FDT_ERR_BADVERSION,\r
 *		-FDT_ERR_BADSTATE,\r
 *		-FDT_ERR_BADSTRUCTURE,\r
 *		-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
const void *fdt_getprop_by_offset(const void *fdt, int offset,\r
				  const char **namep, int *lenp);\r
\r
/**\r
 * fdt_getprop_namelen - get property value based on substring\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to find\r
 * @name: name of the property to find\r
 * @namelen: number of characters of name to consider\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * Identical to fdt_getprop(), but only examine the first namelen\r
 * characters of name for matching the property name.\r
 */\r
const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,\r
				const char *name, int namelen, int *lenp);\r
\r
/**\r
 * fdt_getprop - retrieve the value of a given property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to find\r
 * @name: name of the property to find\r
 * @lenp: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * fdt_getprop() retrieves a pointer to the value of the property\r
 * named 'name' of the node at offset nodeoffset (this will be a\r
 * pointer to within the device blob itself, not a copy of the value).\r
 * If lenp is non-NULL, the length of the property value is also\r
 * returned, in the integer pointed to by lenp.\r
 *\r
 * returns:\r
 *	pointer to the property's value\r
 *		if lenp is non-NULL, *lenp contains the length of the property\r
 *		value (>=0)\r
 *	NULL, on error\r
 *		if lenp is non-NULL, *lenp contains an error code (<0):\r
 *		-FDT_ERR_NOTFOUND, node does not have named property\r
 *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *		-FDT_ERR_BADMAGIC,\r
 *		-FDT_ERR_BADVERSION,\r
 *		-FDT_ERR_BADSTATE,\r
 *		-FDT_ERR_BADSTRUCTURE,\r
 *		-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
const void *fdt_getprop(const void *fdt, int nodeoffset,\r
			const char *name, int *lenp);\r
static inline void *fdt_getprop_w(void *fdt, int nodeoffset,\r
				  const char *name, int *lenp)\r
{\r
	return (void *)(uintptr_t)fdt_getprop(fdt, nodeoffset, name, lenp);\r
}\r
\r
/**\r
 * fdt_get_phandle - retrieve the phandle of a given node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: structure block offset of the node\r
 *\r
 * fdt_get_phandle() retrieves the phandle of the device tree node at\r
 * structure block offset nodeoffset.\r
 *\r
 * returns:\r
 *	the phandle of the node at nodeoffset, on success (!= 0, != -1)\r
 *	0, if the node has no phandle, or another error occurs\r
 */\r
uint32_t fdt_get_phandle(const void *fdt, int nodeoffset);\r
\r
/**\r
 * fdt_get_alias_namelen - get alias based on substring\r
 * @fdt: pointer to the device tree blob\r
 * @name: name of the alias th look up\r
 * @namelen: number of characters of name to consider\r
 *\r
 * Identical to fdt_get_alias(), but only examine the first namelen\r
 * characters of name for matching the alias name.\r
 */\r
const char *fdt_get_alias_namelen(const void *fdt,\r
				  const char *name, int namelen);\r
\r
/**\r
 * fdt_get_alias - retreive the path referenced by a given alias\r
 * @fdt: pointer to the device tree blob\r
 * @name: name of the alias th look up\r
 *\r
 * fdt_get_alias() retrieves the value of a given alias.  That is, the\r
 * value of the property named 'name' in the node /aliases.\r
 *\r
 * returns:\r
 *	a pointer to the expansion of the alias named 'name', if it exists\r
 *	NULL, if the given alias or the /aliases node does not exist\r
 */\r
const char *fdt_get_alias(const void *fdt, const char *name);\r
\r
/**\r
 * fdt_get_path - determine the full path of a node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose path to find\r
 * @buf: character buffer to contain the returned path (will be overwritten)\r
 * @buflen: size of the character buffer at buf\r
 *\r
 * fdt_get_path() computes the full path of the node at offset\r
 * nodeoffset, and records that path in the buffer at buf.\r
 *\r
 * NOTE: This function is expensive, as it must scan the device tree\r
 * structure from the start to nodeoffset.\r
 *\r
 * returns:\r
 *	0, on success\r
 *		buf contains the absolute path of the node at\r
 *		nodeoffset, as a NUL-terminated string.\r
 * 	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag\r
 *	-FDT_ERR_NOSPACE, the path of the given node is longer than (bufsize-1)\r
 *		characters and will not fit in the given buffer.\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen);\r
\r
/**\r
 * fdt_supernode_atdepth_offset - find a specific ancestor of a node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose parent to find\r
 * @supernodedepth: depth of the ancestor to find\r
 * @nodedepth: pointer to an integer variable (will be overwritten) or NULL\r
 *\r
 * fdt_supernode_atdepth_offset() finds an ancestor of the given node\r
 * at a specific depth from the root (where the root itself has depth\r
 * 0, its immediate subnodes depth 1 and so forth).  So\r
 *	fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, NULL);\r
 * will always return 0, the offset of the root node.  If the node at\r
 * nodeoffset has depth D, then:\r
 *	fdt_supernode_atdepth_offset(fdt, nodeoffset, D, NULL);\r
 * will return nodeoffset itself.\r
 *\r
 * NOTE: This function is expensive, as it must scan the device tree\r
 * structure from the start to nodeoffset.\r
 *\r
 * returns:\r
\r
 *	structure block offset of the node at node offset's ancestor\r
 *		of depth supernodedepth (>=0), on success\r
 * 	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag\r
*	-FDT_ERR_NOTFOUND, supernodedepth was greater than the depth of nodeoffset\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,\r
				 int supernodedepth, int *nodedepth);\r
\r
/**\r
 * fdt_node_depth - find the depth of a given node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose parent to find\r
 *\r
 * fdt_node_depth() finds the depth of a given node.  The root node\r
 * has depth 0, its immediate subnodes depth 1 and so forth.\r
 *\r
 * NOTE: This function is expensive, as it must scan the device tree\r
 * structure from the start to nodeoffset.\r
 *\r
 * returns:\r
 *	depth of the node at nodeoffset (>=0), on success\r
 * 	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_node_depth(const void *fdt, int nodeoffset);\r
\r
/**\r
 * fdt_parent_offset - find the parent of a given node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose parent to find\r
 *\r
 * fdt_parent_offset() locates the parent node of a given node (that\r
 * is, it finds the offset of the node which contains the node at\r
 * nodeoffset as a subnode).\r
 *\r
 * NOTE: This function is expensive, as it must scan the device tree\r
 * structure from the start to nodeoffset, *twice*.\r
 *\r
 * returns:\r
 *	structure block offset of the parent of the node at nodeoffset\r
 *		(>=0), on success\r
 * 	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_parent_offset(const void *fdt, int nodeoffset);\r
\r
/**\r
 * fdt_node_offset_by_prop_value - find nodes with a given property value\r
 * @fdt: pointer to the device tree blob\r
 * @startoffset: only find nodes after this offset\r
 * @propname: property name to check\r
 * @propval: property value to search for\r
 * @proplen: length of the value in propval\r
 *\r
 * fdt_node_offset_by_prop_value() returns the offset of the first\r
 * node after startoffset, which has a property named propname whose\r
 * value is of length proplen and has value equal to propval; or if\r
 * startoffset is -1, the very first such node in the tree.\r
 *\r
 * To iterate through all nodes matching the criterion, the following\r
 * idiom can be used:\r
 *	offset = fdt_node_offset_by_prop_value(fdt, -1, propname,\r
 *					       propval, proplen);\r
 *	while (offset != -FDT_ERR_NOTFOUND) {\r
 *		// other code here\r
 *		offset = fdt_node_offset_by_prop_value(fdt, offset, propname,\r
 *						       propval, proplen);\r
 *	}\r
 *\r
 * Note the -1 in the first call to the function, if 0 is used here\r
 * instead, the function will never locate the root node, even if it\r
 * matches the criterion.\r
 *\r
 * returns:\r
 *	structure block offset of the located node (>= 0, >startoffset),\r
 *		 on success\r
 *	-FDT_ERR_NOTFOUND, no node matching the criterion exists in the\r
 *		tree after startoffset\r
 * 	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,\r
				  const char *propname,\r
				  const void *propval, int proplen);\r
\r
/**\r
 * fdt_node_offset_by_phandle - find the node with a given phandle\r
 * @fdt: pointer to the device tree blob\r
 * @phandle: phandle value\r
 *\r
 * fdt_node_offset_by_phandle() returns the offset of the node\r
 * which has the given phandle value.  If there is more than one node\r
 * in the tree with the given phandle (an invalid tree), results are\r
 * undefined.\r
 *\r
 * returns:\r
 *	structure block offset of the located node (>= 0), on success\r
 *	-FDT_ERR_NOTFOUND, no node with that phandle exists\r
 *	-FDT_ERR_BADPHANDLE, given phandle value was invalid (0 or -1)\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle);\r
\r
/**\r
 * fdt_node_check_compatible: check a node's compatible property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of a tree node\r
 * @compatible: string to match against\r
 *\r
 *\r
 * fdt_node_check_compatible() returns 0 if the given node contains a\r
 * 'compatible' property with the given string as one of its elements,\r
 * it returns non-zero otherwise, or on error.\r
 *\r
 * returns:\r
 *	0, if the node has a 'compatible' property listing the given string\r
 *	1, if the node has a 'compatible' property, but it does not list\r
 *		the given string\r
 *	-FDT_ERR_NOTFOUND, if the given node has no 'compatible' property\r
 * 	-FDT_ERR_BADOFFSET, if nodeoffset does not refer to a BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_node_check_compatible(const void *fdt, int nodeoffset,\r
			      const char *compatible);\r
\r
/**\r
 * fdt_node_offset_by_compatible - find nodes with a given 'compatible' value\r
 * @fdt: pointer to the device tree blob\r
 * @startoffset: only find nodes after this offset\r
 * @compatible: 'compatible' string to match against\r
 *\r
 * fdt_node_offset_by_compatible() returns the offset of the first\r
 * node after startoffset, which has a 'compatible' property which\r
 * lists the given compatible string; or if startoffset is -1, the\r
 * very first such node in the tree.\r
 *\r
 * To iterate through all nodes matching the criterion, the following\r
 * idiom can be used:\r
 *	offset = fdt_node_offset_by_compatible(fdt, -1, compatible);\r
 *	while (offset != -FDT_ERR_NOTFOUND) {\r
 *		// other code here\r
 *		offset = fdt_node_offset_by_compatible(fdt, offset, compatible);\r
 *	}\r
 *\r
 * Note the -1 in the first call to the function, if 0 is used here\r
 * instead, the function will never locate the root node, even if it\r
 * matches the criterion.\r
 *\r
 * returns:\r
 *	structure block offset of the located node (>= 0, >startoffset),\r
 *		 on success\r
 *	-FDT_ERR_NOTFOUND, no node matching the criterion exists in the\r
 *		tree after startoffset\r
 * 	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE, standard meanings\r
 */\r
int fdt_node_offset_by_compatible(const void *fdt, int startoffset,\r
				  const char *compatible);\r
\r
/**\r
 * fdt_stringlist_contains - check a string list property for a string\r
 * @strlist: Property containing a list of strings to check\r
 * @listlen: Length of property\r
 * @str: String to search for\r
 *\r
 * This is a utility function provided for convenience. The list contains\r
 * one or more strings, each terminated by \0, as is found in a device tree\r
 * "compatible" property.\r
 *\r
 * @return: 1 if the string is found in the list, 0 not found, or invalid list\r
 */\r
int fdt_stringlist_contains(const char *strlist, int listlen, const char *str);\r
\r
/**********************************************************************/\r
/* Write-in-place functions                                           */\r
/**********************************************************************/\r
\r
/**\r
 * fdt_setprop_inplace - change a property's value, but not its size\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: pointer to data to replace the property value with\r
 * @len: length of the property value\r
 *\r
 * fdt_setprop_inplace() replaces the value of a given property with\r
 * the data in val, of length len.  This function cannot change the\r
 * size of a property, and so will only work if len is equal to the\r
 * current length of the property.\r
 *\r
 * This function will alter only the bytes in the blob which contain\r
 * the given property value, and will not alter or move any other part\r
 * of the tree.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, if len is not equal to the property's current length\r
 *	-FDT_ERR_NOTFOUND, node does not have the named property\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,\r
			const void *val, int len);\r
\r
/**\r
 * fdt_setprop_inplace_u32 - change the value of a 32-bit integer property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: 32-bit integer value to replace the property with\r
 *\r
 * fdt_setprop_inplace_u32() replaces the value of a given property\r
 * with the 32-bit integer value in val, converting val to big-endian\r
 * if necessary.  This function cannot change the size of a property,\r
 * and so will only work if the property already exists and has length\r
 * 4.\r
 *\r
 * This function will alter only the bytes in the blob which contain\r
 * the given property value, and will not alter or move any other part\r
 * of the tree.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, if the property's length is not equal to 4\r
 *	-FDT_ERR_NOTFOUND, node does not have the named property\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
static inline int fdt_setprop_inplace_u32(void *fdt, int nodeoffset,\r
					  const char *name, uint32_t val)\r
{\r
	fdt32_t tmp = cpu_to_fdt32(val);\r
	return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));\r
}\r
\r
/**\r
 * fdt_setprop_inplace_u64 - change the value of a 64-bit integer property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: 64-bit integer value to replace the property with\r
 *\r
 * fdt_setprop_inplace_u64() replaces the value of a given property\r
 * with the 64-bit integer value in val, converting val to big-endian\r
 * if necessary.  This function cannot change the size of a property,\r
 * and so will only work if the property already exists and has length\r
 * 8.\r
 *\r
 * This function will alter only the bytes in the blob which contain\r
 * the given property value, and will not alter or move any other part\r
 * of the tree.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, if the property's length is not equal to 8\r
 *	-FDT_ERR_NOTFOUND, node does not have the named property\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
static inline int fdt_setprop_inplace_u64(void *fdt, int nodeoffset,\r
					  const char *name, uint64_t val)\r
{\r
	fdt64_t tmp = cpu_to_fdt64(val);\r
	return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));\r
}\r
\r
/**\r
 * fdt_setprop_inplace_cell - change the value of a single-cell property\r
 *\r
 * This is an alternative name for fdt_setprop_inplace_u32()\r
 */\r
static inline int fdt_setprop_inplace_cell(void *fdt, int nodeoffset,\r
					   const char *name, uint32_t val)\r
{\r
	return fdt_setprop_inplace_u32(fdt, nodeoffset, name, val);\r
}\r
\r
/**\r
 * fdt_nop_property - replace a property with nop tags\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to nop\r
 * @name: name of the property to nop\r
 *\r
 * fdt_nop_property() will replace a given property's representation\r
 * in the blob with FDT_NOP tags, effectively removing it from the\r
 * tree.\r
 *\r
 * This function will alter only the bytes in the blob which contain\r
 * the property, and will not alter or move any other part of the\r
 * tree.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOTFOUND, node does not have the named property\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_nop_property(void *fdt, int nodeoffset, const char *name);\r
\r
/**\r
 * fdt_nop_node - replace a node (subtree) with nop tags\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node to nop\r
 *\r
 * fdt_nop_node() will replace a given node's representation in the\r
 * blob, including all its subnodes, if any, with FDT_NOP tags,\r
 * effectively removing it from the tree.\r
 *\r
 * This function will alter only the bytes in the blob which contain\r
 * the node and its properties and subnodes, and will not alter or\r
 * move any other part of the tree.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_nop_node(void *fdt, int nodeoffset);\r
\r
/**********************************************************************/\r
/* Sequential write functions                                         */\r
/**********************************************************************/\r
\r
int fdt_create(void *buf, int bufsize);\r
int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size);\r
int fdt_finish_reservemap(void *fdt);\r
int fdt_begin_node(void *fdt, const char *name);\r
int fdt_property(void *fdt, const char *name, const void *val, int len);\r
static inline int fdt_property_u32(void *fdt, const char *name, uint32_t val)\r
{\r
	fdt32_t tmp = cpu_to_fdt32(val);\r
	return fdt_property(fdt, name, &tmp, sizeof(tmp));\r
}\r
static inline int fdt_property_u64(void *fdt, const char *name, uint64_t val)\r
{\r
	fdt64_t tmp = cpu_to_fdt64(val);\r
	return fdt_property(fdt, name, &tmp, sizeof(tmp));\r
}\r
static inline int fdt_property_cell(void *fdt, const char *name, uint32_t val)\r
{\r
	return fdt_property_u32(fdt, name, val);\r
}\r
#define fdt_property_string(fdt, name, str) \\r
	fdt_property(fdt, name, str, strlen(str)+1)\r
int fdt_end_node(void *fdt);\r
int fdt_finish(void *fdt);\r
\r
/**********************************************************************/\r
/* Read-write functions                                               */\r
/**********************************************************************/\r
\r
int fdt_create_empty_tree(void *buf, int bufsize);\r
int fdt_open_into(const void *fdt, void *buf, int bufsize);\r
int fdt_pack(void *fdt);\r
\r
/**\r
 * fdt_add_mem_rsv - add one memory reserve map entry\r
 * @fdt: pointer to the device tree blob\r
 * @address, @size: 64-bit values (native endian)\r
 *\r
 * Adds a reserve map entry to the given blob reserving a region at\r
 * address address of length size.\r
 *\r
 * This function will insert data into the reserve map and will\r
 * therefore change the indexes of some entries in the table.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new reservation entry\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size);\r
\r
/**\r
 * fdt_del_mem_rsv - remove a memory reserve map entry\r
 * @fdt: pointer to the device tree blob\r
 * @n: entry to remove\r
 *\r
 * fdt_del_mem_rsv() removes the n-th memory reserve map entry from\r
 * the blob.\r
 *\r
 * This function will delete data from the reservation table and will\r
 * therefore change the indexes of some entries in the table.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOTFOUND, there is no entry of the given index (i.e. there\r
 *		are less than n+1 reserve map entries)\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_del_mem_rsv(void *fdt, int n);\r
\r
/**\r
 * fdt_set_name - change the name of a given node\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: structure block offset of a node\r
 * @name: name to give the node\r
 *\r
 * fdt_set_name() replaces the name (including unit address, if any)\r
 * of the given node with the given string.  NOTE: this function can't\r
 * efficiently check if the new name is unique amongst the given\r
 * node's siblings; results are undefined if this function is invoked\r
 * with a name equal to one of the given node's siblings.\r
 *\r
 * This function may insert or delete data from the blob, and will\r
 * therefore change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob\r
 *		to contain the new name\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE, standard meanings\r
 */\r
int fdt_set_name(void *fdt, int nodeoffset, const char *name);\r
\r
/**\r
 * fdt_setprop - create or change a property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: pointer to data to set the property value to\r
 * @len: length of the property value\r
 *\r
 * fdt_setprop() sets the value of the named property in the given\r
 * node to the given value and length, creating the property if it\r
 * does not already exist.\r
 *\r
 * This function may insert or delete data from the blob, and will\r
 * therefore change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_setprop(void *fdt, int nodeoffset, const char *name,\r
		const void *val, int len);\r
\r
/**\r
 * fdt_setprop_u32 - set a property to a 32-bit integer\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: 32-bit integer value for the property (native endian)\r
 *\r
 * fdt_setprop_u32() sets the value of the named property in the given\r
 * node to the given 32-bit integer value (converting to big-endian if\r
 * necessary), or creates a new property with that value if it does\r
 * not already exist.\r
 *\r
 * This function may insert or delete data from the blob, and will\r
 * therefore change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
static inline int fdt_setprop_u32(void *fdt, int nodeoffset, const char *name,\r
				  uint32_t val)\r
{\r
	fdt32_t tmp = cpu_to_fdt32(val);\r
	return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));\r
}\r
\r
/**\r
 * fdt_setprop_u64 - set a property to a 64-bit integer\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: 64-bit integer value for the property (native endian)\r
 *\r
 * fdt_setprop_u64() sets the value of the named property in the given\r
 * node to the given 64-bit integer value (converting to big-endian if\r
 * necessary), or creates a new property with that value if it does\r
 * not already exist.\r
 *\r
 * This function may insert or delete data from the blob, and will\r
 * therefore change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
static inline int fdt_setprop_u64(void *fdt, int nodeoffset, const char *name,\r
				  uint64_t val)\r
{\r
	fdt64_t tmp = cpu_to_fdt64(val);\r
	return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));\r
}\r
\r
/**\r
 * fdt_setprop_cell - set a property to a single cell value\r
 *\r
 * This is an alternative name for fdt_setprop_u32()\r
 */\r
static inline int fdt_setprop_cell(void *fdt, int nodeoffset, const char *name,\r
				   uint32_t val)\r
{\r
	return fdt_setprop_u32(fdt, nodeoffset, name, val);\r
}\r
\r
/**\r
 * fdt_setprop_string - set a property to a string value\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @str: string value for the property\r
 *\r
 * fdt_setprop_string() sets the value of the named property in the\r
 * given node to the given string value (using the length of the\r
 * string to determine the new length of the property), or creates a\r
 * new property with that value if it does not already exist.\r
 *\r
 * This function may insert or delete data from the blob, and will\r
 * therefore change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
#define fdt_setprop_string(fdt, nodeoffset, name, str) \\r
	fdt_setprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)\r
\r
/**\r
 * fdt_appendprop - append to or create a property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to append to\r
 * @val: pointer to data to append to the property value\r
 * @len: length of the data to append to the property value\r
 *\r
 * fdt_appendprop() appends the value to the named property in the\r
 * given node, creating the property if it does not already exist.\r
 *\r
 * This function may insert data into the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_appendprop(void *fdt, int nodeoffset, const char *name,\r
		   const void *val, int len);\r
\r
/**\r
 * fdt_appendprop_u32 - append a 32-bit integer value to a property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: 32-bit integer value to append to the property (native endian)\r
 *\r
 * fdt_appendprop_u32() appends the given 32-bit integer value\r
 * (converting to big-endian if necessary) to the value of the named\r
 * property in the given node, or creates a new property with that\r
 * value if it does not already exist.\r
 *\r
 * This function may insert data into the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
static inline int fdt_appendprop_u32(void *fdt, int nodeoffset,\r
				     const char *name, uint32_t val)\r
{\r
	fdt32_t tmp = cpu_to_fdt32(val);\r
	return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));\r
}\r
\r
/**\r
 * fdt_appendprop_u64 - append a 64-bit integer value to a property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @val: 64-bit integer value to append to the property (native endian)\r
 *\r
 * fdt_appendprop_u64() appends the given 64-bit integer value\r
 * (converting to big-endian if necessary) to the value of the named\r
 * property in the given node, or creates a new property with that\r
 * value if it does not already exist.\r
 *\r
 * This function may insert data into the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
static inline int fdt_appendprop_u64(void *fdt, int nodeoffset,\r
				     const char *name, uint64_t val)\r
{\r
	fdt64_t tmp = cpu_to_fdt64(val);\r
	return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));\r
}\r
\r
/**\r
 * fdt_appendprop_cell - append a single cell value to a property\r
 *\r
 * This is an alternative name for fdt_appendprop_u32()\r
 */\r
static inline int fdt_appendprop_cell(void *fdt, int nodeoffset,\r
				      const char *name, uint32_t val)\r
{\r
	return fdt_appendprop_u32(fdt, nodeoffset, name, val);\r
}\r
\r
/**\r
 * fdt_appendprop_string - append a string to a property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to change\r
 * @name: name of the property to change\r
 * @str: string value to append to the property\r
 *\r
 * fdt_appendprop_string() appends the given string to the value of\r
 * the named property in the given node, or creates a new property\r
 * with that value if it does not already exist.\r
 *\r
 * This function may insert data into the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to\r
 *		contain the new property value\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
#define fdt_appendprop_string(fdt, nodeoffset, name, str) \\r
	fdt_appendprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)\r
\r
/**\r
 * fdt_delprop - delete a property\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node whose property to nop\r
 * @name: name of the property to nop\r
 *\r
 * fdt_del_property() will delete the given property.\r
 *\r
 * This function will delete data from the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_NOTFOUND, node does not have the named property\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_delprop(void *fdt, int nodeoffset, const char *name);\r
\r
/**\r
 * fdt_add_subnode_namelen - creates a new node based on substring\r
 * @fdt: pointer to the device tree blob\r
 * @parentoffset: structure block offset of a node\r
 * @name: name of the subnode to locate\r
 * @namelen: number of characters of name to consider\r
 *\r
 * Identical to fdt_add_subnode(), but use only the first namelen\r
 * characters of name as the name of the new node.  This is useful for\r
 * creating subnodes based on a portion of a larger string, such as a\r
 * full path.\r
 */\r
int fdt_add_subnode_namelen(void *fdt, int parentoffset,\r
			    const char *name, int namelen);\r
\r
/**\r
 * fdt_add_subnode - creates a new node\r
 * @fdt: pointer to the device tree blob\r
 * @parentoffset: structure block offset of a node\r
 * @name: name of the subnode to locate\r
 *\r
 * fdt_add_subnode() creates a new node as a subnode of the node at\r
 * structure block offset parentoffset, with the given name (which\r
 * should include the unit address, if any).\r
 *\r
 * This function will insert data into the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
\r
 * returns:\r
 *	structure block offset of the created nodeequested subnode (>=0), on success\r
 *	-FDT_ERR_NOTFOUND, if the requested subnode does not exist\r
 *	-FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of\r
 *		the given name\r
 *	-FDT_ERR_NOSPACE, if there is insufficient free space in the\r
 *		blob to contain the new node\r
 *	-FDT_ERR_NOSPACE\r
 *	-FDT_ERR_BADLAYOUT\r
 *      -FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings.\r
 */\r
int fdt_add_subnode(void *fdt, int parentoffset, const char *name);\r
\r
/**\r
 * fdt_del_node - delete a node (subtree)\r
 * @fdt: pointer to the device tree blob\r
 * @nodeoffset: offset of the node to nop\r
 *\r
 * fdt_del_node() will remove the given node, including all its\r
 * subnodes if any, from the blob.\r
 *\r
 * This function will delete data from the blob, and will therefore\r
 * change the offsets of some existing nodes.\r
 *\r
 * returns:\r
 *	0, on success\r
 *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag\r
 *	-FDT_ERR_BADLAYOUT,\r
 *	-FDT_ERR_BADMAGIC,\r
 *	-FDT_ERR_BADVERSION,\r
 *	-FDT_ERR_BADSTATE,\r
 *	-FDT_ERR_BADSTRUCTURE,\r
 *	-FDT_ERR_TRUNCATED, standard meanings\r
 */\r
int fdt_del_node(void *fdt, int nodeoffset);\r
\r
/**********************************************************************/\r
/* Debugging / informational functions                                */\r
/**********************************************************************/\r
\r
const char *fdt_strerror(int errval);\r
\r
#endif /* _LIBFDT_H */\r