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;
54 const char *full_name;
55 struct fwnode_handle fwnode;
57 struct property *properties;
58 struct property *deadprops; /* removed properties */
59 struct device_node *parent;
60 struct device_node *child;
61 struct device_node *sibling;
62 #if defined(CONFIG_OF_KOBJ)
67 #if defined(CONFIG_SPARC)
68 unsigned int unique_id;
69 struct of_irq_controller *irq_trans;
73 #define MAX_PHANDLE_ARGS 16
74 struct of_phandle_args {
75 struct device_node *np;
77 uint32_t args[MAX_PHANDLE_ARGS];
80 struct of_phandle_iterator {
81 /* Common iterator information */
82 const char *cells_name;
84 const struct device_node *parent;
86 /* List size information */
87 const __be32 *list_end;
88 const __be32 *phandle_end;
90 /* Current position state */
94 struct device_node *node;
97 struct of_reconfig_data {
98 struct device_node *dn;
99 struct property *prop;
100 struct property *old_prop;
103 /* initialize a node */
104 extern struct kobj_type of_node_ktype;
105 extern const struct fwnode_operations of_fwnode_ops;
106 static inline void of_node_init(struct device_node *node)
108 #if defined(CONFIG_OF_KOBJ)
109 kobject_init(&node->kobj, &of_node_ktype);
111 node->fwnode.ops = &of_fwnode_ops;
114 #if defined(CONFIG_OF_KOBJ)
115 #define of_node_kobj(n) (&(n)->kobj)
117 #define of_node_kobj(n) NULL
120 #ifdef CONFIG_OF_DYNAMIC
121 extern struct device_node *of_node_get(struct device_node *node);
122 extern void of_node_put(struct device_node *node);
123 #else /* CONFIG_OF_DYNAMIC */
124 /* Dummy ref counting routines - to be implemented later */
125 static inline struct device_node *of_node_get(struct device_node *node)
129 static inline void of_node_put(struct device_node *node) { }
130 #endif /* !CONFIG_OF_DYNAMIC */
132 /* Pointer for first entry in chain of all nodes. */
133 extern struct device_node *of_root;
134 extern struct device_node *of_chosen;
135 extern struct device_node *of_aliases;
136 extern struct device_node *of_stdout;
137 extern raw_spinlock_t devtree_lock;
140 * struct device_node flag descriptions
141 * (need to be visible even when !CONFIG_OF)
143 #define OF_DYNAMIC 1 /* (and properties) allocated via kmalloc */
144 #define OF_DETACHED 2 /* detached from the device tree */
145 #define OF_POPULATED 3 /* device already created */
146 #define OF_POPULATED_BUS 4 /* platform bus created for children */
147 #define OF_OVERLAY 5 /* allocated for an overlay */
148 #define OF_OVERLAY_FREE_CSET 6 /* in overlay cset being freed */
150 #define OF_BAD_ADDR ((u64)-1)
153 void of_core_init(void);
155 static inline bool is_of_node(const struct fwnode_handle *fwnode)
157 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &of_fwnode_ops;
160 #define to_of_node(__fwnode) \
162 typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \
164 is_of_node(__to_of_node_fwnode) ? \
165 container_of(__to_of_node_fwnode, \
166 struct device_node, fwnode) : \
170 #define of_fwnode_handle(node) \
172 typeof(node) __of_fwnode_handle_node = (node); \
174 __of_fwnode_handle_node ? \
175 &__of_fwnode_handle_node->fwnode : NULL; \
178 static inline bool of_have_populated_dt(void)
180 return of_root != NULL;
183 static inline bool of_node_is_root(const struct device_node *node)
185 return node && (node->parent == NULL);
188 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
190 return test_bit(flag, &n->_flags);
193 static inline int of_node_test_and_set_flag(struct device_node *n,
196 return test_and_set_bit(flag, &n->_flags);
199 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
201 set_bit(flag, &n->_flags);
204 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
206 clear_bit(flag, &n->_flags);
209 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
210 static inline int of_property_check_flag(struct property *p, unsigned long flag)
212 return test_bit(flag, &p->_flags);
215 static inline void of_property_set_flag(struct property *p, unsigned long flag)
217 set_bit(flag, &p->_flags);
220 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
222 clear_bit(flag, &p->_flags);
226 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
227 extern struct device_node *of_find_all_nodes(struct device_node *prev);
230 * OF address retrieval & translation
233 /* Helper to read a big number; size is in cells (not bytes) */
234 static inline u64 of_read_number(const __be32 *cell, int size)
237 for (; size--; cell++)
238 r = (r << 32) | be32_to_cpu(*cell);
242 /* Like of_read_number, but we want an unsigned long result */
243 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
245 /* toss away upper bits if unsigned long is smaller than u64 */
246 return of_read_number(cell, size);
249 #if defined(CONFIG_SPARC)
250 #include <asm/prom.h>
253 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
254 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
256 extern bool of_node_name_eq(const struct device_node *np, const char *name);
257 extern bool of_node_name_prefix(const struct device_node *np, const char *prefix);
259 static inline const char *of_node_full_name(const struct device_node *np)
261 return np ? np->full_name : "<no-node>";
264 #define for_each_of_allnodes_from(from, dn) \
265 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
266 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
267 extern struct device_node *of_find_node_by_name(struct device_node *from,
269 extern struct device_node *of_find_node_by_type(struct device_node *from,
271 extern struct device_node *of_find_compatible_node(struct device_node *from,
272 const char *type, const char *compat);
273 extern struct device_node *of_find_matching_node_and_match(
274 struct device_node *from,
275 const struct of_device_id *matches,
276 const struct of_device_id **match);
278 extern struct device_node *of_find_node_opts_by_path(const char *path,
280 static inline struct device_node *of_find_node_by_path(const char *path)
282 return of_find_node_opts_by_path(path, NULL);
285 extern struct device_node *of_find_node_by_phandle(phandle handle);
286 extern struct device_node *of_get_parent(const struct device_node *node);
287 extern struct device_node *of_get_next_parent(struct device_node *node);
288 extern struct device_node *of_get_next_child(const struct device_node *node,
289 struct device_node *prev);
290 extern struct device_node *of_get_next_available_child(
291 const struct device_node *node, struct device_node *prev);
293 extern struct device_node *of_get_compatible_child(const struct device_node *parent,
294 const char *compatible);
295 extern struct device_node *of_get_child_by_name(const struct device_node *node,
299 extern struct device_node *of_find_next_cache_node(const struct device_node *);
300 extern int of_find_last_cache_level(unsigned int cpu);
301 extern struct device_node *of_find_node_with_property(
302 struct device_node *from, const char *prop_name);
304 extern struct property *of_find_property(const struct device_node *np,
307 extern int of_property_count_elems_of_size(const struct device_node *np,
308 const char *propname, int elem_size);
309 extern int of_property_read_u32_index(const struct device_node *np,
310 const char *propname,
311 u32 index, u32 *out_value);
312 extern int of_property_read_u64_index(const struct device_node *np,
313 const char *propname,
314 u32 index, u64 *out_value);
315 extern int of_property_read_variable_u8_array(const struct device_node *np,
316 const char *propname, u8 *out_values,
317 size_t sz_min, size_t sz_max);
318 extern int of_property_read_variable_u16_array(const struct device_node *np,
319 const char *propname, u16 *out_values,
320 size_t sz_min, size_t sz_max);
321 extern int of_property_read_variable_u32_array(const struct device_node *np,
322 const char *propname,
326 extern int of_property_read_u64(const struct device_node *np,
327 const char *propname, u64 *out_value);
328 extern int of_property_read_variable_u64_array(const struct device_node *np,
329 const char *propname,
334 extern int of_property_read_string(const struct device_node *np,
335 const char *propname,
336 const char **out_string);
337 extern int of_property_match_string(const struct device_node *np,
338 const char *propname,
340 extern int of_property_read_string_helper(const struct device_node *np,
341 const char *propname,
342 const char **out_strs, size_t sz, int index);
343 extern int of_device_is_compatible(const struct device_node *device,
345 extern int of_device_compatible_match(struct device_node *device,
346 const char *const *compat);
347 extern bool of_device_is_available(const struct device_node *device);
348 extern bool of_device_is_big_endian(const struct device_node *device);
349 extern const void *of_get_property(const struct device_node *node,
352 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
353 extern struct device_node *of_get_next_cpu_node(struct device_node *prev);
354 extern struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
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 * struct property *prop;
423 * of_property_for_each_u32(np, "propname", prop, p, u)
424 * printk("U32 value: %x\n", u);
426 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
429 * struct property *prop;
432 * of_property_for_each_string(np, "propname", prop, s)
433 * printk("String value: %s\n", s);
435 const char *of_prop_next_string(struct property *prop, const char *cur);
437 bool of_console_check(struct device_node *dn, char *name, int index);
439 extern int of_cpu_node_to_id(struct device_node *np);
441 int of_map_id(struct device_node *np, u32 id,
442 const char *map_name, const char *map_mask_name,
443 struct device_node **target, u32 *id_out);
445 phys_addr_t of_dma_get_max_cpu_address(struct device_node *np);
447 #else /* CONFIG_OF */
449 static inline void of_core_init(void)
453 static inline bool is_of_node(const struct fwnode_handle *fwnode)
458 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode)
463 static inline bool of_node_name_eq(const struct device_node *np, const char *name)
468 static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix)
473 static inline const char* of_node_full_name(const struct device_node *np)
478 static inline struct device_node *of_find_node_by_name(struct device_node *from,
484 static inline struct device_node *of_find_node_by_type(struct device_node *from,
490 static inline struct device_node *of_find_matching_node_and_match(
491 struct device_node *from,
492 const struct of_device_id *matches,
493 const struct of_device_id **match)
498 static inline struct device_node *of_find_node_by_path(const char *path)
503 static inline struct device_node *of_find_node_opts_by_path(const char *path,
509 static inline struct device_node *of_find_node_by_phandle(phandle handle)
514 static inline struct device_node *of_get_parent(const struct device_node *node)
519 static inline struct device_node *of_get_next_parent(struct device_node *node)
524 static inline struct device_node *of_get_next_child(
525 const struct device_node *node, struct device_node *prev)
530 static inline struct device_node *of_get_next_available_child(
531 const struct device_node *node, struct device_node *prev)
536 static inline struct device_node *of_find_node_with_property(
537 struct device_node *from, const char *prop_name)
542 #define of_fwnode_handle(node) NULL
544 static inline bool of_have_populated_dt(void)
549 static inline struct device_node *of_get_compatible_child(const struct device_node *parent,
550 const char *compatible)
555 static inline struct device_node *of_get_child_by_name(
556 const struct device_node *node,
562 static inline int of_device_is_compatible(const struct device_node *device,
568 static inline int of_device_compatible_match(struct device_node *device,
569 const char *const *compat)
574 static inline bool of_device_is_available(const struct device_node *device)
579 static inline bool of_device_is_big_endian(const struct device_node *device)
584 static inline struct property *of_find_property(const struct device_node *np,
591 static inline struct device_node *of_find_compatible_node(
592 struct device_node *from,
599 static inline int of_property_count_elems_of_size(const struct device_node *np,
600 const char *propname, int elem_size)
605 static inline int of_property_read_u32_index(const struct device_node *np,
606 const char *propname, u32 index, u32 *out_value)
611 static inline int of_property_read_u64_index(const struct device_node *np,
612 const char *propname, u32 index, u64 *out_value)
617 static inline const void *of_get_property(const struct device_node *node,
624 static inline struct device_node *of_get_cpu_node(int cpu,
625 unsigned int *thread)
630 static inline struct device_node *of_get_next_cpu_node(struct device_node *prev)
635 static inline struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
641 static inline int of_n_addr_cells(struct device_node *np)
646 static inline int of_n_size_cells(struct device_node *np)
651 static inline int of_property_read_variable_u8_array(const struct device_node *np,
652 const char *propname, u8 *out_values,
653 size_t sz_min, size_t sz_max)
658 static inline int of_property_read_variable_u16_array(const struct device_node *np,
659 const char *propname, u16 *out_values,
660 size_t sz_min, size_t sz_max)
665 static inline int of_property_read_variable_u32_array(const struct device_node *np,
666 const char *propname,
674 static inline int of_property_read_u64(const struct device_node *np,
675 const char *propname, u64 *out_value)
680 static inline int of_property_read_variable_u64_array(const struct device_node *np,
681 const char *propname,
689 static inline int of_property_read_string(const struct device_node *np,
690 const char *propname,
691 const char **out_string)
696 static inline int of_property_match_string(const struct device_node *np,
697 const char *propname,
703 static inline int of_property_read_string_helper(const struct device_node *np,
704 const char *propname,
705 const char **out_strs, size_t sz, int index)
710 static inline struct device_node *of_parse_phandle(const struct device_node *np,
711 const char *phandle_name,
717 static inline int of_parse_phandle_with_args(const struct device_node *np,
718 const char *list_name,
719 const char *cells_name,
721 struct of_phandle_args *out_args)
726 static inline int of_parse_phandle_with_args_map(const struct device_node *np,
727 const char *list_name,
728 const char *stem_name,
730 struct of_phandle_args *out_args)
735 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
736 const char *list_name, int cells_count, int index,
737 struct of_phandle_args *out_args)
742 static inline int of_count_phandle_with_args(struct device_node *np,
743 const char *list_name,
744 const char *cells_name)
749 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
750 const struct device_node *np,
751 const char *list_name,
752 const char *cells_name,
758 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
763 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
770 static inline int of_alias_get_id(struct device_node *np, const char *stem)
775 static inline int of_alias_get_highest_id(const char *stem)
780 static inline int of_alias_get_alias_list(const struct of_device_id *matches,
781 const char *stem, unsigned long *bitmap,
787 static inline int of_machine_is_compatible(const char *compat)
792 static inline int of_remove_property(struct device_node *np, struct property *prop)
797 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
802 static inline const __be32 *of_prop_next_u32(struct property *prop,
803 const __be32 *cur, u32 *pu)
808 static inline const char *of_prop_next_string(struct property *prop,
814 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
819 static inline int of_node_test_and_set_flag(struct device_node *n,
825 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
829 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
833 static inline int of_property_check_flag(struct property *p, unsigned long flag)
838 static inline void of_property_set_flag(struct property *p, unsigned long flag)
842 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
846 static inline int of_cpu_node_to_id(struct device_node *np)
851 static inline int of_map_id(struct device_node *np, u32 id,
852 const char *map_name, const char *map_mask_name,
853 struct device_node **target, u32 *id_out)
858 static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np)
860 return PHYS_ADDR_MAX;
863 #define of_match_ptr(_ptr) NULL
864 #define of_match_node(_matches, _node) NULL
865 #endif /* CONFIG_OF */
867 /* Default string compare functions, Allow arch asm/prom.h to override */
868 #if !defined(of_compat_cmp)
869 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
870 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
871 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
874 static inline int of_prop_val_eq(struct property *p1, struct property *p2)
876 return p1->length == p2->length &&
877 !memcmp(p1->value, p2->value, (size_t)p1->length);
880 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
881 extern int of_node_to_nid(struct device_node *np);
883 static inline int of_node_to_nid(struct device_node *device)
889 #ifdef CONFIG_OF_NUMA
890 extern int of_numa_init(void);
892 static inline int of_numa_init(void)
898 static inline struct device_node *of_find_matching_node(
899 struct device_node *from,
900 const struct of_device_id *matches)
902 return of_find_matching_node_and_match(from, matches, NULL);
905 static inline const char *of_node_get_device_type(const struct device_node *np)
907 return of_get_property(np, "device_type", NULL);
910 static inline bool of_node_is_type(const struct device_node *np, const char *type)
912 const char *match = of_node_get_device_type(np);
914 return np && match && type && !strcmp(match, type);
918 * of_property_count_u8_elems - Count the number of u8 elements in a property
920 * @np: device node from which the property value is to be read.
921 * @propname: name of the property to be searched.
923 * Search for a property in a device node and count the number of u8 elements
926 * Return: The number of elements on sucess, -EINVAL if the property does
927 * not exist or its length does not match a multiple of u8 and -ENODATA if the
928 * property does not have a value.
930 static inline int of_property_count_u8_elems(const struct device_node *np,
931 const char *propname)
933 return of_property_count_elems_of_size(np, propname, sizeof(u8));
937 * of_property_count_u16_elems - Count the number of u16 elements in a property
939 * @np: device node from which the property value is to be read.
940 * @propname: name of the property to be searched.
942 * Search for a property in a device node and count the number of u16 elements
945 * Return: The number of elements on sucess, -EINVAL if the property does
946 * not exist or its length does not match a multiple of u16 and -ENODATA if the
947 * property does not have a value.
949 static inline int of_property_count_u16_elems(const struct device_node *np,
950 const char *propname)
952 return of_property_count_elems_of_size(np, propname, sizeof(u16));
956 * of_property_count_u32_elems - Count the number of u32 elements in a property
958 * @np: device node from which the property value is to be read.
959 * @propname: name of the property to be searched.
961 * Search for a property in a device node and count the number of u32 elements
964 * Return: The number of elements on sucess, -EINVAL if the property does
965 * not exist or its length does not match a multiple of u32 and -ENODATA if the
966 * property does not have a value.
968 static inline int of_property_count_u32_elems(const struct device_node *np,
969 const char *propname)
971 return of_property_count_elems_of_size(np, propname, sizeof(u32));
975 * of_property_count_u64_elems - Count the number of u64 elements in a property
977 * @np: device node from which the property value is to be read.
978 * @propname: name of the property to be searched.
980 * Search for a property in a device node and count the number of u64 elements
983 * Return: The number of elements on sucess, -EINVAL if the property does
984 * not exist or its length does not match a multiple of u64 and -ENODATA if the
985 * property does not have a value.
987 static inline int of_property_count_u64_elems(const struct device_node *np,
988 const char *propname)
990 return of_property_count_elems_of_size(np, propname, sizeof(u64));
994 * of_property_read_string_array() - Read an array of strings from a multiple
996 * @np: device node from which the property value is to be read.
997 * @propname: name of the property to be searched.
998 * @out_strs: output array of string pointers.
999 * @sz: number of array elements to read.
1001 * Search for a property in a device tree node and retrieve a list of
1002 * terminated string values (pointer to data, not a copy) in that property.
1004 * Return: If @out_strs is NULL, the number of strings in the property is returned.
1006 static inline int of_property_read_string_array(const struct device_node *np,
1007 const char *propname, const char **out_strs,
1010 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1014 * of_property_count_strings() - Find and return the number of strings from a
1015 * multiple strings property.
1016 * @np: device node from which the property value is to be read.
1017 * @propname: name of the property to be searched.
1019 * Search for a property in a device tree node and retrieve the number of null
1020 * terminated string contain in it.
1022 * Return: The number of strings on success, -EINVAL if the property does not
1023 * exist, -ENODATA if property does not have a value, and -EILSEQ if the string
1024 * is not null-terminated within the length of the property data.
1026 static inline int of_property_count_strings(const struct device_node *np,
1027 const char *propname)
1029 return of_property_read_string_helper(np, propname, NULL, 0, 0);
1033 * of_property_read_string_index() - Find and read a string from a multiple
1035 * @np: device node from which the property value is to be read.
1036 * @propname: name of the property to be searched.
1037 * @index: index of the string in the list of strings
1038 * @out_string: pointer to null terminated return string, modified only if
1039 * return value is 0.
1041 * Search for a property in a device tree node and retrieve a null
1042 * terminated string value (pointer to data, not a copy) in the list of strings
1043 * contained in that property.
1045 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
1046 * property does not have a value, and -EILSEQ if the string is not
1047 * null-terminated within the length of the property data.
1049 * The out_string pointer is modified only if a valid string can be decoded.
1051 static inline int of_property_read_string_index(const struct device_node *np,
1052 const char *propname,
1053 int index, const char **output)
1055 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1056 return rc < 0 ? rc : 0;
1060 * of_property_read_bool - Find a property
1061 * @np: device node from which the property value is to be read.
1062 * @propname: name of the property to be searched.
1064 * Search for a boolean property in a device node. Usage on non-boolean
1065 * property types is deprecated.
1067 * Return: true if the property exists false otherwise.
1069 static inline bool of_property_read_bool(const struct device_node *np,
1070 const char *propname)
1072 struct property *prop = of_find_property(np, propname, NULL);
1074 return prop ? true : false;
1078 * of_property_present - Test if a property is present in a node
1079 * @np: device node to search for the property.
1080 * @propname: name of the property to be searched.
1082 * Test for a property present in a device node.
1084 * Return: true if the property exists false otherwise.
1086 static inline bool of_property_present(const struct device_node *np, const char *propname)
1088 return of_property_read_bool(np, propname);
1092 * of_property_read_u8_array - Find and read an array of u8 from a property.
1094 * @np: device node from which the property value is to be read.
1095 * @propname: name of the property to be searched.
1096 * @out_values: pointer to return value, modified only if return value is 0.
1097 * @sz: number of array elements to read
1099 * Search for a property in a device node and read 8-bit value(s) from
1102 * dts entry of array should be like:
1103 * ``property = /bits/ 8 <0x50 0x60 0x70>;``
1105 * Return: 0 on success, -EINVAL if the property does not exist,
1106 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1107 * property data isn't large enough.
1109 * The out_values is modified only if a valid u8 value can be decoded.
1111 static inline int of_property_read_u8_array(const struct device_node *np,
1112 const char *propname,
1113 u8 *out_values, size_t sz)
1115 int ret = of_property_read_variable_u8_array(np, propname, out_values,
1124 * of_property_read_u16_array - Find and read an array of u16 from a property.
1126 * @np: device node from which the property value is to be read.
1127 * @propname: name of the property to be searched.
1128 * @out_values: pointer to return value, modified only if return value is 0.
1129 * @sz: number of array elements to read
1131 * Search for a property in a device node and read 16-bit value(s) from
1134 * dts entry of array should be like:
1135 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
1137 * Return: 0 on success, -EINVAL if the property does not exist,
1138 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1139 * property data isn't large enough.
1141 * The out_values is modified only if a valid u16 value can be decoded.
1143 static inline int of_property_read_u16_array(const struct device_node *np,
1144 const char *propname,
1145 u16 *out_values, size_t sz)
1147 int ret = of_property_read_variable_u16_array(np, propname, out_values,
1156 * of_property_read_u32_array - Find and read an array of 32 bit integers
1159 * @np: device node from which the property value is to be read.
1160 * @propname: name of the property to be searched.
1161 * @out_values: pointer to return value, modified only if return value is 0.
1162 * @sz: number of array elements to read
1164 * Search for a property in a device node and read 32-bit value(s) from
1167 * Return: 0 on success, -EINVAL if the property does not exist,
1168 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1169 * property data isn't large enough.
1171 * The out_values is modified only if a valid u32 value can be decoded.
1173 static inline int of_property_read_u32_array(const struct device_node *np,
1174 const char *propname,
1175 u32 *out_values, size_t sz)
1177 int ret = of_property_read_variable_u32_array(np, propname, out_values,
1186 * of_property_read_u64_array - Find and read an array of 64 bit integers
1189 * @np: device node from which the property value is to be read.
1190 * @propname: name of the property to be searched.
1191 * @out_values: pointer to return value, modified only if return value is 0.
1192 * @sz: number of array elements to read
1194 * Search for a property in a device node and read 64-bit value(s) from
1197 * Return: 0 on success, -EINVAL if the property does not exist,
1198 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1199 * property data isn't large enough.
1201 * The out_values is modified only if a valid u64 value can be decoded.
1203 static inline int of_property_read_u64_array(const struct device_node *np,
1204 const char *propname,
1205 u64 *out_values, size_t sz)
1207 int ret = of_property_read_variable_u64_array(np, propname, out_values,
1215 static inline int of_property_read_u8(const struct device_node *np,
1216 const char *propname,
1219 return of_property_read_u8_array(np, propname, out_value, 1);
1222 static inline int of_property_read_u16(const struct device_node *np,
1223 const char *propname,
1226 return of_property_read_u16_array(np, propname, out_value, 1);
1229 static inline int of_property_read_u32(const struct device_node *np,
1230 const char *propname,
1233 return of_property_read_u32_array(np, propname, out_value, 1);
1236 static inline int of_property_read_s32(const struct device_node *np,
1237 const char *propname,
1240 return of_property_read_u32(np, propname, (u32*) out_value);
1243 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1244 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1245 err = of_phandle_iterator_next(it); \
1247 err = of_phandle_iterator_next(it))
1249 #define of_property_for_each_u32(np, propname, prop, p, u) \
1250 for (prop = of_find_property(np, propname, NULL), \
1251 p = of_prop_next_u32(prop, NULL, &u); \
1253 p = of_prop_next_u32(prop, p, &u))
1255 #define of_property_for_each_string(np, propname, prop, s) \
1256 for (prop = of_find_property(np, propname, NULL), \
1257 s = of_prop_next_string(prop, NULL); \
1259 s = of_prop_next_string(prop, s))
1261 #define for_each_node_by_name(dn, name) \
1262 for (dn = of_find_node_by_name(NULL, name); dn; \
1263 dn = of_find_node_by_name(dn, name))
1264 #define for_each_node_by_type(dn, type) \
1265 for (dn = of_find_node_by_type(NULL, type); dn; \
1266 dn = of_find_node_by_type(dn, type))
1267 #define for_each_compatible_node(dn, type, compatible) \
1268 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1269 dn = of_find_compatible_node(dn, type, compatible))
1270 #define for_each_matching_node(dn, matches) \
1271 for (dn = of_find_matching_node(NULL, matches); dn; \
1272 dn = of_find_matching_node(dn, matches))
1273 #define for_each_matching_node_and_match(dn, matches, match) \
1274 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1275 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1277 #define for_each_child_of_node(parent, child) \
1278 for (child = of_get_next_child(parent, NULL); child != NULL; \
1279 child = of_get_next_child(parent, child))
1280 #define for_each_available_child_of_node(parent, child) \
1281 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1282 child = of_get_next_available_child(parent, child))
1284 #define for_each_of_cpu_node(cpu) \
1285 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1286 cpu = of_get_next_cpu_node(cpu))
1288 #define for_each_node_with_property(dn, prop_name) \
1289 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1290 dn = of_find_node_with_property(dn, prop_name))
1292 static inline int of_get_child_count(const struct device_node *np)
1294 struct device_node *child;
1297 for_each_child_of_node(np, child)
1303 static inline int of_get_available_child_count(const struct device_node *np)
1305 struct device_node *child;
1308 for_each_available_child_of_node(np, child)
1314 #if defined(CONFIG_OF) && !defined(MODULE)
1315 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1316 static const struct of_device_id __of_table_##name \
1317 __used __section("__" #table "_of_table") \
1318 __aligned(__alignof__(struct of_device_id)) \
1319 = { .compatible = compat, \
1320 .data = (fn == (fn_type)NULL) ? fn : fn }
1322 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1323 static const struct of_device_id __of_table_##name \
1324 __attribute__((unused)) \
1325 = { .compatible = compat, \
1326 .data = (fn == (fn_type)NULL) ? fn : fn }
1329 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1330 typedef int (*of_init_fn_1_ret)(struct device_node *);
1331 typedef void (*of_init_fn_1)(struct device_node *);
1333 #define OF_DECLARE_1(table, name, compat, fn) \
1334 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1335 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1336 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1337 #define OF_DECLARE_2(table, name, compat, fn) \
1338 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1341 * struct of_changeset_entry - Holds a changeset entry
1343 * @node: list_head for the log list
1344 * @action: notifier action
1345 * @np: pointer to the device node affected
1346 * @prop: pointer to the property affected
1347 * @old_prop: hold a pointer to the original property
1349 * Every modification of the device tree during a changeset
1350 * is held in a list of of_changeset_entry structures.
1351 * That way we can recover from a partial application, or we can
1352 * revert the changeset
1354 struct of_changeset_entry {
1355 struct list_head node;
1356 unsigned long action;
1357 struct device_node *np;
1358 struct property *prop;
1359 struct property *old_prop;
1363 * struct of_changeset - changeset tracker structure
1365 * @entries: list_head for the changeset entries
1367 * changesets are a convenient way to apply bulk changes to the
1368 * live tree. In case of an error, changes are rolled-back.
1369 * changesets live on after initial application, and if not
1370 * destroyed after use, they can be reverted in one single call.
1372 struct of_changeset {
1373 struct list_head entries;
1376 enum of_reconfig_change {
1377 OF_RECONFIG_NO_CHANGE = 0,
1378 OF_RECONFIG_CHANGE_ADD,
1379 OF_RECONFIG_CHANGE_REMOVE,
1382 #ifdef CONFIG_OF_DYNAMIC
1383 extern int of_reconfig_notifier_register(struct notifier_block *);
1384 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1385 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1386 extern int of_reconfig_get_state_change(unsigned long action,
1387 struct of_reconfig_data *arg);
1389 extern void of_changeset_init(struct of_changeset *ocs);
1390 extern void of_changeset_destroy(struct of_changeset *ocs);
1391 extern int of_changeset_apply(struct of_changeset *ocs);
1392 extern int of_changeset_revert(struct of_changeset *ocs);
1393 extern int of_changeset_action(struct of_changeset *ocs,
1394 unsigned long action, struct device_node *np,
1395 struct property *prop);
1397 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1398 struct device_node *np)
1400 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1403 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1404 struct device_node *np)
1406 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1409 static inline int of_changeset_add_property(struct of_changeset *ocs,
1410 struct device_node *np, struct property *prop)
1412 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1415 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1416 struct device_node *np, struct property *prop)
1418 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1421 static inline int of_changeset_update_property(struct of_changeset *ocs,
1422 struct device_node *np, struct property *prop)
1424 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1426 #else /* CONFIG_OF_DYNAMIC */
1427 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1431 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1435 static inline int of_reconfig_notify(unsigned long action,
1436 struct of_reconfig_data *arg)
1440 static inline int of_reconfig_get_state_change(unsigned long action,
1441 struct of_reconfig_data *arg)
1445 #endif /* CONFIG_OF_DYNAMIC */
1448 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1449 * @np: Pointer to the given device_node
1451 * Return: true if present false otherwise
1453 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1455 return of_property_read_bool(np, "system-power-controller");
1462 enum of_overlay_notify_action {
1463 OF_OVERLAY_PRE_APPLY = 0,
1464 OF_OVERLAY_POST_APPLY,
1465 OF_OVERLAY_PRE_REMOVE,
1466 OF_OVERLAY_POST_REMOVE,
1469 struct of_overlay_notify_data {
1470 struct device_node *overlay;
1471 struct device_node *target;
1474 #ifdef CONFIG_OF_OVERLAY
1476 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1478 int of_overlay_remove(int *ovcs_id);
1479 int of_overlay_remove_all(void);
1481 int of_overlay_notifier_register(struct notifier_block *nb);
1482 int of_overlay_notifier_unregister(struct notifier_block *nb);
1486 static inline int of_overlay_fdt_apply(void *overlay_fdt, u32 overlay_fdt_size,
1492 static inline int of_overlay_remove(int *ovcs_id)
1497 static inline int of_overlay_remove_all(void)
1502 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1507 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1514 #endif /* _LINUX_OF_H */