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 #define of_fwnode_handle(node) (&(node)->fwnode)
164 static inline bool of_have_populated_dt(void)
166 return of_root != NULL;
169 static inline bool of_node_is_root(const struct device_node *node)
171 return node && (node->parent == NULL);
174 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
176 return test_bit(flag, &n->_flags);
179 static inline int of_node_test_and_set_flag(struct device_node *n,
182 return test_and_set_bit(flag, &n->_flags);
185 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
187 set_bit(flag, &n->_flags);
190 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
192 clear_bit(flag, &n->_flags);
195 static inline int of_property_check_flag(struct property *p, unsigned long flag)
197 return test_bit(flag, &p->_flags);
200 static inline void of_property_set_flag(struct property *p, unsigned long flag)
202 set_bit(flag, &p->_flags);
205 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
207 clear_bit(flag, &p->_flags);
210 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
211 extern struct device_node *of_find_all_nodes(struct device_node *prev);
214 * OF address retrieval & translation
217 /* Helper to read a big number; size is in cells (not bytes) */
218 static inline u64 of_read_number(const __be32 *cell, int size)
222 r = (r << 32) | be32_to_cpu(*(cell++));
226 /* Like of_read_number, but we want an unsigned long result */
227 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
229 /* toss away upper bits if unsigned long is smaller than u64 */
230 return of_read_number(cell, size);
233 #if defined(CONFIG_SPARC)
234 #include <asm/prom.h>
237 /* Default #address and #size cells. Allow arch asm/prom.h to override */
238 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
239 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
240 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
243 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
244 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
246 static inline const char *of_node_full_name(const struct device_node *np)
248 return np ? np->full_name : "<no-node>";
251 #define for_each_of_allnodes_from(from, dn) \
252 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
253 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
254 extern struct device_node *of_find_node_by_name(struct device_node *from,
256 extern struct device_node *of_find_node_by_type(struct device_node *from,
258 extern struct device_node *of_find_compatible_node(struct device_node *from,
259 const char *type, const char *compat);
260 extern struct device_node *of_find_matching_node_and_match(
261 struct device_node *from,
262 const struct of_device_id *matches,
263 const struct of_device_id **match);
265 extern struct device_node *of_find_node_opts_by_path(const char *path,
267 static inline struct device_node *of_find_node_by_path(const char *path)
269 return of_find_node_opts_by_path(path, NULL);
272 extern struct device_node *of_find_node_by_phandle(phandle handle);
273 extern struct device_node *of_get_parent(const struct device_node *node);
274 extern struct device_node *of_get_next_parent(struct device_node *node);
275 extern struct device_node *of_get_next_child(const struct device_node *node,
276 struct device_node *prev);
277 extern struct device_node *of_get_next_available_child(
278 const struct device_node *node, struct device_node *prev);
280 extern struct device_node *of_get_child_by_name(const struct device_node *node,
284 extern struct device_node *of_find_next_cache_node(const struct device_node *);
285 extern int of_find_last_cache_level(unsigned int cpu);
286 extern struct device_node *of_find_node_with_property(
287 struct device_node *from, const char *prop_name);
289 extern struct property *of_find_property(const struct device_node *np,
292 extern int of_property_count_elems_of_size(const struct device_node *np,
293 const char *propname, int elem_size);
294 extern int of_property_read_u32_index(const struct device_node *np,
295 const char *propname,
296 u32 index, u32 *out_value);
297 extern int of_property_read_u64_index(const struct device_node *np,
298 const char *propname,
299 u32 index, u64 *out_value);
300 extern int of_property_read_variable_u8_array(const struct device_node *np,
301 const char *propname, u8 *out_values,
302 size_t sz_min, size_t sz_max);
303 extern int of_property_read_variable_u16_array(const struct device_node *np,
304 const char *propname, u16 *out_values,
305 size_t sz_min, size_t sz_max);
306 extern int of_property_read_variable_u32_array(const struct device_node *np,
307 const char *propname,
311 extern int of_property_read_u64(const struct device_node *np,
312 const char *propname, u64 *out_value);
313 extern int of_property_read_variable_u64_array(const struct device_node *np,
314 const char *propname,
319 extern int of_property_read_string(const struct device_node *np,
320 const char *propname,
321 const char **out_string);
322 extern int of_property_match_string(const struct device_node *np,
323 const char *propname,
325 extern int of_property_read_string_helper(const struct device_node *np,
326 const char *propname,
327 const char **out_strs, size_t sz, int index);
328 extern int of_device_is_compatible(const struct device_node *device,
330 extern int of_device_compatible_match(struct device_node *device,
331 const char *const *compat);
332 extern bool of_device_is_available(const struct device_node *device);
333 extern bool of_device_is_big_endian(const struct device_node *device);
334 extern const void *of_get_property(const struct device_node *node,
337 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
338 #define for_each_property_of_node(dn, pp) \
339 for (pp = dn->properties; pp != NULL; pp = pp->next)
341 extern int of_n_addr_cells(struct device_node *np);
342 extern int of_n_size_cells(struct device_node *np);
343 extern const struct of_device_id *of_match_node(
344 const struct of_device_id *matches, const struct device_node *node);
345 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
346 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
347 extern struct device_node *of_parse_phandle(const struct device_node *np,
348 const char *phandle_name,
350 extern int of_parse_phandle_with_args(const struct device_node *np,
351 const char *list_name, const char *cells_name, int index,
352 struct of_phandle_args *out_args);
353 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
354 const char *list_name, int cells_count, int index,
355 struct of_phandle_args *out_args);
356 extern int of_count_phandle_with_args(const struct device_node *np,
357 const char *list_name, const char *cells_name);
359 /* phandle iterator functions */
360 extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
361 const struct device_node *np,
362 const char *list_name,
363 const char *cells_name,
366 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
367 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
371 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
372 extern int of_alias_get_id(struct device_node *np, const char *stem);
373 extern int of_alias_get_highest_id(const char *stem);
375 extern int of_machine_is_compatible(const char *compat);
377 extern int of_add_property(struct device_node *np, struct property *prop);
378 extern int of_remove_property(struct device_node *np, struct property *prop);
379 extern int of_update_property(struct device_node *np, struct property *newprop);
381 /* For updating the device tree at runtime */
382 #define OF_RECONFIG_ATTACH_NODE 0x0001
383 #define OF_RECONFIG_DETACH_NODE 0x0002
384 #define OF_RECONFIG_ADD_PROPERTY 0x0003
385 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
386 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
388 extern int of_attach_node(struct device_node *);
389 extern int of_detach_node(struct device_node *);
391 #define of_match_ptr(_ptr) (_ptr)
394 * of_property_read_u8_array - Find and read an array of u8 from a property.
396 * @np: device node from which the property value is to be read.
397 * @propname: name of the property to be searched.
398 * @out_values: pointer to return value, modified only if return value is 0.
399 * @sz: number of array elements to read
401 * Search for a property in a device node and read 8-bit value(s) from
402 * it. Returns 0 on success, -EINVAL if the property does not exist,
403 * -ENODATA if property does not have a value, and -EOVERFLOW if the
404 * property data isn't large enough.
406 * dts entry of array should be like:
407 * property = /bits/ 8 <0x50 0x60 0x70>;
409 * The out_values is modified only if a valid u8 value can be decoded.
411 static inline int of_property_read_u8_array(const struct device_node *np,
412 const char *propname,
413 u8 *out_values, size_t sz)
415 int ret = of_property_read_variable_u8_array(np, propname, out_values,
424 * of_property_read_u16_array - Find and read an array of u16 from a property.
426 * @np: device node from which the property value is to be read.
427 * @propname: name of the property to be searched.
428 * @out_values: pointer to return value, modified only if return value is 0.
429 * @sz: number of array elements to read
431 * Search for a property in a device node and read 16-bit value(s) from
432 * it. Returns 0 on success, -EINVAL if the property does not exist,
433 * -ENODATA if property does not have a value, and -EOVERFLOW if the
434 * property data isn't large enough.
436 * dts entry of array should be like:
437 * property = /bits/ 16 <0x5000 0x6000 0x7000>;
439 * The out_values is modified only if a valid u16 value can be decoded.
441 static inline int of_property_read_u16_array(const struct device_node *np,
442 const char *propname,
443 u16 *out_values, size_t sz)
445 int ret = of_property_read_variable_u16_array(np, propname, out_values,
454 * of_property_read_u32_array - Find and read an array of 32 bit integers
457 * @np: device node from which the property value is to be read.
458 * @propname: name of the property to be searched.
459 * @out_values: pointer to return value, modified only if return value is 0.
460 * @sz: number of array elements to read
462 * Search for a property in a device node and read 32-bit value(s) from
463 * it. Returns 0 on success, -EINVAL if the property does not exist,
464 * -ENODATA if property does not have a value, and -EOVERFLOW if the
465 * property data isn't large enough.
467 * The out_values is modified only if a valid u32 value can be decoded.
469 static inline int of_property_read_u32_array(const struct device_node *np,
470 const char *propname,
471 u32 *out_values, size_t sz)
473 int ret = of_property_read_variable_u32_array(np, propname, out_values,
482 * of_property_read_u64_array - Find and read an array of 64 bit integers
485 * @np: device node from which the property value is to be read.
486 * @propname: name of the property to be searched.
487 * @out_values: pointer to return value, modified only if return value is 0.
488 * @sz: number of array elements to read
490 * Search for a property in a device node and read 64-bit value(s) from
491 * it. Returns 0 on success, -EINVAL if the property does not exist,
492 * -ENODATA if property does not have a value, and -EOVERFLOW if the
493 * property data isn't large enough.
495 * The out_values is modified only if a valid u64 value can be decoded.
497 static inline int of_property_read_u64_array(const struct device_node *np,
498 const char *propname,
499 u64 *out_values, size_t sz)
501 int ret = of_property_read_variable_u64_array(np, propname, out_values,
510 * struct property *prop;
514 * of_property_for_each_u32(np, "propname", prop, p, u)
515 * printk("U32 value: %x\n", u);
517 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
520 * struct property *prop;
523 * of_property_for_each_string(np, "propname", prop, s)
524 * printk("String value: %s\n", s);
526 const char *of_prop_next_string(struct property *prop, const char *cur);
528 bool of_console_check(struct device_node *dn, char *name, int index);
530 #else /* CONFIG_OF */
532 static inline void of_core_init(void)
536 static inline bool is_of_node(struct fwnode_handle *fwnode)
541 static inline struct device_node *to_of_node(struct fwnode_handle *fwnode)
546 static inline const char* of_node_full_name(const struct device_node *np)
551 static inline struct device_node *of_find_node_by_name(struct device_node *from,
557 static inline struct device_node *of_find_node_by_type(struct device_node *from,
563 static inline struct device_node *of_find_matching_node_and_match(
564 struct device_node *from,
565 const struct of_device_id *matches,
566 const struct of_device_id **match)
571 static inline struct device_node *of_find_node_by_path(const char *path)
576 static inline struct device_node *of_find_node_opts_by_path(const char *path,
582 static inline struct device_node *of_find_node_by_phandle(phandle handle)
587 static inline struct device_node *of_get_parent(const struct device_node *node)
592 static inline struct device_node *of_get_next_child(
593 const struct device_node *node, struct device_node *prev)
598 static inline struct device_node *of_get_next_available_child(
599 const struct device_node *node, struct device_node *prev)
604 static inline struct device_node *of_find_node_with_property(
605 struct device_node *from, const char *prop_name)
610 #define of_fwnode_handle(node) NULL
612 static inline bool of_have_populated_dt(void)
617 static inline struct device_node *of_get_child_by_name(
618 const struct device_node *node,
624 static inline int of_device_is_compatible(const struct device_node *device,
630 static inline bool of_device_is_available(const struct device_node *device)
635 static inline bool of_device_is_big_endian(const struct device_node *device)
640 static inline struct property *of_find_property(const struct device_node *np,
647 static inline struct device_node *of_find_compatible_node(
648 struct device_node *from,
655 static inline int of_property_count_elems_of_size(const struct device_node *np,
656 const char *propname, int elem_size)
661 static inline int of_property_read_u32_index(const struct device_node *np,
662 const char *propname, u32 index, u32 *out_value)
667 static inline int of_property_read_u8_array(const struct device_node *np,
668 const char *propname, u8 *out_values, size_t sz)
673 static inline int of_property_read_u16_array(const struct device_node *np,
674 const char *propname, u16 *out_values, size_t sz)
679 static inline int of_property_read_u32_array(const struct device_node *np,
680 const char *propname,
681 u32 *out_values, size_t sz)
686 static inline int of_property_read_u64_array(const struct device_node *np,
687 const char *propname,
688 u64 *out_values, size_t sz)
693 static inline int of_property_read_string(const struct device_node *np,
694 const char *propname,
695 const char **out_string)
700 static inline int of_property_read_string_helper(const struct device_node *np,
701 const char *propname,
702 const char **out_strs, size_t sz, int index)
707 static inline const void *of_get_property(const struct device_node *node,
714 static inline struct device_node *of_get_cpu_node(int cpu,
715 unsigned int *thread)
720 static inline int of_property_read_u64(const struct device_node *np,
721 const char *propname, u64 *out_value)
726 static inline int of_property_match_string(const struct device_node *np,
727 const char *propname,
733 static inline struct device_node *of_parse_phandle(const struct device_node *np,
734 const char *phandle_name,
740 static inline int of_parse_phandle_with_args(const struct device_node *np,
741 const char *list_name,
742 const char *cells_name,
744 struct of_phandle_args *out_args)
749 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
750 const char *list_name, int cells_count, int index,
751 struct of_phandle_args *out_args)
756 static inline int of_count_phandle_with_args(struct device_node *np,
757 const char *list_name,
758 const char *cells_name)
763 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
764 const struct device_node *np,
765 const char *list_name,
766 const char *cells_name,
772 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
777 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
784 static inline int of_alias_get_id(struct device_node *np, const char *stem)
789 static inline int of_alias_get_highest_id(const char *stem)
794 static inline int of_machine_is_compatible(const char *compat)
799 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
804 static inline const __be32 *of_prop_next_u32(struct property *prop,
805 const __be32 *cur, u32 *pu)
810 static inline const char *of_prop_next_string(struct property *prop,
816 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
821 static inline int of_node_test_and_set_flag(struct device_node *n,
827 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
831 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
835 static inline int of_property_check_flag(struct property *p, unsigned long flag)
840 static inline void of_property_set_flag(struct property *p, unsigned long flag)
844 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
848 #define of_match_ptr(_ptr) NULL
849 #define of_match_node(_matches, _node) NULL
850 #endif /* CONFIG_OF */
852 /* Default string compare functions, Allow arch asm/prom.h to override */
853 #if !defined(of_compat_cmp)
854 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
855 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
856 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
859 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
860 extern int of_node_to_nid(struct device_node *np);
862 static inline int of_node_to_nid(struct device_node *device)
868 #ifdef CONFIG_OF_NUMA
869 extern int of_numa_init(void);
871 static inline int of_numa_init(void)
877 static inline struct device_node *of_find_matching_node(
878 struct device_node *from,
879 const struct of_device_id *matches)
881 return of_find_matching_node_and_match(from, matches, NULL);
885 * of_property_count_u8_elems - Count the number of u8 elements in a property
887 * @np: device node from which the property value is to be read.
888 * @propname: name of the property to be searched.
890 * Search for a property in a device node and count the number of u8 elements
891 * in it. Returns number of elements on sucess, -EINVAL if the property does
892 * not exist or its length does not match a multiple of u8 and -ENODATA if the
893 * property does not have a value.
895 static inline int of_property_count_u8_elems(const struct device_node *np,
896 const char *propname)
898 return of_property_count_elems_of_size(np, propname, sizeof(u8));
902 * of_property_count_u16_elems - Count the number of u16 elements in a property
904 * @np: device node from which the property value is to be read.
905 * @propname: name of the property to be searched.
907 * Search for a property in a device node and count the number of u16 elements
908 * in it. Returns number of elements on sucess, -EINVAL if the property does
909 * not exist or its length does not match a multiple of u16 and -ENODATA if the
910 * property does not have a value.
912 static inline int of_property_count_u16_elems(const struct device_node *np,
913 const char *propname)
915 return of_property_count_elems_of_size(np, propname, sizeof(u16));
919 * of_property_count_u32_elems - Count the number of u32 elements in a property
921 * @np: device node from which the property value is to be read.
922 * @propname: name of the property to be searched.
924 * Search for a property in a device node and count the number of u32 elements
925 * in it. Returns number of elements on sucess, -EINVAL if the property does
926 * not exist or its length does not match a multiple of u32 and -ENODATA if the
927 * property does not have a value.
929 static inline int of_property_count_u32_elems(const struct device_node *np,
930 const char *propname)
932 return of_property_count_elems_of_size(np, propname, sizeof(u32));
936 * of_property_count_u64_elems - Count the number of u64 elements in a property
938 * @np: device node from which the property value is to be read.
939 * @propname: name of the property to be searched.
941 * Search for a property in a device node and count the number of u64 elements
942 * in it. Returns number of elements on sucess, -EINVAL if the property does
943 * not exist or its length does not match a multiple of u64 and -ENODATA if the
944 * property does not have a value.
946 static inline int of_property_count_u64_elems(const struct device_node *np,
947 const char *propname)
949 return of_property_count_elems_of_size(np, propname, sizeof(u64));
953 * of_property_read_string_array() - Read an array of strings from a multiple
955 * @np: device node from which the property value is to be read.
956 * @propname: name of the property to be searched.
957 * @out_strs: output array of string pointers.
958 * @sz: number of array elements to read.
960 * Search for a property in a device tree node and retrieve a list of
961 * terminated string values (pointer to data, not a copy) in that property.
963 * If @out_strs is NULL, the number of strings in the property is returned.
965 static inline int of_property_read_string_array(const struct device_node *np,
966 const char *propname, const char **out_strs,
969 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
973 * of_property_count_strings() - Find and return the number of strings from a
974 * multiple strings property.
975 * @np: device node from which the property value is to be read.
976 * @propname: name of the property to be searched.
978 * Search for a property in a device tree node and retrieve the number of null
979 * terminated string contain in it. Returns the number of strings on
980 * success, -EINVAL if the property does not exist, -ENODATA if property
981 * does not have a value, and -EILSEQ if the string is not null-terminated
982 * within the length of the property data.
984 static inline int of_property_count_strings(const struct device_node *np,
985 const char *propname)
987 return of_property_read_string_helper(np, propname, NULL, 0, 0);
991 * of_property_read_string_index() - Find and read a string from a multiple
993 * @np: device node from which the property value is to be read.
994 * @propname: name of the property to be searched.
995 * @index: index of the string in the list of strings
996 * @out_string: pointer to null terminated return string, modified only if
999 * Search for a property in a device tree node and retrieve a null
1000 * terminated string value (pointer to data, not a copy) in the list of strings
1001 * contained in that property.
1002 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1003 * property does not have a value, and -EILSEQ if the string is not
1004 * null-terminated within the length of the property data.
1006 * The out_string pointer is modified only if a valid string can be decoded.
1008 static inline int of_property_read_string_index(const struct device_node *np,
1009 const char *propname,
1010 int index, const char **output)
1012 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1013 return rc < 0 ? rc : 0;
1017 * of_property_read_bool - Findfrom a property
1018 * @np: device node from which the property value is to be read.
1019 * @propname: name of the property to be searched.
1021 * Search for a property in a device node.
1022 * Returns true if the property exists false otherwise.
1024 static inline bool of_property_read_bool(const struct device_node *np,
1025 const char *propname)
1027 struct property *prop = of_find_property(np, propname, NULL);
1029 return prop ? true : false;
1032 static inline int of_property_read_u8(const struct device_node *np,
1033 const char *propname,
1036 return of_property_read_u8_array(np, propname, out_value, 1);
1039 static inline int of_property_read_u16(const struct device_node *np,
1040 const char *propname,
1043 return of_property_read_u16_array(np, propname, out_value, 1);
1046 static inline int of_property_read_u32(const struct device_node *np,
1047 const char *propname,
1050 return of_property_read_u32_array(np, propname, out_value, 1);
1053 static inline int of_property_read_s32(const struct device_node *np,
1054 const char *propname,
1057 return of_property_read_u32(np, propname, (u32*) out_value);
1060 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1061 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1062 err = of_phandle_iterator_next(it); \
1064 err = of_phandle_iterator_next(it))
1066 #define of_property_for_each_u32(np, propname, prop, p, u) \
1067 for (prop = of_find_property(np, propname, NULL), \
1068 p = of_prop_next_u32(prop, NULL, &u); \
1070 p = of_prop_next_u32(prop, p, &u))
1072 #define of_property_for_each_string(np, propname, prop, s) \
1073 for (prop = of_find_property(np, propname, NULL), \
1074 s = of_prop_next_string(prop, NULL); \
1076 s = of_prop_next_string(prop, s))
1078 #define for_each_node_by_name(dn, name) \
1079 for (dn = of_find_node_by_name(NULL, name); dn; \
1080 dn = of_find_node_by_name(dn, name))
1081 #define for_each_node_by_type(dn, type) \
1082 for (dn = of_find_node_by_type(NULL, type); dn; \
1083 dn = of_find_node_by_type(dn, type))
1084 #define for_each_compatible_node(dn, type, compatible) \
1085 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1086 dn = of_find_compatible_node(dn, type, compatible))
1087 #define for_each_matching_node(dn, matches) \
1088 for (dn = of_find_matching_node(NULL, matches); dn; \
1089 dn = of_find_matching_node(dn, matches))
1090 #define for_each_matching_node_and_match(dn, matches, match) \
1091 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1092 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1094 #define for_each_child_of_node(parent, child) \
1095 for (child = of_get_next_child(parent, NULL); child != NULL; \
1096 child = of_get_next_child(parent, child))
1097 #define for_each_available_child_of_node(parent, child) \
1098 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1099 child = of_get_next_available_child(parent, child))
1101 #define for_each_node_with_property(dn, prop_name) \
1102 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1103 dn = of_find_node_with_property(dn, prop_name))
1105 static inline int of_get_child_count(const struct device_node *np)
1107 struct device_node *child;
1110 for_each_child_of_node(np, child)
1116 static inline int of_get_available_child_count(const struct device_node *np)
1118 struct device_node *child;
1121 for_each_available_child_of_node(np, child)
1127 #if defined(CONFIG_OF) && !defined(MODULE)
1128 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1129 static const struct of_device_id __of_table_##name \
1130 __used __section(__##table##_of_table) \
1131 = { .compatible = compat, \
1132 .data = (fn == (fn_type)NULL) ? fn : fn }
1134 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1135 static const struct of_device_id __of_table_##name \
1136 __attribute__((unused)) \
1137 = { .compatible = compat, \
1138 .data = (fn == (fn_type)NULL) ? fn : fn }
1141 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1142 typedef int (*of_init_fn_1_ret)(struct device_node *);
1143 typedef void (*of_init_fn_1)(struct device_node *);
1145 #define OF_DECLARE_1(table, name, compat, fn) \
1146 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1147 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1148 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1149 #define OF_DECLARE_2(table, name, compat, fn) \
1150 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1153 * struct of_changeset_entry - Holds a changeset entry
1155 * @node: list_head for the log list
1156 * @action: notifier action
1157 * @np: pointer to the device node affected
1158 * @prop: pointer to the property affected
1159 * @old_prop: hold a pointer to the original property
1161 * Every modification of the device tree during a changeset
1162 * is held in a list of of_changeset_entry structures.
1163 * That way we can recover from a partial application, or we can
1164 * revert the changeset
1166 struct of_changeset_entry {
1167 struct list_head node;
1168 unsigned long action;
1169 struct device_node *np;
1170 struct property *prop;
1171 struct property *old_prop;
1175 * struct of_changeset - changeset tracker structure
1177 * @entries: list_head for the changeset entries
1179 * changesets are a convenient way to apply bulk changes to the
1180 * live tree. In case of an error, changes are rolled-back.
1181 * changesets live on after initial application, and if not
1182 * destroyed after use, they can be reverted in one single call.
1184 struct of_changeset {
1185 struct list_head entries;
1188 enum of_reconfig_change {
1189 OF_RECONFIG_NO_CHANGE = 0,
1190 OF_RECONFIG_CHANGE_ADD,
1191 OF_RECONFIG_CHANGE_REMOVE,
1194 #ifdef CONFIG_OF_DYNAMIC
1195 extern int of_reconfig_notifier_register(struct notifier_block *);
1196 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1197 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1198 extern int of_reconfig_get_state_change(unsigned long action,
1199 struct of_reconfig_data *arg);
1201 extern void of_changeset_init(struct of_changeset *ocs);
1202 extern void of_changeset_destroy(struct of_changeset *ocs);
1203 extern int of_changeset_apply(struct of_changeset *ocs);
1204 extern int of_changeset_revert(struct of_changeset *ocs);
1205 extern int of_changeset_action(struct of_changeset *ocs,
1206 unsigned long action, struct device_node *np,
1207 struct property *prop);
1209 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1210 struct device_node *np)
1212 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1215 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1216 struct device_node *np)
1218 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1221 static inline int of_changeset_add_property(struct of_changeset *ocs,
1222 struct device_node *np, struct property *prop)
1224 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1227 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1228 struct device_node *np, struct property *prop)
1230 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1233 static inline int of_changeset_update_property(struct of_changeset *ocs,
1234 struct device_node *np, struct property *prop)
1236 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1238 #else /* CONFIG_OF_DYNAMIC */
1239 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1243 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1247 static inline int of_reconfig_notify(unsigned long action,
1248 struct of_reconfig_data *arg)
1252 static inline int of_reconfig_get_state_change(unsigned long action,
1253 struct of_reconfig_data *arg)
1257 #endif /* CONFIG_OF_DYNAMIC */
1259 /* CONFIG_OF_RESOLVE api */
1260 extern int of_resolve_phandles(struct device_node *tree);
1263 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1264 * @np: Pointer to the given device_node
1266 * return true if present false otherwise
1268 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1270 return of_property_read_bool(np, "system-power-controller");
1277 enum of_overlay_notify_action {
1278 OF_OVERLAY_PRE_APPLY,
1279 OF_OVERLAY_POST_APPLY,
1280 OF_OVERLAY_PRE_REMOVE,
1281 OF_OVERLAY_POST_REMOVE,
1284 struct of_overlay_notify_data {
1285 struct device_node *overlay;
1286 struct device_node *target;
1289 #ifdef CONFIG_OF_OVERLAY
1291 /* ID based overlays; the API for external users */
1292 int of_overlay_create(struct device_node *tree);
1293 int of_overlay_destroy(int id);
1294 int of_overlay_destroy_all(void);
1296 int of_overlay_notifier_register(struct notifier_block *nb);
1297 int of_overlay_notifier_unregister(struct notifier_block *nb);
1301 static inline int of_overlay_create(struct device_node *tree)
1306 static inline int of_overlay_destroy(int id)
1311 static inline int of_overlay_destroy_all(void)
1316 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1321 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1328 #endif /* _LINUX_OF_H */