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 fwnode_init(&node->fwnode, &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(const 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(const 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(const 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,
356 extern u64 of_get_cpu_hwid(struct device_node *cpun, unsigned int thread);
358 #define for_each_property_of_node(dn, pp) \
359 for (pp = dn->properties; pp != NULL; pp = pp->next)
361 extern int of_n_addr_cells(struct device_node *np);
362 extern int of_n_size_cells(struct device_node *np);
363 extern const struct of_device_id *of_match_node(
364 const struct of_device_id *matches, const struct device_node *node);
365 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
366 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
367 extern int __of_parse_phandle_with_args(const struct device_node *np,
368 const char *list_name, const char *cells_name, int cell_count,
369 int index, struct of_phandle_args *out_args);
370 extern int of_parse_phandle_with_args_map(const struct device_node *np,
371 const char *list_name, const char *stem_name, int index,
372 struct of_phandle_args *out_args);
373 extern int of_count_phandle_with_args(const struct device_node *np,
374 const char *list_name, const char *cells_name);
376 /* phandle iterator functions */
377 extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
378 const struct device_node *np,
379 const char *list_name,
380 const char *cells_name,
383 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
384 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
388 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
389 extern int of_alias_get_id(struct device_node *np, const char *stem);
390 extern int of_alias_get_highest_id(const char *stem);
392 extern int of_machine_is_compatible(const char *compat);
394 extern int of_add_property(struct device_node *np, struct property *prop);
395 extern int of_remove_property(struct device_node *np, struct property *prop);
396 extern int of_update_property(struct device_node *np, struct property *newprop);
398 /* For updating the device tree at runtime */
399 #define OF_RECONFIG_ATTACH_NODE 0x0001
400 #define OF_RECONFIG_DETACH_NODE 0x0002
401 #define OF_RECONFIG_ADD_PROPERTY 0x0003
402 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
403 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
405 extern int of_attach_node(struct device_node *);
406 extern int of_detach_node(struct device_node *);
408 #define of_match_ptr(_ptr) (_ptr)
411 * struct property *prop;
415 * of_property_for_each_u32(np, "propname", prop, p, u)
416 * printk("U32 value: %x\n", u);
418 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
421 * struct property *prop;
424 * of_property_for_each_string(np, "propname", prop, s)
425 * printk("String value: %s\n", s);
427 const char *of_prop_next_string(struct property *prop, const char *cur);
429 bool of_console_check(struct device_node *dn, char *name, int index);
431 extern int of_cpu_node_to_id(struct device_node *np);
433 int of_map_id(struct device_node *np, u32 id,
434 const char *map_name, const char *map_mask_name,
435 struct device_node **target, u32 *id_out);
437 phys_addr_t of_dma_get_max_cpu_address(struct device_node *np);
440 void *of_kexec_alloc_and_setup_fdt(const struct kimage *image,
441 unsigned long initrd_load_addr,
442 unsigned long initrd_len,
443 const char *cmdline, size_t extra_fdt_size);
444 #else /* CONFIG_OF */
446 static inline void of_core_init(void)
450 static inline bool is_of_node(const struct fwnode_handle *fwnode)
455 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode)
460 static inline bool of_node_name_eq(const struct device_node *np, const char *name)
465 static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix)
470 static inline const char* of_node_full_name(const struct device_node *np)
475 static inline struct device_node *of_find_node_by_name(struct device_node *from,
481 static inline struct device_node *of_find_node_by_type(struct device_node *from,
487 static inline struct device_node *of_find_matching_node_and_match(
488 struct device_node *from,
489 const struct of_device_id *matches,
490 const struct of_device_id **match)
495 static inline struct device_node *of_find_node_by_path(const char *path)
500 static inline struct device_node *of_find_node_opts_by_path(const char *path,
506 static inline struct device_node *of_find_node_by_phandle(phandle handle)
511 static inline struct device_node *of_get_parent(const struct device_node *node)
516 static inline struct device_node *of_get_next_parent(struct device_node *node)
521 static inline struct device_node *of_get_next_child(
522 const struct device_node *node, struct device_node *prev)
527 static inline struct device_node *of_get_next_available_child(
528 const struct device_node *node, struct device_node *prev)
533 static inline struct device_node *of_find_node_with_property(
534 struct device_node *from, const char *prop_name)
539 #define of_fwnode_handle(node) NULL
541 static inline bool of_have_populated_dt(void)
546 static inline struct device_node *of_get_compatible_child(const struct device_node *parent,
547 const char *compatible)
552 static inline struct device_node *of_get_child_by_name(
553 const struct device_node *node,
559 static inline int of_device_is_compatible(const struct device_node *device,
565 static inline int of_device_compatible_match(const struct device_node *device,
566 const char *const *compat)
571 static inline bool of_device_is_available(const struct device_node *device)
576 static inline bool of_device_is_big_endian(const struct device_node *device)
581 static inline struct property *of_find_property(const struct device_node *np,
588 static inline struct device_node *of_find_compatible_node(
589 struct device_node *from,
596 static inline int of_property_count_elems_of_size(const struct device_node *np,
597 const char *propname, int elem_size)
602 static inline int of_property_read_u32_index(const struct device_node *np,
603 const char *propname, u32 index, u32 *out_value)
608 static inline int of_property_read_u64_index(const struct device_node *np,
609 const char *propname, u32 index, u64 *out_value)
614 static inline const void *of_get_property(const struct device_node *node,
621 static inline struct device_node *of_get_cpu_node(int cpu,
622 unsigned int *thread)
627 static inline struct device_node *of_get_next_cpu_node(struct device_node *prev)
632 static inline struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
638 static inline int of_n_addr_cells(struct device_node *np)
643 static inline int of_n_size_cells(struct device_node *np)
648 static inline int of_property_read_variable_u8_array(const struct device_node *np,
649 const char *propname, u8 *out_values,
650 size_t sz_min, size_t sz_max)
655 static inline int of_property_read_variable_u16_array(const struct device_node *np,
656 const char *propname, u16 *out_values,
657 size_t sz_min, size_t sz_max)
662 static inline int of_property_read_variable_u32_array(const struct device_node *np,
663 const char *propname,
671 static inline int of_property_read_u64(const struct device_node *np,
672 const char *propname, u64 *out_value)
677 static inline int of_property_read_variable_u64_array(const struct device_node *np,
678 const char *propname,
686 static inline int of_property_read_string(const struct device_node *np,
687 const char *propname,
688 const char **out_string)
693 static inline int of_property_match_string(const struct device_node *np,
694 const char *propname,
700 static inline int of_property_read_string_helper(const struct device_node *np,
701 const char *propname,
702 const char **out_strs, size_t sz, int index)
707 static inline int __of_parse_phandle_with_args(const struct device_node *np,
708 const char *list_name,
709 const char *cells_name,
712 struct of_phandle_args *out_args)
717 static inline int of_parse_phandle_with_args_map(const struct device_node *np,
718 const char *list_name,
719 const char *stem_name,
721 struct of_phandle_args *out_args)
726 static inline int of_count_phandle_with_args(const struct device_node *np,
727 const char *list_name,
728 const char *cells_name)
733 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
734 const struct device_node *np,
735 const char *list_name,
736 const char *cells_name,
742 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
747 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
754 static inline int of_alias_get_id(struct device_node *np, const char *stem)
759 static inline int of_alias_get_highest_id(const char *stem)
764 static inline int of_machine_is_compatible(const char *compat)
769 static inline int of_add_property(struct device_node *np, struct property *prop)
774 static inline int of_remove_property(struct device_node *np, struct property *prop)
779 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
784 static inline const __be32 *of_prop_next_u32(struct property *prop,
785 const __be32 *cur, u32 *pu)
790 static inline const char *of_prop_next_string(struct property *prop,
796 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
801 static inline int of_node_test_and_set_flag(struct device_node *n,
807 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
811 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
815 static inline int of_property_check_flag(const struct property *p,
821 static inline void of_property_set_flag(struct property *p, unsigned long flag)
825 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
829 static inline int of_cpu_node_to_id(struct device_node *np)
834 static inline int of_map_id(struct device_node *np, u32 id,
835 const char *map_name, const char *map_mask_name,
836 struct device_node **target, u32 *id_out)
841 static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np)
843 return PHYS_ADDR_MAX;
846 #define of_match_ptr(_ptr) NULL
847 #define of_match_node(_matches, _node) NULL
848 #endif /* CONFIG_OF */
850 /* Default string compare functions, Allow arch asm/prom.h to override */
851 #if !defined(of_compat_cmp)
852 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
853 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
854 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
857 static inline int of_prop_val_eq(struct property *p1, struct property *p2)
859 return p1->length == p2->length &&
860 !memcmp(p1->value, p2->value, (size_t)p1->length);
863 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
864 extern int of_node_to_nid(struct device_node *np);
866 static inline int of_node_to_nid(struct device_node *device)
872 #ifdef CONFIG_OF_NUMA
873 extern int of_numa_init(void);
875 static inline int of_numa_init(void)
881 static inline struct device_node *of_find_matching_node(
882 struct device_node *from,
883 const struct of_device_id *matches)
885 return of_find_matching_node_and_match(from, matches, NULL);
888 static inline const char *of_node_get_device_type(const struct device_node *np)
890 return of_get_property(np, "device_type", NULL);
893 static inline bool of_node_is_type(const struct device_node *np, const char *type)
895 const char *match = of_node_get_device_type(np);
897 return np && match && type && !strcmp(match, type);
901 * of_parse_phandle - Resolve a phandle property to a device_node pointer
902 * @np: Pointer to device node holding phandle property
903 * @phandle_name: Name of property holding a phandle value
904 * @index: For properties holding a table of phandles, this is the index into
907 * Return: The device_node pointer with refcount incremented. Use
908 * of_node_put() on it when done.
910 static inline struct device_node *of_parse_phandle(const struct device_node *np,
911 const char *phandle_name,
914 struct of_phandle_args args;
916 if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0,
924 * of_parse_phandle_with_args() - Find a node pointed by phandle in a list
925 * @np: pointer to a device tree node containing a list
926 * @list_name: property name that contains a list
927 * @cells_name: property name that specifies phandles' arguments count
928 * @index: index of a phandle to parse out
929 * @out_args: optional pointer to output arguments structure (will be filled)
931 * This function is useful to parse lists of phandles and their arguments.
932 * Returns 0 on success and fills out_args, on error returns appropriate
935 * Caller is responsible to call of_node_put() on the returned out_args->np
949 * list = <&phandle1 1 2 &phandle2 3>;
952 * To get a device_node of the ``node2`` node you may call this:
953 * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
955 static inline int of_parse_phandle_with_args(const struct device_node *np,
956 const char *list_name,
957 const char *cells_name,
959 struct of_phandle_args *out_args)
963 /* If cells_name is NULL we assume a cell count of 0 */
967 return __of_parse_phandle_with_args(np, list_name, cells_name,
968 cell_count, index, out_args);
972 * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list
973 * @np: pointer to a device tree node containing a list
974 * @list_name: property name that contains a list
975 * @cell_count: number of argument cells following the phandle
976 * @index: index of a phandle to parse out
977 * @out_args: optional pointer to output arguments structure (will be filled)
979 * This function is useful to parse lists of phandles and their arguments.
980 * Returns 0 on success and fills out_args, on error returns appropriate
983 * Caller is responsible to call of_node_put() on the returned out_args->np
995 * list = <&phandle1 0 2 &phandle2 2 3>;
998 * To get a device_node of the ``node2`` node you may call this:
999 * of_parse_phandle_with_fixed_args(node3, "list", 2, 1, &args);
1001 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
1002 const char *list_name,
1005 struct of_phandle_args *out_args)
1007 return __of_parse_phandle_with_args(np, list_name, NULL, cell_count,
1012 * of_property_count_u8_elems - Count the number of u8 elements in a property
1014 * @np: device node from which the property value is to be read.
1015 * @propname: name of the property to be searched.
1017 * Search for a property in a device node and count the number of u8 elements
1020 * Return: The number of elements on sucess, -EINVAL if the property does
1021 * not exist or its length does not match a multiple of u8 and -ENODATA if the
1022 * property does not have a value.
1024 static inline int of_property_count_u8_elems(const struct device_node *np,
1025 const char *propname)
1027 return of_property_count_elems_of_size(np, propname, sizeof(u8));
1031 * of_property_count_u16_elems - Count the number of u16 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 u16 elements
1039 * Return: The number of elements on sucess, -EINVAL if the property does
1040 * not exist or its length does not match a multiple of u16 and -ENODATA if the
1041 * property does not have a value.
1043 static inline int of_property_count_u16_elems(const struct device_node *np,
1044 const char *propname)
1046 return of_property_count_elems_of_size(np, propname, sizeof(u16));
1050 * of_property_count_u32_elems - Count the number of u32 elements in a property
1052 * @np: device node from which the property value is to be read.
1053 * @propname: name of the property to be searched.
1055 * Search for a property in a device node and count the number of u32 elements
1058 * Return: The number of elements on sucess, -EINVAL if the property does
1059 * not exist or its length does not match a multiple of u32 and -ENODATA if the
1060 * property does not have a value.
1062 static inline int of_property_count_u32_elems(const struct device_node *np,
1063 const char *propname)
1065 return of_property_count_elems_of_size(np, propname, sizeof(u32));
1069 * of_property_count_u64_elems - Count the number of u64 elements in a property
1071 * @np: device node from which the property value is to be read.
1072 * @propname: name of the property to be searched.
1074 * Search for a property in a device node and count the number of u64 elements
1077 * Return: The number of elements on sucess, -EINVAL if the property does
1078 * not exist or its length does not match a multiple of u64 and -ENODATA if the
1079 * property does not have a value.
1081 static inline int of_property_count_u64_elems(const struct device_node *np,
1082 const char *propname)
1084 return of_property_count_elems_of_size(np, propname, sizeof(u64));
1088 * of_property_read_string_array() - Read an array of strings from a multiple
1090 * @np: device node from which the property value is to be read.
1091 * @propname: name of the property to be searched.
1092 * @out_strs: output array of string pointers.
1093 * @sz: number of array elements to read.
1095 * Search for a property in a device tree node and retrieve a list of
1096 * terminated string values (pointer to data, not a copy) in that property.
1098 * Return: If @out_strs is NULL, the number of strings in the property is returned.
1100 static inline int of_property_read_string_array(const struct device_node *np,
1101 const char *propname, const char **out_strs,
1104 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1108 * of_property_count_strings() - Find and return the number of strings from a
1109 * multiple strings property.
1110 * @np: device node from which the property value is to be read.
1111 * @propname: name of the property to be searched.
1113 * Search for a property in a device tree node and retrieve the number of null
1114 * terminated string contain in it.
1116 * Return: The number of strings on success, -EINVAL if the property does not
1117 * exist, -ENODATA if property does not have a value, and -EILSEQ if the string
1118 * is not null-terminated within the length of the property data.
1120 static inline int of_property_count_strings(const struct device_node *np,
1121 const char *propname)
1123 return of_property_read_string_helper(np, propname, NULL, 0, 0);
1127 * of_property_read_string_index() - Find and read a string from a multiple
1129 * @np: device node from which the property value is to be read.
1130 * @propname: name of the property to be searched.
1131 * @index: index of the string in the list of strings
1132 * @output: pointer to null terminated return string, modified only if
1133 * return value is 0.
1135 * Search for a property in a device tree node and retrieve a null
1136 * terminated string value (pointer to data, not a copy) in the list of strings
1137 * contained in that property.
1139 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
1140 * property does not have a value, and -EILSEQ if the string is not
1141 * null-terminated within the length of the property data.
1143 * The out_string pointer is modified only if a valid string can be decoded.
1145 static inline int of_property_read_string_index(const struct device_node *np,
1146 const char *propname,
1147 int index, const char **output)
1149 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1150 return rc < 0 ? rc : 0;
1154 * of_property_read_bool - Find a property
1155 * @np: device node from which the property value is to be read.
1156 * @propname: name of the property to be searched.
1158 * Search for a property in a device node.
1160 * Return: true if the property exists false otherwise.
1162 static inline bool of_property_read_bool(const struct device_node *np,
1163 const char *propname)
1165 struct property *prop = of_find_property(np, propname, NULL);
1167 return prop ? true : false;
1171 * of_property_read_u8_array - Find and read an array of u8 from a property.
1173 * @np: device node from which the property value is to be read.
1174 * @propname: name of the property to be searched.
1175 * @out_values: pointer to return value, modified only if return value is 0.
1176 * @sz: number of array elements to read
1178 * Search for a property in a device node and read 8-bit value(s) from
1181 * dts entry of array should be like:
1182 * ``property = /bits/ 8 <0x50 0x60 0x70>;``
1184 * Return: 0 on success, -EINVAL if the property does not exist,
1185 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1186 * property data isn't large enough.
1188 * The out_values is modified only if a valid u8 value can be decoded.
1190 static inline int of_property_read_u8_array(const struct device_node *np,
1191 const char *propname,
1192 u8 *out_values, size_t sz)
1194 int ret = of_property_read_variable_u8_array(np, propname, out_values,
1203 * of_property_read_u16_array - Find and read an array of u16 from a property.
1205 * @np: device node from which the property value is to be read.
1206 * @propname: name of the property to be searched.
1207 * @out_values: pointer to return value, modified only if return value is 0.
1208 * @sz: number of array elements to read
1210 * Search for a property in a device node and read 16-bit value(s) from
1213 * dts entry of array should be like:
1214 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
1216 * Return: 0 on success, -EINVAL if the property does not exist,
1217 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1218 * property data isn't large enough.
1220 * The out_values is modified only if a valid u16 value can be decoded.
1222 static inline int of_property_read_u16_array(const struct device_node *np,
1223 const char *propname,
1224 u16 *out_values, size_t sz)
1226 int ret = of_property_read_variable_u16_array(np, propname, out_values,
1235 * of_property_read_u32_array - Find and read an array of 32 bit integers
1238 * @np: device node from which the property value is to be read.
1239 * @propname: name of the property to be searched.
1240 * @out_values: pointer to return value, modified only if return value is 0.
1241 * @sz: number of array elements to read
1243 * Search for a property in a device node and read 32-bit value(s) from
1246 * Return: 0 on success, -EINVAL if the property does not exist,
1247 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1248 * property data isn't large enough.
1250 * The out_values is modified only if a valid u32 value can be decoded.
1252 static inline int of_property_read_u32_array(const struct device_node *np,
1253 const char *propname,
1254 u32 *out_values, size_t sz)
1256 int ret = of_property_read_variable_u32_array(np, propname, out_values,
1265 * of_property_read_u64_array - Find and read an array of 64 bit integers
1268 * @np: device node from which the property value is to be read.
1269 * @propname: name of the property to be searched.
1270 * @out_values: pointer to return value, modified only if return value is 0.
1271 * @sz: number of array elements to read
1273 * Search for a property in a device node and read 64-bit value(s) from
1276 * Return: 0 on success, -EINVAL if the property does not exist,
1277 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1278 * property data isn't large enough.
1280 * The out_values is modified only if a valid u64 value can be decoded.
1282 static inline int of_property_read_u64_array(const struct device_node *np,
1283 const char *propname,
1284 u64 *out_values, size_t sz)
1286 int ret = of_property_read_variable_u64_array(np, propname, out_values,
1294 static inline int of_property_read_u8(const struct device_node *np,
1295 const char *propname,
1298 return of_property_read_u8_array(np, propname, out_value, 1);
1301 static inline int of_property_read_u16(const struct device_node *np,
1302 const char *propname,
1305 return of_property_read_u16_array(np, propname, out_value, 1);
1308 static inline int of_property_read_u32(const struct device_node *np,
1309 const char *propname,
1312 return of_property_read_u32_array(np, propname, out_value, 1);
1315 static inline int of_property_read_s32(const struct device_node *np,
1316 const char *propname,
1319 return of_property_read_u32(np, propname, (u32*) out_value);
1322 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1323 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1324 err = of_phandle_iterator_next(it); \
1326 err = of_phandle_iterator_next(it))
1328 #define of_property_for_each_u32(np, propname, prop, p, u) \
1329 for (prop = of_find_property(np, propname, NULL), \
1330 p = of_prop_next_u32(prop, NULL, &u); \
1332 p = of_prop_next_u32(prop, p, &u))
1334 #define of_property_for_each_string(np, propname, prop, s) \
1335 for (prop = of_find_property(np, propname, NULL), \
1336 s = of_prop_next_string(prop, NULL); \
1338 s = of_prop_next_string(prop, s))
1340 #define for_each_node_by_name(dn, name) \
1341 for (dn = of_find_node_by_name(NULL, name); dn; \
1342 dn = of_find_node_by_name(dn, name))
1343 #define for_each_node_by_type(dn, type) \
1344 for (dn = of_find_node_by_type(NULL, type); dn; \
1345 dn = of_find_node_by_type(dn, type))
1346 #define for_each_compatible_node(dn, type, compatible) \
1347 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1348 dn = of_find_compatible_node(dn, type, compatible))
1349 #define for_each_matching_node(dn, matches) \
1350 for (dn = of_find_matching_node(NULL, matches); dn; \
1351 dn = of_find_matching_node(dn, matches))
1352 #define for_each_matching_node_and_match(dn, matches, match) \
1353 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1354 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1356 #define for_each_child_of_node(parent, child) \
1357 for (child = of_get_next_child(parent, NULL); child != NULL; \
1358 child = of_get_next_child(parent, child))
1359 #define for_each_available_child_of_node(parent, child) \
1360 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1361 child = of_get_next_available_child(parent, child))
1363 #define for_each_of_cpu_node(cpu) \
1364 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1365 cpu = of_get_next_cpu_node(cpu))
1367 #define for_each_node_with_property(dn, prop_name) \
1368 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1369 dn = of_find_node_with_property(dn, prop_name))
1371 static inline int of_get_child_count(const struct device_node *np)
1373 struct device_node *child;
1376 for_each_child_of_node(np, child)
1382 static inline int of_get_available_child_count(const struct device_node *np)
1384 struct device_node *child;
1387 for_each_available_child_of_node(np, child)
1393 #define _OF_DECLARE_STUB(table, name, compat, fn, fn_type) \
1394 static const struct of_device_id __of_table_##name \
1395 __attribute__((unused)) \
1396 = { .compatible = compat, \
1397 .data = (fn == (fn_type)NULL) ? fn : fn }
1399 #if defined(CONFIG_OF) && !defined(MODULE)
1400 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1401 static const struct of_device_id __of_table_##name \
1402 __used __section("__" #table "_of_table") \
1403 __aligned(__alignof__(struct of_device_id)) \
1404 = { .compatible = compat, \
1405 .data = (fn == (fn_type)NULL) ? fn : fn }
1407 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1408 _OF_DECLARE_STUB(table, name, compat, fn, fn_type)
1411 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1412 typedef int (*of_init_fn_1_ret)(struct device_node *);
1413 typedef void (*of_init_fn_1)(struct device_node *);
1415 #define OF_DECLARE_1(table, name, compat, fn) \
1416 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1417 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1418 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1419 #define OF_DECLARE_2(table, name, compat, fn) \
1420 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1423 * struct of_changeset_entry - Holds a changeset entry
1425 * @node: list_head for the log list
1426 * @action: notifier action
1427 * @np: pointer to the device node affected
1428 * @prop: pointer to the property affected
1429 * @old_prop: hold a pointer to the original property
1431 * Every modification of the device tree during a changeset
1432 * is held in a list of of_changeset_entry structures.
1433 * That way we can recover from a partial application, or we can
1434 * revert the changeset
1436 struct of_changeset_entry {
1437 struct list_head node;
1438 unsigned long action;
1439 struct device_node *np;
1440 struct property *prop;
1441 struct property *old_prop;
1445 * struct of_changeset - changeset tracker structure
1447 * @entries: list_head for the changeset entries
1449 * changesets are a convenient way to apply bulk changes to the
1450 * live tree. In case of an error, changes are rolled-back.
1451 * changesets live on after initial application, and if not
1452 * destroyed after use, they can be reverted in one single call.
1454 struct of_changeset {
1455 struct list_head entries;
1458 enum of_reconfig_change {
1459 OF_RECONFIG_NO_CHANGE = 0,
1460 OF_RECONFIG_CHANGE_ADD,
1461 OF_RECONFIG_CHANGE_REMOVE,
1464 #ifdef CONFIG_OF_DYNAMIC
1465 extern int of_reconfig_notifier_register(struct notifier_block *);
1466 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1467 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1468 extern int of_reconfig_get_state_change(unsigned long action,
1469 struct of_reconfig_data *arg);
1471 extern void of_changeset_init(struct of_changeset *ocs);
1472 extern void of_changeset_destroy(struct of_changeset *ocs);
1473 extern int of_changeset_apply(struct of_changeset *ocs);
1474 extern int of_changeset_revert(struct of_changeset *ocs);
1475 extern int of_changeset_action(struct of_changeset *ocs,
1476 unsigned long action, struct device_node *np,
1477 struct property *prop);
1479 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1480 struct device_node *np)
1482 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1485 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1486 struct device_node *np)
1488 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1491 static inline int of_changeset_add_property(struct of_changeset *ocs,
1492 struct device_node *np, struct property *prop)
1494 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1497 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1498 struct device_node *np, struct property *prop)
1500 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1503 static inline int of_changeset_update_property(struct of_changeset *ocs,
1504 struct device_node *np, struct property *prop)
1506 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1508 #else /* CONFIG_OF_DYNAMIC */
1509 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1513 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1517 static inline int of_reconfig_notify(unsigned long action,
1518 struct of_reconfig_data *arg)
1522 static inline int of_reconfig_get_state_change(unsigned long action,
1523 struct of_reconfig_data *arg)
1527 #endif /* CONFIG_OF_DYNAMIC */
1530 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1531 * @np: Pointer to the given device_node
1533 * Return: true if present false otherwise
1535 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1537 return of_property_read_bool(np, "system-power-controller");
1544 enum of_overlay_notify_action {
1545 OF_OVERLAY_INIT = 0, /* kzalloc() of ovcs sets this value */
1546 OF_OVERLAY_PRE_APPLY,
1547 OF_OVERLAY_POST_APPLY,
1548 OF_OVERLAY_PRE_REMOVE,
1549 OF_OVERLAY_POST_REMOVE,
1552 static inline char *of_overlay_action_name(enum of_overlay_notify_action action)
1554 static char *of_overlay_action_name[] = {
1562 return of_overlay_action_name[action];
1565 struct of_overlay_notify_data {
1566 struct device_node *overlay;
1567 struct device_node *target;
1570 #ifdef CONFIG_OF_OVERLAY
1572 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1574 int of_overlay_remove(int *ovcs_id);
1575 int of_overlay_remove_all(void);
1577 int of_overlay_notifier_register(struct notifier_block *nb);
1578 int of_overlay_notifier_unregister(struct notifier_block *nb);
1582 static inline int of_overlay_fdt_apply(void *overlay_fdt, u32 overlay_fdt_size,
1588 static inline int of_overlay_remove(int *ovcs_id)
1593 static inline int of_overlay_remove_all(void)
1598 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1603 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1610 #endif /* _LINUX_OF_H */