of/sparc: Remove sparc-local declaration of allnodes and devtree_lock
[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 #ifdef CONFIG_OF
27
28 typedef u32 phandle;
29 typedef u32 ihandle;
30
31 struct property {
32         char    *name;
33         int     length;
34         void    *value;
35         struct property *next;
36         unsigned long _flags;
37         unsigned int unique_id;
38 };
39
40 #if defined(CONFIG_SPARC)
41 struct of_irq_controller;
42 #endif
43
44 struct device_node {
45         const char *name;
46         const char *type;
47         phandle phandle;
48         char    *full_name;
49
50         struct  property *properties;
51         struct  property *deadprops;    /* removed properties */
52         struct  device_node *parent;
53         struct  device_node *child;
54         struct  device_node *sibling;
55         struct  device_node *next;      /* next device of same type */
56         struct  device_node *allnext;   /* next in list of all nodes */
57         struct  proc_dir_entry *pde;    /* this node's proc directory */
58         struct  kref kref;
59         unsigned long _flags;
60         void    *data;
61 #if defined(CONFIG_SPARC)
62         char    *path_component_name;
63         unsigned int unique_id;
64         struct of_irq_controller *irq_trans;
65 #endif
66 };
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 rwlock_t devtree_lock;
72
73 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
74 {
75         return test_bit(flag, &n->_flags);
76 }
77
78 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
79 {
80         set_bit(flag, &n->_flags);
81 }
82
83 extern struct device_node *of_find_all_nodes(struct device_node *prev);
84
85 #if defined(CONFIG_SPARC)
86 /* Dummy ref counting routines - to be implemented later */
87 static inline struct device_node *of_node_get(struct device_node *node)
88 {
89         return node;
90 }
91 static inline void of_node_put(struct device_node *node)
92 {
93 }
94
95 #else
96 extern struct device_node *of_node_get(struct device_node *node);
97 extern void of_node_put(struct device_node *node);
98 #endif
99
100 /*
101  * OF address retreival & translation
102  */
103
104 /* Helper to read a big number; size is in cells (not bytes) */
105 static inline u64 of_read_number(const __be32 *cell, int size)
106 {
107         u64 r = 0;
108         while (size--)
109                 r = (r << 32) | be32_to_cpu(*(cell++));
110         return r;
111 }
112
113 /* Like of_read_number, but we want an unsigned long result */
114 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
115 {
116         /* toss away upper bits if unsigned long is smaller than u64 */
117         return of_read_number(cell, size);
118 }
119
120 #include <asm/prom.h>
121
122 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
123 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
124 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
125 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
126 #endif
127
128 /* Default string compare functions, Allow arch asm/prom.h to override */
129 #if !defined(of_compat_cmp)
130 #define of_compat_cmp(s1, s2, l)        strncasecmp((s1), (s2), (l))
131 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
132 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
133 #endif
134
135 /* flag descriptions */
136 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
137 #define OF_DETACHED     2 /* node has been detached from the device tree */
138
139 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
140 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
141
142 #define OF_BAD_ADDR     ((u64)-1)
143
144 extern struct device_node *of_find_node_by_name(struct device_node *from,
145         const char *name);
146 #define for_each_node_by_name(dn, name) \
147         for (dn = of_find_node_by_name(NULL, name); dn; \
148              dn = of_find_node_by_name(dn, name))
149 extern struct device_node *of_find_node_by_type(struct device_node *from,
150         const char *type);
151 #define for_each_node_by_type(dn, type) \
152         for (dn = of_find_node_by_type(NULL, type); dn; \
153              dn = of_find_node_by_type(dn, type))
154 extern struct device_node *of_find_compatible_node(struct device_node *from,
155         const char *type, const char *compat);
156 #define for_each_compatible_node(dn, type, compatible) \
157         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
158              dn = of_find_compatible_node(dn, type, compatible))
159 extern struct device_node *of_find_matching_node(struct device_node *from,
160         const struct of_device_id *matches);
161 #define for_each_matching_node(dn, matches) \
162         for (dn = of_find_matching_node(NULL, matches); dn; \
163              dn = of_find_matching_node(dn, matches))
164 extern struct device_node *of_find_node_by_path(const char *path);
165 extern struct device_node *of_find_node_by_phandle(phandle handle);
166 extern struct device_node *of_get_parent(const struct device_node *node);
167 extern struct device_node *of_get_next_parent(struct device_node *node);
168 extern struct device_node *of_get_next_child(const struct device_node *node,
169                                              struct device_node *prev);
170 #define for_each_child_of_node(parent, child) \
171         for (child = of_get_next_child(parent, NULL); child != NULL; \
172              child = of_get_next_child(parent, child))
173
174 extern struct device_node *of_find_node_with_property(
175         struct device_node *from, const char *prop_name);
176 #define for_each_node_with_property(dn, prop_name) \
177         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
178              dn = of_find_node_with_property(dn, prop_name))
179
180 extern struct property *of_find_property(const struct device_node *np,
181                                          const char *name,
182                                          int *lenp);
183 extern int of_device_is_compatible(const struct device_node *device,
184                                    const char *);
185 extern int of_device_is_available(const struct device_node *device);
186 extern const void *of_get_property(const struct device_node *node,
187                                 const char *name,
188                                 int *lenp);
189 extern int of_n_addr_cells(struct device_node *np);
190 extern int of_n_size_cells(struct device_node *np);
191 extern const struct of_device_id *of_match_node(
192         const struct of_device_id *matches, const struct device_node *node);
193 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
194 extern struct device_node *of_parse_phandle(struct device_node *np,
195                                             const char *phandle_name,
196                                             int index);
197 extern int of_parse_phandles_with_args(struct device_node *np,
198         const char *list_name, const char *cells_name, int index,
199         struct device_node **out_node, const void **out_args);
200
201 extern int of_machine_is_compatible(const char *compat);
202
203 extern int prom_add_property(struct device_node* np, struct property* prop);
204 extern int prom_remove_property(struct device_node *np, struct property *prop);
205 extern int prom_update_property(struct device_node *np,
206                                 struct property *newprop,
207                                 struct property *oldprop);
208
209 #if defined(CONFIG_OF_DYNAMIC)
210 /* For updating the device tree at runtime */
211 extern void of_attach_node(struct device_node *);
212 extern void of_detach_node(struct device_node *);
213 #endif
214
215 #endif /* CONFIG_OF */
216 #endif /* _LINUX_OF_H */