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 const void *of_get_property(const struct device_node *node,
311 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
312 #define for_each_property_of_node(dn, pp) \
313 for (pp = dn->properties; pp != NULL; pp = pp->next)
315 extern int of_n_addr_cells(struct device_node *np);
316 extern int of_n_size_cells(struct device_node *np);
317 extern const struct of_device_id *of_match_node(
318 const struct of_device_id *matches, const struct device_node *node);
319 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
320 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
321 extern struct device_node *of_parse_phandle(const struct device_node *np,
322 const char *phandle_name,
324 extern int of_parse_phandle_with_args(const struct device_node *np,
325 const char *list_name, const char *cells_name, int index,
326 struct of_phandle_args *out_args);
327 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
328 const char *list_name, int cells_count, int index,
329 struct of_phandle_args *out_args);
330 extern int of_count_phandle_with_args(const struct device_node *np,
331 const char *list_name, const char *cells_name);
333 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
334 extern int of_alias_get_id(struct device_node *np, const char *stem);
335 extern int of_alias_get_highest_id(const char *stem);
337 extern int of_machine_is_compatible(const char *compat);
339 extern int of_add_property(struct device_node *np, struct property *prop);
340 extern int of_remove_property(struct device_node *np, struct property *prop);
341 extern int of_update_property(struct device_node *np, struct property *newprop);
343 /* For updating the device tree at runtime */
344 #define OF_RECONFIG_ATTACH_NODE 0x0001
345 #define OF_RECONFIG_DETACH_NODE 0x0002
346 #define OF_RECONFIG_ADD_PROPERTY 0x0003
347 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
348 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
350 extern int of_attach_node(struct device_node *);
351 extern int of_detach_node(struct device_node *);
353 #define of_match_ptr(_ptr) (_ptr)
356 * struct property *prop;
360 * of_property_for_each_u32(np, "propname", prop, p, u)
361 * printk("U32 value: %x\n", u);
363 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
366 * struct property *prop;
369 * of_property_for_each_string(np, "propname", prop, s)
370 * printk("String value: %s\n", s);
372 const char *of_prop_next_string(struct property *prop, const char *cur);
374 bool of_console_check(struct device_node *dn, char *name, int index);
376 #else /* CONFIG_OF */
378 static inline bool is_of_node(struct fwnode_handle *fwnode)
383 static inline struct device_node *of_node(struct fwnode_handle *fwnode)
388 static inline const char* of_node_full_name(const struct device_node *np)
393 static inline struct device_node *of_find_node_by_name(struct device_node *from,
399 static inline struct device_node *of_find_node_by_type(struct device_node *from,
405 static inline struct device_node *of_find_matching_node_and_match(
406 struct device_node *from,
407 const struct of_device_id *matches,
408 const struct of_device_id **match)
413 static inline struct device_node *of_find_node_by_path(const char *path)
418 static inline struct device_node *of_find_node_opts_by_path(const char *path,
424 static inline struct device_node *of_get_parent(const struct device_node *node)
429 static inline struct device_node *of_get_next_child(
430 const struct device_node *node, struct device_node *prev)
435 static inline struct device_node *of_get_next_available_child(
436 const struct device_node *node, struct device_node *prev)
441 static inline struct device_node *of_find_node_with_property(
442 struct device_node *from, const char *prop_name)
447 static inline bool of_have_populated_dt(void)
452 static inline struct device_node *of_get_child_by_name(
453 const struct device_node *node,
459 static inline int of_device_is_compatible(const struct device_node *device,
465 static inline bool of_device_is_available(const struct device_node *device)
470 static inline struct property *of_find_property(const struct device_node *np,
477 static inline struct device_node *of_find_compatible_node(
478 struct device_node *from,
485 static inline int of_property_count_elems_of_size(const struct device_node *np,
486 const char *propname, int elem_size)
491 static inline int of_property_read_u32_index(const struct device_node *np,
492 const char *propname, u32 index, u32 *out_value)
497 static inline int of_property_read_u8_array(const struct device_node *np,
498 const char *propname, u8 *out_values, size_t sz)
503 static inline int of_property_read_u16_array(const struct device_node *np,
504 const char *propname, u16 *out_values, size_t sz)
509 static inline int of_property_read_u32_array(const struct device_node *np,
510 const char *propname,
511 u32 *out_values, size_t sz)
516 static inline int of_property_read_u64_array(const struct device_node *np,
517 const char *propname,
518 u64 *out_values, size_t sz)
523 static inline int of_property_read_string(struct device_node *np,
524 const char *propname,
525 const char **out_string)
530 static inline int of_property_read_string_helper(struct device_node *np,
531 const char *propname,
532 const char **out_strs, size_t sz, int index)
537 static inline const void *of_get_property(const struct device_node *node,
544 static inline struct device_node *of_get_cpu_node(int cpu,
545 unsigned int *thread)
550 static inline int of_property_read_u64(const struct device_node *np,
551 const char *propname, u64 *out_value)
556 static inline int of_property_match_string(struct device_node *np,
557 const char *propname,
563 static inline struct device_node *of_parse_phandle(const struct device_node *np,
564 const char *phandle_name,
570 static inline int of_parse_phandle_with_args(struct device_node *np,
571 const char *list_name,
572 const char *cells_name,
574 struct of_phandle_args *out_args)
579 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
580 const char *list_name, int cells_count, int index,
581 struct of_phandle_args *out_args)
586 static inline int of_count_phandle_with_args(struct device_node *np,
587 const char *list_name,
588 const char *cells_name)
593 static inline int of_alias_get_id(struct device_node *np, const char *stem)
598 static inline int of_alias_get_highest_id(const char *stem)
603 static inline int of_machine_is_compatible(const char *compat)
608 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
613 static inline const __be32 *of_prop_next_u32(struct property *prop,
614 const __be32 *cur, u32 *pu)
619 static inline const char *of_prop_next_string(struct property *prop,
625 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
630 static inline int of_node_test_and_set_flag(struct device_node *n,
636 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
640 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
644 static inline int of_property_check_flag(struct property *p, unsigned long flag)
649 static inline void of_property_set_flag(struct property *p, unsigned long flag)
653 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
657 #define of_match_ptr(_ptr) NULL
658 #define of_match_node(_matches, _node) NULL
659 #endif /* CONFIG_OF */
661 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
662 extern int of_node_to_nid(struct device_node *np);
664 static inline int of_node_to_nid(struct device_node *device) { return 0; }
667 static inline struct device_node *of_find_matching_node(
668 struct device_node *from,
669 const struct of_device_id *matches)
671 return of_find_matching_node_and_match(from, matches, NULL);
675 * of_property_count_u8_elems - Count the number of u8 elements in a property
677 * @np: device node from which the property value is to be read.
678 * @propname: name of the property to be searched.
680 * Search for a property in a device node and count the number of u8 elements
681 * in it. Returns number of elements on sucess, -EINVAL if the property does
682 * not exist or its length does not match a multiple of u8 and -ENODATA if the
683 * property does not have a value.
685 static inline int of_property_count_u8_elems(const struct device_node *np,
686 const char *propname)
688 return of_property_count_elems_of_size(np, propname, sizeof(u8));
692 * of_property_count_u16_elems - Count the number of u16 elements in a property
694 * @np: device node from which the property value is to be read.
695 * @propname: name of the property to be searched.
697 * Search for a property in a device node and count the number of u16 elements
698 * in it. Returns number of elements on sucess, -EINVAL if the property does
699 * not exist or its length does not match a multiple of u16 and -ENODATA if the
700 * property does not have a value.
702 static inline int of_property_count_u16_elems(const struct device_node *np,
703 const char *propname)
705 return of_property_count_elems_of_size(np, propname, sizeof(u16));
709 * of_property_count_u32_elems - Count the number of u32 elements in a property
711 * @np: device node from which the property value is to be read.
712 * @propname: name of the property to be searched.
714 * Search for a property in a device node and count the number of u32 elements
715 * in it. Returns number of elements on sucess, -EINVAL if the property does
716 * not exist or its length does not match a multiple of u32 and -ENODATA if the
717 * property does not have a value.
719 static inline int of_property_count_u32_elems(const struct device_node *np,
720 const char *propname)
722 return of_property_count_elems_of_size(np, propname, sizeof(u32));
726 * of_property_count_u64_elems - Count the number of u64 elements in a property
728 * @np: device node from which the property value is to be read.
729 * @propname: name of the property to be searched.
731 * Search for a property in a device node and count the number of u64 elements
732 * in it. Returns number of elements on sucess, -EINVAL if the property does
733 * not exist or its length does not match a multiple of u64 and -ENODATA if the
734 * property does not have a value.
736 static inline int of_property_count_u64_elems(const struct device_node *np,
737 const char *propname)
739 return of_property_count_elems_of_size(np, propname, sizeof(u64));
743 * of_property_read_string_array() - Read an array of strings from a multiple
745 * @np: device node from which the property value is to be read.
746 * @propname: name of the property to be searched.
747 * @out_strs: output array of string pointers.
748 * @sz: number of array elements to read.
750 * Search for a property in a device tree node and retrieve a list of
751 * terminated string values (pointer to data, not a copy) in that property.
753 * If @out_strs is NULL, the number of strings in the property is returned.
755 static inline int of_property_read_string_array(struct device_node *np,
756 const char *propname, const char **out_strs,
759 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
763 * of_property_count_strings() - Find and return the number of strings from a
764 * multiple strings property.
765 * @np: device node from which the property value is to be read.
766 * @propname: name of the property to be searched.
768 * Search for a property in a device tree node and retrieve the number of null
769 * terminated string contain in it. Returns the number of strings on
770 * success, -EINVAL if the property does not exist, -ENODATA if property
771 * does not have a value, and -EILSEQ if the string is not null-terminated
772 * within the length of the property data.
774 static inline int of_property_count_strings(struct device_node *np,
775 const char *propname)
777 return of_property_read_string_helper(np, propname, NULL, 0, 0);
781 * of_property_read_string_index() - Find and read a string from a multiple
783 * @np: device node from which the property value is to be read.
784 * @propname: name of the property to be searched.
785 * @index: index of the string in the list of strings
786 * @out_string: pointer to null terminated return string, modified only if
789 * Search for a property in a device tree node and retrieve a null
790 * terminated string value (pointer to data, not a copy) in the list of strings
791 * contained in that property.
792 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
793 * property does not have a value, and -EILSEQ if the string is not
794 * null-terminated within the length of the property data.
796 * The out_string pointer is modified only if a valid string can be decoded.
798 static inline int of_property_read_string_index(struct device_node *np,
799 const char *propname,
800 int index, const char **output)
802 int rc = of_property_read_string_helper(np, propname, output, 1, index);
803 return rc < 0 ? rc : 0;
807 * of_property_read_bool - Findfrom 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.
812 * Returns true if the property exist false otherwise.
814 static inline bool of_property_read_bool(const struct device_node *np,
815 const char *propname)
817 struct property *prop = of_find_property(np, propname, NULL);
819 return prop ? true : false;
822 static inline int of_property_read_u8(const struct device_node *np,
823 const char *propname,
826 return of_property_read_u8_array(np, propname, out_value, 1);
829 static inline int of_property_read_u16(const struct device_node *np,
830 const char *propname,
833 return of_property_read_u16_array(np, propname, out_value, 1);
836 static inline int of_property_read_u32(const struct device_node *np,
837 const char *propname,
840 return of_property_read_u32_array(np, propname, out_value, 1);
843 static inline int of_property_read_s32(const struct device_node *np,
844 const char *propname,
847 return of_property_read_u32(np, propname, (u32*) out_value);
850 #define of_property_for_each_u32(np, propname, prop, p, u) \
851 for (prop = of_find_property(np, propname, NULL), \
852 p = of_prop_next_u32(prop, NULL, &u); \
854 p = of_prop_next_u32(prop, p, &u))
856 #define of_property_for_each_string(np, propname, prop, s) \
857 for (prop = of_find_property(np, propname, NULL), \
858 s = of_prop_next_string(prop, NULL); \
860 s = of_prop_next_string(prop, s))
862 #define for_each_node_by_name(dn, name) \
863 for (dn = of_find_node_by_name(NULL, name); dn; \
864 dn = of_find_node_by_name(dn, name))
865 #define for_each_node_by_type(dn, type) \
866 for (dn = of_find_node_by_type(NULL, type); dn; \
867 dn = of_find_node_by_type(dn, type))
868 #define for_each_compatible_node(dn, type, compatible) \
869 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
870 dn = of_find_compatible_node(dn, type, compatible))
871 #define for_each_matching_node(dn, matches) \
872 for (dn = of_find_matching_node(NULL, matches); dn; \
873 dn = of_find_matching_node(dn, matches))
874 #define for_each_matching_node_and_match(dn, matches, match) \
875 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
876 dn; dn = of_find_matching_node_and_match(dn, matches, match))
878 #define for_each_child_of_node(parent, child) \
879 for (child = of_get_next_child(parent, NULL); child != NULL; \
880 child = of_get_next_child(parent, child))
881 #define for_each_available_child_of_node(parent, child) \
882 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
883 child = of_get_next_available_child(parent, child))
885 #define for_each_node_with_property(dn, prop_name) \
886 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
887 dn = of_find_node_with_property(dn, prop_name))
889 static inline int of_get_child_count(const struct device_node *np)
891 struct device_node *child;
894 for_each_child_of_node(np, child)
900 static inline int of_get_available_child_count(const struct device_node *np)
902 struct device_node *child;
905 for_each_available_child_of_node(np, child)
912 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
913 static const struct of_device_id __of_table_##name \
914 __used __section(__##table##_of_table) \
915 = { .compatible = compat, \
916 .data = (fn == (fn_type)NULL) ? fn : fn }
918 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
919 static const struct of_device_id __of_table_##name \
920 __attribute__((unused)) \
921 = { .compatible = compat, \
922 .data = (fn == (fn_type)NULL) ? fn : fn }
925 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
926 typedef void (*of_init_fn_1)(struct device_node *);
928 #define OF_DECLARE_1(table, name, compat, fn) \
929 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
930 #define OF_DECLARE_2(table, name, compat, fn) \
931 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
934 * struct of_changeset_entry - Holds a changeset entry
936 * @node: list_head for the log list
937 * @action: notifier action
938 * @np: pointer to the device node affected
939 * @prop: pointer to the property affected
940 * @old_prop: hold a pointer to the original property
942 * Every modification of the device tree during a changeset
943 * is held in a list of of_changeset_entry structures.
944 * That way we can recover from a partial application, or we can
945 * revert the changeset
947 struct of_changeset_entry {
948 struct list_head node;
949 unsigned long action;
950 struct device_node *np;
951 struct property *prop;
952 struct property *old_prop;
956 * struct of_changeset - changeset tracker structure
958 * @entries: list_head for the changeset entries
960 * changesets are a convenient way to apply bulk changes to the
961 * live tree. In case of an error, changes are rolled-back.
962 * changesets live on after initial application, and if not
963 * destroyed after use, they can be reverted in one single call.
965 struct of_changeset {
966 struct list_head entries;
969 enum of_reconfig_change {
970 OF_RECONFIG_NO_CHANGE = 0,
971 OF_RECONFIG_CHANGE_ADD,
972 OF_RECONFIG_CHANGE_REMOVE,
975 #ifdef CONFIG_OF_DYNAMIC
976 extern int of_reconfig_notifier_register(struct notifier_block *);
977 extern int of_reconfig_notifier_unregister(struct notifier_block *);
978 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
979 extern int of_reconfig_get_state_change(unsigned long action,
980 struct of_reconfig_data *arg);
982 extern void of_changeset_init(struct of_changeset *ocs);
983 extern void of_changeset_destroy(struct of_changeset *ocs);
984 extern int of_changeset_apply(struct of_changeset *ocs);
985 extern int of_changeset_revert(struct of_changeset *ocs);
986 extern int of_changeset_action(struct of_changeset *ocs,
987 unsigned long action, struct device_node *np,
988 struct property *prop);
990 static inline int of_changeset_attach_node(struct of_changeset *ocs,
991 struct device_node *np)
993 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
996 static inline int of_changeset_detach_node(struct of_changeset *ocs,
997 struct device_node *np)
999 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1002 static inline int of_changeset_add_property(struct of_changeset *ocs,
1003 struct device_node *np, struct property *prop)
1005 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1008 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1009 struct device_node *np, struct property *prop)
1011 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1014 static inline int of_changeset_update_property(struct of_changeset *ocs,
1015 struct device_node *np, struct property *prop)
1017 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1019 #else /* CONFIG_OF_DYNAMIC */
1020 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1024 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1028 static inline int of_reconfig_notify(unsigned long action,
1029 struct of_reconfig_data *arg)
1033 static inline int of_reconfig_get_state_change(unsigned long action,
1034 struct of_reconfig_data *arg)
1038 #endif /* CONFIG_OF_DYNAMIC */
1040 /* CONFIG_OF_RESOLVE api */
1041 extern int of_resolve_phandles(struct device_node *tree);
1044 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1045 * @np: Pointer to the given device_node
1047 * return true if present false otherwise
1049 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1051 return of_property_read_bool(np, "system-power-controller");
1058 #ifdef CONFIG_OF_OVERLAY
1060 /* ID based overlays; the API for external users */
1061 int of_overlay_create(struct device_node *tree);
1062 int of_overlay_destroy(int id);
1063 int of_overlay_destroy_all(void);
1067 static inline int of_overlay_create(struct device_node *tree)
1072 static inline int of_overlay_destroy(int id)
1077 static inline int of_overlay_destroy_all(void)
1084 #endif /* _LINUX_OF_H */