Linux 3.14.25
[platform/adaptation/renesas_rcar/renesas_kernel.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/kref.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 };
41
42 #if defined(CONFIG_SPARC)
43 struct of_irq_controller;
44 #endif
45
46 struct device_node {
47         const char *name;
48         const char *type;
49         phandle phandle;
50         const char *full_name;
51
52         struct  property *properties;
53         struct  property *deadprops;    /* removed properties */
54         struct  device_node *parent;
55         struct  device_node *child;
56         struct  device_node *sibling;
57         struct  device_node *next;      /* next device of same type */
58         struct  device_node *allnext;   /* next in list of all nodes */
59         struct  proc_dir_entry *pde;    /* this node's proc directory */
60         struct  kref kref;
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 8
71 struct of_phandle_args {
72         struct device_node *np;
73         int args_count;
74         uint32_t args[MAX_PHANDLE_ARGS];
75 };
76
77 #ifdef CONFIG_OF_DYNAMIC
78 extern struct device_node *of_node_get(struct device_node *node);
79 extern void of_node_put(struct device_node *node);
80 #else /* CONFIG_OF_DYNAMIC */
81 /* Dummy ref counting routines - to be implemented later */
82 static inline struct device_node *of_node_get(struct device_node *node)
83 {
84         return node;
85 }
86 static inline void of_node_put(struct device_node *node) { }
87 #endif /* !CONFIG_OF_DYNAMIC */
88
89 #ifdef CONFIG_OF
90
91 /* Pointer for first entry in chain of all nodes. */
92 extern struct device_node *of_allnodes;
93 extern struct device_node *of_chosen;
94 extern struct device_node *of_aliases;
95 extern raw_spinlock_t devtree_lock;
96
97 static inline bool of_have_populated_dt(void)
98 {
99         return of_allnodes != NULL;
100 }
101
102 static inline bool of_node_is_root(const struct device_node *node)
103 {
104         return node && (node->parent == NULL);
105 }
106
107 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
108 {
109         return test_bit(flag, &n->_flags);
110 }
111
112 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
113 {
114         set_bit(flag, &n->_flags);
115 }
116
117 extern struct device_node *of_find_all_nodes(struct device_node *prev);
118
119 /*
120  * OF address retrieval & translation
121  */
122
123 /* Helper to read a big number; size is in cells (not bytes) */
124 static inline u64 of_read_number(const __be32 *cell, int size)
125 {
126         u64 r = 0;
127         while (size--)
128                 r = (r << 32) | be32_to_cpu(*(cell++));
129         return r;
130 }
131
132 /* Like of_read_number, but we want an unsigned long result */
133 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
134 {
135         /* toss away upper bits if unsigned long is smaller than u64 */
136         return of_read_number(cell, size);
137 }
138
139 #if defined(CONFIG_SPARC)
140 #include <asm/prom.h>
141 #endif
142
143 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
144 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
145 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
146 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
147 #endif
148
149 /* Default string compare functions, Allow arch asm/prom.h to override */
150 #if !defined(of_compat_cmp)
151 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
152 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
153 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
154 #endif
155
156 /* flag descriptions */
157 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
158 #define OF_DETACHED     2 /* node has been detached from the device tree */
159
160 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
161 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
162
163 #define OF_BAD_ADDR     ((u64)-1)
164
165 static inline const char *of_node_full_name(const struct device_node *np)
166 {
167         return np ? np->full_name : "<no-node>";
168 }
169
170 extern struct device_node *of_find_node_by_name(struct device_node *from,
171         const char *name);
172 extern struct device_node *of_find_node_by_type(struct device_node *from,
173         const char *type);
174 extern struct device_node *of_find_compatible_node(struct device_node *from,
175         const char *type, const char *compat);
176 extern struct device_node *of_find_matching_node_and_match(
177         struct device_node *from,
178         const struct of_device_id *matches,
179         const struct of_device_id **match);
180
181 extern struct device_node *of_find_node_by_path(const char *path);
182 extern struct device_node *of_find_node_by_phandle(phandle handle);
183 extern struct device_node *of_get_parent(const struct device_node *node);
184 extern struct device_node *of_get_next_parent(struct device_node *node);
185 extern struct device_node *of_get_next_child(const struct device_node *node,
186                                              struct device_node *prev);
187 extern struct device_node *of_get_next_available_child(
188         const struct device_node *node, struct device_node *prev);
189
190 extern struct device_node *of_get_child_by_name(const struct device_node *node,
191                                         const char *name);
192
193 /* cache lookup */
194 extern struct device_node *of_find_next_cache_node(const struct device_node *);
195 extern struct device_node *of_find_node_with_property(
196         struct device_node *from, const char *prop_name);
197
198 extern struct property *of_find_property(const struct device_node *np,
199                                          const char *name,
200                                          int *lenp);
201 extern int of_property_read_u32_index(const struct device_node *np,
202                                        const char *propname,
203                                        u32 index, u32 *out_value);
204 extern int of_property_read_u8_array(const struct device_node *np,
205                         const char *propname, u8 *out_values, size_t sz);
206 extern int of_property_read_u16_array(const struct device_node *np,
207                         const char *propname, u16 *out_values, size_t sz);
208 extern int of_property_read_u32_array(const struct device_node *np,
209                                       const char *propname,
210                                       u32 *out_values,
211                                       size_t sz);
212 extern int of_property_read_u64(const struct device_node *np,
213                                 const char *propname, u64 *out_value);
214
215 extern int of_property_read_string(struct device_node *np,
216                                    const char *propname,
217                                    const char **out_string);
218 extern int of_property_match_string(struct device_node *np,
219                                     const char *propname,
220                                     const char *string);
221 extern int of_property_read_string_helper(struct device_node *np,
222                                               const char *propname,
223                                               const char **out_strs, size_t sz, int index);
224 extern int of_device_is_compatible(const struct device_node *device,
225                                    const char *);
226 extern int of_device_is_available(const struct device_node *device);
227 extern const void *of_get_property(const struct device_node *node,
228                                 const char *name,
229                                 int *lenp);
230 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
231 #define for_each_property_of_node(dn, pp) \
232         for (pp = dn->properties; pp != NULL; pp = pp->next)
233
234 extern int of_n_addr_cells(struct device_node *np);
235 extern int of_n_size_cells(struct device_node *np);
236 extern const struct of_device_id *of_match_node(
237         const struct of_device_id *matches, const struct device_node *node);
238 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
239 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
240 extern struct device_node *of_parse_phandle(const struct device_node *np,
241                                             const char *phandle_name,
242                                             int index);
243 extern int of_parse_phandle_with_args(const struct device_node *np,
244         const char *list_name, const char *cells_name, int index,
245         struct of_phandle_args *out_args);
246 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
247         const char *list_name, int cells_count, int index,
248         struct of_phandle_args *out_args);
249 extern int of_count_phandle_with_args(const struct device_node *np,
250         const char *list_name, const char *cells_name);
251
252 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
253 extern int of_alias_get_id(struct device_node *np, const char *stem);
254
255 extern int of_machine_is_compatible(const char *compat);
256
257 extern int of_add_property(struct device_node *np, struct property *prop);
258 extern int of_remove_property(struct device_node *np, struct property *prop);
259 extern int of_update_property(struct device_node *np, struct property *newprop);
260
261 /* For updating the device tree at runtime */
262 #define OF_RECONFIG_ATTACH_NODE         0x0001
263 #define OF_RECONFIG_DETACH_NODE         0x0002
264 #define OF_RECONFIG_ADD_PROPERTY        0x0003
265 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
266 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
267
268 struct of_prop_reconfig {
269         struct device_node      *dn;
270         struct property         *prop;
271 };
272
273 extern int of_reconfig_notifier_register(struct notifier_block *);
274 extern int of_reconfig_notifier_unregister(struct notifier_block *);
275 extern int of_reconfig_notify(unsigned long, void *);
276
277 extern int of_attach_node(struct device_node *);
278 extern int of_detach_node(struct device_node *);
279
280 #define of_match_ptr(_ptr)      (_ptr)
281
282 /*
283  * struct property *prop;
284  * const __be32 *p;
285  * u32 u;
286  *
287  * of_property_for_each_u32(np, "propname", prop, p, u)
288  *         printk("U32 value: %x\n", u);
289  */
290 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
291                                u32 *pu);
292 /*
293  * struct property *prop;
294  * const char *s;
295  *
296  * of_property_for_each_string(np, "propname", prop, s)
297  *         printk("String value: %s\n", s);
298  */
299 const char *of_prop_next_string(struct property *prop, const char *cur);
300
301 int of_device_is_stdout_path(struct device_node *dn);
302
303 #else /* CONFIG_OF */
304
305 static inline const char* of_node_full_name(struct device_node *np)
306 {
307         return "<no-node>";
308 }
309
310 static inline struct device_node *of_find_node_by_name(struct device_node *from,
311         const char *name)
312 {
313         return NULL;
314 }
315
316 static inline struct device_node *of_find_node_by_type(struct device_node *from,
317         const char *type)
318 {
319         return NULL;
320 }
321
322 static inline struct device_node *of_find_matching_node_and_match(
323         struct device_node *from,
324         const struct of_device_id *matches,
325         const struct of_device_id **match)
326 {
327         return NULL;
328 }
329
330 static inline struct device_node *of_get_parent(const struct device_node *node)
331 {
332         return NULL;
333 }
334
335 static inline struct device_node *of_get_next_child(
336         const struct device_node *node, struct device_node *prev)
337 {
338         return NULL;
339 }
340
341 static inline struct device_node *of_get_next_available_child(
342         const struct device_node *node, struct device_node *prev)
343 {
344         return NULL;
345 }
346
347 static inline struct device_node *of_find_node_with_property(
348         struct device_node *from, const char *prop_name)
349 {
350         return NULL;
351 }
352
353 static inline bool of_have_populated_dt(void)
354 {
355         return false;
356 }
357
358 static inline struct device_node *of_get_child_by_name(
359                                         const struct device_node *node,
360                                         const char *name)
361 {
362         return NULL;
363 }
364
365 static inline int of_device_is_compatible(const struct device_node *device,
366                                           const char *name)
367 {
368         return 0;
369 }
370
371 static inline int of_device_is_available(const struct device_node *device)
372 {
373         return 0;
374 }
375
376 static inline struct property *of_find_property(const struct device_node *np,
377                                                 const char *name,
378                                                 int *lenp)
379 {
380         return NULL;
381 }
382
383 static inline struct device_node *of_find_compatible_node(
384                                                 struct device_node *from,
385                                                 const char *type,
386                                                 const char *compat)
387 {
388         return NULL;
389 }
390
391 static inline int of_property_read_u32_index(const struct device_node *np,
392                         const char *propname, u32 index, u32 *out_value)
393 {
394         return -ENOSYS;
395 }
396
397 static inline int of_property_read_u8_array(const struct device_node *np,
398                         const char *propname, u8 *out_values, size_t sz)
399 {
400         return -ENOSYS;
401 }
402
403 static inline int of_property_read_u16_array(const struct device_node *np,
404                         const char *propname, u16 *out_values, size_t sz)
405 {
406         return -ENOSYS;
407 }
408
409 static inline int of_property_read_u32_array(const struct device_node *np,
410                                              const char *propname,
411                                              u32 *out_values, size_t sz)
412 {
413         return -ENOSYS;
414 }
415
416 static inline int of_property_read_string(struct device_node *np,
417                                           const char *propname,
418                                           const char **out_string)
419 {
420         return -ENOSYS;
421 }
422
423 static inline int of_property_read_string_helper(struct device_node *np,
424                                                  const char *propname,
425                                                  const char **out_strs, size_t sz, int index)
426 {
427         return -ENOSYS;
428 }
429
430 static inline const void *of_get_property(const struct device_node *node,
431                                 const char *name,
432                                 int *lenp)
433 {
434         return NULL;
435 }
436
437 static inline struct device_node *of_get_cpu_node(int cpu,
438                                         unsigned int *thread)
439 {
440         return NULL;
441 }
442
443 static inline int of_property_read_u64(const struct device_node *np,
444                                        const char *propname, u64 *out_value)
445 {
446         return -ENOSYS;
447 }
448
449 static inline int of_property_match_string(struct device_node *np,
450                                            const char *propname,
451                                            const char *string)
452 {
453         return -ENOSYS;
454 }
455
456 static inline struct device_node *of_parse_phandle(const struct device_node *np,
457                                                    const char *phandle_name,
458                                                    int index)
459 {
460         return NULL;
461 }
462
463 static inline int of_parse_phandle_with_args(struct device_node *np,
464                                              const char *list_name,
465                                              const char *cells_name,
466                                              int index,
467                                              struct of_phandle_args *out_args)
468 {
469         return -ENOSYS;
470 }
471
472 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
473         const char *list_name, int cells_count, int index,
474         struct of_phandle_args *out_args)
475 {
476         return -ENOSYS;
477 }
478
479 static inline int of_count_phandle_with_args(struct device_node *np,
480                                              const char *list_name,
481                                              const char *cells_name)
482 {
483         return -ENOSYS;
484 }
485
486 static inline int of_alias_get_id(struct device_node *np, const char *stem)
487 {
488         return -ENOSYS;
489 }
490
491 static inline int of_machine_is_compatible(const char *compat)
492 {
493         return 0;
494 }
495
496 static inline int of_device_is_stdout_path(struct device_node *dn)
497 {
498         return 0;
499 }
500
501 static inline const __be32 *of_prop_next_u32(struct property *prop,
502                 const __be32 *cur, u32 *pu)
503 {
504         return NULL;
505 }
506
507 static inline const char *of_prop_next_string(struct property *prop,
508                 const char *cur)
509 {
510         return NULL;
511 }
512
513 #define of_match_ptr(_ptr)      NULL
514 #define of_match_node(_matches, _node)  NULL
515 #endif /* CONFIG_OF */
516
517 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
518 extern int of_node_to_nid(struct device_node *np);
519 #else
520 static inline int of_node_to_nid(struct device_node *device) { return 0; }
521 #endif
522
523 static inline struct device_node *of_find_matching_node(
524         struct device_node *from,
525         const struct of_device_id *matches)
526 {
527         return of_find_matching_node_and_match(from, matches, NULL);
528 }
529
530 /**
531  * of_property_read_string_array() - Read an array of strings from a multiple
532  * strings property.
533  * @np:         device node from which the property value is to be read.
534  * @propname:   name of the property to be searched.
535  * @out_strs:   output array of string pointers.
536  * @sz:         number of array elements to read.
537  *
538  * Search for a property in a device tree node and retrieve a list of
539  * terminated string values (pointer to data, not a copy) in that property.
540  *
541  * If @out_strs is NULL, the number of strings in the property is returned.
542  */
543 static inline int of_property_read_string_array(struct device_node *np,
544                                                 const char *propname, const char **out_strs,
545                                                 size_t sz)
546 {
547         return of_property_read_string_helper(np, propname, out_strs, sz, 0);
548 }
549
550 /**
551  * of_property_count_strings() - Find and return the number of strings from a
552  * multiple strings property.
553  * @np:         device node from which the property value is to be read.
554  * @propname:   name of the property to be searched.
555  *
556  * Search for a property in a device tree node and retrieve the number of null
557  * terminated string contain in it. Returns the number of strings on
558  * success, -EINVAL if the property does not exist, -ENODATA if property
559  * does not have a value, and -EILSEQ if the string is not null-terminated
560  * within the length of the property data.
561  */
562 static inline int of_property_count_strings(struct device_node *np,
563                                             const char *propname)
564 {
565         return of_property_read_string_helper(np, propname, NULL, 0, 0);
566 }
567
568 /**
569  * of_property_read_string_index() - Find and read a string from a multiple
570  * strings property.
571  * @np:         device node from which the property value is to be read.
572  * @propname:   name of the property to be searched.
573  * @index:      index of the string in the list of strings
574  * @out_string: pointer to null terminated return string, modified only if
575  *              return value is 0.
576  *
577  * Search for a property in a device tree node and retrieve a null
578  * terminated string value (pointer to data, not a copy) in the list of strings
579  * contained in that property.
580  * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
581  * property does not have a value, and -EILSEQ if the string is not
582  * null-terminated within the length of the property data.
583  *
584  * The out_string pointer is modified only if a valid string can be decoded.
585  */
586 static inline int of_property_read_string_index(struct device_node *np,
587                                                 const char *propname,
588                                                 int index, const char **output)
589 {
590         int rc = of_property_read_string_helper(np, propname, output, 1, index);
591         return rc < 0 ? rc : 0;
592 }
593
594 /**
595  * of_property_read_bool - Findfrom a property
596  * @np:         device node from which the property value is to be read.
597  * @propname:   name of the property to be searched.
598  *
599  * Search for a property in a device node.
600  * Returns true if the property exist false otherwise.
601  */
602 static inline bool of_property_read_bool(const struct device_node *np,
603                                          const char *propname)
604 {
605         struct property *prop = of_find_property(np, propname, NULL);
606
607         return prop ? true : false;
608 }
609
610 static inline int of_property_read_u8(const struct device_node *np,
611                                        const char *propname,
612                                        u8 *out_value)
613 {
614         return of_property_read_u8_array(np, propname, out_value, 1);
615 }
616
617 static inline int of_property_read_u16(const struct device_node *np,
618                                        const char *propname,
619                                        u16 *out_value)
620 {
621         return of_property_read_u16_array(np, propname, out_value, 1);
622 }
623
624 static inline int of_property_read_u32(const struct device_node *np,
625                                        const char *propname,
626                                        u32 *out_value)
627 {
628         return of_property_read_u32_array(np, propname, out_value, 1);
629 }
630
631 #define of_property_for_each_u32(np, propname, prop, p, u)      \
632         for (prop = of_find_property(np, propname, NULL),       \
633                 p = of_prop_next_u32(prop, NULL, &u);           \
634                 p;                                              \
635                 p = of_prop_next_u32(prop, p, &u))
636
637 #define of_property_for_each_string(np, propname, prop, s)      \
638         for (prop = of_find_property(np, propname, NULL),       \
639                 s = of_prop_next_string(prop, NULL);            \
640                 s;                                              \
641                 s = of_prop_next_string(prop, s))
642
643 #define for_each_node_by_name(dn, name) \
644         for (dn = of_find_node_by_name(NULL, name); dn; \
645              dn = of_find_node_by_name(dn, name))
646 #define for_each_node_by_type(dn, type) \
647         for (dn = of_find_node_by_type(NULL, type); dn; \
648              dn = of_find_node_by_type(dn, type))
649 #define for_each_compatible_node(dn, type, compatible) \
650         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
651              dn = of_find_compatible_node(dn, type, compatible))
652 #define for_each_matching_node(dn, matches) \
653         for (dn = of_find_matching_node(NULL, matches); dn; \
654              dn = of_find_matching_node(dn, matches))
655 #define for_each_matching_node_and_match(dn, matches, match) \
656         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
657              dn; dn = of_find_matching_node_and_match(dn, matches, match))
658
659 #define for_each_child_of_node(parent, child) \
660         for (child = of_get_next_child(parent, NULL); child != NULL; \
661              child = of_get_next_child(parent, child))
662 #define for_each_available_child_of_node(parent, child) \
663         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
664              child = of_get_next_available_child(parent, child))
665
666 #define for_each_node_with_property(dn, prop_name) \
667         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
668              dn = of_find_node_with_property(dn, prop_name))
669
670 static inline int of_get_child_count(const struct device_node *np)
671 {
672         struct device_node *child;
673         int num = 0;
674
675         for_each_child_of_node(np, child)
676                 num++;
677
678         return num;
679 }
680
681 static inline int of_get_available_child_count(const struct device_node *np)
682 {
683         struct device_node *child;
684         int num = 0;
685
686         for_each_available_child_of_node(np, child)
687                 num++;
688
689         return num;
690 }
691
692 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
693 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
694 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
695 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
696                                          struct property *prop);
697 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
698                                          struct property *newprop,
699                                          struct property *oldprop);
700 #endif
701
702 #endif /* _LINUX_OF_H */