Merge tag 'iio-fixes-for-4.16a' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / include / linux / of.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 #ifndef _LINUX_OF_H
3 #define _LINUX_OF_H
4 /*
5  * Definitions for talking to the Open Firmware PROM on
6  * Power Macintosh and other computers.
7  *
8  * Copyright (C) 1996-2005 Paul Mackerras.
9  *
10  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
11  * Updates for SPARC64 by David S. Miller
12  * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
13  */
14 #include <linux/types.h>
15 #include <linux/bitops.h>
16 #include <linux/errno.h>
17 #include <linux/kobject.h>
18 #include <linux/mod_devicetable.h>
19 #include <linux/spinlock.h>
20 #include <linux/topology.h>
21 #include <linux/notifier.h>
22 #include <linux/property.h>
23 #include <linux/list.h>
24
25 #include <asm/byteorder.h>
26 #include <asm/errno.h>
27
28 typedef u32 phandle;
29 typedef u32 ihandle;
30
31 struct property {
32         char    *name;
33         int     length;
34         void    *value;
35         struct property *next;
36 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
37         unsigned long _flags;
38 #endif
39 #if defined(CONFIG_OF_PROMTREE)
40         unsigned int unique_id;
41 #endif
42 #if defined(CONFIG_OF_KOBJ)
43         struct bin_attribute attr;
44 #endif
45 };
46
47 #if defined(CONFIG_SPARC)
48 struct of_irq_controller;
49 #endif
50
51 struct device_node {
52         const char *name;
53         const char *type;
54         phandle phandle;
55         const char *full_name;
56         struct fwnode_handle fwnode;
57
58         struct  property *properties;
59         struct  property *deadprops;    /* removed properties */
60         struct  device_node *parent;
61         struct  device_node *child;
62         struct  device_node *sibling;
63 #if defined(CONFIG_OF_KOBJ)
64         struct  kobject kobj;
65 #endif
66         unsigned long _flags;
67         void    *data;
68 #if defined(CONFIG_SPARC)
69         const char *path_component_name;
70         unsigned int unique_id;
71         struct of_irq_controller *irq_trans;
72 #endif
73 };
74
75 #define MAX_PHANDLE_ARGS 16
76 struct of_phandle_args {
77         struct device_node *np;
78         int args_count;
79         uint32_t args[MAX_PHANDLE_ARGS];
80 };
81
82 struct of_phandle_iterator {
83         /* Common iterator information */
84         const char *cells_name;
85         int cell_count;
86         const struct device_node *parent;
87
88         /* List size information */
89         const __be32 *list_end;
90         const __be32 *phandle_end;
91
92         /* Current position state */
93         const __be32 *cur;
94         uint32_t cur_count;
95         phandle phandle;
96         struct device_node *node;
97 };
98
99 struct of_reconfig_data {
100         struct device_node      *dn;
101         struct property         *prop;
102         struct property         *old_prop;
103 };
104
105 /* initialize a node */
106 extern struct kobj_type of_node_ktype;
107 extern const struct fwnode_operations of_fwnode_ops;
108 static inline void of_node_init(struct device_node *node)
109 {
110 #if defined(CONFIG_OF_KOBJ)
111         kobject_init(&node->kobj, &of_node_ktype);
112 #endif
113         node->fwnode.ops = &of_fwnode_ops;
114 }
115
116 #if defined(CONFIG_OF_KOBJ)
117 #define of_node_kobj(n) (&(n)->kobj)
118 #else
119 #define of_node_kobj(n) NULL
120 #endif
121
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)
128 {
129         return node;
130 }
131 static inline void of_node_put(struct device_node *node) { }
132 #endif /* !CONFIG_OF_DYNAMIC */
133
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;
140
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 */
146
147 #define OF_BAD_ADDR     ((u64)-1)
148
149 #ifdef CONFIG_OF
150 void of_core_init(void);
151
152 static inline bool is_of_node(const struct fwnode_handle *fwnode)
153 {
154         return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &of_fwnode_ops;
155 }
156
157 #define to_of_node(__fwnode)                                            \
158         ({                                                              \
159                 typeof(__fwnode) __to_of_node_fwnode = (__fwnode);      \
160                                                                         \
161                 is_of_node(__to_of_node_fwnode) ?                       \
162                         container_of(__to_of_node_fwnode,               \
163                                      struct device_node, fwnode) :      \
164                         NULL;                                           \
165         })
166
167 #define of_fwnode_handle(node)                                          \
168         ({                                                              \
169                 typeof(node) __of_fwnode_handle_node = (node);          \
170                                                                         \
171                 __of_fwnode_handle_node ?                               \
172                         &__of_fwnode_handle_node->fwnode : NULL;        \
173         })
174
175 static inline bool of_have_populated_dt(void)
176 {
177         return of_root != NULL;
178 }
179
180 static inline bool of_node_is_root(const struct device_node *node)
181 {
182         return node && (node->parent == NULL);
183 }
184
185 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
186 {
187         return test_bit(flag, &n->_flags);
188 }
189
190 static inline int of_node_test_and_set_flag(struct device_node *n,
191                                             unsigned long flag)
192 {
193         return test_and_set_bit(flag, &n->_flags);
194 }
195
196 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
197 {
198         set_bit(flag, &n->_flags);
199 }
200
201 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
202 {
203         clear_bit(flag, &n->_flags);
204 }
205
206 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
207 static inline int of_property_check_flag(struct property *p, unsigned long flag)
208 {
209         return test_bit(flag, &p->_flags);
210 }
211
212 static inline void of_property_set_flag(struct property *p, unsigned long flag)
213 {
214         set_bit(flag, &p->_flags);
215 }
216
217 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
218 {
219         clear_bit(flag, &p->_flags);
220 }
221 #endif
222
223 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
224 extern struct device_node *of_find_all_nodes(struct device_node *prev);
225
226 /*
227  * OF address retrieval & translation
228  */
229
230 /* Helper to read a big number; size is in cells (not bytes) */
231 static inline u64 of_read_number(const __be32 *cell, int size)
232 {
233         u64 r = 0;
234         while (size--)
235                 r = (r << 32) | be32_to_cpu(*(cell++));
236         return r;
237 }
238
239 /* Like of_read_number, but we want an unsigned long result */
240 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
241 {
242         /* toss away upper bits if unsigned long is smaller than u64 */
243         return of_read_number(cell, size);
244 }
245
246 #if defined(CONFIG_SPARC)
247 #include <asm/prom.h>
248 #endif
249
250 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
251 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
252 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
253 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
254 #endif
255
256 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
257 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
258
259 static inline const char *of_node_full_name(const struct device_node *np)
260 {
261         return np ? np->full_name : "<no-node>";
262 }
263
264 #define for_each_of_allnodes_from(from, dn) \
265         for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
266 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
267 extern struct device_node *of_find_node_by_name(struct device_node *from,
268         const char *name);
269 extern struct device_node *of_find_node_by_type(struct device_node *from,
270         const char *type);
271 extern struct device_node *of_find_compatible_node(struct device_node *from,
272         const char *type, const char *compat);
273 extern struct device_node *of_find_matching_node_and_match(
274         struct device_node *from,
275         const struct of_device_id *matches,
276         const struct of_device_id **match);
277
278 extern struct device_node *of_find_node_opts_by_path(const char *path,
279         const char **opts);
280 static inline struct device_node *of_find_node_by_path(const char *path)
281 {
282         return of_find_node_opts_by_path(path, NULL);
283 }
284
285 extern struct device_node *of_find_node_by_phandle(phandle handle);
286 extern struct device_node *of_get_parent(const struct device_node *node);
287 extern struct device_node *of_get_next_parent(struct device_node *node);
288 extern struct device_node *of_get_next_child(const struct device_node *node,
289                                              struct device_node *prev);
290 extern struct device_node *of_get_next_available_child(
291         const struct device_node *node, struct device_node *prev);
292
293 extern struct device_node *of_get_child_by_name(const struct device_node *node,
294                                         const char *name);
295
296 /* cache lookup */
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);
301
302 extern struct property *of_find_property(const struct device_node *np,
303                                          const char *name,
304                                          int *lenp);
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,
321                                         u32 *out_values,
322                                         size_t sz_min,
323                                         size_t sz_max);
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,
328                                         u64 *out_values,
329                                         size_t sz_min,
330                                         size_t sz_max);
331
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,
337                                     const char *string);
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,
342                                    const char *);
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,
348                                 const char *name,
349                                 int *lenp);
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)
353
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,
362                                             int index);
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);
371
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,
377                                     int cell_count);
378
379 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
380 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
381                                     uint32_t *args,
382                                     int size);
383
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);
387
388 extern int of_machine_is_compatible(const char *compat);
389
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);
393
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
400
401 extern int of_attach_node(struct device_node *);
402 extern int of_detach_node(struct device_node *);
403
404 #define of_match_ptr(_ptr)      (_ptr)
405
406 /**
407  * of_property_read_u8_array - Find and read an array of u8 from a property.
408  *
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
413  *
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.
418  *
419  * dts entry of array should be like:
420  *      property = /bits/ 8 <0x50 0x60 0x70>;
421  *
422  * The out_values is modified only if a valid u8 value can be decoded.
423  */
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)
427 {
428         int ret = of_property_read_variable_u8_array(np, propname, out_values,
429                                                      sz, 0);
430         if (ret >= 0)
431                 return 0;
432         else
433                 return ret;
434 }
435
436 /**
437  * of_property_read_u16_array - Find and read an array of u16 from a property.
438  *
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
443  *
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.
448  *
449  * dts entry of array should be like:
450  *      property = /bits/ 16 <0x5000 0x6000 0x7000>;
451  *
452  * The out_values is modified only if a valid u16 value can be decoded.
453  */
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)
457 {
458         int ret = of_property_read_variable_u16_array(np, propname, out_values,
459                                                       sz, 0);
460         if (ret >= 0)
461                 return 0;
462         else
463                 return ret;
464 }
465
466 /**
467  * of_property_read_u32_array - Find and read an array of 32 bit integers
468  * from a property.
469  *
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
474  *
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.
479  *
480  * The out_values is modified only if a valid u32 value can be decoded.
481  */
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)
485 {
486         int ret = of_property_read_variable_u32_array(np, propname, out_values,
487                                                       sz, 0);
488         if (ret >= 0)
489                 return 0;
490         else
491                 return ret;
492 }
493
494 /**
495  * of_property_read_u64_array - Find and read an array of 64 bit integers
496  * from a property.
497  *
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
502  *
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.
507  *
508  * The out_values is modified only if a valid u64 value can be decoded.
509  */
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)
513 {
514         int ret = of_property_read_variable_u64_array(np, propname, out_values,
515                                                       sz, 0);
516         if (ret >= 0)
517                 return 0;
518         else
519                 return ret;
520 }
521
522 /*
523  * struct property *prop;
524  * const __be32 *p;
525  * u32 u;
526  *
527  * of_property_for_each_u32(np, "propname", prop, p, u)
528  *         printk("U32 value: %x\n", u);
529  */
530 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
531                                u32 *pu);
532 /*
533  * struct property *prop;
534  * const char *s;
535  *
536  * of_property_for_each_string(np, "propname", prop, s)
537  *         printk("String value: %s\n", s);
538  */
539 const char *of_prop_next_string(struct property *prop, const char *cur);
540
541 bool of_console_check(struct device_node *dn, char *name, int index);
542
543 extern int of_cpu_node_to_id(struct device_node *np);
544
545 #else /* CONFIG_OF */
546
547 static inline void of_core_init(void)
548 {
549 }
550
551 static inline bool is_of_node(const struct fwnode_handle *fwnode)
552 {
553         return false;
554 }
555
556 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode)
557 {
558         return NULL;
559 }
560
561 static inline const char* of_node_full_name(const struct device_node *np)
562 {
563         return "<no-node>";
564 }
565
566 static inline struct device_node *of_find_node_by_name(struct device_node *from,
567         const char *name)
568 {
569         return NULL;
570 }
571
572 static inline struct device_node *of_find_node_by_type(struct device_node *from,
573         const char *type)
574 {
575         return NULL;
576 }
577
578 static inline struct device_node *of_find_matching_node_and_match(
579         struct device_node *from,
580         const struct of_device_id *matches,
581         const struct of_device_id **match)
582 {
583         return NULL;
584 }
585
586 static inline struct device_node *of_find_node_by_path(const char *path)
587 {
588         return NULL;
589 }
590
591 static inline struct device_node *of_find_node_opts_by_path(const char *path,
592         const char **opts)
593 {
594         return NULL;
595 }
596
597 static inline struct device_node *of_find_node_by_phandle(phandle handle)
598 {
599         return NULL;
600 }
601
602 static inline struct device_node *of_get_parent(const struct device_node *node)
603 {
604         return NULL;
605 }
606
607 static inline struct device_node *of_get_next_child(
608         const struct device_node *node, struct device_node *prev)
609 {
610         return NULL;
611 }
612
613 static inline struct device_node *of_get_next_available_child(
614         const struct device_node *node, struct device_node *prev)
615 {
616         return NULL;
617 }
618
619 static inline struct device_node *of_find_node_with_property(
620         struct device_node *from, const char *prop_name)
621 {
622         return NULL;
623 }
624
625 #define of_fwnode_handle(node) NULL
626
627 static inline bool of_have_populated_dt(void)
628 {
629         return false;
630 }
631
632 static inline struct device_node *of_get_child_by_name(
633                                         const struct device_node *node,
634                                         const char *name)
635 {
636         return NULL;
637 }
638
639 static inline int of_device_is_compatible(const struct device_node *device,
640                                           const char *name)
641 {
642         return 0;
643 }
644
645 static inline  int of_device_compatible_match(struct device_node *device,
646                                               const char *const *compat)
647 {
648         return 0;
649 }
650
651 static inline bool of_device_is_available(const struct device_node *device)
652 {
653         return false;
654 }
655
656 static inline bool of_device_is_big_endian(const struct device_node *device)
657 {
658         return false;
659 }
660
661 static inline struct property *of_find_property(const struct device_node *np,
662                                                 const char *name,
663                                                 int *lenp)
664 {
665         return NULL;
666 }
667
668 static inline struct device_node *of_find_compatible_node(
669                                                 struct device_node *from,
670                                                 const char *type,
671                                                 const char *compat)
672 {
673         return NULL;
674 }
675
676 static inline int of_property_count_elems_of_size(const struct device_node *np,
677                         const char *propname, int elem_size)
678 {
679         return -ENOSYS;
680 }
681
682 static inline int of_property_read_u8_array(const struct device_node *np,
683                         const char *propname, u8 *out_values, size_t sz)
684 {
685         return -ENOSYS;
686 }
687
688 static inline int of_property_read_u16_array(const struct device_node *np,
689                         const char *propname, u16 *out_values, size_t sz)
690 {
691         return -ENOSYS;
692 }
693
694 static inline int of_property_read_u32_array(const struct device_node *np,
695                                              const char *propname,
696                                              u32 *out_values, size_t sz)
697 {
698         return -ENOSYS;
699 }
700
701 static inline int of_property_read_u64_array(const struct device_node *np,
702                                              const char *propname,
703                                              u64 *out_values, size_t sz)
704 {
705         return -ENOSYS;
706 }
707
708 static inline int of_property_read_u32_index(const struct device_node *np,
709                         const char *propname, u32 index, u32 *out_value)
710 {
711         return -ENOSYS;
712 }
713
714 static inline int of_property_read_u64_index(const struct device_node *np,
715                         const char *propname, u32 index, u64 *out_value)
716 {
717         return -ENOSYS;
718 }
719
720 static inline const void *of_get_property(const struct device_node *node,
721                                 const char *name,
722                                 int *lenp)
723 {
724         return NULL;
725 }
726
727 static inline struct device_node *of_get_cpu_node(int cpu,
728                                         unsigned int *thread)
729 {
730         return NULL;
731 }
732
733 static inline int of_n_addr_cells(struct device_node *np)
734 {
735         return 0;
736
737 }
738 static inline int of_n_size_cells(struct device_node *np)
739 {
740         return 0;
741 }
742
743 static inline int of_property_read_variable_u8_array(const struct device_node *np,
744                                         const char *propname, u8 *out_values,
745                                         size_t sz_min, size_t sz_max)
746 {
747         return -ENOSYS;
748 }
749
750 static inline int of_property_read_variable_u16_array(const struct device_node *np,
751                                         const char *propname, u16 *out_values,
752                                         size_t sz_min, size_t sz_max)
753 {
754         return -ENOSYS;
755 }
756
757 static inline int of_property_read_variable_u32_array(const struct device_node *np,
758                                         const char *propname,
759                                         u32 *out_values,
760                                         size_t sz_min,
761                                         size_t sz_max)
762 {
763         return -ENOSYS;
764 }
765
766 static inline int of_property_read_u64(const struct device_node *np,
767                                        const char *propname, u64 *out_value)
768 {
769         return -ENOSYS;
770 }
771
772 static inline int of_property_read_variable_u64_array(const struct device_node *np,
773                                         const char *propname,
774                                         u64 *out_values,
775                                         size_t sz_min,
776                                         size_t sz_max)
777 {
778         return -ENOSYS;
779 }
780
781 static inline int of_property_read_string(const struct device_node *np,
782                                           const char *propname,
783                                           const char **out_string)
784 {
785         return -ENOSYS;
786 }
787
788 static inline int of_property_match_string(const struct device_node *np,
789                                            const char *propname,
790                                            const char *string)
791 {
792         return -ENOSYS;
793 }
794
795 static inline int of_property_read_string_helper(const struct device_node *np,
796                                                  const char *propname,
797                                                  const char **out_strs, size_t sz, int index)
798 {
799         return -ENOSYS;
800 }
801
802 static inline struct device_node *of_parse_phandle(const struct device_node *np,
803                                                    const char *phandle_name,
804                                                    int index)
805 {
806         return NULL;
807 }
808
809 static inline int of_parse_phandle_with_args(const struct device_node *np,
810                                              const char *list_name,
811                                              const char *cells_name,
812                                              int index,
813                                              struct of_phandle_args *out_args)
814 {
815         return -ENOSYS;
816 }
817
818 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
819         const char *list_name, int cells_count, int index,
820         struct of_phandle_args *out_args)
821 {
822         return -ENOSYS;
823 }
824
825 static inline int of_count_phandle_with_args(struct device_node *np,
826                                              const char *list_name,
827                                              const char *cells_name)
828 {
829         return -ENOSYS;
830 }
831
832 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
833                                            const struct device_node *np,
834                                            const char *list_name,
835                                            const char *cells_name,
836                                            int cell_count)
837 {
838         return -ENOSYS;
839 }
840
841 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
842 {
843         return -ENOSYS;
844 }
845
846 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
847                                            uint32_t *args,
848                                            int size)
849 {
850         return 0;
851 }
852
853 static inline int of_alias_get_id(struct device_node *np, const char *stem)
854 {
855         return -ENOSYS;
856 }
857
858 static inline int of_alias_get_highest_id(const char *stem)
859 {
860         return -ENOSYS;
861 }
862
863 static inline int of_machine_is_compatible(const char *compat)
864 {
865         return 0;
866 }
867
868 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
869 {
870         return false;
871 }
872
873 static inline const __be32 *of_prop_next_u32(struct property *prop,
874                 const __be32 *cur, u32 *pu)
875 {
876         return NULL;
877 }
878
879 static inline const char *of_prop_next_string(struct property *prop,
880                 const char *cur)
881 {
882         return NULL;
883 }
884
885 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
886 {
887         return 0;
888 }
889
890 static inline int of_node_test_and_set_flag(struct device_node *n,
891                                             unsigned long flag)
892 {
893         return 0;
894 }
895
896 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
897 {
898 }
899
900 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
901 {
902 }
903
904 static inline int of_property_check_flag(struct property *p, unsigned long flag)
905 {
906         return 0;
907 }
908
909 static inline void of_property_set_flag(struct property *p, unsigned long flag)
910 {
911 }
912
913 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
914 {
915 }
916
917 static inline int of_cpu_node_to_id(struct device_node *np)
918 {
919         return -ENODEV;
920 }
921
922 #define of_match_ptr(_ptr)      NULL
923 #define of_match_node(_matches, _node)  NULL
924 #endif /* CONFIG_OF */
925
926 /* Default string compare functions, Allow arch asm/prom.h to override */
927 #if !defined(of_compat_cmp)
928 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
929 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
930 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
931 #endif
932
933 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
934 extern int of_node_to_nid(struct device_node *np);
935 #else
936 static inline int of_node_to_nid(struct device_node *device)
937 {
938         return NUMA_NO_NODE;
939 }
940 #endif
941
942 #ifdef CONFIG_OF_NUMA
943 extern int of_numa_init(void);
944 #else
945 static inline int of_numa_init(void)
946 {
947         return -ENOSYS;
948 }
949 #endif
950
951 static inline struct device_node *of_find_matching_node(
952         struct device_node *from,
953         const struct of_device_id *matches)
954 {
955         return of_find_matching_node_and_match(from, matches, NULL);
956 }
957
958 /**
959  * of_property_count_u8_elems - Count the number of u8 elements in a property
960  *
961  * @np:         device node from which the property value is to be read.
962  * @propname:   name of the property to be searched.
963  *
964  * Search for a property in a device node and count the number of u8 elements
965  * in it. Returns number of elements on sucess, -EINVAL if the property does
966  * not exist or its length does not match a multiple of u8 and -ENODATA if the
967  * property does not have a value.
968  */
969 static inline int of_property_count_u8_elems(const struct device_node *np,
970                                 const char *propname)
971 {
972         return of_property_count_elems_of_size(np, propname, sizeof(u8));
973 }
974
975 /**
976  * of_property_count_u16_elems - Count the number of u16 elements in a property
977  *
978  * @np:         device node from which the property value is to be read.
979  * @propname:   name of the property to be searched.
980  *
981  * Search for a property in a device node and count the number of u16 elements
982  * in it. Returns number of elements on sucess, -EINVAL if the property does
983  * not exist or its length does not match a multiple of u16 and -ENODATA if the
984  * property does not have a value.
985  */
986 static inline int of_property_count_u16_elems(const struct device_node *np,
987                                 const char *propname)
988 {
989         return of_property_count_elems_of_size(np, propname, sizeof(u16));
990 }
991
992 /**
993  * of_property_count_u32_elems - Count the number of u32 elements in a property
994  *
995  * @np:         device node from which the property value is to be read.
996  * @propname:   name of the property to be searched.
997  *
998  * Search for a property in a device node and count the number of u32 elements
999  * in it. Returns number of elements on sucess, -EINVAL if the property does
1000  * not exist or its length does not match a multiple of u32 and -ENODATA if the
1001  * property does not have a value.
1002  */
1003 static inline int of_property_count_u32_elems(const struct device_node *np,
1004                                 const char *propname)
1005 {
1006         return of_property_count_elems_of_size(np, propname, sizeof(u32));
1007 }
1008
1009 /**
1010  * of_property_count_u64_elems - Count the number of u64 elements in a property
1011  *
1012  * @np:         device node from which the property value is to be read.
1013  * @propname:   name of the property to be searched.
1014  *
1015  * Search for a property in a device node and count the number of u64 elements
1016  * in it. Returns number of elements on sucess, -EINVAL if the property does
1017  * not exist or its length does not match a multiple of u64 and -ENODATA if the
1018  * property does not have a value.
1019  */
1020 static inline int of_property_count_u64_elems(const struct device_node *np,
1021                                 const char *propname)
1022 {
1023         return of_property_count_elems_of_size(np, propname, sizeof(u64));
1024 }
1025
1026 /**
1027  * of_property_read_string_array() - Read an array of strings from a multiple
1028  * strings property.
1029  * @np:         device node from which the property value is to be read.
1030  * @propname:   name of the property to be searched.
1031  * @out_strs:   output array of string pointers.
1032  * @sz:         number of array elements to read.
1033  *
1034  * Search for a property in a device tree node and retrieve a list of
1035  * terminated string values (pointer to data, not a copy) in that property.
1036  *
1037  * If @out_strs is NULL, the number of strings in the property is returned.
1038  */
1039 static inline int of_property_read_string_array(const struct device_node *np,
1040                                                 const char *propname, const char **out_strs,
1041                                                 size_t sz)
1042 {
1043         return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1044 }
1045
1046 /**
1047  * of_property_count_strings() - Find and return the number of strings from a
1048  * multiple strings property.
1049  * @np:         device node from which the property value is to be read.
1050  * @propname:   name of the property to be searched.
1051  *
1052  * Search for a property in a device tree node and retrieve the number of null
1053  * terminated string contain in it. Returns the number of strings on
1054  * success, -EINVAL if the property does not exist, -ENODATA if property
1055  * does not have a value, and -EILSEQ if the string is not null-terminated
1056  * within the length of the property data.
1057  */
1058 static inline int of_property_count_strings(const struct device_node *np,
1059                                             const char *propname)
1060 {
1061         return of_property_read_string_helper(np, propname, NULL, 0, 0);
1062 }
1063
1064 /**
1065  * of_property_read_string_index() - Find and read a string from a multiple
1066  * strings property.
1067  * @np:         device node from which the property value is to be read.
1068  * @propname:   name of the property to be searched.
1069  * @index:      index of the string in the list of strings
1070  * @out_string: pointer to null terminated return string, modified only if
1071  *              return value is 0.
1072  *
1073  * Search for a property in a device tree node and retrieve a null
1074  * terminated string value (pointer to data, not a copy) in the list of strings
1075  * contained in that property.
1076  * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
1077  * property does not have a value, and -EILSEQ if the string is not
1078  * null-terminated within the length of the property data.
1079  *
1080  * The out_string pointer is modified only if a valid string can be decoded.
1081  */
1082 static inline int of_property_read_string_index(const struct device_node *np,
1083                                                 const char *propname,
1084                                                 int index, const char **output)
1085 {
1086         int rc = of_property_read_string_helper(np, propname, output, 1, index);
1087         return rc < 0 ? rc : 0;
1088 }
1089
1090 /**
1091  * of_property_read_bool - Findfrom a property
1092  * @np:         device node from which the property value is to be read.
1093  * @propname:   name of the property to be searched.
1094  *
1095  * Search for a property in a device node.
1096  * Returns true if the property exists false otherwise.
1097  */
1098 static inline bool of_property_read_bool(const struct device_node *np,
1099                                          const char *propname)
1100 {
1101         struct property *prop = of_find_property(np, propname, NULL);
1102
1103         return prop ? true : false;
1104 }
1105
1106 static inline int of_property_read_u8(const struct device_node *np,
1107                                        const char *propname,
1108                                        u8 *out_value)
1109 {
1110         return of_property_read_u8_array(np, propname, out_value, 1);
1111 }
1112
1113 static inline int of_property_read_u16(const struct device_node *np,
1114                                        const char *propname,
1115                                        u16 *out_value)
1116 {
1117         return of_property_read_u16_array(np, propname, out_value, 1);
1118 }
1119
1120 static inline int of_property_read_u32(const struct device_node *np,
1121                                        const char *propname,
1122                                        u32 *out_value)
1123 {
1124         return of_property_read_u32_array(np, propname, out_value, 1);
1125 }
1126
1127 static inline int of_property_read_s32(const struct device_node *np,
1128                                        const char *propname,
1129                                        s32 *out_value)
1130 {
1131         return of_property_read_u32(np, propname, (u32*) out_value);
1132 }
1133
1134 #define of_for_each_phandle(it, err, np, ln, cn, cc)                    \
1135         for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)),    \
1136              err = of_phandle_iterator_next(it);                        \
1137              err == 0;                                                  \
1138              err = of_phandle_iterator_next(it))
1139
1140 #define of_property_for_each_u32(np, propname, prop, p, u)      \
1141         for (prop = of_find_property(np, propname, NULL),       \
1142                 p = of_prop_next_u32(prop, NULL, &u);           \
1143                 p;                                              \
1144                 p = of_prop_next_u32(prop, p, &u))
1145
1146 #define of_property_for_each_string(np, propname, prop, s)      \
1147         for (prop = of_find_property(np, propname, NULL),       \
1148                 s = of_prop_next_string(prop, NULL);            \
1149                 s;                                              \
1150                 s = of_prop_next_string(prop, s))
1151
1152 #define for_each_node_by_name(dn, name) \
1153         for (dn = of_find_node_by_name(NULL, name); dn; \
1154              dn = of_find_node_by_name(dn, name))
1155 #define for_each_node_by_type(dn, type) \
1156         for (dn = of_find_node_by_type(NULL, type); dn; \
1157              dn = of_find_node_by_type(dn, type))
1158 #define for_each_compatible_node(dn, type, compatible) \
1159         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1160              dn = of_find_compatible_node(dn, type, compatible))
1161 #define for_each_matching_node(dn, matches) \
1162         for (dn = of_find_matching_node(NULL, matches); dn; \
1163              dn = of_find_matching_node(dn, matches))
1164 #define for_each_matching_node_and_match(dn, matches, match) \
1165         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1166              dn; dn = of_find_matching_node_and_match(dn, matches, match))
1167
1168 #define for_each_child_of_node(parent, child) \
1169         for (child = of_get_next_child(parent, NULL); child != NULL; \
1170              child = of_get_next_child(parent, child))
1171 #define for_each_available_child_of_node(parent, child) \
1172         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1173              child = of_get_next_available_child(parent, child))
1174
1175 #define for_each_node_with_property(dn, prop_name) \
1176         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1177              dn = of_find_node_with_property(dn, prop_name))
1178
1179 static inline int of_get_child_count(const struct device_node *np)
1180 {
1181         struct device_node *child;
1182         int num = 0;
1183
1184         for_each_child_of_node(np, child)
1185                 num++;
1186
1187         return num;
1188 }
1189
1190 static inline int of_get_available_child_count(const struct device_node *np)
1191 {
1192         struct device_node *child;
1193         int num = 0;
1194
1195         for_each_available_child_of_node(np, child)
1196                 num++;
1197
1198         return num;
1199 }
1200
1201 #if defined(CONFIG_OF) && !defined(MODULE)
1202 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
1203         static const struct of_device_id __of_table_##name              \
1204                 __used __section(__##table##_of_table)                  \
1205                  = { .compatible = compat,                              \
1206                      .data = (fn == (fn_type)NULL) ? fn : fn  }
1207 #else
1208 #define _OF_DECLARE(table, name, compat, fn, fn_type)                   \
1209         static const struct of_device_id __of_table_##name              \
1210                 __attribute__((unused))                                 \
1211                  = { .compatible = compat,                              \
1212                      .data = (fn == (fn_type)NULL) ? fn : fn }
1213 #endif
1214
1215 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1216 typedef int (*of_init_fn_1_ret)(struct device_node *);
1217 typedef void (*of_init_fn_1)(struct device_node *);
1218
1219 #define OF_DECLARE_1(table, name, compat, fn) \
1220                 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1221 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1222                 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1223 #define OF_DECLARE_2(table, name, compat, fn) \
1224                 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1225
1226 /**
1227  * struct of_changeset_entry    - Holds a changeset entry
1228  *
1229  * @node:       list_head for the log list
1230  * @action:     notifier action
1231  * @np:         pointer to the device node affected
1232  * @prop:       pointer to the property affected
1233  * @old_prop:   hold a pointer to the original property
1234  *
1235  * Every modification of the device tree during a changeset
1236  * is held in a list of of_changeset_entry structures.
1237  * That way we can recover from a partial application, or we can
1238  * revert the changeset
1239  */
1240 struct of_changeset_entry {
1241         struct list_head node;
1242         unsigned long action;
1243         struct device_node *np;
1244         struct property *prop;
1245         struct property *old_prop;
1246 };
1247
1248 /**
1249  * struct of_changeset - changeset tracker structure
1250  *
1251  * @entries:    list_head for the changeset entries
1252  *
1253  * changesets are a convenient way to apply bulk changes to the
1254  * live tree. In case of an error, changes are rolled-back.
1255  * changesets live on after initial application, and if not
1256  * destroyed after use, they can be reverted in one single call.
1257  */
1258 struct of_changeset {
1259         struct list_head entries;
1260 };
1261
1262 enum of_reconfig_change {
1263         OF_RECONFIG_NO_CHANGE = 0,
1264         OF_RECONFIG_CHANGE_ADD,
1265         OF_RECONFIG_CHANGE_REMOVE,
1266 };
1267
1268 #ifdef CONFIG_OF_DYNAMIC
1269 extern int of_reconfig_notifier_register(struct notifier_block *);
1270 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1271 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1272 extern int of_reconfig_get_state_change(unsigned long action,
1273                                         struct of_reconfig_data *arg);
1274
1275 extern void of_changeset_init(struct of_changeset *ocs);
1276 extern void of_changeset_destroy(struct of_changeset *ocs);
1277 extern int of_changeset_apply(struct of_changeset *ocs);
1278 extern int of_changeset_revert(struct of_changeset *ocs);
1279 extern int of_changeset_action(struct of_changeset *ocs,
1280                 unsigned long action, struct device_node *np,
1281                 struct property *prop);
1282
1283 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1284                 struct device_node *np)
1285 {
1286         return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1287 }
1288
1289 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1290                 struct device_node *np)
1291 {
1292         return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1293 }
1294
1295 static inline int of_changeset_add_property(struct of_changeset *ocs,
1296                 struct device_node *np, struct property *prop)
1297 {
1298         return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1299 }
1300
1301 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1302                 struct device_node *np, struct property *prop)
1303 {
1304         return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1305 }
1306
1307 static inline int of_changeset_update_property(struct of_changeset *ocs,
1308                 struct device_node *np, struct property *prop)
1309 {
1310         return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1311 }
1312 #else /* CONFIG_OF_DYNAMIC */
1313 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1314 {
1315         return -EINVAL;
1316 }
1317 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1318 {
1319         return -EINVAL;
1320 }
1321 static inline int of_reconfig_notify(unsigned long action,
1322                                      struct of_reconfig_data *arg)
1323 {
1324         return -EINVAL;
1325 }
1326 static inline int of_reconfig_get_state_change(unsigned long action,
1327                                                 struct of_reconfig_data *arg)
1328 {
1329         return -EINVAL;
1330 }
1331 #endif /* CONFIG_OF_DYNAMIC */
1332
1333 /**
1334  * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1335  * @np: Pointer to the given device_node
1336  *
1337  * return true if present false otherwise
1338  */
1339 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1340 {
1341         return of_property_read_bool(np, "system-power-controller");
1342 }
1343
1344 /**
1345  * Overlay support
1346  */
1347
1348 enum of_overlay_notify_action {
1349         OF_OVERLAY_PRE_APPLY = 0,
1350         OF_OVERLAY_POST_APPLY,
1351         OF_OVERLAY_PRE_REMOVE,
1352         OF_OVERLAY_POST_REMOVE,
1353 };
1354
1355 struct of_overlay_notify_data {
1356         struct device_node *overlay;
1357         struct device_node *target;
1358 };
1359
1360 #ifdef CONFIG_OF_OVERLAY
1361
1362 /* ID based overlays; the API for external users */
1363 int of_overlay_apply(struct device_node *tree, int *ovcs_id);
1364 int of_overlay_remove(int *ovcs_id);
1365 int of_overlay_remove_all(void);
1366
1367 int of_overlay_notifier_register(struct notifier_block *nb);
1368 int of_overlay_notifier_unregister(struct notifier_block *nb);
1369
1370 #else
1371
1372 static inline int of_overlay_apply(struct device_node *tree, int *ovcs_id)
1373 {
1374         return -ENOTSUPP;
1375 }
1376
1377 static inline int of_overlay_remove(int *ovcs_id)
1378 {
1379         return -ENOTSUPP;
1380 }
1381
1382 static inline int of_overlay_remove_all(void)
1383 {
1384         return -ENOTSUPP;
1385 }
1386
1387 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1388 {
1389         return 0;
1390 }
1391
1392 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1393 {
1394         return 0;
1395 }
1396
1397 #endif
1398
1399 #endif /* _LINUX_OF_H */