]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - include/linux/of.h
Merge remote-tracking branches 'regulator/topic/s5m8767', 'regulator/topic/st-pwm...
[karo-tx-linux.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_count_elems_of_size(const struct device_node *np,
202                                 const char *propname, int elem_size);
203 extern int of_property_read_u32_index(const struct device_node *np,
204                                        const char *propname,
205                                        u32 index, u32 *out_value);
206 extern int of_property_read_u8_array(const struct device_node *np,
207                         const char *propname, u8 *out_values, size_t sz);
208 extern int of_property_read_u16_array(const struct device_node *np,
209                         const char *propname, u16 *out_values, size_t sz);
210 extern int of_property_read_u32_array(const struct device_node *np,
211                                       const char *propname,
212                                       u32 *out_values,
213                                       size_t sz);
214 extern int of_property_read_u64(const struct device_node *np,
215                                 const char *propname, u64 *out_value);
216
217 extern int of_property_read_string(struct device_node *np,
218                                    const char *propname,
219                                    const char **out_string);
220 extern int of_property_read_string_index(struct device_node *np,
221                                          const char *propname,
222                                          int index, const char **output);
223 extern int of_property_match_string(struct device_node *np,
224                                     const char *propname,
225                                     const char *string);
226 extern int of_property_count_strings(struct device_node *np,
227                                      const char *propname);
228 extern int of_device_is_compatible(const struct device_node *device,
229                                    const char *);
230 extern int of_device_is_available(const struct device_node *device);
231 extern const void *of_get_property(const struct device_node *node,
232                                 const char *name,
233                                 int *lenp);
234 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
235 #define for_each_property_of_node(dn, pp) \
236         for (pp = dn->properties; pp != NULL; pp = pp->next)
237
238 extern int of_n_addr_cells(struct device_node *np);
239 extern int of_n_size_cells(struct device_node *np);
240 extern const struct of_device_id *of_match_node(
241         const struct of_device_id *matches, const struct device_node *node);
242 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
243 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
244 extern struct device_node *of_parse_phandle(const struct device_node *np,
245                                             const char *phandle_name,
246                                             int index);
247 extern int of_parse_phandle_with_args(const struct device_node *np,
248         const char *list_name, const char *cells_name, int index,
249         struct of_phandle_args *out_args);
250 extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
251         const char *list_name, int cells_count, int index,
252         struct of_phandle_args *out_args);
253 extern int of_count_phandle_with_args(const struct device_node *np,
254         const char *list_name, const char *cells_name);
255
256 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
257 extern int of_alias_get_id(struct device_node *np, const char *stem);
258
259 extern int of_machine_is_compatible(const char *compat);
260
261 extern int of_add_property(struct device_node *np, struct property *prop);
262 extern int of_remove_property(struct device_node *np, struct property *prop);
263 extern int of_update_property(struct device_node *np, struct property *newprop);
264
265 /* For updating the device tree at runtime */
266 #define OF_RECONFIG_ATTACH_NODE         0x0001
267 #define OF_RECONFIG_DETACH_NODE         0x0002
268 #define OF_RECONFIG_ADD_PROPERTY        0x0003
269 #define OF_RECONFIG_REMOVE_PROPERTY     0x0004
270 #define OF_RECONFIG_UPDATE_PROPERTY     0x0005
271
272 struct of_prop_reconfig {
273         struct device_node      *dn;
274         struct property         *prop;
275 };
276
277 extern int of_reconfig_notifier_register(struct notifier_block *);
278 extern int of_reconfig_notifier_unregister(struct notifier_block *);
279 extern int of_reconfig_notify(unsigned long, void *);
280
281 extern int of_attach_node(struct device_node *);
282 extern int of_detach_node(struct device_node *);
283
284 #define of_match_ptr(_ptr)      (_ptr)
285
286 /*
287  * struct property *prop;
288  * const __be32 *p;
289  * u32 u;
290  *
291  * of_property_for_each_u32(np, "propname", prop, p, u)
292  *         printk("U32 value: %x\n", u);
293  */
294 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
295                                u32 *pu);
296 /*
297  * struct property *prop;
298  * const char *s;
299  *
300  * of_property_for_each_string(np, "propname", prop, s)
301  *         printk("String value: %s\n", s);
302  */
303 const char *of_prop_next_string(struct property *prop, const char *cur);
304
305 int of_device_is_stdout_path(struct device_node *dn);
306
307 #else /* CONFIG_OF */
308
309 static inline const char* of_node_full_name(struct device_node *np)
310 {
311         return "<no-node>";
312 }
313
314 static inline struct device_node *of_find_node_by_name(struct device_node *from,
315         const char *name)
316 {
317         return NULL;
318 }
319
320 static inline struct device_node *of_find_node_by_type(struct device_node *from,
321         const char *type)
322 {
323         return NULL;
324 }
325
326 static inline struct device_node *of_find_matching_node_and_match(
327         struct device_node *from,
328         const struct of_device_id *matches,
329         const struct of_device_id **match)
330 {
331         return NULL;
332 }
333
334 static inline struct device_node *of_get_parent(const struct device_node *node)
335 {
336         return NULL;
337 }
338
339 static inline struct device_node *of_get_next_child(
340         const struct device_node *node, struct device_node *prev)
341 {
342         return NULL;
343 }
344
345 static inline struct device_node *of_get_next_available_child(
346         const struct device_node *node, struct device_node *prev)
347 {
348         return NULL;
349 }
350
351 static inline struct device_node *of_find_node_with_property(
352         struct device_node *from, const char *prop_name)
353 {
354         return NULL;
355 }
356
357 static inline bool of_have_populated_dt(void)
358 {
359         return false;
360 }
361
362 static inline struct device_node *of_get_child_by_name(
363                                         const struct device_node *node,
364                                         const char *name)
365 {
366         return NULL;
367 }
368
369 static inline int of_device_is_compatible(const struct device_node *device,
370                                           const char *name)
371 {
372         return 0;
373 }
374
375 static inline int of_device_is_available(const struct device_node *device)
376 {
377         return 0;
378 }
379
380 static inline struct property *of_find_property(const struct device_node *np,
381                                                 const char *name,
382                                                 int *lenp)
383 {
384         return NULL;
385 }
386
387 static inline struct device_node *of_find_compatible_node(
388                                                 struct device_node *from,
389                                                 const char *type,
390                                                 const char *compat)
391 {
392         return NULL;
393 }
394
395 static inline int of_property_count_elems_of_size(const struct device_node *np,
396                         const char *propname, int elem_size)
397 {
398         return -ENOSYS;
399 }
400
401 static inline int of_property_read_u32_index(const struct device_node *np,
402                         const char *propname, u32 index, u32 *out_value)
403 {
404         return -ENOSYS;
405 }
406
407 static inline int of_property_read_u8_array(const struct device_node *np,
408                         const char *propname, u8 *out_values, size_t sz)
409 {
410         return -ENOSYS;
411 }
412
413 static inline int of_property_read_u16_array(const struct device_node *np,
414                         const char *propname, u16 *out_values, size_t sz)
415 {
416         return -ENOSYS;
417 }
418
419 static inline int of_property_read_u32_array(const struct device_node *np,
420                                              const char *propname,
421                                              u32 *out_values, size_t sz)
422 {
423         return -ENOSYS;
424 }
425
426 static inline int of_property_read_string(struct device_node *np,
427                                           const char *propname,
428                                           const char **out_string)
429 {
430         return -ENOSYS;
431 }
432
433 static inline int of_property_read_string_index(struct device_node *np,
434                                                 const char *propname, int index,
435                                                 const char **out_string)
436 {
437         return -ENOSYS;
438 }
439
440 static inline int of_property_count_strings(struct device_node *np,
441                                             const char *propname)
442 {
443         return -ENOSYS;
444 }
445
446 static inline const void *of_get_property(const struct device_node *node,
447                                 const char *name,
448                                 int *lenp)
449 {
450         return NULL;
451 }
452
453 static inline struct device_node *of_get_cpu_node(int cpu,
454                                         unsigned int *thread)
455 {
456         return NULL;
457 }
458
459 static inline int of_property_read_u64(const struct device_node *np,
460                                        const char *propname, u64 *out_value)
461 {
462         return -ENOSYS;
463 }
464
465 static inline int of_property_match_string(struct device_node *np,
466                                            const char *propname,
467                                            const char *string)
468 {
469         return -ENOSYS;
470 }
471
472 static inline struct device_node *of_parse_phandle(const struct device_node *np,
473                                                    const char *phandle_name,
474                                                    int index)
475 {
476         return NULL;
477 }
478
479 static inline int of_parse_phandle_with_args(struct device_node *np,
480                                              const char *list_name,
481                                              const char *cells_name,
482                                              int index,
483                                              struct of_phandle_args *out_args)
484 {
485         return -ENOSYS;
486 }
487
488 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
489         const char *list_name, int cells_count, int index,
490         struct of_phandle_args *out_args)
491 {
492         return -ENOSYS;
493 }
494
495 static inline int of_count_phandle_with_args(struct device_node *np,
496                                              const char *list_name,
497                                              const char *cells_name)
498 {
499         return -ENOSYS;
500 }
501
502 static inline int of_alias_get_id(struct device_node *np, const char *stem)
503 {
504         return -ENOSYS;
505 }
506
507 static inline int of_machine_is_compatible(const char *compat)
508 {
509         return 0;
510 }
511
512 static inline int of_device_is_stdout_path(struct device_node *dn)
513 {
514         return 0;
515 }
516
517 static inline const __be32 *of_prop_next_u32(struct property *prop,
518                 const __be32 *cur, u32 *pu)
519 {
520         return NULL;
521 }
522
523 static inline const char *of_prop_next_string(struct property *prop,
524                 const char *cur)
525 {
526         return NULL;
527 }
528
529 #define of_match_ptr(_ptr)      NULL
530 #define of_match_node(_matches, _node)  NULL
531 #endif /* CONFIG_OF */
532
533 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
534 extern int of_node_to_nid(struct device_node *np);
535 #else
536 static inline int of_node_to_nid(struct device_node *device) { return 0; }
537 #endif
538
539 static inline struct device_node *of_find_matching_node(
540         struct device_node *from,
541         const struct of_device_id *matches)
542 {
543         return of_find_matching_node_and_match(from, matches, NULL);
544 }
545
546 /**
547  * of_property_count_u8_elems - Count the number of u8 elements in a property
548  *
549  * @np:         device node from which the property value is to be read.
550  * @propname:   name of the property to be searched.
551  *
552  * Search for a property in a device node and count the number of u8 elements
553  * in it. Returns number of elements on sucess, -EINVAL if the property does
554  * not exist or its length does not match a multiple of u8 and -ENODATA if the
555  * property does not have a value.
556  */
557 static inline int of_property_count_u8_elems(const struct device_node *np,
558                                 const char *propname)
559 {
560         return of_property_count_elems_of_size(np, propname, sizeof(u8));
561 }
562
563 /**
564  * of_property_count_u16_elems - Count the number of u16 elements in a property
565  *
566  * @np:         device node from which the property value is to be read.
567  * @propname:   name of the property to be searched.
568  *
569  * Search for a property in a device node and count the number of u16 elements
570  * in it. Returns number of elements on sucess, -EINVAL if the property does
571  * not exist or its length does not match a multiple of u16 and -ENODATA if the
572  * property does not have a value.
573  */
574 static inline int of_property_count_u16_elems(const struct device_node *np,
575                                 const char *propname)
576 {
577         return of_property_count_elems_of_size(np, propname, sizeof(u16));
578 }
579
580 /**
581  * of_property_count_u32_elems - Count the number of u32 elements in a property
582  *
583  * @np:         device node from which the property value is to be read.
584  * @propname:   name of the property to be searched.
585  *
586  * Search for a property in a device node and count the number of u32 elements
587  * in it. Returns number of elements on sucess, -EINVAL if the property does
588  * not exist or its length does not match a multiple of u32 and -ENODATA if the
589  * property does not have a value.
590  */
591 static inline int of_property_count_u32_elems(const struct device_node *np,
592                                 const char *propname)
593 {
594         return of_property_count_elems_of_size(np, propname, sizeof(u32));
595 }
596
597 /**
598  * of_property_count_u64_elems - Count the number of u64 elements in a property
599  *
600  * @np:         device node from which the property value is to be read.
601  * @propname:   name of the property to be searched.
602  *
603  * Search for a property in a device node and count the number of u64 elements
604  * in it. Returns number of elements on sucess, -EINVAL if the property does
605  * not exist or its length does not match a multiple of u64 and -ENODATA if the
606  * property does not have a value.
607  */
608 static inline int of_property_count_u64_elems(const struct device_node *np,
609                                 const char *propname)
610 {
611         return of_property_count_elems_of_size(np, propname, sizeof(u64));
612 }
613
614 /**
615  * of_property_read_bool - Findfrom a property
616  * @np:         device node from which the property value is to be read.
617  * @propname:   name of the property to be searched.
618  *
619  * Search for a property in a device node.
620  * Returns true if the property exist false otherwise.
621  */
622 static inline bool of_property_read_bool(const struct device_node *np,
623                                          const char *propname)
624 {
625         struct property *prop = of_find_property(np, propname, NULL);
626
627         return prop ? true : false;
628 }
629
630 static inline int of_property_read_u8(const struct device_node *np,
631                                        const char *propname,
632                                        u8 *out_value)
633 {
634         return of_property_read_u8_array(np, propname, out_value, 1);
635 }
636
637 static inline int of_property_read_u16(const struct device_node *np,
638                                        const char *propname,
639                                        u16 *out_value)
640 {
641         return of_property_read_u16_array(np, propname, out_value, 1);
642 }
643
644 static inline int of_property_read_u32(const struct device_node *np,
645                                        const char *propname,
646                                        u32 *out_value)
647 {
648         return of_property_read_u32_array(np, propname, out_value, 1);
649 }
650
651 #define of_property_for_each_u32(np, propname, prop, p, u)      \
652         for (prop = of_find_property(np, propname, NULL),       \
653                 p = of_prop_next_u32(prop, NULL, &u);           \
654                 p;                                              \
655                 p = of_prop_next_u32(prop, p, &u))
656
657 #define of_property_for_each_string(np, propname, prop, s)      \
658         for (prop = of_find_property(np, propname, NULL),       \
659                 s = of_prop_next_string(prop, NULL);            \
660                 s;                                              \
661                 s = of_prop_next_string(prop, s))
662
663 #define for_each_node_by_name(dn, name) \
664         for (dn = of_find_node_by_name(NULL, name); dn; \
665              dn = of_find_node_by_name(dn, name))
666 #define for_each_node_by_type(dn, type) \
667         for (dn = of_find_node_by_type(NULL, type); dn; \
668              dn = of_find_node_by_type(dn, type))
669 #define for_each_compatible_node(dn, type, compatible) \
670         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
671              dn = of_find_compatible_node(dn, type, compatible))
672 #define for_each_matching_node(dn, matches) \
673         for (dn = of_find_matching_node(NULL, matches); dn; \
674              dn = of_find_matching_node(dn, matches))
675 #define for_each_matching_node_and_match(dn, matches, match) \
676         for (dn = of_find_matching_node_and_match(NULL, matches, match); \
677              dn; dn = of_find_matching_node_and_match(dn, matches, match))
678
679 #define for_each_child_of_node(parent, child) \
680         for (child = of_get_next_child(parent, NULL); child != NULL; \
681              child = of_get_next_child(parent, child))
682 #define for_each_available_child_of_node(parent, child) \
683         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
684              child = of_get_next_available_child(parent, child))
685
686 #define for_each_node_with_property(dn, prop_name) \
687         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
688              dn = of_find_node_with_property(dn, prop_name))
689
690 static inline int of_get_child_count(const struct device_node *np)
691 {
692         struct device_node *child;
693         int num = 0;
694
695         for_each_child_of_node(np, child)
696                 num++;
697
698         return num;
699 }
700
701 static inline int of_get_available_child_count(const struct device_node *np)
702 {
703         struct device_node *child;
704         int num = 0;
705
706         for_each_available_child_of_node(np, child)
707                 num++;
708
709         return num;
710 }
711
712 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
713 extern void proc_device_tree_add_node(struct device_node *, struct proc_dir_entry *);
714 extern void proc_device_tree_add_prop(struct proc_dir_entry *pde, struct property *prop);
715 extern void proc_device_tree_remove_prop(struct proc_dir_entry *pde,
716                                          struct property *prop);
717 extern void proc_device_tree_update_prop(struct proc_dir_entry *pde,
718                                          struct property *newprop,
719                                          struct property *oldprop);
720 #endif
721
722 #endif /* _LINUX_OF_H */