]>
git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blob - include/linux/of.h
4 * Definitions for talking to the Open Firmware PROM on
5 * Power Macintosh and other computers.
7 * Copyright (C) 1996-2005 Paul Mackerras.
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.
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.
18 #include <linux/types.h>
19 #include <linux/bitops.h>
20 #include <linux/errno.h>
21 #include <linux/kref.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/spinlock.h>
25 #include <asm/byteorder.h>
26 #include <asm/errno.h>
35 struct property
*next
;
37 unsigned int unique_id
;
40 #if defined(CONFIG_SPARC)
41 struct of_irq_controller
;
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 */
61 #if defined(CONFIG_EEH)
64 #if defined(CONFIG_SPARC)
65 char *path_component_name
;
66 unsigned int unique_id
;
67 struct of_irq_controller
*irq_trans
;
71 #define MAX_PHANDLE_ARGS 8
72 struct of_phandle_args
{
73 struct device_node
*np
;
75 uint32_t args
[MAX_PHANDLE_ARGS
];
78 #if defined(CONFIG_EEH)
79 static inline struct eeh_dev
*of_node_to_eeh_dev(struct device_node
*dn
)
85 #ifdef CONFIG_OF_DYNAMIC
86 extern struct device_node
*of_node_get(struct device_node
*node
);
87 extern void of_node_put(struct device_node
*node
);
88 #else /* CONFIG_OF_DYNAMIC */
89 /* Dummy ref counting routines - to be implemented later */
90 static inline struct device_node
*of_node_get(struct device_node
*node
)
94 static inline void of_node_put(struct device_node
*node
) { }
95 #endif /* !CONFIG_OF_DYNAMIC */
99 /* Pointer for first entry in chain of all nodes. */
100 extern struct device_node
*allnodes
;
101 extern struct device_node
*of_chosen
;
102 extern struct device_node
*of_aliases
;
103 extern rwlock_t devtree_lock
;
105 static inline bool of_have_populated_dt(void)
107 return allnodes
!= NULL
;
110 static inline bool of_node_is_root(const struct device_node
*node
)
112 return node
&& (node
->parent
== NULL
);
115 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
117 return test_bit(flag
, &n
->_flags
);
120 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
122 set_bit(flag
, &n
->_flags
);
125 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
128 * OF address retrieval & translation
131 /* Helper to read a big number; size is in cells (not bytes) */
132 static inline u64
of_read_number(const __be32
*cell
, int size
)
136 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
140 /* Like of_read_number, but we want an unsigned long result */
141 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
143 /* toss away upper bits if unsigned long is smaller than u64 */
144 return of_read_number(cell
, size
);
147 #include <asm/prom.h>
149 /* Default #address and #size cells. Allow arch asm/prom.h to override */
150 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
151 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
152 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
155 /* Default string compare functions, Allow arch asm/prom.h to override */
156 #if !defined(of_compat_cmp)
157 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
158 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
159 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
162 /* flag descriptions */
163 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
164 #define OF_DETACHED 2 /* node has been detached from the device tree */
166 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
167 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
169 #define OF_BAD_ADDR ((u64)-1)
171 #ifndef of_node_to_nid
172 static inline int of_node_to_nid(struct device_node
*np
) { return -1; }
173 #define of_node_to_nid of_node_to_nid
176 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
178 #define for_each_node_by_name(dn, name) \
179 for (dn = of_find_node_by_name(NULL, name); dn; \
180 dn = of_find_node_by_name(dn, name))
181 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
183 #define for_each_node_by_type(dn, type) \
184 for (dn = of_find_node_by_type(NULL, type); dn; \
185 dn = of_find_node_by_type(dn, type))
186 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
187 const char *type
, const char *compat
);
188 #define for_each_compatible_node(dn, type, compatible) \
189 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
190 dn = of_find_compatible_node(dn, type, compatible))
191 extern struct device_node
*of_find_matching_node(struct device_node
*from
,
192 const struct of_device_id
*matches
);
193 #define for_each_matching_node(dn, matches) \
194 for (dn = of_find_matching_node(NULL, matches); dn; \
195 dn = of_find_matching_node(dn, matches))
196 extern struct device_node
*of_find_node_by_path(const char *path
);
197 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
198 extern struct device_node
*of_get_parent(const struct device_node
*node
);
199 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
200 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
201 struct device_node
*prev
);
202 #define for_each_child_of_node(parent, child) \
203 for (child = of_get_next_child(parent, NULL); child != NULL; \
204 child = of_get_next_child(parent, child))
206 extern struct device_node
*of_find_node_with_property(
207 struct device_node
*from
, const char *prop_name
);
208 #define for_each_node_with_property(dn, prop_name) \
209 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
210 dn = of_find_node_with_property(dn, prop_name))
212 extern struct property
*of_find_property(const struct device_node
*np
,
215 extern int of_property_read_u32_array(const struct device_node
*np
,
216 const char *propname
,
219 extern int of_property_read_u64(const struct device_node
*np
,
220 const char *propname
, u64
*out_value
);
222 extern int of_property_read_string(struct device_node
*np
,
223 const char *propname
,
224 const char **out_string
);
225 extern int of_property_read_string_index(struct device_node
*np
,
226 const char *propname
,
227 int index
, const char **output
);
228 extern int of_property_match_string(struct device_node
*np
,
229 const char *propname
,
231 extern int of_property_count_strings(struct device_node
*np
,
232 const char *propname
);
233 extern int of_device_is_compatible(const struct device_node
*device
,
235 extern int of_device_is_available(const struct device_node
*device
);
236 extern const void *of_get_property(const struct device_node
*node
,
239 #define for_each_property_of_node(dn, pp) \
240 for (pp = dn->properties; pp != NULL; pp = pp->next)
242 extern int of_n_addr_cells(struct device_node
*np
);
243 extern int of_n_size_cells(struct device_node
*np
);
244 extern const struct of_device_id
*of_match_node(
245 const struct of_device_id
*matches
, const struct device_node
*node
);
246 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
247 extern struct device_node
*of_parse_phandle(struct device_node
*np
,
248 const char *phandle_name
,
250 extern int of_parse_phandle_with_args(struct device_node
*np
,
251 const char *list_name
, const char *cells_name
, int index
,
252 struct of_phandle_args
*out_args
);
254 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
255 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
257 extern int of_machine_is_compatible(const char *compat
);
259 extern int prom_add_property(struct device_node
* np
, struct property
* prop
);
260 extern int prom_remove_property(struct device_node
*np
, struct property
*prop
);
261 extern int prom_update_property(struct device_node
*np
,
262 struct property
*newprop
,
263 struct property
*oldprop
);
265 #if defined(CONFIG_OF_DYNAMIC)
266 /* For updating the device tree at runtime */
267 extern void of_attach_node(struct device_node
*);
268 extern void of_detach_node(struct device_node
*);
271 #define of_match_ptr(_ptr) (_ptr)
272 #else /* CONFIG_OF */
274 static inline bool of_have_populated_dt(void)
279 #define for_each_child_of_node(parent, child) \
282 static inline int of_device_is_compatible(const struct device_node
*device
,
288 static inline struct property
*of_find_property(const struct device_node
*np
,
295 static inline struct device_node
*of_find_compatible_node(
296 struct device_node
*from
,
303 static inline int of_property_read_u32_array(const struct device_node
*np
,
304 const char *propname
,
305 u32
*out_values
, size_t sz
)
310 static inline int of_property_read_string(struct device_node
*np
,
311 const char *propname
,
312 const char **out_string
)
317 static inline int of_property_read_string_index(struct device_node
*np
,
318 const char *propname
, int index
,
319 const char **out_string
)
324 static inline int of_property_count_strings(struct device_node
*np
,
325 const char *propname
)
330 static inline const void *of_get_property(const struct device_node
*node
,
337 static inline int of_property_read_u64(const struct device_node
*np
,
338 const char *propname
, u64
*out_value
)
343 static inline struct device_node
*of_parse_phandle(struct device_node
*np
,
344 const char *phandle_name
,
350 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
355 static inline int of_machine_is_compatible(const char *compat
)
360 #define of_match_ptr(_ptr) NULL
361 #define of_match_node(_matches, _node) NULL
362 #endif /* CONFIG_OF */
364 static inline int of_property_read_u32(const struct device_node
*np
,
365 const char *propname
,
368 return of_property_read_u32_array(np
, propname
, out_value
, 1);
371 #endif /* _LINUX_OF_H */