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>
26 #include <linux/property.h>
27 #include <linux/list.h>
29 #include <asm/byteorder.h>
30 #include <asm/errno.h>
39 struct property
*next
;
41 unsigned int unique_id
;
42 struct bin_attribute attr
;
45 #if defined(CONFIG_SPARC)
46 struct of_irq_controller
;
53 const char *full_name
;
54 struct fwnode_handle fwnode
;
56 struct property
*properties
;
57 struct property
*deadprops
; /* removed properties */
58 struct device_node
*parent
;
59 struct device_node
*child
;
60 struct device_node
*sibling
;
64 #if defined(CONFIG_SPARC)
65 const char *path_component_name
;
66 unsigned int unique_id
;
67 struct of_irq_controller
*irq_trans
;
71 #define MAX_PHANDLE_ARGS 16
72 struct of_phandle_args
{
73 struct device_node
*np
;
75 uint32_t args
[MAX_PHANDLE_ARGS
];
78 struct of_reconfig_data
{
79 struct device_node
*dn
;
80 struct property
*prop
;
81 struct property
*old_prop
;
84 /* initialize a node */
85 extern struct kobj_type of_node_ktype
;
86 static inline void of_node_init(struct device_node
*node
)
88 kobject_init(&node
->kobj
, &of_node_ktype
);
89 node
->fwnode
.type
= FWNODE_OF
;
92 /* true when node is initialized */
93 static inline int of_node_is_initialized(struct device_node
*node
)
95 return node
&& node
->kobj
.state_initialized
;
98 /* true when node is attached (i.e. present on sysfs) */
99 static inline int of_node_is_attached(struct device_node
*node
)
101 return node
&& node
->kobj
.state_in_sysfs
;
104 #ifdef CONFIG_OF_DYNAMIC
105 extern struct device_node
*of_node_get(struct device_node
*node
);
106 extern void of_node_put(struct device_node
*node
);
107 #else /* CONFIG_OF_DYNAMIC */
108 /* Dummy ref counting routines - to be implemented later */
109 static inline struct device_node
*of_node_get(struct device_node
*node
)
113 static inline void of_node_put(struct device_node
*node
) { }
114 #endif /* !CONFIG_OF_DYNAMIC */
116 /* Pointer for first entry in chain of all nodes. */
117 extern struct device_node
*of_root
;
118 extern struct device_node
*of_chosen
;
119 extern struct device_node
*of_aliases
;
120 extern struct device_node
*of_stdout
;
121 extern raw_spinlock_t devtree_lock
;
124 void of_core_init(void);
126 static inline bool is_of_node(struct fwnode_handle
*fwnode
)
128 return fwnode
&& fwnode
->type
== FWNODE_OF
;
131 static inline struct device_node
*of_node(struct fwnode_handle
*fwnode
)
133 return fwnode
? container_of(fwnode
, struct device_node
, fwnode
) : NULL
;
136 static inline bool of_have_populated_dt(void)
138 return of_root
!= NULL
;
141 static inline bool of_node_is_root(const struct device_node
*node
)
143 return node
&& (node
->parent
== NULL
);
146 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
148 return test_bit(flag
, &n
->_flags
);
151 static inline int of_node_test_and_set_flag(struct device_node
*n
,
154 return test_and_set_bit(flag
, &n
->_flags
);
157 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
159 set_bit(flag
, &n
->_flags
);
162 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
164 clear_bit(flag
, &n
->_flags
);
167 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
169 return test_bit(flag
, &p
->_flags
);
172 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
174 set_bit(flag
, &p
->_flags
);
177 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
179 clear_bit(flag
, &p
->_flags
);
182 extern struct device_node
*__of_find_all_nodes(struct device_node
*prev
);
183 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
186 * OF address retrieval & translation
189 /* Helper to read a big number; size is in cells (not bytes) */
190 static inline u64
of_read_number(const __be32
*cell
, int size
)
194 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
198 /* Like of_read_number, but we want an unsigned long result */
199 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
201 /* toss away upper bits if unsigned long is smaller than u64 */
202 return of_read_number(cell
, size
);
205 #if defined(CONFIG_SPARC)
206 #include <asm/prom.h>
209 /* Default #address and #size cells. Allow arch asm/prom.h to override */
210 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
211 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
212 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
215 /* Default string compare functions, Allow arch asm/prom.h to override */
216 #if !defined(of_compat_cmp)
217 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
218 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
219 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
222 /* flag descriptions */
223 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
224 #define OF_DETACHED 2 /* node has been detached from the device tree */
225 #define OF_POPULATED 3 /* device already created for the node */
226 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
228 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
229 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
231 #define OF_BAD_ADDR ((u64)-1)
233 static inline const char *of_node_full_name(const struct device_node
*np
)
235 return np
? np
->full_name
: "<no-node>";
238 #define for_each_of_allnodes_from(from, dn) \
239 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
240 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
241 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
243 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
245 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
246 const char *type
, const char *compat
);
247 extern struct device_node
*of_find_matching_node_and_match(
248 struct device_node
*from
,
249 const struct of_device_id
*matches
,
250 const struct of_device_id
**match
);
252 extern struct device_node
*of_find_node_opts_by_path(const char *path
,
254 static inline struct device_node
*of_find_node_by_path(const char *path
)
256 return of_find_node_opts_by_path(path
, NULL
);
259 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
260 extern struct device_node
*of_get_parent(const struct device_node
*node
);
261 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
262 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
263 struct device_node
*prev
);
264 extern struct device_node
*of_get_next_available_child(
265 const struct device_node
*node
, struct device_node
*prev
);
267 extern struct device_node
*of_get_child_by_name(const struct device_node
*node
,
271 extern struct device_node
*of_find_next_cache_node(const struct device_node
*);
272 extern struct device_node
*of_find_node_with_property(
273 struct device_node
*from
, const char *prop_name
);
275 extern struct property
*of_find_property(const struct device_node
*np
,
278 extern int of_property_count_elems_of_size(const struct device_node
*np
,
279 const char *propname
, int elem_size
);
280 extern int of_property_read_u32_index(const struct device_node
*np
,
281 const char *propname
,
282 u32 index
, u32
*out_value
);
283 extern int of_property_read_u8_array(const struct device_node
*np
,
284 const char *propname
, u8
*out_values
, size_t sz
);
285 extern int of_property_read_u16_array(const struct device_node
*np
,
286 const char *propname
, u16
*out_values
, size_t sz
);
287 extern int of_property_read_u32_array(const struct device_node
*np
,
288 const char *propname
,
291 extern int of_property_read_u64(const struct device_node
*np
,
292 const char *propname
, u64
*out_value
);
293 extern int of_property_read_u64_array(const struct device_node
*np
,
294 const char *propname
,
298 extern int of_property_read_string(struct device_node
*np
,
299 const char *propname
,
300 const char **out_string
);
301 extern int of_property_match_string(struct device_node
*np
,
302 const char *propname
,
304 extern int of_property_read_string_helper(struct device_node
*np
,
305 const char *propname
,
306 const char **out_strs
, size_t sz
, int index
);
307 extern int of_device_is_compatible(const struct device_node
*device
,
309 extern bool of_device_is_available(const struct device_node
*device
);
310 extern bool of_device_is_big_endian(const struct device_node
*device
);
311 extern const void *of_get_property(const struct device_node
*node
,
314 extern struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
315 #define for_each_property_of_node(dn, pp) \
316 for (pp = dn->properties; pp != NULL; pp = pp->next)
318 extern int of_n_addr_cells(struct device_node
*np
);
319 extern int of_n_size_cells(struct device_node
*np
);
320 extern const struct of_device_id
*of_match_node(
321 const struct of_device_id
*matches
, const struct device_node
*node
);
322 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
323 extern void of_print_phandle_args(const char *msg
, const struct of_phandle_args
*args
);
324 extern struct device_node
*of_parse_phandle(const struct device_node
*np
,
325 const char *phandle_name
,
327 extern int of_parse_phandle_with_args(const struct device_node
*np
,
328 const char *list_name
, const char *cells_name
, int index
,
329 struct of_phandle_args
*out_args
);
330 extern int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
331 const char *list_name
, int cells_count
, int index
,
332 struct of_phandle_args
*out_args
);
333 extern int of_count_phandle_with_args(const struct device_node
*np
,
334 const char *list_name
, const char *cells_name
);
336 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
337 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
338 extern int of_alias_get_highest_id(const char *stem
);
340 extern int of_machine_is_compatible(const char *compat
);
342 extern int of_add_property(struct device_node
*np
, struct property
*prop
);
343 extern int of_remove_property(struct device_node
*np
, struct property
*prop
);
344 extern int of_update_property(struct device_node
*np
, struct property
*newprop
);
346 /* For updating the device tree at runtime */
347 #define OF_RECONFIG_ATTACH_NODE 0x0001
348 #define OF_RECONFIG_DETACH_NODE 0x0002
349 #define OF_RECONFIG_ADD_PROPERTY 0x0003
350 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
351 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
353 extern int of_attach_node(struct device_node
*);
354 extern int of_detach_node(struct device_node
*);
356 #define of_match_ptr(_ptr) (_ptr)
359 * struct property *prop;
363 * of_property_for_each_u32(np, "propname", prop, p, u)
364 * printk("U32 value: %x\n", u);
366 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
369 * struct property *prop;
372 * of_property_for_each_string(np, "propname", prop, s)
373 * printk("String value: %s\n", s);
375 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
377 bool of_console_check(struct device_node
*dn
, char *name
, int index
);
379 #else /* CONFIG_OF */
381 static inline void of_core_init(void)
385 static inline bool is_of_node(struct fwnode_handle
*fwnode
)
390 static inline struct device_node
*of_node(struct fwnode_handle
*fwnode
)
395 static inline const char* of_node_full_name(const struct device_node
*np
)
400 static inline struct device_node
*of_find_node_by_name(struct device_node
*from
,
406 static inline struct device_node
*of_find_node_by_type(struct device_node
*from
,
412 static inline struct device_node
*of_find_matching_node_and_match(
413 struct device_node
*from
,
414 const struct of_device_id
*matches
,
415 const struct of_device_id
**match
)
420 static inline struct device_node
*of_find_node_by_path(const char *path
)
425 static inline struct device_node
*of_find_node_opts_by_path(const char *path
,
431 static inline struct device_node
*of_get_parent(const struct device_node
*node
)
436 static inline struct device_node
*of_get_next_child(
437 const struct device_node
*node
, struct device_node
*prev
)
442 static inline struct device_node
*of_get_next_available_child(
443 const struct device_node
*node
, struct device_node
*prev
)
448 static inline struct device_node
*of_find_node_with_property(
449 struct device_node
*from
, const char *prop_name
)
454 static inline bool of_have_populated_dt(void)
459 static inline struct device_node
*of_get_child_by_name(
460 const struct device_node
*node
,
466 static inline int of_device_is_compatible(const struct device_node
*device
,
472 static inline bool of_device_is_available(const struct device_node
*device
)
477 static inline bool of_device_is_big_endian(const struct device_node
*device
)
482 static inline struct property
*of_find_property(const struct device_node
*np
,
489 static inline struct device_node
*of_find_compatible_node(
490 struct device_node
*from
,
497 static inline int of_property_count_elems_of_size(const struct device_node
*np
,
498 const char *propname
, int elem_size
)
503 static inline int of_property_read_u32_index(const struct device_node
*np
,
504 const char *propname
, u32 index
, u32
*out_value
)
509 static inline int of_property_read_u8_array(const struct device_node
*np
,
510 const char *propname
, u8
*out_values
, size_t sz
)
515 static inline int of_property_read_u16_array(const struct device_node
*np
,
516 const char *propname
, u16
*out_values
, size_t sz
)
521 static inline int of_property_read_u32_array(const struct device_node
*np
,
522 const char *propname
,
523 u32
*out_values
, size_t sz
)
528 static inline int of_property_read_u64_array(const struct device_node
*np
,
529 const char *propname
,
530 u64
*out_values
, size_t sz
)
535 static inline int of_property_read_string(struct device_node
*np
,
536 const char *propname
,
537 const char **out_string
)
542 static inline int of_property_read_string_helper(struct device_node
*np
,
543 const char *propname
,
544 const char **out_strs
, size_t sz
, int index
)
549 static inline const void *of_get_property(const struct device_node
*node
,
556 static inline struct device_node
*of_get_cpu_node(int cpu
,
557 unsigned int *thread
)
562 static inline int of_property_read_u64(const struct device_node
*np
,
563 const char *propname
, u64
*out_value
)
568 static inline int of_property_match_string(struct device_node
*np
,
569 const char *propname
,
575 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
576 const char *phandle_name
,
582 static inline int of_parse_phandle_with_args(struct device_node
*np
,
583 const char *list_name
,
584 const char *cells_name
,
586 struct of_phandle_args
*out_args
)
591 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
592 const char *list_name
, int cells_count
, int index
,
593 struct of_phandle_args
*out_args
)
598 static inline int of_count_phandle_with_args(struct device_node
*np
,
599 const char *list_name
,
600 const char *cells_name
)
605 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
610 static inline int of_alias_get_highest_id(const char *stem
)
615 static inline int of_machine_is_compatible(const char *compat
)
620 static inline bool of_console_check(const struct device_node
*dn
, const char *name
, int index
)
625 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
626 const __be32
*cur
, u32
*pu
)
631 static inline const char *of_prop_next_string(struct property
*prop
,
637 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
642 static inline int of_node_test_and_set_flag(struct device_node
*n
,
648 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
652 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
656 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
661 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
665 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
669 #define of_match_ptr(_ptr) NULL
670 #define of_match_node(_matches, _node) NULL
671 #endif /* CONFIG_OF */
673 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
674 extern int of_node_to_nid(struct device_node
*np
);
676 static inline int of_node_to_nid(struct device_node
*device
) { return 0; }
679 static inline struct device_node
*of_find_matching_node(
680 struct device_node
*from
,
681 const struct of_device_id
*matches
)
683 return of_find_matching_node_and_match(from
, matches
, NULL
);
687 * of_property_count_u8_elems - Count the number of u8 elements in a property
689 * @np: device node from which the property value is to be read.
690 * @propname: name of the property to be searched.
692 * Search for a property in a device node and count the number of u8 elements
693 * in it. Returns number of elements on sucess, -EINVAL if the property does
694 * not exist or its length does not match a multiple of u8 and -ENODATA if the
695 * property does not have a value.
697 static inline int of_property_count_u8_elems(const struct device_node
*np
,
698 const char *propname
)
700 return of_property_count_elems_of_size(np
, propname
, sizeof(u8
));
704 * of_property_count_u16_elems - Count the number of u16 elements in a property
706 * @np: device node from which the property value is to be read.
707 * @propname: name of the property to be searched.
709 * Search for a property in a device node and count the number of u16 elements
710 * in it. Returns number of elements on sucess, -EINVAL if the property does
711 * not exist or its length does not match a multiple of u16 and -ENODATA if the
712 * property does not have a value.
714 static inline int of_property_count_u16_elems(const struct device_node
*np
,
715 const char *propname
)
717 return of_property_count_elems_of_size(np
, propname
, sizeof(u16
));
721 * of_property_count_u32_elems - Count the number of u32 elements in a property
723 * @np: device node from which the property value is to be read.
724 * @propname: name of the property to be searched.
726 * Search for a property in a device node and count the number of u32 elements
727 * in it. Returns number of elements on sucess, -EINVAL if the property does
728 * not exist or its length does not match a multiple of u32 and -ENODATA if the
729 * property does not have a value.
731 static inline int of_property_count_u32_elems(const struct device_node
*np
,
732 const char *propname
)
734 return of_property_count_elems_of_size(np
, propname
, sizeof(u32
));
738 * of_property_count_u64_elems - Count the number of u64 elements in a property
740 * @np: device node from which the property value is to be read.
741 * @propname: name of the property to be searched.
743 * Search for a property in a device node and count the number of u64 elements
744 * in it. Returns number of elements on sucess, -EINVAL if the property does
745 * not exist or its length does not match a multiple of u64 and -ENODATA if the
746 * property does not have a value.
748 static inline int of_property_count_u64_elems(const struct device_node
*np
,
749 const char *propname
)
751 return of_property_count_elems_of_size(np
, propname
, sizeof(u64
));
755 * of_property_read_string_array() - Read an array of strings from a multiple
757 * @np: device node from which the property value is to be read.
758 * @propname: name of the property to be searched.
759 * @out_strs: output array of string pointers.
760 * @sz: number of array elements to read.
762 * Search for a property in a device tree node and retrieve a list of
763 * terminated string values (pointer to data, not a copy) in that property.
765 * If @out_strs is NULL, the number of strings in the property is returned.
767 static inline int of_property_read_string_array(struct device_node
*np
,
768 const char *propname
, const char **out_strs
,
771 return of_property_read_string_helper(np
, propname
, out_strs
, sz
, 0);
775 * of_property_count_strings() - Find and return the number of strings from a
776 * multiple strings property.
777 * @np: device node from which the property value is to be read.
778 * @propname: name of the property to be searched.
780 * Search for a property in a device tree node and retrieve the number of null
781 * terminated string contain in it. Returns the number of strings on
782 * success, -EINVAL if the property does not exist, -ENODATA if property
783 * does not have a value, and -EILSEQ if the string is not null-terminated
784 * within the length of the property data.
786 static inline int of_property_count_strings(struct device_node
*np
,
787 const char *propname
)
789 return of_property_read_string_helper(np
, propname
, NULL
, 0, 0);
793 * of_property_read_string_index() - Find and read a string from a multiple
795 * @np: device node from which the property value is to be read.
796 * @propname: name of the property to be searched.
797 * @index: index of the string in the list of strings
798 * @out_string: pointer to null terminated return string, modified only if
801 * Search for a property in a device tree node and retrieve a null
802 * terminated string value (pointer to data, not a copy) in the list of strings
803 * contained in that property.
804 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
805 * property does not have a value, and -EILSEQ if the string is not
806 * null-terminated within the length of the property data.
808 * The out_string pointer is modified only if a valid string can be decoded.
810 static inline int of_property_read_string_index(struct device_node
*np
,
811 const char *propname
,
812 int index
, const char **output
)
814 int rc
= of_property_read_string_helper(np
, propname
, output
, 1, index
);
815 return rc
< 0 ? rc
: 0;
819 * of_property_read_bool - Findfrom a property
820 * @np: device node from which the property value is to be read.
821 * @propname: name of the property to be searched.
823 * Search for a property in a device node.
824 * Returns true if the property exist false otherwise.
826 static inline bool of_property_read_bool(const struct device_node
*np
,
827 const char *propname
)
829 struct property
*prop
= of_find_property(np
, propname
, NULL
);
831 return prop
? true : false;
834 static inline int of_property_read_u8(const struct device_node
*np
,
835 const char *propname
,
838 return of_property_read_u8_array(np
, propname
, out_value
, 1);
841 static inline int of_property_read_u16(const struct device_node
*np
,
842 const char *propname
,
845 return of_property_read_u16_array(np
, propname
, out_value
, 1);
848 static inline int of_property_read_u32(const struct device_node
*np
,
849 const char *propname
,
852 return of_property_read_u32_array(np
, propname
, out_value
, 1);
855 static inline int of_property_read_s32(const struct device_node
*np
,
856 const char *propname
,
859 return of_property_read_u32(np
, propname
, (u32
*) out_value
);
862 #define of_property_for_each_u32(np, propname, prop, p, u) \
863 for (prop = of_find_property(np, propname, NULL), \
864 p = of_prop_next_u32(prop, NULL, &u); \
866 p = of_prop_next_u32(prop, p, &u))
868 #define of_property_for_each_string(np, propname, prop, s) \
869 for (prop = of_find_property(np, propname, NULL), \
870 s = of_prop_next_string(prop, NULL); \
872 s = of_prop_next_string(prop, s))
874 #define for_each_node_by_name(dn, name) \
875 for (dn = of_find_node_by_name(NULL, name); dn; \
876 dn = of_find_node_by_name(dn, name))
877 #define for_each_node_by_type(dn, type) \
878 for (dn = of_find_node_by_type(NULL, type); dn; \
879 dn = of_find_node_by_type(dn, type))
880 #define for_each_compatible_node(dn, type, compatible) \
881 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
882 dn = of_find_compatible_node(dn, type, compatible))
883 #define for_each_matching_node(dn, matches) \
884 for (dn = of_find_matching_node(NULL, matches); dn; \
885 dn = of_find_matching_node(dn, matches))
886 #define for_each_matching_node_and_match(dn, matches, match) \
887 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
888 dn; dn = of_find_matching_node_and_match(dn, matches, match))
890 #define for_each_child_of_node(parent, child) \
891 for (child = of_get_next_child(parent, NULL); child != NULL; \
892 child = of_get_next_child(parent, child))
893 #define for_each_available_child_of_node(parent, child) \
894 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
895 child = of_get_next_available_child(parent, child))
897 #define for_each_node_with_property(dn, prop_name) \
898 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
899 dn = of_find_node_with_property(dn, prop_name))
901 static inline int of_get_child_count(const struct device_node
*np
)
903 struct device_node
*child
;
906 for_each_child_of_node(np
, child
)
912 static inline int of_get_available_child_count(const struct device_node
*np
)
914 struct device_node
*child
;
917 for_each_available_child_of_node(np
, child
)
924 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
925 static const struct of_device_id __of_table_##name \
926 __used __section(__##table##_of_table) \
927 = { .compatible = compat, \
928 .data = (fn == (fn_type)NULL) ? fn : fn }
930 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
931 static const struct of_device_id __of_table_##name \
932 __attribute__((unused)) \
933 = { .compatible = compat, \
934 .data = (fn == (fn_type)NULL) ? fn : fn }
937 typedef int (*of_init_fn_2
)(struct device_node
*, struct device_node
*);
938 typedef void (*of_init_fn_1
)(struct device_node
*);
940 #define OF_DECLARE_1(table, name, compat, fn) \
941 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
942 #define OF_DECLARE_2(table, name, compat, fn) \
943 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
946 * struct of_changeset_entry - Holds a changeset entry
948 * @node: list_head for the log list
949 * @action: notifier action
950 * @np: pointer to the device node affected
951 * @prop: pointer to the property affected
952 * @old_prop: hold a pointer to the original property
954 * Every modification of the device tree during a changeset
955 * is held in a list of of_changeset_entry structures.
956 * That way we can recover from a partial application, or we can
957 * revert the changeset
959 struct of_changeset_entry
{
960 struct list_head node
;
961 unsigned long action
;
962 struct device_node
*np
;
963 struct property
*prop
;
964 struct property
*old_prop
;
968 * struct of_changeset - changeset tracker structure
970 * @entries: list_head for the changeset entries
972 * changesets are a convenient way to apply bulk changes to the
973 * live tree. In case of an error, changes are rolled-back.
974 * changesets live on after initial application, and if not
975 * destroyed after use, they can be reverted in one single call.
977 struct of_changeset
{
978 struct list_head entries
;
981 enum of_reconfig_change
{
982 OF_RECONFIG_NO_CHANGE
= 0,
983 OF_RECONFIG_CHANGE_ADD
,
984 OF_RECONFIG_CHANGE_REMOVE
,
987 #ifdef CONFIG_OF_DYNAMIC
988 extern int of_reconfig_notifier_register(struct notifier_block
*);
989 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
990 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data
*rd
);
991 extern int of_reconfig_get_state_change(unsigned long action
,
992 struct of_reconfig_data
*arg
);
994 extern void of_changeset_init(struct of_changeset
*ocs
);
995 extern void of_changeset_destroy(struct of_changeset
*ocs
);
996 extern int of_changeset_apply(struct of_changeset
*ocs
);
997 extern int of_changeset_revert(struct of_changeset
*ocs
);
998 extern int of_changeset_action(struct of_changeset
*ocs
,
999 unsigned long action
, struct device_node
*np
,
1000 struct property
*prop
);
1002 static inline int of_changeset_attach_node(struct of_changeset
*ocs
,
1003 struct device_node
*np
)
1005 return of_changeset_action(ocs
, OF_RECONFIG_ATTACH_NODE
, np
, NULL
);
1008 static inline int of_changeset_detach_node(struct of_changeset
*ocs
,
1009 struct device_node
*np
)
1011 return of_changeset_action(ocs
, OF_RECONFIG_DETACH_NODE
, np
, NULL
);
1014 static inline int of_changeset_add_property(struct of_changeset
*ocs
,
1015 struct device_node
*np
, struct property
*prop
)
1017 return of_changeset_action(ocs
, OF_RECONFIG_ADD_PROPERTY
, np
, prop
);
1020 static inline int of_changeset_remove_property(struct of_changeset
*ocs
,
1021 struct device_node
*np
, struct property
*prop
)
1023 return of_changeset_action(ocs
, OF_RECONFIG_REMOVE_PROPERTY
, np
, prop
);
1026 static inline int of_changeset_update_property(struct of_changeset
*ocs
,
1027 struct device_node
*np
, struct property
*prop
)
1029 return of_changeset_action(ocs
, OF_RECONFIG_UPDATE_PROPERTY
, np
, prop
);
1031 #else /* CONFIG_OF_DYNAMIC */
1032 static inline int of_reconfig_notifier_register(struct notifier_block
*nb
)
1036 static inline int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
1040 static inline int of_reconfig_notify(unsigned long action
,
1041 struct of_reconfig_data
*arg
)
1045 static inline int of_reconfig_get_state_change(unsigned long action
,
1046 struct of_reconfig_data
*arg
)
1050 #endif /* CONFIG_OF_DYNAMIC */
1052 /* CONFIG_OF_RESOLVE api */
1053 extern int of_resolve_phandles(struct device_node
*tree
);
1056 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1057 * @np: Pointer to the given device_node
1059 * return true if present false otherwise
1061 static inline bool of_device_is_system_power_controller(const struct device_node
*np
)
1063 return of_property_read_bool(np
, "system-power-controller");
1070 #ifdef CONFIG_OF_OVERLAY
1072 /* ID based overlays; the API for external users */
1073 int of_overlay_create(struct device_node
*tree
);
1074 int of_overlay_destroy(int id
);
1075 int of_overlay_destroy_all(void);
1079 static inline int of_overlay_create(struct device_node
*tree
)
1084 static inline int of_overlay_destroy(int id
)
1089 static inline int of_overlay_destroy_all(void)
1096 #endif /* _LINUX_OF_H */