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