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 extern const struct fwnode_operations of_fwnode_ops
;
104 static inline void of_node_init(struct device_node
*node
)
106 kobject_init(&node
->kobj
, &of_node_ktype
);
107 node
->fwnode
.ops
= &of_fwnode_ops
;
110 /* true when node is initialized */
111 static inline int of_node_is_initialized(struct device_node
*node
)
113 return node
&& node
->kobj
.state_initialized
;
116 /* true when node is attached (i.e. present on sysfs) */
117 static inline int of_node_is_attached(struct device_node
*node
)
119 return node
&& node
->kobj
.state_in_sysfs
;
122 #ifdef CONFIG_OF_DYNAMIC
123 extern struct device_node
*of_node_get(struct device_node
*node
);
124 extern void of_node_put(struct device_node
*node
);
125 #else /* CONFIG_OF_DYNAMIC */
126 /* Dummy ref counting routines - to be implemented later */
127 static inline struct device_node
*of_node_get(struct device_node
*node
)
131 static inline void of_node_put(struct device_node
*node
) { }
132 #endif /* !CONFIG_OF_DYNAMIC */
134 /* Pointer for first entry in chain of all nodes. */
135 extern struct device_node
*of_root
;
136 extern struct device_node
*of_chosen
;
137 extern struct device_node
*of_aliases
;
138 extern struct device_node
*of_stdout
;
139 extern raw_spinlock_t devtree_lock
;
141 /* flag descriptions (need to be visible even when !CONFIG_OF) */
142 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
143 #define OF_DETACHED 2 /* node has been detached from the device tree */
144 #define OF_POPULATED 3 /* device already created for the node */
145 #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
147 #define OF_BAD_ADDR ((u64)-1)
150 void of_core_init(void);
152 static inline bool is_of_node(const struct fwnode_handle
*fwnode
)
154 return !IS_ERR_OR_NULL(fwnode
) && fwnode
->ops
== &of_fwnode_ops
;
157 #define to_of_node(__fwnode) \
159 typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \
161 is_of_node(__to_of_node_fwnode) ? \
162 container_of(__to_of_node_fwnode, \
163 struct device_node, fwnode) : \
167 #define of_fwnode_handle(node) \
169 typeof(node) __of_fwnode_handle_node = (node); \
171 __of_fwnode_handle_node ? \
172 &__of_fwnode_handle_node->fwnode : NULL; \
175 static inline bool of_have_populated_dt(void)
177 return of_root
!= NULL
;
180 static inline bool of_node_is_root(const struct device_node
*node
)
182 return node
&& (node
->parent
== NULL
);
185 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
187 return test_bit(flag
, &n
->_flags
);
190 static inline int of_node_test_and_set_flag(struct device_node
*n
,
193 return test_and_set_bit(flag
, &n
->_flags
);
196 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
198 set_bit(flag
, &n
->_flags
);
201 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
203 clear_bit(flag
, &n
->_flags
);
206 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
208 return test_bit(flag
, &p
->_flags
);
211 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
213 set_bit(flag
, &p
->_flags
);
216 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
218 clear_bit(flag
, &p
->_flags
);
221 extern struct device_node
*__of_find_all_nodes(struct device_node
*prev
);
222 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
225 * OF address retrieval & translation
228 /* Helper to read a big number; size is in cells (not bytes) */
229 static inline u64
of_read_number(const __be32
*cell
, int size
)
233 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
237 /* Like of_read_number, but we want an unsigned long result */
238 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
240 /* toss away upper bits if unsigned long is smaller than u64 */
241 return of_read_number(cell
, size
);
244 #if defined(CONFIG_SPARC)
245 #include <asm/prom.h>
248 /* Default #address and #size cells. Allow arch asm/prom.h to override */
249 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
250 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
251 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
254 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
255 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
257 static inline const char *of_node_full_name(const struct device_node
*np
)
259 return np
? np
->full_name
: "<no-node>";
262 #define for_each_of_allnodes_from(from, dn) \
263 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
264 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
265 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
267 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
269 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
270 const char *type
, const char *compat
);
271 extern struct device_node
*of_find_matching_node_and_match(
272 struct device_node
*from
,
273 const struct of_device_id
*matches
,
274 const struct of_device_id
**match
);
276 extern struct device_node
*of_find_node_opts_by_path(const char *path
,
278 static inline struct device_node
*of_find_node_by_path(const char *path
)
280 return of_find_node_opts_by_path(path
, NULL
);
283 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
284 extern struct device_node
*of_get_parent(const struct device_node
*node
);
285 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
286 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
287 struct device_node
*prev
);
288 extern struct device_node
*of_get_next_available_child(
289 const struct device_node
*node
, struct device_node
*prev
);
291 extern struct device_node
*of_get_compatible_child(const struct device_node
*parent
,
292 const char *compatible
);
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_compatible_child(const struct device_node
*parent
,
631 const char *compatible
)
636 static inline struct device_node
*of_get_child_by_name(
637 const struct device_node
*node
,
643 static inline int of_device_is_compatible(const struct device_node
*device
,
649 static inline int of_device_compatible_match(struct device_node
*device
,
650 const char *const *compat
)
655 static inline bool of_device_is_available(const struct device_node
*device
)
660 static inline bool of_device_is_big_endian(const struct device_node
*device
)
665 static inline struct property
*of_find_property(const struct device_node
*np
,
672 static inline struct device_node
*of_find_compatible_node(
673 struct device_node
*from
,
680 static inline int of_property_count_elems_of_size(const struct device_node
*np
,
681 const char *propname
, int elem_size
)
686 static inline int of_property_read_u32_index(const struct device_node
*np
,
687 const char *propname
, u32 index
, u32
*out_value
)
692 static inline int of_property_read_u8_array(const struct device_node
*np
,
693 const char *propname
, u8
*out_values
, size_t sz
)
698 static inline int of_property_read_u16_array(const struct device_node
*np
,
699 const char *propname
, u16
*out_values
, size_t sz
)
704 static inline int of_property_read_u32_array(const struct device_node
*np
,
705 const char *propname
,
706 u32
*out_values
, size_t sz
)
711 static inline int of_property_read_u64_array(const struct device_node
*np
,
712 const char *propname
,
713 u64
*out_values
, size_t sz
)
718 static inline int of_property_read_string(const struct device_node
*np
,
719 const char *propname
,
720 const char **out_string
)
725 static inline int of_property_read_string_helper(const struct device_node
*np
,
726 const char *propname
,
727 const char **out_strs
, size_t sz
, int index
)
732 static inline const void *of_get_property(const struct device_node
*node
,
739 static inline struct device_node
*of_get_cpu_node(int cpu
,
740 unsigned int *thread
)
745 static inline int of_n_addr_cells(struct device_node
*np
)
750 static inline int of_n_size_cells(struct device_node
*np
)
755 static inline int of_property_read_u64(const struct device_node
*np
,
756 const char *propname
, u64
*out_value
)
761 static inline int of_property_match_string(const struct device_node
*np
,
762 const char *propname
,
768 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
769 const char *phandle_name
,
775 static inline int of_parse_phandle_with_args(const struct device_node
*np
,
776 const char *list_name
,
777 const char *cells_name
,
779 struct of_phandle_args
*out_args
)
784 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
785 const char *list_name
, int cells_count
, int index
,
786 struct of_phandle_args
*out_args
)
791 static inline int of_count_phandle_with_args(struct device_node
*np
,
792 const char *list_name
,
793 const char *cells_name
)
798 static inline int of_phandle_iterator_init(struct of_phandle_iterator
*it
,
799 const struct device_node
*np
,
800 const char *list_name
,
801 const char *cells_name
,
807 static inline int of_phandle_iterator_next(struct of_phandle_iterator
*it
)
812 static inline int of_phandle_iterator_args(struct of_phandle_iterator
*it
,
819 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
824 static inline int of_alias_get_highest_id(const char *stem
)
829 static inline int of_machine_is_compatible(const char *compat
)
834 static inline bool of_console_check(const struct device_node
*dn
, const char *name
, int index
)
839 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
840 const __be32
*cur
, u32
*pu
)
845 static inline const char *of_prop_next_string(struct property
*prop
,
851 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
856 static inline int of_node_test_and_set_flag(struct device_node
*n
,
862 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
866 static inline void of_node_clear_flag(struct device_node
*n
, unsigned long flag
)
870 static inline int of_property_check_flag(struct property
*p
, unsigned long flag
)
875 static inline void of_property_set_flag(struct property
*p
, unsigned long flag
)
879 static inline void of_property_clear_flag(struct property
*p
, unsigned long flag
)
883 #define of_match_ptr(_ptr) NULL
884 #define of_match_node(_matches, _node) NULL
885 #endif /* CONFIG_OF */
887 /* Default string compare functions, Allow arch asm/prom.h to override */
888 #if !defined(of_compat_cmp)
889 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
890 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
891 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
894 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
895 extern int of_node_to_nid(struct device_node
*np
);
897 static inline int of_node_to_nid(struct device_node
*device
)
903 #ifdef CONFIG_OF_NUMA
904 extern int of_numa_init(void);
906 static inline int of_numa_init(void)
912 static inline struct device_node
*of_find_matching_node(
913 struct device_node
*from
,
914 const struct of_device_id
*matches
)
916 return of_find_matching_node_and_match(from
, matches
, NULL
);
920 * of_property_count_u8_elems - Count the number of u8 elements in a property
922 * @np: device node from which the property value is to be read.
923 * @propname: name of the property to be searched.
925 * Search for a property in a device node and count the number of u8 elements
926 * in it. Returns number of elements on sucess, -EINVAL if the property does
927 * not exist or its length does not match a multiple of u8 and -ENODATA if the
928 * property does not have a value.
930 static inline int of_property_count_u8_elems(const struct device_node
*np
,
931 const char *propname
)
933 return of_property_count_elems_of_size(np
, propname
, sizeof(u8
));
937 * of_property_count_u16_elems - Count the number of u16 elements in a property
939 * @np: device node from which the property value is to be read.
940 * @propname: name of the property to be searched.
942 * Search for a property in a device node and count the number of u16 elements
943 * in it. Returns number of elements on sucess, -EINVAL if the property does
944 * not exist or its length does not match a multiple of u16 and -ENODATA if the
945 * property does not have a value.
947 static inline int of_property_count_u16_elems(const struct device_node
*np
,
948 const char *propname
)
950 return of_property_count_elems_of_size(np
, propname
, sizeof(u16
));
954 * of_property_count_u32_elems - Count the number of u32 elements in a property
956 * @np: device node from which the property value is to be read.
957 * @propname: name of the property to be searched.
959 * Search for a property in a device node and count the number of u32 elements
960 * in it. Returns number of elements on sucess, -EINVAL if the property does
961 * not exist or its length does not match a multiple of u32 and -ENODATA if the
962 * property does not have a value.
964 static inline int of_property_count_u32_elems(const struct device_node
*np
,
965 const char *propname
)
967 return of_property_count_elems_of_size(np
, propname
, sizeof(u32
));
971 * of_property_count_u64_elems - Count the number of u64 elements in a property
973 * @np: device node from which the property value is to be read.
974 * @propname: name of the property to be searched.
976 * Search for a property in a device node and count the number of u64 elements
977 * in it. Returns number of elements on sucess, -EINVAL if the property does
978 * not exist or its length does not match a multiple of u64 and -ENODATA if the
979 * property does not have a value.
981 static inline int of_property_count_u64_elems(const struct device_node
*np
,
982 const char *propname
)
984 return of_property_count_elems_of_size(np
, propname
, sizeof(u64
));
988 * of_property_read_string_array() - Read an array of strings from a multiple
990 * @np: device node from which the property value is to be read.
991 * @propname: name of the property to be searched.
992 * @out_strs: output array of string pointers.
993 * @sz: number of array elements to read.
995 * Search for a property in a device tree node and retrieve a list of
996 * terminated string values (pointer to data, not a copy) in that property.
998 * If @out_strs is NULL, the number of strings in the property is returned.
1000 static inline int of_property_read_string_array(const struct device_node
*np
,
1001 const char *propname
, const char **out_strs
,
1004 return of_property_read_string_helper(np
, propname
, out_strs
, sz
, 0);
1008 * of_property_count_strings() - Find and return the number of strings from a
1009 * multiple strings property.
1010 * @np: device node from which the property value is to be read.
1011 * @propname: name of the property to be searched.
1013 * Search for a property in a device tree node and retrieve the number of null
1014 * terminated string contain in it. Returns the number of strings on
1015 * success, -EINVAL if the property does not exist, -ENODATA if property
1016 * does not have a value, and -EILSEQ if the string is not null-terminated
1017 * within the length of the property data.
1019 static inline int of_property_count_strings(const struct device_node
*np
,
1020 const char *propname
)
1022 return of_property_read_string_helper(np
, propname
, NULL
, 0, 0);
1026 * of_property_read_string_index() - Find and read a string from a multiple
1028 * @np: device node from which the property value is to be read.
1029 * @propname: name of the property to be searched.
1030 * @index: index of the string in the list of strings
1031 * @out_string: pointer to null terminated return string, modified only if
1032 * return value is 0.
1034 * Search for a property in a device tree node and retrieve a null
1035 * terminated string value (pointer to data, not a copy) in the list of strings
1036 * contained in that property.
1037 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1038 * property does not have a value, and -EILSEQ if the string is not
1039 * null-terminated within the length of the property data.
1041 * The out_string pointer is modified only if a valid string can be decoded.
1043 static inline int of_property_read_string_index(const struct device_node
*np
,
1044 const char *propname
,
1045 int index
, const char **output
)
1047 int rc
= of_property_read_string_helper(np
, propname
, output
, 1, index
);
1048 return rc
< 0 ? rc
: 0;
1052 * of_property_read_bool - Findfrom a property
1053 * @np: device node from which the property value is to be read.
1054 * @propname: name of the property to be searched.
1056 * Search for a property in a device node.
1057 * Returns true if the property exists false otherwise.
1059 static inline bool of_property_read_bool(const struct device_node
*np
,
1060 const char *propname
)
1062 struct property
*prop
= of_find_property(np
, propname
, NULL
);
1064 return prop
? true : false;
1067 static inline int of_property_read_u8(const struct device_node
*np
,
1068 const char *propname
,
1071 return of_property_read_u8_array(np
, propname
, out_value
, 1);
1074 static inline int of_property_read_u16(const struct device_node
*np
,
1075 const char *propname
,
1078 return of_property_read_u16_array(np
, propname
, out_value
, 1);
1081 static inline int of_property_read_u32(const struct device_node
*np
,
1082 const char *propname
,
1085 return of_property_read_u32_array(np
, propname
, out_value
, 1);
1088 static inline int of_property_read_s32(const struct device_node
*np
,
1089 const char *propname
,
1092 return of_property_read_u32(np
, propname
, (u32
*) out_value
);
1095 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1096 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1097 err = of_phandle_iterator_next(it); \
1099 err = of_phandle_iterator_next(it))
1101 #define of_property_for_each_u32(np, propname, prop, p, u) \
1102 for (prop = of_find_property(np, propname, NULL), \
1103 p = of_prop_next_u32(prop, NULL, &u); \
1105 p = of_prop_next_u32(prop, p, &u))
1107 #define of_property_for_each_string(np, propname, prop, s) \
1108 for (prop = of_find_property(np, propname, NULL), \
1109 s = of_prop_next_string(prop, NULL); \
1111 s = of_prop_next_string(prop, s))
1113 #define for_each_node_by_name(dn, name) \
1114 for (dn = of_find_node_by_name(NULL, name); dn; \
1115 dn = of_find_node_by_name(dn, name))
1116 #define for_each_node_by_type(dn, type) \
1117 for (dn = of_find_node_by_type(NULL, type); dn; \
1118 dn = of_find_node_by_type(dn, type))
1119 #define for_each_compatible_node(dn, type, compatible) \
1120 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1121 dn = of_find_compatible_node(dn, type, compatible))
1122 #define for_each_matching_node(dn, matches) \
1123 for (dn = of_find_matching_node(NULL, matches); dn; \
1124 dn = of_find_matching_node(dn, matches))
1125 #define for_each_matching_node_and_match(dn, matches, match) \
1126 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1127 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1129 #define for_each_child_of_node(parent, child) \
1130 for (child = of_get_next_child(parent, NULL); child != NULL; \
1131 child = of_get_next_child(parent, child))
1132 #define for_each_available_child_of_node(parent, child) \
1133 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1134 child = of_get_next_available_child(parent, child))
1136 #define for_each_node_with_property(dn, prop_name) \
1137 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1138 dn = of_find_node_with_property(dn, prop_name))
1140 static inline int of_get_child_count(const struct device_node
*np
)
1142 struct device_node
*child
;
1145 for_each_child_of_node(np
, child
)
1151 static inline int of_get_available_child_count(const struct device_node
*np
)
1153 struct device_node
*child
;
1156 for_each_available_child_of_node(np
, child
)
1162 #if defined(CONFIG_OF) && !defined(MODULE)
1163 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1164 static const struct of_device_id __of_table_##name \
1165 __used __section(__##table##_of_table) \
1166 = { .compatible = compat, \
1167 .data = (fn == (fn_type)NULL) ? fn : fn }
1169 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1170 static const struct of_device_id __of_table_##name \
1171 __attribute__((unused)) \
1172 = { .compatible = compat, \
1173 .data = (fn == (fn_type)NULL) ? fn : fn }
1176 typedef int (*of_init_fn_2
)(struct device_node
*, struct device_node
*);
1177 typedef int (*of_init_fn_1_ret
)(struct device_node
*);
1178 typedef void (*of_init_fn_1
)(struct device_node
*);
1180 #define OF_DECLARE_1(table, name, compat, fn) \
1181 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1182 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1183 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1184 #define OF_DECLARE_2(table, name, compat, fn) \
1185 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1188 * struct of_changeset_entry - Holds a changeset entry
1190 * @node: list_head for the log list
1191 * @action: notifier action
1192 * @np: pointer to the device node affected
1193 * @prop: pointer to the property affected
1194 * @old_prop: hold a pointer to the original property
1196 * Every modification of the device tree during a changeset
1197 * is held in a list of of_changeset_entry structures.
1198 * That way we can recover from a partial application, or we can
1199 * revert the changeset
1201 struct of_changeset_entry
{
1202 struct list_head node
;
1203 unsigned long action
;
1204 struct device_node
*np
;
1205 struct property
*prop
;
1206 struct property
*old_prop
;
1210 * struct of_changeset - changeset tracker structure
1212 * @entries: list_head for the changeset entries
1214 * changesets are a convenient way to apply bulk changes to the
1215 * live tree. In case of an error, changes are rolled-back.
1216 * changesets live on after initial application, and if not
1217 * destroyed after use, they can be reverted in one single call.
1219 struct of_changeset
{
1220 struct list_head entries
;
1223 enum of_reconfig_change
{
1224 OF_RECONFIG_NO_CHANGE
= 0,
1225 OF_RECONFIG_CHANGE_ADD
,
1226 OF_RECONFIG_CHANGE_REMOVE
,
1229 #ifdef CONFIG_OF_DYNAMIC
1230 extern int of_reconfig_notifier_register(struct notifier_block
*);
1231 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
1232 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data
*rd
);
1233 extern int of_reconfig_get_state_change(unsigned long action
,
1234 struct of_reconfig_data
*arg
);
1236 extern void of_changeset_init(struct of_changeset
*ocs
);
1237 extern void of_changeset_destroy(struct of_changeset
*ocs
);
1238 extern int of_changeset_apply(struct of_changeset
*ocs
);
1239 extern int of_changeset_revert(struct of_changeset
*ocs
);
1240 extern int of_changeset_action(struct of_changeset
*ocs
,
1241 unsigned long action
, struct device_node
*np
,
1242 struct property
*prop
);
1244 static inline int of_changeset_attach_node(struct of_changeset
*ocs
,
1245 struct device_node
*np
)
1247 return of_changeset_action(ocs
, OF_RECONFIG_ATTACH_NODE
, np
, NULL
);
1250 static inline int of_changeset_detach_node(struct of_changeset
*ocs
,
1251 struct device_node
*np
)
1253 return of_changeset_action(ocs
, OF_RECONFIG_DETACH_NODE
, np
, NULL
);
1256 static inline int of_changeset_add_property(struct of_changeset
*ocs
,
1257 struct device_node
*np
, struct property
*prop
)
1259 return of_changeset_action(ocs
, OF_RECONFIG_ADD_PROPERTY
, np
, prop
);
1262 static inline int of_changeset_remove_property(struct of_changeset
*ocs
,
1263 struct device_node
*np
, struct property
*prop
)
1265 return of_changeset_action(ocs
, OF_RECONFIG_REMOVE_PROPERTY
, np
, prop
);
1268 static inline int of_changeset_update_property(struct of_changeset
*ocs
,
1269 struct device_node
*np
, struct property
*prop
)
1271 return of_changeset_action(ocs
, OF_RECONFIG_UPDATE_PROPERTY
, np
, prop
);
1273 #else /* CONFIG_OF_DYNAMIC */
1274 static inline int of_reconfig_notifier_register(struct notifier_block
*nb
)
1278 static inline int of_reconfig_notifier_unregister(struct notifier_block
*nb
)
1282 static inline int of_reconfig_notify(unsigned long action
,
1283 struct of_reconfig_data
*arg
)
1287 static inline int of_reconfig_get_state_change(unsigned long action
,
1288 struct of_reconfig_data
*arg
)
1292 #endif /* CONFIG_OF_DYNAMIC */
1294 /* CONFIG_OF_RESOLVE api */
1295 extern int of_resolve_phandles(struct device_node
*tree
);
1298 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1299 * @np: Pointer to the given device_node
1301 * return true if present false otherwise
1303 static inline bool of_device_is_system_power_controller(const struct device_node
*np
)
1305 return of_property_read_bool(np
, "system-power-controller");
1312 enum of_overlay_notify_action
{
1313 OF_OVERLAY_PRE_APPLY
,
1314 OF_OVERLAY_POST_APPLY
,
1315 OF_OVERLAY_PRE_REMOVE
,
1316 OF_OVERLAY_POST_REMOVE
,
1319 struct of_overlay_notify_data
{
1320 struct device_node
*overlay
;
1321 struct device_node
*target
;
1324 #ifdef CONFIG_OF_OVERLAY
1326 /* ID based overlays; the API for external users */
1327 int of_overlay_create(struct device_node
*tree
);
1328 int of_overlay_destroy(int id
);
1329 int of_overlay_destroy_all(void);
1331 int of_overlay_notifier_register(struct notifier_block
*nb
);
1332 int of_overlay_notifier_unregister(struct notifier_block
*nb
);
1336 static inline int of_overlay_create(struct device_node
*tree
)
1341 static inline int of_overlay_destroy(int id
)
1346 static inline int of_overlay_destroy_all(void)
1351 static inline int of_overlay_notifier_register(struct notifier_block
*nb
)
1356 static inline int of_overlay_notifier_unregister(struct notifier_block
*nb
)
1363 #endif /* _LINUX_OF_H */