dt: add of_alias_scan and of_alias_get_id
[linux-2.6.git] / include / linux / of.h
1 #ifndef _LINUX_OF_H
2 #define _LINUX_OF_H
3 /*
4  * Definitions for talking to the Open Firmware PROM on
5  * Power Macintosh and other computers.
6  *
7  * Copyright (C) 1996-2005 Paul Mackerras.
8  *
9  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10  * Updates for SPARC64 by David S. Miller
11  * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version
16  * 2 of the License, or (at your option) any later version.
17  */
18 #include <linux/types.h>
19 #include <linux/bitops.h>
20 #include <linux/kref.h>
21 #include <linux/mod_devicetable.h>
22 #include <linux/spinlock.h>
23
24 #include <asm/byteorder.h>
25
26 typedef u32 phandle;
27 typedef u32 ihandle;
28
29 struct property {
30         char    *name;
31         int     length;
32         void    *value;
33         struct property *next;
34         unsigned long _flags;
35         unsigned int unique_id;
36 };
37
38 #if defined(CONFIG_SPARC)
39 struct of_irq_controller;
40 #endif
41
42 struct device_node {
43         const char *name;
44         const char *type;
45         phandle phandle;
46         char    *full_name;
47
48         struct  property *properties;
49         struct  property *deadprops;    /* removed properties */
50         struct  device_node *parent;
51         struct  device_node *child;
52         struct  device_node *sibling;
53         struct  device_node *next;      /* next device of same type */
54         struct  device_node *allnext;   /* next in list of all nodes */
55         struct  proc_dir_entry *pde;    /* this node's proc directory */
56         struct  kref kref;
57         unsigned long _flags;
58         void    *data;
59 #if defined(CONFIG_SPARC)
60         char    *path_component_name;
61         unsigned int unique_id;
62         struct of_irq_controller *irq_trans;
63 #endif
64 };
65
66 #ifdef CONFIG_OF
67
68 /* Pointer for first entry in chain of all nodes. */
69 extern struct device_node *allnodes;
70 extern struct device_node *of_chosen;
71 extern struct device_node *of_aliases;
72 extern rwlock_t devtree_lock;
73
74 static inline bool of_have_populated_dt(void)
75 {
76         return allnodes != NULL;
77 }
78
79 static inline bool of_node_is_root(const struct device_node *node)
80 {
81         return node && (node->parent == NULL);
82 }
83
84 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
85 {
86         return test_bit(flag, &n->_flags);
87 }
88
89 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
90 {
91         set_bit(flag, &n->_flags);
92 }
93
94 extern struct device_node *of_find_all_nodes(struct device_node *prev);
95
96 #if defined(CONFIG_SPARC)
97 /* Dummy ref counting routines - to be implemented later */
98 static inline struct device_node *of_node_get(struct device_node *node)
99 {
100         return node;
101 }
102 static inline void of_node_put(struct device_node *node)
103 {
104 }
105
106 #else
107 extern struct device_node *of_node_get(struct device_node *node);
108 extern void of_node_put(struct device_node *node);
109 #endif
110
111 /*
112  * OF address retrieval & translation
113  */
114
115 /* Helper to read a big number; size is in cells (not bytes) */
116 static inline u64 of_read_number(const __be32 *cell, int size)
117 {
118         u64 r = 0;
119         while (size--)
120                 r = (r << 32) | be32_to_cpu(*(cell++));
121         return r;
122 }
123
124 /* Like of_read_number, but we want an unsigned long result */
125 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
126 {
127         /* toss away upper bits if unsigned long is smaller than u64 */
128         return of_read_number(cell, size);
129 }
130
131 #include <asm/prom.h>
132
133 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
134 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
135 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
136 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
137 #endif
138
139 /* Default string compare functions, Allow arch asm/prom.h to override */
140 #if !defined(of_compat_cmp)
141 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
142 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
143 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
144 #endif
145
146 /* flag descriptions */
147 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
148 #define OF_DETACHED     2 /* node has been detached from the device tree */
149
150 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
151 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
152
153 #define OF_BAD_ADDR     ((u64)-1)
154
155 #ifndef of_node_to_nid
156 static inline int of_node_to_nid(struct device_node *np) { return -1; }
157 #define of_node_to_nid of_node_to_nid
158 #endif
159
160 extern struct device_node *of_find_node_by_name(struct device_node *from,
161         const char *name);
162 #define for_each_node_by_name(dn, name) \
163         for (dn = of_find_node_by_name(NULL, name); dn; \
164              dn = of_find_node_by_name(dn, name))
165 extern struct device_node *of_find_node_by_type(struct device_node *from,
166         const char *type);
167 #define for_each_node_by_type(dn, type) \
168         for (dn = of_find_node_by_type(NULL, type); dn; \
169              dn = of_find_node_by_type(dn, type))
170 extern struct device_node *of_find_compatible_node(struct device_node *from,
171         const char *type, const char *compat);
172 #define for_each_compatible_node(dn, type, compatible) \
173         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
174              dn = of_find_compatible_node(dn, type, compatible))
175 extern struct device_node *of_find_matching_node(struct device_node *from,
176         const struct of_device_id *matches);
177 #define for_each_matching_node(dn, matches) \
178         for (dn = of_find_matching_node(NULL, matches); dn; \
179              dn = of_find_matching_node(dn, matches))
180 extern struct device_node *of_find_node_by_path(const char *path);
181 extern struct device_node *of_find_node_by_phandle(phandle handle);
182 extern struct device_node *of_get_parent(const struct device_node *node);
183 extern struct device_node *of_get_next_parent(struct device_node *node);
184 extern struct device_node *of_get_next_child(const struct device_node *node,
185                                              struct device_node *prev);
186 #define for_each_child_of_node(parent, child) \
187         for (child = of_get_next_child(parent, NULL); child != NULL; \
188              child = of_get_next_child(parent, child))
189
190 extern struct device_node *of_find_node_with_property(
191         struct device_node *from, const char *prop_name);
192 #define for_each_node_with_property(dn, prop_name) \
193         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
194              dn = of_find_node_with_property(dn, prop_name))
195
196 extern struct property *of_find_property(const struct device_node *np,
197                                          const char *name,
198                                          int *lenp);
199 extern int of_property_read_u32_array(const struct device_node *np,
200                                       const char *propname,
201                                       u32 *out_values,
202                                       size_t sz);
203
204 extern int of_property_read_string(struct device_node *np,
205                                    const char *propname,
206                                    const char **out_string);
207 extern int of_device_is_compatible(const struct device_node *device,
208                                    const char *);
209 extern int of_device_is_available(const struct device_node *device);
210 extern const void *of_get_property(const struct device_node *node,
211                                 const char *name,
212                                 int *lenp);
213 #define for_each_property(pp, properties) \
214         for (pp = properties; pp != NULL; pp = pp->next)
215
216 extern int of_n_addr_cells(struct device_node *np);
217 extern int of_n_size_cells(struct device_node *np);
218 extern const struct of_device_id *of_match_node(
219         const struct of_device_id *matches, const struct device_node *node);
220 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
221 extern struct device_node *of_parse_phandle(struct device_node *np,
222                                             const char *phandle_name,
223                                             int index);
224 extern int of_parse_phandles_with_args(struct device_node *np,
225         const char *list_name, const char *cells_name, int index,
226         struct device_node **out_node, const void **out_args);
227
228 extern void *early_init_dt_alloc_memory_arch(u64 size, u64 align);
229 extern void of_alias_scan(void);
230 extern int of_alias_get_id(struct device_node *np, const char *stem);
231
232 extern int of_machine_is_compatible(const char *compat);
233
234 extern int prom_add_property(struct device_node* np, struct property* prop);
235 extern int prom_remove_property(struct device_node *np, struct property *prop);
236 extern int prom_update_property(struct device_node *np,
237                                 struct property *newprop,
238                                 struct property *oldprop);
239
240 #if defined(CONFIG_OF_DYNAMIC)
241 /* For updating the device tree at runtime */
242 extern void of_attach_node(struct device_node *);
243 extern void of_detach_node(struct device_node *);
244 #endif
245
246 #else /* CONFIG_OF */
247
248 static inline bool of_have_populated_dt(void)
249 {
250         return false;
251 }
252
253 static inline int of_property_read_u32_array(const struct device_node *np,
254                                              const char *propname,
255                                              u32 *out_values, size_t sz)
256 {
257         return -ENOSYS;
258 }
259
260 static inline int of_property_read_string(struct device_node *np,
261                                           const char *propname,
262                                           const char **out_string)
263 {
264         return -ENOSYS;
265 }
266
267 #endif /* CONFIG_OF */
268
269 static inline int of_property_read_u32(const struct device_node *np,
270                                        const char *propname,
271                                        u32 *out_value)
272 {
273         return of_property_read_u32_array(np, propname, out_value, 1);
274 }
275
276 #endif /* _LINUX_OF_H */