6545e7aec7bb95dc41ad6225050cb19e7038287a
[sfrench/cifs-2.6.git] / include / linux / of.h
1 #ifndef _LINUX_OF_H
2 #define _LINUX_OF_H
3 /*
4  * Definitions for talking to the Open Firmware PROM on
5  * Power Macintosh and other computers.
6  *
7  * Copyright (C) 1996-2005 Paul Mackerras.
8  *
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.
12  *
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.
17  */
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
27 #include <asm/byteorder.h>
28 #include <asm/errno.h>
29
30 typedef u32 phandle;
31 typedef u32 ihandle;
32
33 struct property {
34         char    *name;
35         int     length;
36         void    *value;
37         struct property *next;
38         unsigned long _flags;
39         unsigned int unique_id;
40         struct bin_attribute attr;
41 };
42
43 #if defined(CONFIG_SPARC)
44 struct of_irq_controller;
45 #endif
46
47 struct device_node {
48         const char *name;
49         const char *type;
50         phandle phandle;
51         const char *full_name;
52
53         struct  property *properties;
54         struct  property *deadprops;    /* removed properties */
55         struct  device_node *parent;
56         struct  device_node *child;
57         struct  device_node *sibling;
58         struct  device_node *next;      /* next device of same type */
59         struct  device_node *allnext;   /* next in list of all nodes */
60         struct  kobject kobj;
61         unsigned long _flags;
62         void    *data;
63 #if defined(CONFIG_SPARC)
64         const char *path_component_name;
65         unsigned int unique_id;
66         struct of_irq_controller *irq_trans;
67 #endif
68 };
69
70 #define MAX_PHANDLE_ARGS 16
71 struct of_phandle_args {
72         struct device_node *np;
73         int args_count;
74         uint32_t args[MAX_PHANDLE_ARGS];
75 };
76
77 /* initialize a node */
78 extern struct kobj_type of_node_ktype;
79 static inline void of_node_init(struct device_node *node)
80 {
81         kobject_init(&node->kobj, &of_node_ktype);
82 }
83
84 /* true when node is initialized */
85 static inline int of_node_is_initialized(struct device_node *node)
86 {
87         return node && node->kobj.state_initialized;
88 }
89
90 /* true when node is attached (i.e. present on sysfs) */
91 static inline int of_node_is_attached(struct device_node *node)
92 {
93         return node && node->kobj.state_in_sysfs;
94 }
95
96 #ifdef CONFIG_OF_DYNAMIC
97 extern struct device_node *of_node_get(struct device_node *node);
98 extern void of_node_put(struct device_node *node);
99 #else /* CONFIG_OF_DYNAMIC */
100 /* Dummy ref counting routines - to be implemented later */
101 static inline struct device_node *of_node_get(struct device_node *node)
102 {
103         return node;
104 }
105 static inline void of_node_put(struct device_node *node) { }
106 #endif /* !CONFIG_OF_DYNAMIC */
107
108 #ifdef CONFIG_OF
109
110 /* Pointer for first entry in chain of all nodes. */
111 extern struct device_node *of_allnodes;
112 extern struct device_node *of_chosen;
113 extern struct device_node *of_aliases;
114 extern struct device_node *of_stdout;
115 extern raw_spinlock_t devtree_lock;
116
117 static inline bool of_have_populated_dt(void)
118 {
119         return of_allnodes != NULL;
120 }
121
122 static inline bool of_node_is_root(const struct device_node *node)
123 {
124         return node && (node->parent == NULL);
125 }
126
127 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
128 {
129         return test_bit(flag, &n->_flags);
130 }
131
132 static inline int of_node_test_and_set_flag(struct device_node *n,
133                                             unsigned long flag)
134 {
135         return test_and_set_bit(flag, &n->_flags);
136 }
137
138 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
139 {
140         set_bit(flag, &n->_flags);
141 }
142
143 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
144 {
145         clear_bit(flag, &n->_flags);
146 }
147
148 static inline int of_property_check_flag(struct property *p, unsigned long flag)
149 {
150         return test_bit(flag, &p->_flags);
151 }
152
153 static inline void of_property_set_flag(struct property *p, unsigned long flag)
154 {
155         set_bit(flag, &p->_flags);
156 }
157
158 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
159 {
160         clear_bit(flag, &p->_flags);
161 }
162
163 extern struct device_node *of_find_all_nodes(struct device_node *prev);
164
165 /*
166  * OF address retrieval & translation
167  */
168
169 /* Helper to read a big number; size is in cells (not bytes) */
170 static inline u64 of_read_number(const __be32 *cell, int size)
171 {
172         u64 r = 0;
173         while (size--)
174                 r = (r << 32) | be32_to_cpu(*(cell++));
175         return r;
176 }
177
178 /* Like of_read_number, but we want an unsigned long result */
179 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
180 {
181         /* toss away upper bits if unsigned long is smaller than u64 */
182         return of_read_number(cell, size);
183 }
184
185 #if defined(CONFIG_SPARC)
186 #include <asm/prom.h>
187 #endif
188
189 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
190 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
191 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
192 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
193 #endif
194
195 /* Default string compare functions, Allow arch asm/prom.h to override */
196 #if !defined(of_compat_cmp)
197 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
198 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
199 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
200 #endif
201
202 /* flag descriptions */
203 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
204 #define OF_DETACHED     2 /* node has been detached from the device tree */
205 #define OF_POPULATED    3 /* device already created for the node */
206 #define OF_POPULATED_BUS        4 /* of_platform_populate recursed to children of this node */
207
208 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
209 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
210
211 #define OF_BAD_ADDR     ((u64)-1)
212
213 static inline const char *of_node_full_name(const struct device_node *np)
214 {
215         return np ? np->full_name : "<no-node>";
216 }
217
218 #define for_each_of_allnodes(dn) \
219         for (dn = of_allnodes; dn; dn = dn->allnext)
220 extern struct device_node *of_find_node_by_name(struct device_node *from,
221         const char *name);
222 extern struct device_node *of_find_node_by_type(struct device_node *from,
223         const char *type);
224 extern struct device_node *of_find_compatible_node(struct device_node *from,
225         const char *type, const char *compat);
226 extern struct device_node *of_find_matching_node_and_match(
227         struct device_node *from,
228         const struct of_device_id *matches,
229         const struct of_device_id **match);
230
231 extern struct device_node *of_find_node_by_path(const char *path);
232 extern struct device_node *of_find_node_by_phandle(phandle handle);
233 extern struct device_node *of_get_parent(const struct device_node *node);
234 extern struct device_node *of_get_next_parent(struct device_node *node);
235 extern struct device_node *of_get_next_child(const struct device_node *node,
236                                              struct device_node *prev);
237 extern struct device_node *of_get_next_available_child(
238         const struct device_node *node, struct device_node *prev);
239
240 extern struct device_node *of_get_child_by_name(const struct device_node *node,
241                                         const char *name);
242
243 /* cache lookup */
244 extern struct device_node *of_find_next_cache_node(const struct device_node *);
245 extern struct device_node *of_find_node_with_property(
246         struct device_node *from, const char *prop_name);
247
248 extern struct property *of_find_property(const struct device_node *np,
249                                          const char *name,
250                                          int *lenp);
251 extern int of_property_count_elems_of_size(const struct device_node *np,
252                                 const char *propname, int elem_size);
253 extern int of_property_read_u32_index(const struct device_node *np,
254                                        const char *propname,
255                                        u32 index, u32 *out_value);
256 extern int of_property_read_u8_array(const struct device_node *np,
257                         const char *propname, u8 *out_values, size_t sz);
258 extern int of_property_read_u16_array(const struct device_node *np,
259                         const char *propname, u16 *out_values, size_t sz);
260 extern int of_property_read_u32_array(const struct device_node *np,
261                                       const char *propname,
262                                       u32 *out_values,
263                                       size_t sz);
264 extern int of_property_read_u64(const struct device_node *np,
265                                 const char *propname, u64 *out_value);
266
267 extern int of_property_read_string(struct device_node *np,
268                                    const char *propname,
269                                    const char **out_string);
270 extern int of_property_read_string_index(struct device_node *np,
271                                          const char *propname,
272                                          int index, const char **output);
273 extern int of_property_match_string(struct device_node *np,
274                                     const char *propname,
275                                     const char *string);
276 extern int of_property_count_strings(struct device_node *np,
277                                      const char *propname);
278 extern int of_device_is_compatible(const struct device_node *device,
279                                    const char *);
280 extern int of_device_is_available(const struct device_node *device);
281 extern const void *of_get_property(const struct device_node *node,
282                                 const char *name,
283                                 int *lenp);
284 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
285 #define for_each_property_of_node(dn, pp) \
286         for (pp = dn->properties; pp != NULL; pp = pp->next)
287
288 extern int of_n_addr_cells(struct device_node *np);
289 extern int of_n_size_cells(struct device_node *np);
290 extern const struct of_device_id *of_match_node(
291         const struct of_device_id *matches, const struct device_node *node);
292 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
293 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
294 extern struct device_node *of_parse_phandle(const struct device_node *np,
295                                             const char *phandle_name,
296                                             int index);
297 extern int of_parse_phandle_with_args(const struct device_node *np,
298         const char *list_name, const char *cells_name, int index,
299         struct of_phandle_args *out_args);
300 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
301         const char *list_name, int cells_count, int index,
302         struct of_phandle_args *out_args);
303 extern int of_count_phandle_with_args(const struct device_node *np,
304         const char *list_name, const char *cells_name);
305
306 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
307 extern int of_alias_get_id(struct device_node *np, const char *stem);
308
309 extern int of_machine_is_compatible(const char *compat);
310
311 extern int of_add_property(struct device_node *np, struct property *prop);
312 extern int of_remove_property(struct device_node *np, struct property *prop);
313 extern int of_update_property(struct device_node *np, struct property *newprop);
314
315 /* For updating the device tree at runtime */
316 #define OF_RECONFIG_ATTACH_NODE         0x0001
317 #define OF_RECONFIG_DETACH_NODE         0x0002
318 #define OF_RECONFIG_ADD_PROPERTY        0x0003
319 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
320 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
321
322 struct of_prop_reconfig {
323         struct device_node      *dn;
324         struct property         *prop;
325         struct property         *old_prop;
326 };
327
328 extern int of_reconfig_notifier_register(struct notifier_block *);
329 extern int of_reconfig_notifier_unregister(struct notifier_block *);
330 extern int of_reconfig_notify(unsigned long, void *);
331
332 extern int of_attach_node(struct device_node *);
333 extern int of_detach_node(struct device_node *);
334
335 #define of_match_ptr(_ptr)      (_ptr)
336
337 /*
338  * struct property *prop;
339  * const __be32 *p;
340  * u32 u;
341  *
342  * of_property_for_each_u32(np, "propname", prop, p, u)
343  *         printk("U32 value: %x\n", u);
344  */
345 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
346                                u32 *pu);
347 /*
348  * struct property *prop;
349  * const char *s;
350  *
351  * of_property_for_each_string(np, "propname", prop, s)
352  *         printk("String value: %s\n", s);
353  */
354 const char *of_prop_next_string(struct property *prop, const char *cur);
355
356 bool of_console_check(struct device_node *dn, char *name, int index);
357
358 #else /* CONFIG_OF */
359
360 static inline const char* of_node_full_name(const struct device_node *np)
361 {
362         return "<no-node>";
363 }
364
365 static inline struct device_node *of_find_node_by_name(struct device_node *from,
366         const char *name)
367 {
368         return NULL;
369 }
370
371 static inline struct device_node *of_find_node_by_type(struct device_node *from,
372         const char *type)
373 {
374         return NULL;
375 }
376
377 static inline struct device_node *of_find_matching_node_and_match(
378         struct device_node *from,
379         const struct of_device_id *matches,
380         const struct of_device_id **match)
381 {
382         return NULL;
383 }
384
385 static inline struct device_node *of_find_node_by_path(const char *path)
386 {
387         return NULL;
388 }
389
390 static inline struct device_node *of_get_parent(const struct device_node *node)
391 {
392         return NULL;
393 }
394
395 static inline struct device_node *of_get_next_child(
396         const struct device_node *node, struct device_node *prev)
397 {
398         return NULL;
399 }
400
401 static inline struct device_node *of_get_next_available_child(
402         const struct device_node *node, struct device_node *prev)
403 {
404         return NULL;
405 }
406
407 static inline struct device_node *of_find_node_with_property(
408         struct device_node *from, const char *prop_name)
409 {
410         return NULL;
411 }
412
413 static inline bool of_have_populated_dt(void)
414 {
415         return false;
416 }
417
418 static inline struct device_node *of_get_child_by_name(
419                                         const struct device_node *node,
420                                         const char *name)
421 {
422         return NULL;
423 }
424
425 static inline int of_device_is_compatible(const struct device_node *device,
426                                           const char *name)
427 {
428         return 0;
429 }
430
431 static inline int of_device_is_available(const struct device_node *device)
432 {
433         return 0;
434 }
435
436 static inline struct property *of_find_property(const struct device_node *np,
437                                                 const char *name,
438                                                 int *lenp)
439 {
440         return NULL;
441 }
442
443 static inline struct device_node *of_find_compatible_node(
444                                                 struct device_node *from,
445                                                 const char *type,
446                                                 const char *compat)
447 {
448         return NULL;
449 }
450
451 static inline int of_property_count_elems_of_size(const struct device_node *np,
452                         const char *propname, int elem_size)
453 {
454         return -ENOSYS;
455 }
456
457 static inline int of_property_read_u32_index(const struct device_node *np,
458                         const char *propname, u32 index, u32 *out_value)
459 {
460         return -ENOSYS;
461 }
462
463 static inline int of_property_read_u8_array(const struct device_node *np,
464                         const char *propname, u8 *out_values, size_t sz)
465 {
466         return -ENOSYS;
467 }
468
469 static inline int of_property_read_u16_array(const struct device_node *np,
470                         const char *propname, u16 *out_values, size_t sz)
471 {
472         return -ENOSYS;
473 }
474
475 static inline int of_property_read_u32_array(const struct device_node *np,
476                                              const char *propname,
477                                              u32 *out_values, size_t sz)
478 {
479         return -ENOSYS;
480 }
481
482 static inline int of_property_read_string(struct device_node *np,
483                                           const char *propname,
484                                           const char **out_string)
485 {
486         return -ENOSYS;
487 }
488
489 static inline int of_property_read_string_index(struct device_node *np,
490                                                 const char *propname, int index,
491                                                 const char **out_string)
492 {
493         return -ENOSYS;
494 }
495
496 static inline int of_property_count_strings(struct device_node *np,
497                                             const char *propname)
498 {
499         return -ENOSYS;
500 }
501
502 static inline const void *of_get_property(const struct device_node *node,
503                                 const char *name,
504                                 int *lenp)
505 {
506         return NULL;
507 }
508
509 static inline struct device_node *of_get_cpu_node(int cpu,
510                                         unsigned int *thread)
511 {
512         return NULL;
513 }
514
515 static inline int of_property_read_u64(const struct device_node *np,
516                                        const char *propname, u64 *out_value)
517 {
518         return -ENOSYS;
519 }
520
521 static inline int of_property_match_string(struct device_node *np,
522                                            const char *propname,
523                                            const char *string)
524 {
525         return -ENOSYS;
526 }
527
528 static inline struct device_node *of_parse_phandle(const struct device_node *np,
529                                                    const char *phandle_name,
530                                                    int index)
531 {
532         return NULL;
533 }
534
535 static inline int of_parse_phandle_with_args(struct device_node *np,
536                                              const char *list_name,
537                                              const char *cells_name,
538                                              int index,
539                                              struct of_phandle_args *out_args)
540 {
541         return -ENOSYS;
542 }
543
544 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
545         const char *list_name, int cells_count, int index,
546         struct of_phandle_args *out_args)
547 {
548         return -ENOSYS;
549 }
550
551 static inline int of_count_phandle_with_args(struct device_node *np,
552                                              const char *list_name,
553                                              const char *cells_name)
554 {
555         return -ENOSYS;
556 }
557
558 static inline int of_alias_get_id(struct device_node *np, const char *stem)
559 {
560         return -ENOSYS;
561 }
562
563 static inline int of_machine_is_compatible(const char *compat)
564 {
565         return 0;
566 }
567
568 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
569 {
570         return false;
571 }
572
573 static inline const __be32 *of_prop_next_u32(struct property *prop,
574                 const __be32 *cur, u32 *pu)
575 {
576         return NULL;
577 }
578
579 static inline const char *of_prop_next_string(struct property *prop,
580                 const char *cur)
581 {
582         return NULL;
583 }
584
585 #define of_match_ptr(_ptr)      NULL
586 #define of_match_node(_matches, _node)  NULL
587 #endif /* CONFIG_OF */
588
589 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
590 extern int of_node_to_nid(struct device_node *np);
591 #else
592 static inline int of_node_to_nid(struct device_node *device) { return 0; }
593 #endif
594
595 static inline struct device_node *of_find_matching_node(
596         struct device_node *from,
597         const struct of_device_id *matches)
598 {
599         return of_find_matching_node_and_match(from, matches, NULL);
600 }
601
602 /**
603  * of_property_count_u8_elems - Count the number of u8 elements in a property
604  *
605  * @np:         device node from which the property value is to be read.
606  * @propname:   name of the property to be searched.
607  *
608  * Search for a property in a device node and count the number of u8 elements
609  * in it. Returns number of elements on sucess, -EINVAL if the property does
610  * not exist or its length does not match a multiple of u8 and -ENODATA if the
611  * property does not have a value.
612  */
613 static inline int of_property_count_u8_elems(const struct device_node *np,
614                                 const char *propname)
615 {
616         return of_property_count_elems_of_size(np, propname, sizeof(u8));
617 }
618
619 /**
620  * of_property_count_u16_elems - Count the number of u16 elements in a property
621  *
622  * @np:         device node from which the property value is to be read.
623  * @propname:   name of the property to be searched.
624  *
625  * Search for a property in a device node and count the number of u16 elements
626  * in it. Returns number of elements on sucess, -EINVAL if the property does
627  * not exist or its length does not match a multiple of u16 and -ENODATA if the
628  * property does not have a value.
629  */
630 static inline int of_property_count_u16_elems(const struct device_node *np,
631                                 const char *propname)
632 {
633         return of_property_count_elems_of_size(np, propname, sizeof(u16));
634 }
635
636 /**
637  * of_property_count_u32_elems - Count the number of u32 elements in a property
638  *
639  * @np:         device node from which the property value is to be read.
640  * @propname:   name of the property to be searched.
641  *
642  * Search for a property in a device node and count the number of u32 elements
643  * in it. Returns number of elements on sucess, -EINVAL if the property does
644  * not exist or its length does not match a multiple of u32 and -ENODATA if the
645  * property does not have a value.
646  */
647 static inline int of_property_count_u32_elems(const struct device_node *np,
648                                 const char *propname)
649 {
650         return of_property_count_elems_of_size(np, propname, sizeof(u32));
651 }
652
653 /**
654  * of_property_count_u64_elems - Count the number of u64 elements in a property
655  *
656  * @np:         device node from which the property value is to be read.
657  * @propname:   name of the property to be searched.
658  *
659  * Search for a property in a device node and count the number of u64 elements
660  * in it. Returns number of elements on sucess, -EINVAL if the property does
661  * not exist or its length does not match a multiple of u64 and -ENODATA if the
662  * property does not have a value.
663  */
664 static inline int of_property_count_u64_elems(const struct device_node *np,
665                                 const char *propname)
666 {
667         return of_property_count_elems_of_size(np, propname, sizeof(u64));
668 }
669
670 /**
671  * of_property_read_bool - Findfrom a property
672  * @np:         device node from which the property value is to be read.
673  * @propname:   name of the property to be searched.
674  *
675  * Search for a property in a device node.
676  * Returns true if the property exist false otherwise.
677  */
678 static inline bool of_property_read_bool(const struct device_node *np,
679                                          const char *propname)
680 {
681         struct property *prop = of_find_property(np, propname, NULL);
682
683         return prop ? true : false;
684 }
685
686 static inline int of_property_read_u8(const struct device_node *np,
687                                        const char *propname,
688                                        u8 *out_value)
689 {
690         return of_property_read_u8_array(np, propname, out_value, 1);
691 }
692
693 static inline int of_property_read_u16(const struct device_node *np,
694                                        const char *propname,
695                                        u16 *out_value)
696 {
697         return of_property_read_u16_array(np, propname, out_value, 1);
698 }
699
700 static inline int of_property_read_u32(const struct device_node *np,
701                                        const char *propname,
702                                        u32 *out_value)
703 {
704         return of_property_read_u32_array(np, propname, out_value, 1);
705 }
706
707 #define of_property_for_each_u32(np, propname, prop, p, u)      \
708         for (prop = of_find_property(np, propname, NULL),       \
709                 p = of_prop_next_u32(prop, NULL, &u);           \
710                 p;                                              \
711                 p = of_prop_next_u32(prop, p, &u))
712
713 #define of_property_for_each_string(np, propname, prop, s)      \
714         for (prop = of_find_property(np, propname, NULL),       \
715                 s = of_prop_next_string(prop, NULL);            \
716                 s;                                              \
717                 s = of_prop_next_string(prop, s))
718
719 #define for_each_node_by_name(dn, name) \
720         for (dn = of_find_node_by_name(NULL, name); dn; \
721              dn = of_find_node_by_name(dn, name))
722 #define for_each_node_by_type(dn, type) \
723         for (dn = of_find_node_by_type(NULL, type); dn; \
724              dn = of_find_node_by_type(dn, type))
725 #define for_each_compatible_node(dn, type, compatible) \
726         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
727              dn = of_find_compatible_node(dn, type, compatible))
728 #define for_each_matching_node(dn, matches) \
729         for (dn = of_find_matching_node(NULL, matches); dn; \
730              dn = of_find_matching_node(dn, matches))
731 #define for_each_matching_node_and_match(dn, matches, match) \
732         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
733              dn; dn = of_find_matching_node_and_match(dn, matches, match))
734
735 #define for_each_child_of_node(parent, child) \
736         for (child = of_get_next_child(parent, NULL); child != NULL; \
737              child = of_get_next_child(parent, child))
738 #define for_each_available_child_of_node(parent, child) \
739         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
740              child = of_get_next_available_child(parent, child))
741
742 #define for_each_node_with_property(dn, prop_name) \
743         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
744              dn = of_find_node_with_property(dn, prop_name))
745
746 static inline int of_get_child_count(const struct device_node *np)
747 {
748         struct device_node *child;
749         int num = 0;
750
751         for_each_child_of_node(np, child)
752                 num++;
753
754         return num;
755 }
756
757 static inline int of_get_available_child_count(const struct device_node *np)
758 {
759         struct device_node *child;
760         int num = 0;
761
762         for_each_available_child_of_node(np, child)
763                 num++;
764
765         return num;
766 }
767
768 #ifdef CONFIG_OF
769 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
770         static const struct of_device_id __of_table_##name              \
771                 __used __section(__##table##_of_table)                  \
772                  = { .compatible = compat,                              \
773                      .data = (fn == (fn_type)NULL) ? fn : fn  }
774 #else
775 #define _OF_DECLARE(table, name, compat, fn, fn_type)                                   \
776         static const struct of_device_id __of_table_##name              \
777                 __attribute__((unused))                                 \
778                  = { .compatible = compat,                              \
779                      .data = (fn == (fn_type)NULL) ? fn : fn }
780 #endif
781
782 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
783 typedef void (*of_init_fn_1)(struct device_node *);
784
785 #define OF_DECLARE_1(table, name, compat, fn) \
786                 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
787 #define OF_DECLARE_2(table, name, compat, fn) \
788                 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
789
790 /**
791  * struct of_changeset_entry    - Holds a changeset entry
792  *
793  * @node:       list_head for the log list
794  * @action:     notifier action
795  * @np:         pointer to the device node affected
796  * @prop:       pointer to the property affected
797  * @old_prop:   hold a pointer to the original property
798  *
799  * Every modification of the device tree during a changeset
800  * is held in a list of of_changeset_entry structures.
801  * That way we can recover from a partial application, or we can
802  * revert the changeset
803  */
804 struct of_changeset_entry {
805         struct list_head node;
806         unsigned long action;
807         struct device_node *np;
808         struct property *prop;
809         struct property *old_prop;
810 };
811
812 /**
813  * struct of_changeset - changeset tracker structure
814  *
815  * @entries:    list_head for the changeset entries
816  *
817  * changesets are a convenient way to apply bulk changes to the
818  * live tree. In case of an error, changes are rolled-back.
819  * changesets live on after initial application, and if not
820  * destroyed after use, they can be reverted in one single call.
821  */
822 struct of_changeset {
823         struct list_head entries;
824 };
825
826 #ifdef CONFIG_OF_DYNAMIC
827 extern void of_changeset_init(struct of_changeset *ocs);
828 extern void of_changeset_destroy(struct of_changeset *ocs);
829 extern int of_changeset_apply(struct of_changeset *ocs);
830 extern int of_changeset_revert(struct of_changeset *ocs);
831 extern int of_changeset_action(struct of_changeset *ocs,
832                 unsigned long action, struct device_node *np,
833                 struct property *prop);
834
835 static inline int of_changeset_attach_node(struct of_changeset *ocs,
836                 struct device_node *np)
837 {
838         return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
839 }
840
841 static inline int of_changeset_detach_node(struct of_changeset *ocs,
842                 struct device_node *np)
843 {
844         return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
845 }
846
847 static inline int of_changeset_add_property(struct of_changeset *ocs,
848                 struct device_node *np, struct property *prop)
849 {
850         return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
851 }
852
853 static inline int of_changeset_remove_property(struct of_changeset *ocs,
854                 struct device_node *np, struct property *prop)
855 {
856         return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
857 }
858
859 static inline int of_changeset_update_property(struct of_changeset *ocs,
860                 struct device_node *np, struct property *prop)
861 {
862         return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
863 }
864 #endif
865
866 /* CONFIG_OF_RESOLVE api */
867 extern int of_resolve_phandles(struct device_node *tree);
868
869 #endif /* _LINUX_OF_H */