1 /* SPDX-License-Identifier: GPL-2.0+ */
5 * Definitions for talking to the Open Firmware PROM on
6 * Power Macintosh and other computers.
8 * Copyright (C) 1996-2005 Paul Mackerras.
10 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
11 * Updates for SPARC64 by David S. Miller
12 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
14 #include <linux/types.h>
15 #include <linux/bitops.h>
16 #include <linux/errno.h>
17 #include <linux/kobject.h>
18 #include <linux/mod_devicetable.h>
19 #include <linux/spinlock.h>
20 #include <linux/topology.h>
21 #include <linux/notifier.h>
22 #include <linux/property.h>
23 #include <linux/list.h>
25 #include <asm/byteorder.h>
26 #include <asm/errno.h>
35 struct property *next;
36 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
39 #if defined(CONFIG_OF_PROMTREE)
40 unsigned int unique_id;
42 #if defined(CONFIG_OF_KOBJ)
43 struct bin_attribute attr;
47 #if defined(CONFIG_SPARC)
48 struct of_irq_controller;
55 const char *full_name;
56 struct fwnode_handle fwnode;
58 struct property *properties;
59 struct property *deadprops; /* removed properties */
60 struct device_node *parent;
61 struct device_node *child;
62 struct device_node *sibling;
63 #if defined(CONFIG_OF_KOBJ)
68 #if defined(CONFIG_SPARC)
69 const char *path_component_name;
70 unsigned int unique_id;
71 struct of_irq_controller *irq_trans;
75 #define MAX_PHANDLE_ARGS 16
76 struct of_phandle_args {
77 struct device_node *np;
79 uint32_t args[MAX_PHANDLE_ARGS];
82 struct of_phandle_iterator {
83 /* Common iterator information */
84 const char *cells_name;
86 const struct device_node *parent;
88 /* List size information */
89 const __be32 *list_end;
90 const __be32 *phandle_end;
92 /* Current position state */
96 struct device_node *node;
99 struct of_reconfig_data {
100 struct device_node *dn;
101 struct property *prop;
102 struct property *old_prop;
105 /* initialize a node */
106 extern struct kobj_type of_node_ktype;
107 extern const struct fwnode_operations of_fwnode_ops;
108 static inline void of_node_init(struct device_node *node)
110 #if defined(CONFIG_OF_KOBJ)
111 kobject_init(&node->kobj, &of_node_ktype);
113 node->fwnode.ops = &of_fwnode_ops;
116 #if defined(CONFIG_OF_KOBJ)
117 #define of_node_kobj(n) (&(n)->kobj)
119 #define of_node_kobj(n) NULL
122 #ifdef CONFIG_OF_DYNAMIC
123 extern struct device_node *of_node_get(struct device_node *node);
124 extern void of_node_put(struct device_node *node);
125 #else /* CONFIG_OF_DYNAMIC */
126 /* Dummy ref counting routines - to be implemented later */
127 static inline struct device_node *of_node_get(struct device_node *node)
131 static inline void of_node_put(struct device_node *node) { }
132 #endif /* !CONFIG_OF_DYNAMIC */
134 /* Pointer for first entry in chain of all nodes. */
135 extern struct device_node *of_root;
136 extern struct device_node *of_chosen;
137 extern struct device_node *of_aliases;
138 extern struct device_node *of_stdout;
139 extern raw_spinlock_t devtree_lock;
142 * struct device_node flag descriptions
143 * (need to be visible even when !CONFIG_OF)
145 #define OF_DYNAMIC 1 /* (and properties) allocated via kmalloc */
146 #define OF_DETACHED 2 /* detached from the device tree */
147 #define OF_POPULATED 3 /* device already created */
148 #define OF_POPULATED_BUS 4 /* platform bus created for children */
149 #define OF_OVERLAY 5 /* allocated for an overlay */
150 #define OF_OVERLAY_FREE_CSET 6 /* in overlay cset being freed */
152 #define OF_BAD_ADDR ((u64)-1)
155 void of_core_init(void);
157 static inline bool is_of_node(const struct fwnode_handle *fwnode)
159 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &of_fwnode_ops;
162 #define to_of_node(__fwnode) \
164 typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \
166 is_of_node(__to_of_node_fwnode) ? \
167 container_of(__to_of_node_fwnode, \
168 struct device_node, fwnode) : \
172 #define of_fwnode_handle(node) \
174 typeof(node) __of_fwnode_handle_node = (node); \
176 __of_fwnode_handle_node ? \
177 &__of_fwnode_handle_node->fwnode : NULL; \
180 static inline bool of_have_populated_dt(void)
182 return of_root != NULL;
185 static inline bool of_node_is_root(const struct device_node *node)
187 return node && (node->parent == NULL);
190 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
192 return test_bit(flag, &n->_flags);
195 static inline int of_node_test_and_set_flag(struct device_node *n,
198 return test_and_set_bit(flag, &n->_flags);
201 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
203 set_bit(flag, &n->_flags);
206 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
208 clear_bit(flag, &n->_flags);
211 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
212 static inline int of_property_check_flag(struct property *p, unsigned long flag)
214 return test_bit(flag, &p->_flags);
217 static inline void of_property_set_flag(struct property *p, unsigned long flag)
219 set_bit(flag, &p->_flags);
222 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
224 clear_bit(flag, &p->_flags);
228 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
229 extern struct device_node *of_find_all_nodes(struct device_node *prev);
232 * OF address retrieval & translation
235 /* Helper to read a big number; size is in cells (not bytes) */
236 static inline u64 of_read_number(const __be32 *cell, int size)
240 r = (r << 32) | be32_to_cpu(*(cell++));
244 /* Like of_read_number, but we want an unsigned long result */
245 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
247 /* toss away upper bits if unsigned long is smaller than u64 */
248 return of_read_number(cell, size);
251 #if defined(CONFIG_SPARC)
252 #include <asm/prom.h>
255 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
256 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
258 extern bool of_node_name_eq(const struct device_node *np, const char *name);
259 extern bool of_node_name_prefix(const struct device_node *np, const char *prefix);
261 static inline const char *of_node_full_name(const struct device_node *np)
263 return np ? np->full_name : "<no-node>";
266 #define for_each_of_allnodes_from(from, dn) \
267 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
268 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
269 extern struct device_node *of_find_node_by_name(struct device_node *from,
271 extern struct device_node *of_find_node_by_type(struct device_node *from,
273 extern struct device_node *of_find_compatible_node(struct device_node *from,
274 const char *type, const char *compat);
275 extern struct device_node *of_find_matching_node_and_match(
276 struct device_node *from,
277 const struct of_device_id *matches,
278 const struct of_device_id **match);
280 extern struct device_node *of_find_node_opts_by_path(const char *path,
282 static inline struct device_node *of_find_node_by_path(const char *path)
284 return of_find_node_opts_by_path(path, NULL);
287 extern struct device_node *of_find_node_by_phandle(phandle handle);
288 extern struct device_node *of_get_parent(const struct device_node *node);
289 extern struct device_node *of_get_next_parent(struct device_node *node);
290 extern struct device_node *of_get_next_child(const struct device_node *node,
291 struct device_node *prev);
292 extern struct device_node *of_get_next_available_child(
293 const struct device_node *node, struct device_node *prev);
295 extern struct device_node *of_get_compatible_child(const struct device_node *parent,
296 const char *compatible);
297 extern struct device_node *of_get_child_by_name(const struct device_node *node,
301 extern struct device_node *of_find_next_cache_node(const struct device_node *);
302 extern int of_find_last_cache_level(unsigned int cpu);
303 extern struct device_node *of_find_node_with_property(
304 struct device_node *from, const char *prop_name);
306 extern struct property *of_find_property(const struct device_node *np,
309 extern int of_property_count_elems_of_size(const struct device_node *np,
310 const char *propname, int elem_size);
311 extern int of_property_read_u32_index(const struct device_node *np,
312 const char *propname,
313 u32 index, u32 *out_value);
314 extern int of_property_read_u64_index(const struct device_node *np,
315 const char *propname,
316 u32 index, u64 *out_value);
317 extern int of_property_read_variable_u8_array(const struct device_node *np,
318 const char *propname, u8 *out_values,
319 size_t sz_min, size_t sz_max);
320 extern int of_property_read_variable_u16_array(const struct device_node *np,
321 const char *propname, u16 *out_values,
322 size_t sz_min, size_t sz_max);
323 extern int of_property_read_variable_u32_array(const struct device_node *np,
324 const char *propname,
328 extern int of_property_read_u64(const struct device_node *np,
329 const char *propname, u64 *out_value);
330 extern int of_property_read_variable_u64_array(const struct device_node *np,
331 const char *propname,
336 extern int of_property_read_string(const struct device_node *np,
337 const char *propname,
338 const char **out_string);
339 extern int of_property_match_string(const struct device_node *np,
340 const char *propname,
342 extern int of_property_read_string_helper(const struct device_node *np,
343 const char *propname,
344 const char **out_strs, size_t sz, int index);
345 extern int of_device_is_compatible(const struct device_node *device,
347 extern int of_device_compatible_match(struct device_node *device,
348 const char *const *compat);
349 extern bool of_device_is_available(const struct device_node *device);
350 extern bool of_device_is_big_endian(const struct device_node *device);
351 extern const void *of_get_property(const struct device_node *node,
354 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
355 extern struct device_node *of_get_next_cpu_node(struct device_node *prev);
357 #define for_each_property_of_node(dn, pp) \
358 for (pp = dn->properties; pp != NULL; pp = pp->next)
360 extern int of_n_addr_cells(struct device_node *np);
361 extern int of_n_size_cells(struct device_node *np);
362 extern const struct of_device_id *of_match_node(
363 const struct of_device_id *matches, const struct device_node *node);
364 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
365 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
366 extern struct device_node *of_parse_phandle(const struct device_node *np,
367 const char *phandle_name,
369 extern int of_parse_phandle_with_args(const struct device_node *np,
370 const char *list_name, const char *cells_name, int index,
371 struct of_phandle_args *out_args);
372 extern int of_parse_phandle_with_args_map(const struct device_node *np,
373 const char *list_name, const char *stem_name, int index,
374 struct of_phandle_args *out_args);
375 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
376 const char *list_name, int cells_count, int index,
377 struct of_phandle_args *out_args);
378 extern int of_count_phandle_with_args(const struct device_node *np,
379 const char *list_name, const char *cells_name);
381 /* phandle iterator functions */
382 extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
383 const struct device_node *np,
384 const char *list_name,
385 const char *cells_name,
388 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
389 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
393 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
394 extern int of_alias_get_id(struct device_node *np, const char *stem);
395 extern int of_alias_get_highest_id(const char *stem);
396 extern int of_alias_get_alias_list(const struct of_device_id *matches,
397 const char *stem, unsigned long *bitmap,
400 extern int of_machine_is_compatible(const char *compat);
402 extern int of_add_property(struct device_node *np, struct property *prop);
403 extern int of_remove_property(struct device_node *np, struct property *prop);
404 extern int of_update_property(struct device_node *np, struct property *newprop);
406 /* For updating the device tree at runtime */
407 #define OF_RECONFIG_ATTACH_NODE 0x0001
408 #define OF_RECONFIG_DETACH_NODE 0x0002
409 #define OF_RECONFIG_ADD_PROPERTY 0x0003
410 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
411 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
413 extern int of_attach_node(struct device_node *);
414 extern int of_detach_node(struct device_node *);
416 #define of_match_ptr(_ptr) (_ptr)
419 * of_property_read_u8_array - Find and read an array of u8 from a property.
421 * @np: device node from which the property value is to be read.
422 * @propname: name of the property to be searched.
423 * @out_values: pointer to return value, modified only if return value is 0.
424 * @sz: number of array elements to read
426 * Search for a property in a device node and read 8-bit value(s) from
427 * it. Returns 0 on success, -EINVAL if the property does not exist,
428 * -ENODATA if property does not have a value, and -EOVERFLOW if the
429 * property data isn't large enough.
431 * dts entry of array should be like:
432 * property = /bits/ 8 <0x50 0x60 0x70>;
434 * The out_values is modified only if a valid u8 value can be decoded.
436 static inline int of_property_read_u8_array(const struct device_node *np,
437 const char *propname,
438 u8 *out_values, size_t sz)
440 int ret = of_property_read_variable_u8_array(np, propname, out_values,
449 * of_property_read_u16_array - Find and read an array of u16 from a property.
451 * @np: device node from which the property value is to be read.
452 * @propname: name of the property to be searched.
453 * @out_values: pointer to return value, modified only if return value is 0.
454 * @sz: number of array elements to read
456 * Search for a property in a device node and read 16-bit value(s) from
457 * it. Returns 0 on success, -EINVAL if the property does not exist,
458 * -ENODATA if property does not have a value, and -EOVERFLOW if the
459 * property data isn't large enough.
461 * dts entry of array should be like:
462 * property = /bits/ 16 <0x5000 0x6000 0x7000>;
464 * The out_values is modified only if a valid u16 value can be decoded.
466 static inline int of_property_read_u16_array(const struct device_node *np,
467 const char *propname,
468 u16 *out_values, size_t sz)
470 int ret = of_property_read_variable_u16_array(np, propname, out_values,
479 * of_property_read_u32_array - Find and read an array of 32 bit integers
482 * @np: device node from which the property value is to be read.
483 * @propname: name of the property to be searched.
484 * @out_values: pointer to return value, modified only if return value is 0.
485 * @sz: number of array elements to read
487 * Search for a property in a device node and read 32-bit value(s) from
488 * it. Returns 0 on success, -EINVAL if the property does not exist,
489 * -ENODATA if property does not have a value, and -EOVERFLOW if the
490 * property data isn't large enough.
492 * The out_values is modified only if a valid u32 value can be decoded.
494 static inline int of_property_read_u32_array(const struct device_node *np,
495 const char *propname,
496 u32 *out_values, size_t sz)
498 int ret = of_property_read_variable_u32_array(np, propname, out_values,
507 * of_property_read_u64_array - Find and read an array of 64 bit integers
510 * @np: device node from which the property value is to be read.
511 * @propname: name of the property to be searched.
512 * @out_values: pointer to return value, modified only if return value is 0.
513 * @sz: number of array elements to read
515 * Search for a property in a device node and read 64-bit value(s) from
516 * it. Returns 0 on success, -EINVAL if the property does not exist,
517 * -ENODATA if property does not have a value, and -EOVERFLOW if the
518 * property data isn't large enough.
520 * The out_values is modified only if a valid u64 value can be decoded.
522 static inline int of_property_read_u64_array(const struct device_node *np,
523 const char *propname,
524 u64 *out_values, size_t sz)
526 int ret = of_property_read_variable_u64_array(np, propname, out_values,
535 * struct property *prop;
539 * of_property_for_each_u32(np, "propname", prop, p, u)
540 * printk("U32 value: %x\n", u);
542 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
545 * struct property *prop;
548 * of_property_for_each_string(np, "propname", prop, s)
549 * printk("String value: %s\n", s);
551 const char *of_prop_next_string(struct property *prop, const char *cur);
553 bool of_console_check(struct device_node *dn, char *name, int index);
555 extern int of_cpu_node_to_id(struct device_node *np);
557 int of_map_rid(struct device_node *np, u32 rid,
558 const char *map_name, const char *map_mask_name,
559 struct device_node **target, u32 *id_out);
561 #else /* CONFIG_OF */
563 static inline void of_core_init(void)
567 static inline bool is_of_node(const struct fwnode_handle *fwnode)
572 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode)
577 static inline bool of_node_name_eq(const struct device_node *np, const char *name)
582 static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix)
587 static inline const char* of_node_full_name(const struct device_node *np)
592 static inline struct device_node *of_find_node_by_name(struct device_node *from,
598 static inline struct device_node *of_find_node_by_type(struct device_node *from,
604 static inline struct device_node *of_find_matching_node_and_match(
605 struct device_node *from,
606 const struct of_device_id *matches,
607 const struct of_device_id **match)
612 static inline struct device_node *of_find_node_by_path(const char *path)
617 static inline struct device_node *of_find_node_opts_by_path(const char *path,
623 static inline struct device_node *of_find_node_by_phandle(phandle handle)
628 static inline struct device_node *of_get_parent(const struct device_node *node)
633 static inline struct device_node *of_get_next_child(
634 const struct device_node *node, struct device_node *prev)
639 static inline struct device_node *of_get_next_available_child(
640 const struct device_node *node, struct device_node *prev)
645 static inline struct device_node *of_find_node_with_property(
646 struct device_node *from, const char *prop_name)
651 #define of_fwnode_handle(node) NULL
653 static inline bool of_have_populated_dt(void)
658 static inline struct device_node *of_get_compatible_child(const struct device_node *parent,
659 const char *compatible)
664 static inline struct device_node *of_get_child_by_name(
665 const struct device_node *node,
671 static inline int of_device_is_compatible(const struct device_node *device,
677 static inline int of_device_compatible_match(struct device_node *device,
678 const char *const *compat)
683 static inline bool of_device_is_available(const struct device_node *device)
688 static inline bool of_device_is_big_endian(const struct device_node *device)
693 static inline struct property *of_find_property(const struct device_node *np,
700 static inline struct device_node *of_find_compatible_node(
701 struct device_node *from,
708 static inline int of_property_count_elems_of_size(const struct device_node *np,
709 const char *propname, int elem_size)
714 static inline int of_property_read_u8_array(const struct device_node *np,
715 const char *propname, u8 *out_values, size_t sz)
720 static inline int of_property_read_u16_array(const struct device_node *np,
721 const char *propname, u16 *out_values, size_t sz)
726 static inline int of_property_read_u32_array(const struct device_node *np,
727 const char *propname,
728 u32 *out_values, size_t sz)
733 static inline int of_property_read_u64_array(const struct device_node *np,
734 const char *propname,
735 u64 *out_values, size_t sz)
740 static inline int of_property_read_u32_index(const struct device_node *np,
741 const char *propname, u32 index, u32 *out_value)
746 static inline int of_property_read_u64_index(const struct device_node *np,
747 const char *propname, u32 index, u64 *out_value)
752 static inline const void *of_get_property(const struct device_node *node,
759 static inline struct device_node *of_get_cpu_node(int cpu,
760 unsigned int *thread)
765 static inline struct device_node *of_get_next_cpu_node(struct device_node *prev)
770 static inline int of_n_addr_cells(struct device_node *np)
775 static inline int of_n_size_cells(struct device_node *np)
780 static inline int of_property_read_variable_u8_array(const struct device_node *np,
781 const char *propname, u8 *out_values,
782 size_t sz_min, size_t sz_max)
787 static inline int of_property_read_variable_u16_array(const struct device_node *np,
788 const char *propname, u16 *out_values,
789 size_t sz_min, size_t sz_max)
794 static inline int of_property_read_variable_u32_array(const struct device_node *np,
795 const char *propname,
803 static inline int of_property_read_u64(const struct device_node *np,
804 const char *propname, u64 *out_value)
809 static inline int of_property_read_variable_u64_array(const struct device_node *np,
810 const char *propname,
818 static inline int of_property_read_string(const struct device_node *np,
819 const char *propname,
820 const char **out_string)
825 static inline int of_property_match_string(const struct device_node *np,
826 const char *propname,
832 static inline int of_property_read_string_helper(const struct device_node *np,
833 const char *propname,
834 const char **out_strs, size_t sz, int index)
839 static inline struct device_node *of_parse_phandle(const struct device_node *np,
840 const char *phandle_name,
846 static inline int of_parse_phandle_with_args(const struct device_node *np,
847 const char *list_name,
848 const char *cells_name,
850 struct of_phandle_args *out_args)
855 static inline int of_parse_phandle_with_args_map(const struct device_node *np,
856 const char *list_name,
857 const char *stem_name,
859 struct of_phandle_args *out_args)
864 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
865 const char *list_name, int cells_count, int index,
866 struct of_phandle_args *out_args)
871 static inline int of_count_phandle_with_args(struct device_node *np,
872 const char *list_name,
873 const char *cells_name)
878 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
879 const struct device_node *np,
880 const char *list_name,
881 const char *cells_name,
887 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
892 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
899 static inline int of_alias_get_id(struct device_node *np, const char *stem)
904 static inline int of_alias_get_highest_id(const char *stem)
909 static inline int of_alias_get_alias_list(const struct of_device_id *matches,
910 const char *stem, unsigned long *bitmap,
916 static inline int of_machine_is_compatible(const char *compat)
921 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
926 static inline const __be32 *of_prop_next_u32(struct property *prop,
927 const __be32 *cur, u32 *pu)
932 static inline const char *of_prop_next_string(struct property *prop,
938 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
943 static inline int of_node_test_and_set_flag(struct device_node *n,
949 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
953 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
957 static inline int of_property_check_flag(struct property *p, unsigned long flag)
962 static inline void of_property_set_flag(struct property *p, unsigned long flag)
966 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
970 static inline int of_cpu_node_to_id(struct device_node *np)
975 static inline int of_map_rid(struct device_node *np, u32 rid,
976 const char *map_name, const char *map_mask_name,
977 struct device_node **target, u32 *id_out)
982 #define of_match_ptr(_ptr) NULL
983 #define of_match_node(_matches, _node) NULL
984 #endif /* CONFIG_OF */
986 /* Default string compare functions, Allow arch asm/prom.h to override */
987 #if !defined(of_compat_cmp)
988 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
989 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
990 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
993 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
994 extern int of_node_to_nid(struct device_node *np);
996 static inline int of_node_to_nid(struct device_node *device)
1002 #ifdef CONFIG_OF_NUMA
1003 extern int of_numa_init(void);
1005 static inline int of_numa_init(void)
1011 static inline struct device_node *of_find_matching_node(
1012 struct device_node *from,
1013 const struct of_device_id *matches)
1015 return of_find_matching_node_and_match(from, matches, NULL);
1018 static inline const char *of_node_get_device_type(const struct device_node *np)
1020 return of_get_property(np, "device_type", NULL);
1023 static inline bool of_node_is_type(const struct device_node *np, const char *type)
1025 const char *match = of_node_get_device_type(np);
1027 return np && match && type && !strcmp(match, type);
1031 * of_property_count_u8_elems - Count the number of u8 elements in a property
1033 * @np: device node from which the property value is to be read.
1034 * @propname: name of the property to be searched.
1036 * Search for a property in a device node and count the number of u8 elements
1037 * in it. Returns number of elements on sucess, -EINVAL if the property does
1038 * not exist or its length does not match a multiple of u8 and -ENODATA if the
1039 * property does not have a value.
1041 static inline int of_property_count_u8_elems(const struct device_node *np,
1042 const char *propname)
1044 return of_property_count_elems_of_size(np, propname, sizeof(u8));
1048 * of_property_count_u16_elems - Count the number of u16 elements in a property
1050 * @np: device node from which the property value is to be read.
1051 * @propname: name of the property to be searched.
1053 * Search for a property in a device node and count the number of u16 elements
1054 * in it. Returns number of elements on sucess, -EINVAL if the property does
1055 * not exist or its length does not match a multiple of u16 and -ENODATA if the
1056 * property does not have a value.
1058 static inline int of_property_count_u16_elems(const struct device_node *np,
1059 const char *propname)
1061 return of_property_count_elems_of_size(np, propname, sizeof(u16));
1065 * of_property_count_u32_elems - Count the number of u32 elements in a property
1067 * @np: device node from which the property value is to be read.
1068 * @propname: name of the property to be searched.
1070 * Search for a property in a device node and count the number of u32 elements
1071 * in it. Returns number of elements on sucess, -EINVAL if the property does
1072 * not exist or its length does not match a multiple of u32 and -ENODATA if the
1073 * property does not have a value.
1075 static inline int of_property_count_u32_elems(const struct device_node *np,
1076 const char *propname)
1078 return of_property_count_elems_of_size(np, propname, sizeof(u32));
1082 * of_property_count_u64_elems - Count the number of u64 elements in a property
1084 * @np: device node from which the property value is to be read.
1085 * @propname: name of the property to be searched.
1087 * Search for a property in a device node and count the number of u64 elements
1088 * in it. Returns number of elements on sucess, -EINVAL if the property does
1089 * not exist or its length does not match a multiple of u64 and -ENODATA if the
1090 * property does not have a value.
1092 static inline int of_property_count_u64_elems(const struct device_node *np,
1093 const char *propname)
1095 return of_property_count_elems_of_size(np, propname, sizeof(u64));
1099 * of_property_read_string_array() - Read an array of strings from a multiple
1101 * @np: device node from which the property value is to be read.
1102 * @propname: name of the property to be searched.
1103 * @out_strs: output array of string pointers.
1104 * @sz: number of array elements to read.
1106 * Search for a property in a device tree node and retrieve a list of
1107 * terminated string values (pointer to data, not a copy) in that property.
1109 * If @out_strs is NULL, the number of strings in the property is returned.
1111 static inline int of_property_read_string_array(const struct device_node *np,
1112 const char *propname, const char **out_strs,
1115 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1119 * of_property_count_strings() - Find and return the number of strings from a
1120 * multiple strings property.
1121 * @np: device node from which the property value is to be read.
1122 * @propname: name of the property to be searched.
1124 * Search for a property in a device tree node and retrieve the number of null
1125 * terminated string contain in it. Returns the number of strings on
1126 * success, -EINVAL if the property does not exist, -ENODATA if property
1127 * does not have a value, and -EILSEQ if the string is not null-terminated
1128 * within the length of the property data.
1130 static inline int of_property_count_strings(const struct device_node *np,
1131 const char *propname)
1133 return of_property_read_string_helper(np, propname, NULL, 0, 0);
1137 * of_property_read_string_index() - Find and read a string from a multiple
1139 * @np: device node from which the property value is to be read.
1140 * @propname: name of the property to be searched.
1141 * @index: index of the string in the list of strings
1142 * @out_string: pointer to null terminated return string, modified only if
1143 * return value is 0.
1145 * Search for a property in a device tree node and retrieve a null
1146 * terminated string value (pointer to data, not a copy) in the list of strings
1147 * contained in that property.
1148 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1149 * property does not have a value, and -EILSEQ if the string is not
1150 * null-terminated within the length of the property data.
1152 * The out_string pointer is modified only if a valid string can be decoded.
1154 static inline int of_property_read_string_index(const struct device_node *np,
1155 const char *propname,
1156 int index, const char **output)
1158 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1159 return rc < 0 ? rc : 0;
1163 * of_property_read_bool - Findfrom a property
1164 * @np: device node from which the property value is to be read.
1165 * @propname: name of the property to be searched.
1167 * Search for a property in a device node.
1168 * Returns true if the property exists false otherwise.
1170 static inline bool of_property_read_bool(const struct device_node *np,
1171 const char *propname)
1173 struct property *prop = of_find_property(np, propname, NULL);
1175 return prop ? true : false;
1178 static inline int of_property_read_u8(const struct device_node *np,
1179 const char *propname,
1182 return of_property_read_u8_array(np, propname, out_value, 1);
1185 static inline int of_property_read_u16(const struct device_node *np,
1186 const char *propname,
1189 return of_property_read_u16_array(np, propname, out_value, 1);
1192 static inline int of_property_read_u32(const struct device_node *np,
1193 const char *propname,
1196 return of_property_read_u32_array(np, propname, out_value, 1);
1199 static inline int of_property_read_s32(const struct device_node *np,
1200 const char *propname,
1203 return of_property_read_u32(np, propname, (u32*) out_value);
1206 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1207 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1208 err = of_phandle_iterator_next(it); \
1210 err = of_phandle_iterator_next(it))
1212 #define of_property_for_each_u32(np, propname, prop, p, u) \
1213 for (prop = of_find_property(np, propname, NULL), \
1214 p = of_prop_next_u32(prop, NULL, &u); \
1216 p = of_prop_next_u32(prop, p, &u))
1218 #define of_property_for_each_string(np, propname, prop, s) \
1219 for (prop = of_find_property(np, propname, NULL), \
1220 s = of_prop_next_string(prop, NULL); \
1222 s = of_prop_next_string(prop, s))
1224 #define for_each_node_by_name(dn, name) \
1225 for (dn = of_find_node_by_name(NULL, name); dn; \
1226 dn = of_find_node_by_name(dn, name))
1227 #define for_each_node_by_type(dn, type) \
1228 for (dn = of_find_node_by_type(NULL, type); dn; \
1229 dn = of_find_node_by_type(dn, type))
1230 #define for_each_compatible_node(dn, type, compatible) \
1231 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1232 dn = of_find_compatible_node(dn, type, compatible))
1233 #define for_each_matching_node(dn, matches) \
1234 for (dn = of_find_matching_node(NULL, matches); dn; \
1235 dn = of_find_matching_node(dn, matches))
1236 #define for_each_matching_node_and_match(dn, matches, match) \
1237 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1238 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1240 #define for_each_child_of_node(parent, child) \
1241 for (child = of_get_next_child(parent, NULL); child != NULL; \
1242 child = of_get_next_child(parent, child))
1243 #define for_each_available_child_of_node(parent, child) \
1244 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1245 child = of_get_next_available_child(parent, child))
1247 #define for_each_of_cpu_node(cpu) \
1248 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1249 cpu = of_get_next_cpu_node(cpu))
1251 #define for_each_node_with_property(dn, prop_name) \
1252 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1253 dn = of_find_node_with_property(dn, prop_name))
1255 static inline int of_get_child_count(const struct device_node *np)
1257 struct device_node *child;
1260 for_each_child_of_node(np, child)
1266 static inline int of_get_available_child_count(const struct device_node *np)
1268 struct device_node *child;
1271 for_each_available_child_of_node(np, child)
1277 #if defined(CONFIG_OF) && !defined(MODULE)
1278 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1279 static const struct of_device_id __of_table_##name \
1280 __used __section(__##table##_of_table) \
1281 = { .compatible = compat, \
1282 .data = (fn == (fn_type)NULL) ? fn : fn }
1284 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1285 static const struct of_device_id __of_table_##name \
1286 __attribute__((unused)) \
1287 = { .compatible = compat, \
1288 .data = (fn == (fn_type)NULL) ? fn : fn }
1291 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1292 typedef int (*of_init_fn_1_ret)(struct device_node *);
1293 typedef void (*of_init_fn_1)(struct device_node *);
1295 #define OF_DECLARE_1(table, name, compat, fn) \
1296 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1297 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1298 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1299 #define OF_DECLARE_2(table, name, compat, fn) \
1300 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1303 * struct of_changeset_entry - Holds a changeset entry
1305 * @node: list_head for the log list
1306 * @action: notifier action
1307 * @np: pointer to the device node affected
1308 * @prop: pointer to the property affected
1309 * @old_prop: hold a pointer to the original property
1311 * Every modification of the device tree during a changeset
1312 * is held in a list of of_changeset_entry structures.
1313 * That way we can recover from a partial application, or we can
1314 * revert the changeset
1316 struct of_changeset_entry {
1317 struct list_head node;
1318 unsigned long action;
1319 struct device_node *np;
1320 struct property *prop;
1321 struct property *old_prop;
1325 * struct of_changeset - changeset tracker structure
1327 * @entries: list_head for the changeset entries
1329 * changesets are a convenient way to apply bulk changes to the
1330 * live tree. In case of an error, changes are rolled-back.
1331 * changesets live on after initial application, and if not
1332 * destroyed after use, they can be reverted in one single call.
1334 struct of_changeset {
1335 struct list_head entries;
1338 enum of_reconfig_change {
1339 OF_RECONFIG_NO_CHANGE = 0,
1340 OF_RECONFIG_CHANGE_ADD,
1341 OF_RECONFIG_CHANGE_REMOVE,
1344 #ifdef CONFIG_OF_DYNAMIC
1345 extern int of_reconfig_notifier_register(struct notifier_block *);
1346 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1347 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1348 extern int of_reconfig_get_state_change(unsigned long action,
1349 struct of_reconfig_data *arg);
1351 extern void of_changeset_init(struct of_changeset *ocs);
1352 extern void of_changeset_destroy(struct of_changeset *ocs);
1353 extern int of_changeset_apply(struct of_changeset *ocs);
1354 extern int of_changeset_revert(struct of_changeset *ocs);
1355 extern int of_changeset_action(struct of_changeset *ocs,
1356 unsigned long action, struct device_node *np,
1357 struct property *prop);
1359 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1360 struct device_node *np)
1362 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1365 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1366 struct device_node *np)
1368 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1371 static inline int of_changeset_add_property(struct of_changeset *ocs,
1372 struct device_node *np, struct property *prop)
1374 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1377 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1378 struct device_node *np, struct property *prop)
1380 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1383 static inline int of_changeset_update_property(struct of_changeset *ocs,
1384 struct device_node *np, struct property *prop)
1386 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1388 #else /* CONFIG_OF_DYNAMIC */
1389 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1393 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1397 static inline int of_reconfig_notify(unsigned long action,
1398 struct of_reconfig_data *arg)
1402 static inline int of_reconfig_get_state_change(unsigned long action,
1403 struct of_reconfig_data *arg)
1407 #endif /* CONFIG_OF_DYNAMIC */
1410 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1411 * @np: Pointer to the given device_node
1413 * return true if present false otherwise
1415 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1417 return of_property_read_bool(np, "system-power-controller");
1424 enum of_overlay_notify_action {
1425 OF_OVERLAY_PRE_APPLY = 0,
1426 OF_OVERLAY_POST_APPLY,
1427 OF_OVERLAY_PRE_REMOVE,
1428 OF_OVERLAY_POST_REMOVE,
1431 struct of_overlay_notify_data {
1432 struct device_node *overlay;
1433 struct device_node *target;
1436 #ifdef CONFIG_OF_OVERLAY
1438 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1440 int of_overlay_remove(int *ovcs_id);
1441 int of_overlay_remove_all(void);
1443 int of_overlay_notifier_register(struct notifier_block *nb);
1444 int of_overlay_notifier_unregister(struct notifier_block *nb);
1448 static inline int of_overlay_fdt_apply(void *overlay_fdt, int *ovcs_id)
1453 static inline int of_overlay_remove(int *ovcs_id)
1458 static inline int of_overlay_remove_all(void)
1463 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1468 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1475 #endif /* _LINUX_OF_H */