blob: acdc72eac6de88db650f131f66d2d731e1655e11 [file] [log] [blame]
David Gibson3da0f9a2006-11-27 16:21:28 +11001#ifndef _LIBFDT_H
2#define _LIBFDT_H
3/*
4 * libfdt - Flat Device Tree manipulation
5 * Copyright (C) 2006 David Gibson, IBM Corporation.
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public License
9 * as published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#include <fdt.h>
David Gibsonede25de2006-12-01 15:02:10 +110023#include <libfdt_env.h>
David Gibson3da0f9a2006-11-27 16:21:28 +110024
25#define FDT_FIRST_SUPPORTED_VERSION 0x10
David Gibsonfe92f6b2006-12-01 16:25:39 +110026#define FDT_LAST_SUPPORTED_VERSION 0x11
David Gibson3da0f9a2006-11-27 16:21:28 +110027
David Gibson3aea8282006-12-15 15:12:52 +110028/* Error codes: informative error codes */
29#define FDT_ERR_NOTFOUND 1
30#define FDT_ERR_EXISTS 2
31#define FDT_ERR_NOSPACE 3
David Gibson3da0f9a2006-11-27 16:21:28 +110032
David Gibson3aea8282006-12-15 15:12:52 +110033/* Error codes: codes for bad parameters */
34#define FDT_ERR_BADOFFSET 4
35#define FDT_ERR_BADPATH 5
36#define FDT_ERR_BADSTATE 6
37
38/* Error codes: codes for bad device tree blobs */
39#define FDT_ERR_TRUNCATED 7
40#define FDT_ERR_BADMAGIC 8
41#define FDT_ERR_BADVERSION 9
42#define FDT_ERR_BADSTRUCTURE 10
43#define FDT_ERR_BADLAYOUT 11
44
45#define FDT_ERR_MAX 11
David Gibson3da0f9a2006-11-27 16:21:28 +110046
David Gibson73d60922006-12-15 15:12:47 +110047#define fdt_get_header(fdt, field) \
48 (fdt32_to_cpu(((struct fdt_header *)(fdt))->field))
49#define fdt_magic(fdt) (fdt_get_header(fdt, magic))
50#define fdt_totalsize(fdt) (fdt_get_header(fdt, totalsize))
51#define fdt_off_dt_struct(fdt) (fdt_get_header(fdt, off_dt_struct))
52#define fdt_off_dt_strings(fdt) (fdt_get_header(fdt, off_dt_strings))
53#define fdt_off_mem_rsvmap(fdt) (fdt_get_header(fdt, off_mem_rsvmap))
54#define fdt_version(fdt) (fdt_get_header(fdt, version))
55#define fdt_last_comp_version(fdt) (fdt_get_header(fdt, last_comp_version))
56#define fdt_boot_cpuid_phys(fdt) (fdt_get_header(fdt, boot_cpuid_phys))
57#define fdt_size_dt_strings(fdt) (fdt_get_header(fdt, size_dt_strings))
58#define fdt_size_dt_struct(fdt) (fdt_get_header(fdt, size_dt_struct))
David Gibsonede25de2006-12-01 15:02:10 +110059
David Gibson73d60922006-12-15 15:12:47 +110060#define fdt_set_header(fdt, field, val) \
61 ((struct fdt_header *)(fdt))->field = cpu_to_fdt32(val)
62
63void *fdt_offset_ptr(const void *fdt, int offset, int checklen);
David Gibson3da0f9a2006-11-27 16:21:28 +110064
65#define fdt_offset_ptr_typed(fdt, offset, var) \
66 ((typeof(var))(fdt_offset_ptr((fdt), (offset), sizeof(*(var)))))
67
David Gibson73d60922006-12-15 15:12:47 +110068int fdt_move(const void *fdt, void *buf, int bufsize);
David Gibson42369762006-12-01 15:07:19 +110069
David Gibson3da0f9a2006-11-27 16:21:28 +110070/* Read-only functions */
David Gibson73d60922006-12-15 15:12:47 +110071char *fdt_string(const void *fdt, int stroffset);
David Gibson3aa4cfd2006-11-29 16:34:30 +110072
David Gibson73d60922006-12-15 15:12:47 +110073int fdt_subnode_offset_namelen(const void *fdt, int parentoffset,
David Gibson3da0f9a2006-11-27 16:21:28 +110074 const char *name, int namelen);
David Gibson73d60922006-12-15 15:12:47 +110075int fdt_subnode_offset(const void *fdt, int parentoffset, const char *name);
David Gibson3da0f9a2006-11-27 16:21:28 +110076
David Gibson73d60922006-12-15 15:12:47 +110077int fdt_path_offset(const void *fdt, const char *path);
David Gibson3da0f9a2006-11-27 16:21:28 +110078
David Gibson73d60922006-12-15 15:12:47 +110079struct fdt_property *fdt_get_property(const void *fdt, int nodeoffset,
David Gibson94993f42006-12-11 16:15:34 +110080 const char *name, int *lenp);
David Gibson73d60922006-12-15 15:12:47 +110081void *fdt_getprop(const void *fdt, int nodeoffset,
David Gibson3da0f9a2006-11-27 16:21:28 +110082 const char *name, int *lenp);
83
84/* Write-in-place functions */
David Gibson73d60922006-12-15 15:12:47 +110085int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,
David Gibson3da0f9a2006-11-27 16:21:28 +110086 const void *val, int len);
87
88#define fdt_setprop_inplace_typed(fdt, nodeoffset, name, val) \
89 ({ \
90 typeof(val) x = val; \
91 fdt_setprop_inplace(fdt, nodeoffset, name, &x, sizeof(x)); \
92 })
93
David Gibson73d60922006-12-15 15:12:47 +110094int fdt_nop_property(void *fdt, int nodeoffset, const char *name);
95int fdt_nop_node(void *fdt, int nodeoffset);
David Gibson3da0f9a2006-11-27 16:21:28 +110096
David Gibson3da0f9a2006-11-27 16:21:28 +110097/* Sequential-write functions */
David Gibson73d60922006-12-15 15:12:47 +110098int fdt_create(void *buf, int bufsize);
99int fdt_add_reservemap_entry(void *fdt, uint64_t addr, uint64_t size);
100int fdt_finish_reservemap(void *fdt);
101int fdt_begin_node(void *fdt, const char *name);
102int fdt_property(void *fdt, const char *name, const void *val, int len);
David Gibson063693a2006-11-29 16:45:46 +1100103#define fdt_property_typed(fdt, name, val) \
104 ({ \
105 typeof(val) x = (val); \
106 fdt_property((fdt), (name), &x, sizeof(x)); \
107 })
108#define fdt_property_string(fdt, name, str) \
109 fdt_property(fdt, name, str, strlen(str)+1)
David Gibson73d60922006-12-15 15:12:47 +1100110int fdt_end_node(void *fdt);
111int fdt_finish(void *fdt);
David Gibson3da0f9a2006-11-27 16:21:28 +1100112
David Gibson3da0f9a2006-11-27 16:21:28 +1100113/* Read-write functions */
David Gibson73d60922006-12-15 15:12:47 +1100114int fdt_open_into(void *fdt, void *buf, int bufsize);
115int fdt_pack(void *fdt);
David Gibson7ba551f2006-12-01 16:59:43 +1100116
David Gibson73d60922006-12-15 15:12:47 +1100117int fdt_setprop(void *fdt, int nodeoffset, const char *name,
David Gibson7ba551f2006-12-01 16:59:43 +1100118 const void *val, int len);
119#define fdt_setprop_typed(fdt, nodeoffset, name, val) \
120 ({ \
121 typeof(val) x = (val); \
122 fdt_setprop((fdt), (nodeoffset), (name), &x, sizeof(x)); \
123 })
124#define fdt_setprop_string(fdt, nodeoffset, name, str) \
125 fdt_setprop((fdt), (nodeoffset), (name), (str), strlen(str)+1)
David Gibson73d60922006-12-15 15:12:47 +1100126int fdt_delprop(void *fdt, int nodeoffset, const char *name);
127int fdt_add_subnode_namelen(void *fdt, int parentoffset,
David Gibson7ba551f2006-12-01 16:59:43 +1100128 const char *name, int namelen);
David Gibson73d60922006-12-15 15:12:47 +1100129int fdt_add_subnode(void *fdt, int parentoffset, const char *name);
130int fdt_del_node(void *fdt, int nodeoffset);
David Gibson3da0f9a2006-11-27 16:21:28 +1100131
David Gibson5b344f92006-12-21 09:57:08 +1100132/* Extra functions */
133const char *fdt_strerror(int errval);
134
David Gibson3da0f9a2006-11-27 16:21:28 +1100135#endif /* _LIBFDT_H */