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