1*4882a593Smuzhiyun #ifndef _LIBFDT_H
2*4882a593Smuzhiyun #define _LIBFDT_H
3*4882a593Smuzhiyun /*
4*4882a593Smuzhiyun * libfdt - Flat Device Tree manipulation
5*4882a593Smuzhiyun * Copyright (C) 2006 David Gibson, IBM Corporation.
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * libfdt is dual licensed: you can use it either under the terms of
8*4882a593Smuzhiyun * the GPL, or the BSD license, at your option.
9*4882a593Smuzhiyun *
10*4882a593Smuzhiyun * a) This library is free software; you can redistribute it and/or
11*4882a593Smuzhiyun * modify it under the terms of the GNU General Public License as
12*4882a593Smuzhiyun * published by the Free Software Foundation; either version 2 of the
13*4882a593Smuzhiyun * License, or (at your option) any later version.
14*4882a593Smuzhiyun *
15*4882a593Smuzhiyun * This library is distributed in the hope that it will be useful,
16*4882a593Smuzhiyun * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*4882a593Smuzhiyun * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18*4882a593Smuzhiyun * GNU General Public License for more details.
19*4882a593Smuzhiyun *
20*4882a593Smuzhiyun * You should have received a copy of the GNU General Public
21*4882a593Smuzhiyun * License along with this library; if not, write to the Free
22*4882a593Smuzhiyun * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
23*4882a593Smuzhiyun * MA 02110-1301 USA
24*4882a593Smuzhiyun *
25*4882a593Smuzhiyun * Alternatively,
26*4882a593Smuzhiyun *
27*4882a593Smuzhiyun * b) Redistribution and use in source and binary forms, with or
28*4882a593Smuzhiyun * without modification, are permitted provided that the following
29*4882a593Smuzhiyun * conditions are met:
30*4882a593Smuzhiyun *
31*4882a593Smuzhiyun * 1. Redistributions of source code must retain the above
32*4882a593Smuzhiyun * copyright notice, this list of conditions and the following
33*4882a593Smuzhiyun * disclaimer.
34*4882a593Smuzhiyun * 2. Redistributions in binary form must reproduce the above
35*4882a593Smuzhiyun * copyright notice, this list of conditions and the following
36*4882a593Smuzhiyun * disclaimer in the documentation and/or other materials
37*4882a593Smuzhiyun * provided with the distribution.
38*4882a593Smuzhiyun *
39*4882a593Smuzhiyun * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
40*4882a593Smuzhiyun * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
41*4882a593Smuzhiyun * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
42*4882a593Smuzhiyun * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43*4882a593Smuzhiyun * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
44*4882a593Smuzhiyun * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45*4882a593Smuzhiyun * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46*4882a593Smuzhiyun * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47*4882a593Smuzhiyun * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48*4882a593Smuzhiyun * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
49*4882a593Smuzhiyun * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
50*4882a593Smuzhiyun * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
51*4882a593Smuzhiyun * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52*4882a593Smuzhiyun */
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun #include "libfdt_env.h"
55*4882a593Smuzhiyun #include "fdt.h"
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun #define FDT_FIRST_SUPPORTED_VERSION 0x10
58*4882a593Smuzhiyun #define FDT_LAST_SUPPORTED_VERSION 0x11
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun /* Error codes: informative error codes */
61*4882a593Smuzhiyun #define FDT_ERR_NOTFOUND 1
62*4882a593Smuzhiyun /* FDT_ERR_NOTFOUND: The requested node or property does not exist */
63*4882a593Smuzhiyun #define FDT_ERR_EXISTS 2
64*4882a593Smuzhiyun /* FDT_ERR_EXISTS: Attempted to create a node or property which
65*4882a593Smuzhiyun * already exists */
66*4882a593Smuzhiyun #define FDT_ERR_NOSPACE 3
67*4882a593Smuzhiyun /* FDT_ERR_NOSPACE: Operation needed to expand the device
68*4882a593Smuzhiyun * tree, but its buffer did not have sufficient space to
69*4882a593Smuzhiyun * contain the expanded tree. Use fdt_open_into() to move the
70*4882a593Smuzhiyun * device tree to a buffer with more space. */
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun /* Error codes: codes for bad parameters */
73*4882a593Smuzhiyun #define FDT_ERR_BADOFFSET 4
74*4882a593Smuzhiyun /* FDT_ERR_BADOFFSET: Function was passed a structure block
75*4882a593Smuzhiyun * offset which is out-of-bounds, or which points to an
76*4882a593Smuzhiyun * unsuitable part of the structure for the operation. */
77*4882a593Smuzhiyun #define FDT_ERR_BADPATH 5
78*4882a593Smuzhiyun /* FDT_ERR_BADPATH: Function was passed a badly formatted path
79*4882a593Smuzhiyun * (e.g. missing a leading / for a function which requires an
80*4882a593Smuzhiyun * absolute path) */
81*4882a593Smuzhiyun #define FDT_ERR_BADPHANDLE 6
82*4882a593Smuzhiyun /* FDT_ERR_BADPHANDLE: Function was passed an invalid phandle.
83*4882a593Smuzhiyun * This can be caused either by an invalid phandle property
84*4882a593Smuzhiyun * length, or the phandle value was either 0 or -1, which are
85*4882a593Smuzhiyun * not permitted. */
86*4882a593Smuzhiyun #define FDT_ERR_BADSTATE 7
87*4882a593Smuzhiyun /* FDT_ERR_BADSTATE: Function was passed an incomplete device
88*4882a593Smuzhiyun * tree created by the sequential-write functions, which is
89*4882a593Smuzhiyun * not sufficiently complete for the requested operation. */
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun /* Error codes: codes for bad device tree blobs */
92*4882a593Smuzhiyun #define FDT_ERR_TRUNCATED 8
93*4882a593Smuzhiyun /* FDT_ERR_TRUNCATED: Structure block of the given device tree
94*4882a593Smuzhiyun * ends without an FDT_END tag. */
95*4882a593Smuzhiyun #define FDT_ERR_BADMAGIC 9
96*4882a593Smuzhiyun /* FDT_ERR_BADMAGIC: Given "device tree" appears not to be a
97*4882a593Smuzhiyun * device tree at all - it is missing the flattened device
98*4882a593Smuzhiyun * tree magic number. */
99*4882a593Smuzhiyun #define FDT_ERR_BADVERSION 10
100*4882a593Smuzhiyun /* FDT_ERR_BADVERSION: Given device tree has a version which
101*4882a593Smuzhiyun * can't be handled by the requested operation. For
102*4882a593Smuzhiyun * read-write functions, this may mean that fdt_open_into() is
103*4882a593Smuzhiyun * required to convert the tree to the expected version. */
104*4882a593Smuzhiyun #define FDT_ERR_BADSTRUCTURE 11
105*4882a593Smuzhiyun /* FDT_ERR_BADSTRUCTURE: Given device tree has a corrupt
106*4882a593Smuzhiyun * structure block or other serious error (e.g. misnested
107*4882a593Smuzhiyun * nodes, or subnodes preceding properties). */
108*4882a593Smuzhiyun #define FDT_ERR_BADLAYOUT 12
109*4882a593Smuzhiyun /* FDT_ERR_BADLAYOUT: For read-write functions, the given
110*4882a593Smuzhiyun * device tree has it's sub-blocks in an order that the
111*4882a593Smuzhiyun * function can't handle (memory reserve map, then structure,
112*4882a593Smuzhiyun * then strings). Use fdt_open_into() to reorganize the tree
113*4882a593Smuzhiyun * into a form suitable for the read-write operations. */
114*4882a593Smuzhiyun
115*4882a593Smuzhiyun /* "Can't happen" error indicating a bug in libfdt */
116*4882a593Smuzhiyun #define FDT_ERR_INTERNAL 13
117*4882a593Smuzhiyun /* FDT_ERR_INTERNAL: libfdt has failed an internal assertion.
118*4882a593Smuzhiyun * Should never be returned, if it is, it indicates a bug in
119*4882a593Smuzhiyun * libfdt itself. */
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun /* Errors in device tree content */
122*4882a593Smuzhiyun #define FDT_ERR_BADNCELLS 14
123*4882a593Smuzhiyun /* FDT_ERR_BADNCELLS: Device tree has a #address-cells, #size-cells
124*4882a593Smuzhiyun * or similar property with a bad format or value */
125*4882a593Smuzhiyun
126*4882a593Smuzhiyun #define FDT_ERR_BADVALUE 15
127*4882a593Smuzhiyun /* FDT_ERR_BADVALUE: Device tree has a property with an unexpected
128*4882a593Smuzhiyun * value. For example: a property expected to contain a string list
129*4882a593Smuzhiyun * is not NUL-terminated within the length of its value. */
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun #define FDT_ERR_BADOVERLAY 16
132*4882a593Smuzhiyun /* FDT_ERR_BADOVERLAY: The device tree overlay, while
133*4882a593Smuzhiyun * correctly structured, cannot be applied due to some
134*4882a593Smuzhiyun * unexpected or missing value, property or node. */
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun #define FDT_ERR_NOPHANDLES 17
137*4882a593Smuzhiyun /* FDT_ERR_NOPHANDLES: The device tree doesn't have any
138*4882a593Smuzhiyun * phandle available anymore without causing an overflow */
139*4882a593Smuzhiyun
140*4882a593Smuzhiyun #define FDT_ERR_MAX 17
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun /**********************************************************************/
143*4882a593Smuzhiyun /* Low-level functions (you probably don't need these) */
144*4882a593Smuzhiyun /**********************************************************************/
145*4882a593Smuzhiyun
146*4882a593Smuzhiyun #ifndef SWIG /* This function is not useful in Python */
147*4882a593Smuzhiyun const void *fdt_offset_ptr(const void *fdt, int offset, unsigned int checklen);
148*4882a593Smuzhiyun #endif
fdt_offset_ptr_w(void * fdt,int offset,int checklen)149*4882a593Smuzhiyun static inline void *fdt_offset_ptr_w(void *fdt, int offset, int checklen)
150*4882a593Smuzhiyun {
151*4882a593Smuzhiyun return (void *)(uintptr_t)fdt_offset_ptr(fdt, offset, checklen);
152*4882a593Smuzhiyun }
153*4882a593Smuzhiyun
154*4882a593Smuzhiyun uint32_t fdt_next_tag(const void *fdt, int offset, int *nextoffset);
155*4882a593Smuzhiyun
156*4882a593Smuzhiyun /**********************************************************************/
157*4882a593Smuzhiyun /* Traversal functions */
158*4882a593Smuzhiyun /**********************************************************************/
159*4882a593Smuzhiyun
160*4882a593Smuzhiyun int fdt_next_node(const void *fdt, int offset, int *depth);
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun /**
163*4882a593Smuzhiyun * fdt_first_subnode() - get offset of first direct subnode
164*4882a593Smuzhiyun *
165*4882a593Smuzhiyun * @fdt: FDT blob
166*4882a593Smuzhiyun * @offset: Offset of node to check
167*4882a593Smuzhiyun * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
168*4882a593Smuzhiyun */
169*4882a593Smuzhiyun int fdt_first_subnode(const void *fdt, int offset);
170*4882a593Smuzhiyun
171*4882a593Smuzhiyun /**
172*4882a593Smuzhiyun * fdt_next_subnode() - get offset of next direct subnode
173*4882a593Smuzhiyun *
174*4882a593Smuzhiyun * After first calling fdt_first_subnode(), call this function repeatedly to
175*4882a593Smuzhiyun * get direct subnodes of a parent node.
176*4882a593Smuzhiyun *
177*4882a593Smuzhiyun * @fdt: FDT blob
178*4882a593Smuzhiyun * @offset: Offset of previous subnode
179*4882a593Smuzhiyun * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
180*4882a593Smuzhiyun * subnodes
181*4882a593Smuzhiyun */
182*4882a593Smuzhiyun int fdt_next_subnode(const void *fdt, int offset);
183*4882a593Smuzhiyun
184*4882a593Smuzhiyun /**
185*4882a593Smuzhiyun * fdt_for_each_subnode - iterate over all subnodes of a parent
186*4882a593Smuzhiyun *
187*4882a593Smuzhiyun * @node: child node (int, lvalue)
188*4882a593Smuzhiyun * @fdt: FDT blob (const void *)
189*4882a593Smuzhiyun * @parent: parent node (int)
190*4882a593Smuzhiyun *
191*4882a593Smuzhiyun * This is actually a wrapper around a for loop and would be used like so:
192*4882a593Smuzhiyun *
193*4882a593Smuzhiyun * fdt_for_each_subnode(node, fdt, parent) {
194*4882a593Smuzhiyun * Use node
195*4882a593Smuzhiyun * ...
196*4882a593Smuzhiyun * }
197*4882a593Smuzhiyun *
198*4882a593Smuzhiyun * if ((node < 0) && (node != -FDT_ERR_NOT_FOUND)) {
199*4882a593Smuzhiyun * Error handling
200*4882a593Smuzhiyun * }
201*4882a593Smuzhiyun *
202*4882a593Smuzhiyun * Note that this is implemented as a macro and @node is used as
203*4882a593Smuzhiyun * iterator in the loop. The parent variable be constant or even a
204*4882a593Smuzhiyun * literal.
205*4882a593Smuzhiyun *
206*4882a593Smuzhiyun */
207*4882a593Smuzhiyun #define fdt_for_each_subnode(node, fdt, parent) \
208*4882a593Smuzhiyun for (node = fdt_first_subnode(fdt, parent); \
209*4882a593Smuzhiyun node >= 0; \
210*4882a593Smuzhiyun node = fdt_next_subnode(fdt, node))
211*4882a593Smuzhiyun
212*4882a593Smuzhiyun /**********************************************************************/
213*4882a593Smuzhiyun /* General functions */
214*4882a593Smuzhiyun /**********************************************************************/
215*4882a593Smuzhiyun #define fdt_get_header(fdt, field) \
216*4882a593Smuzhiyun (fdt32_to_cpu(((const struct fdt_header *)(fdt))->field))
217*4882a593Smuzhiyun #define fdt_magic(fdt) (fdt_get_header(fdt, magic))
218*4882a593Smuzhiyun #define fdt_totalsize(fdt) (fdt_get_header(fdt, totalsize))
219*4882a593Smuzhiyun #define fdt_off_dt_struct(fdt) (fdt_get_header(fdt, off_dt_struct))
220*4882a593Smuzhiyun #define fdt_off_dt_strings(fdt) (fdt_get_header(fdt, off_dt_strings))
221*4882a593Smuzhiyun #define fdt_off_mem_rsvmap(fdt) (fdt_get_header(fdt, off_mem_rsvmap))
222*4882a593Smuzhiyun #define fdt_version(fdt) (fdt_get_header(fdt, version))
223*4882a593Smuzhiyun #define fdt_last_comp_version(fdt) (fdt_get_header(fdt, last_comp_version))
224*4882a593Smuzhiyun #define fdt_boot_cpuid_phys(fdt) (fdt_get_header(fdt, boot_cpuid_phys))
225*4882a593Smuzhiyun #define fdt_size_dt_strings(fdt) (fdt_get_header(fdt, size_dt_strings))
226*4882a593Smuzhiyun #define fdt_size_dt_struct(fdt) (fdt_get_header(fdt, size_dt_struct))
227*4882a593Smuzhiyun
228*4882a593Smuzhiyun #define __fdt_set_hdr(name) \
229*4882a593Smuzhiyun static inline void fdt_set_##name(void *fdt, uint32_t val) \
230*4882a593Smuzhiyun { \
231*4882a593Smuzhiyun struct fdt_header *fdth = (struct fdt_header *)fdt; \
232*4882a593Smuzhiyun fdth->name = cpu_to_fdt32(val); \
233*4882a593Smuzhiyun }
234*4882a593Smuzhiyun __fdt_set_hdr(magic);
235*4882a593Smuzhiyun __fdt_set_hdr(totalsize);
236*4882a593Smuzhiyun __fdt_set_hdr(off_dt_struct);
237*4882a593Smuzhiyun __fdt_set_hdr(off_dt_strings);
238*4882a593Smuzhiyun __fdt_set_hdr(off_mem_rsvmap);
239*4882a593Smuzhiyun __fdt_set_hdr(version);
240*4882a593Smuzhiyun __fdt_set_hdr(last_comp_version);
241*4882a593Smuzhiyun __fdt_set_hdr(boot_cpuid_phys);
242*4882a593Smuzhiyun __fdt_set_hdr(size_dt_strings);
243*4882a593Smuzhiyun __fdt_set_hdr(size_dt_struct);
244*4882a593Smuzhiyun #undef __fdt_set_hdr
245*4882a593Smuzhiyun
246*4882a593Smuzhiyun /**
247*4882a593Smuzhiyun * fdt_check_header - sanity check a device tree or possible device tree
248*4882a593Smuzhiyun * @fdt: pointer to data which might be a flattened device tree
249*4882a593Smuzhiyun *
250*4882a593Smuzhiyun * fdt_check_header() checks that the given buffer contains what
251*4882a593Smuzhiyun * appears to be a flattened device tree with sane information in its
252*4882a593Smuzhiyun * header.
253*4882a593Smuzhiyun *
254*4882a593Smuzhiyun * returns:
255*4882a593Smuzhiyun * 0, if the buffer appears to contain a valid device tree
256*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
257*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
258*4882a593Smuzhiyun * -FDT_ERR_BADSTATE, standard meanings, as above
259*4882a593Smuzhiyun */
260*4882a593Smuzhiyun int fdt_check_header(const void *fdt);
261*4882a593Smuzhiyun
262*4882a593Smuzhiyun /**
263*4882a593Smuzhiyun * fdt_move - move a device tree around in memory
264*4882a593Smuzhiyun * @fdt: pointer to the device tree to move
265*4882a593Smuzhiyun * @buf: pointer to memory where the device is to be moved
266*4882a593Smuzhiyun * @bufsize: size of the memory space at buf
267*4882a593Smuzhiyun *
268*4882a593Smuzhiyun * fdt_move() relocates, if possible, the device tree blob located at
269*4882a593Smuzhiyun * fdt to the buffer at buf of size bufsize. The buffer may overlap
270*4882a593Smuzhiyun * with the existing device tree blob at fdt. Therefore,
271*4882a593Smuzhiyun * fdt_move(fdt, fdt, fdt_totalsize(fdt))
272*4882a593Smuzhiyun * should always succeed.
273*4882a593Smuzhiyun *
274*4882a593Smuzhiyun * returns:
275*4882a593Smuzhiyun * 0, on success
276*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree
277*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
278*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
279*4882a593Smuzhiyun * -FDT_ERR_BADSTATE, standard meanings
280*4882a593Smuzhiyun */
281*4882a593Smuzhiyun int fdt_move(const void *fdt, void *buf, int bufsize);
282*4882a593Smuzhiyun
283*4882a593Smuzhiyun /**********************************************************************/
284*4882a593Smuzhiyun /* Read-only functions */
285*4882a593Smuzhiyun /**********************************************************************/
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun /**
288*4882a593Smuzhiyun * fdt_string - retrieve a string from the strings block of a device tree
289*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
290*4882a593Smuzhiyun * @stroffset: offset of the string within the strings block (native endian)
291*4882a593Smuzhiyun *
292*4882a593Smuzhiyun * fdt_string() retrieves a pointer to a single string from the
293*4882a593Smuzhiyun * strings block of the device tree blob at fdt.
294*4882a593Smuzhiyun *
295*4882a593Smuzhiyun * returns:
296*4882a593Smuzhiyun * a pointer to the string, on success
297*4882a593Smuzhiyun * NULL, if stroffset is out of bounds
298*4882a593Smuzhiyun */
299*4882a593Smuzhiyun const char *fdt_string(const void *fdt, int stroffset);
300*4882a593Smuzhiyun
301*4882a593Smuzhiyun /**
302*4882a593Smuzhiyun * fdt_get_max_phandle - retrieves the highest phandle in a tree
303*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
304*4882a593Smuzhiyun *
305*4882a593Smuzhiyun * fdt_get_max_phandle retrieves the highest phandle in the given
306*4882a593Smuzhiyun * device tree. This will ignore badly formatted phandles, or phandles
307*4882a593Smuzhiyun * with a value of 0 or -1.
308*4882a593Smuzhiyun *
309*4882a593Smuzhiyun * returns:
310*4882a593Smuzhiyun * the highest phandle on success
311*4882a593Smuzhiyun * 0, if no phandle was found in the device tree
312*4882a593Smuzhiyun * -1, if an error occurred
313*4882a593Smuzhiyun */
314*4882a593Smuzhiyun uint32_t fdt_get_max_phandle(const void *fdt);
315*4882a593Smuzhiyun
316*4882a593Smuzhiyun /**
317*4882a593Smuzhiyun * fdt_num_mem_rsv - retrieve the number of memory reserve map entries
318*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
319*4882a593Smuzhiyun *
320*4882a593Smuzhiyun * Returns the number of entries in the device tree blob's memory
321*4882a593Smuzhiyun * reservation map. This does not include the terminating 0,0 entry
322*4882a593Smuzhiyun * or any other (0,0) entries reserved for expansion.
323*4882a593Smuzhiyun *
324*4882a593Smuzhiyun * returns:
325*4882a593Smuzhiyun * the number of entries
326*4882a593Smuzhiyun */
327*4882a593Smuzhiyun int fdt_num_mem_rsv(const void *fdt);
328*4882a593Smuzhiyun
329*4882a593Smuzhiyun /**
330*4882a593Smuzhiyun * fdt_get_mem_rsv - retrieve one memory reserve map entry
331*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
332*4882a593Smuzhiyun * @address, @size: pointers to 64-bit variables
333*4882a593Smuzhiyun *
334*4882a593Smuzhiyun * On success, *address and *size will contain the address and size of
335*4882a593Smuzhiyun * the n-th reserve map entry from the device tree blob, in
336*4882a593Smuzhiyun * native-endian format.
337*4882a593Smuzhiyun *
338*4882a593Smuzhiyun * returns:
339*4882a593Smuzhiyun * 0, on success
340*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
341*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
342*4882a593Smuzhiyun * -FDT_ERR_BADSTATE, standard meanings
343*4882a593Smuzhiyun */
344*4882a593Smuzhiyun int fdt_get_mem_rsv(const void *fdt, int n, uint64_t *address, uint64_t *size);
345*4882a593Smuzhiyun
346*4882a593Smuzhiyun /**
347*4882a593Smuzhiyun * fdt_subnode_offset_namelen - find a subnode based on substring
348*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
349*4882a593Smuzhiyun * @parentoffset: structure block offset of a node
350*4882a593Smuzhiyun * @name: name of the subnode to locate
351*4882a593Smuzhiyun * @namelen: number of characters of name to consider
352*4882a593Smuzhiyun *
353*4882a593Smuzhiyun * Identical to fdt_subnode_offset(), but only examine the first
354*4882a593Smuzhiyun * namelen characters of name for matching the subnode name. This is
355*4882a593Smuzhiyun * useful for finding subnodes based on a portion of a larger string,
356*4882a593Smuzhiyun * such as a full path.
357*4882a593Smuzhiyun */
358*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
359*4882a593Smuzhiyun int fdt_subnode_offset_namelen(const void *fdt, int parentoffset,
360*4882a593Smuzhiyun const char *name, int namelen);
361*4882a593Smuzhiyun #endif
362*4882a593Smuzhiyun /**
363*4882a593Smuzhiyun * fdt_subnode_offset - find a subnode of a given node
364*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
365*4882a593Smuzhiyun * @parentoffset: structure block offset of a node
366*4882a593Smuzhiyun * @name: name of the subnode to locate
367*4882a593Smuzhiyun *
368*4882a593Smuzhiyun * fdt_subnode_offset() finds a subnode of the node at structure block
369*4882a593Smuzhiyun * offset parentoffset with the given name. name may include a unit
370*4882a593Smuzhiyun * address, in which case fdt_subnode_offset() will find the subnode
371*4882a593Smuzhiyun * with that unit address, or the unit address may be omitted, in
372*4882a593Smuzhiyun * which case fdt_subnode_offset() will find an arbitrary subnode
373*4882a593Smuzhiyun * whose name excluding unit address matches the given name.
374*4882a593Smuzhiyun *
375*4882a593Smuzhiyun * returns:
376*4882a593Smuzhiyun * structure block offset of the requested subnode (>=0), on success
377*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, if the requested subnode does not exist
378*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE
379*4882a593Smuzhiyun * tag
380*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
381*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
382*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
383*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
384*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings.
385*4882a593Smuzhiyun */
386*4882a593Smuzhiyun int fdt_subnode_offset(const void *fdt, int parentoffset, const char *name);
387*4882a593Smuzhiyun
388*4882a593Smuzhiyun /**
389*4882a593Smuzhiyun * fdt_path_offset_namelen - find a tree node by its full path
390*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
391*4882a593Smuzhiyun * @path: full path of the node to locate
392*4882a593Smuzhiyun * @namelen: number of characters of path to consider
393*4882a593Smuzhiyun *
394*4882a593Smuzhiyun * Identical to fdt_path_offset(), but only consider the first namelen
395*4882a593Smuzhiyun * characters of path as the path name.
396*4882a593Smuzhiyun */
397*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
398*4882a593Smuzhiyun int fdt_path_offset_namelen(const void *fdt, const char *path, int namelen);
399*4882a593Smuzhiyun #endif
400*4882a593Smuzhiyun
401*4882a593Smuzhiyun /**
402*4882a593Smuzhiyun * fdt_path_offset - find a tree node by its full path
403*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
404*4882a593Smuzhiyun * @path: full path of the node to locate
405*4882a593Smuzhiyun *
406*4882a593Smuzhiyun * fdt_path_offset() finds a node of a given path in the device tree.
407*4882a593Smuzhiyun * Each path component may omit the unit address portion, but the
408*4882a593Smuzhiyun * results of this are undefined if any such path component is
409*4882a593Smuzhiyun * ambiguous (that is if there are multiple nodes at the relevant
410*4882a593Smuzhiyun * level matching the given component, differentiated only by unit
411*4882a593Smuzhiyun * address).
412*4882a593Smuzhiyun *
413*4882a593Smuzhiyun * returns:
414*4882a593Smuzhiyun * structure block offset of the node with the requested path (>=0), on
415*4882a593Smuzhiyun * success
416*4882a593Smuzhiyun * -FDT_ERR_BADPATH, given path does not begin with '/' or is invalid
417*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, if the requested node does not exist
418*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
419*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
420*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
421*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
422*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings.
423*4882a593Smuzhiyun */
424*4882a593Smuzhiyun int fdt_path_offset(const void *fdt, const char *path);
425*4882a593Smuzhiyun
426*4882a593Smuzhiyun /**
427*4882a593Smuzhiyun * fdt_get_name - retrieve the name of a given node
428*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
429*4882a593Smuzhiyun * @nodeoffset: structure block offset of the starting node
430*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
431*4882a593Smuzhiyun *
432*4882a593Smuzhiyun * fdt_get_name() retrieves the name (including unit address) of the
433*4882a593Smuzhiyun * device tree node at structure block offset nodeoffset. If lenp is
434*4882a593Smuzhiyun * non-NULL, the length of this name is also returned, in the integer
435*4882a593Smuzhiyun * pointed to by lenp.
436*4882a593Smuzhiyun *
437*4882a593Smuzhiyun * returns:
438*4882a593Smuzhiyun * pointer to the node's name, on success
439*4882a593Smuzhiyun * If lenp is non-NULL, *lenp contains the length of that name
440*4882a593Smuzhiyun * (>=0)
441*4882a593Smuzhiyun * NULL, on error
442*4882a593Smuzhiyun * if lenp is non-NULL *lenp contains an error code (<0):
443*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE
444*4882a593Smuzhiyun * tag
445*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
446*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
447*4882a593Smuzhiyun * -FDT_ERR_BADSTATE, standard meanings
448*4882a593Smuzhiyun */
449*4882a593Smuzhiyun const char *fdt_get_name(const void *fdt, int nodeoffset, int *lenp);
450*4882a593Smuzhiyun
451*4882a593Smuzhiyun /**
452*4882a593Smuzhiyun * fdt_first_property_offset - find the offset of a node's first property
453*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
454*4882a593Smuzhiyun * @nodeoffset: structure block offset of a node
455*4882a593Smuzhiyun *
456*4882a593Smuzhiyun * fdt_first_property_offset() finds the first property of the node at
457*4882a593Smuzhiyun * the given structure block offset.
458*4882a593Smuzhiyun *
459*4882a593Smuzhiyun * returns:
460*4882a593Smuzhiyun * structure block offset of the property (>=0), on success
461*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, if the requested node has no properties
462*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_BEGIN_NODE tag
463*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
464*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
465*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
466*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
467*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings.
468*4882a593Smuzhiyun */
469*4882a593Smuzhiyun int fdt_first_property_offset(const void *fdt, int nodeoffset);
470*4882a593Smuzhiyun
471*4882a593Smuzhiyun /**
472*4882a593Smuzhiyun * fdt_next_property_offset - step through a node's properties
473*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
474*4882a593Smuzhiyun * @offset: structure block offset of a property
475*4882a593Smuzhiyun *
476*4882a593Smuzhiyun * fdt_next_property_offset() finds the property immediately after the
477*4882a593Smuzhiyun * one at the given structure block offset. This will be a property
478*4882a593Smuzhiyun * of the same node as the given property.
479*4882a593Smuzhiyun *
480*4882a593Smuzhiyun * returns:
481*4882a593Smuzhiyun * structure block offset of the next property (>=0), on success
482*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, if the given property is the last in its node
483*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_PROP tag
484*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
485*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
486*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
487*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
488*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings.
489*4882a593Smuzhiyun */
490*4882a593Smuzhiyun int fdt_next_property_offset(const void *fdt, int offset);
491*4882a593Smuzhiyun
492*4882a593Smuzhiyun /**
493*4882a593Smuzhiyun * fdt_for_each_property_offset - iterate over all properties of a node
494*4882a593Smuzhiyun *
495*4882a593Smuzhiyun * @property_offset: property offset (int, lvalue)
496*4882a593Smuzhiyun * @fdt: FDT blob (const void *)
497*4882a593Smuzhiyun * @node: node offset (int)
498*4882a593Smuzhiyun *
499*4882a593Smuzhiyun * This is actually a wrapper around a for loop and would be used like so:
500*4882a593Smuzhiyun *
501*4882a593Smuzhiyun * fdt_for_each_property_offset(property, fdt, node) {
502*4882a593Smuzhiyun * Use property
503*4882a593Smuzhiyun * ...
504*4882a593Smuzhiyun * }
505*4882a593Smuzhiyun *
506*4882a593Smuzhiyun * if ((property < 0) && (property != -FDT_ERR_NOT_FOUND)) {
507*4882a593Smuzhiyun * Error handling
508*4882a593Smuzhiyun * }
509*4882a593Smuzhiyun *
510*4882a593Smuzhiyun * Note that this is implemented as a macro and property is used as
511*4882a593Smuzhiyun * iterator in the loop. The node variable can be constant or even a
512*4882a593Smuzhiyun * literal.
513*4882a593Smuzhiyun */
514*4882a593Smuzhiyun #define fdt_for_each_property_offset(property, fdt, node) \
515*4882a593Smuzhiyun for (property = fdt_first_property_offset(fdt, node); \
516*4882a593Smuzhiyun property >= 0; \
517*4882a593Smuzhiyun property = fdt_next_property_offset(fdt, property))
518*4882a593Smuzhiyun
519*4882a593Smuzhiyun /**
520*4882a593Smuzhiyun * fdt_get_property_by_offset - retrieve the property at a given offset
521*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
522*4882a593Smuzhiyun * @offset: offset of the property to retrieve
523*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
524*4882a593Smuzhiyun *
525*4882a593Smuzhiyun * fdt_get_property_by_offset() retrieves a pointer to the
526*4882a593Smuzhiyun * fdt_property structure within the device tree blob at the given
527*4882a593Smuzhiyun * offset. If lenp is non-NULL, the length of the property value is
528*4882a593Smuzhiyun * also returned, in the integer pointed to by lenp.
529*4882a593Smuzhiyun *
530*4882a593Smuzhiyun * returns:
531*4882a593Smuzhiyun * pointer to the structure representing the property
532*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains the length of the property
533*4882a593Smuzhiyun * value (>=0)
534*4882a593Smuzhiyun * NULL, on error
535*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains an error code (<0):
536*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag
537*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
538*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
539*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
540*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
541*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
542*4882a593Smuzhiyun */
543*4882a593Smuzhiyun const struct fdt_property *fdt_get_property_by_offset(const void *fdt,
544*4882a593Smuzhiyun int offset,
545*4882a593Smuzhiyun int *lenp);
546*4882a593Smuzhiyun
547*4882a593Smuzhiyun /**
548*4882a593Smuzhiyun * fdt_get_property_namelen - find a property based on substring
549*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
550*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to find
551*4882a593Smuzhiyun * @name: name of the property to find
552*4882a593Smuzhiyun * @namelen: number of characters of name to consider
553*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
554*4882a593Smuzhiyun *
555*4882a593Smuzhiyun * Identical to fdt_get_property(), but only examine the first namelen
556*4882a593Smuzhiyun * characters of name for matching the property name.
557*4882a593Smuzhiyun */
558*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
559*4882a593Smuzhiyun const struct fdt_property *fdt_get_property_namelen(const void *fdt,
560*4882a593Smuzhiyun int nodeoffset,
561*4882a593Smuzhiyun const char *name,
562*4882a593Smuzhiyun int namelen, int *lenp);
563*4882a593Smuzhiyun #endif
564*4882a593Smuzhiyun
565*4882a593Smuzhiyun /**
566*4882a593Smuzhiyun * fdt_get_property - find a given property in a given node
567*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
568*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to find
569*4882a593Smuzhiyun * @name: name of the property to find
570*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
571*4882a593Smuzhiyun *
572*4882a593Smuzhiyun * fdt_get_property() retrieves a pointer to the fdt_property
573*4882a593Smuzhiyun * structure within the device tree blob corresponding to the property
574*4882a593Smuzhiyun * named 'name' of the node at offset nodeoffset. If lenp is
575*4882a593Smuzhiyun * non-NULL, the length of the property value is also returned, in the
576*4882a593Smuzhiyun * integer pointed to by lenp.
577*4882a593Smuzhiyun *
578*4882a593Smuzhiyun * returns:
579*4882a593Smuzhiyun * pointer to the structure representing the property
580*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains the length of the property
581*4882a593Smuzhiyun * value (>=0)
582*4882a593Smuzhiyun * NULL, on error
583*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains an error code (<0):
584*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have named property
585*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE
586*4882a593Smuzhiyun * tag
587*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
588*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
589*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
590*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
591*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
592*4882a593Smuzhiyun */
593*4882a593Smuzhiyun const struct fdt_property *fdt_get_property(const void *fdt, int nodeoffset,
594*4882a593Smuzhiyun const char *name, int *lenp);
fdt_get_property_w(void * fdt,int nodeoffset,const char * name,int * lenp)595*4882a593Smuzhiyun static inline struct fdt_property *fdt_get_property_w(void *fdt, int nodeoffset,
596*4882a593Smuzhiyun const char *name,
597*4882a593Smuzhiyun int *lenp)
598*4882a593Smuzhiyun {
599*4882a593Smuzhiyun return (struct fdt_property *)(uintptr_t)
600*4882a593Smuzhiyun fdt_get_property(fdt, nodeoffset, name, lenp);
601*4882a593Smuzhiyun }
602*4882a593Smuzhiyun
603*4882a593Smuzhiyun /**
604*4882a593Smuzhiyun * fdt_getprop_by_offset - retrieve the value of a property at a given offset
605*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
606*4882a593Smuzhiyun * @ffset: offset of the property to read
607*4882a593Smuzhiyun * @namep: pointer to a string variable (will be overwritten) or NULL
608*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
609*4882a593Smuzhiyun *
610*4882a593Smuzhiyun * fdt_getprop_by_offset() retrieves a pointer to the value of the
611*4882a593Smuzhiyun * property at structure block offset 'offset' (this will be a pointer
612*4882a593Smuzhiyun * to within the device blob itself, not a copy of the value). If
613*4882a593Smuzhiyun * lenp is non-NULL, the length of the property value is also
614*4882a593Smuzhiyun * returned, in the integer pointed to by lenp. If namep is non-NULL,
615*4882a593Smuzhiyun * the property's namne will also be returned in the char * pointed to
616*4882a593Smuzhiyun * by namep (this will be a pointer to within the device tree's string
617*4882a593Smuzhiyun * block, not a new copy of the name).
618*4882a593Smuzhiyun *
619*4882a593Smuzhiyun * returns:
620*4882a593Smuzhiyun * pointer to the property's value
621*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains the length of the property
622*4882a593Smuzhiyun * value (>=0)
623*4882a593Smuzhiyun * if namep is non-NULL *namep contiains a pointer to the property
624*4882a593Smuzhiyun * name.
625*4882a593Smuzhiyun * NULL, on error
626*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains an error code (<0):
627*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag
628*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
629*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
630*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
631*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
632*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
633*4882a593Smuzhiyun */
634*4882a593Smuzhiyun #ifndef SWIG /* This function is not useful in Python */
635*4882a593Smuzhiyun const void *fdt_getprop_by_offset(const void *fdt, int offset,
636*4882a593Smuzhiyun const char **namep, int *lenp);
637*4882a593Smuzhiyun #endif
638*4882a593Smuzhiyun
639*4882a593Smuzhiyun /**
640*4882a593Smuzhiyun * fdt_getprop_namelen - get property value based on substring
641*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
642*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to find
643*4882a593Smuzhiyun * @name: name of the property to find
644*4882a593Smuzhiyun * @namelen: number of characters of name to consider
645*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
646*4882a593Smuzhiyun *
647*4882a593Smuzhiyun * Identical to fdt_getprop(), but only examine the first namelen
648*4882a593Smuzhiyun * characters of name for matching the property name.
649*4882a593Smuzhiyun */
650*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
651*4882a593Smuzhiyun const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
652*4882a593Smuzhiyun const char *name, int namelen, int *lenp);
fdt_getprop_namelen_w(void * fdt,int nodeoffset,const char * name,int namelen,int * lenp)653*4882a593Smuzhiyun static inline void *fdt_getprop_namelen_w(void *fdt, int nodeoffset,
654*4882a593Smuzhiyun const char *name, int namelen,
655*4882a593Smuzhiyun int *lenp)
656*4882a593Smuzhiyun {
657*4882a593Smuzhiyun return (void *)(uintptr_t)fdt_getprop_namelen(fdt, nodeoffset, name,
658*4882a593Smuzhiyun namelen, lenp);
659*4882a593Smuzhiyun }
660*4882a593Smuzhiyun #endif
661*4882a593Smuzhiyun
662*4882a593Smuzhiyun /**
663*4882a593Smuzhiyun * fdt_getprop - retrieve the value of a given property
664*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
665*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to find
666*4882a593Smuzhiyun * @name: name of the property to find
667*4882a593Smuzhiyun * @lenp: pointer to an integer variable (will be overwritten) or NULL
668*4882a593Smuzhiyun *
669*4882a593Smuzhiyun * fdt_getprop() retrieves a pointer to the value of the property
670*4882a593Smuzhiyun * named 'name' of the node at offset nodeoffset (this will be a
671*4882a593Smuzhiyun * pointer to within the device blob itself, not a copy of the value).
672*4882a593Smuzhiyun * If lenp is non-NULL, the length of the property value is also
673*4882a593Smuzhiyun * returned, in the integer pointed to by lenp.
674*4882a593Smuzhiyun *
675*4882a593Smuzhiyun * returns:
676*4882a593Smuzhiyun * pointer to the property's value
677*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains the length of the property
678*4882a593Smuzhiyun * value (>=0)
679*4882a593Smuzhiyun * NULL, on error
680*4882a593Smuzhiyun * if lenp is non-NULL, *lenp contains an error code (<0):
681*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have named property
682*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE
683*4882a593Smuzhiyun * tag
684*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
685*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
686*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
687*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
688*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
689*4882a593Smuzhiyun */
690*4882a593Smuzhiyun const void *fdt_getprop(const void *fdt, int nodeoffset,
691*4882a593Smuzhiyun const char *name, int *lenp);
fdt_getprop_w(void * fdt,int nodeoffset,const char * name,int * lenp)692*4882a593Smuzhiyun static inline void *fdt_getprop_w(void *fdt, int nodeoffset,
693*4882a593Smuzhiyun const char *name, int *lenp)
694*4882a593Smuzhiyun {
695*4882a593Smuzhiyun return (void *)(uintptr_t)fdt_getprop(fdt, nodeoffset, name, lenp);
696*4882a593Smuzhiyun }
697*4882a593Smuzhiyun
698*4882a593Smuzhiyun /**
699*4882a593Smuzhiyun * fdt_get_phandle - retrieve the phandle of a given node
700*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
701*4882a593Smuzhiyun * @nodeoffset: structure block offset of the node
702*4882a593Smuzhiyun *
703*4882a593Smuzhiyun * fdt_get_phandle() retrieves the phandle of the device tree node at
704*4882a593Smuzhiyun * structure block offset nodeoffset.
705*4882a593Smuzhiyun *
706*4882a593Smuzhiyun * returns:
707*4882a593Smuzhiyun * the phandle of the node at nodeoffset, on success (!= 0, != -1)
708*4882a593Smuzhiyun * 0, if the node has no phandle, or another error occurs
709*4882a593Smuzhiyun */
710*4882a593Smuzhiyun uint32_t fdt_get_phandle(const void *fdt, int nodeoffset);
711*4882a593Smuzhiyun
712*4882a593Smuzhiyun /**
713*4882a593Smuzhiyun * fdt_get_alias_namelen - get alias based on substring
714*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
715*4882a593Smuzhiyun * @name: name of the alias th look up
716*4882a593Smuzhiyun * @namelen: number of characters of name to consider
717*4882a593Smuzhiyun *
718*4882a593Smuzhiyun * Identical to fdt_get_alias(), but only examine the first namelen
719*4882a593Smuzhiyun * characters of name for matching the alias name.
720*4882a593Smuzhiyun */
721*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
722*4882a593Smuzhiyun const char *fdt_get_alias_namelen(const void *fdt,
723*4882a593Smuzhiyun const char *name, int namelen);
724*4882a593Smuzhiyun #endif
725*4882a593Smuzhiyun
726*4882a593Smuzhiyun /**
727*4882a593Smuzhiyun * fdt_get_alias - retrieve the path referenced by a given alias
728*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
729*4882a593Smuzhiyun * @name: name of the alias th look up
730*4882a593Smuzhiyun *
731*4882a593Smuzhiyun * fdt_get_alias() retrieves the value of a given alias. That is, the
732*4882a593Smuzhiyun * value of the property named 'name' in the node /aliases.
733*4882a593Smuzhiyun *
734*4882a593Smuzhiyun * returns:
735*4882a593Smuzhiyun * a pointer to the expansion of the alias named 'name', if it exists
736*4882a593Smuzhiyun * NULL, if the given alias or the /aliases node does not exist
737*4882a593Smuzhiyun */
738*4882a593Smuzhiyun const char *fdt_get_alias(const void *fdt, const char *name);
739*4882a593Smuzhiyun
740*4882a593Smuzhiyun /**
741*4882a593Smuzhiyun * fdt_get_path - determine the full path of a node
742*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
743*4882a593Smuzhiyun * @nodeoffset: offset of the node whose path to find
744*4882a593Smuzhiyun * @buf: character buffer to contain the returned path (will be overwritten)
745*4882a593Smuzhiyun * @buflen: size of the character buffer at buf
746*4882a593Smuzhiyun *
747*4882a593Smuzhiyun * fdt_get_path() computes the full path of the node at offset
748*4882a593Smuzhiyun * nodeoffset, and records that path in the buffer at buf.
749*4882a593Smuzhiyun *
750*4882a593Smuzhiyun * NOTE: This function is expensive, as it must scan the device tree
751*4882a593Smuzhiyun * structure from the start to nodeoffset.
752*4882a593Smuzhiyun *
753*4882a593Smuzhiyun * returns:
754*4882a593Smuzhiyun * 0, on success
755*4882a593Smuzhiyun * buf contains the absolute path of the node at
756*4882a593Smuzhiyun * nodeoffset, as a NUL-terminated string.
757*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
758*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, the path of the given node is longer than (bufsize-1)
759*4882a593Smuzhiyun * characters and will not fit in the given buffer.
760*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
761*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
762*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
763*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
764*4882a593Smuzhiyun */
765*4882a593Smuzhiyun int fdt_get_path(const void *fdt, int nodeoffset, char *buf, int buflen);
766*4882a593Smuzhiyun
767*4882a593Smuzhiyun /**
768*4882a593Smuzhiyun * fdt_supernode_atdepth_offset - find a specific ancestor of a node
769*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
770*4882a593Smuzhiyun * @nodeoffset: offset of the node whose parent to find
771*4882a593Smuzhiyun * @supernodedepth: depth of the ancestor to find
772*4882a593Smuzhiyun * @nodedepth: pointer to an integer variable (will be overwritten) or NULL
773*4882a593Smuzhiyun *
774*4882a593Smuzhiyun * fdt_supernode_atdepth_offset() finds an ancestor of the given node
775*4882a593Smuzhiyun * at a specific depth from the root (where the root itself has depth
776*4882a593Smuzhiyun * 0, its immediate subnodes depth 1 and so forth). So
777*4882a593Smuzhiyun * fdt_supernode_atdepth_offset(fdt, nodeoffset, 0, NULL);
778*4882a593Smuzhiyun * will always return 0, the offset of the root node. If the node at
779*4882a593Smuzhiyun * nodeoffset has depth D, then:
780*4882a593Smuzhiyun * fdt_supernode_atdepth_offset(fdt, nodeoffset, D, NULL);
781*4882a593Smuzhiyun * will return nodeoffset itself.
782*4882a593Smuzhiyun *
783*4882a593Smuzhiyun * NOTE: This function is expensive, as it must scan the device tree
784*4882a593Smuzhiyun * structure from the start to nodeoffset.
785*4882a593Smuzhiyun *
786*4882a593Smuzhiyun * returns:
787*4882a593Smuzhiyun * structure block offset of the node at node offset's ancestor
788*4882a593Smuzhiyun * of depth supernodedepth (>=0), on success
789*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
790*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, supernodedepth was greater than the depth of
791*4882a593Smuzhiyun * nodeoffset
792*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
793*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
794*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
795*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
796*4882a593Smuzhiyun */
797*4882a593Smuzhiyun int fdt_supernode_atdepth_offset(const void *fdt, int nodeoffset,
798*4882a593Smuzhiyun int supernodedepth, int *nodedepth);
799*4882a593Smuzhiyun
800*4882a593Smuzhiyun /**
801*4882a593Smuzhiyun * fdt_node_depth - find the depth of a given node
802*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
803*4882a593Smuzhiyun * @nodeoffset: offset of the node whose parent to find
804*4882a593Smuzhiyun *
805*4882a593Smuzhiyun * fdt_node_depth() finds the depth of a given node. The root node
806*4882a593Smuzhiyun * has depth 0, its immediate subnodes depth 1 and so forth.
807*4882a593Smuzhiyun *
808*4882a593Smuzhiyun * NOTE: This function is expensive, as it must scan the device tree
809*4882a593Smuzhiyun * structure from the start to nodeoffset.
810*4882a593Smuzhiyun *
811*4882a593Smuzhiyun * returns:
812*4882a593Smuzhiyun * depth of the node at nodeoffset (>=0), on success
813*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
814*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
815*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
816*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
817*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
818*4882a593Smuzhiyun */
819*4882a593Smuzhiyun int fdt_node_depth(const void *fdt, int nodeoffset);
820*4882a593Smuzhiyun
821*4882a593Smuzhiyun /**
822*4882a593Smuzhiyun * fdt_parent_offset - find the parent of a given node
823*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
824*4882a593Smuzhiyun * @nodeoffset: offset of the node whose parent to find
825*4882a593Smuzhiyun *
826*4882a593Smuzhiyun * fdt_parent_offset() locates the parent node of a given node (that
827*4882a593Smuzhiyun * is, it finds the offset of the node which contains the node at
828*4882a593Smuzhiyun * nodeoffset as a subnode).
829*4882a593Smuzhiyun *
830*4882a593Smuzhiyun * NOTE: This function is expensive, as it must scan the device tree
831*4882a593Smuzhiyun * structure from the start to nodeoffset, *twice*.
832*4882a593Smuzhiyun *
833*4882a593Smuzhiyun * returns:
834*4882a593Smuzhiyun * structure block offset of the parent of the node at nodeoffset
835*4882a593Smuzhiyun * (>=0), on success
836*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
837*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
838*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
839*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
840*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
841*4882a593Smuzhiyun */
842*4882a593Smuzhiyun int fdt_parent_offset(const void *fdt, int nodeoffset);
843*4882a593Smuzhiyun
844*4882a593Smuzhiyun /**
845*4882a593Smuzhiyun * fdt_node_offset_by_prop_value - find nodes with a given property value
846*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
847*4882a593Smuzhiyun * @startoffset: only find nodes after this offset
848*4882a593Smuzhiyun * @propname: property name to check
849*4882a593Smuzhiyun * @propval: property value to search for
850*4882a593Smuzhiyun * @proplen: length of the value in propval
851*4882a593Smuzhiyun *
852*4882a593Smuzhiyun * fdt_node_offset_by_prop_value() returns the offset of the first
853*4882a593Smuzhiyun * node after startoffset, which has a property named propname whose
854*4882a593Smuzhiyun * value is of length proplen and has value equal to propval; or if
855*4882a593Smuzhiyun * startoffset is -1, the very first such node in the tree.
856*4882a593Smuzhiyun *
857*4882a593Smuzhiyun * To iterate through all nodes matching the criterion, the following
858*4882a593Smuzhiyun * idiom can be used:
859*4882a593Smuzhiyun * offset = fdt_node_offset_by_prop_value(fdt, -1, propname,
860*4882a593Smuzhiyun * propval, proplen);
861*4882a593Smuzhiyun * while (offset != -FDT_ERR_NOTFOUND) {
862*4882a593Smuzhiyun * // other code here
863*4882a593Smuzhiyun * offset = fdt_node_offset_by_prop_value(fdt, offset, propname,
864*4882a593Smuzhiyun * propval, proplen);
865*4882a593Smuzhiyun * }
866*4882a593Smuzhiyun *
867*4882a593Smuzhiyun * Note the -1 in the first call to the function, if 0 is used here
868*4882a593Smuzhiyun * instead, the function will never locate the root node, even if it
869*4882a593Smuzhiyun * matches the criterion.
870*4882a593Smuzhiyun *
871*4882a593Smuzhiyun * returns:
872*4882a593Smuzhiyun * structure block offset of the located node (>= 0, >startoffset),
873*4882a593Smuzhiyun * on success
874*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, no node matching the criterion exists in the
875*4882a593Smuzhiyun * tree after startoffset
876*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
877*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
878*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
879*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
880*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
881*4882a593Smuzhiyun */
882*4882a593Smuzhiyun int fdt_node_offset_by_prop_value(const void *fdt, int startoffset,
883*4882a593Smuzhiyun const char *propname,
884*4882a593Smuzhiyun const void *propval, int proplen);
885*4882a593Smuzhiyun
886*4882a593Smuzhiyun /**
887*4882a593Smuzhiyun * fdt_node_offset_by_phandle - find the node with a given phandle
888*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
889*4882a593Smuzhiyun * @phandle: phandle value
890*4882a593Smuzhiyun *
891*4882a593Smuzhiyun * fdt_node_offset_by_phandle() returns the offset of the node
892*4882a593Smuzhiyun * which has the given phandle value. If there is more than one node
893*4882a593Smuzhiyun * in the tree with the given phandle (an invalid tree), results are
894*4882a593Smuzhiyun * undefined.
895*4882a593Smuzhiyun *
896*4882a593Smuzhiyun * returns:
897*4882a593Smuzhiyun * structure block offset of the located node (>= 0), on success
898*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, no node with that phandle exists
899*4882a593Smuzhiyun * -FDT_ERR_BADPHANDLE, given phandle value was invalid (0 or -1)
900*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
901*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
902*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
903*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
904*4882a593Smuzhiyun */
905*4882a593Smuzhiyun int fdt_node_offset_by_phandle(const void *fdt, uint32_t phandle);
906*4882a593Smuzhiyun
907*4882a593Smuzhiyun /**
908*4882a593Smuzhiyun * fdt_node_check_compatible: check a node's compatible property
909*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
910*4882a593Smuzhiyun * @nodeoffset: offset of a tree node
911*4882a593Smuzhiyun * @compatible: string to match against
912*4882a593Smuzhiyun *
913*4882a593Smuzhiyun *
914*4882a593Smuzhiyun * fdt_node_check_compatible() returns 0 if the given node contains a
915*4882a593Smuzhiyun * 'compatible' property with the given string as one of its elements,
916*4882a593Smuzhiyun * it returns non-zero otherwise, or on error.
917*4882a593Smuzhiyun *
918*4882a593Smuzhiyun * returns:
919*4882a593Smuzhiyun * 0, if the node has a 'compatible' property listing the given string
920*4882a593Smuzhiyun * 1, if the node has a 'compatible' property, but it does not list
921*4882a593Smuzhiyun * the given string
922*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, if the given node has no 'compatible' property
923*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, if nodeoffset does not refer to a BEGIN_NODE tag
924*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
925*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
926*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
927*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
928*4882a593Smuzhiyun */
929*4882a593Smuzhiyun int fdt_node_check_compatible(const void *fdt, int nodeoffset,
930*4882a593Smuzhiyun const char *compatible);
931*4882a593Smuzhiyun
932*4882a593Smuzhiyun /**
933*4882a593Smuzhiyun * fdt_node_offset_by_compatible - find nodes with a given 'compatible' value
934*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
935*4882a593Smuzhiyun * @startoffset: only find nodes after this offset
936*4882a593Smuzhiyun * @compatible: 'compatible' string to match against
937*4882a593Smuzhiyun *
938*4882a593Smuzhiyun * fdt_node_offset_by_compatible() returns the offset of the first
939*4882a593Smuzhiyun * node after startoffset, which has a 'compatible' property which
940*4882a593Smuzhiyun * lists the given compatible string; or if startoffset is -1, the
941*4882a593Smuzhiyun * very first such node in the tree.
942*4882a593Smuzhiyun *
943*4882a593Smuzhiyun * To iterate through all nodes matching the criterion, the following
944*4882a593Smuzhiyun * idiom can be used:
945*4882a593Smuzhiyun * offset = fdt_node_offset_by_compatible(fdt, -1, compatible);
946*4882a593Smuzhiyun * while (offset != -FDT_ERR_NOTFOUND) {
947*4882a593Smuzhiyun * // other code here
948*4882a593Smuzhiyun * offset = fdt_node_offset_by_compatible(fdt, offset, compatible);
949*4882a593Smuzhiyun * }
950*4882a593Smuzhiyun *
951*4882a593Smuzhiyun * Note the -1 in the first call to the function, if 0 is used here
952*4882a593Smuzhiyun * instead, the function will never locate the root node, even if it
953*4882a593Smuzhiyun * matches the criterion.
954*4882a593Smuzhiyun *
955*4882a593Smuzhiyun * returns:
956*4882a593Smuzhiyun * structure block offset of the located node (>= 0, >startoffset),
957*4882a593Smuzhiyun * on success
958*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, no node matching the criterion exists in the
959*4882a593Smuzhiyun * tree after startoffset
960*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
961*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
962*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
963*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
964*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE, standard meanings
965*4882a593Smuzhiyun */
966*4882a593Smuzhiyun int fdt_node_offset_by_compatible(const void *fdt, int startoffset,
967*4882a593Smuzhiyun const char *compatible);
968*4882a593Smuzhiyun
969*4882a593Smuzhiyun /**
970*4882a593Smuzhiyun * fdt_stringlist_contains - check a string list property for a string
971*4882a593Smuzhiyun * @strlist: Property containing a list of strings to check
972*4882a593Smuzhiyun * @listlen: Length of property
973*4882a593Smuzhiyun * @str: String to search for
974*4882a593Smuzhiyun *
975*4882a593Smuzhiyun * This is a utility function provided for convenience. The list contains
976*4882a593Smuzhiyun * one or more strings, each terminated by \0, as is found in a device tree
977*4882a593Smuzhiyun * "compatible" property.
978*4882a593Smuzhiyun *
979*4882a593Smuzhiyun * @return: 1 if the string is found in the list, 0 not found, or invalid list
980*4882a593Smuzhiyun */
981*4882a593Smuzhiyun int fdt_stringlist_contains(const char *strlist, int listlen, const char *str);
982*4882a593Smuzhiyun
983*4882a593Smuzhiyun /**
984*4882a593Smuzhiyun * fdt_stringlist_count - count the number of strings in a string list
985*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
986*4882a593Smuzhiyun * @nodeoffset: offset of a tree node
987*4882a593Smuzhiyun * @property: name of the property containing the string list
988*4882a593Smuzhiyun * @return:
989*4882a593Smuzhiyun * the number of strings in the given property
990*4882a593Smuzhiyun * -FDT_ERR_BADVALUE if the property value is not NUL-terminated
991*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND if the property does not exist
992*4882a593Smuzhiyun */
993*4882a593Smuzhiyun int fdt_stringlist_count(const void *fdt, int nodeoffset, const char *property);
994*4882a593Smuzhiyun
995*4882a593Smuzhiyun /**
996*4882a593Smuzhiyun * fdt_stringlist_search - find a string in a string list and return its index
997*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
998*4882a593Smuzhiyun * @nodeoffset: offset of a tree node
999*4882a593Smuzhiyun * @property: name of the property containing the string list
1000*4882a593Smuzhiyun * @string: string to look up in the string list
1001*4882a593Smuzhiyun *
1002*4882a593Smuzhiyun * Note that it is possible for this function to succeed on property values
1003*4882a593Smuzhiyun * that are not NUL-terminated. That's because the function will stop after
1004*4882a593Smuzhiyun * finding the first occurrence of @string. This can for example happen with
1005*4882a593Smuzhiyun * small-valued cell properties, such as #address-cells, when searching for
1006*4882a593Smuzhiyun * the empty string.
1007*4882a593Smuzhiyun *
1008*4882a593Smuzhiyun * @return:
1009*4882a593Smuzhiyun * the index of the string in the list of strings
1010*4882a593Smuzhiyun * -FDT_ERR_BADVALUE if the property value is not NUL-terminated
1011*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND if the property does not exist or does not contain
1012*4882a593Smuzhiyun * the given string
1013*4882a593Smuzhiyun */
1014*4882a593Smuzhiyun int fdt_stringlist_search(const void *fdt, int nodeoffset, const char *property,
1015*4882a593Smuzhiyun const char *string);
1016*4882a593Smuzhiyun
1017*4882a593Smuzhiyun /**
1018*4882a593Smuzhiyun * fdt_stringlist_get() - obtain the string at a given index in a string list
1019*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1020*4882a593Smuzhiyun * @nodeoffset: offset of a tree node
1021*4882a593Smuzhiyun * @property: name of the property containing the string list
1022*4882a593Smuzhiyun * @index: index of the string to return
1023*4882a593Smuzhiyun * @lenp: return location for the string length or an error code on failure
1024*4882a593Smuzhiyun *
1025*4882a593Smuzhiyun * Note that this will successfully extract strings from properties with
1026*4882a593Smuzhiyun * non-NUL-terminated values. For example on small-valued cell properties
1027*4882a593Smuzhiyun * this function will return the empty string.
1028*4882a593Smuzhiyun *
1029*4882a593Smuzhiyun * If non-NULL, the length of the string (on success) or a negative error-code
1030*4882a593Smuzhiyun * (on failure) will be stored in the integer pointer to by lenp.
1031*4882a593Smuzhiyun *
1032*4882a593Smuzhiyun * @return:
1033*4882a593Smuzhiyun * A pointer to the string at the given index in the string list or NULL on
1034*4882a593Smuzhiyun * failure. On success the length of the string will be stored in the memory
1035*4882a593Smuzhiyun * location pointed to by the lenp parameter, if non-NULL. On failure one of
1036*4882a593Smuzhiyun * the following negative error codes will be returned in the lenp parameter
1037*4882a593Smuzhiyun * (if non-NULL):
1038*4882a593Smuzhiyun * -FDT_ERR_BADVALUE if the property value is not NUL-terminated
1039*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND if the property does not exist
1040*4882a593Smuzhiyun */
1041*4882a593Smuzhiyun const char *fdt_stringlist_get(const void *fdt, int nodeoffset,
1042*4882a593Smuzhiyun const char *property, int index,
1043*4882a593Smuzhiyun int *lenp);
1044*4882a593Smuzhiyun
1045*4882a593Smuzhiyun /**********************************************************************/
1046*4882a593Smuzhiyun /* Read-only functions (addressing related) */
1047*4882a593Smuzhiyun /**********************************************************************/
1048*4882a593Smuzhiyun
1049*4882a593Smuzhiyun /**
1050*4882a593Smuzhiyun * FDT_MAX_NCELLS - maximum value for #address-cells and #size-cells
1051*4882a593Smuzhiyun *
1052*4882a593Smuzhiyun * This is the maximum value for #address-cells, #size-cells and
1053*4882a593Smuzhiyun * similar properties that will be processed by libfdt. IEE1275
1054*4882a593Smuzhiyun * requires that OF implementations handle values up to 4.
1055*4882a593Smuzhiyun * Implementations may support larger values, but in practice higher
1056*4882a593Smuzhiyun * values aren't used.
1057*4882a593Smuzhiyun */
1058*4882a593Smuzhiyun #define FDT_MAX_NCELLS 4
1059*4882a593Smuzhiyun
1060*4882a593Smuzhiyun /**
1061*4882a593Smuzhiyun * fdt_address_cells - retrieve address size for a bus represented in the tree
1062*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1063*4882a593Smuzhiyun * @nodeoffset: offset of the node to find the address size for
1064*4882a593Smuzhiyun *
1065*4882a593Smuzhiyun * When the node has a valid #address-cells property, returns its value.
1066*4882a593Smuzhiyun *
1067*4882a593Smuzhiyun * returns:
1068*4882a593Smuzhiyun * 0 <= n < FDT_MAX_NCELLS, on success
1069*4882a593Smuzhiyun * 2, if the node has no #address-cells property
1070*4882a593Smuzhiyun * -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
1071*4882a593Smuzhiyun * #address-cells property
1072*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1073*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1074*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1075*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1076*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1077*4882a593Smuzhiyun */
1078*4882a593Smuzhiyun int fdt_address_cells(const void *fdt, int nodeoffset);
1079*4882a593Smuzhiyun
1080*4882a593Smuzhiyun /**
1081*4882a593Smuzhiyun * fdt_size_cells - retrieve address range size for a bus represented in the
1082*4882a593Smuzhiyun * tree
1083*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1084*4882a593Smuzhiyun * @nodeoffset: offset of the node to find the address range size for
1085*4882a593Smuzhiyun *
1086*4882a593Smuzhiyun * When the node has a valid #size-cells property, returns its value.
1087*4882a593Smuzhiyun *
1088*4882a593Smuzhiyun * returns:
1089*4882a593Smuzhiyun * 0 <= n < FDT_MAX_NCELLS, on success
1090*4882a593Smuzhiyun * 2, if the node has no #address-cells property
1091*4882a593Smuzhiyun * -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
1092*4882a593Smuzhiyun * #size-cells property
1093*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1094*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1095*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1096*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1097*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1098*4882a593Smuzhiyun */
1099*4882a593Smuzhiyun int fdt_size_cells(const void *fdt, int nodeoffset);
1100*4882a593Smuzhiyun
1101*4882a593Smuzhiyun
1102*4882a593Smuzhiyun /**********************************************************************/
1103*4882a593Smuzhiyun /* Write-in-place functions */
1104*4882a593Smuzhiyun /**********************************************************************/
1105*4882a593Smuzhiyun
1106*4882a593Smuzhiyun /**
1107*4882a593Smuzhiyun * fdt_setprop_inplace_namelen_partial - change a property's value,
1108*4882a593Smuzhiyun * but not its size
1109*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1110*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1111*4882a593Smuzhiyun * @name: name of the property to change
1112*4882a593Smuzhiyun * @namelen: number of characters of name to consider
1113*4882a593Smuzhiyun * @idx: index of the property to change in the array
1114*4882a593Smuzhiyun * @val: pointer to data to replace the property value with
1115*4882a593Smuzhiyun * @len: length of the property value
1116*4882a593Smuzhiyun *
1117*4882a593Smuzhiyun * Identical to fdt_setprop_inplace(), but modifies the given property
1118*4882a593Smuzhiyun * starting from the given index, and using only the first characters
1119*4882a593Smuzhiyun * of the name. It is useful when you want to manipulate only one value of
1120*4882a593Smuzhiyun * an array and you have a string that doesn't end with \0.
1121*4882a593Smuzhiyun */
1122*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
1123*4882a593Smuzhiyun int fdt_setprop_inplace_namelen_partial(void *fdt, int nodeoffset,
1124*4882a593Smuzhiyun const char *name, int namelen,
1125*4882a593Smuzhiyun uint32_t idx, const void *val,
1126*4882a593Smuzhiyun int len);
1127*4882a593Smuzhiyun #endif
1128*4882a593Smuzhiyun
1129*4882a593Smuzhiyun /**
1130*4882a593Smuzhiyun * fdt_setprop_inplace - change a property's value, but not its size
1131*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1132*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1133*4882a593Smuzhiyun * @name: name of the property to change
1134*4882a593Smuzhiyun * @val: pointer to data to replace the property value with
1135*4882a593Smuzhiyun * @len: length of the property value
1136*4882a593Smuzhiyun *
1137*4882a593Smuzhiyun * fdt_setprop_inplace() replaces the value of a given property with
1138*4882a593Smuzhiyun * the data in val, of length len. This function cannot change the
1139*4882a593Smuzhiyun * size of a property, and so will only work if len is equal to the
1140*4882a593Smuzhiyun * current length of the property.
1141*4882a593Smuzhiyun *
1142*4882a593Smuzhiyun * This function will alter only the bytes in the blob which contain
1143*4882a593Smuzhiyun * the given property value, and will not alter or move any other part
1144*4882a593Smuzhiyun * of the tree.
1145*4882a593Smuzhiyun *
1146*4882a593Smuzhiyun * returns:
1147*4882a593Smuzhiyun * 0, on success
1148*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, if len is not equal to the property's current length
1149*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have the named property
1150*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1151*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1152*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1153*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1154*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1155*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1156*4882a593Smuzhiyun */
1157*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
1158*4882a593Smuzhiyun int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,
1159*4882a593Smuzhiyun const void *val, int len);
1160*4882a593Smuzhiyun #endif
1161*4882a593Smuzhiyun
1162*4882a593Smuzhiyun /**
1163*4882a593Smuzhiyun * fdt_setprop_inplace_u32 - change the value of a 32-bit integer property
1164*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1165*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1166*4882a593Smuzhiyun * @name: name of the property to change
1167*4882a593Smuzhiyun * @val: 32-bit integer value to replace the property with
1168*4882a593Smuzhiyun *
1169*4882a593Smuzhiyun * fdt_setprop_inplace_u32() replaces the value of a given property
1170*4882a593Smuzhiyun * with the 32-bit integer value in val, converting val to big-endian
1171*4882a593Smuzhiyun * if necessary. This function cannot change the size of a property,
1172*4882a593Smuzhiyun * and so will only work if the property already exists and has length
1173*4882a593Smuzhiyun * 4.
1174*4882a593Smuzhiyun *
1175*4882a593Smuzhiyun * This function will alter only the bytes in the blob which contain
1176*4882a593Smuzhiyun * the given property value, and will not alter or move any other part
1177*4882a593Smuzhiyun * of the tree.
1178*4882a593Smuzhiyun *
1179*4882a593Smuzhiyun * returns:
1180*4882a593Smuzhiyun * 0, on success
1181*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, if the property's length is not equal to 4
1182*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have the named property
1183*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1184*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1185*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1186*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1187*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1188*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1189*4882a593Smuzhiyun */
fdt_setprop_inplace_u32(void * fdt,int nodeoffset,const char * name,uint32_t val)1190*4882a593Smuzhiyun static inline int fdt_setprop_inplace_u32(void *fdt, int nodeoffset,
1191*4882a593Smuzhiyun const char *name, uint32_t val)
1192*4882a593Smuzhiyun {
1193*4882a593Smuzhiyun fdt32_t tmp = cpu_to_fdt32(val);
1194*4882a593Smuzhiyun return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1195*4882a593Smuzhiyun }
1196*4882a593Smuzhiyun
1197*4882a593Smuzhiyun /**
1198*4882a593Smuzhiyun * fdt_setprop_inplace_u64 - change the value of a 64-bit integer property
1199*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1200*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1201*4882a593Smuzhiyun * @name: name of the property to change
1202*4882a593Smuzhiyun * @val: 64-bit integer value to replace the property with
1203*4882a593Smuzhiyun *
1204*4882a593Smuzhiyun * fdt_setprop_inplace_u64() replaces the value of a given property
1205*4882a593Smuzhiyun * with the 64-bit integer value in val, converting val to big-endian
1206*4882a593Smuzhiyun * if necessary. This function cannot change the size of a property,
1207*4882a593Smuzhiyun * and so will only work if the property already exists and has length
1208*4882a593Smuzhiyun * 8.
1209*4882a593Smuzhiyun *
1210*4882a593Smuzhiyun * This function will alter only the bytes in the blob which contain
1211*4882a593Smuzhiyun * the given property value, and will not alter or move any other part
1212*4882a593Smuzhiyun * of the tree.
1213*4882a593Smuzhiyun *
1214*4882a593Smuzhiyun * returns:
1215*4882a593Smuzhiyun * 0, on success
1216*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, if the property's length is not equal to 8
1217*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have the named property
1218*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1219*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1220*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1221*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1222*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1223*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1224*4882a593Smuzhiyun */
fdt_setprop_inplace_u64(void * fdt,int nodeoffset,const char * name,uint64_t val)1225*4882a593Smuzhiyun static inline int fdt_setprop_inplace_u64(void *fdt, int nodeoffset,
1226*4882a593Smuzhiyun const char *name, uint64_t val)
1227*4882a593Smuzhiyun {
1228*4882a593Smuzhiyun fdt64_t tmp = cpu_to_fdt64(val);
1229*4882a593Smuzhiyun return fdt_setprop_inplace(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1230*4882a593Smuzhiyun }
1231*4882a593Smuzhiyun
1232*4882a593Smuzhiyun /**
1233*4882a593Smuzhiyun * fdt_setprop_inplace_cell - change the value of a single-cell property
1234*4882a593Smuzhiyun *
1235*4882a593Smuzhiyun * This is an alternative name for fdt_setprop_inplace_u32()
1236*4882a593Smuzhiyun */
fdt_setprop_inplace_cell(void * fdt,int nodeoffset,const char * name,uint32_t val)1237*4882a593Smuzhiyun static inline int fdt_setprop_inplace_cell(void *fdt, int nodeoffset,
1238*4882a593Smuzhiyun const char *name, uint32_t val)
1239*4882a593Smuzhiyun {
1240*4882a593Smuzhiyun return fdt_setprop_inplace_u32(fdt, nodeoffset, name, val);
1241*4882a593Smuzhiyun }
1242*4882a593Smuzhiyun
1243*4882a593Smuzhiyun /**
1244*4882a593Smuzhiyun * fdt_nop_property - replace a property with nop tags
1245*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1246*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to nop
1247*4882a593Smuzhiyun * @name: name of the property to nop
1248*4882a593Smuzhiyun *
1249*4882a593Smuzhiyun * fdt_nop_property() will replace a given property's representation
1250*4882a593Smuzhiyun * in the blob with FDT_NOP tags, effectively removing it from the
1251*4882a593Smuzhiyun * tree.
1252*4882a593Smuzhiyun *
1253*4882a593Smuzhiyun * This function will alter only the bytes in the blob which contain
1254*4882a593Smuzhiyun * the property, and will not alter or move any other part of the
1255*4882a593Smuzhiyun * tree.
1256*4882a593Smuzhiyun *
1257*4882a593Smuzhiyun * returns:
1258*4882a593Smuzhiyun * 0, on success
1259*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have the named property
1260*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1261*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1262*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1263*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1264*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1265*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1266*4882a593Smuzhiyun */
1267*4882a593Smuzhiyun int fdt_nop_property(void *fdt, int nodeoffset, const char *name);
1268*4882a593Smuzhiyun
1269*4882a593Smuzhiyun /**
1270*4882a593Smuzhiyun * fdt_nop_node - replace a node (subtree) with nop tags
1271*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1272*4882a593Smuzhiyun * @nodeoffset: offset of the node to nop
1273*4882a593Smuzhiyun *
1274*4882a593Smuzhiyun * fdt_nop_node() will replace a given node's representation in the
1275*4882a593Smuzhiyun * blob, including all its subnodes, if any, with FDT_NOP tags,
1276*4882a593Smuzhiyun * effectively removing it from the tree.
1277*4882a593Smuzhiyun *
1278*4882a593Smuzhiyun * This function will alter only the bytes in the blob which contain
1279*4882a593Smuzhiyun * the node and its properties and subnodes, and will not alter or
1280*4882a593Smuzhiyun * move any other part of the tree.
1281*4882a593Smuzhiyun *
1282*4882a593Smuzhiyun * returns:
1283*4882a593Smuzhiyun * 0, on success
1284*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1285*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1286*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1287*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1288*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1289*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1290*4882a593Smuzhiyun */
1291*4882a593Smuzhiyun int fdt_nop_node(void *fdt, int nodeoffset);
1292*4882a593Smuzhiyun
1293*4882a593Smuzhiyun /**********************************************************************/
1294*4882a593Smuzhiyun /* Sequential write functions */
1295*4882a593Smuzhiyun /**********************************************************************/
1296*4882a593Smuzhiyun
1297*4882a593Smuzhiyun int fdt_create(void *buf, int bufsize);
1298*4882a593Smuzhiyun int fdt_resize(void *fdt, void *buf, int bufsize);
1299*4882a593Smuzhiyun int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size);
1300*4882a593Smuzhiyun int fdt_finish_reservemap(void *fdt);
1301*4882a593Smuzhiyun int fdt_begin_node(void *fdt, const char *name);
1302*4882a593Smuzhiyun int fdt_property(void *fdt, const char *name, const void *val, int len);
fdt_property_u32(void * fdt,const char * name,uint32_t val)1303*4882a593Smuzhiyun static inline int fdt_property_u32(void *fdt, const char *name, uint32_t val)
1304*4882a593Smuzhiyun {
1305*4882a593Smuzhiyun fdt32_t tmp = cpu_to_fdt32(val);
1306*4882a593Smuzhiyun return fdt_property(fdt, name, &tmp, sizeof(tmp));
1307*4882a593Smuzhiyun }
fdt_property_u64(void * fdt,const char * name,uint64_t val)1308*4882a593Smuzhiyun static inline int fdt_property_u64(void *fdt, const char *name, uint64_t val)
1309*4882a593Smuzhiyun {
1310*4882a593Smuzhiyun fdt64_t tmp = cpu_to_fdt64(val);
1311*4882a593Smuzhiyun return fdt_property(fdt, name, &tmp, sizeof(tmp));
1312*4882a593Smuzhiyun }
fdt_property_cell(void * fdt,const char * name,uint32_t val)1313*4882a593Smuzhiyun static inline int fdt_property_cell(void *fdt, const char *name, uint32_t val)
1314*4882a593Smuzhiyun {
1315*4882a593Smuzhiyun return fdt_property_u32(fdt, name, val);
1316*4882a593Smuzhiyun }
1317*4882a593Smuzhiyun
1318*4882a593Smuzhiyun /**
1319*4882a593Smuzhiyun * fdt_property_placeholder - add a new property and return a ptr to its value
1320*4882a593Smuzhiyun *
1321*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1322*4882a593Smuzhiyun * @name: name of property to add
1323*4882a593Smuzhiyun * @len: length of property value in bytes
1324*4882a593Smuzhiyun * @valp: returns a pointer to where where the value should be placed
1325*4882a593Smuzhiyun *
1326*4882a593Smuzhiyun * returns:
1327*4882a593Smuzhiyun * 0, on success
1328*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1329*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, standard meanings
1330*4882a593Smuzhiyun */
1331*4882a593Smuzhiyun int fdt_property_placeholder(void *fdt, const char *name, int len, void **valp);
1332*4882a593Smuzhiyun
1333*4882a593Smuzhiyun #define fdt_property_string(fdt, name, str) \
1334*4882a593Smuzhiyun fdt_property(fdt, name, str, strlen(str)+1)
1335*4882a593Smuzhiyun int fdt_end_node(void *fdt);
1336*4882a593Smuzhiyun int fdt_finish(void *fdt);
1337*4882a593Smuzhiyun
1338*4882a593Smuzhiyun /**********************************************************************/
1339*4882a593Smuzhiyun /* Read-write functions */
1340*4882a593Smuzhiyun /**********************************************************************/
1341*4882a593Smuzhiyun
1342*4882a593Smuzhiyun int fdt_create_empty_tree(void *buf, int bufsize);
1343*4882a593Smuzhiyun int fdt_open_into(const void *fdt, void *buf, int bufsize);
1344*4882a593Smuzhiyun int fdt_pack(void *fdt);
1345*4882a593Smuzhiyun
1346*4882a593Smuzhiyun /**
1347*4882a593Smuzhiyun * fdt_add_mem_rsv - add one memory reserve map entry
1348*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1349*4882a593Smuzhiyun * @address, @size: 64-bit values (native endian)
1350*4882a593Smuzhiyun *
1351*4882a593Smuzhiyun * Adds a reserve map entry to the given blob reserving a region at
1352*4882a593Smuzhiyun * address address of length size.
1353*4882a593Smuzhiyun *
1354*4882a593Smuzhiyun * This function will insert data into the reserve map and will
1355*4882a593Smuzhiyun * therefore change the indexes of some entries in the table.
1356*4882a593Smuzhiyun *
1357*4882a593Smuzhiyun * returns:
1358*4882a593Smuzhiyun * 0, on success
1359*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1360*4882a593Smuzhiyun * contain the new reservation entry
1361*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1362*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1363*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1364*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1365*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1366*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1367*4882a593Smuzhiyun */
1368*4882a593Smuzhiyun int fdt_add_mem_rsv(void *fdt, uint64_t address, uint64_t size);
1369*4882a593Smuzhiyun
1370*4882a593Smuzhiyun /**
1371*4882a593Smuzhiyun * fdt_del_mem_rsv - remove a memory reserve map entry
1372*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1373*4882a593Smuzhiyun * @n: entry to remove
1374*4882a593Smuzhiyun *
1375*4882a593Smuzhiyun * fdt_del_mem_rsv() removes the n-th memory reserve map entry from
1376*4882a593Smuzhiyun * the blob.
1377*4882a593Smuzhiyun *
1378*4882a593Smuzhiyun * This function will delete data from the reservation table and will
1379*4882a593Smuzhiyun * therefore change the indexes of some entries in the table.
1380*4882a593Smuzhiyun *
1381*4882a593Smuzhiyun * returns:
1382*4882a593Smuzhiyun * 0, on success
1383*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, there is no entry of the given index (i.e. there
1384*4882a593Smuzhiyun * are less than n+1 reserve map entries)
1385*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1386*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1387*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1388*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1389*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1390*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1391*4882a593Smuzhiyun */
1392*4882a593Smuzhiyun int fdt_del_mem_rsv(void *fdt, int n);
1393*4882a593Smuzhiyun
1394*4882a593Smuzhiyun /**
1395*4882a593Smuzhiyun * fdt_set_name - change the name of a given node
1396*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1397*4882a593Smuzhiyun * @nodeoffset: structure block offset of a node
1398*4882a593Smuzhiyun * @name: name to give the node
1399*4882a593Smuzhiyun *
1400*4882a593Smuzhiyun * fdt_set_name() replaces the name (including unit address, if any)
1401*4882a593Smuzhiyun * of the given node with the given string. NOTE: this function can't
1402*4882a593Smuzhiyun * efficiently check if the new name is unique amongst the given
1403*4882a593Smuzhiyun * node's siblings; results are undefined if this function is invoked
1404*4882a593Smuzhiyun * with a name equal to one of the given node's siblings.
1405*4882a593Smuzhiyun *
1406*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1407*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1408*4882a593Smuzhiyun *
1409*4882a593Smuzhiyun * returns:
1410*4882a593Smuzhiyun * 0, on success
1411*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob
1412*4882a593Smuzhiyun * to contain the new name
1413*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1414*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1415*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1416*4882a593Smuzhiyun * -FDT_ERR_BADSTATE, standard meanings
1417*4882a593Smuzhiyun */
1418*4882a593Smuzhiyun int fdt_set_name(void *fdt, int nodeoffset, const char *name);
1419*4882a593Smuzhiyun
1420*4882a593Smuzhiyun /**
1421*4882a593Smuzhiyun * fdt_setprop - create or change a property
1422*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1423*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1424*4882a593Smuzhiyun * @name: name of the property to change
1425*4882a593Smuzhiyun * @val: pointer to data to set the property value to
1426*4882a593Smuzhiyun * @len: length of the property value
1427*4882a593Smuzhiyun *
1428*4882a593Smuzhiyun * fdt_setprop() sets the value of the named property in the given
1429*4882a593Smuzhiyun * node to the given value and length, creating the property if it
1430*4882a593Smuzhiyun * does not already exist.
1431*4882a593Smuzhiyun *
1432*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1433*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1434*4882a593Smuzhiyun *
1435*4882a593Smuzhiyun * returns:
1436*4882a593Smuzhiyun * 0, on success
1437*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1438*4882a593Smuzhiyun * contain the new property value
1439*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1440*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1441*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1442*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1443*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1444*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1445*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1446*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1447*4882a593Smuzhiyun */
1448*4882a593Smuzhiyun int fdt_setprop(void *fdt, int nodeoffset, const char *name,
1449*4882a593Smuzhiyun const void *val, int len);
1450*4882a593Smuzhiyun
1451*4882a593Smuzhiyun /**
1452*4882a593Smuzhiyun * fdt_setprop _placeholder - allocate space for a property
1453*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1454*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1455*4882a593Smuzhiyun * @name: name of the property to change
1456*4882a593Smuzhiyun * @len: length of the property value
1457*4882a593Smuzhiyun * @prop_data: return pointer to property data
1458*4882a593Smuzhiyun *
1459*4882a593Smuzhiyun * fdt_setprop_placeholer() allocates the named property in the given node.
1460*4882a593Smuzhiyun * If the property exists it is resized. In either case a pointer to the
1461*4882a593Smuzhiyun * property data is returned.
1462*4882a593Smuzhiyun *
1463*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1464*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1465*4882a593Smuzhiyun *
1466*4882a593Smuzhiyun * returns:
1467*4882a593Smuzhiyun * 0, on success
1468*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1469*4882a593Smuzhiyun * contain the new property value
1470*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1471*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1472*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1473*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1474*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1475*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1476*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1477*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1478*4882a593Smuzhiyun */
1479*4882a593Smuzhiyun int fdt_setprop_placeholder(void *fdt, int nodeoffset, const char *name,
1480*4882a593Smuzhiyun int len, void **prop_data);
1481*4882a593Smuzhiyun
1482*4882a593Smuzhiyun /**
1483*4882a593Smuzhiyun * fdt_setprop_u32 - set a property to a 32-bit integer
1484*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1485*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1486*4882a593Smuzhiyun * @name: name of the property to change
1487*4882a593Smuzhiyun * @val: 32-bit integer value for the property (native endian)
1488*4882a593Smuzhiyun *
1489*4882a593Smuzhiyun * fdt_setprop_u32() sets the value of the named property in the given
1490*4882a593Smuzhiyun * node to the given 32-bit integer value (converting to big-endian if
1491*4882a593Smuzhiyun * necessary), or creates a new property with that value if it does
1492*4882a593Smuzhiyun * not already exist.
1493*4882a593Smuzhiyun *
1494*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1495*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1496*4882a593Smuzhiyun *
1497*4882a593Smuzhiyun * returns:
1498*4882a593Smuzhiyun * 0, on success
1499*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1500*4882a593Smuzhiyun * contain the new property value
1501*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1502*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1503*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1504*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1505*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1506*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1507*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1508*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1509*4882a593Smuzhiyun */
fdt_setprop_u32(void * fdt,int nodeoffset,const char * name,uint32_t val)1510*4882a593Smuzhiyun static inline int fdt_setprop_u32(void *fdt, int nodeoffset, const char *name,
1511*4882a593Smuzhiyun uint32_t val)
1512*4882a593Smuzhiyun {
1513*4882a593Smuzhiyun fdt32_t tmp = cpu_to_fdt32(val);
1514*4882a593Smuzhiyun return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1515*4882a593Smuzhiyun }
1516*4882a593Smuzhiyun
1517*4882a593Smuzhiyun /**
1518*4882a593Smuzhiyun * fdt_setprop_u64 - set a property to a 64-bit integer
1519*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1520*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1521*4882a593Smuzhiyun * @name: name of the property to change
1522*4882a593Smuzhiyun * @val: 64-bit integer value for the property (native endian)
1523*4882a593Smuzhiyun *
1524*4882a593Smuzhiyun * fdt_setprop_u64() sets the value of the named property in the given
1525*4882a593Smuzhiyun * node to the given 64-bit integer value (converting to big-endian if
1526*4882a593Smuzhiyun * necessary), or creates a new property with that value if it does
1527*4882a593Smuzhiyun * not already exist.
1528*4882a593Smuzhiyun *
1529*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1530*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1531*4882a593Smuzhiyun *
1532*4882a593Smuzhiyun * returns:
1533*4882a593Smuzhiyun * 0, on success
1534*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1535*4882a593Smuzhiyun * contain the new property value
1536*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1537*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1538*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1539*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1540*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1541*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1542*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1543*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1544*4882a593Smuzhiyun */
fdt_setprop_u64(void * fdt,int nodeoffset,const char * name,uint64_t val)1545*4882a593Smuzhiyun static inline int fdt_setprop_u64(void *fdt, int nodeoffset, const char *name,
1546*4882a593Smuzhiyun uint64_t val)
1547*4882a593Smuzhiyun {
1548*4882a593Smuzhiyun fdt64_t tmp = cpu_to_fdt64(val);
1549*4882a593Smuzhiyun return fdt_setprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1550*4882a593Smuzhiyun }
1551*4882a593Smuzhiyun
1552*4882a593Smuzhiyun /**
1553*4882a593Smuzhiyun * fdt_setprop_cell - set a property to a single cell value
1554*4882a593Smuzhiyun *
1555*4882a593Smuzhiyun * This is an alternative name for fdt_setprop_u32()
1556*4882a593Smuzhiyun */
fdt_setprop_cell(void * fdt,int nodeoffset,const char * name,uint32_t val)1557*4882a593Smuzhiyun static inline int fdt_setprop_cell(void *fdt, int nodeoffset, const char *name,
1558*4882a593Smuzhiyun uint32_t val)
1559*4882a593Smuzhiyun {
1560*4882a593Smuzhiyun return fdt_setprop_u32(fdt, nodeoffset, name, val);
1561*4882a593Smuzhiyun }
1562*4882a593Smuzhiyun
1563*4882a593Smuzhiyun /**
1564*4882a593Smuzhiyun * fdt_setprop_string - set a property to a string value
1565*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1566*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1567*4882a593Smuzhiyun * @name: name of the property to change
1568*4882a593Smuzhiyun * @str: string value for the property
1569*4882a593Smuzhiyun *
1570*4882a593Smuzhiyun * fdt_setprop_string() sets the value of the named property in the
1571*4882a593Smuzhiyun * given node to the given string value (using the length of the
1572*4882a593Smuzhiyun * string to determine the new length of the property), or creates a
1573*4882a593Smuzhiyun * new property with that value if it does not already exist.
1574*4882a593Smuzhiyun *
1575*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1576*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1577*4882a593Smuzhiyun *
1578*4882a593Smuzhiyun * returns:
1579*4882a593Smuzhiyun * 0, on success
1580*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1581*4882a593Smuzhiyun * contain the new property value
1582*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1583*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1584*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1585*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1586*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1587*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1588*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1589*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1590*4882a593Smuzhiyun */
1591*4882a593Smuzhiyun #define fdt_setprop_string(fdt, nodeoffset, name, str) \
1592*4882a593Smuzhiyun fdt_setprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
1593*4882a593Smuzhiyun
1594*4882a593Smuzhiyun
1595*4882a593Smuzhiyun /**
1596*4882a593Smuzhiyun * fdt_setprop_empty - set a property to an empty value
1597*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1598*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1599*4882a593Smuzhiyun * @name: name of the property to change
1600*4882a593Smuzhiyun *
1601*4882a593Smuzhiyun * fdt_setprop_empty() sets the value of the named property in the
1602*4882a593Smuzhiyun * given node to an empty (zero length) value, or creates a new empty
1603*4882a593Smuzhiyun * property if it does not already exist.
1604*4882a593Smuzhiyun *
1605*4882a593Smuzhiyun * This function may insert or delete data from the blob, and will
1606*4882a593Smuzhiyun * therefore change the offsets of some existing nodes.
1607*4882a593Smuzhiyun *
1608*4882a593Smuzhiyun * returns:
1609*4882a593Smuzhiyun * 0, on success
1610*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1611*4882a593Smuzhiyun * contain the new property value
1612*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1613*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1614*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1615*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1616*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1617*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1618*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1619*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1620*4882a593Smuzhiyun */
1621*4882a593Smuzhiyun #define fdt_setprop_empty(fdt, nodeoffset, name) \
1622*4882a593Smuzhiyun fdt_setprop((fdt), (nodeoffset), (name), NULL, 0)
1623*4882a593Smuzhiyun
1624*4882a593Smuzhiyun /**
1625*4882a593Smuzhiyun * fdt_appendprop - append to or create a property
1626*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1627*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1628*4882a593Smuzhiyun * @name: name of the property to append to
1629*4882a593Smuzhiyun * @val: pointer to data to append to the property value
1630*4882a593Smuzhiyun * @len: length of the data to append to the property value
1631*4882a593Smuzhiyun *
1632*4882a593Smuzhiyun * fdt_appendprop() appends the value to the named property in the
1633*4882a593Smuzhiyun * given node, creating the property if it does not already exist.
1634*4882a593Smuzhiyun *
1635*4882a593Smuzhiyun * This function may insert data into the blob, and will therefore
1636*4882a593Smuzhiyun * change the offsets of some existing nodes.
1637*4882a593Smuzhiyun *
1638*4882a593Smuzhiyun * returns:
1639*4882a593Smuzhiyun * 0, on success
1640*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1641*4882a593Smuzhiyun * contain the new property value
1642*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1643*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1644*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1645*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1646*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1647*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1648*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1649*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1650*4882a593Smuzhiyun */
1651*4882a593Smuzhiyun int fdt_appendprop(void *fdt, int nodeoffset, const char *name,
1652*4882a593Smuzhiyun const void *val, int len);
1653*4882a593Smuzhiyun
1654*4882a593Smuzhiyun /**
1655*4882a593Smuzhiyun * fdt_appendprop_u32 - append a 32-bit integer value to a property
1656*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1657*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1658*4882a593Smuzhiyun * @name: name of the property to change
1659*4882a593Smuzhiyun * @val: 32-bit integer value to append to the property (native endian)
1660*4882a593Smuzhiyun *
1661*4882a593Smuzhiyun * fdt_appendprop_u32() appends the given 32-bit integer value
1662*4882a593Smuzhiyun * (converting to big-endian if necessary) to the value of the named
1663*4882a593Smuzhiyun * property in the given node, or creates a new property with that
1664*4882a593Smuzhiyun * value if it does not already exist.
1665*4882a593Smuzhiyun *
1666*4882a593Smuzhiyun * This function may insert data into the blob, and will therefore
1667*4882a593Smuzhiyun * change the offsets of some existing nodes.
1668*4882a593Smuzhiyun *
1669*4882a593Smuzhiyun * returns:
1670*4882a593Smuzhiyun * 0, on success
1671*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1672*4882a593Smuzhiyun * contain the new property value
1673*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1674*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1675*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1676*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1677*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1678*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1679*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1680*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1681*4882a593Smuzhiyun */
fdt_appendprop_u32(void * fdt,int nodeoffset,const char * name,uint32_t val)1682*4882a593Smuzhiyun static inline int fdt_appendprop_u32(void *fdt, int nodeoffset,
1683*4882a593Smuzhiyun const char *name, uint32_t val)
1684*4882a593Smuzhiyun {
1685*4882a593Smuzhiyun fdt32_t tmp = cpu_to_fdt32(val);
1686*4882a593Smuzhiyun return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1687*4882a593Smuzhiyun }
1688*4882a593Smuzhiyun
1689*4882a593Smuzhiyun /**
1690*4882a593Smuzhiyun * fdt_appendprop_u64 - append a 64-bit integer value to a property
1691*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1692*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1693*4882a593Smuzhiyun * @name: name of the property to change
1694*4882a593Smuzhiyun * @val: 64-bit integer value to append to the property (native endian)
1695*4882a593Smuzhiyun *
1696*4882a593Smuzhiyun * fdt_appendprop_u64() appends the given 64-bit integer value
1697*4882a593Smuzhiyun * (converting to big-endian if necessary) to the value of the named
1698*4882a593Smuzhiyun * property in the given node, or creates a new property with that
1699*4882a593Smuzhiyun * value if it does not already exist.
1700*4882a593Smuzhiyun *
1701*4882a593Smuzhiyun * This function may insert data into the blob, and will therefore
1702*4882a593Smuzhiyun * change the offsets of some existing nodes.
1703*4882a593Smuzhiyun *
1704*4882a593Smuzhiyun * returns:
1705*4882a593Smuzhiyun * 0, on success
1706*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1707*4882a593Smuzhiyun * contain the new property value
1708*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1709*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1710*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1711*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1712*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1713*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1714*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1715*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1716*4882a593Smuzhiyun */
fdt_appendprop_u64(void * fdt,int nodeoffset,const char * name,uint64_t val)1717*4882a593Smuzhiyun static inline int fdt_appendprop_u64(void *fdt, int nodeoffset,
1718*4882a593Smuzhiyun const char *name, uint64_t val)
1719*4882a593Smuzhiyun {
1720*4882a593Smuzhiyun fdt64_t tmp = cpu_to_fdt64(val);
1721*4882a593Smuzhiyun return fdt_appendprop(fdt, nodeoffset, name, &tmp, sizeof(tmp));
1722*4882a593Smuzhiyun }
1723*4882a593Smuzhiyun
1724*4882a593Smuzhiyun /**
1725*4882a593Smuzhiyun * fdt_appendprop_cell - append a single cell value to a property
1726*4882a593Smuzhiyun *
1727*4882a593Smuzhiyun * This is an alternative name for fdt_appendprop_u32()
1728*4882a593Smuzhiyun */
fdt_appendprop_cell(void * fdt,int nodeoffset,const char * name,uint32_t val)1729*4882a593Smuzhiyun static inline int fdt_appendprop_cell(void *fdt, int nodeoffset,
1730*4882a593Smuzhiyun const char *name, uint32_t val)
1731*4882a593Smuzhiyun {
1732*4882a593Smuzhiyun return fdt_appendprop_u32(fdt, nodeoffset, name, val);
1733*4882a593Smuzhiyun }
1734*4882a593Smuzhiyun
1735*4882a593Smuzhiyun /**
1736*4882a593Smuzhiyun * fdt_appendprop_string - append a string to a property
1737*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1738*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to change
1739*4882a593Smuzhiyun * @name: name of the property to change
1740*4882a593Smuzhiyun * @str: string value to append to the property
1741*4882a593Smuzhiyun *
1742*4882a593Smuzhiyun * fdt_appendprop_string() appends the given string to the value of
1743*4882a593Smuzhiyun * the named property in the given node, or creates a new property
1744*4882a593Smuzhiyun * with that value if it does not already exist.
1745*4882a593Smuzhiyun *
1746*4882a593Smuzhiyun * This function may insert data into the blob, and will therefore
1747*4882a593Smuzhiyun * change the offsets of some existing nodes.
1748*4882a593Smuzhiyun *
1749*4882a593Smuzhiyun * returns:
1750*4882a593Smuzhiyun * 0, on success
1751*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1752*4882a593Smuzhiyun * contain the new property value
1753*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1754*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1755*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1756*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1757*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1758*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1759*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1760*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1761*4882a593Smuzhiyun */
1762*4882a593Smuzhiyun #define fdt_appendprop_string(fdt, nodeoffset, name, str) \
1763*4882a593Smuzhiyun fdt_appendprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
1764*4882a593Smuzhiyun
1765*4882a593Smuzhiyun /**
1766*4882a593Smuzhiyun * fdt_delprop - delete a property
1767*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1768*4882a593Smuzhiyun * @nodeoffset: offset of the node whose property to nop
1769*4882a593Smuzhiyun * @name: name of the property to nop
1770*4882a593Smuzhiyun *
1771*4882a593Smuzhiyun * fdt_del_property() will delete the given property.
1772*4882a593Smuzhiyun *
1773*4882a593Smuzhiyun * This function will delete data from the blob, and will therefore
1774*4882a593Smuzhiyun * change the offsets of some existing nodes.
1775*4882a593Smuzhiyun *
1776*4882a593Smuzhiyun * returns:
1777*4882a593Smuzhiyun * 0, on success
1778*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, node does not have the named property
1779*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1780*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1781*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1782*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1783*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1784*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1785*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1786*4882a593Smuzhiyun */
1787*4882a593Smuzhiyun int fdt_delprop(void *fdt, int nodeoffset, const char *name);
1788*4882a593Smuzhiyun
1789*4882a593Smuzhiyun /**
1790*4882a593Smuzhiyun * fdt_add_subnode_namelen - creates a new node based on substring
1791*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1792*4882a593Smuzhiyun * @parentoffset: structure block offset of a node
1793*4882a593Smuzhiyun * @name: name of the subnode to locate
1794*4882a593Smuzhiyun * @namelen: number of characters of name to consider
1795*4882a593Smuzhiyun *
1796*4882a593Smuzhiyun * Identical to fdt_add_subnode(), but use only the first namelen
1797*4882a593Smuzhiyun * characters of name as the name of the new node. This is useful for
1798*4882a593Smuzhiyun * creating subnodes based on a portion of a larger string, such as a
1799*4882a593Smuzhiyun * full path.
1800*4882a593Smuzhiyun */
1801*4882a593Smuzhiyun #ifndef SWIG /* Not available in Python */
1802*4882a593Smuzhiyun int fdt_add_subnode_namelen(void *fdt, int parentoffset,
1803*4882a593Smuzhiyun const char *name, int namelen);
1804*4882a593Smuzhiyun #endif
1805*4882a593Smuzhiyun
1806*4882a593Smuzhiyun /**
1807*4882a593Smuzhiyun * fdt_add_subnode - creates a new node
1808*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1809*4882a593Smuzhiyun * @parentoffset: structure block offset of a node
1810*4882a593Smuzhiyun * @name: name of the subnode to locate
1811*4882a593Smuzhiyun *
1812*4882a593Smuzhiyun * fdt_add_subnode() creates a new node as a subnode of the node at
1813*4882a593Smuzhiyun * structure block offset parentoffset, with the given name (which
1814*4882a593Smuzhiyun * should include the unit address, if any).
1815*4882a593Smuzhiyun *
1816*4882a593Smuzhiyun * This function will insert data into the blob, and will therefore
1817*4882a593Smuzhiyun * change the offsets of some existing nodes.
1818*4882a593Smuzhiyun
1819*4882a593Smuzhiyun * returns:
1820*4882a593Smuzhiyun * structure block offset of the created nodeequested subnode (>=0), on
1821*4882a593Smuzhiyun * success
1822*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, if the requested subnode does not exist
1823*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE
1824*4882a593Smuzhiyun * tag
1825*4882a593Smuzhiyun * -FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of
1826*4882a593Smuzhiyun * the given name
1827*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, if there is insufficient free space in the
1828*4882a593Smuzhiyun * blob to contain the new node
1829*4882a593Smuzhiyun * -FDT_ERR_NOSPACE
1830*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT
1831*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1832*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1833*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1834*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1835*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings.
1836*4882a593Smuzhiyun */
1837*4882a593Smuzhiyun int fdt_add_subnode(void *fdt, int parentoffset, const char *name);
1838*4882a593Smuzhiyun
1839*4882a593Smuzhiyun /**
1840*4882a593Smuzhiyun * fdt_del_node - delete a node (subtree)
1841*4882a593Smuzhiyun * @fdt: pointer to the device tree blob
1842*4882a593Smuzhiyun * @nodeoffset: offset of the node to nop
1843*4882a593Smuzhiyun *
1844*4882a593Smuzhiyun * fdt_del_node() will remove the given node, including all its
1845*4882a593Smuzhiyun * subnodes if any, from the blob.
1846*4882a593Smuzhiyun *
1847*4882a593Smuzhiyun * This function will delete data from the blob, and will therefore
1848*4882a593Smuzhiyun * change the offsets of some existing nodes.
1849*4882a593Smuzhiyun *
1850*4882a593Smuzhiyun * returns:
1851*4882a593Smuzhiyun * 0, on success
1852*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1853*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1854*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1855*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1856*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1857*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1858*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1859*4882a593Smuzhiyun */
1860*4882a593Smuzhiyun int fdt_del_node(void *fdt, int nodeoffset);
1861*4882a593Smuzhiyun
1862*4882a593Smuzhiyun /**
1863*4882a593Smuzhiyun * fdt_overlay_apply - Applies a DT overlay on a base DT
1864*4882a593Smuzhiyun * @fdt: pointer to the base device tree blob
1865*4882a593Smuzhiyun * @fdto: pointer to the device tree overlay blob
1866*4882a593Smuzhiyun *
1867*4882a593Smuzhiyun * fdt_overlay_apply() will apply the given device tree overlay on the
1868*4882a593Smuzhiyun * given base device tree.
1869*4882a593Smuzhiyun *
1870*4882a593Smuzhiyun * Expect the base device tree to be modified, even if the function
1871*4882a593Smuzhiyun * returns an error.
1872*4882a593Smuzhiyun *
1873*4882a593Smuzhiyun * returns:
1874*4882a593Smuzhiyun * 0, on success
1875*4882a593Smuzhiyun * -FDT_ERR_NOSPACE, there's not enough space in the base device tree
1876*4882a593Smuzhiyun * -FDT_ERR_NOTFOUND, the overlay points to some inexistant nodes or
1877*4882a593Smuzhiyun * properties in the base DT
1878*4882a593Smuzhiyun * -FDT_ERR_BADPHANDLE,
1879*4882a593Smuzhiyun * -FDT_ERR_BADOVERLAY,
1880*4882a593Smuzhiyun * -FDT_ERR_NOPHANDLES,
1881*4882a593Smuzhiyun * -FDT_ERR_INTERNAL,
1882*4882a593Smuzhiyun * -FDT_ERR_BADLAYOUT,
1883*4882a593Smuzhiyun * -FDT_ERR_BADMAGIC,
1884*4882a593Smuzhiyun * -FDT_ERR_BADOFFSET,
1885*4882a593Smuzhiyun * -FDT_ERR_BADPATH,
1886*4882a593Smuzhiyun * -FDT_ERR_BADVERSION,
1887*4882a593Smuzhiyun * -FDT_ERR_BADSTRUCTURE,
1888*4882a593Smuzhiyun * -FDT_ERR_BADSTATE,
1889*4882a593Smuzhiyun * -FDT_ERR_TRUNCATED, standard meanings
1890*4882a593Smuzhiyun */
1891*4882a593Smuzhiyun int fdt_overlay_apply(void *fdt, void *fdto);
1892*4882a593Smuzhiyun
1893*4882a593Smuzhiyun /**********************************************************************/
1894*4882a593Smuzhiyun /* Debugging / informational functions */
1895*4882a593Smuzhiyun /**********************************************************************/
1896*4882a593Smuzhiyun
1897*4882a593Smuzhiyun const char *fdt_strerror(int errval);
1898*4882a593Smuzhiyun
1899*4882a593Smuzhiyun #endif /* _LIBFDT_H */
1900