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_phandle_iterator {
79 /* Common iterator information */
80 const char *cells_name;
82 const struct device_node *parent;
84 /* List size information */
85 const __be32 *list_end;
86 const __be32 *phandle_end;
88 /* Current position state */
92 struct device_node *node;
95 struct of_reconfig_data {
96 struct device_node *dn;
97 struct property *prop;
98 struct property *old_prop;
101 /* initialize a node */
102 extern struct kobj_type of_node_ktype;
103 static inline void of_node_init(struct device_node *node)
105 kobject_init(&node->kobj, &of_node_ktype);
106 node->fwnode.type = FWNODE_OF;
109 /* true when node is initialized */
110 static inline int of_node_is_initialized(struct device_node *node)
112 return node && node->kobj.state_initialized;
115 /* true when node is attached (i.e. present on sysfs) */
116 static inline int of_node_is_attached(struct device_node *node)
118 return node && node->kobj.state_in_sysfs;
121 #ifdef CONFIG_OF_DYNAMIC
122 extern struct device_node *of_node_get(struct device_node *node);
123 extern void of_node_put(struct device_node *node);
124 #else /* CONFIG_OF_DYNAMIC */
125 /* Dummy ref counting routines - to be implemented later */
126 static inline struct device_node *of_node_get(struct device_node *node)
130 static inline void of_node_put(struct device_node *node) { }
131 #endif /* !CONFIG_OF_DYNAMIC */
133 /* Pointer for first entry in chain of all nodes. */
134 extern struct device_node *of_root;
135 extern struct device_node *of_chosen;
136 extern struct device_node *of_aliases;
137 extern struct device_node *of_stdout;
138 extern raw_spinlock_t devtree_lock;
140 /* flag descriptions (need to be visible even when !CONFIG_OF) */
141 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
142 #define OF_DETACHED 2 /* node has been detached from the device tree */
143 #define OF_POPULATED 3 /* device already created for the node */
144 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
146 #define OF_BAD_ADDR ((u64)-1)
149 void of_core_init(void);
151 static inline bool is_of_node(struct fwnode_handle *fwnode)
153 return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_OF;
156 static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
158 return is_of_node(fwnode) ?
159 container_of(fwnode, struct device_node, fwnode) : NULL;
162 static inline bool of_have_populated_dt(void)
164 return of_root != NULL;
167 static inline bool of_node_is_root(const struct device_node *node)
169 return node && (node->parent == NULL);
172 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
174 return test_bit(flag, &n->_flags);
177 static inline int of_node_test_and_set_flag(struct device_node *n,
180 return test_and_set_bit(flag, &n->_flags);
183 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
185 set_bit(flag, &n->_flags);
188 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
190 clear_bit(flag, &n->_flags);
193 static inline int of_property_check_flag(struct property *p, unsigned long flag)
195 return test_bit(flag, &p->_flags);
198 static inline void of_property_set_flag(struct property *p, unsigned long flag)
200 set_bit(flag, &p->_flags);
203 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
205 clear_bit(flag, &p->_flags);
208 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
209 extern struct device_node *of_find_all_nodes(struct device_node *prev);
212 * OF address retrieval & translation
215 /* Helper to read a big number; size is in cells (not bytes) */
216 static inline u64 of_read_number(const __be32 *cell, int size)
220 r = (r << 32) | be32_to_cpu(*(cell++));
224 /* Like of_read_number, but we want an unsigned long result */
225 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
227 /* toss away upper bits if unsigned long is smaller than u64 */
228 return of_read_number(cell, size);
231 #if defined(CONFIG_SPARC)
232 #include <asm/prom.h>
235 /* Default #address and #size cells. Allow arch asm/prom.h to override */
236 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
237 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
238 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
241 /* Default string compare functions, Allow arch asm/prom.h to override */
242 #if !defined(of_compat_cmp)
243 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
244 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
245 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
248 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
249 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
251 static inline const char *of_node_full_name(const struct device_node *np)
253 return np ? np->full_name : "<no-node>";
256 #define for_each_of_allnodes_from(from, dn) \
257 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
258 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
259 extern struct device_node *of_find_node_by_name(struct device_node *from,
261 extern struct device_node *of_find_node_by_type(struct device_node *from,
263 extern struct device_node *of_find_compatible_node(struct device_node *from,
264 const char *type, const char *compat);
265 extern struct device_node *of_find_matching_node_and_match(
266 struct device_node *from,
267 const struct of_device_id *matches,
268 const struct of_device_id **match);
270 extern struct device_node *of_find_node_opts_by_path(const char *path,
272 static inline struct device_node *of_find_node_by_path(const char *path)
274 return of_find_node_opts_by_path(path, NULL);
277 extern struct device_node *of_find_node_by_phandle(phandle handle);
278 extern struct device_node *of_get_parent(const struct device_node *node);
279 extern struct device_node *of_get_next_parent(struct device_node *node);
280 extern struct device_node *of_get_next_child(const struct device_node *node,
281 struct device_node *prev);
282 extern struct device_node *of_get_next_available_child(
283 const struct device_node *node, struct device_node *prev);
285 extern struct device_node *of_get_child_by_name(const struct device_node *node,
289 extern struct device_node *of_find_next_cache_node(const struct device_node *);
290 extern struct device_node *of_find_node_with_property(
291 struct device_node *from, const char *prop_name);
293 extern struct property *of_find_property(const struct device_node *np,
296 extern int of_property_count_elems_of_size(const struct device_node *np,
297 const char *propname, int elem_size);
298 extern int of_property_read_u32_index(const struct device_node *np,
299 const char *propname,
300 u32 index, u32 *out_value);
301 extern int of_property_read_u8_array(const struct device_node *np,
302 const char *propname, u8 *out_values, size_t sz);
303 extern int of_property_read_u16_array(const struct device_node *np,
304 const char *propname, u16 *out_values, size_t sz);
305 extern int of_property_read_u32_array(const struct device_node *np,
306 const char *propname,
309 extern int of_property_read_u64(const struct device_node *np,
310 const char *propname, u64 *out_value);
311 extern int of_property_read_u64_array(const struct device_node *np,
312 const char *propname,
316 extern int of_property_read_string(const struct device_node *np,
317 const char *propname,
318 const char **out_string);
319 extern int of_property_match_string(const struct device_node *np,
320 const char *propname,
322 extern int of_property_read_string_helper(const struct device_node *np,
323 const char *propname,
324 const char **out_strs, size_t sz, int index);
325 extern int of_device_is_compatible(const struct device_node *device,
327 extern bool of_device_is_available(const struct device_node *device);
328 extern bool of_device_is_big_endian(const struct device_node *device);
329 extern const void *of_get_property(const struct device_node *node,
332 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
333 #define for_each_property_of_node(dn, pp) \
334 for (pp = dn->properties; pp != NULL; pp = pp->next)
336 extern int of_n_addr_cells(struct device_node *np);
337 extern int of_n_size_cells(struct device_node *np);
338 extern const struct of_device_id *of_match_node(
339 const struct of_device_id *matches, const struct device_node *node);
340 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
341 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
342 extern struct device_node *of_parse_phandle(const struct device_node *np,
343 const char *phandle_name,
345 extern int of_parse_phandle_with_args(const struct device_node *np,
346 const char *list_name, const char *cells_name, int index,
347 struct of_phandle_args *out_args);
348 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
349 const char *list_name, int cells_count, int index,
350 struct of_phandle_args *out_args);
351 extern int of_count_phandle_with_args(const struct device_node *np,
352 const char *list_name, const char *cells_name);
354 /* phandle iterator functions */
355 extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
356 const struct device_node *np,
357 const char *list_name,
358 const char *cells_name,
361 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
362 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
366 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
367 extern int of_alias_get_id(struct device_node *np, const char *stem);
368 extern int of_alias_get_highest_id(const char *stem);
370 extern int of_machine_is_compatible(const char *compat);
372 extern int of_add_property(struct device_node *np, struct property *prop);
373 extern int of_remove_property(struct device_node *np, struct property *prop);
374 extern int of_update_property(struct device_node *np, struct property *newprop);
376 /* For updating the device tree at runtime */
377 #define OF_RECONFIG_ATTACH_NODE 0x0001
378 #define OF_RECONFIG_DETACH_NODE 0x0002
379 #define OF_RECONFIG_ADD_PROPERTY 0x0003
380 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
381 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
383 extern int of_attach_node(struct device_node *);
384 extern int of_detach_node(struct device_node *);
386 #define of_match_ptr(_ptr) (_ptr)
389 * struct property *prop;
393 * of_property_for_each_u32(np, "propname", prop, p, u)
394 * printk("U32 value: %x\n", u);
396 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
399 * struct property *prop;
402 * of_property_for_each_string(np, "propname", prop, s)
403 * printk("String value: %s\n", s);
405 const char *of_prop_next_string(struct property *prop, const char *cur);
407 bool of_console_check(struct device_node *dn, char *name, int index);
409 #else /* CONFIG_OF */
411 static inline void of_core_init(void)
415 static inline bool is_of_node(struct fwnode_handle *fwnode)
420 static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
425 static inline const char* of_node_full_name(const struct device_node *np)
430 static inline struct device_node *of_find_node_by_name(struct device_node *from,
436 static inline struct device_node *of_find_node_by_type(struct device_node *from,
442 static inline struct device_node *of_find_matching_node_and_match(
443 struct device_node *from,
444 const struct of_device_id *matches,
445 const struct of_device_id **match)
450 static inline struct device_node *of_find_node_by_path(const char *path)
455 static inline struct device_node *of_find_node_opts_by_path(const char *path,
461 static inline struct device_node *of_find_node_by_phandle(phandle handle)
466 static inline struct device_node *of_get_parent(const struct device_node *node)
471 static inline struct device_node *of_get_next_child(
472 const struct device_node *node, struct device_node *prev)
477 static inline struct device_node *of_get_next_available_child(
478 const struct device_node *node, struct device_node *prev)
483 static inline struct device_node *of_find_node_with_property(
484 struct device_node *from, const char *prop_name)
489 static inline bool of_have_populated_dt(void)
494 static inline struct device_node *of_get_child_by_name(
495 const struct device_node *node,
501 static inline int of_device_is_compatible(const struct device_node *device,
507 static inline bool of_device_is_available(const struct device_node *device)
512 static inline bool of_device_is_big_endian(const struct device_node *device)
517 static inline struct property *of_find_property(const struct device_node *np,
524 static inline struct device_node *of_find_compatible_node(
525 struct device_node *from,
532 static inline int of_property_count_elems_of_size(const struct device_node *np,
533 const char *propname, int elem_size)
538 static inline int of_property_read_u32_index(const struct device_node *np,
539 const char *propname, u32 index, u32 *out_value)
544 static inline int of_property_read_u8_array(const struct device_node *np,
545 const char *propname, u8 *out_values, size_t sz)
550 static inline int of_property_read_u16_array(const struct device_node *np,
551 const char *propname, u16 *out_values, size_t sz)
556 static inline int of_property_read_u32_array(const struct device_node *np,
557 const char *propname,
558 u32 *out_values, size_t sz)
563 static inline int of_property_read_u64_array(const struct device_node *np,
564 const char *propname,
565 u64 *out_values, size_t sz)
570 static inline int of_property_read_string(const struct device_node *np,
571 const char *propname,
572 const char **out_string)
577 static inline int of_property_read_string_helper(const struct device_node *np,
578 const char *propname,
579 const char **out_strs, size_t sz, int index)
584 static inline const void *of_get_property(const struct device_node *node,
591 static inline struct device_node *of_get_cpu_node(int cpu,
592 unsigned int *thread)
597 static inline int of_property_read_u64(const struct device_node *np,
598 const char *propname, u64 *out_value)
603 static inline int of_property_match_string(const struct device_node *np,
604 const char *propname,
610 static inline struct device_node *of_parse_phandle(const struct device_node *np,
611 const char *phandle_name,
617 static inline int of_parse_phandle_with_args(const struct device_node *np,
618 const char *list_name,
619 const char *cells_name,
621 struct of_phandle_args *out_args)
626 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
627 const char *list_name, int cells_count, int index,
628 struct of_phandle_args *out_args)
633 static inline int of_count_phandle_with_args(struct device_node *np,
634 const char *list_name,
635 const char *cells_name)
640 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
641 const struct device_node *np,
642 const char *list_name,
643 const char *cells_name,
649 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
654 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
661 static inline int of_alias_get_id(struct device_node *np, const char *stem)
666 static inline int of_alias_get_highest_id(const char *stem)
671 static inline int of_machine_is_compatible(const char *compat)
676 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
681 static inline const __be32 *of_prop_next_u32(struct property *prop,
682 const __be32 *cur, u32 *pu)
687 static inline const char *of_prop_next_string(struct property *prop,
693 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
698 static inline int of_node_test_and_set_flag(struct device_node *n,
704 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
708 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
712 static inline int of_property_check_flag(struct property *p, unsigned long flag)
717 static inline void of_property_set_flag(struct property *p, unsigned long flag)
721 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
725 #define of_match_ptr(_ptr) NULL
726 #define of_match_node(_matches, _node) NULL
727 #endif /* CONFIG_OF */
729 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
730 extern int of_node_to_nid(struct device_node *np);
732 static inline int of_node_to_nid(struct device_node *device)
738 #ifdef CONFIG_OF_NUMA
739 extern int of_numa_init(void);
741 static inline int of_numa_init(void)
747 static inline struct device_node *of_find_matching_node(
748 struct device_node *from,
749 const struct of_device_id *matches)
751 return of_find_matching_node_and_match(from, matches, NULL);
755 * of_property_count_u8_elems - Count the number of u8 elements in a property
757 * @np: device node from which the property value is to be read.
758 * @propname: name of the property to be searched.
760 * Search for a property in a device node and count the number of u8 elements
761 * in it. Returns number of elements on sucess, -EINVAL if the property does
762 * not exist or its length does not match a multiple of u8 and -ENODATA if the
763 * property does not have a value.
765 static inline int of_property_count_u8_elems(const struct device_node *np,
766 const char *propname)
768 return of_property_count_elems_of_size(np, propname, sizeof(u8));
772 * of_property_count_u16_elems - Count the number of u16 elements in a property
774 * @np: device node from which the property value is to be read.
775 * @propname: name of the property to be searched.
777 * Search for a property in a device node and count the number of u16 elements
778 * in it. Returns number of elements on sucess, -EINVAL if the property does
779 * not exist or its length does not match a multiple of u16 and -ENODATA if the
780 * property does not have a value.
782 static inline int of_property_count_u16_elems(const struct device_node *np,
783 const char *propname)
785 return of_property_count_elems_of_size(np, propname, sizeof(u16));
789 * of_property_count_u32_elems - Count the number of u32 elements in a property
791 * @np: device node from which the property value is to be read.
792 * @propname: name of the property to be searched.
794 * Search for a property in a device node and count the number of u32 elements
795 * in it. Returns number of elements on sucess, -EINVAL if the property does
796 * not exist or its length does not match a multiple of u32 and -ENODATA if the
797 * property does not have a value.
799 static inline int of_property_count_u32_elems(const struct device_node *np,
800 const char *propname)
802 return of_property_count_elems_of_size(np, propname, sizeof(u32));
806 * of_property_count_u64_elems - Count the number of u64 elements in a property
808 * @np: device node from which the property value is to be read.
809 * @propname: name of the property to be searched.
811 * Search for a property in a device node and count the number of u64 elements
812 * in it. Returns number of elements on sucess, -EINVAL if the property does
813 * not exist or its length does not match a multiple of u64 and -ENODATA if the
814 * property does not have a value.
816 static inline int of_property_count_u64_elems(const struct device_node *np,
817 const char *propname)
819 return of_property_count_elems_of_size(np, propname, sizeof(u64));
823 * of_property_read_string_array() - Read an array of strings from a multiple
825 * @np: device node from which the property value is to be read.
826 * @propname: name of the property to be searched.
827 * @out_strs: output array of string pointers.
828 * @sz: number of array elements to read.
830 * Search for a property in a device tree node and retrieve a list of
831 * terminated string values (pointer to data, not a copy) in that property.
833 * If @out_strs is NULL, the number of strings in the property is returned.
835 static inline int of_property_read_string_array(const struct device_node *np,
836 const char *propname, const char **out_strs,
839 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
843 * of_property_count_strings() - Find and return the number of strings from a
844 * multiple strings property.
845 * @np: device node from which the property value is to be read.
846 * @propname: name of the property to be searched.
848 * Search for a property in a device tree node and retrieve the number of null
849 * terminated string contain in it. Returns the number of strings on
850 * success, -EINVAL if the property does not exist, -ENODATA if property
851 * does not have a value, and -EILSEQ if the string is not null-terminated
852 * within the length of the property data.
854 static inline int of_property_count_strings(const struct device_node *np,
855 const char *propname)
857 return of_property_read_string_helper(np, propname, NULL, 0, 0);
861 * of_property_read_string_index() - Find and read a string from a multiple
863 * @np: device node from which the property value is to be read.
864 * @propname: name of the property to be searched.
865 * @index: index of the string in the list of strings
866 * @out_string: pointer to null terminated return string, modified only if
869 * Search for a property in a device tree node and retrieve a null
870 * terminated string value (pointer to data, not a copy) in the list of strings
871 * contained in that property.
872 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
873 * property does not have a value, and -EILSEQ if the string is not
874 * null-terminated within the length of the property data.
876 * The out_string pointer is modified only if a valid string can be decoded.
878 static inline int of_property_read_string_index(const struct device_node *np,
879 const char *propname,
880 int index, const char **output)
882 int rc = of_property_read_string_helper(np, propname, output, 1, index);
883 return rc < 0 ? rc : 0;
887 * of_property_read_bool - Findfrom a property
888 * @np: device node from which the property value is to be read.
889 * @propname: name of the property to be searched.
891 * Search for a property in a device node.
892 * Returns true if the property exists false otherwise.
894 static inline bool of_property_read_bool(const struct device_node *np,
895 const char *propname)
897 struct property *prop = of_find_property(np, propname, NULL);
899 return prop ? true : false;
902 static inline int of_property_read_u8(const struct device_node *np,
903 const char *propname,
906 return of_property_read_u8_array(np, propname, out_value, 1);
909 static inline int of_property_read_u16(const struct device_node *np,
910 const char *propname,
913 return of_property_read_u16_array(np, propname, out_value, 1);
916 static inline int of_property_read_u32(const struct device_node *np,
917 const char *propname,
920 return of_property_read_u32_array(np, propname, out_value, 1);
923 static inline int of_property_read_s32(const struct device_node *np,
924 const char *propname,
927 return of_property_read_u32(np, propname, (u32*) out_value);
930 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
931 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
932 err = of_phandle_iterator_next(it); \
934 err = of_phandle_iterator_next(it))
936 #define of_property_for_each_u32(np, propname, prop, p, u) \
937 for (prop = of_find_property(np, propname, NULL), \
938 p = of_prop_next_u32(prop, NULL, &u); \
940 p = of_prop_next_u32(prop, p, &u))
942 #define of_property_for_each_string(np, propname, prop, s) \
943 for (prop = of_find_property(np, propname, NULL), \
944 s = of_prop_next_string(prop, NULL); \
946 s = of_prop_next_string(prop, s))
948 #define for_each_node_by_name(dn, name) \
949 for (dn = of_find_node_by_name(NULL, name); dn; \
950 dn = of_find_node_by_name(dn, name))
951 #define for_each_node_by_type(dn, type) \
952 for (dn = of_find_node_by_type(NULL, type); dn; \
953 dn = of_find_node_by_type(dn, type))
954 #define for_each_compatible_node(dn, type, compatible) \
955 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
956 dn = of_find_compatible_node(dn, type, compatible))
957 #define for_each_matching_node(dn, matches) \
958 for (dn = of_find_matching_node(NULL, matches); dn; \
959 dn = of_find_matching_node(dn, matches))
960 #define for_each_matching_node_and_match(dn, matches, match) \
961 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
962 dn; dn = of_find_matching_node_and_match(dn, matches, match))
964 #define for_each_child_of_node(parent, child) \
965 for (child = of_get_next_child(parent, NULL); child != NULL; \
966 child = of_get_next_child(parent, child))
967 #define for_each_available_child_of_node(parent, child) \
968 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
969 child = of_get_next_available_child(parent, child))
971 #define for_each_node_with_property(dn, prop_name) \
972 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
973 dn = of_find_node_with_property(dn, prop_name))
975 static inline int of_get_child_count(const struct device_node *np)
977 struct device_node *child;
980 for_each_child_of_node(np, child)
986 static inline int of_get_available_child_count(const struct device_node *np)
988 struct device_node *child;
991 for_each_available_child_of_node(np, child)
997 #if defined(CONFIG_OF) && !defined(MODULE)
998 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
999 static const struct of_device_id __of_table_##name \
1000 __used __section(__##table##_of_table) \
1001 = { .compatible = compat, \
1002 .data = (fn == (fn_type)NULL) ? fn : fn }
1004 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1005 static const struct of_device_id __of_table_##name \
1006 __attribute__((unused)) \
1007 = { .compatible = compat, \
1008 .data = (fn == (fn_type)NULL) ? fn : fn }
1011 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1012 typedef int (*of_init_fn_1_ret)(struct device_node *);
1013 typedef void (*of_init_fn_1)(struct device_node *);
1015 #define OF_DECLARE_1(table, name, compat, fn) \
1016 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1017 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1018 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1019 #define OF_DECLARE_2(table, name, compat, fn) \
1020 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1023 * struct of_changeset_entry - Holds a changeset entry
1025 * @node: list_head for the log list
1026 * @action: notifier action
1027 * @np: pointer to the device node affected
1028 * @prop: pointer to the property affected
1029 * @old_prop: hold a pointer to the original property
1031 * Every modification of the device tree during a changeset
1032 * is held in a list of of_changeset_entry structures.
1033 * That way we can recover from a partial application, or we can
1034 * revert the changeset
1036 struct of_changeset_entry {
1037 struct list_head node;
1038 unsigned long action;
1039 struct device_node *np;
1040 struct property *prop;
1041 struct property *old_prop;
1045 * struct of_changeset - changeset tracker structure
1047 * @entries: list_head for the changeset entries
1049 * changesets are a convenient way to apply bulk changes to the
1050 * live tree. In case of an error, changes are rolled-back.
1051 * changesets live on after initial application, and if not
1052 * destroyed after use, they can be reverted in one single call.
1054 struct of_changeset {
1055 struct list_head entries;
1058 enum of_reconfig_change {
1059 OF_RECONFIG_NO_CHANGE = 0,
1060 OF_RECONFIG_CHANGE_ADD,
1061 OF_RECONFIG_CHANGE_REMOVE,
1064 #ifdef CONFIG_OF_DYNAMIC
1065 extern int of_reconfig_notifier_register(struct notifier_block *);
1066 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1067 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1068 extern int of_reconfig_get_state_change(unsigned long action,
1069 struct of_reconfig_data *arg);
1071 extern void of_changeset_init(struct of_changeset *ocs);
1072 extern void of_changeset_destroy(struct of_changeset *ocs);
1073 extern int of_changeset_apply(struct of_changeset *ocs);
1074 extern int of_changeset_revert(struct of_changeset *ocs);
1075 extern int of_changeset_action(struct of_changeset *ocs,
1076 unsigned long action, struct device_node *np,
1077 struct property *prop);
1079 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1080 struct device_node *np)
1082 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1085 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1086 struct device_node *np)
1088 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1091 static inline int of_changeset_add_property(struct of_changeset *ocs,
1092 struct device_node *np, struct property *prop)
1094 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1097 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1098 struct device_node *np, struct property *prop)
1100 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1103 static inline int of_changeset_update_property(struct of_changeset *ocs,
1104 struct device_node *np, struct property *prop)
1106 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1108 #else /* CONFIG_OF_DYNAMIC */
1109 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1113 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1117 static inline int of_reconfig_notify(unsigned long action,
1118 struct of_reconfig_data *arg)
1122 static inline int of_reconfig_get_state_change(unsigned long action,
1123 struct of_reconfig_data *arg)
1127 #endif /* CONFIG_OF_DYNAMIC */
1129 /* CONFIG_OF_RESOLVE api */
1130 extern int of_resolve_phandles(struct device_node *tree);
1133 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1134 * @np: Pointer to the given device_node
1136 * return true if present false otherwise
1138 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1140 return of_property_read_bool(np, "system-power-controller");
1147 #ifdef CONFIG_OF_OVERLAY
1149 /* ID based overlays; the API for external users */
1150 int of_overlay_create(struct device_node *tree);
1151 int of_overlay_destroy(int id);
1152 int of_overlay_destroy_all(void);
1156 static inline int of_overlay_create(struct device_node *tree)
1161 static inline int of_overlay_destroy(int id)
1166 static inline int of_overlay_destroy_all(void)
1173 #endif /* _LINUX_OF_H */