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(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
429 * dts entry of array should be like:
430 * ``property = /bits/ 8 <0x50 0x60 0x70>;``
432 * Return: 0 on success, -EINVAL if the property does not exist,
433 * -ENODATA if property does not have a value, and -EOVERFLOW if the
434 * property data isn't large enough.
436 * The out_values is modified only if a valid u8 value can be decoded.
438 static inline int of_property_read_u8_array(const struct device_node
*np
,
439 const char *propname
,
440 u8
*out_values
, size_t sz
)
442 int ret
= of_property_read_variable_u8_array(np
, propname
, out_values
,
451 * of_property_read_u16_array - Find and read an array of u16 from a property.
453 * @np: device node from which the property value is to be read.
454 * @propname: name of the property to be searched.
455 * @out_values: pointer to return value, modified only if return value is 0.
456 * @sz: number of array elements to read
458 * Search for a property in a device node and read 16-bit value(s) from
461 * dts entry of array should be like:
462 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
464 * Return: 0 on success, -EINVAL if the property does not exist,
465 * -ENODATA if property does not have a value, and -EOVERFLOW if the
466 * property data isn't large enough.
468 * The out_values is modified only if a valid u16 value can be decoded.
470 static inline int of_property_read_u16_array(const struct device_node
*np
,
471 const char *propname
,
472 u16
*out_values
, size_t sz
)
474 int ret
= of_property_read_variable_u16_array(np
, propname
, out_values
,
483 * of_property_read_u32_array - Find and read an array of 32 bit integers
486 * @np: device node from which the property value is to be read.
487 * @propname: name of the property to be searched.
488 * @out_values: pointer to return value, modified only if return value is 0.
489 * @sz: number of array elements to read
491 * Search for a property in a device node and read 32-bit value(s) from
494 * Return: 0 on success, -EINVAL if the property does not exist,
495 * -ENODATA if property does not have a value, and -EOVERFLOW if the
496 * property data isn't large enough.
498 * The out_values is modified only if a valid u32 value can be decoded.
500 static inline int of_property_read_u32_array(const struct device_node
*np
,
501 const char *propname
,
502 u32
*out_values
, size_t sz
)
504 int ret
= of_property_read_variable_u32_array(np
, propname
, out_values
,
513 * of_property_read_u64_array - Find and read an array of 64 bit integers
516 * @np: device node from which the property value is to be read.
517 * @propname: name of the property to be searched.
518 * @out_values: pointer to return value, modified only if return value is 0.
519 * @sz: number of array elements to read
521 * Search for a property in a device node and read 64-bit value(s) from
524 * Return: 0 on success, -EINVAL if the property does not exist,
525 * -ENODATA if property does not have a value, and -EOVERFLOW if the
526 * property data isn't large enough.
528 * The out_values is modified only if a valid u64 value can be decoded.
530 static inline int of_property_read_u64_array(const struct device_node
*np
,
531 const char *propname
,
532 u64
*out_values
, size_t sz
)
534 int ret
= of_property_read_variable_u64_array(np
, propname
, out_values
,
543 * struct property *prop;
547 * of_property_for_each_u32(np, "propname", prop, p, u)
548 * printk("U32 value: %x\n", u);
550 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
553 * struct property *prop;
556 * of_property_for_each_string(np, "propname", prop, s)
557 * printk("String value: %s\n", s);
559 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
561 bool of_console_check(struct device_node
*dn
, char *name
, int index
);
563 extern int of_cpu_node_to_id(struct device_node
*np
);
565 int of_map_id(struct device_node
*np
, u32 id
,
566 const char *map_name
, const char *map_mask_name
,
567 struct device_node
**target
, u32
*id_out
);
569 phys_addr_t
of_dma_get_max_cpu_address(struct device_node
*np
);
572 void *of_kexec_alloc_and_setup_fdt(const struct kimage
*image
,
573 unsigned long initrd_load_addr
,
574 unsigned long initrd_len
,
575 const char *cmdline
, size_t extra_fdt_size
);
576 int ima_get_kexec_buffer(void **addr
, size_t *size
);
577 int ima_free_kexec_buffer(void);
578 #else /* CONFIG_OF */
580 static inline void of_core_init(void)
584 static inline bool is_of_node(const struct fwnode_handle
*fwnode
)
589 static inline struct device_node
*to_of_node(const struct fwnode_handle
*fwnode
)
594 static inline bool of_node_name_eq(const struct device_node
*np
, const char *name
)
599 static inline bool of_node_name_prefix(const struct device_node
*np
, const char *prefix
)
604 static inline const char* of_node_full_name(const struct device_node
*np
)
609 static inline struct device_node
*of_find_node_by_name(struct device_node
*from
,
615 static inline struct device_node
*of_find_node_by_type(struct device_node
*from
,
621 static inline struct device_node
*of_find_matching_node_and_match(
622 struct device_node
*from
,
623 const struct of_device_id
*matches
,
624 const struct of_device_id
**match
)
629 static inline struct device_node
*of_find_node_by_path(const char *path
)
634 static inline struct device_node
*of_find_node_opts_by_path(const char *path
,
640 static inline struct device_node
*of_find_node_by_phandle(phandle handle
)
645 static inline struct device_node
*of_get_parent(const struct device_node
*node
)
650 static inline struct device_node
*of_get_next_parent(struct device_node
*node
)
655 static inline struct device_node
*of_get_next_child(
656 const struct device_node
*node
, struct device_node
*prev
)
661 static inline struct device_node
*of_get_next_available_child(
662 const struct device_node
*node
, struct device_node
*prev
)
667 static inline struct device_node
*of_find_node_with_property(
668 struct device_node
*from
, const char *prop_name
)
673 #define of_fwnode_handle(node) NULL
675 static inline bool of_have_populated_dt(void)
680 static inline struct device_node
*of_get_compatible_child(const struct device_node
*parent
,
681 const char *compatible
)
686 static inline struct device_node
*of_get_child_by_name(
687 const struct device_node
*node
,
693 static inline int of_device_is_compatible(const struct device_node
*device
,
699 static inline int of_device_compatible_match(struct device_node
*device
,
700 const char *const *compat
)
705 static inline bool of_device_is_available(const struct device_node
*device
)
710 static inline bool of_device_is_big_endian(const struct device_node
*device
)
715 static inline struct property
*of_find_property(const struct device_node
*np
,
722 static inline struct device_node
*of_find_compatible_node(
723 struct device_node
*from
,
730 static inline int of_property_count_elems_of_size(const struct device_node
*np
,
731 const char *propname
, int elem_size
)
736 static inline int of_property_read_u8_array(const struct device_node
*np
,
737 const char *propname
, u8
*out_values
, size_t sz
)
742 static inline int of_property_read_u16_array(const struct device_node
*np
,
743 const char *propname
, u16
*out_values
, size_t sz
)
748 static inline int of_property_read_u32_array(const struct device_node
*np
,
749 const char *propname
,
750 u32
*out_values
, size_t sz
)
755 static inline int of_property_read_u64_array(const struct device_node
*np
,
756 const char *propname
,
757 u64
*out_values
, size_t sz
)
762 static inline int of_property_read_u32_index(const struct device_node
*np
,
763 const char *propname
, u32 index
, u32
*out_value
)
768 static inline int of_property_read_u64_index(const struct device_node
*np
,
769 const char *propname
, u32 index
, u64
*out_value
)
774 static inline const void *of_get_property(const struct device_node
*node
,
781 static inline struct device_node
*of_get_cpu_node(int cpu
,
782 unsigned int *thread
)
787 static inline struct device_node
*of_get_next_cpu_node(struct device_node
*prev
)
792 static inline struct device_node
*of_get_cpu_state_node(struct device_node
*cpu_node
,
798 static inline int of_n_addr_cells(struct device_node
*np
)
803 static inline int of_n_size_cells(struct device_node
*np
)
808 static inline int of_property_read_variable_u8_array(const struct device_node
*np
,
809 const char *propname
, u8
*out_values
,
810 size_t sz_min
, size_t sz_max
)
815 static inline int of_property_read_variable_u16_array(const struct device_node
*np
,
816 const char *propname
, u16
*out_values
,
817 size_t sz_min
, size_t sz_max
)
822 static inline int of_property_read_variable_u32_array(const struct device_node
*np
,
823 const char *propname
,
831 static inline int of_property_read_u64(const struct device_node
*np
,
832 const char *propname
, u64
*out_value
)
837 static inline int of_property_read_variable_u64_array(const struct device_node
*np
,
838 const char *propname
,
846 static inline int of_property_read_string(const struct device_node
*np
,
847 const char *propname
,
848 const char **out_string
)
853 static inline int of_property_match_string(const struct device_node
*np
,
854 const char *propname
,
860 static inline int of_property_read_string_helper(const struct device_node
*np
,
861 const char *propname
,
862 const char **out_strs
, size_t sz
, int index
)
867 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
868 const char *phandle_name
,
874 static inline int of_parse_phandle_with_args(const struct device_node
*np
,
875 const char *list_name
,
876 const char *cells_name
,
878 struct of_phandle_args
*out_args
)
883 static inline int of_parse_phandle_with_args_map(const struct device_node
*np
,
884 const char *list_name
,
885 const char *stem_name
,
887 struct of_phandle_args
*out_args
)
892 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
893 const char *list_name
, int cells_count
, int index
,
894 struct of_phandle_args
*out_args
)
899 static inline int of_count_phandle_with_args(struct device_node
*np
,
900 const char *list_name
,
901 const char *cells_name
)
906 static inline int of_phandle_iterator_init(struct of_phandle_iterator
*it
,
907 const struct device_node
*np
,
908 const char *list_name
,
909 const char *cells_name
,
915 static inline int of_phandle_iterator_next(struct of_phandle_iterator
*it
)
920 static inline int of_phandle_iterator_args(struct of_phandle_iterator
*it
,
927 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
932 static inline int of_alias_get_highest_id(const char *stem
)
937 static inline int of_alias_get_alias_list(const struct of_device_id
*matches
,
938 const char *stem
, unsigned long *bitmap
,
944 static inline int of_machine_is_compatible(const char *compat
)
949 static inline int of_remove_property(struct device_node
*np
, struct property
*prop
)
954 static inline bool of_console_check(const struct device_node
*dn
, const char *name
, int index
)
959 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
960 const __be32
*cur
, u32
*pu
)
965 static inline const char *of_prop_next_string(struct property
*prop
,
971 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
976 static inline int of_node_test_and_set_flag(struct device_node
*n
,
982 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
986 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
990 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
995 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
999 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
1003 static inline int of_cpu_node_to_id(struct device_node
*np
)
1008 static inline int of_map_id(struct device_node
*np
, u32 id
,
1009 const char *map_name
, const char *map_mask_name
,
1010 struct device_node
**target
, u32
*id_out
)
1015 static inline phys_addr_t
of_dma_get_max_cpu_address(struct device_node
*np
)
1017 return PHYS_ADDR_MAX
;
1020 #define of_match_ptr(_ptr) NULL
1021 #define of_match_node(_matches, _node) NULL
1022 #endif /* CONFIG_OF */
1024 /* Default string compare functions, Allow arch asm/prom.h to override */
1025 #if !defined(of_compat_cmp)
1026 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
1027 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
1028 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
1031 static inline int of_prop_val_eq(struct property
*p1
, struct property
*p2
)
1033 return p1
->length
== p2
->length
&&
1034 !memcmp(p1
->value
, p2
->value
, (size_t)p1
->length
);
1037 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
1038 extern int of_node_to_nid(struct device_node
*np
);
1040 static inline int of_node_to_nid(struct device_node
*device
)
1042 return NUMA_NO_NODE
;
1046 #ifdef CONFIG_OF_NUMA
1047 extern int of_numa_init(void);
1049 static inline int of_numa_init(void)
1055 static inline struct device_node
*of_find_matching_node(
1056 struct device_node
*from
,
1057 const struct of_device_id
*matches
)
1059 return of_find_matching_node_and_match(from
, matches
, NULL
);
1062 static inline const char *of_node_get_device_type(const struct device_node
*np
)
1064 return of_get_property(np
, "device_type", NULL
);
1067 static inline bool of_node_is_type(const struct device_node
*np
, const char *type
)
1069 const char *match
= of_node_get_device_type(np
);
1071 return np
&& match
&& type
&& !strcmp(match
, type
);
1075 * of_property_count_u8_elems - Count the number of u8 elements in a property
1077 * @np: device node from which the property value is to be read.
1078 * @propname: name of the property to be searched.
1080 * Search for a property in a device node and count the number of u8 elements
1083 * Return: The number of elements on sucess, -EINVAL if the property does
1084 * not exist or its length does not match a multiple of u8 and -ENODATA if the
1085 * property does not have a value.
1087 static inline int of_property_count_u8_elems(const struct device_node
*np
,
1088 const char *propname
)
1090 return of_property_count_elems_of_size(np
, propname
, sizeof(u8
));
1094 * of_property_count_u16_elems - Count the number of u16 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 u16 elements
1102 * Return: The number of elements on sucess, -EINVAL if the property does
1103 * not exist or its length does not match a multiple of u16 and -ENODATA if the
1104 * property does not have a value.
1106 static inline int of_property_count_u16_elems(const struct device_node
*np
,
1107 const char *propname
)
1109 return of_property_count_elems_of_size(np
, propname
, sizeof(u16
));
1113 * of_property_count_u32_elems - Count the number of u32 elements in a property
1115 * @np: device node from which the property value is to be read.
1116 * @propname: name of the property to be searched.
1118 * Search for a property in a device node and count the number of u32 elements
1121 * Return: The number of elements on sucess, -EINVAL if the property does
1122 * not exist or its length does not match a multiple of u32 and -ENODATA if the
1123 * property does not have a value.
1125 static inline int of_property_count_u32_elems(const struct device_node
*np
,
1126 const char *propname
)
1128 return of_property_count_elems_of_size(np
, propname
, sizeof(u32
));
1132 * of_property_count_u64_elems - Count the number of u64 elements in a property
1134 * @np: device node from which the property value is to be read.
1135 * @propname: name of the property to be searched.
1137 * Search for a property in a device node and count the number of u64 elements
1140 * Return: The number of elements on sucess, -EINVAL if the property does
1141 * not exist or its length does not match a multiple of u64 and -ENODATA if the
1142 * property does not have a value.
1144 static inline int of_property_count_u64_elems(const struct device_node
*np
,
1145 const char *propname
)
1147 return of_property_count_elems_of_size(np
, propname
, sizeof(u64
));
1151 * of_property_read_string_array() - Read an array of strings from a multiple
1153 * @np: device node from which the property value is to be read.
1154 * @propname: name of the property to be searched.
1155 * @out_strs: output array of string pointers.
1156 * @sz: number of array elements to read.
1158 * Search for a property in a device tree node and retrieve a list of
1159 * terminated string values (pointer to data, not a copy) in that property.
1161 * Return: If @out_strs is NULL, the number of strings in the property is returned.
1163 static inline int of_property_read_string_array(const struct device_node
*np
,
1164 const char *propname
, const char **out_strs
,
1167 return of_property_read_string_helper(np
, propname
, out_strs
, sz
, 0);
1171 * of_property_count_strings() - Find and return the number of strings from a
1172 * multiple strings property.
1173 * @np: device node from which the property value is to be read.
1174 * @propname: name of the property to be searched.
1176 * Search for a property in a device tree node and retrieve the number of null
1177 * terminated string contain in it.
1179 * Return: The number of strings on success, -EINVAL if the property does not
1180 * exist, -ENODATA if property does not have a value, and -EILSEQ if the string
1181 * is not null-terminated within the length of the property data.
1183 static inline int of_property_count_strings(const struct device_node
*np
,
1184 const char *propname
)
1186 return of_property_read_string_helper(np
, propname
, NULL
, 0, 0);
1190 * of_property_read_string_index() - Find and read a string from a multiple
1192 * @np: device node from which the property value is to be read.
1193 * @propname: name of the property to be searched.
1194 * @index: index of the string in the list of strings
1195 * @output: pointer to null terminated return string, modified only if
1196 * return value is 0.
1198 * Search for a property in a device tree node and retrieve a null
1199 * terminated string value (pointer to data, not a copy) in the list of strings
1200 * contained in that property.
1202 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
1203 * property does not have a value, and -EILSEQ if the string is not
1204 * null-terminated within the length of the property data.
1206 * The out_string pointer is modified only if a valid string can be decoded.
1208 static inline int of_property_read_string_index(const struct device_node
*np
,
1209 const char *propname
,
1210 int index
, const char **output
)
1212 int rc
= of_property_read_string_helper(np
, propname
, output
, 1, index
);
1213 return rc
< 0 ? rc
: 0;
1217 * of_property_read_bool - Find a property
1218 * @np: device node from which the property value is to be read.
1219 * @propname: name of the property to be searched.
1221 * Search for a property in a device node.
1223 * Return: true if the property exists false otherwise.
1225 static inline bool of_property_read_bool(const struct device_node
*np
,
1226 const char *propname
)
1228 struct property
*prop
= of_find_property(np
, propname
, NULL
);
1230 return prop
? true : false;
1233 static inline int of_property_read_u8(const struct device_node
*np
,
1234 const char *propname
,
1237 return of_property_read_u8_array(np
, propname
, out_value
, 1);
1240 static inline int of_property_read_u16(const struct device_node
*np
,
1241 const char *propname
,
1244 return of_property_read_u16_array(np
, propname
, out_value
, 1);
1247 static inline int of_property_read_u32(const struct device_node
*np
,
1248 const char *propname
,
1251 return of_property_read_u32_array(np
, propname
, out_value
, 1);
1254 static inline int of_property_read_s32(const struct device_node
*np
,
1255 const char *propname
,
1258 return of_property_read_u32(np
, propname
, (u32
*) out_value
);
1261 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1262 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1263 err = of_phandle_iterator_next(it); \
1265 err = of_phandle_iterator_next(it))
1267 #define of_property_for_each_u32(np, propname, prop, p, u) \
1268 for (prop = of_find_property(np, propname, NULL), \
1269 p = of_prop_next_u32(prop, NULL, &u); \
1271 p = of_prop_next_u32(prop, p, &u))
1273 #define of_property_for_each_string(np, propname, prop, s) \
1274 for (prop = of_find_property(np, propname, NULL), \
1275 s = of_prop_next_string(prop, NULL); \
1277 s = of_prop_next_string(prop, s))
1279 #define for_each_node_by_name(dn, name) \
1280 for (dn = of_find_node_by_name(NULL, name); dn; \
1281 dn = of_find_node_by_name(dn, name))
1282 #define for_each_node_by_type(dn, type) \
1283 for (dn = of_find_node_by_type(NULL, type); dn; \
1284 dn = of_find_node_by_type(dn, type))
1285 #define for_each_compatible_node(dn, type, compatible) \
1286 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1287 dn = of_find_compatible_node(dn, type, compatible))
1288 #define for_each_matching_node(dn, matches) \
1289 for (dn = of_find_matching_node(NULL, matches); dn; \
1290 dn = of_find_matching_node(dn, matches))
1291 #define for_each_matching_node_and_match(dn, matches, match) \
1292 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1293 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1295 #define for_each_child_of_node(parent, child) \
1296 for (child = of_get_next_child(parent, NULL); child != NULL; \
1297 child = of_get_next_child(parent, child))
1298 #define for_each_available_child_of_node(parent, child) \
1299 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1300 child = of_get_next_available_child(parent, child))
1302 #define for_each_of_cpu_node(cpu) \
1303 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1304 cpu = of_get_next_cpu_node(cpu))
1306 #define for_each_node_with_property(dn, prop_name) \
1307 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1308 dn = of_find_node_with_property(dn, prop_name))
1310 static inline int of_get_child_count(const struct device_node
*np
)
1312 struct device_node
*child
;
1315 for_each_child_of_node(np
, child
)
1321 static inline int of_get_available_child_count(const struct device_node
*np
)
1323 struct device_node
*child
;
1326 for_each_available_child_of_node(np
, child
)
1332 #if defined(CONFIG_OF) && !defined(MODULE)
1333 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1334 static const struct of_device_id __of_table_##name \
1335 __used __section("__" #table "_of_table") \
1336 __aligned(__alignof__(struct of_device_id)) \
1337 = { .compatible = compat, \
1338 .data = (fn == (fn_type)NULL) ? fn : fn }
1340 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1341 static const struct of_device_id __of_table_##name \
1342 __attribute__((unused)) \
1343 = { .compatible = compat, \
1344 .data = (fn == (fn_type)NULL) ? fn : fn }
1347 typedef int (*of_init_fn_2
)(struct device_node
*, struct device_node
*);
1348 typedef int (*of_init_fn_1_ret
)(struct device_node
*);
1349 typedef void (*of_init_fn_1
)(struct device_node
*);
1351 #define OF_DECLARE_1(table, name, compat, fn) \
1352 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1353 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1354 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1355 #define OF_DECLARE_2(table, name, compat, fn) \
1356 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1359 * struct of_changeset_entry - Holds a changeset entry
1361 * @node: list_head for the log list
1362 * @action: notifier action
1363 * @np: pointer to the device node affected
1364 * @prop: pointer to the property affected
1365 * @old_prop: hold a pointer to the original property
1367 * Every modification of the device tree during a changeset
1368 * is held in a list of of_changeset_entry structures.
1369 * That way we can recover from a partial application, or we can
1370 * revert the changeset
1372 struct of_changeset_entry
{
1373 struct list_head node
;
1374 unsigned long action
;
1375 struct device_node
*np
;
1376 struct property
*prop
;
1377 struct property
*old_prop
;
1381 * struct of_changeset - changeset tracker structure
1383 * @entries: list_head for the changeset entries
1385 * changesets are a convenient way to apply bulk changes to the
1386 * live tree. In case of an error, changes are rolled-back.
1387 * changesets live on after initial application, and if not
1388 * destroyed after use, they can be reverted in one single call.
1390 struct of_changeset
{
1391 struct list_head entries
;
1394 enum of_reconfig_change
{
1395 OF_RECONFIG_NO_CHANGE
= 0,
1396 OF_RECONFIG_CHANGE_ADD
,
1397 OF_RECONFIG_CHANGE_REMOVE
,
1400 #ifdef CONFIG_OF_DYNAMIC
1401 extern int of_reconfig_notifier_register(struct notifier_block
*);
1402 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
1403 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data
*rd
);
1404 extern int of_reconfig_get_state_change(unsigned long action
,
1405 struct of_reconfig_data
*arg
);
1407 extern void of_changeset_init(struct of_changeset
*ocs
);
1408 extern void of_changeset_destroy(struct of_changeset
*ocs
);
1409 extern int of_changeset_apply(struct of_changeset
*ocs
);
1410 extern int of_changeset_revert(struct of_changeset
*ocs
);
1411 extern int of_changeset_action(struct of_changeset
*ocs
,
1412 unsigned long action
, struct device_node
*np
,
1413 struct property
*prop
);
1415 static inline int of_changeset_attach_node(struct of_changeset
*ocs
,
1416 struct device_node
*np
)
1418 return of_changeset_action(ocs
, OF_RECONFIG_ATTACH_NODE
, np
, NULL
);
1421 static inline int of_changeset_detach_node(struct of_changeset
*ocs
,
1422 struct device_node
*np
)
1424 return of_changeset_action(ocs
, OF_RECONFIG_DETACH_NODE
, np
, NULL
);
1427 static inline int of_changeset_add_property(struct of_changeset
*ocs
,
1428 struct device_node
*np
, struct property
*prop
)
1430 return of_changeset_action(ocs
, OF_RECONFIG_ADD_PROPERTY
, np
, prop
);
1433 static inline int of_changeset_remove_property(struct of_changeset
*ocs
,
1434 struct device_node
*np
, struct property
*prop
)
1436 return of_changeset_action(ocs
, OF_RECONFIG_REMOVE_PROPERTY
, np
, prop
);
1439 static inline int of_changeset_update_property(struct of_changeset
*ocs
,
1440 struct device_node
*np
, struct property
*prop
)
1442 return of_changeset_action(ocs
, OF_RECONFIG_UPDATE_PROPERTY
, np
, prop
);
1444 #else /* CONFIG_OF_DYNAMIC */
1445 static inline int of_reconfig_notifier_register(struct notifier_block
*nb
)
1449 static inline int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
1453 static inline int of_reconfig_notify(unsigned long action
,
1454 struct of_reconfig_data
*arg
)
1458 static inline int of_reconfig_get_state_change(unsigned long action
,
1459 struct of_reconfig_data
*arg
)
1463 #endif /* CONFIG_OF_DYNAMIC */
1466 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1467 * @np: Pointer to the given device_node
1469 * Return: true if present false otherwise
1471 static inline bool of_device_is_system_power_controller(const struct device_node
*np
)
1473 return of_property_read_bool(np
, "system-power-controller");
1480 enum of_overlay_notify_action
{
1481 OF_OVERLAY_PRE_APPLY
= 0,
1482 OF_OVERLAY_POST_APPLY
,
1483 OF_OVERLAY_PRE_REMOVE
,
1484 OF_OVERLAY_POST_REMOVE
,
1487 struct of_overlay_notify_data
{
1488 struct device_node
*overlay
;
1489 struct device_node
*target
;
1492 #ifdef CONFIG_OF_OVERLAY
1494 int of_overlay_fdt_apply(const void *overlay_fdt
, u32 overlay_fdt_size
,
1496 int of_overlay_remove(int *ovcs_id
);
1497 int of_overlay_remove_all(void);
1499 int of_overlay_notifier_register(struct notifier_block
*nb
);
1500 int of_overlay_notifier_unregister(struct notifier_block
*nb
);
1504 static inline int of_overlay_fdt_apply(void *overlay_fdt
, u32 overlay_fdt_size
,
1510 static inline int of_overlay_remove(int *ovcs_id
)
1515 static inline int of_overlay_remove_all(void)
1520 static inline int of_overlay_notifier_register(struct notifier_block
*nb
)
1525 static inline int of_overlay_notifier_unregister(struct notifier_block
*nb
)
1532 #endif /* _LINUX_OF_H */