proc: Move PDE_NET() to fs/proc/proc_net.c
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / of.h
CommitLineData
76c1ce78
SR
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>
1977f032 19#include <linux/bitops.h>
e51130c0 20#include <linux/errno.h>
6f192492 21#include <linux/kref.h>
283029d1 22#include <linux/mod_devicetable.h>
0d351c3e 23#include <linux/spinlock.h>
5ca4db61 24#include <linux/topology.h>
1cf3d8b3 25#include <linux/notifier.h>
76c1ce78 26
2e89e685 27#include <asm/byteorder.h>
d0a99402 28#include <asm/errno.h>
2e89e685 29
731581e6
GL
30typedef u32 phandle;
31typedef u32 ihandle;
32
33struct 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
6f192492
GL
42#if defined(CONFIG_SPARC)
43struct of_irq_controller;
44#endif
45
46struct device_node {
47 const char *name;
48 const char *type;
6016a363 49 phandle phandle;
c22618a1 50 const char *full_name;
6f192492
GL
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)
c22618a1 64 const char *path_component_name;
6f192492
GL
65 unsigned int unique_id;
66 struct of_irq_controller *irq_trans;
67#endif
68};
69
15c9a0ac
GL
70#define MAX_PHANDLE_ARGS 8
71struct of_phandle_args {
72 struct device_node *np;
73 int args_count;
74 uint32_t args[MAX_PHANDLE_ARGS];
75};
76
0f22dd39
GL
77#ifdef CONFIG_OF_DYNAMIC
78extern struct device_node *of_node_get(struct device_node *node);
79extern void of_node_put(struct device_node *node);
80#else /* CONFIG_OF_DYNAMIC */
3ecdd051
RH
81/* Dummy ref counting routines - to be implemented later */
82static inline struct device_node *of_node_get(struct device_node *node)
83{
84 return node;
85}
0f22dd39
GL
86static inline void of_node_put(struct device_node *node) { }
87#endif /* !CONFIG_OF_DYNAMIC */
3ecdd051 88
c9e358df
GL
89#ifdef CONFIG_OF
90
41f88009 91/* Pointer for first entry in chain of all nodes. */
465aac6d 92extern struct device_node *of_allnodes;
fc0bdae4 93extern struct device_node *of_chosen;
611cad72 94extern struct device_node *of_aliases;
d6d3c4e6 95extern raw_spinlock_t devtree_lock;
41f88009 96
3bcbaf6e
SAS
97static inline bool of_have_populated_dt(void)
98{
465aac6d 99 return of_allnodes != NULL;
3bcbaf6e
SAS
100}
101
035ebefc
AS
102static inline bool of_node_is_root(const struct device_node *node)
103{
104 return node && (node->parent == NULL);
105}
106
50436312
GL
107static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
108{
109 return test_bit(flag, &n->_flags);
110}
111
112static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
113{
114 set_bit(flag, &n->_flags);
115}
116
e91edcf5
GL
117extern struct device_node *of_find_all_nodes(struct device_node *prev);
118
b6caf2ad 119/*
3d6b8828 120 * OF address retrieval & translation
b6caf2ad
GL
121 */
122
123/* Helper to read a big number; size is in cells (not bytes) */
2e89e685 124static inline u64 of_read_number(const __be32 *cell, int size)
b6caf2ad
GL
125{
126 u64 r = 0;
127 while (size--)
2e89e685 128 r = (r << 32) | be32_to_cpu(*(cell++));
b6caf2ad
GL
129 return r;
130}
131
132/* Like of_read_number, but we want an unsigned long result */
2e89e685 133static inline unsigned long of_read_ulong(const __be32 *cell, int size)
b6caf2ad 134{
2be09cb9
GL
135 /* toss away upper bits if unsigned long is smaller than u64 */
136 return of_read_number(cell, size);
b6caf2ad 137}
b6caf2ad 138
76c1ce78
SR
139#include <asm/prom.h>
140
7c7b60cb
GL
141/* Default #address and #size cells. Allow arch asm/prom.h to override */
142#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
143#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
144#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
145#endif
146
147/* Default string compare functions, Allow arch asm/prom.h to override */
148#if !defined(of_compat_cmp)
1976152f 149#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
7c7b60cb
GL
150#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
151#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
152#endif
153
76c1ce78
SR
154/* flag descriptions */
155#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
156#define OF_DETACHED 2 /* node has been detached from the device tree */
157
61e955db
GL
158#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
159#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
160
76c1ce78
SR
161#define OF_BAD_ADDR ((u64)-1)
162
c0a05bf0 163static inline const char *of_node_full_name(const struct device_node *np)
74a7f084
GL
164{
165 return np ? np->full_name : "<no-node>";
166}
167
76c1ce78
SR
168extern struct device_node *of_find_node_by_name(struct device_node *from,
169 const char *name);
170#define for_each_node_by_name(dn, name) \
171 for (dn = of_find_node_by_name(NULL, name); dn; \
172 dn = of_find_node_by_name(dn, name))
173extern struct device_node *of_find_node_by_type(struct device_node *from,
174 const char *type);
175#define for_each_node_by_type(dn, type) \
176 for (dn = of_find_node_by_type(NULL, type); dn; \
177 dn = of_find_node_by_type(dn, type))
178extern struct device_node *of_find_compatible_node(struct device_node *from,
179 const char *type, const char *compat);
180#define for_each_compatible_node(dn, type, compatible) \
181 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
182 dn = of_find_compatible_node(dn, type, compatible))
50c8af4c
SW
183extern struct device_node *of_find_matching_node_and_match(
184 struct device_node *from,
185 const struct of_device_id *matches,
186 const struct of_device_id **match);
187static inline struct device_node *of_find_matching_node(
188 struct device_node *from,
189 const struct of_device_id *matches)
190{
191 return of_find_matching_node_and_match(from, matches, NULL);
192}
283029d1
GL
193#define for_each_matching_node(dn, matches) \
194 for (dn = of_find_matching_node(NULL, matches); dn; \
195 dn = of_find_matching_node(dn, matches))
50c8af4c
SW
196#define for_each_matching_node_and_match(dn, matches, match) \
197 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
198 dn; dn = of_find_matching_node_and_match(dn, matches, match))
76c1ce78
SR
199extern struct device_node *of_find_node_by_path(const char *path);
200extern struct device_node *of_find_node_by_phandle(phandle handle);
201extern struct device_node *of_get_parent(const struct device_node *node);
f4eb0107 202extern struct device_node *of_get_next_parent(struct device_node *node);
76c1ce78
SR
203extern struct device_node *of_get_next_child(const struct device_node *node,
204 struct device_node *prev);
3296193d
TT
205extern struct device_node *of_get_next_available_child(
206 const struct device_node *node, struct device_node *prev);
207
9c19761a
SK
208extern struct device_node *of_get_child_by_name(const struct device_node *node,
209 const char *name);
aabc08dc
ME
210#define for_each_child_of_node(parent, child) \
211 for (child = of_get_next_child(parent, NULL); child != NULL; \
212 child = of_get_next_child(parent, child))
213
3296193d
TT
214#define for_each_available_child_of_node(parent, child) \
215 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
216 child = of_get_next_available_child(parent, child))
217
183f1d0c
DA
218static inline int of_get_child_count(const struct device_node *np)
219{
220 struct device_node *child;
221 int num = 0;
222
223 for_each_child_of_node(np, child)
224 num++;
225
226 return num;
227}
228
1e291b14
ME
229extern struct device_node *of_find_node_with_property(
230 struct device_node *from, const char *prop_name);
231#define for_each_node_with_property(dn, prop_name) \
232 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
233 dn = of_find_node_with_property(dn, prop_name))
234
76c1ce78
SR
235extern struct property *of_find_property(const struct device_node *np,
236 const char *name,
237 int *lenp);
be193249
VK
238extern int of_property_read_u8_array(const struct device_node *np,
239 const char *propname, u8 *out_values, size_t sz);
240extern int of_property_read_u16_array(const struct device_node *np,
241 const char *propname, u16 *out_values, size_t sz);
0e373639 242extern int of_property_read_u32_array(const struct device_node *np,
aac285c6 243 const char *propname,
0e373639
RH
244 u32 *out_values,
245 size_t sz);
4cd7f7a3
JI
246extern int of_property_read_u64(const struct device_node *np,
247 const char *propname, u64 *out_value);
0e373639 248
aac285c6
JI
249extern int of_property_read_string(struct device_node *np,
250 const char *propname,
251 const char **out_string);
4fcd15a0
BC
252extern int of_property_read_string_index(struct device_node *np,
253 const char *propname,
254 int index, const char **output);
7aff0fe3
GL
255extern int of_property_match_string(struct device_node *np,
256 const char *propname,
257 const char *string);
4fcd15a0
BC
258extern int of_property_count_strings(struct device_node *np,
259 const char *propname);
76c1ce78
SR
260extern int of_device_is_compatible(const struct device_node *device,
261 const char *);
834d97d4 262extern int of_device_is_available(const struct device_node *device);
76c1ce78
SR
263extern const void *of_get_property(const struct device_node *node,
264 const char *name,
265 int *lenp);
8af0da93
DA
266#define for_each_property_of_node(dn, pp) \
267 for (pp = dn->properties; pp != NULL; pp = pp->next)
611cad72 268
76c1ce78
SR
269extern int of_n_addr_cells(struct device_node *np);
270extern int of_n_size_cells(struct device_node *np);
283029d1
GL
271extern const struct of_device_id *of_match_node(
272 const struct of_device_id *matches, const struct device_node *node);
3f07af49 273extern int of_modalias_node(struct device_node *node, char *modalias, int len);
b8fbdc42 274extern struct device_node *of_parse_phandle(const struct device_node *np,
739649c5
GL
275 const char *phandle_name,
276 int index);
93c667ca 277extern int of_parse_phandle_with_args(const struct device_node *np,
64b60e09 278 const char *list_name, const char *cells_name, int index,
15c9a0ac 279 struct of_phandle_args *out_args);
bd69f73f
GL
280extern int of_count_phandle_with_args(const struct device_node *np,
281 const char *list_name, const char *cells_name);
76c1ce78 282
611cad72
SG
283extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
284extern int of_alias_get_id(struct device_node *np, const char *stem);
285
21b082ec
GL
286extern int of_machine_is_compatible(const char *compat);
287
79d1c712
NF
288extern int of_add_property(struct device_node *np, struct property *prop);
289extern int of_remove_property(struct device_node *np, struct property *prop);
290extern int of_update_property(struct device_node *np, struct property *newprop);
21b082ec 291
fcdeb7fe 292/* For updating the device tree at runtime */
1cf3d8b3
NF
293#define OF_RECONFIG_ATTACH_NODE 0x0001
294#define OF_RECONFIG_DETACH_NODE 0x0002
295#define OF_RECONFIG_ADD_PROPERTY 0x0003
296#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
297#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
298
299struct of_prop_reconfig {
300 struct device_node *dn;
301 struct property *prop;
302};
303
304extern int of_reconfig_notifier_register(struct notifier_block *);
305extern int of_reconfig_notifier_unregister(struct notifier_block *);
306extern int of_reconfig_notify(unsigned long, void *);
307
308extern int of_attach_node(struct device_node *);
309extern int of_detach_node(struct device_node *);
fcdeb7fe 310
3a1e362e 311#define of_match_ptr(_ptr) (_ptr)
c541adc6
SW
312
313/*
314 * struct property *prop;
315 * const __be32 *p;
316 * u32 u;
317 *
318 * of_property_for_each_u32(np, "propname", prop, p, u)
319 * printk("U32 value: %x\n", u);
320 */
321const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
322 u32 *pu);
323#define of_property_for_each_u32(np, propname, prop, p, u) \
324 for (prop = of_find_property(np, propname, NULL), \
325 p = of_prop_next_u32(prop, NULL, &u); \
326 p; \
327 p = of_prop_next_u32(prop, p, &u))
328
329/*
330 * struct property *prop;
331 * const char *s;
332 *
333 * of_property_for_each_string(np, "propname", prop, s)
334 * printk("String value: %s\n", s);
335 */
336const char *of_prop_next_string(struct property *prop, const char *cur);
337#define of_property_for_each_string(np, propname, prop, s) \
338 for (prop = of_find_property(np, propname, NULL), \
339 s = of_prop_next_string(prop, NULL); \
340 s; \
341 s = of_prop_next_string(prop, s))
342
b98c0239 343#else /* CONFIG_OF */
3bcbaf6e 344
74a7f084
GL
345static inline const char* of_node_full_name(struct device_node *np)
346{
347 return "<no-node>";
348}
349
1cc44f43
PU
350static inline struct device_node *of_find_node_by_name(struct device_node *from,
351 const char *name)
352{
353 return NULL;
354}
355
3bcbaf6e
SAS
356static inline bool of_have_populated_dt(void)
357{
358 return false;
359}
360
aba3dfff
SW
361#define for_each_child_of_node(parent, child) \
362 while (0)
363
25c040c9
OJ
364static inline struct device_node *of_get_child_by_name(
365 const struct device_node *node,
366 const char *name)
367{
368 return NULL;
369}
370
183f1d0c
DA
371static inline int of_get_child_count(const struct device_node *np)
372{
373 return 0;
374}
375
36a0904e
RN
376static inline int of_device_is_compatible(const struct device_node *device,
377 const char *name)
378{
379 return 0;
380}
381
aba3dfff
SW
382static inline struct property *of_find_property(const struct device_node *np,
383 const char *name,
384 int *lenp)
385{
386 return NULL;
387}
388
2261cc62
SG
389static inline struct device_node *of_find_compatible_node(
390 struct device_node *from,
391 const char *type,
392 const char *compat)
393{
394 return NULL;
395}
396
be193249
VK
397static 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
403static 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
b98c0239 409static inline int of_property_read_u32_array(const struct device_node *np,
aac285c6
JI
410 const char *propname,
411 u32 *out_values, size_t sz)
b98c0239
SG
412{
413 return -ENOSYS;
414}
415
416static inline int of_property_read_string(struct device_node *np,
aac285c6
JI
417 const char *propname,
418 const char **out_string)
b98c0239
SG
419{
420 return -ENOSYS;
421}
422
4fcd15a0
BC
423static inline int of_property_read_string_index(struct device_node *np,
424 const char *propname, int index,
425 const char **out_string)
426{
427 return -ENOSYS;
428}
429
430static inline int of_property_count_strings(struct device_node *np,
431 const char *propname)
432{
433 return -ENOSYS;
434}
435
89272b8c
SW
436static inline const void *of_get_property(const struct device_node *node,
437 const char *name,
438 int *lenp)
439{
440 return NULL;
441}
442
4cd7f7a3
JI
443static inline int of_property_read_u64(const struct device_node *np,
444 const char *propname, u64 *out_value)
445{
446 return -ENOSYS;
447}
448
bd3d5500
TR
449static inline int of_property_match_string(struct device_node *np,
450 const char *propname,
451 const char *string)
452{
453 return -ENOSYS;
454}
455
b8fbdc42 456static inline struct device_node *of_parse_phandle(const struct device_node *np,
36a0904e
RN
457 const char *phandle_name,
458 int index)
459{
460 return NULL;
461}
462
e05e5070
TR
463static 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
bd69f73f
GL
472static inline int of_count_phandle_with_args(struct device_node *np,
473 const char *list_name,
474 const char *cells_name)
475{
476 return -ENOSYS;
477}
478
ed5f886d
NF
479static inline int of_alias_get_id(struct device_node *np, const char *stem)
480{
481 return -ENOSYS;
482}
483
50e07f88
SW
484static inline int of_machine_is_compatible(const char *compat)
485{
486 return 0;
487}
488
3a1e362e 489#define of_match_ptr(_ptr) NULL
5762c205 490#define of_match_node(_matches, _node) NULL
c541adc6
SW
491#define of_property_for_each_u32(np, propname, prop, p, u) \
492 while (0)
493#define of_property_for_each_string(np, propname, prop, s) \
494 while (0)
9dfbf207 495#endif /* CONFIG_OF */
b98c0239 496
5ca4db61
PM
497#ifndef of_node_to_nid
498static inline int of_node_to_nid(struct device_node *np)
499{
500 return numa_node_id();
501}
502
503#define of_node_to_nid of_node_to_nid
504#endif
505
fa4d34cc
JCPV
506/**
507 * of_property_read_bool - Findfrom a property
508 * @np: device node from which the property value is to be read.
509 * @propname: name of the property to be searched.
510 *
511 * Search for a property in a device node.
512 * Returns true if the property exist false otherwise.
513 */
514static inline bool of_property_read_bool(const struct device_node *np,
515 const char *propname)
516{
517 struct property *prop = of_find_property(np, propname, NULL);
518
519 return prop ? true : false;
520}
521
be193249
VK
522static inline int of_property_read_u8(const struct device_node *np,
523 const char *propname,
524 u8 *out_value)
525{
526 return of_property_read_u8_array(np, propname, out_value, 1);
527}
528
529static inline int of_property_read_u16(const struct device_node *np,
530 const char *propname,
531 u16 *out_value)
532{
533 return of_property_read_u16_array(np, propname, out_value, 1);
534}
535
b98c0239 536static inline int of_property_read_u32(const struct device_node *np,
aac285c6 537 const char *propname,
b98c0239
SG
538 u32 *out_value)
539{
540 return of_property_read_u32_array(np, propname, out_value, 1);
541}
542
76c1ce78 543#endif /* _LINUX_OF_H */