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/kobject.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/spinlock.h>
24 #include <linux/topology.h>
25 #include <linux/notifier.h>
27 #include <asm/byteorder.h>
28 #include <asm/errno.h>
37 struct property *next;
39 unsigned int unique_id;
40 struct bin_attribute attr;
43 #if defined(CONFIG_SPARC)
44 struct of_irq_controller;
51 const char *full_name;
53 struct property *properties;
54 struct property *deadprops; /* removed properties */
55 struct device_node *parent;
56 struct device_node *child;
57 struct device_node *sibling;
58 struct device_node *next; /* next device of same type */
59 struct device_node *allnext; /* next in list of all nodes */
63 #if defined(CONFIG_SPARC)
64 const char *path_component_name;
65 unsigned int unique_id;
66 struct of_irq_controller *irq_trans;
70 #define MAX_PHANDLE_ARGS 16
71 struct of_phandle_args {
72 struct device_node *np;
74 uint32_t args[MAX_PHANDLE_ARGS];
77 extern int of_node_add(struct device_node *node);
79 /* initialize a node */
80 extern struct kobj_type of_node_ktype;
81 static inline void of_node_init(struct device_node *node)
83 kobject_init(&node->kobj, &of_node_ktype);
86 /* true when node is initialized */
87 static inline int of_node_is_initialized(struct device_node *node)
89 return node && node->kobj.state_initialized;
92 /* true when node is attached (i.e. present on sysfs) */
93 static inline int of_node_is_attached(struct device_node *node)
95 return node && node->kobj.state_in_sysfs;
98 #ifdef CONFIG_OF_DYNAMIC
99 extern struct device_node *of_node_get(struct device_node *node);
100 extern void of_node_put(struct device_node *node);
101 #else /* CONFIG_OF_DYNAMIC */
102 /* Dummy ref counting routines - to be implemented later */
103 static inline struct device_node *of_node_get(struct device_node *node)
107 static inline void of_node_put(struct device_node *node) { }
108 #endif /* !CONFIG_OF_DYNAMIC */
112 /* Pointer for first entry in chain of all nodes. */
113 extern struct device_node *of_allnodes;
114 extern struct device_node *of_chosen;
115 extern struct device_node *of_aliases;
116 extern raw_spinlock_t devtree_lock;
118 static inline bool of_have_populated_dt(void)
120 return of_allnodes != NULL;
123 static inline bool of_node_is_root(const struct device_node *node)
125 return node && (node->parent == NULL);
128 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
130 return test_bit(flag, &n->_flags);
133 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
135 set_bit(flag, &n->_flags);
138 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
140 clear_bit(flag, &n->_flags);
143 static inline int of_property_check_flag(struct property *p, unsigned long flag)
145 return test_bit(flag, &p->_flags);
148 static inline void of_property_set_flag(struct property *p, unsigned long flag)
150 set_bit(flag, &p->_flags);
153 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
155 clear_bit(flag, &p->_flags);
158 extern struct device_node *of_find_all_nodes(struct device_node *prev);
161 * OF address retrieval & translation
164 /* Helper to read a big number; size is in cells (not bytes) */
165 static inline u64 of_read_number(const __be32 *cell, int size)
169 r = (r << 32) | be32_to_cpu(*(cell++));
173 /* Like of_read_number, but we want an unsigned long result */
174 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
176 /* toss away upper bits if unsigned long is smaller than u64 */
177 return of_read_number(cell, size);
180 #if defined(CONFIG_SPARC)
181 #include <asm/prom.h>
184 /* Default #address and #size cells. Allow arch asm/prom.h to override */
185 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
186 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
187 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
190 /* Default string compare functions, Allow arch asm/prom.h to override */
191 #if !defined(of_compat_cmp)
192 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
193 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
194 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
197 /* flag descriptions */
198 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
199 #define OF_DETACHED 2 /* node has been detached from the device tree */
201 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
202 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
204 #define OF_BAD_ADDR ((u64)-1)
206 static inline const char *of_node_full_name(const struct device_node *np)
208 return np ? np->full_name : "<no-node>";
211 #define for_each_of_allnodes(dn) \
212 for (dn = of_allnodes; dn; dn = dn->allnext)
213 extern struct device_node *of_find_node_by_name(struct device_node *from,
215 extern struct device_node *of_find_node_by_type(struct device_node *from,
217 extern struct device_node *of_find_compatible_node(struct device_node *from,
218 const char *type, const char *compat);
219 extern struct device_node *of_find_matching_node_and_match(
220 struct device_node *from,
221 const struct of_device_id *matches,
222 const struct of_device_id **match);
224 extern struct device_node *of_find_node_by_path(const char *path);
225 extern struct device_node *of_find_node_by_phandle(phandle handle);
226 extern struct device_node *of_get_parent(const struct device_node *node);
227 extern struct device_node *of_get_next_parent(struct device_node *node);
228 extern struct device_node *of_get_next_child(const struct device_node *node,
229 struct device_node *prev);
230 extern struct device_node *of_get_next_available_child(
231 const struct device_node *node, struct device_node *prev);
233 extern struct device_node *of_get_child_by_name(const struct device_node *node,
237 extern struct device_node *of_find_next_cache_node(const struct device_node *);
238 extern struct device_node *of_find_node_with_property(
239 struct device_node *from, const char *prop_name);
241 extern struct property *of_find_property(const struct device_node *np,
244 extern int of_property_count_elems_of_size(const struct device_node *np,
245 const char *propname, int elem_size);
246 extern int of_property_read_u32_index(const struct device_node *np,
247 const char *propname,
248 u32 index, u32 *out_value);
249 extern int of_property_read_u8_array(const struct device_node *np,
250 const char *propname, u8 *out_values, size_t sz);
251 extern int of_property_read_u16_array(const struct device_node *np,
252 const char *propname, u16 *out_values, size_t sz);
253 extern int of_property_read_u32_array(const struct device_node *np,
254 const char *propname,
257 extern int of_property_read_u64(const struct device_node *np,
258 const char *propname, u64 *out_value);
260 extern int of_property_read_string(struct device_node *np,
261 const char *propname,
262 const char **out_string);
263 extern int of_property_read_string_index(struct device_node *np,
264 const char *propname,
265 int index, const char **output);
266 extern int of_property_match_string(struct device_node *np,
267 const char *propname,
269 extern int of_property_count_strings(struct device_node *np,
270 const char *propname);
271 extern int of_device_is_compatible(const struct device_node *device,
273 extern int of_device_is_available(const struct device_node *device);
274 extern const void *of_get_property(const struct device_node *node,
277 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
278 #define for_each_property_of_node(dn, pp) \
279 for (pp = dn->properties; pp != NULL; pp = pp->next)
281 extern int of_n_addr_cells(struct device_node *np);
282 extern int of_n_size_cells(struct device_node *np);
283 extern const struct of_device_id *of_match_node(
284 const struct of_device_id *matches, const struct device_node *node);
285 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
286 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
287 extern struct device_node *of_parse_phandle(const struct device_node *np,
288 const char *phandle_name,
290 extern int of_parse_phandle_with_args(const struct device_node *np,
291 const char *list_name, const char *cells_name, int index,
292 struct of_phandle_args *out_args);
293 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
294 const char *list_name, int cells_count, int index,
295 struct of_phandle_args *out_args);
296 extern int of_count_phandle_with_args(const struct device_node *np,
297 const char *list_name, const char *cells_name);
299 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
300 extern int of_alias_get_id(struct device_node *np, const char *stem);
302 extern int of_machine_is_compatible(const char *compat);
304 extern int of_add_property(struct device_node *np, struct property *prop);
305 extern int of_remove_property(struct device_node *np, struct property *prop);
306 extern int of_update_property(struct device_node *np, struct property *newprop);
308 /* For updating the device tree at runtime */
309 #define OF_RECONFIG_ATTACH_NODE 0x0001
310 #define OF_RECONFIG_DETACH_NODE 0x0002
311 #define OF_RECONFIG_ADD_PROPERTY 0x0003
312 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
313 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
315 struct of_prop_reconfig {
316 struct device_node *dn;
317 struct property *prop;
320 extern int of_reconfig_notifier_register(struct notifier_block *);
321 extern int of_reconfig_notifier_unregister(struct notifier_block *);
322 extern int of_reconfig_notify(unsigned long, void *);
324 extern int of_attach_node(struct device_node *);
325 extern int of_detach_node(struct device_node *);
327 #define of_match_ptr(_ptr) (_ptr)
330 * struct property *prop;
334 * of_property_for_each_u32(np, "propname", prop, p, u)
335 * printk("U32 value: %x\n", u);
337 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
340 * struct property *prop;
343 * of_property_for_each_string(np, "propname", prop, s)
344 * printk("String value: %s\n", s);
346 const char *of_prop_next_string(struct property *prop, const char *cur);
348 int of_device_is_stdout_path(struct device_node *dn);
350 #else /* CONFIG_OF */
352 static inline const char* of_node_full_name(struct device_node *np)
357 static inline struct device_node *of_find_node_by_name(struct device_node *from,
363 static inline struct device_node *of_find_node_by_type(struct device_node *from,
369 static inline struct device_node *of_find_matching_node_and_match(
370 struct device_node *from,
371 const struct of_device_id *matches,
372 const struct of_device_id **match)
377 static inline struct device_node *of_get_parent(const struct device_node *node)
382 static inline struct device_node *of_get_next_child(
383 const struct device_node *node, struct device_node *prev)
388 static inline struct device_node *of_get_next_available_child(
389 const struct device_node *node, struct device_node *prev)
394 static inline struct device_node *of_find_node_with_property(
395 struct device_node *from, const char *prop_name)
400 static inline bool of_have_populated_dt(void)
405 static inline struct device_node *of_get_child_by_name(
406 const struct device_node *node,
412 static inline int of_device_is_compatible(const struct device_node *device,
418 static inline int of_device_is_available(const struct device_node *device)
423 static inline struct property *of_find_property(const struct device_node *np,
430 static inline struct device_node *of_find_compatible_node(
431 struct device_node *from,
438 static inline int of_property_count_elems_of_size(const struct device_node *np,
439 const char *propname, int elem_size)
444 static inline int of_property_read_u32_index(const struct device_node *np,
445 const char *propname, u32 index, u32 *out_value)
450 static inline int of_property_read_u8_array(const struct device_node *np,
451 const char *propname, u8 *out_values, size_t sz)
456 static inline int of_property_read_u16_array(const struct device_node *np,
457 const char *propname, u16 *out_values, size_t sz)
462 static inline int of_property_read_u32_array(const struct device_node *np,
463 const char *propname,
464 u32 *out_values, size_t sz)
469 static inline int of_property_read_string(struct device_node *np,
470 const char *propname,
471 const char **out_string)
476 static inline int of_property_read_string_index(struct device_node *np,
477 const char *propname, int index,
478 const char **out_string)
483 static inline int of_property_count_strings(struct device_node *np,
484 const char *propname)
489 static inline const void *of_get_property(const struct device_node *node,
496 static inline struct device_node *of_get_cpu_node(int cpu,
497 unsigned int *thread)
502 static inline int of_property_read_u64(const struct device_node *np,
503 const char *propname, u64 *out_value)
508 static inline int of_property_match_string(struct device_node *np,
509 const char *propname,
515 static inline struct device_node *of_parse_phandle(const struct device_node *np,
516 const char *phandle_name,
522 static inline int of_parse_phandle_with_args(struct device_node *np,
523 const char *list_name,
524 const char *cells_name,
526 struct of_phandle_args *out_args)
531 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
532 const char *list_name, int cells_count, int index,
533 struct of_phandle_args *out_args)
538 static inline int of_count_phandle_with_args(struct device_node *np,
539 const char *list_name,
540 const char *cells_name)
545 static inline int of_alias_get_id(struct device_node *np, const char *stem)
550 static inline int of_machine_is_compatible(const char *compat)
555 static inline int of_device_is_stdout_path(struct device_node *dn)
560 static inline const __be32 *of_prop_next_u32(struct property *prop,
561 const __be32 *cur, u32 *pu)
566 static inline const char *of_prop_next_string(struct property *prop,
572 #define of_match_ptr(_ptr) NULL
573 #define of_match_node(_matches, _node) NULL
574 #endif /* CONFIG_OF */
576 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
577 extern int of_node_to_nid(struct device_node *np);
579 static inline int of_node_to_nid(struct device_node *device) { return 0; }
582 static inline struct device_node *of_find_matching_node(
583 struct device_node *from,
584 const struct of_device_id *matches)
586 return of_find_matching_node_and_match(from, matches, NULL);
590 * of_property_count_u8_elems - Count the number of u8 elements in a property
592 * @np: device node from which the property value is to be read.
593 * @propname: name of the property to be searched.
595 * Search for a property in a device node and count the number of u8 elements
596 * in it. Returns number of elements on sucess, -EINVAL if the property does
597 * not exist or its length does not match a multiple of u8 and -ENODATA if the
598 * property does not have a value.
600 static inline int of_property_count_u8_elems(const struct device_node *np,
601 const char *propname)
603 return of_property_count_elems_of_size(np, propname, sizeof(u8));
607 * of_property_count_u16_elems - Count the number of u16 elements in a property
609 * @np: device node from which the property value is to be read.
610 * @propname: name of the property to be searched.
612 * Search for a property in a device node and count the number of u16 elements
613 * in it. Returns number of elements on sucess, -EINVAL if the property does
614 * not exist or its length does not match a multiple of u16 and -ENODATA if the
615 * property does not have a value.
617 static inline int of_property_count_u16_elems(const struct device_node *np,
618 const char *propname)
620 return of_property_count_elems_of_size(np, propname, sizeof(u16));
624 * of_property_count_u32_elems - Count the number of u32 elements in a property
626 * @np: device node from which the property value is to be read.
627 * @propname: name of the property to be searched.
629 * Search for a property in a device node and count the number of u32 elements
630 * in it. Returns number of elements on sucess, -EINVAL if the property does
631 * not exist or its length does not match a multiple of u32 and -ENODATA if the
632 * property does not have a value.
634 static inline int of_property_count_u32_elems(const struct device_node *np,
635 const char *propname)
637 return of_property_count_elems_of_size(np, propname, sizeof(u32));
641 * of_property_count_u64_elems - Count the number of u64 elements in a property
643 * @np: device node from which the property value is to be read.
644 * @propname: name of the property to be searched.
646 * Search for a property in a device node and count the number of u64 elements
647 * in it. Returns number of elements on sucess, -EINVAL if the property does
648 * not exist or its length does not match a multiple of u64 and -ENODATA if the
649 * property does not have a value.
651 static inline int of_property_count_u64_elems(const struct device_node *np,
652 const char *propname)
654 return of_property_count_elems_of_size(np, propname, sizeof(u64));
658 * of_property_read_bool - Findfrom a property
659 * @np: device node from which the property value is to be read.
660 * @propname: name of the property to be searched.
662 * Search for a property in a device node.
663 * Returns true if the property exist false otherwise.
665 static inline bool of_property_read_bool(const struct device_node *np,
666 const char *propname)
668 struct property *prop = of_find_property(np, propname, NULL);
670 return prop ? true : false;
673 static inline int of_property_read_u8(const struct device_node *np,
674 const char *propname,
677 return of_property_read_u8_array(np, propname, out_value, 1);
680 static inline int of_property_read_u16(const struct device_node *np,
681 const char *propname,
684 return of_property_read_u16_array(np, propname, out_value, 1);
687 static inline int of_property_read_u32(const struct device_node *np,
688 const char *propname,
691 return of_property_read_u32_array(np, propname, out_value, 1);
694 #define of_property_for_each_u32(np, propname, prop, p, u) \
695 for (prop = of_find_property(np, propname, NULL), \
696 p = of_prop_next_u32(prop, NULL, &u); \
698 p = of_prop_next_u32(prop, p, &u))
700 #define of_property_for_each_string(np, propname, prop, s) \
701 for (prop = of_find_property(np, propname, NULL), \
702 s = of_prop_next_string(prop, NULL); \
704 s = of_prop_next_string(prop, s))
706 #define for_each_node_by_name(dn, name) \
707 for (dn = of_find_node_by_name(NULL, name); dn; \
708 dn = of_find_node_by_name(dn, name))
709 #define for_each_node_by_type(dn, type) \
710 for (dn = of_find_node_by_type(NULL, type); dn; \
711 dn = of_find_node_by_type(dn, type))
712 #define for_each_compatible_node(dn, type, compatible) \
713 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
714 dn = of_find_compatible_node(dn, type, compatible))
715 #define for_each_matching_node(dn, matches) \
716 for (dn = of_find_matching_node(NULL, matches); dn; \
717 dn = of_find_matching_node(dn, matches))
718 #define for_each_matching_node_and_match(dn, matches, match) \
719 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
720 dn; dn = of_find_matching_node_and_match(dn, matches, match))
722 #define for_each_child_of_node(parent, child) \
723 for (child = of_get_next_child(parent, NULL); child != NULL; \
724 child = of_get_next_child(parent, child))
725 #define for_each_available_child_of_node(parent, child) \
726 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
727 child = of_get_next_available_child(parent, child))
729 #define for_each_node_with_property(dn, prop_name) \
730 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
731 dn = of_find_node_with_property(dn, prop_name))
733 static inline int of_get_child_count(const struct device_node *np)
735 struct device_node *child;
738 for_each_child_of_node(np, child)
744 static inline int of_get_available_child_count(const struct device_node *np)
746 struct device_node *child;
749 for_each_available_child_of_node(np, child)
755 #endif /* _LINUX_OF_H */