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 struct device_node *of_stdout;
117 extern raw_spinlock_t devtree_lock;
119 static inline bool of_have_populated_dt(void)
121 return of_allnodes != NULL;
124 static inline bool of_node_is_root(const struct device_node *node)
126 return node && (node->parent == NULL);
129 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
131 return test_bit(flag, &n->_flags);
134 static inline int of_node_test_and_set_flag(struct device_node *n,
137 return test_and_set_bit(flag, &n->_flags);
140 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
142 set_bit(flag, &n->_flags);
145 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
147 clear_bit(flag, &n->_flags);
150 static inline int of_property_check_flag(struct property *p, unsigned long flag)
152 return test_bit(flag, &p->_flags);
155 static inline void of_property_set_flag(struct property *p, unsigned long flag)
157 set_bit(flag, &p->_flags);
160 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
162 clear_bit(flag, &p->_flags);
165 extern struct device_node *of_find_all_nodes(struct device_node *prev);
168 * OF address retrieval & translation
171 /* Helper to read a big number; size is in cells (not bytes) */
172 static inline u64 of_read_number(const __be32 *cell, int size)
176 r = (r << 32) | be32_to_cpu(*(cell++));
180 /* Like of_read_number, but we want an unsigned long result */
181 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
183 /* toss away upper bits if unsigned long is smaller than u64 */
184 return of_read_number(cell, size);
187 #if defined(CONFIG_SPARC)
188 #include <asm/prom.h>
191 /* Default #address and #size cells. Allow arch asm/prom.h to override */
192 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
193 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
194 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
197 /* Default string compare functions, Allow arch asm/prom.h to override */
198 #if !defined(of_compat_cmp)
199 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
200 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
201 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
204 /* flag descriptions */
205 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
206 #define OF_DETACHED 2 /* node has been detached from the device tree */
207 #define OF_POPULATED 3 /* device already created for the node */
209 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
210 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
212 #define OF_BAD_ADDR ((u64)-1)
214 static inline const char *of_node_full_name(const struct device_node *np)
216 return np ? np->full_name : "<no-node>";
219 #define for_each_of_allnodes(dn) \
220 for (dn = of_allnodes; dn; dn = dn->allnext)
221 extern struct device_node *of_find_node_by_name(struct device_node *from,
223 extern struct device_node *of_find_node_by_type(struct device_node *from,
225 extern struct device_node *of_find_compatible_node(struct device_node *from,
226 const char *type, const char *compat);
227 extern struct device_node *of_find_matching_node_and_match(
228 struct device_node *from,
229 const struct of_device_id *matches,
230 const struct of_device_id **match);
232 extern struct device_node *of_find_node_by_path(const char *path);
233 extern struct device_node *of_find_node_by_phandle(phandle handle);
234 extern struct device_node *of_get_parent(const struct device_node *node);
235 extern struct device_node *of_get_next_parent(struct device_node *node);
236 extern struct device_node *of_get_next_child(const struct device_node *node,
237 struct device_node *prev);
238 extern struct device_node *of_get_next_available_child(
239 const struct device_node *node, struct device_node *prev);
241 extern struct device_node *of_get_child_by_name(const struct device_node *node,
245 extern struct device_node *of_find_next_cache_node(const struct device_node *);
246 extern struct device_node *of_find_node_with_property(
247 struct device_node *from, const char *prop_name);
249 extern struct property *of_find_property(const struct device_node *np,
252 extern int of_property_count_elems_of_size(const struct device_node *np,
253 const char *propname, int elem_size);
254 extern int of_property_read_u32_index(const struct device_node *np,
255 const char *propname,
256 u32 index, u32 *out_value);
257 extern int of_property_read_u8_array(const struct device_node *np,
258 const char *propname, u8 *out_values, size_t sz);
259 extern int of_property_read_u16_array(const struct device_node *np,
260 const char *propname, u16 *out_values, size_t sz);
261 extern int of_property_read_u32_array(const struct device_node *np,
262 const char *propname,
265 extern int of_property_read_u64(const struct device_node *np,
266 const char *propname, u64 *out_value);
268 extern int of_property_read_string(struct device_node *np,
269 const char *propname,
270 const char **out_string);
271 extern int of_property_read_string_index(struct device_node *np,
272 const char *propname,
273 int index, const char **output);
274 extern int of_property_match_string(struct device_node *np,
275 const char *propname,
277 extern int of_property_count_strings(struct device_node *np,
278 const char *propname);
279 extern int of_device_is_compatible(const struct device_node *device,
281 extern int of_device_is_available(const struct device_node *device);
282 extern const void *of_get_property(const struct device_node *node,
285 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
286 #define for_each_property_of_node(dn, pp) \
287 for (pp = dn->properties; pp != NULL; pp = pp->next)
289 extern int of_n_addr_cells(struct device_node *np);
290 extern int of_n_size_cells(struct device_node *np);
291 extern const struct of_device_id *of_match_node(
292 const struct of_device_id *matches, const struct device_node *node);
293 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
294 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
295 extern struct device_node *of_parse_phandle(const struct device_node *np,
296 const char *phandle_name,
298 extern int of_parse_phandle_with_args(const struct device_node *np,
299 const char *list_name, const char *cells_name, int index,
300 struct of_phandle_args *out_args);
301 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
302 const char *list_name, int cells_count, int index,
303 struct of_phandle_args *out_args);
304 extern int of_count_phandle_with_args(const struct device_node *np,
305 const char *list_name, const char *cells_name);
307 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
308 extern int of_alias_get_id(struct device_node *np, const char *stem);
310 extern int of_machine_is_compatible(const char *compat);
312 extern int of_add_property(struct device_node *np, struct property *prop);
313 extern int of_remove_property(struct device_node *np, struct property *prop);
314 extern int of_update_property(struct device_node *np, struct property *newprop);
316 /* For updating the device tree at runtime */
317 #define OF_RECONFIG_ATTACH_NODE 0x0001
318 #define OF_RECONFIG_DETACH_NODE 0x0002
319 #define OF_RECONFIG_ADD_PROPERTY 0x0003
320 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
321 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
323 struct of_prop_reconfig {
324 struct device_node *dn;
325 struct property *prop;
328 extern int of_reconfig_notifier_register(struct notifier_block *);
329 extern int of_reconfig_notifier_unregister(struct notifier_block *);
330 extern int of_reconfig_notify(unsigned long, void *);
332 extern int of_attach_node(struct device_node *);
333 extern int of_detach_node(struct device_node *);
335 #define of_match_ptr(_ptr) (_ptr)
338 * struct property *prop;
342 * of_property_for_each_u32(np, "propname", prop, p, u)
343 * printk("U32 value: %x\n", u);
345 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
348 * struct property *prop;
351 * of_property_for_each_string(np, "propname", prop, s)
352 * printk("String value: %s\n", s);
354 const char *of_prop_next_string(struct property *prop, const char *cur);
356 bool of_console_check(struct device_node *dn, char *name, int index);
358 #else /* CONFIG_OF */
360 static inline const char* of_node_full_name(const struct device_node *np)
365 static inline struct device_node *of_find_node_by_name(struct device_node *from,
371 static inline struct device_node *of_find_node_by_type(struct device_node *from,
377 static inline struct device_node *of_find_matching_node_and_match(
378 struct device_node *from,
379 const struct of_device_id *matches,
380 const struct of_device_id **match)
385 static inline struct device_node *of_find_node_by_path(const char *path)
390 static inline struct device_node *of_get_parent(const struct device_node *node)
395 static inline struct device_node *of_get_next_child(
396 const struct device_node *node, struct device_node *prev)
401 static inline struct device_node *of_get_next_available_child(
402 const struct device_node *node, struct device_node *prev)
407 static inline struct device_node *of_find_node_with_property(
408 struct device_node *from, const char *prop_name)
413 static inline bool of_have_populated_dt(void)
418 static inline struct device_node *of_get_child_by_name(
419 const struct device_node *node,
425 static inline int of_device_is_compatible(const struct device_node *device,
431 static inline int of_device_is_available(const struct device_node *device)
436 static inline struct property *of_find_property(const struct device_node *np,
443 static inline struct device_node *of_find_compatible_node(
444 struct device_node *from,
451 static inline int of_property_count_elems_of_size(const struct device_node *np,
452 const char *propname, int elem_size)
457 static inline int of_property_read_u32_index(const struct device_node *np,
458 const char *propname, u32 index, u32 *out_value)
463 static inline int of_property_read_u8_array(const struct device_node *np,
464 const char *propname, u8 *out_values, size_t sz)
469 static inline int of_property_read_u16_array(const struct device_node *np,
470 const char *propname, u16 *out_values, size_t sz)
475 static inline int of_property_read_u32_array(const struct device_node *np,
476 const char *propname,
477 u32 *out_values, size_t sz)
482 static inline int of_property_read_string(struct device_node *np,
483 const char *propname,
484 const char **out_string)
489 static inline int of_property_read_string_index(struct device_node *np,
490 const char *propname, int index,
491 const char **out_string)
496 static inline int of_property_count_strings(struct device_node *np,
497 const char *propname)
502 static inline const void *of_get_property(const struct device_node *node,
509 static inline struct device_node *of_get_cpu_node(int cpu,
510 unsigned int *thread)
515 static inline int of_property_read_u64(const struct device_node *np,
516 const char *propname, u64 *out_value)
521 static inline int of_property_match_string(struct device_node *np,
522 const char *propname,
528 static inline struct device_node *of_parse_phandle(const struct device_node *np,
529 const char *phandle_name,
535 static inline int of_parse_phandle_with_args(struct device_node *np,
536 const char *list_name,
537 const char *cells_name,
539 struct of_phandle_args *out_args)
544 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
545 const char *list_name, int cells_count, int index,
546 struct of_phandle_args *out_args)
551 static inline int of_count_phandle_with_args(struct device_node *np,
552 const char *list_name,
553 const char *cells_name)
558 static inline int of_alias_get_id(struct device_node *np, const char *stem)
563 static inline int of_machine_is_compatible(const char *compat)
568 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
573 static inline const __be32 *of_prop_next_u32(struct property *prop,
574 const __be32 *cur, u32 *pu)
579 static inline const char *of_prop_next_string(struct property *prop,
585 #define of_match_ptr(_ptr) NULL
586 #define of_match_node(_matches, _node) NULL
587 #endif /* CONFIG_OF */
589 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
590 extern int of_node_to_nid(struct device_node *np);
592 static inline int of_node_to_nid(struct device_node *device) { return 0; }
595 static inline struct device_node *of_find_matching_node(
596 struct device_node *from,
597 const struct of_device_id *matches)
599 return of_find_matching_node_and_match(from, matches, NULL);
603 * of_property_count_u8_elems - Count the number of u8 elements in a property
605 * @np: device node from which the property value is to be read.
606 * @propname: name of the property to be searched.
608 * Search for a property in a device node and count the number of u8 elements
609 * in it. Returns number of elements on sucess, -EINVAL if the property does
610 * not exist or its length does not match a multiple of u8 and -ENODATA if the
611 * property does not have a value.
613 static inline int of_property_count_u8_elems(const struct device_node *np,
614 const char *propname)
616 return of_property_count_elems_of_size(np, propname, sizeof(u8));
620 * of_property_count_u16_elems - Count the number of u16 elements in a property
622 * @np: device node from which the property value is to be read.
623 * @propname: name of the property to be searched.
625 * Search for a property in a device node and count the number of u16 elements
626 * in it. Returns number of elements on sucess, -EINVAL if the property does
627 * not exist or its length does not match a multiple of u16 and -ENODATA if the
628 * property does not have a value.
630 static inline int of_property_count_u16_elems(const struct device_node *np,
631 const char *propname)
633 return of_property_count_elems_of_size(np, propname, sizeof(u16));
637 * of_property_count_u32_elems - Count the number of u32 elements in a property
639 * @np: device node from which the property value is to be read.
640 * @propname: name of the property to be searched.
642 * Search for a property in a device node and count the number of u32 elements
643 * in it. Returns number of elements on sucess, -EINVAL if the property does
644 * not exist or its length does not match a multiple of u32 and -ENODATA if the
645 * property does not have a value.
647 static inline int of_property_count_u32_elems(const struct device_node *np,
648 const char *propname)
650 return of_property_count_elems_of_size(np, propname, sizeof(u32));
654 * of_property_count_u64_elems - Count the number of u64 elements in a property
656 * @np: device node from which the property value is to be read.
657 * @propname: name of the property to be searched.
659 * Search for a property in a device node and count the number of u64 elements
660 * in it. Returns number of elements on sucess, -EINVAL if the property does
661 * not exist or its length does not match a multiple of u64 and -ENODATA if the
662 * property does not have a value.
664 static inline int of_property_count_u64_elems(const struct device_node *np,
665 const char *propname)
667 return of_property_count_elems_of_size(np, propname, sizeof(u64));
671 * of_property_read_bool - Findfrom a property
672 * @np: device node from which the property value is to be read.
673 * @propname: name of the property to be searched.
675 * Search for a property in a device node.
676 * Returns true if the property exist false otherwise.
678 static inline bool of_property_read_bool(const struct device_node *np,
679 const char *propname)
681 struct property *prop = of_find_property(np, propname, NULL);
683 return prop ? true : false;
686 static inline int of_property_read_u8(const struct device_node *np,
687 const char *propname,
690 return of_property_read_u8_array(np, propname, out_value, 1);
693 static inline int of_property_read_u16(const struct device_node *np,
694 const char *propname,
697 return of_property_read_u16_array(np, propname, out_value, 1);
700 static inline int of_property_read_u32(const struct device_node *np,
701 const char *propname,
704 return of_property_read_u32_array(np, propname, out_value, 1);
707 #define of_property_for_each_u32(np, propname, prop, p, u) \
708 for (prop = of_find_property(np, propname, NULL), \
709 p = of_prop_next_u32(prop, NULL, &u); \
711 p = of_prop_next_u32(prop, p, &u))
713 #define of_property_for_each_string(np, propname, prop, s) \
714 for (prop = of_find_property(np, propname, NULL), \
715 s = of_prop_next_string(prop, NULL); \
717 s = of_prop_next_string(prop, s))
719 #define for_each_node_by_name(dn, name) \
720 for (dn = of_find_node_by_name(NULL, name); dn; \
721 dn = of_find_node_by_name(dn, name))
722 #define for_each_node_by_type(dn, type) \
723 for (dn = of_find_node_by_type(NULL, type); dn; \
724 dn = of_find_node_by_type(dn, type))
725 #define for_each_compatible_node(dn, type, compatible) \
726 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
727 dn = of_find_compatible_node(dn, type, compatible))
728 #define for_each_matching_node(dn, matches) \
729 for (dn = of_find_matching_node(NULL, matches); dn; \
730 dn = of_find_matching_node(dn, matches))
731 #define for_each_matching_node_and_match(dn, matches, match) \
732 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
733 dn; dn = of_find_matching_node_and_match(dn, matches, match))
735 #define for_each_child_of_node(parent, child) \
736 for (child = of_get_next_child(parent, NULL); child != NULL; \
737 child = of_get_next_child(parent, child))
738 #define for_each_available_child_of_node(parent, child) \
739 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
740 child = of_get_next_available_child(parent, child))
742 #define for_each_node_with_property(dn, prop_name) \
743 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
744 dn = of_find_node_with_property(dn, prop_name))
746 static inline int of_get_child_count(const struct device_node *np)
748 struct device_node *child;
751 for_each_child_of_node(np, child)
757 static inline int of_get_available_child_count(const struct device_node *np)
759 struct device_node *child;
762 for_each_available_child_of_node(np, child)
769 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
770 static const struct of_device_id __of_table_##name \
771 __used __section(__##table##_of_table) \
772 = { .compatible = compat, \
773 .data = (fn == (fn_type)NULL) ? fn : fn }
775 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
776 static const struct of_device_id __of_table_##name \
777 __attribute__((unused)) \
778 = { .compatible = compat, \
779 .data = (fn == (fn_type)NULL) ? fn : fn }
782 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
783 typedef void (*of_init_fn_1)(struct device_node *);
785 #define OF_DECLARE_1(table, name, compat, fn) \
786 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
787 #define OF_DECLARE_2(table, name, compat, fn) \
788 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
790 #endif /* _LINUX_OF_H */