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;
123 /* flag descriptions (need to be visible even when !CONFIG_OF) */
124 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
125 #define OF_DETACHED 2 /* node has been detached from the device tree */
126 #define OF_POPULATED 3 /* device already created for the node */
127 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
129 #define OF_BAD_ADDR ((u64)-1)
132 void of_core_init(void);
134 static inline bool is_of_node(struct fwnode_handle *fwnode)
136 return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_OF;
139 static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
141 return is_of_node(fwnode) ?
142 container_of(fwnode, struct device_node, fwnode) : NULL;
145 static inline bool of_have_populated_dt(void)
147 return of_root != NULL;
150 static inline bool of_node_is_root(const struct device_node *node)
152 return node && (node->parent == NULL);
155 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
157 return test_bit(flag, &n->_flags);
160 static inline int of_node_test_and_set_flag(struct device_node *n,
163 return test_and_set_bit(flag, &n->_flags);
166 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
168 set_bit(flag, &n->_flags);
171 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
173 clear_bit(flag, &n->_flags);
176 static inline int of_property_check_flag(struct property *p, unsigned long flag)
178 return test_bit(flag, &p->_flags);
181 static inline void of_property_set_flag(struct property *p, unsigned long flag)
183 set_bit(flag, &p->_flags);
186 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
188 clear_bit(flag, &p->_flags);
191 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
192 extern struct device_node *of_find_all_nodes(struct device_node *prev);
195 * OF address retrieval & translation
198 /* Helper to read a big number; size is in cells (not bytes) */
199 static inline u64 of_read_number(const __be32 *cell, int size)
203 r = (r << 32) | be32_to_cpu(*(cell++));
207 /* Like of_read_number, but we want an unsigned long result */
208 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
210 /* toss away upper bits if unsigned long is smaller than u64 */
211 return of_read_number(cell, size);
214 #if defined(CONFIG_SPARC)
215 #include <asm/prom.h>
218 /* Default #address and #size cells. Allow arch asm/prom.h to override */
219 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
220 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
221 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
224 /* Default string compare functions, Allow arch asm/prom.h to override */
225 #if !defined(of_compat_cmp)
226 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
227 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
228 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
231 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
232 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
234 static inline const char *of_node_full_name(const struct device_node *np)
236 return np ? np->full_name : "<no-node>";
239 #define for_each_of_allnodes_from(from, dn) \
240 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
241 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
242 extern struct device_node *of_find_node_by_name(struct device_node *from,
244 extern struct device_node *of_find_node_by_type(struct device_node *from,
246 extern struct device_node *of_find_compatible_node(struct device_node *from,
247 const char *type, const char *compat);
248 extern struct device_node *of_find_matching_node_and_match(
249 struct device_node *from,
250 const struct of_device_id *matches,
251 const struct of_device_id **match);
253 extern struct device_node *of_find_node_opts_by_path(const char *path,
255 static inline struct device_node *of_find_node_by_path(const char *path)
257 return of_find_node_opts_by_path(path, NULL);
260 extern struct device_node *of_find_node_by_phandle(phandle handle);
261 extern struct device_node *of_get_parent(const struct device_node *node);
262 extern struct device_node *of_get_next_parent(struct device_node *node);
263 extern struct device_node *of_get_next_child(const struct device_node *node,
264 struct device_node *prev);
265 extern struct device_node *of_get_next_available_child(
266 const struct device_node *node, struct device_node *prev);
268 extern struct device_node *of_get_child_by_name(const struct device_node *node,
272 extern struct device_node *of_find_next_cache_node(const struct device_node *);
273 extern struct device_node *of_find_node_with_property(
274 struct device_node *from, const char *prop_name);
276 extern struct property *of_find_property(const struct device_node *np,
279 extern int of_property_count_elems_of_size(const struct device_node *np,
280 const char *propname, int elem_size);
281 extern int of_property_read_u32_index(const struct device_node *np,
282 const char *propname,
283 u32 index, u32 *out_value);
284 extern int of_property_read_u8_array(const struct device_node *np,
285 const char *propname, u8 *out_values, size_t sz);
286 extern int of_property_read_u16_array(const struct device_node *np,
287 const char *propname, u16 *out_values, size_t sz);
288 extern int of_property_read_u32_array(const struct device_node *np,
289 const char *propname,
292 extern int of_property_read_u64(const struct device_node *np,
293 const char *propname, u64 *out_value);
294 extern int of_property_read_u64_array(const struct device_node *np,
295 const char *propname,
299 extern int of_property_read_string(const struct device_node *np,
300 const char *propname,
301 const char **out_string);
302 extern int of_property_match_string(const struct device_node *np,
303 const char *propname,
305 extern int of_property_read_string_helper(const struct device_node *np,
306 const char *propname,
307 const char **out_strs, size_t sz, int index);
308 extern int of_device_is_compatible(const struct device_node *device,
310 extern bool of_device_is_available(const struct device_node *device);
311 extern bool of_device_is_big_endian(const struct device_node *device);
312 extern const void *of_get_property(const struct device_node *node,
315 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
316 #define for_each_property_of_node(dn, pp) \
317 for (pp = dn->properties; pp != NULL; pp = pp->next)
319 extern int of_n_addr_cells(struct device_node *np);
320 extern int of_n_size_cells(struct device_node *np);
321 extern const struct of_device_id *of_match_node(
322 const struct of_device_id *matches, const struct device_node *node);
323 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
324 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
325 extern struct device_node *of_parse_phandle(const struct device_node *np,
326 const char *phandle_name,
328 extern int of_parse_phandle_with_args(const struct device_node *np,
329 const char *list_name, const char *cells_name, int index,
330 struct of_phandle_args *out_args);
331 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
332 const char *list_name, int cells_count, int index,
333 struct of_phandle_args *out_args);
334 extern int of_count_phandle_with_args(const struct device_node *np,
335 const char *list_name, const char *cells_name);
337 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
338 extern int of_alias_get_id(struct device_node *np, const char *stem);
339 extern int of_alias_get_highest_id(const char *stem);
341 extern int of_machine_is_compatible(const char *compat);
343 extern int of_add_property(struct device_node *np, struct property *prop);
344 extern int of_remove_property(struct device_node *np, struct property *prop);
345 extern int of_update_property(struct device_node *np, struct property *newprop);
347 /* For updating the device tree at runtime */
348 #define OF_RECONFIG_ATTACH_NODE 0x0001
349 #define OF_RECONFIG_DETACH_NODE 0x0002
350 #define OF_RECONFIG_ADD_PROPERTY 0x0003
351 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
352 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
354 extern int of_attach_node(struct device_node *);
355 extern int of_detach_node(struct device_node *);
357 #define of_match_ptr(_ptr) (_ptr)
360 * struct property *prop;
364 * of_property_for_each_u32(np, "propname", prop, p, u)
365 * printk("U32 value: %x\n", u);
367 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
370 * struct property *prop;
373 * of_property_for_each_string(np, "propname", prop, s)
374 * printk("String value: %s\n", s);
376 const char *of_prop_next_string(struct property *prop, const char *cur);
378 bool of_console_check(struct device_node *dn, char *name, int index);
380 #else /* CONFIG_OF */
382 static inline void of_core_init(void)
386 static inline bool is_of_node(struct fwnode_handle *fwnode)
391 static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
396 static inline const char* of_node_full_name(const struct device_node *np)
401 static inline struct device_node *of_find_node_by_name(struct device_node *from,
407 static inline struct device_node *of_find_node_by_type(struct device_node *from,
413 static inline struct device_node *of_find_matching_node_and_match(
414 struct device_node *from,
415 const struct of_device_id *matches,
416 const struct of_device_id **match)
421 static inline struct device_node *of_find_node_by_path(const char *path)
426 static inline struct device_node *of_find_node_opts_by_path(const char *path,
432 static inline struct device_node *of_find_node_by_phandle(phandle handle)
437 static inline struct device_node *of_get_parent(const struct device_node *node)
442 static inline struct device_node *of_get_next_child(
443 const struct device_node *node, struct device_node *prev)
448 static inline struct device_node *of_get_next_available_child(
449 const struct device_node *node, struct device_node *prev)
454 static inline struct device_node *of_find_node_with_property(
455 struct device_node *from, const char *prop_name)
460 static inline bool of_have_populated_dt(void)
465 static inline struct device_node *of_get_child_by_name(
466 const struct device_node *node,
472 static inline int of_device_is_compatible(const struct device_node *device,
478 static inline bool of_device_is_available(const struct device_node *device)
483 static inline bool of_device_is_big_endian(const struct device_node *device)
488 static inline struct property *of_find_property(const struct device_node *np,
495 static inline struct device_node *of_find_compatible_node(
496 struct device_node *from,
503 static inline int of_property_count_elems_of_size(const struct device_node *np,
504 const char *propname, int elem_size)
509 static inline int of_property_read_u32_index(const struct device_node *np,
510 const char *propname, u32 index, u32 *out_value)
515 static inline int of_property_read_u8_array(const struct device_node *np,
516 const char *propname, u8 *out_values, size_t sz)
521 static inline int of_property_read_u16_array(const struct device_node *np,
522 const char *propname, u16 *out_values, size_t sz)
527 static inline int of_property_read_u32_array(const struct device_node *np,
528 const char *propname,
529 u32 *out_values, size_t sz)
534 static inline int of_property_read_u64_array(const struct device_node *np,
535 const char *propname,
536 u64 *out_values, size_t sz)
541 static inline int of_property_read_string(const struct device_node *np,
542 const char *propname,
543 const char **out_string)
548 static inline int of_property_read_string_helper(const struct device_node *np,
549 const char *propname,
550 const char **out_strs, size_t sz, int index)
555 static inline const void *of_get_property(const struct device_node *node,
562 static inline struct device_node *of_get_cpu_node(int cpu,
563 unsigned int *thread)
568 static inline int of_property_read_u64(const struct device_node *np,
569 const char *propname, u64 *out_value)
574 static inline int of_property_match_string(const struct device_node *np,
575 const char *propname,
581 static inline struct device_node *of_parse_phandle(const struct device_node *np,
582 const char *phandle_name,
588 static inline int of_parse_phandle_with_args(struct device_node *np,
589 const char *list_name,
590 const char *cells_name,
592 struct of_phandle_args *out_args)
597 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
598 const char *list_name, int cells_count, int index,
599 struct of_phandle_args *out_args)
604 static inline int of_count_phandle_with_args(struct device_node *np,
605 const char *list_name,
606 const char *cells_name)
611 static inline int of_alias_get_id(struct device_node *np, const char *stem)
616 static inline int of_alias_get_highest_id(const char *stem)
621 static inline int of_machine_is_compatible(const char *compat)
626 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
631 static inline const __be32 *of_prop_next_u32(struct property *prop,
632 const __be32 *cur, u32 *pu)
637 static inline const char *of_prop_next_string(struct property *prop,
643 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
648 static inline int of_node_test_and_set_flag(struct device_node *n,
654 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
658 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
662 static inline int of_property_check_flag(struct property *p, unsigned long flag)
667 static inline void of_property_set_flag(struct property *p, unsigned long flag)
671 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
675 #define of_match_ptr(_ptr) NULL
676 #define of_match_node(_matches, _node) NULL
677 #endif /* CONFIG_OF */
679 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
680 extern int of_node_to_nid(struct device_node *np);
682 static inline int of_node_to_nid(struct device_node *device)
688 #ifdef CONFIG_OF_NUMA
689 extern int of_numa_init(void);
691 static inline int of_numa_init(void)
697 static inline struct device_node *of_find_matching_node(
698 struct device_node *from,
699 const struct of_device_id *matches)
701 return of_find_matching_node_and_match(from, matches, NULL);
705 * of_property_count_u8_elems - Count the number of u8 elements in a property
707 * @np: device node from which the property value is to be read.
708 * @propname: name of the property to be searched.
710 * Search for a property in a device node and count the number of u8 elements
711 * in it. Returns number of elements on sucess, -EINVAL if the property does
712 * not exist or its length does not match a multiple of u8 and -ENODATA if the
713 * property does not have a value.
715 static inline int of_property_count_u8_elems(const struct device_node *np,
716 const char *propname)
718 return of_property_count_elems_of_size(np, propname, sizeof(u8));
722 * of_property_count_u16_elems - Count the number of u16 elements in a property
724 * @np: device node from which the property value is to be read.
725 * @propname: name of the property to be searched.
727 * Search for a property in a device node and count the number of u16 elements
728 * in it. Returns number of elements on sucess, -EINVAL if the property does
729 * not exist or its length does not match a multiple of u16 and -ENODATA if the
730 * property does not have a value.
732 static inline int of_property_count_u16_elems(const struct device_node *np,
733 const char *propname)
735 return of_property_count_elems_of_size(np, propname, sizeof(u16));
739 * of_property_count_u32_elems - Count the number of u32 elements in a property
741 * @np: device node from which the property value is to be read.
742 * @propname: name of the property to be searched.
744 * Search for a property in a device node and count the number of u32 elements
745 * in it. Returns number of elements on sucess, -EINVAL if the property does
746 * not exist or its length does not match a multiple of u32 and -ENODATA if the
747 * property does not have a value.
749 static inline int of_property_count_u32_elems(const struct device_node *np,
750 const char *propname)
752 return of_property_count_elems_of_size(np, propname, sizeof(u32));
756 * of_property_count_u64_elems - Count the number of u64 elements in a property
758 * @np: device node from which the property value is to be read.
759 * @propname: name of the property to be searched.
761 * Search for a property in a device node and count the number of u64 elements
762 * in it. Returns number of elements on sucess, -EINVAL if the property does
763 * not exist or its length does not match a multiple of u64 and -ENODATA if the
764 * property does not have a value.
766 static inline int of_property_count_u64_elems(const struct device_node *np,
767 const char *propname)
769 return of_property_count_elems_of_size(np, propname, sizeof(u64));
773 * of_property_read_string_array() - Read an array of strings from a multiple
775 * @np: device node from which the property value is to be read.
776 * @propname: name of the property to be searched.
777 * @out_strs: output array of string pointers.
778 * @sz: number of array elements to read.
780 * Search for a property in a device tree node and retrieve a list of
781 * terminated string values (pointer to data, not a copy) in that property.
783 * If @out_strs is NULL, the number of strings in the property is returned.
785 static inline int of_property_read_string_array(const struct device_node *np,
786 const char *propname, const char **out_strs,
789 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
793 * of_property_count_strings() - Find and return the number of strings from a
794 * multiple strings property.
795 * @np: device node from which the property value is to be read.
796 * @propname: name of the property to be searched.
798 * Search for a property in a device tree node and retrieve the number of null
799 * terminated string contain in it. Returns the number of strings on
800 * success, -EINVAL if the property does not exist, -ENODATA if property
801 * does not have a value, and -EILSEQ if the string is not null-terminated
802 * within the length of the property data.
804 static inline int of_property_count_strings(const struct device_node *np,
805 const char *propname)
807 return of_property_read_string_helper(np, propname, NULL, 0, 0);
811 * of_property_read_string_index() - Find and read a string from a multiple
813 * @np: device node from which the property value is to be read.
814 * @propname: name of the property to be searched.
815 * @index: index of the string in the list of strings
816 * @out_string: pointer to null terminated return string, modified only if
819 * Search for a property in a device tree node and retrieve a null
820 * terminated string value (pointer to data, not a copy) in the list of strings
821 * contained in that property.
822 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
823 * property does not have a value, and -EILSEQ if the string is not
824 * null-terminated within the length of the property data.
826 * The out_string pointer is modified only if a valid string can be decoded.
828 static inline int of_property_read_string_index(const struct device_node *np,
829 const char *propname,
830 int index, const char **output)
832 int rc = of_property_read_string_helper(np, propname, output, 1, index);
833 return rc < 0 ? rc : 0;
837 * of_property_read_bool - Findfrom a property
838 * @np: device node from which the property value is to be read.
839 * @propname: name of the property to be searched.
841 * Search for a property in a device node.
842 * Returns true if the property exists false otherwise.
844 static inline bool of_property_read_bool(const struct device_node *np,
845 const char *propname)
847 struct property *prop = of_find_property(np, propname, NULL);
849 return prop ? true : false;
852 static inline int of_property_read_u8(const struct device_node *np,
853 const char *propname,
856 return of_property_read_u8_array(np, propname, out_value, 1);
859 static inline int of_property_read_u16(const struct device_node *np,
860 const char *propname,
863 return of_property_read_u16_array(np, propname, out_value, 1);
866 static inline int of_property_read_u32(const struct device_node *np,
867 const char *propname,
870 return of_property_read_u32_array(np, propname, out_value, 1);
873 static inline int of_property_read_s32(const struct device_node *np,
874 const char *propname,
877 return of_property_read_u32(np, propname, (u32*) out_value);
880 #define of_property_for_each_u32(np, propname, prop, p, u) \
881 for (prop = of_find_property(np, propname, NULL), \
882 p = of_prop_next_u32(prop, NULL, &u); \
884 p = of_prop_next_u32(prop, p, &u))
886 #define of_property_for_each_string(np, propname, prop, s) \
887 for (prop = of_find_property(np, propname, NULL), \
888 s = of_prop_next_string(prop, NULL); \
890 s = of_prop_next_string(prop, s))
892 #define for_each_node_by_name(dn, name) \
893 for (dn = of_find_node_by_name(NULL, name); dn; \
894 dn = of_find_node_by_name(dn, name))
895 #define for_each_node_by_type(dn, type) \
896 for (dn = of_find_node_by_type(NULL, type); dn; \
897 dn = of_find_node_by_type(dn, type))
898 #define for_each_compatible_node(dn, type, compatible) \
899 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
900 dn = of_find_compatible_node(dn, type, compatible))
901 #define for_each_matching_node(dn, matches) \
902 for (dn = of_find_matching_node(NULL, matches); dn; \
903 dn = of_find_matching_node(dn, matches))
904 #define for_each_matching_node_and_match(dn, matches, match) \
905 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
906 dn; dn = of_find_matching_node_and_match(dn, matches, match))
908 #define for_each_child_of_node(parent, child) \
909 for (child = of_get_next_child(parent, NULL); child != NULL; \
910 child = of_get_next_child(parent, child))
911 #define for_each_available_child_of_node(parent, child) \
912 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
913 child = of_get_next_available_child(parent, child))
915 #define for_each_node_with_property(dn, prop_name) \
916 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
917 dn = of_find_node_with_property(dn, prop_name))
919 static inline int of_get_child_count(const struct device_node *np)
921 struct device_node *child;
924 for_each_child_of_node(np, child)
930 static inline int of_get_available_child_count(const struct device_node *np)
932 struct device_node *child;
935 for_each_available_child_of_node(np, child)
941 #if defined(CONFIG_OF) && !defined(MODULE)
942 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
943 static const struct of_device_id __of_table_##name \
944 __used __section(__##table##_of_table) \
945 = { .compatible = compat, \
946 .data = (fn == (fn_type)NULL) ? fn : fn }
948 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
949 static const struct of_device_id __of_table_##name \
950 __attribute__((unused)) \
951 = { .compatible = compat, \
952 .data = (fn == (fn_type)NULL) ? fn : fn }
955 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
956 typedef void (*of_init_fn_1)(struct device_node *);
958 #define OF_DECLARE_1(table, name, compat, fn) \
959 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
960 #define OF_DECLARE_2(table, name, compat, fn) \
961 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
964 * struct of_changeset_entry - Holds a changeset entry
966 * @node: list_head for the log list
967 * @action: notifier action
968 * @np: pointer to the device node affected
969 * @prop: pointer to the property affected
970 * @old_prop: hold a pointer to the original property
972 * Every modification of the device tree during a changeset
973 * is held in a list of of_changeset_entry structures.
974 * That way we can recover from a partial application, or we can
975 * revert the changeset
977 struct of_changeset_entry {
978 struct list_head node;
979 unsigned long action;
980 struct device_node *np;
981 struct property *prop;
982 struct property *old_prop;
986 * struct of_changeset - changeset tracker structure
988 * @entries: list_head for the changeset entries
990 * changesets are a convenient way to apply bulk changes to the
991 * live tree. In case of an error, changes are rolled-back.
992 * changesets live on after initial application, and if not
993 * destroyed after use, they can be reverted in one single call.
995 struct of_changeset {
996 struct list_head entries;
999 enum of_reconfig_change {
1000 OF_RECONFIG_NO_CHANGE = 0,
1001 OF_RECONFIG_CHANGE_ADD,
1002 OF_RECONFIG_CHANGE_REMOVE,
1005 #ifdef CONFIG_OF_DYNAMIC
1006 extern int of_reconfig_notifier_register(struct notifier_block *);
1007 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1008 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1009 extern int of_reconfig_get_state_change(unsigned long action,
1010 struct of_reconfig_data *arg);
1012 extern void of_changeset_init(struct of_changeset *ocs);
1013 extern void of_changeset_destroy(struct of_changeset *ocs);
1014 extern int of_changeset_apply(struct of_changeset *ocs);
1015 extern int of_changeset_revert(struct of_changeset *ocs);
1016 extern int of_changeset_action(struct of_changeset *ocs,
1017 unsigned long action, struct device_node *np,
1018 struct property *prop);
1020 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1021 struct device_node *np)
1023 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1026 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1027 struct device_node *np)
1029 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1032 static inline int of_changeset_add_property(struct of_changeset *ocs,
1033 struct device_node *np, struct property *prop)
1035 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1038 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1039 struct device_node *np, struct property *prop)
1041 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1044 static inline int of_changeset_update_property(struct of_changeset *ocs,
1045 struct device_node *np, struct property *prop)
1047 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1049 #else /* CONFIG_OF_DYNAMIC */
1050 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1054 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1058 static inline int of_reconfig_notify(unsigned long action,
1059 struct of_reconfig_data *arg)
1063 static inline int of_reconfig_get_state_change(unsigned long action,
1064 struct of_reconfig_data *arg)
1068 #endif /* CONFIG_OF_DYNAMIC */
1070 /* CONFIG_OF_RESOLVE api */
1071 extern int of_resolve_phandles(struct device_node *tree);
1074 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1075 * @np: Pointer to the given device_node
1077 * return true if present false otherwise
1079 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1081 return of_property_read_bool(np, "system-power-controller");
1088 #ifdef CONFIG_OF_OVERLAY
1090 /* ID based overlays; the API for external users */
1091 int of_overlay_create(struct device_node *tree);
1092 int of_overlay_destroy(int id);
1093 int of_overlay_destroy_all(void);
1097 static inline int of_overlay_create(struct device_node *tree)
1102 static inline int of_overlay_destroy(int id)
1107 static inline int of_overlay_destroy_all(void)
1114 #endif /* _LINUX_OF_H */