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 unsigned int unique_id
;
42 struct bin_attribute attr
;
45 #if defined(CONFIG_SPARC)
46 struct of_irq_controller
;
53 const char *full_name
;
54 struct fwnode_handle fwnode
;
56 struct property
*properties
;
57 struct property
*deadprops
; /* removed properties */
58 struct device_node
*parent
;
59 struct device_node
*child
;
60 struct device_node
*sibling
;
64 #if defined(CONFIG_SPARC)
65 const char *path_component_name
;
66 unsigned int unique_id
;
67 struct of_irq_controller
*irq_trans
;
71 #define MAX_PHANDLE_ARGS 16
72 struct of_phandle_args
{
73 struct device_node
*np
;
75 uint32_t args
[MAX_PHANDLE_ARGS
];
78 struct of_phandle_iterator
{
79 /* Common iterator information */
80 const char *cells_name
;
82 const struct device_node
*parent
;
84 /* List size information */
85 const __be32
*list_end
;
86 const __be32
*phandle_end
;
88 /* Current position state */
92 struct device_node
*node
;
95 struct of_reconfig_data
{
96 struct device_node
*dn
;
97 struct property
*prop
;
98 struct property
*old_prop
;
101 /* initialize a node */
102 extern struct kobj_type of_node_ktype
;
103 static inline void of_node_init(struct device_node
*node
)
105 kobject_init(&node
->kobj
, &of_node_ktype
);
106 node
->fwnode
.type
= FWNODE_OF
;
109 /* true when node is initialized */
110 static inline int of_node_is_initialized(struct device_node
*node
)
112 return node
&& node
->kobj
.state_initialized
;
115 /* true when node is attached (i.e. present on sysfs) */
116 static inline int of_node_is_attached(struct device_node
*node
)
118 return node
&& node
->kobj
.state_in_sysfs
;
121 #ifdef CONFIG_OF_DYNAMIC
122 extern struct device_node
*of_node_get(struct device_node
*node
);
123 extern void of_node_put(struct device_node
*node
);
124 #else /* CONFIG_OF_DYNAMIC */
125 /* Dummy ref counting routines - to be implemented later */
126 static inline struct device_node
*of_node_get(struct device_node
*node
)
130 static inline void of_node_put(struct device_node
*node
) { }
131 #endif /* !CONFIG_OF_DYNAMIC */
133 /* Pointer for first entry in chain of all nodes. */
134 extern struct device_node
*of_root
;
135 extern struct device_node
*of_chosen
;
136 extern struct device_node
*of_aliases
;
137 extern struct device_node
*of_stdout
;
138 extern raw_spinlock_t devtree_lock
;
140 /* flag descriptions (need to be visible even when !CONFIG_OF) */
141 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
142 #define OF_DETACHED 2 /* node has been detached from the device tree */
143 #define OF_POPULATED 3 /* device already created for the node */
144 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
146 #define OF_BAD_ADDR ((u64)-1)
149 void of_core_init(void);
151 static inline bool is_of_node(struct fwnode_handle
*fwnode
)
153 return !IS_ERR_OR_NULL(fwnode
) && fwnode
->type
== FWNODE_OF
;
156 static inline struct device_node
*to_of_node(struct fwnode_handle
*fwnode
)
158 return is_of_node(fwnode
) ?
159 container_of(fwnode
, struct device_node
, fwnode
) : NULL
;
162 static inline bool of_have_populated_dt(void)
164 return of_root
!= NULL
;
167 static inline bool of_node_is_root(const struct device_node
*node
)
169 return node
&& (node
->parent
== NULL
);
172 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
174 return test_bit(flag
, &n
->_flags
);
177 static inline int of_node_test_and_set_flag(struct device_node
*n
,
180 return test_and_set_bit(flag
, &n
->_flags
);
183 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
185 set_bit(flag
, &n
->_flags
);
188 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
190 clear_bit(flag
, &n
->_flags
);
193 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
195 return test_bit(flag
, &p
->_flags
);
198 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
200 set_bit(flag
, &p
->_flags
);
203 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
205 clear_bit(flag
, &p
->_flags
);
208 extern struct device_node
*__of_find_all_nodes(struct device_node
*prev
);
209 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
212 * OF address retrieval & translation
215 /* Helper to read a big number; size is in cells (not bytes) */
216 static inline u64
of_read_number(const __be32
*cell
, int size
)
220 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
224 /* Like of_read_number, but we want an unsigned long result */
225 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
227 /* toss away upper bits if unsigned long is smaller than u64 */
228 return of_read_number(cell
, size
);
231 #if defined(CONFIG_SPARC)
232 #include <asm/prom.h>
235 /* Default #address and #size cells. Allow arch asm/prom.h to override */
236 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
237 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
238 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
241 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
242 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
244 static inline const char *of_node_full_name(const struct device_node
*np
)
246 return np
? np
->full_name
: "<no-node>";
249 #define for_each_of_allnodes_from(from, dn) \
250 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
251 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
252 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
254 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
256 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
257 const char *type
, const char *compat
);
258 extern struct device_node
*of_find_matching_node_and_match(
259 struct device_node
*from
,
260 const struct of_device_id
*matches
,
261 const struct of_device_id
**match
);
263 extern struct device_node
*of_find_node_opts_by_path(const char *path
,
265 static inline struct device_node
*of_find_node_by_path(const char *path
)
267 return of_find_node_opts_by_path(path
, NULL
);
270 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
271 extern struct device_node
*of_get_parent(const struct device_node
*node
);
272 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
273 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
274 struct device_node
*prev
);
275 extern struct device_node
*of_get_next_available_child(
276 const struct device_node
*node
, struct device_node
*prev
);
278 extern struct device_node
*of_get_child_by_name(const struct device_node
*node
,
282 extern struct device_node
*of_find_next_cache_node(const struct device_node
*);
283 extern struct device_node
*of_find_node_with_property(
284 struct device_node
*from
, const char *prop_name
);
286 extern struct property
*of_find_property(const struct device_node
*np
,
289 extern int of_property_count_elems_of_size(const struct device_node
*np
,
290 const char *propname
, int elem_size
);
291 extern int of_property_read_u32_index(const struct device_node
*np
,
292 const char *propname
,
293 u32 index
, u32
*out_value
);
294 extern int of_property_read_u64_index(const struct device_node
*np
,
295 const char *propname
,
296 u32 index
, u64
*out_value
);
297 extern int of_property_read_variable_u8_array(const struct device_node
*np
,
298 const char *propname
, u8
*out_values
,
299 size_t sz_min
, size_t sz_max
);
300 extern int of_property_read_variable_u16_array(const struct device_node
*np
,
301 const char *propname
, u16
*out_values
,
302 size_t sz_min
, size_t sz_max
);
303 extern int of_property_read_variable_u32_array(const struct device_node
*np
,
304 const char *propname
,
308 extern int of_property_read_u64(const struct device_node
*np
,
309 const char *propname
, u64
*out_value
);
310 extern int of_property_read_variable_u64_array(const struct device_node
*np
,
311 const char *propname
,
316 extern int of_property_read_string(const struct device_node
*np
,
317 const char *propname
,
318 const char **out_string
);
319 extern int of_property_match_string(const struct device_node
*np
,
320 const char *propname
,
322 extern int of_property_read_string_helper(const struct device_node
*np
,
323 const char *propname
,
324 const char **out_strs
, size_t sz
, int index
);
325 extern int of_device_is_compatible(const struct device_node
*device
,
327 extern int of_device_compatible_match(struct device_node
*device
,
328 const char *const *compat
);
329 extern bool of_device_is_available(const struct device_node
*device
);
330 extern bool of_device_is_big_endian(const struct device_node
*device
);
331 extern const void *of_get_property(const struct device_node
*node
,
334 extern struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
335 #define for_each_property_of_node(dn, pp) \
336 for (pp = dn->properties; pp != NULL; pp = pp->next)
338 extern int of_n_addr_cells(struct device_node
*np
);
339 extern int of_n_size_cells(struct device_node
*np
);
340 extern const struct of_device_id
*of_match_node(
341 const struct of_device_id
*matches
, const struct device_node
*node
);
342 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
343 extern void of_print_phandle_args(const char *msg
, const struct of_phandle_args
*args
);
344 extern struct device_node
*of_parse_phandle(const struct device_node
*np
,
345 const char *phandle_name
,
347 extern int of_parse_phandle_with_args(const struct device_node
*np
,
348 const char *list_name
, const char *cells_name
, int index
,
349 struct of_phandle_args
*out_args
);
350 extern int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
351 const char *list_name
, int cells_count
, int index
,
352 struct of_phandle_args
*out_args
);
353 extern int of_count_phandle_with_args(const struct device_node
*np
,
354 const char *list_name
, const char *cells_name
);
356 /* phandle iterator functions */
357 extern int of_phandle_iterator_init(struct of_phandle_iterator
*it
,
358 const struct device_node
*np
,
359 const char *list_name
,
360 const char *cells_name
,
363 extern int of_phandle_iterator_next(struct of_phandle_iterator
*it
);
364 extern int of_phandle_iterator_args(struct of_phandle_iterator
*it
,
368 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
369 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
370 extern int of_alias_get_highest_id(const char *stem
);
372 extern int of_machine_is_compatible(const char *compat
);
374 extern int of_add_property(struct device_node
*np
, struct property
*prop
);
375 extern int of_remove_property(struct device_node
*np
, struct property
*prop
);
376 extern int of_update_property(struct device_node
*np
, struct property
*newprop
);
378 /* For updating the device tree at runtime */
379 #define OF_RECONFIG_ATTACH_NODE 0x0001
380 #define OF_RECONFIG_DETACH_NODE 0x0002
381 #define OF_RECONFIG_ADD_PROPERTY 0x0003
382 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
383 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
385 extern int of_attach_node(struct device_node
*);
386 extern int of_detach_node(struct device_node
*);
388 #define of_match_ptr(_ptr) (_ptr)
391 * of_property_read_u8_array - Find and read an array of u8 from a property.
393 * @np: device node from which the property value is to be read.
394 * @propname: name of the property to be searched.
395 * @out_values: pointer to return value, modified only if return value is 0.
396 * @sz: number of array elements to read
398 * Search for a property in a device node and read 8-bit value(s) from
399 * it. Returns 0 on success, -EINVAL if the property does not exist,
400 * -ENODATA if property does not have a value, and -EOVERFLOW if the
401 * property data isn't large enough.
403 * dts entry of array should be like:
404 * property = /bits/ 8 <0x50 0x60 0x70>;
406 * The out_values is modified only if a valid u8 value can be decoded.
408 static inline int of_property_read_u8_array(const struct device_node
*np
,
409 const char *propname
,
410 u8
*out_values
, size_t sz
)
412 int ret
= of_property_read_variable_u8_array(np
, propname
, out_values
,
421 * of_property_read_u16_array - Find and read an array of u16 from a property.
423 * @np: device node from which the property value is to be read.
424 * @propname: name of the property to be searched.
425 * @out_values: pointer to return value, modified only if return value is 0.
426 * @sz: number of array elements to read
428 * Search for a property in a device node and read 16-bit value(s) from
429 * it. Returns 0 on success, -EINVAL if the property does not exist,
430 * -ENODATA if property does not have a value, and -EOVERFLOW if the
431 * property data isn't large enough.
433 * dts entry of array should be like:
434 * property = /bits/ 16 <0x5000 0x6000 0x7000>;
436 * The out_values is modified only if a valid u16 value can be decoded.
438 static inline int of_property_read_u16_array(const struct device_node
*np
,
439 const char *propname
,
440 u16
*out_values
, size_t sz
)
442 int ret
= of_property_read_variable_u16_array(np
, propname
, out_values
,
451 * of_property_read_u32_array - Find and read an array of 32 bit integers
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 32-bit value(s) from
460 * it. Returns 0 on success, -EINVAL if the property does not exist,
461 * -ENODATA if property does not have a value, and -EOVERFLOW if the
462 * property data isn't large enough.
464 * The out_values is modified only if a valid u32 value can be decoded.
466 static inline int of_property_read_u32_array(const struct device_node
*np
,
467 const char *propname
,
468 u32
*out_values
, size_t sz
)
470 int ret
= of_property_read_variable_u32_array(np
, propname
, out_values
,
479 * of_property_read_u64_array - Find and read an array of 64 bit integers
482 * @np: device node from which the property value is to be read.
483 * @propname: name of the property to be searched.
484 * @out_values: pointer to return value, modified only if return value is 0.
485 * @sz: number of array elements to read
487 * Search for a property in a device node and read 64-bit value(s) from
488 * it. Returns 0 on success, -EINVAL if the property does not exist,
489 * -ENODATA if property does not have a value, and -EOVERFLOW if the
490 * property data isn't large enough.
492 * The out_values is modified only if a valid u64 value can be decoded.
494 static inline int of_property_read_u64_array(const struct device_node
*np
,
495 const char *propname
,
496 u64
*out_values
, size_t sz
)
498 int ret
= of_property_read_variable_u64_array(np
, propname
, out_values
,
507 * struct property *prop;
511 * of_property_for_each_u32(np, "propname", prop, p, u)
512 * printk("U32 value: %x\n", u);
514 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
517 * struct property *prop;
520 * of_property_for_each_string(np, "propname", prop, s)
521 * printk("String value: %s\n", s);
523 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
525 bool of_console_check(struct device_node
*dn
, char *name
, int index
);
527 #else /* CONFIG_OF */
529 static inline void of_core_init(void)
533 static inline bool is_of_node(struct fwnode_handle
*fwnode
)
538 static inline struct device_node
*to_of_node(struct fwnode_handle
*fwnode
)
543 static inline const char* of_node_full_name(const struct device_node
*np
)
548 static inline struct device_node
*of_find_node_by_name(struct device_node
*from
,
554 static inline struct device_node
*of_find_node_by_type(struct device_node
*from
,
560 static inline struct device_node
*of_find_matching_node_and_match(
561 struct device_node
*from
,
562 const struct of_device_id
*matches
,
563 const struct of_device_id
**match
)
568 static inline struct device_node
*of_find_node_by_path(const char *path
)
573 static inline struct device_node
*of_find_node_opts_by_path(const char *path
,
579 static inline struct device_node
*of_find_node_by_phandle(phandle handle
)
584 static inline struct device_node
*of_get_parent(const struct device_node
*node
)
589 static inline struct device_node
*of_get_next_child(
590 const struct device_node
*node
, struct device_node
*prev
)
595 static inline struct device_node
*of_get_next_available_child(
596 const struct device_node
*node
, struct device_node
*prev
)
601 static inline struct device_node
*of_find_node_with_property(
602 struct device_node
*from
, const char *prop_name
)
607 static inline bool of_have_populated_dt(void)
612 static inline struct device_node
*of_get_child_by_name(
613 const struct device_node
*node
,
619 static inline int of_device_is_compatible(const struct device_node
*device
,
625 static inline bool of_device_is_available(const struct device_node
*device
)
630 static inline bool of_device_is_big_endian(const struct device_node
*device
)
635 static inline struct property
*of_find_property(const struct device_node
*np
,
642 static inline struct device_node
*of_find_compatible_node(
643 struct device_node
*from
,
650 static inline int of_property_count_elems_of_size(const struct device_node
*np
,
651 const char *propname
, int elem_size
)
656 static inline int of_property_read_u32_index(const struct device_node
*np
,
657 const char *propname
, u32 index
, u32
*out_value
)
662 static inline int of_property_read_u8_array(const struct device_node
*np
,
663 const char *propname
, u8
*out_values
, size_t sz
)
668 static inline int of_property_read_u16_array(const struct device_node
*np
,
669 const char *propname
, u16
*out_values
, size_t sz
)
674 static inline int of_property_read_u32_array(const struct device_node
*np
,
675 const char *propname
,
676 u32
*out_values
, size_t sz
)
681 static inline int of_property_read_u64_array(const struct device_node
*np
,
682 const char *propname
,
683 u64
*out_values
, size_t sz
)
688 static inline int of_property_read_string(const struct device_node
*np
,
689 const char *propname
,
690 const char **out_string
)
695 static inline int of_property_read_string_helper(const struct device_node
*np
,
696 const char *propname
,
697 const char **out_strs
, size_t sz
, int index
)
702 static inline const void *of_get_property(const struct device_node
*node
,
709 static inline struct device_node
*of_get_cpu_node(int cpu
,
710 unsigned int *thread
)
715 static inline int of_property_read_u64(const struct device_node
*np
,
716 const char *propname
, u64
*out_value
)
721 static inline int of_property_match_string(const struct device_node
*np
,
722 const char *propname
,
728 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
729 const char *phandle_name
,
735 static inline int of_parse_phandle_with_args(const struct device_node
*np
,
736 const char *list_name
,
737 const char *cells_name
,
739 struct of_phandle_args
*out_args
)
744 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
745 const char *list_name
, int cells_count
, int index
,
746 struct of_phandle_args
*out_args
)
751 static inline int of_count_phandle_with_args(struct device_node
*np
,
752 const char *list_name
,
753 const char *cells_name
)
758 static inline int of_phandle_iterator_init(struct of_phandle_iterator
*it
,
759 const struct device_node
*np
,
760 const char *list_name
,
761 const char *cells_name
,
767 static inline int of_phandle_iterator_next(struct of_phandle_iterator
*it
)
772 static inline int of_phandle_iterator_args(struct of_phandle_iterator
*it
,
779 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
784 static inline int of_alias_get_highest_id(const char *stem
)
789 static inline int of_machine_is_compatible(const char *compat
)
794 static inline bool of_console_check(const struct device_node
*dn
, const char *name
, int index
)
799 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
800 const __be32
*cur
, u32
*pu
)
805 static inline const char *of_prop_next_string(struct property
*prop
,
811 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
816 static inline int of_node_test_and_set_flag(struct device_node
*n
,
822 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
826 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
830 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
835 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
839 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
843 #define of_match_ptr(_ptr) NULL
844 #define of_match_node(_matches, _node) NULL
845 #endif /* CONFIG_OF */
847 /* Default string compare functions, Allow arch asm/prom.h to override */
848 #if !defined(of_compat_cmp)
849 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
850 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
851 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
854 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
855 extern int of_node_to_nid(struct device_node
*np
);
857 static inline int of_node_to_nid(struct device_node
*device
)
863 #ifdef CONFIG_OF_NUMA
864 extern int of_numa_init(void);
866 static inline int of_numa_init(void)
872 static inline struct device_node
*of_find_matching_node(
873 struct device_node
*from
,
874 const struct of_device_id
*matches
)
876 return of_find_matching_node_and_match(from
, matches
, NULL
);
880 * of_property_count_u8_elems - Count the number of u8 elements in a property
882 * @np: device node from which the property value is to be read.
883 * @propname: name of the property to be searched.
885 * Search for a property in a device node and count the number of u8 elements
886 * in it. Returns number of elements on sucess, -EINVAL if the property does
887 * not exist or its length does not match a multiple of u8 and -ENODATA if the
888 * property does not have a value.
890 static inline int of_property_count_u8_elems(const struct device_node
*np
,
891 const char *propname
)
893 return of_property_count_elems_of_size(np
, propname
, sizeof(u8
));
897 * of_property_count_u16_elems - Count the number of u16 elements in a property
899 * @np: device node from which the property value is to be read.
900 * @propname: name of the property to be searched.
902 * Search for a property in a device node and count the number of u16 elements
903 * in it. Returns number of elements on sucess, -EINVAL if the property does
904 * not exist or its length does not match a multiple of u16 and -ENODATA if the
905 * property does not have a value.
907 static inline int of_property_count_u16_elems(const struct device_node
*np
,
908 const char *propname
)
910 return of_property_count_elems_of_size(np
, propname
, sizeof(u16
));
914 * of_property_count_u32_elems - Count the number of u32 elements in a property
916 * @np: device node from which the property value is to be read.
917 * @propname: name of the property to be searched.
919 * Search for a property in a device node and count the number of u32 elements
920 * in it. Returns number of elements on sucess, -EINVAL if the property does
921 * not exist or its length does not match a multiple of u32 and -ENODATA if the
922 * property does not have a value.
924 static inline int of_property_count_u32_elems(const struct device_node
*np
,
925 const char *propname
)
927 return of_property_count_elems_of_size(np
, propname
, sizeof(u32
));
931 * of_property_count_u64_elems - Count the number of u64 elements in a property
933 * @np: device node from which the property value is to be read.
934 * @propname: name of the property to be searched.
936 * Search for a property in a device node and count the number of u64 elements
937 * in it. Returns number of elements on sucess, -EINVAL if the property does
938 * not exist or its length does not match a multiple of u64 and -ENODATA if the
939 * property does not have a value.
941 static inline int of_property_count_u64_elems(const struct device_node
*np
,
942 const char *propname
)
944 return of_property_count_elems_of_size(np
, propname
, sizeof(u64
));
948 * of_property_read_string_array() - Read an array of strings from a multiple
950 * @np: device node from which the property value is to be read.
951 * @propname: name of the property to be searched.
952 * @out_strs: output array of string pointers.
953 * @sz: number of array elements to read.
955 * Search for a property in a device tree node and retrieve a list of
956 * terminated string values (pointer to data, not a copy) in that property.
958 * If @out_strs is NULL, the number of strings in the property is returned.
960 static inline int of_property_read_string_array(const struct device_node
*np
,
961 const char *propname
, const char **out_strs
,
964 return of_property_read_string_helper(np
, propname
, out_strs
, sz
, 0);
968 * of_property_count_strings() - Find and return the number of strings from a
969 * multiple strings property.
970 * @np: device node from which the property value is to be read.
971 * @propname: name of the property to be searched.
973 * Search for a property in a device tree node and retrieve the number of null
974 * terminated string contain in it. Returns the number of strings on
975 * success, -EINVAL if the property does not exist, -ENODATA if property
976 * does not have a value, and -EILSEQ if the string is not null-terminated
977 * within the length of the property data.
979 static inline int of_property_count_strings(const struct device_node
*np
,
980 const char *propname
)
982 return of_property_read_string_helper(np
, propname
, NULL
, 0, 0);
986 * of_property_read_string_index() - Find and read a string from a multiple
988 * @np: device node from which the property value is to be read.
989 * @propname: name of the property to be searched.
990 * @index: index of the string in the list of strings
991 * @out_string: pointer to null terminated return string, modified only if
994 * Search for a property in a device tree node and retrieve a null
995 * terminated string value (pointer to data, not a copy) in the list of strings
996 * contained in that property.
997 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
998 * property does not have a value, and -EILSEQ if the string is not
999 * null-terminated within the length of the property data.
1001 * The out_string pointer is modified only if a valid string can be decoded.
1003 static inline int of_property_read_string_index(const struct device_node
*np
,
1004 const char *propname
,
1005 int index
, const char **output
)
1007 int rc
= of_property_read_string_helper(np
, propname
, output
, 1, index
);
1008 return rc
< 0 ? rc
: 0;
1012 * of_property_read_bool - Findfrom a property
1013 * @np: device node from which the property value is to be read.
1014 * @propname: name of the property to be searched.
1016 * Search for a property in a device node.
1017 * Returns true if the property exists false otherwise.
1019 static inline bool of_property_read_bool(const struct device_node
*np
,
1020 const char *propname
)
1022 struct property
*prop
= of_find_property(np
, propname
, NULL
);
1024 return prop
? true : false;
1027 static inline int of_property_read_u8(const struct device_node
*np
,
1028 const char *propname
,
1031 return of_property_read_u8_array(np
, propname
, out_value
, 1);
1034 static inline int of_property_read_u16(const struct device_node
*np
,
1035 const char *propname
,
1038 return of_property_read_u16_array(np
, propname
, out_value
, 1);
1041 static inline int of_property_read_u32(const struct device_node
*np
,
1042 const char *propname
,
1045 return of_property_read_u32_array(np
, propname
, out_value
, 1);
1048 static inline int of_property_read_s32(const struct device_node
*np
,
1049 const char *propname
,
1052 return of_property_read_u32(np
, propname
, (u32
*) out_value
);
1055 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1056 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1057 err = of_phandle_iterator_next(it); \
1059 err = of_phandle_iterator_next(it))
1061 #define of_property_for_each_u32(np, propname, prop, p, u) \
1062 for (prop = of_find_property(np, propname, NULL), \
1063 p = of_prop_next_u32(prop, NULL, &u); \
1065 p = of_prop_next_u32(prop, p, &u))
1067 #define of_property_for_each_string(np, propname, prop, s) \
1068 for (prop = of_find_property(np, propname, NULL), \
1069 s = of_prop_next_string(prop, NULL); \
1071 s = of_prop_next_string(prop, s))
1073 #define for_each_node_by_name(dn, name) \
1074 for (dn = of_find_node_by_name(NULL, name); dn; \
1075 dn = of_find_node_by_name(dn, name))
1076 #define for_each_node_by_type(dn, type) \
1077 for (dn = of_find_node_by_type(NULL, type); dn; \
1078 dn = of_find_node_by_type(dn, type))
1079 #define for_each_compatible_node(dn, type, compatible) \
1080 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1081 dn = of_find_compatible_node(dn, type, compatible))
1082 #define for_each_matching_node(dn, matches) \
1083 for (dn = of_find_matching_node(NULL, matches); dn; \
1084 dn = of_find_matching_node(dn, matches))
1085 #define for_each_matching_node_and_match(dn, matches, match) \
1086 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1087 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1089 #define for_each_child_of_node(parent, child) \
1090 for (child = of_get_next_child(parent, NULL); child != NULL; \
1091 child = of_get_next_child(parent, child))
1092 #define for_each_available_child_of_node(parent, child) \
1093 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1094 child = of_get_next_available_child(parent, child))
1096 #define for_each_node_with_property(dn, prop_name) \
1097 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1098 dn = of_find_node_with_property(dn, prop_name))
1100 static inline int of_get_child_count(const struct device_node
*np
)
1102 struct device_node
*child
;
1105 for_each_child_of_node(np
, child
)
1111 static inline int of_get_available_child_count(const struct device_node
*np
)
1113 struct device_node
*child
;
1116 for_each_available_child_of_node(np
, child
)
1122 #if defined(CONFIG_OF) && !defined(MODULE)
1123 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1124 static const struct of_device_id __of_table_##name \
1125 __used __section(__##table##_of_table) \
1126 = { .compatible = compat, \
1127 .data = (fn == (fn_type)NULL) ? fn : fn }
1129 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1130 static const struct of_device_id __of_table_##name \
1131 __attribute__((unused)) \
1132 = { .compatible = compat, \
1133 .data = (fn == (fn_type)NULL) ? fn : fn }
1136 typedef int (*of_init_fn_2
)(struct device_node
*, struct device_node
*);
1137 typedef int (*of_init_fn_1_ret
)(struct device_node
*);
1138 typedef void (*of_init_fn_1
)(struct device_node
*);
1140 #define OF_DECLARE_1(table, name, compat, fn) \
1141 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1142 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1143 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1144 #define OF_DECLARE_2(table, name, compat, fn) \
1145 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1148 * struct of_changeset_entry - Holds a changeset entry
1150 * @node: list_head for the log list
1151 * @action: notifier action
1152 * @np: pointer to the device node affected
1153 * @prop: pointer to the property affected
1154 * @old_prop: hold a pointer to the original property
1156 * Every modification of the device tree during a changeset
1157 * is held in a list of of_changeset_entry structures.
1158 * That way we can recover from a partial application, or we can
1159 * revert the changeset
1161 struct of_changeset_entry
{
1162 struct list_head node
;
1163 unsigned long action
;
1164 struct device_node
*np
;
1165 struct property
*prop
;
1166 struct property
*old_prop
;
1170 * struct of_changeset - changeset tracker structure
1172 * @entries: list_head for the changeset entries
1174 * changesets are a convenient way to apply bulk changes to the
1175 * live tree. In case of an error, changes are rolled-back.
1176 * changesets live on after initial application, and if not
1177 * destroyed after use, they can be reverted in one single call.
1179 struct of_changeset
{
1180 struct list_head entries
;
1183 enum of_reconfig_change
{
1184 OF_RECONFIG_NO_CHANGE
= 0,
1185 OF_RECONFIG_CHANGE_ADD
,
1186 OF_RECONFIG_CHANGE_REMOVE
,
1189 #ifdef CONFIG_OF_DYNAMIC
1190 extern int of_reconfig_notifier_register(struct notifier_block
*);
1191 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
1192 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data
*rd
);
1193 extern int of_reconfig_get_state_change(unsigned long action
,
1194 struct of_reconfig_data
*arg
);
1196 extern void of_changeset_init(struct of_changeset
*ocs
);
1197 extern void of_changeset_destroy(struct of_changeset
*ocs
);
1198 extern int of_changeset_apply(struct of_changeset
*ocs
);
1199 extern int of_changeset_revert(struct of_changeset
*ocs
);
1200 extern int of_changeset_action(struct of_changeset
*ocs
,
1201 unsigned long action
, struct device_node
*np
,
1202 struct property
*prop
);
1204 static inline int of_changeset_attach_node(struct of_changeset
*ocs
,
1205 struct device_node
*np
)
1207 return of_changeset_action(ocs
, OF_RECONFIG_ATTACH_NODE
, np
, NULL
);
1210 static inline int of_changeset_detach_node(struct of_changeset
*ocs
,
1211 struct device_node
*np
)
1213 return of_changeset_action(ocs
, OF_RECONFIG_DETACH_NODE
, np
, NULL
);
1216 static inline int of_changeset_add_property(struct of_changeset
*ocs
,
1217 struct device_node
*np
, struct property
*prop
)
1219 return of_changeset_action(ocs
, OF_RECONFIG_ADD_PROPERTY
, np
, prop
);
1222 static inline int of_changeset_remove_property(struct of_changeset
*ocs
,
1223 struct device_node
*np
, struct property
*prop
)
1225 return of_changeset_action(ocs
, OF_RECONFIG_REMOVE_PROPERTY
, np
, prop
);
1228 static inline int of_changeset_update_property(struct of_changeset
*ocs
,
1229 struct device_node
*np
, struct property
*prop
)
1231 return of_changeset_action(ocs
, OF_RECONFIG_UPDATE_PROPERTY
, np
, prop
);
1233 #else /* CONFIG_OF_DYNAMIC */
1234 static inline int of_reconfig_notifier_register(struct notifier_block
*nb
)
1238 static inline int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
1242 static inline int of_reconfig_notify(unsigned long action
,
1243 struct of_reconfig_data
*arg
)
1247 static inline int of_reconfig_get_state_change(unsigned long action
,
1248 struct of_reconfig_data
*arg
)
1252 #endif /* CONFIG_OF_DYNAMIC */
1254 /* CONFIG_OF_RESOLVE api */
1255 extern int of_resolve_phandles(struct device_node
*tree
);
1258 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1259 * @np: Pointer to the given device_node
1261 * return true if present false otherwise
1263 static inline bool of_device_is_system_power_controller(const struct device_node
*np
)
1265 return of_property_read_bool(np
, "system-power-controller");
1272 enum of_overlay_notify_action
{
1273 OF_OVERLAY_PRE_APPLY
,
1274 OF_OVERLAY_POST_APPLY
,
1275 OF_OVERLAY_PRE_REMOVE
,
1276 OF_OVERLAY_POST_REMOVE
,
1279 struct of_overlay_notify_data
{
1280 struct device_node
*overlay
;
1281 struct device_node
*target
;
1284 #ifdef CONFIG_OF_OVERLAY
1286 /* ID based overlays; the API for external users */
1287 int of_overlay_create(struct device_node
*tree
);
1288 int of_overlay_destroy(int id
);
1289 int of_overlay_destroy_all(void);
1291 int of_overlay_notifier_register(struct notifier_block
*nb
);
1292 int of_overlay_notifier_unregister(struct notifier_block
*nb
);
1296 static inline int of_overlay_create(struct device_node
*tree
)
1301 static inline int of_overlay_destroy(int id
)
1306 static inline int of_overlay_destroy_all(void)
1311 static inline int of_overlay_notifier_register(struct notifier_block
*nb
)
1316 static inline int of_overlay_notifier_unregister(struct notifier_block
*nb
)
1323 #endif /* _LINUX_OF_H */