]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - include/linux/of.h
dt: add helper function to read u8 & u16 variables & arrays
[~shefty/rdma-dev.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
26 #include <asm/byteorder.h>
27 #include <asm/errno.h>
28
29 typedef u32 phandle;
30 typedef u32 ihandle;
31
32 struct property {
33         char    *name;
34         int     length;
35         void    *value;
36         struct property *next;
37         unsigned long _flags;
38         unsigned int unique_id;
39 };
40
41 #if defined(CONFIG_SPARC)
42 struct of_irq_controller;
43 #endif
44
45 struct device_node {
46         const char *name;
47         const char *type;
48         phandle phandle;
49         const char *full_name;
50
51         struct  property *properties;
52         struct  property *deadprops;    /* removed properties */
53         struct  device_node *parent;
54         struct  device_node *child;
55         struct  device_node *sibling;
56         struct  device_node *next;      /* next device of same type */
57         struct  device_node *allnext;   /* next in list of all nodes */
58         struct  proc_dir_entry *pde;    /* this node's proc directory */
59         struct  kref kref;
60         unsigned long _flags;
61         void    *data;
62 #if defined(CONFIG_SPARC)
63         const char *path_component_name;
64         unsigned int unique_id;
65         struct of_irq_controller *irq_trans;
66 #endif
67 };
68
69 #define MAX_PHANDLE_ARGS 8
70 struct of_phandle_args {
71         struct device_node *np;
72         int args_count;
73         uint32_t args[MAX_PHANDLE_ARGS];
74 };
75
76 #ifdef CONFIG_OF_DYNAMIC
77 extern struct device_node *of_node_get(struct device_node *node);
78 extern void of_node_put(struct device_node *node);
79 #else /* CONFIG_OF_DYNAMIC */
80 /* Dummy ref counting routines - to be implemented later */
81 static inline struct device_node *of_node_get(struct device_node *node)
82 {
83         return node;
84 }
85 static inline void of_node_put(struct device_node *node) { }
86 #endif /* !CONFIG_OF_DYNAMIC */
87
88 #ifdef CONFIG_OF
89
90 /* Pointer for first entry in chain of all nodes. */
91 extern struct device_node *allnodes;
92 extern struct device_node *of_chosen;
93 extern struct device_node *of_aliases;
94 extern rwlock_t devtree_lock;
95
96 static inline bool of_have_populated_dt(void)
97 {
98         return allnodes != NULL;
99 }
100
101 static inline bool of_node_is_root(const struct device_node *node)
102 {
103         return node && (node->parent == NULL);
104 }
105
106 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
107 {
108         return test_bit(flag, &n->_flags);
109 }
110
111 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
112 {
113         set_bit(flag, &n->_flags);
114 }
115
116 extern struct device_node *of_find_all_nodes(struct device_node *prev);
117
118 /*
119  * OF address retrieval & translation
120  */
121
122 /* Helper to read a big number; size is in cells (not bytes) */
123 static inline u64 of_read_number(const __be32 *cell, int size)
124 {
125         u64 r = 0;
126         while (size--)
127                 r = (r << 32) | be32_to_cpu(*(cell++));
128         return r;
129 }
130
131 /* Like of_read_number, but we want an unsigned long result */
132 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
133 {
134         /* toss away upper bits if unsigned long is smaller than u64 */
135         return of_read_number(cell, size);
136 }
137
138 #include <asm/prom.h>
139
140 /* Default #address and #size cells.  Allow arch asm/prom.h to override */
141 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
142 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
143 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
144 #endif
145
146 /* Default string compare functions, Allow arch asm/prom.h to override */
147 #if !defined(of_compat_cmp)
148 #define of_compat_cmp(s1, s2, l)        strcasecmp((s1), (s2))
149 #define of_prop_cmp(s1, s2)             strcmp((s1), (s2))
150 #define of_node_cmp(s1, s2)             strcasecmp((s1), (s2))
151 #endif
152
153 /* flag descriptions */
154 #define OF_DYNAMIC      1 /* node and properties were allocated via kmalloc */
155 #define OF_DETACHED     2 /* node has been detached from the device tree */
156
157 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
158 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
159
160 #define OF_BAD_ADDR     ((u64)-1)
161
162 static inline const char* of_node_full_name(struct device_node *np)
163 {
164         return np ? np->full_name : "<no-node>";
165 }
166
167 extern struct device_node *of_find_node_by_name(struct device_node *from,
168         const char *name);
169 #define for_each_node_by_name(dn, name) \
170         for (dn = of_find_node_by_name(NULL, name); dn; \
171              dn = of_find_node_by_name(dn, name))
172 extern struct device_node *of_find_node_by_type(struct device_node *from,
173         const char *type);
174 #define for_each_node_by_type(dn, type) \
175         for (dn = of_find_node_by_type(NULL, type); dn; \
176              dn = of_find_node_by_type(dn, type))
177 extern struct device_node *of_find_compatible_node(struct device_node *from,
178         const char *type, const char *compat);
179 #define for_each_compatible_node(dn, type, compatible) \
180         for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
181              dn = of_find_compatible_node(dn, type, compatible))
182 extern struct device_node *of_find_matching_node(struct device_node *from,
183         const struct of_device_id *matches);
184 #define for_each_matching_node(dn, matches) \
185         for (dn = of_find_matching_node(NULL, matches); dn; \
186              dn = of_find_matching_node(dn, matches))
187 extern struct device_node *of_find_node_by_path(const char *path);
188 extern struct device_node *of_find_node_by_phandle(phandle handle);
189 extern struct device_node *of_get_parent(const struct device_node *node);
190 extern struct device_node *of_get_next_parent(struct device_node *node);
191 extern struct device_node *of_get_next_child(const struct device_node *node,
192                                              struct device_node *prev);
193 extern struct device_node *of_get_next_available_child(
194         const struct device_node *node, struct device_node *prev);
195
196 extern struct device_node *of_get_child_by_name(const struct device_node *node,
197                                         const char *name);
198 #define for_each_child_of_node(parent, child) \
199         for (child = of_get_next_child(parent, NULL); child != NULL; \
200              child = of_get_next_child(parent, child))
201
202 #define for_each_available_child_of_node(parent, child) \
203         for (child = of_get_next_available_child(parent, NULL); child != NULL; \
204              child = of_get_next_available_child(parent, child))
205
206 static inline int of_get_child_count(const struct device_node *np)
207 {
208         struct device_node *child;
209         int num = 0;
210
211         for_each_child_of_node(np, child)
212                 num++;
213
214         return num;
215 }
216
217 extern struct device_node *of_find_node_with_property(
218         struct device_node *from, const char *prop_name);
219 #define for_each_node_with_property(dn, prop_name) \
220         for (dn = of_find_node_with_property(NULL, prop_name); dn; \
221              dn = of_find_node_with_property(dn, prop_name))
222
223 extern struct property *of_find_property(const struct device_node *np,
224                                          const char *name,
225                                          int *lenp);
226 extern int of_property_read_u8_array(const struct device_node *np,
227                         const char *propname, u8 *out_values, size_t sz);
228 extern int of_property_read_u16_array(const struct device_node *np,
229                         const char *propname, u16 *out_values, size_t sz);
230 extern int of_property_read_u32_array(const struct device_node *np,
231                                       const char *propname,
232                                       u32 *out_values,
233                                       size_t sz);
234 extern int of_property_read_u64(const struct device_node *np,
235                                 const char *propname, u64 *out_value);
236
237 extern int of_property_read_string(struct device_node *np,
238                                    const char *propname,
239                                    const char **out_string);
240 extern int of_property_read_string_index(struct device_node *np,
241                                          const char *propname,
242                                          int index, const char **output);
243 extern int of_property_match_string(struct device_node *np,
244                                     const char *propname,
245                                     const char *string);
246 extern int of_property_count_strings(struct device_node *np,
247                                      const char *propname);
248 extern int of_device_is_compatible(const struct device_node *device,
249                                    const char *);
250 extern int of_device_is_available(const struct device_node *device);
251 extern const void *of_get_property(const struct device_node *node,
252                                 const char *name,
253                                 int *lenp);
254 #define for_each_property_of_node(dn, pp) \
255         for (pp = dn->properties; pp != NULL; pp = pp->next)
256
257 extern int of_n_addr_cells(struct device_node *np);
258 extern int of_n_size_cells(struct device_node *np);
259 extern const struct of_device_id *of_match_node(
260         const struct of_device_id *matches, const struct device_node *node);
261 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
262 extern struct device_node *of_parse_phandle(struct device_node *np,
263                                             const char *phandle_name,
264                                             int index);
265 extern int of_parse_phandle_with_args(struct device_node *np,
266         const char *list_name, const char *cells_name, int index,
267         struct of_phandle_args *out_args);
268
269 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
270 extern int of_alias_get_id(struct device_node *np, const char *stem);
271
272 extern int of_machine_is_compatible(const char *compat);
273
274 extern int prom_add_property(struct device_node* np, struct property* prop);
275 extern int prom_remove_property(struct device_node *np, struct property *prop);
276 extern int prom_update_property(struct device_node *np,
277                                 struct property *newprop);
278
279 #if defined(CONFIG_OF_DYNAMIC)
280 /* For updating the device tree at runtime */
281 extern void of_attach_node(struct device_node *);
282 extern void of_detach_node(struct device_node *);
283 #endif
284
285 #define of_match_ptr(_ptr)      (_ptr)
286
287 /*
288  * struct property *prop;
289  * const __be32 *p;
290  * u32 u;
291  *
292  * of_property_for_each_u32(np, "propname", prop, p, u)
293  *         printk("U32 value: %x\n", u);
294  */
295 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
296                                u32 *pu);
297 #define of_property_for_each_u32(np, propname, prop, p, u)      \
298         for (prop = of_find_property(np, propname, NULL),       \
299                 p = of_prop_next_u32(prop, NULL, &u);           \
300                 p;                                              \
301                 p = of_prop_next_u32(prop, p, &u))
302
303 /*
304  * struct property *prop;
305  * const char *s;
306  *
307  * of_property_for_each_string(np, "propname", prop, s)
308  *         printk("String value: %s\n", s);
309  */
310 const char *of_prop_next_string(struct property *prop, const char *cur);
311 #define of_property_for_each_string(np, propname, prop, s)      \
312         for (prop = of_find_property(np, propname, NULL),       \
313                 s = of_prop_next_string(prop, NULL);            \
314                 s;                                              \
315                 s = of_prop_next_string(prop, s))
316
317 #else /* CONFIG_OF */
318
319 static inline const char* of_node_full_name(struct device_node *np)
320 {
321         return "<no-node>";
322 }
323
324 static inline struct device_node *of_find_node_by_name(struct device_node *from,
325         const char *name)
326 {
327         return NULL;
328 }
329
330 static inline bool of_have_populated_dt(void)
331 {
332         return false;
333 }
334
335 #define for_each_child_of_node(parent, child) \
336         while (0)
337
338 static inline struct device_node *of_get_child_by_name(
339                                         const struct device_node *node,
340                                         const char *name)
341 {
342         return NULL;
343 }
344
345 static inline int of_get_child_count(const struct device_node *np)
346 {
347         return 0;
348 }
349
350 static inline int of_device_is_compatible(const struct device_node *device,
351                                           const char *name)
352 {
353         return 0;
354 }
355
356 static inline struct property *of_find_property(const struct device_node *np,
357                                                 const char *name,
358                                                 int *lenp)
359 {
360         return NULL;
361 }
362
363 static inline struct device_node *of_find_compatible_node(
364                                                 struct device_node *from,
365                                                 const char *type,
366                                                 const char *compat)
367 {
368         return NULL;
369 }
370
371 static inline int of_property_read_u8_array(const struct device_node *np,
372                         const char *propname, u8 *out_values, size_t sz)
373 {
374         return -ENOSYS;
375 }
376
377 static inline int of_property_read_u16_array(const struct device_node *np,
378                         const char *propname, u16 *out_values, size_t sz)
379 {
380         return -ENOSYS;
381 }
382
383 static inline int of_property_read_u32_array(const struct device_node *np,
384                                              const char *propname,
385                                              u32 *out_values, size_t sz)
386 {
387         return -ENOSYS;
388 }
389
390 static inline int of_property_read_string(struct device_node *np,
391                                           const char *propname,
392                                           const char **out_string)
393 {
394         return -ENOSYS;
395 }
396
397 static inline int of_property_read_string_index(struct device_node *np,
398                                                 const char *propname, int index,
399                                                 const char **out_string)
400 {
401         return -ENOSYS;
402 }
403
404 static inline int of_property_count_strings(struct device_node *np,
405                                             const char *propname)
406 {
407         return -ENOSYS;
408 }
409
410 static inline const void *of_get_property(const struct device_node *node,
411                                 const char *name,
412                                 int *lenp)
413 {
414         return NULL;
415 }
416
417 static inline int of_property_read_u64(const struct device_node *np,
418                                        const char *propname, u64 *out_value)
419 {
420         return -ENOSYS;
421 }
422
423 static inline int of_property_match_string(struct device_node *np,
424                                            const char *propname,
425                                            const char *string)
426 {
427         return -ENOSYS;
428 }
429
430 static inline struct device_node *of_parse_phandle(struct device_node *np,
431                                                    const char *phandle_name,
432                                                    int index)
433 {
434         return NULL;
435 }
436
437 static inline int of_parse_phandle_with_args(struct device_node *np,
438                                              const char *list_name,
439                                              const char *cells_name,
440                                              int index,
441                                              struct of_phandle_args *out_args)
442 {
443         return -ENOSYS;
444 }
445
446 static inline int of_alias_get_id(struct device_node *np, const char *stem)
447 {
448         return -ENOSYS;
449 }
450
451 static inline int of_machine_is_compatible(const char *compat)
452 {
453         return 0;
454 }
455
456 #define of_match_ptr(_ptr)      NULL
457 #define of_match_node(_matches, _node)  NULL
458 #define of_property_for_each_u32(np, propname, prop, p, u) \
459         while (0)
460 #define of_property_for_each_string(np, propname, prop, s) \
461         while (0)
462 #endif /* CONFIG_OF */
463
464 #ifndef of_node_to_nid
465 static inline int of_node_to_nid(struct device_node *np)
466 {
467         return numa_node_id();
468 }
469
470 #define of_node_to_nid of_node_to_nid
471 #endif
472
473 /**
474  * of_property_read_bool - Findfrom a property
475  * @np:         device node from which the property value is to be read.
476  * @propname:   name of the property to be searched.
477  *
478  * Search for a property in a device node.
479  * Returns true if the property exist false otherwise.
480  */
481 static inline bool of_property_read_bool(const struct device_node *np,
482                                          const char *propname)
483 {
484         struct property *prop = of_find_property(np, propname, NULL);
485
486         return prop ? true : false;
487 }
488
489 static inline int of_property_read_u8(const struct device_node *np,
490                                        const char *propname,
491                                        u8 *out_value)
492 {
493         return of_property_read_u8_array(np, propname, out_value, 1);
494 }
495
496 static inline int of_property_read_u16(const struct device_node *np,
497                                        const char *propname,
498                                        u16 *out_value)
499 {
500         return of_property_read_u16_array(np, propname, out_value, 1);
501 }
502
503 static inline int of_property_read_u32(const struct device_node *np,
504                                        const char *propname,
505                                        u32 *out_value)
506 {
507         return of_property_read_u32_array(np, propname, out_value, 1);
508 }
509
510 #endif /* _LINUX_OF_H */