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 static inline bool is_of_node(struct fwnode_handle
*fwnode
)
126 return fwnode
&& fwnode
->type
== FWNODE_OF
;
129 static inline struct device_node
*of_node(struct fwnode_handle
*fwnode
)
131 return fwnode
? container_of(fwnode
, struct device_node
, fwnode
) : NULL
;
134 static inline bool of_have_populated_dt(void)
136 return of_root
!= NULL
;
139 static inline bool of_node_is_root(const struct device_node
*node
)
141 return node
&& (node
->parent
== NULL
);
144 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
146 return test_bit(flag
, &n
->_flags
);
149 static inline int of_node_test_and_set_flag(struct device_node
*n
,
152 return test_and_set_bit(flag
, &n
->_flags
);
155 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
157 set_bit(flag
, &n
->_flags
);
160 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
162 clear_bit(flag
, &n
->_flags
);
165 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
167 return test_bit(flag
, &p
->_flags
);
170 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
172 set_bit(flag
, &p
->_flags
);
175 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
177 clear_bit(flag
, &p
->_flags
);
180 extern struct device_node
*__of_find_all_nodes(struct device_node
*prev
);
181 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
184 * OF address retrieval & translation
187 /* Helper to read a big number; size is in cells (not bytes) */
188 static inline u64
of_read_number(const __be32
*cell
, int size
)
192 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
196 /* Like of_read_number, but we want an unsigned long result */
197 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
199 /* toss away upper bits if unsigned long is smaller than u64 */
200 return of_read_number(cell
, size
);
203 #if defined(CONFIG_SPARC)
204 #include <asm/prom.h>
207 /* Default #address and #size cells. Allow arch asm/prom.h to override */
208 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
209 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
210 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
213 /* Default string compare functions, Allow arch asm/prom.h to override */
214 #if !defined(of_compat_cmp)
215 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
216 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
217 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
220 /* flag descriptions */
221 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
222 #define OF_DETACHED 2 /* node has been detached from the device tree */
223 #define OF_POPULATED 3 /* device already created for the node */
224 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
226 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
227 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
229 #define OF_BAD_ADDR ((u64)-1)
231 static inline const char *of_node_full_name(const struct device_node
*np
)
233 return np
? np
->full_name
: "<no-node>";
236 #define for_each_of_allnodes_from(from, dn) \
237 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
238 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
239 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
241 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
243 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
244 const char *type
, const char *compat
);
245 extern struct device_node
*of_find_matching_node_and_match(
246 struct device_node
*from
,
247 const struct of_device_id
*matches
,
248 const struct of_device_id
**match
);
250 extern struct device_node
*of_find_node_opts_by_path(const char *path
,
252 static inline struct device_node
*of_find_node_by_path(const char *path
)
254 return of_find_node_opts_by_path(path
, NULL
);
257 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
258 extern struct device_node
*of_get_parent(const struct device_node
*node
);
259 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
260 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
261 struct device_node
*prev
);
262 extern struct device_node
*of_get_next_available_child(
263 const struct device_node
*node
, struct device_node
*prev
);
265 extern struct device_node
*of_get_child_by_name(const struct device_node
*node
,
269 extern struct device_node
*of_find_next_cache_node(const struct device_node
*);
270 extern struct device_node
*of_find_node_with_property(
271 struct device_node
*from
, const char *prop_name
);
273 extern struct property
*of_find_property(const struct device_node
*np
,
276 extern int of_property_count_elems_of_size(const struct device_node
*np
,
277 const char *propname
, int elem_size
);
278 extern int of_property_read_u32_index(const struct device_node
*np
,
279 const char *propname
,
280 u32 index
, u32
*out_value
);
281 extern int of_property_read_u8_array(const struct device_node
*np
,
282 const char *propname
, u8
*out_values
, size_t sz
);
283 extern int of_property_read_u16_array(const struct device_node
*np
,
284 const char *propname
, u16
*out_values
, size_t sz
);
285 extern int of_property_read_u32_array(const struct device_node
*np
,
286 const char *propname
,
289 extern int of_property_read_u64(const struct device_node
*np
,
290 const char *propname
, u64
*out_value
);
291 extern int of_property_read_u64_array(const struct device_node
*np
,
292 const char *propname
,
296 extern int of_property_read_string(struct device_node
*np
,
297 const char *propname
,
298 const char **out_string
);
299 extern int of_property_match_string(struct device_node
*np
,
300 const char *propname
,
302 extern int of_property_read_string_helper(struct device_node
*np
,
303 const char *propname
,
304 const char **out_strs
, size_t sz
, int index
);
305 extern int of_device_is_compatible(const struct device_node
*device
,
307 extern bool of_device_is_available(const struct device_node
*device
);
308 extern bool of_device_is_big_endian(const struct device_node
*device
);
309 extern const void *of_get_property(const struct device_node
*node
,
312 extern struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
313 #define for_each_property_of_node(dn, pp) \
314 for (pp = dn->properties; pp != NULL; pp = pp->next)
316 extern int of_n_addr_cells(struct device_node
*np
);
317 extern int of_n_size_cells(struct device_node
*np
);
318 extern const struct of_device_id
*of_match_node(
319 const struct of_device_id
*matches
, const struct device_node
*node
);
320 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
321 extern void of_print_phandle_args(const char *msg
, const struct of_phandle_args
*args
);
322 extern struct device_node
*of_parse_phandle(const struct device_node
*np
,
323 const char *phandle_name
,
325 extern int of_parse_phandle_with_args(const struct device_node
*np
,
326 const char *list_name
, const char *cells_name
, int index
,
327 struct of_phandle_args
*out_args
);
328 extern int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
329 const char *list_name
, int cells_count
, int index
,
330 struct of_phandle_args
*out_args
);
331 extern int of_count_phandle_with_args(const struct device_node
*np
,
332 const char *list_name
, const char *cells_name
);
334 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
335 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
336 extern int of_alias_get_highest_id(const char *stem
);
338 extern int of_machine_is_compatible(const char *compat
);
340 extern int of_add_property(struct device_node
*np
, struct property
*prop
);
341 extern int of_remove_property(struct device_node
*np
, struct property
*prop
);
342 extern int of_update_property(struct device_node
*np
, struct property
*newprop
);
344 /* For updating the device tree at runtime */
345 #define OF_RECONFIG_ATTACH_NODE 0x0001
346 #define OF_RECONFIG_DETACH_NODE 0x0002
347 #define OF_RECONFIG_ADD_PROPERTY 0x0003
348 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
349 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
351 extern int of_attach_node(struct device_node
*);
352 extern int of_detach_node(struct device_node
*);
354 #define of_match_ptr(_ptr) (_ptr)
357 * struct property *prop;
361 * of_property_for_each_u32(np, "propname", prop, p, u)
362 * printk("U32 value: %x\n", u);
364 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
367 * struct property *prop;
370 * of_property_for_each_string(np, "propname", prop, s)
371 * printk("String value: %s\n", s);
373 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
375 bool of_console_check(struct device_node
*dn
, char *name
, int index
);
377 #else /* CONFIG_OF */
379 static inline bool is_of_node(struct fwnode_handle
*fwnode
)
384 static inline struct device_node
*of_node(struct fwnode_handle
*fwnode
)
389 static inline const char* of_node_full_name(const struct device_node
*np
)
394 static inline struct device_node
*of_find_node_by_name(struct device_node
*from
,
400 static inline struct device_node
*of_find_node_by_type(struct device_node
*from
,
406 static inline struct device_node
*of_find_matching_node_and_match(
407 struct device_node
*from
,
408 const struct of_device_id
*matches
,
409 const struct of_device_id
**match
)
414 static inline struct device_node
*of_find_node_by_path(const char *path
)
419 static inline struct device_node
*of_find_node_opts_by_path(const char *path
,
425 static inline struct device_node
*of_get_parent(const struct device_node
*node
)
430 static inline struct device_node
*of_get_next_child(
431 const struct device_node
*node
, struct device_node
*prev
)
436 static inline struct device_node
*of_get_next_available_child(
437 const struct device_node
*node
, struct device_node
*prev
)
442 static inline struct device_node
*of_find_node_with_property(
443 struct device_node
*from
, const char *prop_name
)
448 static inline bool of_have_populated_dt(void)
453 static inline struct device_node
*of_get_child_by_name(
454 const struct device_node
*node
,
460 static inline int of_device_is_compatible(const struct device_node
*device
,
466 static inline bool of_device_is_available(const struct device_node
*device
)
471 static inline bool of_device_is_big_endian(const struct device_node
*device
)
476 static inline struct property
*of_find_property(const struct device_node
*np
,
483 static inline struct device_node
*of_find_compatible_node(
484 struct device_node
*from
,
491 static inline int of_property_count_elems_of_size(const struct device_node
*np
,
492 const char *propname
, int elem_size
)
497 static inline int of_property_read_u32_index(const struct device_node
*np
,
498 const char *propname
, u32 index
, u32
*out_value
)
503 static inline int of_property_read_u8_array(const struct device_node
*np
,
504 const char *propname
, u8
*out_values
, size_t sz
)
509 static inline int of_property_read_u16_array(const struct device_node
*np
,
510 const char *propname
, u16
*out_values
, size_t sz
)
515 static inline int of_property_read_u32_array(const struct device_node
*np
,
516 const char *propname
,
517 u32
*out_values
, size_t sz
)
522 static inline int of_property_read_u64_array(const struct device_node
*np
,
523 const char *propname
,
524 u64
*out_values
, size_t sz
)
529 static inline int of_property_read_string(struct device_node
*np
,
530 const char *propname
,
531 const char **out_string
)
536 static inline int of_property_read_string_helper(struct device_node
*np
,
537 const char *propname
,
538 const char **out_strs
, size_t sz
, int index
)
543 static inline const void *of_get_property(const struct device_node
*node
,
550 static inline struct device_node
*of_get_cpu_node(int cpu
,
551 unsigned int *thread
)
556 static inline int of_property_read_u64(const struct device_node
*np
,
557 const char *propname
, u64
*out_value
)
562 static inline int of_property_match_string(struct device_node
*np
,
563 const char *propname
,
569 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
570 const char *phandle_name
,
576 static inline int of_parse_phandle_with_args(struct device_node
*np
,
577 const char *list_name
,
578 const char *cells_name
,
580 struct of_phandle_args
*out_args
)
585 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
586 const char *list_name
, int cells_count
, int index
,
587 struct of_phandle_args
*out_args
)
592 static inline int of_count_phandle_with_args(struct device_node
*np
,
593 const char *list_name
,
594 const char *cells_name
)
599 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
604 static inline int of_alias_get_highest_id(const char *stem
)
609 static inline int of_machine_is_compatible(const char *compat
)
614 static inline bool of_console_check(const struct device_node
*dn
, const char *name
, int index
)
619 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
620 const __be32
*cur
, u32
*pu
)
625 static inline const char *of_prop_next_string(struct property
*prop
,
631 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
636 static inline int of_node_test_and_set_flag(struct device_node
*n
,
642 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
646 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
650 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
655 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
659 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
663 #define of_match_ptr(_ptr) NULL
664 #define of_match_node(_matches, _node) NULL
665 #endif /* CONFIG_OF */
667 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
668 extern int of_node_to_nid(struct device_node
*np
);
670 static inline int of_node_to_nid(struct device_node
*device
) { return 0; }
673 static inline struct device_node
*of_find_matching_node(
674 struct device_node
*from
,
675 const struct of_device_id
*matches
)
677 return of_find_matching_node_and_match(from
, matches
, NULL
);
681 * of_property_count_u8_elems - Count the number of u8 elements in a property
683 * @np: device node from which the property value is to be read.
684 * @propname: name of the property to be searched.
686 * Search for a property in a device node and count the number of u8 elements
687 * in it. Returns number of elements on sucess, -EINVAL if the property does
688 * not exist or its length does not match a multiple of u8 and -ENODATA if the
689 * property does not have a value.
691 static inline int of_property_count_u8_elems(const struct device_node
*np
,
692 const char *propname
)
694 return of_property_count_elems_of_size(np
, propname
, sizeof(u8
));
698 * of_property_count_u16_elems - Count the number of u16 elements in a property
700 * @np: device node from which the property value is to be read.
701 * @propname: name of the property to be searched.
703 * Search for a property in a device node and count the number of u16 elements
704 * in it. Returns number of elements on sucess, -EINVAL if the property does
705 * not exist or its length does not match a multiple of u16 and -ENODATA if the
706 * property does not have a value.
708 static inline int of_property_count_u16_elems(const struct device_node
*np
,
709 const char *propname
)
711 return of_property_count_elems_of_size(np
, propname
, sizeof(u16
));
715 * of_property_count_u32_elems - Count the number of u32 elements in a property
717 * @np: device node from which the property value is to be read.
718 * @propname: name of the property to be searched.
720 * Search for a property in a device node and count the number of u32 elements
721 * in it. Returns number of elements on sucess, -EINVAL if the property does
722 * not exist or its length does not match a multiple of u32 and -ENODATA if the
723 * property does not have a value.
725 static inline int of_property_count_u32_elems(const struct device_node
*np
,
726 const char *propname
)
728 return of_property_count_elems_of_size(np
, propname
, sizeof(u32
));
732 * of_property_count_u64_elems - Count the number of u64 elements in a property
734 * @np: device node from which the property value is to be read.
735 * @propname: name of the property to be searched.
737 * Search for a property in a device node and count the number of u64 elements
738 * in it. Returns number of elements on sucess, -EINVAL if the property does
739 * not exist or its length does not match a multiple of u64 and -ENODATA if the
740 * property does not have a value.
742 static inline int of_property_count_u64_elems(const struct device_node
*np
,
743 const char *propname
)
745 return of_property_count_elems_of_size(np
, propname
, sizeof(u64
));
749 * of_property_read_string_array() - Read an array of strings from a multiple
751 * @np: device node from which the property value is to be read.
752 * @propname: name of the property to be searched.
753 * @out_strs: output array of string pointers.
754 * @sz: number of array elements to read.
756 * Search for a property in a device tree node and retrieve a list of
757 * terminated string values (pointer to data, not a copy) in that property.
759 * If @out_strs is NULL, the number of strings in the property is returned.
761 static inline int of_property_read_string_array(struct device_node
*np
,
762 const char *propname
, const char **out_strs
,
765 return of_property_read_string_helper(np
, propname
, out_strs
, sz
, 0);
769 * of_property_count_strings() - Find and return the number of strings from a
770 * multiple strings property.
771 * @np: device node from which the property value is to be read.
772 * @propname: name of the property to be searched.
774 * Search for a property in a device tree node and retrieve the number of null
775 * terminated string contain in it. Returns the number of strings on
776 * success, -EINVAL if the property does not exist, -ENODATA if property
777 * does not have a value, and -EILSEQ if the string is not null-terminated
778 * within the length of the property data.
780 static inline int of_property_count_strings(struct device_node
*np
,
781 const char *propname
)
783 return of_property_read_string_helper(np
, propname
, NULL
, 0, 0);
787 * of_property_read_string_index() - Find and read a string from a multiple
789 * @np: device node from which the property value is to be read.
790 * @propname: name of the property to be searched.
791 * @index: index of the string in the list of strings
792 * @out_string: pointer to null terminated return string, modified only if
795 * Search for a property in a device tree node and retrieve a null
796 * terminated string value (pointer to data, not a copy) in the list of strings
797 * contained in that property.
798 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
799 * property does not have a value, and -EILSEQ if the string is not
800 * null-terminated within the length of the property data.
802 * The out_string pointer is modified only if a valid string can be decoded.
804 static inline int of_property_read_string_index(struct device_node
*np
,
805 const char *propname
,
806 int index
, const char **output
)
808 int rc
= of_property_read_string_helper(np
, propname
, output
, 1, index
);
809 return rc
< 0 ? rc
: 0;
813 * of_property_read_bool - Findfrom a property
814 * @np: device node from which the property value is to be read.
815 * @propname: name of the property to be searched.
817 * Search for a property in a device node.
818 * Returns true if the property exist false otherwise.
820 static inline bool of_property_read_bool(const struct device_node
*np
,
821 const char *propname
)
823 struct property
*prop
= of_find_property(np
, propname
, NULL
);
825 return prop
? true : false;
828 static inline int of_property_read_u8(const struct device_node
*np
,
829 const char *propname
,
832 return of_property_read_u8_array(np
, propname
, out_value
, 1);
835 static inline int of_property_read_u16(const struct device_node
*np
,
836 const char *propname
,
839 return of_property_read_u16_array(np
, propname
, out_value
, 1);
842 static inline int of_property_read_u32(const struct device_node
*np
,
843 const char *propname
,
846 return of_property_read_u32_array(np
, propname
, out_value
, 1);
849 static inline int of_property_read_s32(const struct device_node
*np
,
850 const char *propname
,
853 return of_property_read_u32(np
, propname
, (u32
*) out_value
);
856 #define of_property_for_each_u32(np, propname, prop, p, u) \
857 for (prop = of_find_property(np, propname, NULL), \
858 p = of_prop_next_u32(prop, NULL, &u); \
860 p = of_prop_next_u32(prop, p, &u))
862 #define of_property_for_each_string(np, propname, prop, s) \
863 for (prop = of_find_property(np, propname, NULL), \
864 s = of_prop_next_string(prop, NULL); \
866 s = of_prop_next_string(prop, s))
868 #define for_each_node_by_name(dn, name) \
869 for (dn = of_find_node_by_name(NULL, name); dn; \
870 dn = of_find_node_by_name(dn, name))
871 #define for_each_node_by_type(dn, type) \
872 for (dn = of_find_node_by_type(NULL, type); dn; \
873 dn = of_find_node_by_type(dn, type))
874 #define for_each_compatible_node(dn, type, compatible) \
875 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
876 dn = of_find_compatible_node(dn, type, compatible))
877 #define for_each_matching_node(dn, matches) \
878 for (dn = of_find_matching_node(NULL, matches); dn; \
879 dn = of_find_matching_node(dn, matches))
880 #define for_each_matching_node_and_match(dn, matches, match) \
881 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
882 dn; dn = of_find_matching_node_and_match(dn, matches, match))
884 #define for_each_child_of_node(parent, child) \
885 for (child = of_get_next_child(parent, NULL); child != NULL; \
886 child = of_get_next_child(parent, child))
887 #define for_each_available_child_of_node(parent, child) \
888 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
889 child = of_get_next_available_child(parent, child))
891 #define for_each_node_with_property(dn, prop_name) \
892 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
893 dn = of_find_node_with_property(dn, prop_name))
895 static inline int of_get_child_count(const struct device_node
*np
)
897 struct device_node
*child
;
900 for_each_child_of_node(np
, child
)
906 static inline int of_get_available_child_count(const struct device_node
*np
)
908 struct device_node
*child
;
911 for_each_available_child_of_node(np
, child
)
918 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
919 static const struct of_device_id __of_table_##name \
920 __used __section(__##table##_of_table) \
921 = { .compatible = compat, \
922 .data = (fn == (fn_type)NULL) ? fn : fn }
924 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
925 static const struct of_device_id __of_table_##name \
926 __attribute__((unused)) \
927 = { .compatible = compat, \
928 .data = (fn == (fn_type)NULL) ? fn : fn }
931 typedef int (*of_init_fn_2
)(struct device_node
*, struct device_node
*);
932 typedef void (*of_init_fn_1
)(struct device_node
*);
934 #define OF_DECLARE_1(table, name, compat, fn) \
935 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
936 #define OF_DECLARE_2(table, name, compat, fn) \
937 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
940 * struct of_changeset_entry - Holds a changeset entry
942 * @node: list_head for the log list
943 * @action: notifier action
944 * @np: pointer to the device node affected
945 * @prop: pointer to the property affected
946 * @old_prop: hold a pointer to the original property
948 * Every modification of the device tree during a changeset
949 * is held in a list of of_changeset_entry structures.
950 * That way we can recover from a partial application, or we can
951 * revert the changeset
953 struct of_changeset_entry
{
954 struct list_head node
;
955 unsigned long action
;
956 struct device_node
*np
;
957 struct property
*prop
;
958 struct property
*old_prop
;
962 * struct of_changeset - changeset tracker structure
964 * @entries: list_head for the changeset entries
966 * changesets are a convenient way to apply bulk changes to the
967 * live tree. In case of an error, changes are rolled-back.
968 * changesets live on after initial application, and if not
969 * destroyed after use, they can be reverted in one single call.
971 struct of_changeset
{
972 struct list_head entries
;
975 enum of_reconfig_change
{
976 OF_RECONFIG_NO_CHANGE
= 0,
977 OF_RECONFIG_CHANGE_ADD
,
978 OF_RECONFIG_CHANGE_REMOVE
,
981 #ifdef CONFIG_OF_DYNAMIC
982 extern int of_reconfig_notifier_register(struct notifier_block
*);
983 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
984 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data
*rd
);
985 extern int of_reconfig_get_state_change(unsigned long action
,
986 struct of_reconfig_data
*arg
);
988 extern void of_changeset_init(struct of_changeset
*ocs
);
989 extern void of_changeset_destroy(struct of_changeset
*ocs
);
990 extern int of_changeset_apply(struct of_changeset
*ocs
);
991 extern int of_changeset_revert(struct of_changeset
*ocs
);
992 extern int of_changeset_action(struct of_changeset
*ocs
,
993 unsigned long action
, struct device_node
*np
,
994 struct property
*prop
);
996 static inline int of_changeset_attach_node(struct of_changeset
*ocs
,
997 struct device_node
*np
)
999 return of_changeset_action(ocs
, OF_RECONFIG_ATTACH_NODE
, np
, NULL
);
1002 static inline int of_changeset_detach_node(struct of_changeset
*ocs
,
1003 struct device_node
*np
)
1005 return of_changeset_action(ocs
, OF_RECONFIG_DETACH_NODE
, np
, NULL
);
1008 static inline int of_changeset_add_property(struct of_changeset
*ocs
,
1009 struct device_node
*np
, struct property
*prop
)
1011 return of_changeset_action(ocs
, OF_RECONFIG_ADD_PROPERTY
, np
, prop
);
1014 static inline int of_changeset_remove_property(struct of_changeset
*ocs
,
1015 struct device_node
*np
, struct property
*prop
)
1017 return of_changeset_action(ocs
, OF_RECONFIG_REMOVE_PROPERTY
, np
, prop
);
1020 static inline int of_changeset_update_property(struct of_changeset
*ocs
,
1021 struct device_node
*np
, struct property
*prop
)
1023 return of_changeset_action(ocs
, OF_RECONFIG_UPDATE_PROPERTY
, np
, prop
);
1025 #else /* CONFIG_OF_DYNAMIC */
1026 static inline int of_reconfig_notifier_register(struct notifier_block
*nb
)
1030 static inline int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
1034 static inline int of_reconfig_notify(unsigned long action
,
1035 struct of_reconfig_data
*arg
)
1039 static inline int of_reconfig_get_state_change(unsigned long action
,
1040 struct of_reconfig_data
*arg
)
1044 #endif /* CONFIG_OF_DYNAMIC */
1046 /* CONFIG_OF_RESOLVE api */
1047 extern int of_resolve_phandles(struct device_node
*tree
);
1050 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1051 * @np: Pointer to the given device_node
1053 * return true if present false otherwise
1055 static inline bool of_device_is_system_power_controller(const struct device_node
*np
)
1057 return of_property_read_bool(np
, "system-power-controller");
1064 #ifdef CONFIG_OF_OVERLAY
1066 /* ID based overlays; the API for external users */
1067 int of_overlay_create(struct device_node
*tree
);
1068 int of_overlay_destroy(int id
);
1069 int of_overlay_destroy_all(void);
1073 static inline int of_overlay_create(struct device_node
*tree
)
1078 static inline int of_overlay_destroy(int id
)
1083 static inline int of_overlay_destroy_all(void)
1090 #endif /* _LINUX_OF_H */