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(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,
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 struct device_node *of_parse_phandle(const struct device_node *np,
368 const char *phandle_name,
370 extern int of_parse_phandle_with_args(const struct device_node *np,
371 const char *list_name, const char *cells_name, int index,
372 struct of_phandle_args *out_args);
373 extern int of_parse_phandle_with_args_map(const struct device_node *np,
374 const char *list_name, const char *stem_name, int index,
375 struct of_phandle_args *out_args);
376 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
377 const char *list_name, int cells_count, int index,
378 struct of_phandle_args *out_args);
379 extern int of_count_phandle_with_args(const struct device_node *np,
380 const char *list_name, const char *cells_name);
382 /* phandle iterator functions */
383 extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
384 const struct device_node *np,
385 const char *list_name,
386 const char *cells_name,
389 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
390 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
394 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
395 extern int of_alias_get_id(struct device_node *np, const char *stem);
396 extern int of_alias_get_highest_id(const char *stem);
397 extern int of_alias_get_alias_list(const struct of_device_id *matches,
398 const char *stem, unsigned long *bitmap,
401 extern int of_machine_is_compatible(const char *compat);
403 extern int of_add_property(struct device_node *np, struct property *prop);
404 extern int of_remove_property(struct device_node *np, struct property *prop);
405 extern int of_update_property(struct device_node *np, struct property *newprop);
407 /* For updating the device tree at runtime */
408 #define OF_RECONFIG_ATTACH_NODE 0x0001
409 #define OF_RECONFIG_DETACH_NODE 0x0002
410 #define OF_RECONFIG_ADD_PROPERTY 0x0003
411 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
412 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
414 extern int of_attach_node(struct device_node *);
415 extern int of_detach_node(struct device_node *);
417 #define of_match_ptr(_ptr) (_ptr)
420 * of_property_read_u8_array - Find and read an array of u8 from a property.
422 * @np: device node from which the property value is to be read.
423 * @propname: name of the property to be searched.
424 * @out_values: pointer to return value, modified only if return value is 0.
425 * @sz: number of array elements to read
427 * Search for a property in a device node and read 8-bit value(s) from
430 * dts entry of array should be like:
431 * ``property = /bits/ 8 <0x50 0x60 0x70>;``
433 * Return: 0 on success, -EINVAL if the property does not exist,
434 * -ENODATA if property does not have a value, and -EOVERFLOW if the
435 * property data isn't large enough.
437 * The out_values is modified only if a valid u8 value can be decoded.
439 static inline int of_property_read_u8_array(const struct device_node *np,
440 const char *propname,
441 u8 *out_values, size_t sz)
443 int ret = of_property_read_variable_u8_array(np, propname, out_values,
452 * of_property_read_u16_array - Find and read an array of u16 from a property.
454 * @np: device node from which the property value is to be read.
455 * @propname: name of the property to be searched.
456 * @out_values: pointer to return value, modified only if return value is 0.
457 * @sz: number of array elements to read
459 * Search for a property in a device node and read 16-bit value(s) from
462 * dts entry of array should be like:
463 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
465 * Return: 0 on success, -EINVAL if the property does not exist,
466 * -ENODATA if property does not have a value, and -EOVERFLOW if the
467 * property data isn't large enough.
469 * The out_values is modified only if a valid u16 value can be decoded.
471 static inline int of_property_read_u16_array(const struct device_node *np,
472 const char *propname,
473 u16 *out_values, size_t sz)
475 int ret = of_property_read_variable_u16_array(np, propname, out_values,
484 * of_property_read_u32_array - Find and read an array of 32 bit integers
487 * @np: device node from which the property value is to be read.
488 * @propname: name of the property to be searched.
489 * @out_values: pointer to return value, modified only if return value is 0.
490 * @sz: number of array elements to read
492 * Search for a property in a device node and read 32-bit value(s) from
495 * Return: 0 on success, -EINVAL if the property does not exist,
496 * -ENODATA if property does not have a value, and -EOVERFLOW if the
497 * property data isn't large enough.
499 * The out_values is modified only if a valid u32 value can be decoded.
501 static inline int of_property_read_u32_array(const struct device_node *np,
502 const char *propname,
503 u32 *out_values, size_t sz)
505 int ret = of_property_read_variable_u32_array(np, propname, out_values,
514 * of_property_read_u64_array - Find and read an array of 64 bit integers
517 * @np: device node from which the property value is to be read.
518 * @propname: name of the property to be searched.
519 * @out_values: pointer to return value, modified only if return value is 0.
520 * @sz: number of array elements to read
522 * Search for a property in a device node and read 64-bit value(s) from
525 * Return: 0 on success, -EINVAL if the property does not exist,
526 * -ENODATA if property does not have a value, and -EOVERFLOW if the
527 * property data isn't large enough.
529 * The out_values is modified only if a valid u64 value can be decoded.
531 static inline int of_property_read_u64_array(const struct device_node *np,
532 const char *propname,
533 u64 *out_values, size_t sz)
535 int ret = of_property_read_variable_u64_array(np, propname, out_values,
544 * struct property *prop;
548 * of_property_for_each_u32(np, "propname", prop, p, u)
549 * printk("U32 value: %x\n", u);
551 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
554 * struct property *prop;
557 * of_property_for_each_string(np, "propname", prop, s)
558 * printk("String value: %s\n", s);
560 const char *of_prop_next_string(struct property *prop, const char *cur);
562 bool of_console_check(struct device_node *dn, char *name, int index);
564 extern int of_cpu_node_to_id(struct device_node *np);
566 int of_map_id(struct device_node *np, u32 id,
567 const char *map_name, const char *map_mask_name,
568 struct device_node **target, u32 *id_out);
570 phys_addr_t of_dma_get_max_cpu_address(struct device_node *np);
573 void *of_kexec_alloc_and_setup_fdt(const struct kimage *image,
574 unsigned long initrd_load_addr,
575 unsigned long initrd_len,
576 const char *cmdline, size_t extra_fdt_size);
577 int ima_get_kexec_buffer(void **addr, size_t *size);
578 int ima_free_kexec_buffer(void);
579 #else /* CONFIG_OF */
581 static inline void of_core_init(void)
585 static inline bool is_of_node(const struct fwnode_handle *fwnode)
590 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode)
595 static inline bool of_node_name_eq(const struct device_node *np, const char *name)
600 static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix)
605 static inline const char* of_node_full_name(const struct device_node *np)
610 static inline struct device_node *of_find_node_by_name(struct device_node *from,
616 static inline struct device_node *of_find_node_by_type(struct device_node *from,
622 static inline struct device_node *of_find_matching_node_and_match(
623 struct device_node *from,
624 const struct of_device_id *matches,
625 const struct of_device_id **match)
630 static inline struct device_node *of_find_node_by_path(const char *path)
635 static inline struct device_node *of_find_node_opts_by_path(const char *path,
641 static inline struct device_node *of_find_node_by_phandle(phandle handle)
646 static inline struct device_node *of_get_parent(const struct device_node *node)
651 static inline struct device_node *of_get_next_parent(struct device_node *node)
656 static inline struct device_node *of_get_next_child(
657 const struct device_node *node, struct device_node *prev)
662 static inline struct device_node *of_get_next_available_child(
663 const struct device_node *node, struct device_node *prev)
668 static inline struct device_node *of_find_node_with_property(
669 struct device_node *from, const char *prop_name)
674 #define of_fwnode_handle(node) NULL
676 static inline bool of_have_populated_dt(void)
681 static inline struct device_node *of_get_compatible_child(const struct device_node *parent,
682 const char *compatible)
687 static inline struct device_node *of_get_child_by_name(
688 const struct device_node *node,
694 static inline int of_device_is_compatible(const struct device_node *device,
700 static inline int of_device_compatible_match(struct device_node *device,
701 const char *const *compat)
706 static inline bool of_device_is_available(const struct device_node *device)
711 static inline bool of_device_is_big_endian(const struct device_node *device)
716 static inline struct property *of_find_property(const struct device_node *np,
723 static inline struct device_node *of_find_compatible_node(
724 struct device_node *from,
731 static inline int of_property_count_elems_of_size(const struct device_node *np,
732 const char *propname, int elem_size)
737 static inline int of_property_read_u8_array(const struct device_node *np,
738 const char *propname, u8 *out_values, size_t sz)
743 static inline int of_property_read_u16_array(const struct device_node *np,
744 const char *propname, u16 *out_values, size_t sz)
749 static inline int of_property_read_u32_array(const struct device_node *np,
750 const char *propname,
751 u32 *out_values, size_t sz)
756 static inline int of_property_read_u64_array(const struct device_node *np,
757 const char *propname,
758 u64 *out_values, size_t sz)
763 static inline int of_property_read_u32_index(const struct device_node *np,
764 const char *propname, u32 index, u32 *out_value)
769 static inline int of_property_read_u64_index(const struct device_node *np,
770 const char *propname, u32 index, u64 *out_value)
775 static inline const void *of_get_property(const struct device_node *node,
782 static inline struct device_node *of_get_cpu_node(int cpu,
783 unsigned int *thread)
788 static inline struct device_node *of_get_next_cpu_node(struct device_node *prev)
793 static inline struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
799 static inline int of_n_addr_cells(struct device_node *np)
804 static inline int of_n_size_cells(struct device_node *np)
809 static inline int of_property_read_variable_u8_array(const struct device_node *np,
810 const char *propname, u8 *out_values,
811 size_t sz_min, size_t sz_max)
816 static inline int of_property_read_variable_u16_array(const struct device_node *np,
817 const char *propname, u16 *out_values,
818 size_t sz_min, size_t sz_max)
823 static inline int of_property_read_variable_u32_array(const struct device_node *np,
824 const char *propname,
832 static inline int of_property_read_u64(const struct device_node *np,
833 const char *propname, u64 *out_value)
838 static inline int of_property_read_variable_u64_array(const struct device_node *np,
839 const char *propname,
847 static inline int of_property_read_string(const struct device_node *np,
848 const char *propname,
849 const char **out_string)
854 static inline int of_property_match_string(const struct device_node *np,
855 const char *propname,
861 static inline int of_property_read_string_helper(const struct device_node *np,
862 const char *propname,
863 const char **out_strs, size_t sz, int index)
868 static inline struct device_node *of_parse_phandle(const struct device_node *np,
869 const char *phandle_name,
875 static inline int of_parse_phandle_with_args(const struct device_node *np,
876 const char *list_name,
877 const char *cells_name,
879 struct of_phandle_args *out_args)
884 static inline int of_parse_phandle_with_args_map(const struct device_node *np,
885 const char *list_name,
886 const char *stem_name,
888 struct of_phandle_args *out_args)
893 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
894 const char *list_name, int cells_count, int index,
895 struct of_phandle_args *out_args)
900 static inline int of_count_phandle_with_args(const struct device_node *np,
901 const char *list_name,
902 const char *cells_name)
907 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
908 const struct device_node *np,
909 const char *list_name,
910 const char *cells_name,
916 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
921 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
928 static inline int of_alias_get_id(struct device_node *np, const char *stem)
933 static inline int of_alias_get_highest_id(const char *stem)
938 static inline int of_alias_get_alias_list(const struct of_device_id *matches,
939 const char *stem, unsigned long *bitmap,
945 static inline int of_machine_is_compatible(const char *compat)
950 static inline int of_add_property(struct device_node *np, struct property *prop)
955 static inline int of_remove_property(struct device_node *np, struct property *prop)
960 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
965 static inline const __be32 *of_prop_next_u32(struct property *prop,
966 const __be32 *cur, u32 *pu)
971 static inline const char *of_prop_next_string(struct property *prop,
977 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
982 static inline int of_node_test_and_set_flag(struct device_node *n,
988 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
992 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
996 static inline int of_property_check_flag(struct property *p, unsigned long flag)
1001 static inline void of_property_set_flag(struct property *p, unsigned long flag)
1005 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
1009 static inline int of_cpu_node_to_id(struct device_node *np)
1014 static inline int of_map_id(struct device_node *np, u32 id,
1015 const char *map_name, const char *map_mask_name,
1016 struct device_node **target, u32 *id_out)
1021 static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np)
1023 return PHYS_ADDR_MAX;
1026 #define of_match_ptr(_ptr) NULL
1027 #define of_match_node(_matches, _node) NULL
1028 #endif /* CONFIG_OF */
1030 /* Default string compare functions, Allow arch asm/prom.h to override */
1031 #if !defined(of_compat_cmp)
1032 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
1033 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
1034 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
1037 static inline int of_prop_val_eq(struct property *p1, struct property *p2)
1039 return p1->length == p2->length &&
1040 !memcmp(p1->value, p2->value, (size_t)p1->length);
1043 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
1044 extern int of_node_to_nid(struct device_node *np);
1046 static inline int of_node_to_nid(struct device_node *device)
1048 return NUMA_NO_NODE;
1052 #ifdef CONFIG_OF_NUMA
1053 extern int of_numa_init(void);
1055 static inline int of_numa_init(void)
1061 static inline struct device_node *of_find_matching_node(
1062 struct device_node *from,
1063 const struct of_device_id *matches)
1065 return of_find_matching_node_and_match(from, matches, NULL);
1068 static inline const char *of_node_get_device_type(const struct device_node *np)
1070 return of_get_property(np, "device_type", NULL);
1073 static inline bool of_node_is_type(const struct device_node *np, const char *type)
1075 const char *match = of_node_get_device_type(np);
1077 return np && match && type && !strcmp(match, type);
1081 * of_property_count_u8_elems - Count the number of u8 elements in a property
1083 * @np: device node from which the property value is to be read.
1084 * @propname: name of the property to be searched.
1086 * Search for a property in a device node and count the number of u8 elements
1089 * Return: The number of elements on sucess, -EINVAL if the property does
1090 * not exist or its length does not match a multiple of u8 and -ENODATA if the
1091 * property does not have a value.
1093 static inline int of_property_count_u8_elems(const struct device_node *np,
1094 const char *propname)
1096 return of_property_count_elems_of_size(np, propname, sizeof(u8));
1100 * of_property_count_u16_elems - Count the number of u16 elements in a property
1102 * @np: device node from which the property value is to be read.
1103 * @propname: name of the property to be searched.
1105 * Search for a property in a device node and count the number of u16 elements
1108 * Return: The number of elements on sucess, -EINVAL if the property does
1109 * not exist or its length does not match a multiple of u16 and -ENODATA if the
1110 * property does not have a value.
1112 static inline int of_property_count_u16_elems(const struct device_node *np,
1113 const char *propname)
1115 return of_property_count_elems_of_size(np, propname, sizeof(u16));
1119 * of_property_count_u32_elems - Count the number of u32 elements in a property
1121 * @np: device node from which the property value is to be read.
1122 * @propname: name of the property to be searched.
1124 * Search for a property in a device node and count the number of u32 elements
1127 * Return: The number of elements on sucess, -EINVAL if the property does
1128 * not exist or its length does not match a multiple of u32 and -ENODATA if the
1129 * property does not have a value.
1131 static inline int of_property_count_u32_elems(const struct device_node *np,
1132 const char *propname)
1134 return of_property_count_elems_of_size(np, propname, sizeof(u32));
1138 * of_property_count_u64_elems - Count the number of u64 elements in a property
1140 * @np: device node from which the property value is to be read.
1141 * @propname: name of the property to be searched.
1143 * Search for a property in a device node and count the number of u64 elements
1146 * Return: The number of elements on sucess, -EINVAL if the property does
1147 * not exist or its length does not match a multiple of u64 and -ENODATA if the
1148 * property does not have a value.
1150 static inline int of_property_count_u64_elems(const struct device_node *np,
1151 const char *propname)
1153 return of_property_count_elems_of_size(np, propname, sizeof(u64));
1157 * of_property_read_string_array() - Read an array of strings from a multiple
1159 * @np: device node from which the property value is to be read.
1160 * @propname: name of the property to be searched.
1161 * @out_strs: output array of string pointers.
1162 * @sz: number of array elements to read.
1164 * Search for a property in a device tree node and retrieve a list of
1165 * terminated string values (pointer to data, not a copy) in that property.
1167 * Return: If @out_strs is NULL, the number of strings in the property is returned.
1169 static inline int of_property_read_string_array(const struct device_node *np,
1170 const char *propname, const char **out_strs,
1173 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1177 * of_property_count_strings() - Find and return the number of strings from a
1178 * multiple strings property.
1179 * @np: device node from which the property value is to be read.
1180 * @propname: name of the property to be searched.
1182 * Search for a property in a device tree node and retrieve the number of null
1183 * terminated string contain in it.
1185 * Return: The number of strings on success, -EINVAL if the property does not
1186 * exist, -ENODATA if property does not have a value, and -EILSEQ if the string
1187 * is not null-terminated within the length of the property data.
1189 static inline int of_property_count_strings(const struct device_node *np,
1190 const char *propname)
1192 return of_property_read_string_helper(np, propname, NULL, 0, 0);
1196 * of_property_read_string_index() - Find and read a string from a multiple
1198 * @np: device node from which the property value is to be read.
1199 * @propname: name of the property to be searched.
1200 * @index: index of the string in the list of strings
1201 * @output: pointer to null terminated return string, modified only if
1202 * return value is 0.
1204 * Search for a property in a device tree node and retrieve a null
1205 * terminated string value (pointer to data, not a copy) in the list of strings
1206 * contained in that property.
1208 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
1209 * property does not have a value, and -EILSEQ if the string is not
1210 * null-terminated within the length of the property data.
1212 * The out_string pointer is modified only if a valid string can be decoded.
1214 static inline int of_property_read_string_index(const struct device_node *np,
1215 const char *propname,
1216 int index, const char **output)
1218 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1219 return rc < 0 ? rc : 0;
1223 * of_property_read_bool - Find a property
1224 * @np: device node from which the property value is to be read.
1225 * @propname: name of the property to be searched.
1227 * Search for a property in a device node.
1229 * Return: true if the property exists false otherwise.
1231 static inline bool of_property_read_bool(const struct device_node *np,
1232 const char *propname)
1234 struct property *prop = of_find_property(np, propname, NULL);
1236 return prop ? true : false;
1239 static inline int of_property_read_u8(const struct device_node *np,
1240 const char *propname,
1243 return of_property_read_u8_array(np, propname, out_value, 1);
1246 static inline int of_property_read_u16(const struct device_node *np,
1247 const char *propname,
1250 return of_property_read_u16_array(np, propname, out_value, 1);
1253 static inline int of_property_read_u32(const struct device_node *np,
1254 const char *propname,
1257 return of_property_read_u32_array(np, propname, out_value, 1);
1260 static inline int of_property_read_s32(const struct device_node *np,
1261 const char *propname,
1264 return of_property_read_u32(np, propname, (u32*) out_value);
1267 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1268 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1269 err = of_phandle_iterator_next(it); \
1271 err = of_phandle_iterator_next(it))
1273 #define of_property_for_each_u32(np, propname, prop, p, u) \
1274 for (prop = of_find_property(np, propname, NULL), \
1275 p = of_prop_next_u32(prop, NULL, &u); \
1277 p = of_prop_next_u32(prop, p, &u))
1279 #define of_property_for_each_string(np, propname, prop, s) \
1280 for (prop = of_find_property(np, propname, NULL), \
1281 s = of_prop_next_string(prop, NULL); \
1283 s = of_prop_next_string(prop, s))
1285 #define for_each_node_by_name(dn, name) \
1286 for (dn = of_find_node_by_name(NULL, name); dn; \
1287 dn = of_find_node_by_name(dn, name))
1288 #define for_each_node_by_type(dn, type) \
1289 for (dn = of_find_node_by_type(NULL, type); dn; \
1290 dn = of_find_node_by_type(dn, type))
1291 #define for_each_compatible_node(dn, type, compatible) \
1292 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1293 dn = of_find_compatible_node(dn, type, compatible))
1294 #define for_each_matching_node(dn, matches) \
1295 for (dn = of_find_matching_node(NULL, matches); dn; \
1296 dn = of_find_matching_node(dn, matches))
1297 #define for_each_matching_node_and_match(dn, matches, match) \
1298 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1299 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1301 #define for_each_child_of_node(parent, child) \
1302 for (child = of_get_next_child(parent, NULL); child != NULL; \
1303 child = of_get_next_child(parent, child))
1304 #define for_each_available_child_of_node(parent, child) \
1305 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1306 child = of_get_next_available_child(parent, child))
1308 #define for_each_of_cpu_node(cpu) \
1309 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1310 cpu = of_get_next_cpu_node(cpu))
1312 #define for_each_node_with_property(dn, prop_name) \
1313 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1314 dn = of_find_node_with_property(dn, prop_name))
1316 static inline int of_get_child_count(const struct device_node *np)
1318 struct device_node *child;
1321 for_each_child_of_node(np, child)
1327 static inline int of_get_available_child_count(const struct device_node *np)
1329 struct device_node *child;
1332 for_each_available_child_of_node(np, child)
1338 #define _OF_DECLARE_STUB(table, name, compat, fn, fn_type) \
1339 static const struct of_device_id __of_table_##name \
1340 __attribute__((unused)) \
1341 = { .compatible = compat, \
1342 .data = (fn == (fn_type)NULL) ? fn : fn }
1344 #if defined(CONFIG_OF) && !defined(MODULE)
1345 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1346 static const struct of_device_id __of_table_##name \
1347 __used __section("__" #table "_of_table") \
1348 __aligned(__alignof__(struct of_device_id)) \
1349 = { .compatible = compat, \
1350 .data = (fn == (fn_type)NULL) ? fn : fn }
1352 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1353 _OF_DECLARE_STUB(table, name, compat, fn, fn_type)
1356 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1357 typedef int (*of_init_fn_1_ret)(struct device_node *);
1358 typedef void (*of_init_fn_1)(struct device_node *);
1360 #define OF_DECLARE_1(table, name, compat, fn) \
1361 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1362 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1363 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1364 #define OF_DECLARE_2(table, name, compat, fn) \
1365 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1368 * struct of_changeset_entry - Holds a changeset entry
1370 * @node: list_head for the log list
1371 * @action: notifier action
1372 * @np: pointer to the device node affected
1373 * @prop: pointer to the property affected
1374 * @old_prop: hold a pointer to the original property
1376 * Every modification of the device tree during a changeset
1377 * is held in a list of of_changeset_entry structures.
1378 * That way we can recover from a partial application, or we can
1379 * revert the changeset
1381 struct of_changeset_entry {
1382 struct list_head node;
1383 unsigned long action;
1384 struct device_node *np;
1385 struct property *prop;
1386 struct property *old_prop;
1390 * struct of_changeset - changeset tracker structure
1392 * @entries: list_head for the changeset entries
1394 * changesets are a convenient way to apply bulk changes to the
1395 * live tree. In case of an error, changes are rolled-back.
1396 * changesets live on after initial application, and if not
1397 * destroyed after use, they can be reverted in one single call.
1399 struct of_changeset {
1400 struct list_head entries;
1403 enum of_reconfig_change {
1404 OF_RECONFIG_NO_CHANGE = 0,
1405 OF_RECONFIG_CHANGE_ADD,
1406 OF_RECONFIG_CHANGE_REMOVE,
1409 #ifdef CONFIG_OF_DYNAMIC
1410 extern int of_reconfig_notifier_register(struct notifier_block *);
1411 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1412 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1413 extern int of_reconfig_get_state_change(unsigned long action,
1414 struct of_reconfig_data *arg);
1416 extern void of_changeset_init(struct of_changeset *ocs);
1417 extern void of_changeset_destroy(struct of_changeset *ocs);
1418 extern int of_changeset_apply(struct of_changeset *ocs);
1419 extern int of_changeset_revert(struct of_changeset *ocs);
1420 extern int of_changeset_action(struct of_changeset *ocs,
1421 unsigned long action, struct device_node *np,
1422 struct property *prop);
1424 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1425 struct device_node *np)
1427 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1430 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1431 struct device_node *np)
1433 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1436 static inline int of_changeset_add_property(struct of_changeset *ocs,
1437 struct device_node *np, struct property *prop)
1439 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1442 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1443 struct device_node *np, struct property *prop)
1445 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1448 static inline int of_changeset_update_property(struct of_changeset *ocs,
1449 struct device_node *np, struct property *prop)
1451 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1453 #else /* CONFIG_OF_DYNAMIC */
1454 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1458 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1462 static inline int of_reconfig_notify(unsigned long action,
1463 struct of_reconfig_data *arg)
1467 static inline int of_reconfig_get_state_change(unsigned long action,
1468 struct of_reconfig_data *arg)
1472 #endif /* CONFIG_OF_DYNAMIC */
1475 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1476 * @np: Pointer to the given device_node
1478 * Return: true if present false otherwise
1480 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1482 return of_property_read_bool(np, "system-power-controller");
1489 enum of_overlay_notify_action {
1490 OF_OVERLAY_PRE_APPLY = 0,
1491 OF_OVERLAY_POST_APPLY,
1492 OF_OVERLAY_PRE_REMOVE,
1493 OF_OVERLAY_POST_REMOVE,
1496 struct of_overlay_notify_data {
1497 struct device_node *overlay;
1498 struct device_node *target;
1501 #ifdef CONFIG_OF_OVERLAY
1503 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1505 int of_overlay_remove(int *ovcs_id);
1506 int of_overlay_remove_all(void);
1508 int of_overlay_notifier_register(struct notifier_block *nb);
1509 int of_overlay_notifier_unregister(struct notifier_block *nb);
1513 static inline int of_overlay_fdt_apply(void *overlay_fdt, u32 overlay_fdt_size,
1519 static inline int of_overlay_remove(int *ovcs_id)
1524 static inline int of_overlay_remove_all(void)
1529 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1534 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1541 #endif /* _LINUX_OF_H */