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>
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;
42 #if defined(CONFIG_SPARC)
43 struct of_irq_controller;
50 const char *full_name;
52 struct property *properties;
53 struct property *deadprops; /* removed properties */
54 struct device_node *parent;
55 struct device_node *child;
56 struct device_node *sibling;
57 struct device_node *next; /* next device of same type */
58 struct device_node *allnext; /* next in list of all nodes */
59 struct proc_dir_entry *pde; /* this node's proc directory */
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 8
71 struct of_phandle_args {
72 struct device_node *np;
74 uint32_t args[MAX_PHANDLE_ARGS];
77 #ifdef CONFIG_OF_DYNAMIC
78 extern struct device_node *of_node_get(struct device_node *node);
79 extern void of_node_put(struct device_node *node);
80 #else /* CONFIG_OF_DYNAMIC */
81 /* Dummy ref counting routines - to be implemented later */
82 static inline struct device_node *of_node_get(struct device_node *node)
86 static inline void of_node_put(struct device_node *node) { }
87 #endif /* !CONFIG_OF_DYNAMIC */
91 /* Pointer for first entry in chain of all nodes. */
92 extern struct device_node *of_allnodes;
93 extern struct device_node *of_chosen;
94 extern struct device_node *of_aliases;
95 extern raw_spinlock_t devtree_lock;
97 static inline bool of_have_populated_dt(void)
99 return of_allnodes != NULL;
102 static inline bool of_node_is_root(const struct device_node *node)
104 return node && (node->parent == NULL);
107 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
109 return test_bit(flag, &n->_flags);
112 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
114 set_bit(flag, &n->_flags);
117 extern struct device_node *of_find_all_nodes(struct device_node *prev);
120 * OF address retrieval & translation
123 /* Helper to read a big number; size is in cells (not bytes) */
124 static inline u64 of_read_number(const __be32 *cell, int size)
128 r = (r << 32) | be32_to_cpu(*(cell++));
132 /* Like of_read_number, but we want an unsigned long result */
133 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
135 /* toss away upper bits if unsigned long is smaller than u64 */
136 return of_read_number(cell, size);
139 #if defined(CONFIG_SPARC)
140 #include <asm/prom.h>
143 /* Default #address and #size cells. Allow arch asm/prom.h to override */
144 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
145 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
146 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
149 /* Default string compare functions, Allow arch asm/prom.h to override */
150 #if !defined(of_compat_cmp)
151 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
152 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
153 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
156 /* flag descriptions */
157 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
158 #define OF_DETACHED 2 /* node has been detached from the device tree */
160 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
161 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
163 #define OF_BAD_ADDR ((u64)-1)
165 static inline const char *of_node_full_name(const struct device_node *np)
167 return np ? np->full_name : "<no-node>";
170 extern struct device_node *of_find_node_by_name(struct device_node *from,
172 extern struct device_node *of_find_node_by_type(struct device_node *from,
174 extern struct device_node *of_find_compatible_node(struct device_node *from,
175 const char *type, const char *compat);
176 extern struct device_node *of_find_matching_node_and_match(
177 struct device_node *from,
178 const struct of_device_id *matches,
179 const struct of_device_id **match);
181 extern struct device_node *of_find_node_by_path(const char *path);
182 extern struct device_node *of_find_node_by_phandle(phandle handle);
183 extern struct device_node *of_get_parent(const struct device_node *node);
184 extern struct device_node *of_get_next_parent(struct device_node *node);
185 extern struct device_node *of_get_next_child(const struct device_node *node,
186 struct device_node *prev);
187 extern struct device_node *of_get_next_available_child(
188 const struct device_node *node, struct device_node *prev);
190 extern struct device_node *of_get_child_by_name(const struct device_node *node,
194 extern struct device_node *of_find_next_cache_node(const struct device_node *);
195 extern struct device_node *of_find_node_with_property(
196 struct device_node *from, const char *prop_name);
198 extern struct property *of_find_property(const struct device_node *np,
201 extern int of_property_read_u32_index(const struct device_node *np,
202 const char *propname,
203 u32 index, u32 *out_value);
204 extern int of_property_read_u8_array(const struct device_node *np,
205 const char *propname, u8 *out_values, size_t sz);
206 extern int of_property_read_u16_array(const struct device_node *np,
207 const char *propname, u16 *out_values, size_t sz);
208 extern int of_property_read_u32_array(const struct device_node *np,
209 const char *propname,
212 extern int of_property_read_u64(const struct device_node *np,
213 const char *propname, u64 *out_value);
215 extern int of_property_read_string(struct device_node *np,
216 const char *propname,
217 const char **out_string);
218 extern int of_property_match_string(struct device_node *np,
219 const char *propname,
221 extern int of_property_read_string_helper(struct device_node *np,
222 const char *propname,
223 const char **out_strs, size_t sz, int index);
224 extern int of_device_is_compatible(const struct device_node *device,
226 extern int of_device_is_available(const struct device_node *device);
227 extern const void *of_get_property(const struct device_node *node,
230 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
231 #define for_each_property_of_node(dn, pp) \
232 for (pp = dn->properties; pp != NULL; pp = pp->next)
234 extern int of_n_addr_cells(struct device_node *np);
235 extern int of_n_size_cells(struct device_node *np);
236 extern const struct of_device_id *of_match_node(
237 const struct of_device_id *matches, const struct device_node *node);
238 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
239 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
240 extern struct device_node *of_parse_phandle(const struct device_node *np,
241 const char *phandle_name,
243 extern int of_parse_phandle_with_args(const struct device_node *np,
244 const char *list_name, const char *cells_name, int index,
245 struct of_phandle_args *out_args);
246 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
247 const char *list_name, int cells_count, int index,
248 struct of_phandle_args *out_args);
249 extern int of_count_phandle_with_args(const struct device_node *np,
250 const char *list_name, const char *cells_name);
252 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
253 extern int of_alias_get_id(struct device_node *np, const char *stem);
255 extern int of_machine_is_compatible(const char *compat);
257 extern int of_add_property(struct device_node *np, struct property *prop);
258 extern int of_remove_property(struct device_node *np, struct property *prop);
259 extern int of_update_property(struct device_node *np, struct property *newprop);
261 /* For updating the device tree at runtime */
262 #define OF_RECONFIG_ATTACH_NODE 0x0001
263 #define OF_RECONFIG_DETACH_NODE 0x0002
264 #define OF_RECONFIG_ADD_PROPERTY 0x0003
265 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
266 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
268 struct of_prop_reconfig {
269 struct device_node *dn;
270 struct property *prop;
273 extern int of_reconfig_notifier_register(struct notifier_block *);
274 extern int of_reconfig_notifier_unregister(struct notifier_block *);
275 extern int of_reconfig_notify(unsigned long, void *);
277 extern int of_attach_node(struct device_node *);
278 extern int of_detach_node(struct device_node *);
280 #define of_match_ptr(_ptr) (_ptr)
283 * struct property *prop;
287 * of_property_for_each_u32(np, "propname", prop, p, u)
288 * printk("U32 value: %x\n", u);
290 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
293 * struct property *prop;
296 * of_property_for_each_string(np, "propname", prop, s)
297 * printk("String value: %s\n", s);
299 const char *of_prop_next_string(struct property *prop, const char *cur);
301 int of_device_is_stdout_path(struct device_node *dn);
303 #else /* CONFIG_OF */
305 static inline const char* of_node_full_name(struct device_node *np)
310 static inline struct device_node *of_find_node_by_name(struct device_node *from,
316 static inline struct device_node *of_find_node_by_type(struct device_node *from,
322 static inline struct device_node *of_find_matching_node_and_match(
323 struct device_node *from,
324 const struct of_device_id *matches,
325 const struct of_device_id **match)
330 static inline struct device_node *of_get_parent(const struct device_node *node)
335 static inline struct device_node *of_get_next_child(
336 const struct device_node *node, struct device_node *prev)
341 static inline struct device_node *of_get_next_available_child(
342 const struct device_node *node, struct device_node *prev)
347 static inline struct device_node *of_find_node_with_property(
348 struct device_node *from, const char *prop_name)
353 static inline bool of_have_populated_dt(void)
358 static inline struct device_node *of_get_child_by_name(
359 const struct device_node *node,
365 static inline int of_device_is_compatible(const struct device_node *device,
371 static inline int of_device_is_available(const struct device_node *device)
376 static inline struct property *of_find_property(const struct device_node *np,
383 static inline struct device_node *of_find_compatible_node(
384 struct device_node *from,
391 static inline int of_property_read_u32_index(const struct device_node *np,
392 const char *propname, u32 index, u32 *out_value)
397 static inline int of_property_read_u8_array(const struct device_node *np,
398 const char *propname, u8 *out_values, size_t sz)
403 static inline int of_property_read_u16_array(const struct device_node *np,
404 const char *propname, u16 *out_values, size_t sz)
409 static inline int of_property_read_u32_array(const struct device_node *np,
410 const char *propname,
411 u32 *out_values, size_t sz)
416 static inline int of_property_read_string(struct device_node *np,
417 const char *propname,
418 const char **out_string)
423 static inline int of_property_read_string_helper(struct device_node *np,
424 const char *propname,
425 const char **out_strs, size_t sz, int index)
430 static inline const void *of_get_property(const struct device_node *node,
437 static inline struct device_node *of_get_cpu_node(int cpu,
438 unsigned int *thread)
443 static inline int of_property_read_u64(const struct device_node *np,
444 const char *propname, u64 *out_value)
449 static inline int of_property_match_string(struct device_node *np,
450 const char *propname,
456 static inline struct device_node *of_parse_phandle(const struct device_node *np,
457 const char *phandle_name,
463 static inline int of_parse_phandle_with_args(struct device_node *np,
464 const char *list_name,
465 const char *cells_name,
467 struct of_phandle_args *out_args)
472 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
473 const char *list_name, int cells_count, int index,
474 struct of_phandle_args *out_args)
479 static inline int of_count_phandle_with_args(struct device_node *np,
480 const char *list_name,
481 const char *cells_name)
486 static inline int of_alias_get_id(struct device_node *np, const char *stem)
491 static inline int of_machine_is_compatible(const char *compat)
496 static inline int of_device_is_stdout_path(struct device_node *dn)
501 static inline const __be32 *of_prop_next_u32(struct property *prop,
502 const __be32 *cur, u32 *pu)
507 static inline const char *of_prop_next_string(struct property *prop,
513 #define of_match_ptr(_ptr) NULL
514 #define of_match_node(_matches, _node) NULL
515 #endif /* CONFIG_OF */
517 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
518 extern int of_node_to_nid(struct device_node *np);
520 static inline int of_node_to_nid(struct device_node *device) { return 0; }
523 static inline struct device_node *of_find_matching_node(
524 struct device_node *from,
525 const struct of_device_id *matches)
527 return of_find_matching_node_and_match(from, matches, NULL);
531 * of_property_read_string_array() - Read an array of strings from a multiple
533 * @np: device node from which the property value is to be read.
534 * @propname: name of the property to be searched.
535 * @out_strs: output array of string pointers.
536 * @sz: number of array elements to read.
538 * Search for a property in a device tree node and retrieve a list of
539 * terminated string values (pointer to data, not a copy) in that property.
541 * If @out_strs is NULL, the number of strings in the property is returned.
543 static inline int of_property_read_string_array(struct device_node *np,
544 const char *propname, const char **out_strs,
547 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
551 * of_property_count_strings() - Find and return the number of strings from a
552 * multiple strings property.
553 * @np: device node from which the property value is to be read.
554 * @propname: name of the property to be searched.
556 * Search for a property in a device tree node and retrieve the number of null
557 * terminated string contain in it. Returns the number of strings on
558 * success, -EINVAL if the property does not exist, -ENODATA if property
559 * does not have a value, and -EILSEQ if the string is not null-terminated
560 * within the length of the property data.
562 static inline int of_property_count_strings(struct device_node *np,
563 const char *propname)
565 return of_property_read_string_helper(np, propname, NULL, 0, 0);
569 * of_property_read_string_index() - Find and read a string from a multiple
571 * @np: device node from which the property value is to be read.
572 * @propname: name of the property to be searched.
573 * @index: index of the string in the list of strings
574 * @out_string: pointer to null terminated return string, modified only if
577 * Search for a property in a device tree node and retrieve a null
578 * terminated string value (pointer to data, not a copy) in the list of strings
579 * contained in that property.
580 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
581 * property does not have a value, and -EILSEQ if the string is not
582 * null-terminated within the length of the property data.
584 * The out_string pointer is modified only if a valid string can be decoded.
586 static inline int of_property_read_string_index(struct device_node *np,
587 const char *propname,
588 int index, const char **output)
590 int rc = of_property_read_string_helper(np, propname, output, 1, index);
591 return rc < 0 ? rc : 0;
595 * of_property_read_bool - Findfrom a property
596 * @np: device node from which the property value is to be read.
597 * @propname: name of the property to be searched.
599 * Search for a property in a device node.
600 * Returns true if the property exist false otherwise.
602 static inline bool of_property_read_bool(const struct device_node *np,
603 const char *propname)
605 struct property *prop = of_find_property(np, propname, NULL);
607 return prop ? true : false;
610 static inline int of_property_read_u8(const struct device_node *np,
611 const char *propname,
614 return of_property_read_u8_array(np, propname, out_value, 1);
617 static inline int of_property_read_u16(const struct device_node *np,
618 const char *propname,
621 return of_property_read_u16_array(np, propname, out_value, 1);
624 static inline int of_property_read_u32(const struct device_node *np,
625 const char *propname,
628 return of_property_read_u32_array(np, propname, out_value, 1);
631 #define of_property_for_each_u32(np, propname, prop, p, u) \
632 for (prop = of_find_property(np, propname, NULL), \
633 p = of_prop_next_u32(prop, NULL, &u); \
635 p = of_prop_next_u32(prop, p, &u))
637 #define of_property_for_each_string(np, propname, prop, s) \
638 for (prop = of_find_property(np, propname, NULL), \
639 s = of_prop_next_string(prop, NULL); \
641 s = of_prop_next_string(prop, s))
643 #define for_each_node_by_name(dn, name) \
644 for (dn = of_find_node_by_name(NULL, name); dn; \
645 dn = of_find_node_by_name(dn, name))
646 #define for_each_node_by_type(dn, type) \
647 for (dn = of_find_node_by_type(NULL, type); dn; \
648 dn = of_find_node_by_type(dn, type))
649 #define for_each_compatible_node(dn, type, compatible) \
650 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
651 dn = of_find_compatible_node(dn, type, compatible))
652 #define for_each_matching_node(dn, matches) \
653 for (dn = of_find_matching_node(NULL, matches); dn; \
654 dn = of_find_matching_node(dn, matches))
655 #define for_each_matching_node_and_match(dn, matches, match) \
656 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
657 dn; dn = of_find_matching_node_and_match(dn, matches, match))
659 #define for_each_child_of_node(parent, child) \
660 for (child = of_get_next_child(parent, NULL); child != NULL; \
661 child = of_get_next_child(parent, child))
662 #define for_each_available_child_of_node(parent, child) \
663 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
664 child = of_get_next_available_child(parent, child))
666 #define for_each_node_with_property(dn, prop_name) \
667 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
668 dn = of_find_node_with_property(dn, prop_name))
670 static inline int of_get_child_count(const struct device_node *np)
672 struct device_node *child;
675 for_each_child_of_node(np, child)
681 static inline int of_get_available_child_count(const struct device_node *np)
683 struct device_node *child;
686 for_each_available_child_of_node(np, child)
692 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
693 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
694 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
695 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
696 struct property *prop);
697 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
698 struct property *newprop,
699 struct property *oldprop);
702 #endif /* _LINUX_OF_H */