blob: a1ef1e15df3ddbd8abec45766b9f9038f334bcc1 [file] [log] [blame]
Kumar Gala8d04f022007-10-24 11:04:22 -05001#ifndef _LIBFDT_H
2#define _LIBFDT_H
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04003/*
4 * libfdt - Flat Device Tree manipulation
5 * Copyright (C) 2006 David Gibson, IBM Corporation.
6 *
Kumar Gala8d04f022007-10-24 11:04:22 -05007 * libfdt is dual licensed: you can use it either under the terms of
8 * the GPL, or the BSD license, at your option.
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04009 *
Kumar Gala8d04f022007-10-24 11:04:22 -050010 * 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.
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040014 *
Kumar Gala8d04f022007-10-24 11:04:22 -050015 * 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.
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040052 */
53
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040054#include <libfdt_env.h>
Kumar Gala8d04f022007-10-24 11:04:22 -050055#include <fdt.h>
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040056
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
Kumar Gala8d04f022007-10-24 11:04:22 -050062 /* FDT_ERR_NOTFOUND: The requested node or property does not exist */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040063#define FDT_ERR_EXISTS 2
Kumar Gala8d04f022007-10-24 11:04:22 -050064 /* FDT_ERR_EXISTS: Attemped to create a node or property which
65 * already exists */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040066#define FDT_ERR_NOSPACE 3
Kumar Gala8d04f022007-10-24 11:04:22 -050067 /* 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. */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040071
72/* Error codes: codes for bad parameters */
73#define FDT_ERR_BADOFFSET 4
Kumar Gala8d04f022007-10-24 11:04:22 -050074 /* 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. */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040077#define FDT_ERR_BADPATH 5
Kumar Gala8d04f022007-10-24 11:04:22 -050078 /* 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. */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -040088
89/* Error codes: codes for bad device tree blobs */
Kumar Gala8d04f022007-10-24 11:04:22 -050090#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. */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400112
Kumar Gala8d04f022007-10-24 11:04:22 -0500113/* "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
Simon Glass0596d352014-07-30 03:59:03 -0600119/* 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
Kumar Gala8d04f022007-10-24 11:04:22 -0500125
126/**********************************************************************/
127/* Low-level functions (you probably don't need these) */
128/**********************************************************************/
129
Jon Loeliger741a6d02008-09-25 11:02:17 -0500130const void *fdt_offset_ptr(const void *fdt, int offset, unsigned int checklen);
Kumar Gala8d04f022007-10-24 11:04:22 -0500131static inline void *fdt_offset_ptr_w(void *fdt, int offset, int checklen)
132{
David Gibsonc6683022008-07-07 10:14:15 +1000133 return (void *)(uintptr_t)fdt_offset_ptr(fdt, offset, checklen);
Kumar Gala8d04f022007-10-24 11:04:22 -0500134}
135
136uint32_t fdt_next_tag(const void *fdt, int offset, int *nextoffset);
137
138/**********************************************************************/
David Gibsonae0b5902008-02-12 11:58:31 +1100139/* Traversal functions */
140/**********************************************************************/
141
142int fdt_next_node(const void *fdt, int offset, int *depth);
143
Simon Glass88f95bb2013-05-07 06:11:50 +0000144/**
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 */
151int 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 */
164int fdt_next_subnode(const void *fdt, int offset);
165
David Gibsonae0b5902008-02-12 11:58:31 +1100166/**********************************************************************/
Kumar Gala8d04f022007-10-24 11:04:22 -0500167/* General functions */
168/**********************************************************************/
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400169
170#define fdt_get_header(fdt, field) \
Kumar Gala8d04f022007-10-24 11:04:22 -0500171 (fdt32_to_cpu(((const struct fdt_header *)(fdt))->field))
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200172#define fdt_magic(fdt) (fdt_get_header(fdt, magic))
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400173#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))
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200178#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))
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400181#define fdt_size_dt_struct(fdt) (fdt_get_header(fdt, size_dt_struct))
182
Kumar Gala8d04f022007-10-24 11:04:22 -0500183#define __fdt_set_hdr(name) \
184 static inline void fdt_set_##name(void *fdt, uint32_t val) \
185 { \
Laurent Gregoire67b89c72009-03-03 14:23:59 +0100186 struct fdt_header *fdth = (struct fdt_header*)fdt; \
Kumar Gala8d04f022007-10-24 11:04:22 -0500187 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
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400200
Kumar Gala8d04f022007-10-24 11:04:22 -0500201/**
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 */
Gerald Van Baren6679f922007-04-06 14:17:14 -0400215int fdt_check_header(const void *fdt);
216
Kumar Gala8d04f022007-10-24 11:04:22 -0500217/**
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 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400236int fdt_move(const void *fdt, void *buf, int bufsize);
237
Kumar Gala8d04f022007-10-24 11:04:22 -0500238/**********************************************************************/
239/* Read-only functions */
240/**********************************************************************/
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400241
Kumar Gala8d04f022007-10-24 11:04:22 -0500242/**
Wolfram Sang46390da2008-07-09 11:22:44 +0200243 * fdt_string - retrieve a string from the strings block of a device tree
Kumar Gala8d04f022007-10-24 11:04:22 -0500244 * @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 */
254const char *fdt_string(const void *fdt, int stroffset);
255
256/**
Wolfram Sang46390da2008-07-09 11:22:44 +0200257 * fdt_num_mem_rsv - retrieve the number of memory reserve map entries
Kumar Gala8d04f022007-10-24 11:04:22 -0500258 * @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 */
267int fdt_num_mem_rsv(const void *fdt);
268
269/**
Wolfram Sang46390da2008-07-09 11:22:44 +0200270 * fdt_get_mem_rsv - retrieve one memory reserve map entry
Kumar Gala8d04f022007-10-24 11:04:22 -0500271 * @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 */
284int 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 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400298int fdt_subnode_offset_namelen(const void *fdt, int parentoffset,
299 const char *name, int namelen);
Kumar Gala8d04f022007-10-24 11:04:22 -0500300/**
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 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400323int fdt_subnode_offset(const void *fdt, int parentoffset, const char *name);
324
Kumar Gala8d04f022007-10-24 11:04:22 -0500325/**
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 */
347int fdt_path_offset(const void *fdt, const char *path);
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400348
Kumar Gala8d04f022007-10-24 11:04:22 -0500349/**
Wolfram Sang46390da2008-07-09 11:22:44 +0200350 * fdt_get_name - retrieve the name of a given node
Kumar Gala8d04f022007-10-24 11:04:22 -0500351 * @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 */
370const char *fdt_get_name(const void *fdt, int nodeoffset, int *lenp);
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400371
Kumar Gala8d04f022007-10-24 11:04:22 -0500372/**
David Gibsond1c63142010-03-09 17:39:14 +1100373 * 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 */
390int 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 */
411int 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 */
437const struct fdt_property *fdt_get_property_by_offset(const void *fdt,
438 int offset,
439 int *lenp);
440
441/**
David Gibson02193992008-08-06 14:50:49 +1000442 * 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 */
452const struct fdt_property *fdt_get_property_namelen(const void *fdt,
453 int nodeoffset,
454 const char *name,
455 int namelen, int *lenp);
456
457/**
Kumar Gala8d04f022007-10-24 11:04:22 -0500458 * 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
Wolfram Sang46390da2008-07-09 11:22:44 +0200467 * non-NULL, the length of the property value is also returned, in the
Kumar Gala8d04f022007-10-24 11:04:22 -0500468 * 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 */
484const struct fdt_property *fdt_get_property(const void *fdt, int nodeoffset,
485 const char *name, int *lenp);
486static inline struct fdt_property *fdt_get_property_w(void *fdt, int nodeoffset,
487 const char *name,
488 int *lenp)
489{
David Gibsonc6683022008-07-07 10:14:15 +1000490 return (struct fdt_property *)(uintptr_t)
491 fdt_get_property(fdt, nodeoffset, name, lenp);
Kumar Gala8d04f022007-10-24 11:04:22 -0500492}
Gerald Van Baren3af0d582007-03-31 12:13:43 -0400493
Kumar Gala8d04f022007-10-24 11:04:22 -0500494/**
David Gibsond1c63142010-03-09 17:39:14 +1100495 * 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 */
525const void *fdt_getprop_by_offset(const void *fdt, int offset,
526 const char **namep, int *lenp);
527
528/**
David Gibson02193992008-08-06 14:50:49 +1000529 * 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 */
539const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
540 const char *name, int namelen, int *lenp);
541
542/**
Kumar Gala8d04f022007-10-24 11:04:22 -0500543 * 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).
Wolfram Sang46390da2008-07-09 11:22:44 +0200552 * If lenp is non-NULL, the length of the property value is also
Kumar Gala8d04f022007-10-24 11:04:22 -0500553 * 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 */
569const void *fdt_getprop(const void *fdt, int nodeoffset,
570 const char *name, int *lenp);
571static inline void *fdt_getprop_w(void *fdt, int nodeoffset,
572 const char *name, int *lenp)
573{
David Gibsonc6683022008-07-07 10:14:15 +1000574 return (void *)(uintptr_t)fdt_getprop(fdt, nodeoffset, name, lenp);
Kumar Gala8d04f022007-10-24 11:04:22 -0500575}
576
577/**
Wolfram Sang46390da2008-07-09 11:22:44 +0200578 * fdt_get_phandle - retrieve the phandle of a given node
Kumar Gala8d04f022007-10-24 11:04:22 -0500579 * @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:
Wolfram Sang46390da2008-07-09 11:22:44 +0200586 * the phandle of the node at nodeoffset, on success (!= 0, != -1)
Kumar Gala8d04f022007-10-24 11:04:22 -0500587 * 0, if the node has no phandle, or another error occurs
588 */
589uint32_t fdt_get_phandle(const void *fdt, int nodeoffset);
590
591/**
Gerald Van Barencd3cb0d2008-10-04 07:56:06 -0400592 * fdt_get_alias_namelen - get alias based on substring
David Gibson9a6cf732008-08-20 16:55:14 +1000593 * @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 */
600const char *fdt_get_alias_namelen(const void *fdt,
601 const char *name, int namelen);
602
603/**
Simon Glass0596d352014-07-30 03:59:03 -0600604 * fdt_get_alias - retreive the path referenced by a given alias
David Gibson9a6cf732008-08-20 16:55:14 +1000605 * @fdt: pointer to the device tree blob
Simon Glass0596d352014-07-30 03:59:03 -0600606 * @name: name of the alias th look up
David Gibson9a6cf732008-08-20 16:55:14 +1000607 *
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:
François Revolc73bd492013-02-03 00:52:21 +0100612 * a pointer to the expansion of the alias named 'name', if it exists
David Gibson9a6cf732008-08-20 16:55:14 +1000613 * NULL, if the given alias or the /aliases node does not exist
614 */
615const char *fdt_get_alias(const void *fdt, const char *name);
616
617/**
Kumar Gala8d04f022007-10-24 11:04:22 -0500618 * 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.
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200634 * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500635 * -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 */
642int 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
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200667 * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500668* -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 */
674int 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
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200690 * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500691 * -FDT_ERR_BADMAGIC,
692 * -FDT_ERR_BADVERSION,
693 * -FDT_ERR_BADSTATE,
694 * -FDT_ERR_BADSTRUCTURE, standard meanings
695 */
696int 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:
Wolfram Sang46390da2008-07-09 11:22:44 +0200711 * structure block offset of the parent of the node at nodeoffset
Kumar Gala8d04f022007-10-24 11:04:22 -0500712 * (>=0), on success
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200713 * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500714 * -FDT_ERR_BADMAGIC,
715 * -FDT_ERR_BADVERSION,
716 * -FDT_ERR_BADSTATE,
717 * -FDT_ERR_BADSTRUCTURE, standard meanings
718 */
719int 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) {
Simon Glass0596d352014-07-30 03:59:03 -0600739 * // other code here
Kumar Gala8d04f022007-10-24 11:04:22 -0500740 * 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
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200753 * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500754 * -FDT_ERR_BADMAGIC,
755 * -FDT_ERR_BADVERSION,
756 * -FDT_ERR_BADSTATE,
757 * -FDT_ERR_BADSTRUCTURE, standard meanings
758 */
759int 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 *
Wolfram Sang46390da2008-07-09 11:22:44 +0200768 * fdt_node_offset_by_phandle() returns the offset of the node
Kumar Gala8d04f022007-10-24 11:04:22 -0500769 * 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 */
782int 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
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200800 * -FDT_ERR_BADOFFSET, if nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500801 * -FDT_ERR_BADMAGIC,
802 * -FDT_ERR_BADVERSION,
803 * -FDT_ERR_BADSTATE,
804 * -FDT_ERR_BADSTRUCTURE, standard meanings
805 */
806int 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) {
Simon Glass0596d352014-07-30 03:59:03 -0600824 * // other code here
Kumar Gala8d04f022007-10-24 11:04:22 -0500825 * 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
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200837 * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
Kumar Gala8d04f022007-10-24 11:04:22 -0500838 * -FDT_ERR_BADMAGIC,
839 * -FDT_ERR_BADVERSION,
840 * -FDT_ERR_BADSTATE,
841 * -FDT_ERR_BADSTRUCTURE, standard meanings
842 */
843int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
844 const char *compatible);
845
Simon Glasse853b322013-01-21 12:59:18 -0800846/**
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 */
858int fdt_stringlist_contains(const char *strlist, int listlen, const char *str);
859
Kumar Gala8d04f022007-10-24 11:04:22 -0500860/**********************************************************************/
Simon Glass0596d352014-07-30 03:59:03 -0600861/* Read-only functions (addressing related) */
862/**********************************************************************/
863
864/**
865 * FDT_MAX_NCELLS - maximum value for #address-cells and #size-cells
866 *
867 * This is the maximum value for #address-cells, #size-cells and
868 * similar properties that will be processed by libfdt. IEE1275
869 * requires that OF implementations handle values up to 4.
870 * Implementations may support larger values, but in practice higher
871 * values aren't used.
872 */
873#define FDT_MAX_NCELLS 4
874
875/**
876 * fdt_address_cells - retrieve address size for a bus represented in the tree
877 * @fdt: pointer to the device tree blob
878 * @nodeoffset: offset of the node to find the address size for
879 *
880 * When the node has a valid #address-cells property, returns its value.
881 *
882 * returns:
883 * 0 <= n < FDT_MAX_NCELLS, on success
884 * 2, if the node has no #address-cells property
885 * -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
886 * #address-cells property
887 * -FDT_ERR_BADMAGIC,
888 * -FDT_ERR_BADVERSION,
889 * -FDT_ERR_BADSTATE,
890 * -FDT_ERR_BADSTRUCTURE,
891 * -FDT_ERR_TRUNCATED, standard meanings
892 */
893int fdt_address_cells(const void *fdt, int nodeoffset);
894
895/**
896 * fdt_size_cells - retrieve address range size for a bus represented in the
897 * tree
898 * @fdt: pointer to the device tree blob
899 * @nodeoffset: offset of the node to find the address range size for
900 *
901 * When the node has a valid #size-cells property, returns its value.
902 *
903 * returns:
904 * 0 <= n < FDT_MAX_NCELLS, on success
905 * 2, if the node has no #address-cells property
906 * -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
907 * #size-cells property
908 * -FDT_ERR_BADMAGIC,
909 * -FDT_ERR_BADVERSION,
910 * -FDT_ERR_BADSTATE,
911 * -FDT_ERR_BADSTRUCTURE,
912 * -FDT_ERR_TRUNCATED, standard meanings
913 */
914int fdt_size_cells(const void *fdt, int nodeoffset);
915
916
917/**********************************************************************/
Kumar Gala8d04f022007-10-24 11:04:22 -0500918/* Write-in-place functions */
919/**********************************************************************/
920
David Gibson9d4450b2007-12-17 14:41:52 +1100921/**
922 * fdt_setprop_inplace - change a property's value, but not its size
923 * @fdt: pointer to the device tree blob
924 * @nodeoffset: offset of the node whose property to change
925 * @name: name of the property to change
926 * @val: pointer to data to replace the property value with
927 * @len: length of the property value
928 *
929 * fdt_setprop_inplace() replaces the value of a given property with
930 * the data in val, of length len. This function cannot change the
931 * size of a property, and so will only work if len is equal to the
932 * current length of the property.
933 *
934 * This function will alter only the bytes in the blob which contain
935 * the given property value, and will not alter or move any other part
936 * of the tree.
937 *
938 * returns:
939 * 0, on success
940 * -FDT_ERR_NOSPACE, if len is not equal to the property's current length
941 * -FDT_ERR_NOTFOUND, node does not have the named property
942 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
943 * -FDT_ERR_BADMAGIC,
944 * -FDT_ERR_BADVERSION,
945 * -FDT_ERR_BADSTATE,
946 * -FDT_ERR_BADSTRUCTURE,
947 * -FDT_ERR_TRUNCATED, standard meanings
948 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400949int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,
950 const void *val, int len);
David Gibson9d4450b2007-12-17 14:41:52 +1100951
952/**
David Gibson24fa0e52012-08-27 19:39:00 -0500953 * fdt_setprop_inplace_u32 - change the value of a 32-bit integer property
David Gibson9d4450b2007-12-17 14:41:52 +1100954 * @fdt: pointer to the device tree blob
955 * @nodeoffset: offset of the node whose property to change
956 * @name: name of the property to change
David Gibson24fa0e52012-08-27 19:39:00 -0500957 * @val: 32-bit integer value to replace the property with
David Gibson9d4450b2007-12-17 14:41:52 +1100958 *
David Gibson24fa0e52012-08-27 19:39:00 -0500959 * fdt_setprop_inplace_u32() replaces the value of a given property
960 * with the 32-bit integer value in val, converting val to big-endian
961 * if necessary. This function cannot change the size of a property,
962 * and so will only work if the property already exists and has length
963 * 4.
David Gibson9d4450b2007-12-17 14:41:52 +1100964 *
965 * This function will alter only the bytes in the blob which contain
966 * the given property value, and will not alter or move any other part
967 * of the tree.
968 *
969 * returns:
970 * 0, on success
971 * -FDT_ERR_NOSPACE, if the property's length is not equal to 4
David Gibson24fa0e52012-08-27 19:39:00 -0500972 * -FDT_ERR_NOTFOUND, node does not have the named property
David Gibson9d4450b2007-12-17 14:41:52 +1100973 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
974 * -FDT_ERR_BADMAGIC,
975 * -FDT_ERR_BADVERSION,
976 * -FDT_ERR_BADSTATE,
977 * -FDT_ERR_BADSTRUCTURE,
978 * -FDT_ERR_TRUNCATED, standard meanings
979 */
David Gibson24fa0e52012-08-27 19:39:00 -0500980static inline int fdt_setprop_inplace_u32(void *fdt, int nodeoffset,
981 const char *name, uint32_t val)
Kumar Gala8d04f022007-10-24 11:04:22 -0500982{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +0000983 fdt32_t tmp = cpu_to_fdt32(val);
984 return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));
Kumar Gala8d04f022007-10-24 11:04:22 -0500985}
Gerald Van Baren7cd5da02007-03-31 11:59:59 -0400986
David Gibson9d4450b2007-12-17 14:41:52 +1100987/**
David Gibson24fa0e52012-08-27 19:39:00 -0500988 * fdt_setprop_inplace_u64 - change the value of a 64-bit integer property
989 * @fdt: pointer to the device tree blob
990 * @nodeoffset: offset of the node whose property to change
991 * @name: name of the property to change
992 * @val: 64-bit integer value to replace the property with
993 *
994 * fdt_setprop_inplace_u64() replaces the value of a given property
995 * with the 64-bit integer value in val, converting val to big-endian
996 * if necessary. This function cannot change the size of a property,
997 * and so will only work if the property already exists and has length
998 * 8.
999 *
1000 * This function will alter only the bytes in the blob which contain
1001 * the given property value, and will not alter or move any other part
1002 * of the tree.
1003 *
1004 * returns:
1005 * 0, on success
1006 * -FDT_ERR_NOSPACE, if the property's length is not equal to 8
1007 * -FDT_ERR_NOTFOUND, node does not have the named property
1008 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1009 * -FDT_ERR_BADMAGIC,
1010 * -FDT_ERR_BADVERSION,
1011 * -FDT_ERR_BADSTATE,
1012 * -FDT_ERR_BADSTRUCTURE,
1013 * -FDT_ERR_TRUNCATED, standard meanings
1014 */
1015static inline int fdt_setprop_inplace_u64(void *fdt, int nodeoffset,
1016 const char *name, uint64_t val)
1017{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001018 fdt64_t tmp = cpu_to_fdt64(val);
1019 return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));
David Gibson24fa0e52012-08-27 19:39:00 -05001020}
1021
1022/**
1023 * fdt_setprop_inplace_cell - change the value of a single-cell property
1024 *
1025 * This is an alternative name for fdt_setprop_inplace_u32()
1026 */
1027static inline int fdt_setprop_inplace_cell(void *fdt, int nodeoffset,
1028 const char *name, uint32_t val)
1029{
1030 return fdt_setprop_inplace_u32(fdt, nodeoffset, name, val);
1031}
1032
1033/**
David Gibson9d4450b2007-12-17 14:41:52 +11001034 * fdt_nop_property - replace a property with nop tags
1035 * @fdt: pointer to the device tree blob
1036 * @nodeoffset: offset of the node whose property to nop
1037 * @name: name of the property to nop
1038 *
1039 * fdt_nop_property() will replace a given property's representation
1040 * in the blob with FDT_NOP tags, effectively removing it from the
1041 * tree.
1042 *
1043 * This function will alter only the bytes in the blob which contain
1044 * the property, and will not alter or move any other part of the
1045 * tree.
1046 *
1047 * returns:
1048 * 0, on success
1049 * -FDT_ERR_NOTFOUND, node does not have the named property
1050 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1051 * -FDT_ERR_BADMAGIC,
1052 * -FDT_ERR_BADVERSION,
1053 * -FDT_ERR_BADSTATE,
1054 * -FDT_ERR_BADSTRUCTURE,
1055 * -FDT_ERR_TRUNCATED, standard meanings
1056 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001057int fdt_nop_property(void *fdt, int nodeoffset, const char *name);
David Gibson9d4450b2007-12-17 14:41:52 +11001058
1059/**
1060 * fdt_nop_node - replace a node (subtree) with nop tags
1061 * @fdt: pointer to the device tree blob
1062 * @nodeoffset: offset of the node to nop
1063 *
1064 * fdt_nop_node() will replace a given node's representation in the
1065 * blob, including all its subnodes, if any, with FDT_NOP tags,
1066 * effectively removing it from the tree.
1067 *
1068 * This function will alter only the bytes in the blob which contain
1069 * the node and its properties and subnodes, and will not alter or
1070 * move any other part of the tree.
1071 *
1072 * returns:
1073 * 0, on success
1074 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1075 * -FDT_ERR_BADMAGIC,
1076 * -FDT_ERR_BADVERSION,
1077 * -FDT_ERR_BADSTATE,
1078 * -FDT_ERR_BADSTRUCTURE,
1079 * -FDT_ERR_TRUNCATED, standard meanings
1080 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001081int fdt_nop_node(void *fdt, int nodeoffset);
Gerald Van Baren3f9f08c2007-04-14 22:46:41 -04001082
Kumar Gala8d04f022007-10-24 11:04:22 -05001083/**********************************************************************/
1084/* Sequential write functions */
1085/**********************************************************************/
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001086
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001087int fdt_create(void *buf, int bufsize);
Simon Glass0596d352014-07-30 03:59:03 -06001088int fdt_resize(void *fdt, void *buf, int bufsize);
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001089int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size);
1090int fdt_finish_reservemap(void *fdt);
1091int fdt_begin_node(void *fdt, const char *name);
1092int fdt_property(void *fdt, const char *name, const void *val, int len);
David Gibson24fa0e52012-08-27 19:39:00 -05001093static inline int fdt_property_u32(void *fdt, const char *name, uint32_t val)
Kumar Gala8d04f022007-10-24 11:04:22 -05001094{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001095 fdt32_t tmp = cpu_to_fdt32(val);
1096 return fdt_property(fdt, name, &tmp, sizeof(tmp));
Kumar Gala8d04f022007-10-24 11:04:22 -05001097}
David Gibson24fa0e52012-08-27 19:39:00 -05001098static inline int fdt_property_u64(void *fdt, const char *name, uint64_t val)
1099{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001100 fdt64_t tmp = cpu_to_fdt64(val);
1101 return fdt_property(fdt, name, &tmp, sizeof(tmp));
David Gibson24fa0e52012-08-27 19:39:00 -05001102}
1103static inline int fdt_property_cell(void *fdt, const char *name, uint32_t val)
1104{
1105 return fdt_property_u32(fdt, name, val);
1106}
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001107#define fdt_property_string(fdt, name, str) \
1108 fdt_property(fdt, name, str, strlen(str)+1)
1109int fdt_end_node(void *fdt);
1110int fdt_finish(void *fdt);
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001111
Kumar Gala8d04f022007-10-24 11:04:22 -05001112/**********************************************************************/
1113/* Read-write functions */
1114/**********************************************************************/
1115
Gerald Van Barenc71b64f2012-10-15 22:24:36 -04001116int fdt_create_empty_tree(void *buf, int bufsize);
Kumar Gala8d04f022007-10-24 11:04:22 -05001117int fdt_open_into(const void *fdt, void *buf, int bufsize);
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001118int fdt_pack(void *fdt);
1119
David Gibsonaec71352007-12-17 14:42:07 +11001120/**
1121 * fdt_add_mem_rsv - add one memory reserve map entry
1122 * @fdt: pointer to the device tree blob
Wolfram Sang46390da2008-07-09 11:22:44 +02001123 * @address, @size: 64-bit values (native endian)
David Gibsonaec71352007-12-17 14:42:07 +11001124 *
1125 * Adds a reserve map entry to the given blob reserving a region at
1126 * address address of length size.
1127 *
1128 * This function will insert data into the reserve map and will
Wolfram Sang46390da2008-07-09 11:22:44 +02001129 * therefore change the indexes of some entries in the table.
David Gibsonaec71352007-12-17 14:42:07 +11001130 *
1131 * returns:
1132 * 0, on success
1133 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1134 * contain the new reservation entry
1135 * -FDT_ERR_BADMAGIC,
1136 * -FDT_ERR_BADVERSION,
1137 * -FDT_ERR_BADSTATE,
1138 * -FDT_ERR_BADSTRUCTURE,
1139 * -FDT_ERR_BADLAYOUT,
1140 * -FDT_ERR_TRUNCATED, standard meanings
1141 */
Kumar Gala8d04f022007-10-24 11:04:22 -05001142int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size);
David Gibsonaec71352007-12-17 14:42:07 +11001143
1144/**
1145 * fdt_del_mem_rsv - remove a memory reserve map entry
1146 * @fdt: pointer to the device tree blob
1147 * @n: entry to remove
1148 *
1149 * fdt_del_mem_rsv() removes the n-th memory reserve map entry from
1150 * the blob.
1151 *
1152 * This function will delete data from the reservation table and will
Wolfram Sang46390da2008-07-09 11:22:44 +02001153 * therefore change the indexes of some entries in the table.
David Gibsonaec71352007-12-17 14:42:07 +11001154 *
1155 * returns:
1156 * 0, on success
1157 * -FDT_ERR_NOTFOUND, there is no entry of the given index (i.e. there
1158 * are less than n+1 reserve map entries)
1159 * -FDT_ERR_BADMAGIC,
1160 * -FDT_ERR_BADVERSION,
1161 * -FDT_ERR_BADSTATE,
1162 * -FDT_ERR_BADSTRUCTURE,
1163 * -FDT_ERR_BADLAYOUT,
1164 * -FDT_ERR_TRUNCATED, standard meanings
1165 */
Kumar Gala8d04f022007-10-24 11:04:22 -05001166int fdt_del_mem_rsv(void *fdt, int n);
1167
David Gibsonaec71352007-12-17 14:42:07 +11001168/**
David Gibson9eaeb072008-01-11 14:55:05 +11001169 * fdt_set_name - change the name of a given node
1170 * @fdt: pointer to the device tree blob
1171 * @nodeoffset: structure block offset of a node
1172 * @name: name to give the node
1173 *
1174 * fdt_set_name() replaces the name (including unit address, if any)
1175 * of the given node with the given string. NOTE: this function can't
1176 * efficiently check if the new name is unique amongst the given
1177 * node's siblings; results are undefined if this function is invoked
1178 * with a name equal to one of the given node's siblings.
1179 *
1180 * This function may insert or delete data from the blob, and will
1181 * therefore change the offsets of some existing nodes.
1182 *
1183 * returns:
1184 * 0, on success
1185 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob
1186 * to contain the new name
1187 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1188 * -FDT_ERR_BADMAGIC,
1189 * -FDT_ERR_BADVERSION,
1190 * -FDT_ERR_BADSTATE, standard meanings
1191 */
1192int fdt_set_name(void *fdt, int nodeoffset, const char *name);
1193
1194/**
David Gibsonaec71352007-12-17 14:42:07 +11001195 * fdt_setprop - create or change a property
1196 * @fdt: pointer to the device tree blob
1197 * @nodeoffset: offset of the node whose property to change
1198 * @name: name of the property to change
1199 * @val: pointer to data to set the property value to
1200 * @len: length of the property value
1201 *
1202 * fdt_setprop() sets the value of the named property in the given
Wolfram Sang46390da2008-07-09 11:22:44 +02001203 * node to the given value and length, creating the property if it
David Gibsonaec71352007-12-17 14:42:07 +11001204 * does not already exist.
1205 *
1206 * This function may insert or delete data from the blob, and will
1207 * therefore change the offsets of some existing nodes.
1208 *
1209 * returns:
1210 * 0, on success
1211 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1212 * contain the new property value
1213 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1214 * -FDT_ERR_BADLAYOUT,
1215 * -FDT_ERR_BADMAGIC,
1216 * -FDT_ERR_BADVERSION,
1217 * -FDT_ERR_BADSTATE,
1218 * -FDT_ERR_BADSTRUCTURE,
1219 * -FDT_ERR_BADLAYOUT,
1220 * -FDT_ERR_TRUNCATED, standard meanings
1221 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001222int fdt_setprop(void *fdt, int nodeoffset, const char *name,
1223 const void *val, int len);
David Gibsonaec71352007-12-17 14:42:07 +11001224
1225/**
David Gibson24fa0e52012-08-27 19:39:00 -05001226 * fdt_setprop_u32 - set a property to a 32-bit integer
David Gibsonaec71352007-12-17 14:42:07 +11001227 * @fdt: pointer to the device tree blob
1228 * @nodeoffset: offset of the node whose property to change
1229 * @name: name of the property to change
1230 * @val: 32-bit integer value for the property (native endian)
1231 *
David Gibson24fa0e52012-08-27 19:39:00 -05001232 * fdt_setprop_u32() sets the value of the named property in the given
1233 * node to the given 32-bit integer value (converting to big-endian if
David Gibsonaec71352007-12-17 14:42:07 +11001234 * necessary), or creates a new property with that value if it does
1235 * not already exist.
1236 *
1237 * This function may insert or delete data from the blob, and will
1238 * therefore change the offsets of some existing nodes.
1239 *
1240 * returns:
1241 * 0, on success
1242 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1243 * contain the new property value
1244 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1245 * -FDT_ERR_BADLAYOUT,
1246 * -FDT_ERR_BADMAGIC,
1247 * -FDT_ERR_BADVERSION,
1248 * -FDT_ERR_BADSTATE,
1249 * -FDT_ERR_BADSTRUCTURE,
1250 * -FDT_ERR_BADLAYOUT,
1251 * -FDT_ERR_TRUNCATED, standard meanings
1252 */
David Gibson24fa0e52012-08-27 19:39:00 -05001253static inline int fdt_setprop_u32(void *fdt, int nodeoffset, const char *name,
1254 uint32_t val)
Kumar Gala8d04f022007-10-24 11:04:22 -05001255{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001256 fdt32_t tmp = cpu_to_fdt32(val);
1257 return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
Kumar Gala8d04f022007-10-24 11:04:22 -05001258}
David Gibsonaec71352007-12-17 14:42:07 +11001259
1260/**
David Gibson24fa0e52012-08-27 19:39:00 -05001261 * fdt_setprop_u64 - set a property to a 64-bit integer
1262 * @fdt: pointer to the device tree blob
1263 * @nodeoffset: offset of the node whose property to change
1264 * @name: name of the property to change
1265 * @val: 64-bit integer value for the property (native endian)
1266 *
1267 * fdt_setprop_u64() sets the value of the named property in the given
1268 * node to the given 64-bit integer value (converting to big-endian if
1269 * necessary), or creates a new property with that value if it does
1270 * not already exist.
1271 *
1272 * This function may insert or delete data from the blob, and will
1273 * therefore change the offsets of some existing nodes.
1274 *
1275 * returns:
1276 * 0, on success
1277 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1278 * contain the new property value
1279 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1280 * -FDT_ERR_BADLAYOUT,
1281 * -FDT_ERR_BADMAGIC,
1282 * -FDT_ERR_BADVERSION,
1283 * -FDT_ERR_BADSTATE,
1284 * -FDT_ERR_BADSTRUCTURE,
1285 * -FDT_ERR_BADLAYOUT,
1286 * -FDT_ERR_TRUNCATED, standard meanings
1287 */
1288static inline int fdt_setprop_u64(void *fdt, int nodeoffset, const char *name,
1289 uint64_t val)
1290{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001291 fdt64_t tmp = cpu_to_fdt64(val);
1292 return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
David Gibson24fa0e52012-08-27 19:39:00 -05001293}
1294
1295/**
1296 * fdt_setprop_cell - set a property to a single cell value
1297 *
1298 * This is an alternative name for fdt_setprop_u32()
1299 */
1300static inline int fdt_setprop_cell(void *fdt, int nodeoffset, const char *name,
1301 uint32_t val)
1302{
1303 return fdt_setprop_u32(fdt, nodeoffset, name, val);
1304}
1305
1306/**
David Gibsonaec71352007-12-17 14:42:07 +11001307 * fdt_setprop_string - set a property to a string value
1308 * @fdt: pointer to the device tree blob
1309 * @nodeoffset: offset of the node whose property to change
1310 * @name: name of the property to change
1311 * @str: string value for the property
1312 *
1313 * fdt_setprop_string() sets the value of the named property in the
1314 * given node to the given string value (using the length of the
1315 * string to determine the new length of the property), or creates a
1316 * new property with that value if it does not already exist.
1317 *
1318 * This function may insert or delete data from the blob, and will
1319 * therefore change the offsets of some existing nodes.
1320 *
1321 * returns:
1322 * 0, on success
1323 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1324 * contain the new property value
1325 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1326 * -FDT_ERR_BADLAYOUT,
1327 * -FDT_ERR_BADMAGIC,
1328 * -FDT_ERR_BADVERSION,
1329 * -FDT_ERR_BADSTATE,
1330 * -FDT_ERR_BADSTRUCTURE,
1331 * -FDT_ERR_BADLAYOUT,
1332 * -FDT_ERR_TRUNCATED, standard meanings
1333 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001334#define fdt_setprop_string(fdt, nodeoffset, name, str) \
1335 fdt_setprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
David Gibsonaec71352007-12-17 14:42:07 +11001336
1337/**
Minghuan Lian36ad18a2012-08-27 19:38:59 -05001338 * fdt_appendprop - append to or create a property
1339 * @fdt: pointer to the device tree blob
1340 * @nodeoffset: offset of the node whose property to change
1341 * @name: name of the property to append to
1342 * @val: pointer to data to append to the property value
1343 * @len: length of the data to append to the property value
1344 *
1345 * fdt_appendprop() appends the value to the named property in the
1346 * given node, creating the property if it does not already exist.
1347 *
1348 * This function may insert data into the blob, and will therefore
1349 * change the offsets of some existing nodes.
1350 *
1351 * returns:
1352 * 0, on success
1353 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1354 * contain the new property value
1355 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1356 * -FDT_ERR_BADLAYOUT,
1357 * -FDT_ERR_BADMAGIC,
1358 * -FDT_ERR_BADVERSION,
1359 * -FDT_ERR_BADSTATE,
1360 * -FDT_ERR_BADSTRUCTURE,
1361 * -FDT_ERR_BADLAYOUT,
1362 * -FDT_ERR_TRUNCATED, standard meanings
1363 */
1364int fdt_appendprop(void *fdt, int nodeoffset, const char *name,
1365 const void *val, int len);
1366
1367/**
David Gibson24fa0e52012-08-27 19:39:00 -05001368 * fdt_appendprop_u32 - append a 32-bit integer value to a property
Minghuan Lian36ad18a2012-08-27 19:38:59 -05001369 * @fdt: pointer to the device tree blob
1370 * @nodeoffset: offset of the node whose property to change
1371 * @name: name of the property to change
1372 * @val: 32-bit integer value to append to the property (native endian)
1373 *
David Gibson24fa0e52012-08-27 19:39:00 -05001374 * fdt_appendprop_u32() appends the given 32-bit integer value
1375 * (converting to big-endian if necessary) to the value of the named
1376 * property in the given node, or creates a new property with that
1377 * value if it does not already exist.
Minghuan Lian36ad18a2012-08-27 19:38:59 -05001378 *
1379 * This function may insert data into the blob, and will therefore
1380 * change the offsets of some existing nodes.
1381 *
1382 * returns:
1383 * 0, on success
1384 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1385 * contain the new property value
1386 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1387 * -FDT_ERR_BADLAYOUT,
1388 * -FDT_ERR_BADMAGIC,
1389 * -FDT_ERR_BADVERSION,
1390 * -FDT_ERR_BADSTATE,
1391 * -FDT_ERR_BADSTRUCTURE,
1392 * -FDT_ERR_BADLAYOUT,
1393 * -FDT_ERR_TRUNCATED, standard meanings
1394 */
David Gibson24fa0e52012-08-27 19:39:00 -05001395static inline int fdt_appendprop_u32(void *fdt, int nodeoffset,
1396 const char *name, uint32_t val)
Minghuan Lian36ad18a2012-08-27 19:38:59 -05001397{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001398 fdt32_t tmp = cpu_to_fdt32(val);
1399 return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
Minghuan Lian36ad18a2012-08-27 19:38:59 -05001400}
1401
1402/**
David Gibson24fa0e52012-08-27 19:39:00 -05001403 * fdt_appendprop_u64 - append a 64-bit integer value to a property
1404 * @fdt: pointer to the device tree blob
1405 * @nodeoffset: offset of the node whose property to change
1406 * @name: name of the property to change
1407 * @val: 64-bit integer value to append to the property (native endian)
1408 *
1409 * fdt_appendprop_u64() appends the given 64-bit integer value
1410 * (converting to big-endian if necessary) to the value of the named
1411 * property in the given node, or creates a new property with that
1412 * value if it does not already exist.
1413 *
1414 * This function may insert data into the blob, and will therefore
1415 * change the offsets of some existing nodes.
1416 *
1417 * returns:
1418 * 0, on success
1419 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1420 * contain the new property value
1421 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1422 * -FDT_ERR_BADLAYOUT,
1423 * -FDT_ERR_BADMAGIC,
1424 * -FDT_ERR_BADVERSION,
1425 * -FDT_ERR_BADSTATE,
1426 * -FDT_ERR_BADSTRUCTURE,
1427 * -FDT_ERR_BADLAYOUT,
1428 * -FDT_ERR_TRUNCATED, standard meanings
1429 */
1430static inline int fdt_appendprop_u64(void *fdt, int nodeoffset,
1431 const char *name, uint64_t val)
1432{
Kim Phillipsb2ba62a2013-01-16 13:59:50 +00001433 fdt64_t tmp = cpu_to_fdt64(val);
1434 return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
David Gibson24fa0e52012-08-27 19:39:00 -05001435}
1436
1437/**
1438 * fdt_appendprop_cell - append a single cell value to a property
1439 *
1440 * This is an alternative name for fdt_appendprop_u32()
1441 */
1442static inline int fdt_appendprop_cell(void *fdt, int nodeoffset,
1443 const char *name, uint32_t val)
1444{
1445 return fdt_appendprop_u32(fdt, nodeoffset, name, val);
1446}
1447
1448/**
Minghuan Lian36ad18a2012-08-27 19:38:59 -05001449 * fdt_appendprop_string - append a string to a property
1450 * @fdt: pointer to the device tree blob
1451 * @nodeoffset: offset of the node whose property to change
1452 * @name: name of the property to change
1453 * @str: string value to append to the property
1454 *
1455 * fdt_appendprop_string() appends the given string to the value of
1456 * the named property in the given node, or creates a new property
1457 * with that value if it does not already exist.
1458 *
1459 * This function may insert data into the blob, and will therefore
1460 * change the offsets of some existing nodes.
1461 *
1462 * returns:
1463 * 0, on success
1464 * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1465 * contain the new property value
1466 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1467 * -FDT_ERR_BADLAYOUT,
1468 * -FDT_ERR_BADMAGIC,
1469 * -FDT_ERR_BADVERSION,
1470 * -FDT_ERR_BADSTATE,
1471 * -FDT_ERR_BADSTRUCTURE,
1472 * -FDT_ERR_BADLAYOUT,
1473 * -FDT_ERR_TRUNCATED, standard meanings
1474 */
1475#define fdt_appendprop_string(fdt, nodeoffset, name, str) \
1476 fdt_appendprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
1477
1478/**
David Gibsonaec71352007-12-17 14:42:07 +11001479 * fdt_delprop - delete a property
1480 * @fdt: pointer to the device tree blob
1481 * @nodeoffset: offset of the node whose property to nop
1482 * @name: name of the property to nop
1483 *
1484 * fdt_del_property() will delete the given property.
1485 *
1486 * This function will delete data from the blob, and will therefore
1487 * change the offsets of some existing nodes.
1488 *
1489 * returns:
1490 * 0, on success
1491 * -FDT_ERR_NOTFOUND, node does not have the named property
1492 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1493 * -FDT_ERR_BADLAYOUT,
1494 * -FDT_ERR_BADMAGIC,
1495 * -FDT_ERR_BADVERSION,
1496 * -FDT_ERR_BADSTATE,
1497 * -FDT_ERR_BADSTRUCTURE,
1498 * -FDT_ERR_TRUNCATED, standard meanings
1499 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001500int fdt_delprop(void *fdt, int nodeoffset, const char *name);
David Gibsonaec71352007-12-17 14:42:07 +11001501
1502/**
1503 * fdt_add_subnode_namelen - creates a new node based on substring
1504 * @fdt: pointer to the device tree blob
1505 * @parentoffset: structure block offset of a node
1506 * @name: name of the subnode to locate
1507 * @namelen: number of characters of name to consider
1508 *
1509 * Identical to fdt_add_subnode(), but use only the first namelen
1510 * characters of name as the name of the new node. This is useful for
1511 * creating subnodes based on a portion of a larger string, such as a
1512 * full path.
1513 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001514int fdt_add_subnode_namelen(void *fdt, int parentoffset,
1515 const char *name, int namelen);
David Gibsonaec71352007-12-17 14:42:07 +11001516
1517/**
1518 * fdt_add_subnode - creates a new node
1519 * @fdt: pointer to the device tree blob
1520 * @parentoffset: structure block offset of a node
1521 * @name: name of the subnode to locate
1522 *
1523 * fdt_add_subnode() creates a new node as a subnode of the node at
1524 * structure block offset parentoffset, with the given name (which
1525 * should include the unit address, if any).
1526 *
1527 * This function will insert data into the blob, and will therefore
1528 * change the offsets of some existing nodes.
1529
1530 * returns:
1531 * structure block offset of the created nodeequested subnode (>=0), on success
1532 * -FDT_ERR_NOTFOUND, if the requested subnode does not exist
1533 * -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE tag
1534 * -FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of
1535 * the given name
1536 * -FDT_ERR_NOSPACE, if there is insufficient free space in the
1537 * blob to contain the new node
1538 * -FDT_ERR_NOSPACE
1539 * -FDT_ERR_BADLAYOUT
1540 * -FDT_ERR_BADMAGIC,
1541 * -FDT_ERR_BADVERSION,
1542 * -FDT_ERR_BADSTATE,
1543 * -FDT_ERR_BADSTRUCTURE,
1544 * -FDT_ERR_TRUNCATED, standard meanings.
1545 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001546int fdt_add_subnode(void *fdt, int parentoffset, const char *name);
David Gibsonaec71352007-12-17 14:42:07 +11001547
1548/**
1549 * fdt_del_node - delete a node (subtree)
1550 * @fdt: pointer to the device tree blob
1551 * @nodeoffset: offset of the node to nop
1552 *
1553 * fdt_del_node() will remove the given node, including all its
1554 * subnodes if any, from the blob.
1555 *
1556 * This function will delete data from the blob, and will therefore
1557 * change the offsets of some existing nodes.
1558 *
1559 * returns:
1560 * 0, on success
1561 * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1562 * -FDT_ERR_BADLAYOUT,
1563 * -FDT_ERR_BADMAGIC,
1564 * -FDT_ERR_BADVERSION,
1565 * -FDT_ERR_BADSTATE,
1566 * -FDT_ERR_BADSTRUCTURE,
1567 * -FDT_ERR_TRUNCATED, standard meanings
1568 */
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001569int fdt_del_node(void *fdt, int nodeoffset);
1570
Kumar Gala8d04f022007-10-24 11:04:22 -05001571/**********************************************************************/
1572/* Debugging / informational functions */
1573/**********************************************************************/
1574
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001575const char *fdt_strerror(int errval);
1576
Simon Glass3e06cd12013-06-13 15:10:08 -07001577struct fdt_region {
1578 int offset;
1579 int size;
1580};
1581
1582/**
1583 * fdt_find_regions() - find regions in device tree
1584 *
1585 * Given a list of nodes to include and properties to exclude, find
1586 * the regions of the device tree which describe those included parts.
1587 *
1588 * The intent is to get a list of regions which will be invariant provided
1589 * those parts are invariant. For example, if you request a list of regions
1590 * for all nodes but exclude the property "data", then you will get the
1591 * same region contents regardless of any change to "data" properties.
1592 *
1593 * This function can be used to produce a byte-stream to send to a hashing
1594 * function to verify that critical parts of the FDT have not changed.
1595 *
1596 * Nodes which are given in 'inc' are included in the region list, as
1597 * are the names of the immediate subnodes nodes (but not the properties
1598 * or subnodes of those subnodes).
1599 *
1600 * For eaxample "/" means to include the root node, all root properties
1601 * and the FDT_BEGIN_NODE and FDT_END_NODE of all subnodes of /. The latter
1602 * ensures that we capture the names of the subnodes. In a hashing situation
1603 * it prevents the root node from changing at all Any change to non-excluded
1604 * properties, names of subnodes or number of subnodes would be detected.
1605 *
1606 * When used with FITs this provides the ability to hash and sign parts of
1607 * the FIT based on different configurations in the FIT. Then it is
1608 * impossible to change anything about that configuration (include images
1609 * attached to the configuration), but it may be possible to add new
1610 * configurations, new images or new signatures within the existing
1611 * framework.
1612 *
1613 * Adding new properties to a device tree may result in the string table
1614 * being extended (if the new property names are different from those
1615 * already added). This function can optionally include a region for
1616 * the string table so that this can be part of the hash too.
1617 *
1618 * The device tree header is not included in the list.
1619 *
1620 * @fdt: Device tree to check
1621 * @inc: List of node paths to included
1622 * @inc_count: Number of node paths in list
1623 * @exc_prop: List of properties names to exclude
1624 * @exc_prop_count: Number of properties in exclude list
1625 * @region: Returns list of regions
1626 * @max_region: Maximum length of region list
1627 * @path: Pointer to a temporary string for the function to use for
1628 * building path names
1629 * @path_len: Length of path, must be large enough to hold the longest
1630 * path in the tree
1631 * @add_string_tab: 1 to add a region for the string table
1632 * @return number of regions in list. If this is >max_regions then the
1633 * region array was exhausted. You should increase max_regions and try
1634 * the call again.
1635 */
1636int fdt_find_regions(const void *fdt, char * const inc[], int inc_count,
1637 char * const exc_prop[], int exc_prop_count,
1638 struct fdt_region region[], int max_regions,
1639 char *path, int path_len, int add_string_tab);
1640
Gerald Van Baren7cd5da02007-03-31 11:59:59 -04001641#endif /* _LIBFDT_H */