4 * Definitions for talking to the Open Firmware PROM on
5 * Power Macintosh and other computers.
7 * Copyright (C) 1996-2005 Paul Mackerras.
9 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10 * Updates for SPARC64 by David S. Miller
11 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
18 #include <linux/types.h>
19 #include <linux/bitops.h>
20 #include <linux/errno.h>
21 #include <linux/kobject.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/spinlock.h>
24 #include <linux/topology.h>
25 #include <linux/notifier.h>
26 #include <linux/property.h>
27 #include <linux/list.h>
29 #include <asm/byteorder.h>
30 #include <asm/errno.h>
39 struct property
*next
;
41 #if defined(CONFIG_OF_PROMTREE)
42 unsigned int unique_id
;
44 struct bin_attribute attr
;
47 #if defined(CONFIG_SPARC)
48 struct of_irq_controller
;
55 const char *full_name
;
56 struct fwnode_handle fwnode
;
58 struct property
*properties
;
59 struct property
*deadprops
; /* removed properties */
60 struct device_node
*parent
;
61 struct device_node
*child
;
62 struct device_node
*sibling
;
66 #if defined(CONFIG_SPARC)
67 const char *path_component_name
;
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 kobject_init(&node
->kobj
, &of_node_ktype
);
109 node
->fwnode
.ops
= &of_fwnode_ops
;
112 /* true when node is initialized */
113 static inline int of_node_is_initialized(struct device_node
*node
)
115 return node
&& node
->kobj
.state_initialized
;
118 /* true when node is attached (i.e. present on sysfs) */
119 static inline int of_node_is_attached(struct device_node
*node
)
121 return node
&& node
->kobj
.state_in_sysfs
;
124 #ifdef CONFIG_OF_DYNAMIC
125 extern struct device_node
*of_node_get(struct device_node
*node
);
126 extern void of_node_put(struct device_node
*node
);
127 #else /* CONFIG_OF_DYNAMIC */
128 /* Dummy ref counting routines - to be implemented later */
129 static inline struct device_node
*of_node_get(struct device_node
*node
)
133 static inline void of_node_put(struct device_node
*node
) { }
134 #endif /* !CONFIG_OF_DYNAMIC */
136 /* Pointer for first entry in chain of all nodes. */
137 extern struct device_node
*of_root
;
138 extern struct device_node
*of_chosen
;
139 extern struct device_node
*of_aliases
;
140 extern struct device_node
*of_stdout
;
141 extern raw_spinlock_t devtree_lock
;
143 /* flag descriptions (need to be visible even when !CONFIG_OF) */
144 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
145 #define OF_DETACHED 2 /* node has been detached from the device tree */
146 #define OF_POPULATED 3 /* device already created for the node */
147 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
149 #define OF_BAD_ADDR ((u64)-1)
152 void of_core_init(void);
154 static inline bool is_of_node(const struct fwnode_handle
*fwnode
)
156 return !IS_ERR_OR_NULL(fwnode
) && fwnode
->ops
== &of_fwnode_ops
;
159 #define to_of_node(__fwnode) \
161 typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \
163 is_of_node(__to_of_node_fwnode) ? \
164 container_of(__to_of_node_fwnode, \
165 struct device_node, fwnode) : \
169 #define of_fwnode_handle(node) \
171 typeof(node) __of_fwnode_handle_node = (node); \
173 __of_fwnode_handle_node ? \
174 &__of_fwnode_handle_node->fwnode : NULL; \
177 static inline bool of_have_populated_dt(void)
179 return of_root
!= NULL
;
182 static inline bool of_node_is_root(const struct device_node
*node
)
184 return node
&& (node
->parent
== NULL
);
187 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
189 return test_bit(flag
, &n
->_flags
);
192 static inline int of_node_test_and_set_flag(struct device_node
*n
,
195 return test_and_set_bit(flag
, &n
->_flags
);
198 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
200 set_bit(flag
, &n
->_flags
);
203 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
205 clear_bit(flag
, &n
->_flags
);
208 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
210 return test_bit(flag
, &p
->_flags
);
213 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
215 set_bit(flag
, &p
->_flags
);
218 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
220 clear_bit(flag
, &p
->_flags
);
223 extern struct device_node
*__of_find_all_nodes(struct device_node
*prev
);
224 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
227 * OF address retrieval & translation
230 /* Helper to read a big number; size is in cells (not bytes) */
231 static inline u64
of_read_number(const __be32
*cell
, int size
)
235 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
239 /* Like of_read_number, but we want an unsigned long result */
240 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
242 /* toss away upper bits if unsigned long is smaller than u64 */
243 return of_read_number(cell
, size
);
246 #if defined(CONFIG_SPARC)
247 #include <asm/prom.h>
250 /* Default #address and #size cells. Allow arch asm/prom.h to override */
251 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
252 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
253 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
256 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
257 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
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_child_by_name(const struct device_node
*node
,
297 extern struct device_node
*of_find_next_cache_node(const struct device_node
*);
298 extern int of_find_last_cache_level(unsigned int cpu
);
299 extern struct device_node
*of_find_node_with_property(
300 struct device_node
*from
, const char *prop_name
);
302 extern struct property
*of_find_property(const struct device_node
*np
,
305 extern int of_property_count_elems_of_size(const struct device_node
*np
,
306 const char *propname
, int elem_size
);
307 extern int of_property_read_u32_index(const struct device_node
*np
,
308 const char *propname
,
309 u32 index
, u32
*out_value
);
310 extern int of_property_read_u64_index(const struct device_node
*np
,
311 const char *propname
,
312 u32 index
, u64
*out_value
);
313 extern int of_property_read_variable_u8_array(const struct device_node
*np
,
314 const char *propname
, u8
*out_values
,
315 size_t sz_min
, size_t sz_max
);
316 extern int of_property_read_variable_u16_array(const struct device_node
*np
,
317 const char *propname
, u16
*out_values
,
318 size_t sz_min
, size_t sz_max
);
319 extern int of_property_read_variable_u32_array(const struct device_node
*np
,
320 const char *propname
,
324 extern int of_property_read_u64(const struct device_node
*np
,
325 const char *propname
, u64
*out_value
);
326 extern int of_property_read_variable_u64_array(const struct device_node
*np
,
327 const char *propname
,
332 extern int of_property_read_string(const struct device_node
*np
,
333 const char *propname
,
334 const char **out_string
);
335 extern int of_property_match_string(const struct device_node
*np
,
336 const char *propname
,
338 extern int of_property_read_string_helper(const struct device_node
*np
,
339 const char *propname
,
340 const char **out_strs
, size_t sz
, int index
);
341 extern int of_device_is_compatible(const struct device_node
*device
,
343 extern int of_device_compatible_match(struct device_node
*device
,
344 const char *const *compat
);
345 extern bool of_device_is_available(const struct device_node
*device
);
346 extern bool of_device_is_big_endian(const struct device_node
*device
);
347 extern const void *of_get_property(const struct device_node
*node
,
350 extern struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
351 #define for_each_property_of_node(dn, pp) \
352 for (pp = dn->properties; pp != NULL; pp = pp->next)
354 extern int of_n_addr_cells(struct device_node
*np
);
355 extern int of_n_size_cells(struct device_node
*np
);
356 extern const struct of_device_id
*of_match_node(
357 const struct of_device_id
*matches
, const struct device_node
*node
);
358 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
359 extern void of_print_phandle_args(const char *msg
, const struct of_phandle_args
*args
);
360 extern struct device_node
*of_parse_phandle(const struct device_node
*np
,
361 const char *phandle_name
,
363 extern int of_parse_phandle_with_args(const struct device_node
*np
,
364 const char *list_name
, const char *cells_name
, int index
,
365 struct of_phandle_args
*out_args
);
366 extern int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
367 const char *list_name
, int cells_count
, int index
,
368 struct of_phandle_args
*out_args
);
369 extern int of_count_phandle_with_args(const struct device_node
*np
,
370 const char *list_name
, const char *cells_name
);
372 /* phandle iterator functions */
373 extern int of_phandle_iterator_init(struct of_phandle_iterator
*it
,
374 const struct device_node
*np
,
375 const char *list_name
,
376 const char *cells_name
,
379 extern int of_phandle_iterator_next(struct of_phandle_iterator
*it
);
380 extern int of_phandle_iterator_args(struct of_phandle_iterator
*it
,
384 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
385 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
386 extern int of_alias_get_highest_id(const char *stem
);
388 extern int of_machine_is_compatible(const char *compat
);
390 extern int of_add_property(struct device_node
*np
, struct property
*prop
);
391 extern int of_remove_property(struct device_node
*np
, struct property
*prop
);
392 extern int of_update_property(struct device_node
*np
, struct property
*newprop
);
394 /* For updating the device tree at runtime */
395 #define OF_RECONFIG_ATTACH_NODE 0x0001
396 #define OF_RECONFIG_DETACH_NODE 0x0002
397 #define OF_RECONFIG_ADD_PROPERTY 0x0003
398 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
399 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
401 extern int of_attach_node(struct device_node
*);
402 extern int of_detach_node(struct device_node
*);
404 #define of_match_ptr(_ptr) (_ptr)
407 * of_property_read_u8_array - Find and read an array of u8 from a property.
409 * @np: device node from which the property value is to be read.
410 * @propname: name of the property to be searched.
411 * @out_values: pointer to return value, modified only if return value is 0.
412 * @sz: number of array elements to read
414 * Search for a property in a device node and read 8-bit value(s) from
415 * it. Returns 0 on success, -EINVAL if the property does not exist,
416 * -ENODATA if property does not have a value, and -EOVERFLOW if the
417 * property data isn't large enough.
419 * dts entry of array should be like:
420 * property = /bits/ 8 <0x50 0x60 0x70>;
422 * The out_values is modified only if a valid u8 value can be decoded.
424 static inline int of_property_read_u8_array(const struct device_node
*np
,
425 const char *propname
,
426 u8
*out_values
, size_t sz
)
428 int ret
= of_property_read_variable_u8_array(np
, propname
, out_values
,
437 * of_property_read_u16_array - Find and read an array of u16 from a property.
439 * @np: device node from which the property value is to be read.
440 * @propname: name of the property to be searched.
441 * @out_values: pointer to return value, modified only if return value is 0.
442 * @sz: number of array elements to read
444 * Search for a property in a device node and read 16-bit value(s) from
445 * it. Returns 0 on success, -EINVAL if the property does not exist,
446 * -ENODATA if property does not have a value, and -EOVERFLOW if the
447 * property data isn't large enough.
449 * dts entry of array should be like:
450 * property = /bits/ 16 <0x5000 0x6000 0x7000>;
452 * The out_values is modified only if a valid u16 value can be decoded.
454 static inline int of_property_read_u16_array(const struct device_node
*np
,
455 const char *propname
,
456 u16
*out_values
, size_t sz
)
458 int ret
= of_property_read_variable_u16_array(np
, propname
, out_values
,
467 * of_property_read_u32_array - Find and read an array of 32 bit integers
470 * @np: device node from which the property value is to be read.
471 * @propname: name of the property to be searched.
472 * @out_values: pointer to return value, modified only if return value is 0.
473 * @sz: number of array elements to read
475 * Search for a property in a device node and read 32-bit value(s) from
476 * it. Returns 0 on success, -EINVAL if the property does not exist,
477 * -ENODATA if property does not have a value, and -EOVERFLOW if the
478 * property data isn't large enough.
480 * The out_values is modified only if a valid u32 value can be decoded.
482 static inline int of_property_read_u32_array(const struct device_node
*np
,
483 const char *propname
,
484 u32
*out_values
, size_t sz
)
486 int ret
= of_property_read_variable_u32_array(np
, propname
, out_values
,
495 * of_property_read_u64_array - Find and read an array of 64 bit integers
498 * @np: device node from which the property value is to be read.
499 * @propname: name of the property to be searched.
500 * @out_values: pointer to return value, modified only if return value is 0.
501 * @sz: number of array elements to read
503 * Search for a property in a device node and read 64-bit value(s) from
504 * it. Returns 0 on success, -EINVAL if the property does not exist,
505 * -ENODATA if property does not have a value, and -EOVERFLOW if the
506 * property data isn't large enough.
508 * The out_values is modified only if a valid u64 value can be decoded.
510 static inline int of_property_read_u64_array(const struct device_node
*np
,
511 const char *propname
,
512 u64
*out_values
, size_t sz
)
514 int ret
= of_property_read_variable_u64_array(np
, propname
, out_values
,
523 * struct property *prop;
527 * of_property_for_each_u32(np, "propname", prop, p, u)
528 * printk("U32 value: %x\n", u);
530 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
533 * struct property *prop;
536 * of_property_for_each_string(np, "propname", prop, s)
537 * printk("String value: %s\n", s);
539 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
541 bool of_console_check(struct device_node
*dn
, char *name
, int index
);
543 #else /* CONFIG_OF */
545 static inline void of_core_init(void)
549 static inline bool is_of_node(const struct fwnode_handle
*fwnode
)
554 static inline struct device_node
*to_of_node(const struct fwnode_handle
*fwnode
)
559 static inline const char* of_node_full_name(const struct device_node
*np
)
564 static inline struct device_node
*of_find_node_by_name(struct device_node
*from
,
570 static inline struct device_node
*of_find_node_by_type(struct device_node
*from
,
576 static inline struct device_node
*of_find_matching_node_and_match(
577 struct device_node
*from
,
578 const struct of_device_id
*matches
,
579 const struct of_device_id
**match
)
584 static inline struct device_node
*of_find_node_by_path(const char *path
)
589 static inline struct device_node
*of_find_node_opts_by_path(const char *path
,
595 static inline struct device_node
*of_find_node_by_phandle(phandle handle
)
600 static inline struct device_node
*of_get_parent(const struct device_node
*node
)
605 static inline struct device_node
*of_get_next_child(
606 const struct device_node
*node
, struct device_node
*prev
)
611 static inline struct device_node
*of_get_next_available_child(
612 const struct device_node
*node
, struct device_node
*prev
)
617 static inline struct device_node
*of_find_node_with_property(
618 struct device_node
*from
, const char *prop_name
)
623 #define of_fwnode_handle(node) NULL
625 static inline bool of_have_populated_dt(void)
630 static inline struct device_node
*of_get_child_by_name(
631 const struct device_node
*node
,
637 static inline int of_device_is_compatible(const struct device_node
*device
,
643 static inline int of_device_compatible_match(struct device_node
*device
,
644 const char *const *compat
)
649 static inline bool of_device_is_available(const struct device_node
*device
)
654 static inline bool of_device_is_big_endian(const struct device_node
*device
)
659 static inline struct property
*of_find_property(const struct device_node
*np
,
666 static inline struct device_node
*of_find_compatible_node(
667 struct device_node
*from
,
674 static inline int of_property_count_elems_of_size(const struct device_node
*np
,
675 const char *propname
, int elem_size
)
680 static inline int of_property_read_u32_index(const struct device_node
*np
,
681 const char *propname
, u32 index
, u32
*out_value
)
686 static inline int of_property_read_u8_array(const struct device_node
*np
,
687 const char *propname
, u8
*out_values
, size_t sz
)
692 static inline int of_property_read_u16_array(const struct device_node
*np
,
693 const char *propname
, u16
*out_values
, size_t sz
)
698 static inline int of_property_read_u32_array(const struct device_node
*np
,
699 const char *propname
,
700 u32
*out_values
, size_t sz
)
705 static inline int of_property_read_u64_array(const struct device_node
*np
,
706 const char *propname
,
707 u64
*out_values
, size_t sz
)
712 static inline int of_property_read_string(const struct device_node
*np
,
713 const char *propname
,
714 const char **out_string
)
719 static inline int of_property_read_string_helper(const struct device_node
*np
,
720 const char *propname
,
721 const char **out_strs
, size_t sz
, int index
)
726 static inline const void *of_get_property(const struct device_node
*node
,
733 static inline struct device_node
*of_get_cpu_node(int cpu
,
734 unsigned int *thread
)
739 static inline int of_property_read_u64(const struct device_node
*np
,
740 const char *propname
, u64
*out_value
)
745 static inline int of_property_match_string(const struct device_node
*np
,
746 const char *propname
,
752 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
753 const char *phandle_name
,
759 static inline int of_parse_phandle_with_args(const struct device_node
*np
,
760 const char *list_name
,
761 const char *cells_name
,
763 struct of_phandle_args
*out_args
)
768 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
769 const char *list_name
, int cells_count
, int index
,
770 struct of_phandle_args
*out_args
)
775 static inline int of_count_phandle_with_args(struct device_node
*np
,
776 const char *list_name
,
777 const char *cells_name
)
782 static inline int of_phandle_iterator_init(struct of_phandle_iterator
*it
,
783 const struct device_node
*np
,
784 const char *list_name
,
785 const char *cells_name
,
791 static inline int of_phandle_iterator_next(struct of_phandle_iterator
*it
)
796 static inline int of_phandle_iterator_args(struct of_phandle_iterator
*it
,
803 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
808 static inline int of_alias_get_highest_id(const char *stem
)
813 static inline int of_machine_is_compatible(const char *compat
)
818 static inline bool of_console_check(const struct device_node
*dn
, const char *name
, int index
)
823 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
824 const __be32
*cur
, u32
*pu
)
829 static inline const char *of_prop_next_string(struct property
*prop
,
835 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
840 static inline int of_node_test_and_set_flag(struct device_node
*n
,
846 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
850 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
854 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
859 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
863 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
867 #define of_match_ptr(_ptr) NULL
868 #define of_match_node(_matches, _node) NULL
869 #endif /* CONFIG_OF */
871 /* Default string compare functions, Allow arch asm/prom.h to override */
872 #if !defined(of_compat_cmp)
873 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
874 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
875 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
878 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
879 extern int of_node_to_nid(struct device_node
*np
);
881 static inline int of_node_to_nid(struct device_node
*device
)
887 #ifdef CONFIG_OF_NUMA
888 extern int of_numa_init(void);
890 static inline int of_numa_init(void)
896 static inline struct device_node
*of_find_matching_node(
897 struct device_node
*from
,
898 const struct of_device_id
*matches
)
900 return of_find_matching_node_and_match(from
, matches
, NULL
);
904 * of_property_count_u8_elems - Count the number of u8 elements in a property
906 * @np: device node from which the property value is to be read.
907 * @propname: name of the property to be searched.
909 * Search for a property in a device node and count the number of u8 elements
910 * in it. Returns number of elements on sucess, -EINVAL if the property does
911 * not exist or its length does not match a multiple of u8 and -ENODATA if the
912 * property does not have a value.
914 static inline int of_property_count_u8_elems(const struct device_node
*np
,
915 const char *propname
)
917 return of_property_count_elems_of_size(np
, propname
, sizeof(u8
));
921 * of_property_count_u16_elems - Count the number of u16 elements in a property
923 * @np: device node from which the property value is to be read.
924 * @propname: name of the property to be searched.
926 * Search for a property in a device node and count the number of u16 elements
927 * in it. Returns number of elements on sucess, -EINVAL if the property does
928 * not exist or its length does not match a multiple of u16 and -ENODATA if the
929 * property does not have a value.
931 static inline int of_property_count_u16_elems(const struct device_node
*np
,
932 const char *propname
)
934 return of_property_count_elems_of_size(np
, propname
, sizeof(u16
));
938 * of_property_count_u32_elems - Count the number of u32 elements in a property
940 * @np: device node from which the property value is to be read.
941 * @propname: name of the property to be searched.
943 * Search for a property in a device node and count the number of u32 elements
944 * in it. Returns number of elements on sucess, -EINVAL if the property does
945 * not exist or its length does not match a multiple of u32 and -ENODATA if the
946 * property does not have a value.
948 static inline int of_property_count_u32_elems(const struct device_node
*np
,
949 const char *propname
)
951 return of_property_count_elems_of_size(np
, propname
, sizeof(u32
));
955 * of_property_count_u64_elems - Count the number of u64 elements in a property
957 * @np: device node from which the property value is to be read.
958 * @propname: name of the property to be searched.
960 * Search for a property in a device node and count the number of u64 elements
961 * in it. Returns number of elements on sucess, -EINVAL if the property does
962 * not exist or its length does not match a multiple of u64 and -ENODATA if the
963 * property does not have a value.
965 static inline int of_property_count_u64_elems(const struct device_node
*np
,
966 const char *propname
)
968 return of_property_count_elems_of_size(np
, propname
, sizeof(u64
));
972 * of_property_read_string_array() - Read an array of strings from a multiple
974 * @np: device node from which the property value is to be read.
975 * @propname: name of the property to be searched.
976 * @out_strs: output array of string pointers.
977 * @sz: number of array elements to read.
979 * Search for a property in a device tree node and retrieve a list of
980 * terminated string values (pointer to data, not a copy) in that property.
982 * If @out_strs is NULL, the number of strings in the property is returned.
984 static inline int of_property_read_string_array(const struct device_node
*np
,
985 const char *propname
, const char **out_strs
,
988 return of_property_read_string_helper(np
, propname
, out_strs
, sz
, 0);
992 * of_property_count_strings() - Find and return the number of strings from a
993 * multiple strings property.
994 * @np: device node from which the property value is to be read.
995 * @propname: name of the property to be searched.
997 * Search for a property in a device tree node and retrieve the number of null
998 * terminated string contain in it. Returns the number of strings on
999 * success, -EINVAL if the property does not exist, -ENODATA if property
1000 * does not have a value, and -EILSEQ if the string is not null-terminated
1001 * within the length of the property data.
1003 static inline int of_property_count_strings(const struct device_node
*np
,
1004 const char *propname
)
1006 return of_property_read_string_helper(np
, propname
, NULL
, 0, 0);
1010 * of_property_read_string_index() - Find and read a string from a multiple
1012 * @np: device node from which the property value is to be read.
1013 * @propname: name of the property to be searched.
1014 * @index: index of the string in the list of strings
1015 * @out_string: pointer to null terminated return string, modified only if
1016 * return value is 0.
1018 * Search for a property in a device tree node and retrieve a null
1019 * terminated string value (pointer to data, not a copy) in the list of strings
1020 * contained in that property.
1021 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1022 * property does not have a value, and -EILSEQ if the string is not
1023 * null-terminated within the length of the property data.
1025 * The out_string pointer is modified only if a valid string can be decoded.
1027 static inline int of_property_read_string_index(const struct device_node
*np
,
1028 const char *propname
,
1029 int index
, const char **output
)
1031 int rc
= of_property_read_string_helper(np
, propname
, output
, 1, index
);
1032 return rc
< 0 ? rc
: 0;
1036 * of_property_read_bool - Findfrom a property
1037 * @np: device node from which the property value is to be read.
1038 * @propname: name of the property to be searched.
1040 * Search for a property in a device node.
1041 * Returns true if the property exists false otherwise.
1043 static inline bool of_property_read_bool(const struct device_node
*np
,
1044 const char *propname
)
1046 struct property
*prop
= of_find_property(np
, propname
, NULL
);
1048 return prop
? true : false;
1051 static inline int of_property_read_u8(const struct device_node
*np
,
1052 const char *propname
,
1055 return of_property_read_u8_array(np
, propname
, out_value
, 1);
1058 static inline int of_property_read_u16(const struct device_node
*np
,
1059 const char *propname
,
1062 return of_property_read_u16_array(np
, propname
, out_value
, 1);
1065 static inline int of_property_read_u32(const struct device_node
*np
,
1066 const char *propname
,
1069 return of_property_read_u32_array(np
, propname
, out_value
, 1);
1072 static inline int of_property_read_s32(const struct device_node
*np
,
1073 const char *propname
,
1076 return of_property_read_u32(np
, propname
, (u32
*) out_value
);
1079 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1080 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1081 err = of_phandle_iterator_next(it); \
1083 err = of_phandle_iterator_next(it))
1085 #define of_property_for_each_u32(np, propname, prop, p, u) \
1086 for (prop = of_find_property(np, propname, NULL), \
1087 p = of_prop_next_u32(prop, NULL, &u); \
1089 p = of_prop_next_u32(prop, p, &u))
1091 #define of_property_for_each_string(np, propname, prop, s) \
1092 for (prop = of_find_property(np, propname, NULL), \
1093 s = of_prop_next_string(prop, NULL); \
1095 s = of_prop_next_string(prop, s))
1097 #define for_each_node_by_name(dn, name) \
1098 for (dn = of_find_node_by_name(NULL, name); dn; \
1099 dn = of_find_node_by_name(dn, name))
1100 #define for_each_node_by_type(dn, type) \
1101 for (dn = of_find_node_by_type(NULL, type); dn; \
1102 dn = of_find_node_by_type(dn, type))
1103 #define for_each_compatible_node(dn, type, compatible) \
1104 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1105 dn = of_find_compatible_node(dn, type, compatible))
1106 #define for_each_matching_node(dn, matches) \
1107 for (dn = of_find_matching_node(NULL, matches); dn; \
1108 dn = of_find_matching_node(dn, matches))
1109 #define for_each_matching_node_and_match(dn, matches, match) \
1110 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1111 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1113 #define for_each_child_of_node(parent, child) \
1114 for (child = of_get_next_child(parent, NULL); child != NULL; \
1115 child = of_get_next_child(parent, child))
1116 #define for_each_available_child_of_node(parent, child) \
1117 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1118 child = of_get_next_available_child(parent, child))
1120 #define for_each_node_with_property(dn, prop_name) \
1121 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1122 dn = of_find_node_with_property(dn, prop_name))
1124 static inline int of_get_child_count(const struct device_node
*np
)
1126 struct device_node
*child
;
1129 for_each_child_of_node(np
, child
)
1135 static inline int of_get_available_child_count(const struct device_node
*np
)
1137 struct device_node
*child
;
1140 for_each_available_child_of_node(np
, child
)
1146 #if defined(CONFIG_OF) && !defined(MODULE)
1147 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1148 static const struct of_device_id __of_table_##name \
1149 __used __section(__##table##_of_table) \
1150 = { .compatible = compat, \
1151 .data = (fn == (fn_type)NULL) ? fn : fn }
1153 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1154 static const struct of_device_id __of_table_##name \
1155 __attribute__((unused)) \
1156 = { .compatible = compat, \
1157 .data = (fn == (fn_type)NULL) ? fn : fn }
1160 typedef int (*of_init_fn_2
)(struct device_node
*, struct device_node
*);
1161 typedef int (*of_init_fn_1_ret
)(struct device_node
*);
1162 typedef void (*of_init_fn_1
)(struct device_node
*);
1164 #define OF_DECLARE_1(table, name, compat, fn) \
1165 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1166 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1167 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1168 #define OF_DECLARE_2(table, name, compat, fn) \
1169 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1172 * struct of_changeset_entry - Holds a changeset entry
1174 * @node: list_head for the log list
1175 * @action: notifier action
1176 * @np: pointer to the device node affected
1177 * @prop: pointer to the property affected
1178 * @old_prop: hold a pointer to the original property
1180 * Every modification of the device tree during a changeset
1181 * is held in a list of of_changeset_entry structures.
1182 * That way we can recover from a partial application, or we can
1183 * revert the changeset
1185 struct of_changeset_entry
{
1186 struct list_head node
;
1187 unsigned long action
;
1188 struct device_node
*np
;
1189 struct property
*prop
;
1190 struct property
*old_prop
;
1194 * struct of_changeset - changeset tracker structure
1196 * @entries: list_head for the changeset entries
1198 * changesets are a convenient way to apply bulk changes to the
1199 * live tree. In case of an error, changes are rolled-back.
1200 * changesets live on after initial application, and if not
1201 * destroyed after use, they can be reverted in one single call.
1203 struct of_changeset
{
1204 struct list_head entries
;
1207 enum of_reconfig_change
{
1208 OF_RECONFIG_NO_CHANGE
= 0,
1209 OF_RECONFIG_CHANGE_ADD
,
1210 OF_RECONFIG_CHANGE_REMOVE
,
1213 #ifdef CONFIG_OF_DYNAMIC
1214 extern int of_reconfig_notifier_register(struct notifier_block
*);
1215 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
1216 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data
*rd
);
1217 extern int of_reconfig_get_state_change(unsigned long action
,
1218 struct of_reconfig_data
*arg
);
1220 extern void of_changeset_init(struct of_changeset
*ocs
);
1221 extern void of_changeset_destroy(struct of_changeset
*ocs
);
1222 extern int of_changeset_apply(struct of_changeset
*ocs
);
1223 extern int of_changeset_revert(struct of_changeset
*ocs
);
1224 extern int of_changeset_action(struct of_changeset
*ocs
,
1225 unsigned long action
, struct device_node
*np
,
1226 struct property
*prop
);
1228 static inline int of_changeset_attach_node(struct of_changeset
*ocs
,
1229 struct device_node
*np
)
1231 return of_changeset_action(ocs
, OF_RECONFIG_ATTACH_NODE
, np
, NULL
);
1234 static inline int of_changeset_detach_node(struct of_changeset
*ocs
,
1235 struct device_node
*np
)
1237 return of_changeset_action(ocs
, OF_RECONFIG_DETACH_NODE
, np
, NULL
);
1240 static inline int of_changeset_add_property(struct of_changeset
*ocs
,
1241 struct device_node
*np
, struct property
*prop
)
1243 return of_changeset_action(ocs
, OF_RECONFIG_ADD_PROPERTY
, np
, prop
);
1246 static inline int of_changeset_remove_property(struct of_changeset
*ocs
,
1247 struct device_node
*np
, struct property
*prop
)
1249 return of_changeset_action(ocs
, OF_RECONFIG_REMOVE_PROPERTY
, np
, prop
);
1252 static inline int of_changeset_update_property(struct of_changeset
*ocs
,
1253 struct device_node
*np
, struct property
*prop
)
1255 return of_changeset_action(ocs
, OF_RECONFIG_UPDATE_PROPERTY
, np
, prop
);
1257 #else /* CONFIG_OF_DYNAMIC */
1258 static inline int of_reconfig_notifier_register(struct notifier_block
*nb
)
1262 static inline int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
1266 static inline int of_reconfig_notify(unsigned long action
,
1267 struct of_reconfig_data
*arg
)
1271 static inline int of_reconfig_get_state_change(unsigned long action
,
1272 struct of_reconfig_data
*arg
)
1276 #endif /* CONFIG_OF_DYNAMIC */
1278 /* CONFIG_OF_RESOLVE api */
1279 extern int of_resolve_phandles(struct device_node
*tree
);
1282 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1283 * @np: Pointer to the given device_node
1285 * return true if present false otherwise
1287 static inline bool of_device_is_system_power_controller(const struct device_node
*np
)
1289 return of_property_read_bool(np
, "system-power-controller");
1296 enum of_overlay_notify_action
{
1297 OF_OVERLAY_PRE_APPLY
,
1298 OF_OVERLAY_POST_APPLY
,
1299 OF_OVERLAY_PRE_REMOVE
,
1300 OF_OVERLAY_POST_REMOVE
,
1303 struct of_overlay_notify_data
{
1304 struct device_node
*overlay
;
1305 struct device_node
*target
;
1308 #ifdef CONFIG_OF_OVERLAY
1310 /* ID based overlays; the API for external users */
1311 int of_overlay_create(struct device_node
*tree
);
1312 int of_overlay_destroy(int id
);
1313 int of_overlay_destroy_all(void);
1315 int of_overlay_notifier_register(struct notifier_block
*nb
);
1316 int of_overlay_notifier_unregister(struct notifier_block
*nb
);
1320 static inline int of_overlay_create(struct device_node
*tree
)
1325 static inline int of_overlay_destroy(int id
)
1330 static inline int of_overlay_destroy_all(void)
1335 static inline int of_overlay_notifier_register(struct notifier_block
*nb
)
1340 static inline int of_overlay_notifier_unregister(struct notifier_block
*nb
)
1347 #endif /* _LINUX_OF_H */