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 * 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 struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
776 static inline int of_n_addr_cells(struct device_node *np)
781 static inline int of_n_size_cells(struct device_node *np)
786 static inline int of_property_read_variable_u8_array(const struct device_node *np,
787 const char *propname, u8 *out_values,
788 size_t sz_min, size_t sz_max)
793 static inline int of_property_read_variable_u16_array(const struct device_node *np,
794 const char *propname, u16 *out_values,
795 size_t sz_min, size_t sz_max)
800 static inline int of_property_read_variable_u32_array(const struct device_node *np,
801 const char *propname,
809 static inline int of_property_read_u64(const struct device_node *np,
810 const char *propname, u64 *out_value)
815 static inline int of_property_read_variable_u64_array(const struct device_node *np,
816 const char *propname,
824 static inline int of_property_read_string(const struct device_node *np,
825 const char *propname,
826 const char **out_string)
831 static inline int of_property_match_string(const struct device_node *np,
832 const char *propname,
838 static inline int of_property_read_string_helper(const struct device_node *np,
839 const char *propname,
840 const char **out_strs, size_t sz, int index)
845 static inline struct device_node *of_parse_phandle(const struct device_node *np,
846 const char *phandle_name,
852 static inline int of_parse_phandle_with_args(const struct device_node *np,
853 const char *list_name,
854 const char *cells_name,
856 struct of_phandle_args *out_args)
861 static inline int of_parse_phandle_with_args_map(const struct device_node *np,
862 const char *list_name,
863 const char *stem_name,
865 struct of_phandle_args *out_args)
870 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
871 const char *list_name, int cells_count, int index,
872 struct of_phandle_args *out_args)
877 static inline int of_count_phandle_with_args(struct device_node *np,
878 const char *list_name,
879 const char *cells_name)
884 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
885 const struct device_node *np,
886 const char *list_name,
887 const char *cells_name,
893 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
898 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
905 static inline int of_alias_get_id(struct device_node *np, const char *stem)
910 static inline int of_alias_get_highest_id(const char *stem)
915 static inline int of_alias_get_alias_list(const struct of_device_id *matches,
916 const char *stem, unsigned long *bitmap,
922 static inline int of_machine_is_compatible(const char *compat)
927 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
932 static inline const __be32 *of_prop_next_u32(struct property *prop,
933 const __be32 *cur, u32 *pu)
938 static inline const char *of_prop_next_string(struct property *prop,
944 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
949 static inline int of_node_test_and_set_flag(struct device_node *n,
955 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
959 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
963 static inline int of_property_check_flag(struct property *p, unsigned long flag)
968 static inline void of_property_set_flag(struct property *p, unsigned long flag)
972 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
976 static inline int of_cpu_node_to_id(struct device_node *np)
981 static inline int of_map_rid(struct device_node *np, u32 rid,
982 const char *map_name, const char *map_mask_name,
983 struct device_node **target, u32 *id_out)
988 #define of_match_ptr(_ptr) NULL
989 #define of_match_node(_matches, _node) NULL
990 #endif /* CONFIG_OF */
992 /* Default string compare functions, Allow arch asm/prom.h to override */
993 #if !defined(of_compat_cmp)
994 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
995 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
996 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
999 static inline int of_prop_val_eq(struct property *p1, struct property *p2)
1001 return p1->length == p2->length &&
1002 !memcmp(p1->value, p2->value, (size_t)p1->length);
1005 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
1006 extern int of_node_to_nid(struct device_node *np);
1008 static inline int of_node_to_nid(struct device_node *device)
1010 return NUMA_NO_NODE;
1014 #ifdef CONFIG_OF_NUMA
1015 extern int of_numa_init(void);
1017 static inline int of_numa_init(void)
1023 static inline struct device_node *of_find_matching_node(
1024 struct device_node *from,
1025 const struct of_device_id *matches)
1027 return of_find_matching_node_and_match(from, matches, NULL);
1030 static inline const char *of_node_get_device_type(const struct device_node *np)
1032 return of_get_property(np, "device_type", NULL);
1035 static inline bool of_node_is_type(const struct device_node *np, const char *type)
1037 const char *match = of_node_get_device_type(np);
1039 return np && match && type && !strcmp(match, type);
1043 * of_property_count_u8_elems - Count the number of u8 elements in a property
1045 * @np: device node from which the property value is to be read.
1046 * @propname: name of the property to be searched.
1048 * Search for a property in a device node and count the number of u8 elements
1049 * in it. Returns number of elements on sucess, -EINVAL if the property does
1050 * not exist or its length does not match a multiple of u8 and -ENODATA if the
1051 * property does not have a value.
1053 static inline int of_property_count_u8_elems(const struct device_node *np,
1054 const char *propname)
1056 return of_property_count_elems_of_size(np, propname, sizeof(u8));
1060 * of_property_count_u16_elems - Count the number of u16 elements in a property
1062 * @np: device node from which the property value is to be read.
1063 * @propname: name of the property to be searched.
1065 * Search for a property in a device node and count the number of u16 elements
1066 * in it. Returns number of elements on sucess, -EINVAL if the property does
1067 * not exist or its length does not match a multiple of u16 and -ENODATA if the
1068 * property does not have a value.
1070 static inline int of_property_count_u16_elems(const struct device_node *np,
1071 const char *propname)
1073 return of_property_count_elems_of_size(np, propname, sizeof(u16));
1077 * of_property_count_u32_elems - Count the number of u32 elements in a property
1079 * @np: device node from which the property value is to be read.
1080 * @propname: name of the property to be searched.
1082 * Search for a property in a device node and count the number of u32 elements
1083 * in it. Returns number of elements on sucess, -EINVAL if the property does
1084 * not exist or its length does not match a multiple of u32 and -ENODATA if the
1085 * property does not have a value.
1087 static inline int of_property_count_u32_elems(const struct device_node *np,
1088 const char *propname)
1090 return of_property_count_elems_of_size(np, propname, sizeof(u32));
1094 * of_property_count_u64_elems - Count the number of u64 elements in a property
1096 * @np: device node from which the property value is to be read.
1097 * @propname: name of the property to be searched.
1099 * Search for a property in a device node and count the number of u64 elements
1100 * in it. Returns number of elements on sucess, -EINVAL if the property does
1101 * not exist or its length does not match a multiple of u64 and -ENODATA if the
1102 * property does not have a value.
1104 static inline int of_property_count_u64_elems(const struct device_node *np,
1105 const char *propname)
1107 return of_property_count_elems_of_size(np, propname, sizeof(u64));
1111 * of_property_read_string_array() - Read an array of strings from a multiple
1113 * @np: device node from which the property value is to be read.
1114 * @propname: name of the property to be searched.
1115 * @out_strs: output array of string pointers.
1116 * @sz: number of array elements to read.
1118 * Search for a property in a device tree node and retrieve a list of
1119 * terminated string values (pointer to data, not a copy) in that property.
1121 * If @out_strs is NULL, the number of strings in the property is returned.
1123 static inline int of_property_read_string_array(const struct device_node *np,
1124 const char *propname, const char **out_strs,
1127 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1131 * of_property_count_strings() - Find and return the number of strings from a
1132 * multiple strings property.
1133 * @np: device node from which the property value is to be read.
1134 * @propname: name of the property to be searched.
1136 * Search for a property in a device tree node and retrieve the number of null
1137 * terminated string contain in it. Returns the number of strings on
1138 * success, -EINVAL if the property does not exist, -ENODATA if property
1139 * does not have a value, and -EILSEQ if the string is not null-terminated
1140 * within the length of the property data.
1142 static inline int of_property_count_strings(const struct device_node *np,
1143 const char *propname)
1145 return of_property_read_string_helper(np, propname, NULL, 0, 0);
1149 * of_property_read_string_index() - Find and read a string from a multiple
1151 * @np: device node from which the property value is to be read.
1152 * @propname: name of the property to be searched.
1153 * @index: index of the string in the list of strings
1154 * @out_string: pointer to null terminated return string, modified only if
1155 * return value is 0.
1157 * Search for a property in a device tree node and retrieve a null
1158 * terminated string value (pointer to data, not a copy) in the list of strings
1159 * contained in that property.
1160 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1161 * property does not have a value, and -EILSEQ if the string is not
1162 * null-terminated within the length of the property data.
1164 * The out_string pointer is modified only if a valid string can be decoded.
1166 static inline int of_property_read_string_index(const struct device_node *np,
1167 const char *propname,
1168 int index, const char **output)
1170 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1171 return rc < 0 ? rc : 0;
1175 * of_property_read_bool - Find a property
1176 * @np: device node from which the property value is to be read.
1177 * @propname: name of the property to be searched.
1179 * Search for a property in a device node.
1180 * Returns true if the property exists false otherwise.
1182 static inline bool of_property_read_bool(const struct device_node *np,
1183 const char *propname)
1185 struct property *prop = of_find_property(np, propname, NULL);
1187 return prop ? true : false;
1190 static inline int of_property_read_u8(const struct device_node *np,
1191 const char *propname,
1194 return of_property_read_u8_array(np, propname, out_value, 1);
1197 static inline int of_property_read_u16(const struct device_node *np,
1198 const char *propname,
1201 return of_property_read_u16_array(np, propname, out_value, 1);
1204 static inline int of_property_read_u32(const struct device_node *np,
1205 const char *propname,
1208 return of_property_read_u32_array(np, propname, out_value, 1);
1211 static inline int of_property_read_s32(const struct device_node *np,
1212 const char *propname,
1215 return of_property_read_u32(np, propname, (u32*) out_value);
1218 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1219 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1220 err = of_phandle_iterator_next(it); \
1222 err = of_phandle_iterator_next(it))
1224 #define of_property_for_each_u32(np, propname, prop, p, u) \
1225 for (prop = of_find_property(np, propname, NULL), \
1226 p = of_prop_next_u32(prop, NULL, &u); \
1228 p = of_prop_next_u32(prop, p, &u))
1230 #define of_property_for_each_string(np, propname, prop, s) \
1231 for (prop = of_find_property(np, propname, NULL), \
1232 s = of_prop_next_string(prop, NULL); \
1234 s = of_prop_next_string(prop, s))
1236 #define for_each_node_by_name(dn, name) \
1237 for (dn = of_find_node_by_name(NULL, name); dn; \
1238 dn = of_find_node_by_name(dn, name))
1239 #define for_each_node_by_type(dn, type) \
1240 for (dn = of_find_node_by_type(NULL, type); dn; \
1241 dn = of_find_node_by_type(dn, type))
1242 #define for_each_compatible_node(dn, type, compatible) \
1243 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1244 dn = of_find_compatible_node(dn, type, compatible))
1245 #define for_each_matching_node(dn, matches) \
1246 for (dn = of_find_matching_node(NULL, matches); dn; \
1247 dn = of_find_matching_node(dn, matches))
1248 #define for_each_matching_node_and_match(dn, matches, match) \
1249 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1250 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1252 #define for_each_child_of_node(parent, child) \
1253 for (child = of_get_next_child(parent, NULL); child != NULL; \
1254 child = of_get_next_child(parent, child))
1255 #define for_each_available_child_of_node(parent, child) \
1256 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1257 child = of_get_next_available_child(parent, child))
1259 #define for_each_of_cpu_node(cpu) \
1260 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1261 cpu = of_get_next_cpu_node(cpu))
1263 #define for_each_node_with_property(dn, prop_name) \
1264 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1265 dn = of_find_node_with_property(dn, prop_name))
1267 static inline int of_get_child_count(const struct device_node *np)
1269 struct device_node *child;
1272 for_each_child_of_node(np, child)
1278 static inline int of_get_available_child_count(const struct device_node *np)
1280 struct device_node *child;
1283 for_each_available_child_of_node(np, child)
1289 #if defined(CONFIG_OF) && !defined(MODULE)
1290 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1291 static const struct of_device_id __of_table_##name \
1292 __used __section(__##table##_of_table) \
1293 = { .compatible = compat, \
1294 .data = (fn == (fn_type)NULL) ? fn : fn }
1296 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1297 static const struct of_device_id __of_table_##name \
1298 __attribute__((unused)) \
1299 = { .compatible = compat, \
1300 .data = (fn == (fn_type)NULL) ? fn : fn }
1303 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1304 typedef int (*of_init_fn_1_ret)(struct device_node *);
1305 typedef void (*of_init_fn_1)(struct device_node *);
1307 #define OF_DECLARE_1(table, name, compat, fn) \
1308 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1309 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1310 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1311 #define OF_DECLARE_2(table, name, compat, fn) \
1312 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1315 * struct of_changeset_entry - Holds a changeset entry
1317 * @node: list_head for the log list
1318 * @action: notifier action
1319 * @np: pointer to the device node affected
1320 * @prop: pointer to the property affected
1321 * @old_prop: hold a pointer to the original property
1323 * Every modification of the device tree during a changeset
1324 * is held in a list of of_changeset_entry structures.
1325 * That way we can recover from a partial application, or we can
1326 * revert the changeset
1328 struct of_changeset_entry {
1329 struct list_head node;
1330 unsigned long action;
1331 struct device_node *np;
1332 struct property *prop;
1333 struct property *old_prop;
1337 * struct of_changeset - changeset tracker structure
1339 * @entries: list_head for the changeset entries
1341 * changesets are a convenient way to apply bulk changes to the
1342 * live tree. In case of an error, changes are rolled-back.
1343 * changesets live on after initial application, and if not
1344 * destroyed after use, they can be reverted in one single call.
1346 struct of_changeset {
1347 struct list_head entries;
1350 enum of_reconfig_change {
1351 OF_RECONFIG_NO_CHANGE = 0,
1352 OF_RECONFIG_CHANGE_ADD,
1353 OF_RECONFIG_CHANGE_REMOVE,
1356 #ifdef CONFIG_OF_DYNAMIC
1357 extern int of_reconfig_notifier_register(struct notifier_block *);
1358 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1359 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1360 extern int of_reconfig_get_state_change(unsigned long action,
1361 struct of_reconfig_data *arg);
1363 extern void of_changeset_init(struct of_changeset *ocs);
1364 extern void of_changeset_destroy(struct of_changeset *ocs);
1365 extern int of_changeset_apply(struct of_changeset *ocs);
1366 extern int of_changeset_revert(struct of_changeset *ocs);
1367 extern int of_changeset_action(struct of_changeset *ocs,
1368 unsigned long action, struct device_node *np,
1369 struct property *prop);
1371 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1372 struct device_node *np)
1374 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1377 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1378 struct device_node *np)
1380 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1383 static inline int of_changeset_add_property(struct of_changeset *ocs,
1384 struct device_node *np, struct property *prop)
1386 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1389 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1390 struct device_node *np, struct property *prop)
1392 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1395 static inline int of_changeset_update_property(struct of_changeset *ocs,
1396 struct device_node *np, struct property *prop)
1398 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1400 #else /* CONFIG_OF_DYNAMIC */
1401 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1405 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1409 static inline int of_reconfig_notify(unsigned long action,
1410 struct of_reconfig_data *arg)
1414 static inline int of_reconfig_get_state_change(unsigned long action,
1415 struct of_reconfig_data *arg)
1419 #endif /* CONFIG_OF_DYNAMIC */
1422 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1423 * @np: Pointer to the given device_node
1425 * return true if present false otherwise
1427 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1429 return of_property_read_bool(np, "system-power-controller");
1436 enum of_overlay_notify_action {
1437 OF_OVERLAY_PRE_APPLY = 0,
1438 OF_OVERLAY_POST_APPLY,
1439 OF_OVERLAY_PRE_REMOVE,
1440 OF_OVERLAY_POST_REMOVE,
1443 struct of_overlay_notify_data {
1444 struct device_node *overlay;
1445 struct device_node *target;
1448 #ifdef CONFIG_OF_OVERLAY
1450 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1452 int of_overlay_remove(int *ovcs_id);
1453 int of_overlay_remove_all(void);
1455 int of_overlay_notifier_register(struct notifier_block *nb);
1456 int of_overlay_notifier_unregister(struct notifier_block *nb);
1460 static inline int of_overlay_fdt_apply(void *overlay_fdt, u32 overlay_fdt_size,
1466 static inline int of_overlay_remove(int *ovcs_id)
1471 static inline int of_overlay_remove_all(void)
1476 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1481 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1488 #endif /* _LINUX_OF_H */